Remove incorrect export declaration
[dyninst.git] / symtabAPI / h / Aggregate.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 /************************************************************************
32  * $Id: Symbol.h,v 1.20 2008/11/03 15:19:24 jaw Exp $
33
34 ************************************************************************/
35
36 // Present a common superclass for all Symbol aggregates. 
37 // We never create an Aggregate directly, but only via a child class.
38
39 #if !defined(_Aggregate_h_)
40 #define _Aggregate_h_
41
42 #include <iostream>
43 #include "Annotatable.h"
44
45 SYMTAB_EXPORT std::ostream &operator<<(std::ostream &os, const Dyninst::SymtabAPI::Aggregate &);
46
47 namespace Dyninst{
48 namespace SymtabAPI{
49
50 class Symbol;
51 class Module;
52 class Symtab; 
53 class Region; 
54 class Aggregate; 
55 class DwarfWalker;
56
57 struct SymbolCompareByAddr;
58
59 class SYMTAB_EXPORT Aggregate
60 {
61    friend class Symtab;
62    friend struct SymbolCompareByAddr;
63         friend std::ostream &::operator<<(std::ostream &os, const Dyninst::SymtabAPI::Aggregate &);
64    friend class DwarfWalker;
65   protected:
66       Aggregate();
67       Aggregate(Symbol *sym);
68       Aggregate(Module *m);      
69   public:
70
71       
72       virtual ~Aggregate() {};
73
74       Offset   getOffset() const;
75       unsigned getSize() const;
76       Module * getModule() const { return module_; }
77       Region * getRegion() const;
78
79       /***** Symbol Collection Management *****/
80       bool addSymbol(Symbol *sym);
81       virtual bool removeSymbol(Symbol *sym) = 0;
82       bool getSymbols(std::vector<Symbol *> &syms) const;
83       Symbol *getFirstSymbol() const;
84
85       /***** Symbol naming *****/
86       const std::vector<std::string> &getAllMangledNames();
87       const std::vector<std::string> &getAllPrettyNames();
88       const std::vector<std::string> &getAllTypedNames();
89
90       /***** Aggregate updating *****/
91       virtual bool addMangledName(std::string name, bool isPrimary);
92       virtual bool addPrettyName(std::string name, bool isPrimary);
93       virtual bool addTypedName(std::string name, bool isPrimary);
94
95       bool setModule(Module *mod);
96       bool setSize(unsigned size);
97       bool setOffset(unsigned offset);
98       
99           bool operator==(const Aggregate &a);
100
101
102    protected:
103       bool removeSymbolInt(Symbol *sym);
104       virtual bool changeSymbolOffset(Symbol *sym);
105
106       // Offset comes from a symbol
107       // Module we keep here so we can have the correct "primary"
108       // (AKA 'not DEFAULT_MODULE') module
109       Module *module_;
110
111       std::vector<Symbol *> symbols_;
112       Symbol *firstSymbol;  // cached for speed
113       Offset offset_;       // cached for speed
114
115       std::vector<std::string> mangledNames_;
116       std::vector<std::string> prettyNames_;
117       std::vector<std::string> typedNames_;
118
119           void restore_type_by_id(SerializerBase *, Type *&, unsigned) THROW_SPEC (SerializerError);
120           void restore_module_by_name(SerializerBase *, std::string &) THROW_SPEC (SerializerError);
121           //void rebuild_symbol_vector(SerializerBase *, std::vector<Offset> *) THROW_SPEC (SerializerError);
122           void rebuild_symbol_vector(SerializerBase *, std::vector<Address> &) THROW_SPEC (SerializerError);
123           void serialize_aggregate(SerializerBase *, const char * = "Aggregate") THROW_SPEC (SerializerError);
124      bool addMangledNameInternal(std::string name, bool isPrimary, bool demangle);
125 };
126
127 }
128 }
129
130 #endif