src/Headers/constraintExpr.h

   1 #ifndef __constraintExpr_h__
   2
   3 #define __constraintExpr_h__
   4
   5 typedef enum
   6 {
   7   binaryexpr,
   8   unaryExpr,
   9   term
  10 }
  11 constraintExprKind;
  12
  13 struct s_constraintExpr {
  14   constraintExprKind kind;
  15   bool ct; /*changed type */
  16   ctype origType;
  17   constraintExprData data;
  18 };
  19
  20
  21
  22 /*@constant null constraintExpr constraintExpr_undefined; @*/
  23 # define constraintExpr_undefined ((constraintExpr)NULL)
  24
  25 extern /*@falsewhennull@*/ bool constraintExpr_isDefined (constraintExpr p_e) /*@*/ ;
  26 extern /*@unused@*/ /*@nullwhentrue@*/ bool constraintExpr_isUndefined (constraintExpr p_e) /*@*/ ;
  27 extern /*@unused@*/ /*@nullwhentrue@*/ bool constraintExpr_isError (constraintExpr p_e) /*@*/ ;
  28
  29 # define constraintExpr_isDefined(e)        ((e) != constraintExpr_undefined)
  30 # define constraintExpr_isUndefined(e)      ((e) == constraintExpr_undefined)
  31 # define constraintExpr_isError(e)          ((e) == constraintExpr_undefined)
  32
  33
  34 void constraintExpr_free ( /*@only@*/ constraintExpr p_expr);
  35
  36 constraintExpr constraintExpr_setFileloc (/*@returned@*/ constraintExpr p_c, fileloc p_loc) /*@modifies p_c@*/;
  37
  38 constraintExpr constraintExpr_copy (constraintExpr p_expr) /*@*/;
  39
  40 /*@only@*/ cstring constraintExpr_unparse (/*@temp@*/ /*@observer@*/ constraintExpr p_ex) /*@*/;
  41 extern cstring constraintExpr_print (constraintExpr p_expr) /*@*/;
  42
  43
  44 bool constraintExpr_similar (constraintExpr p_expr1, constraintExpr p_expr2) /*@*/;
  45 bool constraintExpr_same (constraintExpr p_expr1, constraintExpr p_expr2) /*@*/;
  46 /*@only@*/ constraintExpr constraintExpr_searchandreplace (/*@only@*/ /*@unique@*/ constraintExpr p_c, /*@temp@*/ /*@observer@*/ constraintExpr p_old, /*@temp@*/ /*@observer@*/ constraintExpr p_newExpr ) /*@modifies p_c@*/;
  47
  48 bool constraintExpr_canGetValue (constraintExpr p_expr) /*@*/;
  49 long constraintExpr_getValue (constraintExpr p_expr) /*@*/;
  50
  51 int constraintExpr_compare (constraintExpr p_expr1, constraintExpr p_expr2) /*@*/;
  52
  53 /* constraintExpr constraintExpr_makeValueInt (int i); */
  54
  55 /*@only@*/ /*@notnull@*/constraintExpr constraintExpr_makeIntLiteral (long p_i);
  56
  57 /*@only@*/ constraintExpr constraintExpr_makeValueExpr (/*@exposed@*/ exprNode p_expr);
  58
  59 /*@only@*/ constraintExpr constraintExpr_makeMaxSetExpr (/*@exposed@*/ exprNode p_expr);
  60
  61 /*@only@*/ constraintExpr  constraintExpr_makeMaxReadExpr (/*@exposed@*/ exprNode p_expr);
  62
  63 /*@only@*/ constraintExpr constraintExpr_makeIncConstraintExpr (/*@only@*/ constraintExpr p_expr);
  64
  65 /*@only@*/ constraintExpr constraintExpr_makeDecConstraintExpr (/*@only@*/ constraintExpr p_expr);
  66
  67 /*@only@*/ constraintExpr constraintExpr_simplify (/*@only@*/ constraintExpr p_c);
  68
  69 /*@only@*/ constraintExpr constraintExpr_solveBinaryExpr (constraintExpr p_lexpr, /*@only@*/ constraintExpr p_expr) /*@modifies p_lexpr, p_expr @*/;
  70
  71 bool constraintExpr_search (/*@observer@*/ /*@temp@*/ constraintExpr p_c, /*@observer@*/ /*@temp@*/ constraintExpr p_old);
  72
  73 /*@only@*/ fileloc constraintExpr_getFileloc (constraintExpr p_expr);
  74
  75
  76 /*@only@*/ constraintExpr constraintExpr_makeSRefMaxset ( /*@temp@*/ /*@observer@*/ sRef p_s);
  77
  78 /*@only@*/ constraintExpr constraintExpr_makeSRefMaxRead(/*@temp@*/ /*@observer@*/ sRef p_s);
  79
  80 /*@only@*/ constraintExpr constraintExpr_makeTermsRef (/*@temp@*/ sRef  p_s);
  81
  82 constraintExpr constraintExpr_doSRefFixBaseParam ( /*@returned@*/ constraintExpr p_expr, exprNodeList p_arglist);
  83
  84 /*@only@*/ constraintExpr constraintExpr_makeExprNode (/*@dependent@*/  exprNode p_e);
  85
  86 /*@only@*/ constraintExpr constraintExpr_doFixResult (/*@only@*/  constraintExpr p_expr, /*@observer@*/ exprNode p_fcnCall);
  87
  88 /*@falsewhennull@*/ bool constraintExpr_isLit (constraintExpr p_expr) /*@*/ ;
  89
  90 /*@only@*/ constraintExpr constraintExpr_makeAddExpr (/*@only@*/ constraintExpr p_expr, /*@only@*/ constraintExpr p_addent);
  91
  92 /*@only@*/  constraintExpr constraintExpr_makeSubtractExpr (/*@only@*/ constraintExpr p_expr, /*@only@*/ constraintExpr p_addent);
  93
  94 /*@only@*/ constraintExpr constraintExpr_parseMakeUnaryOp (lltok p_op,/*@only@*/ constraintExpr p_cexpr);
  95
  96 constraintExpr constraintExpr_parseMakeBinaryOp (/*@only@*/ constraintExpr p_expr1, lltok p_op, /*@only@*/ constraintExpr p_expr2);
  97
  98 bool constraintExpr_hasMaxSet (/*@observer@*/ /*@temp@*/ constraintExpr p_expr);
  99
 100
 101
 102 /*@only@*/ constraintExpr constraintExpr_doSRefFixConstraintParam (/*@returned@*/ /*@only@*/ constraintExpr p_expr, exprNodeList p_arglist) /*@modifies p_expr@*/;
 103
 104 /*@only@*/
 105 constraintExpr constraintExpr_propagateConstants (/*@only@*/ constraintExpr p_expr,
 106                                                 /*@out@*/ bool * p_propagate,
 107                                                   /*@out@*/ int *p_literal);
 108
 109 /*@falsewhennull@*/ bool constraintExpr_isBinaryExpr (/*@observer@*/ /*@temp@*/ constraintExpr p_c) /*@*/ ;
 110
 111 extern void  constraintExpr_dump (/*@observer@*/ /*@temp@*/ constraintExpr p_expr,  FILE *p_f);
 112
 113 extern /*@only@*/ constraintExpr  constraintExpr_undump (FILE *p_f);
 114
 115 extern /*@only@*/ constraintExpr constraintExpr_makeTermExprNode (/*@exposed@*/ exprNode p_e) ;
 116
 117 /* drl added 8/8/001*/
 118 bool constraintExpr_isTerm (/*@observer@*/ /*@temp@*/ constraintExpr p_c);
 119
 120 /* drl added 8/8/001*/
 121 /*@observer@*/ /*@temp@*/ constraintTerm constraintExpr_getTerm ( /*@temp@*/ /*@observer@*/ constraintExpr p_c);
 122
 123 /* drl added 8/8/001*/
 124 int constraintExpr_getDepth (/*@observer@*/ /*@temp@*/ constraintExpr p_ex);
 125
 126
 127 /*drl 1/6/2001: I didn't think these functions were solid enough to include in the   stable  release of splint.*/
 128 /* drl added 12/30/001*/
 129 /* extern / *@only@* / constraintExpr constraintExpr_doSRefFixInvarConstraint (/ *@only@* / constraintExpr p_expr, sRef p_s, ctype p_ct); */
 130
 131
 132
 133 /*drl added 12/19 */
 134 bool  constraintExpr_isConstantOnly ( constraintExpr p_e );
 135
 136 #else
 137 # error "Multiple include"
 138 #endif