use bool for rna funcs.
[blender.git] / source / blender / makesrna / intern / rna_access.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_access.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29 #include <stddef.h>
30 #include <string.h>
31 #include <ctype.h>
32
33 #include "MEM_guardedalloc.h"
34
35 #include "DNA_ID.h"
36 #include "DNA_scene_types.h"
37 #include "DNA_windowmanager_types.h"
38
39 #include "BLI_blenlib.h"
40 #include "BLI_utildefines.h"
41 #include "BLI_dynstr.h"
42 #include "BLI_ghash.h"
43 #include "BLI_math.h"
44
45 #include "BLF_api.h"
46 #include "BLF_translation.h"
47
48 #include "BKE_animsys.h"
49 #include "BKE_context.h"
50 #include "BKE_idcode.h"
51 #include "BKE_idprop.h"
52 #include "BKE_main.h"
53 #include "BKE_report.h"
54
55 #include "RNA_access.h"
56 #include "RNA_define.h"
57
58 #include "WM_api.h"
59
60 /* flush updates */
61 #include "DNA_object_types.h"
62 #include "BKE_depsgraph.h"
63 #include "WM_types.h"
64
65 #include "rna_internal.h"
66
67 const PointerRNA PointerRNA_NULL = {{NULL}};
68
69 /* Init/Exit */
70
71 void RNA_init(void)
72 {
73         StructRNA *srna;
74         PropertyRNA *prop;
75
76         for (srna = BLENDER_RNA.structs.first; srna; srna = srna->cont.next) {
77                 if (!srna->cont.prophash) {
78                         srna->cont.prophash = BLI_ghash_str_new("RNA_init gh");
79
80                         for (prop = srna->cont.properties.first; prop; prop = prop->next)
81                                 if (!(prop->flag & PROP_BUILTIN))
82                                         BLI_ghash_insert(srna->cont.prophash, (void *)prop->identifier, prop);
83                 }
84         }
85 }
86
87 void RNA_exit(void)
88 {
89         StructRNA *srna;
90         
91         RNA_property_update_cache_free();
92         
93         for (srna = BLENDER_RNA.structs.first; srna; srna = srna->cont.next) {
94                 if (srna->cont.prophash) {
95                         BLI_ghash_free(srna->cont.prophash, NULL, NULL);
96                         srna->cont.prophash = NULL;
97                 }
98         }
99
100         RNA_free(&BLENDER_RNA);
101 }
102
103 /* Pointer */
104
105 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr)
106 {
107         r_ptr->id.data = NULL;
108         r_ptr->type = &RNA_BlendData;
109         r_ptr->data = main;
110 }
111
112 void RNA_id_pointer_create(ID *id, PointerRNA *r_ptr)
113 {
114         StructRNA *type, *idtype = NULL;
115
116         if (id) {
117                 PointerRNA tmp = {{NULL}};
118                 tmp.data = id;
119                 idtype = rna_ID_refine(&tmp);
120                 
121                 while (idtype->refine) {
122                         type = idtype->refine(&tmp);
123
124                         if (type == idtype)
125                                 break;
126                         else
127                                 idtype = type;
128                 }
129         }
130         
131         r_ptr->id.data = id;
132         r_ptr->type = idtype;
133         r_ptr->data = id;
134 }
135
136 void RNA_pointer_create(ID *id, StructRNA *type, void *data, PointerRNA *r_ptr)
137 {
138 #if 0 /* UNUSED */
139         StructRNA *idtype = NULL;
140
141         if (id) {
142                 PointerRNA tmp = {{0}};
143                 tmp.data = id;
144                 idtype = rna_ID_refine(&tmp);
145         }
146 #endif
147
148         r_ptr->id.data = id;
149         r_ptr->type = type;
150         r_ptr->data = data;
151
152         if (data) {
153                 while (r_ptr->type && r_ptr->type->refine) {
154                         StructRNA *rtype = r_ptr->type->refine(r_ptr);
155
156                         if (rtype == r_ptr->type)
157                                 break;
158                         else
159                                 r_ptr->type = rtype;
160                 }
161         }
162 }
163
164 static void rna_pointer_inherit_id(StructRNA *type, PointerRNA *parent, PointerRNA *ptr)
165 {
166         if (type && type->flag & STRUCT_ID) {
167                 ptr->id.data = ptr->data;
168         }
169         else {
170                 ptr->id.data = parent->id.data;
171         }
172 }
173
174 void RNA_blender_rna_pointer_create(PointerRNA *r_ptr)
175 {
176         r_ptr->id.data = NULL;
177         r_ptr->type = &RNA_BlenderRNA;
178         r_ptr->data = &BLENDER_RNA;
179 }
180
181 PointerRNA rna_pointer_inherit_refine(PointerRNA *ptr, StructRNA *type, void *data)
182 {
183         if (data) {
184                 PointerRNA result;
185                 result.data = data;
186                 result.type = type;
187                 rna_pointer_inherit_id(type, ptr, &result);
188
189                 while (result.type->refine) {
190                         type = result.type->refine(&result);
191
192                         if (type == result.type)
193                                 break;
194                         else
195                                 result.type = type;
196                 }
197                 return result;
198         }
199         else {
200                 return PointerRNA_NULL;
201         }
202 }
203
204 /**/
205 void RNA_pointer_recast(PointerRNA *ptr, PointerRNA *r_ptr)
206 {
207 #if 0 /* works but this case if covered by more general code below. */
208         if (RNA_struct_is_ID(ptr->type)) {
209                 /* simple case */
210                 RNA_id_pointer_create(ptr->id.data, r_ptr);
211         }
212         else
213 #endif
214         {
215                 StructRNA *base;
216                 PointerRNA t_ptr;
217                 *r_ptr = *ptr; /* initialize as the same in case cant recast */
218
219                 for (base = ptr->type->base; base; base = base->base) {
220                         t_ptr = rna_pointer_inherit_refine(ptr, base, ptr->data);
221                         if (t_ptr.type && t_ptr.type != ptr->type) {
222                                 *r_ptr = t_ptr;
223                         }
224                 }
225         }
226 }
227
228 /* ID Properties */
229
230 static void rna_idproperty_touch(IDProperty *idprop)
231 {
232         /* so the property is seen as 'set' by rna */
233         idprop->flag &= ~IDP_FLAG_GHOST;
234 }
235
236 /* return a UI local ID prop definition for this prop */
237 static IDProperty *rna_idproperty_ui(PropertyRNA *prop)
238 {
239         IDProperty *idprop;
240
241         for (idprop = ((IDProperty *)prop)->prev; idprop; idprop = idprop->prev) {
242                 if (strcmp(RNA_IDP_UI, idprop->name) == 0)
243                         break;
244         }
245
246         if (idprop == NULL) {
247                 for (idprop = ((IDProperty *)prop)->next; idprop; idprop = idprop->next) {
248                         if (strcmp(RNA_IDP_UI, idprop->name) == 0)
249                                 break;
250                 }
251         }
252
253         if (idprop) {
254                 return IDP_GetPropertyTypeFromGroup(idprop, ((IDProperty *)prop)->name, IDP_GROUP);
255         }
256
257         return NULL;
258 }
259
260 IDProperty *RNA_struct_idprops(PointerRNA *ptr, bool create)
261 {
262         StructRNA *type = ptr->type;
263
264         if (type && type->idproperties)
265                 return type->idproperties(ptr, create);
266         
267         return NULL;
268 }
269
270 bool RNA_struct_idprops_check(StructRNA *srna)
271 {
272         return (srna && srna->idproperties);
273 }
274
275 static IDProperty *rna_idproperty_find(PointerRNA *ptr, const char *name)
276 {
277         IDProperty *group = RNA_struct_idprops(ptr, 0);
278
279         if (group)
280                 return IDP_GetPropertyFromGroup(group, name);
281
282         return NULL;
283 }
284
285 static int rna_ensure_property_array_length(PointerRNA *ptr, PropertyRNA *prop)
286 {
287         if (prop->magic == RNA_MAGIC) {
288                 int arraylen[RNA_MAX_ARRAY_DIMENSION];
289                 return (prop->getlength && ptr->data) ? prop->getlength(ptr, arraylen) : prop->totarraylength;
290         }
291         else {
292                 IDProperty *idprop = (IDProperty *)prop;
293
294                 if (idprop->type == IDP_ARRAY)
295                         return idprop->len;
296                 else
297                         return 0;
298         }
299 }
300
301 static bool rna_ensure_property_array_check(PropertyRNA *prop)
302 {
303         if (prop->magic == RNA_MAGIC) {
304                 return (prop->getlength || prop->totarraylength);
305         }
306         else {
307                 IDProperty *idprop = (IDProperty *)prop;
308
309                 return (idprop->type == IDP_ARRAY);
310         }
311 }
312
313 static void rna_ensure_property_multi_array_length(PointerRNA *ptr, PropertyRNA *prop, int length[])
314 {
315         if (prop->magic == RNA_MAGIC) {
316                 if (prop->getlength)
317                         prop->getlength(ptr, length);
318                 else
319                         memcpy(length, prop->arraylength, prop->arraydimension * sizeof(int));
320         }
321         else {
322                 IDProperty *idprop = (IDProperty *)prop;
323
324                 if (idprop->type == IDP_ARRAY)
325                         length[0] = idprop->len;
326                 else
327                         length[0] = 0;
328         }
329 }
330
331 static bool rna_idproperty_verify_valid(PointerRNA *ptr, PropertyRNA *prop, IDProperty *idprop)
332 {
333         /* this verifies if the idproperty actually matches the property
334          * description and otherwise removes it. this is to ensure that
335          * rna property access is type safe, e.g. if you defined the rna
336          * to have a certain array length you can count on that staying so */
337         
338         switch (idprop->type) {
339                 case IDP_IDPARRAY:
340                         if (prop->type != PROP_COLLECTION)
341                                 return false;
342                         break;
343                 case IDP_ARRAY:
344                         if (rna_ensure_property_array_length(ptr, prop) != idprop->len)
345                                 return false;
346
347                         if (idprop->subtype == IDP_FLOAT && prop->type != PROP_FLOAT)
348                                 return false;
349                         if (idprop->subtype == IDP_INT && !ELEM3(prop->type, PROP_BOOLEAN, PROP_INT, PROP_ENUM))
350                                 return false;
351
352                         break;
353                 case IDP_INT:
354                         if (!ELEM3(prop->type, PROP_BOOLEAN, PROP_INT, PROP_ENUM))
355                                 return false;
356                         break;
357                 case IDP_FLOAT:
358                 case IDP_DOUBLE:
359                         if (prop->type != PROP_FLOAT)
360                                 return false;
361                         break;
362                 case IDP_STRING:
363                         if (prop->type != PROP_STRING)
364                                 return false;
365                         break;
366                 case IDP_GROUP:
367                         if (prop->type != PROP_POINTER)
368                                 return false;
369                         break;
370                 default:
371                         return false;
372         }
373
374         return true;
375 }
376
377 static PropertyRNA *typemap[IDP_NUMTYPES] = {
378         (PropertyRNA *)&rna_PropertyGroupItem_string,
379         (PropertyRNA *)&rna_PropertyGroupItem_int,
380         (PropertyRNA *)&rna_PropertyGroupItem_float,
381         NULL, NULL, NULL,
382         (PropertyRNA *)&rna_PropertyGroupItem_group, NULL,
383         (PropertyRNA *)&rna_PropertyGroupItem_double,
384         (PropertyRNA *)&rna_PropertyGroupItem_idp_array
385 };
386
387 static PropertyRNA *arraytypemap[IDP_NUMTYPES] = {
388         NULL, (PropertyRNA *)&rna_PropertyGroupItem_int_array,
389         (PropertyRNA *)&rna_PropertyGroupItem_float_array,
390         NULL, NULL, NULL,
391         (PropertyRNA *)&rna_PropertyGroupItem_collection, NULL,
392         (PropertyRNA *)&rna_PropertyGroupItem_double_array
393 };
394
395 IDProperty *rna_idproperty_check(PropertyRNA **prop, PointerRNA *ptr)
396 {
397         /* This is quite a hack, but avoids some complexity in the API. we
398          * pass IDProperty structs as PropertyRNA pointers to the outside.
399          * We store some bytes in PropertyRNA structs that allows us to
400          * distinguish it from IDProperty structs. If it is an ID property,
401          * we look up an IDP PropertyRNA based on the type, and set the data
402          * pointer to the IDProperty. */
403
404         if ((*prop)->magic == RNA_MAGIC) {
405                 if ((*prop)->flag & PROP_IDPROPERTY) {
406                         IDProperty *idprop = rna_idproperty_find(ptr, (*prop)->identifier);
407
408                         if (idprop && !rna_idproperty_verify_valid(ptr, *prop, idprop)) {
409                                 IDProperty *group = RNA_struct_idprops(ptr, 0);
410
411                                 IDP_RemFromGroup(group, idprop);
412                                 IDP_FreeProperty(idprop);
413                                 MEM_freeN(idprop);
414                                 return NULL;
415                         }
416
417                         return idprop;
418                 }
419                 else
420                         return NULL;
421         }
422
423         {
424                 IDProperty *idprop = (IDProperty *)(*prop);
425
426                 if (idprop->type == IDP_ARRAY)
427                         *prop = arraytypemap[(int)(idprop->subtype)];
428                 else
429                         *prop = typemap[(int)(idprop->type)];
430
431                 return idprop;
432         }
433 }
434
435 static PropertyRNA *rna_ensure_property(PropertyRNA *prop)
436 {
437         /* the quick version if we don't need the idproperty */
438
439         if (prop->magic == RNA_MAGIC)
440                 return prop;
441
442         {
443                 IDProperty *idprop = (IDProperty *)prop;
444
445                 if (idprop->type == IDP_ARRAY)
446                         return arraytypemap[(int)(idprop->subtype)];
447                 else
448                         return typemap[(int)(idprop->type)];
449         }
450 }
451
452 static const char *rna_ensure_property_identifier(PropertyRNA *prop)
453 {
454         if (prop->magic == RNA_MAGIC)
455                 return prop->identifier;
456         else
457                 return ((IDProperty *)prop)->name;
458 }
459
460 static const char *rna_ensure_property_description(PropertyRNA *prop)
461 {
462         const char *description = NULL;
463
464         if (prop->magic == RNA_MAGIC)
465                 description = prop->description;
466         else {
467                 /* attempt to get the local ID values */
468                 IDProperty *idp_ui = rna_idproperty_ui(prop);
469
470                 if (idp_ui) {
471                         IDProperty *item = IDP_GetPropertyTypeFromGroup(idp_ui, "description", IDP_STRING);
472                         if (item)
473                                 description = IDP_String(item);
474                 }
475
476                 if (description == NULL)
477                         description = ((IDProperty *)prop)->name;  /* XXX - not correct */
478         }
479
480         return TIP_(description);
481 }
482
483 static const char *rna_ensure_property_name(PropertyRNA *prop)
484 {
485         const char *name;
486
487         if (prop->magic == RNA_MAGIC)
488                 name = prop->name;
489         else
490                 name = ((IDProperty *)prop)->name;
491
492         return CTX_IFACE_(prop->translation_context, name);
493 }
494
495 /* Structs */
496
497 StructRNA *RNA_struct_find(const char *identifier)
498 {
499         StructRNA *type;
500         if (identifier) {
501                 for (type = BLENDER_RNA.structs.first; type; type = type->cont.next)
502                         if (strcmp(type->identifier, identifier) == 0)
503                                 return type;
504         }
505         return NULL;
506 }
507
508 const char *RNA_struct_identifier(StructRNA *type)
509 {
510         return type->identifier;
511 }
512
513 const char *RNA_struct_ui_name(StructRNA *type)
514 {
515         return CTX_IFACE_(type->translation_context, type->name);
516 }
517
518 int RNA_struct_ui_icon(StructRNA *type)
519 {
520         if (type)
521                 return type->icon;
522         else
523                 return ICON_DOT;
524 }
525
526 const char *RNA_struct_ui_description(StructRNA *type)
527 {
528         return TIP_(type->description);
529 }
530
531 const char *RNA_struct_translation_context(StructRNA *type)
532 {
533         return type->translation_context ? type->translation_context : BLF_I18NCONTEXT_DEFAULT;
534 }
535
536 PropertyRNA *RNA_struct_name_property(StructRNA *type)
537 {
538         return type->nameproperty;
539 }
540
541 PropertyRNA *RNA_struct_iterator_property(StructRNA *type)
542 {
543         return type->iteratorproperty;
544 }
545
546 StructRNA *RNA_struct_base(StructRNA *type)
547 {
548         return type->base;
549 }
550
551 bool RNA_struct_is_ID(StructRNA *type)
552 {
553         return (type->flag & STRUCT_ID) != 0;
554 }
555
556 bool RNA_struct_undo_check(StructRNA *type)
557 {
558         return (type->flag & STRUCT_UNDO) != 0;
559 }
560
561 bool RNA_struct_idprops_register_check(StructRNA *type)
562 {
563         return (type->flag & STRUCT_NO_IDPROPERTIES) == 0;
564 }
565
566 /* remove an id-property */
567 bool RNA_struct_idprops_unset(PointerRNA *ptr, const char *identifier)
568 {
569         IDProperty *group = RNA_struct_idprops(ptr, 0);
570
571         if (group) {
572                 IDProperty *idp = IDP_GetPropertyFromGroup(group, identifier);
573                 if (idp) {
574                         IDP_RemFromGroup(group, idp);
575                         IDP_FreeProperty(idp);
576                         MEM_freeN(idp);
577
578                         return true;
579                 }
580         }
581         return false;
582 }
583
584 bool RNA_struct_is_a(StructRNA *type, StructRNA *srna)
585 {
586         StructRNA *base;
587
588         if (!type)
589                 return false;
590
591         /* ptr->type is always maximally refined */
592         for (base = type; base; base = base->base)
593                 if (base == srna)
594                         return true;
595         
596         return false;
597 }
598
599 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier)
600 {
601         if (identifier[0] == '[' && identifier[1] == '"') { /* "  (dummy comment to avoid confusing some
602                                                                  * function lists in text editors) */
603                 /* id prop lookup, not so common */
604                 PropertyRNA *r_prop = NULL;
605                 PointerRNA r_ptr; /* only support single level props */
606                 if (RNA_path_resolve(ptr, identifier, &r_ptr, &r_prop) && r_ptr.type == ptr->type && r_ptr.data == ptr->data)
607                         return r_prop;
608         }
609         else {
610                 /* most common case */
611                 PropertyRNA *iterprop = RNA_struct_iterator_property(ptr->type);
612                 PointerRNA propptr;
613
614                 if (RNA_property_collection_lookup_string(ptr, iterprop, identifier, &propptr))
615                         return propptr.data;
616         }
617         
618         return NULL;
619 }
620
621 /* Find the property which uses the given nested struct */
622 static PropertyRNA *RNA_struct_find_nested(PointerRNA *ptr, StructRNA *srna)
623 {
624         PropertyRNA *prop = NULL;
625
626         RNA_STRUCT_BEGIN(ptr, iprop)
627         {
628                 /* This assumes that there can only be one user of this nested struct */
629                 if (RNA_property_pointer_type(ptr, iprop) == srna) {
630                         prop = iprop;
631                         break;
632                 }
633         }
634         RNA_PROP_END;
635
636         return prop;
637 }
638
639 bool RNA_struct_contains_property(PointerRNA *ptr, PropertyRNA *prop_test)
640 {
641         /* note, prop_test could be freed memory, only use for comparison */
642
643         /* validate the RNA is ok */
644         PropertyRNA *iterprop;
645         bool found = false;
646
647         iterprop = RNA_struct_iterator_property(ptr->type);
648
649         RNA_PROP_BEGIN(ptr, itemptr, iterprop)
650         {
651                 /* PropertyRNA *prop = itemptr.data; */
652                 if (prop_test == (PropertyRNA *)itemptr.data) {
653                         found = true;
654                         break;
655                 }
656         }
657         RNA_PROP_END;
658
659         return found;
660 }
661
662 /* low level direct access to type->properties, note this ignores parent classes so should be used with care */
663 const struct ListBase *RNA_struct_type_properties(StructRNA *srna)
664 {
665         return &srna->cont.properties;
666 }
667
668 PropertyRNA *RNA_struct_type_find_property(StructRNA *srna, const char *identifier)
669 {
670         return BLI_findstring_ptr(&srna->cont.properties, identifier, offsetof(PropertyRNA, identifier));
671 }
672
673 FunctionRNA *RNA_struct_find_function(StructRNA *srna, const char *identifier)
674 {
675 #if 1
676         FunctionRNA *func;
677         StructRNA *type;
678         for (type = srna; type; type = type->base) {
679                 func = (FunctionRNA *)BLI_findstring_ptr(&type->functions, identifier, offsetof(FunctionRNA, identifier));
680                 if (func) {
681                         return func;
682                 }
683         }
684         return NULL;
685
686         /* funcitonal but slow */
687 #else
688         PointerRNA tptr;
689         PropertyRNA *iterprop;
690         FunctionRNA *func;
691
692         RNA_pointer_create(NULL, &RNA_Struct, srna, &tptr);
693         iterprop = RNA_struct_find_property(&tptr, "functions");
694
695         func = NULL;
696
697         RNA_PROP_BEGIN(&tptr, funcptr, iterprop)
698         {
699                 if (strcmp(identifier, RNA_function_identifier(funcptr.data)) == 0) {
700                         func = funcptr.data;
701                         break;
702                 }
703         }
704         RNA_PROP_END;
705
706         return func;
707 #endif
708 }
709
710 const ListBase *RNA_struct_type_functions(StructRNA *srna)
711 {
712         return &srna->functions;
713 }
714
715 StructRegisterFunc RNA_struct_register(StructRNA *type)
716 {
717         return type->reg;
718 }
719
720 StructUnregisterFunc RNA_struct_unregister(StructRNA *type)
721 {
722         do {
723                 if (type->unreg)
724                         return type->unreg;
725         } while ((type = type->base));
726
727         return NULL;
728 }
729
730 void **RNA_struct_instance(PointerRNA *ptr)
731 {
732         StructRNA *type = ptr->type;
733
734         do {
735                 if (type->instance)
736                         return type->instance(ptr);
737         } while ((type = type->base));
738
739         return NULL;
740 }
741
742 void *RNA_struct_py_type_get(StructRNA *srna)
743 {
744         return srna->py_type;
745 }
746
747 void RNA_struct_py_type_set(StructRNA *srna, void *py_type)
748 {
749         srna->py_type = py_type;
750 }
751
752 void *RNA_struct_blender_type_get(StructRNA *srna)
753 {
754         return srna->blender_type;
755 }
756
757 void RNA_struct_blender_type_set(StructRNA *srna, void *blender_type)
758 {
759         srna->blender_type = blender_type;
760 }
761
762 char *RNA_struct_name_get_alloc(PointerRNA *ptr, char *fixedbuf, int fixedlen, int *r_len)
763 {
764         PropertyRNA *nameprop;
765
766         if (ptr->data && (nameprop = RNA_struct_name_property(ptr->type)))
767                 return RNA_property_string_get_alloc(ptr, nameprop, fixedbuf, fixedlen, r_len);
768
769         return NULL;
770 }
771
772 /* Property Information */
773
774 const char *RNA_property_identifier(PropertyRNA *prop)
775 {
776         return rna_ensure_property_identifier(prop);
777 }
778
779 const char *RNA_property_description(PropertyRNA *prop)
780 {
781         return rna_ensure_property_description(prop);
782 }
783
784 PropertyType RNA_property_type(PropertyRNA *prop)
785 {
786         return rna_ensure_property(prop)->type;
787 }
788
789 PropertySubType RNA_property_subtype(PropertyRNA *prop)
790 {
791         return rna_ensure_property(prop)->subtype;
792 }
793
794 PropertyUnit RNA_property_unit(PropertyRNA *prop)
795 {
796         return RNA_SUBTYPE_UNIT(rna_ensure_property(prop)->subtype);
797 }
798
799 int RNA_property_flag(PropertyRNA *prop)
800 {
801         return rna_ensure_property(prop)->flag;
802 }
803
804 void *RNA_property_py_data_get(PropertyRNA *prop)
805 {
806         return prop->py_data;
807 }
808
809 int RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop)
810 {
811         return rna_ensure_property_array_length(ptr, prop);
812 }
813
814 bool RNA_property_array_check(PropertyRNA *prop)
815 {
816         return rna_ensure_property_array_check(prop);
817 }
818
819 /* used by BPY to make an array from the python object */
820 int RNA_property_array_dimension(PointerRNA *ptr, PropertyRNA *prop, int length[])
821 {
822         PropertyRNA *rprop = rna_ensure_property(prop);
823
824         if (length)
825                 rna_ensure_property_multi_array_length(ptr, prop, length);
826
827         return rprop->arraydimension;
828 }
829
830 /* Return the size of Nth dimension. */
831 int RNA_property_multi_array_length(PointerRNA *ptr, PropertyRNA *prop, int dim)
832 {
833         int len[RNA_MAX_ARRAY_DIMENSION];
834
835         rna_ensure_property_multi_array_length(ptr, prop, len);
836
837         return len[dim];
838 }
839
840 char RNA_property_array_item_char(PropertyRNA *prop, int index)
841 {
842         const char *vectoritem = "XYZW";
843         const char *quatitem = "WXYZ";
844         const char *coloritem = "RGBA";
845         PropertySubType subtype = rna_ensure_property(prop)->subtype;
846
847         BLI_assert(index >= 0);
848
849         /* get string to use for array index */
850         if ((index < 4) && ELEM(subtype, PROP_QUATERNION, PROP_AXISANGLE)) {
851                 return quatitem[index];
852         }
853         else if ((index < 4) && ELEM8(subtype, PROP_TRANSLATION, PROP_DIRECTION, PROP_XYZ, PROP_XYZ_LENGTH,
854                                       PROP_EULER, PROP_VELOCITY, PROP_ACCELERATION, PROP_COORDS))
855         {
856                 return vectoritem[index];
857         }
858         else if ((index < 4) && ELEM(subtype, PROP_COLOR, PROP_COLOR_GAMMA)) {
859                 return coloritem[index];
860         }
861
862         return '\0';
863 }
864
865 int RNA_property_array_item_index(PropertyRNA *prop, char name)
866 {
867         PropertySubType subtype = rna_ensure_property(prop)->subtype;
868
869         /* get index based on string name/alias */
870         /* maybe a function to find char index in string would be better than all the switches */
871         if (ELEM(subtype, PROP_QUATERNION, PROP_AXISANGLE)) {
872                 switch (name) {
873                         case 'w':
874                                 return 0;
875                         case 'x':
876                                 return 1;
877                         case 'y':
878                                 return 2;
879                         case 'z':
880                                 return 3;
881                 }
882         }
883         else if (ELEM6(subtype, PROP_TRANSLATION, PROP_DIRECTION, PROP_XYZ,
884                        PROP_EULER, PROP_VELOCITY, PROP_ACCELERATION))
885         {
886                 switch (name) {
887                         case 'x':
888                                 return 0;
889                         case 'y':
890                                 return 1;
891                         case 'z':
892                                 return 2;
893                         case 'w':
894                                 return 3;
895                 }
896         }
897         else if (ELEM(subtype, PROP_COLOR, PROP_COLOR_GAMMA)) {
898                 switch (name) {
899                         case 'r':
900                                 return 0;
901                         case 'g':
902                                 return 1;
903                         case 'b':
904                                 return 2;
905                         case 'a':
906                                 return 3;
907                 }
908         }
909
910         return -1;
911 }
912
913
914 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax)
915 {
916         IntPropertyRNA *iprop = (IntPropertyRNA *)rna_ensure_property(prop);
917         int softmin, softmax;
918
919         if (prop->magic != RNA_MAGIC) {
920                 /* attempt to get the local ID values */
921                 IDProperty *idp_ui = rna_idproperty_ui(prop);
922
923                 if (idp_ui) {
924                         IDProperty *item;
925
926                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "min", IDP_INT);
927                         *hardmin = item ? IDP_Int(item) : INT_MIN;
928
929                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "max", IDP_INT);
930                         *hardmax = item ? IDP_Int(item) : INT_MAX;
931
932                         return;
933                 }
934         }
935
936         if (iprop->range) {
937                 *hardmin = INT_MIN;
938                 *hardmax = INT_MAX;
939
940                 iprop->range(ptr, hardmin, hardmax, &softmin, &softmax);
941         }
942         else if (iprop->range_ex) {
943                 *hardmin = INT_MIN;
944                 *hardmax = INT_MAX;
945
946                 iprop->range_ex(ptr, prop, hardmin, hardmax, &softmin, &softmax);
947         }
948         else {
949                 *hardmin = iprop->hardmin;
950                 *hardmax = iprop->hardmax;
951         }
952 }
953
954 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step)
955 {
956         IntPropertyRNA *iprop = (IntPropertyRNA *)rna_ensure_property(prop);
957         int hardmin, hardmax;
958         
959         if (prop->magic != RNA_MAGIC) {
960                 /* attempt to get the local ID values */
961                 IDProperty *idp_ui = rna_idproperty_ui(prop);
962
963                 if (idp_ui) {
964                         IDProperty *item;
965
966                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "soft_min", IDP_INT);
967                         *softmin = item ? IDP_Int(item) : INT_MIN;
968
969                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "soft_max", IDP_INT);
970                         *softmax = item ? IDP_Int(item) : INT_MAX;
971
972                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "step", IDP_INT);
973                         *step = item ? IDP_Int(item) : 1;
974
975                         return;
976                 }
977         }
978
979         *softmin = iprop->softmin;
980         *softmax = iprop->softmax;
981
982         if (iprop->range) {
983                 hardmin = INT_MIN;
984                 hardmax = INT_MAX;
985
986                 iprop->range(ptr, &hardmin, &hardmax, softmin, softmax);
987
988                 *softmin = max_ii(*softmin, hardmin);
989                 *softmax = min_ii(*softmax, hardmax);
990         }
991         else if (iprop->range_ex) {
992                 hardmin = INT_MIN;
993                 hardmax = INT_MAX;
994
995                 iprop->range_ex(ptr, prop, &hardmin, &hardmax, softmin, softmax);
996
997                 *softmin = max_ii(*softmin, hardmin);
998                 *softmax = min_ii(*softmax, hardmax);
999         }
1000
1001         *step = iprop->step;
1002 }
1003
1004 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax)
1005 {
1006         FloatPropertyRNA *fprop = (FloatPropertyRNA *)rna_ensure_property(prop);
1007         float softmin, softmax;
1008
1009         if (prop->magic != RNA_MAGIC) {
1010                 /* attempt to get the local ID values */
1011                 IDProperty *idp_ui = rna_idproperty_ui(prop);
1012
1013                 if (idp_ui) {
1014                         IDProperty *item;
1015
1016                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "min", IDP_DOUBLE);
1017                         *hardmin = item ? (float)IDP_Double(item) : -FLT_MAX;
1018
1019                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "max", IDP_DOUBLE);
1020                         *hardmax = item ? (float)IDP_Double(item) : FLT_MAX;
1021
1022                         return;
1023                 }
1024         }
1025
1026         if (fprop->range) {
1027                 *hardmin = -FLT_MAX;
1028                 *hardmax = FLT_MAX;
1029
1030                 fprop->range(ptr, hardmin, hardmax, &softmin, &softmax);
1031         }
1032         else if (fprop->range_ex) {
1033                 *hardmin = -FLT_MAX;
1034                 *hardmax = FLT_MAX;
1035
1036                 fprop->range_ex(ptr, prop, hardmin, hardmax, &softmin, &softmax);
1037         }
1038         else {
1039                 *hardmin = fprop->hardmin;
1040                 *hardmax = fprop->hardmax;
1041         }
1042 }
1043
1044 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax,
1045                                  float *step, float *precision)
1046 {
1047         FloatPropertyRNA *fprop = (FloatPropertyRNA *)rna_ensure_property(prop);
1048         float hardmin, hardmax;
1049
1050         if (prop->magic != RNA_MAGIC) {
1051                 /* attempt to get the local ID values */
1052                 IDProperty *idp_ui = rna_idproperty_ui(prop);
1053
1054                 if (idp_ui) {
1055                         IDProperty *item;
1056
1057                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "soft_min", IDP_DOUBLE);
1058                         *softmin = item ? (float)IDP_Double(item) : -FLT_MAX;
1059
1060                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "soft_max", IDP_DOUBLE);
1061                         *softmax = item ? (float)IDP_Double(item) : FLT_MAX;
1062
1063                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "step", IDP_DOUBLE);
1064                         *step = item ? (float)IDP_Double(item) : 1.0f;
1065
1066                         item = IDP_GetPropertyTypeFromGroup(idp_ui, "precision", IDP_DOUBLE);
1067                         *precision = item ? (float)IDP_Double(item) : 3.0f;
1068
1069                         return;
1070                 }
1071         }
1072
1073         *softmin = fprop->softmin;
1074         *softmax = fprop->softmax;
1075
1076         if (fprop->range) {
1077                 hardmin = -FLT_MAX;
1078                 hardmax = FLT_MAX;
1079
1080                 fprop->range(ptr, &hardmin, &hardmax, softmin, softmax);
1081
1082                 *softmin = max_ff(*softmin, hardmin);
1083                 *softmax = min_ff(*softmax, hardmax);
1084         }
1085         else if (fprop->range_ex) {
1086                 hardmin = -FLT_MAX;
1087                 hardmax = FLT_MAX;
1088
1089                 fprop->range_ex(ptr, prop, &hardmin, &hardmax, softmin, softmax);
1090
1091                 *softmin = max_ff(*softmin, hardmin);
1092                 *softmax = min_ff(*softmax, hardmax);
1093         }
1094
1095         *step = fprop->step;
1096         *precision = (float)fprop->precision;
1097 }
1098
1099 int RNA_property_float_clamp(PointerRNA *ptr, PropertyRNA *prop, float *value)
1100 {
1101         float min, max;
1102
1103         RNA_property_float_range(ptr, prop, &min, &max);
1104
1105         if (*value < min) {
1106                 *value = min;
1107                 return -1;
1108         }
1109         else if (*value > max) {
1110                 *value = max;
1111                 return 1;
1112         }
1113         else {
1114                 return 0;
1115         }
1116 }
1117
1118 int RNA_property_int_clamp(PointerRNA *ptr, PropertyRNA *prop, int *value)
1119 {
1120         int min, max;
1121
1122         RNA_property_int_range(ptr, prop, &min, &max);
1123
1124         if (*value < min) {
1125                 *value = min;
1126                 return -1;
1127         }
1128         else if (*value > max) {
1129                 *value = max;
1130                 return 1;
1131         }
1132         else {
1133                 return 0;
1134         }
1135 }
1136
1137 /* this is the max length including \0 terminator.
1138  * '0' used when their is no maximum */
1139 int RNA_property_string_maxlength(PropertyRNA *prop)
1140 {
1141         StringPropertyRNA *sprop = (StringPropertyRNA *)rna_ensure_property(prop);
1142         return sprop->maxlength;
1143 }
1144
1145 StructRNA *RNA_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop)
1146 {
1147         prop = rna_ensure_property(prop);
1148
1149         if (prop->type == PROP_POINTER) {
1150                 PointerPropertyRNA *pprop = (PointerPropertyRNA *)prop;
1151
1152                 if (pprop->typef)
1153                         return pprop->typef(ptr);
1154                 else if (pprop->type)
1155                         return pprop->type;
1156         }
1157         else if (prop->type == PROP_COLLECTION) {
1158                 CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)prop;
1159
1160                 if (cprop->item_type)
1161                         return cprop->item_type;
1162         }
1163         /* ignore other types, RNA_struct_find_nested calls with unchecked props */
1164
1165         return &RNA_UnknownType;
1166 }
1167
1168 int RNA_property_pointer_poll(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *value)
1169 {
1170         prop = rna_ensure_property(prop);
1171
1172         if (prop->type == PROP_POINTER) {
1173                 PointerPropertyRNA *pprop = (PointerPropertyRNA *)prop;
1174                 if (pprop->poll)
1175                         return pprop->poll(ptr, *value);
1176
1177                 return 1;
1178         }
1179
1180         printf("%s %s: is not a pointer property.\n", __func__, prop->identifier);
1181         return 0;
1182 }
1183
1184 /* Reuse for dynamic types  */
1185 EnumPropertyItem DummyRNA_NULL_items[] = {
1186         {0, NULL, 0, NULL, NULL}
1187 };
1188
1189 /* Reuse for dynamic types with default value */
1190 EnumPropertyItem DummyRNA_DEFAULT_items[] = {
1191         {0, "DEFAULT", 0, "Default", ""},
1192         {0, NULL, 0, NULL, NULL}
1193 };
1194
1195 void RNA_property_enum_items(bContext *C, PointerRNA *ptr, PropertyRNA *prop, EnumPropertyItem **item,
1196                              int *totitem, int *free)
1197 {
1198         EnumPropertyRNA *eprop = (EnumPropertyRNA *)rna_ensure_property(prop);
1199
1200         *free = 0;
1201
1202         if (eprop->itemf && (C != NULL || (prop->flag & PROP_ENUM_NO_CONTEXT))) {
1203                 int tot = 0;
1204
1205                 if (prop->flag & PROP_ENUM_NO_CONTEXT)
1206                         *item = eprop->itemf(NULL, ptr, prop, free);
1207                 else
1208                         *item = eprop->itemf(C, ptr, prop, free);
1209
1210                 if (totitem) {
1211                         if (*item) {
1212                                 for (; (*item)[tot].identifier; tot++) ;
1213                         }
1214
1215                         *totitem = tot;
1216                 }
1217
1218         }
1219         else {
1220                 *item = eprop->item;
1221                 if (totitem)
1222                         *totitem = eprop->totitem;
1223         }
1224 }
1225
1226 void RNA_property_enum_items_gettexted(bContext *C, PointerRNA *ptr, PropertyRNA *prop,
1227                                        EnumPropertyItem **item, int *totitem, int *free)
1228 {
1229         RNA_property_enum_items(C, ptr, prop, item, totitem, free);
1230
1231 #ifdef WITH_INTERNATIONAL
1232         {
1233                 int i;
1234                 /* Note: Only do those tests once, and then use BLF_pgettext. */
1235                 int do_iface = BLF_translate_iface();
1236                 int do_tooltip = BLF_translate_tooltips();
1237                 EnumPropertyItem *nitem;
1238
1239                 if (!(do_iface || do_tooltip))
1240                         return;
1241
1242                 if (*free) {
1243                         nitem = *item;
1244                 }
1245                 else {
1246                         int totitem = 0;
1247
1248                         /* count */
1249                         for (i = 0; (*item)[i].identifier; i++)
1250                                 totitem++;
1251
1252                         nitem = MEM_callocN(sizeof(EnumPropertyItem) * (totitem + 1), "enum_items_gettexted");
1253
1254                         for (i = 0; (*item)[i].identifier; i++)
1255                                 nitem[i] = (*item)[i];
1256
1257                         *free = TRUE;
1258                 }
1259
1260                 for (i = 0; nitem[i].identifier; i++) {
1261                         if (nitem[i].name && do_iface) {
1262                                 /* note: prop->translation_context may be NULL, this just means we use the default "" context */
1263                                 nitem[i].name = BLF_pgettext(prop->translation_context, nitem[i].name);
1264                         }
1265                         if (nitem[i].description && do_tooltip) {
1266                                 nitem[i].description = BLF_pgettext(NULL, nitem[i].description);
1267                         }
1268                 }
1269
1270                 *item = nitem;
1271         }
1272 #endif
1273 }
1274
1275
1276 bool RNA_property_enum_value(bContext *C, PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *r_value)
1277 {
1278         EnumPropertyItem *item, *item_array;
1279         int free;
1280         bool found;
1281
1282         RNA_property_enum_items(C, ptr, prop, &item_array, NULL, &free);
1283
1284         if (item_array) {
1285                 for (item = item_array; item->identifier; item++) {
1286                         if (item->identifier[0] && strcmp(item->identifier, identifier) == 0) {
1287                                 *r_value = item->value;
1288                                 break;
1289                         }
1290                 }
1291
1292                 found = (item->identifier != NULL); /* could be alloc'd, assign before free */
1293
1294                 if (free) {
1295                         MEM_freeN(item_array);
1296                 }
1297         }
1298         else {
1299                 found = false;
1300         }
1301         return found;
1302 }
1303
1304 bool RNA_enum_identifier(EnumPropertyItem *item, const int value, const char **identifier)
1305 {
1306         for (; item->identifier; item++) {
1307                 if (item->identifier[0] && item->value == value) {
1308                         *identifier = item->identifier;
1309                         return true;
1310                 }
1311         }
1312         return false;
1313 }
1314
1315 int RNA_enum_bitflag_identifiers(EnumPropertyItem *item, const int value, const char **r_identifier)
1316 {
1317         int index = 0;
1318         for (; item->identifier; item++) {
1319                 if (item->identifier[0] && item->value & value) {
1320                         r_identifier[index++] = item->identifier;
1321                 }
1322         }
1323         r_identifier[index] = NULL;
1324         return index;
1325 }
1326
1327 bool RNA_enum_name(EnumPropertyItem *item, const int value, const char **r_name)
1328 {
1329         for (; item->identifier; item++) {
1330                 if (item->identifier[0] && item->value == value) {
1331                         *r_name = item->name;
1332                         return true;
1333                 }
1334         }
1335         return false;
1336 }
1337
1338 bool RNA_enum_description(EnumPropertyItem *item, const int value, const char **r_description)
1339 {
1340         for (; item->identifier; item++) {
1341                 if (item->identifier[0] && item->value == value) {
1342                         *r_description = item->description;
1343                         return true;
1344                 }
1345         }
1346         return false;
1347 }
1348
1349 bool RNA_property_enum_identifier(bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value,
1350                                   const char **identifier)
1351 {
1352         EnumPropertyItem *item = NULL;
1353         int free;
1354         
1355         RNA_property_enum_items(C, ptr, prop, &item, NULL, &free);
1356         if (item) {
1357                 bool result;
1358                 result = RNA_enum_identifier(item, value, identifier);
1359                 if (free)
1360                         MEM_freeN(item);
1361
1362                 return result;
1363         }
1364         return false;
1365 }
1366
1367 bool RNA_property_enum_name(bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **name)
1368 {
1369         EnumPropertyItem *item = NULL;
1370         int free;
1371         
1372         RNA_property_enum_items(C, ptr, prop, &item, NULL, &free);
1373         if (item) {
1374                 bool result;
1375                 result = RNA_enum_name(item, value, name);
1376                 if (free)
1377                         MEM_freeN(item);
1378                 
1379                 return result;
1380         }
1381         return false;
1382 }
1383
1384 int RNA_property_enum_bitflag_identifiers(bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value,
1385                                           const char **identifier)
1386 {
1387         EnumPropertyItem *item = NULL;
1388         int free;
1389
1390         RNA_property_enum_items(C, ptr, prop, &item, NULL, &free);
1391         if (item) {
1392                 int result;
1393                 result = RNA_enum_bitflag_identifiers(item, value, identifier);
1394                 if (free)
1395                         MEM_freeN(item);
1396
1397                 return result;
1398         }
1399         return 0;
1400 }
1401
1402 const char *RNA_property_ui_name(PropertyRNA *prop)
1403 {
1404         return rna_ensure_property_name(prop);
1405 }
1406
1407 const char *RNA_property_ui_description(PropertyRNA *prop)
1408 {
1409         return rna_ensure_property_description(prop);
1410 }
1411
1412 const char *RNA_property_translation_context(PropertyRNA *_prop)
1413 {
1414         PropertyRNA *prop = rna_ensure_property(_prop);
1415         return prop->translation_context ? prop->translation_context : BLF_I18NCONTEXT_DEFAULT;
1416 }
1417
1418 int RNA_property_ui_icon(PropertyRNA *prop)
1419 {
1420         return rna_ensure_property(prop)->icon;
1421 }
1422
1423 bool RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop)
1424 {
1425         ID *id = ptr->id.data;
1426         int flag;
1427
1428         prop = rna_ensure_property(prop);
1429         flag = prop->editable ? prop->editable(ptr) : prop->flag;
1430         return (flag & PROP_EDITABLE) && (!id || !id->lib || (prop->flag & PROP_LIB_EXCEPTION));
1431 }
1432
1433 bool RNA_property_editable_flag(PointerRNA *ptr, PropertyRNA *prop)
1434 {
1435         int flag;
1436
1437         prop = rna_ensure_property(prop);
1438         flag = prop->editable ? prop->editable(ptr) : prop->flag;
1439         return (flag & PROP_EDITABLE) != 0;
1440 }
1441
1442 /* same as RNA_property_editable(), except this checks individual items in an array */
1443 bool RNA_property_editable_index(PointerRNA *ptr, PropertyRNA *prop, int index)
1444 {
1445         ID *id;
1446         int flag;
1447
1448         BLI_assert(index >= 0);
1449
1450         prop = rna_ensure_property(prop);
1451
1452         flag = prop->flag;
1453         
1454         if (prop->editable)
1455                 flag &= prop->editable(ptr);
1456
1457         if (prop->itemeditable)
1458                 flag &= prop->itemeditable(ptr, index);
1459
1460         id = ptr->id.data;
1461
1462         return (flag & PROP_EDITABLE) && (!id || !id->lib || (prop->flag & PROP_LIB_EXCEPTION));
1463 }
1464
1465 bool RNA_property_animateable(PointerRNA *ptr, PropertyRNA *prop)
1466 {
1467         /* check that base ID-block can support animation data */
1468         if (!id_type_can_have_animdata(ptr->id.data))
1469                 return false;
1470         
1471         prop = rna_ensure_property(prop);
1472
1473         if (!(prop->flag & PROP_ANIMATABLE))
1474                 return false;
1475
1476         return (prop->flag & PROP_EDITABLE) != 0;
1477 }
1478
1479 bool RNA_property_animated(PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop))
1480 {
1481         /* would need to ask animation system */
1482
1483         return false;
1484 }
1485
1486
1487 /* this function is to check if its possible to create a valid path from the ID
1488  * its slow so don't call in a loop */
1489 bool RNA_property_path_from_ID_check(PointerRNA *ptr, PropertyRNA *prop)
1490 {
1491         char *path = RNA_path_from_ID_to_property(ptr, prop);
1492         bool ret = false;
1493
1494         if (path) {
1495                 PointerRNA id_ptr;
1496                 PointerRNA r_ptr;
1497                 PropertyRNA *r_prop;
1498
1499                 RNA_id_pointer_create(ptr->id.data, &id_ptr);
1500                 if (RNA_path_resolve(&id_ptr, path, &r_ptr, &r_prop) == TRUE) {
1501                         ret = (prop == r_prop);
1502                 }
1503                 MEM_freeN(path);
1504         }
1505
1506         return ret;
1507 }
1508
1509
1510 static void rna_property_update(bContext *C, Main *bmain, Scene *scene, PointerRNA *ptr, PropertyRNA *prop)
1511 {
1512         const bool is_rna = (prop->magic == RNA_MAGIC);
1513         prop = rna_ensure_property(prop);
1514
1515         if (is_rna) {
1516                 if (prop->update) {
1517                         /* ideally no context would be needed for update, but there's some
1518                          * parts of the code that need it still, so we have this exception */
1519                         if (prop->flag & PROP_CONTEXT_UPDATE) {
1520                                 if (C) {
1521                                         if (prop->flag & PROP_CONTEXT_PROPERTY_UPDATE) {
1522                                                 ((ContextPropUpdateFunc)prop->update)(C, ptr, prop);
1523                                         }
1524                                         else {
1525                                                 ((ContextUpdateFunc)prop->update)(C, ptr);
1526                                         }
1527                                 }
1528                         }
1529                         else
1530                                 prop->update(bmain, scene, ptr);
1531                 }
1532                 if (prop->noteflag)
1533                         WM_main_add_notifier(prop->noteflag, ptr->id.data);
1534         }
1535         
1536         if (!is_rna || (prop->flag & PROP_IDPROPERTY)) {
1537                 /* WARNING! This is so property drivers update the display!
1538                  * not especially nice  */
1539                 DAG_id_tag_update(ptr->id.data, OB_RECALC_OB | OB_RECALC_DATA | OB_RECALC_TIME);
1540                 WM_main_add_notifier(NC_WINDOW, NULL);
1541         }
1542 }
1543
1544 /* must keep in sync with 'rna_property_update'
1545  * note, its possible this returns a false positive in the case of PROP_CONTEXT_UPDATE
1546  * but this isn't likely to be a performance problem. */
1547 bool RNA_property_update_check(PropertyRNA *prop)
1548 {
1549         return (prop->magic != RNA_MAGIC || prop->update || prop->noteflag);
1550 }
1551
1552 void RNA_property_update(bContext *C, PointerRNA *ptr, PropertyRNA *prop)
1553 {
1554         rna_property_update(C, CTX_data_main(C), CTX_data_scene(C), ptr, prop);
1555 }
1556
1557 void RNA_property_update_main(Main *bmain, Scene *scene, PointerRNA *ptr, PropertyRNA *prop)
1558 {
1559         rna_property_update(NULL, bmain, scene, ptr, prop);
1560 }
1561
1562
1563 /* RNA Updates Cache ------------------------ */
1564 /* Overview of RNA Update cache system:
1565  *
1566  * RNA Update calls need to be cached in order to maintain reasonable performance
1567  * of the animation system (i.e. maintaining a somewhat interactive framerate)
1568  * while still allowing updates to be called (necessary in particular for modifier
1569  * property updates to actually work).
1570  *
1571  * The cache is structured with a dual-layer structure
1572  * - L1 = PointerRNA used as key; id.data is used (it should always be defined,
1573  *        and most updates end up using just that anyways)
1574  * - L2 = Update functions to be called on those PointerRNA's
1575  */
1576
1577 /* cache element */
1578 typedef struct tRnaUpdateCacheElem {
1579         struct tRnaUpdateCacheElem *next, *prev;
1580         
1581         PointerRNA ptr;     /* L1 key - id as primary, data secondary/ignored? */
1582         ListBase L2Funcs;   /* L2 functions (LinkData<RnaUpdateFuncRef>) */
1583 } tRnaUpdateCacheElem;
1584
1585 /* cache global (tRnaUpdateCacheElem's) - only accessible using these API calls */
1586 static ListBase rna_updates_cache = {NULL, NULL};
1587
1588 /* ........................... */
1589
1590 void RNA_property_update_cache_add(PointerRNA *ptr, PropertyRNA *prop)
1591 {
1592         const bool is_rna = (prop->magic == RNA_MAGIC);
1593         tRnaUpdateCacheElem *uce = NULL;
1594         UpdateFunc fn = NULL;
1595         LinkData *ld;
1596         
1597         /* sanity check */
1598         if (NULL == ptr)
1599                 return;
1600                 
1601         prop = rna_ensure_property(prop);
1602         
1603         /* we can only handle update calls with no context args for now (makes animsys updates easier) */
1604         if ((is_rna == false) || (prop->update == NULL) || (prop->flag & PROP_CONTEXT_UPDATE))
1605                 return;
1606         fn = prop->update;
1607                 
1608         /* find cache element for which key matches... */
1609         for (uce = rna_updates_cache.first; uce; uce = uce->next) {
1610                 /* just match by id only for now, since most update calls that we'll encounter only really care about this */
1611                 /* TODO: later, the cache might need to have some nesting on L1 to cope better
1612                  * with these problems + some tagging to indicate we need this */
1613                 if (uce->ptr.id.data == ptr->id.data)
1614                         break;
1615         }
1616         if (uce == NULL) {
1617                 /* create new instance */
1618                 uce = MEM_callocN(sizeof(tRnaUpdateCacheElem), "tRnaUpdateCacheElem");
1619                 BLI_addtail(&rna_updates_cache, uce);
1620                 
1621                 /* copy pointer */
1622                 RNA_pointer_create(ptr->id.data, ptr->type, ptr->data, &uce->ptr);
1623         }
1624         
1625         /* check on the update func */
1626         for (ld = uce->L2Funcs.first; ld; ld = ld->next) {
1627                 /* stop on match - function already cached */
1628                 if (fn == ld->data)
1629                         return;
1630         }
1631         /* else... if still here, we need to add it */
1632         BLI_addtail(&uce->L2Funcs, BLI_genericNodeN(fn));
1633 }
1634
1635 void RNA_property_update_cache_flush(Main *bmain, Scene *scene)
1636 {
1637         tRnaUpdateCacheElem *uce;
1638         
1639         /* TODO: should we check that bmain and scene are valid? The above stuff doesn't! */
1640         
1641         /* execute the cached updates */
1642         for (uce = rna_updates_cache.first; uce; uce = uce->next) {
1643                 LinkData *ld;
1644                 
1645                 for (ld = uce->L2Funcs.first; ld; ld = ld->next) {
1646                         UpdateFunc fn = (UpdateFunc)ld->data;
1647                         fn(bmain, scene, &uce->ptr);
1648                 }
1649         }
1650 }
1651
1652 void RNA_property_update_cache_free(void)
1653 {
1654         tRnaUpdateCacheElem *uce, *ucn;
1655         
1656         for (uce = rna_updates_cache.first; uce; uce = ucn) {
1657                 ucn = uce->next;
1658                 
1659                 /* free L2 cache */
1660                 BLI_freelistN(&uce->L2Funcs);
1661                 
1662                 /* remove self */
1663                 BLI_freelinkN(&rna_updates_cache, uce);
1664         }
1665 }
1666
1667 /* ---------------------------------------------------------------------- */
1668
1669 /* Property Data */
1670
1671 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop)
1672 {
1673         BoolPropertyRNA *bprop = (BoolPropertyRNA *)prop;
1674         IDProperty *idprop;
1675
1676         BLI_assert(RNA_property_type(prop) == PROP_BOOLEAN);
1677         BLI_assert(RNA_property_array_check(prop) == false);
1678
1679         if ((idprop = rna_idproperty_check(&prop, ptr)))
1680                 return IDP_Int(idprop);
1681         else if (bprop->get)
1682                 return bprop->get(ptr);
1683         else if (bprop->get_ex)
1684                 return bprop->get_ex(ptr, prop);
1685         else
1686                 return bprop->defaultvalue;
1687 }
1688
1689 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value)
1690 {
1691         BoolPropertyRNA *bprop = (BoolPropertyRNA *)prop;
1692         IDProperty *idprop;
1693
1694         BLI_assert(RNA_property_type(prop) == PROP_BOOLEAN);
1695         BLI_assert(RNA_property_array_check(prop) == false);
1696
1697         /* just in case other values are passed */
1698         if (value) value = 1;
1699
1700         if ((idprop = rna_idproperty_check(&prop, ptr))) {
1701                 IDP_Int(idprop) = value;
1702                 rna_idproperty_touch(idprop);
1703         }
1704         else if (bprop->set) {
1705                 bprop->set(ptr, value);
1706         }
1707         else if (bprop->set_ex) {
1708                 bprop->set_ex(ptr, prop, value);
1709         }
1710         else if (prop->flag & PROP_EDITABLE) {
1711                 IDPropertyTemplate val = {0};
1712                 IDProperty *group;
1713
1714                 val.i = value;
1715
1716                 group = RNA_struct_idprops(ptr, 1);
1717                 if (group)
1718                         IDP_AddToGroup(group, IDP_New(IDP_INT, &val, prop->identifier));
1719         }
1720 }
1721
1722 void RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values)
1723 {
1724         BoolPropertyRNA *bprop = (BoolPropertyRNA *)prop;
1725         IDProperty *idprop;
1726
1727         BLI_assert(RNA_property_type(prop) == PROP_BOOLEAN);
1728         BLI_assert(RNA_property_array_check(prop) != false);
1729
1730         if ((idprop = rna_idproperty_check(&prop, ptr))) {
1731                 if (prop->arraydimension == 0)
1732                         values[0] = RNA_property_boolean_get(ptr, prop);
1733                 else
1734                         memcpy(values, IDP_Array(idprop), sizeof(int) * idprop->len);
1735         }
1736         else if (prop->arraydimension == 0)
1737                 values[0] = RNA_property_boolean_get(ptr, prop);
1738         else if (bprop->getarray)
1739                 bprop->getarray(ptr, values);
1740         else if (bprop->getarray_ex)
1741                 bprop->getarray_ex(ptr, prop, values);
1742         else if (bprop->defaultarray)
1743                 memcpy(values, bprop->defaultarray, sizeof(int) * prop->totarraylength);
1744         else
1745                 memset(values, 0, sizeof(int) * prop->totarraylength);
1746 }
1747
1748 int RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index)
1749 {
1750         int tmp[RNA_MAX_ARRAY_LENGTH];
1751         int len = rna_ensure_property_array_length(ptr, prop);
1752
1753         BLI_assert(RNA_property_type(prop) == PROP_BOOLEAN);
1754         BLI_assert(RNA_property_array_check(prop) != false);
1755         BLI_assert(index >= 0);
1756
1757         if (len <= RNA_MAX_ARRAY_LENGTH) {
1758                 RNA_property_boolean_get_array(ptr, prop, tmp);
1759                 return tmp[index];
1760         }
1761         else {
1762                 int *tmparray, value;
1763
1764                 tmparray = MEM_callocN(sizeof(int) * len, "RNA_property_boolean_get_index");
1765                 RNA_property_boolean_get_array(ptr, prop, tmparray);
1766                 value = tmparray[index];
1767                 MEM_freeN(tmparray);
1768
1769                 return value;
1770         }
1771 }
1772
1773 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values)
1774 {
1775         BoolPropertyRNA *bprop = (BoolPropertyRNA *)prop;
1776         IDProperty *idprop;
1777
1778         BLI_assert(RNA_property_type(prop) == PROP_BOOLEAN);
1779         BLI_assert(RNA_property_array_check(prop) != false);
1780
1781         if ((idprop = rna_idproperty_check(&prop, ptr))) {
1782                 if (prop->arraydimension == 0)
1783                         IDP_Int(idprop) = values[0];
1784                 else
1785                         memcpy(IDP_Array(idprop), values, sizeof(int) * idprop->len);
1786
1787                 rna_idproperty_touch(idprop);
1788         }
1789         else if (prop->arraydimension == 0)
1790                 RNA_property_boolean_set(ptr, prop, values[0]);
1791         else if (bprop->setarray)
1792                 bprop->setarray(ptr, values);
1793         else if (bprop->setarray_ex)
1794                 bprop->setarray_ex(ptr, prop, values);
1795         else if (prop->flag & PROP_EDITABLE) {
1796                 IDPropertyTemplate val = {0};
1797                 IDProperty *group;
1798
1799                 val.array.len = prop->totarraylength;
1800                 val.array.type = IDP_INT;
1801
1802                 group = RNA_struct_idprops(ptr, 1);
1803                 if (group) {
1804                         idprop = IDP_New(IDP_ARRAY, &val, prop->identifier);
1805                         IDP_AddToGroup(group, idprop);
1806                         memcpy(IDP_Array(idprop), values, sizeof(int) * idprop->len);
1807                 }
1808         }
1809 }
1810
1811 void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value)
1812 {
1813         int tmp[RNA_MAX_ARRAY_LENGTH];
1814         int len = rna_ensure_property_array_length(ptr, prop);
1815
1816         BLI_assert(RNA_property_type(prop) == PROP_BOOLEAN);
1817         BLI_assert(RNA_property_array_check(prop) != false);
1818         BLI_assert(index >= 0);
1819
1820         if (len <= RNA_MAX_ARRAY_LENGTH) {
1821                 RNA_property_boolean_get_array(ptr, prop, tmp);
1822                 tmp[index] = value;
1823                 RNA_property_boolean_set_array(ptr, prop, tmp);
1824         }
1825         else {
1826                 int *tmparray;
1827
1828                 tmparray = MEM_callocN(sizeof(int) * len, "RNA_property_boolean_get_index");
1829                 RNA_property_boolean_get_array(ptr, prop, tmparray);
1830                 tmparray[index] = value;
1831                 RNA_property_boolean_set_array(ptr, prop, tmparray);
1832                 MEM_freeN(tmparray);
1833         }
1834 }
1835
1836 int RNA_property_boolean_get_default(PointerRNA *UNUSED(ptr), PropertyRNA *prop)
1837 {
1838         BoolPropertyRNA *bprop = (BoolPropertyRNA *)prop;
1839
1840         BLI_assert(RNA_property_type(prop) == PROP_BOOLEAN);
1841         BLI_assert(RNA_property_array_check(prop) == false);
1842
1843         return bprop->defaultvalue;
1844 }
1845
1846 void RNA_property_boolean_get_default_array(PointerRNA *UNUSED(ptr), PropertyRNA *prop, int *values)
1847 {
1848         BoolPropertyRNA *bprop = (BoolPropertyRNA *)prop;
1849         
1850         BLI_assert(RNA_property_type(prop) == PROP_BOOLEAN);
1851         BLI_assert(RNA_property_array_check(prop) != false);
1852
1853         if (prop->arraydimension == 0)
1854                 values[0] = bprop->defaultvalue;
1855         else if (bprop->defaultarray)
1856                 memcpy(values, bprop->defaultarray, sizeof(int) * prop->totarraylength);
1857         else
1858                 memset(values, 0, sizeof(int) * prop->totarraylength);
1859 }
1860
1861 int RNA_property_boolean_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index)
1862 {
1863         int tmp[RNA_MAX_ARRAY_LENGTH];
1864         int len = rna_ensure_property_array_length(ptr, prop);
1865
1866         BLI_assert(RNA_property_type(prop) == PROP_BOOLEAN);
1867         BLI_assert(RNA_property_array_check(prop) != false);
1868         BLI_assert(index >= 0);
1869
1870         if (len <= RNA_MAX_ARRAY_LENGTH) {
1871                 RNA_property_boolean_get_default_array(ptr, prop, tmp);
1872                 return tmp[index];
1873         }
1874         else {
1875                 int *tmparray, value;
1876
1877                 tmparray = MEM_callocN(sizeof(int) * len, "RNA_property_boolean_get_default_index");
1878                 RNA_property_boolean_get_default_array(ptr, prop, tmparray);
1879                 value = tmparray[index];
1880                 MEM_freeN(tmparray);
1881
1882                 return value;
1883         }
1884 }
1885
1886 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop)
1887 {
1888         IntPropertyRNA *iprop = (IntPropertyRNA *)prop;
1889         IDProperty *idprop;
1890
1891         BLI_assert(RNA_property_type(prop) == PROP_INT);
1892         BLI_assert(RNA_property_array_check(prop) == false);
1893
1894         if ((idprop = rna_idproperty_check(&prop, ptr)))
1895                 return IDP_Int(idprop);
1896         else if (iprop->get)
1897                 return iprop->get(ptr);
1898         else if (iprop->get_ex)
1899                 return iprop->get_ex(ptr, prop);
1900         else
1901                 return iprop->defaultvalue;
1902 }
1903
1904 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value)
1905 {
1906         IntPropertyRNA *iprop = (IntPropertyRNA *)prop;
1907         IDProperty *idprop;
1908
1909         BLI_assert(RNA_property_type(prop) == PROP_INT);
1910         BLI_assert(RNA_property_array_check(prop) == false);
1911         /* useful to check on bad values but set function should clamp */
1912         /* BLI_assert(RNA_property_int_clamp(ptr, prop, &value) == 0); */
1913
1914         if ((idprop = rna_idproperty_check(&prop, ptr))) {
1915                 IDP_Int(idprop) = value;
1916                 rna_idproperty_touch(idprop);
1917         }
1918         else if (iprop->set)
1919                 iprop->set(ptr, value);
1920         else if (iprop->set_ex)
1921                 iprop->set_ex(ptr, prop, value);
1922         else if (prop->flag & PROP_EDITABLE) {
1923                 IDPropertyTemplate val = {0};
1924                 IDProperty *group;
1925
1926                 RNA_property_int_clamp(ptr, prop, &value);
1927
1928                 val.i = value;
1929
1930                 group = RNA_struct_idprops(ptr, 1);
1931                 if (group)
1932                         IDP_AddToGroup(group, IDP_New(IDP_INT, &val, prop->identifier));
1933         }
1934 }
1935
1936 void RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values)
1937 {
1938         IntPropertyRNA *iprop = (IntPropertyRNA *)prop;
1939         IDProperty *idprop;
1940
1941         BLI_assert(RNA_property_type(prop) == PROP_INT);
1942         BLI_assert(RNA_property_array_check(prop) != false);
1943
1944         if ((idprop = rna_idproperty_check(&prop, ptr))) {
1945                 if (prop->arraydimension == 0)
1946                         values[0] = RNA_property_int_get(ptr, prop);
1947                 else
1948                         memcpy(values, IDP_Array(idprop), sizeof(int) * idprop->len);
1949         }
1950         else if (prop->arraydimension == 0)
1951                 values[0] = RNA_property_int_get(ptr, prop);
1952         else if (iprop->getarray)
1953                 iprop->getarray(ptr, values);
1954         else if (iprop->getarray_ex)
1955                 iprop->getarray_ex(ptr, prop, values);
1956         else if (iprop->defaultarray)
1957                 memcpy(values, iprop->defaultarray, sizeof(int) * prop->totarraylength);
1958         else
1959                 memset(values, 0, sizeof(int) * prop->totarraylength);
1960 }
1961
1962 void RNA_property_int_get_array_range(PointerRNA *ptr, PropertyRNA *prop, int values[2])
1963 {
1964         const int array_len = RNA_property_array_length(ptr, prop);
1965
1966         if (array_len <= 0) {
1967                 values[0] = 0;
1968                 values[1] = 0;
1969         }
1970         else if (array_len == 1) {
1971                 RNA_property_int_get_array(ptr, prop, values);
1972                 values[1] = values[0];
1973         }
1974         else {
1975                 int arr_stack[32];
1976                 int *arr;
1977                 int i;
1978
1979                 if (array_len > 32) {
1980                         arr = MEM_mallocN(sizeof(int) * array_len, "RNA_property_int_get_array_range");
1981                 }
1982                 else {
1983                         arr = arr_stack;
1984                 }
1985
1986                 RNA_property_int_get_array(ptr, prop, arr);
1987                 values[0] = values[1] = arr[0];
1988                 for (i = 1; i < array_len; i++) {
1989                         values[0] = MIN2(values[0], arr[i]);
1990                         values[1] = MAX2(values[1], arr[i]);
1991                 }
1992
1993                 if (arr != arr_stack) {
1994                         MEM_freeN(arr);
1995                 }
1996         }
1997 }
1998
1999 int RNA_property_int_get_index(PointerRNA *ptr, PropertyRNA *prop, int index)
2000 {
2001         int tmp[RNA_MAX_ARRAY_LENGTH];
2002         int len = rna_ensure_property_array_length(ptr, prop);
2003
2004         BLI_assert(RNA_property_type(prop) == PROP_INT);
2005         BLI_assert(RNA_property_array_check(prop) != false);
2006         BLI_assert(index >= 0);
2007
2008         if (len <= RNA_MAX_ARRAY_LENGTH) {
2009                 RNA_property_int_get_array(ptr, prop, tmp);
2010                 return tmp[index];
2011         }
2012         else {
2013                 int *tmparray, value;
2014
2015                 tmparray = MEM_callocN(sizeof(int) * len, "RNA_property_int_get_index");
2016                 RNA_property_int_get_array(ptr, prop, tmparray);
2017                 value = tmparray[index];
2018                 MEM_freeN(tmparray);
2019
2020                 return value;
2021         }
2022 }
2023
2024 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values)
2025 {
2026         IntPropertyRNA *iprop = (IntPropertyRNA *)prop;
2027         IDProperty *idprop;
2028
2029         BLI_assert(RNA_property_type(prop) == PROP_INT);
2030         BLI_assert(RNA_property_array_check(prop) != false);
2031
2032         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2033                 if (prop->arraydimension == 0)
2034                         IDP_Int(idprop) = values[0];
2035                 else
2036                         memcpy(IDP_Array(idprop), values, sizeof(int) * idprop->len);
2037
2038                 rna_idproperty_touch(idprop);
2039         }
2040         else if (prop->arraydimension == 0)
2041                 RNA_property_int_set(ptr, prop, values[0]);
2042         else if (iprop->setarray)
2043                 iprop->setarray(ptr, values);
2044         else if (iprop->setarray_ex)
2045                 iprop->setarray_ex(ptr, prop, values);
2046         else if (prop->flag & PROP_EDITABLE) {
2047                 IDPropertyTemplate val = {0};
2048                 IDProperty *group;
2049
2050                 /* TODO: RNA_property_int_clamp_array(ptr, prop, &value); */
2051
2052                 val.array.len = prop->totarraylength;
2053                 val.array.type = IDP_INT;
2054
2055                 group = RNA_struct_idprops(ptr, 1);
2056                 if (group) {
2057                         idprop = IDP_New(IDP_ARRAY, &val, prop->identifier);
2058                         IDP_AddToGroup(group, idprop);
2059                         memcpy(IDP_Array(idprop), values, sizeof(int) * idprop->len);
2060                 }
2061         }
2062 }
2063
2064 void RNA_property_int_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value)
2065 {
2066         int tmp[RNA_MAX_ARRAY_LENGTH];
2067         int len = rna_ensure_property_array_length(ptr, prop);
2068
2069         BLI_assert(RNA_property_type(prop) == PROP_INT);
2070         BLI_assert(RNA_property_array_check(prop) != false);
2071         BLI_assert(index >= 0);
2072
2073         if (len <= RNA_MAX_ARRAY_LENGTH) {
2074                 RNA_property_int_get_array(ptr, prop, tmp);
2075                 tmp[index] = value;
2076                 RNA_property_int_set_array(ptr, prop, tmp);
2077         }
2078         else {
2079                 int *tmparray;
2080
2081                 tmparray = MEM_callocN(sizeof(int) * len, "RNA_property_int_get_index");
2082                 RNA_property_int_get_array(ptr, prop, tmparray);
2083                 tmparray[index] = value;
2084                 RNA_property_int_set_array(ptr, prop, tmparray);
2085                 MEM_freeN(tmparray);
2086         }
2087 }
2088
2089 int RNA_property_int_get_default(PointerRNA *UNUSED(ptr), PropertyRNA *prop)
2090 {
2091         IntPropertyRNA *iprop = (IntPropertyRNA *)prop;
2092         return iprop->defaultvalue;
2093 }
2094
2095 void RNA_property_int_get_default_array(PointerRNA *UNUSED(ptr), PropertyRNA *prop, int *values)
2096 {
2097         IntPropertyRNA *iprop = (IntPropertyRNA *)prop;
2098         
2099         BLI_assert(RNA_property_type(prop) == PROP_INT);
2100         BLI_assert(RNA_property_array_check(prop) != false);
2101
2102         if (prop->arraydimension == 0)
2103                 values[0] = iprop->defaultvalue;
2104         else if (iprop->defaultarray)
2105                 memcpy(values, iprop->defaultarray, sizeof(int) * prop->totarraylength);
2106         else
2107                 memset(values, 0, sizeof(int) * prop->totarraylength);
2108 }
2109
2110 int RNA_property_int_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index)
2111 {
2112         int tmp[RNA_MAX_ARRAY_LENGTH];
2113         int len = rna_ensure_property_array_length(ptr, prop);
2114
2115         BLI_assert(RNA_property_type(prop) == PROP_INT);
2116         BLI_assert(RNA_property_array_check(prop) != false);
2117         BLI_assert(index >= 0);
2118
2119         if (len <= RNA_MAX_ARRAY_LENGTH) {
2120                 RNA_property_int_get_default_array(ptr, prop, tmp);
2121                 return tmp[index];
2122         }
2123         else {
2124                 int *tmparray, value;
2125
2126                 tmparray = MEM_callocN(sizeof(int) * len, "RNA_property_int_get_default_index");
2127                 RNA_property_int_get_default_array(ptr, prop, tmparray);
2128                 value = tmparray[index];
2129                 MEM_freeN(tmparray);
2130
2131                 return value;
2132         }
2133 }
2134
2135 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop)
2136 {
2137         FloatPropertyRNA *fprop = (FloatPropertyRNA *)prop;
2138         IDProperty *idprop;
2139
2140         BLI_assert(RNA_property_type(prop) == PROP_FLOAT);
2141         BLI_assert(RNA_property_array_check(prop) == false);
2142
2143         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2144                 if (idprop->type == IDP_FLOAT)
2145                         return IDP_Float(idprop);
2146                 else
2147                         return (float)IDP_Double(idprop);
2148         }
2149         else if (fprop->get)
2150                 return fprop->get(ptr);
2151         else if (fprop->get_ex)
2152                 return fprop->get_ex(ptr, prop);
2153         else
2154                 return fprop->defaultvalue;
2155 }
2156
2157 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value)
2158 {
2159         FloatPropertyRNA *fprop = (FloatPropertyRNA *)prop;
2160         IDProperty *idprop;
2161
2162         BLI_assert(RNA_property_type(prop) == PROP_FLOAT);
2163         BLI_assert(RNA_property_array_check(prop) == false);
2164         /* useful to check on bad values but set function should clamp */
2165         /* BLI_assert(RNA_property_float_clamp(ptr, prop, &value) == 0); */
2166
2167         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2168                 if (idprop->type == IDP_FLOAT)
2169                         IDP_Float(idprop) = value;
2170                 else
2171                         IDP_Double(idprop) = value;
2172
2173                 rna_idproperty_touch(idprop);
2174         }
2175         else if (fprop->set) {
2176                 fprop->set(ptr, value);
2177         }
2178         else if (fprop->set_ex) {
2179                 fprop->set_ex(ptr, prop, value);
2180         }
2181         else if (prop->flag & PROP_EDITABLE) {
2182                 IDPropertyTemplate val = {0};
2183                 IDProperty *group;
2184
2185                 RNA_property_float_clamp(ptr, prop, &value);
2186
2187                 val.f = value;
2188
2189                 group = RNA_struct_idprops(ptr, 1);
2190                 if (group)
2191                         IDP_AddToGroup(group, IDP_New(IDP_FLOAT, &val, prop->identifier));
2192         }
2193 }
2194
2195 void RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, float *values)
2196 {
2197         FloatPropertyRNA *fprop = (FloatPropertyRNA *)prop;
2198         IDProperty *idprop;
2199         int i;
2200
2201         BLI_assert(RNA_property_type(prop) == PROP_FLOAT);
2202         BLI_assert(RNA_property_array_check(prop) != false);
2203
2204         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2205                 if (prop->arraydimension == 0)
2206                         values[0] = RNA_property_float_get(ptr, prop);
2207                 else if (idprop->subtype == IDP_FLOAT) {
2208                         memcpy(values, IDP_Array(idprop), sizeof(float) * idprop->len);
2209                 }
2210                 else {
2211                         for (i = 0; i < idprop->len; i++)
2212                                 values[i] =  (float)(((double *)IDP_Array(idprop))[i]);
2213                 }
2214         }
2215         else if (prop->arraydimension == 0)
2216                 values[0] = RNA_property_float_get(ptr, prop);
2217         else if (fprop->getarray)
2218                 fprop->getarray(ptr, values);
2219         else if (fprop->getarray_ex)
2220                 fprop->getarray_ex(ptr, prop, values);
2221         else if (fprop->defaultarray)
2222                 memcpy(values, fprop->defaultarray, sizeof(float) * prop->totarraylength);
2223         else
2224                 memset(values, 0, sizeof(float) * prop->totarraylength);
2225 }
2226
2227 void RNA_property_float_get_array_range(PointerRNA *ptr, PropertyRNA *prop, float values[2])
2228 {
2229         const int array_len = RNA_property_array_length(ptr, prop);
2230
2231         if (array_len <= 0) {
2232                 values[0] = 0.0f;
2233                 values[1] = 0.0f;
2234         }
2235         else if (array_len == 1) {
2236                 RNA_property_float_get_array(ptr, prop, values);
2237                 values[1] = values[0];
2238         }
2239         else {
2240                 float arr_stack[32];
2241                 float *arr;
2242                 int i;
2243
2244                 if (array_len > 32) {
2245                         arr = MEM_mallocN(sizeof(float) * array_len, "RNA_property_float_get_array_range");
2246                 }
2247                 else {
2248                         arr = arr_stack;
2249                 }
2250
2251                 RNA_property_float_get_array(ptr, prop, arr);
2252                 values[0] = values[1] = arr[0];
2253                 for (i = 1; i < array_len; i++) {
2254                         values[0] = MIN2(values[0], arr[i]);
2255                         values[1] = MAX2(values[1], arr[i]);
2256                 }
2257
2258                 if (arr != arr_stack) {
2259                         MEM_freeN(arr);
2260                 }
2261         }
2262 }
2263
2264 float RNA_property_float_get_index(PointerRNA *ptr, PropertyRNA *prop, int index)
2265 {
2266         float tmp[RNA_MAX_ARRAY_LENGTH];
2267         int len = rna_ensure_property_array_length(ptr, prop);
2268
2269         BLI_assert(RNA_property_type(prop) == PROP_FLOAT);
2270         BLI_assert(RNA_property_array_check(prop) != false);
2271         BLI_assert(index >= 0);
2272
2273         if (len <= RNA_MAX_ARRAY_LENGTH) {
2274                 RNA_property_float_get_array(ptr, prop, tmp);
2275                 return tmp[index];
2276         }
2277         else {
2278                 float *tmparray, value;
2279
2280                 tmparray = MEM_callocN(sizeof(float) * len, "RNA_property_float_get_index");
2281                 RNA_property_float_get_array(ptr, prop, tmparray);
2282                 value = tmparray[index];
2283                 MEM_freeN(tmparray);
2284
2285                 return value;
2286         }
2287 }
2288
2289 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, const float *values)
2290 {
2291         FloatPropertyRNA *fprop = (FloatPropertyRNA *)prop;
2292         IDProperty *idprop;
2293         int i;
2294
2295         BLI_assert(RNA_property_type(prop) == PROP_FLOAT);
2296         BLI_assert(RNA_property_array_check(prop) != false);
2297
2298         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2299                 if (prop->arraydimension == 0) {
2300                         if (idprop->type == IDP_FLOAT)
2301                                 IDP_Float(idprop) = values[0];
2302                         else
2303                                 IDP_Double(idprop) = values[0];
2304                 }
2305                 else if (idprop->subtype == IDP_FLOAT) {
2306                         memcpy(IDP_Array(idprop), values, sizeof(float) * idprop->len);
2307                 }
2308                 else {
2309                         for (i = 0; i < idprop->len; i++)
2310                                 ((double *)IDP_Array(idprop))[i] = values[i];
2311                 }
2312
2313                 rna_idproperty_touch(idprop);
2314         }
2315         else if (prop->arraydimension == 0)
2316                 RNA_property_float_set(ptr, prop, values[0]);
2317         else if (fprop->setarray) {
2318                 fprop->setarray(ptr, values);
2319         }
2320         else if (fprop->setarray_ex) {
2321                 fprop->setarray_ex(ptr, prop, values);
2322         }
2323         else if (prop->flag & PROP_EDITABLE) {
2324                 IDPropertyTemplate val = {0};
2325                 IDProperty *group;
2326
2327                 /* TODO: RNA_property_float_clamp_array(ptr, prop, &value); */
2328
2329                 val.array.len = prop->totarraylength;
2330                 val.array.type = IDP_FLOAT;
2331
2332                 group = RNA_struct_idprops(ptr, 1);
2333                 if (group) {
2334                         idprop = IDP_New(IDP_ARRAY, &val, prop->identifier);
2335                         IDP_AddToGroup(group, idprop);
2336                         memcpy(IDP_Array(idprop), values, sizeof(float) * idprop->len);
2337                 }
2338         }
2339 }
2340
2341 void RNA_property_float_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, float value)
2342 {
2343         float tmp[RNA_MAX_ARRAY_LENGTH];
2344         int len = rna_ensure_property_array_length(ptr, prop);
2345
2346         BLI_assert(RNA_property_type(prop) == PROP_FLOAT);
2347         BLI_assert(RNA_property_array_check(prop) != false);
2348         BLI_assert(index >= 0);
2349
2350         if (len <= RNA_MAX_ARRAY_LENGTH) {
2351                 RNA_property_float_get_array(ptr, prop, tmp);
2352                 tmp[index] = value;
2353                 RNA_property_float_set_array(ptr, prop, tmp);
2354         }
2355         else {
2356                 float *tmparray;
2357
2358                 tmparray = MEM_callocN(sizeof(float) * len, "RNA_property_float_get_index");
2359                 RNA_property_float_get_array(ptr, prop, tmparray);
2360                 tmparray[index] = value;
2361                 RNA_property_float_set_array(ptr, prop, tmparray);
2362                 MEM_freeN(tmparray);
2363         }
2364 }
2365
2366 float RNA_property_float_get_default(PointerRNA *UNUSED(ptr), PropertyRNA *prop)
2367 {
2368         FloatPropertyRNA *fprop = (FloatPropertyRNA *)prop;
2369
2370         BLI_assert(RNA_property_type(prop) == PROP_FLOAT);
2371         BLI_assert(RNA_property_array_check(prop) == false);
2372
2373         return fprop->defaultvalue;
2374 }
2375
2376 void RNA_property_float_get_default_array(PointerRNA *UNUSED(ptr), PropertyRNA *prop, float *values)
2377 {
2378         FloatPropertyRNA *fprop = (FloatPropertyRNA *)prop;
2379         
2380         BLI_assert(RNA_property_type(prop) == PROP_FLOAT);
2381         BLI_assert(RNA_property_array_check(prop) != false);
2382
2383         if (prop->arraydimension == 0)
2384                 values[0] = fprop->defaultvalue;
2385         else if (fprop->defaultarray)
2386                 memcpy(values, fprop->defaultarray, sizeof(float) * prop->totarraylength);
2387         else
2388                 memset(values, 0, sizeof(float) * prop->totarraylength);
2389 }
2390
2391 float RNA_property_float_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index)
2392 {
2393         float tmp[RNA_MAX_ARRAY_LENGTH];
2394         int len = rna_ensure_property_array_length(ptr, prop);
2395
2396         BLI_assert(RNA_property_type(prop) == PROP_FLOAT);
2397         BLI_assert(RNA_property_array_check(prop) != false);
2398         BLI_assert(index >= 0);
2399
2400         if (len <= RNA_MAX_ARRAY_LENGTH) {
2401                 RNA_property_float_get_default_array(ptr, prop, tmp);
2402                 return tmp[index];
2403         }
2404         else {
2405                 float *tmparray, value;
2406
2407                 tmparray = MEM_callocN(sizeof(float) * len, "RNA_property_float_get_default_index");
2408                 RNA_property_float_get_default_array(ptr, prop, tmparray);
2409                 value = tmparray[index];
2410                 MEM_freeN(tmparray);
2411
2412                 return value;
2413         }
2414 }
2415
2416 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value)
2417 {
2418         StringPropertyRNA *sprop = (StringPropertyRNA *)prop;
2419         IDProperty *idprop;
2420
2421         BLI_assert(RNA_property_type(prop) == PROP_STRING);
2422
2423         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2424                 /* editing bytes is not 100% supported
2425                  * since they can contain NIL chars */
2426                 if (idprop->subtype == IDP_STRING_SUB_BYTE) {
2427                         memcpy(value, IDP_String(idprop), idprop->len);
2428                         value[idprop->len] = '\0';
2429                 }
2430                 else {
2431                         memcpy(value, IDP_String(idprop), idprop->len);
2432                 }
2433         }
2434         else if (sprop->get) {
2435                 sprop->get(ptr, value);
2436         }
2437         else if (sprop->get_ex) {
2438                 sprop->get_ex(ptr, prop, value);
2439         }
2440         else {
2441                 strcpy(value, sprop->defaultvalue);
2442         }
2443 }
2444
2445 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop,
2446                                     char *fixedbuf, int fixedlen, int *r_len)
2447 {
2448         char *buf;
2449         int length;
2450
2451         BLI_assert(RNA_property_type(prop) == PROP_STRING);
2452
2453         length = RNA_property_string_length(ptr, prop);
2454
2455         if (length + 1 < fixedlen)
2456                 buf = fixedbuf;
2457         else
2458                 buf = MEM_mallocN(sizeof(char) * (length + 1), "RNA_string_get_alloc");
2459
2460 #ifndef NDEBUG
2461         /* safety check to ensure the string is actually set */
2462         buf[length] = 255;
2463 #endif
2464
2465         RNA_property_string_get(ptr, prop, buf);
2466
2467 #ifndef NDEBUG
2468         BLI_assert(buf[length] == '\0');
2469 #endif
2470
2471         if (r_len) {
2472                 *r_len = length;
2473         }
2474
2475         return buf;
2476 }
2477
2478 /* this is the length without \0 terminator */
2479 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop)
2480 {
2481         StringPropertyRNA *sprop = (StringPropertyRNA *)prop;
2482         IDProperty *idprop;
2483
2484         BLI_assert(RNA_property_type(prop) == PROP_STRING);
2485
2486         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2487                 if (idprop->subtype == IDP_STRING_SUB_BYTE) {
2488                         return idprop->len;
2489                 }
2490                 else {
2491 #ifndef NDEBUG
2492                         /* these _must_ stay in sync */
2493                         BLI_assert(strlen(IDP_String(idprop)) == idprop->len - 1);
2494 #endif
2495                         return idprop->len - 1;
2496                 }
2497         }
2498         else if (sprop->length)
2499                 return sprop->length(ptr);
2500         else if (sprop->length_ex)
2501                 return sprop->length_ex(ptr, prop);
2502         else
2503                 return strlen(sprop->defaultvalue);
2504 }
2505
2506 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value)
2507 {
2508         StringPropertyRNA *sprop = (StringPropertyRNA *)prop;
2509         IDProperty *idprop;
2510
2511         BLI_assert(RNA_property_type(prop) == PROP_STRING);
2512
2513         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2514                 /* both IDP_STRING_SUB_BYTE / IDP_STRING_SUB_UTF8 */
2515                 IDP_AssignString(idprop, value, RNA_property_string_maxlength(prop) - 1);
2516                 rna_idproperty_touch(idprop);
2517         }
2518         else if (sprop->set)
2519                 sprop->set(ptr, value);  /* set function needs to clamp its self */
2520         else if (sprop->set_ex)
2521                 sprop->set_ex(ptr, prop, value);  /* set function needs to clamp its self */
2522         else if (prop->flag & PROP_EDITABLE) {
2523                 IDProperty *group;
2524
2525                 group = RNA_struct_idprops(ptr, 1);
2526                 if (group)
2527                         IDP_AddToGroup(group, IDP_NewString(value, prop->identifier, RNA_property_string_maxlength(prop) - 1));
2528         }
2529 }
2530
2531 void RNA_property_string_get_default(PointerRNA *UNUSED(ptr), PropertyRNA *prop, char *value)
2532 {
2533         StringPropertyRNA *sprop = (StringPropertyRNA *)prop;
2534
2535         BLI_assert(RNA_property_type(prop) == PROP_STRING);
2536
2537         strcpy(value, sprop->defaultvalue);
2538 }
2539
2540 char *RNA_property_string_get_default_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen)
2541 {
2542         char *buf;
2543         int length;
2544
2545         BLI_assert(RNA_property_type(prop) == PROP_STRING);
2546
2547         length = RNA_property_string_default_length(ptr, prop);
2548
2549         if (length + 1 < fixedlen)
2550                 buf = fixedbuf;
2551         else
2552                 buf = MEM_callocN(sizeof(char) * (length + 1), "RNA_string_get_alloc");
2553
2554         RNA_property_string_get_default(ptr, prop, buf);
2555
2556         return buf;
2557 }
2558
2559 /* this is the length without \0 terminator */
2560 int RNA_property_string_default_length(PointerRNA *UNUSED(ptr), PropertyRNA *prop)
2561 {
2562         StringPropertyRNA *sprop = (StringPropertyRNA *)prop;
2563
2564         BLI_assert(RNA_property_type(prop) == PROP_STRING);
2565
2566         return strlen(sprop->defaultvalue);
2567 }
2568
2569 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop)
2570 {
2571         EnumPropertyRNA *eprop = (EnumPropertyRNA *)prop;
2572         IDProperty *idprop;
2573
2574         BLI_assert(RNA_property_type(prop) == PROP_ENUM);
2575
2576         if ((idprop = rna_idproperty_check(&prop, ptr)))
2577                 return IDP_Int(idprop);
2578         else if (eprop->get)
2579                 return eprop->get(ptr);
2580         else if (eprop->get_ex)
2581                 return eprop->get_ex(ptr, prop);
2582         else
2583                 return eprop->defaultvalue;
2584 }
2585
2586 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value)
2587 {
2588         EnumPropertyRNA *eprop = (EnumPropertyRNA *)prop;
2589         IDProperty *idprop;
2590
2591         BLI_assert(RNA_property_type(prop) == PROP_ENUM);
2592
2593         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2594                 IDP_Int(idprop) = value;
2595                 rna_idproperty_touch(idprop);
2596         }
2597         else if (eprop->set) {
2598                 eprop->set(ptr, value);
2599         }
2600         else if (eprop->set_ex) {
2601                 eprop->set_ex(ptr, prop, value);
2602         }
2603         else if (prop->flag & PROP_EDITABLE) {
2604                 IDPropertyTemplate val = {0};
2605                 IDProperty *group;
2606
2607                 val.i = value;
2608
2609                 group = RNA_struct_idprops(ptr, 1);
2610                 if (group)
2611                         IDP_AddToGroup(group, IDP_New(IDP_INT, &val, prop->identifier));
2612         }
2613 }
2614
2615 int RNA_property_enum_get_default(PointerRNA *UNUSED(ptr), PropertyRNA *prop)
2616 {
2617         EnumPropertyRNA *eprop = (EnumPropertyRNA *)prop;
2618
2619         BLI_assert(RNA_property_type(prop) == PROP_ENUM);
2620
2621         return eprop->defaultvalue;
2622 }
2623
2624 void *RNA_property_enum_py_data_get(PropertyRNA *prop)
2625 {
2626         EnumPropertyRNA *eprop = (EnumPropertyRNA *)prop;
2627
2628         BLI_assert(RNA_property_type(prop) == PROP_ENUM);
2629
2630         return eprop->py_data;
2631 }
2632
2633 PointerRNA RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop)
2634 {
2635         PointerPropertyRNA *pprop = (PointerPropertyRNA *)prop;
2636         IDProperty *idprop;
2637
2638         BLI_assert(RNA_property_type(prop) == PROP_POINTER);
2639
2640         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2641                 pprop = (PointerPropertyRNA *)prop;
2642
2643                 /* for groups, data is idprop itself */
2644                 if (pprop->typef)
2645                         return rna_pointer_inherit_refine(ptr, pprop->typef(ptr), idprop);
2646                 else
2647                         return rna_pointer_inherit_refine(ptr, pprop->type, idprop);
2648         }
2649         else if (pprop->get) {
2650                 return pprop->get(ptr);
2651         }
2652         else if (prop->flag & PROP_IDPROPERTY) {
2653                 /* XXX temporary hack to add it automatically, reading should
2654                  * never do any write ops, to ensure thread safety etc .. */
2655                 RNA_property_pointer_add(ptr, prop);
2656                 return RNA_property_pointer_get(ptr, prop);
2657         }
2658         else {
2659                 return PointerRNA_NULL;
2660         }
2661 }
2662
2663 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA ptr_value)
2664 {
2665         /*IDProperty *idprop;*/
2666
2667         BLI_assert(RNA_property_type(prop) == PROP_POINTER);
2668
2669         if ((/*idprop = */ rna_idproperty_check(&prop, ptr))) {
2670                 /* not supported */
2671                 /* rna_idproperty_touch(idprop); */
2672         }
2673         else {
2674                 PointerPropertyRNA *pprop = (PointerPropertyRNA *)prop;
2675
2676                 if (pprop->set &&
2677                     !((prop->flag & PROP_NEVER_NULL) && ptr_value.data == NULL) &&
2678                     !((prop->flag & PROP_ID_SELF_CHECK) && ptr->id.data == ptr_value.id.data))
2679                 {
2680                         pprop->set(ptr, ptr_value);
2681                 }
2682         }
2683 }
2684
2685 PointerRNA RNA_property_pointer_get_default(PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop))
2686 {
2687         /*PointerPropertyRNA *pprop = (PointerPropertyRNA *)prop; */
2688
2689         /* BLI_assert(RNA_property_type(prop) == PROP_POINTER); */
2690
2691         return PointerRNA_NULL; /* FIXME: there has to be a way... */
2692 }
2693
2694 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop)
2695 {
2696         /*IDProperty *idprop;*/
2697
2698         BLI_assert(RNA_property_type(prop) == PROP_POINTER);
2699
2700         if ((/*idprop=*/ rna_idproperty_check(&prop, ptr))) {
2701                 /* already exists */
2702         }
2703         else if (prop->flag & PROP_IDPROPERTY) {
2704                 IDPropertyTemplate val = {0};
2705                 IDProperty *group;
2706
2707                 val.i = 0;
2708
2709                 group = RNA_struct_idprops(ptr, 1);
2710                 if (group)
2711                         IDP_AddToGroup(group, IDP_New(IDP_GROUP, &val, prop->identifier));
2712         }
2713         else
2714                 printf("%s %s.%s: only supported for id properties.\n", __func__, ptr->type->identifier, prop->identifier);
2715 }
2716
2717 void RNA_property_pointer_remove(PointerRNA *ptr, PropertyRNA *prop)
2718 {
2719         IDProperty *idprop, *group;
2720
2721         BLI_assert(RNA_property_type(prop) == PROP_POINTER);
2722
2723         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2724                 group = RNA_struct_idprops(ptr, 0);
2725                 
2726                 if (group) {
2727                         IDP_RemFromGroup(group, idprop);
2728                         IDP_FreeProperty(idprop);
2729                         MEM_freeN(idprop);
2730                 }
2731         }
2732         else
2733                 printf("%s %s.%s: only supported for id properties.\n", __func__, ptr->type->identifier, prop->identifier);
2734 }
2735
2736 static void rna_property_collection_get_idp(CollectionPropertyIterator *iter)
2737 {
2738         CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)iter->prop;
2739
2740         iter->ptr.data = rna_iterator_array_get(iter);
2741         iter->ptr.type = cprop->item_type;
2742         rna_pointer_inherit_id(cprop->item_type, &iter->parent, &iter->ptr);
2743 }
2744
2745 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter)
2746 {
2747         IDProperty *idprop;
2748
2749         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
2750
2751         memset(iter, 0, sizeof(*iter));
2752
2753         if ((idprop = rna_idproperty_check(&prop, ptr)) || (prop->flag & PROP_IDPROPERTY)) {
2754                 iter->parent = *ptr;
2755                 iter->prop = prop;
2756
2757                 if (idprop)
2758                         rna_iterator_array_begin(iter, IDP_IDPArray(idprop), sizeof(IDProperty), idprop->len, 0, NULL);
2759                 else
2760                         rna_iterator_array_begin(iter, NULL, sizeof(IDProperty), 0, 0, NULL);
2761
2762                 if (iter->valid)
2763                         rna_property_collection_get_idp(iter);
2764
2765                 iter->idprop = 1;
2766         }
2767         else {
2768                 CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)prop;
2769                 cprop->begin(iter, ptr);
2770         }
2771 }
2772
2773 void RNA_property_collection_next(CollectionPropertyIterator *iter)
2774 {
2775         CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)rna_ensure_property(iter->prop);
2776
2777         if (iter->idprop) {
2778                 rna_iterator_array_next(iter);
2779
2780                 if (iter->valid)
2781                         rna_property_collection_get_idp(iter);
2782         }
2783         else
2784                 cprop->next(iter);
2785 }
2786
2787 void RNA_property_collection_end(CollectionPropertyIterator *iter)
2788 {
2789         CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)rna_ensure_property(iter->prop);
2790
2791         if (iter->idprop)
2792                 rna_iterator_array_end(iter);
2793         else
2794                 cprop->end(iter);
2795 }
2796
2797 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop)
2798 {
2799         CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)prop;
2800         IDProperty *idprop;
2801
2802         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
2803
2804         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2805                 return idprop->len;
2806         }
2807         else if (cprop->length) {
2808                 return cprop->length(ptr);
2809         }
2810         else {
2811                 CollectionPropertyIterator iter;
2812                 int length = 0;
2813
2814                 RNA_property_collection_begin(ptr, prop, &iter);
2815                 for (; iter.valid; RNA_property_collection_next(&iter))
2816                         length++;
2817                 RNA_property_collection_end(&iter);
2818
2819                 return length;
2820         }
2821 }
2822
2823 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr)
2824 {
2825         IDProperty *idprop;
2826 /*      CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)prop; */
2827
2828         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
2829
2830         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2831                 IDPropertyTemplate val = {0};
2832                 IDProperty *item;
2833
2834                 item = IDP_New(IDP_GROUP, &val, "");
2835                 IDP_AppendArray(idprop, item);
2836                 /* IDP_FreeProperty(item);  *//* IDP_AppendArray does a shallow copy (memcpy), only free memory  */
2837                 MEM_freeN(item);
2838         }
2839         else if (prop->flag & PROP_IDPROPERTY) {
2840                 IDProperty *group, *item;
2841                 IDPropertyTemplate val = {0};
2842
2843                 group = RNA_struct_idprops(ptr, 1);
2844                 if (group) {
2845                         idprop = IDP_NewIDPArray(prop->identifier);
2846                         IDP_AddToGroup(group, idprop);
2847
2848                         item = IDP_New(IDP_GROUP, &val, "");
2849                         IDP_AppendArray(idprop, item);
2850                         /* IDP_FreeProperty(item);  *//* IDP_AppendArray does a shallow copy (memcpy), only free memory */
2851                         MEM_freeN(item);
2852                 }
2853         }
2854
2855         /* py api calls directly */
2856 #if 0
2857         else if (cprop->add) {
2858                 if (!(cprop->add->flag & FUNC_USE_CONTEXT)) { /* XXX check for this somewhere else */
2859                         ParameterList params;
2860                         RNA_parameter_list_create(&params, ptr, cprop->add);
2861                         RNA_function_call(NULL, NULL, ptr, cprop->add, &params);
2862                         RNA_parameter_list_free(&params);
2863                 }
2864         }
2865         /*else
2866             printf("%s %s.%s: not implemented for this property.\n", __func__, ptr->type->identifier, prop->identifier);*/
2867 #endif
2868
2869         if (r_ptr) {
2870                 if (idprop) {
2871                         CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)prop;
2872
2873                         r_ptr->data = IDP_GetIndexArray(idprop, idprop->len - 1);
2874                         r_ptr->type = cprop->item_type;
2875                         rna_pointer_inherit_id(NULL, ptr, r_ptr);
2876                 }
2877                 else
2878                         memset(r_ptr, 0, sizeof(*r_ptr));
2879         }
2880 }
2881
2882 bool RNA_property_collection_remove(PointerRNA *ptr, PropertyRNA *prop, int key)
2883 {
2884         IDProperty *idprop;
2885 /*      CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)prop; */
2886
2887         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
2888
2889         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2890                 IDProperty tmp, *array;
2891                 int len;
2892
2893                 len = idprop->len;
2894                 array = IDP_IDPArray(idprop);
2895
2896                 if (key >= 0 && key < len) {
2897                         if (key + 1 < len) {
2898                                 /* move element to be removed to the back */
2899                                 memcpy(&tmp, &array[key], sizeof(IDProperty));
2900                                 memmove(array + key, array + key + 1, sizeof(IDProperty) * (len - (key + 1)));
2901                                 memcpy(&array[len - 1], &tmp, sizeof(IDProperty));
2902                         }
2903
2904                         IDP_ResizeIDPArray(idprop, len - 1);
2905                 }
2906
2907                 return true;
2908         }
2909         else if (prop->flag & PROP_IDPROPERTY) {
2910                 return true;
2911         }
2912
2913         /* py api calls directly */
2914 #if 0
2915         else if (cprop->remove) {
2916                 if (!(cprop->remove->flag & FUNC_USE_CONTEXT)) { /* XXX check for this somewhere else */
2917                         ParameterList params;
2918                         RNA_parameter_list_create(&params, ptr, cprop->remove);
2919                         RNA_function_call(NULL, NULL, ptr, cprop->remove, &params);
2920                         RNA_parameter_list_free(&params);
2921                 }
2922
2923                 return false;
2924         }
2925         /*else
2926             printf("%s %s.%s: only supported for id properties.\n", __func__, ptr->type->identifier, prop->identifier);*/
2927 #endif
2928         return false;
2929 }
2930
2931 bool RNA_property_collection_move(PointerRNA *ptr, PropertyRNA *prop, int key, int pos)
2932 {
2933         IDProperty *idprop;
2934
2935         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
2936
2937         if ((idprop = rna_idproperty_check(&prop, ptr))) {
2938                 IDProperty tmp, *array;
2939                 int len;
2940
2941                 len = idprop->len;
2942                 array = IDP_IDPArray(idprop);
2943
2944                 if (key >= 0 && key < len && pos >= 0 && pos < len && key != pos) {
2945                         memcpy(&tmp, &array[key], sizeof(IDProperty));
2946                         if (pos < key)
2947                                 memmove(array + pos + 1, array + pos, sizeof(IDProperty) * (key - pos));
2948                         else
2949                                 memmove(array + key, array + key + 1, sizeof(IDProperty) * (pos - key));
2950                         memcpy(&array[pos], &tmp, sizeof(IDProperty));
2951                 }
2952
2953                 return true;
2954         }
2955         else if (prop->flag & PROP_IDPROPERTY) {
2956                 return true;
2957         }
2958
2959         return false;
2960 }
2961
2962 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop)
2963 {
2964         IDProperty *idprop;
2965
2966         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
2967
2968         if ((idprop = rna_idproperty_check(&prop, ptr)))
2969                 IDP_ResizeIDPArray(idprop, 0);
2970 }
2971
2972 int RNA_property_collection_lookup_index(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *t_ptr)
2973 {
2974         CollectionPropertyIterator iter;
2975         int index = 0;
2976         
2977         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
2978
2979         RNA_property_collection_begin(ptr, prop, &iter);
2980         for (index = 0; iter.valid; RNA_property_collection_next(&iter), index++) {
2981                 if (iter.ptr.data == t_ptr->data)
2982                         break;
2983         }
2984         RNA_property_collection_end(&iter);
2985         
2986         /* did we find it? */
2987         if (iter.valid)
2988                 return index;
2989         else
2990                 return -1;
2991 }
2992
2993 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr)
2994 {
2995         CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)rna_ensure_property(prop);
2996
2997         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
2998
2999         if (cprop->lookupint) {
3000                 /* we have a callback defined, use it */
3001                 return cprop->lookupint(ptr, key, r_ptr);
3002         }
3003         else {
3004                 /* no callback defined, just iterate and find the nth item */
3005                 CollectionPropertyIterator iter;
3006                 int i;
3007
3008                 RNA_property_collection_begin(ptr, prop, &iter);
3009                 for (i = 0; iter.valid; RNA_property_collection_next(&iter), i++) {
3010                         if (i == key) {
3011                                 *r_ptr = iter.ptr;
3012                                 break;
3013                         }
3014                 }
3015                 RNA_property_collection_end(&iter);
3016
3017                 if (!iter.valid)
3018                         memset(r_ptr, 0, sizeof(*r_ptr));
3019
3020                 return iter.valid;
3021         }
3022 }
3023
3024 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr)
3025 {
3026         CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)rna_ensure_property(prop);
3027
3028         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
3029
3030         if (cprop->lookupstring) {
3031                 /* we have a callback defined, use it */
3032                 return cprop->lookupstring(ptr, key, r_ptr);
3033         }
3034         else {
3035                 /* no callback defined, compare with name properties if they exist */
3036                 CollectionPropertyIterator iter;
3037                 PropertyRNA *nameprop;
3038                 char name[256], *nameptr;
3039                 int found = 0;
3040                 int keylen = strlen(key);
3041                 int namelen;
3042
3043                 RNA_property_collection_begin(ptr, prop, &iter);
3044                 for (; iter.valid; RNA_property_collection_next(&iter)) {
3045                         if (iter.ptr.data && iter.ptr.type->nameproperty) {
3046                                 nameprop = iter.ptr.type->nameproperty;
3047
3048                                 nameptr = RNA_property_string_get_alloc(&iter.ptr, nameprop, name, sizeof(name), &namelen);
3049
3050                                 if ((keylen == namelen) && (strcmp(nameptr, key) == 0)) {
3051                                         *r_ptr = iter.ptr;
3052                                         found = 1;
3053                                 }
3054
3055                                 if ((char *)&name != nameptr)
3056                                         MEM_freeN(nameptr);
3057
3058                                 if (found)
3059                                         break;
3060                         }
3061                 }
3062                 RNA_property_collection_end(&iter);
3063
3064                 if (!iter.valid)
3065                         memset(r_ptr, 0, sizeof(*r_ptr));
3066
3067                 return iter.valid;
3068         }
3069 }
3070
3071 /* zero return is an assignment error */
3072 int RNA_property_collection_assign_int(PointerRNA *ptr, PropertyRNA *prop, const int key, const PointerRNA *assign_ptr)
3073 {
3074         CollectionPropertyRNA *cprop = (CollectionPropertyRNA *)rna_ensure_property(prop);
3075
3076         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
3077
3078         if (cprop->assignint) {
3079                 /* we have a callback defined, use it */
3080                 return cprop->assignint(ptr, key, assign_ptr);
3081         }
3082
3083         return 0;
3084 }
3085
3086 bool RNA_property_collection_type_get(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr)
3087 {
3088         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
3089
3090         *r_ptr = *ptr;
3091         return ((r_ptr->type = rna_ensure_property(prop)->srna) ? 1 : 0);
3092 }
3093
3094 int RNA_property_collection_raw_array(PointerRNA *ptr, PropertyRNA *prop, PropertyRNA *itemprop, RawArray *array)
3095 {
3096         CollectionPropertyIterator iter;
3097         ArrayIterator *internal;
3098         char *arrayp;
3099
3100         BLI_assert(RNA_property_type(prop) == PROP_COLLECTION);
3101
3102         if (!(prop->flag & PROP_RAW_ARRAY) || !(itemprop->flag & PROP_RAW_ACCESS))
3103                 return 0;
3104
3105         RNA_property_collection_begin(ptr, prop, &iter);
3106
3107         if (iter.valid) {
3108                 /* get data from array iterator and item property */
3109                 internal = iter.internal;
3110                 arrayp = (iter.valid) ? iter.ptr.data : NULL;
3111
3112                 if (internal->skip || !RNA_property_editable(&iter.ptr, itemprop)) {
3113                         /* we might skip some items, so it's not a proper array */
3114                         RNA_property_collection_end(&iter);
3115                         return 0;
3116                 }
3117
3118                 array->array = arrayp + itemprop->rawoffset;
3119                 array->stride = internal->itemsize;
3120                 array->len = ((char *)internal->endptr - arrayp) / internal->itemsize;
3121                 array->type = itemprop->rawtype;
3122         }
3123         else
3124                 memset(array, 0, sizeof(RawArray));
3125
3126         RNA_property_collection_end(&iter);
3127
3128         return 1;
3129 }
3130
3131 #define RAW_GET(dtype, var, raw, a)                                           \
3132 {                                                                             \
3133         switch (raw.type) {                                                       \
3134                 case PROP_RAW_CHAR: var = (dtype)((char *)raw.array)[a]; break;       \
3135                 case PROP_RAW_SHORT: var = (dtype)((short *)raw.array)[a]; break;     \
3136                 case PROP_RAW_INT: var = (dtype)((int *)raw.array)[a]; break;         \
3137                 case PROP_RAW_FLOAT: var = (dtype)((float *)raw.array)[a]; break;     \
3138                 case PROP_RAW_DOUBLE: var = (dtype)((double *)raw.array)[a]; break;   \
3139                 default: var = (dtype)0;                                              \
3140         }                                                                         \
3141 } (void)0
3142
3143 #define RAW_SET(dtype, raw, a, var)                                           \
3144 {                                                                             \
3145         switch (raw.type) {                                                       \
3146                 case PROP_RAW_CHAR: ((char *)raw.array)[a] = (char)var; break;        \
3147                 case PROP_RAW_SHORT: ((short *)raw.array)[a] = (short)var; break;     \
3148                 case PROP_RAW_INT: ((int *)raw.array)[a] = (int)var; break;           \
3149                 case PROP_RAW_FLOAT: ((float *)raw.array)[a] = (float)var; break;     \
3150                 case PROP_RAW_DOUBLE: ((double *)raw.array)[a] = (double)var; break;  \
3151                 default: break;                                                       \
3152         }                                                                         \
3153 } (void)0
3154
3155 int RNA_raw_type_sizeof(RawPropertyType type)
3156 {
3157         switch (type) {
3158                 case PROP_RAW_CHAR: return sizeof(char);
3159                 case PROP_RAW_SHORT: return sizeof(short);
3160                 case PROP_RAW_INT: return sizeof(int);
3161                 case PROP_RAW_FLOAT: return sizeof(float);
3162                 case PROP_RAW_DOUBLE: return sizeof(double);
3163                 default: return 0;
3164         }
3165 }
3166
3167 static int rna_property_array_length_all_dimensions(PointerRNA *ptr, PropertyRNA *prop)
3168 {
3169         int i, len[RNA_MAX_ARRAY_DIMENSION];
3170         const int dim = RNA_property_array_dimension(ptr, prop, len);
3171         int size;
3172
3173         if (dim == 0)
3174                 return 0;
3175
3176         for (size = 1, i = 0; i < dim; i++)
3177                 size *= len[i];
3178         
3179         return size;
3180 }
3181
3182 static int rna_raw_access(ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, const char *propname,
3183                           void *inarray, RawPropertyType intype, int inlen, int set)
3184 {
3185         StructRNA *ptype;
3186         PointerRNA itemptr;
3187         PropertyRNA *itemprop, *iprop;
3188         PropertyType itemtype = 0;
3189         RawArray in;
3190         int itemlen = 0;
3191
3192         /* initialize in array, stride assumed 0 in following code */
3193         in.array = inarray;
3194         in.type = intype;
3195         in.len = inlen;
3196         in.stride = 0;
3197
3198         ptype = RNA_property_pointer_type(ptr, prop);
3199
3200         /* try to get item property pointer */
3201         RNA_pointer_create(NULL, ptype, NULL, &itemptr);
3202         itemprop = RNA_struct_find_property(&itemptr, propname);
3203
3204         if (itemprop) {
3205                 /* we have item property pointer */
3206                 RawArray out;
3207
3208                 /* check type */
3209                 itemtype = RNA_property_type(itemprop);
3210
3211                 if (!ELEM3(itemtype, PROP_BOOLEAN, PROP_INT, PROP_FLOAT)) {
3212                         BKE_report(reports, RPT_ERROR, "Only boolean, int and float properties supported");
3213                         return 0;
3214                 }
3215
3216                 /* check item array */
3217                 itemlen = RNA_property_array_length(&itemptr, itemprop);
3218
3219                 /* dynamic array? need to get length per item */
3220                 if (itemprop->getlength) {
3221                         itemprop = NULL;
3222                 }
3223                 /* try to access as raw array */
3224                 else if (RNA_property_collection_raw_array(ptr, prop, itemprop, &out)) {
3225                         int arraylen = (itemlen == 0) ? 1 : itemlen;
3226                         if (in.len != arraylen * out.len) {
3227                                 BKE_reportf(reports, RPT_ERROR, "Array length mismatch (expected %d, got %d)",
3228                                             out.len * arraylen, in.len);
3229                                 return 0;
3230                         }
3231                         
3232                         /* matching raw types */
3233                         if (out.type == in.type) {
3234                                 void *inp = in.array;
3235                                 void *outp = out.array;
3236                                 int a, size;
3237
3238                                 size = RNA_raw_type_sizeof(out.type) * arraylen;
3239
3240                                 for (a = 0; a < out.len; a++) {
3241                                         if (set) memcpy(outp, inp, size);
3242                                         else memcpy(inp, outp, size);
3243
3244                                         inp = (char *)inp + size;
3245                                         outp = (char *)outp + out.stride;
3246                                 }
3247
3248                                 return 1;
3249                         }
3250
3251                         /* could also be faster with non-matching types,
3252                          * for now we just do slower loop .. */
3253                 }
3254         }
3255
3256         {
3257                 void *tmparray = NULL;
3258                 int tmplen = 0;
3259                 int err = 0, j, a = 0;
3260                 int needconv = 1;
3261
3262                 if (((itemtype == PROP_BOOLEAN || itemtype == PROP_INT) && in.type == PROP_RAW_INT) ||
3263                     (itemtype == PROP_FLOAT && in.type == PROP_RAW_FLOAT))
3264                 {
3265                         /* avoid creating temporary buffer if the data type match */
3266                         needconv = 0;
3267                 }
3268                 /* no item property pointer, can still be id property, or
3269                  * property of a type derived from the collection pointer type */
3270                 RNA_PROP_BEGIN(ptr, itemptr, prop)
3271                 {
3272                         if (itemptr.data) {
3273                                 if (itemprop) {
3274                                         /* we got the property already */
3275                                         iprop = itemprop;
3276                                 }
3277                                 else {
3278                                         /* not yet, look it up and verify if it is valid */
3279                                         iprop = RNA_struct_find_property(&itemptr, propname);
3280
3281                                         if (iprop) {
3282                                                 itemlen = rna_property_array_length_all_dimensions(&itemptr, iprop);
3283                                                 itemtype = RNA_property_type(iprop);
3284                                         }
3285                                         else {
3286                                                 BKE_reportf(reports, RPT_ERROR, "Property named '%s' not found", propname);
3287                                                 err = 1;
3288                                                 break;
3289                                         }
3290
3291                                         if (!ELEM3(itemtype, PROP_BOOLEAN, PROP_INT, PROP_FLOAT)) {
3292                                                 BKE_report(reports, RPT_ERROR, "Only boolean, int and float properties supported");
3293                                                 err = 1;
3294                                                 break;
3295                                         }
3296                                 }
3297
3298                                 /* editable check */
3299                                 if (!set || RNA_property_editable(&itemptr, iprop)) {
3300                                         if (a + itemlen > in.len) {
3301                                                 BKE_reportf(reports, RPT_ERROR, "Array length mismatch (got %d, expected more)", in.len);
3302                                                 err = 1;
3303                                                 break;
3304                                         }
3305
3306                                         if (itemlen == 0) {
3307                                                 /* handle conversions */
3308                                                 if (set) {
3309                                                         switch (itemtype) {
3310                                                                 case PROP_BOOLEAN:
3311                                                                 {
3312                                                                         int b;
3313                                                                         RAW_GET(int, b, in, a);
3314                                                                         RNA_property_boolean_set(&itemptr, iprop, b);
3315                                                                         break;
3316                                                                 }
3317                                                                 case PROP_INT:
3318                                                                 {
3319                                                                         int i;
3320                                                                         RAW_GET(int, i, in, a);
3321                                                                         RNA_property_int_set(&itemptr, iprop, i);
3322                                                                         break;
3323                                                                 }
3324                                                                 case PROP_FLOAT:
3325                                                                 {
3326                                                                         float f;
3327                                                                         RAW_GET(float, f, in, a);
3328                                                                         RNA_property_float_set(&itemptr, iprop, f);
3329                                                                         break;
3330                                                                 }
3331                                                                 default:
3332                                                                         break;
3333                                                         }
3334                                                 }
3335                                                 else {
3336                                                         switch (itemtype) {
3337                           &