]> andersk Git - splint.git/blame - src/Headers/exprNode.h
Added basic support for simple loops.
[splint.git] / src / Headers / exprNode.h
CommitLineData
885824d3 1/*
2** Copyright (C) University of Virginia, Massachusetts Institue of Technology 1994-2000.
3** See ../LICENSE for license information.
4**
5*/
6/*
7** exprNode.h
8*/
9
10# ifndef EXPRNODE_H
11# define EXPRNODE_H
12
13/*
14** expression Nodes:
15**
16** ctype typ --- type of expression
17**
18** union _val
19** { long ival;
20** char cval;
21** double fval;
22** cstring sval;
23** } *val --- value, if known. if unknown, val = (_val *)0
24**
25** storeRef sref --- storage referred to by expression, of storeRef_null
26**
27** cstring etext --- to get nice error messages, punt for now!
28*/
29
30/* in exprNode_type: typedef struct _exprNode *exprNode; */
31
32typedef enum
33{
34 XPR_PARENS, XPR_ASSIGN, XPR_CALL, XPR_EMPTY, XPR_VAR,
35 XPR_OP, XPR_POSTOP, XPR_PREOP, XPR_SIZEOFT, XPR_SIZEOF, XPR_ALIGNOFT, XPR_ALIGNOF,
36 XPR_OFFSETOF, XPR_CAST, XPR_FETCH, XPR_VAARG, XPR_ITER,
37 XPR_FOR, XPR_FORPRED, XPR_GOTO, XPR_CONTINUE, XPR_BREAK,
38 XPR_RETURN, XPR_NULLRETURN, XPR_COMMA, XPR_COND, XPR_IF, XPR_IFELSE,
39 XPR_DOWHILE, XPR_WHILE, XPR_STMT, XPR_STMTLIST, XPR_SWITCH,
40 XPR_INIT, XPR_FACCESS, XPR_ARROW, XPR_CONST, XPR_STRINGLITERAL,
41 XPR_NUMLIT, XPR_BODY, XPR_NODE, XPR_ITERCALL, XPR_TOK,
42 XPR_WHILEPRED, XPR_CASE, XPR_FTCASE, XPR_DEFAULT, XPR_FTDEFAULT,
43 XPR_BLOCK, XPR_INITBLOCK, XPR_LABEL
44} exprKind;
45
46typedef struct _exprOffsetof
47{
48 /*@only@*/ qtype q;
49 /*@only@*/ cstringList field;
50} *exprOffsetof;
51
52typedef struct _exprPair
53{
54 /*@only@*/ exprNode a;
55 /*@only@*/ exprNode b;
56} *exprPair;
57
58typedef struct _exprTriple
59{
60 /*@only@*/ exprNode pred;
61 /*@only@*/ exprNode tbranch;
62 /*@only@*/ exprNode fbranch;
63} *exprTriple;
64
65typedef struct _exprIter
66{
67 /*@dependent@*/ /*@observer@*/ uentry sname;
68 /*@only@*/ exprNodeList args;
69 /*@only@*/ exprNode body;
70 /*@dependent@*/ /*@observer@*/ uentry ename;
71} *exprIter;
72
73typedef struct _exprCall
74{
75 /*@only@*/ exprNode fcn;
76 /*@only@*/ exprNodeList args;
77} *exprCall;
78
79typedef struct _exprIterCall
80{
81 /*@dependent@*/ /*@exposed@*/ uentry iter;
82 /*@only@*/ exprNodeList args;
83} *exprIterCall;
84
85typedef struct _exprOp
86{
87 /*@only@*/ exprNode a;
88 /*@only@*/ exprNode b;
89 lltok op;
90} *exprOp;
91
92typedef struct _exprField
93{
94 /*@only@*/ exprNode rec;
95 /*@only@*/ cstring field;
96} *exprField;
97
98typedef struct _exprUop
99{
100 /*@only@*/ exprNode a;
101 lltok op;
102} *exprUop;
103
104typedef struct _exprCast
105{
106 /*@only@*/ exprNode exp;
107 lltok tok;
108 qtype q;
109} *exprCast;
110
111typedef struct _exprInit
112{
113 /*@only@*/ exprNode exp;
114 idDecl id;
115} *exprInit;
116
117typedef /*@null@*/ union _exprData
118{
119 cstring literal;
120 cstring id;
121 lltok *tok;
122 qtype qt; /* sizeof(type) */
123 /* use for any 2-operator (comma, arrayFetch, case, stmt) */
124 exprPair pair;
125 exprOp op; /* pair + operator */
126 exprUop uop;
127 exprInit init;
128 exprIter iter;
129 exprCall call;
130 exprIterCall itercall;
131 exprCast cast;
132 exprNode single;
133 exprField field;
134 exprTriple triple; /* ifelse, ternary op, for pred */
135 exprOffsetof offset;
136} *exprData;
137
138/*@constant null exprData exprData_undefined; @*/
139# define exprData_undefined ((exprData) NULL)
140
141struct _exprNode
142{
143 bool isJumpPoint BOOLBITS; /* expr can be reached non-sequentially */
144 bool canBreak BOOLBITS; /* expr can break (has break, continue) */
145 bool mustBreak BOOLBITS;
146
147 ctype typ;
148 exitkind exitCode;
149
150 multiVal val;
151 /*@exposed@*/ sRef sref;
152 sRefSet uses; /* sRef's used by this expression */
153 sRefSet sets; /* sRef's set by this expression */
154 sRefSet msets; /* sRef's possibly set (implicit out params, etc.) */
155
156 guardSet guards;
157 exprKind kind;
158
159 fileloc loc;
160 /*@relnull@*/ exprData edata;
161 cstring etext;
a0a162cd 162 environmentTable environment;
361091cc 163 constraintList requiresConstraints;
164 constraintList ensuresConstraints;
754746a0 165 //these two are used only for boolean expressions
166 //they store the ensures constraints for the true and false cases
167 constraintList trueEnsuresConstraints;
168 constraintList falseEnsuresConstraints;
885824d3 169} ;
170
171/*@constant null exprNode exprNode_undefined; @*/
172# define exprNode_undefined ((exprNode)NULL)
173
174extern /*@falsenull@*/ bool exprNode_isDefined (exprNode p_e) /*@*/ ;
175extern /*@unused@*/ /*@truenull@*/ bool exprNode_isUndefined (exprNode p_e) /*@*/ ;
176extern /*@truenull@*/ bool exprNode_isError (exprNode p_e) /*@*/ ;
177
178# define exprNode_isDefined(e) ((e) != exprNode_undefined)
179# define exprNode_isUndefined(e) ((e) == exprNode_undefined)
180# define exprNode_isError(e) ((e) == exprNode_undefined)
181
182extern /*@dependent@*/ /*@exposed@*/ guardSet
183 exprNode_getGuards (/*@sef@*/ exprNode p_e) /*@*/ ;
184# define exprNode_getGuards(e) \
185 (exprNode_isDefined(e) ? (e)->guards : guardSet_undefined)
186
187extern ctype exprNode_getType (/*@sef@*/ exprNode p_e) /*@*/ ;
188# define exprNode_getType(e) \
189 (exprNode_isDefined(e) ? (e)->typ : ctype_unknown)
190
191extern /*@unused@*/ /*@falsenull@*/ bool exprNode_isInParens (/*@sef@*/ exprNode p_e) /*@*/ ;
192# define exprNode_isInParens(e) \
193 (exprNode_isDefined(e) && (e)->kind == XPR_PARENS)
194
195extern bool exprNode_isStringLiteral (/*@sef@*/ exprNode p_e);
196# define exprNode_isStringLiteral(e) \
197 (exprNode_isDefined(e) && (e)->kind == XPR_STRINGLITERAL)
198
199extern /*@unused@*/ bool exprNode_knownIntValue (/*@sef@*/ exprNode p_e) /*@*/ ;
200# define exprNode_knownIntValue(e) \
201 (exprNode_isDefined(e) && multiVal_isInt (exprNode_getValue (e)))
202
203extern /*@unused@*/ bool exprNode_knownStringValue (/*@sef@*/ exprNode p_e) /*@*/ ;
204# define exprNode_knownStringValue(e) \
205 (exprNode_isDefined(e) && multiVal_isString (exprNode_getValue (e)))
206
207extern bool exprNode_hasValue (/*@sef@*/ exprNode p_e) /*@*/ ;
208# define exprNode_hasValue(e) \
209 (exprNode_isDefined(e) && multiVal_isDefined (exprNode_getValue (e)))
210
211extern /*@exposed@*/ multiVal exprNode_getValue (exprNode p_e) /*@*/ ;
a0a162cd 212extern long exprNode_getLongValue (exprNode p_e) /*@*/ ;
885824d3 213
214extern /*@observer@*/ cstring exprNode_unparseFirst (exprNode p_e) /*@*/ ;
215extern /*@observer@*/ guardSet exprNode_getForGuards (exprNode p_pred) /*@*/ ;
216extern bool exprNode_isNullValue (exprNode p_e) /*@*/ ;
217extern /*@exposed@*/ sRef exprNode_getSref (exprNode p_e) /*@*/ ;
218extern /*@observer@*/ uentry exprNode_getUentry (exprNode p_e)
219 /*@globals internalState@*/ ;
220extern void exprNode_produceGuards (exprNode p_pred) /*@modifies p_pred@*/ ;
221extern /*@observer@*/ fileloc exprNode_loc (exprNode p_e) /*@*/ ;
222extern exprNode
223 exprNode_charLiteral (char p_c, cstring p_text, /*@only@*/ fileloc p_loc) /*@*/ ;
224extern /*@observer@*/ exprNode exprNode_makeMustExit (void) /*@*/ ;
225extern exprNode
226 exprNode_cond (/*@keep@*/ exprNode p_pred, /*@keep@*/ exprNode p_ifclause,
227 /*@keep@*/ exprNode p_elseclause) /*@*/ ;
228extern exprNode exprNode_makeError(void) /*@*/ ;
229
230extern exprNode exprNode_makeInitBlock (lltok p_brace, /*@only@*/ exprNodeList p_inits) /*@*/ ;
231
232extern exprNode exprNode_functionCall (/*@only@*/ exprNode p_f,
233 /*@only@*/ exprNodeList p_args) /*@*/ ;
234extern /*@notnull@*/ exprNode
235 exprNode_fromIdentifier (/*@observer@*/ uentry p_c) /*@globals internalState@*/ ;
236extern exprNode exprNode_fromUIO (cstring p_c) /*@globals internalState@*/ ;
237extern exprNode exprNode_fieldAccess (/*@only@*/ exprNode p_s, /*@only@*/ cstring p_f) /*@*/ ;
238extern exprNode exprNode_arrowAccess (/*@only@*/ exprNode p_s, /*@only@*/ cstring p_f) /*@*/ ;
239extern exprNode exprNode_postOp (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_op)
240 /*@modifies p_e@*/ ;
241extern exprNode exprNode_preOp (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_op) /*@*/ ;
242extern exprNode exprNode_addParens (/*@only@*/ lltok p_lpar, /*@only@*/ exprNode p_e) /*@*/ ;
243extern exprNode exprNode_offsetof (/*@only@*/ qtype p_qt, /*@only@*/ cstringList p_s) /*@*/ ;
244extern exprNode exprNode_sizeofType (/*@only@*/ qtype p_qt) /*@*/ ;
245extern exprNode exprNode_sizeofExpr (/*@only@*/ exprNode p_e) /*@*/ ;
246extern exprNode exprNode_alignofType (/*@only@*/ qtype p_qt) /*@*/ ;
247extern exprNode exprNode_alignofExpr (/*@only@*/ exprNode p_e) /*@*/ ;
248extern exprNode
249 exprNode_op (/*@only@*/ exprNode p_e1, /*@keep@*/ exprNode p_e2, /*@only@*/ lltok p_op) /*@*/ ;
250extern exprNode
251 exprNode_assign (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2, /*@only@*/ lltok p_op) ;
252extern exprNode
253 exprNode_arrayFetch (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2)
254 /*@modifies p_e1, p_e2@*/ ;
255
256extern void exprNode_free (/*@only@*/ exprNode p_e) ;
257extern exprNode
258 exprNode_vaArg (/*@only@*/ lltok p_tok, /*@only@*/ exprNode p_arg, /*@only@*/ qtype p_qt)
259 /*@globals internalState@*/ ;
260
261extern exprNode
262 exprNode_stringLiteral (/*@only@*/ cstring p_t, /*@only@*/ fileloc p_loc) /*@*/ ;
263extern exprNode exprNode_comma (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2) /*@*/ ;
264extern exprNode exprNode_labelMarker (/*@only@*/ cstring p_label);
265extern exprNode
266 exprNode_notReached (/*@returned@*/ exprNode p_stmt);
267
268extern
269exprNode exprNode_caseMarker (/*@only@*/ exprNode p_test, bool p_fallThrough) /*@*/ ;
270
271extern exprNode exprNode_concat (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2);
272extern exprNode exprNode_createTok (/*@only@*/ lltok p_t) /*@*/ ;
4cccc6ad 273extern exprNode exprNode_statement (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_t);
885824d3 274extern exprNode exprNode_makeBlock (/*@only@*/ exprNode p_e);
275extern exprNode exprNode_if (/*@only@*/ exprNode p_pred, /*@only@*/ exprNode p_tclause);
276extern exprNode
277 exprNode_ifelse (/*@only@*/ exprNode p_pred, /*@only@*/ exprNode p_tclause,
278 /*@only@*/ exprNode p_eclause);
279extern exprNode exprNode_switch (/*@only@*/ exprNode p_e, /*@only@*/ exprNode p_s);
280extern exprNode exprNode_while (/*@keep@*/ exprNode p_t, /*@keep@*/ exprNode p_b);
281extern exprNode exprNode_doWhile (/*@only@*/ exprNode p_b, /*@only@*/ exprNode p_t);
282extern /*@notnull@*/ /*@only@*/ exprNode exprNode_goto (/*@only@*/ cstring p_label);
283extern exprNode exprNode_continue (/*@only@*/ lltok p_l, int p_qcontinue);
284extern exprNode exprNode_break (/*@only@*/ lltok p_l, int p_bqual);
285extern exprNode exprNode_nullReturn (/*@only@*/ lltok p_t);
286extern exprNode exprNode_return (/*@only@*/ exprNode p_e);
287extern /*@dependent@*/ /*@observer@*/ cstring
288 exprNode_unparse (exprNode p_e) /*@*/ ;
289
290extern bool exprNode_isCharLit (exprNode p_e) /*@*/ ;
291extern bool exprNode_isNumLit (exprNode p_e) /*@*/ ;
292
293extern exprNode
294 exprNode_makeInitialization (/*@only@*/ idDecl p_t, /*@only@*/ exprNode p_e);
295extern bool exprNode_matchType (ctype p_expected, exprNode p_e);
296
297extern /*@notnull@*/ /*@only@*/ exprNode
298 exprNode_defaultMarker (/*@only@*/ lltok p_def, bool p_fallThrough);
299
300extern exprNode
301 exprNode_iter (/*@observer@*/ uentry p_name, /*@only@*/ exprNodeList p_alist,
302 /*@only@*/ exprNode p_body, /*@observer@*/ uentry p_end);
303extern exprNode exprNode_iterId (/*@observer@*/ uentry p_c);
304extern exprNode exprNode_iterExpr (/*@returned@*/ exprNode p_e);
305extern exprNode exprNode_iterNewId (/*@only@*/ cstring p_s);
306extern exprNode
307 exprNode_iterStart (/*@observer@*/ uentry p_name, /*@only@*/ exprNodeList p_alist);
308extern exprNode
309 exprNode_numLiteral (ctype p_c, /*@temp@*/ cstring p_t,
310 /*@only@*/ fileloc p_loc, long p_val);
311extern void exprNode_initMod (void) /*@modifies internalState@*/ ;
312extern exprNode exprNode_for (/*@keep@*/ exprNode p_inc, /*@keep@*/ exprNode p_body);
313extern exprNode
314 exprNode_forPred (/*@only@*/ exprNode p_init,
315 /*@only@*/ exprNode p_test, /*@only@*/ exprNode p_inc);
316extern exprNode
317 exprNode_floatLiteral (double p_d, ctype p_ct,
318 cstring p_text, /*@only@*/ fileloc p_loc);
319extern /*@notnull@*/ exprNode exprNode_createId (/*@observer@*/ uentry p_c);
320extern exprNode exprNode_cast (/*@only@*/ lltok p_tok, /*@only@*/ exprNode p_e, /*@only@*/ qtype p_q);
321extern bool exprNode_matchLiteral (ctype p_expected, exprNode p_e);
322extern void exprNode_checkUseParam (exprNode p_current);
323extern void exprNode_checkSet (exprNode p_e, sRef p_s);
324extern void exprNode_checkMSet (exprNode p_e, sRef p_s);
325extern exprNode exprNode_checkExpr (/*@returned@*/ exprNode p_e);
326extern bool exprNode_mustEscape (exprNode p_e);
327extern bool exprNode_errorEscape (exprNode p_e);
328extern bool exprNode_mayEscape (exprNode p_e);
329extern exprNode exprNode_whilePred (/*@only@*/ exprNode p_test);
330extern exprNode
331 exprNode_updateLocation (/*@returned@*/ exprNode p_e, /*@temp@*/ fileloc p_loc);
332extern void exprNode_freeShallow (/*@only@*/ exprNode p_e);
333extern void exprNode_destroyMod (void) /*@modifies internalState@*/ ;
334extern bool exprNode_isAssign (exprNode p_e) /*@*/ ;
335
4cccc6ad 336/* added 8-15-00
337 by DRL */
338extern fileloc exprNode_getfileloc (exprNode p_e) ;
339
885824d3 340/*@-exportlocal@*/
341extern bool exprNode_isDefaultMarker (exprNode p_e) /*@*/ ;
342extern bool exprNode_isCaseMarker (exprNode p_e) /*@*/ ;
343extern bool exprNode_isLabelMarker (exprNode p_e) /*@*/ ;
344/*@=exportlocal@*/
345
4cccc6ad 346/* evs 2000-08-22 */
347fileloc exprNode_getNextSequencePoint (exprNode p_e) /*@*/ ;
348
349/*drl 09-08-2008 */
350exprNode exprNode_fakeCopy (exprNode e);
885824d3 351# else
352# error "Multiple include"
353# endif
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
This page took 0.103453 seconds and 5 git commands to generate.