This commit adds a new layer of abstraction to the SymtabAPI, and
[dyninst.git] / symtabAPI / h / Variable.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 #if !defined(_Variable_h_)
38 #define _Variable_h_
39
40 #include "Annotatable.h"
41
42 namespace Dyninst{
43 namespace SymtabAPI{
44
45 class Symbol;
46
47 class Variable : public AnnotatableSparse 
48 {
49    public:
50       DLLEXPORT Variable();
51       
52       DLLEXPORT static Variable *createVariable(Symbol *sym);
53
54       DLLEXPORT Offset   getAddress() const;
55       DLLEXPORT Module * getModule() const;
56
57       /***** Symbol Collection Management *****/
58       DLLEXPORT bool addSymbol(Symbol *sym);
59       DLLEXPORT bool removeSymbol(Symbol *sym);
60       DLLEXPORT bool getAllSymbols(std::vector<Symbol *>&syms) const;
61       DLLEXPORT Symbol * getFirstSymbol() const;
62
63       /***** Symbol naming *****/
64       DLLEXPORT const vector<std::string> &getAllMangledNames();
65       DLLEXPORT const vector<std::string> &getAllPrettyNames();
66       DLLEXPORT const vector<std::string> &getAllTypedNames();
67       DLLEXPORT bool addMangledName(std::string name, bool isPrimary = false);
68       DLLEXPORT bool addPrettyName(std::string name, bool isPrimary = false);
69       DLLEXPORT bool addTypedName(std::string name, bool isPrimary = false);
70
71    private:
72       Offset        address_;
73       Module*       module_;
74
75       std::vector<Symbol *> symbols_;
76
77       std::vector<std::string> mangledNames_;
78       std::vector<std::string> prettyNames_;
79       std::vector<std::string> typedNames_;
80 };
81
82 }
83 }
84
85 #endif