Merged changes in the trunk up to revision 54110.
[blender.git] / source / blender / makesrna / intern / rna_internal.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_internal.h
24  *  \ingroup RNA
25  */
26
27
28 #ifndef __RNA_INTERNAL_H__
29 #define __RNA_INTERNAL_H__
30
31 #include "UI_resources.h"
32
33 #include "rna_internal_types.h"
34
35 #define RNA_MAGIC ((int)~0)
36
37 struct ColorBand;
38 struct ID;
39 struct IDProperty;
40 struct Main;
41 struct Mesh;
42 struct Object;
43 struct RenderEngine;
44 struct ReportList;
45 struct SDNA;
46 struct Sequence;
47
48 /* Data structures used during define */
49
50 typedef struct ContainerDefRNA {
51         void *next, *prev;
52
53         ContainerRNA *cont;
54         ListBase properties;
55 } ContainerDefRNA;
56
57 typedef struct FunctionDefRNA {
58         ContainerDefRNA cont;
59
60         FunctionRNA *func;
61         const char *srna;
62         const char *call;
63         const char *gencall;
64 } FunctionDefRNA;
65
66 typedef struct PropertyDefRNA {
67         struct PropertyDefRNA *next, *prev;
68
69         struct ContainerRNA *cont;
70         struct PropertyRNA *prop;
71
72         /* struct */
73         const char *dnastructname;
74         const char *dnastructfromname;
75         const char *dnastructfromprop;
76
77         /* property */
78         const char *dnaname;
79         const char *dnatype;
80         int dnaarraylength;
81         int dnapointerlevel;
82
83         /* for finding length of array collections */
84         const char *dnalengthstructname;
85         const char *dnalengthname;
86         int dnalengthfixed;
87
88         int booleanbit, booleannegative;
89
90         /* not to be confused with PROP_ENUM_FLAG
91          * this only allows one of the flags to be set at a time, clearing all others */
92         int enumbitflags;
93 } PropertyDefRNA;
94
95 typedef struct StructDefRNA {
96         ContainerDefRNA cont;
97
98         struct StructRNA *srna;
99         const char *filename;
100
101         const char *dnaname;
102
103         /* for derived structs to find data in some property */
104         const char *dnafromname;
105         const char *dnafromprop;
106
107         ListBase functions;
108 } StructDefRNA;
109
110 typedef struct AllocDefRNA {
111         struct AllocDefRNA *next, *prev;
112         void *mem;
113 } AllocDefRNA;
114
115 typedef struct BlenderDefRNA {
116         struct SDNA *sdna;
117         ListBase structs;
118         ListBase allocs;
119         struct StructRNA *laststruct;
120         int error, silent, preprocess, verify;
121 } BlenderDefRNA;
122
123 extern BlenderDefRNA DefRNA;
124
125 /* Define functions for all types */
126
127 extern BlenderRNA BLENDER_RNA;
128
129 void RNA_def_ID(struct BlenderRNA *brna);
130 void RNA_def_action(struct BlenderRNA *brna);
131 void RNA_def_animation(struct BlenderRNA *brna);
132 void RNA_def_animviz(struct BlenderRNA *brna);
133 void RNA_def_armature(struct BlenderRNA *brna);
134 void RNA_def_actuator(struct BlenderRNA *brna);
135 void RNA_def_boid(struct BlenderRNA *brna);
136 void RNA_def_brush(struct BlenderRNA *brna);
137 void RNA_def_camera(struct BlenderRNA *brna);
138 void RNA_def_cloth(struct BlenderRNA *brna);
139 void RNA_def_color(struct BlenderRNA *brna);
140 void RNA_def_constraint(struct BlenderRNA *brna);
141 void RNA_def_context(struct BlenderRNA *brna);
142 void RNA_def_controller(struct BlenderRNA *brna);
143 void RNA_def_curve(struct BlenderRNA *brna);
144 void RNA_def_dynamic_paint(struct BlenderRNA *brna);
145 void RNA_def_fluidsim(struct BlenderRNA *brna);
146 void RNA_def_fcurve(struct BlenderRNA *brna);
147 void RNA_def_gameproperty(struct BlenderRNA *brna);
148 void RNA_def_gpencil(struct BlenderRNA *brna);
149 void RNA_def_group(struct BlenderRNA *brna);
150 void RNA_def_image(struct BlenderRNA *brna);
151 void RNA_def_key(struct BlenderRNA *brna);
152 void RNA_def_lamp(struct BlenderRNA *brna);
153 void RNA_def_lattice(struct BlenderRNA *brna);
154 #ifdef WITH_FREESTYLE
155 void RNA_def_linestyle(struct BlenderRNA *brna);
156 #endif
157 void RNA_def_main(struct BlenderRNA *brna);
158 void RNA_def_material(struct BlenderRNA *brna);
159 void RNA_def_mesh(struct BlenderRNA *brna);
160 void RNA_def_meta(struct BlenderRNA *brna);
161 void RNA_def_modifier(struct BlenderRNA *brna);
162 void RNA_def_nla(struct BlenderRNA *brna);
163 void RNA_def_nodetree(struct BlenderRNA *brna);
164 void RNA_def_object(struct BlenderRNA *brna);
165 void RNA_def_object_force(struct BlenderRNA *brna);
166 void RNA_def_packedfile(struct BlenderRNA *brna);
167 void RNA_def_particle(struct BlenderRNA *brna);
168 void RNA_def_pose(struct BlenderRNA *brna);
169 void RNA_def_render(struct BlenderRNA *brna);
170 void RNA_def_rigidbody(struct BlenderRNA *brna);
171 void RNA_def_rna(struct BlenderRNA *brna);
172 void RNA_def_scene(struct BlenderRNA *brna);
173 void RNA_def_screen(struct BlenderRNA *brna);
174 void RNA_def_sculpt_paint(struct BlenderRNA *brna);
175 void RNA_def_sensor(struct BlenderRNA *brna);
176 void RNA_def_sequencer(struct BlenderRNA *brna);
177 void RNA_def_smoke(struct BlenderRNA *brna);
178 void RNA_def_space(struct BlenderRNA *brna);
179 void RNA_def_speaker(struct BlenderRNA *brna);
180 void RNA_def_test(struct BlenderRNA *brna);
181 void RNA_def_text(struct BlenderRNA *brna);
182 void RNA_def_texture(struct BlenderRNA *brna);
183 void RNA_def_timeline_marker(struct BlenderRNA *brna);
184 void RNA_def_sound(struct BlenderRNA *brna);
185 void RNA_def_ui(struct BlenderRNA *brna);
186 void RNA_def_userdef(struct BlenderRNA *brna);
187 void RNA_def_vfont(struct BlenderRNA *brna);
188 void RNA_def_wm(struct BlenderRNA *brna);
189 void RNA_def_world(struct BlenderRNA *brna);
190 void RNA_def_movieclip(struct BlenderRNA *brna);
191 void RNA_def_tracking(struct BlenderRNA *brna);
192 void RNA_def_mask(struct BlenderRNA *brna);
193
194 /* Common Define functions */
195
196 void rna_def_animdata_common(struct StructRNA *srna);
197
198 void rna_def_animviz_common(struct StructRNA *srna);
199 void rna_def_motionpath_common(struct StructRNA *srna);
200
201 void rna_def_texmat_common(struct StructRNA *srna, const char *texspace_editable);
202 void rna_def_mtex_common(struct BlenderRNA *brna, struct StructRNA *srna, const char *begin, const char *activeget,
203                          const char *activeset, const char *activeeditable, const char *structname,
204                          const char *structname_slots, const char *update);
205 void rna_def_render_layer_common(struct StructRNA *srna, int scene);
206
207 void rna_def_actionbone_group_common(struct StructRNA *srna, int update_flag, const char *update_cb);
208 void rna_ActionGroup_colorset_set(struct PointerRNA *ptr, int value);
209
210 void rna_ID_name_get(struct PointerRNA *ptr, char *value);
211 int rna_ID_name_length(struct PointerRNA *ptr);
212 void rna_ID_name_set(struct PointerRNA *ptr, const char *value);
213 struct StructRNA *rna_ID_refine(struct PointerRNA *ptr);
214 struct IDProperty *rna_ID_idprops(struct PointerRNA *ptr, int create);
215 void rna_ID_fake_user_set(struct PointerRNA *ptr, int value);
216 struct IDProperty *rna_PropertyGroup_idprops(struct PointerRNA *ptr, int create);
217 void rna_PropertyGroup_unregister(struct Main *bmain, struct StructRNA *type);
218 struct StructRNA *rna_PropertyGroup_register(struct Main *bmain, struct ReportList *reports, void *data,
219                                              const char *identifier, StructValidateFunc validate,
220                                              StructCallbackFunc call, StructFreeFunc free);
221 struct StructRNA *rna_PropertyGroup_refine(struct PointerRNA *ptr);
222
223 void rna_object_vgroup_name_index_get(struct PointerRNA *ptr, char *value, int index);
224 int rna_object_vgroup_name_index_length(struct PointerRNA *ptr, int index);
225 void rna_object_vgroup_name_index_set(struct PointerRNA *ptr, const char *value, short *index);
226 void rna_object_vgroup_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
227 void rna_object_uvlayer_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
228 void rna_object_vcollayer_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
229 PointerRNA rna_object_shapekey_index_get(struct ID *id, int value);
230 int rna_object_shapekey_index_set(struct ID *id, PointerRNA value, int current);
231
232 /* named internal so as not to conflict with obj.update() rna func */
233 void rna_Object_internal_update_data(struct Main *bmain, struct Scene *scene, struct PointerRNA *ptr);
234 void rna_Mesh_update_draw(struct Main *bmain, struct Scene *scene, struct PointerRNA *ptr);
235 void rna_TextureSlot_update(struct Main *bmain, struct Scene *scene, struct PointerRNA *ptr);
236
237 /* basic poll functions for object types */
238 int rna_Armature_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
239 int rna_Camera_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
240 int rna_Curve_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
241 int rna_Lattice_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
242 int rna_Mesh_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
243
244 /* basic poll functions for actions (to prevent actions getting set in wrong places) */
245 int rna_Action_id_poll(struct PointerRNA *ptr, struct PointerRNA value);
246 int rna_Action_actedit_assign_poll(struct PointerRNA *ptr, struct PointerRNA value);
247
248 char *rna_TextureSlot_path(struct PointerRNA *ptr);
249
250 /* API functions */
251
252 void RNA_api_action(StructRNA *srna);
253 void RNA_api_armature_edit_bone(StructRNA *srna);
254 void RNA_api_bone(StructRNA *srna);
255 void RNA_api_camera(StructRNA *srna);
256 void RNA_api_drivers(StructRNA *srna);
257 void RNA_api_image(struct StructRNA *srna);
258 void RNA_api_operator(struct StructRNA *srna);
259 void RNA_api_macro(struct StructRNA *srna);
260 void RNA_api_keyconfig(struct StructRNA *srna);
261 void RNA_api_keyconfigs(struct StructRNA *srna);
262 void RNA_api_keyingset(struct StructRNA *srna);
263 void RNA_api_keymap(struct StructRNA *srna);
264 void RNA_api_keymaps(struct StructRNA *srna);
265 void RNA_api_keymapitem(struct StructRNA *srna);
266 void RNA_api_keymapitems(struct StructRNA *srna);
267 void RNA_api_main(struct StructRNA *srna);
268 void RNA_api_material(StructRNA *srna);
269 void RNA_api_mesh(struct StructRNA *srna);
270 void RNA_api_object(struct StructRNA *srna);
271 void RNA_api_object_base(struct StructRNA *srna);
272 void RNA_api_pose(struct StructRNA *srna);
273 void RNA_api_pose_channel(struct StructRNA *srna);
274 void RNA_api_scene(struct StructRNA *srna);
275 void RNA_api_scene_render(struct StructRNA *srna);
276 void RNA_api_sequence_strip(StructRNA *srna);
277 void RNA_api_text(struct StructRNA *srna);
278 void RNA_api_ui_layout(struct StructRNA *srna);
279 void RNA_api_wm(struct StructRNA *srna);
280 void RNA_api_sensor(struct StructRNA *srna);
281 void RNA_api_controller(struct StructRNA *srna);
282 void RNA_api_actuator(struct StructRNA *srna);
283 void RNA_api_texture(struct StructRNA *srna);
284 void RNA_api_environment_map(struct StructRNA *srna);
285 void RNA_api_sequences(BlenderRNA *brna, PropertyRNA *cprop);
286 void RNA_api_sequence_elements(BlenderRNA *brna, PropertyRNA *cprop);
287
288 /* main collection functions */
289 void RNA_def_main_cameras(BlenderRNA *brna, PropertyRNA *cprop);
290 void RNA_def_main_scenes(BlenderRNA *brna, PropertyRNA *cprop);
291 void RNA_def_main_objects(BlenderRNA *brna, PropertyRNA *cprop);
292 void RNA_def_main_materials(BlenderRNA *brna, PropertyRNA *cprop);
293 void RNA_def_main_node_groups(BlenderRNA *brna, PropertyRNA *cprop);
294 void RNA_def_main_meshes(BlenderRNA *brna, PropertyRNA *cprop);
295 void RNA_def_main_lamps(BlenderRNA *brna, PropertyRNA *cprop);
296 void RNA_def_main_libraries(BlenderRNA *brna, PropertyRNA *cprop);
297 void RNA_def_main_screens(BlenderRNA *brna, PropertyRNA *cprop);
298 void RNA_def_main_window_managers(BlenderRNA *brna, PropertyRNA *cprop);
299 void RNA_def_main_images(BlenderRNA *brna, PropertyRNA *cprop);
300 void RNA_def_main_lattices(BlenderRNA *brna, PropertyRNA *cprop);
301 void RNA_def_main_curves(BlenderRNA *brna, PropertyRNA *cprop);
302 void RNA_def_main_metaballs(BlenderRNA *brna, PropertyRNA *cprop);
303 void RNA_def_main_fonts(BlenderRNA *brna, PropertyRNA *cprop);
304 void RNA_def_main_textures(BlenderRNA *brna, PropertyRNA *cprop);
305 void RNA_def_main_brushes(BlenderRNA *brna, PropertyRNA *cprop);
306 void RNA_def_main_worlds(BlenderRNA *brna, PropertyRNA *cprop);
307 void RNA_def_main_groups(BlenderRNA *brna, PropertyRNA *cprop);
308 void RNA_def_main_texts(BlenderRNA *brna, PropertyRNA *cprop);
309 void RNA_def_main_speakers(BlenderRNA *brna, PropertyRNA *cprop);
310 void RNA_def_main_sounds(BlenderRNA *brna, PropertyRNA *cprop);
311 void RNA_def_main_armatures(BlenderRNA *brna, PropertyRNA *cprop);
312 void RNA_def_main_actions(BlenderRNA *brna, PropertyRNA *cprop);
313 void RNA_def_main_particles(BlenderRNA *brna, PropertyRNA *cprop);
314 void RNA_def_main_gpencil(BlenderRNA *brna, PropertyRNA *cprop);
315 void RNA_def_main_movieclips(BlenderRNA *brna, PropertyRNA *cprop);
316 void RNA_def_main_masks(BlenderRNA *brna, PropertyRNA *cprop);
317 #ifdef WITH_FREESTYLE
318 void RNA_def_main_linestyles(BlenderRNA *brna, PropertyRNA *cprop);
319 #endif
320
321 /* ID Properties */
322
323 extern StringPropertyRNA rna_PropertyGroupItem_string;
324 extern IntPropertyRNA rna_PropertyGroupItem_int;
325 extern IntPropertyRNA rna_PropertyGroupItem_int_array;
326 extern FloatPropertyRNA rna_PropertyGroupItem_float;
327 extern FloatPropertyRNA rna_PropertyGroupItem_float_array;
328 extern PointerPropertyRNA rna_PropertyGroupItem_group;
329 extern CollectionPropertyRNA rna_PropertyGroupItem_collection;
330 extern CollectionPropertyRNA rna_PropertyGroupItem_idp_array;
331 extern FloatPropertyRNA rna_PropertyGroupItem_double;
332 extern FloatPropertyRNA rna_PropertyGroupItem_double_array;
333
334 extern StructRNA RNA_PropertyGroupItem;
335 extern StructRNA RNA_PropertyGroup;
336
337 struct IDProperty *rna_idproperty_check(struct PropertyRNA **prop, struct PointerRNA *ptr);
338
339 /* Builtin Property Callbacks */
340
341 void rna_builtin_properties_begin(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
342 void rna_builtin_properties_next(struct CollectionPropertyIterator *iter);
343 PointerRNA rna_builtin_properties_get(struct CollectionPropertyIterator *iter);
344 PointerRNA rna_builtin_type_get(struct PointerRNA *ptr);
345 int rna_builtin_properties_lookup_string(PointerRNA *ptr, const char *key, PointerRNA *r_ptr);
346
347 /* Iterators */
348
349 typedef int (*IteratorSkipFunc)(struct CollectionPropertyIterator *iter, void *data);
350
351 typedef struct ListBaseIterator {
352         Link *link;
353         int flag;
354         IteratorSkipFunc skip;
355 } ListBaseIterator;
356
357 void rna_iterator_listbase_begin(struct CollectionPropertyIterator *iter, struct ListBase *lb, IteratorSkipFunc skip);
358 void rna_iterator_listbase_next(struct CollectionPropertyIterator *iter);
359 void *rna_iterator_listbase_get(struct CollectionPropertyIterator *iter);
360 void rna_iterator_listbase_end(struct CollectionPropertyIterator *iter);
361 PointerRNA rna_listbase_lookup_int(PointerRNA *ptr, StructRNA *type, struct ListBase *lb, int index);
362
363 typedef struct ArrayIterator {
364         char *ptr;
365         char *endptr;  /* past the last valid pointer, only for comparisons, ignores skipped values */
366         void *free_ptr; /* will be freed if set */
367         int itemsize;
368
369         /* array length with no skip functions applied, take care not to compare against index from animsys
370          * or python indices */
371         int length;
372
373         /* optional skip function, when set the array as viewed by rna can contain only a subset of the members.
374          * this changes indices so quick array index lookups are not possible when skip function is used. */
375         IteratorSkipFunc skip;
376 } ArrayIterator;
377
378 void rna_iterator_array_begin(struct CollectionPropertyIterator *iter, void *ptr, int itemsize, int length,
379                               int free_ptr, IteratorSkipFunc skip);
380 void rna_iterator_array_next(struct CollectionPropertyIterator *iter);
381 void *rna_iterator_array_get(struct CollectionPropertyIterator *iter);
382 void *rna_iterator_array_dereference_get(struct CollectionPropertyIterator *iter);
383 void rna_iterator_array_end(struct CollectionPropertyIterator *iter);
384 PointerRNA rna_array_lookup_int(PointerRNA *ptr, StructRNA *type, void *data, int itemsize, int length, int index);
385
386 /* Duplicated code since we can't link in blenlib */
387
388 void rna_addtail(struct ListBase *listbase, void *vlink);
389 void rna_freelinkN(struct ListBase *listbase, void *vlink);
390 void rna_freelistN(struct ListBase *listbase);
391 PropertyDefRNA *rna_findlink(ListBase *listbase, const char *identifier);
392
393 StructDefRNA *rna_find_struct_def(StructRNA *srna);
394 FunctionDefRNA *rna_find_function_def(FunctionRNA *func);
395 PropertyDefRNA *rna_find_parameter_def(PropertyRNA *parm);
396 PropertyDefRNA *rna_find_struct_property_def(StructRNA *srna, PropertyRNA *prop);
397
398 /* Pointer Handling */
399
400 PointerRNA rna_pointer_inherit_refine(struct PointerRNA *ptr, struct StructRNA *type, void *data);
401
402 /* Functions */
403
404 int rna_parameter_size(struct PropertyRNA *parm);
405 int rna_parameter_size_alloc(struct PropertyRNA *parm);
406
407 /* XXX, these should not need to be defined here~! */
408 struct MTex *rna_mtex_texture_slots_add(struct ID *self, struct bContext *C, struct ReportList *reports);
409 struct MTex *rna_mtex_texture_slots_create(struct ID *self, struct bContext *C, struct ReportList *reports, int index);
410 void rna_mtex_texture_slots_clear(struct ID *self, struct bContext *C, struct ReportList *reports, int index);
411
412
413 int rna_IDMaterials_assign_int(struct PointerRNA *ptr, int key, const struct PointerRNA *assign_ptr);
414
415
416 /* Internal functions that cycles uses so we need to declare (tsk tsk) */
417 void rna_RenderLayer_rect_set(PointerRNA *ptr, const float *values);
418 void rna_RenderPass_rect_set(PointerRNA *ptr, const float *values);
419
420 #endif /* __RNA_INTERNAL_H__ */
421
422