Py-Driver: add 'self' option
[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 /* also update enums in bpy_props.c when adding items here
112  * watch it: these values are written to files as part of
113  * node socket button subtypes!
114  */
115 typedef enum PropertySubType {
116         PROP_NONE              = 0,
117
118         /* strings */
119         PROP_FILEPATH          = 1,
120         PROP_DIRPATH           = 2,
121         PROP_FILENAME          = 3,
122         PROP_BYTESTRING        = 4, /* a string which should be represented as bytes in python, NULL terminated though. */
123         /* 5 was used by "PROP_TRANSLATE" sub-type, which is now a flag. */
124         PROP_PASSWORD          = 6, /* a string which should not be displayed in UI */
125
126         /* numbers */
127         PROP_PIXEL             = 12,
128         PROP_UNSIGNED          = 13,
129         PROP_PERCENTAGE        = 14,
130         PROP_FACTOR            = 15,
131         PROP_ANGLE             = 16 | PROP_UNIT_ROTATION,
132         PROP_TIME              = 17 | PROP_UNIT_TIME,
133         /* distance in 3d space, don't use for pixel distance for eg. */
134         PROP_DISTANCE          = 18 | PROP_UNIT_LENGTH,
135         PROP_DISTANCE_CAMERA   = 19 | PROP_UNIT_CAMERA,
136
137         /* number arrays */
138         PROP_COLOR             = 20,
139         PROP_TRANSLATION       = 21 | PROP_UNIT_LENGTH,
140         PROP_DIRECTION         = 22,
141         PROP_VELOCITY          = 23 | PROP_UNIT_VELOCITY,
142         PROP_ACCELERATION      = 24 | PROP_UNIT_ACCELERATION,
143         PROP_MATRIX            = 25,
144         PROP_EULER             = 26 | PROP_UNIT_ROTATION,
145         PROP_QUATERNION        = 27,
146         PROP_AXISANGLE         = 28,
147         PROP_XYZ               = 29,
148         PROP_XYZ_LENGTH        = 29 | PROP_UNIT_LENGTH,
149         PROP_COLOR_GAMMA       = 30, /* used for colors which would be color managed before display */
150         PROP_COORDS            = 31, /* generic array, no units applied, only that x/y/z/w are used (python vec) */
151
152         /* booleans */
153         PROP_LAYER             = 40,
154         PROP_LAYER_MEMBER      = 41,
155 } PropertySubType;
156
157 /* Make sure enums are updated with these */
158 /* HIGHEST FLAG IN USE: 1 << 31 */
159 typedef enum PropertyFlag {
160         /* editable means the property is editable in the user
161          * interface, properties are editable by default except
162          * for pointers and collections. */
163         PROP_EDITABLE                = (1 << 0),
164
165         /* this property is editable even if it is lib linked,
166          * meaning it will get lost on reload, but it's useful
167          * for editing. */
168         PROP_LIB_EXCEPTION           = (1 << 16),
169
170         /* animatable means the property can be driven by some
171          * other input, be it animation curves, expressions, ..
172          * properties are animatable by default except for pointers
173          * and collections */
174         PROP_ANIMATABLE              = (1 << 1),
175
176         /* This flag means when the property's widget is in 'textedit' mode, it will be updated after every typed char,
177          * instead of waiting final validation. Used e.g. for text searchbox. */
178         PROP_TEXTEDIT_UPDATE         = (1 << 31),
179
180         /* icon */
181         PROP_ICONS_CONSECUTIVE       = (1 << 12),
182
183         /* hidden in  the user interface */
184         PROP_HIDDEN                  = (1 << 19),
185         /* do not write in presets */
186         PROP_SKIP_SAVE               = (1 << 28),
187
188         /* function parameter flags */
189         PROP_REQUIRED                = (1 << 2),
190         PROP_OUTPUT                  = (1 << 3),
191         PROP_RNAPTR                  = (1 << 11),
192         /* This allows for non-breaking API updates, when adding non-critical new parameter to a callback function.
193          * This way, old py code defining funcs without that parameter would still work.
194          * WARNING: any parameter after the first PYFUNC_OPTIONAL one will be considered as optional!
195          * NOTE: only for input parameters!
196          */
197         PROP_PYFUNC_OPTIONAL         = (1 << 30),
198         /* registering */
199         PROP_REGISTER                = (1 << 4),
200         PROP_REGISTER_OPTIONAL       = PROP_REGISTER | (1 << 5),
201
202         /* numbers */
203
204         /* each value is related proportionally (object scale, image size) */
205         PROP_PROPORTIONAL            = (1 << 26),
206
207         /* pointers */
208         PROP_ID_REFCOUNT             = (1 << 6),
209
210         /* disallow assigning a variable to its self, eg an object tracking its self
211          * only apply this to types that are derived from an ID ()*/
212         PROP_ID_SELF_CHECK           = (1 << 20),
213         /* use for...
214          * - pointers: in the UI and python so unsetting or setting to None won't work
215          * - strings: so our internal generated get/length/set functions know to do NULL checks before access [#30865] */
216         PROP_NEVER_NULL              = (1 << 18),
217         /* currently only used for UI, this is similar to PROP_NEVER_NULL
218          * except that the value may be NULL at times, used for ObData, where an Empty's will be NULL
219          * but setting NULL on a mesh object is not possible. So, if its not NULL, setting NULL cant be done! */
220         PROP_NEVER_UNLINK            = (1 << 25),
221
222         /* flag contains multiple enums.
223          * note: not to be confused with prop->enumbitflags
224          * this exposes the flag as multiple options in python and the UI.
225          *
226          * note: these can't be animated so use with care.
227          */
228         PROP_ENUM_FLAG               = (1 << 21),
229
230         /* need context for update function */
231         PROP_CONTEXT_UPDATE          = (1 << 22),
232         PROP_CONTEXT_PROPERTY_UPDATE = (1 << 22) | (1 << 27),
233
234         /* Use for arrays or for any data that should not have a reference kept
235          * most common case is functions that return arrays where the array */
236         PROP_THICK_WRAP              = (1 << 23),
237
238         /* internal flags */
239         PROP_BUILTIN                 = (1 << 7),
240         PROP_EXPORT                  = (1 << 8),
241         PROP_RUNTIME                 = (1 << 9),
242         PROP_IDPROPERTY              = (1 << 10),
243         PROP_RAW_ACCESS              = (1 << 13),
244         PROP_RAW_ARRAY               = (1 << 14),
245         PROP_FREE_POINTERS           = (1 << 15),
246         PROP_DYNAMIC                 = (1 << 17), /* for dynamic arrays, and retvals of type string */
247         PROP_ENUM_NO_CONTEXT         = (1 << 24), /* for enum that shouldn't be contextual */
248         PROP_ENUM_NO_TRANSLATE       = (1 << 29), /* for enums not to be translated (e.g. renderlayers' names in nodes) */
249 } PropertyFlag;
250
251 struct CollectionPropertyIterator;
252 struct Link;
253 typedef int (*IteratorSkipFunc)(struct CollectionPropertyIterator *iter, void *data);
254
255 typedef struct ListBaseIterator {
256         struct Link *link;
257         int flag;
258         IteratorSkipFunc skip;
259 } ListBaseIterator;
260
261 typedef struct ArrayIterator {
262         char *ptr;
263         char *endptr;  /* past the last valid pointer, only for comparisons, ignores skipped values */
264         void *free_ptr; /* will be freed if set */
265         int itemsize;
266
267         /* array length with no skip functions applied, take care not to compare against index from animsys
268          * or python indices */
269         int length;
270
271         /* optional skip function, when set the array as viewed by rna can contain only a subset of the members.
272          * this changes indices so quick array index lookups are not possible when skip function is used. */
273         IteratorSkipFunc skip;
274 } ArrayIterator;
275
276 typedef struct CollectionPropertyIterator {
277         /* internal */
278         PointerRNA parent;
279         PointerRNA builtin_parent;
280         struct PropertyRNA *prop;
281         union {
282                 ArrayIterator array;
283                 ListBaseIterator listbase;
284         } internal;
285         int idprop;
286         int level;
287
288         /* external */
289         PointerRNA ptr;
290         int valid;
291 } CollectionPropertyIterator;
292
293 typedef struct CollectionPointerLink {
294         struct CollectionPointerLink *next, *prev;
295         PointerRNA ptr;
296 } CollectionPointerLink;
297
298 /* Copy of ListBase for RNA... */
299 typedef struct CollectionListBase {
300         struct CollectionPointerLink *first, *last;
301 } CollectionListBase;
302
303 typedef enum RawPropertyType {
304         PROP_RAW_UNSET = -1,
305         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
306         PROP_RAW_SHORT,
307         PROP_RAW_CHAR,
308         PROP_RAW_DOUBLE,
309         PROP_RAW_FLOAT
310 } RawPropertyType;
311
312 typedef struct RawArray {
313         void *array;
314         RawPropertyType type;
315         int len;
316         int stride;
317 } RawArray;
318
319 /**
320  * This struct is are typically defined in arrays which define an *enum* for RNA,
321  * which is used by the RNA API both for user-interface and the Python API.
322  */
323 typedef struct EnumPropertyItem {
324         /** The internal value of the enum, not exposed to users. */
325         int value;
326         /**
327          * Note that identifiers must be unique within the array,
328          * by convention they're upper case with underscores for separators.
329          * - An empty string is used to define menu separators.
330          * - NULL denotes the end of the array of items.
331          */
332         const char *identifier;
333         /** Optional icon, typically 'ICON_NONE' */
334         int icon;
335         /** Name displayed in the interface. */
336         const char *name;
337         /** Longer description used in the interface. */
338         const char *description;
339 } EnumPropertyItem;
340
341 /* extended versions with PropertyRNA argument */
342 typedef int (*BooleanPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
343 typedef void (*BooleanPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
344 typedef void (*BooleanArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values);
345 typedef void (*BooleanArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values);
346 typedef int (*IntPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
347 typedef void (*IntPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
348 typedef void (*IntArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values);
349 typedef void (*IntArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values);
350 typedef void (*IntPropertyRangeFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *min, int *max, int *softmin, int *softmax);
351 typedef float (*FloatPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
352 typedef void (*FloatPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float value);
353 typedef void (*FloatArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *values);
354 typedef void (*FloatArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const float *values);
355 typedef void (*FloatPropertyRangeFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *min, float *max, float *softmin, float *softmax);
356 typedef void (*StringPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, char *value);
357 typedef int (*StringPropertyLengthFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
358 typedef void (*StringPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const char *value);
359 typedef int (*EnumPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
360 typedef void (*EnumPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
361 /* same as PropEnumItemFunc */
362 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, struct PropertyRNA *prop, bool *r_free);
363
364 typedef struct PropertyRNA PropertyRNA;
365
366 /* Parameter List */
367
368 typedef struct ParameterList {
369         /* storage for parameters */
370         void *data;
371
372         /* function passed at creation time */
373         struct FunctionRNA *func;
374
375         /* store the parameter size */
376         int alloc_size;
377
378         int arg_count, ret_count;
379 } ParameterList;
380
381 typedef struct ParameterIterator {
382         struct ParameterList *parms;
383         /* PointerRNA funcptr; */ /*UNUSED*/
384         void *data;
385         int size, offset;
386
387         PropertyRNA *parm;
388         int valid;
389 } ParameterIterator;
390
391 /* mainly to avoid confusing casts */
392 typedef struct ParameterDynAlloc {
393         intptr_t array_tot; /* important, this breaks when set to an int */
394         void *array;
395 } ParameterDynAlloc;
396
397 /* Function */
398
399 typedef enum FunctionFlag {
400         FUNC_NO_SELF           = (1 << 0), /* for static functions */
401         FUNC_USE_SELF_TYPE     = (1 << 1), /* for class methods, only used when FUNC_NO_SELF is set */
402         FUNC_USE_MAIN          = (1 << 2),
403         FUNC_USE_CONTEXT       = (1 << 3),
404         FUNC_USE_REPORTS       = (1 << 4),
405         FUNC_USE_SELF_ID       = (1 << 11),
406         FUNC_ALLOW_WRITE       = (1 << 12),
407
408         /* registering */
409         FUNC_REGISTER          = (1 << 5),
410         FUNC_REGISTER_OPTIONAL = FUNC_REGISTER | (1 << 6),
411
412         /* internal flags */
413         FUNC_BUILTIN           = (1 << 7),
414         FUNC_EXPORT            = (1 << 8),
415         FUNC_RUNTIME           = (1 << 9),
416         FUNC_FREE_POINTERS     = (1 << 10),
417 } FunctionFlag;
418
419 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
420
421 typedef struct FunctionRNA FunctionRNA;
422
423 /* Struct */
424
425 typedef enum StructFlag {
426         /* indicates that this struct is an ID struct, and to use refcounting */
427         STRUCT_ID              = (1 << 0),
428         STRUCT_ID_REFCOUNT     = (1 << 1),
429         STRUCT_UNDO            = (1 << 2), /* defaults on, clear for user preferences and similar */
430
431         /* internal flags */
432         STRUCT_RUNTIME         = (1 << 3),
433         STRUCT_GENERATED       = (1 << 4),
434         STRUCT_FREE_POINTERS   = (1 << 5),
435         STRUCT_NO_IDPROPERTIES = (1 << 6), /* Menus and Panels don't need properties */
436 } StructFlag;
437
438 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
439 typedef int (*StructCallbackFunc)(struct bContext *C, struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
440 typedef void (*StructFreeFunc)(void *data);
441 typedef struct StructRNA *(*StructRegisterFunc)(
442         struct Main *bmain, struct ReportList *reports, void *data, const char *identifier,
443         StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
444
445 typedef void (*StructUnregisterFunc)(struct Main *bmain, struct StructRNA *type);
446 typedef void **(*StructInstanceFunc)(PointerRNA *ptr);
447
448 typedef struct StructRNA StructRNA;
449
450 /* Blender RNA
451  *
452  * Root RNA data structure that lists all struct types. */
453
454 typedef struct BlenderRNA BlenderRNA;
455
456 /* Extending
457  *
458  * This struct must be embedded in *Type structs in
459  * order to make then definable through RNA. */
460
461 typedef struct ExtensionRNA {
462         void *data;
463         StructRNA *srna;
464         StructCallbackFunc call;
465         StructFreeFunc free;
466         
467 } ExtensionRNA;
468
469 #ifdef __cplusplus
470 }
471 #endif
472
473 #endif /* __RNA_TYPES_H__ */