2 ** Copyright (C) University of Virginia, Massachusetts Institue of Technology 1994-2001.
3 ** See ../LICENSE for license information.
8 ** A record that keeps information on a user-defined state including:
11 ** o State Type (what kinds of things have this state value)
12 ** o Number of values, and their mnemonics
13 ** o A combination table (stateCombinationTable) for how different states combine as l/rvalues
14 ** o Annotations (and map between annotation and value)
15 ** o Context information (where can annotations be used)
21 /*@constant int metaState_error@*/
22 # define metaState_error -1
24 struct s_metaStateInfo {
25 /*@only@*/ cstring name;
27 /* metaStateKind type; */
28 cstringList valueNames;
29 stateCombinationTable sctable;
30 stateCombinationTable mergetable;
33 int defaultValue [MTC_NUMCONTEXTS];
36 mtContextNode context;
39 /* in forwardTypes: abst_typedef null struct _metaStateInfo *metaStateInfo; */
41 /*@constant null metaStateInfo metaStateInfo_undefined; @*/
42 # define metaStateInfo_undefined ((metaStateInfo) NULL)
44 extern /*@falsenull@*/ bool metaStateInfo_isDefined (metaStateInfo) /*@*/ ;
45 # define metaStateInfo_isDefined(p_info) ((p_info) != NULL)
47 extern /*@truenull@*/ bool metaStateInfo_isUndefined (metaStateInfo) /*@*/ ;
48 # define metaStateInfo_isUndefined(p_info) ((p_info) == NULL)
50 extern /*@notnull@*/ metaStateInfo
51 metaStateInfo_create (/*@only@*/ cstring p_name,
52 /*@only@*/ cstringList p_valueNames,
53 /*@only@*/ mtContextNode p_context,
54 /*@only@*/ stateCombinationTable p_sctable,
55 /*@only@*/ stateCombinationTable p_mergetable,
56 /*@only@*/ fileloc p_loc) ;
58 extern bool metaStateInfo_equal (metaStateInfo p_m1, metaStateInfo p_m2) /*@*/ ;
59 # define metaStateInfo_equal(m1,m2) ((m1) == (m2))
61 extern int metaStateInfo_getDefaultValueContext (metaStateInfo p_info, mtContextKind p_context) /*@*/ ;
62 extern void metaStateInfo_setDefaultValueContext (metaStateInfo p_info, mtContextKind p_context, int p_val) /*@modifies p_info@*/ ;
64 extern void metaStateInfo_setDefaultRefValue (metaStateInfo p_info, int p_val)
65 /*@modifies p_info@*/ ;
67 extern void metaStateInfo_setDefaultParamValue (metaStateInfo p_info, int p_val)
68 /*@modifies p_info@*/ ;
70 extern void metaStateInfo_setDefaultResultValue (metaStateInfo p_info, int p_val)
71 /*@modifies p_info@*/ ;
73 extern int metaStateInfo_getDefaultValue (metaStateInfo p_info, sRef p_s) /*@*/ ;
75 extern int metaStateInfo_getDefaultRefValue (metaStateInfo p_info) /*@*/ ;
76 extern int metaStateInfo_getDefaultParamValue (metaStateInfo p_info) /*@*/ ;
77 extern int metaStateInfo_getDefaultResultValue (metaStateInfo p_info) /*@*/ ;
78 extern int metaStateInfo_getDefaultGlobalValue (metaStateInfo p_info) /*@*/ ;
80 extern /*@observer@*/ mtContextNode metaStateInfo_getContext (metaStateInfo p_info) /*@*/ ;
81 extern /*@observer@*/ cstring metaStateInfo_getName (metaStateInfo p_info) /*@*/ ;
82 extern /*@observer@*/ fileloc metaStateInfo_getLoc (metaStateInfo p_info) /*@*/ ;
84 extern /*@exposed@*/ stateCombinationTable metaStateInfo_getTransferTable (metaStateInfo p_info) /*@*/ ;
86 extern /*@exposed@*/ stateCombinationTable metaStateInfo_getMergeTable (metaStateInfo p_info) /*@*/ ;
88 extern /*@only@*/ cstring metaStateInfo_unparse (metaStateInfo p_info) /*@*/ ;
90 extern /*@observer@*/ cstring metaStateInfo_unparseValue (metaStateInfo p_info, int p_value) /*@*/ ;
92 extern void metaStateInfo_free (/*@only@*/ metaStateInfo) ;
95 # error "Multiple include"