Merging r42648 through r42722 from trunk into soc-2011-tomato
[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 /* Blender RNA */
41
42 BlenderRNA *RNA_create(void);
43 void RNA_define_free(BlenderRNA *brna);
44 void RNA_free(BlenderRNA *brna);
45 void RNA_define_verify_sdna(int verify);
46
47 void RNA_init(void);
48 void RNA_exit(void);
49
50 /* Struct */
51
52 StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from);
53 void RNA_def_struct_sdna(StructRNA *srna, const char *structname);
54 void RNA_def_struct_sdna_from(StructRNA *srna, const char *structname, const char *propname);
55 void RNA_def_struct_name_property(StructRNA *srna, PropertyRNA *prop);
56 void RNA_def_struct_nested(BlenderRNA *brna, StructRNA *srna, const char *structname);
57 void RNA_def_struct_flag(StructRNA *srna, int flag);
58 void RNA_def_struct_clear_flag(StructRNA *srna, int flag);
59 void RNA_def_struct_refine_func(StructRNA *srna, const char *refine);
60 void RNA_def_struct_idprops_func(StructRNA *srna, const char *refine);
61 void RNA_def_struct_register_funcs(StructRNA *srna, const char *reg, const char *unreg, const char *instance);
62 void RNA_def_struct_path_func(StructRNA *srna, const char *path);
63 void RNA_def_struct_identifier(StructRNA *srna, const char *identifier);
64 void RNA_def_struct_ui_text(StructRNA *srna, const char *name, const char *description);
65 void RNA_def_struct_ui_icon(StructRNA *srna, int icon);
66 void RNA_struct_free_extension(StructRNA *srna, ExtensionRNA *ext);
67 void RNA_struct_free(BlenderRNA *brna, StructRNA *srna);
68
69 /* Compact Property Definitions */
70
71 typedef void StructOrFunctionRNA;
72
73 PropertyRNA *RNA_def_boolean(StructOrFunctionRNA *cont, const char *identifier, int default_value, const char *ui_name, const char *ui_description);
74 PropertyRNA *RNA_def_boolean_array(StructOrFunctionRNA *cont, const char *identifier, int len, int *default_value, const char *ui_name, const char *ui_description);
75 PropertyRNA *RNA_def_boolean_layer(StructOrFunctionRNA *cont, const char *identifier, int len, int *default_value, const char *ui_name, const char *ui_description);
76 PropertyRNA *RNA_def_boolean_layer_member(StructOrFunctionRNA *cont, const char *identifier, int len, int *default_value, const char *ui_name, const char *ui_description);
77 PropertyRNA *RNA_def_boolean_vector(StructOrFunctionRNA *cont, const char *identifier, int len, int *default_value, const char *ui_name, const char *ui_description);
78
79 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);
80 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);
81 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);
82
83 PropertyRNA *RNA_def_string(StructOrFunctionRNA *cont, const char *identifier, const char *default_value, int maxlen, const char *ui_name, const char *ui_description);
84 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);
85 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);
86 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);
87 PropertyRNA *RNA_def_string_translate(StructOrFunctionRNA *cont, const char *identifier, const char *default_value, int maxlen, const char *ui_name, const char *ui_description);
88
89 PropertyRNA *RNA_def_enum(StructOrFunctionRNA *cont, const char *identifier, const EnumPropertyItem *items, int default_value, const char *ui_name, const char *ui_description);
90 PropertyRNA *RNA_def_enum_flag(StructOrFunctionRNA *cont, const char *identifier, const EnumPropertyItem *items, int default_value, const char *ui_name, const char *ui_description);
91 void RNA_def_enum_funcs(PropertyRNA *prop, EnumPropertyItemFunc itemfunc);
92 void RNA_def_enum_py_data(PropertyRNA *prop, void *py_data);
93
94 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);
95 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);
96 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);
97 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);
98 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);
99 PropertyRNA *RNA_def_float_rotation(StructOrFunctionRNA *cont, const char *identifier, int len, const float *default_value,
100         float hardmin, float hardmax, const char *ui_name, const char *ui_description, float softmin, float softmax);
101 PropertyRNA *RNA_def_float_array(StructOrFunctionRNA *cont, const char *identifier, int len, const float *default_value,
102         float hardmin, float hardmax, const char *ui_name, const char *ui_description, float softmin, float softmax);
103         /*
104 PropertyRNA *RNA_def_float_dynamic_array(StructOrFunctionRNA *cont, const char *identifier, float hardmin, float hardmax,
105         const char *ui_name, const char *ui_description, float softmin, float softmax, unsigned int dimension, unsigned short dim_size[]);
106         */
107 PropertyRNA *RNA_def_float_percentage(StructOrFunctionRNA *cont, const char *identifier, float default_value, float hardmin, float hardmax,
108         const char *ui_name, const char *ui_description, float softmin, float softmax);
109 PropertyRNA *RNA_def_float_factor(StructOrFunctionRNA *cont, const char *identifier, float default_value, float hardmin, float hardmax,
110         const char *ui_name, const char *ui_description, float softmin, float softmax);
111
112 PropertyRNA *RNA_def_pointer(StructOrFunctionRNA *cont, const char *identifier, const char *type,
113         const char *ui_name, const char *ui_description);
114 PropertyRNA *RNA_def_pointer_runtime(StructOrFunctionRNA *cont, const char *identifier, StructRNA *type,
115         const char *ui_name, const char *ui_description);
116
117 PropertyRNA *RNA_def_collection(StructOrFunctionRNA *cont, const char *identifier, const char *type,
118         const char *ui_name, const char *ui_description);
119 PropertyRNA *RNA_def_collection_runtime(StructOrFunctionRNA *cont, const char *identifier, StructRNA *type,
120         const char *ui_name, const char *ui_description);
121
122 /* Extended Property Definitions */
123
124 PropertyRNA *RNA_def_property(StructOrFunctionRNA *cont, const char *identifier, int type, int subtype);
125
126 void RNA_def_property_boolean_sdna(PropertyRNA *prop, const char *structname, const char *propname, int bit);
127 void RNA_def_property_boolean_negative_sdna(PropertyRNA *prop, const char *structname, const char *propname, int bit);
128 void RNA_def_property_int_sdna(PropertyRNA *prop, const char *structname, const char *propname);
129 void RNA_def_property_float_sdna(PropertyRNA *prop, const char *structname, const char *propname);
130 void RNA_def_property_string_sdna(PropertyRNA *prop, const char *structname, const char *propname);
131 void RNA_def_property_enum_sdna(PropertyRNA *prop, const char *structname, const char *propname);
132 void RNA_def_property_enum_bitflag_sdna(PropertyRNA *prop, const char *structname, const char *propname);
133 void RNA_def_property_pointer_sdna(PropertyRNA *prop, const char *structname, const char *propname);
134 void RNA_def_property_collection_sdna(PropertyRNA *prop, const char *structname, const char *propname, const char *lengthpropname);
135
136 void RNA_def_property_flag(PropertyRNA *prop, int flag);
137 void RNA_def_property_clear_flag(PropertyRNA *prop, int flag);
138 void RNA_def_property_subtype(PropertyRNA *prop, PropertySubType subtype);
139 void RNA_def_property_array(PropertyRNA *prop, int length);
140 void RNA_def_property_multi_array(PropertyRNA *prop, int dimension, const int length[]);
141 void RNA_def_property_range(PropertyRNA *prop, double min, double max);
142
143 void RNA_def_property_enum_items(PropertyRNA *prop, const EnumPropertyItem *item);
144 void RNA_def_property_string_maxlength(PropertyRNA *prop, int maxlength);
145 void RNA_def_property_struct_type(PropertyRNA *prop, const char *type);
146 void RNA_def_property_struct_runtime(PropertyRNA *prop, StructRNA *type);
147
148 void RNA_def_property_boolean_default(PropertyRNA *prop, int value);
149 void RNA_def_property_boolean_array_default(PropertyRNA *prop, const int *array);
150 void RNA_def_property_int_default(PropertyRNA *prop, int value);
151 void RNA_def_property_int_array_default(PropertyRNA *prop, const int *array);
152 void RNA_def_property_float_default(PropertyRNA *prop, float value);
153 void RNA_def_property_float_array_default(PropertyRNA *prop, const float *array);
154 void RNA_def_property_enum_default(PropertyRNA *prop, int value);
155 void RNA_def_property_string_default(PropertyRNA *prop, const char *value);
156
157 void RNA_def_property_ui_text(PropertyRNA *prop, const char *name, const char *description);
158 void RNA_def_property_ui_range(PropertyRNA *prop, double min, double max, double step, int precision);
159 void RNA_def_property_ui_icon(PropertyRNA *prop, int icon, int consecutive);
160
161 void RNA_def_property_update(PropertyRNA *prop, int noteflag, const char *updatefunc);
162 void RNA_def_property_editable_func(PropertyRNA *prop, const char *editable);
163 void RNA_def_property_editable_array_func(PropertyRNA *prop, const char *editable);
164
165 void RNA_def_property_update_runtime(PropertyRNA *prop, void *func);
166
167 void RNA_def_property_dynamic_array_funcs(PropertyRNA *prop, const char *getlength);
168 void RNA_def_property_boolean_funcs(PropertyRNA *prop, const char *get, const char *set);
169 void RNA_def_property_int_funcs(PropertyRNA *prop, const char *get, const char *set, const char *range);
170 void RNA_def_property_float_funcs(PropertyRNA *prop, const char *get, const char *set, const char *range);
171 void RNA_def_property_enum_funcs(PropertyRNA *prop, const char *get, const char *set, const char *item);
172 void RNA_def_property_string_funcs(PropertyRNA *prop, const char *get, const char *length, const char *set);
173 void RNA_def_property_pointer_funcs(PropertyRNA *prop, const char *get, const char *set, const char *typef, const char *poll);
174 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);
175 void RNA_def_property_srna(PropertyRNA *prop, const char *type);
176 void RNA_def_py_data(PropertyRNA *prop, void *py_data);
177
178 /* Function */
179
180 FunctionRNA *RNA_def_function(StructRNA *srna, const char *identifier, const char *call);
181 FunctionRNA *RNA_def_function_runtime(StructRNA *srna, const char *identifier, CallFunc call);
182 void RNA_def_function_return(FunctionRNA *func, PropertyRNA *ret);
183 void RNA_def_function_output(FunctionRNA *func, PropertyRNA *ret);
184 void RNA_def_function_flag(FunctionRNA *func, int flag);
185 void RNA_def_function_ui_description(FunctionRNA *func, const char *description);
186
187 /* Dynamic Enums
188  * strings are not freed, assumed pointing to static location. */
189
190 void RNA_enum_item_add(EnumPropertyItem **items, int *totitem, const EnumPropertyItem *item);
191 void RNA_enum_item_add_separator(EnumPropertyItem **items, int *totitem);
192 void RNA_enum_items_add(EnumPropertyItem **items, int *totitem, EnumPropertyItem *item);
193 void RNA_enum_items_add_value(EnumPropertyItem **items, int *totitem, EnumPropertyItem *item, int value);
194 void RNA_enum_item_end(EnumPropertyItem **items, int *totitem);
195
196 /* Memory management */
197
198 void RNA_def_struct_duplicate_pointers(StructRNA *srna);
199 void RNA_def_struct_free_pointers(StructRNA *srna);
200 void RNA_def_func_duplicate_pointers(FunctionRNA *func);
201 void RNA_def_func_free_pointers(FunctionRNA *func);
202 void RNA_def_property_duplicate_pointers(StructOrFunctionRNA *cont_, PropertyRNA *prop);
203 void RNA_def_property_free_pointers(PropertyRNA *prop);
204 int RNA_def_property_free_identifier(StructOrFunctionRNA *cont_, const char *identifier);
205
206 /* utilities */
207 const char *RNA_property_typename(PropertyType type);
208 #define IS_DNATYPE_FLOAT_COMPAT(_str) (strcmp(_str, "float") == 0 || strcmp(_str, "double") == 0)
209 #define IS_DNATYPE_INT_COMPAT(_str) (strcmp(_str, "int") == 0 || strcmp(_str, "short") == 0 || strcmp(_str, "char") == 0)
210
211 /* max size for dynamic defined type descriptors,
212  * this value is arbitrary */
213 #define RNA_DYN_DESCR_MAX 240
214
215 #ifdef __cplusplus
216 }
217 #endif
218
219 #endif /* RNA_DEFINE_H */
220