Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesrna / RNA_define.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 #ifndef __RNA_DEFINE_H__
24 #define __RNA_DEFINE_H__
25
26 /** \file RNA_define.h
27  *  \ingroup RNA
28  *  Functions used during preprocess and runtime, for defining the RNA. */
29
30 #include <float.h>
31 #include <limits.h>
32
33 #include "DNA_listBase.h"
34 #include "RNA_types.h"
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #ifdef UNIT_TEST
41 #define RNA_MAX_ARRAY_LENGTH 64
42 #else
43 #define RNA_MAX_ARRAY_LENGTH 32
44 #endif
45
46 #define RNA_MAX_ARRAY_DIMENSION 3
47
48 /* Blender RNA */
49
50 BlenderRNA *RNA_create(void);
51 void RNA_define_free(BlenderRNA *brna);
52 void RNA_free(BlenderRNA *brna);
53 void RNA_define_verify_sdna(bool verify);
54 void RNA_define_animate_sdna(bool animate);
55
56 void RNA_init(void);
57 void RNA_exit(void);
58
59 /* Struct */
60
61 StructRNA *RNA_def_struct_ptr(BlenderRNA *brna, const char *identifier, StructRNA *srnafrom);
62 StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from);
63 void RNA_def_struct_sdna(StructRNA *srna, const char *structname);
64 void RNA_def_struct_sdna_from(StructRNA *srna, const char *structname, const char *propname);
65 void RNA_def_struct_name_property(StructRNA *srna, PropertyRNA *prop);
66 void RNA_def_struct_nested(BlenderRNA *brna, StructRNA *srna, const char *structname);
67 void RNA_def_struct_flag(StructRNA *srna, int flag);
68 void RNA_def_struct_clear_flag(StructRNA *srna, int flag);
69 void RNA_def_struct_refine_func(StructRNA *srna, const char *refine);
70 void RNA_def_struct_idprops_func(StructRNA *srna, const char *refine);
71 void RNA_def_struct_register_funcs(StructRNA *srna, const char *reg, const char *unreg, const char *instance);
72 void RNA_def_struct_path_func(StructRNA *srna, const char *path);
73 void RNA_def_struct_identifier_no_struct_map(StructRNA *srna, const char *identifier);
74 void RNA_def_struct_identifier(BlenderRNA *brna, StructRNA *srna, const char *identifier);
75 void RNA_def_struct_ui_text(StructRNA *srna, const char *name, const char *description);
76 void RNA_def_struct_ui_icon(StructRNA *srna, int icon);
77 void RNA_struct_free_extension(StructRNA *srna, ExtensionRNA *ext);
78 void RNA_struct_free(BlenderRNA *brna, StructRNA *srna);
79
80 void RNA_def_struct_translation_context(StructRNA *srna, const char *context);
81
82 /* Compact Property Definitions */
83
84 typedef void StructOrFunctionRNA;
85
86 PropertyRNA *RNA_def_boolean(StructOrFunctionRNA *cont, const char *identifier, int default_value, const char *ui_name, const char *ui_description);
87 PropertyRNA *RNA_def_boolean_array(StructOrFunctionRNA *cont, const char *identifier, int len, int *default_value, const char *ui_name, const char *ui_description);
88 PropertyRNA *RNA_def_boolean_layer(StructOrFunctionRNA *cont, const char *identifier, int len, int *default_value, const char *ui_name, const char *ui_description);
89 PropertyRNA *RNA_def_boolean_layer_member(StructOrFunctionRNA *cont, const char *identifier, int len, int *default_value, const char *ui_name, const char *ui_description);
90 PropertyRNA *RNA_def_boolean_vector(StructOrFunctionRNA *cont, const char *identifier, int len, int *default_value, const char *ui_name, const char *ui_description);
91
92 PropertyRNA *RNA_def_int(StructOrFunctionRNA *cont, const char *identifier, int default_value, int hardmin, int hardmax, const char *ui_name, const char *ui_description, int softmin, int softmax);
93 PropertyRNA *RNA_def_int_vector(StructOrFunctionRNA *cont, const char *identifier, int len, const int *default_value, int hardmin, int hardmax, const char *ui_name, const char *ui_description, int softmin, int softmax);
94 PropertyRNA *RNA_def_int_array(StructOrFunctionRNA *cont, const char *identifier, int len, const int *default_value, int hardmin, int hardmax, const char *ui_name, const char *ui_description, int softmin, int softmax);
95
96 PropertyRNA *RNA_def_string(StructOrFunctionRNA *cont, const char *identifier, const char *default_value, int maxlen, const char *ui_name, const char *ui_description);
97 PropertyRNA *RNA_def_string_file_path(StructOrFunctionRNA *cont, const char *identifier, const char *default_value, int maxlen, const char *ui_name, const char *ui_description);
98 PropertyRNA *RNA_def_string_dir_path(StructOrFunctionRNA *cont, const char *identifier, const char *default_value, int maxlen, const char *ui_name, const char *ui_description);
99 PropertyRNA *RNA_def_string_file_name(StructOrFunctionRNA *cont, const char *identifier, const char *default_value, int maxlen, const char *ui_name, const char *ui_description);
100
101 PropertyRNA *RNA_def_enum(StructOrFunctionRNA *cont, const char *identifier, const EnumPropertyItem *items, int default_value, const char *ui_name, const char *ui_description);
102 PropertyRNA *RNA_def_enum_flag(StructOrFunctionRNA *cont, const char *identifier, const EnumPropertyItem *items, int default_value, const char *ui_name, const char *ui_description);
103 void RNA_def_enum_funcs(PropertyRNA *prop, EnumPropertyItemFunc itemfunc);
104
105 PropertyRNA *RNA_def_float(StructOrFunctionRNA *cont, const char *identifier, float default_value, float hardmin, float hardmax, const char *ui_name, const char *ui_description, float softmin, float softmax);
106 PropertyRNA *RNA_def_float_vector(StructOrFunctionRNA *cont, const char *identifier, int len, const float *default_value, float hardmin, float hardmax, const char *ui_name, const char *ui_description, float softmin, float softmax);
107 PropertyRNA *RNA_def_float_vector_xyz(StructOrFunctionRNA *cont, const char *identifier, int len, const float *default_value, float hardmin, float hardmax, const char *ui_name, const char *ui_description, float softmin, float softmax);
108 PropertyRNA *RNA_def_float_color(StructOrFunctionRNA *cont, const char *identifier, int len, const float *default_value, float hardmin, float hardmax, const char *ui_name, const char *ui_description, float softmin, float softmax);
109 PropertyRNA *RNA_def_float_matrix(StructOrFunctionRNA *cont, const char *identifier, int rows, int columns, const float *default_value, float hardmin, float hardmax, const char *ui_name, const char *ui_description, float softmin, float softmax);
110 PropertyRNA *RNA_def_float_rotation(StructOrFunctionRNA *cont, const char *identifier, int len, const float *default_value,
111         float hardmin, float hardmax, const char *ui_name, const char *ui_description, float softmin, float softmax);
112 PropertyRNA *RNA_def_float_distance(StructOrFunctionRNA *cont, const char *identifier, float default_value,
113         float hardmin, float hardmax, const char *ui_name, const char *ui_description, float softmin, float softmax);
114 PropertyRNA *RNA_def_float_array(StructOrFunctionRNA *cont, const char *identifier, int len, const float *default_value,
115         float hardmin, float hardmax, const char *ui_name, const char *ui_description, float softmin, float softmax);
116
117 //PropertyRNA *RNA_def_float_dynamic_array(StructOrFunctionRNA *cont, const char *identifier, float hardmin, float hardmax,
118 //      const char *ui_name, const char *ui_description, float softmin, float softmax, unsigned int dimension, unsigned short dim_size[]);
119
120 PropertyRNA *RNA_def_float_percentage(StructOrFunctionRNA *cont, const char *identifier, float default_value, float hardmin, float hardmax,
121         const char *ui_name, const char *ui_description, float softmin, float softmax);
122 PropertyRNA *RNA_def_float_factor(StructOrFunctionRNA *cont, const char *identifier, float default_value, float hardmin, float hardmax,
123         const char *ui_name, const char *ui_description, float softmin, float softmax);
124
125 PropertyRNA *RNA_def_pointer(StructOrFunctionRNA *cont, const char *identifier, const char *type,
126         const char *ui_name, const char *ui_description);
127 PropertyRNA *RNA_def_pointer_runtime(StructOrFunctionRNA *cont, const char *identifier, StructRNA *type,
128         const char *ui_name, const char *ui_description);
129
130 PropertyRNA *RNA_def_collection(StructOrFunctionRNA *cont, const char *identifier, const char *type,
131         const char *ui_name, const char *ui_description);
132 PropertyRNA *RNA_def_collection_runtime(StructOrFunctionRNA *cont, const char *identifier, StructRNA *type,
133         const char *ui_name, const char *ui_description);
134
135 /* Extended Property Definitions */
136
137 PropertyRNA *RNA_def_property(StructOrFunctionRNA *cont, const char *identifier, int type, int subtype);
138
139 void RNA_def_property_boolean_sdna(PropertyRNA *prop, const char *structname, const char *propname, int bit);
140 void RNA_def_property_boolean_negative_sdna(PropertyRNA *prop, const char *structname, const char *propname, int bit);
141 void RNA_def_property_int_sdna(PropertyRNA *prop, const char *structname, const char *propname);
142 void RNA_def_property_float_sdna(PropertyRNA *prop, const char *structname, const char *propname);
143 void RNA_def_property_string_sdna(PropertyRNA *prop, const char *structname, const char *propname);
144 void RNA_def_property_enum_sdna(PropertyRNA *prop, const char *structname, const char *propname);
145 void RNA_def_property_enum_bitflag_sdna(PropertyRNA *prop, const char *structname, const char *propname);
146 void RNA_def_property_pointer_sdna(PropertyRNA *prop, const char *structname, const char *propname);
147 void RNA_def_property_collection_sdna(PropertyRNA *prop, const char *structname, const char *propname, const char *lengthpropname);
148
149 void RNA_def_property_flag(PropertyRNA *prop, PropertyFlag flag);
150 void RNA_def_property_clear_flag(PropertyRNA *prop, PropertyFlag flag);
151 void RNA_def_property_subtype(PropertyRNA *prop, PropertySubType subtype);
152 void RNA_def_property_array(PropertyRNA *prop, int length);
153 void RNA_def_property_multi_array(PropertyRNA *prop, int dimension, const int length[]);
154 void RNA_def_property_range(PropertyRNA *prop, double min, double max);
155
156 void RNA_def_property_enum_items(PropertyRNA *prop, const EnumPropertyItem *item);
157 void RNA_def_property_string_maxlength(PropertyRNA *prop, int maxlength);
158 void RNA_def_property_struct_type(PropertyRNA *prop, const char *type);
159 void RNA_def_property_struct_runtime(PropertyRNA *prop, StructRNA *type);
160
161 void RNA_def_property_boolean_default(PropertyRNA *prop, int value);
162 void RNA_def_property_boolean_array_default(PropertyRNA *prop, const int *array);
163 void RNA_def_property_int_default(PropertyRNA *prop, int value);
164 void RNA_def_property_int_array_default(PropertyRNA *prop, const int *array);
165 void RNA_def_property_float_default(PropertyRNA *prop, float value);
166 void RNA_def_property_float_array_default(PropertyRNA *prop, const float *array);
167 void RNA_def_property_enum_default(PropertyRNA *prop, int value);
168 void RNA_def_property_string_default(PropertyRNA *prop, const char *value);
169
170 void RNA_def_property_ui_text(PropertyRNA *prop, const char *name, const char *description);
171 void RNA_def_property_ui_range(PropertyRNA *prop, double min, double max, double step, int precision);
172 void RNA_def_property_ui_icon(PropertyRNA *prop, int icon, bool consecutive);
173
174 void RNA_def_property_update(PropertyRNA *prop, int noteflag, const char *updatefunc);
175 void RNA_def_property_editable_func(PropertyRNA *prop, const char *editable);
176 void RNA_def_property_editable_array_func(PropertyRNA *prop, const char *editable);
177
178 void RNA_def_property_update_runtime(PropertyRNA *prop, const void *func);
179 void RNA_def_property_poll_runtime(PropertyRNA *prop, const void *func);
180
181 void RNA_def_property_dynamic_array_funcs(PropertyRNA *prop, const char *getlength);
182 void RNA_def_property_boolean_funcs(PropertyRNA *prop, const char *get, const char *set);
183 void RNA_def_property_int_funcs(PropertyRNA *prop, const char *get, const char *set, const char *range);
184 void RNA_def_property_float_funcs(PropertyRNA *prop, const char *get, const char *set, const char *range);
185 void RNA_def_property_enum_funcs(PropertyRNA *prop, const char *get, const char *set, const char *item);
186 void RNA_def_property_string_funcs(PropertyRNA *prop, const char *get, const char *length, const char *set);
187 void RNA_def_property_pointer_funcs(PropertyRNA *prop, const char *get, const char *set, const char *typef, const char *poll);
188 void RNA_def_property_collection_funcs(PropertyRNA *prop, const char *begin, const char *next, const char *end, const char *get, const char *length, const char *lookupint, const char *lookupstring, const char *assignint);
189 void RNA_def_property_srna(PropertyRNA *prop, const char *type);
190 void RNA_def_py_data(PropertyRNA *prop, void *py_data);
191
192 void RNA_def_property_boolean_funcs_runtime(PropertyRNA *prop, BooleanPropertyGetFunc getfunc, BooleanPropertySetFunc setfunc);
193 void RNA_def_property_boolean_array_funcs_runtime(PropertyRNA *prop, BooleanArrayPropertyGetFunc getfunc, BooleanArrayPropertySetFunc setfunc);
194 void RNA_def_property_int_funcs_runtime(PropertyRNA *prop, IntPropertyGetFunc getfunc, IntPropertySetFunc setfunc, IntPropertyRangeFunc rangefunc);
195 void RNA_def_property_int_array_funcs_runtime(PropertyRNA *prop, IntArrayPropertyGetFunc getfunc, IntArrayPropertySetFunc setfunc, IntPropertyRangeFunc rangefunc);
196 void RNA_def_property_float_funcs_runtime(PropertyRNA *prop, FloatPropertyGetFunc getfunc, FloatPropertySetFunc setfunc, FloatPropertyRangeFunc rangefunc);
197 void RNA_def_property_float_array_funcs_runtime(PropertyRNA *prop, FloatArrayPropertyGetFunc getfunc, FloatArrayPropertySetFunc setfunc, FloatPropertyRangeFunc rangefunc);
198 void RNA_def_property_enum_funcs_runtime(PropertyRNA *prop, EnumPropertyGetFunc getfunc, EnumPropertySetFunc setfunc, EnumPropertyItemFunc itemfunc);
199 void RNA_def_property_string_funcs_runtime(PropertyRNA *prop, StringPropertyGetFunc getfunc, StringPropertyLengthFunc lengthfunc, StringPropertySetFunc setfunc);
200
201 void RNA_def_property_enum_py_data(PropertyRNA *prop, void *py_data);
202
203 void RNA_def_property_translation_context(PropertyRNA *prop, const char *context);
204
205 /* Function */
206
207 FunctionRNA *RNA_def_function(StructRNA *srna, const char *identifier, const char *call);
208 FunctionRNA *RNA_def_function_runtime(StructRNA *srna, const char *identifier, CallFunc call);
209 void RNA_def_function_return(FunctionRNA *func, PropertyRNA *ret);
210 void RNA_def_function_output(FunctionRNA *func, PropertyRNA *ret);
211 void RNA_def_function_flag(FunctionRNA *func, int flag);
212 void RNA_def_function_ui_description(FunctionRNA *func, const char *description);
213
214 void RNA_def_parameter_flags(PropertyRNA *prop, PropertyFlag flag_property, ParameterFlag flag_parameter);
215 void RNA_def_parameter_clear_flags(PropertyRNA *prop, PropertyFlag flag_property, ParameterFlag flag_parameter);
216
217 /* Dynamic Enums
218  * strings are not freed, assumed pointing to static location. */
219
220 void RNA_enum_item_add(EnumPropertyItem **items, int *totitem, const EnumPropertyItem *item);
221 void RNA_enum_item_add_separator(EnumPropertyItem **items, int *totitem);
222 void RNA_enum_items_add(EnumPropertyItem **items, int *totitem, EnumPropertyItem *item);
223 void RNA_enum_items_add_value(EnumPropertyItem **items, int *totitem, EnumPropertyItem *item, int value);
224 void RNA_enum_item_end(EnumPropertyItem **items, int *totitem);
225
226 /* Memory management */
227
228 void RNA_def_struct_duplicate_pointers(BlenderRNA *brna, StructRNA *srna);
229 void RNA_def_struct_free_pointers(BlenderRNA *brna, StructRNA *srna);
230 void RNA_def_func_duplicate_pointers(FunctionRNA *func);
231 void RNA_def_func_free_pointers(FunctionRNA *func);
232 void RNA_def_property_duplicate_pointers(StructOrFunctionRNA *cont_, PropertyRNA *prop);
233 void RNA_def_property_free_pointers(PropertyRNA *prop);
234 int RNA_def_property_free_identifier(StructOrFunctionRNA *cont_, const char *identifier);
235
236 /* utilities */
237 const char *RNA_property_typename(PropertyType type);
238 #define IS_DNATYPE_FLOAT_COMPAT(_str) (strcmp(_str, "float") == 0 || strcmp(_str, "double") == 0)
239 #define IS_DNATYPE_INT_COMPAT(_str) (strcmp(_str, "int") == 0 || strcmp(_str, "short") == 0 || strcmp(_str, "char") == 0)
240
241 void RNA_identifier_sanitize(char *identifier, int property);
242
243 extern const int rna_matrix_dimsize_3x3[];
244 extern const int rna_matrix_dimsize_4x4[];
245 extern const int rna_matrix_dimsize_4x2[];
246
247 /* max size for dynamic defined type descriptors,
248  * this value is arbitrary */
249 #define RNA_DYN_DESCR_MAX 240
250
251 #ifdef __cplusplus
252 }
253 #endif
254
255 #endif /* __RNA_DEFINE_H__ */
256