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