1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/*@@
@header cctk_Parameter.h
@date Wed Sep 8 10:46:19 MSZ 1999
@author Andre Merzky
@desc
Public defines for parameter stuff
@enddesc
@version $Header$
@@*/
#ifndef _CCTK_PARAMETER_H
#define _CCTK_PARAMETER_H 1
/* this include file declares all parameter structs/defines which
* should be visible and useable for some thorn programmers.
* At first of all this means (read) access to parameter properties.
* Direct acces to parameter values (or its data pointers) are not
* allowed. The functions/declarations for this are in
* ParameterBindings.h, which in turn includes this file.
*/
/* Parameter checking levels */
#define CCTK_PARAMETER_STRICT 800
#define CCTK_PARAMETER_NORMAL 801
#define CCTK_PARAMETER_RELAXED 802
/* these SCOPE* defines are used as flags for parameter scopes. */
#define SCOPE_FIRST 901 /* must be the lowest value */
#define SCOPE_GLOBAL 901 /* parameter is visible everywhere */
#define SCOPE_RESTRICTED 902 /* parameter is visible for friend thorns only */
#define SCOPE_PRIVATE 903 /* parameter is visible for parent thorn only */
#define SCOPE_NOT_GLOBAL 904 /* parameter is not visible everywhere */
#define SCOPE_ANY 905 /* parameter scope is undefined/arbitrary */
#ifdef NEED_PARAMETER_SCOPE_STRINGS
static const char *cctk_parameter_scopes[] = {"GLOBAL",
"RESTRICTED",
"PRIVATE",
"NOT GLOBAL",
"ANY"};
#endif /* NEED_SCOPE_STRINGS */
/* parameter types */
/* These definitions must be identical to the ones in ParameterBindings.h */
#define PARAMETER_FIRST 701 /* must be the lowest value */
#define PARAMETER_KEYWORD 701 /* parameter is keyword */
#define PARAMETER_STRING 702 /* parameter is string */
#define PARAMETER_SENTENCE 703 /* parameter is sentence */
#define PARAMETER_INT 704 /* parameter is integer */
#define PARAMETER_INTEGER 704 /* parameter is integer */
#define PARAMETER_REAL 705 /* parameter is float */
#define PARAMETER_BOOLEAN 706 /* parameter is bool */
#ifdef NEED_PARAMETER_TYPE_STRINGS
static const char *cctk_parameter_type_names[] = {"KEYWORD",
"STRING",
"SENTENCE",
"INTEGER",
"REAL",
"BOOLEAN"};
#endif /* NEED_PARAMETER_TYPE_STRINGS */
/* parameter set mask flags */
#define PARAMETER_RECOVERY_PRE 0
#define PARAMETER_RECOVERY_IN 1
#define PARAMETER_RECOVERY_POST 2
/* what is a parameter range:
* list of independent ranges, each with
* - orig string (range)
* - active flag
* - description
*/
typedef struct RANGE
{
struct RANGE *last;
struct RANGE *next;
char *range;
char *origin;
int active;
char *description;
} t_range;
/* what are parameter properties:
* everything users may know about paras:
* - name
* - thorn it belongs to
* - scope
* - description
* - default value
* - type
* - range (see above)
* - number of times it has been set
* - steerable flag
*/
typedef struct PARAM_PROPS
{
char *name;
char *thorn;
int scope;
char *description;
char *defval;
int type;
t_range *range;
int n_set;
int steerable;
int array_size;
int array_index;
char *accumulator_expression;
} cParamData;
/* typedef for the prototype of a parameter set notify callback */
typedef void (*cParameterSetNotifyCallbackFn) (void *data,
const char *thorn,
const char *parameter,
const char *new_value);
#ifdef __cplusplus
extern "C"
{
#endif
/* return the parameter checking level */
int CCTK_ParameterLevel(void);
/* set the value of a parameter */
int CCTK_ParameterSet (const char *name, /* The name of the parameter */
const char *thorn, /* The originating thorn */
const char *value); /* The value of the parameter */
/* get the data pointer to and type of a parameter's value */
const void *CCTK_ParameterGet (const char *name, /* The name of the parameter*/
const char *thorn, /* The originating thorn */
int *type); /* Holds type of parameter */
/* get the string representation of a parameter's value
(string should be freed afterwards) */
char *CCTK_ParameterValString (const char *name, /* The name of the parameter */
const char *thorn); /* The originating thorn */
/* walk through list of parameters */
int CCTK_ParameterWalk(int first, /* Get first parameter or not */
const char *origin, /* Origin of this walk */
char **pfullname, /* Address of string pointer */
const cParamData **pdata); /* Address of parameter data ptr */
/* get parameter properties for given parameter/thorn pair */
const cParamData *CCTK_ParameterData (const char *name,
const char *thorn);
/* Return number of times a parameter has been set */
int CCTK_ParameterQueryTimesSet(const char *name,
const char *thorn);
/* register a parameter set notify callback */
int CCTK_ParameterSetNotifyRegister (cParameterSetNotifyCallbackFn callback,
void *data,
const char *name,
const char *thorn_regex,
const char *parameter_regex);
/* unregister a parameter set notify callback */
int CCTK_ParameterSetNotifyUnregister (const char *name);
#ifdef __cplusplus
}
#endif
#endif /* _CCTK_PARAMETER_H */
|
