rna support for passing dynamic sized arrays to rna 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., 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
28 #define RNA_TYPES
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
171         /* flag contains multiple enums.
172          * note: not to be confused with prop->enumbitflags
173          * this exposes the flag as multiple options in python and the UI.
174          *
175          * note: these can't be animated so use with care.
176           */
177         PROP_ENUM_FLAG = 1<<21,
178
179         /* need context for update function */
180         PROP_CONTEXT_UPDATE = 1<<22,
181
182         /* Use for arrays or for any data that should not have a referene kept
183          * most common case is functions that return arrays where the array */
184         PROP_THICK_WRAP = 1<<23,
185
186         /* internal flags */
187         PROP_BUILTIN = 1<<7,
188         PROP_EXPORT = 1<<8,
189         PROP_RUNTIME = 1<<9,
190         PROP_IDPROPERTY = 1<<10,
191         PROP_RAW_ACCESS = 1<<13,
192         PROP_RAW_ARRAY = 1<<14,
193         PROP_FREE_POINTERS = 1<<15,
194         PROP_DYNAMIC = 1<<17, /* for dynamic arrays, and retvals of type string */
195         PROP_ENUM_NO_CONTEXT = 1<<18 /* for enum that shouldn't be contextual */
196 } PropertyFlag;
197
198 typedef struct CollectionPropertyIterator {
199         /* internal */
200         PointerRNA parent;
201         PointerRNA builtin_parent;
202         struct PropertyRNA *prop;
203         void *internal;
204         int idprop;
205         int level;
206
207         /* external */
208         int valid;
209         PointerRNA ptr;
210 } CollectionPropertyIterator;
211
212 typedef struct CollectionPointerLink {
213         struct CollectionPointerLink *next, *prev;
214         PointerRNA ptr;
215 } CollectionPointerLink;
216
217 typedef enum RawPropertyType {
218         PROP_RAW_UNSET=-1,
219         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
220         PROP_RAW_SHORT,
221         PROP_RAW_CHAR,
222         PROP_RAW_DOUBLE,
223         PROP_RAW_FLOAT
224 } RawPropertyType;
225
226 typedef struct RawArray {
227         void *array;
228         RawPropertyType type;
229         int len;
230         int stride;
231 } RawArray;
232
233 typedef struct EnumPropertyItem {
234         int value;
235         const char *identifier;
236         int icon;
237         const char *name;
238         const char *description;
239 } EnumPropertyItem;
240
241 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
242
243 typedef struct PropertyRNA PropertyRNA;
244
245 /* Parameter List */
246
247 typedef struct ParameterList {
248         /* storage for parameters */
249         void *data;
250
251         /* store the parameter size */
252         int alloc_size;
253
254         int arg_count, ret_count;
255
256         /* function passed at creation time */
257         struct FunctionRNA *func;
258 } ParameterList;
259
260 typedef struct ParameterIterator {
261         struct ParameterList *parms;
262         PointerRNA funcptr;
263         void *data;
264         int size, offset;
265
266         PropertyRNA *parm;
267         int valid;
268 } ParameterIterator;
269
270 /* mainly to avoid confusing casts */
271 typedef struct ParameterDynAlloc {
272         intptr_t array_tot; /* important, this breaks when set to an int */
273         void *array;
274 } ParameterDynAlloc;
275
276 /* Function */
277
278 typedef enum FunctionFlag {
279         FUNC_NO_SELF = 1, /* for static functions */
280         FUNC_USE_CONTEXT = 2,
281         FUNC_USE_REPORTS = 4,
282         FUNC_USE_SELF_ID = 2048,
283
284         /* registering */
285         FUNC_REGISTER = 8,
286         FUNC_REGISTER_OPTIONAL = 8|16,
287
288         /* internal flags */
289         FUNC_BUILTIN = 128,
290         FUNC_EXPORT = 256,
291         FUNC_RUNTIME = 512,
292         FUNC_FREE_POINTERS = 1024
293 } FunctionFlag;
294
295 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
296
297 typedef struct FunctionRNA FunctionRNA;
298
299 /* Struct */
300
301 typedef enum StructFlag {
302         /* indicates that this struct is an ID struct, and to use refcounting */
303         STRUCT_ID = 1,
304         STRUCT_ID_REFCOUNT = 2,
305
306         /* internal flags */
307         STRUCT_RUNTIME = 4,
308         STRUCT_GENERATED = 8,
309         STRUCT_FREE_POINTERS = 16,
310         STRUCT_NO_IDPROPERTIES = 32, /* Menu's and Panels don't need properties */
311 } StructFlag;
312
313 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
314 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
315 typedef void (*StructFreeFunc)(void *data);
316 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
317         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
318 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
319
320 typedef struct StructRNA StructRNA;
321
322 /* Blender RNA
323  *
324  * Root RNA data structure that lists all struct types. */
325
326 typedef struct BlenderRNA BlenderRNA;
327
328 /* Extending
329  *
330  * This struct must be embedded in *Type structs in
331  * order to make then definable through RNA. */
332
333 typedef struct ExtensionRNA {
334         void *data;
335         StructRNA *srna;
336
337         int (*call)(PointerRNA *, FunctionRNA *, ParameterList *);
338         void (*free)(void *data);
339 } ExtensionRNA;
340
341 /* fake struct definitions, needed otherwise collections end up owning the C
342  * structs like 'Object' when defined first */
343 #define MainActions             Main
344 #define MainArmatures           Main
345 #define MainBrushes             Main
346 #define MainCameras             Main
347 #define MainCurves              Main
348 #define MainFonts               Main
349 #define MainGreasePencils       Main
350 #define MainGroups              Main
351 #define MainImages              Main
352 #define MainLamps               Main
353 #define MainLattices            Main
354 #define MainLibraries           Main
355 #define MainMaterials           Main
356 #define MainMeshes              Main
357 #define MainMetaBalls           Main
358 #define MainNodeTrees           Main
359 #define MainObjects             Main
360 #define MainParticles           Main
361 #define MainScenes              Main
362 #define MainScreens             Main
363 #define MainSounds              Main
364 #define MainTexts               Main
365 #define MainTextures            Main
366 #define MainWindowManagers      Main
367 #define MainWorlds              Main
368
369 #ifdef __cplusplus
370 }
371 #endif
372
373 #endif /* RNA_TYPES */
374
375