UI: Refactor timecode functions into BLI_timecode
[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, 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_PIXEL             = 12,
120         PROP_UNSIGNED          = 13,
121         PROP_PERCENTAGE        = 14,
122         PROP_FACTOR            = 15,
123         PROP_ANGLE             = 16 | PROP_UNIT_ROTATION,
124         PROP_TIME              = 17 | PROP_UNIT_TIME,
125         /* distance in 3d space, don't use for pixel distance for eg. */
126         PROP_DISTANCE          = 18 | PROP_UNIT_LENGTH,
127         PROP_DISTANCE_CAMERA   = 19 | PROP_UNIT_CAMERA,
128
129         /* number arrays */
130         PROP_COLOR             = 20,
131         PROP_TRANSLATION       = 21 | PROP_UNIT_LENGTH,
132         PROP_DIRECTION         = 22,
133         PROP_VELOCITY          = 23 | PROP_UNIT_VELOCITY,
134         PROP_ACCELERATION      = 24 | PROP_UNIT_ACCELERATION,
135         PROP_MATRIX            = 25,
136         PROP_EULER             = 26 | PROP_UNIT_ROTATION,
137         PROP_QUATERNION        = 27,
138         PROP_AXISANGLE         = 28,
139         PROP_XYZ               = 29,
140         PROP_XYZ_LENGTH        = 29 | PROP_UNIT_LENGTH,
141         PROP_COLOR_GAMMA       = 30, /* used for colors which would be color managed before display */
142         PROP_COORDS            = 31, /* generic array, no units applied, only that x/y/z/w are used (python vec) */
143
144         /* booleans */
145         PROP_LAYER             = 40,
146         PROP_LAYER_MEMBER      = 41,
147 } PropertySubType;
148
149 /* Make sure enums are updated with these */
150 /* HIGHEST FLAG IN USE: 1 << 30 */
151 typedef enum PropertyFlag {
152         /* editable means the property is editable in the user
153          * interface, properties are editable by default except
154          * for pointers and collections. */
155         PROP_EDITABLE                = (1 << 0),
156
157         /* this property is editable even if it is lib linked,
158          * meaning it will get lost on reload, but it's useful
159          * for editing. */
160         PROP_LIB_EXCEPTION           = (1 << 16),
161
162         /* animatable means the property can be driven by some
163          * other input, be it animation curves, expressions, ..
164          * properties are animatable by default except for pointers
165          * and collections */
166         PROP_ANIMATABLE              = (1 << 1),
167
168         /* icon */
169         PROP_ICONS_CONSECUTIVE       = (1 << 12),
170
171         /* hidden in  the user interface */
172         PROP_HIDDEN                  = (1 << 19),
173         /* do not write in presets */
174         PROP_SKIP_SAVE               = (1 << 28),
175
176         /* function parameter flags */
177         PROP_REQUIRED                = (1 << 2),
178         PROP_OUTPUT                  = (1 << 3),
179         PROP_RNAPTR                  = (1 << 11),
180         /* This allows for non-breaking API updates, when adding non-critical new parameter to a callback function.
181          * This way, old py code defining funcs without that parameter would still work.
182          * WARNING: any parameter after the first PYFUNC_OPTIONAL one will be considered as optional!
183          * NOTE: only for input parameters!
184          */
185         PROP_PYFUNC_OPTIONAL         = (1 << 30),
186         /* registering */
187         PROP_REGISTER                = (1 << 4),
188         PROP_REGISTER_OPTIONAL       = PROP_REGISTER | (1 << 5),
189
190         /* pointers */
191         PROP_ID_REFCOUNT             = (1 << 6),
192
193         /* disallow assigning a variable to its self, eg an object tracking its self
194          * only apply this to types that are derived from an ID ()*/
195         PROP_ID_SELF_CHECK           = (1 << 20),
196         /* use for...
197          * - pointers: in the UI and python so unsetting or setting to None won't work
198          * - strings: so our internal generated get/length/set functions know to do NULL checks before access [#30865] */
199         PROP_NEVER_NULL              = (1 << 18),
200         /* currently only used for UI, this is similar to PROP_NEVER_NULL
201          * except that the value may be NULL at times, used for ObData, where an Empty's will be NULL
202          * but setting NULL on a mesh object is not possible. So, if its not NULL, setting NULL cant be done! */
203         PROP_NEVER_UNLINK            = (1 << 25),
204
205         /* flag contains multiple enums.
206          * note: not to be confused with prop->enumbitflags
207          * this exposes the flag as multiple options in python and the UI.
208          *
209          * note: these can't be animated so use with care.
210          */
211         PROP_ENUM_FLAG               = (1 << 21),
212
213         /* need context for update function */
214         PROP_CONTEXT_UPDATE          = (1 << 22),
215         PROP_CONTEXT_PROPERTY_UPDATE = (1 << 22) | (1 << 27),
216
217         /* Use for arrays or for any data that should not have a reference kept
218          * most common case is functions that return arrays where the array */
219         PROP_THICK_WRAP              = (1 << 23),
220
221         /* Reject values outside limits, use for python api only so far
222          * this is for use when silently clamping string length will give
223          * bad behavior later. Could also enforce this for INT's and other types.
224          * note: currently no support for function arguments or non utf8 paths (filepaths) */
225         PROP_NEVER_CLAMP             = (1 << 26),
226
227         /* internal flags */
228         PROP_BUILTIN                 = (1 << 7),
229         PROP_EXPORT                  = (1 << 8),
230         PROP_RUNTIME                 = (1 << 9),
231         PROP_IDPROPERTY              = (1 << 10),
232         PROP_RAW_ACCESS              = (1 << 13),
233         PROP_RAW_ARRAY               = (1 << 14),
234         PROP_FREE_POINTERS           = (1 << 15),
235         PROP_DYNAMIC                 = (1 << 17), /* for dynamic arrays, and retvals of type string */
236         PROP_ENUM_NO_CONTEXT         = (1 << 24), /* for enum that shouldn't be contextual */
237         PROP_ENUM_NO_TRANSLATE       = (1 << 29), /* for enums not to be translated (e.g. renderlayers' names in nodes) */
238 } PropertyFlag;
239
240 typedef struct CollectionPropertyIterator {
241         /* internal */
242         PointerRNA parent;
243         PointerRNA builtin_parent;
244         struct PropertyRNA *prop;
245         void *internal;
246         int idprop;
247         int level;
248
249         /* external */
250         PointerRNA ptr;
251         int valid;
252 } CollectionPropertyIterator;
253
254 typedef struct CollectionPointerLink {
255         struct CollectionPointerLink *next, *prev;
256         PointerRNA ptr;
257 } CollectionPointerLink;
258
259 typedef enum RawPropertyType {
260         PROP_RAW_UNSET = -1,
261         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
262         PROP_RAW_SHORT,
263         PROP_RAW_CHAR,
264         PROP_RAW_DOUBLE,
265         PROP_RAW_FLOAT
266 } RawPropertyType;
267
268 typedef struct RawArray {
269         void *array;
270         RawPropertyType type;
271         int len;
272         int stride;
273 } RawArray;
274
275 typedef struct EnumPropertyItem {
276         int value;
277         const char *identifier;
278         int icon;
279         const char *name;
280         const char *description;
281 } EnumPropertyItem;
282
283 /* extended versions with PropertyRNA argument */
284 typedef int (*BooleanPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
285 typedef void (*BooleanPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
286 typedef void (*BooleanArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values);
287 typedef void (*BooleanArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values);
288 typedef int (*IntPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
289 typedef void (*IntPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
290 typedef void (*IntArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values);
291 typedef void (*IntArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values);
292 typedef void (*IntPropertyRangeFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *min, int *max, int *softmin, int *softmax);
293 typedef float (*FloatPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
294 typedef void (*FloatPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float value);
295 typedef void (*FloatArrayPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *values);
296 typedef void (*FloatArrayPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const float *values);
297 typedef void (*FloatPropertyRangeFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *min, float *max, float *softmin, float *softmax);
298 typedef void (*StringPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, char *value);
299 typedef int (*StringPropertyLengthFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
300 typedef void (*StringPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, const char *value);
301 typedef int (*EnumPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
302 typedef void (*EnumPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
303 /* same as PropEnumItemFunc */
304 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, struct PropertyRNA *prop, bool *r_free);
305
306 typedef struct PropertyRNA PropertyRNA;
307
308 /* Parameter List */
309
310 typedef struct ParameterList {
311         /* storage for parameters */
312         void *data;
313
314         /* function passed at creation time */
315         struct FunctionRNA *func;
316
317         /* store the parameter size */
318         int alloc_size;
319
320         int arg_count, ret_count;
321 } ParameterList;
322
323 typedef struct ParameterIterator {
324         struct ParameterList *parms;
325         /* PointerRNA funcptr; */ /*UNUSED*/
326         void *data;
327         int size, offset;
328
329         PropertyRNA *parm;
330         int valid;
331 } ParameterIterator;
332
333 /* mainly to avoid confusing casts */
334 typedef struct ParameterDynAlloc {
335         intptr_t array_tot; /* important, this breaks when set to an int */
336         void *array;
337 } ParameterDynAlloc;
338
339 /* Function */
340
341 typedef enum FunctionFlag {
342         FUNC_NO_SELF           = (1 << 0), /* for static functions */
343         FUNC_USE_SELF_TYPE     = (1 << 1), /* for class methods, only used when FUNC_NO_SELF is set */
344         FUNC_USE_MAIN          = (1 << 2),
345         FUNC_USE_CONTEXT       = (1 << 3),
346         FUNC_USE_REPORTS       = (1 << 4),
347         FUNC_USE_SELF_ID       = (1 << 11),
348         FUNC_ALLOW_WRITE       = (1 << 12),
349
350         /* registering */
351         FUNC_REGISTER          = (1 << 5),
352         FUNC_REGISTER_OPTIONAL = FUNC_REGISTER | (1 << 6),
353
354         /* internal flags */
355         FUNC_BUILTIN           = (1 << 7),
356         FUNC_EXPORT            = (1 << 8),
357         FUNC_RUNTIME           = (1 << 9),
358         FUNC_FREE_POINTERS     = (1 << 10),
359 } FunctionFlag;
360
361 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
362
363 typedef struct FunctionRNA FunctionRNA;
364
365 /* Struct */
366
367 typedef enum StructFlag {
368         /* indicates that this struct is an ID struct, and to use refcounting */
369         STRUCT_ID              = (1 << 0),
370         STRUCT_ID_REFCOUNT     = (1 << 1),
371         STRUCT_UNDO            = (1 << 2), /* defaults on, clear for user preferences and similar */
372
373         /* internal flags */
374         STRUCT_RUNTIME         = (1 << 3),
375         STRUCT_GENERATED       = (1 << 4),
376         STRUCT_FREE_POINTERS   = (1 << 5),
377         STRUCT_NO_IDPROPERTIES = (1 << 6), /* Menu's and Panels don't need properties */
378 } StructFlag;
379
380 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
381 typedef int (*StructCallbackFunc)(struct bContext *C, struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
382 typedef void (*StructFreeFunc)(void *data);
383 typedef struct StructRNA *(*StructRegisterFunc)(
384         struct Main *bmain, struct ReportList *reports, void *data, const char *identifier,
385         StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
386
387 typedef void (*StructUnregisterFunc)(struct Main *bmain, struct StructRNA *type);
388 typedef void **(*StructInstanceFunc)(PointerRNA *ptr);
389
390 typedef struct StructRNA StructRNA;
391
392 /* Blender RNA
393  *
394  * Root RNA data structure that lists all struct types. */
395
396 typedef struct BlenderRNA BlenderRNA;
397
398 /* Extending
399  *
400  * This struct must be embedded in *Type structs in
401  * order to make then definable through RNA. */
402
403 typedef struct ExtensionRNA {
404         void *data;
405         StructRNA *srna;
406         StructCallbackFunc call;
407         StructFreeFunc free;
408         
409 } ExtensionRNA;
410
411 #ifdef __cplusplus
412 }
413 #endif
414
415 #endif /* __RNA_TYPES_H__ */