svn merge -r 20486:20651 https://svn.blender.org/svnroot/bf-blender/branches/blender2...
[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         /* animateable means the property can be driven by some
89          * other input, be it animation curves, expressions, ..
90          * properties are animateable by default except for pointers
91          * and collections */
92         PROP_ANIMATEABLE = 2,
93
94         /* function paramater flags */
95         PROP_REQUIRED = 4,
96         PROP_RETURN = 8,
97
98         /* registering */
99         PROP_REGISTER = 16,
100         PROP_REGISTER_OPTIONAL = 16|32,
101
102         /* pointers */
103         PROP_ID_REFCOUNT = 64,
104
105         /* internal flags */
106         PROP_BUILTIN = 128,
107         PROP_EXPORT = 256,
108         PROP_RUNTIME = 512,
109         PROP_IDPROPERTY = 1024
110 } PropertyFlag;
111
112 typedef struct CollectionPropertyIterator {
113         /* internal */
114         PointerRNA parent;
115         PointerRNA builtin_parent;
116         struct PropertyRNA *prop;
117         void *internal;
118         int idprop;
119         int level;
120
121         /* external */
122         int valid;
123         PointerRNA ptr;
124 } CollectionPropertyIterator;
125
126 typedef struct CollectionPointerLink {
127         struct CollectionPointerLink *next, *prev;
128         PointerRNA ptr;
129 } CollectionPointerLink;
130
131 /* Iterator Utility */
132
133 typedef struct EnumPropertyItem {
134         int value;
135         const char *identifier;
136         const char *name;
137         const char *description;
138 } EnumPropertyItem;
139
140 typedef struct PropertyRNA PropertyRNA;
141
142 /* Parameter List */
143
144 typedef struct ParameterList ParameterList;
145
146 typedef struct ParameterIterator {
147         ParameterList *parms;
148         PointerRNA funcptr;
149         void *data;
150         int size, offset;
151
152         PropertyRNA *parm;
153         int valid;
154 } ParameterIterator;
155
156 /* Function */
157
158 typedef enum FunctionFlag {
159         FUNC_TYPESTATIC = 1, /* for static functions, FUNC_ STATIC is taken by some windows header it seems */
160
161         /* registering */
162         FUNC_REGISTER = 2,
163         FUNC_REGISTER_OPTIONAL = 2|4,
164
165         /* internal flags */
166         FUNC_BUILTIN = 128,
167         FUNC_EXPORT = 256,
168         FUNC_RUNTIME = 512
169 } FunctionFlag;
170
171 typedef void (*CallFunc)(PointerRNA *ptr, ParameterList *parms);
172
173 typedef struct FunctionRNA FunctionRNA;
174
175 /* Struct */
176
177 typedef enum StructFlag {
178         /* indicates that this struct is an ID struct, and to use refcounting */
179         STRUCT_ID = 1,
180         STRUCT_ID_REFCOUNT = 2,
181
182         /* internal flags */
183         STRUCT_RUNTIME = 4,
184         STRUCT_GENERATED = 8
185 } StructFlag;
186
187 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
188 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, struct ParameterList *list);
189 typedef void (*StructFreeFunc)(void *data);
190 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
191         StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
192 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
193
194 typedef struct StructRNA StructRNA;
195
196 /* Blender RNA
197  *
198  * Root RNA data structure that lists all struct types. */
199
200 typedef struct BlenderRNA BlenderRNA;
201
202 #ifdef __cplusplus
203 }
204 #endif
205
206 #endif /* RNA_TYPES */
207
208