RNA functions
[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 "UI_resources.h"
29
30 #include "rna_internal_types.h"
31
32 #define RNA_MAGIC ((int)~0)
33
34 struct IDProperty;
35 struct SDNA;
36
37 /* Data structures used during define */
38
39 typedef struct ContainerDefRNA {
40         void *next, *prev;
41
42         ContainerRNA *cont;
43         ListBase properties;
44 } ContainerDefRNA;
45
46 typedef struct FunctionDefRNA {
47         ContainerDefRNA cont;
48
49         FunctionRNA *func;
50         const char *srna;
51         const char *call;
52         const char *gencall;
53 } FunctionDefRNA;
54
55 typedef struct PropertyDefRNA {
56         struct PropertyDefRNA *next, *prev;
57
58         struct ContainerRNA *cont;
59         struct PropertyRNA *prop;
60
61         /* struct */
62         const char *dnastructname;
63         const char *dnastructfromname;
64         const char *dnastructfromprop;
65
66         /* property */
67         const char *dnaname;
68         const char *dnatype;
69         int dnaarraylength;
70         int dnapointerlevel;
71
72         /* for finding length of array collections */
73         const char *dnalengthstructname;
74         const char *dnalengthname;
75         int dnalengthfixed;
76
77         int booleanbit, booleannegative;
78
79         /* not to be confused with PROP_ENUM_FLAG
80          * this only allows one of the flags to be set at a time, clearing all others */
81         int enumbitflags;
82 } PropertyDefRNA;
83
84 typedef struct StructDefRNA {
85         ContainerDefRNA cont;
86
87         struct StructRNA *srna;
88         const char *filename;
89
90         const char *dnaname;
91
92         /* for derived structs to find data in some property */
93         const char *dnafromname;
94         const char *dnafromprop;
95
96         ListBase functions;
97 } StructDefRNA;
98
99 typedef struct AllocDefRNA {
100         struct AllocDefRNA *next, *prev;
101         void *mem;
102 } AllocDefRNA;
103
104 typedef struct BlenderDefRNA {
105         struct SDNA *sdna;
106         ListBase structs;
107         ListBase allocs;
108         struct StructRNA *laststruct;
109         int error, silent, preprocess, verify;
110 } BlenderDefRNA;
111
112 extern BlenderDefRNA DefRNA;
113
114 /* Define functions for all types */
115
116 extern BlenderRNA BLENDER_RNA;
117
118 void RNA_def_ID(struct BlenderRNA *brna);
119 void RNA_def_action(struct BlenderRNA *brna);
120 void RNA_def_animation(struct BlenderRNA *brna);
121 void RNA_def_animviz(struct BlenderRNA *brna);
122 void RNA_def_armature(struct BlenderRNA *brna);
123 void RNA_def_actuator(struct BlenderRNA *brna);
124 void RNA_def_boid(struct BlenderRNA *brna);
125 void RNA_def_brush(struct BlenderRNA *brna);
126 void RNA_def_brushclone(struct BlenderRNA *brna);
127 void RNA_def_camera(struct BlenderRNA *brna);
128 void RNA_def_cloth(struct BlenderRNA *brna);
129 void RNA_def_color(struct BlenderRNA *brna);
130 void RNA_def_constraint(struct BlenderRNA *brna);
131 void RNA_def_context(struct BlenderRNA *brna);
132 void RNA_def_controller(struct BlenderRNA *brna);
133 void RNA_def_curve(struct BlenderRNA *brna);
134 void RNA_def_fluidsim(struct BlenderRNA *brna);
135 void RNA_def_fcurve(struct BlenderRNA *brna);
136 void RNA_def_gameproperty(struct BlenderRNA *brna);
137 void RNA_def_gpencil(struct BlenderRNA *brna);
138 void RNA_def_group(struct BlenderRNA *brna);
139 void RNA_def_image(struct BlenderRNA *brna);
140 void RNA_def_key(struct BlenderRNA *brna);
141 void RNA_def_lamp(struct BlenderRNA *brna);
142 void RNA_def_lattice(struct BlenderRNA *brna);
143 void RNA_def_main(struct BlenderRNA *brna);
144 void RNA_def_material(struct BlenderRNA *brna);
145 void RNA_def_mesh(struct BlenderRNA *brna);
146 void RNA_def_meta(struct BlenderRNA *brna);
147 void RNA_def_modifier(struct BlenderRNA *brna);
148 void RNA_def_nla(struct BlenderRNA *brna);
149 void RNA_def_nodetree(struct BlenderRNA *brna);
150 void RNA_def_object(struct BlenderRNA *brna);
151 void RNA_def_object_force(struct BlenderRNA *brna);
152 void RNA_def_packedfile(struct BlenderRNA *brna);
153 void RNA_def_particle(struct BlenderRNA *brna);
154 void RNA_def_pose(struct BlenderRNA *brna);
155 void RNA_def_render(struct BlenderRNA *brna);
156 void RNA_def_rna(struct BlenderRNA *brna);
157 void RNA_def_scene(struct BlenderRNA *brna);
158 void RNA_def_screen(struct BlenderRNA *brna);
159 void RNA_def_sculpt_paint(struct BlenderRNA *brna);
160 void RNA_def_sensor(struct BlenderRNA *brna);
161 void RNA_def_sequencer(struct BlenderRNA *brna);
162 void RNA_def_smoke(struct BlenderRNA *brna);
163 void RNA_def_space(struct BlenderRNA *brna);
164 void RNA_def_test(struct BlenderRNA *brna);
165 void RNA_def_text(struct BlenderRNA *brna);
166 void RNA_def_texture(struct BlenderRNA *brna);
167 void RNA_def_timeline_marker(struct BlenderRNA *brna);
168 void RNA_def_sound(struct BlenderRNA *brna);
169 void RNA_def_ui(struct BlenderRNA *brna);
170 void RNA_def_userdef(struct BlenderRNA *brna);
171 void RNA_def_vfont(struct BlenderRNA *brna);
172 void RNA_def_wm(struct BlenderRNA *brna);
173 void RNA_def_world(struct BlenderRNA *brna);
174
175 /* Common Define functions */
176
177 void rna_def_animdata_common(struct StructRNA *srna);
178
179 void rna_def_animviz_common(struct StructRNA *srna);
180 void rna_def_motionpath_common(struct StructRNA *srna);
181
182 void rna_def_texmat_common(struct StructRNA *srna, const char *texspace_editable);
183 void rna_def_mtex_common(struct StructRNA *srna, const char *begin, const char *activeget, const char *activeset, const char *structname, const char *update);
184 void rna_def_render_layer_common(struct StructRNA *srna, int scene);
185
186 void rna_ID_name_get(struct PointerRNA *ptr, char *value);
187 int rna_ID_name_length(struct PointerRNA *ptr);
188 void rna_ID_name_set(struct PointerRNA *ptr, const char *value);
189 struct StructRNA *rna_ID_refine(struct PointerRNA *ptr);
190 struct IDProperty *rna_ID_idproperties(struct PointerRNA *ptr, int create);
191 void rna_ID_fake_user_set(struct PointerRNA *ptr, int value);
192 struct IDProperty *rna_IDPropertyGroup_idproperties(struct PointerRNA *ptr, int create);
193 void rna_IDPropertyGroup_unregister(const struct bContext *C, struct StructRNA *type);
194 struct StructRNA *rna_IDPropertyGroup_register(const struct bContext *C, struct ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
195 struct StructRNA* rna_IDPropertyGroup_refine(struct PointerRNA *ptr);
196
197 void rna_object_vgroup_name_index_get(struct PointerRNA *ptr, char *value, int index);
198 int rna_object_vgroup_name_index_length(struct PointerRNA *ptr, int index);
199 void rna_object_vgroup_name_index_set(struct PointerRNA *ptr, const char *value, short *index);
200 void rna_object_vgroup_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
201 void rna_object_uvlayer_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
202 void rna_object_vcollayer_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
203
204 void rna_Object_update(struct Main *bmain, struct Scene *scene, struct PointerRNA *ptr);
205 void rna_Object_update_data(struct Main *bmain, struct Scene *scene, struct PointerRNA *ptr);
206 void rna_Mesh_update_draw(struct Main *bmain, struct Scene *scene, struct PointerRNA *ptr);
207 void rna_TextureSlot_update(struct Main *bmain, struct Scene *scene, struct PointerRNA *ptr);
208
209 char *rna_TextureSlot_path(struct PointerRNA *ptr);
210
211 /* API functions */
212
213 void RNA_api_action(StructRNA *srna);
214 void RNA_api_armature_edit_bone(StructRNA *srna);
215 void RNA_api_drivers(StructRNA *srna);
216 void RNA_api_image(struct StructRNA *srna);
217 void RNA_api_operator(struct StructRNA *srna);
218 void RNA_api_macro(struct StructRNA *srna);
219 void RNA_api_keyconfig(struct StructRNA *srna);
220 void RNA_api_keyingset(struct StructRNA *srna);
221 void RNA_api_keymap(struct StructRNA *srna);
222 void RNA_api_keymapitem(struct StructRNA *srna);
223 void RNA_api_main(struct StructRNA *srna);
224 void RNA_api_material(StructRNA *srna);
225 void RNA_api_mesh(struct StructRNA *srna);
226 void RNA_api_object(struct StructRNA *srna);
227 void RNA_api_pose_channel(struct StructRNA *srna);
228 void RNA_api_scene(struct StructRNA *srna);
229 void RNA_api_scene_render(struct StructRNA *srna);
230 void RNA_api_text(struct StructRNA *srna);
231 void RNA_api_ui_layout(struct StructRNA *srna);
232 void RNA_api_wm(struct StructRNA *srna);
233
234 /* main collection functions */
235 void RNA_def_main_cameras(BlenderRNA *brna, PropertyRNA *cprop);
236 void RNA_def_main_scenes(BlenderRNA *brna, PropertyRNA *cprop);
237 void RNA_def_main_objects(BlenderRNA *brna, PropertyRNA *cprop);
238 void RNA_def_main_materials(BlenderRNA *brna, PropertyRNA *cprop);
239 void RNA_def_main_node_groups(BlenderRNA *brna, PropertyRNA *cprop);
240 void RNA_def_main_meshes(BlenderRNA *brna, PropertyRNA *cprop);
241 void RNA_def_main_lamps(BlenderRNA *brna, PropertyRNA *cprop);
242 void RNA_def_main_libraries(BlenderRNA *brna, PropertyRNA *cprop);
243 void RNA_def_main_screens(BlenderRNA *brna, PropertyRNA *cprop);
244 void RNA_def_main_window_managers(BlenderRNA *brna, PropertyRNA *cprop);
245 void RNA_def_main_images(BlenderRNA *brna, PropertyRNA *cprop);
246 void RNA_def_main_lattices(BlenderRNA *brna, PropertyRNA *cprop);
247 void RNA_def_main_curves(BlenderRNA *brna, PropertyRNA *cprop);
248 void RNA_def_main_metaballs(BlenderRNA *brna, PropertyRNA *cprop);
249 void RNA_def_main_vfonts(BlenderRNA *brna, PropertyRNA *cprop);
250 void RNA_def_main_textures(BlenderRNA *brna, PropertyRNA *cprop);
251 void RNA_def_main_brushes(BlenderRNA *brna, PropertyRNA *cprop);
252 void RNA_def_main_worlds(BlenderRNA *brna, PropertyRNA *cprop);
253 void RNA_def_main_groups(BlenderRNA *brna, PropertyRNA *cprop);
254 void RNA_def_main_texts(BlenderRNA *brna, PropertyRNA *cprop);
255 void RNA_def_main_sounds(BlenderRNA *brna, PropertyRNA *cprop);
256 void RNA_def_main_armatures(BlenderRNA *brna, PropertyRNA *cprop);
257 void RNA_def_main_actions(BlenderRNA *brna, PropertyRNA *cprop);
258 void RNA_def_main_particles(BlenderRNA *brna, PropertyRNA *cprop);
259 void RNA_def_main_gpencil(BlenderRNA *brna, PropertyRNA *cprop);
260
261 /* ID Properties */
262
263 extern StringPropertyRNA rna_IDProperty_string;
264 extern IntPropertyRNA rna_IDProperty_int;
265 extern IntPropertyRNA rna_IDProperty_int_array;
266 extern FloatPropertyRNA rna_IDProperty_float;
267 extern FloatPropertyRNA rna_IDProperty_float_array;
268 extern PointerPropertyRNA rna_IDProperty_group;
269 extern CollectionPropertyRNA rna_IDProperty_collection;
270 extern FloatPropertyRNA rna_IDProperty_double;
271 extern FloatPropertyRNA rna_IDProperty_double_array;
272
273 extern StructRNA RNA_IDProperty;
274 extern StructRNA RNA_IDPropertyGroup;
275
276 struct IDProperty *rna_idproperty_check(struct PropertyRNA **prop, struct PointerRNA *ptr);
277
278 /* Builtin Property Callbacks */
279
280 void rna_builtin_properties_begin(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
281 void rna_builtin_properties_next(struct CollectionPropertyIterator *iter);
282 PointerRNA rna_builtin_properties_get(struct CollectionPropertyIterator *iter);
283 PointerRNA rna_builtin_type_get(struct PointerRNA *ptr);
284 PointerRNA rna_builtin_properties_lookup_string(PointerRNA *ptr, const char *key);
285
286 /* Iterators */
287
288 typedef int (*IteratorSkipFunc)(struct CollectionPropertyIterator *iter, void *data);
289
290 typedef struct ListBaseIterator {
291         Link *link;
292         int flag;
293         IteratorSkipFunc skip;
294 } ListBaseIterator;
295
296 void rna_iterator_listbase_begin(struct CollectionPropertyIterator *iter, struct ListBase *lb, IteratorSkipFunc skip);
297 void rna_iterator_listbase_next(struct CollectionPropertyIterator *iter);
298 void *rna_iterator_listbase_get(struct CollectionPropertyIterator *iter);
299 void rna_iterator_listbase_end(struct CollectionPropertyIterator *iter);
300
301 typedef struct ArrayIterator {
302         char *ptr;
303         char *endptr;
304         void *free_ptr; /* will be free'd if set */
305         int itemsize;
306         IteratorSkipFunc skip;
307 } ArrayIterator;
308
309 void rna_iterator_array_begin(struct CollectionPropertyIterator *iter, void *ptr, int itemsize, int length, int free_ptr, IteratorSkipFunc skip);
310 void rna_iterator_array_next(struct CollectionPropertyIterator *iter);
311 void *rna_iterator_array_get(struct CollectionPropertyIterator *iter);
312 void *rna_iterator_array_dereference_get(struct CollectionPropertyIterator *iter);
313 void rna_iterator_array_end(struct CollectionPropertyIterator *iter);
314
315 /* Duplicated code since we can't link in blenlib */
316
317 void rna_addtail(struct ListBase *listbase, void *vlink);
318 void rna_freelinkN(struct ListBase *listbase, void *vlink);
319 void rna_freelistN(struct ListBase *listbase);
320 PropertyDefRNA *rna_findlink(ListBase *listbase, const char *identifier);
321
322 StructDefRNA *rna_find_struct_def(StructRNA *srna);
323 FunctionDefRNA *rna_find_function_def(FunctionRNA *func);
324 PropertyDefRNA *rna_find_parameter_def(PropertyRNA *parm);
325 PropertyDefRNA *rna_find_struct_property_def(StructRNA *srna, PropertyRNA *prop);
326
327 /* Pointer Handling */
328
329 PointerRNA rna_pointer_inherit_refine(struct PointerRNA *ptr, struct StructRNA *type, void *data);
330
331 /* Functions */
332
333 int rna_parameter_size(struct PropertyRNA *parm);
334 int rna_parameter_size_alloc(struct PropertyRNA *parm);
335
336 #endif /* RNA_INTERNAL_H */
337
338