2 ** Copyright (C) University of Virginia, Massachusetts Institue of Technology 1994-2000.
3 ** See ../LICENSE for license information.
16 ** ctype typ --- type of expression
23 ** } *val --- value, if known. if unknown, val = (_val *)0
25 ** storeRef sref --- storage referred to by expression, of storeRef_null
27 ** cstring etext --- to get nice error messages, punt for now!
30 /* in exprNode_type: typedef struct _exprNode *exprNode; */
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
46 typedef struct _exprOffsetof
49 /*@only@*/ cstringList field;
52 typedef struct _exprPair
54 /*@only@*/ exprNode a;
55 /*@only@*/ exprNode b;
58 typedef struct _exprTriple
60 /*@only@*/ exprNode pred;
61 /*@only@*/ exprNode tbranch;
62 /*@only@*/ exprNode fbranch;
65 typedef struct _exprIter
67 /*@dependent@*/ /*@observer@*/ uentry sname;
68 /*@only@*/ exprNodeList args;
69 /*@only@*/ exprNode body;
70 /*@dependent@*/ /*@observer@*/ uentry ename;
73 typedef struct _exprCall
75 /*@only@*/ exprNode fcn;
76 /*@only@*/ exprNodeList args;
79 typedef struct _exprIterCall
81 /*@dependent@*/ /*@exposed@*/ uentry iter;
82 /*@only@*/ exprNodeList args;
85 typedef struct _exprOp
87 /*@only@*/ exprNode a;
88 /*@only@*/ exprNode b;
92 typedef struct _exprField
94 /*@only@*/ exprNode rec;
95 /*@only@*/ cstring field;
98 typedef struct _exprUop
100 /*@only@*/ exprNode a;
104 typedef struct _exprCast
106 /*@only@*/ exprNode exp;
111 typedef struct _exprInit
113 /*@only@*/ exprNode exp;
117 typedef /*@null@*/ union _exprData
122 qtype qt; /* sizeof(type) */
123 /* use for any 2-operator (comma, arrayFetch, case, stmt) */
125 exprOp op; /* pair + operator */
130 exprIterCall itercall;
134 exprTriple triple; /* ifelse, ternary op, for pred */
138 /*@constant null exprData exprData_undefined; @*/
139 # define exprData_undefined ((exprData) NULL)
143 bool isJumpPoint BOOLBITS; /* expr can be reached non-sequentially */
144 bool canBreak BOOLBITS; /* expr can break (has break, continue) */
145 bool mustBreak BOOLBITS;
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.) */
160 /*@relnull@*/ exprData edata;
162 environmentTable environment;
163 constraintList requiresConstraints;
164 constraintList ensuresConstraints;
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;
171 /*@constant null exprNode exprNode_undefined; @*/
172 # define exprNode_undefined ((exprNode)NULL)
174 extern /*@falsenull@*/ bool exprNode_isDefined (exprNode p_e) /*@*/ ;
175 extern /*@unused@*/ /*@truenull@*/ bool exprNode_isUndefined (exprNode p_e) /*@*/ ;
176 extern /*@truenull@*/ bool exprNode_isError (exprNode p_e) /*@*/ ;
178 # define exprNode_isDefined(e) ((e) != exprNode_undefined)
179 # define exprNode_isUndefined(e) ((e) == exprNode_undefined)
180 # define exprNode_isError(e) ((e) == exprNode_undefined)
182 extern /*@dependent@*/ /*@exposed@*/ guardSet
183 exprNode_getGuards (/*@sef@*/ exprNode p_e) /*@*/ ;
184 # define exprNode_getGuards(e) \
185 (exprNode_isDefined(e) ? (e)->guards : guardSet_undefined)
187 extern ctype exprNode_getType (/*@sef@*/ exprNode p_e) /*@*/ ;
188 # define exprNode_getType(e) \
189 (exprNode_isDefined(e) ? (e)->typ : ctype_unknown)
191 extern /*@unused@*/ /*@falsenull@*/ bool exprNode_isInParens (/*@sef@*/ exprNode p_e) /*@*/ ;
192 # define exprNode_isInParens(e) \
193 (exprNode_isDefined(e) && (e)->kind == XPR_PARENS)
195 extern bool exprNode_isStringLiteral (/*@sef@*/ exprNode p_e);
196 # define exprNode_isStringLiteral(e) \
197 (exprNode_isDefined(e) && (e)->kind == XPR_STRINGLITERAL)
199 extern /*@unused@*/ bool exprNode_knownIntValue (/*@sef@*/ exprNode p_e) /*@*/ ;
200 # define exprNode_knownIntValue(e) \
201 (exprNode_isDefined(e) && multiVal_isInt (exprNode_getValue (e)))
203 extern /*@unused@*/ bool exprNode_knownStringValue (/*@sef@*/ exprNode p_e) /*@*/ ;
204 # define exprNode_knownStringValue(e) \
205 (exprNode_isDefined(e) && multiVal_isString (exprNode_getValue (e)))
207 extern bool exprNode_hasValue (/*@sef@*/ exprNode p_e) /*@*/ ;
208 # define exprNode_hasValue(e) \
209 (exprNode_isDefined(e) && multiVal_isDefined (exprNode_getValue (e)))
211 extern /*@exposed@*/ multiVal exprNode_getValue (exprNode p_e) /*@*/ ;
212 extern long exprNode_getLongValue (exprNode p_e) /*@*/ ;
214 extern /*@observer@*/ cstring exprNode_unparseFirst (exprNode p_e) /*@*/ ;
215 extern /*@observer@*/ guardSet exprNode_getForGuards (exprNode p_pred) /*@*/ ;
216 extern bool exprNode_isNullValue (exprNode p_e) /*@*/ ;
217 extern /*@exposed@*/ sRef exprNode_getSref (exprNode p_e) /*@*/ ;
218 extern /*@observer@*/ uentry exprNode_getUentry (exprNode p_e)
219 /*@globals internalState@*/ ;
220 extern void exprNode_produceGuards (exprNode p_pred) /*@modifies p_pred@*/ ;
221 extern /*@observer@*/ fileloc exprNode_loc (exprNode p_e) /*@*/ ;
223 exprNode_charLiteral (char p_c, cstring p_text, /*@only@*/ fileloc p_loc) /*@*/ ;
224 extern /*@observer@*/ exprNode exprNode_makeMustExit (void) /*@*/ ;
226 exprNode_cond (/*@keep@*/ exprNode p_pred, /*@keep@*/ exprNode p_ifclause,
227 /*@keep@*/ exprNode p_elseclause) /*@*/ ;
228 extern exprNode exprNode_makeError(void) /*@*/ ;
230 extern exprNode exprNode_makeInitBlock (lltok p_brace, /*@only@*/ exprNodeList p_inits) /*@*/ ;
232 extern exprNode exprNode_functionCall (/*@only@*/ exprNode p_f,
233 /*@only@*/ exprNodeList p_args) /*@*/ ;
234 extern /*@notnull@*/ exprNode
235 exprNode_fromIdentifier (/*@observer@*/ uentry p_c) /*@globals internalState@*/ ;
236 extern exprNode exprNode_fromUIO (cstring p_c) /*@globals internalState@*/ ;
237 extern exprNode exprNode_fieldAccess (/*@only@*/ exprNode p_s, /*@only@*/ cstring p_f) /*@*/ ;
238 extern exprNode exprNode_arrowAccess (/*@only@*/ exprNode p_s, /*@only@*/ cstring p_f) /*@*/ ;
239 extern exprNode exprNode_postOp (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_op)
241 extern exprNode exprNode_preOp (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_op) /*@*/ ;
242 extern exprNode exprNode_addParens (/*@only@*/ lltok p_lpar, /*@only@*/ exprNode p_e) /*@*/ ;
243 extern exprNode exprNode_offsetof (/*@only@*/ qtype p_qt, /*@only@*/ cstringList p_s) /*@*/ ;
244 extern exprNode exprNode_sizeofType (/*@only@*/ qtype p_qt) /*@*/ ;
245 extern exprNode exprNode_sizeofExpr (/*@only@*/ exprNode p_e) /*@*/ ;
246 extern exprNode exprNode_alignofType (/*@only@*/ qtype p_qt) /*@*/ ;
247 extern exprNode exprNode_alignofExpr (/*@only@*/ exprNode p_e) /*@*/ ;
249 exprNode_op (/*@only@*/ exprNode p_e1, /*@keep@*/ exprNode p_e2, /*@only@*/ lltok p_op) /*@*/ ;
251 exprNode_assign (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2, /*@only@*/ lltok p_op) ;
253 exprNode_arrayFetch (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2)
254 /*@modifies p_e1, p_e2@*/ ;
256 extern void exprNode_free (/*@only@*/ exprNode p_e) ;
258 exprNode_vaArg (/*@only@*/ lltok p_tok, /*@only@*/ exprNode p_arg, /*@only@*/ qtype p_qt)
259 /*@globals internalState@*/ ;
262 exprNode_stringLiteral (/*@only@*/ cstring p_t, /*@only@*/ fileloc p_loc) /*@*/ ;
263 extern exprNode exprNode_comma (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2) /*@*/ ;
264 extern exprNode exprNode_labelMarker (/*@only@*/ cstring p_label);
266 exprNode_notReached (/*@returned@*/ exprNode p_stmt);
269 exprNode exprNode_caseMarker (/*@only@*/ exprNode p_test, bool p_fallThrough) /*@*/ ;
271 extern exprNode exprNode_concat (/*@only@*/ exprNode p_e1, /*@only@*/ exprNode p_e2);
272 extern exprNode exprNode_createTok (/*@only@*/ lltok p_t) /*@*/ ;
273 extern exprNode exprNode_statement (/*@only@*/ exprNode p_e, /*@only@*/ lltok p_t);
274 extern exprNode exprNode_makeBlock (/*@only@*/ exprNode p_e);
275 extern exprNode exprNode_if (/*@only@*/ exprNode p_pred, /*@only@*/ exprNode p_tclause);
277 exprNode_ifelse (/*@only@*/ exprNode p_pred, /*@only@*/ exprNode p_tclause,
278 /*@only@*/ exprNode p_eclause);
279 extern exprNode exprNode_switch (/*@only@*/ exprNode p_e, /*@only@*/ exprNode p_s);
280 extern exprNode exprNode_while (/*@keep@*/ exprNode p_t, /*@keep@*/ exprNode p_b);
281 extern exprNode exprNode_doWhile (/*@only@*/ exprNode p_b, /*@only@*/ exprNode p_t);
282 extern /*@notnull@*/ /*@only@*/ exprNode exprNode_goto (/*@only@*/ cstring p_label);
283 extern exprNode exprNode_continue (/*@only@*/ lltok p_l, int p_qcontinue);
284 extern exprNode exprNode_break (/*@only@*/ lltok p_l, int p_bqual);
285 extern exprNode exprNode_nullReturn (/*@only@*/ lltok p_t);
286 extern exprNode exprNode_return (/*@only@*/ exprNode p_e);
287 extern /*@dependent@*/ /*@observer@*/ cstring
288 exprNode_unparse (exprNode p_e) /*@*/ ;
290 extern bool exprNode_isCharLit (exprNode p_e) /*@*/ ;
291 extern bool exprNode_isNumLit (exprNode p_e) /*@*/ ;
294 exprNode_makeInitialization (/*@only@*/ idDecl p_t, /*@only@*/ exprNode p_e);
295 extern bool exprNode_matchType (ctype p_expected, exprNode p_e);
297 extern /*@notnull@*/ /*@only@*/ exprNode
298 exprNode_defaultMarker (/*@only@*/ lltok p_def, bool p_fallThrough);
301 exprNode_iter (/*@observer@*/ uentry p_name, /*@only@*/ exprNodeList p_alist,
302 /*@only@*/ exprNode p_body, /*@observer@*/ uentry p_end);
303 extern exprNode exprNode_iterId (/*@observer@*/ uentry p_c);
304 extern exprNode exprNode_iterExpr (/*@returned@*/ exprNode p_e);
305 extern exprNode exprNode_iterNewId (/*@only@*/ cstring p_s);
307 exprNode_iterStart (/*@observer@*/ uentry p_name, /*@only@*/ exprNodeList p_alist);
309 exprNode_numLiteral (ctype p_c, /*@temp@*/ cstring p_t,
310 /*@only@*/ fileloc p_loc, long p_val);
311 extern void exprNode_initMod (void) /*@modifies internalState@*/ ;
312 extern exprNode exprNode_for (/*@keep@*/ exprNode p_inc, /*@keep@*/ exprNode p_body);
314 exprNode_forPred (/*@only@*/ exprNode p_init,
315 /*@only@*/ exprNode p_test, /*@only@*/ exprNode p_inc);
317 exprNode_floatLiteral (double p_d, ctype p_ct,
318 cstring p_text, /*@only@*/ fileloc p_loc);
319 extern /*@notnull@*/ exprNode exprNode_createId (/*@observer@*/ uentry p_c);
320 extern exprNode exprNode_cast (/*@only@*/ lltok p_tok, /*@only@*/ exprNode p_e, /*@only@*/ qtype p_q);
321 extern bool exprNode_matchLiteral (ctype p_expected, exprNode p_e);
322 extern void exprNode_checkUseParam (exprNode p_current);
323 extern void exprNode_checkSet (exprNode p_e, sRef p_s);
324 extern void exprNode_checkMSet (exprNode p_e, sRef p_s);
325 extern exprNode exprNode_checkExpr (/*@returned@*/ exprNode p_e);
326 extern bool exprNode_mustEscape (exprNode p_e);
327 extern bool exprNode_errorEscape (exprNode p_e);
328 extern bool exprNode_mayEscape (exprNode p_e);
329 extern exprNode exprNode_whilePred (/*@only@*/ exprNode p_test);
331 exprNode_updateLocation (/*@returned@*/ exprNode p_e, /*@temp@*/ fileloc p_loc);
332 extern void exprNode_freeShallow (/*@only@*/ exprNode p_e);
333 extern void exprNode_destroyMod (void) /*@modifies internalState@*/ ;
334 extern bool exprNode_isAssign (exprNode p_e) /*@*/ ;
338 extern fileloc exprNode_getfileloc (exprNode p_e) ;
341 extern bool exprNode_isDefaultMarker (exprNode p_e) /*@*/ ;
342 extern bool exprNode_isCaseMarker (exprNode p_e) /*@*/ ;
343 extern bool exprNode_isLabelMarker (exprNode p_e) /*@*/ ;
347 fileloc exprNode_getNextSequencePoint (exprNode p_e) /*@*/ ;
350 exprNode exprNode_fakeCopy (exprNode e);
352 # error "Multiple include"