Merge with trunk r37475.
[blender.git] / source / blender / makesrna / RNA_types.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/makesrna/RNA_types.h
26  *  \ingroup RNA
27  */
28
29
30 #include "BLO_sys_types.h"
31
32 #ifndef RNA_TYPES_H
33 #define RNA_TYPES_H
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct ParameterList;
40 struct FunctionRNA;
41 struct PropertyRNA;
42 struct EnumPropertyRNA;
43 struct StructRNA;
44 struct BlenderRNA;
45 struct IDProperty;
46 struct bContext;
47 struct Main;
48 struct ReportList;
49
50 /** Pointer
51  *
52  * RNA pointers are not a single C pointer but include the type,
53  * and a pointer to the ID struct that owns the struct, since
54  * in some cases this information is needed to correctly get/set
55  * the properties and validate them. */
56
57 typedef struct PointerRNA {
58         struct {
59                 void *data;
60         } id;
61
62         struct StructRNA *type;
63         void *data;
64 } PointerRNA;
65
66 typedef struct PropertyPointerRNA {
67         PointerRNA ptr;
68         struct PropertyRNA *prop;
69 } PropertyPointerRNA;
70
71 /* Property */
72
73 typedef enum PropertyType {
74         PROP_BOOLEAN = 0,
75         PROP_INT = 1,
76         PROP_FLOAT = 2,
77         PROP_STRING = 3,
78         PROP_ENUM = 4,
79         PROP_POINTER = 5,
80         PROP_COLLECTION = 6
81 } PropertyType;
82
83 /* also update rna_property_subtype_unit when you change this */
84 typedef enum PropertyUnit {
85         PROP_UNIT_NONE = (0<<16),
86         PROP_UNIT_LENGTH = (1<<16),                     /* m */
87         PROP_UNIT_AREA = (2<<16),                       /* m^2 */
88         PROP_UNIT_VOLUME = (3<<16),                     /* m^3 */
89         PROP_UNIT_MASS = (4<<16),                       /* kg */
90         PROP_UNIT_ROTATION = (5<<16),           /* radians */
91         PROP_UNIT_TIME = (6<<16),                       /* frame */
92         PROP_UNIT_VELOCITY = (7<<16),           /* m/s */
93         PROP_UNIT_ACCELERATION = (8<<16)        /* m/(s^2) */
94 } PropertyUnit;
95
96 #define RNA_SUBTYPE_UNIT(subtype) ((subtype) & 0x00FF0000)
97 #define RNA_SUBTYPE_VALUE(subtype) ((subtype) & ~0x00FF0000)
98 #define RNA_SUBTYPE_UNIT_VALUE(subtype) ((subtype)>>16)
99
100 #define RNA_ENUM_BITFLAG_SIZE 32
101
102 /* also update enums in bpy_props.c when adding items here */
103 typedef enum PropertySubType {
104         PROP_NONE = 0,
105
106         /* strings */
107         PROP_FILEPATH = 1,
108         PROP_DIRPATH = 2,
109         PROP_FILENAME = 3,
110
111         /* numbers */
112         PROP_UNSIGNED = 13,
113         PROP_PERCENTAGE = 14,
114         PROP_FACTOR = 15,
115         PROP_ANGLE = 16|PROP_UNIT_ROTATION,
116         PROP_TIME = 17|PROP_UNIT_TIME,
117         PROP_DISTANCE = 18|PROP_UNIT_LENGTH,
118
119         /* number arrays */
120         PROP_COLOR = 20,
121         PROP_TRANSLATION = 21|PROP_UNIT_LENGTH,
122         PROP_DIRECTION = 22,
123         PROP_VELOCITY = 23|PROP_UNIT_VELOCITY,
124         PROP_ACCELERATION = 24|PROP_UNIT_ACCELERATION,
125         PROP_MATRIX = 25,
126         PROP_EULER = 26|PROP_UNIT_ROTATION,
127         PROP_QUATERNION = 27,
128         PROP_AXISANGLE = 28,
129         PROP_XYZ = 29,
130         PROP_XYZ_LENGTH = 29|PROP_UNIT_LENGTH,
131         PROP_COLOR_GAMMA = 30,
132         PROP_COORDS = 31, /* generic array, no units applied, only that x/y/z/w are used (python vec) */
133
134         /* booleans */
135         PROP_LAYER = 40,
136         PROP_LAYER_MEMBER = 41
137 } PropertySubType;
138
139 /* Make sure enums are updated with thses */
140 typedef enum PropertyFlag {
141         /* editable means the property is editable in the user
142          * interface, properties are editable by default except
143          * for pointers and collections. */
144         PROP_EDITABLE = 1<<0,
145
146         /* this property is editable even if it is lib linked,
147          * meaning it will get lost on reload, but it's useful
148          * for editing. */
149         PROP_LIB_EXCEPTION = 1<<16,
150
151         /* animateable means the property can be driven by some
152          * other input, be it animation curves, expressions, ..
153          * properties are animateable by default except for pointers
154          * and collections */
155         PROP_ANIMATABLE = 1<<1,
156
157         /* icon */
158         PROP_ICONS_CONSECUTIVE = 1<<12,
159
160         /* hidden in  the user interface */
161         PROP_HIDDEN = 1<<19,
162         /* do not write in presets */
163         PROP_SKIP_SAVE = 1<<28,
164
165         /* function paramater flags */
166         PROP_REQUIRED = 1<<2,
167         PROP_OUTPUT = 1<<3,
168         PROP_RNAPTR = 1<<11,
169         /* registering */
170         PROP_REGISTER = 1<<4,
171         PROP_REGISTER_OPTIONAL = (1<<4)|(1<<5),
172
173         /* pointers */
174         PROP_ID_REFCOUNT = 1<<6,
175
176         /* disallow assigning a variable to its self, eg an object tracking its self
177          * only apply this to types that are derived from an ID ()*/
178         PROP_ID_SELF_CHECK = 1<<20,
179         PROP_NEVER_NULL = 1<<18,
180         /* currently only used for UI, this is similar to PROP_NEVER_NULL
181          * except that the value may be NULL at times, used for ObData, where an Empty's will be NULL
182          * but setting NULL on a mesh object is not possible. So, if its not NULL, setting NULL cant be done! */
183         PROP_NEVER_UNLINK = 1<<25,
184
185         /* flag contains multiple enums.
186          * note: not to be confused with prop->enumbitflags
187          * this exposes the flag as multiple options in python and the UI.
188          *
189          * note: these can't be animated so use with care.
190           */
191         PROP_ENUM_FLAG = 1<<21,
192
193         /* need context for update function */
194         PROP_CONTEXT_UPDATE = 1<<22,
195         PROP_CONTEXT_PROPERTY_UPDATE = (1<<22)|(1<<27),
196
197         /* Use for arrays or for any data that should not have a referene kept
198          * most common case is functions that return arrays where the array */
199         PROP_THICK_WRAP = 1<<23,
200
201         /* Reject values outside limits, use for python api only so far
202          * this is for use when silently clamping string length will give
203          * bad behavior later. Could also enforce this for INT's and other types.
204          * note: currently no support for function arguments or non utf8 paths (filepaths) */
205         PROP_NEVER_CLAMP = 1<<26,
206
207         /* internal flags */
208         PROP_BUILTIN = 1<<7,
209         PROP_EXPORT = 1<<8,
210         PROP_RUNTIME = 1<<9,
211         PROP_IDPROPERTY = 1<<10,
212         PROP_RAW_ACCESS = 1<<13,
213         PROP_RAW_ARRAY = 1<<14,
214         PROP_FREE_POINTERS = 1<<15,
215         PROP_DYNAMIC = 1<<17, /* for dynamic arrays, and retvals of type string */
216         PROP_ENUM_NO_CONTEXT = 1<<24 /* for enum that shouldn't be contextual */
217 } PropertyFlag;
218
219 typedef struct CollectionPropertyIterator {
220         /* internal */
221         PointerRNA parent;
222         PointerRNA builtin_parent;
223         struct PropertyRNA *prop;
224         void *internal;
225         int idprop;
226         int level;
227
228         /* external */
229         int valid;
230         PointerRNA ptr;
231 } CollectionPropertyIterator;
232
233 typedef struct CollectionPointerLink {
234         struct CollectionPointerLink *next, *prev;
235         PointerRNA ptr;
236 } CollectionPointerLink;
237
238 typedef enum RawPropertyType {
239         PROP_RAW_UNSET=-1,
240         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
241         PROP_RAW_SHORT,
242         PROP_RAW_CHAR,
243         PROP_RAW_DOUBLE,
244         PROP_RAW_FLOAT
245 } RawPropertyType;
246
247 typedef struct RawArray {
248         void *array;
249         RawPropertyType type;
250         int len;
251         int stride;
252 } RawArray;
253
254 typedef struct EnumPropertyItem {
255         int value;
256         const char *identifier;
257         int icon;
258         const char *name;
259         const char *description;
260 } EnumPropertyItem;
261
262 /* this is a copy of 'PropEnumItemFunc' defined in rna_internal_types.h */
263 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, struct PropertyRNA *prop, int *free);
264
265 typedef struct PropertyRNA PropertyRNA;
266
267 /* Parameter List */
268
269 typedef struct ParameterList {
270         /* storage for parameters */
271         void *data;
272
273         /* store the parameter size */
274         int alloc_size;
275
276         int arg_count, ret_count;
277
278         /* function passed at creation time */
279         struct FunctionRNA *func;
280 } ParameterList;
281
282 typedef struct ParameterIterator {
283         struct ParameterList *parms;
284         PointerRNA funcptr;
285         void *data;
286         int size, offset;
287
288         PropertyRNA *parm;
289         int valid;
290 } ParameterIterator;
291
292 /* mainly to avoid confusing casts */
293 typedef struct ParameterDynAlloc {
294         intptr_t array_tot; /* important, this breaks when set to an int */
295         void *array;
296 } ParameterDynAlloc;
297
298 /* Function */
299
300 typedef enum FunctionFlag {
301         FUNC_NO_SELF = 1, /* for static functions */
302         FUNC_USE_CONTEXT = 2,
303         FUNC_USE_REPORTS = 4,
304         FUNC_USE_SELF_ID = 2048,
305
306         /* registering */
307         FUNC_REGISTER = 8,
308         FUNC_REGISTER_OPTIONAL = 8|16,
309
310         /* internal flags */
311         FUNC_BUILTIN = 128,
312         FUNC_EXPORT = 256,
313         FUNC_RUNTIME = 512,
314         FUNC_FREE_POINTERS = 1024
315 } FunctionFlag;
316
317 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
318
319 typedef struct FunctionRNA FunctionRNA;
320
321 /* Struct */
322
323 typedef enum StructFlag {
324         /* indicates that this struct is an ID struct, and to use refcounting */
325         STRUCT_ID = 1,
326         STRUCT_ID_REFCOUNT = 2,
327
328         /* internal flags */
329         STRUCT_RUNTIME = 4,
330         STRUCT_GENERATED = 8,
331         STRUCT_FREE_POINTERS = 16,
332         STRUCT_NO_IDPROPERTIES = 32 /* Menu's and Panels don't need properties */
333 } StructFlag;
334
335 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
336 typedef int (*StructCallbackFunc)(struct bContext *C, struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
337 typedef void (*StructFreeFunc)(void *data);
338 typedef struct StructRNA *(*StructRegisterFunc)(struct Main *bmain, struct ReportList *reports, void *data,
339         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
340 typedef void (*StructUnregisterFunc)(struct Main *bmain, struct StructRNA *type);
341 typedef void **(*StructInstanceFunc)(PointerRNA *ptr);
342
343 typedef struct StructRNA StructRNA;
344
345 /* Blender RNA
346  *
347  * Root RNA data structure that lists all struct types. */
348
349 typedef struct BlenderRNA BlenderRNA;
350
351 /* Extending
352  *
353  * This struct must be embedded in *Type structs in
354  * order to make then definable through RNA. */
355
356 typedef struct ExtensionRNA {
357         void *data;
358         StructRNA *srna;
359         StructCallbackFunc call;
360         StructFreeFunc free;
361         
362 } ExtensionRNA;
363
364 #ifdef __cplusplus
365 }
366 #endif
367
368 #endif /* RNA_TYPES_H */