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