Merged revision(s) 58452-58584 from trunk/blender into soc-2013-dingto.
[blender.git] / source / blender / makesrna / RNA_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/RNA_types.h
24  *  \ingroup RNA
25  */
26
27
28 #include "../blenlib/BLI_sys_types.h"
29
30 #ifndef __RNA_TYPES_H__
31 #define __RNA_TYPES_H__
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct ParameterList;
38 struct FunctionRNA;
39 struct PropertyRNA;
40 struct EnumPropertyRNA;
41 struct StructRNA;
42 struct BlenderRNA;
43 struct IDProperty;
44 struct bContext;
45 struct Main;
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         PROP_UNIT_CAMERA = (9 << 16)       /* mm */
93 } PropertyUnit;
94
95 #define RNA_SUBTYPE_UNIT(subtype)       ((subtype) &  0x00FF0000)
96 #define RNA_SUBTYPE_VALUE(subtype)      ((subtype) & ~0x00FF0000)
97 #define RNA_SUBTYPE_UNIT_VALUE(subtype) ((subtype) >> 16)
98
99 #define RNA_ENUM_BITFLAG_SIZE 32
100
101 #define RNA_TRANSLATION_PREC_DEFAULT 5
102
103 /* also update enums in bpy_props.c when adding items here
104  * watch it: these values are written to files as part of
105  * node socket button subtypes!
106  */
107 typedef enum PropertySubType {
108         PROP_NONE = 0,
109
110         /* strings */
111         PROP_FILEPATH = 1,
112         PROP_DIRPATH = 2,
113         PROP_FILENAME = 3,
114         PROP_BYTESTRING = 4, /* a string which should be represented as bytes in python, still NULL terminated though. */
115         /* 5 was used by "PROP_TRANSLATE" sub-type, which is now a flag. */
116         PROP_PASSWORD = 6, /* a string which should not be displayed in UI */
117
118         /* numbers */
119         PROP_UNSIGNED = 13,
120         PROP_PERCENTAGE = 14,
121         PROP_FACTOR = 15,
122         PROP_ANGLE = 16 | PROP_UNIT_ROTATION,
123         PROP_TIME = 17 | PROP_UNIT_TIME,
124         /* distance in 3d space, don't use for pixel distance for eg. */
125         PROP_DISTANCE = 18 | PROP_UNIT_LENGTH,
126         PROP_DISTANCE_CAMERA = 19 | PROP_UNIT_CAMERA,
127
128         /* number arrays */
129         PROP_COLOR = 20,
130         PROP_TRANSLATION = 21 | PROP_UNIT_LENGTH,
131         PROP_DIRECTION = 22,
132         PROP_VELOCITY = 23 | PROP_UNIT_VELOCITY,
133         PROP_ACCELERATION = 24 | PROP_UNIT_ACCELERATION,
134         PROP_MATRIX = 25,
135         PROP_EULER = 26 | PROP_UNIT_ROTATION,
136         PROP_QUATERNION = 27,
137         PROP_AXISANGLE = 28,
138         PROP_XYZ = 29,
139         PROP_XYZ_LENGTH = 29 | PROP_UNIT_LENGTH,
140         PROP_COLOR_GAMMA = 30, /* used for colors which would be color managed before display */
141         PROP_COORDS = 31, /* generic array, no units applied, only that x/y/z/w are used (python vec) */
142
143         /* booleans */
144         PROP_LAYER = 40,
145         PROP_LAYER_MEMBER = 41
146 } PropertySubType;
147
148 /* Make sure enums are updated with thses */
149 /* HIGHEST FLAG IN USE: 1 << 29 */
150 typedef enum PropertyFlag {
151         /* editable means the property is editable in the user
152          * interface, properties are editable by default except
153          * for pointers and collections. */
154         PROP_EDITABLE = (1 << 0),
155
156         /* this property is editable even if it is lib linked,
157          * meaning it will get lost on reload, but it's useful
158          * for editing. */
159         PROP_LIB_EXCEPTION = (1 << 16),
160
161         /* animatable means the property can be driven by some
162          * other input, be it animation curves, expressions, ..
163          * properties are animatable by default except for pointers
164          * and collections */
165         PROP_ANIMATABLE = (1 << 1),
166
167         /* icon */
168         PROP_ICONS_CONSECUTIVE = (1 << 12),
169
170         /* hidden in  the user interface */
171         PROP_HIDDEN = (1 << 19),
172         /* do not write in presets */
173         PROP_SKIP_SAVE = (1 << 28),
174
175         /* function paramater flags */
176         PROP_REQUIRED = (1 << 2),
177         PROP_OUTPUT = (1 << 3),
178         PROP_RNAPTR = (1 << 11),
179         /* registering */
180         PROP_REGISTER = (1 << 4),
181         PROP_REGISTER_OPTIONAL = (1 << 4) | (1 << 5),
182
183         /* pointers */
184         PROP_ID_REFCOUNT = (1 << 6),
185
186         /* disallow assigning a variable to its self, eg an object tracking its self
187          * only apply this to types that are derived from an ID ()*/
188         PROP_ID_SELF_CHECK = (1 << 20),
189         /* use for...
190          * - pointers: in the UI and python so unsetting or setting to None won't work
191          * - strings: so our internal generated get/length/set functions know to do NULL checks before access [#30865] */
192         PROP_NEVER_NULL = (1 << 18),
193         /* currently only used for UI, this is similar to PROP_NEVER_NULL
194          * except that the value may be NULL at times, used for ObData, where an Empty's will be NULL
195          * but setting NULL on a mesh object is not possible. So, if its not NULL, setting NULL cant be done! */
196         PROP_NEVER_UNLINK = (1 << 25),
197
198         /* flag contains multiple enums.
199          * note: not to be confused with prop->enumbitflags
200          * this exposes the flag as multiple options in python and the UI.
201          *
202          * note: these can't be animated so use with care.
203          */
204         PROP_ENUM_FLAG = (1 << 21),
205
206         /* need context for update function */
207         PROP_CONTEXT_UPDATE = (1 << 22),
208         PROP_CONTEXT_PROPERTY_UPDATE = (1 << 22) | (1 << 27),
209
210         /* Use for arrays or for any data that should not have a reference kept
211          * most common case is functions that return arrays where the array */
212         PROP_THICK_WRAP = (1 << 23),
213
214         /* Reject values outside limits, use for python api only so far
215          * this is for use when silently clamping string length will give
216          * bad behavior later. Could also enforce this for INT's and other types.
217          * note: currently no support for function arguments or non utf8 paths (filepaths) */
218         PROP_NEVER_CLAMP = (1 << 26),
219
220         /* internal flags */
221         PROP_BUILTIN = (1 << 7),
222         PROP_EXPORT = (1 << 8),
223         PROP_RUNTIME = (1 << 9),
224         PROP_IDPROPERTY = (1 << 10),
225         PROP_RAW_ACCESS = (1 << 13),
226         PROP_RAW_ARRAY = (1 << 14),
227         PROP_FREE_POINTERS = (1 << 15),
228         PROP_DYNAMIC = (1 << 17), /* for dynamic arrays, and retvals of type string */
229         PROP_ENUM_NO_CONTEXT = (1 << 24), /* for enum that shouldn't be contextual */
230         PROP_ENUM_NO_TRANSLATE = (1 << 29), /* for enums that shouldn't be translated (e.g. renderlayers' names in nodes) */
231 } PropertyFlag;
232
233 typedef struct CollectionPropertyIterator {
234         /* internal */
235         PointerRNA parent;
236         PointerRNA builtin_parent;
237         struct PropertyRNA *prop;
238         void *internal;
239         int idprop;
240         int level;
241
242         /* external */
243         PointerRNA ptr;
244         int valid;
245 } CollectionPropertyIterator;
246
247 typedef struct CollectionPointerLink {
248         struct CollectionPointerLink *next, *prev;
249         PointerRNA ptr;
250 } CollectionPointerLink;
251
252 typedef enum RawPropertyType {
253         PROP_RAW_UNSET = -1,
254         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
255         PROP_RAW_SHORT,
256         PROP_RAW_CHAR,
257         PROP_RAW_DOUBLE,
258         PROP_RAW_FLOAT
259 } RawPropertyType;
260
261 typedef struct RawArray {
262         void *array;
263         RawPropertyType type;
264         int len;
265         int stride;
266 } RawArray;
267
268 typedef struct EnumPropertyItem {
269         int value;
270         const char *identifier;
271         int icon;
272         const char *name;
273         const char *description;
274 } EnumPropertyItem;
275
276 /* extended versions with PropertyRNA argument */
277 typedef int (*BooleanPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
278 typedef void (*BooleanPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
279 typedef void (*BooleanArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values);
280 typedef void (*BooleanArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values);
281 typedef int (*IntPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
282 typedef void (*IntPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
283 typedef void (*IntArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values);
284 typedef void (*IntArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values);
285 typedef void (*IntPropertyRangeFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *min, int *max, int *softmin, int *softmax);
286 typedef float (*FloatPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
287 typedef void (*FloatPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float value);
288 typedef void (*FloatArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *values);
289 typedef void (*FloatArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const float *values);
290 typedef void (*FloatPropertyRangeFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *min, float *max, float *softmin, float *softmax);
291 typedef void (*StringPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, char *value);
292 typedef int (*StringPropertyLengthFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
293 typedef void (*StringPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const char *value);
294 typedef int (*EnumPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
295 typedef void (*EnumPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
296 /* same as PropEnumItemFunc */
297 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, struct PropertyRNA *prop, int *free);
298
299 typedef struct PropertyRNA PropertyRNA;
300
301 /* Parameter List */
302
303 typedef struct ParameterList {
304         /* storage for parameters */
305         void *data;
306
307         /* function passed at creation time */
308         struct FunctionRNA *func;
309
310         /* store the parameter size */
311         int alloc_size;
312
313         int arg_count, ret_count;
314 } ParameterList;
315
316 typedef struct ParameterIterator {
317         struct ParameterList *parms;
318         /* PointerRNA funcptr; */ /*UNUSED*/
319         void *data;
320         int size, offset;
321
322         PropertyRNA *parm;
323         int valid;
324 } ParameterIterator;
325
326 /* mainly to avoid confusing casts */
327 typedef struct ParameterDynAlloc {
328         intptr_t array_tot; /* important, this breaks when set to an int */
329         void *array;
330 } ParameterDynAlloc;
331
332 /* Function */
333
334 typedef enum FunctionFlag {
335         FUNC_NO_SELF = 1, /* for static functions */
336         FUNC_USE_SELF_TYPE = 2, /* for class methods, only used when FUNC_NO_SELF is set */
337         FUNC_USE_MAIN = 4,
338         FUNC_USE_CONTEXT = 8,
339         FUNC_USE_REPORTS = 16,
340         FUNC_USE_SELF_ID = 2048,
341         FUNC_ALLOW_WRITE = 4096,
342
343         /* registering */
344         FUNC_REGISTER = 32,
345         FUNC_REGISTER_OPTIONAL = 32 | 64,
346
347         /* internal flags */
348         FUNC_BUILTIN = 128,
349         FUNC_EXPORT = 256,
350         FUNC_RUNTIME = 512,
351         FUNC_FREE_POINTERS = 1024
352 } FunctionFlag;
353
354 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
355
356 typedef struct FunctionRNA FunctionRNA;
357
358 /* Struct */
359
360 typedef enum StructFlag {
361         /* indicates that this struct is an ID struct, and to use refcounting */
362         STRUCT_ID = 1,
363         STRUCT_ID_REFCOUNT = 2,
364         STRUCT_UNDO = 4, /* defaults on, clear for user preferences and similar */
365
366         /* internal flags */
367         STRUCT_RUNTIME = 8,
368         STRUCT_GENERATED = 16,
369         STRUCT_FREE_POINTERS = 32,
370         STRUCT_NO_IDPROPERTIES = 64 /* Menu's and Panels don't need properties */
371 } StructFlag;
372
373 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
374 typedef int (*StructCallbackFunc)(struct bContext *C, struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
375 typedef void (*StructFreeFunc)(void *data);
376 typedef struct StructRNA *(*StructRegisterFunc)(
377         struct Main *bmain, struct ReportList *reports, void *data, const char *identifier,
378         StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
379
380 typedef void (*StructUnregisterFunc)(struct Main *bmain, struct StructRNA *type);
381 typedef void **(*StructInstanceFunc)(PointerRNA *ptr);
382
383 typedef struct StructRNA StructRNA;
384
385 /* Blender RNA
386  *
387  * Root RNA data structure that lists all struct types. */
388
389 typedef struct BlenderRNA BlenderRNA;
390
391 /* Extending
392  *
393  * This struct must be embedded in *Type structs in
394  * order to make then definable through RNA. */
395
396 typedef struct ExtensionRNA {
397         void *data;
398         StructRNA *srna;
399         StructCallbackFunc call;
400         StructFreeFunc free;
401         
402 } ExtensionRNA;
403
404 #ifdef __cplusplus
405 }
406 #endif
407
408 #endif /* __RNA_TYPES_H__ */