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