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