Add a common Aggregate superclass for Function/Variable and make
[dyninst.git] / symtabAPI / src / Aggregate.C
1 /*
2  * Copyright (c) 1996-2007 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
30  */
31
32 #include "Annotatable.h"
33 #include "common/h/serialize.h"
34
35 #include "Symtab.h"
36 #include "symutil.h"
37 #include "Module.h"
38 #include "Collections.h"
39 #include "Variable.h"
40
41 #include "symtabAPI/src/Object.h"
42
43
44 #include "Aggregate.h"
45 #include "Symbol.h"
46
47 using namespace std;
48 using namespace Dyninst;
49 using namespace Dyninst::SymtabAPI;
50
51 Aggregate::Aggregate() : module_(NULL)
52 {}
53
54 Offset Aggregate::getAddress() const {
55     return symbols_[0]->getAddr();
56 }
57
58 Module *Aggregate::getModule() const {
59     return module_;
60 }
61
62 const vector<std::string> &Aggregate::getAllMangledNames() {
63     return mangledNames_;
64 }
65 const vector<std::string> &Aggregate::getAllPrettyNames() {
66     return prettyNames_;
67 }
68 const vector<std::string> &Aggregate::getAllTypedNames() {
69     return typedNames_;
70 }
71
72 bool Aggregate::addSymbol(Symbol *sym) {
73
74     // We keep a "primary" module, which is defined as "anything not DEFAULT_MODULE".
75     if (module_ == NULL) {
76         module_ = sym->getModule();
77     }
78     else if (module_->fileName() == "DEFAULT_MODULE") {
79         module_ = sym->getModule();
80     }
81     // else keep current module.
82
83     symbols_.push_back(sym);
84
85     // We need to add the symbol names (if they aren't there already)
86     // We can have multiple identical names - for example, there are
87     // often two symbols for main (static and dynamic symbol table)
88     
89     bool found = false;
90     for (unsigned j = 0; j < mangledNames_.size(); j++) {
91         if (sym->getMangledName() == mangledNames_[j]) {
92             found = true;
93             break;
94         }
95     }
96     if (!found) mangledNames_.push_back(sym->getMangledName());
97
98     found = false;
99
100     for (unsigned j = 0; j < prettyNames_.size(); j++) {
101         if (sym->getPrettyName() == prettyNames_[j]) {
102             found = true;
103             break;
104         }
105     }
106     if (!found) prettyNames_.push_back(sym->getPrettyName());
107
108     found = false;
109     for (unsigned j = 0; j < typedNames_.size(); j++) {
110         if (sym->getTypedName() == typedNames_[j]) {
111             found = true;
112             break;
113         }
114     }
115     if (!found) typedNames_.push_back(sym->getTypedName());;
116
117     return true;
118 }
119
120 bool Aggregate::removeSymbol(Symbol *sym) {
121     std::vector<Symbol *>::iterator iter;
122     for (iter = symbols_.begin(); iter != symbols_.end(); iter++) {
123         if (*iter == sym) {
124             symbols_.erase(iter);
125             return true;
126         }
127     }
128     // TODO: remove from names. Do we ever call this?
129
130     return false;
131 }
132
133 bool Aggregate::getAllSymbols(std::vector<Symbol *> &syms) const {
134     syms = symbols_;
135     return true;
136 }
137
138 Symbol * Aggregate::getFirstSymbol() const
139 {
140     assert( symbols_.size()>0 );
141     return symbols_[0];
142 }
143
144 bool Aggregate::addMangledNameInt(string name, bool isPrimary) {
145     // Check to see if we're duplicating
146     for (unsigned i = 0; i < mangledNames_.size(); i++) {
147         if (mangledNames_[i] == name)
148             return false;
149     }
150
151     if (isPrimary) {
152         std::vector<std::string>::iterator iter = mangledNames_.begin();
153         mangledNames_.insert(iter, name);
154     }
155     else
156         mangledNames_.push_back(name);
157     return true;
158 }
159
160 bool Aggregate::addPrettyNameInt(string name, bool isPrimary) {
161     // Check to see if we're duplicating
162     for (unsigned i = 0; i < prettyNames_.size(); i++) {
163         if (prettyNames_[i] == name)
164             return false;
165     }
166
167     if (isPrimary) {
168         std::vector<std::string>::iterator iter = prettyNames_.begin();
169         prettyNames_.insert(iter, name);
170     }
171     else
172         prettyNames_.push_back(name);
173     return true;
174 }
175
176 bool Aggregate::addTypedNameInt(string name, bool isPrimary) {
177     // Check to see if we're duplicating
178     for (unsigned i = 0; i < typedNames_.size(); i++) {
179         if (typedNames_[i] == name)
180             return false;
181     }
182
183     if (isPrimary) {
184         std::vector<std::string>::iterator iter = typedNames_.begin();
185         typedNames_.insert(iter, name);
186     }
187     else
188         typedNames_.push_back(name);
189     return true;
190 }
191