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