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