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