Remove incorrect export declaration
[dyninst.git] / symtabAPI / h / Collections.h
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 #ifndef _Collections_h_
32 #define _Collections_h_
33
34 #include "Type.h"
35 #include "Variable.h"
36 #include "Serialization.h"
37
38 namespace Dyninst {
39
40 namespace SymtabAPI {
41
42 class Module;
43 class Symtab;
44 class localVar;
45 class DwarfWalker;
46
47 /*
48  * This class contains a collection of local variables.
49  * Each function will have one of these objects associated with it.
50  * This object will store all the local variables within this function.
51  * Note: This class is unaware of scope.
52  */
53 class SYMTAB_EXPORT localVarCollection : public AnnotationContainer<localVar *> {
54   
55   std::vector<localVar *> localVars;
56   
57   bool addItem_impl(localVar *);
58 public:
59   localVarCollection(){}
60   ~localVarCollection();
61
62   void addLocalVar(localVar * var);
63   localVar * findLocalVar(std::string &name);
64   std::vector<localVar *> *getAllVars();  
65
66   Serializable *ac_serialize_impl(SerializerBase *, const char * = "localVarCollection") THROW_SPEC (SerializerError);
67 };
68   
69
70
71 /*
72  * Due to DWARF weirdness, this can be shared between multiple BPatch_modules.
73  * So we reference-count to make life easier.
74  */
75 class SYMTAB_EXPORT typeCollection : public Serializable//, public AnnotatableSparse 
76 {
77     friend class Symtab;
78     friend class Object;
79     friend class Module;
80     friend class Type;
81     friend class DwarfWalker;
82
83     dyn_hash_map<std::string, Type *> typesByName;
84     dyn_hash_map<std::string, Type *> globalVarsByName;
85     dyn_hash_map<int, Type *> typesByID;
86
87
88     // DWARF:
89     /* Cache type collections on a per-image basis.  (Since
90        BPatch_functions are solitons, we don't have to cache them.) */
91     static dyn_hash_map< void *, typeCollection * > fileToTypesMap;
92         //static dyn_hash_map<int, std::vector<std::pair<dataClass, Type **> > > deferred_lookups;
93         static bool doDeferredLookups(typeCollection *);
94
95     // DWARF...
96     bool dwarfParsed_;
97
98         Serializable *serialize_impl(SerializerBase *, const char * = "typeCollection") THROW_SPEC (SerializerError);
99         public:
100     typeCollection();
101     ~typeCollection();
102 public:
103         static void addDeferredLookup(int, dataClass, Type **);
104
105     static typeCollection *getModTypeCollection(Module *mod);
106 #if 0
107     static typeCollection *getGlobalTypeCollection();
108     static void freeTypeCollection(typeCollection *tc);
109 #endif
110
111     // DWARF...
112     bool dwarfParsed() { return dwarfParsed_; }
113     void setDwarfParsed() { dwarfParsed_ = true; }
114
115     Type        *findType(std::string name);
116     Type        *findType(const int ID);
117     Type        *findTypeLocal(std::string name);
118     Type        *findTypeLocal(const int ID);
119     void        addType(Type *type);
120     void        addGlobalVariable(std::string &name, Type *type);
121
122     /* Some debug formats allow forward references.  Rather than
123        fill in forward in a second pass, generate placeholder
124        types, and fill them in as we go.  Because we require
125        One True Pointer for each type (in parseStab.C), when
126        updating a type, return that One True Pointer. */
127     Type * findOrCreateType( const int ID );
128     template<class T>
129     T* addOrUpdateType(T* type);
130
131     Type *findVariableType(std::string &name);
132
133     std::vector<Type *> *getAllTypes();
134     std::vector<std::pair<std::string, Type *> > *getAllGlobalVariables();
135     void clearNumberedTypes();
136 };
137
138 /*
139  * This class defines the collection for the built-in Types
140  * gnu ( and AIX??) use negative numbers to define other types
141  * in terms of these built-in types.
142  * This collection is global and built in the BPatch_image constructor.
143  * This means that only one collection of built-in types is made
144  * per image.  jdd 4/21/99
145  *
146  */
147
148 class SYMTAB_EXPORT builtInTypeCollection {
149    
150     dyn_hash_map<std::string, Type *> builtInTypesByName;
151     dyn_hash_map<int, Type *> builtInTypesByID;
152 public:
153
154     builtInTypeCollection();
155     ~builtInTypeCollection();
156
157     Type        *findBuiltInType(std::string &name);
158     Type        *findBuiltInType(const int ID);
159     void        addBuiltInType(Type *type);
160     std::vector<Type *> *getAllBuiltInTypes();
161    
162 };
163
164 }// namespace SymtabAPI
165 }// namespace Dyninst
166
167 #endif /* _Collections_h_ */
168
169
170