Build failed because with merge I didn't get updates on interface_api.c since I remov...
[blender.git] / source / blender / makesrna / intern / rna_internal_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_INTERNAL_TYPES
26 #define RNA_INTERNAL_TYPES
27
28 #include "DNA_listBase.h"
29
30 struct BlenderRNA;
31 struct ContainerRNA;
32 struct StructRNA;
33 struct PropertyRNA;
34 struct PointerRNA;
35 struct FunctionRNA;
36 struct ReportList;
37 struct CollectionPropertyIterator;
38 struct bContext;
39 struct IDProperty;
40
41 #define RNA_MAX_ARRAY 32
42
43 /* Function Callbacks */
44
45 typedef void (*UpdateFunc)(struct bContext *C, struct PointerRNA *ptr);
46 typedef int (*EditableFunc)(struct PointerRNA *ptr);
47 typedef struct IDProperty* (*IDPropertiesFunc)(struct PointerRNA *ptr, int create);
48 typedef struct StructRNA *(*StructRefineFunc)(struct PointerRNA *ptr);
49 typedef char *(*StructPathFunc)(struct PointerRNA *ptr);
50
51 typedef int (*PropBooleanGetFunc)(struct PointerRNA *ptr);
52 typedef void (*PropBooleanSetFunc)(struct PointerRNA *ptr, int value);
53 typedef void (*PropBooleanArrayGetFunc)(struct PointerRNA *ptr, int *values);
54 typedef void (*PropBooleanArraySetFunc)(struct PointerRNA *ptr, const int *values);
55 typedef int (*PropIntGetFunc)(struct PointerRNA *ptr);
56 typedef void (*PropIntSetFunc)(struct PointerRNA *ptr, int value);
57 typedef void (*PropIntArrayGetFunc)(struct PointerRNA *ptr, int *values);
58 typedef void (*PropIntArraySetFunc)(struct PointerRNA *ptr, const int *values);
59 typedef void (*PropIntRangeFunc)(struct PointerRNA *ptr, int *min, int *max);
60 typedef float (*PropFloatGetFunc)(struct PointerRNA *ptr);
61 typedef void (*PropFloatSetFunc)(struct PointerRNA *ptr, float value);
62 typedef void (*PropFloatArrayGetFunc)(struct PointerRNA *ptr, float *values);
63 typedef void (*PropFloatArraySetFunc)(struct PointerRNA *ptr, const float *values);
64 typedef void (*PropFloatRangeFunc)(struct PointerRNA *ptr, float *min, float *max);
65 typedef void (*PropStringGetFunc)(struct PointerRNA *ptr, char *value);
66 typedef int (*PropStringLengthFunc)(struct PointerRNA *ptr);
67 typedef void (*PropStringSetFunc)(struct PointerRNA *ptr, const char *value);
68 typedef int (*PropEnumGetFunc)(struct PointerRNA *ptr);
69 typedef void (*PropEnumSetFunc)(struct PointerRNA *ptr, int value);
70 typedef EnumPropertyItem *(*PropEnumItemFunc)(struct PointerRNA *ptr);
71 typedef PointerRNA (*PropPointerGetFunc)(struct PointerRNA *ptr);
72 typedef StructRNA* (*PropPointerTypeFunc)(struct PointerRNA *ptr);
73 typedef void (*PropPointerSetFunc)(struct PointerRNA *ptr, const PointerRNA value);
74 typedef void (*PropCollectionBeginFunc)(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
75 typedef void (*PropCollectionNextFunc)(struct CollectionPropertyIterator *iter);
76 typedef void (*PropCollectionEndFunc)(struct CollectionPropertyIterator *iter);
77 typedef PointerRNA (*PropCollectionGetFunc)(struct CollectionPropertyIterator *iter);
78 typedef int (*PropCollectionLengthFunc)(struct PointerRNA *ptr);
79 typedef PointerRNA (*PropCollectionLookupIntFunc)(struct PointerRNA *ptr, int key);
80 typedef PointerRNA (*PropCollectionLookupStringFunc)(struct PointerRNA *ptr, const char *key);
81 typedef void (*PropCollectionAddFunc)(PointerRNA *ptr, PointerRNA *ptr_item);
82
83 /* Container - generic abstracted container of RNA properties */
84 typedef struct ContainerRNA {
85         void *next, *prev;
86
87         ListBase properties;
88 } ContainerRNA;
89
90 struct ParameterList {
91         /* storage for parameters */
92         void *data;
93
94         /* function passed at creation time */
95         FunctionRNA *func;
96 };
97
98 struct FunctionRNA {
99         /* structs are containers of properties */
100         ContainerRNA cont;
101
102         /* unique identifier */
103         const char *identifier;
104         /* various options */
105         int flag;
106
107         /* single line description, displayed in the tooltip for example */
108         const char *description;
109
110         /* callback to execute the function */
111         CallFunc call;
112
113         /* parameter for the return value */
114         PropertyRNA *ret;
115 };
116
117 struct PropertyRNA {
118         struct PropertyRNA *next, *prev;
119
120         /* magic bytes to distinguish with IDProperty */
121         int magic;
122
123         /* unique identifier */
124         const char *identifier;
125         /* various options */
126         int flag;
127
128         /* user readable name */
129         const char *name;
130         /* single line description, displayed in the tooltip for example */
131         const char *description;
132         /* icon ID */
133         int icon;
134
135         /* property type as it appears to the outside */
136         PropertyType type;
137         /* subtype, 'interpretation' of the property */
138         PropertySubType subtype;
139         /* if an array this is > 0, specifying the length */
140         unsigned int arraylength;
141         
142         /* callback for updates on change */
143         UpdateFunc update;
144         int noteflag;
145
146         /* callback for testing if editable/evaluated */
147         EditableFunc editable;
148 };
149
150 /* Property Types */
151
152 typedef struct BooleanPropertyRNA {
153         PropertyRNA property;
154
155         PropBooleanGetFunc get;
156         PropBooleanSetFunc set;
157
158         PropBooleanArrayGetFunc getarray;
159         PropBooleanArraySetFunc setarray;
160
161         int defaultvalue;
162         const int *defaultarray;
163 } BooleanPropertyRNA;
164
165 typedef struct IntPropertyRNA {
166         PropertyRNA property;
167
168         PropIntGetFunc get;
169         PropIntSetFunc set;
170
171         PropIntArrayGetFunc getarray;
172         PropIntArraySetFunc setarray;
173
174         PropIntRangeFunc range;
175
176         int softmin, softmax;
177         int hardmin, hardmax;
178         int step;
179
180         int defaultvalue;
181         const int *defaultarray;
182 } IntPropertyRNA;
183
184 typedef struct FloatPropertyRNA {
185         PropertyRNA property;
186
187         PropFloatGetFunc get;
188         PropFloatSetFunc set;
189
190         PropFloatArrayGetFunc getarray;
191         PropFloatArraySetFunc setarray;
192
193         PropFloatRangeFunc range;
194
195         float softmin, softmax;
196         float hardmin, hardmax;
197         float step;
198         int precision;
199
200         float defaultvalue;
201         const float *defaultarray;
202 } FloatPropertyRNA;
203
204 typedef struct StringPropertyRNA {
205         PropertyRNA property;
206
207         PropStringGetFunc get;
208         PropStringLengthFunc length;
209         PropStringSetFunc set;
210
211         int maxlength;  /* includes string terminator! */
212
213         const char *defaultvalue;
214 } StringPropertyRNA;
215
216 typedef struct EnumPropertyRNA {
217         PropertyRNA property;
218
219         PropEnumGetFunc get;
220         PropEnumSetFunc set;
221         PropEnumItemFunc itemf;
222
223         const EnumPropertyItem *item;
224         int totitem;
225
226         int defaultvalue;
227 } EnumPropertyRNA;
228
229 typedef struct PointerPropertyRNA {
230         PropertyRNA property;
231
232         PropPointerGetFunc get;
233         PropPointerSetFunc set;
234         PropPointerTypeFunc typef;
235
236         struct StructRNA *type;
237 } PointerPropertyRNA;
238
239 typedef struct CollectionPropertyRNA {
240         PropertyRNA property;
241
242         PropCollectionBeginFunc begin;
243         PropCollectionNextFunc next;
244         PropCollectionEndFunc end;                                              /* optional */
245         PropCollectionGetFunc get;
246         PropCollectionLengthFunc length;                                /* optional */
247         PropCollectionLookupIntFunc lookupint;                  /* optional */
248         PropCollectionLookupStringFunc lookupstring;    /* optional */
249         PropCollectionAddFunc add;
250
251         struct StructRNA *type;
252 } CollectionPropertyRNA;
253
254
255 /* changes to this struct require updating rna_generate_struct in makesrna.c */
256 struct StructRNA {
257         /* structs are containers of properties */
258         ContainerRNA cont;
259
260         /* python type, this is a subtype of pyrna_struct_Type but used so each struct can have its own type
261          * which is useful for subclassing RNA */
262         void *py_type;
263         void *blender_type;
264         
265         /* unique identifier */
266         const char *identifier;
267         /* various options */
268         int flag;
269
270         /* user readable name */
271         const char *name;
272         /* single line description, displayed in the tooltip for example */
273         const char *description;
274         /* icon ID */
275         int icon;
276         
277         /* property that defines the name */
278         PropertyRNA *nameproperty;
279
280         /* property to iterate over properties */
281         PropertyRNA *iteratorproperty;
282
283         /* struct this is derivedfrom */
284         struct StructRNA *base;
285
286         /* only use for nested structs, where both the parent and child access
287          * the same C Struct but nesting is used for grouping properties.
288          * The parent property is used so we know NULL checks are not needed,
289          * and that this struct will never exist without its parent */
290         struct StructRNA *nested;
291
292         /* function to give the more specific type */
293         StructRefineFunc refine; 
294
295         /* function to find path to this struct in an ID */
296         StructPathFunc path; 
297
298         /* function to register/unregister subclasses */
299         StructRegisterFunc reg; 
300         StructUnregisterFunc unreg; 
301
302         /* callback to get id properties */
303         IDPropertiesFunc idproperties;
304
305         /* functions of this struct */
306         ListBase functions; 
307 };
308
309 /* Blender RNA
310  *
311  * Root RNA data structure that lists all struct types. */
312
313 struct BlenderRNA {
314         ListBase structs;
315 };
316
317 #endif /* RNA_INTERNAL_TYPES */
318