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