Fixed some /@*i@*/ comments in the code.

[splint.git] / src / Headers / constraintTerm.h

diff --git a/src/Headers/constraintTerm.h b/src/Headers/constraintTerm.h
index 31ba0ba584e8a18f906427dad9834c37ef99d287..1bebd5b2932eb130d0954068a020a92eeebda8e6 100644 (file)
--- a/src/Headers/constraintTerm.h
+++ b/src/Headers/constraintTerm.h
@@ -1,68 +1,83 @@
-
 #ifndef __constraintTerm_h__
 
 #define __constraintTerm_h__
 
-constraintTerm constraintTerm_simplify (constraintTerm term);
+typedef union
+{
+  /*@exposed@*/ /*@dependent@*/ exprNode expr;
+  /*@only@*/  sRef     sref;
+  long intlit;
+} constraintTermValue;
 
-constraintTerm constraintTerm_makeExprNode (/*@only@*/ exprNode e);
+typedef enum
+{
+  CTT_ERRORBADCONSTRAINTTERMTYPE,
+  CTT_EXPR, 
+  CTT_SREF,
+  CTT_INTLITERAL
+} constraintTermType;
 
-constraintTerm constraintTerm_copy (constraintTerm term);
+struct s_constraintTerm {
+  /*@only@*/ fileloc loc;
+  constraintTermValue value;
+  constraintTermType kind;
+} ;
 
-constraintTerm exprNode_makeConstraintTerm ( exprNode e);
+abst_typedef struct s_constraintTerm *constraintTerm;
 
 
-bool constraintTerm_same (constraintTerm term1, constraintTerm term2);
+extern bool constraintTerm_isDefined (constraintTerm p_t) /*@*/ ;
 
-bool constraintTerm_similar (constraintTerm term1, constraintTerm term2);
+extern constraintTermType constraintTerm_getKind (constraintTerm) ;
+extern /*@exposed@*/ sRef constraintTerm_getSRef (constraintTerm) ;
 
-bool constraintTerm_canGetValue (constraintTerm term);
-int constraintTerm_getValue (constraintTerm term);
+void constraintTerm_free (/*@only@*/ constraintTerm p_term);
 
-fileloc constraintTerm_getFileloc (constraintTerm t);
+constraintTerm constraintTerm_simplify (/*@returned@*/ constraintTerm p_term) /*@modifies p_term@*/ ;
 
-constraintTerm constraintTerm_makeMaxSetexpr (exprNode e);
+/*@only@*/ constraintTerm constraintTerm_makeExprNode (/*@dependent@*/ exprNode p_e) /*@*/;
 
-constraintTerm constraintTerm_makeMinSetexpr (exprNode e);
+constraintTerm constraintTerm_copy (constraintTerm p_term) /*@*/;
 
-constraintTerm constraintTerm_makeMaxReadexpr (exprNode e);
+bool constraintTerm_similar (constraintTerm p_term1, constraintTerm p_term2) /*@*/;
 
-constraintTerm constraintTerm_makeMinReadexpr (exprNode e);
+bool constraintTerm_canGetValue (constraintTerm p_term)/*@*/;
+long constraintTerm_getValue (constraintTerm p_term) /*@*/;
 
-constraintTerm constraintTerm_makeValueexpr (exprNode e);
+fileloc constraintTerm_getFileloc (constraintTerm p_t) /*@*/;
 
-constraintTerm intLit_makeConstraintTerm (int i);
 
-constraintTerm constraintTerm_makeIntLitValue (int i);
+bool constraintTerm_isIntLiteral (constraintTerm p_term) /*@*/;
 
-bool constraintTerm_isIntLiteral (constraintTerm term);
+constraintTerm constraintTerm_makesRef  (/*@temp@*/ /*@observer@*/ sRef p_s) /*@*/;
 
-cstring constraintTerm_print (constraintTerm term);
+/*@unused@*/ bool constraintTerm_probSame (constraintTerm p_term1, constraintTerm p_term2) /*@*/;
 
-constraintTerm constraintTerm_makesRef  (/*@only@*/ sRef s);
+constraintTerm constraintTerm_setFileloc (/*@returned@*/ constraintTerm p_term, fileloc p_loc) /*@modifies p_term@*/;
 
-bool constraintTerm_probSame (constraintTerm term1, constraintTerm term2);
+constraintTerm constraintTerm_makeIntLiteral (long p_i) /*@*/;
 
+bool constraintTerm_isStringLiteral (constraintTerm p_c) /*@*/;
+cstring constraintTerm_getStringLiteral (constraintTerm p_c) /*@*/;
 
-constraintTerm constraintTerm_doSRefFixBaseParam (constraintTerm term, exprNodeList arglist);
 
-constraintExpr 
-constraintTerm_doSRefFixConstraintParam (constraintExpr e, exprNodeList arglist);
+constraintTerm constraintTerm_doSRefFixBaseParam (/*@returned@*/ constraintTerm p_term, exprNodeList p_arglist) /*@modifies p_term@*/;
 
-constraintTerm constraintTerm_setFileloc (constraintTerm term, fileloc loc);
-cstring constraintTerm_print (constraintTerm term);
-constraintTerm constraintTerm_makeIntLiteral (int i);
+extern cstring constraintTerm_unparse (constraintTerm)  /*@*/ ;
 
-bool constraintTerm_isStringLiteral (constraintTerm c);
-cstring constraintTerm_getStringLiteral (constraintTerm c);
+extern void constraintTerm_dump ( /*@observer@*/ constraintTerm p_t,  FILE * p_f);
+extern /*@only@*/ constraintTerm constraintTerm_undump ( FILE * p_f);
+extern bool constraintTerm_isInitBlock (/*@observer@*/ /*@temp@*/ constraintTerm p_c) /*@*/;
+extern int constraintTerm_getInitBlockLength (/*@observer@*/ /*@temp@*/ constraintTerm p_c) /*@*/;
+extern bool constraintTerm_isExprNode (/*@observer@*/ /*@temp@*/ constraintTerm p_c) /*@*/;
+extern ctype constraintTerm_getCType (constraintTerm p_term);
 
-constraintExpr 
-constraintTerm_doFixResult (constraintExpr e, exprNode fcnCall);
+extern /*@exposed@*/ exprNode constraintTerm_getExprNode (constraintTerm p_t);
+extern /*@exposed@*/ sRef constraintTerm_getsRef (constraintTerm p_t);
 
+/*drl added 12/19/2002*/
+extern bool constraintTerm_isConstantOnly (constraintTerm p_term);
+     
+#else
+#error "Multiple Include!"
 #endif
-
-
-
-
-
-