2 * Generate include file dependencies
4 * Copyright 1996 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #define NO_LIBWINE_PORT
23 #include "wine/port.h"
35 #include "wine/list.h"
37 /* Max first-level includes per file */
38 #define MAX_INCLUDES 200
40 typedef struct _INCL_FILE
45 char *sourcename; /* source file name for generated headers */
46 struct _INCL_FILE *included_by; /* file that included this one */
47 int included_line; /* line where this file was included */
48 int system; /* is it a system include (#include <name>) */
49 struct _INCL_FILE *owner;
50 struct _INCL_FILE *files[MAX_INCLUDES];
53 static struct list sources = LIST_INIT(sources);
54 static struct list includes = LIST_INIT(includes);
56 typedef struct _INCL_PATH
62 static struct list paths = LIST_INIT(paths);
64 static const char *src_dir;
65 static const char *top_src_dir;
66 static const char *top_obj_dir;
67 static const char *OutputFileName = "Makefile";
68 static const char *Separator = "### Dependencies";
69 static const char *ProgramName;
70 static int input_line;
72 static const char Usage[] =
73 "Usage: %s [options] [files]\n"
75 " -Idir Search for include files in directory 'dir'\n"
76 " -Cdir Search for source files in directory 'dir'\n"
77 " -Sdir Set the top source directory\n"
78 " -Sdir Set the top object directory\n"
79 " -fxxx Store output in file 'xxx' (default: Makefile)\n"
80 " -sxxx Use 'xxx' as separator (default: \"### Dependencies\")\n";
83 /*******************************************************************
86 static void fatal_error( const char *msg, ... )
89 va_start( valist, msg );
90 vfprintf( stderr, msg, valist );
96 /*******************************************************************
99 static void *xmalloc( size_t size )
102 if (!(res = malloc (size ? size : 1)))
103 fatal_error( "%s: Virtual memory exhausted.\n", ProgramName );
108 /*******************************************************************
111 static void *xrealloc (void *ptr, size_t size)
115 if (!(res = realloc( ptr, size )))
116 fatal_error( "%s: Virtual memory exhausted.\n", ProgramName );
120 /*******************************************************************
123 static char *xstrdup( const char *str )
125 char *res = strdup( str );
126 if (!res) fatal_error( "%s: Virtual memory exhausted.\n", ProgramName );
131 /*******************************************************************
134 static char *strmake( const char* fmt, ... )
142 char *p = xmalloc (size);
144 n = vsnprintf (p, size, fmt, ap);
146 if (n == -1) size *= 2;
147 else if ((size_t)n >= size) size = n + 1;
154 /*******************************************************************
157 static int strendswith( const char* str, const char* end )
162 return l >= m && strcmp(str + l - m, end) == 0;
165 /*******************************************************************
168 static char *get_extension( char *filename )
170 char *ext = strrchr( filename, '.' );
171 if (ext && strchr( ext, '/' )) ext = NULL;
176 /*******************************************************************
179 static char *get_line( FILE *file )
182 static unsigned int size;
187 buffer = xmalloc( size );
189 if (!fgets( buffer, size, file )) return NULL;
194 char *p = buffer + strlen(buffer);
195 /* if line is larger than buffer, resize buffer */
196 while (p == buffer + size - 1 && p[-1] != '\n')
198 buffer = xrealloc( buffer, size * 2 );
199 fgets( buffer + size - 1, size + 1, file );
200 p = buffer + strlen(buffer);
203 if (p > buffer && p[-1] == '\n')
206 if (p > buffer && p[-1] == '\r') *(--p) = 0;
207 if (p > buffer && p[-1] == '\\')
210 /* line ends in backslash, read continuation line */
211 fgets( p, size - (p - buffer), file );
220 /*******************************************************************
223 * Add a directory to the include path.
225 static void add_include_path( const char *name )
227 INCL_PATH *path = xmalloc( sizeof(*path) );
228 list_add_tail( &paths, &path->entry );
232 /*******************************************************************
235 static INCL_FILE *find_src_file( const char *name )
239 LIST_FOR_EACH_ENTRY( file, &sources, INCL_FILE, entry )
240 if (!strcmp( name, file->name )) return file;
244 /*******************************************************************
247 * Add a source file to the list.
249 static INCL_FILE *add_src_file( const char *name )
253 if (find_src_file( name )) return NULL; /* we already have it */
254 file = xmalloc( sizeof(*file) );
255 memset( file, 0, sizeof(*file) );
256 file->name = xstrdup(name);
257 list_add_tail( &sources, &file->entry );
262 /*******************************************************************
265 * Add an include file if it doesn't already exists.
267 static INCL_FILE *add_include( INCL_FILE *pFile, const char *name, int line, int system )
273 for (pos = 0; pos < MAX_INCLUDES; pos++) if (!pFile->files[pos]) break;
274 if (pos >= MAX_INCLUDES)
275 fatal_error( "%s: %s: too many included files, please fix MAX_INCLUDES\n",
276 ProgramName, pFile->name );
278 /* enforce some rules for the Wine tree */
280 if (!memcmp( name, "../", 3 ))
281 fatal_error( "%s:%d: #include directive with relative path not allowed\n",
282 pFile->filename, line );
284 if (!strcmp( name, "config.h" ))
286 if ((ext = strrchr( pFile->filename, '.' )) && !strcmp( ext, ".h" ))
287 fatal_error( "%s:%d: config.h must not be included by a header file\n",
288 pFile->filename, line );
290 fatal_error( "%s:%d: config.h must be included before anything else\n",
291 pFile->filename, line );
293 else if (!strcmp( name, "wine/port.h" ))
295 if ((ext = strrchr( pFile->filename, '.' )) && !strcmp( ext, ".h" ))
296 fatal_error( "%s:%d: wine/port.h must not be included by a header file\n",
297 pFile->filename, line );
298 if (!pos) fatal_error( "%s:%d: config.h must be included before wine/port.h\n",
299 pFile->filename, line );
301 fatal_error( "%s:%d: wine/port.h must be included before everything except config.h\n",
302 pFile->filename, line );
303 if (strcmp( pFile->files[0]->name, "config.h" ))
304 fatal_error( "%s:%d: config.h must be included before wine/port.h\n",
305 pFile->filename, line );
308 LIST_FOR_EACH_ENTRY( include, &includes, INCL_FILE, entry )
309 if (!strcmp( name, include->name )) goto found;
311 include = xmalloc( sizeof(INCL_FILE) );
312 memset( include, 0, sizeof(INCL_FILE) );
313 include->name = xstrdup(name);
314 include->included_by = pFile;
315 include->included_line = line;
316 include->system = system;
317 list_add_tail( &includes, &include->entry );
319 pFile->files[pos] = include;
324 /*******************************************************************
327 static FILE *open_src_file( INCL_FILE *pFile )
331 /* first try name as is */
332 if ((file = fopen( pFile->name, "r" )))
334 pFile->filename = xstrdup( pFile->name );
337 /* now try in source dir */
340 pFile->filename = strmake( "%s/%s", src_dir, pFile->name );
341 file = fopen( pFile->filename, "r" );
345 perror( pFile->name );
352 /*******************************************************************
355 static FILE *open_include_file( INCL_FILE *pFile )
363 /* check for generated bison header */
365 if (strendswith( pFile->name, ".tab.h" ))
368 filename = strmake( "%s/%.*s.y", src_dir, strlen(pFile->name) - 6, pFile->name );
370 filename = strmake( "%.*s.y", strlen(pFile->name) - 6, pFile->name );
372 if ((file = fopen( filename, "r" )))
374 pFile->sourcename = filename;
375 pFile->filename = xstrdup( pFile->name );
376 /* don't bother to parse it */
383 /* check for generated message resource */
385 if (strendswith( pFile->name, ".mc.rc" ))
388 filename = strmake( "%s/%s", src_dir, pFile->name );
390 filename = xstrdup( pFile->name );
392 filename[strlen(filename) - 3] = 0;
394 if ((file = fopen( filename, "r" )))
396 pFile->sourcename = filename;
397 pFile->filename = xstrdup( pFile->name );
398 /* don't bother to parse it */
405 /* check for corresponding idl file in source dir */
407 if (strendswith( pFile->name, ".h" ))
410 filename = strmake( "%s/%.*s.idl", src_dir, strlen(pFile->name) - 2, pFile->name );
412 filename = strmake( "%.*s.idl", strlen(pFile->name) - 2, pFile->name );
414 if ((file = fopen( filename, "r" )))
416 pFile->sourcename = filename;
417 pFile->filename = xstrdup( pFile->name );
423 /* first try name as is */
424 if ((file = fopen( pFile->name, "r" )))
426 pFile->filename = xstrdup( pFile->name );
430 /* now try in source dir */
433 filename = strmake( "%s/%s", src_dir, pFile->name );
434 if ((file = fopen( filename, "r" ))) goto found;
438 /* check for corresponding idl file in global includes */
440 if (strendswith( pFile->name, ".h" ))
443 filename = strmake( "%s/include/%.*s.idl",
444 top_src_dir, strlen(pFile->name) - 2, pFile->name );
445 else if (top_obj_dir)
446 filename = strmake( "%s/include/%.*s.idl",
447 top_obj_dir, strlen(pFile->name) - 2, pFile->name );
451 if (filename && (file = fopen( filename, "r" )))
453 pFile->sourcename = filename;
454 pFile->filename = strmake( "%s/include/%s", top_obj_dir, pFile->name );
460 /* now try in global includes */
463 filename = strmake( "%s/include/%s", top_obj_dir, pFile->name );
464 if ((file = fopen( filename, "r" ))) goto found;
469 filename = strmake( "%s/include/%s", top_src_dir, pFile->name );
470 if ((file = fopen( filename, "r" ))) goto found;
474 /* now search in include paths */
475 LIST_FOR_EACH_ENTRY( path, &paths, INCL_PATH, entry )
477 filename = strmake( "%s/%s", path->name, pFile->name );
478 if ((file = fopen( filename, "r" ))) goto found;
481 if (pFile->system) return NULL; /* ignore system files we cannot find */
483 /* try in src file directory */
484 if ((p = strrchr(pFile->included_by->filename, '/')))
486 int l = p - pFile->included_by->filename + 1;
487 filename = xmalloc(l + strlen(pFile->name) + 1);
488 memcpy( filename, pFile->included_by->filename, l );
489 strcpy( filename + l, pFile->name );
490 if ((file = fopen( filename, "r" ))) goto found;
494 perror( pFile->name );
495 while (pFile->included_by)
497 const char *parent = pFile->included_by->sourcename;
498 if (!parent) parent = pFile->included_by->name;
499 fprintf( stderr, " %s was first included from %s:%d\n",
500 pFile->name, parent, pFile->included_line );
501 pFile = pFile->included_by;
506 pFile->filename = filename;
511 /*******************************************************************
514 * If for_h_file is non-zero, it means we are not interested in the idl file
515 * itself, but only in the contents of the .h file that will be generated from it.
517 static void parse_idl_file( INCL_FILE *pFile, FILE *file, int for_h_file )
519 char *buffer, *include;
523 /* generated .h file always includes these */
524 add_include( pFile, "rpc.h", 0, 1 );
525 add_include( pFile, "rpcndr.h", 0, 1 );
529 while ((buffer = get_line( file )))
533 while (*p && isspace(*p)) p++;
535 if (!strncmp( p, "import", 6 ))
538 while (*p && isspace(*p)) p++;
539 if (*p != '"') continue;
541 while (*p && (*p != '"')) p++;
542 if (!*p) fatal_error( "%s:%d: Malformed import directive\n", pFile->filename, input_line );
544 if (for_h_file && strendswith( include, ".idl" )) strcpy( p - 4, ".h" );
545 add_include( pFile, include, input_line, 0 );
549 if (for_h_file) /* only check for #include inside cpp_quote */
551 if (strncmp( p, "cpp_quote", 9 )) continue;
553 while (*p && isspace(*p)) p++;
554 if (*p++ != '(') continue;
555 while (*p && isspace(*p)) p++;
556 if (*p++ != '"') continue;
557 if (*p++ != '#') continue;
558 while (*p && isspace(*p)) p++;
559 if (strncmp( p, "include", 7 )) continue;
561 while (*p && isspace(*p)) p++;
562 if (*p == '\\' && p[1] == '"')
569 if (*p++ != '<' ) continue;
573 while (*p && (*p != quote)) p++;
574 if (!*p || (quote == '"' && p[-1] != '\\'))
575 fatal_error( "%s:%d: Malformed #include directive inside cpp_quote\n",
576 pFile->filename, input_line );
577 if (quote == '"') p--; /* remove backslash */
579 add_include( pFile, include, input_line, (quote == '>') );
583 /* check for normal #include */
584 if (*p++ != '#') continue;
585 while (*p && isspace(*p)) p++;
586 if (strncmp( p, "include", 7 )) continue;
588 while (*p && isspace(*p)) p++;
589 if (*p != '\"' && *p != '<' ) continue;
591 if (quote == '<') quote = '>';
593 while (*p && (*p != quote)) p++;
594 if (!*p) fatal_error( "%s:%d: Malformed #include directive\n", pFile->filename, input_line );
596 add_include( pFile, include, input_line, (quote == '>') );
600 /*******************************************************************
603 static void parse_c_file( INCL_FILE *pFile, FILE *file )
605 char *buffer, *include;
608 while ((buffer = get_line( file )))
612 while (*p && isspace(*p)) p++;
613 if (*p++ != '#') continue;
614 while (*p && isspace(*p)) p++;
615 if (strncmp( p, "include", 7 )) continue;
617 while (*p && isspace(*p)) p++;
618 if (*p != '\"' && *p != '<' ) continue;
620 if (quote == '<') quote = '>';
622 while (*p && (*p != quote)) p++;
623 if (!*p) fatal_error( "%s:%d: Malformed #include directive\n",
624 pFile->filename, input_line );
626 add_include( pFile, include, input_line, (quote == '>') );
631 /*******************************************************************
634 static void parse_rc_file( INCL_FILE *pFile, FILE *file )
636 char *buffer, *include;
639 while ((buffer = get_line( file )))
643 while (*p && isspace(*p)) p++;
645 if (p[0] == '/' && p[1] == '*') /* check for magic makedep comment */
648 while (*p && isspace(*p)) p++;
649 if (strncmp( p, "@makedep:", 9 )) continue;
651 while (*p && isspace(*p)) p++;
656 while (*p && *p != quote) p++;
661 while (*p && !isspace(*p) && *p != '*') p++;
664 fatal_error( "%s:%d: Malformed makedep comment\n", pFile->filename, input_line );
667 else /* check for #include */
669 if (*p++ != '#') continue;
670 while (*p && isspace(*p)) p++;
671 if (strncmp( p, "include", 7 )) continue;
673 while (*p && isspace(*p)) p++;
674 if (*p != '\"' && *p != '<' ) continue;
676 if (quote == '<') quote = '>';
678 while (*p && (*p != quote)) p++;
679 if (!*p) fatal_error( "%s:%d: Malformed #include directive\n",
680 pFile->filename, input_line );
683 add_include( pFile, include, input_line, (quote == '>') );
688 /*******************************************************************
689 * parse_generated_idl
691 static void parse_generated_idl( INCL_FILE *source )
693 char *header, *basename;
695 basename = xstrdup( source->name );
696 basename[strlen(basename) - 4] = 0;
697 header = strmake( "%s.h", basename );
698 source->filename = xstrdup( source->name );
700 if (strendswith( source->name, "_c.c" ))
702 add_include( source, header, 0, 0 );
704 else if (strendswith( source->name, "_i.c" ))
706 add_include( source, "rpc.h", 0, 1 );
707 add_include( source, "rpcndr.h", 0, 1 );
708 add_include( source, "guiddef.h", 0, 1 );
710 else if (strendswith( source->name, "_p.c" ))
712 add_include( source, "objbase.h", 0, 1 );
713 add_include( source, "rpcproxy.h", 0, 1 );
714 add_include( source, header, 0, 0 );
716 else if (strendswith( source->name, "_s.c" ))
718 add_include( source, header, 0, 0 );
725 /*******************************************************************
728 static void parse_file( INCL_FILE *pFile, int src )
732 /* special case for source files generated from idl */
733 if (strendswith( pFile->name, "_c.c" ) ||
734 strendswith( pFile->name, "_i.c" ) ||
735 strendswith( pFile->name, "_p.c" ) ||
736 strendswith( pFile->name, "_s.c" ))
738 parse_generated_idl( pFile );
742 file = src ? open_src_file( pFile ) : open_include_file( pFile );
745 if (pFile->sourcename && strendswith( pFile->sourcename, ".idl" ))
746 parse_idl_file( pFile, file, 1 );
747 else if (strendswith( pFile->filename, ".idl" ))
748 parse_idl_file( pFile, file, 0 );
749 else if (strendswith( pFile->filename, ".c" ) ||
750 strendswith( pFile->filename, ".h" ) ||
751 strendswith( pFile->filename, ".l" ) ||
752 strendswith( pFile->filename, ".y" ))
753 parse_c_file( pFile, file );
754 else if (strendswith( pFile->filename, ".rc" ))
755 parse_rc_file( pFile, file );
760 /*******************************************************************
763 static void output_include( FILE *file, INCL_FILE *pFile,
764 INCL_FILE *owner, int *column )
768 if (pFile->owner == owner) return;
769 if (!pFile->filename) return;
770 pFile->owner = owner;
771 if (*column + strlen(pFile->filename) + 1 > 70)
773 fprintf( file, " \\\n" );
776 fprintf( file, " %s", pFile->filename );
777 *column += strlen(pFile->filename) + 1;
778 for (i = 0; i < MAX_INCLUDES; i++)
779 if (pFile->files[i]) output_include( file, pFile->files[i],
784 /*******************************************************************
787 static void output_src( FILE *file, INCL_FILE *pFile, int *column )
789 char *obj = xstrdup( pFile->name );
790 char *ext = get_extension( obj );
794 if (!strcmp( ext, "y" )) /* yacc file */
796 *column += fprintf( file, "%s.tab.o: %s.tab.c", obj, obj );
798 else if (!strcmp( ext, "l" )) /* lex file */
800 *column += fprintf( file, "%s.yy.o: %s.yy.c", obj, obj );
802 else if (!strcmp( ext, "rc" )) /* resource file */
804 *column += fprintf( file, "%s.res: %s", obj, pFile->filename );
806 else if (!strcmp( ext, "mc" )) /* message file */
808 *column += fprintf( file, "%s.mc.rc: %s", obj, pFile->filename );
810 else if (!strcmp( ext, "idl" )) /* IDL file */
814 *column += fprintf( file, "%s.h", obj );
816 name = strmake( "%s_c.c", obj );
817 if (find_src_file( name )) *column += fprintf( file, " %s", name );
819 name = strmake( "%s_i.c", obj );
820 if (find_src_file( name )) *column += fprintf( file, " %s", name );
822 name = strmake( "%s_p.c", obj );
823 if (find_src_file( name )) *column += fprintf( file, " %s", name );
825 name = strmake( "%s_s.c", obj );
826 if (find_src_file( name )) *column += fprintf( file, " %s", name );
829 *column += fprintf( file, ": %s", pFile->filename );
833 *column += fprintf( file, "%s.o: %s", obj, pFile->filename );
840 /*******************************************************************
841 * output_dependencies
843 static void output_dependencies(void)
850 if (Separator && ((file = fopen( OutputFileName, "r+" ))))
852 while ((buffer = get_line( file )))
854 if (strncmp( buffer, Separator, strlen(Separator) )) continue;
855 ftruncate( fileno(file), ftell(file) );
856 fseek( file, 0L, SEEK_END );
862 if (!(file = fopen( OutputFileName, Separator ? "a" : "w" )))
864 perror( OutputFileName );
868 LIST_FOR_EACH_ENTRY( pFile, &sources, INCL_FILE, entry )
871 output_src( file, pFile, &column );
872 for (i = 0; i < MAX_INCLUDES; i++)
873 if (pFile->files[i]) output_include( file, pFile->files[i],
875 fprintf( file, "\n" );
881 /*******************************************************************
884 static void parse_option( const char *opt )
889 if (opt[2]) add_include_path( opt + 2 );
895 top_src_dir = opt + 2;
898 top_obj_dir = opt + 2;
901 if (opt[2]) OutputFileName = opt + 2;
904 if (opt[2]) Separator = opt + 2;
905 else Separator = NULL;
908 fprintf( stderr, "Unknown option '%s'\n", opt );
909 fprintf( stderr, Usage, ProgramName );
915 /*******************************************************************
918 int main( int argc, char *argv[] )
921 INCL_PATH *path, *next;
924 ProgramName = argv[0];
929 if (argv[i][0] == '-')
931 parse_option( argv[i] );
932 for (j = i; j < argc; j++) argv[j] = argv[j+1];
938 /* ignore redundant source paths */
939 if (src_dir && !strcmp( src_dir, "." )) src_dir = NULL;
940 if (top_src_dir && top_obj_dir && !strcmp( top_src_dir, top_obj_dir )) top_src_dir = NULL;
942 /* get rid of absolute paths that don't point into the source dir */
943 LIST_FOR_EACH_ENTRY_SAFE( path, next, &paths, INCL_PATH, entry )
945 if (path->name[0] != '/') continue;
948 if (!strncmp( path->name, top_src_dir, strlen(top_src_dir) ) &&
949 path->name[strlen(top_src_dir)] == '/') continue;
951 list_remove( &path->entry );
955 for (i = 1; i < argc; i++)
957 if ((pFile = add_src_file( argv[i] ))) parse_file( pFile, 1 );
959 LIST_FOR_EACH_ENTRY( pFile, &includes, INCL_FILE, entry ) parse_file( pFile, 0 );
960 output_dependencies();