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