Merge branch 'master' into blender2.8
[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 void IDP_FreeIDPArray(IDProperty *prop)
121 {
122         int i;
123         
124         BLI_assert(prop->type == IDP_IDPARRAY);
125
126         for (i = 0; i < prop->len; i++)
127                 IDP_FreeProperty(GETPROP(prop, i));
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 (not in use yet) */
441
442 /** \name IDProperty ID API (unused)
443  * \{ */
444 void IDP_LinkID(IDProperty *prop, ID *id)
445 {
446         if (prop->data.pointer)
447                 id_us_min(((ID *)prop->data.pointer));
448         prop->data.pointer = id;
449         id_us_plus(id);
450 }
451
452 void IDP_UnlinkID(IDProperty *prop)
453 {
454         id_us_min(((ID *)prop->data.pointer));
455 }
456 /** \} */
457
458
459 /* -------------------------------------------------------------------- */
460 /* Group Functions */
461
462 /** \name IDProperty Group API
463  * \{ */
464
465 /**
466  * Checks if a property with the same name as prop exists, and if so replaces it.
467  */
468 static IDProperty *IDP_CopyGroup(const IDProperty *prop)
469 {
470         IDProperty *newp, *link;
471         
472         BLI_assert(prop->type == IDP_GROUP);
473         newp = idp_generic_copy(prop);
474         newp->len = prop->len;
475         newp->subtype = prop->subtype;
476
477         for (link = prop->data.group.first; link; link = link->next) {
478                 BLI_addtail(&newp->data.group, IDP_CopyProperty(link));
479         }
480
481         return newp;
482 }
483
484 /* use for syncing proxies.
485  * When values name and types match, copy the values, else ignore */
486 void IDP_SyncGroupValues(IDProperty *dest, const IDProperty *src)
487 {
488         IDProperty *other, *prop;
489
490         BLI_assert(dest->type == IDP_GROUP);
491         BLI_assert(src->type == IDP_GROUP);
492
493         for (prop = src->data.group.first; prop; prop = prop->next) {
494                 other = BLI_findstring(&dest->data.group, prop->name, offsetof(IDProperty, name));
495                 if (other && prop->type == other->type) {
496                         switch (prop->type) {
497                                 case IDP_INT:
498                                 case IDP_FLOAT:
499                                 case IDP_DOUBLE:
500                                         other->data = prop->data;
501                                         break;
502                                 case IDP_GROUP:
503                                         IDP_SyncGroupValues(other, prop);
504                                         break;
505                                 default:
506                                 {
507                                         BLI_insertlinkreplace(&dest->data.group, other, IDP_CopyProperty(prop));
508                                         IDP_FreeProperty(other);
509                                         MEM_freeN(other);
510                                         break;
511                                 }
512                         }
513                 }
514         }
515 }
516
517 void IDP_SyncGroupTypes(IDProperty *dst, const IDProperty *src, const bool do_arraylen)
518 {
519         IDProperty *prop_dst, *prop_dst_next;
520         const IDProperty *prop_src;
521
522         for (prop_dst = dst->data.group.first; prop_dst; prop_dst = prop_dst_next) {
523                 prop_dst_next = prop_dst->next;
524                 if ((prop_src = IDP_GetPropertyFromGroup((IDProperty *)src, prop_dst->name))) {
525                         /* check of we should replace? */
526                         if ((prop_dst->type != prop_src->type || prop_dst->subtype != prop_src->subtype) ||
527                             (do_arraylen && ELEM(prop_dst->type, IDP_ARRAY, IDP_IDPARRAY) && (prop_src->len != prop_dst->len)))
528                         {
529                                 BLI_insertlinkreplace(&dst->data.group, prop_dst, IDP_CopyProperty(prop_src));
530                                 IDP_FreeProperty(prop_dst);
531                                 MEM_freeN(prop_dst);
532                         }
533                         else if (prop_dst->type == IDP_GROUP) {
534                                 IDP_SyncGroupTypes(prop_dst, prop_src, do_arraylen);
535                         }
536                 }
537                 else {
538                         IDP_FreeFromGroup(dst, prop_dst);
539                 }
540         }
541 }
542
543 /**
544  * Replaces all properties with the same name in a destination group from a source group.
545  */
546 void IDP_ReplaceGroupInGroup(IDProperty *dest, const IDProperty *src)
547 {
548         IDProperty *loop, *prop;
549
550         BLI_assert(dest->type == IDP_GROUP);
551         BLI_assert(src->type == IDP_GROUP);
552
553         for (prop = src->data.group.first; prop; prop = prop->next) {
554                 for (loop = dest->data.group.first; loop; loop = loop->next) {
555                         if (STREQ(loop->name, prop->name)) {
556                                 BLI_insertlinkreplace(&dest->data.group, loop, IDP_CopyProperty(prop));
557                                 IDP_FreeProperty(loop);
558                                 MEM_freeN(loop);
559                                 break;
560                         }
561                 }
562
563                 /* only add at end if not added yet */
564                 if (loop == NULL) {
565                         IDProperty *copy = IDP_CopyProperty(prop);
566                         dest->len++;
567                         BLI_addtail(&dest->data.group, copy);
568                 }
569         }
570 }
571
572 /**
573  * Checks if a property with the same name as prop exists, and if so replaces it.
574  * Use this to preserve order!
575  */
576 void IDP_ReplaceInGroup_ex(IDProperty *group, IDProperty *prop, IDProperty *prop_exist)
577 {
578         BLI_assert(group->type == IDP_GROUP);
579
580         BLI_assert(prop_exist == IDP_GetPropertyFromGroup(group, prop->name));
581
582         if ((prop_exist = IDP_GetPropertyFromGroup(group, prop->name))) {
583                 BLI_insertlinkreplace(&group->data.group, prop_exist, prop);
584                 IDP_FreeProperty(prop_exist);
585                 MEM_freeN(prop_exist);
586         }
587         else {
588                 group->len++;
589                 BLI_addtail(&group->data.group, prop);
590         }
591 }
592
593 void IDP_ReplaceInGroup(IDProperty *group, IDProperty *prop)
594 {
595         IDProperty *prop_exist = IDP_GetPropertyFromGroup(group, prop->name);
596
597         IDP_ReplaceInGroup_ex(group, prop, prop_exist);
598 }
599
600 /**
601  * If a property is missing in \a dest, add it.
602  */
603 void IDP_MergeGroup(IDProperty *dest, const IDProperty *src, const bool do_overwrite)
604 {
605         IDProperty *prop;
606
607         BLI_assert(dest->type == IDP_GROUP);
608         BLI_assert(src->type == IDP_GROUP);
609
610         if (do_overwrite) {
611                 for (prop = src->data.group.first; prop; prop = prop->next) {
612                         IDProperty *copy = IDP_CopyProperty(prop);
613                         IDP_ReplaceInGroup(dest, copy);
614                 }
615         }
616         else {
617                 for (prop = src->data.group.first; prop; prop = prop->next) {
618                         if (IDP_GetPropertyFromGroup(dest, prop->name) == NULL) {
619                                 IDProperty *copy = IDP_CopyProperty(prop);
620                                 dest->len++;
621                                 BLI_addtail(&dest->data.group, copy);
622                         }
623                 }
624         }
625 }
626
627 /**
628  * This function has a sanity check to make sure ID properties with the same name don't
629  * get added to the group.
630  *
631  * The sanity check just means the property is not added to the group if another property
632  * exists with the same name; the client code using ID properties then needs to detect this
633  * (the function that adds new properties to groups, IDP_AddToGroup, returns false if a property can't
634  * be added to the group, and true if it can) and free the property.
635  *
636  * Currently the code to free ID properties is designed to leave the actual struct
637  * you pass it un-freed, this is needed for how the system works.  This means
638  * to free an ID property, you first call IDP_FreeProperty then MEM_freeN the
639  * struct.  In the future this will just be IDP_FreeProperty and the code will
640  * be reorganized to work properly.
641  */
642 bool IDP_AddToGroup(IDProperty *group, IDProperty *prop)
643 {
644         BLI_assert(group->type == IDP_GROUP);
645
646         if (IDP_GetPropertyFromGroup(group, prop->name) == NULL) {
647                 group->len++;
648                 BLI_addtail(&group->data.group, prop);
649                 return true;
650         }
651
652         return false;
653 }
654
655 /**
656  * This is the same as IDP_AddToGroup, only you pass an item
657  * in the group list to be inserted after.
658  */
659 bool IDP_InsertToGroup(IDProperty *group, IDProperty *previous, IDProperty *pnew)
660 {
661         BLI_assert(group->type == IDP_GROUP);
662
663         if (IDP_GetPropertyFromGroup(group, pnew->name) == NULL) {
664                 group->len++;
665                 BLI_insertlinkafter(&group->data.group, previous, pnew);
666                 return true;
667         }
668
669         return false;
670 }
671
672 /**
673  * \note this does not free the property!!
674  *
675  * To free the property, you have to do:
676  * IDP_FreeProperty(prop); //free all subdata
677  * MEM_freeN(prop); //free property struct itself
678  */
679 void IDP_RemoveFromGroup(IDProperty *group, IDProperty *prop)
680 {
681         BLI_assert(group->type == IDP_GROUP);
682
683         group->len--;
684         BLI_remlink(&group->data.group, prop);
685 }
686
687 /**
688  * Removes the property from the group and frees it.
689  */
690 void IDP_FreeFromGroup(IDProperty *group, IDProperty *prop)
691 {
692         IDP_RemoveFromGroup(group, prop);
693         IDP_FreeProperty(prop);
694         MEM_freeN(prop);
695 }
696
697 IDProperty *IDP_GetPropertyFromGroup(IDProperty *prop, const char *name)
698 {
699         BLI_assert(prop->type == IDP_GROUP);
700
701         return (IDProperty *)BLI_findstring(&prop->data.group, name, offsetof(IDProperty, name));
702 }
703 /** same as above but ensure type match */
704 IDProperty *IDP_GetPropertyTypeFromGroup(IDProperty *prop, const char *name, const char type)
705 {
706         IDProperty *idprop = IDP_GetPropertyFromGroup(prop, name);
707         return (idprop && idprop->type == type) ? idprop : NULL;
708 }
709
710 /* Ok, the way things work, Groups free the ID Property structs of their children.
711  * This is because all ID Property freeing functions free only direct data (not the ID Property
712  * struct itself), but for Groups the child properties *are* considered
713  * direct data. */
714 static void IDP_FreeGroup(IDProperty *prop)
715 {
716         IDProperty *loop;
717
718         BLI_assert(prop->type == IDP_GROUP);
719         for (loop = prop->data.group.first; loop; loop = loop->next) {
720                 IDP_FreeProperty(loop);
721         }
722         BLI_freelistN(&prop->data.group);
723 }
724 /** \} */
725
726
727 /* -------------------------------------------------------------------- */
728 /* Main Functions */
729
730 /** \name IDProperty Main API
731  * \{ */
732 IDProperty *IDP_CopyProperty(const IDProperty *prop)
733 {
734         switch (prop->type) {
735                 case IDP_GROUP: return IDP_CopyGroup(prop);
736                 case IDP_STRING: return IDP_CopyString(prop);
737                 case IDP_ARRAY: return IDP_CopyArray(prop);
738                 case IDP_IDPARRAY: return IDP_CopyIDPArray(prop);
739                 default: return idp_generic_copy(prop);
740         }
741 }
742
743 /**
744  * Get the Group property that contains the id properties for ID id.  Set create_if_needed
745  * to create the Group property and attach it to id if it doesn't exist; otherwise
746  * the function will return NULL if there's no Group property attached to the ID.
747  */
748 IDProperty *IDP_GetProperties(ID *id, const bool create_if_needed)
749 {
750         if (id->properties) {
751                 return id->properties;
752         }
753         else {
754                 if (create_if_needed) {
755                         id->properties = MEM_callocN(sizeof(IDProperty), "IDProperty");
756                         id->properties->type = IDP_GROUP;
757                         /* don't overwrite the data's name and type
758                          * some functions might need this if they
759                          * don't have a real ID, should be named elsewhere - Campbell */
760                         /* strcpy(id->name, "top_level_group");*/
761                 }
762                 return id->properties;
763         }
764 }
765
766 /**
767  * \param is_strict When false treat missing items as a match */
768 bool IDP_EqualsProperties_ex(IDProperty *prop1, IDProperty *prop2, const bool is_strict)
769 {
770         if (prop1 == NULL && prop2 == NULL)
771                 return true;
772         else if (prop1 == NULL || prop2 == NULL)
773                 return is_strict ? false : true;
774         else if (prop1->type != prop2->type)
775                 return false;
776
777         switch (prop1->type) {
778                 case IDP_INT:
779                         return (IDP_Int(prop1) == IDP_Int(prop2));
780                 case IDP_FLOAT:
781 #if !defined(NDEBUG) && defined(WITH_PYTHON)
782                         {
783                                 float p1 = IDP_Float(prop1);
784                                 float p2 = IDP_Float(prop2);
785                                 if ((p1 != p2) && ((fabsf(p1 - p2) / max_ff(p1, p2)) < 0.001f)) {
786                                         printf("WARNING: Comparing two float properties that have nearly the same value (%f vs. %f)\n", p1, p2);
787                                         printf("    p1: ");
788                                         IDP_spit(prop1);
789                                         printf("    p2: ");
790                                         IDP_spit(prop2);
791                                 }
792                         }
793 #endif
794                         return (IDP_Float(prop1) == IDP_Float(prop2));
795                 case IDP_DOUBLE:
796                         return (IDP_Double(prop1) == IDP_Double(prop2));
797                 case IDP_STRING:
798                 {
799                         return (((prop1->len == prop2->len) &&
800                                  STREQLEN(IDP_String(prop1), IDP_String(prop2), (size_t)prop1->len)));
801                 }
802                 case IDP_ARRAY:
803                         if (prop1->len == prop2->len && prop1->subtype == prop2->subtype) {
804                                 return (memcmp(IDP_Array(prop1),
805                                                IDP_Array(prop2),
806                                                idp_size_table[(int)prop1->subtype] * (size_t)prop1->len) == 0);
807                         }
808                         return false;
809                 case IDP_GROUP:
810                 {
811                         IDProperty *link1, *link2;
812
813                         if (is_strict && prop1->len != prop2->len)
814                                 return false;
815
816                         for (link1 = prop1->data.group.first; link1; link1 = link1->next) {
817                                 link2 = IDP_GetPropertyFromGroup(prop2, link1->name);
818
819                                 if (!IDP_EqualsProperties_ex(link1, link2, is_strict))
820                                         return false;
821                         }
822
823                         return true;
824                 }
825                 case IDP_IDPARRAY:
826                 {
827                         IDProperty *array1 = IDP_IDPArray(prop1);
828                         IDProperty *array2 = IDP_IDPArray(prop2);
829                         int i;
830
831                         if (prop1->len != prop2->len)
832                                 return false;
833
834                         for (i = 0; i < prop1->len; i++)
835                                 if (!IDP_EqualsProperties(&array1[i], &array2[i]))
836                                         return false;
837                         return true;
838                 }
839                 default:
840                         /* should never get here */
841                         BLI_assert(0);
842                         break;
843         }
844
845         return true;
846 }
847
848 bool IDP_EqualsProperties(IDProperty *prop1, IDProperty *prop2)
849 {
850         return IDP_EqualsProperties_ex(prop1, prop2, true);
851 }
852
853 /**
854  * Allocate a new ID.
855  *
856  * This function takes three arguments: the ID property type, a union which defines
857  * it's initial value, and a name.
858  *
859  * The union is simple to use; see the top of this header file for its definition.
860  * An example of using this function:
861  *
862  * \code{.c}
863  * IDPropertyTemplate val;
864  * IDProperty *group, *idgroup, *color;
865  * group = IDP_New(IDP_GROUP, val, "group1"); //groups don't need a template.
866  *
867  * val.array.len = 4
868  * val.array.type = IDP_FLOAT;
869  * color = IDP_New(IDP_ARRAY, val, "color1");
870  *
871  * idgroup = IDP_GetProperties(some_id, 1);
872  * IDP_AddToGroup(idgroup, color);
873  * IDP_AddToGroup(idgroup, group);
874  * \endcode
875  *
876  * Note that you MUST either attach the id property to an id property group with
877  * IDP_AddToGroup or MEM_freeN the property, doing anything else might result in
878  * a memory leak.
879  */
880 IDProperty *IDP_New(const char type, const IDPropertyTemplate *val, const char *name)
881 {
882         IDProperty *prop = NULL;
883
884         switch (type) {
885                 case IDP_INT:
886                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty int");
887                         prop->data.val = val->i;
888                         break;
889                 case IDP_FLOAT:
890                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty float");
891                         *(float *)&prop->data.val = val->f;
892                         break;
893                 case IDP_DOUBLE:
894                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty double");
895                         *(double *)&prop->data.val = val->d;
896                         break;
897                 case IDP_ARRAY:
898                 {
899                         /* for now, we only support float and int and double arrays */
900                         if ( (val->array.type == IDP_FLOAT) ||
901                              (val->array.type == IDP_INT) ||
902                              (val->array.type == IDP_DOUBLE) ||
903                              (val->array.type == IDP_GROUP) )
904                         {
905                                 prop = MEM_callocN(sizeof(IDProperty), "IDProperty array");
906                                 prop->subtype = val->array.type;
907                                 if (val->array.len) {
908                                         prop->data.pointer = MEM_callocN(
909                                                 idp_size_table[val->array.type] * (size_t)val->array.len, "id property array");
910                                 }
911                                 prop->len = prop->totallen = val->array.len;
912                                 break;
913                         }
914                         return NULL;
915                 }
916                 case IDP_STRING:
917                 {
918                         const char *st = val->string.str;
919
920                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty string");
921                         if (val->string.subtype == IDP_STRING_SUB_BYTE) {
922                                 /* note, intentionally not null terminated */
923                                 if (st == NULL) {
924                                         prop->data.pointer = MEM_mallocN(DEFAULT_ALLOC_FOR_NULL_STRINGS, "id property string 1");
925                                         *IDP_String(prop) = '\0';
926                                         prop->totallen = DEFAULT_ALLOC_FOR_NULL_STRINGS;
927                                         prop->len = 0;
928                                 }
929                                 else {
930                                         prop->data.pointer = MEM_mallocN((size_t)val->string.len, "id property string 2");
931                                         prop->len = prop->totallen = val->string.len;
932                                         memcpy(prop->data.pointer, st, (size_t)val->string.len);
933                                 }
934                                 prop->subtype = IDP_STRING_SUB_BYTE;
935                         }
936                         else {
937                                 if (st == NULL || val->string.len <= 1) {
938                                         prop->data.pointer = MEM_mallocN(DEFAULT_ALLOC_FOR_NULL_STRINGS, "id property string 1");
939                                         *IDP_String(prop) = '\0';
940                                         prop->totallen = DEFAULT_ALLOC_FOR_NULL_STRINGS;
941                                         prop->len = 1; /*NULL string, has len of 1 to account for null byte.*/
942                                 }
943                                 else {
944                                         BLI_assert((int)val->string.len <= (int)strlen(st) + 1);
945                                         prop->data.pointer = MEM_mallocN((size_t)val->string.len, "id property string 3");
946                                         memcpy(prop->data.pointer, st, (size_t)val->string.len - 1);
947                                         IDP_String(prop)[val->string.len - 1] = '\0';
948                                         prop->len = prop->totallen = val->string.len;
949                                 }
950                                 prop->subtype = IDP_STRING_SUB_UTF8;
951                         }
952                         break;
953                 }
954                 case IDP_GROUP:
955                 {
956                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty group");
957                         /* heh I think all needed values are set properly by calloc anyway :) */
958                         break;
959                 }
960                 default:
961                 {
962                         prop = MEM_callocN(sizeof(IDProperty), "IDProperty array");
963                         break;
964                 }
965         }
966
967         prop->type = type;
968         BLI_strncpy(prop->name, name, MAX_IDPROP_NAME);
969         
970         return prop;
971 }
972
973 /**
974  * \note this will free all child properties of list arrays and groups!
975  * Also, note that this does NOT unlink anything!  Plus it doesn't free
976  * the actual struct IDProperty struct either.
977  */
978 void IDP_FreeProperty(IDProperty *prop)
979 {
980         switch (prop->type) {
981                 case IDP_ARRAY:
982                         IDP_FreeArray(prop);
983                         break;
984                 case IDP_STRING:
985                         IDP_FreeString(prop);
986                         break;
987                 case IDP_GROUP:
988                         IDP_FreeGroup(prop);
989                         break;
990                 case IDP_IDPARRAY:
991                         IDP_FreeIDPArray(prop);
992                         break;
993         }
994 }
995
996 void IDP_ClearProperty(IDProperty *prop)
997 {
998         IDP_FreeProperty(prop);
999         prop->data.pointer = NULL;
1000         prop->len = prop->totallen = 0;
1001 }
1002
1003 /**
1004  * Unlinks any struct IDProperty<->ID linkage that might be going on.
1005  *
1006  * \note currently unused
1007  */
1008 void IDP_UnlinkProperty(IDProperty *prop)
1009 {
1010         switch (prop->type) {
1011                 case IDP_ID:
1012                         IDP_UnlinkID(prop);
1013                         break;
1014         }
1015 }
1016
1017 /** \} */