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