2.5: Various Fixes
[blender.git] / source / blender / makesrna / RNA_define.h
index 6f0c1c1bca39d6b84d84362da35880d971f2addd..69f5b5adc37287953219c0eebceb1c0d098c4ef1 100644 (file)
 #ifndef RNA_DEFINE_H
 #define RNA_DEFINE_H
 
-/* Functions used during preprocess, for defining the RNA.
- *
- * This is currently only used internally in the module, but should eventually
- * also become available outside of that, at runtime for python and plugins.
- * Where the result of such runtime RNA is stored and how it integrates needs
- * to be figured out still. */
+/* Functions used during preprocess and runtime, for defining the RNA. */
+
+#include <float.h>
+#include <limits.h>
 
 #include "DNA_listBase.h"
+#include "RNA_types.h"
 
-struct BlenderRNA;
-struct StructRNA;
-struct PropertyRNA;
-struct PropertyEnumItem;
+#ifdef __cplusplus
+extern "C" {
+#endif
 
 /* Blender RNA */
 
-struct BlenderRNA *RNA_create(void);
-void RNA_define_free(struct BlenderRNA *brna);
-void RNA_free(struct BlenderRNA *brna);
+BlenderRNA *RNA_create(void);
+void RNA_define_free(BlenderRNA *brna);
+void RNA_free(BlenderRNA *brna);
+
+void RNA_init(void);
+void RNA_exit(void);
 
 /* Struct */
 
-struct StructRNA *RNA_def_struct(struct BlenderRNA *brna, const char *cname, const char *name);
-void RNA_def_struct_sdna(struct StructRNA *srna, const char *structname);
-void RNA_def_struct_name_property(struct StructRNA *srna, struct PropertyRNA *prop);
-void RNA_def_struct_flag(struct StructRNA *srna, int flag);
-
-/* Property */
-
-struct PropertyRNA *RNA_def_property(struct StructRNA *srna, const char *cname, int type, int subtype);
-
-void RNA_def_property_boolean_sdna(struct PropertyRNA *prop, const char *structname, const char *propname, int bit);
-void RNA_def_property_int_sdna(struct PropertyRNA *prop, const char *structname, const char *propname);
-void RNA_def_property_float_sdna(struct PropertyRNA *prop, const char *structname, const char *propname);
-void RNA_def_property_string_sdna(struct PropertyRNA *prop, const char *structname, const char *propname);
-void RNA_def_property_enum_sdna(struct PropertyRNA *prop, const char *structname, const char *propname);
-void RNA_def_property_pointer_sdna(struct PropertyRNA *prop, const char *structname, const char *propname);
-void RNA_def_property_collection_sdna(struct PropertyRNA *prop, const char *structname, const char *propname, const char *lengthpropname);
-
-void RNA_def_property_flag(struct PropertyRNA *prop, int flag);
-void RNA_def_property_array(struct PropertyRNA *prop, int arraylength);
-void RNA_def_property_range(struct PropertyRNA *prop, double min, double max);
-
-void RNA_def_property_enum_items(struct PropertyRNA *prop, const struct PropertyEnumItem *item);
-void RNA_def_property_string_maxlength(struct PropertyRNA *prop, int maxlength);
-void RNA_def_property_struct_type(struct PropertyRNA *prop, const char *type);
-
-void RNA_def_property_boolean_default(struct PropertyRNA *prop, int value);
-void RNA_def_property_boolean_array_default(struct PropertyRNA *prop, const int *array);
-void RNA_def_property_int_default(struct PropertyRNA *prop, int value);
-void RNA_def_property_int_array_default(struct PropertyRNA *prop, const int *array);
-void RNA_def_property_float_default(struct PropertyRNA *prop, float value);
-void RNA_def_property_float_array_default(struct PropertyRNA *prop, const float *array);
-void RNA_def_property_enum_default(struct PropertyRNA *prop, int value);
-void RNA_def_property_string_default(struct PropertyRNA *prop, const char *value);
-
-void RNA_def_property_ui_text(struct PropertyRNA *prop, const char *name, const char *description);
-void RNA_def_property_ui_range(struct PropertyRNA *prop, double min, double max, double step, double precision);
-
-void RNA_def_property_funcs(struct PropertyRNA *prop, const char *notify, const char *readonly);
-void RNA_def_property_boolean_funcs(struct PropertyRNA *prop, const char *get, const char *set);
-void RNA_def_property_int_funcs(struct PropertyRNA *prop, const char *get, const char *set);
-void RNA_def_property_float_funcs(struct PropertyRNA *prop, const char *get, const char *set);
-void RNA_def_property_enum_funcs(struct PropertyRNA *prop, const char *get, const char *set);
-void RNA_def_property_string_funcs(struct PropertyRNA *prop, const char *get, const char *length, const char *set);
-void RNA_def_property_pointer_funcs(struct PropertyRNA *prop, const char *get, const char *type, const char *set);
-void RNA_def_property_collection_funcs(struct PropertyRNA *prop, const char *begin, const char *next, const char *end, const char *get, const char *type, const char *length, const char *lookupint, const char *lookupstring);
+StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from);
+void RNA_def_struct_sdna(StructRNA *srna, const char *structname);
+void RNA_def_struct_sdna_from(StructRNA *srna, const char *structname, const char *propname);
+void RNA_def_struct_name_property(StructRNA *srna, PropertyRNA *prop);
+void RNA_def_struct_nested(BlenderRNA *brna, StructRNA *srna, const char *structname);
+void RNA_def_struct_flag(StructRNA *srna, int flag);
+void RNA_def_struct_clear_flag(StructRNA *srna, int flag);
+void RNA_def_struct_refine_func(StructRNA *srna, const char *refine);
+void RNA_def_struct_idproperties_func(StructRNA *srna, const char *refine);
+void RNA_def_struct_register_funcs(StructRNA *srna, const char *reg, const char *unreg);
+void RNA_def_struct_path_func(StructRNA *srna, const char *path);
+void RNA_def_struct_identifier(StructRNA *srna, const char *identifier);
+void RNA_def_struct_ui_text(StructRNA *srna, const char *name, const char *description);
+void RNA_def_struct_ui_icon(StructRNA *srna, int icon);
+void RNA_struct_free(BlenderRNA *brna, StructRNA *srna);
+
+/* Compact Property Definitions */
+
+typedef void StructOrFunctionRNA;
+
+PropertyRNA *RNA_def_boolean(StructOrFunctionRNA *cont, const char *identifier, int default_value, const char *ui_name, const char *ui_description);
+PropertyRNA *RNA_def_boolean_array(StructOrFunctionRNA *cont, const char *identifier, int len, int *default_value, const char *ui_name, const char *ui_description);
+PropertyRNA *RNA_def_boolean_vector(StructOrFunctionRNA *cont, const char *identifier, int len, int *default_value, const char *ui_name, const char *ui_description);
+
+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);
+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);
+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);
+
+PropertyRNA *RNA_def_string(StructOrFunctionRNA *cont, const char *identifier, const char *default_value, int maxlen, const char *ui_name, const char *ui_description);
+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);
+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);
+
+PropertyRNA *RNA_def_enum(StructOrFunctionRNA *cont, const char *identifier, const EnumPropertyItem *items, int default_value, const char *ui_name, const char *ui_description);
+void RNA_def_enum_funcs(PropertyRNA *prop, EnumPropertyItemFunc itemfunc);
+
+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);
+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);
+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);
+PropertyRNA *RNA_def_float_matrix(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);
+PropertyRNA *RNA_def_float_rotation(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);
+PropertyRNA *RNA_def_float_array(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);
+PropertyRNA *RNA_def_float_percentage(StructOrFunctionRNA *cont, const char *identifier, float default_value, float hardmin, float hardmax,
+       const char *ui_name, const char *ui_description, float softmin, float softmax);
+
+PropertyRNA *RNA_def_pointer(StructOrFunctionRNA *cont, const char *identifier, const char *type,
+       const char *ui_name, const char *ui_description);
+PropertyRNA *RNA_def_pointer_runtime(StructOrFunctionRNA *cont, const char *identifier, StructRNA *type,
+       const char *ui_name, const char *ui_description);
+
+PropertyRNA *RNA_def_collection(StructOrFunctionRNA *cont, const char *identifier, const char *type,
+       const char *ui_name, const char *ui_description);
+PropertyRNA *RNA_def_collection_runtime(StructOrFunctionRNA *cont, const char *identifier, StructRNA *type,
+       const char *ui_name, const char *ui_description);
+
+/* Extended Property Definitions */
+
+PropertyRNA *RNA_def_property(StructOrFunctionRNA *cont, const char *identifier, int type, int subtype);
+
+void RNA_def_property_boolean_sdna(PropertyRNA *prop, const char *structname, const char *propname, int bit);
+void RNA_def_property_boolean_negative_sdna(PropertyRNA *prop, const char *structname, const char *propname, int bit);
+void RNA_def_property_int_sdna(PropertyRNA *prop, const char *structname, const char *propname);
+void RNA_def_property_float_sdna(PropertyRNA *prop, const char *structname, const char *propname);
+void RNA_def_property_string_sdna(PropertyRNA *prop, const char *structname, const char *propname);
+void RNA_def_property_enum_sdna(PropertyRNA *prop, const char *structname, const char *propname);
+void RNA_def_property_enum_bitflag_sdna(PropertyRNA *prop, const char *structname, const char *propname);
+void RNA_def_property_pointer_sdna(PropertyRNA *prop, const char *structname, const char *propname);
+void RNA_def_property_collection_sdna(PropertyRNA *prop, const char *structname, const char *propname, const char *lengthpropname);
+
+void RNA_def_property_flag(PropertyRNA *prop, int flag);
+void RNA_def_property_clear_flag(PropertyRNA *prop, int flag);
+void RNA_def_property_array(PropertyRNA *prop, int arraylength);
+void RNA_def_property_range(PropertyRNA *prop, double min, double max);
+
+void RNA_def_property_enum_items(PropertyRNA *prop, const EnumPropertyItem *item);
+void RNA_def_property_string_maxlength(PropertyRNA *prop, int maxlength);
+void RNA_def_property_struct_type(PropertyRNA *prop, const char *type);
+void RNA_def_property_struct_runtime(PropertyRNA *prop, StructRNA *type);
+
+void RNA_def_property_boolean_default(PropertyRNA *prop, int value);
+void RNA_def_property_boolean_array_default(PropertyRNA *prop, const int *array);
+void RNA_def_property_int_default(PropertyRNA *prop, int value);
+void RNA_def_property_int_array_default(PropertyRNA *prop, const int *array);
+void RNA_def_property_float_default(PropertyRNA *prop, float value);
+void RNA_def_property_float_array_default(PropertyRNA *prop, const float *array);
+void RNA_def_property_enum_default(PropertyRNA *prop, int value);
+void RNA_def_property_string_default(PropertyRNA *prop, const char *value);
+
+void RNA_def_property_ui_text(PropertyRNA *prop, const char *name, const char *description);
+void RNA_def_property_ui_range(PropertyRNA *prop, double min, double max, double step, int precision);
+void RNA_def_property_ui_icon(PropertyRNA *prop, int icon, int consecutive);
+
+void RNA_def_property_update(PropertyRNA *prop, int noteflag, const char *updatefunc);
+void RNA_def_property_editable_func(PropertyRNA *prop, const char *editable);
+
+void RNA_def_property_boolean_funcs(PropertyRNA *prop, const char *get, const char *set);
+void RNA_def_property_int_funcs(PropertyRNA *prop, const char *get, const char *set, const char *range);
+void RNA_def_property_float_funcs(PropertyRNA *prop, const char *get, const char *set, const char *range);
+void RNA_def_property_enum_funcs(PropertyRNA *prop, const char *get, const char *set, const char *item);
+void RNA_def_property_string_funcs(PropertyRNA *prop, const char *get, const char *length, const char *set);
+void RNA_def_property_pointer_funcs(PropertyRNA *prop, const char *get, const char *set, const char *typef);
+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 *add, const char *remove);
+
+/* Function */
+
+FunctionRNA *RNA_def_function(StructRNA *srna, const char *identifier, const char *call);
+FunctionRNA *RNA_def_function_runtime(StructRNA *srna, const char *identifier, CallFunc call);
+void RNA_def_function_return(FunctionRNA *func, PropertyRNA *ret);
+void RNA_def_function_flag(FunctionRNA *func, int flag);
+void RNA_def_function_ui_description(FunctionRNA *func, const char *description);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* RNA_DEFINE_H */