]> andersk Git - splint.git/blame - src/Headers/exprNode.h
Fixed but with parenthesized pointer declarations.
[splint.git] / src / Headers / exprNode.h
CommitLineData
885824d3 1/*
28bf4b0b 2** Copyright (C) University of Virginia, Massachusetts Institue of Technology 1994-2001.
885824d3 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
28bf4b0b 46typedef struct
885824d3 47{
48 /*@only@*/ qtype q;
49 /*@only@*/ cstringList field;
50} *exprOffsetof;
51
28bf4b0b 52typedef struct
885824d3 53{
54 /*@only@*/ exprNode a;
55 /*@only@*/ exprNode b;
56} *exprPair;
57
28bf4b0b 58typedef struct
885824d3 59{
60 /*@only@*/ exprNode pred;
61 /*@only@*/ exprNode tbranch;
62 /*@only@*/ exprNode fbranch;
63} *exprTriple;
64
28bf4b0b 65typedef struct
885824d3 66{
67 /*@dependent@*/ /*@observer@*/ uentry sname;
68 /*@only@*/ exprNodeList args;
69 /*@only@*/ exprNode body;
70 /*@dependent@*/ /*@observer@*/ uentry ename;
71} *exprIter;
72
28bf4b0b 73typedef struct
885824d3 74{
75 /*@only@*/ exprNode fcn;
76 /*@only@*/ exprNodeList args;
77} *exprCall;
78
28bf4b0b 79typedef struct
885824d3 80{
81 /*@dependent@*/ /*@exposed@*/ uentry iter;
82 /*@only@*/ exprNodeList args;
83} *exprIterCall;
84
28bf4b0b 85typedef struct
885824d3 86{
87 /*@only@*/ exprNode a;
88 /*@only@*/ exprNode b;
89 lltok op;
90} *exprOp;
91
28bf4b0b 92typedef struct
885824d3 93{
94 /*@only@*/ exprNode rec;
95 /*@only@*/ cstring field;
96} *exprField;
97
28bf4b0b 98typedef struct
885824d3 99{
100 /*@only@*/ exprNode a;
101 lltok op;
102} *exprUop;
103
28bf4b0b 104typedef struct
885824d3 105{
106 /*@only@*/ exprNode exp;
107 lltok tok;
108 qtype q;
109} *exprCast;
110
28bf4b0b 111typedef struct
885824d3 112{
113 /*@only@*/ exprNode exp;
114 idDecl id;
115} *exprInit;
116
28bf4b0b 117typedef /*@null@*/ union
885824d3 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
28bf4b0b 141struct s_exprNode
885824d3 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;
b7b694d6 164
165 /*
166 ** These two are used only for boolean expressions,
167 ** they store the ensures constraints for the true and false cases
168 */
169
bb25bea6 170 /*@notnull@*/ constraintList trueEnsuresConstraints;
171 /*@notnull@*/ constraintList falseEnsuresConstraints;
885824d3 172} ;
173
174/*@constant null exprNode exprNode_undefined; @*/
175# define exprNode_undefined ((exprNode)NULL)
176
0e41eb0e 177extern /*@falsewhennull@*/ bool exprNode_isDefined (exprNode p_e) /*@*/ ;
178extern /*@unused@*/ /*@nullwhentrue@*/ bool exprNode_isUndefined (exprNode p_e) /*@*/ ;
179extern /*@nullwhentrue@*/ bool exprNode_isError (exprNode p_e) /*@*/ ;
885824d3 180
181# define exprNode_isDefined(e) ((e) != exprNode_undefined)
182# define exprNode_isUndefined(e) ((e) == exprNode_undefined)
183# define exprNode_isError(e) ((e) == exprNode_undefined)
184
185extern /*@dependent@*/ /*@exposed@*/ guardSet
186 exprNode_getGuards (/*@sef@*/ exprNode p_e) /*@*/ ;
187# define exprNode_getGuards(e) \
188 (exprNode_isDefined(e) ? (e)->guards : guardSet_undefined)
189
190extern ctype exprNode_getType (/*@sef@*/ exprNode p_e) /*@*/ ;
191# define exprNode_getType(e) \
192 (exprNode_isDefined(e) ? (e)->typ : ctype_unknown)
193
0e41eb0e 194extern /*@unused@*/ /*@falsewhennull@*/ bool exprNode_isInParens (/*@sef@*/ exprNode p_e) /*@*/ ;
885824d3 195# define exprNode_isInParens(e) \
196 (exprNode_isDefined(e) && (e)->kind == XPR_PARENS)
197
28bf4b0b 198extern bool exprNode_isStringLiteral (/*@sef@*/ exprNode p_e) /*@*/ ;
885824d3 199# define exprNode_isStringLiteral(e) \
200 (exprNode_isDefined(e) && (e)->kind == XPR_STRINGLITERAL)
201
202extern /*@unused@*/ bool exprNode_knownIntValue (/*@sef@*/ exprNode p_e) /*@*/ ;
203# define exprNode_knownIntValue(e) \
204 (exprNode_isDefined(e) && multiVal_isInt (exprNode_getValue (e)))
205
206extern /*@unused@*/ bool exprNode_knownStringValue (/*@sef@*/ exprNode p_e) /*@*/ ;
207# define exprNode_knownStringValue(e) \
208 (exprNode_isDefined(e) && multiVal_isString (exprNode_getValue (e)))
209
210extern bool exprNode_hasValue (/*@sef@*/ exprNode p_e) /*@*/ ;
211# define exprNode_hasValue(e) \
212 (exprNode_isDefined(e) && multiVal_isDefined (exprNode_getValue (e)))
213
214extern /*@exposed@*/ multiVal exprNode_getValue (exprNode p_e) /*@*/ ;
a0a162cd 215extern long exprNode_getLongValue (exprNode p_e) /*@*/ ;
885824d3 216
217extern /*@observer@*/ cstring exprNode_unparseFirst (exprNode p_e) /*@*/ ;
218extern /*@observer@*/ guardSet exprNode_getForGuards (exprNode p_pred) /*@*/ ;
3e3ec469 219extern bool exprNode_loopMustExec (exprNode p_forPred) /*@*/ ;
220
885824d3 221extern bool exprNode_isNullValue (exprNode p_e) /*@*/ ;
222extern /*@exposed@*/ sRef exprNode_getSref (exprNode p_e) /*@*/ ;
e83c79ec 223extern /*@exposed@*/ uentry exprNode_getUentry (exprNode p_e)
885824d3 224 /*@globals internalState@*/ ;
225extern void exprNode_produceGuards (exprNode p_pred) /*@modifies p_pred@*/ ;
6970c11b 226
885824d3 227extern /*@observer@*/ fileloc exprNode_loc (exprNode p_e) /*@*/ ;
6970c11b 228extern /*@observer@*/ fileloc exprNode_getLoc (exprNode p_e) /*@*/ ;
229# define exprNode_getLoc exprNode_loc
230
885824d3 231extern exprNode
232 exprNode_charLiteral (char p_c, cstring p_text, /*@only@*/ fileloc p_loc) /*@*/ ;
233extern /*@observer@*/ exprNode exprNode_makeMustExit (void) /*@*/ ;
234extern exprNode
235 exprNode_cond (/*@keep@*/ exprNode p_pred, /*@keep@*/ exprNode p_ifclause,
236 /*@keep@*/ exprNode p_elseclause) /*@*/ ;
237extern exprNode exprNode_makeError(void) /*@*/ ;
238
239extern exprNode exprNode_makeInitBlock (lltok p_brace, /*@only@*/ exprNodeList p_inits) /*@*/ ;
240
241extern exprNode exprNode_functionCall (/*@only@*/ exprNode p_f,
242 /*@only@*/ exprNodeList p_args) /*@*/ ;
243extern /*@notnull@*/ exprNode
244 exprNode_fromIdentifier (/*@observer@*/ uentry p_c) /*@globals internalState@*/ ;
245extern exprNode exprNode_fromUIO (cstring p_c) /*@globals internalState@*/ ;
28bf4b0b 246extern exprNode exprNode_fieldAccess (/*@only@*/ exprNode p_s,
247 /*@only@*/ lltok p_dot,
248 /*@only@*/ cstring p_f) /*@*/ ;
249
250extern exprNode exprNode_arrowAccess (/*@only@*/ exprNode p_s,
251 /*@only@*/ lltok p_arrow,
252 /*@only@*/ cstring p_f) /*@*/ ;
253
885824d3 254extern exprNode exprNode_postOp (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_op)
255 /*@modifies p_e@*/ ;
256extern exprNode exprNode_preOp (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_op) /*@*/ ;
257extern exprNode exprNode_addParens (/*@only@*/ lltok p_lpar, /*@only@*/ exprNode p_e) /*@*/ ;
258extern exprNode exprNode_offsetof (/*@only@*/ qtype p_qt, /*@only@*/ cstringList p_s) /*@*/ ;
259extern exprNode exprNode_sizeofType (/*@only@*/ qtype p_qt) /*@*/ ;
260extern exprNode exprNode_sizeofExpr (/*@only@*/ exprNode p_e) /*@*/ ;
261extern exprNode exprNode_alignofType (/*@only@*/ qtype p_qt) /*@*/ ;
262extern exprNode exprNode_alignofExpr (/*@only@*/ exprNode p_e) /*@*/ ;
263extern exprNode
264 exprNode_op (/*@only@*/ exprNode p_e1, /*@keep@*/ exprNode p_e2, /*@only@*/ lltok p_op) /*@*/ ;
265extern exprNode
266 exprNode_assign (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2, /*@only@*/ lltok p_op) ;
267extern exprNode
268 exprNode_arrayFetch (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2)
269 /*@modifies p_e1, p_e2@*/ ;
270
271extern void exprNode_free (/*@only@*/ exprNode p_e) ;
272extern exprNode
273 exprNode_vaArg (/*@only@*/ lltok p_tok, /*@only@*/ exprNode p_arg, /*@only@*/ qtype p_qt)
274 /*@globals internalState@*/ ;
275
28bf4b0b 276/*
277** Has surrounding quotes.
278*/
279
885824d3 280extern exprNode
281 exprNode_stringLiteral (/*@only@*/ cstring p_t, /*@only@*/ fileloc p_loc) /*@*/ ;
28bf4b0b 282
e0b363ad 283extern /*@only@*/ exprNode
284 exprNode_wideStringLiteral (/*@only@*/ cstring p_t, /*@only@*/ fileloc p_loc) /*@*/ ;
285
28bf4b0b 286/*
287** No surrounding quotes.
288*/
289
290extern exprNode
291 exprNode_rawStringLiteral (/*@only@*/ cstring p_t, /*@only@*/ fileloc p_loc) /*@*/ ;
292
885824d3 293extern exprNode exprNode_comma (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2) /*@*/ ;
294extern exprNode exprNode_labelMarker (/*@only@*/ cstring p_label);
295extern exprNode
296 exprNode_notReached (/*@returned@*/ exprNode p_stmt);
297
298extern
299exprNode exprNode_caseMarker (/*@only@*/ exprNode p_test, bool p_fallThrough) /*@*/ ;
300
301extern exprNode exprNode_concat (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2);
302extern exprNode exprNode_createTok (/*@only@*/ lltok p_t) /*@*/ ;
4cccc6ad 303extern exprNode exprNode_statement (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_t);
885824d3 304extern exprNode exprNode_makeBlock (/*@only@*/ exprNode p_e);
2e127cb8 305
306extern void exprNode_checkIfPred (exprNode p_pred) /*@modifies g_msgstream@*/ ;
307
885824d3 308extern exprNode exprNode_if (/*@only@*/ exprNode p_pred, /*@only@*/ exprNode p_tclause);
309extern exprNode
310 exprNode_ifelse (/*@only@*/ exprNode p_pred, /*@only@*/ exprNode p_tclause,
311 /*@only@*/ exprNode p_eclause);
312extern exprNode exprNode_switch (/*@only@*/ exprNode p_e, /*@only@*/ exprNode p_s);
313extern exprNode exprNode_while (/*@keep@*/ exprNode p_t, /*@keep@*/ exprNode p_b);
314extern exprNode exprNode_doWhile (/*@only@*/ exprNode p_b, /*@only@*/ exprNode p_t);
315extern /*@notnull@*/ /*@only@*/ exprNode exprNode_goto (/*@only@*/ cstring p_label);
316extern exprNode exprNode_continue (/*@only@*/ lltok p_l, int p_qcontinue);
317extern exprNode exprNode_break (/*@only@*/ lltok p_l, int p_bqual);
318extern exprNode exprNode_nullReturn (/*@only@*/ lltok p_t);
319extern exprNode exprNode_return (/*@only@*/ exprNode p_e);
320extern /*@dependent@*/ /*@observer@*/ cstring
28bf4b0b 321exprNode_unparse (/*@temp@*/ exprNode p_e) /*@*/ ;
885824d3 322
323extern bool exprNode_isCharLit (exprNode p_e) /*@*/ ;
324extern bool exprNode_isNumLit (exprNode p_e) /*@*/ ;
325
326extern exprNode
327 exprNode_makeInitialization (/*@only@*/ idDecl p_t, /*@only@*/ exprNode p_e);
28bf4b0b 328
329exprNode exprNode_makeEmptyInitialization (/*@only@*/ idDecl p_t) ;
330
331extern bool exprNode_isInitializer (exprNode p_e) /*@*/ ;
332
885824d3 333extern bool exprNode_matchType (ctype p_expected, exprNode p_e);
334
335extern /*@notnull@*/ /*@only@*/ exprNode
336 exprNode_defaultMarker (/*@only@*/ lltok p_def, bool p_fallThrough);
337
338extern exprNode
339 exprNode_iter (/*@observer@*/ uentry p_name, /*@only@*/ exprNodeList p_alist,
340 /*@only@*/ exprNode p_body, /*@observer@*/ uentry p_end);
341extern exprNode exprNode_iterId (/*@observer@*/ uentry p_c);
342extern exprNode exprNode_iterExpr (/*@returned@*/ exprNode p_e);
343extern exprNode exprNode_iterNewId (/*@only@*/ cstring p_s);
344extern exprNode
345 exprNode_iterStart (/*@observer@*/ uentry p_name, /*@only@*/ exprNodeList p_alist);
346extern exprNode
347 exprNode_numLiteral (ctype p_c, /*@temp@*/ cstring p_t,
348 /*@only@*/ fileloc p_loc, long p_val);
349extern void exprNode_initMod (void) /*@modifies internalState@*/ ;
350extern exprNode exprNode_for (/*@keep@*/ exprNode p_inc, /*@keep@*/ exprNode p_body);
351extern exprNode
352 exprNode_forPred (/*@only@*/ exprNode p_init,
353 /*@only@*/ exprNode p_test, /*@only@*/ exprNode p_inc);
354extern exprNode
355 exprNode_floatLiteral (double p_d, ctype p_ct,
356 cstring p_text, /*@only@*/ fileloc p_loc);
357extern /*@notnull@*/ exprNode exprNode_createId (/*@observer@*/ uentry p_c);
5c2f3045 358extern /*@notnull@*/ exprNode exprNode_makeConstantString (/*@temp@*/ cstring p_c, /*@only@*/ fileloc p_loc) /*@*/ ;
885824d3 359extern exprNode exprNode_cast (/*@only@*/ lltok p_tok, /*@only@*/ exprNode p_e, /*@only@*/ qtype p_q);
360extern bool exprNode_matchLiteral (ctype p_expected, exprNode p_e);
361extern void exprNode_checkUseParam (exprNode p_current);
28bf4b0b 362extern void exprNode_checkSet (exprNode p_e, /*@exposed@*/ sRef p_s);
363extern void exprNode_checkMSet (exprNode p_e, /*@exposed@*/ sRef p_s);
885824d3 364extern exprNode exprNode_checkExpr (/*@returned@*/ exprNode p_e);
365extern bool exprNode_mustEscape (exprNode p_e);
366extern bool exprNode_errorEscape (exprNode p_e);
367extern bool exprNode_mayEscape (exprNode p_e);
368extern exprNode exprNode_whilePred (/*@only@*/ exprNode p_test);
369extern exprNode
370 exprNode_updateLocation (/*@returned@*/ exprNode p_e, /*@temp@*/ fileloc p_loc);
371extern void exprNode_freeShallow (/*@only@*/ exprNode p_e);
372extern void exprNode_destroyMod (void) /*@modifies internalState@*/ ;
373extern bool exprNode_isAssign (exprNode p_e) /*@*/ ;
374
4cccc6ad 375/* added 8-15-00
376 by DRL */
d46ce6a4 377extern /*@observer@*/ fileloc exprNode_getfileloc (exprNode p_e) ;
4cccc6ad 378
885824d3 379/*@-exportlocal@*/
380extern bool exprNode_isDefaultMarker (exprNode p_e) /*@*/ ;
381extern bool exprNode_isCaseMarker (exprNode p_e) /*@*/ ;
382extern bool exprNode_isLabelMarker (exprNode p_e) /*@*/ ;
383/*@=exportlocal@*/
384
28bf4b0b 385extern /*@only@*/ exprNode exprNode_combineLiterals (/*@only@*/ exprNode p_e, /*@only@*/ exprNode p_rest) ;
386
387extern /*@only@*/ fileloc exprNode_getNextSequencePoint (exprNode p_e) ;
4cccc6ad 388
103db890 389/*drl 01-20-2001*/
28bf4b0b 390exprNode exprNode_createNew(ctype p_c);
391
d30bc0c7 392/* drl 07-25-01 */
d30bc0c7 393bool exprNode_isInitBlock (exprNode p_e);
394
885824d3 395# else
396# error "Multiple include"
397# endif
This page took 0.304947 seconds and 5 git commands to generate.