rna flag PROP_ENUM_FLAG which makes rna props a tuple of enums when converted into...
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #ifndef RNA_TYPES
26 #define RNA_TYPES
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 struct ParameterList;
33 struct FunctionRNA;
34 struct PropertyRNA;
35 struct StructRNA;
36 struct BlenderRNA;
37 struct IDProperty;
38 struct bContext;
39 struct ReportList;
40
41 /* Pointer
42  *
43  * RNA pointers are not a single C pointer but include the type,
44  * and a pointer to the ID struct that owns the struct, since
45  * in some cases this information is needed to correctly get/set
46  * the properties and validate them. */
47
48 typedef struct PointerRNA {
49         struct {
50                 void *data;
51         } id;
52
53         struct StructRNA *type;
54         void *data;
55 } PointerRNA;
56
57 typedef struct PropertyPointerRNA {
58         PointerRNA ptr;
59         struct PropertyRNA *prop;
60 } PropertyPointerRNA;
61
62 /* Property */
63
64 typedef enum PropertyType {
65         PROP_BOOLEAN = 0,
66         PROP_INT = 1,
67         PROP_FLOAT = 2,
68         PROP_STRING = 3,
69         PROP_ENUM = 4,
70         PROP_POINTER = 5,
71         PROP_COLLECTION = 6
72 } PropertyType;
73
74 /* also update rna_property_subtype_unit when you change this */
75 typedef enum PropertyUnit {
76         PROP_UNIT_NONE = (0<<16),
77         PROP_UNIT_LENGTH = (1<<16),                     /* m */
78         PROP_UNIT_AREA = (2<<16),                       /* m^2 */
79         PROP_UNIT_VOLUME = (3<<16),                     /* m^3 */
80         PROP_UNIT_MASS = (4<<16),                       /* kg */
81         PROP_UNIT_ROTATION = (5<<16),           /* rad */
82         PROP_UNIT_TIME = (6<<16),                       /* frame */
83         PROP_UNIT_VELOCITY = (7<<16),           /* m/s */
84         PROP_UNIT_ACCELERATION = (8<<16)        /* m/(s^2) */
85 } PropertyUnit;
86
87 #define RNA_SUBTYPE_UNIT(subtype) (subtype & 0x00FF0000)
88 #define RNA_SUBTYPE_UNIT_VALUE(subtype) (subtype>>16)
89
90 #define RNA_ENUM_BITFLAG_SIZE 32
91
92 /* also update rna_property_subtypename when you change this */
93 typedef enum PropertySubType {
94         PROP_NONE = 0,
95
96         /* strings */
97         PROP_FILEPATH = 1,
98         PROP_DIRPATH = 2,
99         PROP_FILENAME = 3,
100
101         /* numbers */
102         PROP_UNSIGNED = 13,
103         PROP_PERCENTAGE = 14,
104         PROP_FACTOR = 15,
105         PROP_ANGLE = 16|PROP_UNIT_ROTATION,
106         PROP_TIME = 17|PROP_UNIT_TIME,
107         PROP_DISTANCE = 18|PROP_UNIT_LENGTH,
108
109         /* number arrays */
110         PROP_COLOR = 20,
111         PROP_TRANSLATION = 21|PROP_UNIT_LENGTH,
112         PROP_DIRECTION = 22,
113         PROP_VELOCITY = 23|PROP_UNIT_VELOCITY,
114         PROP_ACCELERATION = 24|PROP_UNIT_ACCELERATION,
115         PROP_MATRIX = 25,
116         PROP_EULER = 26|PROP_UNIT_ROTATION,
117         PROP_QUATERNION = 27,
118         PROP_AXISANGLE = 28,
119         PROP_XYZ = 29,
120         PROP_COLOR_GAMMA = 30,
121
122         /* booleans */
123         PROP_LAYER = 40,
124         PROP_LAYER_MEMBER = 41
125 } PropertySubType;
126
127 typedef enum PropertyFlag {
128         /* editable means the property is editable in the user
129          * interface, properties are editable by default except
130          * for pointers and collections. */
131         PROP_EDITABLE = 1<<0,
132
133         /* this property is editable even if it is lib linked,
134          * meaning it will get lost on reload, but it's useful
135          * for editing. */
136         PROP_LIB_EXCEPTION = 1<<16,
137
138         /* animateable means the property can be driven by some
139          * other input, be it animation curves, expressions, ..
140          * properties are animateable by default except for pointers
141          * and collections */
142         PROP_ANIMATEABLE = 1<<1,
143
144         /* icon */
145         PROP_ICONS_CONSECUTIVE = 1<<12,
146
147         /* hidden in  the user interface */
148         PROP_HIDDEN = 1<<19,
149
150         /* function paramater flags */
151         PROP_REQUIRED = 1<<2,
152         PROP_RETURN = 1<<3,
153         PROP_RNAPTR = 1<<11,
154         /* registering */
155         PROP_REGISTER = 1<<4,
156         PROP_REGISTER_OPTIONAL = (1<<4)|(1<<5),
157
158         /* pointers */
159         PROP_ID_REFCOUNT = 1<<6,
160
161         /* disallow assigning a variable to its self, eg an object tracking its self
162          * only apply this to types that are derived from an ID ()*/
163         PROP_ID_SELF_CHECK = 1<<20,
164         PROP_NEVER_NULL = 1<<18,
165
166         /* flag contains multiple enums */
167         PROP_ENUM_FLAG = 1<<21,
168
169         /* internal flags */
170         PROP_BUILTIN = 1<<7,
171         PROP_EXPORT = 1<<8,
172         PROP_RUNTIME = 1<<9,
173         PROP_IDPROPERTY = 1<<10,
174         PROP_RAW_ACCESS = 1<<13,
175         PROP_RAW_ARRAY = 1<<14,
176         PROP_FREE_POINTERS = 1<<15,
177         PROP_DYNAMIC = 1<<17 /* for dynamic arrays, and retvals of type string */
178 } PropertyFlag;
179
180 typedef struct CollectionPropertyIterator {
181         /* internal */
182         PointerRNA parent;
183         PointerRNA builtin_parent;
184         struct PropertyRNA *prop;
185         void *internal;
186         int idprop;
187         int level;
188
189         /* external */
190         int valid;
191         PointerRNA ptr;
192 } CollectionPropertyIterator;
193
194 typedef struct CollectionPointerLink {
195         struct CollectionPointerLink *next, *prev;
196         PointerRNA ptr;
197 } CollectionPointerLink;
198
199 typedef enum RawPropertyType {
200         PROP_RAW_INT, // XXX - abused for types that are not set, eg. MFace.verts, needs fixing.
201         PROP_RAW_SHORT,
202         PROP_RAW_CHAR,
203         PROP_RAW_DOUBLE,
204         PROP_RAW_FLOAT
205 } RawPropertyType;
206
207 typedef struct RawArray {
208         void *array;
209         RawPropertyType type;
210         int len;
211         int stride;
212 } RawArray;
213
214 typedef struct EnumPropertyItem {
215         int value;
216         const char *identifier;
217         int icon;
218         const char *name;
219         const char *description;
220 } EnumPropertyItem;
221
222 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
223
224 typedef struct PropertyRNA PropertyRNA;
225
226 /* Parameter List */
227
228 typedef struct ParameterList {
229         /* storage for parameters */
230         void *data;
231
232         /* store the parameter count */
233         int tot;
234
235         /* function passed at creation time */
236         struct FunctionRNA *func;
237 } ParameterList;
238
239 typedef struct ParameterIterator {
240         struct ParameterList *parms;
241         PointerRNA funcptr;
242         void *data;
243         int size, offset;
244
245         PropertyRNA *parm;
246         int valid;
247 } ParameterIterator;
248
249 /* Function */
250
251 typedef enum FunctionFlag {
252         FUNC_NO_SELF = 1, /* for static functions */
253         FUNC_USE_CONTEXT = 2,
254         FUNC_USE_REPORTS = 4,
255
256         /* registering */
257         FUNC_REGISTER = 8,
258         FUNC_REGISTER_OPTIONAL = 8|16,
259
260         /* internal flags */
261         FUNC_BUILTIN = 128,
262         FUNC_EXPORT = 256,
263         FUNC_RUNTIME = 512,
264         FUNC_FREE_POINTERS = 1024
265 } FunctionFlag;
266
267 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
268
269 typedef struct FunctionRNA FunctionRNA;
270
271 /* Struct */
272
273 typedef enum StructFlag {
274         /* indicates that this struct is an ID struct, and to use refcounting */
275         STRUCT_ID = 1,
276         STRUCT_ID_REFCOUNT = 2,
277
278         /* internal flags */
279         STRUCT_RUNTIME = 4,
280         STRUCT_GENERATED = 8,
281         STRUCT_FREE_POINTERS = 16
282 } StructFlag;
283
284 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
285 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
286 typedef void (*StructFreeFunc)(void *data);
287 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
288         const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
289 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
290
291 typedef struct StructRNA StructRNA;
292
293 /* Blender RNA
294  *
295  * Root RNA data structure that lists all struct types. */
296
297 typedef struct BlenderRNA BlenderRNA;
298
299 /* Extending
300  *
301  * This struct must be embedded in *Type structs in
302  * order to make then definable through RNA. */
303
304 typedef struct ExtensionRNA {
305         void *data;
306         StructRNA *srna;
307
308         int (*call)(PointerRNA *, FunctionRNA *, ParameterList *);
309         void (*free)(void *data);
310 } ExtensionRNA;
311
312 #ifdef __cplusplus
313 }
314 #endif
315
316 #endif /* RNA_TYPES */
317
318