writefile: remove SDNA last-hit, optimize DNA reconstruct
[blender.git] / source / blender / makesdna / intern / dna_genfile.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  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * DNA handling
27  */
28
29 /** \file blender/makesdna/intern/dna_genfile.c
30  *  \ingroup DNA
31  *
32  * Lowest-level functions for decoding the parts of a saved .blend
33  * file, including interpretation of its SDNA block and conversion of
34  * contents of other parts according to the differences between that
35  * SDNA and the SDNA of the current (running) version of Blender.
36  */
37
38
39 #include <stdio.h>
40 #include <stdlib.h>
41 #include <string.h>
42 #include <limits.h>
43
44 #include "MEM_guardedalloc.h" // for MEM_freeN MEM_mallocN MEM_callocN
45
46 #include "BLI_utildefines.h"
47 #include "BLI_endian_switch.h"
48
49 #ifdef WITH_DNA_GHASH
50 #  include "BLI_ghash.h"
51 #endif
52
53 #include "DNA_genfile.h"
54 #include "DNA_sdna_types.h" // for SDNA ;-)
55
56 /**
57  * \section dna_genfile Overview
58  *
59  * - please note: no builtin security to detect input of double structs
60  * - if you want a struct not to be in DNA file: add two hash marks above it (#<enter>#<enter>)
61  *
62  * Structure DNA data is added to each blender file and to each executable, this to detect
63  * in .blend files new variables in structs, changed array sizes, etc. It's also used for
64  * converting endian and pointer size (32-64 bits)
65  * As an extra, Python uses a call to detect run-time the contents of a blender struct.
66  *
67  * Create a structDNA: only needed when one of the input include (.h) files change.
68  * File Syntax:
69  * \code{.unparsed}
70  *     SDNA (4 bytes) (magic number)
71  *     NAME (4 bytes)
72  *     <nr> (4 bytes) amount of names (int)
73  *     <string>
74  *     <string>
75  *     ...
76  *     ...
77  *     TYPE (4 bytes)
78  *     <nr> amount of types (int)
79  *     <string>
80  *     <string>
81  *     ...
82  *     ...
83  *     TLEN (4 bytes)
84  *     <len> (short) the lengths of types
85  *     <len>
86  *     ...
87  *     ...
88  *     STRC (4 bytes)
89  *     <nr> amount of structs (int)
90  *     <typenr><nr_of_elems> <typenr><namenr> <typenr><namenr> ...
91  * \endcode
92  *
93  *  **Remember to read/write integer and short aligned!**
94  *
95  *  While writing a file, the names of a struct is indicated with a type number,
96  *  to be found with: ``type = DNA_struct_find_nr(SDNA *, const char *)``
97  *  The value of ``type`` corresponds with the index within the structs array
98  *
99  *  For the moment: the complete DNA file is included in a .blend file. For
100  *  the future we can think of smarter methods, like only included the used
101  *  structs. Only needed to keep a file short though...
102  *
103  * ALLOWED AND TESTED CHANGES IN STRUCTS:
104  *  - type change (a char to float will be divided by 255)
105  *  - location within a struct (everthing can be randomly mixed up)
106  *  - struct within struct (within struct etc), this is recursive
107  *  - adding new elements, will be default initialized zero
108  *  - removing elements
109  *  - change of array sizes
110  *  - change of a pointer type: when the name doesn't change the contents is copied
111  *
112  * NOT YET:
113  *  - array (``vec[3]``) to float struct (``vec3f``)
114  *
115  * DONE:
116  *  - endian compatibility
117  *  - pointer conversion (32-64 bits)
118  *
119  * IMPORTANT:
120  *  - do not use #defines in structs for array lengths, this cannot be read by the dna functions
121  *  - do not use uint, but unsigned int instead, ushort and ulong are allowed
122  *  - only use a long in Blender if you want this to be the size of a pointer. so it is
123  *    32 bits or 64 bits, dependent at the cpu architecture
124  *  - chars are always unsigned
125  *  - alignment of variables has to be done in such a way, that any system does
126  *    not create 'padding' (gaps) in structures. So make sure that:
127  *    - short: 2 aligned
128  *    - int: 4 aligned
129  *    - float: 4 aligned
130  *    - double: 8 aligned
131  *    - long: 8 aligned
132  *    - struct: 8 aligned
133  *  - the sdna functions have several error prints builtin, always check blender running from a console.
134  *
135  */
136
137 /* ************************* ENDIAN STUFF ********************** */
138
139 /**
140  * converts a short between big/little endian.
141  */
142 static short le_short(short temp)
143 {
144         short new;
145         char *rt = (char *)&temp, *rtn = (char *)&new;
146
147         rtn[0] = rt[1];
148         rtn[1] = rt[0];
149
150         return new;
151 }
152
153 /**
154  * converts an int between big/little endian.
155  */
156 static int le_int(int temp)
157 {
158         int new;
159         char *rt = (char *)&temp, *rtn = (char *)&new;
160
161         rtn[0] = rt[3];
162         rtn[1] = rt[2];
163         rtn[2] = rt[1];
164         rtn[3] = rt[0];
165
166         return new;
167 }
168
169
170 /* ************************* MAKE DNA ********************** */
171
172 /* allowed duplicate code from makesdna.c */
173
174 /**
175  * parses the "[n]" on the end of an array name and returns the number of array elements n.
176  */
177 int DNA_elem_array_size(const char *str)
178 {
179         int a, mul = 1;
180         const char *cp = NULL;
181
182         for (a = 0; str[a]; a++) {
183                 if (str[a] == '[') {
184                         cp = &(str[a + 1]);
185                 }
186                 else if (str[a] == ']' && cp) {
187                         mul *= atoi(cp);
188                 }
189         }
190
191         return mul;
192 }
193
194 /* ************************* END MAKE DNA ********************** */
195
196 /* ************************* DIV ********************** */
197
198 void DNA_sdna_free(SDNA *sdna)
199 {
200         if (sdna->data_alloc) {
201                 MEM_freeN((void *)sdna->data);
202         }
203
204         MEM_freeN((void *)sdna->names);
205         MEM_freeN(sdna->types);
206         MEM_freeN(sdna->structs);
207
208 #ifdef WITH_DNA_GHASH
209         BLI_ghash_free(sdna->structs_map, NULL, NULL);
210 #endif
211
212         MEM_freeN(sdna);
213 }
214
215 /**
216  * Return true if the name indicates a pointer of some kind.
217  */
218 static bool ispointer(const char *name)
219 {
220         /* check if pointer or function pointer */
221         return (name[0] == '*' || (name[0] == '(' && name[1] == '*'));
222 }
223
224 /**
225  * Returns the size of struct fields of the specified type and name.
226  *
227  * \param type  Index into sdna->types/typelens
228  * \param name  Index into sdna->names,
229  * needed to extract possible pointer/array information.
230  */
231 static int elementsize(const SDNA *sdna, short type, short name)
232 {
233         int mul, namelen, len;
234         const char *cp;
235         
236         cp = sdna->names[name];
237         len = 0;
238         
239         namelen = strlen(cp);
240         /* is it a pointer or function pointer? */
241         if (ispointer(cp)) {
242                 /* has the name an extra length? (array) */
243                 mul = 1;
244                 if (cp[namelen - 1] == ']') {
245                         mul = DNA_elem_array_size(cp);
246                 }
247                 
248                 len = sdna->pointerlen * mul;
249         }
250         else if (sdna->typelens[type]) {
251                 /* has the name an extra length? (array) */
252                 mul = 1;
253                 if (cp[namelen - 1] == ']') {
254                         mul = DNA_elem_array_size(cp);
255                 }
256                 
257                 len = mul * sdna->typelens[type];
258                 
259         }
260         
261         return len;
262 }
263
264 #if 0
265 static void printstruct(SDNA *sdna, short strnr)
266 {
267         /* is for debug */
268         int b, nr;
269         short *sp;
270         
271         sp = sdna->structs[strnr];
272         
273         printf("struct %s\n", sdna->types[sp[0]]);
274         nr = sp[1];
275         sp += 2;
276         
277         for (b = 0; b < nr; b++, sp += 2) {
278                 printf("   %s %s\n", sdna->types[sp[0]], sdna->names[sp[1]]);
279         }
280 }
281 #endif
282
283 /**
284  * Returns the index of the struct info for the struct with the specified name.
285  */
286 int DNA_struct_find_nr_ex(const SDNA *sdna, const char *str, unsigned int *index_last)
287 {
288         const short *sp = NULL;
289
290         if (*index_last < sdna->nr_structs) {
291                 sp = sdna->structs[*index_last];
292                 if (strcmp(sdna->types[sp[0]], str) == 0) {
293                         return *index_last;
294                 }
295         }
296
297 #ifdef WITH_DNA_GHASH
298         {
299                 void **index_p;
300                 int a;
301
302                 index_p = BLI_ghash_lookup_p(sdna->structs_map, str);
303
304                 if (index_p) {
305                         a = GET_INT_FROM_POINTER(*index_p);
306                         *index_last = a;
307                 }
308                 else {
309                         a = -1;
310                 }
311                 return a;
312         }
313 #else
314         {
315                 int a;
316
317                 for (a = 0; a < sdna->nr_structs; a++) {
318
319                         sp = sdna->structs[a];
320
321                         if (strcmp(sdna->types[sp[0]], str) == 0) {
322                                 *index_last = a;
323                                 return a;
324                         }
325                 }
326         }
327         return -1;
328 #endif
329 }
330
331 int DNA_struct_find_nr(const SDNA *sdna, const char *str)
332 {
333         unsigned int index_last_dummy = UINT_MAX;
334         return DNA_struct_find_nr_ex(sdna, str, &index_last_dummy);
335 }
336
337 /* ************************* END DIV ********************** */
338
339 /* ************************* READ DNA ********************** */
340
341 /**
342  * In sdna->data the data, now we convert that to something understandable
343  */
344 static void init_structDNA(SDNA *sdna, bool do_endian_swap)
345 {
346         int *data, *verg, gravity_fix = -1;
347         short *sp;
348         char str[8];
349         
350         verg = (int *)str;
351         data = (int *)sdna->data;
352
353         strcpy(str, "SDNA");
354         if (*data != *verg) {
355                 printf("SDNA error in SDNA file\n");
356                 return;
357         }
358         else {
359                 intptr_t nr;
360                 char *cp;
361
362                 data++;
363                 
364                 /* load names array */
365                 strcpy(str, "NAME");
366                 if (*data == *verg) {
367                         data++;
368                         
369                         if (do_endian_swap) sdna->nr_names = le_int(*data);
370                         else sdna->nr_names = *data;
371                         
372                         data++;
373                         sdna->names = MEM_callocN(sizeof(void *) * sdna->nr_names, "sdnanames");
374                 }
375                 else {
376                         printf("NAME error in SDNA file\n");
377                         return;
378                 }
379                 
380                 nr = 0;
381                 cp = (char *)data;
382                 while (nr < sdna->nr_names) {
383                         sdna->names[nr] = cp;
384
385                         /* "float gravity [3]" was parsed wrong giving both "gravity" and
386                          * "[3]"  members. we rename "[3]", and later set the type of
387                          * "gravity" to "void" so the offsets work out correct */
388                         if (*cp == '[' && strcmp(cp, "[3]") == 0) {
389                                 if (nr && strcmp(sdna->names[nr - 1], "Cvi") == 0) {
390                                         sdna->names[nr] = "gravity[3]";
391                                         gravity_fix = nr;
392                                 }
393                         }
394
395                         while (*cp) cp++;
396                         cp++;
397                         nr++;
398                 }
399                 nr = (intptr_t)cp;       /* prevent BUS error */
400                 nr = (nr + 3) & ~3;
401                 cp = (char *)nr;
402                 
403                 /* load type names array */
404                 data = (int *)cp;
405                 strcpy(str, "TYPE");
406                 if (*data == *verg) {
407                         data++;
408                         
409                         if (do_endian_swap) sdna->nr_types = le_int(*data);
410                         else sdna->nr_types = *data;
411                         
412                         data++;
413                         sdna->types = MEM_callocN(sizeof(void *) * sdna->nr_types, "sdnatypes");
414                 }
415                 else {
416                         printf("TYPE error in SDNA file\n");
417                         return;
418                 }
419                 
420                 nr = 0;
421                 cp = (char *)data;
422                 while (nr < sdna->nr_types) {
423                         sdna->types[nr] = cp;
424                         
425                         /* this is a patch, to change struct names without a conflict with SDNA */
426                         /* be careful to use it, in this case for a system-struct (opengl/X) */
427                         
428                         if (*cp == 'b') {
429                                 /* struct Screen was already used by X, 'bScreen' replaces the old IrisGL 'Screen' struct */
430                                 if (strcmp("bScreen", cp) == 0) sdna->types[nr] = cp + 1;
431                         }
432                         
433                         while (*cp) cp++;
434                         cp++;
435                         nr++;
436                 }
437                 nr = (intptr_t)cp;       /* prevent BUS error */
438                 nr = (nr + 3) & ~3;
439                 cp = (char *)nr;
440                 
441                 /* load typelen array */
442                 data = (int *)cp;
443                 strcpy(str, "TLEN");
444                 if (*data == *verg) {
445                         data++;
446                         sp = (short *)data;
447                         sdna->typelens = sp;
448                         
449                         if (do_endian_swap) {
450                                 short a, *spo = sp;
451                                 
452                                 a = sdna->nr_types;
453                                 while (a--) {
454                                         spo[0] = le_short(spo[0]);
455                                         spo++;
456                                 }
457                         }
458                         
459                         sp += sdna->nr_types;
460                 }
461                 else {
462                         printf("TLEN error in SDNA file\n");
463                         return;
464                 }
465                 if (sdna->nr_types & 1) sp++;   /* prevent BUS error */
466
467                 /* load struct array */
468                 data = (int *)sp;
469                 strcpy(str, "STRC");
470                 if (*data == *verg) {
471                         data++;
472                         
473                         if (do_endian_swap) sdna->nr_structs = le_int(*data);
474                         else sdna->nr_structs = *data;
475                         
476                         data++;
477                         sdna->structs = MEM_callocN(sizeof(void *) * sdna->nr_structs, "sdnastrcs");
478                 }
479                 else {
480                         printf("STRC error in SDNA file\n");
481                         return;
482                 }
483                 
484                 nr = 0;
485                 sp = (short *)data;
486                 while (nr < sdna->nr_structs) {
487                         sdna->structs[nr] = sp;
488                         
489                         if (do_endian_swap) {
490                                 short a;
491                                 
492                                 sp[0] = le_short(sp[0]);
493                                 sp[1] = le_short(sp[1]);
494                                 
495                                 a = sp[1];
496                                 sp += 2;
497                                 while (a--) {
498                                         sp[0] = le_short(sp[0]);
499                                         sp[1] = le_short(sp[1]);
500                                         sp += 2;
501                                 }
502                         }
503                         else {
504                                 sp += 2 * sp[1] + 2;
505                         }
506                         
507                         nr++;
508                 }
509         }
510
511         {
512                 /* second part of gravity problem, setting "gravity" type to void */
513                 if (gravity_fix > -1) {
514                         for (intptr_t nr = 0; nr < sdna->nr_structs; nr++) {
515                                 sp = sdna->structs[nr];
516                                 if (strcmp(sdna->types[sp[0]], "ClothSimSettings") == 0)
517                                         sp[10] = SDNA_TYPE_VOID;
518                         }
519                 }
520         }
521
522 #ifdef WITH_DNA_GHASH
523         {
524                 /* create a ghash lookup to speed up */
525                 sdna->structs_map = BLI_ghash_str_new_ex("init_structDNA gh", sdna->nr_structs);
526
527                 for (intptr_t nr = 0; nr < sdna->nr_structs; nr++) {
528                         sp = sdna->structs[nr];
529                         BLI_ghash_insert(sdna->structs_map, sdna->types[sp[0]], SET_INT_IN_POINTER(nr));
530                 }
531         }
532 #endif
533
534         /* Calculate 'sdna->pointerlen' */
535         {
536                 intptr_t nr = DNA_struct_find_nr(sdna, "ListBase");
537
538                 /* should never happen, only with corrupt file for example */
539                 if (UNLIKELY(nr == -1)) {
540                         printf("ListBase struct error! Not found.\n");
541                         exit(1);
542                 }
543
544                 /* finally pointerlen: use struct ListBase to test it, never change the size of it! */
545                 sp = sdna->structs[nr];
546                 /* weird; i have no memory of that... I think I used sizeof(void *) before... (ton) */
547
548                 sdna->pointerlen = sdna->typelens[sp[0]] / 2;
549
550                 if (sp[1] != 2 || (sdna->pointerlen != 4 && sdna->pointerlen != 8)) {
551                         printf("ListBase struct error! Needs it to calculate pointerize.\n");
552                         exit(1);
553                         /* well, at least sizeof(ListBase) is error proof! (ton) */
554                 }
555         }
556 }
557
558 /**
559  * Constructs and returns a decoded SDNA structure from the given encoded SDNA data block.
560  */
561 SDNA *DNA_sdna_from_data(
562         const void *data, const int datalen,
563         bool do_endian_swap, bool data_alloc)
564 {
565         SDNA *sdna = MEM_mallocN(sizeof(*sdna), "sdna");
566
567         sdna->datalen = datalen;
568         if (data_alloc) {
569                 char *data_copy = MEM_mallocN(datalen, "sdna_data");
570                 memcpy(data_copy, data, datalen);
571                 sdna->data = data_copy;
572         }
573         else {
574                 sdna->data = data;
575         }
576         sdna->data_alloc = data_alloc;
577         
578         init_structDNA(sdna, do_endian_swap);
579         
580         return sdna;
581 }
582
583 /* ******************** END READ DNA ********************** */
584
585 /* ******************* HANDLE DNA ***************** */
586
587 /**
588  * Used by #DNA_struct_get_compareflags (below) to recursively mark all structs
589  * containing a field of type structnr as changed between old and current SDNAs.
590  */
591 static void recurs_test_compflags(const SDNA *sdna, char *compflags, int structnr)
592 {
593         int a, b, typenr, elems;
594         const short *sp;
595         const char *cp;
596         
597         /* check all structs, test if it's inside another struct */
598         sp = sdna->structs[structnr];
599         typenr = sp[0];
600         
601         for (a = 0; a < sdna->nr_structs; a++) {
602                 if ((a != structnr) && (compflags[a] == SDNA_CMP_EQUAL)) {
603                         sp = sdna->structs[a];
604                         elems = sp[1];
605                         sp += 2;
606                         for (b = 0; b < elems; b++, sp += 2) {
607                                 if (sp[0] == typenr) {
608                                         cp = sdna->names[sp[1]];
609                                         if (!ispointer(cp)) {
610                                                 compflags[a] = SDNA_CMP_NOT_EQUAL;
611                                                 recurs_test_compflags(sdna, compflags, a);
612                                         }
613                                 }
614                         }
615                 }
616         }
617         
618 }
619
620
621 /**
622  * Constructs and returns an array of byte flags with one element for each struct in oldsdna,
623  * indicating how it compares to newsdna:
624  *
625  * flag value:
626  * - 0  Struct has disappeared (values of this struct type will not be loaded by the current Blender)
627  * - 1  Struct is the same (can be loaded with straight memory copy after any necessary endian conversion)
628  * - 2  Struct is different in some way (needs to be copied/converted field by field)
629  */
630 char *DNA_struct_get_compareflags(const SDNA *oldsdna, const SDNA *newsdna)
631 {
632         int a, b;
633         const short *sp_old, *sp_new;
634         const char *str1, *str2;
635         char *compflags;
636         
637         if (oldsdna->nr_structs == 0) {
638                 printf("error: file without SDNA\n");
639                 return NULL;
640         }
641
642         compflags = MEM_callocN(oldsdna->nr_structs, "compflags");
643
644         /* we check all structs in 'oldsdna' and compare them with 
645          * the structs in 'newsdna'
646          */
647         unsigned int newsdna_index_last = 0;
648         
649         for (a = 0; a < oldsdna->nr_structs; a++) {
650                 sp_old = oldsdna->structs[a];
651                 
652                 /* search for type in cur */
653                 int sp_new_index = DNA_struct_find_nr_ex(newsdna, oldsdna->types[sp_old[0]], &newsdna_index_last);
654
655                 /* The next indices will almost always match */
656                 newsdna_index_last++;
657
658                 if (sp_new_index != -1) {
659                         sp_new = newsdna->structs[sp_new_index];
660                         /* initial assumption */
661                         compflags[a] = SDNA_CMP_NOT_EQUAL;
662                         
663                         /* compare length and amount of elems */
664                         if (sp_new[1] == sp_old[1]) {
665                                 if (newsdna->typelens[sp_new[0]] == oldsdna->typelens[sp_old[0]]) {
666
667                                         /* same length, same amount of elems, now per type and name */
668                                         b = sp_old[1];
669                                         sp_old += 2;
670                                         sp_new += 2;
671                                         while (b > 0) {
672                                                 str1 = newsdna->types[sp_new[0]];
673                                                 str2 = oldsdna->types[sp_old[0]];
674                                                 if (strcmp(str1, str2) != 0) break;
675
676                                                 str1 = newsdna->names[sp_new[1]];
677                                                 str2 = oldsdna->names[sp_old[1]];
678                                                 if (strcmp(str1, str2) != 0) break;
679
680                                                 /* same type and same name, now pointersize */
681                                                 if (ispointer(str1)) {
682                                                         if (oldsdna->pointerlen != newsdna->pointerlen) break;
683                                                 }
684
685                                                 b--;
686                                                 sp_old += 2;
687                                                 sp_new += 2;
688                                         }
689                                         if (b == 0) {
690                                                 /* no differences found */
691                                                 compflags[a] = SDNA_CMP_EQUAL;
692                                         }
693
694                                 }
695                         }
696                         
697                 }
698         }
699
700         /* first struct in util.h is struct Link, this is skipped in compflags (als # 0).
701          * was a bug, and this way dirty patched! Solve this later....
702          */
703         compflags[0] = SDNA_CMP_EQUAL;
704
705         /* Because structs can be inside structs, we recursively
706          * set flags when a struct is altered
707          */
708         for (a = 0; a < oldsdna->nr_structs; a++) {
709                 if (compflags[a] == SDNA_CMP_NOT_EQUAL) {
710                         recurs_test_compflags(oldsdna, compflags, a);
711                 }
712         }
713         
714 #if 0
715         for (a = 0; a < oldsdna->nr_structs; a++) {
716                 if (compflags[a] == SDNA_CMP_NOT_EQUAL) {
717                         spold = oldsdna->structs[a];
718                         printf("changed: %s\n", oldsdna->types[spold[0]]);
719                 }
720         }
721 #endif
722
723         return compflags;
724 }
725
726 /**
727  * Converts the name of a primitive type to its enumeration code.
728  */
729 static eSDNA_Type sdna_type_nr(const char *dna_type)
730 {
731         if     ((strcmp(dna_type, "char") == 0) || (strcmp(dna_type, "const char") == 0))          return SDNA_TYPE_CHAR;
732         else if ((strcmp(dna_type, "uchar") == 0) || (strcmp(dna_type, "unsigned char") == 0))     return SDNA_TYPE_UCHAR;
733         else if ( strcmp(dna_type, "short") == 0)                                                  return SDNA_TYPE_SHORT;
734         else if ((strcmp(dna_type, "ushort") == 0) || (strcmp(dna_type, "unsigned short") == 0))   return SDNA_TYPE_USHORT;
735         else if ( strcmp(dna_type, "int") == 0)                                                    return SDNA_TYPE_INT;
736         else if ( strcmp(dna_type, "float") == 0)                                                  return SDNA_TYPE_FLOAT;
737         else if ( strcmp(dna_type, "double") == 0)                                                 return SDNA_TYPE_DOUBLE;
738         else if ( strcmp(dna_type, "int64_t") == 0)                                                return SDNA_TYPE_INT64;
739         else if ( strcmp(dna_type, "uint64_t") == 0)                                               return SDNA_TYPE_UINT64;
740         else                                                                                       return -1; /* invalid! */
741 }
742
743 /**
744  * Converts a value of one primitive type to another.
745  * Note there is no optimization for the case where otype and ctype are the same:
746  * assumption is that caller will handle this case.
747  *
748  * \param ctype  Name of type to convert to
749  * \param otype  Name of type to convert from
750  * \param name  Field name to extract array-size information
751  * \param curdata  Where to put converted data
752  * \param olddata  Data of type otype to convert
753  */
754 static void cast_elem(
755         const char *ctype, const char *otype, const char *name,
756         char *curdata, const char *olddata)
757 {
758         double val = 0.0;
759         int arrlen, curlen = 1, oldlen = 1;
760
761         eSDNA_Type ctypenr, otypenr;
762
763         arrlen = DNA_elem_array_size(name);
764
765         if ( (otypenr = sdna_type_nr(otype)) == -1 ||
766              (ctypenr = sdna_type_nr(ctype)) == -1)
767         {
768                 return;
769         }
770
771         /* define lengths */
772         oldlen = DNA_elem_type_size(otypenr);
773         curlen = DNA_elem_type_size(ctypenr);
774
775         while (arrlen > 0) {
776                 switch (otypenr) {
777                         case SDNA_TYPE_CHAR:
778                                 val = *olddata; break;
779                         case SDNA_TYPE_UCHAR:
780                                 val = *( (unsigned char *)olddata); break;
781                         case SDNA_TYPE_SHORT:
782                                 val = *( (short *)olddata); break;
783                         case SDNA_TYPE_USHORT:
784                                 val = *( (unsigned short *)olddata); break;
785                         case SDNA_TYPE_INT:
786                                 val = *( (int *)olddata); break;
787                         case SDNA_TYPE_FLOAT:
788                                 val = *( (float *)olddata); break;
789                         case SDNA_TYPE_DOUBLE:
790                                 val = *( (double *)olddata); break;
791                         case SDNA_TYPE_INT64:
792                                 val = *( (int64_t *)olddata); break;
793                         case SDNA_TYPE_UINT64:
794                                 val = *( (uint64_t *)olddata); break;
795                 }
796                 
797                 switch (ctypenr) {
798                         case SDNA_TYPE_CHAR:
799                                 *curdata = val; break;
800                         case SDNA_TYPE_UCHAR:
801                                 *( (unsigned char *)curdata) = val; break;
802                         case SDNA_TYPE_SHORT:
803                                 *( (short *)curdata) = val; break;
804                         case SDNA_TYPE_USHORT:
805                                 *( (unsigned short *)curdata) = val; break;
806                         case SDNA_TYPE_INT:
807                                 *( (int *)curdata) = val; break;
808                         case SDNA_TYPE_FLOAT:
809                                 if (otypenr < 2) val /= 255;
810                                 *( (float *)curdata) = val; break;
811                         case SDNA_TYPE_DOUBLE:
812                                 if (otypenr < 2) val /= 255;
813                                 *( (double *)curdata) = val; break;
814                         case SDNA_TYPE_INT64:
815                                 *( (int64_t *)curdata) = val; break;
816                         case SDNA_TYPE_UINT64:
817                                 *( (uint64_t *)curdata) = val; break;
818                 }
819
820                 olddata += oldlen;
821                 curdata += curlen;
822                 arrlen--;
823         }
824 }
825
826 /**
827  * Converts pointer values between different sizes. These are only used
828  * as lookup keys to identify data blocks in the saved .blend file, not
829  * as actual in-memory pointers.
830  *
831  * \param curlen  Pointer length to conver to
832  * \param oldlen  Length of pointers in olddata
833  * \param name  Field name to extract array-size information
834  * \param curdata  Where to put converted data
835  * \param olddata  Data to convert
836  */
837 static void cast_pointer(int curlen, int oldlen, const char *name, char *curdata, const char *olddata)
838 {
839         int64_t lval;
840         int arrlen;
841         
842         arrlen = DNA_elem_array_size(name);
843         
844         while (arrlen > 0) {
845         
846                 if (curlen == oldlen) {
847                         memcpy(curdata, olddata, curlen);
848                 }
849                 else if (curlen == 4 && oldlen == 8) {
850                         lval = *((int64_t *)olddata);
851
852                         /* WARNING: 32-bit Blender trying to load file saved by 64-bit Blender,
853                          * pointers may lose uniqueness on truncation! (Hopefully this wont
854                          * happen unless/until we ever get to multi-gigabyte .blend files...) */
855                         *((int *)curdata) = lval >> 3;
856                 }
857                 else if (curlen == 8 && oldlen == 4) {
858                         *((int64_t *)curdata) = *((int *)olddata);
859                 }
860                 else {
861                         /* for debug */
862                         printf("errpr: illegal pointersize!\n");
863                 }
864                 
865                 olddata += oldlen;
866                 curdata += curlen;
867                 arrlen--;
868
869         }
870 }
871
872 /**
873  * Equality test on name and oname excluding any array-size suffix.
874  */
875 static int elem_strcmp(const char *name, const char *oname)
876 {
877         int a = 0;
878         
879         while (1) {
880                 if (name[a] != oname[a]) return 1;
881                 if (name[a] == '[' || oname[a] == '[') break;
882                 if (name[a] == 0 || oname[a] == 0) break;
883                 a++;
884         }
885         return 0;
886 }
887
888 /**
889  * Returns the address of the data for the specified field within olddata
890  * according to the struct format pointed to by old, or NULL if no such
891  * field can be found.
892  *
893  * \param sdna  Old SDNA
894  * \param type  Current field type name
895  * \param name  Current field name
896  * \param old  Pointer to struct information in sdna
897  * \param olddata  Struct data
898  * \param sppo  Optional place to return pointer to field info in sdna
899  * \return Data address.
900  */
901 static char *find_elem(
902         const SDNA *sdna,
903         const char *type,
904         const char *name,
905         const short *old,
906         char *olddata,
907         const short **sppo)
908 {
909         int a, elemcount, len;
910         const char *otype, *oname;
911         
912         /* without arraypart, so names can differ: return old namenr and type */
913         
914         /* in old is the old struct */
915         elemcount = old[1];
916         old += 2;
917         for (a = 0; a < elemcount; a++, old += 2) {
918
919                 otype = sdna->types[old[0]];
920                 oname = sdna->names[old[1]];
921
922                 len = elementsize(sdna, old[0], old[1]);
923
924                 if (elem_strcmp(name, oname) == 0) {  /* name equal */
925                         if (strcmp(type, otype) == 0) {   /* type equal */
926                                 if (sppo) *sppo = old;
927                                 return olddata;
928                         }
929                         
930                         return NULL;
931                 }
932                 
933                 olddata += len;
934         }
935         return NULL;
936 }
937
938 /**
939  * Converts the contents of a single field of a struct, of a non-struct type,
940  * from oldsdna to newsdna format.
941  *
942  * \param newsdna  SDNA of current Blender
943  * \param oldsdna  SDNA of Blender that saved file
944  * \param type  current field type name
945  * \param name  current field name
946  * \param curdata  put field data converted to newsdna here
947  * \param old  pointer to struct info in oldsdna
948  * \param olddata  struct contents laid out according to oldsdna
949  */
950 static void reconstruct_elem(
951         const SDNA *newsdna,
952         const SDNA *oldsdna,
953         const char *type,
954         const char *name,
955         char *curdata,
956         const short *old,
957         const char *olddata)
958 {
959         /* rules: test for NAME:
960          *      - name equal:
961          *          - cast type
962          *      - name partially equal (array differs)
963          *          - type equal: memcpy
964          *          - types casten
965          * (nzc 2-4-2001 I want the 'unsigned' bit to be parsed as well. Where
966          * can I force this?)
967          */
968         int a, elemcount, len, countpos, oldsize, cursize, mul;
969         const char *otype, *oname, *cp;
970         
971         /* is 'name' an array? */
972         cp = name;
973         countpos = 0;
974         while (*cp && *cp != '[') {
975                 cp++; countpos++;
976         }
977         if (*cp != '[') countpos = 0;
978         
979         /* in old is the old struct */
980         elemcount = old[1];
981         old += 2;
982         for (a = 0; a < elemcount; a++, old += 2) {
983                 otype = oldsdna->types[old[0]];
984                 oname = oldsdna->names[old[1]];
985                 len = elementsize(oldsdna, old[0], old[1]);
986                 
987                 if (strcmp(name, oname) == 0) { /* name equal */
988                         
989                         if (ispointer(name)) {  /* pointer of functionpointer afhandelen */
990                                 cast_pointer(newsdna->pointerlen, oldsdna->pointerlen, name, curdata, olddata);
991                         }
992                         else if (strcmp(type, otype) == 0) {    /* type equal */
993                                 memcpy(curdata, olddata, len);
994                         }
995                         else {
996                                 cast_elem(type, otype, name, curdata, olddata);
997                         }
998
999                         return;
1000                 }
1001                 else if (countpos != 0) {  /* name is an array */
1002
1003                         if (oname[countpos] == '[' && strncmp(name, oname, countpos) == 0) {  /* basis equal */
1004                                 
1005                                 cursize = DNA_elem_array_size(name);
1006                                 oldsize = DNA_elem_array_size(oname);
1007
1008                                 if (ispointer(name)) {  /* handle pointer or functionpointer */
1009                                         cast_pointer(newsdna->pointerlen, oldsdna->pointerlen,
1010                                                      cursize > oldsize ? oname : name,
1011                                                      curdata, olddata);
1012                                 }
1013                                 else if (strcmp(type, otype) == 0) {  /* type equal */
1014                                         mul = len / oldsize; /* size of single old array element */
1015                                         mul *= (cursize < oldsize) ? cursize : oldsize; /* smaller of sizes of old and new arrays */
1016                                         memcpy(curdata, olddata, mul);
1017                                         
1018                                         if (oldsize > cursize && strcmp(type, "char") == 0) {
1019                                                 /* string had to be truncated, ensure it's still null-terminated */
1020                                                 curdata[mul - 1] = '\0';
1021                                         }
1022                                 }
1023                                 else {
1024                                         cast_elem(type, otype,
1025                                                   cursize > oldsize ? oname : name,
1026                                                   curdata, olddata);
1027                                 }
1028                                 return;
1029                         }
1030                 }
1031                 olddata += len;
1032         }
1033 }
1034
1035 /**
1036  * Converts the contents of an entire struct from oldsdna to newsdna format.
1037  *
1038  * \param newsdna  SDNA of current Blender
1039  * \param oldsdna  SDNA of Blender that saved file
1040  * \param compflags
1041  *
1042  * Result from DNA_struct_get_compareflags to avoid needless conversions.
1043  * \param oldSDNAnr  Index of old struct definition in oldsdna
1044  * \param data  Struct contents laid out according to oldsdna
1045  * \param curSDNAnr  Index of current struct definition in newsdna
1046  * \param cur  Where to put converted struct contents
1047  */
1048 static void reconstruct_struct(
1049         const SDNA *newsdna,
1050         const SDNA *oldsdna,
1051         const char *compflags,
1052
1053         int oldSDNAnr,
1054         char *data,
1055         int curSDNAnr,
1056         char *cur)
1057 {
1058         /* Recursive!
1059          * Per element from cur_struct, read data from old_struct.
1060          * If element is a struct, call recursive.
1061          */
1062         int a, elemcount, elen, eleno, mul, mulo, firststructtypenr;
1063         const short *spo, *spc, *sppo;
1064         const char *type;
1065         char *cpo, *cpc;
1066         const char *name, *nameo;
1067
1068         unsigned int oldsdna_index_last = UINT_MAX;
1069         unsigned int cursdna_index_last = UINT_MAX;
1070
1071
1072         if (oldSDNAnr == -1) return;
1073         if (curSDNAnr == -1) return;
1074
1075         if (compflags[oldSDNAnr] == SDNA_CMP_EQUAL) {
1076                 /* if recursive: test for equal */
1077                 spo = oldsdna->structs[oldSDNAnr];
1078                 elen = oldsdna->typelens[spo[0]];
1079                 memcpy(cur, data, elen);
1080                 
1081                 return;
1082         }
1083
1084         firststructtypenr = *(newsdna->structs[0]);
1085
1086         spo = oldsdna->structs[oldSDNAnr];
1087         spc = newsdna->structs[curSDNAnr];
1088
1089         elemcount = spc[1];
1090
1091         spc += 2;
1092         cpc = cur;
1093         for (a = 0; a < elemcount; a++, spc += 2) {  /* convert each field */
1094                 type = newsdna->types[spc[0]];
1095                 name = newsdna->names[spc[1]];
1096                 
1097                 elen = elementsize(newsdna, spc[0], spc[1]);
1098
1099                 /* test: is type a struct? */
1100                 if (spc[0] >= firststructtypenr && !ispointer(name)) {
1101                         /* struct field type */
1102                         /* where does the old struct data start (and is there an old one?) */
1103                         cpo = find_elem(oldsdna, type, name, spo, data, &sppo);
1104                         
1105                         if (cpo) {
1106                                 oldSDNAnr = DNA_struct_find_nr_ex(oldsdna, type, &oldsdna_index_last);
1107                                 curSDNAnr = DNA_struct_find_nr_ex(newsdna, type, &cursdna_index_last);
1108                                 
1109                                 /* array! */
1110                                 mul = DNA_elem_array_size(name);
1111                                 nameo = oldsdna->names[sppo[1]];
1112                                 mulo = DNA_elem_array_size(nameo);
1113                                 
1114                                 eleno = elementsize(oldsdna, sppo[0], sppo[1]);
1115                                 
1116                                 elen /= mul;
1117                                 eleno /= mulo;
1118                                 
1119                                 while (mul--) {
1120                                         reconstruct_struct(newsdna, oldsdna, compflags, oldSDNAnr, cpo, curSDNAnr, cpc);
1121                                         cpo += eleno;
1122                                         cpc += elen;
1123                                         
1124                                         /* new struct array larger than old */
1125                                         mulo--;
1126                                         if (mulo <= 0) break;
1127                                 }
1128                         }
1129                         else {
1130                                 cpc += elen;  /* skip field no longer present */
1131                         }
1132                 }
1133                 else {
1134                         /* non-struct field type */
1135                         reconstruct_elem(newsdna, oldsdna, type, name, cpc, spo, data);
1136                         cpc += elen;
1137                 }
1138         }
1139 }
1140
1141 /**
1142  * Does endian swapping on the fields of a struct value.
1143  *
1144  * \param oldsdna  SDNA of Blender that saved file
1145  * \param oldSDNAnr  Index of struct info within oldsdna
1146  * \param data  Struct data
1147  */
1148 void DNA_struct_switch_endian(const SDNA *oldsdna, int oldSDNAnr, char *data)
1149 {
1150         /* Recursive!
1151          * If element is a struct, call recursive.
1152          */
1153         int a, mul, elemcount, elen, elena, firststructtypenr;
1154         const short *spo, *spc;
1155         char *cur;
1156         const char *type, *name;
1157         unsigned int oldsdna_index_last = UINT_MAX;
1158
1159         if (oldSDNAnr == -1) return;
1160         firststructtypenr = *(oldsdna->structs[0]);
1161         
1162         spo = spc = oldsdna->structs[oldSDNAnr];
1163
1164         elemcount = spo[1];
1165
1166         spc += 2;
1167         cur = data;
1168         
1169         for (a = 0; a < elemcount; a++, spc += 2) {
1170                 type = oldsdna->types[spc[0]];
1171                 name = oldsdna->names[spc[1]];
1172                 
1173                 /* elementsize = including arraysize */
1174                 elen = elementsize(oldsdna, spc[0], spc[1]);
1175
1176                 /* test: is type a struct? */
1177                 if (spc[0] >= firststructtypenr && !ispointer(name)) {
1178                         /* struct field type */
1179                         /* where does the old data start (is there one?) */
1180                         char *cpo = find_elem(oldsdna, type, name, spo, data, NULL);
1181                         if (cpo) {
1182                                 oldSDNAnr = DNA_struct_find_nr_ex(oldsdna, type, &oldsdna_index_last);
1183                                 
1184                                 mul = DNA_elem_array_size(name);
1185                                 elena = elen / mul;
1186
1187                                 while (mul--) {
1188                                         DNA_struct_switch_endian(oldsdna, oldSDNAnr, cpo);
1189                                         cpo += elena;
1190                                 }
1191                         }
1192                 }
1193                 else {
1194                         /* non-struct field type */
1195                         if (ispointer(name)) {
1196                                 if (oldsdna->pointerlen == 8) {
1197                                         BLI_endian_switch_int64_array((int64_t *)cur, DNA_elem_array_size(name));
1198                                 }
1199                         }
1200                         else {
1201                                 if (ELEM(spc[0], SDNA_TYPE_SHORT, SDNA_TYPE_USHORT)) {
1202
1203                                         /* exception: variable called blocktype: derived from ID_  */
1204                                         bool skip = false;
1205                                         if (name[0] == 'b' && name[1] == 'l') {
1206                                                 if (strcmp(name, "blocktype") == 0) skip = true;
1207                                         }
1208
1209                                         if (skip == false) {
1210                                                 BLI_endian_switch_int16_array((int16_t *)cur, DNA_elem_array_size(name));
1211                                         }
1212                                 }
1213                                 else if (ELEM(spc[0], SDNA_TYPE_INT, SDNA_TYPE_FLOAT)) {
1214                                         /* note, intentionally ignore long/ulong here these could be 4 or 8 bits,
1215                                          * but turns out we only used for runtime vars and
1216                                          * only once for a struct type thats no longer used. */
1217
1218                                         BLI_endian_switch_int32_array((int32_t *)cur, DNA_elem_array_size(name));
1219                                 }
1220                                 else if (ELEM(spc[0], SDNA_TYPE_INT64, SDNA_TYPE_UINT64, SDNA_TYPE_DOUBLE)) {
1221                                         BLI_endian_switch_int64_array((int64_t *)cur, DNA_elem_array_size(name));
1222                                 }
1223                         }
1224                 }
1225                 cur += elen;
1226         }
1227 }
1228
1229 /**
1230  * \param newsdna  SDNA of current Blender
1231  * \param oldsdna  SDNA of Blender that saved file
1232  * \param compflags
1233  *
1234  * Result from DNA_struct_get_compareflags to avoid needless conversions
1235  * \param oldSDNAnr  Index of struct info within oldsdna
1236  * \param blocks  The number of array elements
1237  * \param data  Array of struct data
1238  * \return An allocated reconstructed struct
1239  */
1240 void *DNA_struct_reconstruct(
1241         const SDNA *newsdna, const SDNA *oldsdna,
1242         char *compflags, int oldSDNAnr, int blocks, void *data)
1243 {
1244         int a, curSDNAnr, curlen = 0, oldlen;
1245         const short *spo, *spc;
1246         char *cur, *cpc, *cpo;
1247         const char *type;
1248         
1249         /* oldSDNAnr == structnr, we're looking for the corresponding 'cur' number */
1250         spo = oldsdna->structs[oldSDNAnr];
1251         type = oldsdna->types[spo[0]];
1252         oldlen = oldsdna->typelens[spo[0]];
1253         curSDNAnr = DNA_struct_find_nr(newsdna, type);
1254
1255         /* init data and alloc */
1256         if (curSDNAnr != -1) {
1257                 spc = newsdna->structs[curSDNAnr];
1258                 curlen = newsdna->typelens[spc[0]];
1259         }
1260         if (curlen == 0) {
1261                 return NULL;
1262         }
1263
1264         cur = MEM_callocN(blocks * curlen, "reconstruct");
1265         cpc = cur;
1266         cpo = data;
1267         for (a = 0; a < blocks; a++) {
1268                 reconstruct_struct(newsdna, oldsdna, compflags, oldSDNAnr, cpo, curSDNAnr, cpc);
1269                 cpc += curlen;
1270                 cpo += oldlen;
1271         }
1272
1273         return cur;
1274 }
1275
1276 /**
1277  * Returns the offset of the field with the specified name and type within the specified
1278  * struct type in sdna.
1279  */
1280 int DNA_elem_offset(SDNA *sdna, const char *stype, const char *vartype, const char *name)
1281 {
1282         const int SDNAnr = DNA_struct_find_nr(sdna, stype);
1283         const short * const spo = sdna->structs[SDNAnr];
1284         const char * const cp = find_elem(sdna, vartype, name, spo, NULL, NULL);
1285         BLI_assert(SDNAnr != -1);
1286         return (int)((intptr_t)cp);
1287 }
1288
1289 bool DNA_struct_elem_find(SDNA *sdna, const char *stype, const char *vartype, const char *name)
1290 {
1291         const int SDNAnr = DNA_struct_find_nr(sdna, stype);
1292         
1293         if (SDNAnr != -1) {
1294                 const short * const spo = sdna->structs[SDNAnr];
1295                 const char * const cp = find_elem(sdna, vartype, name, spo, NULL, NULL);
1296                 
1297                 if (cp) {
1298                         return true;
1299                 }
1300         }
1301         return false;
1302 }
1303
1304
1305 /**
1306  * Returns the size in bytes of a primitive type.
1307  */
1308 int DNA_elem_type_size(const eSDNA_Type elem_nr)
1309 {
1310         /* should contain all enum types */
1311         switch (elem_nr) {
1312                 case SDNA_TYPE_CHAR:
1313                 case SDNA_TYPE_UCHAR:
1314                         return 1;
1315                 case SDNA_TYPE_SHORT:
1316                 case SDNA_TYPE_USHORT:
1317                         return 2;
1318                 case SDNA_TYPE_INT:
1319                 case SDNA_TYPE_FLOAT:
1320                         return 4;
1321                 case SDNA_TYPE_DOUBLE:
1322                 case SDNA_TYPE_INT64:
1323                 case SDNA_TYPE_UINT64:
1324                         return 8;
1325         }
1326
1327         /* weak */
1328         return 8;
1329 }