Cleanup: sort forward declarations of enum & struct
[blender.git] / source / blender / makesrna / intern / rna_internal_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/intern/rna_internal_types.h
24  *  \ingroup RNA
25  */
26
27
28 #ifndef __RNA_INTERNAL_TYPES_H__
29 #define __RNA_INTERNAL_TYPES_H__
30
31 #include "DNA_listBase.h"
32
33 #include "RNA_types.h"
34
35 struct BlenderRNA;
36 struct CollectionPropertyIterator;
37 struct ContainerRNA;
38 struct FunctionRNA;
39 struct GHash;
40 struct IDProperty;
41 struct Main;
42 struct PointerRNA;
43 struct PropertyRNA;
44 struct Scene;
45 struct StructRNA;
46 struct bContext;
47
48 #ifdef UNIT_TEST
49 #define RNA_MAX_ARRAY_LENGTH 64
50 #else
51 #define RNA_MAX_ARRAY_LENGTH 32
52 #endif
53
54 #define RNA_MAX_ARRAY_DIMENSION 3
55
56
57 /* store local properties here */
58 #define RNA_IDP_UI "_RNA_UI"
59
60 /* Function Callbacks */
61
62 typedef void (*UpdateFunc)(struct Main *main, struct Scene *scene, struct PointerRNA *ptr);
63 typedef void (*ContextPropUpdateFunc)(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop);
64 typedef void (*ContextUpdateFunc)(struct bContext *C, struct PointerRNA *ptr);
65 typedef int (*EditableFunc)(struct PointerRNA *ptr, const char **r_info);
66 typedef int (*ItemEditableFunc)(struct PointerRNA *ptr, int index);
67 typedef struct IDProperty *(*IDPropertiesFunc)(struct PointerRNA *ptr, bool create);
68 typedef struct StructRNA *(*StructRefineFunc)(struct PointerRNA *ptr);
69 typedef char *(*StructPathFunc)(struct PointerRNA *ptr);
70
71 typedef int (*PropArrayLengthGetFunc)(struct PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION]);
72 typedef bool (*PropBooleanGetFunc)(struct PointerRNA *ptr);
73 typedef void (*PropBooleanSetFunc)(struct PointerRNA *ptr, bool value);
74 typedef void (*PropBooleanArrayGetFunc)(struct PointerRNA *ptr, bool *values);
75 typedef void (*PropBooleanArraySetFunc)(struct PointerRNA *ptr, const bool *values);
76 typedef int (*PropIntGetFunc)(struct PointerRNA *ptr);
77 typedef void (*PropIntSetFunc)(struct PointerRNA *ptr, int value);
78 typedef void (*PropIntArrayGetFunc)(struct PointerRNA *ptr, int *values);
79 typedef void (*PropIntArraySetFunc)(struct PointerRNA *ptr, const int *values);
80 typedef void (*PropIntRangeFunc)(struct PointerRNA *ptr, int *min, int *max, int *softmin, int *softmax);
81 typedef float (*PropFloatGetFunc)(struct PointerRNA *ptr);
82 typedef void (*PropFloatSetFunc)(struct PointerRNA *ptr, float value);
83 typedef void (*PropFloatArrayGetFunc)(struct PointerRNA *ptr, float *values);
84 typedef void (*PropFloatArraySetFunc)(struct PointerRNA *ptr, const float *values);
85 typedef void (*PropFloatRangeFunc)(struct PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax);
86 typedef void (*PropStringGetFunc)(struct PointerRNA *ptr, char *value);
87 typedef int (*PropStringLengthFunc)(struct PointerRNA *ptr);
88 typedef void (*PropStringSetFunc)(struct PointerRNA *ptr, const char *value);
89 typedef int (*PropEnumGetFunc)(struct PointerRNA *ptr);
90 typedef void (*PropEnumSetFunc)(struct PointerRNA *ptr, int value);
91 typedef const EnumPropertyItem *(*PropEnumItemFunc)(
92         struct bContext *C, struct PointerRNA *ptr,
93         struct PropertyRNA *prop, bool *r_free);
94 typedef PointerRNA (*PropPointerGetFunc)(struct PointerRNA *ptr);
95 typedef StructRNA *(*PropPointerTypeFunc)(struct PointerRNA *ptr);
96 typedef void (*PropPointerSetFunc)(struct PointerRNA *ptr, const PointerRNA value);
97 typedef bool (*PropPointerPollFunc)(struct PointerRNA *ptr, const PointerRNA value);
98 typedef bool (*PropPointerPollFuncPy)(struct PointerRNA *ptr, const PointerRNA value, const PropertyRNA *prop);
99 typedef void (*PropCollectionBeginFunc)(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
100 typedef void (*PropCollectionNextFunc)(struct CollectionPropertyIterator *iter);
101 typedef void (*PropCollectionEndFunc)(struct CollectionPropertyIterator *iter);
102 typedef PointerRNA (*PropCollectionGetFunc)(struct CollectionPropertyIterator *iter);
103 typedef int (*PropCollectionLengthFunc)(struct PointerRNA *ptr);
104 typedef int (*PropCollectionLookupIntFunc)(struct PointerRNA *ptr, int key, struct PointerRNA *r_ptr);
105 typedef int (*PropCollectionLookupStringFunc)(struct PointerRNA *ptr, const char *key, struct PointerRNA *r_ptr);
106 typedef int (*PropCollectionAssignIntFunc)(struct PointerRNA *ptr, int key, const struct PointerRNA *assign_ptr);
107
108 /* extended versions with PropertyRNA argument */
109 typedef bool (*PropBooleanGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop);
110 typedef void (*PropBooleanSetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, bool value);
111 typedef void (*PropBooleanArrayGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, bool *values);
112 typedef void (*PropBooleanArraySetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, const bool *values);
113 typedef int (*PropIntGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop);
114 typedef void (*PropIntSetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
115 typedef void (*PropIntArrayGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values);
116 typedef void (*PropIntArraySetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values);
117 typedef void (*PropIntRangeFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *min, int *max, int *softmin, int *softmax);
118 typedef float (*PropFloatGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop);
119 typedef void (*PropFloatSetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, float value);
120 typedef void (*PropFloatArrayGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *values);
121 typedef void (*PropFloatArraySetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, const float *values);
122 typedef void (*PropFloatRangeFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *min, float *max, float *softmin, float *softmax);
123 typedef void (*PropStringGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, char *value);
124 typedef int (*PropStringLengthFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop);
125 typedef void (*PropStringSetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, const char *value);
126 typedef int (*PropEnumGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop);
127 typedef void (*PropEnumSetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
128
129 /* Container - generic abstracted container of RNA properties */
130 typedef struct ContainerRNA {
131         void *next, *prev;
132
133         struct GHash *prophash;
134         ListBase properties;
135 } ContainerRNA;
136
137 struct FunctionRNA {
138         /* structs are containers of properties */
139         ContainerRNA cont;
140
141         /* unique identifier, keep after 'cont' */
142         const char *identifier;
143         /* various options */
144         int flag;
145
146         /* single line description, displayed in the tooltip for example */
147         const char *description;
148
149         /* callback to execute the function */
150         CallFunc call;
151
152         /* parameter for the return value
153          * note: this is only the C return value, rna functions can have multiple return values */
154         PropertyRNA *c_ret;
155 };
156
157 struct PropertyRNA {
158         struct PropertyRNA *next, *prev;
159
160         /* magic bytes to distinguish with IDProperty */
161         int magic;
162
163         /* unique identifier */
164         const char *identifier;
165         /* various options */
166         int flag;
167         /* Function parameters flags. */
168         short flag_parameter;
169         /* Internal ("private") flags. */
170         short flag_internal;
171         /* The subset of StructRNA.prop_tag_defines values that applies to this property. */
172         short tags;
173
174         /* user readable name */
175         const char *name;
176         /* single line description, displayed in the tooltip for example */
177         const char *description;
178         /* icon ID */
179         int icon;
180         /* context for translation */
181         const char *translation_context;
182
183         /* property type as it appears to the outside */
184         PropertyType type;
185         /* subtype, 'interpretation' of the property */
186         PropertySubType subtype;
187         /* if non-NULL, overrides arraylength. Must not return 0? */
188         PropArrayLengthGetFunc getlength;
189         /* dimension of array */
190         unsigned int arraydimension;
191         /* array lengths lengths for all dimensions (when arraydimension > 0) */
192         unsigned int arraylength[RNA_MAX_ARRAY_DIMENSION];
193         unsigned int totarraylength;
194
195         /* callback for updates on change */
196         UpdateFunc update;
197         int noteflag;
198
199         /* Callback for testing if editable. Its r_info parameter can be used to
200          * return info on editable state that might be shown to user. E.g. tooltips
201          * of disabled buttons can show reason why button is disabled using this. */
202         EditableFunc editable;
203         /* callback for testing if array-item editable (if applicable) */
204         ItemEditableFunc itemeditable;
205
206         /* raw access */
207         int rawoffset;
208         RawPropertyType rawtype;
209
210         /* This is used for accessing props/functions of this property
211          * any property can have this but should only be used for collections and arrays
212          * since python will convert int/bool/pointer's */
213         struct StructRNA *srna; /* attributes attached directly to this collection */
214
215         /* python handle to hold all callbacks
216          * (in a pointer array at the moment, may later be a tuple) */
217         void *py_data;
218 };
219
220 /* internal flags WARNING! 16bits only! */
221 typedef enum PropertyFlagIntern {
222         PROP_INTERN_BUILTIN                 = (1 << 0),
223         PROP_INTERN_RUNTIME                 = (1 << 1),
224         PROP_INTERN_RAW_ACCESS              = (1 << 2),
225         PROP_INTERN_RAW_ARRAY               = (1 << 3),
226         PROP_INTERN_FREE_POINTERS           = (1 << 4),
227 } PropertyFlagIntern;
228
229 /* Property Types */
230
231 typedef struct BoolPropertyRNA {
232         PropertyRNA property;
233
234         PropBooleanGetFunc get;
235         PropBooleanSetFunc set;
236         PropBooleanArrayGetFunc getarray;
237         PropBooleanArraySetFunc setarray;
238
239         PropBooleanGetFuncEx get_ex;
240         PropBooleanSetFuncEx set_ex;
241         PropBooleanArrayGetFuncEx getarray_ex;
242         PropBooleanArraySetFuncEx setarray_ex;
243
244         bool defaultvalue;
245         const bool *defaultarray;
246 } BoolPropertyRNA;
247
248 typedef struct IntPropertyRNA {
249         PropertyRNA property;
250
251         PropIntGetFunc get;
252         PropIntSetFunc set;
253         PropIntArrayGetFunc getarray;
254         PropIntArraySetFunc setarray;
255         PropIntRangeFunc range;
256
257         PropIntGetFuncEx get_ex;
258         PropIntSetFuncEx set_ex;
259         PropIntArrayGetFuncEx getarray_ex;
260         PropIntArraySetFuncEx setarray_ex;
261         PropIntRangeFuncEx range_ex;
262
263         int softmin, softmax;
264         int hardmin, hardmax;
265         int step;
266
267         int defaultvalue;
268         const int *defaultarray;
269 } IntPropertyRNA;
270
271 typedef struct FloatPropertyRNA {
272         PropertyRNA property;
273
274         PropFloatGetFunc get;
275         PropFloatSetFunc set;
276         PropFloatArrayGetFunc getarray;
277         PropFloatArraySetFunc setarray;
278         PropFloatRangeFunc range;
279
280         PropFloatGetFuncEx get_ex;
281         PropFloatSetFuncEx set_ex;
282         PropFloatArrayGetFuncEx getarray_ex;
283         PropFloatArraySetFuncEx setarray_ex;
284         PropFloatRangeFuncEx range_ex;
285
286         float softmin, softmax;
287         float hardmin, hardmax;
288         float step;
289         int precision;
290
291         float defaultvalue;
292         const float *defaultarray;
293 } FloatPropertyRNA;
294
295 typedef struct StringPropertyRNA {
296         PropertyRNA property;
297
298         PropStringGetFunc get;
299         PropStringLengthFunc length;
300         PropStringSetFunc set;
301
302         PropStringGetFuncEx get_ex;
303         PropStringLengthFuncEx length_ex;
304         PropStringSetFuncEx set_ex;
305
306         int maxlength;  /* includes string terminator! */
307
308         const char *defaultvalue;
309 } StringPropertyRNA;
310
311 typedef struct EnumPropertyRNA {
312         PropertyRNA property;
313
314         PropEnumGetFunc get;
315         PropEnumSetFunc set;
316         PropEnumItemFunc itemf;
317
318         PropEnumGetFuncEx get_ex;
319         PropEnumSetFuncEx set_ex;
320         void *py_data; /* store py callback here */
321
322         const EnumPropertyItem *item;
323         int totitem;
324
325         int defaultvalue;
326 } EnumPropertyRNA;
327
328 typedef struct PointerPropertyRNA {
329         PropertyRNA property;
330
331         PropPointerGetFunc get;
332         PropPointerSetFunc set;
333         PropPointerTypeFunc typef;
334         PropPointerPollFunc poll; /* unlike operators, 'set' can still run if poll fails, used for filtering display */
335
336         struct StructRNA *type;
337 } PointerPropertyRNA;
338
339 typedef struct CollectionPropertyRNA {
340         PropertyRNA property;
341
342         PropCollectionBeginFunc begin;
343         PropCollectionNextFunc next;
344         PropCollectionEndFunc end;                                              /* optional */
345         PropCollectionGetFunc get;
346         PropCollectionLengthFunc length;                                /* optional */
347         PropCollectionLookupIntFunc lookupint;                  /* optional */
348         PropCollectionLookupStringFunc lookupstring;    /* optional */
349         PropCollectionAssignIntFunc assignint;                  /* optional */
350
351         struct StructRNA *item_type;                    /* the type of this item */
352 } CollectionPropertyRNA;
353
354
355 /* changes to this struct require updating rna_generate_struct in makesrna.c */
356 struct StructRNA {
357         /* structs are containers of properties */
358         ContainerRNA cont;
359
360         /* unique identifier, keep after 'cont' */
361         const char *identifier;
362
363         /* python type, this is a subtype of pyrna_struct_Type but used so each struct can have its own type
364          * which is useful for subclassing RNA */
365         void *py_type;
366         void *blender_type;
367
368         /* various options */
369         int flag;
370         /* Each StructRNA type can define own tags which properties can set
371          * (PropertyRNA.tags) for changed behavior based on struct-type. */
372         const EnumPropertyItem *prop_tag_defines;
373
374         /* user readable name */
375         const char *name;
376         /* single line description, displayed in the tooltip for example */
377         const char *description;
378         /* context for translation */
379         const char *translation_context;
380         /* icon ID */
381         int icon;
382
383         /* property that defines the name */
384         PropertyRNA *nameproperty;
385
386         /* property to iterate over properties */
387         PropertyRNA *iteratorproperty;
388
389         /* struct this is derivedfrom */
390         struct StructRNA *base;
391
392         /* only use for nested structs, where both the parent and child access
393          * the same C Struct but nesting is used for grouping properties.
394          * The parent property is used so we know NULL checks are not needed,
395          * and that this struct will never exist without its parent */
396         struct StructRNA *nested;
397
398         /* function to give the more specific type */
399         StructRefineFunc refine;
400
401         /* function to find path to this struct in an ID */
402         StructPathFunc path;
403
404         /* function to register/unregister subclasses */
405         StructRegisterFunc reg;
406         StructUnregisterFunc unreg;
407         StructInstanceFunc instance;
408
409         /* callback to get id properties */
410         IDPropertiesFunc idproperties;
411
412         /* functions of this struct */
413         ListBase functions;
414 };
415
416 /* Blender RNA
417  *
418  * Root RNA data structure that lists all struct types. */
419
420 struct BlenderRNA {
421         ListBase structs;
422         /* A map of structs: {StructRNA.identifier -> StructRNA}
423          * These are ensured to have unique names (with STRUCT_PUBLIC_NAMESPACE enabled). */
424         struct GHash *structs_map;
425         /* Needed because types with an empty identifier aren't included in 'structs_map'. */
426         unsigned int  structs_len;
427 };
428
429 #define CONTAINER_RNA_ID(cont) (*(const char **)(((ContainerRNA *)(cont))+1))
430
431 #endif /* __RNA_INTERNAL_TYPES_H__ */