0e7c3956d7ba6e3fe9268ac3c79aa79ea6f69472
[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 StructRNA;
41 struct BlenderRNA;
42 struct bContext;
43 struct Main;
44 struct ReportList;
45
46 /** Pointer
47  *
48  * RNA pointers are not a single C pointer but include the type,
49  * and a pointer to the ID struct that owns the struct, since
50  * in some cases this information is needed to correctly get/set
51  * the properties and validate them. */
52
53 typedef struct PointerRNA {
54         struct {
55                 void *data;
56         } id;
57
58         struct StructRNA *type;
59         void *data;
60 } PointerRNA;
61
62 typedef struct PropertyPointerRNA {
63         PointerRNA ptr;
64         struct PropertyRNA *prop;
65 } PropertyPointerRNA;
66
67 /**
68  * Stored result of a RNA path lookup (as used by anim-system)
69  */
70 typedef struct PathResolvedRNA {
71         struct PointerRNA ptr;
72         struct PropertyRNA *prop;
73         /* -1 for non-array access */
74         int prop_index;
75 } PathResolvedRNA;
76
77 /* Property */
78
79 typedef enum PropertyType {
80         PROP_BOOLEAN      = 0,
81         PROP_INT          = 1,
82         PROP_FLOAT        = 2,
83         PROP_STRING       = 3,
84         PROP_ENUM         = 4,
85         PROP_POINTER      = 5,
86         PROP_COLLECTION   = 6,
87 } PropertyType;
88
89 /* also update rna_property_subtype_unit when you change this */
90 typedef enum PropertyUnit {
91         PROP_UNIT_NONE         = (0 << 16),
92         PROP_UNIT_LENGTH       = (1 << 16),   /* m */
93         PROP_UNIT_AREA         = (2 << 16),   /* m^2 */
94         PROP_UNIT_VOLUME       = (3 << 16),   /* m^3 */
95         PROP_UNIT_MASS         = (4 << 16),   /* kg */
96         PROP_UNIT_ROTATION     = (5 << 16),   /* radians */
97         PROP_UNIT_TIME         = (6 << 16),   /* frame */
98         PROP_UNIT_VELOCITY     = (7 << 16),   /* m/s */
99         PROP_UNIT_ACCELERATION = (8 << 16),   /* m/(s^2) */
100         PROP_UNIT_CAMERA       = (9 << 16),   /* mm */
101 } PropertyUnit;
102
103 #define RNA_SUBTYPE_UNIT(subtype)       ((subtype) &  0x00FF0000)
104 #define RNA_SUBTYPE_VALUE(subtype)      ((subtype) & ~0x00FF0000)
105 #define RNA_SUBTYPE_UNIT_VALUE(subtype) ((subtype) >> 16)
106
107 #define RNA_ENUM_BITFLAG_SIZE 32
108
109 #define RNA_TRANSLATION_PREC_DEFAULT 5
110
111 #define RNA_STACK_ARRAY 32
112
113 /* also update enums in bpy_props.c when adding items here
114  * watch it: these values are written to files as part of
115  * node socket button subtypes!
116  */
117 typedef enum PropertySubType {
118         PROP_NONE              = 0,
119
120         /* strings */
121         PROP_FILEPATH          = 1,
122         PROP_DIRPATH           = 2,
123         PROP_FILENAME          = 3,
124         PROP_BYTESTRING        = 4, /* a string which should be represented as bytes in python, NULL terminated though. */
125         /* 5 was used by "PROP_TRANSLATE" sub-type, which is now a flag. */
126         PROP_PASSWORD          = 6, /* a string which should not be displayed in UI */
127
128         /* numbers */
129         PROP_PIXEL             = 12,
130         PROP_UNSIGNED          = 13,
131         PROP_PERCENTAGE        = 14,
132         PROP_FACTOR            = 15,
133         PROP_ANGLE             = 16 | PROP_UNIT_ROTATION,
134         PROP_TIME              = 17 | PROP_UNIT_TIME,
135         /* distance in 3d space, don't use for pixel distance for eg. */
136         PROP_DISTANCE          = 18 | PROP_UNIT_LENGTH,
137         PROP_DISTANCE_CAMERA   = 19 | PROP_UNIT_CAMERA,
138
139         /* number arrays */
140         PROP_COLOR             = 20,
141         PROP_TRANSLATION       = 21 | PROP_UNIT_LENGTH,
142         PROP_DIRECTION         = 22,
143         PROP_VELOCITY          = 23 | PROP_UNIT_VELOCITY,
144         PROP_ACCELERATION      = 24 | PROP_UNIT_ACCELERATION,
145         PROP_MATRIX            = 25,
146         PROP_EULER             = 26 | PROP_UNIT_ROTATION,
147         PROP_QUATERNION        = 27,
148         PROP_AXISANGLE         = 28,
149         PROP_XYZ               = 29,
150         PROP_XYZ_LENGTH        = 29 | PROP_UNIT_LENGTH,
151         PROP_COLOR_GAMMA       = 30, /* used for colors which would be color managed before display */
152         PROP_COORDS            = 31, /* generic array, no units applied, only that x/y/z/w are used (python vec) */
153
154         /* booleans */
155         PROP_LAYER             = 40,
156         PROP_LAYER_MEMBER      = 41,
157 } PropertySubType;
158
159 /* Make sure enums are updated with these */
160 /* HIGHEST FLAG IN USE: 1 << 31
161  * FREE FLAGS: 2, 9, 11, 13, 14, 15, 30 */
162 typedef enum PropertyFlag {
163         /* editable means the property is editable in the user
164          * interface, properties are editable by default except
165          * for pointers and collections. */
166         PROP_EDITABLE                = (1 << 0),
167
168         /* this property is editable even if it is lib linked,
169          * meaning it will get lost on reload, but it's useful
170          * for editing. */
171         PROP_LIB_EXCEPTION           = (1 << 16),
172
173         /* animatable means the property can be driven by some
174          * other input, be it animation curves, expressions, ..
175          * properties are animatable by default except for pointers
176          * and collections */
177         PROP_ANIMATABLE              = (1 << 1),
178
179         /* This flag means when the property's widget is in 'textedit' mode, it will be updated
180          * after every typed char, instead of waiting final validation. Used e.g. for text searchbox.
181          * It will also cause UI_BUT_VALUE_CLEAR to be set for text buttons. We could add an own flag
182          * for search/filter properties, but this works just fine for now. */
183         PROP_TEXTEDIT_UPDATE         = (1u << 31),
184
185         /* icon */
186         PROP_ICONS_CONSECUTIVE       = (1 << 12),
187
188         /* hidden in  the user interface */
189         PROP_HIDDEN                  = (1 << 19),
190         /* do not write in presets */
191         PROP_SKIP_SAVE               = (1 << 28),
192
193         /* numbers */
194
195         /* each value is related proportionally (object scale, image size) */
196         PROP_PROPORTIONAL            = (1 << 26),
197
198         /* pointers */
199         PROP_ID_REFCOUNT             = (1 << 6),
200
201         /* disallow assigning a variable to its self, eg an object tracking its self
202          * only apply this to types that are derived from an ID ()*/
203         PROP_ID_SELF_CHECK           = (1 << 20),
204         /* use for...
205          * - pointers: in the UI and python so unsetting or setting to None won't work
206          * - strings: so our internal generated get/length/set functions know to do NULL checks before access [#30865] */
207         PROP_NEVER_NULL              = (1 << 18),
208         /* currently only used for UI, this is similar to PROP_NEVER_NULL
209          * except that the value may be NULL at times, used for ObData, where an Empty's will be NULL
210          * but setting NULL on a mesh object is not possible. So, if its not NULL, setting NULL cant be done! */
211         PROP_NEVER_UNLINK            = (1 << 25),
212
213         /* Pointers to data that is not owned by the struct.
214          * Typical example: Bone.parent, Bone.child, etc., and nearly all ID pointers.
215          * This is crucial information for processes that walk the whole data of an ID e.g. (like static override).
216          * Note that all ID pointers are enforced to this by default, this probably will need to be rechecked
217          * (see ugly infamous NodeTrees of mat/tex/scene/etc.). */
218         PROP_PTR_NO_OWNERSHIP        = (1 << 7),
219
220         /* flag contains multiple enums.
221          * note: not to be confused with prop->enumbitflags
222          * this exposes the flag as multiple options in python and the UI.
223          *
224          * note: these can't be animated so use with care.
225          */
226         PROP_ENUM_FLAG               = (1 << 21),
227
228         /* need context for update function */
229         PROP_CONTEXT_UPDATE          = (1 << 22),
230         PROP_CONTEXT_PROPERTY_UPDATE = PROP_CONTEXT_UPDATE | (1 << 27),
231
232         /* registering */
233         PROP_REGISTER                = (1 << 4),
234         PROP_REGISTER_OPTIONAL       = PROP_REGISTER | (1 << 5),
235
236         /* Use for arrays or for any data that should not have a reference kept
237          * most common case is functions that return arrays where the array */
238         PROP_THICK_WRAP              = (1 << 23),
239
240         PROP_IDPROPERTY              = (1 << 10), /* This is an IDProperty, not a DNA one. */
241         PROP_DYNAMIC                 = (1 << 17), /* for dynamic arrays, and retvals of type string */
242         PROP_ENUM_NO_CONTEXT         = (1 << 24), /* for enum that shouldn't be contextual */
243         PROP_ENUM_NO_TRANSLATE       = (1 << 29), /* for enums not to be translated (e.g. viewlayers' names in nodes) */
244 } PropertyFlag;
245
246 /* Flags related to comparing and overriding RNA properties. Make sure enums are updated with these */
247 /* FREE FLAGS: 2, 3, 4, 5, 6, 7, 8, 9, 12 and above. */
248 typedef enum PropertyOverrideFlag {
249         /* Means the property can be overridden by a local 'proxy' of some linked datablock. */
250         PROPOVERRIDE_OVERRIDABLE_STATIC = (1 << 0),
251
252         /* Forbid usage of this property in comparison (& hence override) code.
253          * Useful e.g. for collections of data like mesh's geometry, particles, etc. */
254         PROPOVERRIDE_NO_COMPARISON = (1 << 1),
255
256         /*** Collections-related ***/
257
258         /* The property supports insertion (collections only). */
259         PROPOVERRIDE_STATIC_INSERTION = (1 << 10),
260
261         /* Only use indices to compare items in the property, never names (collections only). */
262         /* Useful when nameprop of the items is generated from other data
263          * (e.g. name of material slots is actually name of assigned material). */
264         PROPOVERRIDE_NO_PROP_NAME = (1 << 11),
265 } PropertyOverrideFlag;
266
267 /* Function parameters flags.
268  * WARNING: 16bits only. */
269 typedef enum ParameterFlag {
270         PARM_REQUIRED                = (1 << 0),
271         PARM_OUTPUT                  = (1 << 1),
272         PARM_RNAPTR                  = (1 << 2),
273         /* This allows for non-breaking API updates, when adding non-critical new parameter to a callback function.
274          * This way, old py code defining funcs without that parameter would still work.
275          * WARNING: any parameter after the first PYFUNC_OPTIONAL one will be considered as optional!
276          * NOTE: only for input parameters!
277          */
278         PARM_PYFUNC_OPTIONAL         = (1 << 3),
279 } ParameterFlag;
280
281 struct CollectionPropertyIterator;
282 struct Link;
283 typedef int (*IteratorSkipFunc)(struct CollectionPropertyIterator *iter, void *data);
284
285 typedef struct ListBaseIterator {
286         struct Link *link;
287         int flag;
288         IteratorSkipFunc skip;
289 } ListBaseIterator;
290
291 typedef struct ArrayIterator {
292         char *ptr;
293         char *endptr;  /* past the last valid pointer, only for comparisons, ignores skipped values */
294         void *free_ptr; /* will be freed if set */
295         int itemsize;
296
297         /* array length with no skip functions applied, take care not to compare against index from animsys
298          * or python indices */
299         int length;
300
301         /* optional skip function, when set the array as viewed by rna can contain only a subset of the members.
302          * this changes indices so quick array index lookups are not possible when skip function is used. */
303         IteratorSkipFunc skip;
304 } ArrayIterator;
305
306 typedef struct CollectionPropertyIterator {
307         /* internal */
308         PointerRNA parent;
309         PointerRNA builtin_parent;
310         struct PropertyRNA *prop;
311         union {
312                 ArrayIterator array;
313                 ListBaseIterator listbase;
314                 void *custom;
315         } internal;
316         int idprop;
317         int level;
318
319         /* external */
320         PointerRNA ptr;
321         int valid;
322 } CollectionPropertyIterator;
323
324 typedef struct CollectionPointerLink {
325         struct CollectionPointerLink *next, *prev;
326         PointerRNA ptr;
327 } CollectionPointerLink;
328
329 /* Copy of ListBase for RNA... */
330 typedef struct CollectionListBase {
331         struct CollectionPointerLink *first, *last;
332 } CollectionListBase;
333
334 typedef enum RawPropertyType {
335         PROP_RAW_UNSET = -1,
336         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
337         PROP_RAW_SHORT,
338         PROP_RAW_CHAR,
339         PROP_RAW_BOOLEAN,
340         PROP_RAW_DOUBLE,
341         PROP_RAW_FLOAT
342 } RawPropertyType;
343
344 typedef struct RawArray {
345         void *array;
346         RawPropertyType type;
347         int len;
348         int stride;
349 } RawArray;
350
351 /**
352  * This struct is are typically defined in arrays which define an *enum* for RNA,
353  * which is used by the RNA API both for user-interface and the Python API.
354  */
355 typedef struct EnumPropertyItem {
356         /** The internal value of the enum, not exposed to users. */
357         int value;
358         /**
359          * Note that identifiers must be unique within the array,
360          * by convention they're upper case with underscores for separators.
361          * - An empty string is used to define menu separators.
362          * - NULL denotes the end of the array of items.
363          */
364         const char *identifier;
365         /** Optional icon, typically 'ICON_NONE' */
366         int icon;
367         /** Name displayed in the interface. */
368         const char *name;
369         /** Longer description used in the interface. */
370         const char *description;
371 } EnumPropertyItem;
372
373 /* extended versions with PropertyRNA argument */
374 typedef bool (*BooleanPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
375 typedef void (*BooleanPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, bool value);
376 typedef void (*BooleanArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, bool *values);
377 typedef void (*BooleanArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const bool *values);
378 typedef int (*IntPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
379 typedef void (*IntPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
380 typedef void (*IntArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values);
381 typedef void (*IntArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values);
382 typedef void (*IntPropertyRangeFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *min, int *max, int *softmin, int *softmax);
383 typedef float (*FloatPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
384 typedef void (*FloatPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float value);
385 typedef void (*FloatArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *values);
386 typedef void (*FloatArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const float *values);
387 typedef void (*FloatPropertyRangeFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *min, float *max, float *softmin, float *softmax);
388 typedef void (*StringPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, char *value);
389 typedef int (*StringPropertyLengthFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
390 typedef void (*StringPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const char *value);
391 typedef int (*EnumPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
392 typedef void (*EnumPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
393 /* same as PropEnumItemFunc */
394 typedef const EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, struct PropertyRNA *prop, bool *r_free);
395
396 typedef struct PropertyRNA PropertyRNA;
397
398 /* Parameter List */
399
400 typedef struct ParameterList {
401         /* storage for parameters */
402         void *data;
403
404         /* function passed at creation time */
405         struct FunctionRNA *func;
406
407         /* store the parameter size */
408         int alloc_size;
409
410         int arg_count, ret_count;
411 } ParameterList;
412
413 typedef struct ParameterIterator {
414         struct ParameterList *parms;
415         /* PointerRNA funcptr; */ /*UNUSED*/
416         void *data;
417         int size, offset;
418
419         PropertyRNA *parm;
420         int valid;
421 } ParameterIterator;
422
423 /* mainly to avoid confusing casts */
424 typedef struct ParameterDynAlloc {
425         intptr_t array_tot; /* important, this breaks when set to an int */
426         void *array;
427 } ParameterDynAlloc;
428
429 /* Function */
430
431 typedef enum FunctionFlag {
432         /***** Options affecting callback signature. *****/
433         /* Those add additional parameters at the beginning of the C callback, like that:
434          *     rna_my_func([ID *_selfid],
435          *                 [<DNA_STRUCT> *self|StructRNA *type],
436          *                 [Main *bmain],
437          *                 [bContext *C],
438          *                 [ReportList *reports],
439          *                 <other RNA-defined parameters>);
440          */
441         /* Pass ID owning 'self' data (i.e. ptr->id.data, might be same as self in case data is an ID...). */
442         FUNC_USE_SELF_ID       = (1 << 11),
443
444         /* Do not pass the object (DNA struct pointer) from which it is called, used to define static or class functions. */
445         FUNC_NO_SELF           = (1 << 0),
446         /* Pass RNA type, used to define class functions, only valid when FUNC_NO_SELF is set. */
447         FUNC_USE_SELF_TYPE     = (1 << 1),
448
449         /* Pass Main, bContext and/or ReportList. */
450         FUNC_USE_MAIN          = (1 << 2),
451         FUNC_USE_CONTEXT       = (1 << 3),
452         FUNC_USE_REPORTS       = (1 << 4),
453
454
455         /***** Registering of python subclasses. *****/
456         /* This function is part of the registerable class' interface, and can be implemented/redefined in python. */
457         FUNC_REGISTER          = (1 << 5),
458         /* Subclasses can choose not to implement this function. */
459         FUNC_REGISTER_OPTIONAL = FUNC_REGISTER | (1 << 6),
460         /* If not set, the python function implementing this call is not allowed to write into data-blocks.
461          * Except for WindowManager and Screen currently, see rna_id_write_error() in bpy_rna.c */
462         FUNC_ALLOW_WRITE       = (1 << 12),
463
464         /***** Internal flags. *****/
465         /* UNUSED CURRENTLY? ??? */
466         FUNC_BUILTIN           = (1 << 7),
467         /* UNUSED CURRENTLY. ??? */
468         FUNC_EXPORT            = (1 << 8),
469         /* Function has been defined at runtime, not statically in RNA source code. */
470         FUNC_RUNTIME           = (1 << 9),
471         /* UNUSED CURRENTLY? Function owns its identifier and description strings, and has to free them when deleted. */
472         FUNC_FREE_POINTERS     = (1 << 10),
473 } FunctionFlag;
474
475 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
476
477 typedef struct FunctionRNA FunctionRNA;
478
479 /* Struct */
480
481 typedef enum StructFlag {
482         /* indicates that this struct is an ID struct, and to use refcounting */
483         STRUCT_ID              = (1 << 0),
484         STRUCT_ID_REFCOUNT     = (1 << 1),
485         STRUCT_UNDO            = (1 << 2), /* defaults on, clear for user preferences and similar */
486
487         /* internal flags */
488         STRUCT_RUNTIME         = (1 << 3),
489         STRUCT_GENERATED       = (1 << 4),
490         STRUCT_FREE_POINTERS   = (1 << 5),
491         STRUCT_NO_IDPROPERTIES = (1 << 6), /* Menus and Panels don't need properties */
492         STRUCT_NO_DATABLOCK_IDPROPERTIES = (1 << 7), /* e.g. for Operator */
493         STRUCT_CONTAINS_DATABLOCK_IDPROPERTIES = (1 << 8), /* for PropertyGroup which contains pointers to datablocks */
494         STRUCT_PUBLIC_NAMESPACE = (1 << 9), /* Added to type-map #BlenderRNA.structs_map */
495         STRUCT_PUBLIC_NAMESPACE_INHERIT = (1 << 10), /* All subtypes are added too. */
496 } StructFlag;
497
498 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
499 typedef int (*StructCallbackFunc)(struct bContext *C, struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
500 typedef void (*StructFreeFunc)(void *data);
501 typedef struct StructRNA *(*StructRegisterFunc)(
502         struct Main *bmain, struct ReportList *reports, void *data, const char *identifier,
503         StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
504
505 typedef void (*StructUnregisterFunc)(struct Main *bmain, struct StructRNA *type);
506 typedef void **(*StructInstanceFunc)(PointerRNA *ptr);
507
508 typedef struct StructRNA StructRNA;
509
510 /* Blender RNA
511  *
512  * Root RNA data structure that lists all struct types. */
513
514 typedef struct BlenderRNA BlenderRNA;
515
516 /* Extending
517  *
518  * This struct must be embedded in *Type structs in
519  * order to make then definable through RNA. */
520
521 typedef struct ExtensionRNA {
522         void *data;
523         StructRNA *srna;
524         StructCallbackFunc call;
525         StructFreeFunc free;
526 } ExtensionRNA;
527
528 #ifdef __cplusplus
529 }
530 #endif
531
532 #endif /* __RNA_TYPES_H__ */