doxygen: prevent GPL license block from being parsed as doxygen comment.
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include "BLO_sys_types.h"
26
27 #ifndef RNA_TYPES_H
28 #define RNA_TYPES_H
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 struct ParameterList;
35 struct FunctionRNA;
36 struct PropertyRNA;
37 struct StructRNA;
38 struct BlenderRNA;
39 struct IDProperty;
40 struct bContext;
41 struct ReportList;
42
43 /* Pointer
44  *
45  * RNA pointers are not a single C pointer but include the type,
46  * and a pointer to the ID struct that owns the struct, since
47  * in some cases this information is needed to correctly get/set
48  * the properties and validate them. */
49
50 typedef struct PointerRNA {
51         struct {
52                 void *data;
53         } id;
54
55         struct StructRNA *type;
56         void *data;
57 } PointerRNA;
58
59 typedef struct PropertyPointerRNA {
60         PointerRNA ptr;
61         struct PropertyRNA *prop;
62 } PropertyPointerRNA;
63
64 /* Property */
65
66 typedef enum PropertyType {
67         PROP_BOOLEAN = 0,
68         PROP_INT = 1,
69         PROP_FLOAT = 2,
70         PROP_STRING = 3,
71         PROP_ENUM = 4,
72         PROP_POINTER = 5,
73         PROP_COLLECTION = 6
74 } PropertyType;
75
76 /* also update rna_property_subtype_unit when you change this */
77 typedef enum PropertyUnit {
78         PROP_UNIT_NONE = (0<<16),
79         PROP_UNIT_LENGTH = (1<<16),                     /* m */
80         PROP_UNIT_AREA = (2<<16),                       /* m^2 */
81         PROP_UNIT_VOLUME = (3<<16),                     /* m^3 */
82         PROP_UNIT_MASS = (4<<16),                       /* kg */
83         PROP_UNIT_ROTATION = (5<<16),           /* radians */
84         PROP_UNIT_TIME = (6<<16),                       /* frame */
85         PROP_UNIT_VELOCITY = (7<<16),           /* m/s */
86         PROP_UNIT_ACCELERATION = (8<<16)        /* m/(s^2) */
87 } PropertyUnit;
88
89 #define RNA_SUBTYPE_UNIT(subtype) ((subtype) & 0x00FF0000)
90 #define RNA_SUBTYPE_VALUE(subtype) ((subtype) & ~0x00FF0000)
91 #define RNA_SUBTYPE_UNIT_VALUE(subtype) ((subtype)>>16)
92
93 #define RNA_ENUM_BITFLAG_SIZE 32
94
95 /* also update enums in bpy_props.c when adding items here */
96 typedef enum PropertySubType {
97         PROP_NONE = 0,
98
99         /* strings */
100         PROP_FILEPATH = 1,
101         PROP_DIRPATH = 2,
102         PROP_FILENAME = 3,
103
104         /* numbers */
105         PROP_UNSIGNED = 13,
106         PROP_PERCENTAGE = 14,
107         PROP_FACTOR = 15,
108         PROP_ANGLE = 16|PROP_UNIT_ROTATION,
109         PROP_TIME = 17|PROP_UNIT_TIME,
110         PROP_DISTANCE = 18|PROP_UNIT_LENGTH,
111
112         /* number arrays */
113         PROP_COLOR = 20,
114         PROP_TRANSLATION = 21|PROP_UNIT_LENGTH,
115         PROP_DIRECTION = 22,
116         PROP_VELOCITY = 23|PROP_UNIT_VELOCITY,
117         PROP_ACCELERATION = 24|PROP_UNIT_ACCELERATION,
118         PROP_MATRIX = 25,
119         PROP_EULER = 26|PROP_UNIT_ROTATION,
120         PROP_QUATERNION = 27,
121         PROP_AXISANGLE = 28,
122         PROP_XYZ = 29,
123         PROP_XYZ_LENGTH = 29|PROP_UNIT_LENGTH,
124         PROP_COLOR_GAMMA = 30,
125
126         /* booleans */
127         PROP_LAYER = 40,
128         PROP_LAYER_MEMBER = 41
129 } PropertySubType;
130
131 /* Make sure enums are updated with thses */
132 typedef enum PropertyFlag {
133         /* editable means the property is editable in the user
134          * interface, properties are editable by default except
135          * for pointers and collections. */
136         PROP_EDITABLE = 1<<0,
137
138         /* this property is editable even if it is lib linked,
139          * meaning it will get lost on reload, but it's useful
140          * for editing. */
141         PROP_LIB_EXCEPTION = 1<<16,
142
143         /* animateable means the property can be driven by some
144          * other input, be it animation curves, expressions, ..
145          * properties are animateable by default except for pointers
146          * and collections */
147         PROP_ANIMATABLE = 1<<1,
148
149         /* icon */
150         PROP_ICONS_CONSECUTIVE = 1<<12,
151
152         /* hidden in  the user interface */
153         PROP_HIDDEN = 1<<19,
154
155         /* function paramater flags */
156         PROP_REQUIRED = 1<<2,
157         PROP_OUTPUT = 1<<3,
158         PROP_RNAPTR = 1<<11,
159         /* registering */
160         PROP_REGISTER = 1<<4,
161         PROP_REGISTER_OPTIONAL = (1<<4)|(1<<5),
162
163         /* pointers */
164         PROP_ID_REFCOUNT = 1<<6,
165
166         /* disallow assigning a variable to its self, eg an object tracking its self
167          * only apply this to types that are derived from an ID ()*/
168         PROP_ID_SELF_CHECK = 1<<20,
169         PROP_NEVER_NULL = 1<<18,
170         /* currently only used for UI, this is similar to PROP_NEVER_NULL
171          * except that the value may be NULL at times, used for ObData, where an Empty's will be NULL
172          * but setting NULL on a mesh object is not possible. So, if its not NULL, setting NULL cant be done! */
173         PROP_NEVER_UNLINK = 1<<25,
174
175         /* flag contains multiple enums.
176          * note: not to be confused with prop->enumbitflags
177          * this exposes the flag as multiple options in python and the UI.
178          *
179          * note: these can't be animated so use with care.
180           */
181         PROP_ENUM_FLAG = 1<<21,
182
183         /* need context for update function */
184         PROP_CONTEXT_UPDATE = 1<<22,
185
186         /* Use for arrays or for any data that should not have a referene kept
187          * most common case is functions that return arrays where the array */
188         PROP_THICK_WRAP = 1<<23,
189
190         /* Reject values outside limits, use for python api only so far
191          * this is for use when silently clamping string length will give
192          * bad behavior later. Could also enforce this for INT's and other types.
193          * note: currently no support for function arguments or non utf8 paths (filepaths) */
194         PROP_NEVER_CLAMP = 1<<26,
195
196         /* internal flags */
197         PROP_BUILTIN = 1<<7,
198         PROP_EXPORT = 1<<8,
199         PROP_RUNTIME = 1<<9,
200         PROP_IDPROPERTY = 1<<10,
201         PROP_RAW_ACCESS = 1<<13,
202         PROP_RAW_ARRAY = 1<<14,
203         PROP_FREE_POINTERS = 1<<15,
204         PROP_DYNAMIC = 1<<17, /* for dynamic arrays, and retvals of type string */
205         PROP_ENUM_NO_CONTEXT = 1<<24 /* for enum that shouldn't be contextual */
206 } PropertyFlag;
207
208 typedef struct CollectionPropertyIterator {
209         /* internal */
210         PointerRNA parent;
211         PointerRNA builtin_parent;
212         struct PropertyRNA *prop;
213         void *internal;
214         int idprop;
215         int level;
216
217         /* external */
218         int valid;
219         PointerRNA ptr;
220 } CollectionPropertyIterator;
221
222 typedef struct CollectionPointerLink {
223         struct CollectionPointerLink *next, *prev;
224         PointerRNA ptr;
225 } CollectionPointerLink;
226
227 typedef enum RawPropertyType {
228         PROP_RAW_UNSET=-1,
229         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
230         PROP_RAW_SHORT,
231         PROP_RAW_CHAR,
232         PROP_RAW_DOUBLE,
233         PROP_RAW_FLOAT
234 } RawPropertyType;
235
236 typedef struct RawArray {
237         void *array;
238         RawPropertyType type;
239         int len;
240         int stride;
241 } RawArray;
242
243 typedef struct EnumPropertyItem {
244         int value;
245         const char *identifier;
246         int icon;
247         const char *name;
248         const char *description;
249 } EnumPropertyItem;
250
251 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
252
253 typedef struct PropertyRNA PropertyRNA;
254
255 /* Parameter List */
256
257 typedef struct ParameterList {
258         /* storage for parameters */
259         void *data;
260
261         /* store the parameter size */
262         int alloc_size;
263
264         int arg_count, ret_count;
265
266         /* function passed at creation time */
267         struct FunctionRNA *func;
268 } ParameterList;
269
270 typedef struct ParameterIterator {
271         struct ParameterList *parms;
272         PointerRNA funcptr;
273         void *data;
274         int size, offset;
275
276         PropertyRNA *parm;
277         int valid;
278 } ParameterIterator;
279
280 /* mainly to avoid confusing casts */
281 typedef struct ParameterDynAlloc {
282         intptr_t array_tot; /* important, this breaks when set to an int */
283         void *array;
284 } ParameterDynAlloc;
285
286 /* Function */
287
288 typedef enum FunctionFlag {
289         FUNC_NO_SELF = 1, /* for static functions */
290         FUNC_USE_CONTEXT = 2,
291         FUNC_USE_REPORTS = 4,
292         FUNC_USE_SELF_ID = 2048,
293
294         /* registering */
295         FUNC_REGISTER = 8,
296         FUNC_REGISTER_OPTIONAL = 8|16,
297
298         /* internal flags */
299         FUNC_BUILTIN = 128,
300         FUNC_EXPORT = 256,
301         FUNC_RUNTIME = 512,
302         FUNC_FREE_POINTERS = 1024
303 } FunctionFlag;
304
305 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
306
307 typedef struct FunctionRNA FunctionRNA;
308
309 /* Struct */
310
311 typedef enum StructFlag {
312         /* indicates that this struct is an ID struct, and to use refcounting */
313         STRUCT_ID = 1,
314         STRUCT_ID_REFCOUNT = 2,
315
316         /* internal flags */
317         STRUCT_RUNTIME = 4,
318         STRUCT_GENERATED = 8,
319         STRUCT_FREE_POINTERS = 16,
320         STRUCT_NO_IDPROPERTIES = 32 /* Menu's and Panels don't need properties */
321 } StructFlag;
322
323 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
324 typedef int (*StructCallbackFunc)(struct bContext *C, struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
325 typedef void (*StructFreeFunc)(void *data);
326 typedef struct StructRNA *(*StructRegisterFunc)(struct bContext *C, struct ReportList *reports, void *data,
327         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
328 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
329
330 typedef struct StructRNA StructRNA;
331
332 /* Blender RNA
333  *
334  * Root RNA data structure that lists all struct types. */
335
336 typedef struct BlenderRNA BlenderRNA;
337
338 /* Extending
339  *
340  * This struct must be embedded in *Type structs in
341  * order to make then definable through RNA. */
342
343 typedef struct ExtensionRNA {
344         void *data;
345         StructRNA *srna;
346         StructCallbackFunc call;
347         StructFreeFunc free;
348         
349 } ExtensionRNA;
350
351 /* fake struct definitions, needed otherwise collections end up owning the C
352  * structs like 'Object' when defined first */
353 #define BlendDataActions                Main
354 #define BlendDataArmatures              Main
355 #define BlendDataBrushes                Main
356 #define BlendDataCameras                Main
357 #define BlendDataCurves         Main
358 #define BlendDataFonts          Main
359 #define BlendDataGreasePencils  Main
360 #define BlendDataGroups         Main
361 #define BlendDataImages         Main
362 #define BlendDataLamps          Main
363 #define BlendDataLattices               Main
364 #define BlendDataLibraries              Main
365 #define BlendDataMaterials              Main
366 #define BlendDataMeshes         Main
367 #define BlendDataMetaBalls              Main
368 #define BlendDataNodeTrees              Main
369 #define BlendDataObjects                Main
370 #define BlendDataParticles              Main
371 #define BlendDataScenes         Main
372 #define BlendDataScreens                Main
373 #define BlendDataSounds         Main
374 #define BlendDataTexts          Main
375 #define BlendDataTextures               Main
376 #define BlendDataWindowManagers Main
377 #define BlendDataWorlds         Main
378
379 #ifdef __cplusplus
380 }
381 #endif
382
383 #endif /* RNA_TYPES_H */