Merge pull request #298 from teco-kit/master
[dyninst.git] / dynC_API / h / snippetGen.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 #ifndef SNIPPET_GEN_H
31 #define SNIPPET_GEN_H
32
33 #include "BPatch_snippet.h"
34 #include "BPatch_addressSpace.h"
35 #include "BPatch_point.h"
36 #include "BPatch_function.h"
37 #include "BPatch_module.h"
38 #include "BPatch.h"
39 #include <sstream>
40 #include <string>
41
42
43
44 class SnippetGenerator{
45   public:
46
47    enum SGErrorType{
48       SG_LookUpFailure,
49       SG_TypeError,
50       SG_ScopeViolation,
51       SG_SyntaxError,
52       SG_InternalError
53    };
54
55    struct SGError{
56       SGErrorType type;
57       bool fatal;
58    };   
59
60    enum SGContext{
61       SG_FunctionName,
62       SG_ModuleName,
63       SG_TID
64    };
65
66   private:
67    std::stringstream lastError;
68    SGError lastErrorInfo;   
69    BPatch_point *point;
70    BPatch_addressSpace *addSpace;
71    BPatch_image *image;
72    
73    std::vector<BPatch_register> registers;
74   
75   public:
76    std::string getError() {return lastError.str();};
77    SGError getErrorInfo() {return lastErrorInfo;};
78   
79   public:
80
81   SnippetGenerator() :  point(NULL), addSpace(NULL), image(NULL) {};
82   SnippetGenerator(BPatch_point &pt) : point(&pt)
83    { 
84       addSpace = point->getAddressSpace();
85       image = addSpace->getImage();
86    };
87    
88   SnippetGenerator(BPatch_addressSpace &aSpace) : addSpace(&aSpace)
89    { 
90       point = NULL;
91       image = addSpace->getImage();
92    };
93
94    ~SnippetGenerator(){};
95
96    BPatch_snippet *findOrCreateVariable(const char * name, const char * type, const void * initialValue = NULL);
97    BPatch_snippet *findOrCreateArray(const char * name, const char * elementType, long size);
98    BPatch_snippet *findRegister(const char *name);
99    BPatch_snippet *findAppVariable(const char * name, bool global = false, bool local = false);
100    BPatch_snippet *findParameter(const char * name);
101    BPatch_snippet *findParameter(int index);
102    BPatch_snippet *findInstVariable(const char *mangledStub, const char * name);
103    BPatch_snippet *generateArrayRef(BPatch_snippet *base, BPatch_snippet *index);
104    BPatch_function *findFunction(const char * name, std::vector<BPatch_snippet *> params);
105    BPatch_snippet *getContextInfo(SGContext context);
106
107    BPatch_point *getPoint() {return point;};
108 };
109
110 #endif