Just added another param to RNA_def_property_collection_funcs
[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 *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
133         /* property type as it appears to the outside */
134         PropertyType type;
135         /* subtype, 'interpretation' of the property */
136         PropertySubType subtype;
137         /* if an array this is > 0, specifying the length */
138         unsigned int arraylength;
139         
140         /* callback for updates on change */
141         UpdateFunc update;
142         int noteflag;
143
144         /* callback for testing if editable/evaluated */
145         EditableFunc editable;
146 };
147
148 /* Property Types */
149
150 typedef struct BooleanPropertyRNA {
151         PropertyRNA property;
152
153         PropBooleanGetFunc get;
154         PropBooleanSetFunc set;
155
156         PropBooleanArrayGetFunc getarray;
157         PropBooleanArraySetFunc setarray;
158
159         int defaultvalue;
160         const int *defaultarray;
161 } BooleanPropertyRNA;
162
163 typedef struct IntPropertyRNA {
164         PropertyRNA property;
165
166         PropIntGetFunc get;
167         PropIntSetFunc set;
168
169         PropIntArrayGetFunc getarray;
170         PropIntArraySetFunc setarray;
171
172         PropIntRangeFunc range;
173
174         int softmin, softmax;
175         int hardmin, hardmax;
176         int step;
177
178         int defaultvalue;
179         const int *defaultarray;
180 } IntPropertyRNA;
181
182 typedef struct FloatPropertyRNA {
183         PropertyRNA property;
184
185         PropFloatGetFunc get;
186         PropFloatSetFunc set;
187
188         PropFloatArrayGetFunc getarray;
189         PropFloatArraySetFunc setarray;
190
191         PropFloatRangeFunc range;
192
193         float softmin, softmax;
194         float hardmin, hardmax;
195         float step;
196         int precision;
197
198         float defaultvalue;
199         const float *defaultarray;
200 } FloatPropertyRNA;
201
202 typedef struct StringPropertyRNA {
203         PropertyRNA property;
204
205         PropStringGetFunc get;
206         PropStringLengthFunc length;
207         PropStringSetFunc set;
208
209         int maxlength;  /* includes string terminator! */
210
211         const char *defaultvalue;
212 } StringPropertyRNA;
213
214 typedef struct EnumPropertyRNA {
215         PropertyRNA property;
216
217         PropEnumGetFunc get;
218         PropEnumSetFunc set;
219         PropEnumItemFunc itemf;
220
221         const EnumPropertyItem *item;
222         int totitem;
223
224         int defaultvalue;
225 } EnumPropertyRNA;
226
227 typedef struct PointerPropertyRNA {
228         PropertyRNA property;
229
230         PropPointerGetFunc get;
231         PropPointerSetFunc set;
232         PropPointerTypeFunc typef;
233
234         struct StructRNA *type;
235 } PointerPropertyRNA;
236
237 typedef struct CollectionPropertyRNA {
238         PropertyRNA property;
239
240         PropCollectionBeginFunc begin;
241         PropCollectionNextFunc next;
242         PropCollectionEndFunc end;                                              /* optional */
243         PropCollectionGetFunc get;
244         PropCollectionLengthFunc length;                                /* optional */
245         PropCollectionLookupIntFunc lookupint;                  /* optional */
246         PropCollectionLookupStringFunc lookupstring;    /* optional */
247         PropCollectionAddFunc add;
248
249         struct StructRNA *type;
250 } CollectionPropertyRNA;
251
252
253 /* changes to this struct require updating rna_generate_struct in makesrna.c */
254 struct StructRNA {
255         /* structs are containers of properties */
256         ContainerRNA cont;
257
258         /* python type, this is a subtype of pyrna_struct_Type but used so each struct can have its own type
259          * which is useful for subclassing RNA */
260         void *py_type;
261         void *blender_type;
262         
263         /* unique identifier */
264         const char *identifier;
265         /* various options */
266         int flag;
267
268         /* user readable name */
269         const char *name;
270         /* single line description, displayed in the tooltip for example */
271         const char *description;
272         /* icon ID */
273         int icon;
274         
275         /* property that defines the name */
276         PropertyRNA *nameproperty;
277
278         /* property to iterate over properties */
279         PropertyRNA *iteratorproperty;
280
281         /* struct this is derivedfrom */
282         struct StructRNA *base;
283
284         /* only use for nested structs, where both the parent and child access
285          * the same C Struct but nesting is used for grouping properties.
286          * The parent property is used so we know NULL checks are not needed,
287          * and that this struct will never exist without its parent */
288         struct StructRNA *nested;
289
290         /* function to give the more specific type */
291         StructRefineFunc refine; 
292
293         /* function to find path to this struct in an ID */
294         StructPathFunc path; 
295
296         /* function to register/unregister subclasses */
297         StructRegisterFunc reg; 
298         StructUnregisterFunc unreg; 
299
300         /* callback to get id properties */
301         IDPropertiesFunc idproperties;
302
303         /* functions of this struct */
304         ListBase functions; 
305 };
306
307 /* Blender RNA
308  *
309  * Root RNA data structure that lists all struct types. */
310
311 struct BlenderRNA {
312         ListBase structs;
313 };
314
315 #endif /* RNA_INTERNAL_TYPES */
316