use static functions where possible for some local functions.
[blender.git] / source / blender / makesrna / RNA_types.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #ifndef RNA_TYPES
26 #define RNA_TYPES
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 struct ParameterList;
33 struct FunctionRNA;
34 struct PropertyRNA;
35 struct StructRNA;
36 struct BlenderRNA;
37 struct IDProperty;
38 struct bContext;
39 struct ReportList;
40
41 /* Pointer
42  *
43  * RNA pointers are not a single C pointer but include the type,
44  * and a pointer to the ID struct that owns the struct, since
45  * in some cases this information is needed to correctly get/set
46  * the properties and validate them. */
47
48 typedef struct PointerRNA {
49         struct {
50                 void *data;
51         } id;
52
53         struct StructRNA *type;
54         void *data;
55 } PointerRNA;
56
57 /* Property */
58
59 typedef enum PropertyType {
60         PROP_BOOLEAN = 0,
61         PROP_INT = 1,
62         PROP_FLOAT = 2,
63         PROP_STRING = 3,
64         PROP_ENUM = 4,
65         PROP_POINTER = 5,
66         PROP_COLLECTION = 6
67 } PropertyType;
68
69 /* also update rna_property_subtype_unit when you change this */
70 typedef enum PropertyUnit {
71         PROP_UNIT_NONE = (0<<16),
72         PROP_UNIT_LENGTH = (1<<16),                     /* m */
73         PROP_UNIT_AREA = (2<<16),                       /* m^2 */
74         PROP_UNIT_VOLUME = (3<<16),                     /* m^3 */
75         PROP_UNIT_MASS = (4<<16),                       /* kg */
76         PROP_UNIT_ROTATION = (5<<16),           /* rad */
77         PROP_UNIT_TIME = (6<<16),                       /* frame */
78         PROP_UNIT_VELOCITY = (7<<16),           /* m/s */
79         PROP_UNIT_ACCELERATION = (8<<16)        /* m/(s^2) */
80 } PropertyUnit;
81
82 #define RNA_SUBTYPE_UNIT(subtype) (subtype & 0x00FF0000)
83 #define RNA_SUBTYPE_UNIT_VALUE(subtype) (subtype>>16)
84
85 /* also update rna_property_subtypename when you change this */
86 typedef enum PropertySubType {
87         PROP_NONE = 0,
88
89         /* strings */
90         PROP_FILEPATH = 1,
91         PROP_DIRPATH = 2,
92         PROP_FILENAME = 3,
93
94         /* numbers */
95         PROP_UNSIGNED = 13,
96         PROP_PERCENTAGE = 14,
97         PROP_ANGLE = 15|PROP_UNIT_ROTATION,
98         PROP_TIME = 16|PROP_UNIT_TIME,
99         PROP_DISTANCE = 17|PROP_UNIT_LENGTH,
100
101         /* number arrays */
102         PROP_COLOR = 20,
103         PROP_TRANSLATION = 21|PROP_UNIT_LENGTH,
104         PROP_DIRECTION = 22,
105         PROP_VELOCITY = 23|PROP_UNIT_VELOCITY,
106         PROP_ACCELERATION = 24|PROP_UNIT_ACCELERATION,
107         PROP_MATRIX = 25,
108         PROP_EULER = 26|PROP_UNIT_ROTATION,
109         PROP_QUATERNION = 27,
110         PROP_XYZ = 28,
111         PROP_RGB = 29,
112
113         /* pointers */
114         PROP_NEVER_NULL = 30,
115
116         /* booleans */
117         PROP_LAYER = 40,
118         PROP_LAYER_MEMBER = 41
119 } PropertySubType;
120
121 typedef enum PropertyFlag {
122         /* editable means the property is editable in the user
123          * interface, properties are editable by default except
124          * for pointers and collections. */
125         PROP_EDITABLE = 1,
126
127         /* this property is editable even if it is lib linked,
128          * meaning it will get lost on reload, but it's useful
129          * for editing. */
130         PROP_LIB_EXCEPTION = 65536,
131
132         /* animateable means the property can be driven by some
133          * other input, be it animation curves, expressions, ..
134          * properties are animateable by default except for pointers
135          * and collections */
136         PROP_ANIMATEABLE = 2,
137
138         /* icon */
139         PROP_ICONS_CONSECUTIVE = 4096,
140
141         /* function paramater flags */
142         PROP_REQUIRED = 4,
143         PROP_RETURN = 8,
144         PROP_RNAPTR = 2048,
145
146         /* registering */
147         PROP_REGISTER = 16,
148         PROP_REGISTER_OPTIONAL = 16|32,
149
150         /* pointers */
151         PROP_ID_REFCOUNT = 64,
152
153         /* internal flags */
154         PROP_BUILTIN = 128,
155         PROP_EXPORT = 256,
156         PROP_RUNTIME = 512,
157         PROP_IDPROPERTY = 1024,
158         PROP_RAW_ACCESS = 8192,
159         PROP_RAW_ARRAY = 16384,
160         PROP_FREE_POINTERS = 32768,
161         PROP_DYNAMIC = 131072 /* for dynamic arrays, and retvals of type string */
162 } PropertyFlag;
163
164 typedef struct CollectionPropertyIterator {
165         /* internal */
166         PointerRNA parent;
167         PointerRNA builtin_parent;
168         struct PropertyRNA *prop;
169         void *internal;
170         int idprop;
171         int level;
172
173         /* external */
174         int valid;
175         PointerRNA ptr;
176 } CollectionPropertyIterator;
177
178 typedef struct CollectionPointerLink {
179         struct CollectionPointerLink *next, *prev;
180         PointerRNA ptr;
181 } CollectionPointerLink;
182
183 typedef enum RawPropertyType {
184         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
185         PROP_RAW_SHORT,
186         PROP_RAW_CHAR,
187         PROP_RAW_DOUBLE,
188         PROP_RAW_FLOAT
189 } RawPropertyType;
190
191 typedef struct RawArray {
192         void *array;
193         RawPropertyType type;
194         int len;
195         int stride;
196 } RawArray;
197
198 typedef struct EnumPropertyItem {
199         int value;
200         const char *identifier;
201         int icon;
202         const char *name;
203         const char *description;
204 } EnumPropertyItem;
205
206 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
207
208 typedef struct PropertyRNA PropertyRNA;
209
210 /* Parameter List */
211
212 typedef struct ParameterList {
213         /* storage for parameters */
214         void *data;
215
216         /* store the parameter count */
217         int tot;
218
219         /* function passed at creation time */
220         struct FunctionRNA *func;
221 } ParameterList;
222
223 typedef struct ParameterIterator {
224         struct ParameterList *parms;
225         PointerRNA funcptr;
226         void *data;
227         int size, offset;
228
229         PropertyRNA *parm;
230         int valid;
231 } ParameterIterator;
232
233 /* Function */
234
235 typedef enum FunctionFlag {
236         FUNC_NO_SELF = 1, /* for static functions */
237         FUNC_USE_CONTEXT = 2,
238         FUNC_USE_REPORTS = 4,
239
240         /* registering */
241         FUNC_REGISTER = 8,
242         FUNC_REGISTER_OPTIONAL = 8|16,
243
244         /* internal flags */
245         FUNC_BUILTIN = 128,
246         FUNC_EXPORT = 256,
247         FUNC_RUNTIME = 512,
248         FUNC_FREE_POINTERS = 1024
249 } FunctionFlag;
250
251 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
252
253 typedef struct FunctionRNA FunctionRNA;
254
255 /* Struct */
256
257 typedef enum StructFlag {
258         /* indicates that this struct is an ID struct, and to use refcounting */
259         STRUCT_ID = 1,
260         STRUCT_ID_REFCOUNT = 2,
261
262         /* internal flags */
263         STRUCT_RUNTIME = 4,
264         STRUCT_GENERATED = 8,
265         STRUCT_FREE_POINTERS = 16
266 } StructFlag;
267
268 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
269 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
270 typedef void (*StructFreeFunc)(void *data);
271 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
272         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
273 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
274
275 typedef struct StructRNA StructRNA;
276
277 /* Blender RNA
278  *
279  * Root RNA data structure that lists all struct types. */
280
281 typedef struct BlenderRNA BlenderRNA;
282
283 /* Extending
284  *
285  * This struct must be embedded in *Type structs in
286  * order to make then definable through RNA. */
287
288 typedef struct ExtensionRNA {
289         void *data;
290         StructRNA *srna;
291
292         int (*call)(PointerRNA *, FunctionRNA *, ParameterList *);
293         void (*free)(void *data);
294 } ExtensionRNA;
295
296 #ifdef __cplusplus
297 }
298 #endif
299
300 #endif /* RNA_TYPES */
301
302