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