Cleanup: warnings
[blender.git] / source / blender / makesdna / intern / makesdna.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  */
27
28 /**  \file makesdna.c
29  *   \brief Struct muncher for making SDNA.
30  *   \ingroup DNA
31  *
32  * \section aboutmakesdnac About makesdna tool
33  * Originally by Ton, some mods by Frank, and some cleaning and
34  * extension by Nzc.
35  *
36  * Makesdna creates a .c file with a long string of numbers that
37  * encode the Blender file format. It is fast, because it is basically
38  * a binary dump. There are some details to mind when reconstructing
39  * the file (endianness and byte-alignment).
40  *
41  * This little program scans all structs that need to be serialized,
42  * and determined the names and types of all members. It calculates
43  * how much memory (on disk or in ram) is needed to store that struct,
44  * and the offsets for reaching a particular one.
45  *
46  * There is a facility to get verbose output from sdna. Search for
47  * \ref debugSDNA. This int can be set to 0 (no output) to some int. Higher
48  * numbers give more output.
49  */
50
51 #include <string.h>
52 #include <stdlib.h>
53 #include <stdio.h>
54
55 #include "MEM_guardedalloc.h"
56
57 #include "../blenlib/BLI_sys_types.h" // for intptr_t support
58
59 #define SDNA_MAX_FILENAME_LENGTH 255
60
61
62 /* Included the path relative from /source/blender/ here, so we can move     */
63 /* headers around with more freedom.                                         */
64 static const char *includefiles[] = {
65
66         /* if you add files here, please add them at the end
67          * of makesdna.c (this file) as well */
68         "DNA_listBase.h",
69         "DNA_vec_types.h",
70         "DNA_ID.h",
71         "DNA_ipo_types.h",
72         "DNA_key_types.h",
73         "DNA_text_types.h",
74         "DNA_packedFile_types.h",
75         "DNA_gpu_types.h",
76         "DNA_camera_types.h",
77         "DNA_image_types.h",
78         "DNA_texture_types.h",
79         "DNA_lamp_types.h",
80         "DNA_material_types.h",
81         "DNA_vfont_types.h",
82         "DNA_meta_types.h",
83         "DNA_curve_types.h",
84         "DNA_mesh_types.h",
85         "DNA_meshdata_types.h",
86         "DNA_modifier_types.h",
87         "DNA_lattice_types.h",
88         "DNA_object_types.h",
89         "DNA_object_force_types.h",
90         "DNA_object_fluidsim_types.h",
91         "DNA_world_types.h",
92         "DNA_scene_types.h",
93         "DNA_view3d_types.h",
94         "DNA_view2d_types.h",
95         "DNA_space_types.h",
96         "DNA_userdef_types.h",
97         "DNA_screen_types.h",
98         "DNA_sdna_types.h",
99         "DNA_fileglobal_types.h",
100         "DNA_sequence_types.h",
101         "DNA_effect_types.h",
102         "DNA_outliner_types.h",
103         "DNA_sound_types.h",
104         "DNA_group_types.h",
105         "DNA_armature_types.h",
106         "DNA_action_types.h",
107         "DNA_constraint_types.h",
108         "DNA_nla_types.h",
109         "DNA_node_types.h",
110         "DNA_color_types.h",
111         "DNA_brush_types.h",
112         "DNA_customdata_types.h",
113         "DNA_particle_types.h",
114         "DNA_cloth_types.h",
115         "DNA_gpencil_types.h",
116         "DNA_windowmanager_types.h",
117         "DNA_anim_types.h",
118         "DNA_boid_types.h",
119         "DNA_smoke_types.h",
120         "DNA_speaker_types.h",
121         "DNA_movieclip_types.h",
122         "DNA_tracking_types.h",
123         "DNA_dynamicpaint_types.h",
124         "DNA_mask_types.h",
125         "DNA_rigidbody_types.h",
126         "DNA_freestyle_types.h",
127         "DNA_linestyle_types.h",
128         "DNA_cachefile_types.h",
129         "DNA_layer_types.h",
130         "DNA_workspace_types.h",
131         "DNA_lightprobe_types.h",
132
133         /* see comment above before editing! */
134
135         /* empty string to indicate end of includefiles */
136         ""
137 };
138
139 static int maxdata = 500000, maxnr = 50000;
140 static int nr_names = 0;
141 static int nr_types = 0;
142 static int nr_structs = 0;
143 static char **names, *namedata;      /* at address names[a] is string a */
144 static char **types, *typedata;      /* at address types[a] is string a */
145 static short *typelens_native;       /* at typelens[a] is the length of type 'a' on this systems bitness (32 or 64) */
146 static short *typelens_32;           /* contains sizes as they are calculated on 32 bit systems */
147 static short *typelens_64;           /* contains sizes as they are calculated on 64 bit systems */
148 static short **structs, *structdata; /* at sp = structs[a] is the first address of a struct definition
149                                       * sp[0] is type number
150                                       * sp[1] is amount of elements
151                                       * sp[2] sp[3] is typenr,  namenr (etc) */
152 /**
153  * Variable to control debug output of makesdna.
154  * debugSDNA:
155  *  - 0 = no output, except errors
156  *  - 1 = detail actions
157  *  - 2 = full trace, tell which names and types were found
158  *  - 4 = full trace, plus all gritty details
159  */
160 static int debugSDNA = 0;
161 static int additional_slen_offset;
162
163 /* ************************************************************************** */
164 /* Functions                                                                  */
165 /* ************************************************************************** */
166
167 /**
168  * Add type \c str to struct indexed by \c len, if it was not yet found.
169  * \param str char
170  * \param len int
171  */
172 static int add_type(const char *str, int len);
173
174 /**
175  * Add variable \c str to 
176  * \param str
177  */
178 static int add_name(const char *str);
179
180 /**
181  * Search whether this structure type was already found, and if not,
182  * add it.
183  */
184 static short *add_struct(int namecode);
185
186 /**
187  * Remove comments from this buffer. Assumes that the buffer refers to
188  * ascii-code text.
189  */
190 static int preprocess_include(char *maindata, int len);
191
192 /**
193  * Scan this file for serializable types.
194  */ 
195 static int convert_include(const char *filename);
196
197 /**
198  * Determine how many bytes are needed for an array.
199  */ 
200 static int arraysize(const char *str);
201
202 /**
203  * Determine how many bytes are needed for each struct.
204  */ 
205 static int calculate_structlens(int);
206
207 /**
208  * Construct the DNA.c file
209  */ 
210 static void dna_write(FILE *file, const void *pntr, const int size);
211
212 /**
213  * Report all structures found so far, and print their lengths.
214  */
215 void printStructLengths(void);
216
217
218
219 /* ************************************************************************** */
220 /* Implementation                                                             */
221 /* ************************************************************************** */
222
223 /* ************************* MAKEN DNA ********************** */
224
225 static int add_type(const char *str, int len)
226 {
227         int nr;
228         char *cp;
229         
230         /* first do validity check */
231         if (str[0] == 0) {
232                 return -1;
233         }
234         else if (strchr(str, '*')) {
235                 /* note: this is valid C syntax but we can't parse, complain!
236                  * 'struct SomeStruct* somevar;' <-- correct but we cant handle right now. */
237                 return -1;
238         }
239         
240         /* search through type array */
241         for (nr = 0; nr < nr_types; nr++) {
242                 if (strcmp(str, types[nr]) == 0) {
243                         if (len) {
244                                 typelens_native[nr] = len;
245                                 typelens_32[nr] = len;
246                                 typelens_64[nr] = len;
247                         }
248                         return nr;
249                 }
250         }
251         
252         /* append new type */
253         if (nr_types == 0) {
254                 cp = typedata;
255         }
256         else {
257                 cp = types[nr_types - 1] + strlen(types[nr_types - 1]) + 1;
258         }
259         strcpy(cp, str);
260         types[nr_types] = cp;
261         typelens_native[nr_types] = len;
262         typelens_32[nr_types] = len;
263         typelens_64[nr_types] = len;
264         
265         if (nr_types >= maxnr) {
266                 printf("too many types\n");
267                 return nr_types - 1;
268         }
269         nr_types++;
270         
271         return nr_types - 1;
272 }
273
274
275 /**
276  *
277  * Because of the weird way of tokenizing, we have to 'cast' function
278  * pointers to ... (*f)(), whatever the original signature. In fact,
279  * we add name and type at the same time... There are two special
280  * cases, unfortunately. These are explicitly checked.
281  *
282  * */
283 static int add_name(const char *str)
284 {
285         int nr, i, j, k;
286         char *cp;
287         char buf[255]; /* stupid limit, change it :) */
288         const char *name;
289
290         additional_slen_offset = 0;
291         
292         if (str[0] == 0 /*  || (str[1] == 0) */) return -1;
293
294         if (str[0] == '(' && str[1] == '*') {
295                 /* we handle function pointer and special array cases here, e.g.
296                  * void (*function)(...) and float (*array)[..]. the array case
297                  * name is still converted to (array *)() though because it is that
298                  * way in old dna too, and works correct with elementsize() */
299                 int isfuncptr = (strchr(str + 1, '(')) != NULL;
300
301                 if (debugSDNA > 3) printf("\t\t\t\t*** Function pointer or multidim array pointer found\n");
302                 /* functionpointer: transform the type (sometimes) */
303                 i = 0;
304
305                 while (str[i] != ')') {
306                         buf[i] = str[i];
307                         i++;
308                 }
309                 
310                 /* Another number we need is the extra slen offset. This extra
311                  * offset is the overshoot after a space. If there is no
312                  * space, no overshoot should be calculated. */
313                 j = i; /* j at first closing brace */
314
315                 if (debugSDNA > 3) printf("first brace after offset %d\n", i);
316
317                 j++; /* j beyond closing brace ? */
318                 while ((str[j] != 0) && (str[j] != ')')) {
319                         if (debugSDNA > 3) printf("seen %c ( %d)\n", str[j], str[j]);
320                         j++;
321                 }
322                 if (debugSDNA > 3) printf("seen %c ( %d)\n"
323                                               "special after offset%d\n",
324                                               str[j], str[j], j);
325                                 
326                 if (!isfuncptr) {
327                         /* multidimensional array pointer case */
328                         if (str[j] == 0) {
329                                 if (debugSDNA > 3) printf("offsetting for multidim array pointer\n");
330                         }
331                         else
332                                 printf("Error during tokening multidim array pointer\n");
333                 }
334                 else if (str[j] == 0) {
335                         if (debugSDNA > 3) printf("offsetting for space\n"); 
336                         /* get additional offset */
337                         k = 0;
338                         while (str[j] != ')') {
339                                 j++;
340                                 k++;
341                         }
342                         if (debugSDNA > 3) printf("extra offset %d\n", k);
343                         additional_slen_offset = k;
344                 }
345                 else if (str[j] == ')') {
346                         if (debugSDNA > 3) printf("offsetting for brace\n");
347                         ; /* don't get extra offset */
348                 }
349                 else {
350                         printf("Error during tokening function pointer argument list\n");
351                 }
352                                 
353                 /*
354                  * Put )(void) at the end? Maybe )(). Should check this with
355                  * old sdna. Actually, sometimes )(), sometimes )(void...)
356                  * Alas.. such is the nature of braindamage :(
357                  *
358                  * Sorted it out: always do )(), except for headdraw and
359                  * windraw, part of ScrArea. This is important, because some
360                  * linkers will treat different fp's differently when called
361                  * !!! This has to do with interference in byte-alignment and
362                  * the way args are pushed on the stack.
363                  *
364                  * */
365                 buf[i] = 0;
366                 if (debugSDNA > 3) printf("Name before chomping: %s\n", buf); 
367                 if ((strncmp(buf, "(*headdraw", 10) == 0) ||
368                     (strncmp(buf, "(*windraw", 9) == 0) )
369                 {
370                         buf[i] = ')';
371                         buf[i + 1] = '(';
372                         buf[i + 2] = 'v';
373                         buf[i + 3] = 'o';
374                         buf[i + 4] = 'i';
375                         buf[i + 5] = 'd';
376                         buf[i + 6] = ')';
377                         buf[i + 7] = 0;
378                 }
379                 else {
380                         buf[i] = ')';
381                         buf[i + 1] = '(';
382                         buf[i + 2] = ')';
383                         buf[i + 3] = 0;
384                 }
385                 /* now precede with buf*/
386                 if (debugSDNA > 3) printf("\t\t\t\t\tProposing fp name %s\n", buf);
387                 name = buf;
388         }
389         else {
390                 /* normal field: old code */
391                 name = str;
392         }
393         
394         /* search name array */
395         for (nr = 0; nr < nr_names; nr++) {
396                 if (strcmp(name, names[nr]) == 0) {
397                         return nr;
398                 }
399         }
400         
401         /* append new type */
402         if (nr_names == 0) {
403                 cp = namedata;
404         }
405         else {
406                 cp = names[nr_names - 1] + strlen(names[nr_names - 1]) + 1;
407         }
408         strcpy(cp, name);
409         names[nr_names] = cp;
410         
411         if (nr_names >= maxnr) {
412                 printf("too many names\n");
413                 return nr_names - 1;
414         }
415         nr_names++;
416         
417         return nr_names - 1;
418 }
419
420 static short *add_struct(int namecode)
421 {
422         int len;
423         short *sp;
424
425         if (nr_structs == 0) {
426                 structs[0] = structdata;
427         }
428         else {
429                 sp = structs[nr_structs - 1];
430                 len = sp[1];
431                 structs[nr_structs] = sp + 2 * len + 2;
432         }
433         
434         sp = structs[nr_structs];
435         sp[0] = namecode;
436         
437         if (nr_structs >= maxnr) {
438                 printf("too many structs\n");
439                 return sp;
440         }
441         nr_structs++;
442         
443         return sp;
444 }
445
446 static int preprocess_include(char *maindata, int len)
447 {
448         int a, newlen, comment = 0;
449         char *cp, *temp, *md;
450         
451         /* note: len + 1, last character is a dummy to prevent
452          * comparisons using uninitialized memory */
453         temp = MEM_mallocN(len + 1, "preprocess_include");
454         temp[len] = ' ';
455
456         memcpy(temp, maindata, len);
457         
458         /* remove all c++ comments */
459         /* replace all enters/tabs/etc with spaces */
460         cp = temp;
461         a = len;
462         comment = 0;
463         while (a--) {
464                 if (cp[0] == '/' && cp[1] == '/') {
465                         comment = 1;
466                 }
467                 else if (*cp == '\n') {
468                         comment = 0;
469                 }
470                 if (comment || *cp < 32 || *cp > 128) *cp = 32;
471                 cp++;
472         }
473         
474
475         /* data from temp copy to maindata, remove comments and double spaces */
476         cp = temp;
477         md = maindata;
478         newlen = 0;
479         comment = 0;
480         a = len;
481         while (a--) {
482                 
483                 if (cp[0] == '/' && cp[1] == '*') {
484                         comment = 1;
485                         cp[0] = cp[1] = 32;
486                 }
487                 if (cp[0] == '*' && cp[1] == '/') {
488                         comment = 0;
489                         cp[0] = cp[1] = 32;
490                 }
491
492                 /* do not copy when: */
493                 if (comment) {
494                         /* pass */
495                 }
496                 else if (cp[0] == ' ' && cp[1] == ' ') {
497                         /* pass */
498                 }
499                 else if (cp[-1] == '*' && cp[0] == ' ') {
500                         /* pointers with a space */
501                 }       /* skip special keywords */
502                 else if (strncmp("DNA_DEPRECATED", cp, 14) == 0) {
503                         /* single values are skipped already, so decrement 1 less */
504                         a -= 13;
505                         cp += 13;
506                 }
507                 else if (strncmp("DNA_PRIVATE_WORKSPACE", cp, 21) == 0) {
508                         /* Check for DNA_PRIVATE_WORKSPACE_READ_WRITE */
509                         if (strncmp("_READ_WRITE", cp + 21, 11) == 0) {
510                                 a -= 31;
511                                 cp += 31;
512                         }
513                         else {
514                                 a -= 20;
515                                 cp += 20;
516                         }
517                 }
518                 else {
519                         md[0] = cp[0];
520                         md++;
521                         newlen++;
522                 }
523                 cp++;
524         }
525         
526         MEM_freeN(temp);
527         return newlen;
528 }
529
530 static void *read_file_data(const char *filename, int *r_len)
531 {
532 #ifdef WIN32
533         FILE *fp = fopen(filename, "rb");
534 #else
535         FILE *fp = fopen(filename, "r");
536 #endif
537         void *data;
538
539         if (!fp) {
540                 *r_len = -1;
541                 return NULL;
542         }
543
544         fseek(fp, 0L, SEEK_END);
545         *r_len = ftell(fp);
546         fseek(fp, 0L, SEEK_SET);
547
548         if (*r_len == -1) {
549                 fclose(fp);
550                 return NULL;
551         }
552
553         data = MEM_mallocN(*r_len, "read_file_data");
554         if (!data) {
555                 *r_len = -1;
556                 fclose(fp);
557                 return NULL;
558         }
559
560         if (fread(data, *r_len, 1, fp) != 1) {
561                 *r_len = -1;
562                 MEM_freeN(data);
563                 fclose(fp);
564                 return NULL;
565         }
566         
567         fclose(fp);
568         return data;
569 }
570
571 static int convert_include(const char *filename)
572 {
573         /* read include file, skip structs with a '#' before it.
574          * store all data in temporal arrays.
575          */
576         int filelen, count, overslaan, slen, type, name, strct;
577         short *structpoin, *sp;
578         char *maindata, *mainend, *md, *md1;
579         
580         md = maindata = read_file_data(filename, &filelen);
581         if (filelen == -1) {
582                 fprintf(stderr, "Can't read file %s\n", filename);
583                 return 1;
584         }
585
586         filelen = preprocess_include(maindata, filelen);
587         mainend = maindata + filelen - 1;
588
589         /* we look for '{' and then back to 'struct' */
590         count = 0;
591         overslaan = 0;
592         while (count < filelen) {
593                 
594                 /* code for skipping a struct: two hashes on 2 lines. (preprocess added a space) */
595                 if (md[0] == '#' && md[1] == ' ' && md[2] == '#') {
596                         overslaan = 1;
597                 }
598                 
599                 if (md[0] == '{') {
600                         md[0] = 0;
601                         if (overslaan) {
602                                 overslaan = 0;
603                         }
604                         else {
605                                 if (md[-1] == ' ') md[-1] = 0;
606                                 md1 = md - 2;
607                                 while (*md1 != 32) md1--;       /* to beginning of word */
608                                 md1++;
609                                 
610                                 /* we've got a struct name when... */
611                                 if (strncmp(md1 - 7, "struct", 6) == 0) {
612
613                                         strct = add_type(md1, 0);
614                                         if (strct == -1) {
615                                                 fprintf(stderr, "File '%s' contains struct we cant parse \"%s\"\n", filename, md1);
616                                                 return 1;
617                                         }
618
619                                         structpoin = add_struct(strct);
620                                         sp = structpoin + 2;
621
622                                         if (debugSDNA > 1) printf("\t|\t|-- detected struct %s\n", types[strct]);
623
624                                         /* first lets make it all nice strings */
625                                         md1 = md + 1;
626                                         while (*md1 != '}') {
627                                                 if (md1 > mainend) break;
628                                                 
629                                                 if (*md1 == ',' || *md1 == ' ') *md1 = 0;
630                                                 md1++;
631                                         }
632                                         
633                                         /* read types and names until first character that is not '}' */
634                                         md1 = md + 1;
635                                         while (*md1 != '}') {
636                                                 if (md1 > mainend) break;
637                                                 
638                                                 /* skip when it says 'struct' or 'unsigned' or 'const' */
639                                                 if (*md1) {
640                                                         if (strncmp(md1, "struct", 6) == 0) md1 += 7;
641                                                         if (strncmp(md1, "unsigned", 8) == 0) md1 += 9;
642                                                         if (strncmp(md1, "const", 5) == 0) md1 += 6;
643                                                         
644                                                         /* we've got a type! */
645                                                         type = add_type(md1, 0);
646                                                         if (type == -1) {
647                                                                 fprintf(stderr, "File '%s' contains struct we can't parse \"%s\"\n", filename, md1);
648                                                                 return 1;
649                                                         }
650
651                                                         if (debugSDNA > 1) printf("\t|\t|\tfound type %s (", md1);
652
653                                                         md1 += strlen(md1);
654
655                                                         
656                                                         /* read until ';' */
657                                                         while (*md1 != ';') {
658                                                                 if (md1 > mainend) break;
659                                                                 
660                                                                 if (*md1) {
661                                                                         /* We've got a name. slen needs
662                                                                          * correction for function
663                                                                          * pointers! */
664                                                                         slen = (int) strlen(md1);
665                                                                         if (md1[slen - 1] == ';') {
666                                                                                 md1[slen - 1] = 0;
667
668
669                                                                                 name = add_name(md1);
670                                                                                 slen += additional_slen_offset;
671                                                                                 sp[0] = type;
672                                                                                 sp[1] = name;
673
674                                                                                 if ((debugSDNA > 1) && (names[name] != NULL)) printf("%s |", names[name]);
675
676                                                                                 structpoin[1]++;
677                                                                                 sp += 2;
678                                                                                                                                                                         
679                                                                                 md1 += slen;
680                                                                                 break;
681                                                                         }
682                                                                         
683
684                                                                         name = add_name(md1);
685                                                                         slen += additional_slen_offset;
686
687                                                                         sp[0] = type;
688                                                                         sp[1] = name;
689                                                                         if ((debugSDNA > 1) && (names[name] != NULL)) printf("%s ||", names[name]);
690
691                                                                         structpoin[1]++;
692                                                                         sp += 2;
693                                                                         
694                                                                         md1 += slen;
695                                                                 }
696                                                                 md1++;
697                                                         }
698
699                                                         if (debugSDNA > 1) printf(")\n");
700
701                                                 }
702                                                 md1++;
703                                         }
704                                 }
705                         }
706                 }
707                 count++;
708                 md++;
709         }
710         
711         MEM_freeN(maindata);
712
713         return 0;
714 }
715
716 static int arraysize(const char *str)
717 {
718         int a, mul = 1;
719         const char *cp = NULL;
720         
721         for (a = 0; str[a]; a++) {
722                 if (str[a] == '[') {
723                         cp = &(str[a + 1]);
724                 }
725                 else if (str[a] == ']' && cp) {
726                         /* if 'cp' is a preprocessor definition, it will evaluate to 0,
727                          * the caller needs to check for this case and throw an error */
728                         mul *= atoi(cp);
729                 }
730         }
731         
732         return mul;
733 }
734
735 static bool check_field_alignment(int firststruct, int structtype, int type, int len,
736                                   const char *name, const char *detail)
737 {
738         bool result = true;
739         if (type < firststruct && typelens_native[type] > 4 && (len % 8)) {
740                 fprintf(stderr, "Align 8 error (%s) in struct: %s %s (add %d padding bytes)\n",
741                         detail, types[structtype], name, len % 8);
742                 result = false;
743         }
744         if (typelens_native[type] > 3 && (len % 4) ) {
745                 fprintf(stderr, "Align 4 error (%s) in struct: %s %s (add %d padding bytes)\n",
746                         detail, types[structtype], name, len % 4);
747                 result = false;
748         }
749         if (typelens_native[type] == 2 && (len % 2) ) {
750                 fprintf(stderr, "Align 2 error (%s) in struct: %s %s (add %d padding bytes)\n",
751                         detail, types[structtype], name, len % 2);
752                 result = false;
753         }
754         return result;
755 }
756
757 static int calculate_structlens(int firststruct)
758 {
759         int unknown = nr_structs, lastunknown;
760         bool dna_error = false;
761
762         while (unknown) {
763                 lastunknown = unknown;
764                 unknown = 0;
765                 
766                 /* check all structs... */
767                 for (int a = 0; a < nr_structs; a++) {
768                         const short *structpoin = structs[a];
769                         const int    structtype = structpoin[0];
770
771                         /* when length is not known... */
772                         if (typelens_native[structtype] == 0) {
773                                 
774                                 const short *sp = structpoin + 2;
775                                 int len_native = 0;
776                                 int len_32 = 0;
777                                 int len_64 = 0;
778                                 bool has_pointer = false;
779                                 
780                                 /* check all elements in struct */
781                                 for (int b = 0; b < structpoin[1]; b++, sp += 2) {
782                                         int type = sp[0];
783                                         const char *cp = names[sp[1]];
784
785                                         int namelen = (int)strlen(cp);
786                                         /* is it a pointer or function pointer? */
787                                         if (cp[0] == '*' || cp[1] == '*') {
788                                                 has_pointer = 1;
789                                                 /* has the name an extra length? (array) */
790                                                 int mul = 1;
791                                                 if (cp[namelen - 1] == ']') mul = arraysize(cp);
792
793                                                 if (mul == 0) {
794                                                         fprintf(stderr, "Zero array size found or could not parse %s: '%.*s'\n",
795                                                                 types[structtype], namelen + 1, cp);
796                                                         dna_error = 1;
797                                                 }
798
799                                                 /* 4-8 aligned/ */
800                                                 if (sizeof(void *) == 4) {
801                                                         if (len_native % 4) {
802                                                                 fprintf(stderr, "Align pointer error in struct (len_native 4): %s %s\n",
803                                                                         types[structtype], cp);
804                                                                 dna_error = 1;
805                                                         }
806                                                 }
807                                                 else {
808                                                         if (len_native % 8) {
809                                                                 fprintf(stderr, "Align pointer error in struct (len_native 8): %s %s\n",
810                                                                         types[structtype], cp);
811                                                                 dna_error = 1;
812                                                         }
813                                                 }
814
815                                                 if (len_64 % 8) {
816                                                         fprintf(stderr, "Align pointer error in struct (len_64 8): %s %s\n",
817                                                                 types[structtype], cp);
818                                                         dna_error = 1;
819                                                 }
820
821                                                 len_native += sizeof(void *) * mul;
822                                                 len_32 += 4 * mul;
823                                                 len_64 += 8 * mul;
824
825                                         }
826                                         else if (cp[0] == '[') {
827                                                 /* parsing can cause names "var" and "[3]" to be found for "float var [3]" ... */
828                                                 fprintf(stderr, "Parse error in struct, invalid member name: %s %s\n",
829                                                         types[structtype], cp);
830                                                 dna_error = 1;
831                                         }
832                                         else if (typelens_native[type]) {
833                                                 /* has the name an extra length? (array) */
834                                                 int mul = 1;
835                                                 if (cp[namelen - 1] == ']') mul = arraysize(cp);
836
837                                                 if (mul == 0) {
838                                                         fprintf(stderr, "Zero array size found or could not parse %s: '%.*s'\n",
839                                                                 types[structtype], namelen + 1, cp);
840                                                         dna_error = 1;
841                                                 }
842
843                                                 /* struct alignment */
844                                                 if (type >= firststruct) {
845                                                         if (sizeof(void *) == 8 && (len_native % 8) ) {
846                                                                 fprintf(stderr, "Align struct error: %s %s\n",
847                                                                         types[structtype], cp);
848                                                                 dna_error = 1;
849                                                         }
850                                                 }
851                                                 
852                                                 /* Check 2-4-8 aligned. */
853                                                 if (!check_field_alignment(firststruct, structtype, type, len_32, cp, "32 bit")) {
854                                                         dna_error = 1;
855                                                 }
856                                                 if (!check_field_alignment(firststruct, structtype, type, len_64, cp, "64 bit")) {
857                                                         dna_error = 1;
858                                                 }
859
860                                                 len_native += mul * typelens_native[type];
861                                                 len_32 += mul * typelens_32[type];
862                                                 len_64 += mul * typelens_64[type];
863                                                 
864                                         }
865                                         else {
866                                                 len_native = 0;
867                                                 len_32 = 0;
868                                                 len_64 = 0;
869                                                 break;
870                                         }
871                                 }
872                                 
873                                 if (len_native == 0) {
874                                         unknown++;
875                                 }
876                                 else {
877                                         typelens_native[structtype] = len_native;
878                                         typelens_32[structtype] = len_32;
879                                         typelens_64[structtype] = len_64;
880                                         /* two ways to detect if a struct contains a pointer:
881                                          * has_pointer is set or len_native  doesn't match any of 32/64bit lengths*/
882                                         if (has_pointer || len_64 != len_native || len_32 != len_native) {
883                                                 if (len_64 % 8) {
884                                                         fprintf(stderr, "Sizeerror 8 in struct: %s (add %d bytes)\n",
885                                                                 types[structtype], len_64 % 8);
886                                                         dna_error = 1;
887                                                 }
888                                         }
889                                         
890                                         if (len_native % 4) {
891                                                 fprintf(stderr, "Sizeerror 4 in struct: %s (add %d bytes)\n",
892                                                        types[structtype], len_native % 4);
893                                                 dna_error = 1;
894                                         }
895                                         
896                                 }
897                         }
898                 }
899                 
900                 if (unknown == lastunknown) break;
901         }
902         
903         if (unknown) {
904                 fprintf(stderr, "ERROR: still %d structs unknown\n", unknown);
905
906                 if (debugSDNA) {
907                         fprintf(stderr, "*** Known structs :\n");
908                         
909                         for (int a = 0; a < nr_structs; a++) {
910                                 const short *structpoin = structs[a];
911                                 const int    structtype = structpoin[0];
912                                 
913                                 /* length unknown */
914                                 if (typelens_native[structtype] != 0) {
915                                         fprintf(stderr, "  %s\n", types[structtype]);
916                                 }
917                         }
918                 }
919
920                         
921                 fprintf(stderr, "*** Unknown structs :\n");
922                         
923                 for (int a = 0; a < nr_structs; a++) {
924                         const short *structpoin = structs[a];
925                         const int    structtype = structpoin[0];
926
927                         /* length unknown yet */
928                         if (typelens_native[structtype] == 0) {
929                                 fprintf(stderr, "  %s\n", types[structtype]);
930                         }
931                 }
932
933                 dna_error = 1;
934         }
935
936         return(dna_error);
937 }
938
939 #define MAX_DNA_LINE_LENGTH 20
940
941 static void dna_write(FILE *file, const void *pntr, const int size)
942 {
943         static int linelength = 0;
944         int i;
945         const char *data;
946
947         data = (const char *)pntr;
948         
949         for (i = 0; i < size; i++) {
950                 fprintf(file, "%d, ", data[i]);
951                 linelength++;
952                 if (linelength >= MAX_DNA_LINE_LENGTH) {
953                         fprintf(file, "\n");
954                         linelength = 0;
955                 }
956         }
957 }
958
959 void printStructLengths(void)
960 {
961         int a, unknown = nr_structs, structtype;
962         /*int lastunknown;*/ /*UNUSED*/
963         const short *structpoin;
964         printf("\n\n*** All detected structs:\n");
965
966         while (unknown) {
967                 /*lastunknown = unknown;*/ /*UNUSED*/
968                 unknown = 0;
969                 
970                 /* check all structs... */
971                 for (a = 0; a < nr_structs; a++) {
972                         structpoin = structs[a];
973                         structtype = structpoin[0];
974                         printf("\t%s\t:%d\n", types[structtype], typelens_native[structtype]);
975                 }
976         }
977
978         printf("*** End of list\n");
979
980 }
981
982
983 static int make_structDNA(const char *baseDirectory, FILE *file, FILE *file_offsets)
984 {
985         int len, i;
986         const short *sp;
987         /* str contains filenames. Since we now include paths, I stretched       */
988         /* it a bit. Hope this is enough :) -nzc-                                */
989         char str[SDNA_MAX_FILENAME_LENGTH], *cp;
990         int firststruct;
991         
992         if (debugSDNA > 0) {
993                 fflush(stdout);
994                 printf("Running makesdna at debug level %d\n", debugSDNA);
995         }
996                 
997         /* the longest known struct is 50k, so we assume 100k is sufficent! */
998         namedata = MEM_callocN(maxdata, "namedata");
999         typedata = MEM_callocN(maxdata, "typedata");
1000         structdata = MEM_callocN(maxdata, "structdata");
1001         
1002         /* a maximum of 5000 variables, must be sufficient? */
1003         names = MEM_callocN(sizeof(char *) * maxnr, "names");
1004         types = MEM_callocN(sizeof(char *) * maxnr, "types");
1005         typelens_native = MEM_callocN(sizeof(short) * maxnr, "typelens_native");
1006         typelens_32 = MEM_callocN(sizeof(short) * maxnr, "typelens_32");
1007         typelens_64 = MEM_callocN(sizeof(short) * maxnr, "typelens_64");
1008         structs = MEM_callocN(sizeof(short *) * maxnr, "structs");
1009
1010         /**
1011          * Insertion of all known types.
1012          *
1013          * \warning Order of function calls here must be aligned with #eSDNA_Type.
1014          * \warning uint is not allowed! use in structs an unsigned int.
1015          * \warning sizes must match #DNA_elem_type_size().
1016          */
1017         add_type("char", 1);     /* SDNA_TYPE_CHAR */
1018         add_type("uchar", 1);    /* SDNA_TYPE_UCHAR */
1019         add_type("short", 2);    /* SDNA_TYPE_SHORT */
1020         add_type("ushort", 2);   /* SDNA_TYPE_USHORT */
1021         add_type("int", 4);      /* SDNA_TYPE_INT */
1022
1023         /* note, long isn't supported,
1024          * these are place-holders to maintain alignment with eSDNA_Type*/
1025         add_type("long", 4);     /* SDNA_TYPE_LONG */
1026         add_type("ulong", 4);    /* SDNA_TYPE_ULONG */
1027
1028         add_type("float", 4);    /* SDNA_TYPE_FLOAT */
1029         add_type("double", 8);   /* SDNA_TYPE_DOUBLE */
1030         add_type("int64_t", 8);  /* SDNA_TYPE_INT64 */
1031         add_type("uint64_t", 8); /* SDNA_TYPE_UINT64 */
1032         add_type("void", 0);     /* SDNA_TYPE_VOID */
1033
1034         /* the defines above shouldn't be output in the padding file... */
1035         firststruct = nr_types;
1036         
1037         /* add all include files defined in the global array                     */
1038         /* Since the internal file+path name buffer has limited length, I do a   */
1039         /* little test first...                                                  */
1040         /* Mind the breaking condition here!                                     */
1041         if (debugSDNA) printf("\tStart of header scan:\n"); 
1042         for (i = 0; *(includefiles[i]) != '\0'; i++) {
1043                 sprintf(str, "%s%s", baseDirectory, includefiles[i]);
1044                 if (debugSDNA) printf("\t|-- Converting %s\n", str);
1045                 if (convert_include(str)) {
1046                         return (1);
1047                 }
1048         }
1049         if (debugSDNA) printf("\tFinished scanning %d headers.\n", i); 
1050
1051         if (calculate_structlens(firststruct)) {
1052                 /* error */
1053                 return(1);
1054         }
1055
1056         /* FOR DEBUG */
1057         if (debugSDNA > 1) {
1058                 int a, b;
1059                 /* short *elem; */
1060                 short num_types;
1061
1062                 printf("nr_names %d nr_types %d nr_structs %d\n", nr_names, nr_types, nr_structs);
1063                 for (a = 0; a < nr_names; a++) {
1064                         printf(" %s\n", names[a]);
1065                 }
1066                 printf("\n");
1067                 
1068                 sp = typelens_native;
1069                 for (a = 0; a < nr_types; a++, sp++) {
1070                         printf(" %s %d\n", types[a], *sp);
1071                 }
1072                 printf("\n");
1073                 
1074                 for (a = 0; a < nr_structs; a++) {
1075                         sp = structs[a];
1076                         printf(" struct %s elems: %d size: %d\n", types[sp[0]], sp[1], typelens_native[sp[0]]);
1077                         num_types  = sp[1];
1078                         sp += 2;
1079                         /* ? num_types was elem? */
1080                         for (b = 0; b < num_types; b++, sp += 2) {
1081                                 printf("   %s %s\n", types[sp[0]], names[sp[1]]);
1082                         }
1083                 }
1084         }
1085
1086         /* file writing */
1087
1088         if (debugSDNA > 0) printf("Writing file ... ");
1089                 
1090         if (nr_names == 0 || nr_structs == 0) {
1091                 /* pass */
1092         }
1093         else {
1094                 dna_write(file, "SDNA", 4);
1095                 
1096                 /* write names */
1097                 dna_write(file, "NAME", 4);
1098                 len = nr_names;
1099                 dna_write(file, &len, 4);
1100                 
1101                 /* calculate size of datablock with strings */
1102                 cp = names[nr_names - 1];
1103                 cp += strlen(names[nr_names - 1]) + 1;         /* +1: null-terminator */
1104                 len = (intptr_t) (cp - (char *) names[0]);
1105                 len = (len + 3) & ~3;
1106                 dna_write(file, names[0], len);
1107                 
1108                 /* write TYPES */
1109                 dna_write(file, "TYPE", 4);
1110                 len = nr_types;
1111                 dna_write(file, &len, 4);
1112         
1113                 /* calculate datablock size */
1114                 cp = types[nr_types - 1];
1115                 cp += strlen(types[nr_types - 1]) + 1;     /* +1: null-terminator */
1116                 len = (intptr_t) (cp - (char *) types[0]);
1117                 len = (len + 3) & ~3;
1118                 
1119                 dna_write(file, types[0], len);
1120                 
1121                 /* WRITE TYPELENGTHS */
1122                 dna_write(file, "TLEN", 4);
1123                 
1124                 len = 2 * nr_types;
1125                 if (nr_types & 1) len += 2;
1126                 dna_write(file, typelens_native, len);
1127                 
1128                 /* WRITE STRUCTS */
1129                 dna_write(file, "STRC", 4);
1130                 len = nr_structs;
1131                 dna_write(file, &len, 4);
1132         
1133                 /* calc datablock size */
1134                 sp = structs[nr_structs - 1];
1135                 sp += 2 + 2 * (sp[1]);
1136                 len = (intptr_t) ((char *) sp - (char *) structs[0]);
1137                 len = (len + 3) & ~3;
1138                 
1139                 dna_write(file, structs[0], len);
1140         
1141                 /* a simple dna padding test */
1142                 if (0) {
1143                         FILE *fp;
1144                         int a;
1145                         
1146                         fp = fopen("padding.c", "w");
1147                         if (fp == NULL) {
1148                                 /* pass */
1149                         }
1150                         else {
1151
1152                                 /* add all include files defined in the global array */
1153                                 for (i = 0; *(includefiles[i]) != '\0'; i++) {
1154                                         fprintf(fp, "#include \"%s%s\"\n", baseDirectory, includefiles[i]);
1155                                 }
1156
1157                                 fprintf(fp, "main() {\n");
1158                                 sp = typelens_native;
1159                                 sp += firststruct;
1160                                 for (a = firststruct; a < nr_types; a++, sp++) {
1161                                         if (*sp) {
1162                                                 fprintf(fp, "\tif (sizeof(struct %s) - %d) printf(\"ALIGN ERROR:", types[a], *sp);
1163                                                 fprintf(fp, "%%d %s %d ", types[a], *sp);
1164                                                 fprintf(fp, "\\n\",  sizeof(struct %s) - %d);\n", types[a], *sp);
1165                                         }
1166                                 }
1167                                 fprintf(fp, "}\n");
1168                                 fclose(fp);
1169                         }
1170                 }
1171                 /*      end end padding test */
1172         }
1173         
1174         /* write a simple enum with all structs offsets,
1175          * should only be accessed via SDNA_TYPE_FROM_STRUCT macro */
1176         {
1177                 fprintf(file_offsets, "#define SDNA_TYPE_FROM_STRUCT(id) _SDNA_TYPE_##id\n");
1178                 fprintf(file_offsets, "enum {\n");
1179                 for (i = 0; i < nr_structs; i++) {
1180                         const short *structpoin = structs[i];
1181                         const int    structtype = structpoin[0];
1182                         fprintf(file_offsets, "\t_SDNA_TYPE_%s = %d,\n", types[structtype], i);
1183                 }
1184                 fprintf(file_offsets, "\tSDNA_TYPE_MAX = %d,\n", nr_structs);
1185                 fprintf(file_offsets, "};\n");
1186         }
1187         
1188         MEM_freeN(namedata);
1189         MEM_freeN(typedata);
1190         MEM_freeN(structdata);
1191         MEM_freeN(names);
1192         MEM_freeN(types);
1193         MEM_freeN(typelens_native);
1194         MEM_freeN(typelens_32);
1195         MEM_freeN(typelens_64);
1196         MEM_freeN(structs);
1197
1198         if (debugSDNA > 0) printf("done.\n");
1199         
1200         return(0);
1201 }
1202
1203 /* ************************* END MAKE DNA ********************** */
1204
1205 static void make_bad_file(const char *file, int line)
1206 {
1207         FILE *fp = fopen(file, "w");
1208         fprintf(fp, "#error \"Error! can't make correct DNA.c file from %s:%d, STUPID!\"\n", __FILE__, line);
1209         fclose(fp);
1210 }
1211
1212 #ifndef BASE_HEADER
1213 #define BASE_HEADER "../"
1214 #endif
1215
1216 int main(int argc, char **argv)
1217 {
1218         int return_status = 0;
1219
1220         if (argc != 3 && argc != 4) {
1221                 printf("Usage: %s dna.c dna_struct_offsets.h [base directory]\n", argv[0]);
1222                 return_status = 1;
1223         }
1224         else {
1225                 FILE *file_dna         = fopen(argv[1], "w");
1226                 FILE *file_dna_offsets = fopen(argv[2], "w");
1227                 if (!file_dna) {
1228                         printf("Unable to open file: %s\n", argv[1]);
1229                         return_status = 1;
1230                 }
1231                 else if (!file_dna_offsets) {
1232                         printf("Unable to open file: %s\n", argv[2]);
1233                         return_status = 1;
1234                 }
1235                 else {
1236                         const char *baseDirectory;
1237
1238                         if (argc == 4) {
1239                                 baseDirectory = argv[3];
1240                         }
1241                         else {
1242                                 baseDirectory = BASE_HEADER;
1243                         }
1244
1245                         fprintf(file_dna, "const unsigned char DNAstr[] = {\n");
1246                         if (make_structDNA(baseDirectory, file_dna, file_dna_offsets)) {
1247                                 /* error */
1248                                 fclose(file_dna);
1249                                 file_dna = NULL;
1250                                 make_bad_file(argv[1], __LINE__);
1251                                 return_status = 1;
1252                         }
1253                         else {
1254                                 fprintf(file_dna, "};\n");
1255                                 fprintf(file_dna, "const int DNAlen = sizeof(DNAstr);\n");
1256                         }
1257                 }
1258
1259                 if (file_dna) {
1260                         fclose(file_dna);
1261                 }
1262                 if (file_dna_offsets) {
1263                         fclose(file_dna_offsets);
1264                 }
1265         }
1266
1267                 
1268         return(return_status);
1269 }
1270
1271 /* handy but fails on struct bounds which makesdna doesnt care about
1272  * with quite the same strictness as GCC does */
1273 #if 0
1274 /* include files for automatic dependencies */
1275
1276 /* extra safety check that we are aligned,
1277  * warnings here are easier to fix the makesdna's */
1278 #ifdef __GNUC__
1279 #  pragma GCC diagnostic error "-Wpadded"
1280 #endif
1281
1282 #endif /* if 0 */
1283
1284 /* even though DNA supports, 'long' shouldn't be used since it can be either 32 or 64bit,
1285  * use int or int64_t instead.
1286  * Only valid use would be as a runtime variable if an API expected a long,
1287  * but so far we dont have this happening. */
1288 #ifdef __GNUC__
1289 #  pragma GCC poison long
1290 #endif
1291
1292 #include "DNA_listBase.h"
1293 #include "DNA_vec_types.h"
1294 #include "DNA_ID.h"
1295 #include "DNA_ipo_types.h"
1296 #include "DNA_key_types.h"
1297 #include "DNA_text_types.h"
1298 #include "DNA_packedFile_types.h"
1299 #include "DNA_camera_types.h"
1300 #include "DNA_image_types.h"
1301 #include "DNA_texture_types.h"
1302 #include "DNA_lamp_types.h"
1303 #include "DNA_material_types.h"
1304 #include "DNA_vfont_types.h"
1305 #include "DNA_meta_types.h"
1306 #include "DNA_curve_types.h"
1307 #include "DNA_mesh_types.h"
1308 #include "DNA_meshdata_types.h"
1309 #include "DNA_modifier_types.h"
1310 #include "DNA_lattice_types.h"  
1311 #include "DNA_object_types.h"
1312 #include "DNA_object_force_types.h"
1313 #include "DNA_object_fluidsim_types.h"
1314 #include "DNA_world_types.h"
1315 #include "DNA_scene_types.h"
1316 #include "DNA_view3d_types.h"
1317 #include "DNA_view2d_types.h"   
1318 #include "DNA_space_types.h"
1319 #include "DNA_userdef_types.h"
1320 #include "DNA_screen_types.h"
1321 #include "DNA_sdna_types.h"
1322 #include "DNA_fileglobal_types.h"
1323 #include "DNA_sequence_types.h"
1324 #include "DNA_effect_types.h"
1325 #include "DNA_outliner_types.h"
1326 #include "DNA_sound_types.h"
1327 #include "DNA_group_types.h"
1328 #include "DNA_armature_types.h"
1329 #include "DNA_action_types.h"
1330 #include "DNA_constraint_types.h"
1331 #include "DNA_nla_types.h"
1332 #include "DNA_node_types.h"
1333 #include "DNA_color_types.h"
1334 #include "DNA_brush_types.h"
1335 #include "DNA_customdata_types.h"
1336 #include "DNA_particle_types.h"
1337 #include "DNA_cloth_types.h"
1338 #include "DNA_gpencil_types.h"
1339 #include "DNA_windowmanager_types.h"
1340 #include "DNA_anim_types.h"
1341 #include "DNA_boid_types.h"
1342 #include "DNA_smoke_types.h"
1343 #include "DNA_speaker_types.h"
1344 #include "DNA_movieclip_types.h"
1345 #include "DNA_tracking_types.h"
1346 #include "DNA_dynamicpaint_types.h"
1347 #include "DNA_mask_types.h"
1348 #include "DNA_rigidbody_types.h"
1349 #include "DNA_freestyle_types.h"
1350 #include "DNA_linestyle_types.h"
1351 #include "DNA_cachefile_types.h"
1352 #include "DNA_layer_types.h"
1353 #include "DNA_workspace_types.h"
1354 #include "DNA_lightprobe_types.h"
1355
1356 /* end of list */