4 * ***** BEGIN GPL LICENSE BLOCK *****
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 * Contributor(s): Blender Foundation (2008).
22 * ***** END GPL LICENSE BLOCK *****
28 #include "MEM_guardedalloc.h"
31 #include "DNA_windowmanager_types.h"
33 #include "BLI_blenlib.h"
34 #include "BLI_dynstr.h"
35 #include "BLI_ghash.h"
37 #include "BKE_context.h"
38 #include "BKE_idprop.h"
39 #include "BKE_report.h"
40 #include "BKE_utildefines.h"
44 #include "RNA_access.h"
45 #include "RNA_define.h"
46 #include "RNA_types.h"
48 #include "rna_internal.h"
57 for(srna=BLENDER_RNA.structs.first; srna; srna=srna->cont.next) {
58 if(!srna->cont.prophash) {
59 srna->cont.prophash= BLI_ghash_new(BLI_ghashutil_strhash, BLI_ghashutil_strcmp);
61 for(prop=srna->cont.properties.first; prop; prop=prop->next)
62 if(!(prop->flag & PROP_BUILTIN))
63 BLI_ghash_insert(srna->cont.prophash, (void*)prop->identifier, prop);
72 for(srna=BLENDER_RNA.structs.first; srna; srna=srna->cont.next) {
73 if(srna->cont.prophash) {
74 BLI_ghash_free(srna->cont.prophash, NULL, NULL);
75 srna->cont.prophash= NULL;
79 RNA_free(&BLENDER_RNA);
84 PointerRNA PointerRNA_NULL = {{0}, 0, 0};
86 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr)
89 r_ptr->type= &RNA_Main;
93 void RNA_id_pointer_create(ID *id, PointerRNA *r_ptr)
96 StructRNA *type, *idtype= NULL;
99 memset(&tmp, 0, sizeof(tmp));
101 idtype= rna_ID_refine(&tmp);
103 while(idtype->refine) {
104 type= idtype->refine(&tmp);
118 void RNA_pointer_create(ID *id, StructRNA *type, void *data, PointerRNA *r_ptr)
121 StructRNA *idtype= NULL;
124 memset(&tmp, 0, sizeof(tmp));
126 idtype= rna_ID_refine(&tmp);
134 while(r_ptr->type && r_ptr->type->refine) {
135 StructRNA *rtype= r_ptr->type->refine(r_ptr);
137 if(rtype == r_ptr->type)
145 static void rna_pointer_inherit_id(StructRNA *type, PointerRNA *parent, PointerRNA *ptr)
147 if(type && type->flag & STRUCT_ID) {
148 ptr->id.data= ptr->data;
151 ptr->id.data= parent->id.data;
155 void RNA_blender_rna_pointer_create(PointerRNA *r_ptr)
157 r_ptr->id.data= NULL;
158 r_ptr->type= &RNA_BlenderRNA;
159 r_ptr->data= &BLENDER_RNA;
162 PointerRNA rna_pointer_inherit_refine(PointerRNA *ptr, StructRNA *type, void *data)
169 rna_pointer_inherit_id(type, ptr, &result);
171 while(result.type->refine) {
172 type= result.type->refine(&result);
174 if(type == result.type)
181 memset(&result, 0, sizeof(result));
188 IDProperty *RNA_struct_idproperties(PointerRNA *ptr, int create)
190 StructRNA *type= ptr->type;
192 if(type && type->idproperties)
193 return type->idproperties(ptr, create);
198 static IDProperty *rna_idproperty_find(PointerRNA *ptr, const char *name)
200 IDProperty *group= RNA_struct_idproperties(ptr, 0);
204 for(idprop=group->data.group.first; idprop; idprop=idprop->next)
205 if(strcmp(idprop->name, name) == 0)
212 static int rna_idproperty_verify_valid(PropertyRNA *prop, IDProperty *idprop)
214 /* this verifies if the idproperty actually matches the property
215 * description and otherwise removes it. this is to ensure that
216 * rna property access is type safe, e.g. if you defined the rna
217 * to have a certain array length you can count on that staying so */
219 switch(idprop->type) {
221 if(prop->type != PROP_COLLECTION)
225 if(prop->arraylength != idprop->len)
228 if(idprop->subtype == IDP_FLOAT && prop->type != PROP_FLOAT)
230 if(idprop->subtype == IDP_INT && !ELEM3(prop->type, PROP_BOOLEAN, PROP_INT, PROP_ENUM))
235 if(!ELEM3(prop->type, PROP_BOOLEAN, PROP_INT, PROP_ENUM))
240 if(prop->type != PROP_FLOAT)
244 if(prop->type != PROP_STRING)
248 if(prop->type != PROP_POINTER)
258 static PropertyRNA *typemap[IDP_NUMTYPES] =
259 {(PropertyRNA*)&rna_IDProperty_string,
260 (PropertyRNA*)&rna_IDProperty_int,
261 (PropertyRNA*)&rna_IDProperty_float,
263 (PropertyRNA*)&rna_IDProperty_group, NULL,
264 (PropertyRNA*)&rna_IDProperty_double};
266 static PropertyRNA *arraytypemap[IDP_NUMTYPES] =
267 {NULL, (PropertyRNA*)&rna_IDProperty_int_array,
268 (PropertyRNA*)&rna_IDProperty_float_array,
270 (PropertyRNA*)&rna_IDProperty_collection, NULL,
271 (PropertyRNA*)&rna_IDProperty_double_array};
273 IDProperty *rna_idproperty_check(PropertyRNA **prop, PointerRNA *ptr)
275 /* This is quite a hack, but avoids some complexity in the API. we
276 * pass IDProperty structs as PropertyRNA pointers to the outside.
277 * We store some bytes in PropertyRNA structs that allows us to
278 * distinguish it from IDProperty structs. If it is an ID property,
279 * we look up an IDP PropertyRNA based on the type, and set the data
280 * pointer to the IDProperty. */
282 if((*prop)->magic == RNA_MAGIC) {
283 if((*prop)->flag & PROP_IDPROPERTY) {
284 IDProperty *idprop= rna_idproperty_find(ptr, (*prop)->identifier);
286 if(idprop && !rna_idproperty_verify_valid(*prop, idprop)) {
287 IDProperty *group= RNA_struct_idproperties(ptr, 0);
289 IDP_RemFromGroup(group, idprop);
290 IDP_FreeProperty(idprop);
302 IDProperty *idprop= (IDProperty*)(*prop);
304 if(idprop->type == IDP_ARRAY)
305 *prop= arraytypemap[(int)(idprop->subtype)];
307 *prop= typemap[(int)(idprop->type)];
313 PropertyRNA *rna_ensure_property(PropertyRNA *prop)
315 /* the quick version if we don't need the idproperty */
317 if(prop->magic == RNA_MAGIC)
321 IDProperty *idprop= (IDProperty*)prop;
323 if(idprop->type == IDP_ARRAY)
324 return arraytypemap[(int)(idprop->subtype)];
326 return typemap[(int)(idprop->type)];
330 const char *rna_ensure_property_identifier(PropertyRNA *prop)
332 if(prop->magic == RNA_MAGIC)
333 return prop->identifier;
335 return ((IDProperty*)prop)->name;
338 const char *rna_ensure_property_name(PropertyRNA *prop)
340 if(prop->magic == RNA_MAGIC)
343 return ((IDProperty*)prop)->name;
346 int rna_ensure_property_array_length(PropertyRNA *prop)
348 if(prop->magic == RNA_MAGIC)
349 return prop->arraylength;
351 IDProperty *idprop= (IDProperty*)prop;
353 if(idprop->type == IDP_ARRAY)
362 const char *RNA_struct_identifier(StructRNA *type)
364 return type->identifier;
367 const char *RNA_struct_ui_name(StructRNA *type)
372 int RNA_struct_ui_icon(StructRNA *type)
380 const char *RNA_struct_ui_description(StructRNA *type)
382 return type->description;
385 PropertyRNA *RNA_struct_name_property(StructRNA *type)
387 return type->nameproperty;
390 PropertyRNA *RNA_struct_iterator_property(StructRNA *type)
392 return type->iteratorproperty;
395 int RNA_struct_is_ID(StructRNA *type)
397 return (type->flag & STRUCT_ID) != 0;
400 int RNA_struct_is_a(StructRNA *type, StructRNA *srna)
407 /* ptr->type is always maximally refined */
408 for(base=type; base; base=base->base)
415 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier)
417 PropertyRNA *iterprop= RNA_struct_iterator_property(ptr->type);
420 if(RNA_property_collection_lookup_string(ptr, iterprop, identifier, &propptr))
426 /* Find the property which uses the given nested struct */
427 PropertyRNA *RNA_struct_find_nested(PointerRNA *ptr, StructRNA *srna)
429 CollectionPropertyIterator iter;
430 PropertyRNA *iterprop, *prop;
433 iterprop= RNA_struct_iterator_property(ptr->type);
434 RNA_property_collection_begin(ptr, iterprop, &iter);
437 for(; iter.valid; RNA_property_collection_next(&iter), i++) {
438 /* This assumes that there can only be one user of this nested struct */
439 if (RNA_property_pointer_type(ptr, iter.ptr.data) == srna) {
445 RNA_property_collection_end(&iter);
450 const struct ListBase *RNA_struct_defined_properties(StructRNA *srna)
452 return &srna->cont.properties;
455 FunctionRNA *RNA_struct_find_function(PointerRNA *ptr, const char *identifier)
458 CollectionPropertyIterator iter;
459 PropertyRNA *iterprop;
463 RNA_pointer_create(NULL, &RNA_Struct, ptr->type, &tptr);
464 iterprop= RNA_struct_find_property(&tptr, "functions");
466 RNA_property_collection_begin(&tptr, iterprop, &iter);
469 for(; iter.valid; RNA_property_collection_next(&iter), i++) {
470 if(strcmp(identifier, RNA_function_identifier(iter.ptr.data)) == 0) {
476 RNA_property_collection_end(&iter);
481 const struct ListBase *RNA_struct_defined_functions(StructRNA *srna)
483 return &srna->functions;
486 StructRegisterFunc RNA_struct_register(StructRNA *type)
491 StructUnregisterFunc RNA_struct_unregister(StructRNA *type)
496 } while((type=type->base));
501 void *RNA_struct_py_type_get(StructRNA *srna)
503 return srna->py_type;
506 void RNA_struct_py_type_set(StructRNA *srna, void *py_type)
508 srna->py_type= py_type;
511 void *RNA_struct_blender_type_get(StructRNA *srna)
513 return srna->blender_type;
516 void RNA_struct_blender_type_set(StructRNA *srna, void *blender_type)
518 srna->blender_type= blender_type;
521 /* Property Information */
523 const char *RNA_property_identifier(PropertyRNA *prop)
525 return rna_ensure_property_identifier(prop);
528 PropertyType RNA_property_type(PropertyRNA *prop)
530 return rna_ensure_property(prop)->type;
533 PropertySubType RNA_property_subtype(PropertyRNA *prop)
535 return rna_ensure_property(prop)->subtype;
538 int RNA_property_flag(PropertyRNA *prop)
540 return rna_ensure_property(prop)->flag;
543 int RNA_property_array_length(PropertyRNA *prop)
545 return rna_ensure_property_array_length(prop);
548 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax)
550 IntPropertyRNA *iprop= (IntPropertyRNA*)rna_ensure_property(prop);
553 iprop->range(ptr, hardmin, hardmax);
556 *hardmin= iprop->hardmin;
557 *hardmax= iprop->hardmax;
561 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step)
563 IntPropertyRNA *iprop= (IntPropertyRNA*)rna_ensure_property(prop);
564 int hardmin, hardmax;
567 iprop->range(ptr, &hardmin, &hardmax);
568 *softmin= MAX2(iprop->softmin, hardmin);
569 *softmax= MIN2(iprop->softmax, hardmax);
572 *softmin= iprop->softmin;
573 *softmax= iprop->softmax;
579 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax)
581 FloatPropertyRNA *fprop= (FloatPropertyRNA*)rna_ensure_property(prop);
584 fprop->range(ptr, hardmin, hardmax);
587 *hardmin= fprop->hardmin;
588 *hardmax= fprop->hardmax;
592 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision)
594 FloatPropertyRNA *fprop= (FloatPropertyRNA*)rna_ensure_property(prop);
595 float hardmin, hardmax;
598 fprop->range(ptr, &hardmin, &hardmax);
599 *softmin= MAX2(fprop->softmin, hardmin);
600 *softmax= MIN2(fprop->softmax, hardmax);
603 *softmin= fprop->softmin;
604 *softmax= fprop->softmax;
608 *precision= (float)fprop->precision;
611 int RNA_property_string_maxlength(PropertyRNA *prop)
613 StringPropertyRNA *sprop= (StringPropertyRNA*)rna_ensure_property(prop);
614 return sprop->maxlength;
617 StructRNA *RNA_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop)
619 prop= rna_ensure_property(prop);
621 if(prop->type == PROP_POINTER) {
622 PointerPropertyRNA *pprop= (PointerPropertyRNA*)prop;
625 return pprop->typef(ptr);
629 else if(prop->type == PROP_COLLECTION) {
630 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
636 return &RNA_UnknownType;
639 void RNA_property_enum_items(PointerRNA *ptr, PropertyRNA *prop, const EnumPropertyItem **item, int *totitem)
641 EnumPropertyRNA *eprop= (EnumPropertyRNA*)rna_ensure_property(prop);
645 *item= eprop->itemf(ptr);
647 for(tot=0; (*item)[tot].identifier; tot++);
654 *totitem= eprop->totitem;
658 int RNA_property_enum_value(PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *value)
660 const EnumPropertyItem *item;
663 RNA_property_enum_items(ptr, prop, &item, NULL);
665 for(; item->identifier; item++) {
666 if(strcmp(item->identifier, identifier)==0) {
667 *value = item->value;
675 int RNA_enum_identifier(const EnumPropertyItem *item, const int value, const char **identifier)
677 for (; item->identifier; item++) {
678 if(item->value==value) {
679 *identifier = item->identifier;
686 int RNA_enum_name(const EnumPropertyItem *item, const int value, const char **name)
688 for (; item->identifier; item++) {
689 if(item->value==value) {
697 int RNA_property_enum_identifier(PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier)
699 const EnumPropertyItem *item= NULL;
701 RNA_property_enum_items(ptr, prop, &item, NULL);
702 return RNA_enum_identifier(item, value, identifier);
705 const char *RNA_property_ui_name(PropertyRNA *prop)
707 return rna_ensure_property_name(prop);
710 const char *RNA_property_ui_description(PropertyRNA *prop)
712 return rna_ensure_property(prop)->description;
715 int RNA_property_ui_icon(PropertyRNA *prop)
717 return rna_ensure_property(prop)->icon;
720 int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop)
725 prop= rna_ensure_property(prop);
728 flag= prop->editable(ptr);
734 return (flag & PROP_EDITABLE) && (!id || !id->lib);
737 int RNA_property_animateable(PointerRNA *ptr, PropertyRNA *prop)
741 prop= rna_ensure_property(prop);
743 if(!(prop->flag & PROP_ANIMATEABLE))
747 flag= prop->editable(ptr);
751 return (flag & PROP_EDITABLE);
754 int RNA_property_animated(PointerRNA *ptr, PropertyRNA *prop)
756 /* would need to ask animation system */
761 void RNA_property_update(bContext *C, PointerRNA *ptr, PropertyRNA *prop)
763 prop= rna_ensure_property(prop);
766 prop->update(C, ptr);
768 WM_event_add_notifier(C, prop->noteflag, ptr->id.data);
773 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop)
775 BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop;
778 if((idprop=rna_idproperty_check(&prop, ptr)))
779 return IDP_Int(idprop);
781 return bprop->get(ptr);
783 return bprop->defaultvalue;
786 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value)
788 BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop;
791 if((idprop=rna_idproperty_check(&prop, ptr)))
792 IDP_Int(idprop)= value;
794 bprop->set(ptr, value);
795 else if(prop->flag & PROP_EDITABLE) {
796 IDPropertyTemplate val = {0};
801 group= RNA_struct_idproperties(ptr, 1);
803 IDP_AddToGroup(group, IDP_New(IDP_INT, val, (char*)prop->identifier));
807 void RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values)
809 BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop;
812 if((idprop=rna_idproperty_check(&prop, ptr))) {
813 if(prop->arraylength == 0)
814 values[0]= RNA_property_boolean_get(ptr, prop);
816 memcpy(values, IDP_Array(idprop), sizeof(int)*idprop->len);
818 else if(prop->arraylength == 0)
819 values[0]= RNA_property_boolean_get(ptr, prop);
820 else if(bprop->getarray)
821 bprop->getarray(ptr, values);
822 else if(bprop->defaultarray)
823 memcpy(values, bprop->defaultarray, sizeof(int)*prop->arraylength);
825 memset(values, 0, sizeof(int)*prop->arraylength);
828 int RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index)
830 int tmp[RNA_MAX_ARRAY];
832 RNA_property_boolean_get_array(ptr, prop, tmp);
836 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values)
838 BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop;
841 if((idprop=rna_idproperty_check(&prop, ptr))) {
842 if(prop->arraylength == 0)
843 IDP_Int(idprop)= values[0];
845 memcpy(IDP_Array(idprop), values, sizeof(int)*idprop->len);
847 else if(prop->arraylength == 0)
848 RNA_property_boolean_set(ptr, prop, values[0]);
849 else if(bprop->setarray)
850 bprop->setarray(ptr, values);
851 else if(prop->flag & PROP_EDITABLE) {
852 IDPropertyTemplate val = {0};
855 val.array.len= prop->arraylength;
856 val.array.type= IDP_INT;
858 group= RNA_struct_idproperties(ptr, 1);
860 idprop= IDP_New(IDP_ARRAY, val, (char*)prop->identifier);
861 IDP_AddToGroup(group, idprop);
862 memcpy(IDP_Array(idprop), values, sizeof(int)*idprop->len);
867 void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value)
869 int tmp[RNA_MAX_ARRAY];
871 RNA_property_boolean_get_array(ptr, prop, tmp);
873 RNA_property_boolean_set_array(ptr, prop, tmp);
876 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop)
878 IntPropertyRNA *iprop= (IntPropertyRNA*)prop;
881 if((idprop=rna_idproperty_check(&prop, ptr)))
882 return IDP_Int(idprop);
884 return iprop->get(ptr);
886 return iprop->defaultvalue;
889 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value)
891 IntPropertyRNA *iprop= (IntPropertyRNA*)prop;
894 if((idprop=rna_idproperty_check(&prop, ptr)))
895 IDP_Int(idprop)= value;
897 iprop->set(ptr, value);
898 else if(prop->flag & PROP_EDITABLE) {
899 IDPropertyTemplate val = {0};
904 group= RNA_struct_idproperties(ptr, 1);
906 IDP_AddToGroup(group, IDP_New(IDP_INT, val, (char*)prop->identifier));
910 void RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values)
912 IntPropertyRNA *iprop= (IntPropertyRNA*)prop;
915 if((idprop=rna_idproperty_check(&prop, ptr))) {
916 if(prop->arraylength == 0)
917 values[0]= RNA_property_int_get(ptr, prop);
919 memcpy(values, IDP_Array(idprop), sizeof(int)*idprop->len);
921 else if(prop->arraylength == 0)
922 values[0]= RNA_property_int_get(ptr, prop);
923 else if(iprop->getarray)
924 iprop->getarray(ptr, values);
925 else if(iprop->defaultarray)
926 memcpy(values, iprop->defaultarray, sizeof(int)*prop->arraylength);
928 memset(values, 0, sizeof(int)*prop->arraylength);
931 int RNA_property_int_get_index(PointerRNA *ptr, PropertyRNA *prop, int index)
933 int tmp[RNA_MAX_ARRAY];
935 RNA_property_int_get_array(ptr, prop, tmp);
939 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values)
941 IntPropertyRNA *iprop= (IntPropertyRNA*)prop;
944 if((idprop=rna_idproperty_check(&prop, ptr))) {
945 if(prop->arraylength == 0)
946 IDP_Int(idprop)= values[0];
948 memcpy(IDP_Array(idprop), values, sizeof(int)*idprop->len);\
950 else if(prop->arraylength == 0)
951 RNA_property_int_set(ptr, prop, values[0]);
952 else if(iprop->setarray)
953 iprop->setarray(ptr, values);
954 else if(prop->flag & PROP_EDITABLE) {
955 IDPropertyTemplate val = {0};
958 val.array.len= prop->arraylength;
959 val.array.type= IDP_INT;
961 group= RNA_struct_idproperties(ptr, 1);
963 idprop= IDP_New(IDP_ARRAY, val, (char*)prop->identifier);
964 IDP_AddToGroup(group, idprop);
965 memcpy(IDP_Array(idprop), values, sizeof(int)*idprop->len);
970 void RNA_property_int_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value)
972 int tmp[RNA_MAX_ARRAY];
974 RNA_property_int_get_array(ptr, prop, tmp);
976 RNA_property_int_set_array(ptr, prop, tmp);
979 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop)
981 FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop;
984 if((idprop=rna_idproperty_check(&prop, ptr))) {
985 if(idprop->type == IDP_FLOAT)
986 return IDP_Float(idprop);
988 return (float)IDP_Double(idprop);
991 return fprop->get(ptr);
993 return fprop->defaultvalue;
996 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value)
998 FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop;
1001 if((idprop=rna_idproperty_check(&prop, ptr))) {
1002 if(idprop->type == IDP_FLOAT)
1003 IDP_Float(idprop)= value;
1005 IDP_Double(idprop)= value;
1007 else if(fprop->set) {
1008 fprop->set(ptr, value);
1010 else if(prop->flag & PROP_EDITABLE) {
1011 IDPropertyTemplate val = {0};
1016 group= RNA_struct_idproperties(ptr, 1);
1018 IDP_AddToGroup(group, IDP_New(IDP_FLOAT, val, (char*)prop->identifier));
1022 void RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, float *values)
1024 FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop;
1028 if((idprop=rna_idproperty_check(&prop, ptr))) {
1029 if(prop->arraylength == 0)
1030 values[0]= RNA_property_float_get(ptr, prop);
1031 else if(idprop->subtype == IDP_FLOAT) {
1032 memcpy(values, IDP_Array(idprop), sizeof(float)*idprop->len);
1035 for(i=0; i<idprop->len; i++)
1036 values[i]= (float)(((double*)IDP_Array(idprop))[i]);
1039 else if(prop->arraylength == 0)
1040 values[0]= RNA_property_float_get(ptr, prop);
1041 else if(fprop->getarray)
1042 fprop->getarray(ptr, values);
1043 else if(fprop->defaultarray)
1044 memcpy(values, fprop->defaultarray, sizeof(float)*prop->arraylength);
1046 memset(values, 0, sizeof(float)*prop->arraylength);
1049 float RNA_property_float_get_index(PointerRNA *ptr, PropertyRNA *prop, int index)
1051 float tmp[RNA_MAX_ARRAY];
1053 RNA_property_float_get_array(ptr, prop, tmp);
1057 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, const float *values)
1059 FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop;
1063 if((idprop=rna_idproperty_check(&prop, ptr))) {
1064 if(prop->arraylength == 0)
1065 IDP_Double(idprop)= values[0];
1066 else if(idprop->subtype == IDP_FLOAT) {
1067 memcpy(IDP_Array(idprop), values, sizeof(float)*idprop->len);
1070 for(i=0; i<idprop->len; i++)
1071 ((double*)IDP_Array(idprop))[i]= values[i];
1074 else if(prop->arraylength == 0)
1075 RNA_property_float_set(ptr, prop, values[0]);
1076 else if(fprop->setarray) {
1077 fprop->setarray(ptr, values);
1079 else if(prop->flag & PROP_EDITABLE) {
1080 IDPropertyTemplate val = {0};
1083 val.array.len= prop->arraylength;
1084 val.array.type= IDP_FLOAT;
1086 group= RNA_struct_idproperties(ptr, 1);
1088 idprop= IDP_New(IDP_ARRAY, val, (char*)prop->identifier);
1089 IDP_AddToGroup(group, idprop);
1090 memcpy(IDP_Array(idprop), values, sizeof(float)*idprop->len);
1095 void RNA_property_float_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, float value)
1097 float tmp[RNA_MAX_ARRAY];
1099 RNA_property_float_get_array(ptr, prop, tmp);
1101 RNA_property_float_set_array(ptr, prop, tmp);
1104 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value)
1106 StringPropertyRNA *sprop= (StringPropertyRNA*)prop;
1109 if((idprop=rna_idproperty_check(&prop, ptr)))
1110 strcpy(value, IDP_String(idprop));
1112 sprop->get(ptr, value);
1114 strcpy(value, sprop->defaultvalue);
1117 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen)
1122 length= RNA_property_string_length(ptr, prop);
1124 if(length+1 < fixedlen)
1127 buf= MEM_callocN(sizeof(char)*(length+1), "RNA_string_get_alloc");
1129 RNA_property_string_get(ptr, prop, buf);
1134 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop)
1136 StringPropertyRNA *sprop= (StringPropertyRNA*)prop;
1139 if((idprop=rna_idproperty_check(&prop, ptr)))
1140 return strlen(IDP_String(idprop));
1141 else if(sprop->length)
1142 return sprop->length(ptr);
1144 return strlen(sprop->defaultvalue);
1147 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value)
1149 StringPropertyRNA *sprop= (StringPropertyRNA*)prop;
1152 if((idprop=rna_idproperty_check(&prop, ptr)))
1153 IDP_AssignString(idprop, (char*)value);
1155 sprop->set(ptr, value);
1156 else if(prop->flag & PROP_EDITABLE) {
1157 IDPropertyTemplate val = {0};
1160 val.str= (char*)value;
1162 group= RNA_struct_idproperties(ptr, 1);
1164 IDP_AddToGroup(group, IDP_New(IDP_STRING, val, (char*)prop->identifier));
1168 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop)
1170 EnumPropertyRNA *eprop= (EnumPropertyRNA*)prop;
1173 if((idprop=rna_idproperty_check(&prop, ptr)))
1174 return IDP_Int(idprop);
1176 return eprop->get(ptr);
1178 return eprop->defaultvalue;
1182 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value)
1184 EnumPropertyRNA *eprop= (EnumPropertyRNA*)prop;
1187 if((idprop=rna_idproperty_check(&prop, ptr)))
1188 IDP_Int(idprop)= value;
1189 else if(eprop->set) {
1190 eprop->set(ptr, value);
1192 else if(prop->flag & PROP_EDITABLE) {
1193 IDPropertyTemplate val = {0};
1198 group= RNA_struct_idproperties(ptr, 1);
1200 IDP_AddToGroup(group, IDP_New(IDP_INT, val, (char*)prop->identifier));
1204 PointerRNA RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop)
1206 PointerPropertyRNA *pprop= (PointerPropertyRNA*)prop;
1209 if((idprop=rna_idproperty_check(&prop, ptr))) {
1210 pprop= (PointerPropertyRNA*)prop;
1212 /* for groups, data is idprop itself */
1213 return rna_pointer_inherit_refine(ptr, pprop->type, idprop);
1215 else if(pprop->get) {
1216 return pprop->get(ptr);
1220 memset(&result, 0, sizeof(result));
1225 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA ptr_value)
1227 PointerPropertyRNA *pprop= (PointerPropertyRNA*)prop;
1230 pprop->set(ptr, ptr_value);
1233 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop)
1237 if((idprop=rna_idproperty_check(&prop, ptr))) {
1238 /* already exists */
1240 else if(prop->flag & PROP_IDPROPERTY) {
1241 IDPropertyTemplate val = {0};
1246 group= RNA_struct_idproperties(ptr, 1);
1248 IDP_AddToGroup(group, IDP_New(IDP_GROUP, val, (char*)prop->identifier));
1251 printf("RNA_property_pointer_add %s.%s: only supported for id properties.\n", ptr->type->identifier, prop->identifier);
1254 void RNA_property_pointer_remove(PointerRNA *ptr, PropertyRNA *prop)
1256 IDProperty *idprop, *group;
1258 if((idprop=rna_idproperty_check(&prop, ptr))) {
1259 group= RNA_struct_idproperties(ptr, 0);
1262 IDP_RemFromGroup(group, idprop);
1263 IDP_FreeProperty(idprop);
1268 printf("RNA_property_pointer_remove %s.%s: only supported for id properties.\n", ptr->type->identifier, prop->identifier);
1271 static void rna_property_collection_get_idp(CollectionPropertyIterator *iter)
1273 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop;
1275 iter->ptr.data= rna_iterator_array_get(iter);
1276 iter->ptr.type= cprop->type;
1277 rna_pointer_inherit_id(cprop->type, &iter->parent, &iter->ptr);
1280 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter)
1284 memset(iter, 0, sizeof(*iter));
1286 if((idprop=rna_idproperty_check(&prop, ptr)) || (prop->flag & PROP_IDPROPERTY)) {
1291 rna_iterator_array_begin(iter, IDP_IDPArray(idprop), sizeof(IDProperty), idprop->len, NULL);
1293 rna_iterator_array_begin(iter, NULL, sizeof(IDProperty), 0, NULL);
1296 rna_property_collection_get_idp(iter);
1301 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1302 cprop->begin(iter, ptr);
1306 void RNA_property_collection_next(CollectionPropertyIterator *iter)
1308 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop;
1311 rna_iterator_array_next(iter);
1314 rna_property_collection_get_idp(iter);
1320 void RNA_property_collection_end(CollectionPropertyIterator *iter)
1322 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop;
1325 rna_iterator_array_end(iter);
1330 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop)
1332 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1335 if((idprop=rna_idproperty_check(&prop, ptr))) {
1338 else if(cprop->length) {
1339 return cprop->length(ptr);
1342 CollectionPropertyIterator iter;
1345 RNA_property_collection_begin(ptr, prop, &iter);
1346 for(; iter.valid; RNA_property_collection_next(&iter))
1348 RNA_property_collection_end(&iter);
1354 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr)
1357 //CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1359 if((idprop=rna_idproperty_check(&prop, ptr))) {
1360 IDPropertyTemplate val = {0};
1363 item= IDP_New(IDP_GROUP, val, "");
1364 IDP_AppendArray(idprop, item);
1365 IDP_FreeProperty(item);
1368 else if(prop->flag & PROP_IDPROPERTY) {
1369 IDProperty *group, *item;
1370 IDPropertyTemplate val = {0};
1372 group= RNA_struct_idproperties(ptr, 1);
1374 idprop= IDP_NewIDPArray(prop->identifier);
1375 IDP_AddToGroup(group, idprop);
1377 item= IDP_New(IDP_GROUP, val, "");
1378 IDP_AppendArray(idprop, item);
1379 IDP_FreeProperty(item);
1384 else if(cprop->add){
1385 if(!(cprop->add->flag & FUNC_USE_CONTEXT)) { /* XXX check for this somewhere else */
1386 ParameterList *params= RNA_parameter_list_create(ptr, cprop->add);
1387 RNA_function_call(NULL, NULL, ptr, cprop->add, params);
1388 RNA_parameter_list_free(params);
1393 printf("RNA_property_collection_add %s.%s: not implemented for this property.\n", ptr->type->identifier, prop->identifier);
1397 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1399 r_ptr->data= IDP_GetIndexArray(idprop, idprop->len-1);
1400 r_ptr->type= cprop->type;
1401 rna_pointer_inherit_id(NULL, ptr, r_ptr);
1404 memset(r_ptr, 0, sizeof(*r_ptr));
1408 void RNA_property_collection_remove(PointerRNA *ptr, PropertyRNA *prop, int key)
1411 //CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1413 if((idprop=rna_idproperty_check(&prop, ptr))) {
1414 IDProperty tmp, *array;
1418 array= IDP_IDPArray(idprop);
1420 if(key >= 0 && key < len) {
1422 /* move element to be removed to the back */
1423 memcpy(&tmp, &array[key], sizeof(IDProperty));
1424 memmove(array+key, array+key+1, sizeof(IDProperty)*(len-key+1));
1425 memcpy(&array[len-1], &tmp, sizeof(IDProperty));
1428 IDP_ResizeIDPArray(idprop, len-1);
1431 else if(prop->flag & PROP_IDPROPERTY);
1433 else if(cprop->remove){
1434 if(!(cprop->remove->flag & FUNC_USE_CONTEXT)) { /* XXX check for this somewhere else */
1435 ParameterList *params= RNA_parameter_list_create(ptr, cprop->remove);
1436 RNA_function_call(NULL, NULL, ptr, cprop->remove, params);
1437 RNA_parameter_list_free(params);
1442 printf("RNA_property_collection_remove %s.%s: only supported for id properties.\n", ptr->type->identifier, prop->identifier);
1445 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop)
1449 if((idprop=rna_idproperty_check(&prop, ptr)))
1450 IDP_ResizeIDPArray(idprop, 0);
1453 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr)
1455 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1457 if(cprop->lookupint) {
1458 /* we have a callback defined, use it */
1459 *r_ptr= cprop->lookupint(ptr, key);
1460 return (r_ptr->data != NULL);
1463 /* no callback defined, just iterate and find the nth item */
1464 CollectionPropertyIterator iter;
1467 RNA_property_collection_begin(ptr, prop, &iter);
1468 for(i=0; iter.valid; RNA_property_collection_next(&iter), i++) {
1474 RNA_property_collection_end(&iter);
1477 memset(r_ptr, 0, sizeof(*r_ptr));
1483 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr)
1485 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1487 if(cprop->lookupstring) {
1488 /* we have a callback defined, use it */
1489 *r_ptr= cprop->lookupstring(ptr, key);
1490 return (r_ptr->data != NULL);
1493 /* no callback defined, compare with name properties if they exist */
1494 CollectionPropertyIterator iter;
1495 PropertyRNA *nameprop;
1496 char name[256], *nameptr;
1499 RNA_property_collection_begin(ptr, prop, &iter);
1500 for(; iter.valid; RNA_property_collection_next(&iter)) {
1501 if(iter.ptr.data && iter.ptr.type->nameproperty) {
1502 nameprop= iter.ptr.type->nameproperty;
1504 nameptr= RNA_property_string_get_alloc(&iter.ptr, nameprop, name, sizeof(name));
1506 if(strcmp(nameptr, key) == 0) {
1511 if((char *)&name != nameptr)
1518 RNA_property_collection_end(&iter);
1521 memset(r_ptr, 0, sizeof(*r_ptr));
1527 /* Standard iterator functions */
1529 void rna_iterator_listbase_begin(CollectionPropertyIterator *iter, ListBase *lb, IteratorSkipFunc skip)
1531 ListBaseIterator *internal;
1533 internal= MEM_callocN(sizeof(ListBaseIterator), "ListBaseIterator");
1534 internal->link= (lb)? lb->first: NULL;
1535 internal->skip= skip;
1537 iter->internal= internal;
1538 iter->valid= (internal->link != NULL);
1540 if(skip && iter->valid && skip(iter, internal->link))
1541 rna_iterator_listbase_next(iter);
1544 void rna_iterator_listbase_next(CollectionPropertyIterator *iter)
1546 ListBaseIterator *internal= iter->internal;
1548 if(internal->skip) {
1550 internal->link= internal->link->next;
1551 iter->valid= (internal->link != NULL);
1552 } while(iter->valid && internal->skip(iter, internal->link));
1555 internal->link= internal->link->next;
1556 iter->valid= (internal->link != NULL);
1560 void *rna_iterator_listbase_get(CollectionPropertyIterator *iter)
1562 ListBaseIterator *internal= iter->internal;
1564 return internal->link;
1567 void rna_iterator_listbase_end(CollectionPropertyIterator *iter)
1569 MEM_freeN(iter->internal);
1570 iter->internal= NULL;
1573 void rna_iterator_array_begin(CollectionPropertyIterator *iter, void *ptr, int itemsize, int length, IteratorSkipFunc skip)
1575 ArrayIterator *internal;
1580 internal= MEM_callocN(sizeof(ArrayIterator), "ArrayIterator");
1582 internal->endptr= ((char*)ptr)+length*itemsize;
1583 internal->itemsize= itemsize;
1584 internal->skip= skip;
1586 iter->internal= internal;
1587 iter->valid= (internal->ptr != internal->endptr);
1589 if(skip && iter->valid && skip(iter, internal->ptr))
1590 rna_iterator_array_next(iter);
1593 void rna_iterator_array_next(CollectionPropertyIterator *iter)
1595 ArrayIterator *internal= iter->internal;
1597 if(internal->skip) {
1599 internal->ptr += internal->itemsize;
1600 iter->valid= (internal->ptr != internal->endptr);
1601 } while(iter->valid && internal->skip(iter, internal->ptr));
1604 internal->ptr += internal->itemsize;
1605 iter->valid= (internal->ptr != internal->endptr);
1609 void *rna_iterator_array_get(CollectionPropertyIterator *iter)
1611 ArrayIterator *internal= iter->internal;
1613 return internal->ptr;
1616 void *rna_iterator_array_dereference_get(CollectionPropertyIterator *iter)
1618 ArrayIterator *internal= iter->internal;
1621 return *(void**)(internal->ptr);
1624 void rna_iterator_array_end(CollectionPropertyIterator *iter)
1626 MEM_freeN(iter->internal);
1627 iter->internal= NULL;
1630 /* RNA Path - Experiment */
1632 static char *rna_path_token(const char **path, char *fixedbuf, int fixedlen, int bracket)
1636 int i, j, len, escape;
1641 /* get data between [], check escaping ] with \] */
1642 if(**path == '[') (*path)++;
1648 while(*p && (*p != ']' || escape)) {
1649 escape= (*p == '\\');
1654 if(*p != ']') return NULL;
1657 /* get data until . or [ */
1660 while(*p && *p != '.' && *p != '[') {
1670 /* try to use fixed buffer if possible */
1671 if(len+1 < fixedlen)
1674 buf= MEM_callocN(sizeof(char)*(len+1), "rna_path_token");
1676 /* copy string, taking into account escaped ] */
1678 for(p=*path, i=0, j=0; i<len; i++, p++) {
1679 if(*p == '\\' && *(p+1) == ']');
1686 memcpy(buf, *path, sizeof(char)*len);
1690 /* set path to start of next token */
1698 int RNA_path_resolve(PointerRNA *ptr, const char *path, PointerRNA *r_ptr, PropertyRNA **r_prop)
1701 PointerRNA curptr, nextptr;
1702 char fixedbuf[256], *token;
1709 /* look up property name in current struct */
1710 token= rna_path_token(&path, fixedbuf, sizeof(fixedbuf), 0);
1715 prop= RNA_struct_find_property(&curptr, token);
1717 if(token != fixedbuf)
1723 /* now look up the value of this property if it is a pointer or
1724 * collection, otherwise return the property rna so that the
1725 * caller can read the value of the property itself */
1726 if(RNA_property_type(prop) == PROP_POINTER) {
1727 nextptr= RNA_property_pointer_get(&curptr, prop);
1734 else if(RNA_property_type(prop) == PROP_COLLECTION && *path) {
1735 /* resolve the lookup with [] brackets */
1736 token= rna_path_token(&path, fixedbuf, sizeof(fixedbuf), 1);
1743 /* check for "" to see if it is a string */
1744 if(len >= 2 && token[0] == '"' && token[len-1] == '"') {
1747 RNA_property_collection_lookup_string(&curptr, prop, token+1, &nextptr);
1750 /* otherwise do int lookup */
1751 intkey= atoi(token);
1752 RNA_property_collection_lookup_int(&curptr, prop, intkey, &nextptr);
1755 if(token != fixedbuf)
1771 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop, int intkey, const char *strkey)
1775 char appendstr[128], *result;
1777 dynstr= BLI_dynstr_new();
1779 /* add .identifier */
1781 BLI_dynstr_append(dynstr, (char*)path);
1783 BLI_dynstr_append(dynstr, ".");
1786 BLI_dynstr_append(dynstr, (char*)RNA_property_identifier(prop));
1788 if(RNA_property_type(prop) == PROP_COLLECTION) {
1789 /* add ["strkey"] or [intkey] */
1790 BLI_dynstr_append(dynstr, "[");
1793 BLI_dynstr_append(dynstr, "\"");
1794 for(s=strkey; *s; s++) {
1804 BLI_dynstr_append(dynstr, appendstr);
1806 BLI_dynstr_append(dynstr, "\"");
1809 sprintf(appendstr, "%d", intkey);
1810 BLI_dynstr_append(dynstr, appendstr);
1813 BLI_dynstr_append(dynstr, "]");
1816 result= BLI_dynstr_get_cstring(dynstr);
1817 BLI_dynstr_free(dynstr);
1822 char *RNA_path_back(const char *path)
1825 const char *previous, *current;
1826 char *result, *token;
1835 /* parse token by token until the end, then we back up to the previous
1836 * position and strip of the next token to get the path one step back */
1838 token= rna_path_token(¤t, fixedbuf, sizeof(fixedbuf), 0);
1842 if(token != fixedbuf)
1845 /* in case of collection we also need to strip off [] */
1846 token= rna_path_token(¤t, fixedbuf, sizeof(fixedbuf), 1);
1847 if(token && token != fixedbuf)
1859 /* copy and strip off last token */
1861 result= BLI_strdup(path);
1863 if(i > 0 && result[i-1] == '.') i--;
1869 char *RNA_path_from_ID_to_property(PointerRNA *ptr, PropertyRNA *prop)
1871 char *ptrpath=NULL, *path;
1872 const char *propname;
1874 if(!ptr->id.data || !ptr->data || !prop)
1877 if(!RNA_struct_is_ID(ptr->type)) {
1878 if(ptr->type->path) {
1879 /* if type has a path to some ID, use it */
1880 ptrpath= ptr->type->path(ptr);
1882 else if(ptr->type->nested) {
1883 PointerRNA parentptr;
1884 PropertyRNA *userprop;
1886 /* find the property in the struct we're nested in that references this struct, and
1887 * use its identifier as the first part of the path used...
1889 RNA_pointer_create(ptr->id.data, ptr->type->nested, ptr->data, &parentptr);
1890 userprop= RNA_struct_find_nested(&parentptr, ptr->type);
1893 ptrpath= BLI_strdup(RNA_property_identifier(userprop));
1895 return NULL; // can't do anything about this case yet...
1901 propname= RNA_property_identifier(prop);
1904 path= BLI_sprintfN("%s.%s", ptrpath, propname);
1908 path= BLI_strdup(propname);
1913 /* Quick name based property access */
1915 int RNA_boolean_get(PointerRNA *ptr, const char *name)
1917 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1920 return RNA_property_boolean_get(ptr, prop);
1923 printf("RNA_boolean_get: %s.%s not found.\n", ptr->type->identifier, name);
1928 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value)
1930 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1933 RNA_property_boolean_set(ptr, prop, value);
1935 printf("RNA_boolean_set: %s.%s not found.\n", ptr->type->identifier, name);
1938 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values)
1940 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1943 RNA_property_boolean_get_array(ptr, prop, values);
1945 printf("RNA_boolean_get_array: %s.%s not found.\n", ptr->type->identifier, name);
1948 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values)
1950 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1953 RNA_property_boolean_set_array(ptr, prop, values);
1955 printf("RNA_boolean_set_array: %s.%s not found.\n", ptr->type->identifier, name);
1958 int RNA_int_get(PointerRNA *ptr, const char *name)
1960 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1963 return RNA_property_int_get(ptr, prop);
1966 printf("RNA_int_get: %s.%s not found.\n", ptr->type->identifier, name);
1971 void RNA_int_set(PointerRNA *ptr, const char *name, int value)
1973 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1976 RNA_property_int_set(ptr, prop, value);
1978 printf("RNA_int_set: %s.%s not found.\n", ptr->type->identifier, name);
1981 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values)
1983 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1986 RNA_property_int_get_array(ptr, prop, values);
1988 printf("RNA_int_get_array: %s.%s not found.\n", ptr->type->identifier, name);
1991 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values)
1993 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1996 RNA_property_int_set_array(ptr, prop, values);
1998 printf("RNA_int_set_array: %s.%s not found.\n", ptr->type->identifier, name);
2001 float RNA_float_get(PointerRNA *ptr, const char *name)
2003 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2006 return RNA_property_float_get(ptr, prop);
2009 printf("RNA_float_get: %s.%s not found.\n", ptr->type->identifier, name);
2014 void RNA_float_set(PointerRNA *ptr, const char *name, float value)
2016 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2019 RNA_property_float_set(ptr, prop, value);
2021 printf("RNA_float_set: %s.%s not found.\n", ptr->type->identifier, name);
2024 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values)
2026 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2029 RNA_property_float_get_array(ptr, prop, values);
2031 printf("RNA_float_get_array: %s.%s not found.\n", ptr->type->identifier, name);
2034 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values)
2036 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2039 RNA_property_float_set_array(ptr, prop, values);
2041 printf("RNA_float_set_array: %s.%s not found.\n", ptr->type->identifier, name);
2044 int RNA_enum_get(PointerRNA *ptr, const char *name)
2046 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2049 return RNA_property_enum_get(ptr, prop);
2052 printf("RNA_enum_get: %s.%s not found.\n", ptr->type->identifier, name);
2057 void RNA_enum_set(PointerRNA *ptr, const char *name, int value)
2059 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2062 RNA_property_enum_set(ptr, prop, value);
2064 printf("RNA_enum_set: %s.%s not found.\n", ptr->type->identifier, name);
2067 int RNA_enum_is_equal(PointerRNA *ptr, const char *name, const char *enumname)
2069 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2070 const EnumPropertyItem *item;
2073 RNA_property_enum_items(ptr, prop, &item, NULL);
2075 for(; item->identifier; item++)
2076 if(strcmp(item->identifier, enumname) == 0)
2077 return (item->value == RNA_property_enum_get(ptr, prop));
2079 printf("RNA_enum_is_equal: %s.%s item %s not found.\n", ptr->type->identifier, name, enumname);
2083 printf("RNA_enum_is_equal: %s.%s not found.\n", ptr->type->identifier, name);
2088 int RNA_enum_value_from_id(const EnumPropertyItem *item, const char *identifier, int *value)
2090 for( ; item->identifier; item++) {
2091 if(strcmp(item->identifier, identifier)==0) {
2092 *value= item->value;
2100 int RNA_enum_id_from_value(const EnumPropertyItem *item, int value, const char **identifier)
2102 for( ; item->identifier; item++) {
2103 if(item->value==value) {
2104 *identifier= item->identifier;
2114 void RNA_string_get(PointerRNA *ptr, const char *name, char *value)
2116 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2119 RNA_property_string_get(ptr, prop, value);
2121 printf("RNA_string_get: %s.%s not found.\n", ptr->type->identifier, name);
2124 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen)
2126 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2129 return RNA_property_string_get_alloc(ptr, prop, fixedbuf, fixedlen);
2132 printf("RNA_string_get_alloc: %s.%s not found.\n", ptr->type->identifier, name);
2137 int RNA_string_length(PointerRNA *ptr, const char *name)
2139 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2142 return RNA_property_string_length(ptr, prop);
2145 printf("RNA_string_length: %s.%s not found.\n", ptr->type->identifier, name);
2150 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value)
2152 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2155 RNA_property_string_set(ptr, prop, value);
2157 printf("RNA_string_set: %s.%s not found.\n", ptr->type->identifier, name);
2160 PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name)
2162 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2165 return RNA_property_pointer_get(ptr, prop);
2170 printf("RNA_pointer_get: %s.%s not found.\n", ptr->type->identifier, name);
2172 memset(&result, 0, sizeof(result));
2177 void RNA_pointer_add(PointerRNA *ptr, const char *name)
2179 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2182 RNA_property_pointer_add(ptr, prop);
2184 printf("RNA_pointer_set: %s.%s not found.\n", ptr->type->identifier, name);
2187 void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter)
2189 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2192 RNA_property_collection_begin(ptr, prop, iter);
2194 printf("RNA_collection_begin: %s.%s not found.\n", ptr->type->identifier, name);
2197 void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value)
2199 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2202 RNA_property_collection_add(ptr, prop, r_value);
2204 printf("RNA_collection_add: %s.%s not found.\n", ptr->type->identifier, name);
2207 void RNA_collection_clear(PointerRNA *ptr, const char *name)
2209 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2212 RNA_property_collection_clear(ptr, prop);
2214 printf("RNA_collection_clear: %s.%s not found.\n", ptr->type->identifier, name);
2217 int RNA_collection_length(PointerRNA *ptr, const char *name)
2219 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2222 return RNA_property_collection_length(ptr, prop);
2225 printf("RNA_collection_length: %s.%s not found.\n", ptr->type->identifier, name);
2230 int RNA_property_is_set(PointerRNA *ptr, const char *name)
2232 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2235 return (rna_idproperty_find(ptr, name) != NULL);
2238 printf("RNA_property_is_set: %s.%s not found.\n", ptr->type->identifier, name);
2243 /* string representation of a property, python
2244 * compatible but can be used for display too*/
2245 char *RNA_pointer_as_string(PointerRNA *ptr)
2247 DynStr *dynstr= BLI_dynstr_new();
2250 PropertyRNA *prop, *iterprop;
2251 CollectionPropertyIterator iter;
2252 const char *propname;
2255 BLI_dynstr_append(dynstr, "{");
2257 iterprop= RNA_struct_iterator_property(ptr->type);
2259 for(RNA_property_collection_begin(ptr, iterprop, &iter); iter.valid; RNA_property_collection_next(&iter)) {
2260 prop= iter.ptr.data;
2261 propname = RNA_property_identifier(prop);
2263 if(strcmp(propname, "rna_type")==0)
2267 BLI_dynstr_append(dynstr, ", ");
2270 cstring = RNA_property_as_string(ptr, prop);
2271 BLI_dynstr_appendf(dynstr, "\"%s\":%s", propname, cstring);
2275 RNA_property_collection_end(&iter);
2276 BLI_dynstr_append(dynstr, "}");
2279 cstring = BLI_dynstr_get_cstring(dynstr);
2280 BLI_dynstr_free(dynstr);
2284 char *RNA_property_as_string(PointerRNA *ptr, PropertyRNA *prop)
2286 int type = RNA_property_type(prop);
2287 int len = RNA_property_array_length(prop);
2290 DynStr *dynstr= BLI_dynstr_new();
2294 /* see if we can coorce into a python type - PropertyType */
2298 BLI_dynstr_append(dynstr, RNA_property_boolean_get(ptr, prop) ? "True" : "False");
2301 BLI_dynstr_append(dynstr, "(");
2302 for(i=0; i<len; i++) {
2303 BLI_dynstr_appendf(dynstr, i?", %s":"%s", RNA_property_boolean_get_index(ptr, prop, i) ? "True" : "False");
2305 BLI_dynstr_append(dynstr, ")");
2310 BLI_dynstr_appendf(dynstr, "%d", RNA_property_int_get(ptr, prop));
2313 BLI_dynstr_append(dynstr, "(");
2314 for(i=0; i<len; i++) {
2315 BLI_dynstr_appendf(dynstr, i?", %d":"%d", RNA_property_int_get_index(ptr, prop, i));
2317 BLI_dynstr_append(dynstr, ")");
2322 BLI_dynstr_appendf(dynstr, "%g", RNA_property_float_get(ptr, prop));
2325 BLI_dynstr_append(dynstr, "(");
2326 for(i=0; i<len; i++) {
2327 BLI_dynstr_appendf(dynstr, i?", %g":"%g", RNA_property_float_get_index(ptr, prop, i));
2329 BLI_dynstr_append(dynstr, ")");
2334 /* string arrays dont exist */
2336 buf = RNA_property_string_get_alloc(ptr, prop, NULL, -1);
2337 BLI_dynstr_appendf(dynstr, "\"%s\"", buf);
2343 /* string arrays dont exist */
2344 const char *identifier;
2345 int val = RNA_property_enum_get(ptr, prop);
2347 if(RNA_property_enum_identifier(ptr, prop, val, &identifier)) {
2348 BLI_dynstr_appendf(dynstr, "'%s'", identifier);
2351 BLI_dynstr_appendf(dynstr, "'<UNKNOWN ENUM>'", identifier);
2357 BLI_dynstr_append(dynstr, "'<POINTER>'"); /* TODO */
2360 case PROP_COLLECTION:
2363 CollectionPropertyIterator collect_iter;
2364 BLI_dynstr_append(dynstr, "[");
2366 for(RNA_property_collection_begin(ptr, prop, &collect_iter); collect_iter.valid; RNA_property_collection_next(&collect_iter)) {
2367 PointerRNA itemptr= collect_iter.ptr;
2370 BLI_dynstr_append(dynstr, ", ");
2373 /* now get every prop of the collection */
2374 cstring= RNA_pointer_as_string(&itemptr);
2375 BLI_dynstr_append(dynstr, cstring);
2379 RNA_property_collection_end(&collect_iter);
2380 BLI_dynstr_append(dynstr, "]");
2384 BLI_dynstr_append(dynstr, "'<UNKNOWN TYPE>'"); /* TODO */
2388 cstring = BLI_dynstr_get_cstring(dynstr);
2389 BLI_dynstr_free(dynstr);
2395 const char *RNA_function_identifier(FunctionRNA *func)
2397 return func->identifier;
2400 PropertyRNA *RNA_function_return(FunctionRNA *func)
2405 const char *RNA_function_ui_description(FunctionRNA *func)
2407 return func->description;
2410 int RNA_function_flag(FunctionRNA *func)
2415 PropertyRNA *RNA_function_get_parameter(PointerRNA *ptr, FunctionRNA *func, int index)
2420 parm= func->cont.properties.first;
2421 for(i= 0; parm; parm= parm->next, i++)
2428 PropertyRNA *RNA_function_find_parameter(PointerRNA *ptr, FunctionRNA *func, const char *identifier)
2432 parm= func->cont.properties.first;
2433 for(; parm; parm= parm->next)
2434 if(strcmp(parm->identifier, identifier)==0)
2440 const struct ListBase *RNA_function_defined_parameters(FunctionRNA *func)
2442 return &func->cont.properties;
2447 ParameterList *RNA_parameter_list_create(PointerRNA *ptr, FunctionRNA *func)
2449 ParameterList *parms;
2453 parms= MEM_callocN(sizeof(ParameterList), "ParameterList");
2455 parm= func->cont.properties.first;
2456 for(tot= 0; parm; parm= parm->next)
2457 tot+= rna_parameter_size(parm);
2459 parms->data= MEM_callocN(tot, "RNA_parameter_list_create");
2465 void RNA_parameter_list_free(ParameterList *parms)
2467 MEM_freeN(parms->data);
2475 void RNA_parameter_list_begin(ParameterList *parms, ParameterIterator *iter)
2479 RNA_pointer_create(NULL, &RNA_Function, parms->func, &iter->funcptr);
2482 iter->parm= parms->func->cont.properties.first;
2483 iter->valid= iter->parm != NULL;
2487 iter->size= rna_parameter_size(iter->parm);
2488 iter->data= (((char*)iter->parms->data)+iter->offset);
2489 ptype= RNA_property_type(iter->parm);
2493 void RNA_parameter_list_next(ParameterIterator *iter)
2497 iter->offset+= iter->size;
2498 iter->parm= iter->parm->next;
2499 iter->valid= iter->parm != NULL;
2502 iter->size= rna_parameter_size(iter->parm);
2503 iter->data= (((char*)iter->parms->data)+iter->offset);
2504 ptype= RNA_property_type(iter->parm);
2508 void RNA_parameter_list_end(ParameterIterator *iter)
2513 void RNA_parameter_get(ParameterList *parms, PropertyRNA *parm, void **value)
2515 ParameterIterator iter;
2517 RNA_parameter_list_begin(parms, &iter);
2519 for(; iter.valid; RNA_parameter_list_next(&iter))
2528 RNA_parameter_list_end(&iter);
2531 void RNA_parameter_get_lookup(ParameterList *parms, const char *identifier, void **value)
2535 parm= parms->func->cont.properties.first;
2536 for(; parm; parm= parm->next)
2537 if(strcmp(RNA_property_identifier(parm), identifier)==0)
2541 RNA_parameter_get(parms, parm, value);
2544 void RNA_parameter_set(ParameterList *parms, PropertyRNA *parm, void *value)
2546 ParameterIterator iter;
2548 RNA_parameter_list_begin(parms, &iter);
2550 for(; iter.valid; RNA_parameter_list_next(&iter))
2555 memcpy(iter.data, value, iter.size);
2557 RNA_parameter_list_end(&iter);
2560 void RNA_parameter_set_lookup(ParameterList *parms, const char *identifier, void *value)
2564 parm= parms->func->cont.properties.first;
2565 for(; parm; parm= parm->next)
2566 if(strcmp(RNA_property_identifier(parm), identifier)==0)
2570 RNA_parameter_set(parms, parm, value);
2573 int RNA_function_call(bContext *C, ReportList *reports, PointerRNA *ptr, FunctionRNA *func, ParameterList *parms)
2576 func->call(C, reports, ptr, parms);
2584 int RNA_function_call_lookup(bContext *C, ReportList *reports, PointerRNA *ptr, const char *identifier, ParameterList *parms)
2588 func= RNA_struct_find_function(ptr, identifier);
2591 return RNA_function_call(C, reports, ptr, func, parms);
2596 int RNA_function_call_direct(bContext *C, ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, ...)
2601 va_start(args, format);
2603 ret= RNA_function_call_direct_va(C, reports, ptr, func, format, args);
2610 int RNA_function_call_direct_lookup(bContext *C, ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, ...)
2614 func= RNA_struct_find_function(ptr, identifier);
2620 va_start(args, format);
2622 ret= RNA_function_call_direct_va(C, reports, ptr, func, format, args);
2632 static int rna_function_format_array_length(const char *format, int ofs, int flen)
2637 if (format[ofs++]=='[')
2638 for (; ofs<flen && format[ofs]!=']' && idx<sizeof(*lenbuf)-1; idx++, ofs++)
2639 lenbuf[idx]= format[ofs];
2641 if (ofs<flen && format[ofs++]==']') {
2642 /* XXX put better error reporting for ofs>=flen or idx over lenbuf capacity */
2644 return atoi(lenbuf);
2650 static int rna_function_parameter_parse(PointerRNA *ptr, PropertyRNA *prop, PropertyType type, char ftype, int len, void *dest, void *src, StructRNA *srna, const char *tid, const char *fid, const char *pid)
2652 /* ptr is always a function pointer, prop always a parameter */
2658 fprintf(stderr, "%s.%s: wrong type for parameter %s, a boolean was expected\n", tid, fid, pid);
2663 *((int*)dest)= *((int*)src);
2665 memcpy(dest, src, len*sizeof(int));
2672 fprintf(stderr, "%s.%s: wrong type for parameter %s, an integer was expected\n", tid, fid, pid);
2677 *((int*)dest)= *((int*)src);
2679 memcpy(dest, src, len*sizeof(int));
2686 fprintf(stderr, "%s.%s: wrong type for parameter %s, a float was expected\n", tid, fid, pid);
2691 *((float*)dest)= *((float*)src);
2693 memcpy(dest, src, len*sizeof(float));
2700 fprintf(stderr, "%s.%s: wrong type for parameter %s, a string was expected\n", tid, fid, pid);
2704 *((char**)dest)= *((char**)src);
2711 fprintf(stderr, "%s.%s: wrong type for parameter %s, an enum was expected\n", tid, fid, pid);
2715 *((int*)dest)= *((int*)src);
2724 fprintf(stderr, "%s.%s: wrong type for parameter %s, an object was expected\n", tid, fid, pid);
2728 ptype= RNA_property_pointer_type(ptr, prop);
2730 if(prop->flag & PROP_RNAPTR) {
2731 *((PointerRNA*)dest)= *((PointerRNA*)src);
2733 else if (ptype!=srna) {
2734 if (!RNA_struct_is_a(srna, ptype)) {
2735 fprintf(stderr, "%s.%s: wrong type for parameter %s, an object of type %s was expected, passed an object of type %s\n", tid, fid, pid, RNA_struct_identifier(ptype), RNA_struct_identifier(ptype));
2739 *((void**)dest)= *((void**)src);
2744 case PROP_COLLECTION:
2746 /* XXX collections are not supported yet */
2747 fprintf(stderr, "%s.%s: for parameter %s, collections are not supported yet\n", tid, fid, pid);
2753 fprintf(stderr, "%s.%s: unknown type for parameter %s\n", tid, fid, pid);
2755 fprintf(stderr, "%s.%s: unknown array type for parameter %s\n", tid, fid, pid);
2764 int RNA_function_call_direct_va(bContext *C, ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, va_list args)
2767 ParameterList *parms;
2768 ParameterIterator iter;
2769 PropertyRNA *pret, *parm;
2771 int i, ofs, flen, flag, len, alen, err= 0;
2772 const char *tid, *fid, *pid=NULL;
2774 void **retdata=NULL;
2776 RNA_pointer_create(NULL, &RNA_Function, func, &funcptr);
2778 tid= RNA_struct_identifier(ptr->type);
2779 fid= RNA_function_identifier(func);
2780 pret= RNA_function_return(func);
2781 flen= strlen(format);
2783 parms= RNA_parameter_list_create(ptr, func);
2784 RNA_parameter_list_begin(parms, &iter);
2786 for(i= 0, ofs= 0; iter.valid; RNA_parameter_list_next(&iter), i++) {
2794 pid= RNA_property_identifier(parm);
2795 flag= RNA_property_flag(parm);
2797 if (ofs>=flen || format[ofs]=='N') {
2798 if (flag & PROP_REQUIRED) {
2800 fprintf(stderr, "%s.%s: missing required parameter %s\n", tid, fid, pid);
2807 type= RNA_property_type(parm);
2808 ftype= format[ofs++];
2809 len= RNA_property_array_length(parm);
2810 alen= rna_function_format_array_length(format, ofs, flen);
2814 fprintf(stderr, "%s.%s: for parameter %s, was expecting an array of %i elements, passed %i elements instead\n", tid, fid, pid, len, alen);
2823 int arg= va_arg(args, int);
2824 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, iter.data, &arg, NULL, tid, fid, pid);
2829 double arg= va_arg(args, double);
2830 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, iter.data, &arg, NULL, tid, fid, pid);
2835 char *arg= va_arg(args, char*);
2836 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, iter.data, &arg, NULL, tid, fid, pid);
2841 StructRNA *srna= va_arg(args, StructRNA*);
2842 void *arg= va_arg(args, void*);
2843 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, iter.data, &arg, srna, tid, fid, pid);
2849 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, iter.data, NULL, NULL, tid, fid, pid);
2859 err= RNA_function_call(C, reports, ptr, func, parms);
2861 /* XXX throw error when more parameters than those needed are passed or leave silent? */
2862 if (err==0 && pret && ofs<flen && format[ofs++]=='R') {
2865 type= RNA_property_type(parm);
2866 ftype= format[ofs++];
2867 len= RNA_property_array_length(parm);
2868 alen= rna_function_format_array_length(format, ofs, flen);
2872 fprintf(stderr, "%s.%s: for return parameter %s, was expecting an array of %i elements, passed %i elements instead\n", tid, fid, pid, len, alen);
2880 int *arg= va_arg(args, int*);
2881 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, arg, retdata, NULL, tid, fid, pid);
2886 float *arg= va_arg(args, float*);
2887 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, arg, retdata, NULL, tid, fid, pid);
2892 char **arg= va_arg(args, char**);
2893 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, arg, retdata, NULL, tid, fid, pid);
2898 StructRNA *srna= va_arg(args, StructRNA*);
2899 void **arg= va_arg(args, void**);
2900 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, arg, retdata, srna, tid, fid, pid);
2906 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, NULL, NULL, NULL, tid, fid, pid);
2913 RNA_parameter_list_end(&iter);
2914 RNA_parameter_list_free(parms);
2919 int RNA_function_call_direct_va_lookup(bContext *C, ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, va_list args)
2923 func= RNA_struct_find_function(ptr, identifier);
2926 return RNA_function_call_direct_va(C, reports, ptr, func, format, args);