4 * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version. The Blender
10 * Foundation also sells licenses for use in proprietary software under
11 * the Blender License. See http://www.blender.org/BL/ for information
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24 * All rights reserved.
26 * The Original Code is: all of this file.
28 * Contributor(s): none yet.
30 * ***** END GPL/BL DUAL LICENSE BLOCK *****
32 * Struct muncher for making SDNA
34 * Originally by Ton, some mods by Frank, and some cleaning and
37 * Makesdna creates a .c file with a long string of numbers that
38 * encode the Blender file format. It is fast, because it is basically
39 * a binary dump. There are some details to mind when reconstructing
40 * the file (endianness and byte-alignment).
42 * This little program scans all structs that need to be serialized,
43 * and determined the names and types of all members. It calculates
44 * how much memory (on disk or in ram) is needed to store that struct,
45 * and the offsets for reaching a particular one.
47 * There is a facility to get verbose output from sdna. Search for
48 * debugSDNA. This int can be set to 0 (no output) to some int. Higher
49 * numbers give more output.
52 #define DNA_VERSION_DATE "$Id$"
58 #include "MEM_guardedalloc.h"
59 #include "DNA_sdna_types.h"
65 #define SDNA_MAX_FILENAME_LENGTH 255
68 /* Included the path relative from /source/blender/ here, so we can move */
69 /* headers around with more freedom. */
70 char *includefiles[] = {
72 // if you add files here, please add them at the end
73 // of makesdna.c (this file) as well
80 "DNA_scriptlink_types.h",
82 "DNA_packedFile_types.h",
85 "DNA_texture_types.h",
88 "DNA_material_types.h",
90 // if you add files here, please add them at the end
91 // of makesdna.c (this file) as well
95 "DNA_meshdata_types.h",
96 "DNA_modifier_types.h",
97 "DNA_lattice_types.h",
100 "DNA_object_fluidsim.h",
104 "DNA_view3d_types.h",
105 "DNA_view2d_types.h",
107 "DNA_userdef_types.h",
108 "DNA_screen_types.h",
110 // if you add files here, please add them at the end
111 // of makesdna.c (this file) as well
112 "DNA_fileglobal_types.h",
113 "DNA_sequence_types.h",
114 "DNA_effect_types.h",
116 "DNA_property_types.h",
117 "DNA_sensor_types.h",
118 "DNA_controller_types.h",
119 "DNA_actuator_types.h",
122 "DNA_armature_types.h",
123 "DNA_action_types.h",
124 "DNA_constraint_types.h",
126 // if you add files here, please add them at the end
127 // of makesdna.c (this file) as well
129 // empty string to indicate end of includefiles
133 int maxdata= 500000, maxnr= 50000;
137 char **names, *namedata; /* at adress names[a] is string a */
138 char **types, *typedata; /* at adress types[a] is string a */
139 short *typelens; /* at typelens[a] is de length of type a */
140 short *alphalens; /* contains sizes as they are calculated on the alpha */
141 short **structs, *structdata; /* at sp= structs[a] is the first adress of a struct definition
143 sp[1] is amount of elements
144 sp[2] sp[3] is typenr, namenr (etc) */
147 * - 0 = no output, except errors
148 * - 1 = detail actions
149 * - 2 = full trace, tell which names and types were found
150 * - 4 = full trace, plus all gritty details
153 int additional_slen_offset;
155 /* ************************************************************************** */
157 /* ************************************************************************** */
160 * Add type <str> to struct indexed by <len>, if it was not yet found.
162 int add_type(char *str, int len);
165 * Add variable <str> to
167 int add_name(char *str);
170 * Search whether this structure type was already found, and if not,
173 short *add_struct(int namecode);
176 * Remove comments from this buffer. Assumes that the buffer refers to
179 int preprocess_include(char *maindata, int len);
182 * Scan this file for serializable types.
184 int convert_include(char *filename);
187 * Determine how many bytes are needed for an array.
189 int arraysize(char *astr, int len);
192 * Determine how many bytes are needed for each struct.
194 int calculate_structlens(void);
197 * Construct the DNA.c file
199 void dna_write(FILE *file, void *pntr, int size);
202 * Report all structures found so far, and print their lenghts.
204 void printStructLenghts(void);
208 /* ************************************************************************** */
210 /* ************************************************************************** */
212 /* ************************* MAKEN DNA ********************** */
214 int add_type(char *str, int len)
219 if(str[0]==0) return -1;
221 /* search through type array */
222 for(nr=0; nr<nr_types; nr++) {
223 if(strcmp(str, types[nr])==0) {
232 /* append new type */
233 if(nr_types==0) cp= typedata;
235 cp= types[nr_types-1]+strlen(types[nr_types-1])+1;
239 typelens[nr_types]= len;
240 alphalens[nr_types]= len;
242 if(nr_types>=maxnr) {
243 printf("too many types\n");
254 * Because of the weird way of tokenizing, we have to 'cast' function
255 * pointers to ... (*f)(), whatever the original signature. In fact,
256 * we add name and type at the same time... There are two special
257 * cases, unfortunately. These are explicitly checked.
260 int add_name(char *str)
264 char buf[255]; /* stupid limit, change it :) */
267 additional_slen_offset = 0;
269 if((str[0]==0) /* || (str[1]==0) */) return -1;
271 if (str[0] == '(' && str[1] == '*') {
272 if (debugSDNA > 3) printf("\t\t\t\t*** Function pointer found\n");
273 /* functionpointer: transform the type (sometimes) */
277 while (str[i] != ')') {
282 /* Another number we need is the extra slen offset. This extra
283 * offset is the overshoot after a space. If there is no
284 * space, no overshoot should be calculated. */
285 j = i; /* j at first closing brace */
287 if (debugSDNA > 3) printf("first brace after offset %d\n", i);
289 j++; /* j beyond closing brace ? */
290 while ((str[j] != 0) && (str[j] != ')' )) {
291 if (debugSDNA > 3) printf("seen %c ( %d) \n", str[j], str[j]);
294 if (debugSDNA > 3) printf("seen %c ( %d) \n", str[j], str[j]);
295 if (debugSDNA > 3) printf("special after offset %d\n", j);
298 if (debugSDNA > 3) printf("offsetting for space\n");
299 /* get additional offset */
301 while (str[j] != ')') {
305 if (debugSDNA > 3) printf("extra offset %d\n", k);
306 additional_slen_offset = k;
307 } else if (str[j] == ')' ) {
308 if (debugSDNA > 3) printf("offsetting for brace\n");
309 ; /* don't get extra offset */
311 printf("Error during tokening function pointer argument list\n");
315 * Put )(void) at the end? Maybe )(). Should check this with
316 * old sdna. Actually, sometimes )(), sometimes )(void...)
317 * Alas.. such is the nature of braindamage :(
319 * Sorted it out: always do )(), except for headdraw and
320 * windraw, part of ScrArea. This is important, because some
321 * linkers will treat different fp's differently when called
322 * !!! This has to do with interference in byte-alignment and
323 * the way args are pushed on the stack.
327 if (debugSDNA > 3) printf("Name before chomping: %s\n", buf);
328 if ( (strncmp(buf,"(*headdraw", 10) == 0)
329 || (strncmp(buf,"(*windraw", 9) == 0) ) {
344 /* now precede with buf*/
345 if (debugSDNA > 3) printf("\t\t\t\t\tProposing fp name %s\n", buf);
348 /* normal field: old code */
352 /* search name array */
353 for(nr=0; nr<nr_names; nr++) {
354 if(strcmp(name, names[nr])==0) {
359 /* append new type */
360 if(nr_names==0) cp= namedata;
362 cp= names[nr_names-1]+strlen(names[nr_names-1])+1;
367 if(nr_names>=maxnr) {
368 printf("too many names\n");
376 short *add_struct(int namecode)
382 structs[0]= structdata;
385 sp= structs[nr_structs-1];
387 structs[nr_structs]= sp+ 2*len+2;
390 sp= structs[nr_structs];
393 if(nr_structs>=maxnr) {
394 printf("too many structs\n");
402 int preprocess_include(char *maindata, int len)
404 int a, newlen, comment = 0;
405 char *cp, *temp, *md;
407 temp= MEM_mallocN(len, "preprocess_include");
408 memcpy(temp, maindata, len);
410 // remove all c++ comments
411 /* replace all enters/tabs/etc with spaces */
416 if(cp[0]=='/' && cp[1]=='/') {
421 if (comment || *cp<32 || *cp>128 ) *cp= 32;
426 /* data from temp copy to maindata, remove comments and double spaces */
434 if(cp[0]=='/' && cp[1]=='*') {
438 if(cp[0]=='*' && cp[1]=='/') {
443 /* do not copy when: */
445 else if( cp[0]==' ' && cp[1]==' ' );
446 else if( cp[-1]=='*' && cp[0]==' ' ); /* pointers with a space */
459 static void *read_file_data(char *filename, int *len_r)
462 FILE *fp= fopen(filename, "rb");
464 FILE *fp= fopen(filename, "r");
473 fseek(fp, 0L, SEEK_END);
475 fseek(fp, 0L, SEEK_SET);
477 data= MEM_mallocN(*len_r, "read_file_data");
483 if (fread(data, *len_r, 1, fp)!=1) {
492 int convert_include(char *filename)
494 /* read include file, skip structs with a '#' before it.
495 store all data in temporal arrays.
497 int filelen, count, overslaan, slen, type, name, strct;
498 short *structpoin, *sp;
499 char *maindata, *mainend, *md, *md1;
501 md= maindata= read_file_data(filename, &filelen);
503 printf("Can't read file %s\n", filename);
507 filelen= preprocess_include(maindata, filelen);
508 mainend= maindata+filelen-1;
510 /* we look for '{' and then back to 'struct' */
513 while(count<filelen) {
515 /* code for skipping a struct: two hashes. (preprocess added a space) */
516 if(md[0]=='#' && md[1]==' ' && md[2]=='#') {
526 if(md[-1]==' ') md[-1]= 0;
528 while( *md1!=32) md1--; /* to beginning of word */
531 /* we've got a struct name when... */
532 if( strncmp(md1-7, "struct", 6)==0 ) {
535 strct= add_type(md1, 0);
536 structpoin= add_struct(strct);
539 if (debugSDNA > 1) printf("\t|\t|-- detected struct %s\n", types[strct]);
541 /* first lets make it all nice strings */
544 if(md1>mainend) break;
546 if(*md1==',' || *md1==' ') *md1= 0;
550 /* read types and names until first character that is not '}' */
552 while( *md1 != '}' ) {
553 if(md1>mainend) break;
555 /* skip when it says 'struct' or 'unsigned' */
557 if( strncmp(md1, "struct", 6)==0 ) md1+= 7;
558 if( strncmp(md1, "unsigned", 6)==0 ) md1+= 9;
560 /* we've got a type! */
561 type= add_type(md1, 0);
563 if (debugSDNA > 1) printf("\t|\t|\tfound type %s (", md1);
569 while( *md1 != ';' ) {
570 if(md1>mainend) break;
573 /* We've got a name. slen needs
574 * correction for function
576 slen= (int) strlen(md1);
577 if( md1[slen-1]==';' ) {
582 slen += additional_slen_offset;
586 if ((debugSDNA>1) && (names[name] != 0 )) printf("%s |", names[name]);
597 slen += additional_slen_offset;
601 if ((debugSDNA > 1) && (names[name] != 0 )) printf("%s ||", names[name]);
611 if (debugSDNA > 1) printf(")\n");
628 int arraysize(char *astr, int len)
631 char str[100], *cp=0;
633 memcpy(str, astr, len+1);
635 for(a=0; a<len; a++) {
639 else if( str[a]==']' && cp) {
648 int calculate_structlens(void)
650 int a, b, len, alphalen, unknown= nr_structs, lastunknown, structtype, type, mul, namelen;
651 short *sp, *structpoin;
653 int has_pointer, dna_error = 0;
656 lastunknown= unknown;
659 /* check all structs... */
660 for(a=0; a<nr_structs; a++) {
661 structpoin= structs[a];
662 structtype= structpoin[0];
664 /* when length is not known... */
665 if(typelens[structtype]==0) {
672 /* check all elements in struct */
673 for(b=0; b<structpoin[1]; b++, sp+=2) {
677 namelen= (int) strlen(cp);
678 /* is it a pointer or function pointer? */
679 if(cp[0]=='*' || cp[1]=='*') {
681 /* has the name an extra length? (array) */
683 if( cp[namelen-1]==']') mul= arraysize(cp, namelen);
686 if(sizeof(void *) == 4) {
688 printf("Align pointer error in struct: %s %s\n", types[structtype], cp);
693 printf("Align pointer error in struct: %s %s\n", types[structtype], cp);
699 printf("Align pointer error in struct: %s %s\n", types[structtype],cp);
703 len += sizeof(void *) * mul;
706 } else if( typelens[type] ) {
707 /* has the name an extra length? (array) */
709 if( cp[namelen-1]==']') mul= arraysize(cp, namelen);
712 if(typelens[type]>3 && (len % 4) ) {
713 printf("Align 4 error in struct: %s %s (add %d padding bytes)\n", types[structtype], cp, len%4);
716 else if(typelens[type]==2 && (len % 2) ) {
717 printf("Align 2 error in struct: %s %s (add %d padding bytes)\n", types[structtype], cp, len%2);
721 len += mul*typelens[type];
722 alphalen += mul * alphalens[type];
734 typelens[structtype]= len;
735 alphalens[structtype]= alphalen;
736 // two ways to detect if a struct contains a pointer:
737 // has_pointer is set or alphalen != len
738 if (has_pointer || alphalen != len) {
740 printf("Sizeerror in struct: %s (add %d bytes)\n", types[structtype], alphalen%8);
746 printf("Sizeerror in struct: %s (add %d bytes)\n", types[structtype], len%4);
754 if(unknown==lastunknown) break;
758 printf("ERROR: still %d structs unknown\n", unknown);
761 printf("*** Known structs : \n");
763 for(a=0; a<nr_structs; a++) {
764 structpoin= structs[a];
765 structtype= structpoin[0];
768 if(typelens[structtype]!=0) {
769 printf(" %s\n", types[structtype]);
775 printf("*** Unknown structs : \n");
777 for(a=0; a<nr_structs; a++) {
778 structpoin= structs[a];
779 structtype= structpoin[0];
781 /* length unkown yet */
782 if(typelens[structtype]==0) {
783 printf(" %s\n", types[structtype]);
791 #define MAX_DNA_LINE_LENGTH 20
793 void dna_write(FILE *file, void *pntr, int size)
795 static int linelength = 0;
799 data = (char *) pntr;
801 for (i = 0 ; i < size ; i++)
803 fprintf(file, "%d,", data[i]);
805 if (linelength >= MAX_DNA_LINE_LENGTH) {
812 void printStructLenghts(void)
814 int a, unknown= nr_structs, lastunknown, structtype;
816 printf("\n\n*** All detected structs:\n");
819 lastunknown= unknown;
822 /* check all structs... */
823 for(a=0; a<nr_structs; a++) {
824 structpoin= structs[a];
825 structtype= structpoin[0];
826 printf("\t%s\t:%d\n", types[structtype], typelens[structtype]);
830 printf("*** End of list\n");
835 int make_structDNA(char *baseDirectory, FILE *file)
839 /* str contains filenames. Since we now include paths, I stretched */
840 /* it a bit. Hope this is enough :) -nzc- */
841 char str[SDNA_MAX_FILENAME_LENGTH], *cp;
844 if (debugSDNA > -1) {
846 printf("Running makesdna at debug level %d\n", debugSDNA);
847 printf("\tProgram version: %s\n", DNA_VERSION_DATE);
850 /* the longest known struct is 50k, so we assume 100k is sufficent! */
851 namedata= MEM_callocN(maxdata, "namedata");
852 typedata= MEM_callocN(maxdata, "typedata");
853 structdata= MEM_callocN(maxdata, "structdata");
855 /* a maximum of 5000 variables, must be sufficient? */
856 names= MEM_callocN(sizeof(char *)*maxnr, "names");
857 types= MEM_callocN(sizeof(char *)*maxnr, "types");
858 typelens= MEM_callocN(sizeof(short)*maxnr, "typelens");
859 alphalens= MEM_callocN(sizeof(short)*maxnr, "alphalens");
860 structs= MEM_callocN(sizeof(short)*maxnr, "structs");
862 /* insertion of all known types */
863 /* watch it: uint is not allowed! use in structs an unsigned int */
864 add_type("char", 1); /* 0 */
865 add_type("uchar", 1); /* 1 */
866 add_type("short", 2); /* 2 */
867 add_type("ushort", 2); /* 3 */
868 add_type("int", 4); /* 4 */
869 add_type("long", 4); /* 5 */
870 add_type("ulong", 4); /* 6 */
871 add_type("float", 4); /* 7 */
872 add_type("double", 8); /* 8 */
873 add_type("void", 0); /* 9 */
875 // the defines above shouldn't be output in the padding file...
876 firststruct = nr_types;
878 /* add all include files defined in the global array */
879 /* Since the internal file+path name buffer has limited length, I do a */
880 /* little test first... */
881 /* Mind the breaking condition here! */
882 if (debugSDNA) printf("\tStart of header scan:\n");
883 for (i = 0; strlen(includefiles[i]); i++) {
884 sprintf(str, "%s%s", baseDirectory, includefiles[i]);
885 if (debugSDNA) printf("\t|-- Converting %s\n", str);
886 if (convert_include(str)) {
890 if (debugSDNA) printf("\tFinished scanning %d headers.\n", i);
892 if (calculate_structlens()) {
904 printf("nr_names %d nr_types %d nr_structs %d\n", nr_names, nr_types, nr_structs);
905 for(a=0; a<nr_names; a++) {
906 printf(" %s \n", names[a]);
911 for(a=0; a<nr_types; a++, sp++) {
912 printf(" %s %d\n", types[a], *sp);
916 for(a=0; a<nr_structs; a++) {
918 printf(" struct %s elems: %d size: %d\n", types[sp[0]], sp[1],typelens[sp[0]]);
921 /* ? num_types was elem? */
922 for(b=0; b< num_types; b++, sp+= 2) {
923 printf(" %s %s\n", types[sp[0]], names[sp[1]]);
930 if (debugSDNA > -1) printf("Writing file ... ");
932 if(nr_names==0 || nr_structs==0);
935 dna_write(file, str, 4);
939 dna_write(file, str, 4);
941 dna_write(file, &len, 4);
943 /* calculate size of datablock with strings */
944 cp= names[nr_names-1];
945 cp+= strlen(names[nr_names-1]) + 1; /* +1: null-terminator */
946 len= (long) (cp - (char*) names[0]);
948 dna_write(file, names[0], len);
952 dna_write(file, str, 4);
954 dna_write(file, &len, 4);
956 /* calculate datablock size */
957 cp= types[nr_types-1];
958 cp+= strlen(types[nr_types-1]) + 1; /* +1: null-terminator */
959 len= (long) (cp - (char*) types[0]);
962 dna_write(file, types[0], len);
964 /* WRITE TYPELENGTHS */
966 dna_write(file, str, 4);
969 if(nr_types & 1) len+= 2;
970 dna_write(file, typelens, len);
974 dna_write(file, str, 4);
976 dna_write(file, &len, 4);
978 /* calc datablock size */
979 sp= structs[nr_structs-1];
981 len= (long) ((char*) sp - (char*) structs[0]);
984 dna_write(file, structs[0], len);
986 /* a simple dna padding test */
992 fp= fopen("padding.c", "w");
996 // add all include files defined in the global array
997 for (i = 0; strlen(includefiles[i]); i++) {
998 fprintf(fp, "#include \"%s\"\n", includefiles[i]);
1001 fprintf(fp, "main(){\n");
1004 for(a=firststruct; a<nr_types; a++, sp++) {
1005 fprintf(fp, "\tprintf(\" ");
1006 fprintf(fp, "%%d %s %d ", types[a], *sp);
1007 fprintf(fp, "\\n\", sizeof(struct %s) - %d);\n", types[a], *sp);
1013 /* end end padding test */
1017 MEM_freeN(namedata);
1018 MEM_freeN(typedata);
1019 MEM_freeN(structdata);
1022 MEM_freeN(typelens);
1025 if (debugSDNA > -1) printf("done.\n");
1030 /* ************************* END MAKE DNA ********************** */
1032 static void make_bad_file(char *file)
1034 FILE *fp= fopen(file, "w");
1035 fprintf(fp, "ERROR! Cannot make correct DNA.c file, STUPID!\n");
1040 #define BASE_HEADER "../"
1043 int main(int argc, char ** argv)
1046 int return_status = 0;
1048 if (argc!=2 && argc!=3) {
1049 printf("Usage: %s outfile.c [base directory]\n", argv[0]);
1052 file = fopen(argv[1], "w");
1054 printf ("Unable to open file: %s\n", argv[1]);
1057 char baseDirectory[256];
1060 strcpy(baseDirectory, argv[2]);
1062 strcpy(baseDirectory, BASE_HEADER);
1065 fprintf (file, "unsigned char DNAstr[]= {\n");
1066 if (make_structDNA(baseDirectory, file)) {
1069 make_bad_file(argv[1]);
1072 fprintf(file, "};\n");
1073 fprintf(file, "int DNAlen= sizeof(DNAstr);\n");
1081 return(return_status);
1084 // include files for automatic dependancies
1085 #include "DNA_listBase.h"
1086 #include "DNA_vec_types.h"
1088 #include "DNA_ipo_types.h"
1089 #include "DNA_key_types.h"
1090 #include "DNA_scriptlink_types.h"
1091 #include "DNA_text_types.h"
1092 #include "DNA_packedFile_types.h"
1093 #include "DNA_camera_types.h"
1094 #include "DNA_image_types.h"
1095 #include "DNA_texture_types.h"
1096 #include "DNA_lamp_types.h"
1097 #include "DNA_wave_types.h"
1098 #include "DNA_material_types.h"
1099 #include "DNA_vfont_types.h"
1100 #include "DNA_meta_types.h"
1101 #include "DNA_curve_types.h"
1102 #include "DNA_mesh_types.h"
1103 #include "DNA_meshdata_types.h"
1104 #include "DNA_modifier_types.h"
1105 #include "DNA_lattice_types.h"
1106 #include "DNA_object_types.h"
1107 #include "DNA_object_force.h"
1108 #include "DNA_object_fluidsim.h"
1109 #include "DNA_world_types.h"
1110 #include "DNA_radio_types.h"
1111 #include "DNA_scene_types.h"
1112 #include "DNA_view3d_types.h"
1113 #include "DNA_view2d_types.h"
1114 #include "DNA_space_types.h"
1115 #include "DNA_userdef_types.h"
1116 #include "DNA_screen_types.h"
1117 #include "DNA_sdna_types.h"
1118 #include "DNA_fileglobal_types.h"
1119 #include "DNA_sequence_types.h"
1120 #include "DNA_effect_types.h"
1121 #include "DNA_oops_types.h"
1122 #include "DNA_property_types.h"
1123 #include "DNA_sensor_types.h"
1124 #include "DNA_controller_types.h"
1125 #include "DNA_actuator_types.h"
1126 #include "DNA_sound_types.h"
1127 #include "DNA_group_types.h"
1128 #include "DNA_armature_types.h"
1129 #include "DNA_action_types.h"
1130 #include "DNA_constraint_types.h"
1131 #include "DNA_nla_types.h"