Update copyright to LGPL on all files
[dyninst.git] / symtabAPI / h / Module.h
1 /*
2  * Copyright (c) 1996-2009 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 #ifndef __MODULE__H__
33 #define __MODULE__H__
34  
35 #include "symutil.h"
36 #include "Symbol.h"
37
38 #include "Annotatable.h"
39 #include "Serialization.h"
40
41 namespace Dyninst{
42 namespace SymtabAPI{
43
44 class typeCollection;
45 class LineInformation;
46 class localVar;
47 class Symtab;
48
49 class Statement : public AnnotatableSparse, public Serializable
50 {
51         friend class Module;
52         friend class std::vector<Statement>;
53         friend class LineInformation;
54
55         Statement(const char *file, unsigned int line, unsigned int col = 0,
56                         Offset start_addr = (Offset) -1L, Offset end_addr = (Offset) -1L) :
57                 file_(file ? std::string(file) : std::string()),
58             line_(line),
59             column(col),
60             start_addr_(start_addr),
61             end_addr_(end_addr),
62             first(file_.c_str()),
63             second(line_)       {}
64         
65         std::string file_; // Maybe this should be module?
66         unsigned int line_;
67         unsigned int column;
68         Offset start_addr_;
69         Offset end_addr_;
70
71         const char *first;
72         unsigned int &second;
73
74         public:
75         Statement() : first(NULL), second(line_) {}
76         struct StatementLess {
77                 bool operator () ( const Statement &lhs, const Statement &rhs ) const;
78         };
79
80         typedef StatementLess LineNoTupleLess;
81
82         bool operator==(const Statement &cmp) const;
83         ~Statement() {}
84
85         SYMTAB_EXPORT Offset startAddr() { return start_addr_;}
86         SYMTAB_EXPORT Offset endAddr() {return end_addr_;}
87         SYMTAB_EXPORT std::string getFile() { return file_;}
88         SYMTAB_EXPORT unsigned int getLine() {return line_;}
89         SYMTAB_EXPORT unsigned int getColumn() {return column;}
90
91         SYMTAB_EXPORT Serializable *serialize_impl(SerializerBase *sb, const char *tag = "Statement") THROW_SPEC (SerializerError);
92
93         //  Does dyninst really need these?
94         SYMTAB_EXPORT void setLine(unsigned int l) {line_ = l;}
95         SYMTAB_EXPORT void setColumn(unsigned int l) {column = l;}
96         SYMTAB_EXPORT void setFile(const char * l) {file_ = std::string(l); first = file_.c_str();}
97         SYMTAB_EXPORT void setStartAddr(Offset l) {start_addr_ = l;}
98         SYMTAB_EXPORT void setEndAddr(Offset l) {end_addr_ = l;}
99 };
100
101 typedef Statement LineNoTuple;
102 #define MODULE_ANNOTATABLE_CLASS AnnotatableSparse
103
104 class Module : public LookupInterface,
105                            public Serializable, 
106                            public MODULE_ANNOTATABLE_CLASS
107 {
108         friend class Symtab;
109
110         public:
111
112         SYMTAB_EXPORT Module();
113         SYMTAB_EXPORT Module(supportedLanguages lang, Offset adr, std::string fullNm,
114                         Symtab *img);
115         SYMTAB_EXPORT Module(const Module &mod);
116         SYMTAB_EXPORT bool operator==(Module &mod);
117
118         SYMTAB_EXPORT Serializable * serialize_impl(SerializerBase *sb, const char *tag = "Module") THROW_SPEC (SerializerError);
119
120         SYMTAB_EXPORT const std::string &fileName() const;
121         SYMTAB_EXPORT const std::string &fullName() const;
122         SYMTAB_EXPORT bool setName(std::string newName);
123
124         SYMTAB_EXPORT supportedLanguages language() const;
125         SYMTAB_EXPORT void setLanguage(supportedLanguages lang);
126
127         SYMTAB_EXPORT Offset addr() const;
128         SYMTAB_EXPORT Symtab *exec() const;
129
130         SYMTAB_EXPORT bool isShared() const;
131         SYMTAB_EXPORT ~Module();
132
133         // Symbol output methods
134         SYMTAB_EXPORT virtual bool findSymbolByType(std::vector<Symbol *> &ret, 
135                         const std::string name,
136                         Symbol::SymbolType sType, 
137                         NameType nameType = anyName,
138                         bool isRegex = false, 
139                         bool checkCase = false);
140         SYMTAB_EXPORT virtual bool getAllSymbolsByType(std::vector<Symbol *> &ret, 
141                         Symbol::SymbolType sType);
142         SYMTAB_EXPORT virtual bool getAllSymbols(std::vector<Symbol *> &ret);
143
144
145         // Function based methods
146         SYMTAB_EXPORT bool getAllFunctions(std::vector<Function *>&ret);
147         SYMTAB_EXPORT bool findFunctionByEntryOffset(Function *&ret, const Offset offset);
148         SYMTAB_EXPORT bool findFunctionsByName(std::vector<Function *> &ret, const std::string name,
149                         NameType nameType = anyName, 
150                         bool isRegex = false,
151                         bool checkCase = true);
152
153         // Variable based methods
154         SYMTAB_EXPORT bool findVariableByOffset(Variable *&ret, const Offset offset);
155         SYMTAB_EXPORT bool findVariablesByName(std::vector<Variable *> &ret, const std::string name,
156                         NameType nameType = anyName, 
157                         bool isRegex = false, 
158                         bool checkCase = true);
159    SYMTAB_EXPORT bool getAllVariables(std::vector<Variable *> &ret);
160
161
162    // Type output methods
163    SYMTAB_EXPORT virtual bool findType(Type *&type, std::string name);
164    SYMTAB_EXPORT virtual bool findVariableType(Type *&type, std::string name);
165
166    SYMTAB_EXPORT std::vector<Type *> *getAllTypes();
167    SYMTAB_EXPORT std::vector<std::pair<std::string, Type *> > *getAllGlobalVars();
168
169    SYMTAB_EXPORT typeCollection *getModuleTypes();
170
171    /***** Local Variable Information *****/
172    SYMTAB_EXPORT bool findLocalVariable(std::vector<localVar *>&vars, std::string name);
173
174    /***** Line Number Information *****/
175    SYMTAB_EXPORT bool getAddressRanges(std::vector<std::pair<Offset, Offset> >&ranges,
176          std::string lineSource, unsigned int LineNo);
177    SYMTAB_EXPORT bool getSourceLines(std::vector<Statement *> &lines,
178          Offset addressInRange);
179    SYMTAB_EXPORT bool getStatements(std::vector<Statement *> &statements);
180    SYMTAB_EXPORT LineInformation *getLineInformation();
181
182    SYMTAB_EXPORT bool hasLineInformation();
183    SYMTAB_EXPORT bool setDefaultNamespacePrefix(std::string str);
184
185    // Deprecated methods
186    SYMTAB_EXPORT virtual bool findSymbolByType(std::vector<Symbol *> &ret, 
187                                                const std::string name,
188                                                Symbol::SymbolType sType, 
189                                                bool isMangled = false,
190                                                bool isRegex = false, 
191                                                bool checkCase = false);
192
193
194    //  Super secret private methods that aren't really private
195    SYMTAB_EXPORT typeCollection *getModuleTypesPrivate();
196
197    private:
198    bool setLineInfo(Dyninst::SymtabAPI::LineInformation *lineInfo);
199
200
201    std::string fileName_;                   // short file 
202    std::string fullName_;                   // full path to file 
203    supportedLanguages language_;
204    Offset addr_;                      // starting address of module
205    Symtab *exec_;
206 };
207
208
209
210
211
212 }//namespace SymtabAPI
213
214 }//namespace Dyninst
215 #endif