File: vhdl_element.cc

package info (click to toggle)
iverilog 12.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 30,148 kB
  • sloc: cpp: 109,972; ansic: 62,713; yacc: 10,216; sh: 3,470; vhdl: 3,246; perl: 1,814; makefile: 1,774; python: 78; csh: 2
file content (173 lines) | stat: -rw-r--r-- 4,890 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*
 *  VHDL abstract syntax elements.
 *
 *  Copyright (C) 2008-2021  Nick Gasson (nick@nickg.me.uk)
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include "vhdl_element.hh"

#include <algorithm>
#include <cassert>
#include <cstring>
#include <typeinfo>
#include <iostream>
#include <sstream>

using namespace std;

static const int VHDL_INDENT = 2;  // Spaces to indent

int indent(int level)
{
   return level + VHDL_INDENT;
}

std::string nl_string(int level)
{
   std::ostringstream ss;
   newline(ss, level);
   return ss.str();
}

/*
 * Emit a newline and indent to the correct level.
 */
void newline(std::ostream &of, int level)
{
   of << std::endl;
   while (level--)
      of << ' ';
}

void blank_line(std::ostream &of, int level)
{
   of << std::endl;
   newline(of, level);
}

// The array of all vhdl_elements allocated so we can quickly
// clean them up just before the code generator exits
vector<vhdl_element*> vhdl_element::allocated_;

// Just a counter of total bytes allocated for statistics
size_t vhdl_element::total_alloc_(0);

void vhdl_element::set_comment(const std::string&comment)
{
   comment_ = comment;
}

/*
 * Draw the comment for any element. The comment is either on
 * a line before the element (end_of_line is false) or at the
 * end of the line containing the element (end_of_line is true).
 */
void vhdl_element::emit_comment(std::ostream &of, int level,
                                bool end_of_line) const
{
   if (! comment_.empty()) {
      if (end_of_line)
         of << "  -- " << comment_;
      else {
         // Comment may contain embedded newlines
         of << "-- ";
         for (string::const_iterator it = comment_.begin();
              it != comment_.end(); ++it) {
            if (*it == '\n') {
               newline(of, level);
               of << "-- ";
            }
            else
               of << *it;
         }
         newline(of, level);
      }
   }
}

void vhdl_element::print() const
{
   emit(std::cout, 0);
   std::cout << std::endl;
}

// Trap allocations of vhdl_element subclasses.
// This records the pointer allocated in a static field of vhdl_element
// so we can delete it just before the code generator exits.
void* vhdl_element::operator new(size_t size)
{
   // Let the default new handle the allocation
   void* ptr = ::operator new(size);

   // Remember this element so we can delete it later
   vhdl_element* elem = static_cast<vhdl_element*>(ptr);
   allocated_.push_back(elem);

   total_alloc_ += size;

   return ptr;
}

// Explicitly delete a vhdl_element object.
// This just sets the corresponding pointer in vhdl_element::allocated_
// to NULL (since it's safe to delete a NULL pointer).
void vhdl_element::operator delete(void* ptr)
{
   // Let the default delete handle the deallocation
   ::operator delete(ptr);

   // Remember that we've already deleted this pointer so we don't
   // delete it again in the call to free_all_objects
   vector<vhdl_element*>::iterator it =
      find(allocated_.begin(), allocated_.end(), static_cast<vhdl_element*>(ptr));

   if (it != allocated_.end()) {
      *it = NULL;   // It's safe to delete a NULL pointer and much cheaper
                    // than removing an element from the middle of a vector
   }
   else {
      // This shouldn't really happen but it's harmless
      cerr << "??? vhdl_element::operator delete called on an object not "
           << "allocated by vhdl_element::operator new" << endl;
   }
}

// Return the total number of bytes our custom operator new has seen.
size_t vhdl_element::total_allocated()
{
   return total_alloc_;
}

// Free every object derived from vhdl_element that has not yet been
// explicitly deallocated.
// Any pointers to vhdl_elements will be invalid after this call!
// Returns the number of objects freed.
int vhdl_element::free_all_objects()
{
   for (vector<vhdl_element*>::iterator it = allocated_.begin();
        it != allocated_.end(); ++it) {
      if (*it)
         ::operator delete(*it);  // Explicitly use the default delete
   }

   int freed = allocated_.size();

   // Just in case we want to allocated any more vhdl_element objects
   allocated_.clear();

   return freed;
}