Datablock ID Properties
[blender.git] / source / blender / blenkernel / intern / idprop.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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): Joseph Eagar
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/blenkernel/intern/idprop.c
27  *  \ingroup bke
28  */
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <stddef.h>
33 #include <string.h>
34
35 #include "BLI_utildefines.h"
36 #include "BLI_string.h"
37 #include "BLI_listbase.h"
38 #include "BLI_math.h"
39
40 #include "BKE_idprop.h"
41 #include "BKE_library.h"
42
43 #include "MEM_guardedalloc.h"
44
45 #include "BLI_strict_flags.h"
46
47 /* IDPropertyTemplate is a union in DNA_ID.h */
48
49 /**
50  * if the new is 'IDP_ARRAY_REALLOC_LIMIT' items less,
51  * than #IDProperty.totallen, reallocate anyway.
52  */
53 #define IDP_ARRAY_REALLOC_LIMIT 200
54
55 /*local size table.*/
56 static size_t idp_size_table[] = {
57         1, /*strings*/
58         sizeof(int),
59         sizeof(float),
60         sizeof(float) * 3, /*Vector type, deprecated*/
61         sizeof(float) * 16, /*Matrix type, deprecated*/
62         0, /*arrays don't have a fixed size*/
63         sizeof(ListBase), /*Group type*/
64         sizeof(void *),
65         sizeof(double)
66 };
67
68
69 /* -------------------------------------------------------------------- */
70 /* Array Functions */
71
72 /** \name IDP Array API
73  * \{ */
74
75 #define GETPROP(prop, i) &(IDP_IDPArray(prop)[i])
76
77 /* --------- property array type -------------*/
78
79 /**
80  * \note as a start to move away from the stupid IDP_New function, this type
81  * has it's own allocation function.
82  */
83 IDProperty *IDP_NewIDPArray(const char *name)
84 {
85         IDProperty *prop = MEM_callocN(sizeof(IDProperty), "IDProperty prop array");
86         prop->type = IDP_IDPARRAY;
87         prop->len = 0;
88         BLI_strncpy(prop->name, name, MAX_IDPROP_NAME);
89         
90         return prop;
91 }
92
93 IDProperty *IDP_CopyIDPArray(const IDProperty *array)
94 {
95         /* don't use MEM_dupallocN because this may be part of an array */
96         IDProperty *narray, *tmp;
97         int i;
98
99         BLI_assert(array->type == IDP_IDPARRAY);
100
101         narray = MEM_mallocN(sizeof(IDProperty), __func__);
102         *narray = *array;
103
104         narray->data.pointer = MEM_dupallocN(array->data.pointer);
105         for (i = 0; i < narray->len; i++) {
106                 /* ok, the copy functions always allocate a new structure,
107                  * which doesn't work here.  instead, simply copy the
108                  * contents of the new structure into the array cell,
109                  * then free it.  this makes for more maintainable
110                  * code than simply reimplementing the copy functions
111                  * in this loop.*/
112                 tmp = IDP_CopyProperty(GETPROP(narray, i));
113                 memcpy(GETPROP(narray, i), tmp, sizeof(IDProperty));
114                 MEM_freeN(tmp);
115         }
116         
117         return narray;
118 }
119
120 static void IDP_FreeIDPArray(IDProperty *prop, const bool do_id_user)
121 {
122         int i;
123         
124         BLI_assert(prop->type == IDP_IDPARRAY);
125
126         for (i = 0; i < prop->len; i++)
127                 IDP_FreeProperty_ex(GETPROP(prop, i), do_id_user);
128
129         if (prop->data.pointer)
130                 MEM_freeN(prop->data.pointer);
131 }
132
133 /* shallow copies item */
134 void IDP_SetIndexArray(IDProperty *prop, int index, IDProperty *item)
135 {
136         IDProperty *old;
137
138         BLI_assert(prop->type == IDP_IDPARRAY);
139
140         if (index >= prop->len || index < 0)
141                 return;
142
143         old = GETPROP(prop, index);
144         if (item != old) {
145                 IDP_FreeProperty(old);
146
147                 memcpy(old, item, sizeof(IDProperty));
148         }
149 }
150
151 IDProperty *IDP_GetIndexArray(IDProperty *prop, int index)
152 {
153         BLI_assert(prop->type == IDP_IDPARRAY);
154
155         return GETPROP(prop, index);
156 }
157
158 void IDP_AppendArray(IDProperty *prop, IDProperty *item)
159 {
160         BLI_assert(prop->type == IDP_IDPARRAY);
161
162         IDP_ResizeIDPArray(prop, prop->len + 1);
163         IDP_SetIndexArray(prop, prop->len - 1, item);
164 }
165
166 void IDP_ResizeIDPArray(IDProperty *prop, int newlen)
167 {
168         int newsize;
169
170         BLI_assert(prop->type == IDP_IDPARRAY);
171
172         /* first check if the array buffer size has room */
173         if (newlen <= prop->totallen) {
174                 if (newlen < prop->len && prop->totallen - newlen < IDP_ARRAY_REALLOC_LIMIT) {
175                         int i;
176
177                         for (i = newlen; i < prop->len; i++)
178                                 IDP_FreeProperty(GETPROP(prop, i));
179
180                         prop->len = newlen;
181                         return;
182                 }
183                 else if (newlen >= prop->len) {
184                         prop->len = newlen;
185                         return;
186                 }
187         }
188
189         /* free trailing items */
190         if (newlen < prop->len) {
191                 /* newlen is smaller */
192                 int i;
193                 for (i = newlen; i < prop->len; i++) {
194                         IDP_FreeProperty(GETPROP(prop, i));
195                 }
196         }
197
198         /* - Note: This code comes from python, here's the corresponding comment. - */
199         /* This over-allocates proportional to the list size, making room
200          * for additional growth.  The over-allocation is mild, but is
201          * enough to give linear-time amortized behavior over a long
202          * sequence of appends() in the presence of a poorly-performing
203          * system realloc().
204          * The growth pattern is:  0, 4, 8, 16, 25, 35, 46, 58, 72, 88, ...
205          */
206         newsize = newlen;
207         newsize = (newsize >> 3) + (newsize < 9 ? 3 : 6) + newsize;
208         prop->data.pointer = MEM_recallocN(prop->data.pointer, sizeof(IDProperty) * (size_t)newsize);
209         prop->len = newlen;
210         prop->totallen = newsize;
211 }
212
213 /* ----------- Numerical Array Type ----------- */
214 static void idp_resize_group_array(IDProperty *prop, int newlen, void *newarr)
215 {
216         if (prop->subtype != IDP_GROUP)
217                 return;
218
219         if (newlen >= prop->len) {
220                 /* bigger */
221                 IDProperty **array = newarr;
222                 IDPropertyTemplate val;
223                 int a;
224
225                 for (a = prop->len; a < newlen; a++) {
226                         val.i = 0; /* silence MSVC warning about uninitialized var when debugging */
227                         array[a] = IDP_New(IDP_GROUP, &val, "IDP_ResizeArray group");
228                 }
229         }
230         else {
231                 /* smaller */
232                 IDProperty **array = prop->data.pointer;
233                 int a;
234
235                 for (a = newlen; a < prop->len; a++) {
236                         IDP_FreeProperty(array[a]);
237                         MEM_freeN(array[a]);
238                 }
239         }
240 }
241
242 /*this function works for strings too!*/
243 void IDP_ResizeArray(IDProperty *prop, int newlen)
244 {
245         int newsize;
246         const bool is_grow = newlen >= prop->len;
247
248         /* first check if the array buffer size has room */
249         if (newlen <= prop->totallen && prop->totallen - newlen < IDP_ARRAY_REALLOC_LIMIT) {
250                 idp_resize_group_array(prop, newlen, prop->data.pointer);
251                 prop->len = newlen;
252                 return;
253         }
254
255         /* - Note: This code comes from python, here's the corresponding comment. - */
256         /* This over-allocates proportional to the list size, making room
257          * for additional growth.  The over-allocation is mild, but is
258          * enough to give linear-time amortized behavior over a long
259          * sequence of appends() in the presence of a poorly-performing
260          * system realloc().
261          * The growth pattern is:  0, 4, 8, 16, 25, 35, 46, 58, 72, 88, ...
262          */
263         newsize = newlen;
264         newsize = (newsize >> 3) + (newsize < 9 ? 3 : 6) + newsize;
265
266         if (is_grow == false)
267                 idp_resize_group_array(prop, newlen, prop->data.pointer);
268
269         prop->data.pointer = MEM_recallocN(
270                 prop->data.pointer, idp_size_table[(int)prop->subtype] * (size_t)newsize);
271
272         if (is_grow == true)
273                 idp_resize_group_array(prop, newlen, prop->data.pointer);
274
275         prop->len = newlen;
276         prop->totallen = newsize;
277 }
278
279 void IDP_FreeArray(IDProperty *prop)
280 {
281         if (prop->data.pointer) {
282                 idp_resize_group_array(prop, 0, NULL);
283                 MEM_freeN(prop->data.pointer);
284         }
285 }
286
287
288 static IDProperty *idp_generic_copy(const IDProperty *prop)
289 {
290         IDProperty *newp = MEM_callocN(sizeof(IDProperty), "IDProperty array dup");
291
292         BLI_strncpy(newp->name, prop->name, MAX_IDPROP_NAME);
293         newp->type = prop->type;
294         newp->flag = prop->flag;
295         newp->data.val = prop->data.val;
296         newp->data.val2 = prop->data.val2;
297
298         return newp;
299 }
300
301 static IDProperty *IDP_CopyArray(const IDProperty *prop)
302 {
303         IDProperty *newp = idp_generic_copy(prop);
304
305         if (prop->data.pointer) {
306                 newp->data.pointer = MEM_dupallocN(prop->data.pointer);
307
308                 if (prop->type == IDP_GROUP) {
309                         IDProperty **array = newp->data.pointer;
310                         int a;
311
312                         for (a = 0; a < prop->len; a++)
313                                 array[a] = IDP_CopyProperty(array[a]);
314                 }
315         }
316         newp->len = prop->len;
317         newp->subtype = prop->subtype;
318         newp->totallen = prop->totallen;
319
320         return newp;
321 }
322 /** \} */
323
324
325 /* -------------------------------------------------------------------- */
326 /* String Functions */
327
328 /** \name IDProperty String API
329  * \{ */
330
331 /**
332  *
333  * \param st  The string to assign.
334  * \param name  The property name.
335  * \param maxlen  The size of the new string (including the \0 terminator).
336  * \return The new string property.
337  */
338 IDProperty *IDP_NewString(const char *st, const char *name, int maxlen)
339 {
340         IDProperty *prop = MEM_callocN(sizeof(IDProperty), "IDProperty string");
341
342         if (st == NULL) {
343                 prop->data.pointer = MEM_mallocN(DEFAULT_ALLOC_FOR_NULL_STRINGS, "id property string 1");
344                 *IDP_String(prop) = '\0';
345                 prop->totallen = DEFAULT_ALLOC_FOR_NULL_STRINGS;
346                 prop->len = 1;  /* NULL string, has len of 1 to account for null byte. */
347         }
348         else {
349                 /* include null terminator '\0' */
350                 int stlen = (int)strlen(st) + 1;
351
352                 if (maxlen > 0 && maxlen < stlen)
353                         stlen = maxlen;
354
355                 prop->data.pointer = MEM_mallocN((size_t)stlen, "id property string 2");
356                 prop->len = prop->totallen = stlen;
357                 BLI_strncpy(prop->data.pointer, st, (size_t)stlen);
358         }
359
360         prop->type = IDP_STRING;
361         BLI_strncpy(prop->name, name, MAX_IDPROP_NAME);
362
363         return prop;
364 }
365
366 static IDProperty *IDP_CopyString(const IDProperty *prop)
367 {
368         IDProperty *newp;
369
370         BLI_assert(prop->type == IDP_STRING);
371         newp = idp_generic_copy(prop);
372
373         if (prop->data.pointer)
374                 newp->data.pointer = MEM_dupallocN(prop->data.pointer);
375         newp->len = prop->len;
376         newp->subtype = prop->subtype;
377         newp->totallen = prop->totallen;
378
379         return newp;
380 }
381
382
383 void IDP_AssignString(IDProperty *prop, const char *st, int maxlen)
384 {
385         int stlen;
386
387         BLI_assert(prop->type == IDP_STRING);
388         stlen = (int)strlen(st);
389         if (maxlen > 0 && maxlen < stlen)
390                 stlen = maxlen;
391
392         if (prop->subtype == IDP_STRING_SUB_BYTE) {
393                 IDP_ResizeArray(prop, stlen);
394                 memcpy(prop->data.pointer, st, (size_t)stlen);
395         }
396         else {
397                 stlen++;
398                 IDP_ResizeArray(prop, stlen);
399                 BLI_strncpy(prop->data.pointer, st, (size_t)stlen);
400         }
401 }
402
403 void IDP_ConcatStringC(IDProperty *prop, const char *st)
404 {
405         int newlen;
406
407         BLI_assert(prop->type == IDP_STRING);
408
409         newlen = prop->len + (int)strlen(st);
410         /* we have to remember that prop->len includes the null byte for strings.
411          * so there's no need to add +1 to the resize function.*/
412         IDP_ResizeArray(prop, newlen);
413         strcat(prop->data.pointer, st);
414 }
415
416 void IDP_ConcatString(IDProperty *str1, IDProperty *append)
417 {
418         int newlen;
419
420         BLI_assert(append->type == IDP_STRING);
421
422         /* since ->len for strings includes the NULL byte, we have to subtract one or
423          * we'll get an extra null byte after each concatenation operation.*/
424         newlen = str1->len + append->len - 1;
425         IDP_ResizeArray(str1, newlen);
426         strcat(str1->data.pointer, append->data.pointer);
427 }
428
429 void IDP_FreeString(IDProperty *prop)
430 {
431         BLI_assert(prop->type == IDP_STRING);
432
433         if (prop->data.pointer)
434                 MEM_freeN(prop->data.pointer);
435 }
436 /** \} */
437
438
439 /* -------------------------------------------------------------------- */
440 /* ID Type */
441
442 /** \name IDProperty ID API
443  * \{ */
444
445 static IDProperty *IDP_CopyID(const IDProperty *prop)
446 {
447         IDProperty *newp;
448
449         BLI_assert(prop->type == IDP_ID);
450         newp = idp_generic_copy(prop);
451
452         newp->data.pointer = prop->data.pointer;
453         id_us_plus(IDP_Id(newp));
454
455         return newp;
456 }
457
458 /** \} */
459
460
461 /* -------------------------------------------------------------------- */
462 /* Group Functions */
463
464 /** \name IDProperty Group API
465  * \{ */
466
467 /**
468  * Checks if a property with the same name as prop exists, and if so replaces it.
469  */
470 static IDProperty *IDP_CopyGroup(const IDProperty *prop)
471 {
472         IDProperty *newp, *link;
473         
474         BLI_assert(prop->type == IDP_GROUP);
475         newp = idp_generic_copy(prop);
476         newp->len = prop->len;
477
478         for (link = prop->data.group.first; link; link = link->next) {
479                 BLI_addtail(&newp->data.group, IDP_CopyProperty(link));
480         }
481
482         return newp;
483 }
484
485 /* use for syncing proxies.
486  * When values name and types match, copy the values, else ignore */
487 void IDP_SyncGroupValues(IDProperty *dest, const IDProperty *src)
488 {
489         IDProperty *other, *prop;
490
491         BLI_assert(dest->type == IDP_GROUP);
492         BLI_assert(src->type == IDP_GROUP);
493
494         for (prop = src->data.group.first; prop; prop = prop->next) {
495                 other = BLI_findstring(&dest->data.group, prop->name, offsetof(IDProperty, name));
496                 if (other && prop->type == other->type) {
497                         switch (prop->type) {
498                                 case IDP_INT:
499                                 case IDP_FLOAT:
500                                 case IDP_DOUBLE:
501                                         other->data = prop->data;
502                                         break;
503                                 case IDP_GROUP:
504                                         IDP_SyncGroupValues(other, prop);
505                                         break;
506                                 default:
507                                 {
508                                         BLI_insertlinkreplace(&dest->data.group, other, IDP_CopyProperty(prop));
509                                         IDP_FreeProperty(other);
510                                         MEM_freeN(other);
511                                         break;
512                                 }
513                         }
514                 }
515         }
516 }
517
518 void IDP_SyncGroupTypes(IDProperty *dst, const IDProperty *src, const bool do_arraylen)
519 {
520         IDProperty *prop_dst, *prop_dst_next;
521         const IDProperty *prop_src;
522
523         for (prop_dst = dst->data.group.first; prop_dst; prop_dst = prop_dst_next) {
524                 prop_dst_next = prop_dst->next;
525                 if ((prop_src = IDP_GetPropertyFromGroup((IDProperty *)src, prop_dst->name))) {
526                         /* check of we should replace? */
527                         if ((prop_dst->type != prop_src->type || prop_dst->subtype != prop_src->subtype) ||
528                             (do_arraylen && ELEM(prop_dst->type, IDP_ARRAY, IDP_IDPARRAY) && (prop_src->len != prop_dst->len)))
529                         {
530                                 BLI_insertlinkreplace(&dst->data.group, prop_dst, IDP_CopyProperty(prop_src));
531                                 IDP_FreeProperty(prop_dst);
532                                 MEM_freeN(prop_dst);
533                         }
534                         else if (prop_dst->type == IDP_GROUP) {
535                                 IDP_SyncGroupTypes(prop_dst, prop_src, do_arraylen);
536                         }
537                 }
538                 else {
539                         IDP_FreeFromGroup(dst, prop_dst);
540                 }
541         }
542 }
543
544 /**
545  * Replaces all properties with the same name in a destination group from a source group.
546  */
547 void IDP_ReplaceGroupInGroup(IDProperty *dest, const IDProperty *src)
548 {
549         IDProperty *loop, *prop;
550
551         BLI_assert(dest->type == IDP_GROUP);
552         BLI_assert(src->type == IDP_GROUP);
553
554         for (prop = src->data.group.first; prop; prop = prop->next) {
555                 for (loop = dest->data.group.first; loop; loop = loop->next) {
556                         if (STREQ(loop->name, prop->name)) {
557                                 BLI_insertlinkreplace(&dest->data.group, loop, IDP_CopyProperty(prop));
558                                 IDP_FreeProperty(loop);
559                                 MEM_freeN(loop);
560                                 break;
561                         }
562                 }
563
564                 /* only add at end if not added yet */
565                 if (loop == NULL) {
566                         IDProperty *copy = IDP_CopyProperty(prop);
567                         dest->len++;
568                         BLI_addtail(&dest->data.group, copy);
569                 }
570         }
571 }
572
573 /**
574  * Checks if a property with the same name as prop exists, and if so replaces it.
575  * Use this to preserve order!
576  */
577 void IDP_ReplaceInGroup_ex(IDProperty *group, IDProperty *prop, IDProperty *prop_exist)
578 {
579         BLI_assert(group->type == IDP_GROUP);
580
581         BLI_assert(prop_exist == IDP_GetPropertyFromGroup(group, prop->name));
582
583         if ((prop_exist = IDP_GetPropertyFromGroup(group, prop->name))) {
584                 BLI_insertlinkreplace(&group->data.group, prop_exist, prop);
585                 IDP_FreeProperty(prop_exist);
586                 MEM_freeN(prop_exist);
587         }
588         else {
589                 group->len++;
590                 BLI_addtail(&group->data.group, prop);
591         }
592 }
593
594 void IDP_ReplaceInGroup(IDProperty *group, IDProperty *prop)
595 {
596         IDProperty *prop_exist = IDP_GetPropertyFromGroup(group, prop->name);
597
598         IDP_ReplaceInGroup_ex(group, prop, prop_exist);
599 }
600
601 /**
602  * If a property is missing in \a dest, add it.
603  */
604 void IDP_MergeGroup(IDProperty *dest, const IDProperty *src, const bool do_overwrite)
605 {
606         IDProperty *prop;
607
608         BLI_assert(dest->type == IDP_GROUP);
609         BLI_assert(src->type == IDP_GROUP);
610
611         if (do_overwrite) {
612                 for (prop = src->data.group.first; prop; prop = prop->next) {
613                         IDProperty *copy = IDP_CopyProperty(prop);
614                         IDP_ReplaceInGroup(dest, copy);
615                 }
616         }
617         else {
618                 for (prop = src->data.group.first; prop; prop = prop->next) {
619                         if (IDP_GetPropertyFromGroup(dest, prop->name) == NULL) {
620                                 IDProperty *copy = IDP_CopyProperty(prop);
621                                 dest->len++;
622                                 BLI_addtail(&dest->data.group, copy);
623                         }
624                 }
625         }
626 }
627
628 /**
629  * This function has a sanity check to make sure ID properties with the same name don't
630  * get added to the group.
631  *
632  * The sanity check just means the property is not added to the group if another property
633  * exists with the same name; the client code using ID properties then needs to detect this
634  * (the function that adds new properties to groups, IDP_AddToGroup, returns false if a property can't
635  * be added to the group, and true if it can) and free the property.
636  *
637  * Currently the code to free ID properties is designed to leave the actual struct
638  * you pass it un-freed, this is needed for how the system works.  This means
639  * to free an ID property, you first call IDP_FreeProperty then MEM_freeN the
640  * struct.  In the future this will just be IDP_FreeProperty and the code will
641  * be reorganized to work properly.
642  */
643 bool IDP_AddToGroup(IDProperty *group, IDProperty *prop)
644 {
645         BLI_assert(group->type == IDP_GROUP);
646
647         if (IDP_GetPropertyFromGroup(group, prop->name) == NULL) {
648                 group->len++;
649                 BLI_addtail(&group->data.group, prop);
650                 return true;
651         }
652
653         return false;
654 }
655
656 /**
657  * This is the same as IDP_AddToGroup, only you pass an item
658  * in the group list to be inserted after.
659  */
660 bool IDP_InsertToGroup(IDProperty *group, IDProperty *previous, IDProperty *pnew)
661 {
662         BLI_assert(group->type == IDP_GROUP);
663
664         if (IDP_GetPropertyFromGroup(group, pnew->name) == NULL) {
665                 group->len++;
666                 BLI_insertlinkafter(&group->data.group, previous, pnew);
667                 return true;
668         }
669
670         return false;
671 }
672
673 /**
674  * \note this does not free the property!!
675  *
676  * To free the property, you have to do:
677  * IDP_FreeProperty(prop); //free all subdata
678  * MEM_freeN(prop); //free property struct itself
679  */
680 void IDP_RemoveFromGroup(IDProperty *group, IDProperty *prop)
681 {
682         BLI_assert(group->type == IDP_GROUP);
683
684         group->len--;
685         BLI_remlink(&group->data.group, prop);
686 }
687
688 /**
689  * Removes the property from the group and frees it.
690  */
691 void IDP_FreeFromGroup(IDProperty *group, IDProperty *prop)
692 {
693         IDP_RemoveFromGroup(group, prop);
694         IDP_FreeProperty(prop);
695         MEM_freeN(prop);
696 }
697
698 IDProperty *IDP_GetPropertyFromGroup(IDProperty *prop, const char *name)
699 {
700         BLI_assert(prop->type == IDP_GROUP);
701
702         return (IDProperty *)BLI_findstring(&prop->data.group, name, offsetof(IDProperty, name));
703 }
704 /** same as above but ensure type match */
705 IDProperty *IDP_GetPropertyTypeFromGroup(IDProperty *prop, const char *name, const char type)
706 {
707         IDProperty *idprop = IDP_GetPropertyFromGroup(prop, name);
708         return (idprop && idprop->type == type) ? idprop : NULL;
709 }
710
711 /* Ok, the way things work, Groups free the ID Property structs of their children.
712  * This is because all ID Property freeing functions free only direct data (not the ID Property
713  * struct itself), but for Groups the child properties *are* considered
714  * direct data. */
715 static void IDP_FreeGroup(IDProperty *prop, const bool do_id_user)
716 {
717         IDProperty *loop;
718
719         BLI_assert(prop->type == IDP_GROUP);
720         for (loop = prop->data.group.first; loop; loop = loop->next) {
721                 IDP_FreeProperty_ex(loop, do_id_user);
722         }
723         BLI_freelistN(&prop->data.group);
724 }
725 /** \} */
726
727
728 /* -------------------------------------------------------------------- */
729 /* Main Functions */
730
731 /** \name IDProperty Main API
732  * \{ */
733 IDProperty *IDP_CopyProperty(const IDProperty *prop)
734 {
735         switch (prop->type) {
736                 case IDP_GROUP: return IDP_CopyGroup(prop);
737                 case IDP_STRING: return IDP_CopyString(prop);
738                 case IDP_ID: return IDP_CopyID(prop);
739                 case IDP_ARRAY: return IDP_CopyArray(prop);
740                 case IDP_IDPARRAY: return IDP_CopyIDPArray(prop);
741                 default: return idp_generic_copy(prop);
742         }
743 }
744
745 /* Updates ID pointers after an object has been copied */
746 /* TODO Nuke this once its only user has been correctly converted to use generic ID management from BKE_library! */
747 void IDP_RelinkProperty(struct IDProperty *prop)
748 {
749         if (!prop)
750                 return;
751
752         switch (prop->type) {
753                 case IDP_GROUP:
754                 {
755                         for (IDProperty *loop = prop->data.group.first; loop; loop = loop->next) {
756                                 IDP_RelinkProperty(loop);
757                         }
758                         break;
759                 }
760                 case IDP_IDPARRAY:
761                 {
762                         IDProperty *idp_array = IDP_Array(prop);
763                         for (int i = 0; i < prop->len; i++) {
764                                 IDP_RelinkProperty(&idp_array[i]);
765                         }
766                         break;
767                 }
768                 case IDP_ID:
769                 {
770                         ID *id = IDP_Id(prop);
771                         if (id && id->newid) {
772                                 id_us_min(IDP_Id(prop));
773                                 prop->data.pointer = id->newid;
774                                 id_us_plus(IDP_Id(prop));
775                         }
776                         break;
777                 }
778                 default:
779                         break;  /* Nothing to do for other IDProp types. */
780         }
781 }
782
783 /**
784  * Get the Group property that contains the id properties for ID id.  Set create_if_needed
785  * to create the Group property and attach it to id if it doesn't exist; otherwise
786  * the function will return NULL if there's no Group property attached to the ID.
787  */
788 IDProperty *IDP_GetProperties(ID *id, const bool create_if_needed)
789 {
790         if (id->properties) {
791                 return id->properties;
792         }
793         else {
794                 if (create_if_needed) {
795                         id->properties = MEM_callocN(sizeof(IDProperty), "IDProperty");
796                         id->properties->type = IDP_GROUP;
797                         /* don't overwrite the data's name and type
798                          * some functions might need this if they
799                          * don't have a real ID, should be named elsewhere - Campbell */
800                         /* strcpy(id->name, "top_level_group");*/
801                 }
802                 return id->properties;
803         }
804 }
805
806 /**
807  * \param is_strict When false treat missing items as a match */
808 bool IDP_EqualsProperties_ex(IDProperty *prop1, IDProperty *prop2, const bool is_strict)
809 {
810         if (prop1 == NULL && prop2 == NULL)
811                 return true;
812         else if (prop1 == NULL || prop2 == NULL)
813                 return is_strict ? false : true;
814         else if (prop1->type != prop2->type)
815                 return false;
816
817         switch (prop1->type) {
818                 case IDP_INT:
819                         return (IDP_Int(prop1) == IDP_Int(prop2));
820                 case IDP_FLOAT:
821 #if !defined(NDEBUG) && defined(WITH_PYTHON)
822                         {
823                                 float p1 = IDP_Float(prop1);
824                                 float p2 = IDP_Float(prop2);
825                                 if ((p1 != p2) && ((fabsf(p1 - p2) / max_ff(p1, p2)) < 0.001f)) {
826                                         printf("WARNING: Comparing two float properties that have nearly the same value (%f vs. %f)\n", p1, p2);
827                                         printf("    p1: ");
828                                         IDP_spit(prop1);
829                                         printf("    p2: ");
830                                         IDP_spit(prop2);
831                                 }
832                         }
833 #endif
834                         return (IDP_Float(prop1) == IDP_Float(prop2));
835                 case IDP_DOUBLE:
836                         return (IDP_Double(prop1) == IDP_Double(prop2));
837                 case IDP_STRING:
838                 {
839                         return (((prop1->len == prop2->len) &&
840                                  STREQLEN(IDP_String(prop1), IDP_String(prop2), (size_t)prop1->len)));
841                 }
842                 case IDP_ARRAY:
843                         if (prop1->len == prop2->len && prop1->subtype == prop2->subtype) {
844                                 return (memcmp(IDP_Array(prop1),
845                                                IDP_Array(prop2),
846                                                idp_size_table[(int)prop1->subtype] * (size_t)prop1->len) == 0);
847                         }
848                         return false;
849                 case IDP_GROUP:
850                 {
851                         IDProperty *link1, *link2;
852
853                         if (is_strict && prop1->len != prop2->len)
854                                 return false;
855
856                         for (link1 = prop1->data.group.first; link1; link1 = link1->next) {
857                                 link2 = IDP_GetPropertyFromGroup(prop2, link1->name);
858
859                                 if (!IDP_EqualsProperties_ex(link1, link2, is_strict))
860                                         return false;
861                         }
862
863                         return true;
864                 }
865                 case IDP_IDPARRAY:
866                 {
867                         IDProperty *array1 = IDP_IDPArray(prop1);
868                         IDProperty *array2 = IDP_IDPArray(prop2);
869                         int i;
870
871                         if (prop1->len != prop2->len)
872                                 return false;
873
874                         for (i = 0; i < prop1->len; i++)
875                                 if (!IDP_EqualsProperties(&array1[i], &array2[i]))
876                                         return false;
877                         return true;
878                 }
879                 case IDP_ID:
880                         return (IDP_Id(prop1) == IDP_Id(prop2));
881                 default:
882                         /* should never get here */
883                         BLI_assert(0);
884                         break;
885         }
886
887         return true;
888 }
889
890 bool IDP_EqualsProperties(IDProperty *prop1, IDProperty *prop2)
891 {
892         return IDP_EqualsProperties_ex(prop1, prop2, true);
893 }
894
895 /**
896  * Allocate a new ID.
897  *
898  * This function takes three arguments: the ID property type, a union which defines
899  * it's initial value, and a name.
900  *
901  * The union is simple to use; see the top of this header file for its definition.
902  * An example of using this function:
903  *
904  * \code{.c}
905  * IDPropertyTemplate val;
906  * IDProperty *group, *idgroup, *color;
907  * group = IDP_New(IDP_GROUP, val, "group1"); //groups don't need a template.
908  *
909  * val.array.len = 4
910  * val.array.type = IDP_FLOAT;
911  * color = IDP_New(IDP_ARRAY, val, "color1");
912  *
913  * idgroup = IDP_GetProperties(some_id, 1);
914  * IDP_AddToGroup(idgroup, color);
915  * IDP_AddToGroup(idgroup, group);
916  * \endcode
917  *
918  * Note that you MUST either attach the id property to an id property group with
919  * IDP_AddToGroup or MEM_freeN the property, doing anything else might result in
920  * a memory leak.
921  */
922 IDProperty *IDP_New(const char type, const IDPropertyTemplate *val, const char *name)
923 {
924         IDProperty *prop = NULL;
925
926         switch (type) {
927                 case IDP_INT:
928                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty int");
929                         prop->data.val = val->i;
930                         break;
931                 case IDP_FLOAT:
932                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty float");
933                         *(float *)&prop->data.val = val->f;
934                         break;
935                 case IDP_DOUBLE:
936                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty double");
937                         *(double *)&prop->data.val = val->d;
938                         break;
939                 case IDP_ARRAY:
940                 {
941                         /* for now, we only support float and int and double arrays */
942                         if ( (val->array.type == IDP_FLOAT) ||
943                              (val->array.type == IDP_INT) ||
944                              (val->array.type == IDP_DOUBLE) ||
945                              (val->array.type == IDP_GROUP) )
946                         {
947                                 prop = MEM_callocN(sizeof(IDProperty), "IDProperty array");
948                                 prop->subtype = val->array.type;
949                                 if (val->array.len) {
950                                         prop->data.pointer = MEM_callocN(
951                                                 idp_size_table[val->array.type] * (size_t)val->array.len, "id property array");
952                                 }
953                                 prop->len = prop->totallen = val->array.len;
954                                 break;
955                         }
956                         printf("%s: bad array type.\n",__func__);
957                         return NULL;
958                 }
959                 case IDP_STRING:
960                 {
961                         const char *st = val->string.str;
962
963                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty string");
964                         if (val->string.subtype == IDP_STRING_SUB_BYTE) {
965                                 /* note, intentionally not null terminated */
966                                 if (st == NULL) {
967                                         prop->data.pointer = MEM_mallocN(DEFAULT_ALLOC_FOR_NULL_STRINGS, "id property string 1");
968                                         *IDP_String(prop) = '\0';
969                                         prop->totallen = DEFAULT_ALLOC_FOR_NULL_STRINGS;
970                                         prop->len = 0;
971                                 }
972                                 else {
973                                         prop->data.pointer = MEM_mallocN((size_t)val->string.len, "id property string 2");
974                                         prop->len = prop->totallen = val->string.len;
975                                         memcpy(prop->data.pointer, st, (size_t)val->string.len);
976                                 }
977                                 prop->subtype = IDP_STRING_SUB_BYTE;
978                         }
979                         else {
980                                 if (st == NULL || val->string.len <= 1) {
981                                         prop->data.pointer = MEM_mallocN(DEFAULT_ALLOC_FOR_NULL_STRINGS, "id property string 1");
982                                         *IDP_String(prop) = '\0';
983                                         prop->totallen = DEFAULT_ALLOC_FOR_NULL_STRINGS;
984                                         prop->len = 1; /*NULL string, has len of 1 to account for null byte.*/
985                                 }
986                                 else {
987                                         BLI_assert((int)val->string.len <= (int)strlen(st) + 1);
988                                         prop->data.pointer = MEM_mallocN((size_t)val->string.len, "id property string 3");
989                                         memcpy(prop->data.pointer, st, (size_t)val->string.len - 1);
990                                         IDP_String(prop)[val->string.len - 1] = '\0';
991                                         prop->len = prop->totallen = val->string.len;
992                                 }
993                                 prop->subtype = IDP_STRING_SUB_UTF8;
994                         }
995                         break;
996                 }
997                 case IDP_GROUP:
998                 {
999                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty group");
1000                         /* heh I think all needed values are set properly by calloc anyway :) */
1001                         break;
1002                 }
1003                 case IDP_ID:
1004                 {
1005                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty datablock");
1006                         prop->data.pointer = (void *)val->id;
1007                         prop->type = IDP_ID;
1008                         id_us_plus(IDP_Id(prop));
1009                         break;
1010                 }
1011                 default:
1012                 {
1013                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty array");
1014                         break;
1015                 }
1016         }
1017
1018         prop->type = type;
1019         BLI_strncpy(prop->name, name, MAX_IDPROP_NAME);
1020         
1021         return prop;
1022 }
1023
1024 /**
1025  * \note This will free allocated data, all child properties of arrays and groups, and unlink IDs!
1026  * But it does not free the actual IDProperty struct itself.
1027  */
1028 void IDP_FreeProperty_ex(IDProperty *prop, const bool do_id_user)
1029 {
1030         switch (prop->type) {
1031                 case IDP_ARRAY:
1032                         IDP_FreeArray(prop);
1033                         break;
1034                 case IDP_STRING:
1035                         IDP_FreeString(prop);
1036                         break;
1037                 case IDP_GROUP:
1038                         IDP_FreeGroup(prop, do_id_user);
1039                         break;
1040                 case IDP_IDPARRAY:
1041                         IDP_FreeIDPArray(prop, do_id_user);
1042                         break;
1043                 case IDP_ID:
1044                         if (do_id_user) {
1045                                 id_us_min(IDP_Id(prop));
1046                         }
1047                         break;
1048         }
1049 }
1050
1051 void IDP_FreeProperty(IDProperty *prop)
1052 {
1053         IDP_FreeProperty_ex(prop, true);
1054 }
1055
1056 void IDP_ClearProperty(IDProperty *prop)
1057 {
1058         IDP_FreeProperty(prop);
1059         prop->data.pointer = NULL;
1060         prop->len = prop->totallen = 0;
1061 }
1062
1063 /** \} */