diff options
author | Brecht Van Lommel <brechtvanlommel@pandora.be> | 2009-03-15 02:17:55 +0300 |
---|---|---|
committer | Brecht Van Lommel <brechtvanlommel@pandora.be> | 2009-03-15 02:17:55 +0300 |
commit | cc59417cae9de2c08900d76b3d9cfb6683e530b2 (patch) | |
tree | 5debe30cc15a8908ca35430bc7daf754da3450ec /source/blender | |
parent | e7e655ce746039601d8ecc3896db744e81c4dea8 (diff) |
RNA:
- Added an autogenerated C++ API, basically a simple layer over the C
API, but with the advantage that it fits the object oriented RNA
model better. Read-only still like the C API.
- Had to rename "protected" property in Action Group because it is
a C++ keyword, called it "locked" since that seems more consistent
anyway?
- It's not used anywhere, so here's some example code I used to test it,
to get an idea of how it would be used:
http://pasteall.org/4582/cpp
- Also, ID names are now editable.
Diffstat (limited to 'source/blender')
-rw-r--r-- | source/blender/makesrna/RNA_access.h | 11 | ||||
-rw-r--r-- | source/blender/makesrna/RNA_define.h | 9 | ||||
-rw-r--r-- | source/blender/makesrna/RNA_types.h | 8 | ||||
-rw-r--r-- | source/blender/makesrna/intern/makesrna.c | 345 | ||||
-rw-r--r-- | source/blender/makesrna/intern/rna_ID.c | 3 | ||||
-rw-r--r-- | source/blender/makesrna/intern/rna_access.c | 12 | ||||
-rwxr-xr-x | source/blender/makesrna/intern/rna_action.c | 4 |
7 files changed, 384 insertions, 8 deletions
diff --git a/source/blender/makesrna/RNA_access.h b/source/blender/makesrna/RNA_access.h index dfa74ea2f24..1ad9319bc1b 100644 --- a/source/blender/makesrna/RNA_access.h +++ b/source/blender/makesrna/RNA_access.h @@ -27,6 +27,10 @@ #include "RNA_types.h" +#ifdef __cplusplus +extern "C" { +#endif + struct bContext; struct ID; struct Main; @@ -303,6 +307,7 @@ PropertyRNA *RNA_struct_name_property(PointerRNA *ptr); PropertyRNA *RNA_struct_iterator_property(PointerRNA *ptr); int RNA_struct_is_ID(PointerRNA *ptr); +int RNA_struct_is_a(PointerRNA *ptr, StructRNA *srna); PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier); const struct ListBase *RNA_struct_defined_properties(StructRNA *srna); @@ -476,7 +481,9 @@ int RNA_property_is_set(PointerRNA *ptr, const char *name); /* python compatible string representation of this property, (must be freed!) */ char *RNA_property_as_string(PointerRNA *ptr, PropertyRNA *prop); -#endif /* RNA_ACCESS */ - +#ifdef __cplusplus +} +#endif +#endif /* RNA_ACCESS */ diff --git a/source/blender/makesrna/RNA_define.h b/source/blender/makesrna/RNA_define.h index d80a4e4573e..406b8f894ba 100644 --- a/source/blender/makesrna/RNA_define.h +++ b/source/blender/makesrna/RNA_define.h @@ -33,6 +33,10 @@ #include "DNA_listBase.h" #include "RNA_types.h" +#ifdef __cplusplus +extern "C" { +#endif + /* Blender RNA */ BlenderRNA *RNA_create(void); @@ -146,6 +150,9 @@ void RNA_def_property_string_funcs(PropertyRNA *prop, const char *get, const cha void RNA_def_property_pointer_funcs(PropertyRNA *prop, const char *get, const char *set); 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); -#endif /* RNA_DEFINE_H */ +#ifdef __cplusplus +} +#endif +#endif /* RNA_DEFINE_H */ diff --git a/source/blender/makesrna/RNA_types.h b/source/blender/makesrna/RNA_types.h index 03c6fc1a335..fb29d34184d 100644 --- a/source/blender/makesrna/RNA_types.h +++ b/source/blender/makesrna/RNA_types.h @@ -25,6 +25,10 @@ #ifndef RNA_TYPES #define RNA_TYPES +#ifdef __cplusplus +extern "C" { +#endif + struct PropertyRNA; struct StructRNA; struct BlenderRNA; @@ -148,6 +152,10 @@ typedef struct StructRNA StructRNA; typedef struct BlenderRNA BlenderRNA; +#ifdef __cplusplus +} +#endif + #endif /* RNA_TYPES */ diff --git a/source/blender/makesrna/intern/makesrna.c b/source/blender/makesrna/intern/makesrna.c index bf1246c5b9d..c22522d51ba 100644 --- a/source/blender/makesrna/intern/makesrna.c +++ b/source/blender/makesrna/intern/makesrna.c @@ -861,6 +861,154 @@ static void rna_def_property_funcs_header(FILE *f, PropertyDefRNA *dp) fprintf(f, "\n"); } +static void rna_def_property_funcs_header_cpp(FILE *f, PropertyDefRNA *dp) +{ + PropertyRNA *prop; + StructRNA *srna; + + srna= dp->srna; + prop= dp->prop; + + if(prop->flag & (PROP_IDPROPERTY|PROP_BUILTIN)) + return; + + if(prop->name && prop->description && strcmp(prop->description, "") != 0) + fprintf(f, "\t/* %s: %s */\n", prop->name, prop->description); + else if(prop->name) + fprintf(f, "\t/* %s */\n", prop->name); + else + fprintf(f, "\t/* */\n"); + + switch(prop->type) { + case PROP_BOOLEAN: { + if(!prop->arraylength) + fprintf(f, "\tbool %s(void);", prop->identifier); + else + fprintf(f, "\tArray<int, %d> %s(void);", prop->arraylength, prop->identifier); + break; + } + case PROP_INT: { + if(!prop->arraylength) + fprintf(f, "\tint %s(void);", prop->identifier); + else + fprintf(f, "\tArray<int, %d> %s(void);", prop->arraylength, prop->identifier); + break; + } + case PROP_FLOAT: { + if(!prop->arraylength) + fprintf(f, "\tfloat %s(void);", prop->identifier); + else + fprintf(f, "\tArray<float, %d> %s(void);", prop->arraylength, prop->identifier); + break; + } + case PROP_ENUM: { + EnumPropertyRNA *eprop= (EnumPropertyRNA*)prop; + int i; + + if(eprop->item) { + fprintf(f, "\tenum %s_enum {\n", prop->identifier); + + for(i=0; i<eprop->totitem; i++) + fprintf(f, "\t\t%s_%s = %d,\n", prop->identifier, eprop->item[i].identifier, eprop->item[i].value); + + fprintf(f, "\t};\n"); + } + + fprintf(f, "\t%s_enum %s(void);", prop->identifier, prop->identifier); + break; + } + case PROP_STRING: { + fprintf(f, "\tstd::string %s(void);", prop->identifier); + break; + } + case PROP_POINTER: { + PointerPropertyRNA *pprop= (PointerPropertyRNA*)dp->prop; + + if(pprop->structtype) + fprintf(f, "\t%s %s(void);", (char*)pprop->structtype, prop->identifier); + else + fprintf(f, "\t%s %s(void);", "UnknownType", prop->identifier); + break; + } + case PROP_COLLECTION: { + CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)dp->prop; + + if(cprop->structtype) + fprintf(f, "\tCOLLECTION_PROPERTY(%s, %s, %s)", (char*)cprop->structtype, srna->identifier, prop->identifier); + else + fprintf(f, "\tCOLLECTION_PROPERTY(%s, %s, %s)", "UnknownType", srna->identifier, prop->identifier); + break; + } + } + + fprintf(f, "\n"); +} + +static void rna_def_property_funcs_impl_cpp(FILE *f, PropertyDefRNA *dp) +{ + PropertyRNA *prop; + StructRNA *srna; + + srna= dp->srna; + prop= dp->prop; + + if(prop->flag & (PROP_IDPROPERTY|PROP_BUILTIN)) + return; + + switch(prop->type) { + case PROP_BOOLEAN: { + if(!prop->arraylength) + fprintf(f, "\tBOOLEAN_PROPERTY(%s, %s)", srna->identifier, prop->identifier); + else + fprintf(f, "\tBOOLEAN_ARRAY_PROPERTY(%s, %d, %s)", srna->identifier, prop->arraylength, prop->identifier); + break; + } + case PROP_INT: { + if(!prop->arraylength) + fprintf(f, "\tINT_PROPERTY(%s, %s)", srna->identifier, prop->identifier); + else + fprintf(f, "\tINT_ARRAY_PROPERTY(%s, %d, %s)", srna->identifier, prop->arraylength, prop->identifier); + break; + } + case PROP_FLOAT: { + if(!prop->arraylength) + fprintf(f, "\tFLOAT_PROPERTY(%s, %s)", srna->identifier, prop->identifier); + else + fprintf(f, "\tFLOAT_ARRAY_PROPERTY(%s, %d, %s)", srna->identifier, prop->arraylength, prop->identifier); + break; + } + case PROP_ENUM: { + fprintf(f, "\tENUM_PROPERTY(%s_enum, %s, %s)", prop->identifier, srna->identifier, prop->identifier); + + break; + } + case PROP_STRING: { + fprintf(f, "\tSTRING_PROPERTY(%s, %s)", srna->identifier, prop->identifier); + break; + } + case PROP_POINTER: { + PointerPropertyRNA *pprop= (PointerPropertyRNA*)dp->prop; + + if(pprop->structtype) + fprintf(f, "\tPOINTER_PROPERTY(%s, %s, %s)", (char*)pprop->structtype, srna->identifier, prop->identifier); + else + fprintf(f, "\tPOINTER_PROPERTY(%s, %s, %s)", "UnknownType", srna->identifier, prop->identifier); + break; + } + case PROP_COLLECTION: { + /*CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)dp->prop; + + if(cprop->structtype) + fprintf(f, "\tCOLLECTION_PROPERTY(%s, %s, %s)", (char*)cprop->structtype, srna->identifier, prop->identifier); + else + fprintf(f, "\tCOLLECTION_PROPERTY(%s, %s, %s)", "UnknownType", srna->identifier, prop->identifier);*/ + break; + } + } + + fprintf(f, "\n"); +} + static const char *rna_find_type(const char *type) { StructDefRNA *ds; @@ -1255,6 +1403,7 @@ typedef struct RNAProcessItem { } RNAProcessItem; RNAProcessItem PROCESS_ITEMS[]= { + {"rna_rna.c", RNA_def_rna}, {"rna_ID.c", RNA_def_ID}, {"rna_texture.c", RNA_def_texture}, {"rna_action.c", RNA_def_action}, @@ -1287,7 +1436,6 @@ RNAProcessItem PROCESS_ITEMS[]= { {"rna_pose.c", RNA_def_pose}, {"rna_property.c", RNA_def_gameproperty}, {"rna_radio.c", RNA_def_radio}, - {"rna_rna.c", RNA_def_rna}, {"rna_scene.c", RNA_def_scene}, {"rna_screen.c", RNA_def_screen}, {"rna_scriptlink.c", RNA_def_scriptlink}, @@ -1367,6 +1515,8 @@ static void rna_generate_header(BlenderRNA *brna, FILE *f) fprintf(f, "#include \"RNA_types.h\"\n\n"); + fprintf(f, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n"); + fprintf(f, "#define FOREACH_BEGIN(property, sptr, itemptr) \\\n"); fprintf(f, " { \\\n"); fprintf(f, " CollectionPropertyIterator rna_macro_iter; \\\n"); @@ -1393,7 +1543,173 @@ static void rna_generate_header(BlenderRNA *brna, FILE *f) rna_def_property_funcs_header(f, dp); } - fprintf(f, "#endif /* __RNA_BLENDER_H__ */\n"); + fprintf(f, "#ifdef __cplusplus\n}\n#endif\n\n"); + + fprintf(f, "#endif /* __RNA_BLENDER_H__ */\n\n"); +} + +static const char *cpp_classes = "" +"\n" +"#include <string>\n" +"\n" +"namespace RNA {\n" +"\n" +"#define BOOLEAN_PROPERTY(sname, identifier) \\\n" +" bool sname::identifier(void) { return (bool)sname##_##identifier##_get(&ptr); }\n" +"\n" +"#define BOOLEAN_ARRAY_PROPERTY(sname, size, identifier) \\\n" +" Array<int,size> sname::identifier(void) \\\n" +" { Array<int, size> ar; sname##_##identifier##_get(&ptr, ar.data); return ar; }\n" +"\n" +"#define INT_PROPERTY(sname, identifier) \\\n" +" int sname::identifier(void) { return sname##_##identifier##_get(&ptr); }\n" +"\n" +"#define INT_ARRAY_PROPERTY(sname, size, identifier) \\\n" +" Array<int,size> sname::identifier(void) \\\n" +" { Array<int, size> ar; sname##_##identifier##_get(&ptr, ar.data); return ar; }\n" +"\n" +"#define FLOAT_PROPERTY(sname, identifier) \\\n" +" float sname::identifier(void) { return sname##_##identifier##_get(&ptr); }\n" +"\n" +"#define FLOAT_ARRAY_PROPERTY(sname, size, identifier) \\\n" +" Array<float,size> sname::identifier(void) \\\n" +" { Array<float, size> ar; sname##_##identifier##_get(&ptr, ar.data); return ar; }\n" +"\n" +"#define ENUM_PROPERTY(type, sname, identifier) \\\n" +" sname::type sname::identifier(void) { return (type)sname##_##identifier##_get(&ptr); }\n" +"\n" +"#define STRING_PROPERTY(sname, identifier) \\\n" +" std::string sname::identifier(void) { \\\n" +" int len= sname##_##identifier##_length(&ptr); \\\n" +" std::string str; str.resize(len); \\\n" +" sname##_##identifier##_get(&ptr, &str[0]); return str; } \\\n" +"\n" +"#define POINTER_PROPERTY(type, sname, identifier) \\\n" +" type sname::identifier(void) { return type(sname##_##identifier##_get(&ptr)); }\n" +"\n" +"#define COLLECTION_PROPERTY(type, sname, identifier) \\\n" +" typedef CollectionIterator<type, sname##_##identifier##_begin, \\\n" +" sname##_##identifier##_next, sname##_##identifier##_end> identifier##_iterator; \\\n" +" Collection<sname, type, sname##_##identifier##_begin, \\\n" +" sname##_##identifier##_next, sname##_##identifier##_end> identifier;\n" +"\n" +"class Pointer {\n" +"public:\n" +" Pointer(const PointerRNA& p) : ptr(p) { }\n" +" operator const PointerRNA&() { return ptr; }\n" +" bool is_a(StructRNA *type) { return RNA_struct_is_a(&ptr, type); }\n" +" operator void*() { return ptr.data; }\n" +" operator bool() { return ptr.data != NULL; }\n" +"\n" +" PointerRNA ptr;\n" +"};\n" +"\n" +"\n" +"template<typename T, int Tsize>\n" +"class Array {\n" +"public:\n" +" T data[Tsize];\n" +" operator T*() { return data; }\n" +"};\n" +"\n" +"typedef void (*TBeginFunc)(CollectionPropertyIterator *iter, PointerRNA *ptr);\n" +"typedef void (*TNextFunc)(CollectionPropertyIterator *iter);\n" +"typedef void (*TEndFunc)(CollectionPropertyIterator *iter);\n" +"\n" +"template<typename T, TBeginFunc Tbegin, TNextFunc Tnext, TEndFunc Tend>\n" +"class CollectionIterator {\n" +"public:\n" +" CollectionIterator() : t(iter.ptr), init(false) { iter.valid= false; }\n" +" ~CollectionIterator(void) { if(init) Tend(&iter); };\n" +" const CollectionIterator<T, Tbegin, Tnext, Tend>& operator=(const CollectionIterator<T, Tbegin, Tnext, Tend>& copy)\n" +" { if(init) Tend(&iter); iter= copy.iter; if(iter.internal) iter.internal= MEM_dupallocN(iter.internal); t= copy.t; init= copy.init; return *this; }\n" +"\n" +" operator bool(void)\n" +" { return iter.valid != 0; }\n" +" const CollectionIterator<T, Tbegin, Tnext, Tend>& operator++() { Tnext(&iter); t = T(iter.ptr); return *this; }\n" +" T& operator*(void) { return t; }\n" +" T* operator->(void) { return &t; }\n" +" bool operator==(const CollectionIterator<T, Tbegin, Tnext, Tend>& other) { return iter.valid == other.iter.valid; }\n" +" bool operator!=(const CollectionIterator<T, Tbegin, Tnext, Tend>& other) { return iter.valid != other.iter.valid; }\n" +"\n" +" void begin(const Pointer& ptr)\n" +" { if(init) Tend(&iter); Tbegin(&iter, (PointerRNA*)&ptr.ptr); t = T(iter.ptr); init = true; }\n" +"\n" +"private:\n" +" CollectionPropertyIterator iter;\n" +" T t;\n" +" bool init;\n" +"};\n" +"\n" +"template<typename Tp, typename T, TBeginFunc Tbegin, TNextFunc Tnext, TEndFunc Tend>\n" +"class Collection {\n" +"public:\n" +" Collection(const PointerRNA& p) : ptr(p) {}\n" +"\n" +" CollectionIterator<T, Tbegin, Tnext, Tend> begin()\n" +" { CollectionIterator<T, Tbegin, Tnext, Tend> iter; iter.begin(ptr); return iter; }\n" +" CollectionIterator<T, Tbegin, Tnext, Tend> end()\n" +" { return CollectionIterator<T, Tbegin, Tnext, Tend>(); } /* test */ \n" +"\n" +"private:\n" +" PointerRNA ptr;\n" +"};\n" +"\n"; + +static void rna_generate_header_cpp(BlenderRNA *brna, FILE *f) +{ + StructDefRNA *ds; + PropertyDefRNA *dp; + StructRNA *srna; + + fprintf(f, "\n#ifndef __RNA_BLENDER_CPP_H__\n"); + fprintf(f, "#define __RNA_BLENDER_CPP_H__\n\n"); + + fprintf(f, "/* Automatically generated classes for the Data API.\n" + " Do not edit manually, changes will be overwritten. */\n\n"); + + fprintf(f, "#include \"RNA_blender.h\"\n"); + fprintf(f, "#include \"RNA_types.h\"\n"); + + fprintf(f, cpp_classes); + + fprintf(f, "/**************** Declarations ****************/\n\n"); + + for(ds=DefRNA.structs.first; ds; ds=ds->next) + fprintf(f, "class %s;\n", ds->srna->identifier); + fprintf(f, "\n"); + + for(ds=DefRNA.structs.first; ds; ds=ds->next) { + srna= ds->srna; + + fprintf(f, "/**************** %s ****************/\n\n", srna->name); + + srna= ds->srna; + fprintf(f, "class %s : public %s {\n", srna->identifier, (srna->base)? srna->base->identifier: "Pointer"); + fprintf(f, "public:\n"); + fprintf(f, "\t%s(const PointerRNA& ptr) :\n\t\t%s(ptr)", srna->identifier, (srna->base)? srna->base->identifier: "Pointer"); + for(dp=ds->properties.first; dp; dp=dp->next) + if(!(dp->prop->flag & (PROP_IDPROPERTY|PROP_BUILTIN))) + if(dp->prop->type == PROP_COLLECTION) + fprintf(f, ",\n\t\t%s(ptr)", dp->prop->identifier); + fprintf(f, "\n\t\t{}\n\n"); + + for(dp=ds->properties.first; dp; dp=dp->next) + rna_def_property_funcs_header_cpp(f, dp); + fprintf(f, "};\n\n"); + } + + + fprintf(f, "/**************** Implementation ****************/\n"); + + for(ds=DefRNA.structs.first; ds; ds=ds->next) { + for(dp=ds->properties.first; dp; dp=dp->next) + rna_def_property_funcs_impl_cpp(f, dp); + + fprintf(f, "\n"); + } + + fprintf(f, "}\n\n#endif /* __RNA_BLENDER_CPP_H__ */\n\n"); } static void make_bad_file(char *file) @@ -1425,6 +1741,31 @@ static int rna_preprocess(char *outfile) } rna_auto_types(); + + + /* create RNA_blender_cpp.h */ + strcpy(deffile, outfile); + strcat(deffile, "RNA_blender_cpp.h"); + + if(status) { + make_bad_file(deffile); + } + else { + file = fopen(deffile, "w"); + + if(!file) { + printf ("Unable to open file: %s\n", deffile); + status = 1; + } + else { + rna_generate_header_cpp(brna, file); + fclose(file); + + status= (DefRNA.error != 0); + } + } + + rna_sort(brna); status= (DefRNA.error != 0); diff --git a/source/blender/makesrna/intern/rna_ID.c b/source/blender/makesrna/intern/rna_ID.c index 97c87c6a962..23d7a5f2e64 100644 --- a/source/blender/makesrna/intern/rna_ID.c +++ b/source/blender/makesrna/intern/rna_ID.c @@ -33,6 +33,7 @@ #ifdef RNA_RUNTIME #include "BKE_idprop.h" +#include "BKE_library.h" /* name functions that ignore the first two ID characters */ void rna_ID_name_get(PointerRNA *ptr, char *value) @@ -51,6 +52,7 @@ void rna_ID_name_set(PointerRNA *ptr, const char *value) { ID *id= (ID*)ptr->data; BLI_strncpy(id->name+2, value, sizeof(id->name)-2); + test_idbutton(id->name+2); } StructRNA *rna_ID_refine(PointerRNA *ptr) @@ -171,7 +173,6 @@ static void rna_def_ID(BlenderRNA *brna) RNA_def_struct_refine_func(srna, "rna_ID_refine"); prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE); - RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* must be unique */ RNA_def_property_ui_text(prop, "Name", "Unique datablock ID name."); RNA_def_property_string_funcs(prop, "rna_ID_name_get", "rna_ID_name_length", "rna_ID_name_set"); RNA_def_property_string_maxlength(prop, sizeof(((ID*)NULL)->name)-2); diff --git a/source/blender/makesrna/intern/rna_access.c b/source/blender/makesrna/intern/rna_access.c index 202bd6bc615..71ebad2127a 100644 --- a/source/blender/makesrna/intern/rna_access.c +++ b/source/blender/makesrna/intern/rna_access.c @@ -283,6 +283,18 @@ int RNA_struct_is_ID(PointerRNA *ptr) return (ptr->type->flag & STRUCT_ID) != 0; } +int RNA_struct_is_a(PointerRNA *ptr, StructRNA *srna) +{ + StructRNA *type; + + /* ptr->type is always maximally refined */ + for(type=ptr->type; type; type=type->base) + if(type == srna) + return 1; + + return 0; +} + PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier) { CollectionPropertyIterator iter; diff --git a/source/blender/makesrna/intern/rna_action.c b/source/blender/makesrna/intern/rna_action.c index ba5423f0408..22305383e48 100755 --- a/source/blender/makesrna/intern/rna_action.c +++ b/source/blender/makesrna/intern/rna_action.c @@ -236,9 +236,9 @@ void rna_def_action_group(BlenderRNA *brna) RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_SELECTED); RNA_def_property_ui_text(prop, "Selected", "Action Group is selected."); - prop= RNA_def_property(srna, "protected", PROP_BOOLEAN, PROP_NONE); + prop= RNA_def_property(srna, "locked", PROP_BOOLEAN, PROP_NONE); RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_PROTECTED); - RNA_def_property_ui_text(prop, "Protected", "Action Group is protected."); + RNA_def_property_ui_text(prop, "Locked", "Action Group is locked."); prop= RNA_def_property(srna, "expanded", PROP_BOOLEAN, PROP_NONE); RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_EXPANDED); |