windows build fixes and some more work on symtab serialization
[dyninst.git] / symtabAPI / h / Function.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  * Symbol.h: symbol table objects.
35 ************************************************************************/
36
37 #if !defined(_Function_h_)
38 #define _Function_h_
39
40 #include "Annotatable.h"
41 #include "Serialization.h"
42 #include "Aggregate.h"
43 #if 0
44 #include "Symbol.h"
45 #endif
46 #include "Variable.h"
47
48 SYMTAB_EXPORT std::ostream &operator<<(std::ostream &os, const Dyninst::SymtabAPI::Function &);
49
50 namespace Dyninst{
51 namespace SymtabAPI{
52
53 class Symbol;
54 class Type;
55
56
57 class Function : public Aggregate, public Serializable
58 {
59     friend class Symtab;
60         friend std::ostream &::operator<<(std::ostream &os, const Dyninst::SymtabAPI::Function &);
61
62  private:
63     SYMTAB_EXPORT Function(Symbol *sym);
64     SYMTAB_EXPORT ~Function();
65     
66  public:
67     //SYMTAB_EXPORT static Function *createFunction(Symtab *st, std::string fname, std::string modname,Offset offset, size_t sz);
68
69     /* Symbol management */
70     SYMTAB_EXPORT bool removeSymbol(Symbol *sym);      
71       
72       /***** Return Type Information *****/
73       SYMTAB_EXPORT Type  * getReturnType() const;
74       SYMTAB_EXPORT bool        setReturnType(Type *);
75
76       /***** IA64-Specific Frame Pointer Information *****/
77       SYMTAB_EXPORT bool  setFramePtrRegnum(int regnum);
78       SYMTAB_EXPORT int   getFramePtrRegnum() const;
79
80       /***** x84_64-Specific Frame Pointer Information *****/
81           //SYMTAB_EXPORT bool  setFramePtr(std::vector<VariableLocation> *locs);
82       SYMTAB_EXPORT std::vector<VariableLocation> *getFramePtr();
83
84       /***** Local Variable Information *****/
85       SYMTAB_EXPORT bool findLocalVariable(std::vector<localVar *>&vars, std::string name);
86       SYMTAB_EXPORT bool getLocalVariables(std::vector<localVar *>&vars);
87       SYMTAB_EXPORT bool getParams(std::vector<localVar *>&params);
88
89           SYMTAB_EXPORT
90           void serialize(SerializerBase *sb, const char *tag = "Function") THROW_SPEC (SerializerError);
91
92           bool operator==(const Function &);
93       /* internal helper functions */
94       bool addLocalVar(localVar *);
95       bool addParam(localVar *);
96    private:
97
98       Type          *retType_;
99       int           framePtrRegNum_;
100       std::vector<VariableLocation> locs_;
101 };
102
103
104 }
105 }
106
107 #endif