/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software Foundation, * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * All rights reserved. * * The Original Code is: all of this file. * * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** */ /** \file makesdna.c * \brief Struct muncher for making SDNA. * \ingroup DNA * * \section aboutmakesdnac About makesdna tool * Originally by Ton, some mods by Frank, and some cleaning and * extension by Nzc. * * Makesdna creates a .c file with a long string of numbers that * encode the Blender file format. It is fast, because it is basically * a binary dump. There are some details to mind when reconstructing * the file (endianness and byte-alignment). * * This little program scans all structs that need to be serialized, * and determined the names and types of all members. It calculates * how much memory (on disk or in ram) is needed to store that struct, * and the offsets for reaching a particular one. * * There is a facility to get verbose output from sdna. Search for * \ref debugSDNA. This int can be set to 0 (no output) to some int. Higher * numbers give more output. * */ #define DNA_VERSION_DATE "$Id$" #include #include #include #include "MEM_guardedalloc.h" #include "DNA_sdna_types.h" #include "BLO_sys_types.h" // for intptr_t support #define SDNA_MAX_FILENAME_LENGTH 255 /* Included the path relative from /source/blender/ here, so we can move */ /* headers around with more freedom. */ const char *includefiles[] = { // if you add files here, please add them at the end // of makesdna.c (this file) as well "DNA_listBase.h", "DNA_vec_types.h", "DNA_ID.h", "DNA_ipo_types.h", "DNA_key_types.h", "DNA_text_types.h", "DNA_packedFile_types.h", "DNA_camera_types.h", "DNA_image_types.h", "DNA_texture_types.h", "DNA_lamp_types.h", "DNA_material_types.h", "DNA_vfont_types.h", // if you add files here, please add them at the end // of makesdna.c (this file) as well "DNA_meta_types.h", "DNA_curve_types.h", "DNA_mesh_types.h", "DNA_meshdata_types.h", "DNA_modifier_types.h", "DNA_lattice_types.h", "DNA_object_types.h", "DNA_object_force.h", "DNA_object_fluidsim.h", "DNA_world_types.h", "DNA_scene_types.h", "DNA_view3d_types.h", "DNA_view2d_types.h", "DNA_space_types.h", "DNA_userdef_types.h", "DNA_screen_types.h", "DNA_sdna_types.h", // if you add files here, please add them at the end // of makesdna.c (this file) as well "DNA_fileglobal_types.h", "DNA_sequence_types.h", "DNA_effect_types.h", "DNA_outliner_types.h", "DNA_property_types.h", "DNA_sensor_types.h", "DNA_controller_types.h", "DNA_actuator_types.h", "DNA_sound_types.h", "DNA_group_types.h", "DNA_armature_types.h", "DNA_action_types.h", "DNA_constraint_types.h", "DNA_nla_types.h", "DNA_node_types.h", "DNA_color_types.h", "DNA_brush_types.h", "DNA_customdata_types.h", "DNA_particle_types.h", "DNA_cloth_types.h", "DNA_gpencil_types.h", // if you add files here, please add them at the end // of makesdna.c (this file) as well "DNA_windowmanager_types.h", "DNA_anim_types.h", "DNA_boid_types.h", "DNA_smoke_types.h", // empty string to indicate end of includefiles "" }; int maxdata= 500000, maxnr= 50000; int nr_names=0; int nr_types=0; int nr_structs=0; char **names, *namedata; /* at address names[a] is string a */ char **types, *typedata; /* at address types[a] is string a */ short *typelens; /* at typelens[a] is de length of type a */ short *alphalens; /* contains sizes as they are calculated on the DEC Alpha (64 bits) */ short **structs, *structdata; /* at sp= structs[a] is the first address of a struct definition sp[0] is type number sp[1] is amount of elements sp[2] sp[3] is typenr, namenr (etc) */ /** * Variable to control debug output of makesdna. * debugSDNA: * - 0 = no output, except errors * - 1 = detail actions * - 2 = full trace, tell which names and types were found * - 4 = full trace, plus all gritty details */ int debugSDNA = 0; int additional_slen_offset; /* ************************************************************************** */ /* Functions */ /* ************************************************************************** */ /** * Add type \c str to struct indexed by \c len, if it was not yet found. * \param str char * \param len int */ int add_type(const char *str, int len); /** * Add variable \c str to * \param str */ int add_name(char *str); /** * Search whether this structure type was already found, and if not, * add it. */ short *add_struct(int namecode); /** * Remove comments from this buffer. Assumes that the buffer refers to * ascii-code text. */ int preprocess_include(char *maindata, int len); /** * Scan this file for serializable types. */ int convert_include(char *filename); /** * Determine how many bytes are needed for an array. */ int arraysize(char *astr, int len); /** * Determine how many bytes are needed for each struct. */ static int calculate_structlens(int); /** * Construct the DNA.c file */ void dna_write(FILE *file, void *pntr, int size); /** * Report all structures found so far, and print their lengths. */ void printStructLenghts(void); /* ************************************************************************** */ /* Implementation */ /* ************************************************************************** */ /* ************************* MAKEN DNA ********************** */ int add_type(const char *str, int len) { int nr; char *cp; if(str[0]==0) return -1; /* search through type array */ for(nr=0; nr=maxnr) { printf("too many types\n"); return nr_types-1; } nr_types++; return nr_types-1; } /** * * Because of the weird way of tokenizing, we have to 'cast' function * pointers to ... (*f)(), whatever the original signature. In fact, * we add name and type at the same time... There are two special * cases, unfortunately. These are explicitly checked. * * */ int add_name(char *str) { int nr, i, j, k; char *cp; char buf[255]; /* stupid limit, change it :) */ char *name; additional_slen_offset = 0; if(str[0]==0 /* || (str[1]==0) */) return -1; if (str[0] == '(' && str[1] == '*') { /* we handle function pointer and special array cases here, e.g. void (*function)(...) and float (*array)[..]. the array case name is still converted to (array*)() though because it is that way in old dna too, and works correct with elementsize() */ int isfuncptr = (strchr(str+1, '(')) != NULL; if (debugSDNA > 3) printf("\t\t\t\t*** Function pointer or multidim array pointer found\n"); /* functionpointer: transform the type (sometimes) */ i = 0; while (str[i] != ')') { buf[i] = str[i]; i++; } /* Another number we need is the extra slen offset. This extra * offset is the overshoot after a space. If there is no * space, no overshoot should be calculated. */ j = i; /* j at first closing brace */ if (debugSDNA > 3) printf("first brace after offset %d\n", i); j++; /* j beyond closing brace ? */ while ((str[j] != 0) && (str[j] != ')' )) { if (debugSDNA > 3) printf("seen %c ( %d) \n", str[j], str[j]); j++; } if (debugSDNA > 3) printf("seen %c ( %d) \n", str[j], str[j]); if (debugSDNA > 3) printf("special after offset %d\n", j); if (!isfuncptr) { /* multidimensional array pointer case */ if(str[j] == 0) { if (debugSDNA > 3) printf("offsetting for multidim array pointer\n"); } else printf("Error during tokening multidim array pointer\n"); } else if (str[j] == 0 ) { if (debugSDNA > 3) printf("offsetting for space\n"); /* get additional offset */ k = 0; while (str[j] != ')') { j++; k++; } if (debugSDNA > 3) printf("extra offset %d\n", k); additional_slen_offset = k; } else if (str[j] == ')' ) { if (debugSDNA > 3) printf("offsetting for brace\n"); ; /* don't get extra offset */ } else { printf("Error during tokening function pointer argument list\n"); } /* * Put )(void) at the end? Maybe )(). Should check this with * old sdna. Actually, sometimes )(), sometimes )(void...) * Alas.. such is the nature of braindamage :( * * Sorted it out: always do )(), except for headdraw and * windraw, part of ScrArea. This is important, because some * linkers will treat different fp's differently when called * !!! This has to do with interference in byte-alignment and * the way args are pushed on the stack. * * */ buf[i] = 0; if (debugSDNA > 3) printf("Name before chomping: %s\n", buf); if ( (strncmp(buf,"(*headdraw", 10) == 0) || (strncmp(buf,"(*windraw", 9) == 0) ) { buf[i] = ')'; buf[i+1] = '('; buf[i+2] = 'v'; buf[i+3] = 'o'; buf[i+4] = 'i'; buf[i+5] = 'd'; buf[i+6] = ')'; buf[i+7] = 0; } else { buf[i] = ')'; buf[i+1] = '('; buf[i+2] = ')'; buf[i+3] = 0; } /* now precede with buf*/ if (debugSDNA > 3) printf("\t\t\t\t\tProposing fp name %s\n", buf); name = buf; } else { /* normal field: old code */ name = str; } /* search name array */ for(nr=0; nr=maxnr) { printf("too many names\n"); return nr_names-1; } nr_names++; return nr_names-1; } short *add_struct(int namecode) { int len; short *sp; if(nr_structs==0) { structs[0]= structdata; } else { sp= structs[nr_structs-1]; len= sp[1]; structs[nr_structs]= sp+ 2*len+2; } sp= structs[nr_structs]; sp[0]= namecode; if(nr_structs>=maxnr) { printf("too many structs\n"); return sp; } nr_structs++; return sp; } int preprocess_include(char *maindata, int len) { int a, newlen, comment = 0; char *cp, *temp, *md; /* note: len + 1, last character is a dummy to prevent * comparisons using uninitialized memory */ temp= MEM_mallocN(len + 1, "preprocess_include"); temp[len]= ' '; memcpy(temp, maindata, len); // remove all c++ comments /* replace all enters/tabs/etc with spaces */ cp= temp; a= len; comment = 0; while(a--) { if(cp[0]=='/' && cp[1]=='/') { comment = 1; } else if (*cp<32) { comment = 0; } if (comment || *cp<32 || *cp>128 ) *cp= 32; cp++; } /* data from temp copy to maindata, remove comments and double spaces */ cp= temp; md= maindata; newlen= 0; comment= 0; a= len; while(a--) { if(cp[0]=='/' && cp[1]=='*') { comment= 1; cp[0]=cp[1]= 32; } if(cp[0]=='*' && cp[1]=='/') { comment= 0; cp[0]=cp[1]= 32; } /* do not copy when: */ if(comment); else if( cp[0]==' ' && cp[1]==' ' ); else if( cp[-1]=='*' && cp[0]==' ' ); /* pointers with a space */ else { md[0]= cp[0]; md++; newlen++; } cp++; } MEM_freeN(temp); return newlen; } static void *read_file_data(char *filename, int *len_r) { #ifdef WIN32 FILE *fp= fopen(filename, "rb"); #else FILE *fp= fopen(filename, "r"); #endif void *data; if (!fp) { *len_r= -1; return NULL; } fseek(fp, 0L, SEEK_END); *len_r= ftell(fp); fseek(fp, 0L, SEEK_SET); data= MEM_mallocN(*len_r, "read_file_data"); if (!data) { *len_r= -1; fclose(fp); return NULL; } if (fread(data, *len_r, 1, fp)!=1) { *len_r= -1; MEM_freeN(data); fclose(fp); return NULL; } fclose(fp); return data; } int convert_include(char *filename) { /* read include file, skip structs with a '#' before it. store all data in temporal arrays. */ int filelen, count, overslaan, slen, type, name, strct; short *structpoin, *sp; char *maindata, *mainend, *md, *md1; md= maindata= read_file_data(filename, &filelen); if (filelen==-1) { printf("Can't read file %s\n", filename); return 1; } filelen= preprocess_include(maindata, filelen); mainend= maindata+filelen-1; /* we look for '{' and then back to 'struct' */ count= 0; overslaan= 0; while(count 1) printf("\t|\t|-- detected struct %s\n", types[strct]); /* first lets make it all nice strings */ md1= md+1; while(*md1 != '}') { if(md1>mainend) break; if(*md1==',' || *md1==' ') *md1= 0; md1++; } /* read types and names until first character that is not '}' */ md1= md+1; while( *md1 != '}' ) { if(md1>mainend) break; /* skip when it says 'struct' or 'unsigned' or 'const' */ if(*md1) { if( strncmp(md1, "struct", 6)==0 ) md1+= 7; if( strncmp(md1, "unsigned", 8)==0 ) md1+= 9; if( strncmp(md1, "const", 5)==0 ) md1+= 6; /* we've got a type! */ type= add_type(md1, 0); if (debugSDNA > 1) printf("\t|\t|\tfound type %s (", md1); md1+= strlen(md1); /* read until ';' */ while( *md1 != ';' ) { if(md1>mainend) break; if(*md1) { /* We've got a name. slen needs * correction for function * pointers! */ slen= (int) strlen(md1); if( md1[slen-1]==';' ) { md1[slen-1]= 0; name= add_name(md1); slen += additional_slen_offset; sp[0]= type; sp[1]= name; if ((debugSDNA>1) && (names[name] != NULL)) printf("%s |", names[name]); structpoin[1]++; sp+= 2; md1+= slen; break; } name= add_name(md1); slen += additional_slen_offset; sp[0]= type; sp[1]= name; if ((debugSDNA > 1) && (names[name] != NULL)) printf("%s ||", names[name]); structpoin[1]++; sp+= 2; md1+= slen; } md1++; } if (debugSDNA > 1) printf(")\n"); } md1++; } } } } count++; md++; } MEM_freeN(maindata); return 0; } int arraysize(char *astr, int len) { int a, mul=1; char str[100], *cp=NULL; memcpy(str, astr, len+1); for(a=0; a= firststruct) { if(sizeof(void *)==8 && (len % 8) ) { printf("Align struct error: %s %s\n", types[structtype],cp); dna_error = 1; } } /* 2-4 aligned/ */ if(typelens[type]>3 && (len % 4) ) { printf("Align 4 error in struct: %s %s (add %d padding bytes)\n", types[structtype], cp, len%4); dna_error = 1; } else if(typelens[type]==2 && (len % 2) ) { printf("Align 2 error in struct: %s %s (add %d padding bytes)\n", types[structtype], cp, len%2); dna_error = 1; } len += mul*typelens[type]; alphalen += mul * alphalens[type]; } else { len= 0; alphalen = 0; break; } } if (len==0) { unknown++; } else { typelens[structtype]= len; alphalens[structtype]= alphalen; // two ways to detect if a struct contains a pointer: // has_pointer is set or alphalen != len if (has_pointer || alphalen != len) { if (alphalen % 8) { printf("Sizeerror 8 in struct: %s (add %d bytes)\n", types[structtype], alphalen%8); dna_error = 1; } } if(len % 4) { printf("Sizeerror 4 in struct: %s (add %d bytes)\n", types[structtype], len%4); dna_error = 1; } } } } if(unknown==lastunknown) break; } if(unknown) { printf("ERROR: still %d structs unknown\n", unknown); if (debugSDNA) { printf("*** Known structs : \n"); for(a=0; a= MAX_DNA_LINE_LENGTH) { fprintf(file, "\n"); linelength = 0; } } } void printStructLenghts(void) { int a, unknown= nr_structs, lastunknown, structtype; short *structpoin; printf("\n\n*** All detected structs:\n"); while(unknown) { lastunknown= unknown; unknown= 0; /* check all structs... */ for(a=0; a -1) { fflush(stdout); printf("Running makesdna at debug level %d\n", debugSDNA); printf("\tProgram version: %s\n", DNA_VERSION_DATE); } /* the longest known struct is 50k, so we assume 100k is sufficent! */ namedata= MEM_callocN(maxdata, "namedata"); typedata= MEM_callocN(maxdata, "typedata"); structdata= MEM_callocN(maxdata, "structdata"); /* a maximum of 5000 variables, must be sufficient? */ names= MEM_callocN(sizeof(char *)*maxnr, "names"); types= MEM_callocN(sizeof(char *)*maxnr, "types"); typelens= MEM_callocN(sizeof(short)*maxnr, "typelens"); alphalens= MEM_callocN(sizeof(short)*maxnr, "alphalens"); structs= MEM_callocN(sizeof(short)*maxnr, "structs"); /* insertion of all known types */ /* watch it: uint is not allowed! use in structs an unsigned int */ add_type("char", 1); /* 0 */ add_type("uchar", 1); /* 1 */ add_type("short", 2); /* 2 */ add_type("ushort", 2); /* 3 */ add_type("int", 4); /* 4 */ add_type("long", 4); /* 5 */ /* should it be 8 on 64 bits? */ add_type("ulong", 4); /* 6 */ add_type("float", 4); /* 7 */ add_type("double", 8); /* 8 */ add_type("void", 0); /* 9 */ // the defines above shouldn't be output in the padding file... firststruct = nr_types; /* add all include files defined in the global array */ /* Since the internal file+path name buffer has limited length, I do a */ /* little test first... */ /* Mind the breaking condition here! */ if (debugSDNA) printf("\tStart of header scan:\n"); for (i = 0; strlen(includefiles[i]); i++) { sprintf(str, "%s%s", baseDirectory, includefiles[i]); if (debugSDNA) printf("\t|-- Converting %s\n", str); if (convert_include(str)) { return (1); } } if (debugSDNA) printf("\tFinished scanning %d headers.\n", i); if (calculate_structlens(firststruct)) { // error return(1); } /* FOR DEBUG */ if (debugSDNA > 1) { int a,b; /* short *elem; */ short num_types; printf("nr_names %d nr_types %d nr_structs %d\n", nr_names, nr_types, nr_structs); for(a=0; a -1) printf("Writing file ... "); if(nr_names==0 || nr_structs==0); else { strcpy(str, "SDNA"); dna_write(file, str, 4); /* write names */ strcpy(str, "NAME"); dna_write(file, str, 4); len= nr_names; dna_write(file, &len, 4); /* calculate size of datablock with strings */ cp= names[nr_names-1]; cp+= strlen(names[nr_names-1]) + 1; /* +1: null-terminator */ len= (intptr_t) (cp - (char*) names[0]); len= (len+3) & ~3; dna_write(file, names[0], len); /* write TYPES */ strcpy(str, "TYPE"); dna_write(file, str, 4); len= nr_types; dna_write(file, &len, 4); /* calculate datablock size */ cp= types[nr_types-1]; cp+= strlen(types[nr_types-1]) + 1; /* +1: null-terminator */ len= (intptr_t) (cp - (char*) types[0]); len= (len+3) & ~3; dna_write(file, types[0], len); /* WRITE TYPELENGTHS */ strcpy(str, "TLEN"); dna_write(file, str, 4); len= 2*nr_types; if(nr_types & 1) len+= 2; dna_write(file, typelens, len); /* WRITE STRUCTS */ strcpy(str, "STRC"); dna_write(file, str, 4); len= nr_structs; dna_write(file, &len, 4); /* calc datablock size */ sp= structs[nr_structs-1]; sp+= 2+ 2*( sp[1] ); len= (intptr_t) ((char*) sp - (char*) structs[0]); len= (len+3) & ~3; dna_write(file, structs[0], len); /* a simple dna padding test */ if (0) { FILE *fp; int a; fp= fopen("padding.c", "w"); if(fp==NULL); else { // add all include files defined in the global array for (i = 0; strlen(includefiles[i]); i++) { fprintf(fp, "#include \"%s%s\"\n", baseDirectory, includefiles[i]); } fprintf(fp, "main(){\n"); sp = typelens; sp += firststruct; for(a=firststruct; a -1) printf("done.\n"); return(0); } /* ************************* END MAKE DNA ********************** */ static void make_bad_file(char *file, int line) { FILE *fp= fopen(file, "w"); fprintf(fp, "#error \"Error! can't make correct DNA.c file from %s:%d, STUPID!\"\n", __FILE__, line); fclose(fp); } #ifndef BASE_HEADER #define BASE_HEADER "../" #endif int main(int argc, char ** argv) { FILE *file; int return_status = 0; if (argc!=2 && argc!=3) { printf("Usage: %s outfile.c [base directory]\n", argv[0]); return_status = 1; } else { file = fopen(argv[1], "w"); if (!file) { printf ("Unable to open file: %s\n", argv[1]); return_status = 1; } else { char baseDirectory[256]; if (argc==3) { strcpy(baseDirectory, argv[2]); } else { strcpy(baseDirectory, BASE_HEADER); } fprintf (file, "unsigned char DNAstr[]= {\n"); if (make_structDNA(baseDirectory, file)) { // error fclose(file); make_bad_file(argv[1], __LINE__); return_status = 1; } else { fprintf(file, "};\n"); fprintf(file, "int DNAlen= sizeof(DNAstr);\n"); fclose(file); } } } return(return_status); } // include files for automatic dependancies #include "DNA_listBase.h" #include "DNA_vec_types.h" #include "DNA_ID.h" #include "DNA_ipo_types.h" #include "DNA_key_types.h" #include "DNA_text_types.h" #include "DNA_packedFile_types.h" #include "DNA_camera_types.h" #include "DNA_image_types.h" #include "DNA_texture_types.h" #include "DNA_lamp_types.h" #include "DNA_material_types.h" #include "DNA_vfont_types.h" #include "DNA_meta_types.h" #include "DNA_curve_types.h" #include "DNA_mesh_types.h" #include "DNA_meshdata_types.h" #include "DNA_modifier_types.h" #include "DNA_lattice_types.h" #include "DNA_object_types.h" #include "DNA_object_force.h" #include "DNA_object_fluidsim.h" #include "DNA_world_types.h" #include "DNA_scene_types.h" #include "DNA_view3d_types.h" #include "DNA_view2d_types.h" #include "DNA_space_types.h" #include "DNA_userdef_types.h" #include "DNA_screen_types.h" #include "DNA_sdna_types.h" #include "DNA_fileglobal_types.h" #include "DNA_sequence_types.h" #include "DNA_effect_types.h" #include "DNA_outliner_types.h" #include "DNA_property_types.h" #include "DNA_sensor_types.h" #include "DNA_controller_types.h" #include "DNA_actuator_types.h" #include "DNA_sound_types.h" #include "DNA_group_types.h" #include "DNA_armature_types.h" #include "DNA_action_types.h" #include "DNA_constraint_types.h" #include "DNA_nla_types.h" #include "DNA_node_types.h" #include "DNA_color_types.h" #include "DNA_brush_types.h" #include "DNA_customdata_types.h" #include "DNA_particle_types.h" #include "DNA_cloth_types.h" #include "DNA_gpencil_types.h" #include "DNA_windowmanager_types.h" #include "DNA_anim_types.h" #include "DNA_boid_types.h" #include "DNA_smoke_types.h" /* end of list */