WIP PyAPI from winter camp discussions, make subtypes of the base RNA python type...
[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 StructRNA;
32 struct PropertyRNA;
33 struct PointerRNA;
34 struct CollectionPropertyIterator;
35 struct bContext;
36
37 #define RNA_MAX_ARRAY 32
38
39 /* Function Callbacks */
40
41 typedef void (*UpdateFunc)(struct bContext *C, struct PointerRNA *ptr);
42 typedef int (*EditableFunc)(struct PointerRNA *ptr);
43 typedef struct StructRNA *(*StructRefineFunc)(struct PointerRNA *ptr);
44
45 typedef int (*PropBooleanGetFunc)(struct PointerRNA *ptr);
46 typedef void (*PropBooleanSetFunc)(struct PointerRNA *ptr, int value);
47 typedef void (*PropBooleanArrayGetFunc)(struct PointerRNA *ptr, int *values);
48 typedef void (*PropBooleanArraySetFunc)(struct PointerRNA *ptr, const int *values);
49 typedef int (*PropIntGetFunc)(struct PointerRNA *ptr);
50 typedef void (*PropIntSetFunc)(struct PointerRNA *ptr, int value);
51 typedef void (*PropIntArrayGetFunc)(struct PointerRNA *ptr, int *values);
52 typedef void (*PropIntArraySetFunc)(struct PointerRNA *ptr, const int *values);
53 typedef void (*PropIntRangeFunc)(struct PointerRNA *ptr, int *min, int *max);
54 typedef float (*PropFloatGetFunc)(struct PointerRNA *ptr);
55 typedef void (*PropFloatSetFunc)(struct PointerRNA *ptr, float value);
56 typedef void (*PropFloatArrayGetFunc)(struct PointerRNA *ptr, float *values);
57 typedef void (*PropFloatArraySetFunc)(struct PointerRNA *ptr, const float *values);
58 typedef void (*PropFloatRangeFunc)(struct PointerRNA *ptr, float *min, float *max);
59 typedef void (*PropStringGetFunc)(struct PointerRNA *ptr, char *value);
60 typedef int (*PropStringLengthFunc)(struct PointerRNA *ptr);
61 typedef void (*PropStringSetFunc)(struct PointerRNA *ptr, const char *value);
62 typedef int (*PropEnumGetFunc)(struct PointerRNA *ptr);
63 typedef void (*PropEnumSetFunc)(struct PointerRNA *ptr, int value);
64 typedef PointerRNA (*PropPointerGetFunc)(struct PointerRNA *ptr);
65 typedef void (*PropPointerSetFunc)(struct PointerRNA *ptr, const PointerRNA value);
66 typedef void (*PropCollectionBeginFunc)(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
67 typedef void (*PropCollectionNextFunc)(struct CollectionPropertyIterator *iter);
68 typedef void (*PropCollectionEndFunc)(struct CollectionPropertyIterator *iter);
69 typedef PointerRNA (*PropCollectionGetFunc)(struct CollectionPropertyIterator *iter);
70 typedef int (*PropCollectionLengthFunc)(struct PointerRNA *ptr);
71 typedef PointerRNA (*PropCollectionLookupIntFunc)(struct PointerRNA *ptr, int key);
72 typedef PointerRNA (*PropCollectionLookupStringFunc)(struct PointerRNA *ptr, const char *key);
73
74 struct PropertyRNA {
75         struct PropertyRNA *next, *prev;
76
77         /* magic bytes to distinguish with IDProperty */
78         int magic;
79
80         /* unique identifier */
81         const char *identifier;
82         /* various options */
83         int flag;
84
85         /* user readable name */
86         const char *name;
87         /* single line description, displayed in the tooltip for example */
88         const char *description;
89
90         /* property type as it appears to the outside */
91         PropertyType type;
92         /* subtype, 'interpretation' of the property */
93         PropertySubType subtype;
94         /* if an array this is > 0, specifying the length */
95         unsigned int arraylength;
96         
97         /* callback for updates on change */
98         UpdateFunc update;
99         int noteflag;
100
101         /* callback for testing if editable/evaluated */
102         EditableFunc editable;
103 };
104
105 /* Property Types */
106
107 typedef struct BooleanPropertyRNA {
108         PropertyRNA property;
109
110         PropBooleanGetFunc get;
111         PropBooleanSetFunc set;
112
113         PropBooleanArrayGetFunc getarray;
114         PropBooleanArraySetFunc setarray;
115
116         int defaultvalue;
117         const int *defaultarray;
118 } BooleanPropertyRNA;
119
120 typedef struct IntPropertyRNA {
121         PropertyRNA property;
122
123         PropIntGetFunc get;
124         PropIntSetFunc set;
125
126         PropIntArrayGetFunc getarray;
127         PropIntArraySetFunc setarray;
128
129         PropIntRangeFunc range;
130
131         int softmin, softmax;
132         int hardmin, hardmax;
133         int step;
134
135         int defaultvalue;
136         const int *defaultarray;
137 } IntPropertyRNA;
138
139 typedef struct FloatPropertyRNA {
140         PropertyRNA property;
141
142         PropFloatGetFunc get;
143         PropFloatSetFunc set;
144
145         PropFloatArrayGetFunc getarray;
146         PropFloatArraySetFunc setarray;
147
148         PropFloatRangeFunc range;
149
150         float softmin, softmax;
151         float hardmin, hardmax;
152         float step;
153         int precision;
154
155         float defaultvalue;
156         const float *defaultarray;
157 } FloatPropertyRNA;
158
159 typedef struct StringPropertyRNA {
160         PropertyRNA property;
161
162         PropStringGetFunc get;
163         PropStringLengthFunc length;
164         PropStringSetFunc set;
165
166         int maxlength;  /* includes string terminator! */
167
168         const char *defaultvalue;
169 } StringPropertyRNA;
170
171 typedef struct EnumPropertyRNA {
172         PropertyRNA property;
173
174         PropEnumGetFunc get;
175         PropEnumSetFunc set;
176
177         const EnumPropertyItem *item;
178         int totitem;
179
180         int defaultvalue;
181 } EnumPropertyRNA;
182
183 typedef struct PointerPropertyRNA {
184         PropertyRNA property;
185
186         PropPointerGetFunc get;
187         PropPointerSetFunc set;
188
189         struct StructRNA *structtype;
190 } PointerPropertyRNA;
191
192 typedef struct CollectionPropertyRNA {
193         PropertyRNA property;
194
195         PropCollectionBeginFunc begin;
196         PropCollectionNextFunc next;
197         PropCollectionEndFunc end;                                              /* optional */
198         PropCollectionGetFunc get;
199         PropCollectionLengthFunc length;                                /* optional */
200         PropCollectionLookupIntFunc lookupint;                  /* optional */
201         PropCollectionLookupStringFunc lookupstring;    /* optional */
202
203         struct StructRNA *structtype;
204 } CollectionPropertyRNA;
205
206
207 /* changes to this struct require updating rna_generate_struct in makesrna.c */
208 struct StructRNA {
209         struct StructRNA *next, *prev;
210
211         /* python type, this is a subtype of pyrna_struct_Type but used so each struct can have its own type
212          * which is useful for subclassing RNA */
213         void *py_type;
214         
215         /* unique identifier */
216         const char *identifier;
217         /* various options */
218         int flag;
219
220         /* user readable name */
221         const char *name;
222         /* single line description, displayed in the tooltip for example */
223         const char *description;
224         
225         /* property that defines the name */
226         PropertyRNA *nameproperty;
227
228         /* property to iterate over properties */
229         PropertyRNA *iteratorproperty;
230
231         /* struct this is derivedfrom */
232         struct StructRNA *base;
233
234         /* only use for nested structs, where both the parent and child access
235          * the same C Struct but nesting is used for grouping properties.
236          * The parent property is used so we know NULL checks are not needed,
237          * and that this struct will never exist without its parent */
238         struct StructRNA *nested;
239
240         /* function to give the more specific type */
241         StructRefineFunc refine; 
242
243         /* properties of this struct */
244         ListBase properties; 
245 };
246
247 /* Blender RNA
248  *
249  * Root RNA data structure that lists all struct types. */
250
251 struct BlenderRNA {
252         ListBase structs;
253 };
254
255 #endif /* RNA_INTERNAL_TYPES */
256