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 PropertyRNA *prop= NULL;
431 RNA_STRUCT_BEGIN(ptr, iprop) {
432 /* This assumes that there can only be one user of this nested struct */
433 if (RNA_property_pointer_type(ptr, iprop) == srna) {
443 const struct ListBase *RNA_struct_defined_properties(StructRNA *srna)
445 return &srna->cont.properties;
448 FunctionRNA *RNA_struct_find_function(PointerRNA *ptr, const char *identifier)
451 PropertyRNA *iterprop;
454 RNA_pointer_create(NULL, &RNA_Struct, ptr->type, &tptr);
455 iterprop= RNA_struct_find_property(&tptr, "functions");
459 RNA_PROP_BEGIN(&tptr, funcptr, iterprop) {
460 if(strcmp(identifier, RNA_function_identifier(funcptr.data)) == 0) {
470 const struct ListBase *RNA_struct_defined_functions(StructRNA *srna)
472 return &srna->functions;
475 StructRegisterFunc RNA_struct_register(StructRNA *type)
480 StructUnregisterFunc RNA_struct_unregister(StructRNA *type)
485 } while((type=type->base));
490 void *RNA_struct_py_type_get(StructRNA *srna)
492 return srna->py_type;
495 void RNA_struct_py_type_set(StructRNA *srna, void *py_type)
497 srna->py_type= py_type;
500 void *RNA_struct_blender_type_get(StructRNA *srna)
502 return srna->blender_type;
505 void RNA_struct_blender_type_set(StructRNA *srna, void *blender_type)
507 srna->blender_type= blender_type;
510 char *RNA_struct_name_get_alloc(PointerRNA *ptr, char *fixedbuf, int fixedlen)
512 PropertyRNA *nameprop;
514 if(ptr->data && (nameprop = RNA_struct_name_property(ptr->type)))
515 return RNA_property_string_get_alloc(ptr, nameprop, fixedbuf, fixedlen);
520 /* Property Information */
522 const char *RNA_property_identifier(PropertyRNA *prop)
524 return rna_ensure_property_identifier(prop);
527 PropertyType RNA_property_type(PropertyRNA *prop)
529 return rna_ensure_property(prop)->type;
532 PropertySubType RNA_property_subtype(PropertyRNA *prop)
534 return rna_ensure_property(prop)->subtype;
537 int RNA_property_flag(PropertyRNA *prop)
539 return rna_ensure_property(prop)->flag;
542 int RNA_property_array_length(PropertyRNA *prop)
544 return rna_ensure_property_array_length(prop);
547 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax)
549 IntPropertyRNA *iprop= (IntPropertyRNA*)rna_ensure_property(prop);
552 iprop->range(ptr, hardmin, hardmax);
555 *hardmin= iprop->hardmin;
556 *hardmax= iprop->hardmax;
560 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step)
562 IntPropertyRNA *iprop= (IntPropertyRNA*)rna_ensure_property(prop);
563 int hardmin, hardmax;
566 iprop->range(ptr, &hardmin, &hardmax);
567 *softmin= MAX2(iprop->softmin, hardmin);
568 *softmax= MIN2(iprop->softmax, hardmax);
571 *softmin= iprop->softmin;
572 *softmax= iprop->softmax;
578 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax)
580 FloatPropertyRNA *fprop= (FloatPropertyRNA*)rna_ensure_property(prop);
583 fprop->range(ptr, hardmin, hardmax);
586 *hardmin= fprop->hardmin;
587 *hardmax= fprop->hardmax;
591 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision)
593 FloatPropertyRNA *fprop= (FloatPropertyRNA*)rna_ensure_property(prop);
594 float hardmin, hardmax;
597 fprop->range(ptr, &hardmin, &hardmax);
598 *softmin= MAX2(fprop->softmin, hardmin);
599 *softmax= MIN2(fprop->softmax, hardmax);
602 *softmin= fprop->softmin;
603 *softmax= fprop->softmax;
607 *precision= (float)fprop->precision;
610 int RNA_property_string_maxlength(PropertyRNA *prop)
612 StringPropertyRNA *sprop= (StringPropertyRNA*)rna_ensure_property(prop);
613 return sprop->maxlength;
616 StructRNA *RNA_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop)
618 prop= rna_ensure_property(prop);
620 if(prop->type == PROP_POINTER) {
621 PointerPropertyRNA *pprop= (PointerPropertyRNA*)prop;
624 return pprop->typef(ptr);
628 else if(prop->type == PROP_COLLECTION) {
629 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
635 return &RNA_UnknownType;
638 void RNA_property_enum_items(PointerRNA *ptr, PropertyRNA *prop, const EnumPropertyItem **item, int *totitem)
640 EnumPropertyRNA *eprop= (EnumPropertyRNA*)rna_ensure_property(prop);
644 *item= eprop->itemf(ptr);
646 for(tot=0; (*item)[tot].identifier; tot++);
653 *totitem= eprop->totitem;
657 int RNA_property_enum_value(PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *value)
659 const EnumPropertyItem *item;
661 RNA_property_enum_items(ptr, prop, &item, NULL);
663 for(; item->identifier; item++) {
664 if(strcmp(item->identifier, identifier)==0) {
665 *value = item->value;
673 int RNA_enum_identifier(const EnumPropertyItem *item, const int value, const char **identifier)
675 for (; item->identifier; item++) {
676 if(item->value==value) {
677 *identifier = item->identifier;
684 int RNA_enum_name(const EnumPropertyItem *item, const int value, const char **name)
686 for (; item->identifier; item++) {
687 if(item->value==value) {
695 int RNA_property_enum_identifier(PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier)
697 const EnumPropertyItem *item= NULL;
699 RNA_property_enum_items(ptr, prop, &item, NULL);
700 return RNA_enum_identifier(item, value, identifier);
703 const char *RNA_property_ui_name(PropertyRNA *prop)
705 return rna_ensure_property_name(prop);
708 const char *RNA_property_ui_description(PropertyRNA *prop)
710 return rna_ensure_property(prop)->description;
713 int RNA_property_ui_icon(PropertyRNA *prop)
715 return rna_ensure_property(prop)->icon;
718 int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop)
723 prop= rna_ensure_property(prop);
726 flag= prop->editable(ptr);
732 return (flag & PROP_EDITABLE) && (!id || !id->lib);
735 int RNA_property_animateable(PointerRNA *ptr, PropertyRNA *prop)
739 prop= rna_ensure_property(prop);
741 if(!(prop->flag & PROP_ANIMATEABLE))
745 flag= prop->editable(ptr);
749 return (flag & PROP_EDITABLE);
752 int RNA_property_animated(PointerRNA *ptr, PropertyRNA *prop)
754 /* would need to ask animation system */
759 void RNA_property_update(bContext *C, PointerRNA *ptr, PropertyRNA *prop)
761 prop= rna_ensure_property(prop);
764 prop->update(C, ptr);
766 WM_event_add_notifier(C, prop->noteflag, ptr->id.data);
771 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop)
773 BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop;
776 if((idprop=rna_idproperty_check(&prop, ptr)))
777 return IDP_Int(idprop);
779 return bprop->get(ptr);
781 return bprop->defaultvalue;
784 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value)
786 BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop;
789 if((idprop=rna_idproperty_check(&prop, ptr)))
790 IDP_Int(idprop)= value;
792 bprop->set(ptr, value);
793 else if(prop->flag & PROP_EDITABLE) {
794 IDPropertyTemplate val = {0};
799 group= RNA_struct_idproperties(ptr, 1);
801 IDP_AddToGroup(group, IDP_New(IDP_INT, val, (char*)prop->identifier));
805 void RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values)
807 BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop;
810 if((idprop=rna_idproperty_check(&prop, ptr))) {
811 if(prop->arraylength == 0)
812 values[0]= RNA_property_boolean_get(ptr, prop);
814 memcpy(values, IDP_Array(idprop), sizeof(int)*idprop->len);
816 else if(prop->arraylength == 0)
817 values[0]= RNA_property_boolean_get(ptr, prop);
818 else if(bprop->getarray)
819 bprop->getarray(ptr, values);
820 else if(bprop->defaultarray)
821 memcpy(values, bprop->defaultarray, sizeof(int)*prop->arraylength);
823 memset(values, 0, sizeof(int)*prop->arraylength);
826 int RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index)
828 int tmp[RNA_MAX_ARRAY];
830 RNA_property_boolean_get_array(ptr, prop, tmp);
834 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values)
836 BooleanPropertyRNA *bprop= (BooleanPropertyRNA*)prop;
839 if((idprop=rna_idproperty_check(&prop, ptr))) {
840 if(prop->arraylength == 0)
841 IDP_Int(idprop)= values[0];
843 memcpy(IDP_Array(idprop), values, sizeof(int)*idprop->len);
845 else if(prop->arraylength == 0)
846 RNA_property_boolean_set(ptr, prop, values[0]);
847 else if(bprop->setarray)
848 bprop->setarray(ptr, values);
849 else if(prop->flag & PROP_EDITABLE) {
850 IDPropertyTemplate val = {0};
853 val.array.len= prop->arraylength;
854 val.array.type= IDP_INT;
856 group= RNA_struct_idproperties(ptr, 1);
858 idprop= IDP_New(IDP_ARRAY, val, (char*)prop->identifier);
859 IDP_AddToGroup(group, idprop);
860 memcpy(IDP_Array(idprop), values, sizeof(int)*idprop->len);
865 void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value)
867 int tmp[RNA_MAX_ARRAY];
869 RNA_property_boolean_get_array(ptr, prop, tmp);
871 RNA_property_boolean_set_array(ptr, prop, tmp);
874 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop)
876 IntPropertyRNA *iprop= (IntPropertyRNA*)prop;
879 if((idprop=rna_idproperty_check(&prop, ptr)))
880 return IDP_Int(idprop);
882 return iprop->get(ptr);
884 return iprop->defaultvalue;
887 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value)
889 IntPropertyRNA *iprop= (IntPropertyRNA*)prop;
892 if((idprop=rna_idproperty_check(&prop, ptr)))
893 IDP_Int(idprop)= value;
895 iprop->set(ptr, value);
896 else if(prop->flag & PROP_EDITABLE) {
897 IDPropertyTemplate val = {0};
902 group= RNA_struct_idproperties(ptr, 1);
904 IDP_AddToGroup(group, IDP_New(IDP_INT, val, (char*)prop->identifier));
908 void RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values)
910 IntPropertyRNA *iprop= (IntPropertyRNA*)prop;
913 if((idprop=rna_idproperty_check(&prop, ptr))) {
914 if(prop->arraylength == 0)
915 values[0]= RNA_property_int_get(ptr, prop);
917 memcpy(values, IDP_Array(idprop), sizeof(int)*idprop->len);
919 else if(prop->arraylength == 0)
920 values[0]= RNA_property_int_get(ptr, prop);
921 else if(iprop->getarray)
922 iprop->getarray(ptr, values);
923 else if(iprop->defaultarray)
924 memcpy(values, iprop->defaultarray, sizeof(int)*prop->arraylength);
926 memset(values, 0, sizeof(int)*prop->arraylength);
929 int RNA_property_int_get_index(PointerRNA *ptr, PropertyRNA *prop, int index)
931 int tmp[RNA_MAX_ARRAY];
933 RNA_property_int_get_array(ptr, prop, tmp);
937 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values)
939 IntPropertyRNA *iprop= (IntPropertyRNA*)prop;
942 if((idprop=rna_idproperty_check(&prop, ptr))) {
943 if(prop->arraylength == 0)
944 IDP_Int(idprop)= values[0];
946 memcpy(IDP_Array(idprop), values, sizeof(int)*idprop->len);\
948 else if(prop->arraylength == 0)
949 RNA_property_int_set(ptr, prop, values[0]);
950 else if(iprop->setarray)
951 iprop->setarray(ptr, values);
952 else if(prop->flag & PROP_EDITABLE) {
953 IDPropertyTemplate val = {0};
956 val.array.len= prop->arraylength;
957 val.array.type= IDP_INT;
959 group= RNA_struct_idproperties(ptr, 1);
961 idprop= IDP_New(IDP_ARRAY, val, (char*)prop->identifier);
962 IDP_AddToGroup(group, idprop);
963 memcpy(IDP_Array(idprop), values, sizeof(int)*idprop->len);
968 void RNA_property_int_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value)
970 int tmp[RNA_MAX_ARRAY];
972 RNA_property_int_get_array(ptr, prop, tmp);
974 RNA_property_int_set_array(ptr, prop, tmp);
977 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop)
979 FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop;
982 if((idprop=rna_idproperty_check(&prop, ptr))) {
983 if(idprop->type == IDP_FLOAT)
984 return IDP_Float(idprop);
986 return (float)IDP_Double(idprop);
989 return fprop->get(ptr);
991 return fprop->defaultvalue;
994 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value)
996 FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop;
999 if((idprop=rna_idproperty_check(&prop, ptr))) {
1000 if(idprop->type == IDP_FLOAT)
1001 IDP_Float(idprop)= value;
1003 IDP_Double(idprop)= value;
1005 else if(fprop->set) {
1006 fprop->set(ptr, value);
1008 else if(prop->flag & PROP_EDITABLE) {
1009 IDPropertyTemplate val = {0};
1014 group= RNA_struct_idproperties(ptr, 1);
1016 IDP_AddToGroup(group, IDP_New(IDP_FLOAT, val, (char*)prop->identifier));
1020 void RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, float *values)
1022 FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop;
1026 if((idprop=rna_idproperty_check(&prop, ptr))) {
1027 if(prop->arraylength == 0)
1028 values[0]= RNA_property_float_get(ptr, prop);
1029 else if(idprop->subtype == IDP_FLOAT) {
1030 memcpy(values, IDP_Array(idprop), sizeof(float)*idprop->len);
1033 for(i=0; i<idprop->len; i++)
1034 values[i]= (float)(((double*)IDP_Array(idprop))[i]);
1037 else if(prop->arraylength == 0)
1038 values[0]= RNA_property_float_get(ptr, prop);
1039 else if(fprop->getarray)
1040 fprop->getarray(ptr, values);
1041 else if(fprop->defaultarray)
1042 memcpy(values, fprop->defaultarray, sizeof(float)*prop->arraylength);
1044 memset(values, 0, sizeof(float)*prop->arraylength);
1047 float RNA_property_float_get_index(PointerRNA *ptr, PropertyRNA *prop, int index)
1049 float tmp[RNA_MAX_ARRAY];
1051 RNA_property_float_get_array(ptr, prop, tmp);
1055 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, const float *values)
1057 FloatPropertyRNA *fprop= (FloatPropertyRNA*)prop;
1061 if((idprop=rna_idproperty_check(&prop, ptr))) {
1062 if(prop->arraylength == 0)
1063 IDP_Double(idprop)= values[0];
1064 else if(idprop->subtype == IDP_FLOAT) {
1065 memcpy(IDP_Array(idprop), values, sizeof(float)*idprop->len);
1068 for(i=0; i<idprop->len; i++)
1069 ((double*)IDP_Array(idprop))[i]= values[i];
1072 else if(prop->arraylength == 0)
1073 RNA_property_float_set(ptr, prop, values[0]);
1074 else if(fprop->setarray) {
1075 fprop->setarray(ptr, values);
1077 else if(prop->flag & PROP_EDITABLE) {
1078 IDPropertyTemplate val = {0};
1081 val.array.len= prop->arraylength;
1082 val.array.type= IDP_FLOAT;
1084 group= RNA_struct_idproperties(ptr, 1);
1086 idprop= IDP_New(IDP_ARRAY, val, (char*)prop->identifier);
1087 IDP_AddToGroup(group, idprop);
1088 memcpy(IDP_Array(idprop), values, sizeof(float)*idprop->len);
1093 void RNA_property_float_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, float value)
1095 float tmp[RNA_MAX_ARRAY];
1097 RNA_property_float_get_array(ptr, prop, tmp);
1099 RNA_property_float_set_array(ptr, prop, tmp);
1102 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value)
1104 StringPropertyRNA *sprop= (StringPropertyRNA*)prop;
1107 if((idprop=rna_idproperty_check(&prop, ptr)))
1108 strcpy(value, IDP_String(idprop));
1110 sprop->get(ptr, value);
1112 strcpy(value, sprop->defaultvalue);
1115 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen)
1120 length= RNA_property_string_length(ptr, prop);
1122 if(length+1 < fixedlen)
1125 buf= MEM_callocN(sizeof(char)*(length+1), "RNA_string_get_alloc");
1127 RNA_property_string_get(ptr, prop, buf);
1132 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop)
1134 StringPropertyRNA *sprop= (StringPropertyRNA*)prop;
1137 if((idprop=rna_idproperty_check(&prop, ptr)))
1138 return strlen(IDP_String(idprop));
1139 else if(sprop->length)
1140 return sprop->length(ptr);
1142 return strlen(sprop->defaultvalue);
1145 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value)
1147 StringPropertyRNA *sprop= (StringPropertyRNA*)prop;
1150 if((idprop=rna_idproperty_check(&prop, ptr)))
1151 IDP_AssignString(idprop, (char*)value);
1153 sprop->set(ptr, value);
1154 else if(prop->flag & PROP_EDITABLE) {
1155 IDPropertyTemplate val = {0};
1158 val.str= (char*)value;
1160 group= RNA_struct_idproperties(ptr, 1);
1162 IDP_AddToGroup(group, IDP_New(IDP_STRING, val, (char*)prop->identifier));
1166 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop)
1168 EnumPropertyRNA *eprop= (EnumPropertyRNA*)prop;
1171 if((idprop=rna_idproperty_check(&prop, ptr)))
1172 return IDP_Int(idprop);
1174 return eprop->get(ptr);
1176 return eprop->defaultvalue;
1180 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value)
1182 EnumPropertyRNA *eprop= (EnumPropertyRNA*)prop;
1185 if((idprop=rna_idproperty_check(&prop, ptr)))
1186 IDP_Int(idprop)= value;
1187 else if(eprop->set) {
1188 eprop->set(ptr, value);
1190 else if(prop->flag & PROP_EDITABLE) {
1191 IDPropertyTemplate val = {0};
1196 group= RNA_struct_idproperties(ptr, 1);
1198 IDP_AddToGroup(group, IDP_New(IDP_INT, val, (char*)prop->identifier));
1202 PointerRNA RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop)
1204 PointerPropertyRNA *pprop= (PointerPropertyRNA*)prop;
1207 if((idprop=rna_idproperty_check(&prop, ptr))) {
1208 pprop= (PointerPropertyRNA*)prop;
1210 /* for groups, data is idprop itself */
1211 return rna_pointer_inherit_refine(ptr, pprop->type, idprop);
1213 else if(pprop->get) {
1214 return pprop->get(ptr);
1218 memset(&result, 0, sizeof(result));
1223 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA ptr_value)
1225 PointerPropertyRNA *pprop= (PointerPropertyRNA*)prop;
1228 pprop->set(ptr, ptr_value);
1231 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop)
1235 if((idprop=rna_idproperty_check(&prop, ptr))) {
1236 /* already exists */
1238 else if(prop->flag & PROP_IDPROPERTY) {
1239 IDPropertyTemplate val = {0};
1244 group= RNA_struct_idproperties(ptr, 1);
1246 IDP_AddToGroup(group, IDP_New(IDP_GROUP, val, (char*)prop->identifier));
1249 printf("RNA_property_pointer_add %s.%s: only supported for id properties.\n", ptr->type->identifier, prop->identifier);
1252 void RNA_property_pointer_remove(PointerRNA *ptr, PropertyRNA *prop)
1254 IDProperty *idprop, *group;
1256 if((idprop=rna_idproperty_check(&prop, ptr))) {
1257 group= RNA_struct_idproperties(ptr, 0);
1260 IDP_RemFromGroup(group, idprop);
1261 IDP_FreeProperty(idprop);
1266 printf("RNA_property_pointer_remove %s.%s: only supported for id properties.\n", ptr->type->identifier, prop->identifier);
1269 static void rna_property_collection_get_idp(CollectionPropertyIterator *iter)
1271 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop;
1273 iter->ptr.data= rna_iterator_array_get(iter);
1274 iter->ptr.type= cprop->type;
1275 rna_pointer_inherit_id(cprop->type, &iter->parent, &iter->ptr);
1278 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter)
1282 memset(iter, 0, sizeof(*iter));
1284 if((idprop=rna_idproperty_check(&prop, ptr)) || (prop->flag & PROP_IDPROPERTY)) {
1289 rna_iterator_array_begin(iter, IDP_IDPArray(idprop), sizeof(IDProperty), idprop->len, NULL);
1291 rna_iterator_array_begin(iter, NULL, sizeof(IDProperty), 0, NULL);
1294 rna_property_collection_get_idp(iter);
1299 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1300 cprop->begin(iter, ptr);
1304 void RNA_property_collection_next(CollectionPropertyIterator *iter)
1306 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop;
1309 rna_iterator_array_next(iter);
1312 rna_property_collection_get_idp(iter);
1318 void RNA_property_collection_end(CollectionPropertyIterator *iter)
1320 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)iter->prop;
1323 rna_iterator_array_end(iter);
1328 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop)
1330 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1333 if((idprop=rna_idproperty_check(&prop, ptr))) {
1336 else if(cprop->length) {
1337 return cprop->length(ptr);
1340 CollectionPropertyIterator iter;
1343 RNA_property_collection_begin(ptr, prop, &iter);
1344 for(; iter.valid; RNA_property_collection_next(&iter))
1346 RNA_property_collection_end(&iter);
1352 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr)
1355 //CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1357 if((idprop=rna_idproperty_check(&prop, ptr))) {
1358 IDPropertyTemplate val = {0};
1361 item= IDP_New(IDP_GROUP, val, "");
1362 IDP_AppendArray(idprop, item);
1363 IDP_FreeProperty(item);
1366 else if(prop->flag & PROP_IDPROPERTY) {
1367 IDProperty *group, *item;
1368 IDPropertyTemplate val = {0};
1370 group= RNA_struct_idproperties(ptr, 1);
1372 idprop= IDP_NewIDPArray(prop->identifier);
1373 IDP_AddToGroup(group, idprop);
1375 item= IDP_New(IDP_GROUP, val, "");
1376 IDP_AppendArray(idprop, item);
1377 IDP_FreeProperty(item);
1382 else if(cprop->add){
1383 if(!(cprop->add->flag & FUNC_USE_CONTEXT)) { /* XXX check for this somewhere else */
1384 ParameterList *params= RNA_parameter_list_create(ptr, cprop->add);
1385 RNA_function_call(NULL, NULL, ptr, cprop->add, params);
1386 RNA_parameter_list_free(params);
1391 printf("RNA_property_collection_add %s.%s: not implemented for this property.\n", ptr->type->identifier, prop->identifier);
1395 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1397 r_ptr->data= IDP_GetIndexArray(idprop, idprop->len-1);
1398 r_ptr->type= cprop->type;
1399 rna_pointer_inherit_id(NULL, ptr, r_ptr);
1402 memset(r_ptr, 0, sizeof(*r_ptr));
1406 void RNA_property_collection_remove(PointerRNA *ptr, PropertyRNA *prop, int key)
1409 //CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1411 if((idprop=rna_idproperty_check(&prop, ptr))) {
1412 IDProperty tmp, *array;
1416 array= IDP_IDPArray(idprop);
1418 if(key >= 0 && key < len) {
1420 /* move element to be removed to the back */
1421 memcpy(&tmp, &array[key], sizeof(IDProperty));
1422 memmove(array+key, array+key+1, sizeof(IDProperty)*(len-key+1));
1423 memcpy(&array[len-1], &tmp, sizeof(IDProperty));
1426 IDP_ResizeIDPArray(idprop, len-1);
1429 else if(prop->flag & PROP_IDPROPERTY);
1431 else if(cprop->remove){
1432 if(!(cprop->remove->flag & FUNC_USE_CONTEXT)) { /* XXX check for this somewhere else */
1433 ParameterList *params= RNA_parameter_list_create(ptr, cprop->remove);
1434 RNA_function_call(NULL, NULL, ptr, cprop->remove, params);
1435 RNA_parameter_list_free(params);
1440 printf("RNA_property_collection_remove %s.%s: only supported for id properties.\n", ptr->type->identifier, prop->identifier);
1443 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop)
1447 if((idprop=rna_idproperty_check(&prop, ptr)))
1448 IDP_ResizeIDPArray(idprop, 0);
1451 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr)
1453 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1455 if(cprop->lookupint) {
1456 /* we have a callback defined, use it */
1457 *r_ptr= cprop->lookupint(ptr, key);
1458 return (r_ptr->data != NULL);
1461 /* no callback defined, just iterate and find the nth item */
1462 CollectionPropertyIterator iter;
1465 RNA_property_collection_begin(ptr, prop, &iter);
1466 for(i=0; iter.valid; RNA_property_collection_next(&iter), i++) {
1472 RNA_property_collection_end(&iter);
1475 memset(r_ptr, 0, sizeof(*r_ptr));
1481 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr)
1483 CollectionPropertyRNA *cprop= (CollectionPropertyRNA*)prop;
1485 if(cprop->lookupstring) {
1486 /* we have a callback defined, use it */
1487 *r_ptr= cprop->lookupstring(ptr, key);
1488 return (r_ptr->data != NULL);
1491 /* no callback defined, compare with name properties if they exist */
1492 CollectionPropertyIterator iter;
1493 PropertyRNA *nameprop;
1494 char name[256], *nameptr;
1497 RNA_property_collection_begin(ptr, prop, &iter);
1498 for(; iter.valid; RNA_property_collection_next(&iter)) {
1499 if(iter.ptr.data && iter.ptr.type->nameproperty) {
1500 nameprop= iter.ptr.type->nameproperty;
1502 nameptr= RNA_property_string_get_alloc(&iter.ptr, nameprop, name, sizeof(name));
1504 if(strcmp(nameptr, key) == 0) {
1509 if((char *)&name != nameptr)
1516 RNA_property_collection_end(&iter);
1519 memset(r_ptr, 0, sizeof(*r_ptr));
1525 /* Standard iterator functions */
1527 void rna_iterator_listbase_begin(CollectionPropertyIterator *iter, ListBase *lb, IteratorSkipFunc skip)
1529 ListBaseIterator *internal;
1531 internal= MEM_callocN(sizeof(ListBaseIterator), "ListBaseIterator");
1532 internal->link= (lb)? lb->first: NULL;
1533 internal->skip= skip;
1535 iter->internal= internal;
1536 iter->valid= (internal->link != NULL);
1538 if(skip && iter->valid && skip(iter, internal->link))
1539 rna_iterator_listbase_next(iter);
1542 void rna_iterator_listbase_next(CollectionPropertyIterator *iter)
1544 ListBaseIterator *internal= iter->internal;
1546 if(internal->skip) {
1548 internal->link= internal->link->next;
1549 iter->valid= (internal->link != NULL);
1550 } while(iter->valid && internal->skip(iter, internal->link));
1553 internal->link= internal->link->next;
1554 iter->valid= (internal->link != NULL);
1558 void *rna_iterator_listbase_get(CollectionPropertyIterator *iter)
1560 ListBaseIterator *internal= iter->internal;
1562 return internal->link;
1565 void rna_iterator_listbase_end(CollectionPropertyIterator *iter)
1567 MEM_freeN(iter->internal);
1568 iter->internal= NULL;
1571 void rna_iterator_array_begin(CollectionPropertyIterator *iter, void *ptr, int itemsize, int length, IteratorSkipFunc skip)
1573 ArrayIterator *internal;
1578 internal= MEM_callocN(sizeof(ArrayIterator), "ArrayIterator");
1580 internal->endptr= ((char*)ptr)+length*itemsize;
1581 internal->itemsize= itemsize;
1582 internal->skip= skip;
1584 iter->internal= internal;
1585 iter->valid= (internal->ptr != internal->endptr);
1587 if(skip && iter->valid && skip(iter, internal->ptr))
1588 rna_iterator_array_next(iter);
1591 void rna_iterator_array_next(CollectionPropertyIterator *iter)
1593 ArrayIterator *internal= iter->internal;
1595 if(internal->skip) {
1597 internal->ptr += internal->itemsize;
1598 iter->valid= (internal->ptr != internal->endptr);
1599 } while(iter->valid && internal->skip(iter, internal->ptr));
1602 internal->ptr += internal->itemsize;
1603 iter->valid= (internal->ptr != internal->endptr);
1607 void *rna_iterator_array_get(CollectionPropertyIterator *iter)
1609 ArrayIterator *internal= iter->internal;
1611 return internal->ptr;
1614 void *rna_iterator_array_dereference_get(CollectionPropertyIterator *iter)
1616 ArrayIterator *internal= iter->internal;
1619 return *(void**)(internal->ptr);
1622 void rna_iterator_array_end(CollectionPropertyIterator *iter)
1624 MEM_freeN(iter->internal);
1625 iter->internal= NULL;
1628 /* RNA Path - Experiment */
1630 static char *rna_path_token(const char **path, char *fixedbuf, int fixedlen, int bracket)
1634 int i, j, len, escape;
1639 /* get data between [], check escaping ] with \] */
1640 if(**path == '[') (*path)++;
1646 while(*p && (*p != ']' || escape)) {
1647 escape= (*p == '\\');
1652 if(*p != ']') return NULL;
1655 /* get data until . or [ */
1658 while(*p && *p != '.' && *p != '[') {
1668 /* try to use fixed buffer if possible */
1669 if(len+1 < fixedlen)
1672 buf= MEM_callocN(sizeof(char)*(len+1), "rna_path_token");
1674 /* copy string, taking into account escaped ] */
1676 for(p=*path, i=0, j=0; i<len; i++, p++) {
1677 if(*p == '\\' && *(p+1) == ']');
1684 memcpy(buf, *path, sizeof(char)*len);
1688 /* set path to start of next token */
1696 int RNA_path_resolve(PointerRNA *ptr, const char *path, PointerRNA *r_ptr, PropertyRNA **r_prop)
1699 PointerRNA curptr, nextptr;
1700 char fixedbuf[256], *token;
1707 /* look up property name in current struct */
1708 token= rna_path_token(&path, fixedbuf, sizeof(fixedbuf), 0);
1713 prop= RNA_struct_find_property(&curptr, token);
1715 if(token != fixedbuf)
1721 /* now look up the value of this property if it is a pointer or
1722 * collection, otherwise return the property rna so that the
1723 * caller can read the value of the property itself */
1724 if(RNA_property_type(prop) == PROP_POINTER) {
1725 nextptr= RNA_property_pointer_get(&curptr, prop);
1732 else if(RNA_property_type(prop) == PROP_COLLECTION && *path) {
1733 /* resolve the lookup with [] brackets */
1734 token= rna_path_token(&path, fixedbuf, sizeof(fixedbuf), 1);
1741 /* check for "" to see if it is a string */
1742 if(len >= 2 && token[0] == '"' && token[len-1] == '"') {
1745 RNA_property_collection_lookup_string(&curptr, prop, token+1, &nextptr);
1748 /* otherwise do int lookup */
1749 intkey= atoi(token);
1750 RNA_property_collection_lookup_int(&curptr, prop, intkey, &nextptr);
1753 if(token != fixedbuf)
1769 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop, int intkey, const char *strkey)
1773 char appendstr[128], *result;
1775 dynstr= BLI_dynstr_new();
1777 /* add .identifier */
1779 BLI_dynstr_append(dynstr, (char*)path);
1781 BLI_dynstr_append(dynstr, ".");
1784 BLI_dynstr_append(dynstr, (char*)RNA_property_identifier(prop));
1786 if(RNA_property_type(prop) == PROP_COLLECTION) {
1787 /* add ["strkey"] or [intkey] */
1788 BLI_dynstr_append(dynstr, "[");
1791 BLI_dynstr_append(dynstr, "\"");
1792 for(s=strkey; *s; s++) {
1802 BLI_dynstr_append(dynstr, appendstr);
1804 BLI_dynstr_append(dynstr, "\"");
1807 sprintf(appendstr, "%d", intkey);
1808 BLI_dynstr_append(dynstr, appendstr);
1811 BLI_dynstr_append(dynstr, "]");
1814 result= BLI_dynstr_get_cstring(dynstr);
1815 BLI_dynstr_free(dynstr);
1820 char *RNA_path_back(const char *path)
1823 const char *previous, *current;
1824 char *result, *token;
1833 /* parse token by token until the end, then we back up to the previous
1834 * position and strip of the next token to get the path one step back */
1836 token= rna_path_token(¤t, fixedbuf, sizeof(fixedbuf), 0);
1840 if(token != fixedbuf)
1843 /* in case of collection we also need to strip off [] */
1844 token= rna_path_token(¤t, fixedbuf, sizeof(fixedbuf), 1);
1845 if(token && token != fixedbuf)
1857 /* copy and strip off last token */
1859 result= BLI_strdup(path);
1861 if(i > 0 && result[i-1] == '.') i--;
1867 char *RNA_path_from_ID_to_property(PointerRNA *ptr, PropertyRNA *prop)
1869 char *ptrpath=NULL, *path;
1870 const char *propname;
1872 if(!ptr->id.data || !ptr->data || !prop)
1875 if(!RNA_struct_is_ID(ptr->type)) {
1876 if(ptr->type->path) {
1877 /* if type has a path to some ID, use it */
1878 ptrpath= ptr->type->path(ptr);
1880 else if(ptr->type->nested) {
1881 PointerRNA parentptr;
1882 PropertyRNA *userprop;
1884 /* find the property in the struct we're nested in that references this struct, and
1885 * use its identifier as the first part of the path used...
1887 RNA_pointer_create(ptr->id.data, ptr->type->nested, ptr->data, &parentptr);
1888 userprop= RNA_struct_find_nested(&parentptr, ptr->type);
1891 ptrpath= BLI_strdup(RNA_property_identifier(userprop));
1893 return NULL; // can't do anything about this case yet...
1899 propname= RNA_property_identifier(prop);
1902 path= BLI_sprintfN("%s.%s", ptrpath, propname);
1906 path= BLI_strdup(propname);
1911 /* Quick name based property access */
1913 int RNA_boolean_get(PointerRNA *ptr, const char *name)
1915 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1918 return RNA_property_boolean_get(ptr, prop);
1921 printf("RNA_boolean_get: %s.%s not found.\n", ptr->type->identifier, name);
1926 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value)
1928 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1931 RNA_property_boolean_set(ptr, prop, value);
1933 printf("RNA_boolean_set: %s.%s not found.\n", ptr->type->identifier, name);
1936 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values)
1938 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1941 RNA_property_boolean_get_array(ptr, prop, values);
1943 printf("RNA_boolean_get_array: %s.%s not found.\n", ptr->type->identifier, name);
1946 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values)
1948 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1951 RNA_property_boolean_set_array(ptr, prop, values);
1953 printf("RNA_boolean_set_array: %s.%s not found.\n", ptr->type->identifier, name);
1956 int RNA_int_get(PointerRNA *ptr, const char *name)
1958 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1961 return RNA_property_int_get(ptr, prop);
1964 printf("RNA_int_get: %s.%s not found.\n", ptr->type->identifier, name);
1969 void RNA_int_set(PointerRNA *ptr, const char *name, int value)
1971 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1974 RNA_property_int_set(ptr, prop, value);
1976 printf("RNA_int_set: %s.%s not found.\n", ptr->type->identifier, name);
1979 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values)
1981 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1984 RNA_property_int_get_array(ptr, prop, values);
1986 printf("RNA_int_get_array: %s.%s not found.\n", ptr->type->identifier, name);
1989 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values)
1991 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
1994 RNA_property_int_set_array(ptr, prop, values);
1996 printf("RNA_int_set_array: %s.%s not found.\n", ptr->type->identifier, name);
1999 float RNA_float_get(PointerRNA *ptr, const char *name)
2001 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2004 return RNA_property_float_get(ptr, prop);
2007 printf("RNA_float_get: %s.%s not found.\n", ptr->type->identifier, name);
2012 void RNA_float_set(PointerRNA *ptr, const char *name, float value)
2014 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2017 RNA_property_float_set(ptr, prop, value);
2019 printf("RNA_float_set: %s.%s not found.\n", ptr->type->identifier, name);
2022 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values)
2024 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2027 RNA_property_float_get_array(ptr, prop, values);
2029 printf("RNA_float_get_array: %s.%s not found.\n", ptr->type->identifier, name);
2032 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values)
2034 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2037 RNA_property_float_set_array(ptr, prop, values);
2039 printf("RNA_float_set_array: %s.%s not found.\n", ptr->type->identifier, name);
2042 int RNA_enum_get(PointerRNA *ptr, const char *name)
2044 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2047 return RNA_property_enum_get(ptr, prop);
2050 printf("RNA_enum_get: %s.%s not found.\n", ptr->type->identifier, name);
2055 void RNA_enum_set(PointerRNA *ptr, const char *name, int value)
2057 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2060 RNA_property_enum_set(ptr, prop, value);
2062 printf("RNA_enum_set: %s.%s not found.\n", ptr->type->identifier, name);
2065 int RNA_enum_is_equal(PointerRNA *ptr, const char *name, const char *enumname)
2067 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2068 const EnumPropertyItem *item;
2071 RNA_property_enum_items(ptr, prop, &item, NULL);
2073 for(; item->identifier; item++)
2074 if(strcmp(item->identifier, enumname) == 0)
2075 return (item->value == RNA_property_enum_get(ptr, prop));
2077 printf("RNA_enum_is_equal: %s.%s item %s not found.\n", ptr->type->identifier, name, enumname);
2081 printf("RNA_enum_is_equal: %s.%s not found.\n", ptr->type->identifier, name);
2086 int RNA_enum_value_from_id(const EnumPropertyItem *item, const char *identifier, int *value)
2088 for( ; item->identifier; item++) {
2089 if(strcmp(item->identifier, identifier)==0) {
2090 *value= item->value;
2098 int RNA_enum_id_from_value(const EnumPropertyItem *item, int value, const char **identifier)
2100 for( ; item->identifier; item++) {
2101 if(item->value==value) {
2102 *identifier= item->identifier;
2112 void RNA_string_get(PointerRNA *ptr, const char *name, char *value)
2114 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2117 RNA_property_string_get(ptr, prop, value);
2119 printf("RNA_string_get: %s.%s not found.\n", ptr->type->identifier, name);
2122 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen)
2124 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2127 return RNA_property_string_get_alloc(ptr, prop, fixedbuf, fixedlen);
2130 printf("RNA_string_get_alloc: %s.%s not found.\n", ptr->type->identifier, name);
2135 int RNA_string_length(PointerRNA *ptr, const char *name)
2137 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2140 return RNA_property_string_length(ptr, prop);
2143 printf("RNA_string_length: %s.%s not found.\n", ptr->type->identifier, name);
2148 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value)
2150 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2153 RNA_property_string_set(ptr, prop, value);
2155 printf("RNA_string_set: %s.%s not found.\n", ptr->type->identifier, name);
2158 PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name)
2160 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2163 return RNA_property_pointer_get(ptr, prop);
2168 printf("RNA_pointer_get: %s.%s not found.\n", ptr->type->identifier, name);
2170 memset(&result, 0, sizeof(result));
2175 void RNA_pointer_add(PointerRNA *ptr, const char *name)
2177 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2180 RNA_property_pointer_add(ptr, prop);
2182 printf("RNA_pointer_set: %s.%s not found.\n", ptr->type->identifier, name);
2185 void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter)
2187 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2190 RNA_property_collection_begin(ptr, prop, iter);
2192 printf("RNA_collection_begin: %s.%s not found.\n", ptr->type->identifier, name);
2195 void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value)
2197 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2200 RNA_property_collection_add(ptr, prop, r_value);
2202 printf("RNA_collection_add: %s.%s not found.\n", ptr->type->identifier, name);
2205 void RNA_collection_clear(PointerRNA *ptr, const char *name)
2207 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2210 RNA_property_collection_clear(ptr, prop);
2212 printf("RNA_collection_clear: %s.%s not found.\n", ptr->type->identifier, name);
2215 int RNA_collection_length(PointerRNA *ptr, const char *name)
2217 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2220 return RNA_property_collection_length(ptr, prop);
2223 printf("RNA_collection_length: %s.%s not found.\n", ptr->type->identifier, name);
2228 int RNA_property_is_set(PointerRNA *ptr, const char *name)
2230 PropertyRNA *prop= RNA_struct_find_property(ptr, name);
2233 return (rna_idproperty_find(ptr, name) != NULL);
2236 printf("RNA_property_is_set: %s.%s not found.\n", ptr->type->identifier, name);
2241 /* string representation of a property, python
2242 * compatible but can be used for display too*/
2243 char *RNA_pointer_as_string(PointerRNA *ptr)
2245 DynStr *dynstr= BLI_dynstr_new();
2248 const char *propname;
2251 BLI_dynstr_append(dynstr, "{");
2253 RNA_STRUCT_BEGIN(ptr, prop) {
2254 propname = RNA_property_identifier(prop);
2256 if(strcmp(propname, "rna_type")==0)
2260 BLI_dynstr_append(dynstr, ", ");
2263 cstring = RNA_property_as_string(ptr, prop);
2264 BLI_dynstr_appendf(dynstr, "\"%s\":%s", propname, cstring);
2269 BLI_dynstr_append(dynstr, "}");
2272 cstring = BLI_dynstr_get_cstring(dynstr);
2273 BLI_dynstr_free(dynstr);
2277 char *RNA_property_as_string(PointerRNA *ptr, PropertyRNA *prop)
2279 int type = RNA_property_type(prop);
2280 int len = RNA_property_array_length(prop);
2283 DynStr *dynstr= BLI_dynstr_new();
2287 /* see if we can coorce into a python type - PropertyType */
2291 BLI_dynstr_append(dynstr, RNA_property_boolean_get(ptr, prop) ? "True" : "False");
2294 BLI_dynstr_append(dynstr, "(");
2295 for(i=0; i<len; i++) {
2296 BLI_dynstr_appendf(dynstr, i?", %s":"%s", RNA_property_boolean_get_index(ptr, prop, i) ? "True" : "False");
2298 BLI_dynstr_append(dynstr, ")");
2303 BLI_dynstr_appendf(dynstr, "%d", RNA_property_int_get(ptr, prop));
2306 BLI_dynstr_append(dynstr, "(");
2307 for(i=0; i<len; i++) {
2308 BLI_dynstr_appendf(dynstr, i?", %d":"%d", RNA_property_int_get_index(ptr, prop, i));
2310 BLI_dynstr_append(dynstr, ")");
2315 BLI_dynstr_appendf(dynstr, "%g", RNA_property_float_get(ptr, prop));
2318 BLI_dynstr_append(dynstr, "(");
2319 for(i=0; i<len; i++) {
2320 BLI_dynstr_appendf(dynstr, i?", %g":"%g", RNA_property_float_get_index(ptr, prop, i));
2322 BLI_dynstr_append(dynstr, ")");
2327 /* string arrays dont exist */
2329 buf = RNA_property_string_get_alloc(ptr, prop, NULL, -1);
2330 BLI_dynstr_appendf(dynstr, "\"%s\"", buf);
2336 /* string arrays dont exist */
2337 const char *identifier;
2338 int val = RNA_property_enum_get(ptr, prop);
2340 if(RNA_property_enum_identifier(ptr, prop, val, &identifier)) {
2341 BLI_dynstr_appendf(dynstr, "'%s'", identifier);
2344 BLI_dynstr_appendf(dynstr, "'<UNKNOWN ENUM>'", identifier);
2350 BLI_dynstr_append(dynstr, "'<POINTER>'"); /* TODO */
2353 case PROP_COLLECTION:
2356 CollectionPropertyIterator collect_iter;
2357 BLI_dynstr_append(dynstr, "[");
2359 for(RNA_property_collection_begin(ptr, prop, &collect_iter); collect_iter.valid; RNA_property_collection_next(&collect_iter)) {
2360 PointerRNA itemptr= collect_iter.ptr;
2363 BLI_dynstr_append(dynstr, ", ");
2366 /* now get every prop of the collection */
2367 cstring= RNA_pointer_as_string(&itemptr);
2368 BLI_dynstr_append(dynstr, cstring);
2372 RNA_property_collection_end(&collect_iter);
2373 BLI_dynstr_append(dynstr, "]");
2377 BLI_dynstr_append(dynstr, "'<UNKNOWN TYPE>'"); /* TODO */
2381 cstring = BLI_dynstr_get_cstring(dynstr);
2382 BLI_dynstr_free(dynstr);
2388 const char *RNA_function_identifier(FunctionRNA *func)
2390 return func->identifier;
2393 PropertyRNA *RNA_function_return(FunctionRNA *func)
2398 const char *RNA_function_ui_description(FunctionRNA *func)
2400 return func->description;
2403 int RNA_function_flag(FunctionRNA *func)
2408 PropertyRNA *RNA_function_get_parameter(PointerRNA *ptr, FunctionRNA *func, int index)
2413 parm= func->cont.properties.first;
2414 for(i= 0; parm; parm= parm->next, i++)
2421 PropertyRNA *RNA_function_find_parameter(PointerRNA *ptr, FunctionRNA *func, const char *identifier)
2425 parm= func->cont.properties.first;
2426 for(; parm; parm= parm->next)
2427 if(strcmp(parm->identifier, identifier)==0)
2433 const struct ListBase *RNA_function_defined_parameters(FunctionRNA *func)
2435 return &func->cont.properties;
2440 ParameterList *RNA_parameter_list_create(PointerRNA *ptr, FunctionRNA *func)
2442 ParameterList *parms;
2446 parms= MEM_callocN(sizeof(ParameterList), "ParameterList");
2448 parm= func->cont.properties.first;
2449 for(tot= 0; parm; parm= parm->next)
2450 tot+= rna_parameter_size(parm);
2452 parms->data= MEM_callocN(tot, "RNA_parameter_list_create");
2458 void RNA_parameter_list_free(ParameterList *parms)
2460 MEM_freeN(parms->data);
2468 void RNA_parameter_list_begin(ParameterList *parms, ParameterIterator *iter)
2472 RNA_pointer_create(NULL, &RNA_Function, parms->func, &iter->funcptr);
2475 iter->parm= parms->func->cont.properties.first;
2476 iter->valid= iter->parm != NULL;
2480 iter->size= rna_parameter_size(iter->parm);
2481 iter->data= (((char*)iter->parms->data)+iter->offset);
2482 ptype= RNA_property_type(iter->parm);
2486 void RNA_parameter_list_next(ParameterIterator *iter)
2490 iter->offset+= iter->size;
2491 iter->parm= iter->parm->next;
2492 iter->valid= iter->parm != NULL;
2495 iter->size= rna_parameter_size(iter->parm);
2496 iter->data= (((char*)iter->parms->data)+iter->offset);
2497 ptype= RNA_property_type(iter->parm);
2501 void RNA_parameter_list_end(ParameterIterator *iter)
2506 void RNA_parameter_get(ParameterList *parms, PropertyRNA *parm, void **value)
2508 ParameterIterator iter;
2510 RNA_parameter_list_begin(parms, &iter);
2512 for(; iter.valid; RNA_parameter_list_next(&iter))
2521 RNA_parameter_list_end(&iter);
2524 void RNA_parameter_get_lookup(ParameterList *parms, const char *identifier, void **value)
2528 parm= parms->func->cont.properties.first;
2529 for(; parm; parm= parm->next)
2530 if(strcmp(RNA_property_identifier(parm), identifier)==0)
2534 RNA_parameter_get(parms, parm, value);
2537 void RNA_parameter_set(ParameterList *parms, PropertyRNA *parm, void *value)
2539 ParameterIterator iter;
2541 RNA_parameter_list_begin(parms, &iter);
2543 for(; iter.valid; RNA_parameter_list_next(&iter))
2548 memcpy(iter.data, value, iter.size);
2550 RNA_parameter_list_end(&iter);
2553 void RNA_parameter_set_lookup(ParameterList *parms, const char *identifier, void *value)
2557 parm= parms->func->cont.properties.first;
2558 for(; parm; parm= parm->next)
2559 if(strcmp(RNA_property_identifier(parm), identifier)==0)
2563 RNA_parameter_set(parms, parm, value);
2566 int RNA_function_call(bContext *C, ReportList *reports, PointerRNA *ptr, FunctionRNA *func, ParameterList *parms)
2569 func->call(C, reports, ptr, parms);
2577 int RNA_function_call_lookup(bContext *C, ReportList *reports, PointerRNA *ptr, const char *identifier, ParameterList *parms)
2581 func= RNA_struct_find_function(ptr, identifier);
2584 return RNA_function_call(C, reports, ptr, func, parms);
2589 int RNA_function_call_direct(bContext *C, ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, ...)
2594 va_start(args, format);
2596 ret= RNA_function_call_direct_va(C, reports, ptr, func, format, args);
2603 int RNA_function_call_direct_lookup(bContext *C, ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, ...)
2607 func= RNA_struct_find_function(ptr, identifier);
2613 va_start(args, format);
2615 ret= RNA_function_call_direct_va(C, reports, ptr, func, format, args);
2625 static int rna_function_format_array_length(const char *format, int ofs, int flen)
2630 if (format[ofs++]=='[')
2631 for (; ofs<flen && format[ofs]!=']' && idx<sizeof(*lenbuf)-1; idx++, ofs++)
2632 lenbuf[idx]= format[ofs];
2634 if (ofs<flen && format[ofs++]==']') {
2635 /* XXX put better error reporting for ofs>=flen or idx over lenbuf capacity */
2637 return atoi(lenbuf);
2643 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)
2645 /* ptr is always a function pointer, prop always a parameter */
2651 fprintf(stderr, "%s.%s: wrong type for parameter %s, a boolean was expected\n", tid, fid, pid);
2656 *((int*)dest)= *((int*)src);
2658 memcpy(dest, src, len*sizeof(int));
2665 fprintf(stderr, "%s.%s: wrong type for parameter %s, an integer was expected\n", tid, fid, pid);
2670 *((int*)dest)= *((int*)src);
2672 memcpy(dest, src, len*sizeof(int));
2679 fprintf(stderr, "%s.%s: wrong type for parameter %s, a float was expected\n", tid, fid, pid);
2684 *((float*)dest)= *((float*)src);
2686 memcpy(dest, src, len*sizeof(float));
2693 fprintf(stderr, "%s.%s: wrong type for parameter %s, a string was expected\n", tid, fid, pid);
2697 *((char**)dest)= *((char**)src);
2704 fprintf(stderr, "%s.%s: wrong type for parameter %s, an enum was expected\n", tid, fid, pid);
2708 *((int*)dest)= *((int*)src);
2717 fprintf(stderr, "%s.%s: wrong type for parameter %s, an object was expected\n", tid, fid, pid);
2721 ptype= RNA_property_pointer_type(ptr, prop);
2723 if(prop->flag & PROP_RNAPTR) {
2724 *((PointerRNA*)dest)= *((PointerRNA*)src);
2726 else if (ptype!=srna) {
2727 if (!RNA_struct_is_a(srna, ptype)) {
2728 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));
2732 *((void**)dest)= *((void**)src);
2737 case PROP_COLLECTION:
2739 /* XXX collections are not supported yet */
2740 fprintf(stderr, "%s.%s: for parameter %s, collections are not supported yet\n", tid, fid, pid);
2746 fprintf(stderr, "%s.%s: unknown type for parameter %s\n", tid, fid, pid);
2748 fprintf(stderr, "%s.%s: unknown array type for parameter %s\n", tid, fid, pid);
2757 int RNA_function_call_direct_va(bContext *C, ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, va_list args)
2760 ParameterList *parms;
2761 ParameterIterator iter;
2762 PropertyRNA *pret, *parm;
2764 int i, ofs, flen, flag, len, alen, err= 0;
2765 const char *tid, *fid, *pid=NULL;
2767 void **retdata=NULL;
2769 RNA_pointer_create(NULL, &RNA_Function, func, &funcptr);
2771 tid= RNA_struct_identifier(ptr->type);
2772 fid= RNA_function_identifier(func);
2773 pret= RNA_function_return(func);
2774 flen= strlen(format);
2776 parms= RNA_parameter_list_create(ptr, func);
2777 RNA_parameter_list_begin(parms, &iter);
2779 for(i= 0, ofs= 0; iter.valid; RNA_parameter_list_next(&iter), i++) {
2787 pid= RNA_property_identifier(parm);
2788 flag= RNA_property_flag(parm);
2790 if (ofs>=flen || format[ofs]=='N') {
2791 if (flag & PROP_REQUIRED) {
2793 fprintf(stderr, "%s.%s: missing required parameter %s\n", tid, fid, pid);
2800 type= RNA_property_type(parm);
2801 ftype= format[ofs++];
2802 len= RNA_property_array_length(parm);
2803 alen= rna_function_format_array_length(format, ofs, flen);
2807 fprintf(stderr, "%s.%s: for parameter %s, was expecting an array of %i elements, passed %i elements instead\n", tid, fid, pid, len, alen);
2816 int arg= va_arg(args, int);
2817 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, iter.data, &arg, NULL, tid, fid, pid);
2822 double arg= va_arg(args, double);
2823 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, iter.data, &arg, NULL, tid, fid, pid);
2828 char *arg= va_arg(args, char*);
2829 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, iter.data, &arg, NULL, tid, fid, pid);
2834 StructRNA *srna= va_arg(args, StructRNA*);
2835 void *arg= va_arg(args, void*);
2836 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, iter.data, &arg, srna, tid, fid, pid);
2842 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, iter.data, NULL, NULL, tid, fid, pid);
2852 err= RNA_function_call(C, reports, ptr, func, parms);
2854 /* XXX throw error when more parameters than those needed are passed or leave silent? */
2855 if (err==0 && pret && ofs<flen && format[ofs++]=='R') {
2858 type= RNA_property_type(parm);
2859 ftype= format[ofs++];
2860 len= RNA_property_array_length(parm);
2861 alen= rna_function_format_array_length(format, ofs, flen);
2865 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);
2873 int *arg= va_arg(args, int*);
2874 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, arg, retdata, NULL, tid, fid, pid);
2879 float *arg= va_arg(args, float*);
2880 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, arg, retdata, NULL, tid, fid, pid);
2885 char **arg= va_arg(args, char**);
2886 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, arg, retdata, NULL, tid, fid, pid);
2891 StructRNA *srna= va_arg(args, StructRNA*);
2892 void **arg= va_arg(args, void**);
2893 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, arg, retdata, srna, tid, fid, pid);
2899 err= rna_function_parameter_parse(&funcptr, parm, type, ftype, len, NULL, NULL, NULL, tid, fid, pid);
2906 RNA_parameter_list_end(&iter);
2907 RNA_parameter_list_free(parms);
2912 int RNA_function_call_direct_va_lookup(bContext *C, ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, va_list args)
2916 func= RNA_struct_find_function(ptr, identifier);
2919 return RNA_function_call_direct_va(C, reports, ptr, func, format, args);