Merge with 2.5 -r 21756:22173.
[blender.git] / source / blender / makesrna / RNA_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_TYPES
26 #define RNA_TYPES
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 struct ParameterList;
33 struct FunctionRNA;
34 struct PropertyRNA;
35 struct StructRNA;
36 struct BlenderRNA;
37 struct IDProperty;
38 struct bContext;
39 struct ReportList;
40
41 /* Pointer
42  *
43  * RNA pointers are not a single C pointer but include the type,
44  * and a pointer to the ID struct that owns the struct, since
45  * in some cases this information is needed to correctly get/set
46  * the properties and validate them. */
47
48 typedef struct PointerRNA {
49         struct {
50                 void *data;
51         } id;
52
53         struct StructRNA *type;
54         void *data;
55 } PointerRNA;
56
57 /* Property */
58
59 typedef enum PropertyType {
60         PROP_BOOLEAN = 0,
61         PROP_INT = 1,
62         PROP_FLOAT = 2,
63         PROP_STRING = 3,
64         PROP_ENUM = 4,
65         PROP_POINTER = 5,
66         PROP_COLLECTION = 6
67 } PropertyType;
68
69 typedef enum PropertySubType {
70         PROP_NONE = 0,
71         PROP_UNSIGNED = 1,
72         PROP_FILEPATH = 2,
73         PROP_DIRPATH = 3,
74         PROP_COLOR = 4,
75         PROP_VECTOR = 5,
76         PROP_MATRIX = 6,
77         PROP_ROTATION = 7,
78         PROP_NEVER_NULL = 8,
79         PROP_PERCENTAGE = 9
80 } PropertySubType;
81
82 typedef enum PropertyFlag {
83         /* editable means the property is editable in the user
84          * interface, properties are editable by default except
85          * for pointers and collections. */
86         PROP_EDITABLE = 1,
87
88         /* this property is editable even if it is lib linked,
89          * meaning it will get lost on reload, but it's useful
90          * for editing. */
91         PROP_LIB_EXCEPTION = 65536,
92
93         /* animateable means the property can be driven by some
94          * other input, be it animation curves, expressions, ..
95          * properties are animateable by default except for pointers
96          * and collections */
97         PROP_ANIMATEABLE = 2,
98
99         /* icon */
100         PROP_ICONS_CONSECUTIVE = 4096,
101
102         /* function paramater flags */
103         PROP_REQUIRED = 4,
104         PROP_RETURN = 8,
105         PROP_RNAPTR = 2048,
106
107         /* registering */
108         PROP_REGISTER = 16,
109         PROP_REGISTER_OPTIONAL = 16|32,
110
111         /* pointers */
112         PROP_ID_REFCOUNT = 64,
113
114         /* arrays */
115         PROP_DYNAMIC_ARRAY = 32768,
116
117         /* internal flags */
118         PROP_BUILTIN = 128,
119         PROP_EXPORT = 256,
120         PROP_RUNTIME = 512,
121         PROP_IDPROPERTY = 1024,
122         PROP_RAW_ACCESS = 8192,
123         PROP_RAW_ARRAY = 16384,
124         PROP_FREE_POINTERS = 32768
125 } PropertyFlag;
126
127 typedef struct CollectionPropertyIterator {
128         /* internal */
129         PointerRNA parent;
130         PointerRNA builtin_parent;
131         struct PropertyRNA *prop;
132         void *internal;
133         int idprop;
134         int level;
135
136         /* external */
137         int valid;
138         PointerRNA ptr;
139 } CollectionPropertyIterator;
140
141 typedef struct CollectionPointerLink {
142         struct CollectionPointerLink *next, *prev;
143         PointerRNA ptr;
144 } CollectionPointerLink;
145
146 typedef enum RawPropertyType {
147         PROP_RAW_CHAR,
148         PROP_RAW_SHORT,
149         PROP_RAW_INT,
150         PROP_RAW_FLOAT,
151         PROP_RAW_DOUBLE
152 } RawPropertyType;
153
154 typedef struct RawArray {
155         void *array;
156         RawPropertyType type;
157         int len;
158         int stride;
159 } RawArray;
160
161 typedef struct EnumPropertyItem {
162         int value;
163         const char *identifier;
164         int icon;
165         const char *name;
166         const char *description;
167 } EnumPropertyItem;
168
169 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
170
171 typedef struct PropertyRNA PropertyRNA;
172
173 /* Parameter List */
174
175 typedef struct ParameterList {
176         /* storage for parameters */
177         void *data;
178
179         /* store the parameter count */
180         int tot;
181
182         /* function passed at creation time */
183         struct FunctionRNA *func;
184 } ParameterList;
185
186 typedef struct ParameterIterator {
187         struct ParameterList *parms;
188         PointerRNA funcptr;
189         void *data;
190         int size, offset;
191
192         PropertyRNA *parm;
193         int valid;
194 } ParameterIterator;
195
196 /* Function */
197
198 typedef enum FunctionFlag {
199         FUNC_NO_SELF = 1, /* for static functions */
200         FUNC_USE_CONTEXT = 2,
201         FUNC_USE_REPORTS = 4,
202
203         /* registering */
204         FUNC_REGISTER = 8,
205         FUNC_REGISTER_OPTIONAL = 8|16,
206
207         /* internal flags */
208         FUNC_BUILTIN = 128,
209         FUNC_EXPORT = 256,
210         FUNC_RUNTIME = 512,
211         FUNC_FREE_POINTERS = 1024
212 } FunctionFlag;
213
214 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
215
216 typedef struct FunctionRNA FunctionRNA;
217
218 /* Struct */
219
220 typedef enum StructFlag {
221         /* indicates that this struct is an ID struct, and to use refcounting */
222         STRUCT_ID = 1,
223         STRUCT_ID_REFCOUNT = 2,
224
225         /* internal flags */
226         STRUCT_RUNTIME = 4,
227         STRUCT_GENERATED = 8,
228         STRUCT_FREE_POINTERS = 16
229 } StructFlag;
230
231 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
232 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
233 typedef void (*StructFreeFunc)(void *data);
234 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
235         StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
236 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
237
238 typedef struct StructRNA StructRNA;
239
240 /* Blender RNA
241  *
242  * Root RNA data structure that lists all struct types. */
243
244 typedef struct BlenderRNA BlenderRNA;
245
246 /* Extending
247  *
248  * This struct must be embedded in *Type structs in
249  * order to make then definable through RNA. */
250
251 typedef struct ExtensionRNA {
252         void *data;
253         StructRNA *srna;
254
255         int (*call)(PointerRNA *, FunctionRNA *, ParameterList *);
256         void (*free)(void *data);
257 } ExtensionRNA;
258
259 #ifdef __cplusplus
260 }
261 #endif
262
263 #endif /* RNA_TYPES */
264
265