Merge branch 'master' into blender2.8
[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 #ifndef __RNA_INTERNAL_H__
28 #define __RNA_INTERNAL_H__
29
30 #include "BLI_utildefines.h"
31
32 #include "rna_internal_types.h"
33
34 #include "UI_resources.h"
35
36 #define RNA_MAGIC ((int)~0)
37
38 struct ID;
39 struct IDProperty;
40 struct Main;
41 struct Mesh;
42 struct Object;
43 struct ReportList;
44 struct SDNA;
45
46 /* Data structures used during define */
47
48 typedef struct ContainerDefRNA {
49         void *next, *prev;
50
51         ContainerRNA *cont;
52         ListBase properties;
53 } ContainerDefRNA;
54
55 typedef struct FunctionDefRNA {
56         ContainerDefRNA cont;
57
58         FunctionRNA *func;
59         const char *srna;
60         const char *call;
61         const char *gencall;
62 } FunctionDefRNA;
63
64 typedef struct PropertyDefRNA {
65         struct PropertyDefRNA *next, *prev;
66
67         struct ContainerRNA *cont;
68         struct PropertyRNA *prop;
69
70         /* struct */
71         const char *dnastructname;
72         const char *dnastructfromname;
73         const char *dnastructfromprop;
74
75         /* property */
76         const char *dnaname;
77         const char *dnatype;
78         int dnaarraylength;
79         int dnapointerlevel;
80
81         /* for finding length of array collections */
82         const char *dnalengthstructname;
83         const char *dnalengthname;
84         int dnalengthfixed;
85
86         int booleanbit, booleannegative;
87
88         /* not to be confused with PROP_ENUM_FLAG
89          * this only allows one of the flags to be set at a time, clearing all others */
90         int enumbitflags;
91 } PropertyDefRNA;
92
93 typedef struct StructDefRNA {
94         ContainerDefRNA cont;
95
96         struct StructRNA *srna;
97         const char *filename;
98
99         const char *dnaname;
100
101         /* for derived structs to find data in some property */
102         const char *dnafromname;
103         const char *dnafromprop;
104
105         ListBase functions;
106 } StructDefRNA;
107
108 typedef struct AllocDefRNA {
109         struct AllocDefRNA *next, *prev;
110         void *mem;
111 } AllocDefRNA;
112
113 typedef struct BlenderDefRNA {
114         struct SDNA *sdna;
115         ListBase structs;
116         ListBase allocs;
117         struct StructRNA *laststruct;
118         int error, silent, preprocess, verify, animate;
119 } BlenderDefRNA;
120
121 extern BlenderDefRNA DefRNA;
122
123 /* Define functions for all types */
124 #ifndef __RNA_ACCESS_H__
125 extern BlenderRNA BLENDER_RNA;
126 #endif
127
128 void RNA_def_ID(struct BlenderRNA *brna);
129 void RNA_def_action(struct BlenderRNA *brna);
130 void RNA_def_animation(struct BlenderRNA *brna);
131 void RNA_def_animviz(struct BlenderRNA *brna);
132 void RNA_def_armature(struct BlenderRNA *brna);
133 void RNA_def_actuator(struct BlenderRNA *brna);
134 void RNA_def_boid(struct BlenderRNA *brna);
135 void RNA_def_brush(struct BlenderRNA *brna);
136 void RNA_def_cachefile(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_depsgraph(struct BlenderRNA *brna);
145 void RNA_def_dynamic_paint(struct BlenderRNA *brna);
146 void RNA_def_fluidsim(struct BlenderRNA *brna);
147 void RNA_def_fcurve(struct BlenderRNA *brna);
148 void RNA_def_gameproperty(struct BlenderRNA *brna);
149 void RNA_def_gpencil(struct BlenderRNA *brna);
150 void RNA_def_group(struct BlenderRNA *brna);
151 void RNA_def_image(struct BlenderRNA *brna);
152 void RNA_def_key(struct BlenderRNA *brna);
153 void RNA_def_lamp(struct BlenderRNA *brna);
154 void RNA_def_lattice(struct BlenderRNA *brna);
155 void RNA_def_linestyle(struct BlenderRNA *brna);
156 void RNA_def_main(struct BlenderRNA *brna);
157 void RNA_def_material(struct BlenderRNA *brna);
158 void RNA_def_mesh(struct BlenderRNA *brna);
159 void RNA_def_meta(struct BlenderRNA *brna);
160 void RNA_def_modifier(struct BlenderRNA *brna);
161 void RNA_def_nla(struct BlenderRNA *brna);
162 void RNA_def_nodetree(struct BlenderRNA *brna);
163 void RNA_def_object(struct BlenderRNA *brna);
164 void RNA_def_object_force(struct BlenderRNA *brna);
165 void RNA_def_packedfile(struct BlenderRNA *brna);
166 void RNA_def_palette(struct BlenderRNA *brna);
167 void RNA_def_pose(struct BlenderRNA *brna);
168 void RNA_def_render(struct BlenderRNA *brna);
169 void RNA_def_rigidbody(struct BlenderRNA *brna);
170 void RNA_def_rna(struct BlenderRNA *brna);
171 void RNA_def_scene(struct BlenderRNA *brna);
172 void RNA_def_screen(struct BlenderRNA *brna);
173 void RNA_def_sculpt_paint(struct BlenderRNA *brna);
174 void RNA_def_sensor(struct BlenderRNA *brna);
175 void RNA_def_sequencer(struct BlenderRNA *brna);
176 void RNA_def_smoke(struct BlenderRNA *brna);
177 void RNA_def_space(struct BlenderRNA *brna);
178 void RNA_def_speaker(struct BlenderRNA *brna);
179 void RNA_def_test(struct BlenderRNA *brna);
180 void RNA_def_text(struct BlenderRNA *brna);
181 void RNA_def_texture(struct BlenderRNA *brna);
182 void RNA_def_timeline_marker(struct BlenderRNA *brna);
183 void RNA_def_sound(struct BlenderRNA *brna);
184 void RNA_def_ui(struct BlenderRNA *brna);
185 void RNA_def_userdef(struct BlenderRNA *brna);
186 void RNA_def_vfont(struct BlenderRNA *brna);
187 void RNA_def_wm(struct BlenderRNA *brna);
188 void RNA_def_world(struct BlenderRNA *brna);
189 void RNA_def_movieclip(struct BlenderRNA *brna);
190 void RNA_def_tracking(struct BlenderRNA *brna);
191 void RNA_def_mask(struct BlenderRNA *brna);
192
193 /* Common Define functions */
194
195 void rna_def_animdata_common(struct StructRNA *srna);
196
197 void rna_def_animviz_common(struct StructRNA *srna);
198 void rna_def_motionpath_common(struct StructRNA *srna);
199
200 void rna_def_bone_curved_common(struct StructRNA *srna, bool is_posebone);
201
202 void rna_def_texmat_common(struct StructRNA *srna, const char *texspace_editable);
203 void rna_def_mtex_common(struct BlenderRNA *brna, struct StructRNA *srna, const char *begin, const char *activeget,
204                          const char *activeset, const char *activeeditable, const char *structname,
205                          const char *structname_slots, const char *update, const char *update_index);
206 void rna_def_texpaint_slots(struct BlenderRNA *brna, struct StructRNA *srna);
207 void rna_def_render_layer_common(struct StructRNA *srna, int scene);
208
209 void rna_def_actionbone_group_common(struct StructRNA *srna, int update_flag, const char *update_cb);
210 void rna_ActionGroup_colorset_set(struct PointerRNA *ptr, int value);
211 int rna_ActionGroup_is_custom_colorset_get(struct PointerRNA *ptr);
212
213 void rna_ID_name_get(struct PointerRNA *ptr, char *value);
214 int rna_ID_name_length(struct PointerRNA *ptr);
215 void rna_ID_name_set(struct PointerRNA *ptr, const char *value);
216 struct StructRNA *rna_ID_refine(struct PointerRNA *ptr);
217 struct IDProperty *rna_ID_idprops(struct PointerRNA *ptr, bool create);
218 void rna_ID_fake_user_set(struct PointerRNA *ptr, int value);
219 struct IDProperty *rna_PropertyGroup_idprops(struct PointerRNA *ptr, bool create);
220 void rna_PropertyGroup_unregister(struct Main *bmain, struct StructRNA *type);
221 struct StructRNA *rna_PropertyGroup_register(struct Main *bmain, struct ReportList *reports, void *data,
222                                              const char *identifier, StructValidateFunc validate,
223                                              StructCallbackFunc call, StructFreeFunc free);
224 struct StructRNA *rna_PropertyGroup_refine(struct PointerRNA *ptr);
225
226 void rna_object_vgroup_name_index_get(struct PointerRNA *ptr, char *value, int index);
227 int rna_object_vgroup_name_index_length(struct PointerRNA *ptr, int index);
228 void rna_object_vgroup_name_index_set(struct PointerRNA *ptr, const char *value, short *index);
229 void rna_object_vgroup_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
230 void rna_object_uvlayer_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
231 void rna_object_vcollayer_name_set(struct PointerRNA *ptr, const char *value, char *result, int maxlen);
232 PointerRNA rna_object_shapekey_index_get(struct ID *id, int value);
233 int rna_object_shapekey_index_set(struct ID *id, PointerRNA value, int current);
234
235 /* named internal so as not to conflict with obj.update() rna func */
236 void rna_Object_internal_update_data(struct Main *bmain, struct Scene *scene, struct PointerRNA *ptr);
237 void rna_Mesh_update_draw(struct Main *bmain, struct Scene *scene, struct PointerRNA *ptr);
238 void rna_TextureSlot_update(struct Main *bmain, struct Scene *scene, struct PointerRNA *ptr);
239
240 /* basic poll functions for object types */
241 int rna_Armature_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
242 int rna_Camera_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
243 int rna_Curve_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
244 int rna_Lamp_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
245 int rna_Lattice_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
246 int rna_Mesh_object_poll(struct PointerRNA *ptr, struct PointerRNA value);
247
248 /* basic poll functions for actions (to prevent actions getting set in wrong places) */
249 int rna_Action_id_poll(struct PointerRNA *ptr, struct PointerRNA value);
250 int rna_Action_actedit_assign_poll(struct PointerRNA *ptr, struct PointerRNA value);
251
252 char *rna_TextureSlot_path(struct PointerRNA *ptr);
253 char *rna_Node_ImageUser_path(struct PointerRNA *ptr);
254
255 /* API functions */
256
257 void RNA_api_action(StructRNA *srna);
258 void RNA_api_armature_edit_bone(StructRNA *srna);
259 void RNA_api_bone(StructRNA *srna);
260 void RNA_api_camera(StructRNA *srna);
261 void RNA_api_curve(StructRNA *srna);
262 void RNA_api_fcurves(StructRNA *srna);
263 void RNA_api_drivers(StructRNA *srna);
264 void RNA_api_image_packed_file(struct StructRNA *srna);
265 void RNA_api_image(struct StructRNA *srna);
266 void RNA_api_lattice(struct StructRNA *srna);
267 void RNA_api_operator(struct StructRNA *srna);
268 void RNA_api_macro(struct StructRNA *srna);
269 void RNA_api_keyconfig(struct StructRNA *srna);
270 void RNA_api_keyconfigs(struct StructRNA *srna);
271 void RNA_api_keyingset(struct StructRNA *srna);
272 void RNA_api_keymap(struct StructRNA *srna);
273 void RNA_api_keymaps(struct StructRNA *srna);
274 void RNA_api_keymapitem(struct StructRNA *srna);
275 void RNA_api_keymapitems(struct StructRNA *srna);
276 void RNA_api_main(struct StructRNA *srna);
277 void RNA_api_material(StructRNA *srna);
278 void RNA_api_mesh(struct StructRNA *srna);
279 void RNA_api_meta(struct StructRNA *srna);
280 void RNA_api_object(struct StructRNA *srna);
281 void RNA_api_object_base(struct StructRNA *srna);
282 void RNA_api_pose(struct StructRNA *srna);
283 void RNA_api_pose_channel(struct StructRNA *srna);
284 void RNA_api_scene(struct StructRNA *srna);
285 void RNA_api_scene_render(struct StructRNA *srna);
286 void RNA_api_sequence_strip(StructRNA *srna);
287 void RNA_api_text(struct StructRNA *srna);
288 void RNA_api_ui_layout(struct StructRNA *srna);
289 void RNA_api_window(struct StructRNA *srna);
290 void RNA_api_wm(struct StructRNA *srna);
291 void RNA_api_space_node(struct StructRNA *srna);
292 void RNA_api_space_text(struct StructRNA *srna);
293 void RNA_api_region_view3d(struct StructRNA *srna);
294 void RNA_api_sensor(struct StructRNA *srna);
295 void RNA_api_controller(struct StructRNA *srna);
296 void RNA_api_actuator(struct StructRNA *srna);
297 void RNA_api_texture(struct StructRNA *srna);
298 void RNA_api_environment_map(struct StructRNA *srna);
299 void RNA_api_sequences(BlenderRNA *brna, PropertyRNA *cprop);
300 void RNA_api_sequence_elements(BlenderRNA *brna, PropertyRNA *cprop);
301 void RNA_api_sound(struct StructRNA *srna);
302 void RNA_api_vfont(struct StructRNA *srna);
303
304 /* main collection functions */
305 void RNA_def_main_cameras(BlenderRNA *brna, PropertyRNA *cprop);
306 void RNA_def_main_scenes(BlenderRNA *brna, PropertyRNA *cprop);
307 void RNA_def_main_objects(BlenderRNA *brna, PropertyRNA *cprop);
308 void RNA_def_main_materials(BlenderRNA *brna, PropertyRNA *cprop);
309 void RNA_def_main_node_groups(BlenderRNA *brna, PropertyRNA *cprop);
310 void RNA_def_main_meshes(BlenderRNA *brna, PropertyRNA *cprop);
311 void RNA_def_main_lamps(BlenderRNA *brna, PropertyRNA *cprop);
312 void RNA_def_main_libraries(BlenderRNA *brna, PropertyRNA *cprop);
313 void RNA_def_main_screens(BlenderRNA *brna, PropertyRNA *cprop);
314 void RNA_def_main_window_managers(BlenderRNA *brna, PropertyRNA *cprop);
315 void RNA_def_main_images(BlenderRNA *brna, PropertyRNA *cprop);
316 void RNA_def_main_lattices(BlenderRNA *brna, PropertyRNA *cprop);
317 void RNA_def_main_curves(BlenderRNA *brna, PropertyRNA *cprop);
318 void RNA_def_main_metaballs(BlenderRNA *brna, PropertyRNA *cprop);
319 void RNA_def_main_fonts(BlenderRNA *brna, PropertyRNA *cprop);
320 void RNA_def_main_textures(BlenderRNA *brna, PropertyRNA *cprop);
321 void RNA_def_main_brushes(BlenderRNA *brna, PropertyRNA *cprop);
322 void RNA_def_main_worlds(BlenderRNA *brna, PropertyRNA *cprop);
323 void RNA_def_main_groups(BlenderRNA *brna, PropertyRNA *cprop);
324 void RNA_def_main_texts(BlenderRNA *brna, PropertyRNA *cprop);
325 void RNA_def_main_speakers(BlenderRNA *brna, PropertyRNA *cprop);
326 void RNA_def_main_sounds(BlenderRNA *brna, PropertyRNA *cprop);
327 void RNA_def_main_armatures(BlenderRNA *brna, PropertyRNA *cprop);
328 void RNA_def_main_actions(BlenderRNA *brna, PropertyRNA *cprop);
329 void RNA_def_main_palettes(BlenderRNA *brna, PropertyRNA *cprop);
330 void RNA_def_main_gpencil(BlenderRNA *brna, PropertyRNA *cprop);
331 void RNA_def_main_movieclips(BlenderRNA *brna, PropertyRNA *cprop);
332 void RNA_def_main_masks(BlenderRNA *brna, PropertyRNA *cprop);
333 void RNA_def_main_linestyles(BlenderRNA *brna, PropertyRNA *cprop);
334 void RNA_def_main_cachefiles(BlenderRNA *brna, PropertyRNA *cprop);
335
336 /* ID Properties */
337
338 extern StringPropertyRNA rna_PropertyGroupItem_string;
339 extern IntPropertyRNA rna_PropertyGroupItem_int;
340 extern IntPropertyRNA rna_PropertyGroupItem_int_array;
341 extern FloatPropertyRNA rna_PropertyGroupItem_float;
342 extern FloatPropertyRNA rna_PropertyGroupItem_float_array;
343 extern PointerPropertyRNA rna_PropertyGroupItem_group;
344 extern CollectionPropertyRNA rna_PropertyGroupItem_collection;
345 extern CollectionPropertyRNA rna_PropertyGroupItem_idp_array;
346 extern FloatPropertyRNA rna_PropertyGroupItem_double;
347 extern FloatPropertyRNA rna_PropertyGroupItem_double_array;
348
349 #ifndef __RNA_ACCESS_H__
350 extern StructRNA RNA_PropertyGroupItem;
351 extern StructRNA RNA_PropertyGroup;
352 #endif
353
354 struct IDProperty *rna_idproperty_check(struct PropertyRNA **prop, struct PointerRNA *ptr);
355
356 /* Builtin Property Callbacks */
357
358 void rna_builtin_properties_begin(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
359 void rna_builtin_properties_next(struct CollectionPropertyIterator *iter);
360 PointerRNA rna_builtin_properties_get(struct CollectionPropertyIterator *iter);
361 PointerRNA rna_builtin_type_get(struct PointerRNA *ptr);
362 int rna_builtin_properties_lookup_string(PointerRNA *ptr, const char *key, PointerRNA *r_ptr);
363
364 /* Iterators */
365
366 void rna_iterator_listbase_begin(struct CollectionPropertyIterator *iter, struct ListBase *lb, IteratorSkipFunc skip);
367 void rna_iterator_listbase_next(struct CollectionPropertyIterator *iter);
368 void *rna_iterator_listbase_get(struct CollectionPropertyIterator *iter);
369 void rna_iterator_listbase_end(struct CollectionPropertyIterator *iter);
370 PointerRNA rna_listbase_lookup_int(PointerRNA *ptr, StructRNA *type, struct ListBase *lb, int index);
371
372 void rna_iterator_array_begin(struct CollectionPropertyIterator *iter, void *ptr, int itemsize, int length,
373                               bool free_ptr, IteratorSkipFunc skip);
374 void rna_iterator_array_next(struct CollectionPropertyIterator *iter);
375 void *rna_iterator_array_get(struct CollectionPropertyIterator *iter);
376 void *rna_iterator_array_dereference_get(struct CollectionPropertyIterator *iter);
377 void rna_iterator_array_end(struct CollectionPropertyIterator *iter);
378 PointerRNA rna_array_lookup_int(PointerRNA *ptr, StructRNA *type, void *data, int itemsize, int length, int index);
379
380 /* Duplicated code since we can't link in blenlib */
381
382 void rna_addtail(struct ListBase *listbase, void *vlink);
383 void rna_freelinkN(struct ListBase *listbase, void *vlink);
384 void rna_freelistN(struct ListBase *listbase);
385 PropertyDefRNA *rna_findlink(ListBase *listbase, const char *identifier);
386
387 StructDefRNA *rna_find_struct_def(StructRNA *srna);
388 FunctionDefRNA *rna_find_function_def(FunctionRNA *func);
389 PropertyDefRNA *rna_find_parameter_def(PropertyRNA *parm);
390 PropertyDefRNA *rna_find_struct_property_def(StructRNA *srna, PropertyRNA *prop);
391
392 /* Pointer Handling */
393
394 PointerRNA rna_pointer_inherit_refine(struct PointerRNA *ptr, struct StructRNA *type, void *data);
395
396 /* Functions */
397
398 int rna_parameter_size(struct PropertyRNA *parm);
399
400 struct Mesh *rna_Main_meshes_new_from_object(
401         struct Main *bmain, struct ReportList *reports, struct Scene *sce,
402         struct Object *ob, int apply_modifiers, int settings, int calc_tessface, int calc_undeformed);
403
404 /* XXX, these should not need to be defined here~! */
405 struct MTex *rna_mtex_texture_slots_add(struct ID *self, struct bContext *C, struct ReportList *reports);
406 struct MTex *rna_mtex_texture_slots_create(struct ID *self, struct bContext *C, struct ReportList *reports, int index);
407 void rna_mtex_texture_slots_clear(struct ID *self, struct bContext *C, struct ReportList *reports, int index);
408
409
410 int rna_IDMaterials_assign_int(struct PointerRNA *ptr, int key, const struct PointerRNA *assign_ptr);
411
412
413 /* Internal functions that cycles uses so we need to declare (tsk tsk) */
414 void rna_RenderLayer_rect_set(PointerRNA *ptr, const float *values);
415 void rna_RenderPass_rect_set(PointerRNA *ptr, const float *values);
416
417 #ifdef RNA_RUNTIME
418 #  ifdef __GNUC__
419 #    pragma GCC diagnostic ignored "-Wredundant-decls"
420 #  endif
421 #endif
422
423 /* C11 for compile time range checks */
424 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
425 #  define USE_RNA_RANGE_CHECK
426 #  define TYPEOF_MAX(x) \
427         _Generic((x), \
428                 bool: 1, \
429                 char: CHAR_MAX, signed char: SCHAR_MAX, unsigned char: UCHAR_MAX, \
430                 signed short: SHRT_MAX, unsigned short: USHRT_MAX, \
431                 signed int: INT_MAX, unsigned int: UINT_MAX, \
432                 float: FLT_MAX, double: DBL_MAX)
433
434 #  define TYPEOF_MIN(x) \
435         _Generic((x), \
436                 bool: 0, \
437                 char: CHAR_MIN, signed char: SCHAR_MIN, unsigned char: 0, \
438                 signed short: SHRT_MIN, unsigned short: 0, \
439                 signed int: INT_MIN, unsigned int: 0, \
440                 float: -FLT_MAX, double: -DBL_MAX)
441 #endif
442
443 #endif  /* __RNA_INTERNAL_H__ */