readfile: report SDNA decoding errors on file read
[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 bool init_structDNA(
345         SDNA *sdna, bool do_endian_swap,
346         const char **r_error_message)
347 {
348         int *data, *verg, gravity_fix = -1;
349         short *sp;
350         char str[8];
351         
352         verg = (int *)str;
353         data = (int *)sdna->data;
354
355         /* clear pointers incase of error */
356         sdna->names = NULL;
357         sdna->types = NULL;
358         sdna->structs = NULL;
359 #ifdef WITH_DNA_GHASH
360         sdna->structs_map = NULL;
361 #endif
362
363         strcpy(str, "SDNA");
364         if (*data != *verg) {
365                 *r_error_message = "SDNA error in SDNA file";
366                 return false;
367         }
368         else {
369                 intptr_t nr;
370                 char *cp;
371
372                 data++;
373                 
374                 /* load names array */
375                 strcpy(str, "NAME");
376                 if (*data == *verg) {
377                         data++;
378                         
379                         if (do_endian_swap) sdna->nr_names = le_int(*data);
380                         else sdna->nr_names = *data;
381                         
382                         data++;
383                         sdna->names = MEM_callocN(sizeof(void *) * sdna->nr_names, "sdnanames");
384                 }
385                 else {
386                         *r_error_message = "NAME error in SDNA file";
387                         return false;
388                 }
389                 
390                 nr = 0;
391                 cp = (char *)data;
392                 while (nr < sdna->nr_names) {
393                         sdna->names[nr] = cp;
394
395                         /* "float gravity [3]" was parsed wrong giving both "gravity" and
396                          * "[3]"  members. we rename "[3]", and later set the type of
397                          * "gravity" to "void" so the offsets work out correct */
398                         if (*cp == '[' && strcmp(cp, "[3]") == 0) {
399                                 if (nr && strcmp(sdna->names[nr - 1], "Cvi") == 0) {
400                                         sdna->names[nr] = "gravity[3]";
401                                         gravity_fix = nr;
402                                 }
403                         }
404
405                         while (*cp) cp++;
406                         cp++;
407                         nr++;
408                 }
409                 nr = (intptr_t)cp;       /* prevent BUS error */
410                 nr = (nr + 3) & ~3;
411                 cp = (char *)nr;
412                 
413                 /* load type names array */
414                 data = (int *)cp;
415                 strcpy(str, "TYPE");
416                 if (*data == *verg) {
417                         data++;
418                         
419                         if (do_endian_swap) sdna->nr_types = le_int(*data);
420                         else sdna->nr_types = *data;
421                         
422                         data++;
423                         sdna->types = MEM_callocN(sizeof(void *) * sdna->nr_types, "sdnatypes");
424                 }
425                 else {
426                         *r_error_message = "TYPE error in SDNA file";
427                         return false;
428                 }
429                 
430                 nr = 0;
431                 cp = (char *)data;
432                 while (nr < sdna->nr_types) {
433                         sdna->types[nr] = cp;
434                         
435                         /* this is a patch, to change struct names without a conflict with SDNA */
436                         /* be careful to use it, in this case for a system-struct (opengl/X) */
437                         
438                         if (*cp == 'b') {
439                                 /* struct Screen was already used by X, 'bScreen' replaces the old IrisGL 'Screen' struct */
440                                 if (strcmp("bScreen", cp) == 0) sdna->types[nr] = cp + 1;
441                         }
442                         
443                         while (*cp) cp++;
444                         cp++;
445                         nr++;
446                 }
447                 nr = (intptr_t)cp;       /* prevent BUS error */
448                 nr = (nr + 3) & ~3;
449                 cp = (char *)nr;
450                 
451                 /* load typelen array */
452                 data = (int *)cp;
453                 strcpy(str, "TLEN");
454                 if (*data == *verg) {
455                         data++;
456                         sp = (short *)data;
457                         sdna->typelens = sp;
458                         
459                         if (do_endian_swap) {
460                                 short a, *spo = sp;
461                                 
462                                 a = sdna->nr_types;
463                                 while (a--) {
464                                         spo[0] = le_short(spo[0]);
465                                         spo++;
466                                 }
467                         }
468                         
469                         sp += sdna->nr_types;
470                 }
471                 else {
472                         *r_error_message = "TLEN error in SDNA file";
473                         return false;
474                 }
475                 if (sdna->nr_types & 1) sp++;   /* prevent BUS error */
476
477                 /* load struct array */
478                 data = (int *)sp;
479                 strcpy(str, "STRC");
480                 if (*data == *verg) {
481                         data++;
482                         
483                         if (do_endian_swap) sdna->nr_structs = le_int(*data);
484                         else sdna->nr_structs = *data;
485                         
486                         data++;
487                         sdna->structs = MEM_callocN(sizeof(void *) * sdna->nr_structs, "sdnastrcs");
488                 }
489                 else {
490                         *r_error_message = "STRC error in SDNA file";
491                         return false;
492                 }
493                 
494                 nr = 0;
495                 sp = (short *)data;
496                 while (nr < sdna->nr_structs) {
497                         sdna->structs[nr] = sp;
498                         
499                         if (do_endian_swap) {
500                                 short a;
501                                 
502                                 sp[0] = le_short(sp[0]);
503                                 sp[1] = le_short(sp[1]);
504                                 
505                                 a = sp[1];
506                                 sp += 2;
507                                 while (a--) {
508                                         sp[0] = le_short(sp[0]);
509                                         sp[1] = le_short(sp[1]);
510                                         sp += 2;
511                                 }
512                         }
513                         else {
514                                 sp += 2 * sp[1] + 2;
515                         }
516                         
517                         nr++;
518                 }
519         }
520
521         {
522                 /* second part of gravity problem, setting "gravity" type to void */
523                 if (gravity_fix > -1) {
524                         for (intptr_t nr = 0; nr < sdna->nr_structs; nr++) {
525                                 sp = sdna->structs[nr];
526                                 if (strcmp(sdna->types[sp[0]], "ClothSimSettings") == 0)
527                                         sp[10] = SDNA_TYPE_VOID;
528                         }
529                 }
530         }
531
532 #ifdef WITH_DNA_GHASH
533         {
534                 /* create a ghash lookup to speed up */
535                 sdna->structs_map = BLI_ghash_str_new_ex("init_structDNA gh", sdna->nr_structs);
536
537                 for (intptr_t nr = 0; nr < sdna->nr_structs; nr++) {
538                         sp = sdna->structs[nr];
539                         BLI_ghash_insert(sdna->structs_map, sdna->types[sp[0]], SET_INT_IN_POINTER(nr));
540                 }
541         }
542 #endif
543
544         /* Calculate 'sdna->pointerlen' */
545         {
546                 intptr_t nr = DNA_struct_find_nr(sdna, "ListBase");
547
548                 /* should never happen, only with corrupt file for example */
549                 if (UNLIKELY(nr == -1)) {
550                         *r_error_message = "ListBase struct error! Not found.";
551                         return false;
552                 }
553
554                 /* finally pointerlen: use struct ListBase to test it, never change the size of it! */
555                 sp = sdna->structs[nr];
556                 /* weird; i have no memory of that... I think I used sizeof(void *) before... (ton) */
557
558                 sdna->pointerlen = sdna->typelens[sp[0]] / 2;
559
560                 if (sp[1] != 2 || (sdna->pointerlen != 4 && sdna->pointerlen != 8)) {
561                         *r_error_message = "ListBase struct error! Needs it to calculate pointerize.";
562                         /* well, at least sizeof(ListBase) is error proof! (ton) */
563                         return false;
564                 }
565         }
566
567         return true;
568 }
569
570 /**
571  * Constructs and returns a decoded SDNA structure from the given encoded SDNA data block.
572  */
573 SDNA *DNA_sdna_from_data(
574         const void *data, const int datalen,
575         bool do_endian_swap, bool data_alloc,
576         const char **r_error_message)
577 {
578         SDNA *sdna = MEM_mallocN(sizeof(*sdna), "sdna");
579         const char *error_message = NULL;
580
581         sdna->datalen = datalen;
582         if (data_alloc) {
583                 char *data_copy = MEM_mallocN(datalen, "sdna_data");
584                 memcpy(data_copy, data, datalen);
585                 sdna->data = data_copy;
586         }
587         else {
588                 sdna->data = data;
589         }
590         sdna->data_alloc = data_alloc;
591         
592
593         if (init_structDNA(sdna, do_endian_swap, &error_message)) {
594                 return sdna;
595         }
596         else {
597                 if (r_error_message == NULL) {
598                         fprintf(stderr, "Error decoding blend file SDNA: %s\n", error_message);
599                 }
600                 else {
601                         *r_error_message = error_message;
602                 }
603                 DNA_sdna_free(sdna);
604                 return NULL;
605         }
606 }
607
608 /* ******************** END READ DNA ********************** */
609
610 /* ******************* HANDLE DNA ***************** */
611
612 /**
613  * Used by #DNA_struct_get_compareflags (below) to recursively mark all structs
614  * containing a field of type structnr as changed between old and current SDNAs.
615  */
616 static void recurs_test_compflags(const SDNA *sdna, char *compflags, int structnr)
617 {
618         int a, b, typenr, elems;
619         const short *sp;
620         const char *cp;
621         
622         /* check all structs, test if it's inside another struct */
623         sp = sdna->structs[structnr];
624         typenr = sp[0];
625         
626         for (a = 0; a < sdna->nr_structs; a++) {
627                 if ((a != structnr) && (compflags[a] == SDNA_CMP_EQUAL)) {
628                         sp = sdna->structs[a];
629                         elems = sp[1];
630                         sp += 2;
631                         for (b = 0; b < elems; b++, sp += 2) {
632                                 if (sp[0] == typenr) {
633                                         cp = sdna->names[sp[1]];
634                                         if (!ispointer(cp)) {
635                                                 compflags[a] = SDNA_CMP_NOT_EQUAL;
636                                                 recurs_test_compflags(sdna, compflags, a);
637                                         }
638                                 }
639                         }
640                 }
641         }
642         
643 }
644
645
646 /**
647  * Constructs and returns an array of byte flags with one element for each struct in oldsdna,
648  * indicating how it compares to newsdna:
649  *
650  * flag value:
651  * - 0  Struct has disappeared (values of this struct type will not be loaded by the current Blender)
652  * - 1  Struct is the same (can be loaded with straight memory copy after any necessary endian conversion)
653  * - 2  Struct is different in some way (needs to be copied/converted field by field)
654  */
655 char *DNA_struct_get_compareflags(const SDNA *oldsdna, const SDNA *newsdna)
656 {
657         int a, b;
658         const short *sp_old, *sp_new;
659         const char *str1, *str2;
660         char *compflags;
661         
662         if (oldsdna->nr_structs == 0) {
663                 printf("error: file without SDNA\n");
664                 return NULL;
665         }
666
667         compflags = MEM_callocN(oldsdna->nr_structs, "compflags");
668
669         /* we check all structs in 'oldsdna' and compare them with 
670          * the structs in 'newsdna'
671          */
672         unsigned int newsdna_index_last = 0;
673         
674         for (a = 0; a < oldsdna->nr_structs; a++) {
675                 sp_old = oldsdna->structs[a];
676                 
677                 /* search for type in cur */
678                 int sp_new_index = DNA_struct_find_nr_ex(newsdna, oldsdna->types[sp_old[0]], &newsdna_index_last);
679
680                 /* The next indices will almost always match */
681                 newsdna_index_last++;
682
683                 if (sp_new_index != -1) {
684                         sp_new = newsdna->structs[sp_new_index];
685                         /* initial assumption */
686                         compflags[a] = SDNA_CMP_NOT_EQUAL;
687                         
688                         /* compare length and amount of elems */
689                         if (sp_new[1] == sp_old[1]) {
690                                 if (newsdna->typelens[sp_new[0]] == oldsdna->typelens[sp_old[0]]) {
691
692                                         /* same length, same amount of elems, now per type and name */
693                                         b = sp_old[1];
694                                         sp_old += 2;
695                                         sp_new += 2;
696                                         while (b > 0) {
697                                                 str1 = newsdna->types[sp_new[0]];
698                                                 str2 = oldsdna->types[sp_old[0]];
699                                                 if (strcmp(str1, str2) != 0) break;
700
701                                                 str1 = newsdna->names[sp_new[1]];
702                                                 str2 = oldsdna->names[sp_old[1]];
703                                                 if (strcmp(str1, str2) != 0) break;
704
705                                                 /* same type and same name, now pointersize */
706                                                 if (ispointer(str1)) {
707                                                         if (oldsdna->pointerlen != newsdna->pointerlen) break;
708                                                 }
709
710                                                 b--;
711                                                 sp_old += 2;
712                                                 sp_new += 2;
713                                         }
714                                         if (b == 0) {
715                                                 /* no differences found */
716                                                 compflags[a] = SDNA_CMP_EQUAL;
717                                         }
718
719                                 }
720                         }
721                         
722                 }
723         }
724
725         /* first struct in util.h is struct Link, this is skipped in compflags (als # 0).
726          * was a bug, and this way dirty patched! Solve this later....
727          */
728         compflags[0] = SDNA_CMP_EQUAL;
729
730         /* Because structs can be inside structs, we recursively
731          * set flags when a struct is altered
732          */
733         for (a = 0; a < oldsdna->nr_structs; a++) {
734                 if (compflags[a] == SDNA_CMP_NOT_EQUAL) {
735                         recurs_test_compflags(oldsdna, compflags, a);
736                 }
737         }
738         
739 #if 0
740         for (a = 0; a < oldsdna->nr_structs; a++) {
741                 if (compflags[a] == SDNA_CMP_NOT_EQUAL) {
742                         spold = oldsdna->structs[a];
743                         printf("changed: %s\n", oldsdna->types[spold[0]]);
744                 }
745         }
746 #endif
747
748         return compflags;
749 }
750
751 /**
752  * Converts the name of a primitive type to its enumeration code.
753  */
754 static eSDNA_Type sdna_type_nr(const char *dna_type)
755 {
756         if     ((strcmp(dna_type, "char") == 0) || (strcmp(dna_type, "const char") == 0))          return SDNA_TYPE_CHAR;
757         else if ((strcmp(dna_type, "uchar") == 0) || (strcmp(dna_type, "unsigned char") == 0))     return SDNA_TYPE_UCHAR;
758         else if ( strcmp(dna_type, "short") == 0)                                                  return SDNA_TYPE_SHORT;
759         else if ((strcmp(dna_type, "ushort") == 0) || (strcmp(dna_type, "unsigned short") == 0))   return SDNA_TYPE_USHORT;
760         else if ( strcmp(dna_type, "int") == 0)                                                    return SDNA_TYPE_INT;
761         else if ( strcmp(dna_type, "float") == 0)                                                  return SDNA_TYPE_FLOAT;
762         else if ( strcmp(dna_type, "double") == 0)                                                 return SDNA_TYPE_DOUBLE;
763         else if ( strcmp(dna_type, "int64_t") == 0)                                                return SDNA_TYPE_INT64;
764         else if ( strcmp(dna_type, "uint64_t") == 0)                                               return SDNA_TYPE_UINT64;
765         else                                                                                       return -1; /* invalid! */
766 }
767
768 /**
769  * Converts a value of one primitive type to another.
770  * Note there is no optimization for the case where otype and ctype are the same:
771  * assumption is that caller will handle this case.
772  *
773  * \param ctype  Name of type to convert to
774  * \param otype  Name of type to convert from
775  * \param name  Field name to extract array-size information
776  * \param curdata  Where to put converted data
777  * \param olddata  Data of type otype to convert
778  */
779 static void cast_elem(
780         const char *ctype, const char *otype, const char *name,
781         char *curdata, const char *olddata)
782 {
783         double val = 0.0;
784         int arrlen, curlen = 1, oldlen = 1;
785
786         eSDNA_Type ctypenr, otypenr;
787
788         arrlen = DNA_elem_array_size(name);
789
790         if ( (otypenr = sdna_type_nr(otype)) == -1 ||
791              (ctypenr = sdna_type_nr(ctype)) == -1)
792         {
793                 return;
794         }
795
796         /* define lengths */
797         oldlen = DNA_elem_type_size(otypenr);
798         curlen = DNA_elem_type_size(ctypenr);
799
800         while (arrlen > 0) {
801                 switch (otypenr) {
802                         case SDNA_TYPE_CHAR:
803                                 val = *olddata; break;
804                         case SDNA_TYPE_UCHAR:
805                                 val = *( (unsigned char *)olddata); break;
806                         case SDNA_TYPE_SHORT:
807                                 val = *( (short *)olddata); break;
808                         case SDNA_TYPE_USHORT:
809                                 val = *( (unsigned short *)olddata); break;
810                         case SDNA_TYPE_INT:
811                                 val = *( (int *)olddata); break;
812                         case SDNA_TYPE_FLOAT:
813                                 val = *( (float *)olddata); break;
814                         case SDNA_TYPE_DOUBLE:
815                                 val = *( (double *)olddata); break;
816                         case SDNA_TYPE_INT64:
817                                 val = *( (int64_t *)olddata); break;
818                         case SDNA_TYPE_UINT64:
819                                 val = *( (uint64_t *)olddata); break;
820                 }
821                 
822                 switch (ctypenr) {
823                         case SDNA_TYPE_CHAR:
824                                 *curdata = val; break;
825                         case SDNA_TYPE_UCHAR:
826                                 *( (unsigned char *)curdata) = val; break;
827                         case SDNA_TYPE_SHORT:
828                                 *( (short *)curdata) = val; break;
829                         case SDNA_TYPE_USHORT:
830                                 *( (unsigned short *)curdata) = val; break;
831                         case SDNA_TYPE_INT:
832                                 *( (int *)curdata) = val; break;
833                         case SDNA_TYPE_FLOAT:
834                                 if (otypenr < 2) val /= 255;
835                                 *( (float *)curdata) = val; break;
836                         case SDNA_TYPE_DOUBLE:
837                                 if (otypenr < 2) val /= 255;
838                                 *( (double *)curdata) = val; break;
839                         case SDNA_TYPE_INT64:
840                                 *( (int64_t *)curdata) = val; break;
841                         case SDNA_TYPE_UINT64:
842                                 *( (uint64_t *)curdata) = val; break;
843                 }
844
845                 olddata += oldlen;
846                 curdata += curlen;
847                 arrlen--;
848         }
849 }
850
851 /**
852  * Converts pointer values between different sizes. These are only used
853  * as lookup keys to identify data blocks in the saved .blend file, not
854  * as actual in-memory pointers.
855  *
856  * \param curlen  Pointer length to conver to
857  * \param oldlen  Length of pointers in olddata
858  * \param name  Field name to extract array-size information
859  * \param curdata  Where to put converted data
860  * \param olddata  Data to convert
861  */
862 static void cast_pointer(int curlen, int oldlen, const char *name, char *curdata, const char *olddata)
863 {
864         int64_t lval;
865         int arrlen;
866         
867         arrlen = DNA_elem_array_size(name);
868         
869         while (arrlen > 0) {
870         
871                 if (curlen == oldlen) {
872                         memcpy(curdata, olddata, curlen);
873                 }
874                 else if (curlen == 4 && oldlen == 8) {
875                         lval = *((int64_t *)olddata);
876
877                         /* WARNING: 32-bit Blender trying to load file saved by 64-bit Blender,
878                          * pointers may lose uniqueness on truncation! (Hopefully this wont
879                          * happen unless/until we ever get to multi-gigabyte .blend files...) */
880                         *((int *)curdata) = lval >> 3;
881                 }
882                 else if (curlen == 8 && oldlen == 4) {
883                         *((int64_t *)curdata) = *((int *)olddata);
884                 }
885                 else {
886                         /* for debug */
887                         printf("errpr: illegal pointersize!\n");
888                 }
889                 
890                 olddata += oldlen;
891                 curdata += curlen;
892                 arrlen--;
893
894         }
895 }
896
897 /**
898  * Equality test on name and oname excluding any array-size suffix.
899  */
900 static int elem_strcmp(const char *name, const char *oname)
901 {
902         int a = 0;
903         
904         while (1) {
905                 if (name[a] != oname[a]) return 1;
906                 if (name[a] == '[' || oname[a] == '[') break;
907                 if (name[a] == 0 || oname[a] == 0) break;
908                 a++;
909         }
910         return 0;
911 }
912
913 /**
914  * Returns the address of the data for the specified field within olddata
915  * according to the struct format pointed to by old, or NULL if no such
916  * field can be found.
917  *
918  * \param sdna  Old SDNA
919  * \param type  Current field type name
920  * \param name  Current field name
921  * \param old  Pointer to struct information in sdna
922  * \param olddata  Struct data
923  * \param sppo  Optional place to return pointer to field info in sdna
924  * \return Data address.
925  */
926 static char *find_elem(
927         const SDNA *sdna,
928         const char *type,
929         const char *name,
930         const short *old,
931         char *olddata,
932         const short **sppo)
933 {
934         int a, elemcount, len;
935         const char *otype, *oname;
936         
937         /* without arraypart, so names can differ: return old namenr and type */
938         
939         /* in old is the old struct */
940         elemcount = old[1];
941         old += 2;
942         for (a = 0; a < elemcount; a++, old += 2) {
943
944                 otype = sdna->types[old[0]];
945                 oname = sdna->names[old[1]];
946
947                 len = elementsize(sdna, old[0], old[1]);
948
949                 if (elem_strcmp(name, oname) == 0) {  /* name equal */
950                         if (strcmp(type, otype) == 0) {   /* type equal */
951                                 if (sppo) *sppo = old;
952                                 return olddata;
953                         }
954                         
955                         return NULL;
956                 }
957                 
958                 olddata += len;
959         }
960         return NULL;
961 }
962
963 /**
964  * Converts the contents of a single field of a struct, of a non-struct type,
965  * from oldsdna to newsdna format.
966  *
967  * \param newsdna  SDNA of current Blender
968  * \param oldsdna  SDNA of Blender that saved file
969  * \param type  current field type name
970  * \param name  current field name
971  * \param curdata  put field data converted to newsdna here
972  * \param old  pointer to struct info in oldsdna
973  * \param olddata  struct contents laid out according to oldsdna
974  */
975 static void reconstruct_elem(
976         const SDNA *newsdna,
977         const SDNA *oldsdna,
978         const char *type,
979         const char *name,
980         char *curdata,
981         const short *old,
982         const char *olddata)
983 {
984         /* rules: test for NAME:
985          *      - name equal:
986          *          - cast type
987          *      - name partially equal (array differs)
988          *          - type equal: memcpy
989          *          - types casten
990          * (nzc 2-4-2001 I want the 'unsigned' bit to be parsed as well. Where
991          * can I force this?)
992          */
993         int a, elemcount, len, countpos, oldsize, cursize, mul;
994         const char *otype, *oname, *cp;
995         
996         /* is 'name' an array? */
997         cp = name;
998         countpos = 0;
999         while (*cp && *cp != '[') {
1000                 cp++; countpos++;
1001         }
1002         if (*cp != '[') countpos = 0;
1003         
1004         /* in old is the old struct */
1005         elemcount = old[1];
1006         old += 2;
1007         for (a = 0; a < elemcount; a++, old += 2) {
1008                 otype = oldsdna->types[old[0]];
1009                 oname = oldsdna->names[old[1]];
1010                 len = elementsize(oldsdna, old[0], old[1]);
1011                 
1012                 if (strcmp(name, oname) == 0) { /* name equal */
1013                         
1014                         if (ispointer(name)) {  /* pointer of functionpointer afhandelen */
1015                                 cast_pointer(newsdna->pointerlen, oldsdna->pointerlen, name, curdata, olddata);
1016                         }
1017                         else if (strcmp(type, otype) == 0) {    /* type equal */
1018                                 memcpy(curdata, olddata, len);
1019                         }
1020                         else {
1021                                 cast_elem(type, otype, name, curdata, olddata);
1022                         }
1023
1024                         return;
1025                 }
1026                 else if (countpos != 0) {  /* name is an array */
1027
1028                         if (oname[countpos] == '[' && strncmp(name, oname, countpos) == 0) {  /* basis equal */
1029                                 
1030                                 cursize = DNA_elem_array_size(name);
1031                                 oldsize = DNA_elem_array_size(oname);
1032
1033                                 if (ispointer(name)) {  /* handle pointer or functionpointer */
1034                                         cast_pointer(newsdna->pointerlen, oldsdna->pointerlen,
1035                                                      cursize > oldsize ? oname : name,
1036                                                      curdata, olddata);
1037                                 }
1038                                 else if (strcmp(type, otype) == 0) {  /* type equal */
1039                                         mul = len / oldsize; /* size of single old array element */
1040                                         mul *= (cursize < oldsize) ? cursize : oldsize; /* smaller of sizes of old and new arrays */
1041                                         memcpy(curdata, olddata, mul);
1042                                         
1043                                         if (oldsize > cursize && strcmp(type, "char") == 0) {
1044                                                 /* string had to be truncated, ensure it's still null-terminated */
1045                                                 curdata[mul - 1] = '\0';
1046                                         }
1047                                 }
1048                                 else {
1049                                         cast_elem(type, otype,
1050                                                   cursize > oldsize ? oname : name,
1051                                                   curdata, olddata);
1052                                 }
1053                                 return;
1054                         }
1055                 }
1056                 olddata += len;
1057         }
1058 }
1059
1060 /**
1061  * Converts the contents of an entire struct from oldsdna to newsdna format.
1062  *
1063  * \param newsdna  SDNA of current Blender
1064  * \param oldsdna  SDNA of Blender that saved file
1065  * \param compflags
1066  *
1067  * Result from DNA_struct_get_compareflags to avoid needless conversions.
1068  * \param oldSDNAnr  Index of old struct definition in oldsdna
1069  * \param data  Struct contents laid out according to oldsdna
1070  * \param curSDNAnr  Index of current struct definition in newsdna
1071  * \param cur  Where to put converted struct contents
1072  */
1073 static void reconstruct_struct(
1074         const SDNA *newsdna,
1075         const SDNA *oldsdna,
1076         const char *compflags,
1077
1078         int oldSDNAnr,
1079         char *data,
1080         int curSDNAnr,
1081         char *cur)
1082 {
1083         /* Recursive!
1084          * Per element from cur_struct, read data from old_struct.
1085          * If element is a struct, call recursive.
1086          */
1087         int a, elemcount, elen, eleno, mul, mulo, firststructtypenr;
1088         const short *spo, *spc, *sppo;
1089         const char *type;
1090         char *cpo, *cpc;
1091         const char *name, *nameo;
1092
1093         unsigned int oldsdna_index_last = UINT_MAX;
1094         unsigned int cursdna_index_last = UINT_MAX;
1095
1096
1097         if (oldSDNAnr == -1) return;
1098         if (curSDNAnr == -1) return;
1099
1100         if (compflags[oldSDNAnr] == SDNA_CMP_EQUAL) {
1101                 /* if recursive: test for equal */
1102                 spo = oldsdna->structs[oldSDNAnr];
1103                 elen = oldsdna->typelens[spo[0]];
1104                 memcpy(cur, data, elen);
1105                 
1106                 return;
1107         }
1108
1109         firststructtypenr = *(newsdna->structs[0]);
1110
1111         spo = oldsdna->structs[oldSDNAnr];
1112         spc = newsdna->structs[curSDNAnr];
1113
1114         elemcount = spc[1];
1115
1116         spc += 2;
1117         cpc = cur;
1118         for (a = 0; a < elemcount; a++, spc += 2) {  /* convert each field */
1119                 type = newsdna->types[spc[0]];
1120                 name = newsdna->names[spc[1]];
1121                 
1122                 elen = elementsize(newsdna, spc[0], spc[1]);
1123
1124                 /* test: is type a struct? */
1125                 if (spc[0] >= firststructtypenr && !ispointer(name)) {
1126                         /* struct field type */
1127                         /* where does the old struct data start (and is there an old one?) */
1128                         cpo = find_elem(oldsdna, type, name, spo, data, &sppo);
1129                         
1130                         if (cpo) {
1131                                 oldSDNAnr = DNA_struct_find_nr_ex(oldsdna, type, &oldsdna_index_last);
1132                                 curSDNAnr = DNA_struct_find_nr_ex(newsdna, type, &cursdna_index_last);
1133                                 
1134                                 /* array! */
1135                                 mul = DNA_elem_array_size(name);
1136                                 nameo = oldsdna->names[sppo[1]];
1137                                 mulo = DNA_elem_array_size(nameo);
1138                                 
1139                                 eleno = elementsize(oldsdna, sppo[0], sppo[1]);
1140                                 
1141                                 elen /= mul;
1142                                 eleno /= mulo;
1143                                 
1144                                 while (mul--) {
1145                                         reconstruct_struct(newsdna, oldsdna, compflags, oldSDNAnr, cpo, curSDNAnr, cpc);
1146                                         cpo += eleno;
1147                                         cpc += elen;
1148                                         
1149                                         /* new struct array larger than old */
1150                                         mulo--;
1151                                         if (mulo <= 0) break;
1152                                 }
1153                         }
1154                         else {
1155                                 cpc += elen;  /* skip field no longer present */
1156                         }
1157                 }
1158                 else {
1159                         /* non-struct field type */
1160                         reconstruct_elem(newsdna, oldsdna, type, name, cpc, spo, data);
1161                         cpc += elen;
1162                 }
1163         }
1164 }
1165
1166 /**
1167  * Does endian swapping on the fields of a struct value.
1168  *
1169  * \param oldsdna  SDNA of Blender that saved file
1170  * \param oldSDNAnr  Index of struct info within oldsdna
1171  * \param data  Struct data
1172  */
1173 void DNA_struct_switch_endian(const SDNA *oldsdna, int oldSDNAnr, char *data)
1174 {
1175         /* Recursive!
1176          * If element is a struct, call recursive.
1177          */
1178         int a, mul, elemcount, elen, elena, firststructtypenr;
1179         const short *spo, *spc;
1180         char *cur;
1181         const char *type, *name;
1182         unsigned int oldsdna_index_last = UINT_MAX;
1183
1184         if (oldSDNAnr == -1) return;
1185         firststructtypenr = *(oldsdna->structs[0]);
1186         
1187         spo = spc = oldsdna->structs[oldSDNAnr];
1188
1189         elemcount = spo[1];
1190
1191         spc += 2;
1192         cur = data;
1193         
1194         for (a = 0; a < elemcount; a++, spc += 2) {
1195                 type = oldsdna->types[spc[0]];
1196                 name = oldsdna->names[spc[1]];
1197                 
1198                 /* elementsize = including arraysize */
1199                 elen = elementsize(oldsdna, spc[0], spc[1]);
1200
1201                 /* test: is type a struct? */
1202                 if (spc[0] >= firststructtypenr && !ispointer(name)) {
1203                         /* struct field type */
1204                         /* where does the old data start (is there one?) */
1205                         char *cpo = find_elem(oldsdna, type, name, spo, data, NULL);
1206                         if (cpo) {
1207                                 oldSDNAnr = DNA_struct_find_nr_ex(oldsdna, type, &oldsdna_index_last);
1208                                 
1209                                 mul = DNA_elem_array_size(name);
1210                                 elena = elen / mul;
1211
1212                                 while (mul--) {
1213                                         DNA_struct_switch_endian(oldsdna, oldSDNAnr, cpo);
1214                                         cpo += elena;
1215                                 }
1216                         }
1217                 }
1218                 else {
1219                         /* non-struct field type */
1220                         if (ispointer(name)) {
1221                                 if (oldsdna->pointerlen == 8) {
1222                                         BLI_endian_switch_int64_array((int64_t *)cur, DNA_elem_array_size(name));
1223                                 }
1224                         }
1225                         else {
1226                                 if (ELEM(spc[0], SDNA_TYPE_SHORT, SDNA_TYPE_USHORT)) {
1227
1228                                         /* exception: variable called blocktype: derived from ID_  */
1229                                         bool skip = false;
1230                                         if (name[0] == 'b' && name[1] == 'l') {
1231                                                 if (strcmp(name, "blocktype") == 0) skip = true;
1232                                         }
1233
1234                                         if (skip == false) {
1235                                                 BLI_endian_switch_int16_array((int16_t *)cur, DNA_elem_array_size(name));
1236                                         }
1237                                 }
1238                                 else if (ELEM(spc[0], SDNA_TYPE_INT, SDNA_TYPE_FLOAT)) {
1239                                         /* note, intentionally ignore long/ulong here these could be 4 or 8 bits,
1240                                          * but turns out we only used for runtime vars and
1241                                          * only once for a struct type thats no longer used. */
1242
1243                                         BLI_endian_switch_int32_array((int32_t *)cur, DNA_elem_array_size(name));
1244                                 }
1245                                 else if (ELEM(spc[0], SDNA_TYPE_INT64, SDNA_TYPE_UINT64, SDNA_TYPE_DOUBLE)) {
1246                                         BLI_endian_switch_int64_array((int64_t *)cur, DNA_elem_array_size(name));
1247                                 }
1248                         }
1249                 }
1250                 cur += elen;
1251         }
1252 }
1253
1254 /**
1255  * \param newsdna  SDNA of current Blender
1256  * \param oldsdna  SDNA of Blender that saved file
1257  * \param compflags
1258  *
1259  * Result from DNA_struct_get_compareflags to avoid needless conversions
1260  * \param oldSDNAnr  Index of struct info within oldsdna
1261  * \param blocks  The number of array elements
1262  * \param data  Array of struct data
1263  * \return An allocated reconstructed struct
1264  */
1265 void *DNA_struct_reconstruct(
1266         const SDNA *newsdna, const SDNA *oldsdna,
1267         char *compflags, int oldSDNAnr, int blocks, void *data)
1268 {
1269         int a, curSDNAnr, curlen = 0, oldlen;
1270         const short *spo, *spc;
1271         char *cur, *cpc, *cpo;
1272         const char *type;
1273         
1274         /* oldSDNAnr == structnr, we're looking for the corresponding 'cur' number */
1275         spo = oldsdna->structs[oldSDNAnr];
1276         type = oldsdna->types[spo[0]];
1277         oldlen = oldsdna->typelens[spo[0]];
1278         curSDNAnr = DNA_struct_find_nr(newsdna, type);
1279
1280         /* init data and alloc */
1281         if (curSDNAnr != -1) {
1282                 spc = newsdna->structs[curSDNAnr];
1283                 curlen = newsdna->typelens[spc[0]];
1284         }
1285         if (curlen == 0) {
1286                 return NULL;
1287         }
1288
1289         cur = MEM_callocN(blocks * curlen, "reconstruct");
1290         cpc = cur;
1291         cpo = data;
1292         for (a = 0; a < blocks; a++) {
1293                 reconstruct_struct(newsdna, oldsdna, compflags, oldSDNAnr, cpo, curSDNAnr, cpc);
1294                 cpc += curlen;
1295                 cpo += oldlen;
1296         }
1297
1298         return cur;
1299 }
1300
1301 /**
1302  * Returns the offset of the field with the specified name and type within the specified
1303  * struct type in sdna.
1304  */
1305 int DNA_elem_offset(SDNA *sdna, const char *stype, const char *vartype, const char *name)
1306 {
1307         const int SDNAnr = DNA_struct_find_nr(sdna, stype);
1308         const short * const spo = sdna->structs[SDNAnr];
1309         const char * const cp = find_elem(sdna, vartype, name, spo, NULL, NULL);
1310         BLI_assert(SDNAnr != -1);
1311         return (int)((intptr_t)cp);
1312 }
1313
1314 bool DNA_struct_elem_find(SDNA *sdna, const char *stype, const char *vartype, const char *name)
1315 {
1316         const int SDNAnr = DNA_struct_find_nr(sdna, stype);
1317         
1318         if (SDNAnr != -1) {
1319                 const short * const spo = sdna->structs[SDNAnr];
1320                 const char * const cp = find_elem(sdna, vartype, name, spo, NULL, NULL);
1321                 
1322                 if (cp) {
1323                         return true;
1324                 }
1325         }
1326         return false;
1327 }
1328
1329
1330 /**
1331  * Returns the size in bytes of a primitive type.
1332  */
1333 int DNA_elem_type_size(const eSDNA_Type elem_nr)
1334 {
1335         /* should contain all enum types */
1336         switch (elem_nr) {
1337                 case SDNA_TYPE_CHAR:
1338                 case SDNA_TYPE_UCHAR:
1339                         return 1;
1340                 case SDNA_TYPE_SHORT:
1341                 case SDNA_TYPE_USHORT:
1342                         return 2;
1343                 case SDNA_TYPE_INT:
1344                 case SDNA_TYPE_FLOAT:
1345                         return 4;
1346                 case SDNA_TYPE_DOUBLE:
1347                 case SDNA_TYPE_INT64:
1348                 case SDNA_TYPE_UINT64:
1349                         return 8;
1350         }
1351
1352         /* weak */
1353         return 8;
1354 }