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