2 # perl script expect the following variables to be prepended:
4 # RAWCPP TMPDIR TOP_PWD HscIfaceFileVersion
5 # libdir libexecdir datadir INSTALLING
8 # tries to work like mkdependC - capable of dealing with:
10 # -literate Haskell code (Bird tracks or Glasgow literate style) (.lhs)
11 # -straight Haskell source (.hs)
12 # -literate or straight Happy specs (.ly)
14 # ToDo: strip out all the .h junk
16 ($Pgm = $0) =~ s/.*\/([^\/]+)$/\1/;
18 Usage: $Pgm [mkdependHS options] [-- GHC options --] srcfile1 [srcfile2 ...]
20 Options recognised wherever they occur (mkdependHS or GHC):
22 -D<blah> A cpp #define; usual meaning
23 -i<dirs> Add <dirs> (colon-separated) to list of directories
24 to search for "import"ed modules
25 -I<dir> Add <dir> to list of directories to search for
26 .h files (i.e., usual meaning)
27 -syslib <blah> This program uses this GHC system library; take
28 appropriate action (e.g., recognise when they are
29 "import"ing a module from that library).
31 mkdependHS-specific options (not between --'s):
34 -v -v Be very verbose.
36 -f blah Use "blah" as the makefile, rather than "makefile"
38 -cpp Wash the input files through cpp(1).
39 -o <osuf> Use <osuf> as the "object file" suffix ( default: o)
40 -s <suf> Make extra dependencies for files with
41 suffix <suf><osuf>; thus, "-o hc -s _a" will
42 make dependencies both for .hc files and for .a_hc
43 files. (Useful in conjunction with NoFib "ways".)
44 --exclude-module=<file>
45 Regard <file> as "stable"; i.e., eXclude it from having
47 -x same as --exclude-module
48 --exclude-directory=<dirs>
49 Regard : separated list of directories as containing stable,
50 don't generate any dependencies on modules therein.
51 -Xdirs same as --exclude-directory
53 Regard prelude libraries as unstable, i.e., generate dependencies
54 on prelude modules. This option is normally only used by the
55 various system libraries. If a -syslib option is used, dependencies
56 will also be generated on the library's interfaces.
57 --include-module=<file>
58 Regard <file> as not "stable"; i.e., generate dependencies
59 on it (if any). This option is normally used in conjunction
60 with the --exclude-directory option.
64 $Status = 0; # just used for exit() status
65 $Verbose = 0; # 1 => verbose, 2 => very verbose
66 $Warnings = 1; # 1 => warn about duplicate interface files
70 $Cpp_flag_set = 0; # 1 => run cpp over input files.
72 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
73 $Tmp_prefix = $ENV{'TMPDIR'} . "/mkdependHS$$";
75 $Tmp_prefix ="${TMPDIR}/mkdependHS$$";
76 $ENV{'TMPDIR'} = "${TMPDIR}"; # set the env var as well
79 $TopPwd = "${TOP_PWD}";
80 $InstLibDirGhc = "${libdir}";
81 $InstLibExecDirGhc = "${libexecdir}";
82 $InstDataDirGhc = "${datadir}";
84 $Unlit = ($INSTALLING) ? "${InstLibExecDirGhc}/unlit"
85 : "${TopPwd}/ghc/utils/unlit/unlit";
87 $HiBootVersion = $HscIfaceFileVersion;
88 $hi_boot_with_version = 0;
90 $Begin_magic_str = "# DO NOT DELETE: Beginning of Haskell dependencies\n";
91 $End_magic_str = "# DO NOT DELETE: End of Haskell dependencies\n";
97 %LibIfaces = (); # known prelude/syslib ifaces; read from a file
99 # directories to considered stable.
104 $Include_dirs = '-I.';
107 $Include_prelude = 0;
109 $ProcessingOptions=0;
111 # Delete temp. file if script is halted.
112 sub quit_upon_signal { print STDERR "Deleting $Tmp_prefix.hs .. \n"; unlink "$Tmp_prefix.hs"; }
113 $SIG{'INT'} = 'quit_upon_signal';
114 $SIG{'QUIT'} = 'quit_upon_signal';
116 &mangle_command_line_args(@ARGV);
123 @Import_dirs = split(/:/,$Import_dirs);
124 @Include_dirs = split(/\s+/,$Include_dirs); # still has -I's in it
126 # NB: We keep the scalar-variable equivalents to use in error messages
128 &gather_import_dirs();
130 if ( ! $Makefile && -f 'makefile' ) {
131 $Makefile = 'makefile';
132 } elsif ( ! $Makefile && -f 'Makefile') {
133 $Makefile = 'Makefile';
134 } elsif ( ! $Makefile) {
135 die "$Pgm: no makefile or Makefile found\n";
138 print STDERR "CPP defines=@Defines\n" if $Verbose;
139 print STDERR "Import_dirs=@Import_dirs\n" if $Verbose;
140 print STDERR "Include_dirs=@Include_dirs\n" if $Verbose;
142 &preprocess_import_dirs();
146 foreach $sf (@Src_files) {
148 # just like lit-inputter
149 # except it puts each file through CPP and
150 # a de-commenter (not implemented);
151 # builds up @Depend_lines
152 print STDERR "Here we go for source file: $sf\n" if $Verbose;
153 ($bf = $sf) =~ s/\.l?(hs|y)$//;
156 foreach $obj (@Obj_suffix) {
158 foreach $suff (@File_suffix) {
159 $str .= "$bf.${suff}_$obj ";
162 push(@Depend_lines, "$str: $sf\n");
163 # if it's a literate file, .lhs or .ly? (happy specs), then we de-literatize it:
164 if ( $sf !~ /\.l(hs|y)$/ ) {
167 $file_to_read = "$Tmp_prefix.hs";
168 local($to_do) = "$Unlit $sf $file_to_read";
169 &run_something($to_do, $sf, 'unlit');
171 &slurp_file_for_imports($file_to_read, $sf);
173 # Delete the temporary.
174 if ( $sf =~ /\.l(hs|y)$/ ) {
175 unlink "$Tmp_prefix.hs";
181 # Create backup version of output file.
183 if ( ! -f $Makefile ) {
184 # truncate() may not be implemented, so we
187 open(TRUNC,"> $Makefile.bak") && close(TRUNC);
189 rename($Makefile,"$Makefile.bak");
191 # now copy Makefile.bak into Makefile, rm'ing old dependencies
193 open(OMKF,"< $Makefile.bak") || die "$Pgm: can't open $Makefile.bak: $!\n";
194 open(NMKF,"> $Makefile") || die "$Pgm: can't open $Makefile: $!\n";
197 while ($_ && $_ ne $Begin_magic_str) { # copy through, 'til Begin_magic_str
201 while ($_ && $_ ne $End_magic_str) { # delete 'til End_magic_str
204 # insert dependencies
205 print "$Begin_magic_str", @Depend_lines, $End_magic_str || die "Failed to write out dependencies ($!)";
207 while (<OMKF>) { # copy the rest through
208 print $_ || die "Failed to write out dependencies ($!)";
210 close(NMKF) || exit(1);
211 close(OMKF) || exit(1);
214 sub mangle_command_line_args {
217 while($_ = $Args[0]) {
223 } elsif ( /^-D(.*)/ ) { # recognized wherever they occur
225 } elsif ( /^-cpp$/ ) { # recognized wherever they occur
228 $Import_dirs = ''; # import path cleared!
229 } elsif ( /^-i(.*)/ ) {
230 $Import_dirs = "$1:$Import_dirs";
232 $Include_dirs .= " $_";
233 } elsif ( /^-syslib$/ ) {
234 push(@Syslibs, &grab_arg_arg(*Args,$_,''));
235 } elsif ( /^-fglasgow-exts$/ ) {
236 push(@Syslibs, 'lang');
237 } elsif ( /^-concurrent$/ ) {
238 push(@Syslibs, 'concurrent');
239 } elsif (/^-#include(.*)/) {
240 &grab_arg_arg(*Args,$_,'');
241 } elsif ($Dashdashes_seen != 1) { # not between -- ... --
246 } elsif ( /^-f(.*)/ && !$ProcessingOptions ) {
247 $Makefile = &grab_arg_arg(*Args,'-f',$1);
248 } elsif ( /^-o(.*)/ ) {
249 local($suff) = &grab_arg_arg(*Args,'-o',$1);
250 # Weed out existing entry .. there must be a better way of doing this
251 # with arrays (non-assoc) ! -- sof
252 @Obj_suffix = grep(!/$suff/,@Obj_suffix);
253 push(@Obj_suffix, $suff);
255 # --exclude-module=mod => it's stable, trust me!
257 } elsif ( /^-(x|-exclude-module=)(.*)/ ) {
258 local($thing) = &grab_arg_arg(*Args,$1,$2);
259 $IgnoreMe{$thing} = 'Y';
260 } elsif ( /^-(X|-exclude-directory=)(.*)/ ) {
261 foreach $d ( split(/:/,&grab_arg_arg(*Args,$1, $2)) ) {
262 push(@Ignore_dirs,"$d");
264 } elsif ( /^--include-module=(.*)/ ) {
265 local($thing) = &grab_arg_arg(*Args,$1,$2);
266 $IgnoreMe{$thing} = 'n';
267 } elsif ( /^--include-prelude$/ ) {
268 $Include_prelude = 1;
269 } elsif ( /^-s(.*)/ ) {
270 local($suff) = &grab_arg_arg(*Args,'-s',$1);
271 push(@File_suffix, $suff);
273 if (!$ProcessingOptions) {
274 print STDERR "$Pgm: unknown option ignored: $_\n";
278 push(@Src_files, $_);
281 # Removed support for picking up plausible source file
282 # names inside the ghc options chunk of the command
283 # line. It failed to deal with `option-value' stuff present
284 # on some invocations of ghc (e.g., "-ohi foo.baz").
287 # } elsif ($Dashdashes_seen == 1) {
288 # push(@Src_files, $_) if ! /^-/;
291 @File_suffix = sort (@File_suffix);
295 local(*Args, $option, $rest_of_arg) = @_;
298 return($rest_of_arg);
299 } elsif ($#Args >= 0) {
300 local($temp) = $Args[0]; shift(@Args);
303 print STDERR "$Pgm: no argument following $option option\n";
308 sub gather_import_dirs {
310 # set up array of ignored modules
311 local(@dirs) = ($INSTALLING) ?
312 ("$InstLibDirGhc/imports/std")
313 : ("$TopPwd/ghc/lib/std");
315 if (!$Include_prelude) {
316 push(@Ignore_dirs, @dirs);
318 push(@Import_dirs, @dirs);
321 foreach $lib ( @Syslibs ) {
325 if ( $lib eq 'lang' && ! $INSTALLING ) {
326 push(@Import_dirs, "${TopPwd}/hslibs/${lib}/monads");
328 if ( $lib eq 'text' && ! $INSTALLING ) {
329 push(@Import_dirs, "${TopPwd}/hslibs/${lib}/html");
330 push(@Import_dirs, "${TopPwd}/hslibs/${lib}/haxml/lib");
332 if ( $lib eq 'data' && ! $INSTALLING ) {
333 push(@Import_dirs, "${TopPwd}/hslibs/${lib}/edison");
334 push(@Import_dirs, "${TopPwd}/hslibs/${lib}/edison/Assoc");
335 push(@Import_dirs, "${TopPwd}/hslibs/${lib}/edison/Coll");
336 push(@Import_dirs, "${TopPwd}/hslibs/${lib}/edison/Seq");
340 if ( $lib eq 'win32' && ! $INSTALLING ) {
341 $dir = "${TopPwd}/hslibs/${lib}/src";
342 } elsif ( $lib eq 'com' && ! $INSTALLING ) {
343 $dir = "${TopPwd}/hslibs/lib";
345 $dir = ($INSTALLING) ? "${InstLibDirGhc}/imports/${lib}"
346 : "${TopPwd}/hslibs/${lib}";
348 if (!$Include_prelude) {
349 push(@Ignore_dirs,$dir);
351 push(@Import_dirs, $dir);
358 sub preprocess_import_dirs {
359 # it's probably cheaper to find out what's in all
360 # the @Import_dirs before we start processing.
364 foreach $d ( @Import_dirs ) {
365 # Check to see if it can be ignored
366 #print STDERR "Ignore imports from $d\n" if $Verbose && $Ignore_dirs{$d};
367 #next if $Ignore_dirs{$d};
369 opendir(DIR, $d) || die "$Pgm: can't open directory $d\n";
371 for ($_ = readdir(DIR); $_; $_ = readdir(DIR)) {
372 next unless /(.*)\.hi$/;
375 # dLL_ifs.hi is used to indicate whether a directory
376 # contains interface files whose object codes reside in a Win32 DLL.
378 if ($ModuleIn{$thing} && $ModuleIn{$thing} ne $d && $thing ne 'dLL_ifs') {
379 print STDERR "$Pgm: warning: $thing.hi appears in both $ModuleIn{$thing} and $d!\n" if ($Warnings);
381 $ModuleIn{$thing} = $d;
384 closedir(DIR); # No, don't check the error code
387 # Add all the modules
388 # to the IgnoreMe array before we start scanning for imports.
389 foreach $d (@Ignore_dirs) {
391 opendir(DIR, $d) || die "$Pgm: can't open directory $d\n";
393 for ($_ = readdir(DIR); $_; $_ = readdir(DIR)) {
394 next unless /(.*)\.(hi|l?hs|l?y)$/;
395 #don't tag it twice or overwrite it with a diff. value
396 next if $IgnoreMe{$1};
397 print STDERR "Module $d will be ignored\n" if $Verbose;
401 closedir(DIR); # No, don't check the error code
405 sub slurp_file_for_imports {
406 local($file_to_read, $orig_src_file) = @_;
407 local($follow_file,$read_from_file);
410 local(@Old_Syslibs, $options);
411 local(@Old_Ignore_dirs);
412 local($found_options)=0;
414 local($last_seen_dir) = $orig_src_file;
415 $last_seen_dir =~ s/\/[^\/]+$//; # strip to dir name
416 $last_seen_dir = '.' if ($last_seen_dir eq $orig_src_file);
418 local($mod_name) = $orig_src_file;
420 $mod_name =~ s/.*\/([^\/]+)$/$1/g;
421 $mod_name =~ s/^([^.]+)\.(.*)$/$1/;
423 print STDERR "Warning: processing module $mod_name, which I was supposed to ignore.\n"
424 if ( $IgnoreMe{$mod_name} eq 'Y' && $Warnings );
426 &process_dependency('import',0,'Prelude') if ($Include_prelude);
429 # Check for {-# OPTIONS in the file-to-be-processed. If any syslib related options
430 # *only* are found, add them to the module search list (and take them off once
431 # we're through with this module.)
434 $options = &check_for_source_options($file_to_read);
435 if ($options ne "") {
436 @Old_Syslibs=@Syslibs;
437 $ProcessingOptions=1;
438 &mangle_command_line_args(split(/\s+/,$options));
439 if (@Old_Syslibs ne @Syslibs) {
441 @Old_Ignore_dirs = @Ignore_dirs;
442 &gather_import_dirs();
443 &preprocess_import_dirs();
447 # we mangle #include's so they will also leave something
448 # behind to indicate the dependency on _them_
452 &run_something("${SED} -e '/^# *include/{p;s/^# *include/!include/;}' $file_to_read | $Cpp $Include_dirs -I$last_seen_dir @Defines - 2>&1 > ${file_to_read}.i", $orig_src_file, 'cpp');
453 $read_from_file="${file_to_read}.i";
456 $read_from_file="${file_to_read}";
457 $open_cmd = $file_to_read;
459 print STDERR "$open_cmd\n" if $Verbose;
461 open(SRCFILE, $read_from_file) || die "$Pgm: Can't open $file_to_read: $!\n";
465 # import {-# SOURCE #-} Foo (bar) generates dependencies on the source file only,
466 # the compiler will deal with the absence of Foo.hi by consulting the
467 # source for Foo directly. (for dealing with recursive modules).
469 next unless (/^>?\s*(import)(\s+{-#\s*SOURCE\s*#-})?(\s+qualified)?\s+([A-Z][A-Za-z0-9_']*)/ || /^!(include)(\s+)"(\S+)"/);
471 $source = ( $2 ne '') ? 1 : 0;
474 next if $modname eq '';
475 &process_dependency($todo,$source,$modname);
478 if ($found_options) {
479 @Ignore_dirs = @Old_Ignore_dirs;
482 close(SRCFILE) || exit(1);
483 # remove temporary file, if any.
485 unlink("$read_from_file");
491 sub process_dependency {
492 local($todo,$source,$modname) = @_;
494 if ($todo eq 'import') {
495 if ( $IgnoreMe{$modname} eq 'Y' ) {
496 # user specifically asked for this module
498 $follow_file = '__ignore__';
499 } elsif ( $ModuleIn{$modname} ) {
500 $follow_file = "$ModuleIn{$modname}/$modname.hi";
503 &find_in_Import_dirs($orig_src_file, $modname, $last_seen_dir, $source );
507 = &find_in_Include_dirs($orig_src_file, $modname, $last_seen_dir);
510 if (! $follow_file) { # it didnae find anything
511 die "$orig_src_file: Couldn't handle: $_\n";
513 } else { # it found something
514 if ($follow_file ne '__ignore__') {
515 local($int_file) = $follow_file;
517 if ( $int_file !~ /\.(l?hs|hi|l?y)$/ ) {
519 foreach $obj (@Obj_suffix) {
521 foreach $suff (@File_suffix) {
522 $str .= "$bf.${suff}_$obj ";
525 push(@Depend_lines, "$str: $int_file\n");
527 $int_file =~ s/\.l?hs$//;
528 $int_file =~ s/\.l?y$//;
529 $int_file =~ s/\.hi$//;
533 # if a version specific .hi-boot file exist, use it.
534 if ( -f "$int_file.hi-boot-${HiBootVersion}" ) {
535 $source_dep = "$int_file.hi-boot-${HiBootVersion}";
537 $source_dep = "$int_file.hi-boot";
541 foreach $obj (@Obj_suffix) {
544 push(@Depend_lines, "$str: $int_file.hi\n");
548 foreach $suff (@File_suffix) {
550 foreach $obj (@Obj_suffix) {
551 $str .= "$bf.${suff}_$obj ";
553 push(@Depend_lines, "$str: $int_file.${suff}_hi\n");
557 foreach $obj (@Obj_suffix) {
559 foreach $suff (@File_suffix) {
560 $str .= "$bf.${suff}_$obj ";
563 push(@Depend_lines, "$str: $source_dep\n");
570 # when we see something, we cache that fact ('y').
571 # also, when we get a miss, we cache that (so we don't try later); ('n')
574 sub find_in_Import_dirs {
575 local($orig_src_file, $modname, $last_seen_dir, $source) = @_;
577 local($do_magical_check) = 0;
578 local($name_to_check);
580 # do it the old hard way: hop along Import_dir list
581 foreach $import_dir (@Import_dirs) {
583 if ($import_dir eq '.') {
584 # record that we should do a SPECIAL try for a file in last_seen_dir (LAST)
585 $do_magical_check = 1;
588 $name_to_check = "$import_dir/$modname.hi";
589 if ( $FileExists{$name_to_check} ne 'n' ) { # either 'y' or nothing
590 print STDERR "trying $name_to_check...\n" if $Verbose >= 2; # very verbose
591 return($name_to_check) if $FileExists{$name_to_check} eq 'y';
592 if (-f $name_to_check) {
593 $FileExists{$name_to_check} = 'y';
594 return($name_to_check) ;
596 $FileExists{$name_to_check} = 'n';
600 for $suff ('hs', 'lhs', 'ly', 'y') {
601 $name_to_check = "$import_dir/$modname.$suff";
602 print STDERR "trying... $name_to_check\n" if $Verbose >= 2; # very verbose
603 return($name_to_check) if -f $name_to_check;
607 $name_to_check = "$import_dir/$modname.hi-boot-${HiBootVersion}";
608 print STDERR "trying... $name_to_check\n" if $Verbose >= 2; # very verbose
609 return($name_to_check) if -f $name_to_check;
611 $name_to_check = "$import_dir/$modname.hi-boot";
612 print STDERR "trying... $name_to_check\n" if $Verbose >= 2; # very verbose
613 return($name_to_check) if -f $name_to_check;
616 if ($do_magical_check == 1) {
617 $name_to_check = "$last_seen_dir/$modname.hi";
619 if ( $FileExists{$name_to_check} ne 'n' ) { # either 'y' or nothing
620 print STDERR "trying $name_to_check...\n" if $Verbose >= 2; # very verbose
621 return($name_to_check) if $FileExists{$name_to_check} eq 'y';
622 if (-f $name_to_check) {
623 $FileExists{$name_to_check} = 'y';
624 return($name_to_check) ;
626 $FileExists{$name_to_check} = 'n';
630 for $suff ('lhs', 'hs', 'ly', 'y') {
631 $name_to_check = "$last_seen_dir/$modname.$suff";
632 print STDERR "trying... $name_to_check\n" if $Verbose >= 2; # very verbose
633 return($name_to_check) if -f $name_to_check;
637 # OK, maybe it's referring to something in a system library
638 #foreach $lib ( @Syslibs ) {
639 # return('__ignore__') if $LibIfaces{"$lib:$modname"};
642 # Last hope: referring to a Prelude interface
643 return('__ignore__') if ( $IgnoreMe{$modname} eq 'y' );
645 die "No file `$modname.hi', `$modname.lhs', `$modname.hs' (reqd from file `$orig_src_file')\namong import directories:\n\t$Import_dirs\n";
648 sub find_in_Include_dirs {
649 local($orig_src_file, $name, $last_seen_dir) = @_;
651 local($do_magical_check) = 0;
653 # no funny name guessing here
655 # hop along Include_dir list
656 foreach $include_dir (@Include_dirs) {
657 $include_dir =~ s/^-I//;
660 if ($include_dir eq '.') {
661 # record that we should do a SPECIAL try for a file in last_seen_dir (LAST)
662 $do_magical_check = 1;
664 print STDERR "trying $include_dir/$name...\n" if $Verbose >= 2; # very verbose
665 if (-f "$include_dir/$name") {
666 return("$include_dir/$name");
669 if ($do_magical_check == 1) {
670 print STDERR "trying $last_seen_dir/$name...\n" if $Verbose >= 2; # very verbose
671 if (-f "$last_seen_dir/$name") {
672 return("$last_seen_dir/$name");
675 die "No file `$name' (reqd from file `$orig_src_file') among include directories: $Include_dirs\n";
678 # out of the driver, actually
680 local($str_to_do, $file_to_read, $tidy_name) = @_;
682 print STDERR "\n$tidy_name:\n\t" if $Verbose;
683 print STDERR "$str_to_do\n" if $Verbose;
685 local($return_val) = system($str_to_do) >> 8;
687 if ($return_val != 0) {
688 local($die_msg) = "$Pgm: Running $tidy_name ( on $file_to_read ) failed";
689 $die_msg .= " program not found: $str_to_do " if $return_val == 255;
690 $die_msg .= " ($!)" if $Verbose && $! != 0;
692 print STDERR $die_msg;
697 # out of the driver too.
698 sub check_for_source_options {
700 local($comment_start,$comment_end);
702 # Assume it is a file containing Haskell source
703 $comment_start = "{-#";
704 $comment_end = "#-}";
706 open(FILE,$file) || return ""; # No big loss
709 if ( /^${comment_start} OPTIONS (.*)${comment_end}/ ) {
710 # return the options.
712 print STDERR "Found OPTIONS $stuff in $file\n" if $Verbose;
716 elsif ( /^$/ ) { # ignore empty lines
719 elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
722 elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
725 else { # stop looking, something non-empty / not
726 # ${comment_start} OPTIONS .. ${comment_end} encountered.
727 close(FILE);return "";