RNA: Commit of the API patch by vekoon. This adds Functions to RNA,
[blender.git] / source / blender / makesrna / intern / rna_internal.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_H
26 #define RNA_INTERNAL_H
27
28 #include "rna_internal_types.h"
29
30 #define RNA_MAGIC ((int)~0)
31
32 struct IDProperty;
33 struct SDNA;
34
35 /* Data structures used during define */
36
37 typedef struct ContainerDefRNA {
38         void *next, *prev;
39
40         ContainerRNA *cont;
41         ListBase properties;
42 } ContainerDefRNA;
43
44 typedef struct FunctionDefRNA {
45         ContainerDefRNA cont;
46
47         FunctionRNA *func;
48         const char *srna;
49         const char *call;
50 } FunctionDefRNA;
51
52 typedef struct PropertyDefRNA {
53         struct PropertyDefRNA *next, *prev;
54
55         struct ContainerRNA *cont;
56         struct PropertyRNA *prop;
57
58         /* struct */
59         const char *dnastructname;
60         const char *dnastructfromname;
61         const char *dnastructfromprop;
62
63         /* property */
64         const char *dnaname;
65         const char *dnatype;
66         int dnaarraylength;
67         int dnapointerlevel;
68
69         /* for finding length of array collections */
70         const char *dnalengthstructname;
71         const char *dnalengthname;
72         int dnalengthfixed;
73
74         int booleanbit, booleannegative;
75         int enumbitflags;
76 } PropertyDefRNA;
77
78 typedef struct StructDefRNA {
79         ContainerDefRNA cont;
80
81         struct StructRNA *srna;
82         const char *filename;
83
84         const char *dnaname;
85
86         /* for derived structs to find data in some property */
87         const char *dnafromname;
88         const char *dnafromprop;
89
90         ListBase functions;
91 } StructDefRNA;
92
93 typedef struct AllocDefRNA {
94         struct AllocDefRNA *next, *prev;
95         void *mem;
96 } AllocDefRNA;
97
98 typedef struct BlenderDefRNA {
99         struct SDNA *sdna;
100         ListBase structs;
101         ListBase allocs;
102         struct StructRNA *laststruct;
103         int error, silent, preprocess;
104 } BlenderDefRNA;
105
106 extern BlenderDefRNA DefRNA;
107
108 /* Define functions for all types */
109
110 extern BlenderRNA BLENDER_RNA;
111
112 void RNA_def_ID(struct BlenderRNA *brna);
113 void RNA_def_action(struct BlenderRNA *brna);
114 void RNA_def_animation(struct BlenderRNA *brna);
115 void RNA_def_armature(struct BlenderRNA *brna);
116 void RNA_def_actuator(struct BlenderRNA *brna);
117 void RNA_def_brush(struct BlenderRNA *brna);
118 void RNA_def_brushclone(struct BlenderRNA *brna);
119 void RNA_def_camera(struct BlenderRNA *brna);
120 void RNA_def_cloth(struct BlenderRNA *brna);
121 void RNA_def_color(struct BlenderRNA *brna);
122 void RNA_def_constraint(struct BlenderRNA *brna);
123 void RNA_def_context(struct BlenderRNA *brna);
124 void RNA_def_controller(struct BlenderRNA *brna);
125 void RNA_def_curve(struct BlenderRNA *brna);
126 void RNA_def_fluidsim(struct BlenderRNA *brna);
127 void RNA_def_gameproperty(struct BlenderRNA *brna);
128 void RNA_def_group(struct BlenderRNA *brna);
129 void RNA_def_image(struct BlenderRNA *brna);
130 void RNA_def_key(struct BlenderRNA *brna);
131 void RNA_def_lamp(struct BlenderRNA *brna);
132 void RNA_def_lattice(struct BlenderRNA *brna);
133 void RNA_def_main(struct BlenderRNA *brna);
134 void RNA_def_material(struct BlenderRNA *brna);
135 void RNA_def_mesh(struct BlenderRNA *brna);
136 void RNA_def_meta(struct BlenderRNA *brna);
137 void RNA_def_modifier(struct BlenderRNA *brna);
138 void RNA_def_nodetree(struct BlenderRNA *brna);
139 void RNA_def_object(struct BlenderRNA *brna);
140 void RNA_def_object_force(struct BlenderRNA *brna);
141 void RNA_def_packedfile(struct BlenderRNA *brna);
142 void RNA_def_particle(struct BlenderRNA *brna);
143 void RNA_def_pose(struct BlenderRNA *brna);
144 void RNA_def_radio(struct BlenderRNA *brna);
145 void RNA_def_rna(struct BlenderRNA *brna);
146 void RNA_def_scene(struct BlenderRNA *brna);
147 void RNA_def_screen(struct BlenderRNA *brna);
148 void RNA_def_scriptlink(struct BlenderRNA *brna);
149 void RNA_def_sensor(struct BlenderRNA *brna);
150 void RNA_def_sequence(struct BlenderRNA *brna);
151 void RNA_def_space(struct BlenderRNA *brna);
152 void RNA_def_text(struct BlenderRNA *brna);
153 void RNA_def_texture(struct BlenderRNA *brna);
154 void RNA_def_timeline_marker(struct BlenderRNA *brna);
155 void RNA_def_sound(struct BlenderRNA *brna);
156 void RNA_def_userdef(struct BlenderRNA *brna);
157 void RNA_def_vfont(struct BlenderRNA *brna);
158 void RNA_def_vpaint(struct BlenderRNA *brna);
159 void RNA_def_wm(struct BlenderRNA *brna);
160 void RNA_def_world(struct BlenderRNA *brna);
161
162 void rna_def_animdata_common(struct StructRNA *srna);
163
164 void rna_def_texmat_common(struct StructRNA *srna, const char *texspace_editable);
165 void rna_def_mtex_common(struct StructRNA *srna, const char *begin, const char *activeget, const char *structname);
166
167 void rna_ID_name_get(struct PointerRNA *ptr, char *value);
168 int rna_ID_name_length(struct PointerRNA *ptr);
169 void rna_ID_name_set(struct PointerRNA *ptr, const char *value);
170 struct StructRNA *rna_ID_refine(struct PointerRNA *ptr);
171 void rna_ID_fake_user_set(struct PointerRNA *ptr, int value);
172
173 void rna_object_vgroup_name_index_get(struct PointerRNA *ptr, char *value, int index);
174 int rna_object_vgroup_name_index_length(struct PointerRNA *ptr, int index);
175 void rna_object_vgroup_name_index_set(struct PointerRNA *ptr, const char *value, short *index);
176 void rna_object_vgroup_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
177 void rna_object_uvlayer_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
178 void rna_object_vcollayer_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
179
180 /* ID Properties */
181
182 extern StringPropertyRNA rna_IDProperty_string;
183 extern IntPropertyRNA rna_IDProperty_int;
184 extern IntPropertyRNA rna_IDProperty_int_array;
185 extern FloatPropertyRNA rna_IDProperty_float;
186 extern FloatPropertyRNA rna_IDProperty_float_array;
187 extern PointerPropertyRNA rna_IDProperty_group;
188 extern CollectionPropertyRNA rna_IDProperty_collection;
189 extern FloatPropertyRNA rna_IDProperty_double;
190 extern FloatPropertyRNA rna_IDProperty_double_array;
191
192 extern StructRNA RNA_IDProperty;
193 extern StructRNA RNA_IDPropertyGroup;
194
195 struct IDProperty *rna_idproperties_get(struct PointerRNA *ptr, int create);
196 struct IDProperty *rna_idproperty_check(struct PropertyRNA **prop, struct PointerRNA *ptr);
197
198 /* Builtin Property Callbacks */
199
200 void rna_builtin_properties_begin(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
201 void rna_builtin_properties_next(struct CollectionPropertyIterator *iter);
202 PointerRNA rna_builtin_properties_get(struct CollectionPropertyIterator *iter);
203 PointerRNA rna_builtin_type_get(struct PointerRNA *ptr);
204
205 /* Iterators */
206
207 typedef int (*IteratorSkipFunc)(struct CollectionPropertyIterator *iter, void *data);
208
209 typedef struct ListBaseIterator {
210         Link *link;
211         int flag;
212         IteratorSkipFunc skip;
213 } ListBaseIterator;
214
215 void rna_iterator_listbase_begin(struct CollectionPropertyIterator *iter, struct ListBase *lb, IteratorSkipFunc skip);
216 void rna_iterator_listbase_next(struct CollectionPropertyIterator *iter);
217 void *rna_iterator_listbase_get(struct CollectionPropertyIterator *iter);
218 void rna_iterator_listbase_end(struct CollectionPropertyIterator *iter);
219
220 typedef struct ArrayIterator {
221         char *ptr;
222         char *endptr;
223         int itemsize;
224         IteratorSkipFunc skip;
225 } ArrayIterator;
226
227 void rna_iterator_array_begin(struct CollectionPropertyIterator *iter, void *ptr, int itemsize, int length, IteratorSkipFunc skip);
228 void rna_iterator_array_next(struct CollectionPropertyIterator *iter);
229 void *rna_iterator_array_get(struct CollectionPropertyIterator *iter);
230 void *rna_iterator_array_dereference_get(struct CollectionPropertyIterator *iter);
231 void rna_iterator_array_end(struct CollectionPropertyIterator *iter);
232
233 /* Duplicated code since we can't link in blenlib */
234
235 void rna_addtail(struct ListBase *listbase, void *vlink);
236 void rna_freelinkN(struct ListBase *listbase, void *vlink);
237 void rna_freelistN(struct ListBase *listbase);
238
239 StructDefRNA *rna_find_struct_def(StructRNA *srna);
240 FunctionDefRNA *rna_find_function_def(FunctionRNA *func);
241 PropertyDefRNA *rna_find_parameter_def(PropertyRNA *parm);
242
243 /* Pointer Handling */
244
245 PointerRNA rna_pointer_inherit_refine(struct PointerRNA *ptr, struct StructRNA *type, void *data);
246
247 /* Functions */
248
249 int rna_parameter_size(struct PropertyRNA *parm);
250
251 #endif /* RNA_INTERNAL_H */
252
253