/** * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software Foundation, * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * * Contributor(s): Blender Foundation (2008). * * ***** END GPL LICENSE BLOCK ***** */ #include #include #include "MEM_guardedalloc.h" #include "DNA_ID.h" #include "DNA_windowmanager_types.h" #include "BLI_blenlib.h" #include "BLI_dynstr.h" #include "BKE_idprop.h" #include "BKE_utildefines.h" #include "WM_api.h" #include "RNA_access.h" #include "RNA_define.h" #include "RNA_types.h" #include "rna_internal.h" /* Exit */ void RNA_exit() { RNA_free(&BLENDER_RNA); } /* Pointer */ void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr) { r_ptr->id.type= NULL; r_ptr->id.data= NULL; r_ptr->type= &RNA_Main; r_ptr->data= main; } void RNA_id_pointer_create(StructRNA *idtype, ID *id, PointerRNA *r_ptr) { r_ptr->id.type= idtype; r_ptr->id.data= id; r_ptr->type= idtype; r_ptr->data= id; } void RNA_pointer_create(StructRNA *idtype, ID *id, StructRNA *type, void *data, PointerRNA *r_ptr) { r_ptr->id.type= idtype; r_ptr->id.data= id; r_ptr->type= type; r_ptr->data= data; } static void rna_pointer_inherit_id(StructRNA *type, PointerRNA *parent, PointerRNA *ptr) { if(type && type->flag & STRUCT_ID) { ptr->id.data= ptr->data; ptr->id.type= type; } else { ptr->id.data= parent->id.data; ptr->id.type= parent->id.type; } } void RNA_blender_rna_pointer_create(PointerRNA *r_ptr) { r_ptr->id.type= NULL; r_ptr->id.data= NULL; r_ptr->type= &RNA_BlenderRNA; r_ptr->data= &BLENDER_RNA; } /* ID Properties */ IDProperty *rna_idproperties_get(PointerRNA *ptr, int create) { if(ptr->type->flag & STRUCT_ID) return IDP_GetProperties(ptr->data, create); else if(ptr->type == &RNA_IDPropertyGroup || ptr->type->from == &RNA_IDPropertyGroup) return ptr->data; else if(ptr->type->from == &RNA_OperatorProperties) { if(create && !ptr->data) { IDPropertyTemplate val; val.i = 0; /* silence MSVC warning about uninitialized var when debugging */ ptr->data= IDP_New(IDP_GROUP, val, "RNA_OperatorProperties group"); } return ptr->data; } else return NULL; } static IDProperty *rna_idproperty_find(PointerRNA *ptr, const char *name) { IDProperty *group= rna_idproperties_get(ptr, 0); IDProperty *idprop; if(group) { for(idprop=group->data.group.first; idprop; idprop=idprop->next) if(strcmp(idprop->name, name) == 0) return idprop; } return NULL; } static int rna_idproperty_verify_valid(PropertyRNA *prop, IDProperty *idprop) { /* this verifies if the idproperty actually matches the property * description and otherwise removes it. this is to ensure that * rna property access is type safe, e.g. if you defined the rna * to have a certain array length you can count on that staying so */ switch(idprop->type) { case IDP_IDPARRAY: if(prop->type != PROP_COLLECTION) return 0; break; case IDP_ARRAY: if(prop->arraylength != idprop->len) return 0; if(idprop->subtype == IDP_FLOAT && prop->type != PROP_FLOAT) return 0; if(idprop->subtype == IDP_INT && !ELEM3(prop->type, PROP_BOOLEAN, PROP_INT, PROP_ENUM)) return 0; break; case IDP_INT: if(!ELEM3(prop->type, PROP_BOOLEAN, PROP_INT, PROP_ENUM)) return 0; break; case IDP_FLOAT: case IDP_DOUBLE: if(prop->type != PROP_FLOAT) return 0; break; case IDP_STRING: if(prop->type != PROP_STRING) return 0; break; case IDP_GROUP: if(prop->type != PROP_POINTER) return 0; break; default: return 0; } return 1; } IDProperty *rna_idproperty_check(PropertyRNA **prop, PointerRNA *ptr) { /* This is quite a hack, but avoids some complexity in the API. we * pass IDProperty structs as PropertyRNA pointers to the outside. * We store some bytes in PropertyRNA structs that allows us to * distinguish it from IDProperty structs. If it is an ID property, * we look up an IDP PropertyRNA based on the type, and set the data * pointer to the IDProperty. */ if((*prop)->magic == RNA_MAGIC) { if((*prop)->flag & PROP_IDPROPERTY) { IDProperty *idprop= rna_idproperty_find(ptr, (*prop)->identifier); if(idprop && !rna_idproperty_verify_valid(*prop, idprop)) { IDProperty *group= rna_idproperties_get(ptr, 0); IDP_RemFromGroup(group, idprop); IDP_FreeProperty(idprop); MEM_freeN(idprop); return NULL; } return idprop; } else return NULL; } { static PropertyRNA *typemap[IDP_NUMTYPES] = {(PropertyRNA*)&rna_IDProperty_string, (PropertyRNA*)&rna_IDProperty_int, (PropertyRNA*)&rna_IDProperty_float, NULL, NULL, NULL, (PropertyRNA*)&rna_IDProperty_group, NULL, (PropertyRNA*)&rna_IDProperty_double}; static PropertyRNA *arraytypemap[IDP_NUMTYPES] = {NULL, (PropertyRNA*)&rna_IDProperty_intarray, (PropertyRNA*)&rna_IDProperty_floatarray, NULL, NULL, NULL, (PropertyRNA*)&rna_IDProperty_collection, NULL, (PropertyRNA*)&rna_IDProperty_doublearray}; IDProperty *idprop= (IDProperty*)(*prop); if(idprop->type == IDP_ARRAY) *prop= arraytypemap[(int)(idprop->subtype)]; else *prop= typemap[(int)(idprop->type)]; return idprop; } } /* Structs */ const char *RNA_struct_identifier(PointerRNA *ptr) { return ptr->type->identifier; } const char *RNA_struct_ui_name(PointerRNA *ptr) { return ptr->type->name; } const char *RNA_struct_ui_description(PointerRNA *ptr) { return ptr->type->description; } PropertyRNA *RNA_struct_name_property(PointerRNA *ptr) { return ptr->type->nameproperty; } PropertyRNA *RNA_struct_iterator_property(PointerRNA *ptr) { return ptr->type->iteratorproperty; } int RNA_struct_is_ID(PointerRNA *ptr) { return (ptr->type->flag & STRUCT_ID) != 0; } PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier) { CollectionPropertyIterator iter; PropertyRNA *iterprop, *prop; int i = 0; iterprop= RNA_struct_iterator_property(ptr); RNA_property_collection_begin(ptr, iterprop, &iter); prop= NULL; for(; iter.valid; RNA_property_collection_next(&iter), i++) { if(strcmp(identifier, RNA_property_identifier(&iter.ptr, iter.ptr.data)) == 0) { prop= iter.ptr.data; break; } } RNA_property_collection_end(&iter); return prop; } const struct ListBase *RNA_struct_defined_properties(StructRNA *srna) { return &srna->properties; } /* Property Information */ const char *RNA_property_identifier(PointerRNA *ptr, PropertyRNA *prop) { IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) return idprop->name; else return prop->identifier; } PropertyType RNA_property_type(PointerRNA *ptr, PropertyRNA *prop) { rna_idproperty_check(&prop, ptr); return prop->type; } PropertySubType RNA_property_subtype(PointerRNA *ptr, PropertyRNA *prop) { rna_idproperty_check(&prop, ptr); return prop->subtype; } int RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop) { IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr)) && idprop->type==IDP_ARRAY) return idprop->len; else return prop->arraylength; } void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax) { IntPropertyRNA *iprop; rna_idproperty_check(&prop, ptr); iprop= (IntPropertyRNA*)prop; if(iprop->range) { iprop->range(ptr, hardmin, hardmax); } else { *hardmin= iprop->hardmin; *hardmax= iprop->hardmax; } } void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step) { IntPropertyRNA *iprop; int hardmin, hardmax; rna_idproperty_check(&prop, ptr); iprop= (IntPropertyRNA*)prop; if(iprop->range) { iprop->range(ptr, &hardmin, &hardmax); *softmin= MAX2(iprop->softmin, hardmin); *softmax= MIN2(iprop->softmax, hardmax); } else { *softmin= iprop->softmin; *softmax= iprop->softmax; } *step= iprop->step; } void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax) { FloatPropertyRNA *fprop; rna_idproperty_check(&prop, ptr); fprop= (FloatPropertyRNA*)prop; if(fprop->range) { fprop->range(ptr, hardmin, hardmax); } else { *hardmin= fprop->hardmin; *hardmax= fprop->hardmax; } } void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision) { FloatPropertyRNA *fprop; float hardmin, hardmax; rna_idproperty_check(&prop, ptr); fprop= (FloatPropertyRNA*)prop; if(fprop->range) { fprop->range(ptr, &hardmin, &hardmax); *softmin= MAX2(fprop->softmin, hardmin); *softmax= MIN2(fprop->softmax, hardmax); } else { *softmin= fprop->softmin; *softmax= fprop->softmax; } *step= fprop->step; *precision= (float)fprop->precision; } int RNA_property_string_maxlength(PointerRNA *ptr, PropertyRNA *prop) { StringPropertyRNA *sprop; rna_idproperty_check(&prop, ptr); sprop= (StringPropertyRNA*)prop; return sprop->maxlength; } void RNA_property_enum_items(PointerRNA *ptr, PropertyRNA *prop, const EnumPropertyItem **item, int *totitem) { EnumPropertyRNA *eprop; rna_idproperty_check(&prop, ptr); eprop= (EnumPropertyRNA*)prop; *item= eprop->item; *totitem= eprop->totitem; } int RNA_property_enum_value(PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *value) { const EnumPropertyItem *item; int totitem, i; RNA_property_enum_items(ptr, prop, &item, &totitem); for (i=0; iname; else return prop->name; } const char *RNA_property_ui_description(PointerRNA *ptr, PropertyRNA *prop) { PropertyRNA *oldprop= prop; if(rna_idproperty_check(&prop, ptr) && oldprop!=prop) return ""; else return prop->description; } int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop) { int flag; rna_idproperty_check(&prop, ptr); if(prop->editable) flag= prop->editable(ptr); else flag= prop->flag; return !(flag & PROP_NOT_EDITABLE); } int RNA_property_evaluated(PointerRNA *ptr, PropertyRNA *prop) { int flag; rna_idproperty_check(&prop, ptr); if(prop->editable) flag= prop->editable(ptr); else flag= prop->flag; return (flag & PROP_EVALUATED); } void RNA_property_update(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop) { rna_idproperty_check(&prop, ptr); if(prop->update) prop->update(C, ptr); if(prop->noteflag) WM_event_add_notifier(C, prop->noteflag, ptr->id.data); } /* Property Data */ int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop) { BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) return IDP_Int(idprop); else if(bprop->get) return bprop->get(ptr); else return bprop->defaultvalue; } void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value) { BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) IDP_Int(idprop)= value; else if(bprop->set) bprop->set(ptr, value); else if(!(prop->flag & PROP_NOT_EDITABLE)) { IDPropertyTemplate val; IDProperty *group; val.i= value; group= rna_idproperties_get(ptr, 1); if(group) IDP_AddToGroup(group, IDP_New(IDP_INT, val, (char*)prop->identifier)); } } int RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int index) { BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) return ((int*)IDP_Array(idprop))[index]; else if(bprop->getarray) return bprop->getarray(ptr, index); else return bprop->defaultarray[index]; } void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, int value) { BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) ((int*)IDP_Array(idprop))[index]= value; else if(bprop->setarray) bprop->setarray(ptr, index, value); else if(!(prop->flag & PROP_NOT_EDITABLE)) { IDPropertyTemplate val; IDProperty *group; val.array.len= prop->arraylength; val.array.type= IDP_INT; group= rna_idproperties_get(ptr, 1); if(group) { idprop= IDP_New(IDP_ARRAY, val, (char*)prop->identifier); IDP_AddToGroup(group, idprop); memcpy(idprop->data.pointer, bprop->defaultarray, sizeof(int)*prop->arraylength); ((int*)idprop->data.pointer)[index]= value; } } } int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop) { IntPropertyRNA *iprop= (IntPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) return IDP_Int(idprop); else if(iprop->get) return iprop->get(ptr); else return iprop->defaultvalue; } void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value) { IntPropertyRNA *iprop= (IntPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) IDP_Int(idprop)= value; else if(iprop->set) iprop->set(ptr, value); else if(!(prop->flag & PROP_NOT_EDITABLE)) { IDPropertyTemplate val; IDProperty *group; val.i= value; group= rna_idproperties_get(ptr, 1); if(group) IDP_AddToGroup(group, IDP_New(IDP_INT, val, (char*)prop->identifier)); } } int RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int index) { IntPropertyRNA *iprop= (IntPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) return ((int*)IDP_Array(idprop))[index]; else if(iprop->getarray) return iprop->getarray(ptr, index); else return iprop->defaultarray[index]; } void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, int value) { IntPropertyRNA *iprop= (IntPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) ((int*)IDP_Array(idprop))[index]= value; else if(iprop->setarray) iprop->setarray(ptr, index, value); else if(!(prop->flag & PROP_NOT_EDITABLE)) { IDPropertyTemplate val; IDProperty *group; val.array.len= prop->arraylength; val.array.type= IDP_INT; group= rna_idproperties_get(ptr, 1); if(group) { idprop= IDP_New(IDP_ARRAY, val, (char*)prop->identifier); IDP_AddToGroup(group, idprop); memcpy(idprop->data.pointer, iprop->defaultarray, sizeof(int)*prop->arraylength); ((int*)idprop->data.pointer)[index]= value; } } } float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop) { FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) { if(idprop->type == IDP_FLOAT) return IDP_Float(idprop); else return (float)IDP_Double(idprop); } else if(fprop->get) return fprop->get(ptr); else return fprop->defaultvalue; } void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value) { FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) { if(idprop->type == IDP_FLOAT) IDP_Float(idprop)= value; else IDP_Double(idprop)= value; } else if(fprop->set) { fprop->set(ptr, value); } else if(!(prop->flag & PROP_NOT_EDITABLE)) { IDPropertyTemplate val; IDProperty *group; val.f= value; group= rna_idproperties_get(ptr, 1); if(group) IDP_AddToGroup(group, IDP_New(IDP_FLOAT, val, (char*)prop->identifier)); } } float RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, int index) { FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) { if(idprop->subtype == IDP_FLOAT) return ((float*)IDP_Array(idprop))[index]; else return (float)(((double*)IDP_Array(idprop))[index]); } else if(fprop->getarray) return fprop->getarray(ptr, index); else return fprop->defaultarray[index]; } void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, int index, float value) { FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) { if(idprop->subtype == IDP_FLOAT) ((float*)IDP_Array(idprop))[index]= value; else ((double*)IDP_Array(idprop))[index]= value; } else if(fprop->setarray) { fprop->setarray(ptr, index, value); } else if(!(prop->flag & PROP_NOT_EDITABLE)) { IDPropertyTemplate val; IDProperty *group; val.array.len= prop->arraylength; val.array.type= IDP_FLOAT; group= rna_idproperties_get(ptr, 1); if(group) { idprop= IDP_New(IDP_ARRAY, val, (char*)prop->identifier); IDP_AddToGroup(group, idprop); memcpy(idprop->data.pointer, fprop->defaultarray, sizeof(float)*prop->arraylength); ((float*)IDP_Array(idprop))[index]= value; } } } void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value) { StringPropertyRNA *sprop= (StringPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) strcpy(value, IDP_String(idprop)); else if(sprop->get) sprop->get(ptr, value); else strcpy(value, sprop->defaultvalue); } char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen) { char *buf; int length; length= RNA_property_string_length(ptr, prop); if(length+1 < fixedlen) buf= fixedbuf; else buf= MEM_callocN(sizeof(char)*(length+1), "RNA_string_get_alloc"); RNA_property_string_get(ptr, prop, buf); return buf; } int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop) { StringPropertyRNA *sprop= (StringPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) return strlen(IDP_String(idprop)); else if(sprop->length) return sprop->length(ptr); else return strlen(sprop->defaultvalue); } void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value) { StringPropertyRNA *sprop= (StringPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) IDP_AssignString(idprop, (char*)value); else if(sprop->set) sprop->set(ptr, value); else if(!(prop->flag & PROP_NOT_EDITABLE)) { IDPropertyTemplate val; IDProperty *group; val.str= (char*)value; group= rna_idproperties_get(ptr, 1); if(group) IDP_AddToGroup(group, IDP_New(IDP_STRING, val, (char*)prop->identifier)); } } int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop) { EnumPropertyRNA *eprop= (EnumPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) return IDP_Int(idprop); else if(eprop->get) return eprop->get(ptr); else return eprop->defaultvalue; } void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value) { EnumPropertyRNA *eprop= (EnumPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) IDP_Int(idprop)= value; else if(eprop->set) { eprop->set(ptr, value); } else if(!(prop->flag & PROP_NOT_EDITABLE)) { IDPropertyTemplate val; IDProperty *group; val.i= value; group= rna_idproperties_get(ptr, 1); if(group) IDP_AddToGroup(group, IDP_New(IDP_INT, val, (char*)prop->identifier)); } } static StructRNA *rna_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr) { PointerPropertyRNA *pprop= (PointerPropertyRNA*)prop; StructRNA *type; if(pprop->type) type= pprop->type(ptr); else type= pprop->structtype; if(type) { rna_pointer_inherit_id(type, ptr, r_ptr); if(type->refine) type= type->refine(r_ptr); } r_ptr->type= type; return type; } void RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr) { PointerPropertyRNA *pprop= (PointerPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) r_ptr->data= idprop; /* for groups, data is idprop itself */ else if(pprop->get) r_ptr->data= pprop->get(ptr); else r_ptr->data= NULL; if(!(r_ptr->data && rna_property_pointer_type(ptr, prop, r_ptr))) memset(r_ptr, 0, sizeof(*r_ptr)); } void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *ptr_value) { PointerPropertyRNA *pprop= (PointerPropertyRNA*)prop; if(pprop->set) pprop->set(ptr, ptr_value->data); } void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop) { IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) { /* already exists */ } else if(prop->flag & PROP_IDPROPERTY) { IDPropertyTemplate val; IDProperty *group; val.i= 0; group= rna_idproperties_get(ptr, 1); if(group) IDP_AddToGroup(group, IDP_New(IDP_GROUP, val, (char*)prop->identifier)); } else printf("RNA_property_pointer_add %s.%s: only supported for id properties.\n", ptr->type->identifier, prop->identifier); } static StructRNA *rna_property_collection_type(CollectionPropertyIterator *iter) { CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop; StructRNA *type; if(cprop->type) type= cprop->type(iter); else type= cprop->structtype; if(type) { rna_pointer_inherit_id(type, &iter->parent, &iter->ptr); if(type->refine) type= type->refine(&iter->ptr); } iter->ptr.type= type; return type; } static void rna_property_collection_get(CollectionPropertyIterator *iter) { CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop; iter->ptr.data= cprop->get(iter); if(!(iter->ptr.data && rna_property_collection_type(iter))) memset(&iter->ptr, 0, sizeof(iter->ptr)); } static void rna_property_collection_get_idp(CollectionPropertyIterator *iter) { CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop; iter->ptr.data= rna_iterator_array_get(iter); iter->ptr.type= cprop->structtype; rna_pointer_inherit_id(cprop->structtype, &iter->parent, &iter->ptr); } void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter) { IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr)) || (prop->flag & PROP_IDPROPERTY)) { iter->parent= *ptr; iter->prop= prop; if(idprop) rna_iterator_array_begin(iter, IDP_IDPArray(idprop), sizeof(IDProperty), idprop->len, NULL); else rna_iterator_array_begin(iter, NULL, sizeof(IDProperty), 0, NULL); if(iter->valid) rna_property_collection_get_idp(iter); else memset(&iter->ptr, 0, sizeof(iter->ptr)); iter->idprop= 1; } else { CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop; if(cprop->begin) { iter->parent= *ptr; iter->prop= prop; iter->idprop= 0; cprop->begin(iter, ptr); if(iter->valid) rna_property_collection_get(iter); else memset(&iter->ptr, 0, sizeof(iter->ptr)); } else memset(iter, 0, sizeof(*iter)); } } void RNA_property_collection_next(CollectionPropertyIterator *iter) { CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop; if(iter->idprop) { rna_iterator_array_next(iter); if(iter->valid) rna_property_collection_get_idp(iter); else memset(&iter->ptr, 0, sizeof(iter->ptr)); } else { cprop->next(iter); if(iter->valid) rna_property_collection_get(iter); else memset(&iter->ptr, 0, sizeof(iter->ptr)); } } void RNA_property_collection_end(CollectionPropertyIterator *iter) { CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop; if(iter->idprop) rna_iterator_array_end(iter); else if(cprop->end) cprop->end(iter); } int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop) { CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop; IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) { return idprop->len; } else if(cprop->length) { return cprop->length(ptr); } else { CollectionPropertyIterator iter; int length= 0; RNA_property_collection_begin(ptr, prop, &iter); for(; iter.valid; RNA_property_collection_next(&iter)) length++; RNA_property_collection_end(&iter); return length; } } void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr) { IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) { IDPropertyTemplate val; IDProperty *item; val.i= 0; item= IDP_New(IDP_GROUP, val, ""); IDP_AppendArray(idprop, item); IDP_FreeProperty(item); MEM_freeN(item); } else if(prop->flag & PROP_IDPROPERTY) { IDProperty *group, *item; IDPropertyTemplate val; val.i= 0; group= rna_idproperties_get(ptr, 1); if(group) { idprop= IDP_NewIDPArray(prop->identifier); IDP_AddToGroup(group, idprop); item= IDP_New(IDP_GROUP, val, ""); IDP_AppendArray(idprop, item); IDP_FreeProperty(item); MEM_freeN(item); } } else printf("RNA_property_collection_add %s.%s: only supported for id properties.\n", ptr->type->identifier, prop->identifier); if(r_ptr) { if(idprop) { CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop; r_ptr->data= IDP_GetIndexArray(idprop, idprop->len-1); r_ptr->type= cprop->structtype; rna_pointer_inherit_id(NULL, ptr, r_ptr); } else memset(r_ptr, 0, sizeof(*r_ptr)); } } void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop) { IDProperty *idprop; if((idprop=rna_idproperty_check(&prop, ptr))) IDP_ResizeIDPArray(idprop, 0); } int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr) { CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop; if(cprop->lookupint) { /* we have a callback defined, use it */ r_ptr->data= cprop->lookupint(ptr, key, &r_ptr->type); if(r_ptr->data) { if(!r_ptr->type) r_ptr->type= cprop->structtype; rna_pointer_inherit_id(r_ptr->type, ptr, r_ptr); return 1; } else { memset(r_ptr, 0, sizeof(*r_ptr)); return 0; } } else { /* no callback defined, just iterate and find the nth item */ CollectionPropertyIterator iter; int i; RNA_property_collection_begin(ptr, prop, &iter); for(i=0; iter.valid; RNA_property_collection_next(&iter), i++) { if(i == key) { *r_ptr= iter.ptr; break; } } RNA_property_collection_end(&iter); if(!iter.valid) memset(r_ptr, 0, sizeof(*r_ptr)); return iter.valid; } } int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr) { CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop; if(cprop->lookupstring) { /* we have a callback defined, use it */ r_ptr->data= cprop->lookupstring(ptr, key, &r_ptr->type); if(r_ptr->data) { if(!r_ptr->type) r_ptr->type= cprop->structtype; rna_pointer_inherit_id(r_ptr->type, ptr, r_ptr); return 1; } else { memset(r_ptr, 0, sizeof(*r_ptr)); return 0; } } else { /* no callback defined, compare with name properties if they exist */ CollectionPropertyIterator iter; PropertyRNA *nameprop; char name[256], *nameptr; int found= 0; RNA_property_collection_begin(ptr, prop, &iter); for(; iter.valid; RNA_property_collection_next(&iter)) { if(iter.ptr.data && iter.ptr.type->nameproperty) { nameprop= iter.ptr.type->nameproperty; nameptr= RNA_property_string_get_alloc(&iter.ptr, nameprop, name, sizeof(name)); if(strcmp(nameptr, key) == 0) { *r_ptr= iter.ptr; found= 1; } if ((char *)&name != nameptr) MEM_freeN(nameptr); if(found) break; } } RNA_property_collection_end(&iter); if(!iter.valid) memset(r_ptr, 0, sizeof(*r_ptr)); return iter.valid; } } /* Standard iterator functions */ void rna_iterator_listbase_begin(CollectionPropertyIterator *iter, ListBase *lb, IteratorSkipFunc skip) { ListBaseIterator *internal; internal= MEM_callocN(sizeof(ListBaseIterator), "ListBaseIterator"); internal->link= lb->first; internal->skip= skip; iter->internal= internal; iter->valid= (internal->link != NULL); if(skip && iter->valid && skip(iter, internal->link)) rna_iterator_listbase_next(iter); } void rna_iterator_listbase_next(CollectionPropertyIterator *iter) { ListBaseIterator *internal= iter->internal; if(internal->skip) { do { internal->link= internal->link->next; iter->valid= (internal->link != NULL); } while(iter->valid && internal->skip(iter, internal->link)); } else { internal->link= internal->link->next; iter->valid= (internal->link != NULL); } } void *rna_iterator_listbase_get(CollectionPropertyIterator *iter) { ListBaseIterator *internal= iter->internal; return internal->link; } void rna_iterator_listbase_end(CollectionPropertyIterator *iter) { MEM_freeN(iter->internal); } void rna_iterator_array_begin(CollectionPropertyIterator *iter, void *ptr, int itemsize, int length, IteratorSkipFunc skip) { ArrayIterator *internal; if(ptr == NULL) length= 0; internal= MEM_callocN(sizeof(ArrayIterator), "ArrayIterator"); internal->ptr= ptr; internal->endptr= ((char*)ptr)+length*itemsize; internal->itemsize= itemsize; internal->skip= skip; iter->internal= internal; iter->valid= (internal->ptr != internal->endptr); if(skip && iter->valid && skip(iter, internal->ptr)) rna_iterator_array_next(iter); } void rna_iterator_array_next(CollectionPropertyIterator *iter) { ArrayIterator *internal= iter->internal; if(internal->skip) { do { internal->ptr += internal->itemsize; iter->valid= (internal->ptr != internal->endptr); } while(iter->valid && internal->skip(iter, internal->ptr)); } else { internal->ptr += internal->itemsize; iter->valid= (internal->ptr != internal->endptr); } } void *rna_iterator_array_get(CollectionPropertyIterator *iter) { ArrayIterator *internal= iter->internal; return internal->ptr; } void *rna_iterator_array_dereference_get(CollectionPropertyIterator *iter) { ArrayIterator *internal= iter->internal; /* for ** arrays */ return *(void**)(internal->ptr); } void rna_iterator_array_end(CollectionPropertyIterator *iter) { MEM_freeN(iter->internal); } /* RNA Path - Experiment */ static char *rna_path_token(const char **path, char *fixedbuf, int fixedlen, int bracket) { const char *p; char *buf; int i, j, len, escape; len= 0; if(bracket) { /* get data between [], check escaping ] with \] */ if(**path == '[') (*path)++; else return NULL; p= *path; escape= 0; while(*p && (*p != ']' || escape)) { escape= (*p == '\\'); len++; p++; } if(*p != ']') return NULL; } else { /* get data until . or [ */ p= *path; while(*p && *p != '.' && *p != '[') { len++; p++; } } /* empty, return */ if(len == 0) return NULL; /* try to use fixed buffer if possible */ if(len+1 < fixedlen) buf= fixedbuf; else buf= MEM_callocN(sizeof(char)*(len+1), "rna_path_token"); /* copy string, taking into account escaped ] */ for(p=*path, i=0, j=0; i= 2 && *token == '"' && token[len-2] == '"') { /* strip away "" */ token[len-2]= 0; RNA_property_collection_lookup_string(&curptr, prop, token+1, &nextptr); } else { /* otherwise do int lookup */ intkey= atoi(token); RNA_property_collection_lookup_int(&curptr, prop, intkey, &nextptr); } if(token != fixedbuf) MEM_freeN(token); if(nextptr.data) curptr= nextptr; else return 0; } } *r_ptr= curptr; *r_prop= prop; return 1; } char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop, int intkey, const char *strkey) { DynStr *dynstr; const char *s; char appendstr[128], *result; dynstr= BLI_dynstr_new(); /* add .identifier */ if(path) { BLI_dynstr_append(dynstr, (char*)path); if(*path) BLI_dynstr_append(dynstr, "."); } BLI_dynstr_append(dynstr, (char*)RNA_property_identifier(ptr, prop)); if(RNA_property_type(ptr, prop) == PROP_COLLECTION) { /* add ["strkey"] or [intkey] */ BLI_dynstr_append(dynstr, "["); if(strkey) { BLI_dynstr_append(dynstr, "\""); for(s=strkey; *s; s++) { if(*s == '[') { appendstr[0]= '\\'; appendstr[1]= *s; appendstr[2]= 0; } else { appendstr[0]= *s; appendstr[1]= 0; } BLI_dynstr_append(dynstr, appendstr); } BLI_dynstr_append(dynstr, "\""); } else { sprintf(appendstr, "%d", intkey); BLI_dynstr_append(dynstr, appendstr); } BLI_dynstr_append(dynstr, "]"); } result= BLI_dynstr_get_cstring(dynstr); BLI_dynstr_free(dynstr); return result; } char *RNA_path_back(const char *path) { char fixedbuf[256]; const char *previous, *current; char *result, *token; int i; if(!path) return NULL; previous= NULL; current= path; /* parse token by token until the end, then we back up to the previous * position and strip of the next token to get the path one step back */ while(*current) { token= rna_path_token(¤t, fixedbuf, sizeof(fixedbuf), 0); if(!token) return NULL; if(token != fixedbuf) MEM_freeN(token); /* in case of collection we also need to strip off [] */ token= rna_path_token(¤t, fixedbuf, sizeof(fixedbuf), 1); if(token && token != fixedbuf) MEM_freeN(token); if(!*current) break; previous= current; } if(!previous) return NULL; /* copy and strip off last token */ i= previous - path; result= BLI_strdup(path); if(i > 0 && result[i-1] == '.') i--; result[i]= 0; return result; } /* Quick name based property access */ int RNA_boolean_get(PointerRNA *ptr, const char *name) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) { return RNA_property_boolean_get(ptr, prop); } else { printf("RNA_boolean_get: %s.%s not found.\n", ptr->type->identifier, name); return 0; } } void RNA_boolean_set(PointerRNA *ptr, const char *name, int value) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_boolean_set(ptr, prop, value); else printf("RNA_boolean_set: %s.%s not found.\n", ptr->type->identifier, name); } void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); int i, length; if(prop) { length= RNA_property_array_length(ptr, prop); for(i=0; itype->identifier, name); } void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); int i, length; if(prop) { length= RNA_property_array_length(ptr, prop); for(i=0; itype->identifier, name); } int RNA_int_get(PointerRNA *ptr, const char *name) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) { return RNA_property_int_get(ptr, prop); } else { printf("RNA_int_get: %s.%s not found.\n", ptr->type->identifier, name); return 0; } } void RNA_int_set(PointerRNA *ptr, const char *name, int value) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_int_set(ptr, prop, value); else printf("RNA_int_set: %s.%s not found.\n", ptr->type->identifier, name); } void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); int i, length; if(prop) { length= RNA_property_array_length(ptr, prop); for(i=0; itype->identifier, name); } void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); int i, length; if(prop) { length= RNA_property_array_length(ptr, prop); for(i=0; itype->identifier, name); } float RNA_float_get(PointerRNA *ptr, const char *name) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) { return RNA_property_float_get(ptr, prop); } else { printf("RNA_float_get: %s.%s not found.\n", ptr->type->identifier, name); return 0; } } void RNA_float_set(PointerRNA *ptr, const char *name, float value) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_float_set(ptr, prop, value); else printf("RNA_float_set: %s.%s not found.\n", ptr->type->identifier, name); } void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); int i, length; if(prop) { length= RNA_property_array_length(ptr, prop); for(i=0; itype->identifier, name); } void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); int i, length; if(prop) { length= RNA_property_array_length(ptr, prop); for(i=0; itype->identifier, name); } int RNA_enum_get(PointerRNA *ptr, const char *name) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) { return RNA_property_enum_get(ptr, prop); } else { printf("RNA_enum_get: %s.%s not found.\n", ptr->type->identifier, name); return 0; } } void RNA_enum_set(PointerRNA *ptr, const char *name, int value) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_enum_set(ptr, prop, value); else printf("RNA_enum_set: %s.%s not found.\n", ptr->type->identifier, name); } int RNA_enum_is_equal(PointerRNA *ptr, const char *name, const char *enumname) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); const EnumPropertyItem *item; int a, totitem; if(prop) { RNA_property_enum_items(ptr, prop, &item, &totitem); for(a=0; atype->identifier, name, enumname); return 0; } else { printf("RNA_enum_is_equal: %s.%s not found.\n", ptr->type->identifier, name); return 0; } } void RNA_string_get(PointerRNA *ptr, const char *name, char *value) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_string_get(ptr, prop, value); else printf("RNA_string_get: %s.%s not found.\n", ptr->type->identifier, name); } char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) { return RNA_property_string_get_alloc(ptr, prop, fixedbuf, fixedlen); } else { printf("RNA_string_get_alloc: %s.%s not found.\n", ptr->type->identifier, name); return 0; } } int RNA_string_length(PointerRNA *ptr, const char *name) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) { return RNA_property_string_length(ptr, prop); } else { printf("RNA_string_length: %s.%s not found.\n", ptr->type->identifier, name); return 0; } } void RNA_string_set(PointerRNA *ptr, const char *name, const char *value) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_string_set(ptr, prop, value); else printf("RNA_string_set: %s.%s not found.\n", ptr->type->identifier, name); } void RNA_pointer_get(PointerRNA *ptr, const char *name, PointerRNA *r_value) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_pointer_get(ptr, prop, r_value); else printf("RNA_pointer_get: %s.%s not found.\n", ptr->type->identifier, name); } void RNA_pointer_add(PointerRNA *ptr, const char *name) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_pointer_add(ptr, prop); else printf("RNA_pointer_set: %s.%s not found.\n", ptr->type->identifier, name); } void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_collection_begin(ptr, prop, iter); else printf("RNA_collection_begin: %s.%s not found.\n", ptr->type->identifier, name); } void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_collection_add(ptr, prop, r_value); else printf("RNA_collection_add: %s.%s not found.\n", ptr->type->identifier, name); } void RNA_collection_clear(PointerRNA *ptr, const char *name) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) RNA_property_collection_clear(ptr, prop); else printf("RNA_collection_clear: %s.%s not found.\n", ptr->type->identifier, name); } int RNA_collection_length(PointerRNA *ptr, const char *name) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) { return RNA_property_collection_length(ptr, prop); } else { printf("RNA_collection_length: %s.%s not found.\n", ptr->type->identifier, name); return 0; } } int RNA_property_is_set(PointerRNA *ptr, const char *name) { PropertyRNA *prop= RNA_struct_find_property(ptr, name); if(prop) { return (rna_idproperty_find(ptr, name) != NULL); } else { printf("RNA_property_is_set: %s.%s not found.\n", ptr->type->identifier, name); return 0; } } /* string representation of a property, python * compatible but can be used for display too*/ char *RNA_property_as_string(PointerRNA *ptr, PropertyRNA *prop) { int type = RNA_property_type(ptr, prop); int len = RNA_property_array_length(ptr, prop); int i; DynStr *dynstr= BLI_dynstr_new(); char *cstring; /* see if we can coorce into a python type - PropertyType */ switch (type) { case PROP_BOOLEAN: if (len==0) { BLI_dynstr_append(dynstr, RNA_property_boolean_get(ptr, prop) ? "True" : "False"); } else { BLI_dynstr_append(dynstr, "("); for(i=0; i'", identifier); } break; } case PROP_POINTER: { BLI_dynstr_append(dynstr, "''"); /* TODO */ break; } case PROP_COLLECTION: BLI_dynstr_append(dynstr, "''"); /* TODO */ break; default: BLI_dynstr_append(dynstr, "''"); /* TODO */ break; } cstring = BLI_dynstr_get_cstring(dynstr); BLI_dynstr_free(dynstr); return cstring; }