]> andersk Git - splint.git/blame - src/Headers/exprNode.h
andersk / splint.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Updating to use the LEnsures and LRequires instead of the ensures requires so
[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;
bb25bea6 162 /*@notnull@*/ constraintList requiresConstraints;
163 /*@notnull@*/ constraintList ensuresConstraints;
754746a0 164 //these two are used only for boolean expressions
165 //they store the ensures constraints for the true and false cases
bb25bea6 166 /*@notnull@*/ constraintList trueEnsuresConstraints;
167 /*@notnull@*/ constraintList falseEnsuresConstraints;
885824d3 168} ;
169
170/*@constant null exprNode exprNode_undefined; @*/
171# define exprNode_undefined ((exprNode)NULL)
172
173extern /*@falsenull@*/ bool exprNode_isDefined (exprNode p_e) /*@*/ ;
174extern /*@unused@*/ /*@truenull@*/ bool exprNode_isUndefined (exprNode p_e) /*@*/ ;
175extern /*@truenull@*/ bool exprNode_isError (exprNode p_e) /*@*/ ;
176
177# define exprNode_isDefined(e) ((e) != exprNode_undefined)
178# define exprNode_isUndefined(e) ((e) == exprNode_undefined)
179# define exprNode_isError(e) ((e) == exprNode_undefined)
180
181extern /*@dependent@*/ /*@exposed@*/ guardSet
182 exprNode_getGuards (/*@sef@*/ exprNode p_e) /*@*/ ;
183# define exprNode_getGuards(e) \
184 (exprNode_isDefined(e) ? (e)->guards : guardSet_undefined)
185
186extern ctype exprNode_getType (/*@sef@*/ exprNode p_e) /*@*/ ;
187# define exprNode_getType(e) \
188 (exprNode_isDefined(e) ? (e)->typ : ctype_unknown)
189
190extern /*@unused@*/ /*@falsenull@*/ bool exprNode_isInParens (/*@sef@*/ exprNode p_e) /*@*/ ;
191# define exprNode_isInParens(e) \
192 (exprNode_isDefined(e) && (e)->kind == XPR_PARENS)
193
194extern bool exprNode_isStringLiteral (/*@sef@*/ exprNode p_e);
195# define exprNode_isStringLiteral(e) \
196 (exprNode_isDefined(e) && (e)->kind == XPR_STRINGLITERAL)
197
198extern /*@unused@*/ bool exprNode_knownIntValue (/*@sef@*/ exprNode p_e) /*@*/ ;
199# define exprNode_knownIntValue(e) \
200 (exprNode_isDefined(e) && multiVal_isInt (exprNode_getValue (e)))
201
202extern /*@unused@*/ bool exprNode_knownStringValue (/*@sef@*/ exprNode p_e) /*@*/ ;
203# define exprNode_knownStringValue(e) \
204 (exprNode_isDefined(e) && multiVal_isString (exprNode_getValue (e)))
205
206extern bool exprNode_hasValue (/*@sef@*/ exprNode p_e) /*@*/ ;
207# define exprNode_hasValue(e) \
208 (exprNode_isDefined(e) && multiVal_isDefined (exprNode_getValue (e)))
209
210extern /*@exposed@*/ multiVal exprNode_getValue (exprNode p_e) /*@*/ ;
a0a162cd 211extern long exprNode_getLongValue (exprNode p_e) /*@*/ ;
885824d3 212
213extern /*@observer@*/ cstring exprNode_unparseFirst (exprNode p_e) /*@*/ ;
214extern /*@observer@*/ guardSet exprNode_getForGuards (exprNode p_pred) /*@*/ ;
215extern bool exprNode_isNullValue (exprNode p_e) /*@*/ ;
216extern /*@exposed@*/ sRef exprNode_getSref (exprNode p_e) /*@*/ ;
217extern /*@observer@*/ uentry exprNode_getUentry (exprNode p_e)
218 /*@globals internalState@*/ ;
219extern void exprNode_produceGuards (exprNode p_pred) /*@modifies p_pred@*/ ;
220extern /*@observer@*/ fileloc exprNode_loc (exprNode p_e) /*@*/ ;
221extern exprNode
222 exprNode_charLiteral (char p_c, cstring p_text, /*@only@*/ fileloc p_loc) /*@*/ ;
223extern /*@observer@*/ exprNode exprNode_makeMustExit (void) /*@*/ ;
224extern exprNode
225 exprNode_cond (/*@keep@*/ exprNode p_pred, /*@keep@*/ exprNode p_ifclause,
226 /*@keep@*/ exprNode p_elseclause) /*@*/ ;
227extern exprNode exprNode_makeError(void) /*@*/ ;
228
229extern exprNode exprNode_makeInitBlock (lltok p_brace, /*@only@*/ exprNodeList p_inits) /*@*/ ;
230
231extern exprNode exprNode_functionCall (/*@only@*/ exprNode p_f,
232 /*@only@*/ exprNodeList p_args) /*@*/ ;
233extern /*@notnull@*/ exprNode
234 exprNode_fromIdentifier (/*@observer@*/ uentry p_c) /*@globals internalState@*/ ;
235extern exprNode exprNode_fromUIO (cstring p_c) /*@globals internalState@*/ ;
236extern exprNode exprNode_fieldAccess (/*@only@*/ exprNode p_s, /*@only@*/ cstring p_f) /*@*/ ;
237extern exprNode exprNode_arrowAccess (/*@only@*/ exprNode p_s, /*@only@*/ cstring p_f) /*@*/ ;
238extern exprNode exprNode_postOp (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_op)
239 /*@modifies p_e@*/ ;
240extern exprNode exprNode_preOp (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_op) /*@*/ ;
241extern exprNode exprNode_addParens (/*@only@*/ lltok p_lpar, /*@only@*/ exprNode p_e) /*@*/ ;
242extern exprNode exprNode_offsetof (/*@only@*/ qtype p_qt, /*@only@*/ cstringList p_s) /*@*/ ;
243extern exprNode exprNode_sizeofType (/*@only@*/ qtype p_qt) /*@*/ ;
244extern exprNode exprNode_sizeofExpr (/*@only@*/ exprNode p_e) /*@*/ ;
245extern exprNode exprNode_alignofType (/*@only@*/ qtype p_qt) /*@*/ ;
246extern exprNode exprNode_alignofExpr (/*@only@*/ exprNode p_e) /*@*/ ;
247extern exprNode
248 exprNode_op (/*@only@*/ exprNode p_e1, /*@keep@*/ exprNode p_e2, /*@only@*/ lltok p_op) /*@*/ ;
249extern exprNode
250 exprNode_assign (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2, /*@only@*/ lltok p_op) ;
251extern exprNode
252 exprNode_arrayFetch (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2)
253 /*@modifies p_e1, p_e2@*/ ;
254
255extern void exprNode_free (/*@only@*/ exprNode p_e) ;
256extern exprNode
257 exprNode_vaArg (/*@only@*/ lltok p_tok, /*@only@*/ exprNode p_arg, /*@only@*/ qtype p_qt)
258 /*@globals internalState@*/ ;
259
260extern exprNode
261 exprNode_stringLiteral (/*@only@*/ cstring p_t, /*@only@*/ fileloc p_loc) /*@*/ ;
262extern exprNode exprNode_comma (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2) /*@*/ ;
263extern exprNode exprNode_labelMarker (/*@only@*/ cstring p_label);
264extern exprNode
265 exprNode_notReached (/*@returned@*/ exprNode p_stmt);
266
267extern
268exprNode exprNode_caseMarker (/*@only@*/ exprNode p_test, bool p_fallThrough) /*@*/ ;
269
270extern exprNode exprNode_concat (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2);
271extern exprNode exprNode_createTok (/*@only@*/ lltok p_t) /*@*/ ;
4cccc6ad 272extern exprNode exprNode_statement (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_t);
885824d3 273extern exprNode exprNode_makeBlock (/*@only@*/ exprNode p_e);
274extern exprNode exprNode_if (/*@only@*/ exprNode p_pred, /*@only@*/ exprNode p_tclause);
275extern exprNode
276 exprNode_ifelse (/*@only@*/ exprNode p_pred, /*@only@*/ exprNode p_tclause,
277 /*@only@*/ exprNode p_eclause);
278extern exprNode exprNode_switch (/*@only@*/ exprNode p_e, /*@only@*/ exprNode p_s);
279extern exprNode exprNode_while (/*@keep@*/ exprNode p_t, /*@keep@*/ exprNode p_b);
280extern exprNode exprNode_doWhile (/*@only@*/ exprNode p_b, /*@only@*/ exprNode p_t);
281extern /*@notnull@*/ /*@only@*/ exprNode exprNode_goto (/*@only@*/ cstring p_label);
282extern exprNode exprNode_continue (/*@only@*/ lltok p_l, int p_qcontinue);
283extern exprNode exprNode_break (/*@only@*/ lltok p_l, int p_bqual);
284extern exprNode exprNode_nullReturn (/*@only@*/ lltok p_t);
285extern exprNode exprNode_return (/*@only@*/ exprNode p_e);
286extern /*@dependent@*/ /*@observer@*/ cstring
287 exprNode_unparse (exprNode p_e) /*@*/ ;
288
289extern bool exprNode_isCharLit (exprNode p_e) /*@*/ ;
290extern bool exprNode_isNumLit (exprNode p_e) /*@*/ ;
291
292extern exprNode
293 exprNode_makeInitialization (/*@only@*/ idDecl p_t, /*@only@*/ exprNode p_e);
294extern bool exprNode_matchType (ctype p_expected, exprNode p_e);
295
296extern /*@notnull@*/ /*@only@*/ exprNode
297 exprNode_defaultMarker (/*@only@*/ lltok p_def, bool p_fallThrough);
298
299extern exprNode
300 exprNode_iter (/*@observer@*/ uentry p_name, /*@only@*/ exprNodeList p_alist,
301 /*@only@*/ exprNode p_body, /*@observer@*/ uentry p_end);
302extern exprNode exprNode_iterId (/*@observer@*/ uentry p_c);
303extern exprNode exprNode_iterExpr (/*@returned@*/ exprNode p_e);
304extern exprNode exprNode_iterNewId (/*@only@*/ cstring p_s);
305extern exprNode
306 exprNode_iterStart (/*@observer@*/ uentry p_name, /*@only@*/ exprNodeList p_alist);
307extern exprNode
308 exprNode_numLiteral (ctype p_c, /*@temp@*/ cstring p_t,
309 /*@only@*/ fileloc p_loc, long p_val);
310extern void exprNode_initMod (void) /*@modifies internalState@*/ ;
311extern exprNode exprNode_for (/*@keep@*/ exprNode p_inc, /*@keep@*/ exprNode p_body);
312extern exprNode
313 exprNode_forPred (/*@only@*/ exprNode p_init,
314 /*@only@*/ exprNode p_test, /*@only@*/ exprNode p_inc);
315extern exprNode
316 exprNode_floatLiteral (double p_d, ctype p_ct,
317 cstring p_text, /*@only@*/ fileloc p_loc);
318extern /*@notnull@*/ exprNode exprNode_createId (/*@observer@*/ uentry p_c);
319extern exprNode exprNode_cast (/*@only@*/ lltok p_tok, /*@only@*/ exprNode p_e, /*@only@*/ qtype p_q);
320extern bool exprNode_matchLiteral (ctype p_expected, exprNode p_e);
321extern void exprNode_checkUseParam (exprNode p_current);
322extern void exprNode_checkSet (exprNode p_e, sRef p_s);
323extern void exprNode_checkMSet (exprNode p_e, sRef p_s);
324extern exprNode exprNode_checkExpr (/*@returned@*/ exprNode p_e);
325extern bool exprNode_mustEscape (exprNode p_e);
326extern bool exprNode_errorEscape (exprNode p_e);
327extern bool exprNode_mayEscape (exprNode p_e);
328extern exprNode exprNode_whilePred (/*@only@*/ exprNode p_test);
329extern exprNode
330 exprNode_updateLocation (/*@returned@*/ exprNode p_e, /*@temp@*/ fileloc p_loc);
331extern void exprNode_freeShallow (/*@only@*/ exprNode p_e);
332extern void exprNode_destroyMod (void) /*@modifies internalState@*/ ;
333extern bool exprNode_isAssign (exprNode p_e) /*@*/ ;
334
4cccc6ad 335/* added 8-15-00
336 by DRL */
d46ce6a4 337extern /*@observer@*/ fileloc exprNode_getfileloc (exprNode p_e) ;
4cccc6ad 338
885824d3 339/*@-exportlocal@*/
340extern bool exprNode_isDefaultMarker (exprNode p_e) /*@*/ ;
341extern bool exprNode_isCaseMarker (exprNode p_e) /*@*/ ;
342extern bool exprNode_isLabelMarker (exprNode p_e) /*@*/ ;
343/*@=exportlocal@*/
344
4cccc6ad 345/* evs 2000-08-22 */
346fileloc exprNode_getNextSequencePoint (exprNode p_e) /*@*/ ;
347
103db890 348/*drl 09-08-2000 */
d46ce6a4 349exprNode exprNode_fakeCopy (/*@returned@*/ exprNode e);
103db890 350/*drl 01-20-2001*/
351exprNode exprNode_createNew(ctype c);
885824d3 352# else
353# error "Multiple include"
354# endif
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
git-cvsimport mirror of splint
This page took 0.090749 seconds and 5 git commands to generate.