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