a6262a9b130e9ced7f6576c1d605effeb808214b
[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_property_types.h",
104         "DNA_sensor_types.h",
105         "DNA_controller_types.h",
106         "DNA_actuator_types.h",
107         "DNA_sound_types.h",
108         "DNA_group_types.h",
109         "DNA_armature_types.h",
110         "DNA_action_types.h",
111         "DNA_constraint_types.h",
112         "DNA_nla_types.h",
113         "DNA_node_types.h",
114         "DNA_color_types.h",
115         "DNA_brush_types.h",
116         "DNA_customdata_types.h",
117         "DNA_particle_types.h",
118         "DNA_cloth_types.h",
119         "DNA_gpencil_types.h",
120         "DNA_windowmanager_types.h",
121         "DNA_anim_types.h",
122         "DNA_boid_types.h",
123         "DNA_smoke_types.h",
124         "DNA_speaker_types.h",
125         "DNA_movieclip_types.h",
126         "DNA_tracking_types.h",
127         "DNA_dynamicpaint_types.h",
128         "DNA_mask_types.h",
129         "DNA_rigidbody_types.h",
130         "DNA_freestyle_types.h",
131         "DNA_linestyle_types.h",
132         "DNA_cachefile_types.h",
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 {
508                         md[0] = cp[0];
509                         md++;
510                         newlen++;
511                 }
512                 cp++;
513         }
514
515         MEM_freeN(temp);
516         return newlen;
517 }
518
519 static void *read_file_data(const char *filename, int *r_len)
520 {
521 #ifdef WIN32
522         FILE *fp = fopen(filename, "rb");
523 #else
524         FILE *fp = fopen(filename, "r");
525 #endif
526         void *data;
527
528         if (!fp) {
529                 *r_len = -1;
530                 return NULL;
531         }
532
533         fseek(fp, 0L, SEEK_END);
534         *r_len = ftell(fp);
535         fseek(fp, 0L, SEEK_SET);
536
537         if (*r_len == -1) {
538                 fclose(fp);
539                 return NULL;
540         }
541
542         data = MEM_mallocN(*r_len, "read_file_data");
543         if (!data) {
544                 *r_len = -1;
545                 fclose(fp);
546                 return NULL;
547         }
548
549         if (fread(data, *r_len, 1, fp) != 1) {
550                 *r_len = -1;
551                 MEM_freeN(data);
552                 fclose(fp);
553                 return NULL;
554         }
555
556         fclose(fp);
557         return data;
558 }
559
560 static int convert_include(const char *filename)
561 {
562         /* read include file, skip structs with a '#' before it.
563          * store all data in temporal arrays.
564          */
565         int filelen, count, slen, type, name, strct;
566         short *structpoin, *sp;
567         char *maindata, *mainend, *md, *md1;
568         bool skip_struct;
569
570         md = maindata = read_file_data(filename, &filelen);
571         if (filelen == -1) {
572                 fprintf(stderr, "Can't read file %s\n", filename);
573                 return 1;
574         }
575
576         filelen = preprocess_include(maindata, filelen);
577         mainend = maindata + filelen - 1;
578
579         /* we look for '{' and then back to 'struct' */
580         count = 0;
581         skip_struct = false;
582         while (count < filelen) {
583
584                 /* code for skipping a struct: two hashes on 2 lines. (preprocess added a space) */
585                 if (md[0] == '#' && md[1] == ' ' && md[2] == '#') {
586                         skip_struct = true;
587                 }
588
589                 if (md[0] == '{') {
590                         md[0] = 0;
591                         if (skip_struct) {
592                                 skip_struct = false;
593                         }
594                         else {
595                                 if (md[-1] == ' ') md[-1] = 0;
596                                 md1 = md - 2;
597                                 while (*md1 != 32) md1--;       /* to beginning of word */
598                                 md1++;
599
600                                 /* we've got a struct name when... */
601                                 if (strncmp(md1 - 7, "struct", 6) == 0) {
602
603                                         strct = add_type(md1, 0);
604                                         if (strct == -1) {
605                                                 fprintf(stderr, "File '%s' contains struct we cant parse \"%s\"\n", filename, md1);
606                                                 return 1;
607                                         }
608
609                                         structpoin = add_struct(strct);
610                                         sp = structpoin + 2;
611
612                                         if (debugSDNA > 1) printf("\t|\t|-- detected struct %s\n", types[strct]);
613
614                                         /* first lets make it all nice strings */
615                                         md1 = md + 1;
616                                         while (*md1 != '}') {
617                                                 if (md1 > mainend) break;
618
619                                                 if (*md1 == ',' || *md1 == ' ') *md1 = 0;
620                                                 md1++;
621                                         }
622
623                                         /* read types and names until first character that is not '}' */
624                                         md1 = md + 1;
625                                         while (*md1 != '}') {
626                                                 if (md1 > mainend) break;
627
628                                                 /* skip when it says 'struct' or 'unsigned' or 'const' */
629                                                 if (*md1) {
630                                                         if (strncmp(md1, "struct", 6) == 0) md1 += 7;
631                                                         if (strncmp(md1, "unsigned", 8) == 0) md1 += 9;
632                                                         if (strncmp(md1, "const", 5) == 0) md1 += 6;
633
634                                                         /* we've got a type! */
635                                                         type = add_type(md1, 0);
636                                                         if (type == -1) {
637                                                                 fprintf(stderr, "File '%s' contains struct we can't parse \"%s\"\n", filename, md1);
638                                                                 return 1;
639                                                         }
640
641                                                         if (debugSDNA > 1) printf("\t|\t|\tfound type %s (", md1);
642
643                                                         md1 += strlen(md1);
644
645
646                                                         /* read until ';' */
647                                                         while (*md1 != ';') {
648                                                                 if (md1 > mainend) break;
649
650                                                                 if (*md1) {
651                                                                         /* We've got a name. slen needs
652                                                                          * correction for function
653                                                                          * pointers! */
654                                                                         slen = (int) strlen(md1);
655                                                                         if (md1[slen - 1] == ';') {
656                                                                                 md1[slen - 1] = 0;
657
658
659                                                                                 name = add_name(md1);
660                                                                                 slen += additional_slen_offset;
661                                                                                 sp[0] = type;
662                                                                                 sp[1] = name;
663
664                                                                                 if ((debugSDNA > 1) && (names[name] != NULL)) printf("%s |", names[name]);
665
666                                                                                 structpoin[1]++;
667                                                                                 sp += 2;
668
669                                                                                 md1 += slen;
670                                                                                 break;
671                                                                         }
672
673
674                                                                         name = add_name(md1);
675                                                                         slen += additional_slen_offset;
676
677                                                                         sp[0] = type;
678                                                                         sp[1] = name;
679                                                                         if ((debugSDNA > 1) && (names[name] != NULL)) printf("%s ||", names[name]);
680
681                                                                         structpoin[1]++;
682                                                                         sp += 2;
683
684                                                                         md1 += slen;
685                                                                 }
686                                                                 md1++;
687                                                         }
688
689                                                         if (debugSDNA > 1) printf(")\n");
690
691                                                 }
692                                                 md1++;
693                                         }
694                                 }
695                         }
696                 }
697                 count++;
698                 md++;
699         }
700
701         MEM_freeN(maindata);
702
703         return 0;
704 }
705
706 static int arraysize(const char *str)
707 {
708         int a, mul = 1;
709         const char *cp = NULL;
710
711         for (a = 0; str[a]; a++) {
712                 if (str[a] == '[') {
713                         cp = &(str[a + 1]);
714                 }
715                 else if (str[a] == ']' && cp) {
716                         /* if 'cp' is a preprocessor definition, it will evaluate to 0,
717                          * the caller needs to check for this case and throw an error */
718                         mul *= atoi(cp);
719                 }
720         }
721
722         return mul;
723 }
724
725 static bool check_field_alignment(int firststruct, int structtype, int type, int len,
726                                   const char *name, const char *detail)
727 {
728         bool result = true;
729         if (type < firststruct && typelens_native[type] > 4 && (len % 8)) {
730                 fprintf(stderr, "Align 8 error (%s) in struct: %s %s (add %d padding bytes)\n",
731                         detail, types[structtype], name, len % 8);
732                 result = false;
733         }
734         if (typelens_native[type] > 3 && (len % 4) ) {
735                 fprintf(stderr, "Align 4 error (%s) in struct: %s %s (add %d padding bytes)\n",
736                         detail, types[structtype], name, len % 4);
737                 result = false;
738         }
739         if (typelens_native[type] == 2 && (len % 2) ) {
740                 fprintf(stderr, "Align 2 error (%s) in struct: %s %s (add %d padding bytes)\n",
741                         detail, types[structtype], name, len % 2);
742                 result = false;
743         }
744         return result;
745 }
746
747 static int calculate_structlens(int firststruct)
748 {
749         int unknown = nr_structs, lastunknown;
750         bool dna_error = false;
751
752         while (unknown) {
753                 lastunknown = unknown;
754                 unknown = 0;
755
756                 /* check all structs... */
757                 for (int a = 0; a < nr_structs; a++) {
758                         const short *structpoin = structs[a];
759                         const int    structtype = structpoin[0];
760
761                         /* when length is not known... */
762                         if (typelens_native[structtype] == 0) {
763
764                                 const short *sp = structpoin + 2;
765                                 int len_native = 0;
766                                 int len_32 = 0;
767                                 int len_64 = 0;
768                                 bool has_pointer = false;
769
770                                 /* check all elements in struct */
771                                 for (int b = 0; b < structpoin[1]; b++, sp += 2) {
772                                         int type = sp[0];
773                                         const char *cp = names[sp[1]];
774
775                                         int namelen = (int)strlen(cp);
776                                         /* is it a pointer or function pointer? */
777                                         if (cp[0] == '*' || cp[1] == '*') {
778                                                 has_pointer = 1;
779                                                 /* has the name an extra length? (array) */
780                                                 int mul = 1;
781                                                 if (cp[namelen - 1] == ']') mul = arraysize(cp);
782
783                                                 if (mul == 0) {
784                                                         fprintf(stderr, "Zero array size found or could not parse %s: '%.*s'\n",
785                                                                 types[structtype], namelen + 1, cp);
786                                                         dna_error = 1;
787                                                 }
788
789                                                 /* 4-8 aligned/ */
790                                                 if (sizeof(void *) == 4) {
791                                                         if (len_native % 4) {
792                                                                 fprintf(stderr, "Align pointer error in struct (len_native 4): %s %s\n",
793                                                                         types[structtype], cp);
794                                                                 dna_error = 1;
795                                                         }
796                                                 }
797                                                 else {
798                                                         if (len_native % 8) {
799                                                                 fprintf(stderr, "Align pointer error in struct (len_native 8): %s %s\n",
800                                                                         types[structtype], cp);
801                                                                 dna_error = 1;
802                                                         }
803                                                 }
804
805                                                 if (len_64 % 8) {
806                                                         fprintf(stderr, "Align pointer error in struct (len_64 8): %s %s\n",
807                                                                 types[structtype], cp);
808                                                         dna_error = 1;
809                                                 }
810
811                                                 len_native += sizeof(void *) * mul;
812                                                 len_32 += 4 * mul;
813                                                 len_64 += 8 * mul;
814
815                                         }
816                                         else if (cp[0] == '[') {
817                                                 /* parsing can cause names "var" and "[3]" to be found for "float var [3]" ... */
818                                                 fprintf(stderr, "Parse error in struct, invalid member name: %s %s\n",
819                                                         types[structtype], cp);
820                                                 dna_error = 1;
821                                         }
822                                         else if (typelens_native[type]) {
823                                                 /* has the name an extra length? (array) */
824                                                 int mul = 1;
825                                                 if (cp[namelen - 1] == ']') mul = arraysize(cp);
826
827                                                 if (mul == 0) {
828                                                         fprintf(stderr, "Zero array size found or could not parse %s: '%.*s'\n",
829                                                                 types[structtype], namelen + 1, cp);
830                                                         dna_error = 1;
831                                                 }
832
833                                                 /* struct alignment */
834                                                 if (type >= firststruct) {
835                                                         if (sizeof(void *) == 8 && (len_native % 8) ) {
836                                                                 fprintf(stderr, "Align struct error: %s %s\n",
837                                                                         types[structtype], cp);
838                                                                 dna_error = 1;
839                                                         }
840                                                 }
841
842                                                 /* Check 2-4-8 aligned. */
843                                                 if (!check_field_alignment(firststruct, structtype, type, len_32, cp, "32 bit")) {
844                                                         dna_error = 1;
845                                                 }
846                                                 if (!check_field_alignment(firststruct, structtype, type, len_64, cp, "64 bit")) {
847                                                         dna_error = 1;
848                                                 }
849
850                                                 len_native += mul * typelens_native[type];
851                                                 len_32 += mul * typelens_32[type];
852                                                 len_64 += mul * typelens_64[type];
853
854                                         }
855                                         else {
856                                                 len_native = 0;
857                                                 len_32 = 0;
858                                                 len_64 = 0;
859                                                 break;
860                                         }
861                                 }
862
863                                 if (len_native == 0) {
864                                         unknown++;
865                                 }
866                                 else {
867                                         typelens_native[structtype] = len_native;
868                                         typelens_32[structtype] = len_32;
869                                         typelens_64[structtype] = len_64;
870                                         /* two ways to detect if a struct contains a pointer:
871                                          * has_pointer is set or len_native  doesn't match any of 32/64bit lengths*/
872                                         if (has_pointer || len_64 != len_native || len_32 != len_native) {
873                                                 if (len_64 % 8) {
874                                                         fprintf(stderr, "Sizeerror 8 in struct: %s (add %d bytes)\n",
875                                                                 types[structtype], len_64 % 8);
876                                                         dna_error = 1;
877                                                 }
878                                         }
879
880                                         if (len_native % 4) {
881                                                 fprintf(stderr, "Sizeerror 4 in struct: %s (add %d bytes)\n",
882                                                        types[structtype], len_native % 4);
883                                                 dna_error = 1;
884                                         }
885
886                                 }
887                         }
888                 }
889
890                 if (unknown == lastunknown) break;
891         }
892
893         if (unknown) {
894                 fprintf(stderr, "ERROR: still %d structs unknown\n", unknown);
895
896                 if (debugSDNA) {
897                         fprintf(stderr, "*** Known structs :\n");
898
899                         for (int a = 0; a < nr_structs; a++) {
900                                 const short *structpoin = structs[a];
901                                 const int    structtype = structpoin[0];
902
903                                 /* length unknown */
904                                 if (typelens_native[structtype] != 0) {
905                                         fprintf(stderr, "  %s\n", types[structtype]);
906                                 }
907                         }
908                 }
909
910
911                 fprintf(stderr, "*** Unknown structs :\n");
912
913                 for (int a = 0; a < nr_structs; a++) {
914                         const short *structpoin = structs[a];
915                         const int    structtype = structpoin[0];
916
917                         /* length unknown yet */
918                         if (typelens_native[structtype] == 0) {
919                                 fprintf(stderr, "  %s\n", types[structtype]);
920                         }
921                 }
922
923                 dna_error = 1;
924         }
925
926         return(dna_error);
927 }
928
929 #define MAX_DNA_LINE_LENGTH 20
930
931 static void dna_write(FILE *file, const void *pntr, const int size)
932 {
933         static int linelength = 0;
934         int i;
935         const char *data;
936
937         data = (const char *)pntr;
938
939         for (i = 0; i < size; i++) {
940                 fprintf(file, "%d, ", data[i]);
941                 linelength++;
942                 if (linelength >= MAX_DNA_LINE_LENGTH) {
943                         fprintf(file, "\n");
944                         linelength = 0;
945                 }
946         }
947 }
948
949 void printStructLengths(void)
950 {
951         int a, unknown = nr_structs, structtype;
952         /*int lastunknown;*/ /*UNUSED*/
953         const short *structpoin;
954         printf("\n\n*** All detected structs:\n");
955
956         while (unknown) {
957                 /*lastunknown = unknown;*/ /*UNUSED*/
958                 unknown = 0;
959
960                 /* check all structs... */
961                 for (a = 0; a < nr_structs; a++) {
962                         structpoin = structs[a];
963                         structtype = structpoin[0];
964                         printf("\t%s\t:%d\n", types[structtype], typelens_native[structtype]);
965                 }
966         }
967
968         printf("*** End of list\n");
969
970 }
971
972
973 static int make_structDNA(const char *baseDirectory, FILE *file, FILE *file_offsets)
974 {
975         int len, i;
976         const short *sp;
977         /* str contains filenames. Since we now include paths, I stretched       */
978         /* it a bit. Hope this is enough :) -nzc-                                */
979         char str[SDNA_MAX_FILENAME_LENGTH], *cp;
980         int firststruct;
981
982         if (debugSDNA > 0) {
983                 fflush(stdout);
984                 printf("Running makesdna at debug level %d\n", debugSDNA);
985         }
986
987         /* the longest known struct is 50k, so we assume 100k is sufficient! */
988         namedata = MEM_callocN(maxdata, "namedata");
989         typedata = MEM_callocN(maxdata, "typedata");
990         structdata = MEM_callocN(maxdata, "structdata");
991
992         /* a maximum of 5000 variables, must be sufficient? */
993         names = MEM_callocN(sizeof(char *) * maxnr, "names");
994         types = MEM_callocN(sizeof(char *) * maxnr, "types");
995         typelens_native = MEM_callocN(sizeof(short) * maxnr, "typelens_native");
996         typelens_32 = MEM_callocN(sizeof(short) * maxnr, "typelens_32");
997         typelens_64 = MEM_callocN(sizeof(short) * maxnr, "typelens_64");
998         structs = MEM_callocN(sizeof(short *) * maxnr, "structs");
999
1000         /**
1001          * Insertion of all known types.
1002          *
1003          * \warning Order of function calls here must be aligned with #eSDNA_Type.
1004          * \warning uint is not allowed! use in structs an unsigned int.
1005          * \warning sizes must match #DNA_elem_type_size().
1006          */
1007         add_type("char", 1);     /* SDNA_TYPE_CHAR */
1008         add_type("uchar", 1);    /* SDNA_TYPE_UCHAR */
1009         add_type("short", 2);    /* SDNA_TYPE_SHORT */
1010         add_type("ushort", 2);   /* SDNA_TYPE_USHORT */
1011         add_type("int", 4);      /* SDNA_TYPE_INT */
1012
1013         /* note, long isn't supported,
1014          * these are place-holders to maintain alignment with eSDNA_Type*/
1015         add_type("long", 4);     /* SDNA_TYPE_LONG */
1016         add_type("ulong", 4);    /* SDNA_TYPE_ULONG */
1017
1018         add_type("float", 4);    /* SDNA_TYPE_FLOAT */
1019         add_type("double", 8);   /* SDNA_TYPE_DOUBLE */
1020         add_type("int64_t", 8);  /* SDNA_TYPE_INT64 */
1021         add_type("uint64_t", 8); /* SDNA_TYPE_UINT64 */
1022         add_type("void", 0);     /* SDNA_TYPE_VOID */
1023
1024         /* the defines above shouldn't be output in the padding file... */
1025         firststruct = nr_types;
1026
1027         /* add all include files defined in the global array                     */
1028         /* Since the internal file+path name buffer has limited length, I do a   */
1029         /* little test first...                                                  */
1030         /* Mind the breaking condition here!                                     */
1031         if (debugSDNA) printf("\tStart of header scan:\n");
1032         for (i = 0; *(includefiles[i]) != '\0'; i++) {
1033                 sprintf(str, "%s%s", baseDirectory, includefiles[i]);
1034                 if (debugSDNA) printf("\t|-- Converting %s\n", str);
1035                 if (convert_include(str)) {
1036                         return (1);
1037                 }
1038         }
1039         if (debugSDNA) printf("\tFinished scanning %d headers.\n", i);
1040
1041         if (calculate_structlens(firststruct)) {
1042                 /* error */
1043                 return(1);
1044         }
1045
1046         /* FOR DEBUG */
1047         if (debugSDNA > 1) {
1048                 int a, b;
1049                 /* short *elem; */
1050                 short num_types;
1051
1052                 printf("nr_names %d nr_types %d nr_structs %d\n", nr_names, nr_types, nr_structs);
1053                 for (a = 0; a < nr_names; a++) {
1054                         printf(" %s\n", names[a]);
1055                 }
1056                 printf("\n");
1057
1058                 sp = typelens_native;
1059                 for (a = 0; a < nr_types; a++, sp++) {
1060                         printf(" %s %d\n", types[a], *sp);
1061                 }
1062                 printf("\n");
1063
1064                 for (a = 0; a < nr_structs; a++) {
1065                         sp = structs[a];
1066                         printf(" struct %s elems: %d size: %d\n", types[sp[0]], sp[1], typelens_native[sp[0]]);
1067                         num_types  = sp[1];
1068                         sp += 2;
1069                         /* ? num_types was elem? */
1070                         for (b = 0; b < num_types; b++, sp += 2) {
1071                                 printf("   %s %s\n", types[sp[0]], names[sp[1]]);
1072                         }
1073                 }
1074         }
1075
1076         /* file writing */
1077
1078         if (debugSDNA > 0) printf("Writing file ... ");
1079
1080         if (nr_names == 0 || nr_structs == 0) {
1081                 /* pass */
1082         }
1083         else {
1084                 dna_write(file, "SDNA", 4);
1085
1086                 /* write names */
1087                 dna_write(file, "NAME", 4);
1088                 len = nr_names;
1089                 dna_write(file, &len, 4);
1090
1091                 /* calculate size of datablock with strings */
1092                 cp = names[nr_names - 1];
1093                 cp += strlen(names[nr_names - 1]) + 1;         /* +1: null-terminator */
1094                 len = (intptr_t) (cp - (char *) names[0]);
1095                 len = (len + 3) & ~3;
1096                 dna_write(file, names[0], len);
1097
1098                 /* write TYPES */
1099                 dna_write(file, "TYPE", 4);
1100                 len = nr_types;
1101                 dna_write(file, &len, 4);
1102
1103                 /* calculate datablock size */
1104                 cp = types[nr_types - 1];
1105                 cp += strlen(types[nr_types - 1]) + 1;     /* +1: null-terminator */
1106                 len = (intptr_t) (cp - (char *) types[0]);
1107                 len = (len + 3) & ~3;
1108
1109                 dna_write(file, types[0], len);
1110
1111                 /* WRITE TYPELENGTHS */
1112                 dna_write(file, "TLEN", 4);
1113
1114                 len = 2 * nr_types;
1115                 if (nr_types & 1) len += 2;
1116                 dna_write(file, typelens_native, len);
1117
1118                 /* WRITE STRUCTS */
1119                 dna_write(file, "STRC", 4);
1120                 len = nr_structs;
1121                 dna_write(file, &len, 4);
1122
1123                 /* calc datablock size */
1124                 sp = structs[nr_structs - 1];
1125                 sp += 2 + 2 * (sp[1]);
1126                 len = (intptr_t) ((char *) sp - (char *) structs[0]);
1127                 len = (len + 3) & ~3;
1128
1129                 dna_write(file, structs[0], len);
1130
1131                 /* a simple dna padding test */
1132                 if (0) {
1133                         FILE *fp;
1134                         int a;
1135
1136                         fp = fopen("padding.c", "w");
1137                         if (fp == NULL) {
1138                                 /* pass */
1139                         }
1140                         else {
1141
1142                                 /* add all include files defined in the global array */
1143                                 for (i = 0; *(includefiles[i]) != '\0'; i++) {
1144                                         fprintf(fp, "#include \"%s%s\"\n", baseDirectory, includefiles[i]);
1145                                 }
1146
1147                                 fprintf(fp, "main() {\n");
1148                                 sp = typelens_native;
1149                                 sp += firststruct;
1150                                 for (a = firststruct; a < nr_types; a++, sp++) {
1151                                         if (*sp) {
1152                                                 fprintf(fp, "\tif (sizeof(struct %s) - %d) printf(\"ALIGN ERROR:", types[a], *sp);
1153                                                 fprintf(fp, "%%d %s %d ", types[a], *sp);
1154                                                 fprintf(fp, "\\n\",  sizeof(struct %s) - %d);\n", types[a], *sp);
1155                                         }
1156                                 }
1157                                 fprintf(fp, "}\n");
1158                                 fclose(fp);
1159                         }
1160                 }
1161                 /*      end end padding test */
1162         }
1163
1164         /* write a simple enum with all structs offsets,
1165          * should only be accessed via SDNA_TYPE_FROM_STRUCT macro */
1166         {
1167                 fprintf(file_offsets, "#define SDNA_TYPE_FROM_STRUCT(id) _SDNA_TYPE_##id\n");
1168                 fprintf(file_offsets, "enum {\n");
1169                 for (i = 0; i < nr_structs; i++) {
1170                         const short *structpoin = structs[i];
1171                         const int    structtype = structpoin[0];
1172                         fprintf(file_offsets, "\t_SDNA_TYPE_%s = %d,\n", types[structtype], i);
1173                 }
1174                 fprintf(file_offsets, "\tSDNA_TYPE_MAX = %d,\n", nr_structs);
1175                 fprintf(file_offsets, "};\n");
1176         }
1177
1178         MEM_freeN(namedata);
1179         MEM_freeN(typedata);
1180         MEM_freeN(structdata);
1181         MEM_freeN(names);
1182         MEM_freeN(types);
1183         MEM_freeN(typelens_native);
1184         MEM_freeN(typelens_32);
1185         MEM_freeN(typelens_64);
1186         MEM_freeN(structs);
1187
1188         if (debugSDNA > 0) printf("done.\n");
1189
1190         return(0);
1191 }
1192
1193 /* ************************* END MAKE DNA ********************** */
1194
1195 static void make_bad_file(const char *file, int line)
1196 {
1197         FILE *fp = fopen(file, "w");
1198         fprintf(fp, "#error \"Error! can't make correct DNA.c file from %s:%d, STUPID!\"\n", __FILE__, line);
1199         fclose(fp);
1200 }
1201
1202 #ifndef BASE_HEADER
1203 #define BASE_HEADER "../"
1204 #endif
1205
1206 int main(int argc, char **argv)
1207 {
1208         int return_status = 0;
1209
1210         if (argc != 3 && argc != 4) {
1211                 printf("Usage: %s dna.c dna_struct_offsets.h [base directory]\n", argv[0]);
1212                 return_status = 1;
1213         }
1214         else {
1215                 FILE *file_dna         = fopen(argv[1], "w");
1216                 FILE *file_dna_offsets = fopen(argv[2], "w");
1217                 if (!file_dna) {
1218                         printf("Unable to open file: %s\n", argv[1]);
1219                         return_status = 1;
1220                 }
1221                 else if (!file_dna_offsets) {
1222                         printf("Unable to open file: %s\n", argv[2]);
1223                         return_status = 1;
1224                 }
1225                 else {
1226                         const char *baseDirectory;
1227
1228                         if (argc == 4) {
1229                                 baseDirectory = argv[3];
1230                         }
1231                         else {
1232                                 baseDirectory = BASE_HEADER;
1233                         }
1234
1235                         fprintf(file_dna, "const unsigned char DNAstr[] = {\n");
1236                         if (make_structDNA(baseDirectory, file_dna, file_dna_offsets)) {
1237                                 /* error */
1238                                 fclose(file_dna);
1239                                 file_dna = NULL;
1240                                 make_bad_file(argv[1], __LINE__);
1241                                 return_status = 1;
1242                         }
1243                         else {
1244                                 fprintf(file_dna, "};\n");
1245                                 fprintf(file_dna, "const int DNAlen = sizeof(DNAstr);\n");
1246                         }
1247                 }
1248
1249                 if (file_dna) {
1250                         fclose(file_dna);
1251                 }
1252                 if (file_dna_offsets) {
1253                         fclose(file_dna_offsets);
1254                 }
1255         }
1256
1257
1258         return(return_status);
1259 }
1260
1261 /* handy but fails on struct bounds which makesdna doesn't care about
1262  * with quite the same strictness as GCC does */
1263 #if 0
1264 /* include files for automatic dependencies */
1265
1266 /* extra safety check that we are aligned,
1267  * warnings here are easier to fix the makesdna's */
1268 #ifdef __GNUC__
1269 #  pragma GCC diagnostic error "-Wpadded"
1270 #endif
1271
1272 #endif /* if 0 */
1273
1274 /* even though DNA supports, 'long' shouldn't be used since it can be either 32 or 64bit,
1275  * use int or int64_t instead.
1276  * Only valid use would be as a runtime variable if an API expected a long,
1277  * but so far we dont have this happening. */
1278 #ifdef __GNUC__
1279 #  pragma GCC poison long
1280 #endif
1281
1282 #include "DNA_listBase.h"
1283 #include "DNA_vec_types.h"
1284 #include "DNA_ID.h"
1285 #include "DNA_ipo_types.h"
1286 #include "DNA_key_types.h"
1287 #include "DNA_text_types.h"
1288 #include "DNA_packedFile_types.h"
1289 #include "DNA_camera_types.h"
1290 #include "DNA_image_types.h"
1291 #include "DNA_texture_types.h"
1292 #include "DNA_lamp_types.h"
1293 #include "DNA_material_types.h"
1294 #include "DNA_vfont_types.h"
1295 #include "DNA_meta_types.h"
1296 #include "DNA_curve_types.h"
1297 #include "DNA_mesh_types.h"
1298 #include "DNA_meshdata_types.h"
1299 #include "DNA_modifier_types.h"
1300 #include "DNA_lattice_types.h"
1301 #include "DNA_object_types.h"
1302 #include "DNA_object_force_types.h"
1303 #include "DNA_object_fluidsim_types.h"
1304 #include "DNA_world_types.h"
1305 #include "DNA_scene_types.h"
1306 #include "DNA_view3d_types.h"
1307 #include "DNA_view2d_types.h"
1308 #include "DNA_space_types.h"
1309 #include "DNA_userdef_types.h"
1310 #include "DNA_screen_types.h"
1311 #include "DNA_sdna_types.h"
1312 #include "DNA_fileglobal_types.h"
1313 #include "DNA_sequence_types.h"
1314 #include "DNA_effect_types.h"
1315 #include "DNA_outliner_types.h"
1316 #include "DNA_property_types.h"
1317 #include "DNA_sensor_types.h"
1318 #include "DNA_controller_types.h"
1319 #include "DNA_actuator_types.h"
1320 #include "DNA_sound_types.h"
1321 #include "DNA_group_types.h"
1322 #include "DNA_armature_types.h"
1323 #include "DNA_action_types.h"
1324 #include "DNA_constraint_types.h"
1325 #include "DNA_nla_types.h"
1326 #include "DNA_node_types.h"
1327 #include "DNA_color_types.h"
1328 #include "DNA_brush_types.h"
1329 #include "DNA_customdata_types.h"
1330 #include "DNA_particle_types.h"
1331 #include "DNA_cloth_types.h"
1332 #include "DNA_gpencil_types.h"
1333 #include "DNA_windowmanager_types.h"
1334 #include "DNA_anim_types.h"
1335 #include "DNA_boid_types.h"
1336 #include "DNA_smoke_types.h"
1337 #include "DNA_speaker_types.h"
1338 #include "DNA_movieclip_types.h"
1339 #include "DNA_tracking_types.h"
1340 #include "DNA_dynamicpaint_types.h"
1341 #include "DNA_mask_types.h"
1342 #include "DNA_rigidbody_types.h"
1343 #include "DNA_freestyle_types.h"
1344 #include "DNA_linestyle_types.h"
1345 #include "DNA_cachefile_types.h"
1346 /* end of list */