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