Added DLL linkage specification to class declarations to support building
[dyninst.git] / dyninstAPI / h / BPatch_snippet.h
1 /*
2  * Copyright (c) 1996 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  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 #ifndef _BPatch_snippet_h_
43 #define _BPatch_snippet_h_
44
45 #include "BPatch_dll.h"
46 #include "BPatch_Vector.h"
47 #include "BPatch_sourceObj.h"
48 #include "BPatch_point.h"
49 #include "BPatch_type.h"
50 #include "BPatch_module.h"
51 #include "BPatch_function.h"
52
53 class AstNode;
54 class process;
55
56 typedef enum {
57     BPatch_lt,
58     BPatch_eq,
59     BPatch_gt,
60     BPatch_le,
61     BPatch_ne,
62     BPatch_ge,
63     BPatch_and,
64     BPatch_or
65 } BPatch_relOp;
66
67 typedef enum {
68     BPatch_assign,
69     BPatch_plus,
70     BPatch_minus,
71     BPatch_divide,
72     BPatch_times,
73     BPatch_mod,
74     BPatch_ref,
75     BPatch_seq
76 } BPatch_binOp;
77
78 typedef enum {
79     BPatch_negate,
80     BPatch_addr,
81     BPatch_deref
82 } BPatch_unOp;
83
84 class BPATCH_DLL_EXPORT BPatch_snippet {
85 public:
86 // The following members are for  internal use by the library only:
87     AstNode     *ast; /* XXX It would be better if this was protected */
88 // End members for internal use only.
89
90     BPatch_snippet() : ast(NULL) {};
91     BPatch_snippet(const BPatch_snippet &);
92     BPatch_snippet &operator=(const BPatch_snippet &);
93
94     virtual     ~BPatch_snippet();
95
96     float       getCost();
97 };
98
99 class BPATCH_DLL_EXPORT BPatch_arithExpr: public BPatch_snippet {
100 public:
101     BPatch_arithExpr(BPatch_binOp op,
102                      const BPatch_snippet &lOperand,
103                      const BPatch_snippet &rOperand);
104     BPatch_arithExpr(BPatch_unOp op, const BPatch_snippet &lOperand);
105 };
106
107 class BPATCH_DLL_EXPORT BPatch_boolExpr : public BPatch_snippet {
108 public:
109     BPatch_boolExpr(BPatch_relOp op, const BPatch_snippet &lOperand,
110                     const BPatch_snippet &rOperand);
111 };
112
113 class BPATCH_DLL_EXPORT BPatch_constExpr : public BPatch_snippet {
114 public:
115     BPatch_constExpr(int value);
116 #ifdef BPATCH_NOT_YET
117     BPatch_constExpr(float value);
118 #endif
119     BPatch_constExpr(const char *value);
120     BPatch_constExpr(const void *value);
121 };
122
123 class BPATCH_DLL_EXPORT BPatch_funcCallExpr : public BPatch_snippet {
124 public:
125     BPatch_funcCallExpr(const BPatch_function& func,
126                         const BPatch_Vector<BPatch_snippet *> &args);
127 };
128
129 class BPATCH_DLL_EXPORT BPatch_funcJumpExpr : public BPatch_snippet {
130 public:
131      BPatch_funcJumpExpr(const BPatch_function& func);
132 };
133
134 class BPATCH_DLL_EXPORT BPatch_ifExpr : public BPatch_snippet {
135 public:
136     BPatch_ifExpr(const BPatch_boolExpr &conditional,
137                   const BPatch_snippet &tClase);
138     BPatch_ifExpr(const BPatch_boolExpr &conditional,
139                   const BPatch_snippet &tClase,
140                   const BPatch_snippet &fClause);
141 };
142
143 class BPATCH_DLL_EXPORT BPatch_nullExpr : public BPatch_snippet {
144 public:
145     BPatch_nullExpr();
146 };
147
148 class BPATCH_DLL_EXPORT BPatch_paramExpr : public BPatch_snippet {
149 public:
150     BPatch_paramExpr(int n);
151 };
152
153 class BPATCH_DLL_EXPORT BPatch_retExpr : public BPatch_snippet {
154 public:
155     BPatch_retExpr();
156 };
157
158 class BPATCH_DLL_EXPORT BPatch_sequence : public BPatch_snippet {
159 public:
160     BPatch_sequence(const BPatch_Vector<BPatch_snippet *> &items);
161 };
162
163 class BPATCH_DLL_EXPORT BPatch_variableExpr : public BPatch_snippet {
164     char                *name;
165     process             *proc;
166     void                *address;
167     int                 size;
168     BPatch_point        *scope;
169 public:
170 // The following functions are for internal use by the library only:
171     BPatch_variableExpr(char *name, process *in_process, void *in_address,
172                         const BPatch_type *type);
173     BPatch_variableExpr(process *in_process, void *in_address,
174                         const BPatch_type *type, bool frameRelative = false,
175                         BPatch_point *sc = NULL);
176     BPatch_variableExpr(process *in_process, void *in_address,
177                         int in_size);
178     BPatch_variableExpr(char *in_name, process *in_process, AstNode *_ast,
179                         const BPatch_type *type);
180
181 // Public functions for use by users of the library:
182     bool readValue(void *dst);
183     void readValue(void *dst, int len);
184     bool writeValue(const void *src);
185     void writeValue(const void *src, int len);
186
187     char *getName() { return name; }
188     void *getBaseAddr() const { return address; }
189     unsigned int getSize() const { return size; }
190     const BPatch_type *getType();
191     void setType(BPatch_type *);
192     void setSize(int sz) {  size = sz; }
193     BPatch_Vector<BPatch_variableExpr *> *getComponents();
194 };
195
196 class BPATCH_DLL_EXPORT BPatch_breakPointExpr : public BPatch_snippet {
197 public:
198     BPatch_breakPointExpr();
199 };
200
201 #endif /* _BPatch_snippet_h_ */