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