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