[project @ 1998-02-25 12:17:06 by sof]
[ghc-hetmet.git] / ghc / utils / mkdependHS / mkdependHS.prl
1 #
2 # perl script expect the following variables to be prepended:
3 #
4 #  RAWCPP TMPDIR TOP_PWD
5 #  libdir libexecdir datadir INSTALLING
6 #  ProjectVersionInt SED 
7 #
8 # tries to work like mkdependC - capable of dealing with:
9 #
10 #  -literate Haskell code (Bird tracks or Glasgow literate style) (.lhs)
11 #  -straight Haskell source (.hs)
12 #  -literate or straight Happy specs    (.ly)
13 #  
14 # ToDo: strip out all the .h junk
15 #
16 ($Pgm = $0) =~ s/.*\/([^\/]+)$/\1/;
17 $Usage  = <<EOUSAGE;
18 Usage: $Pgm [mkdependHS options] [-- GHC options --] srcfile1 [srcfile2 ...]
19
20 Options recognised wherever they occur (mkdependHS or GHC):
21
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).
30
31 mkdependHS-specific options (not between --'s):
32
33     -v          Be verbose.
34     -v -v       Be very verbose.
35     -w          No warnings
36     -f blah     Use "blah" as the makefile, rather than "makefile"
37                 or "Makefile".
38     -o <osuf>   Use <osuf> as the "object file" suffix ( default: o)
39     -s <suf>    Make extra dependencies for files with
40                 suffix <suf><osuf>; thus, "-o hc -s _a" will
41                 make dependencies both for .hc files and for .a_hc
42                 files.  (Useful in conjunction with NoFib "ways".)
43     --exclude-module=<file> 
44                 Regard <file> as "stable"; i.e., eXclude it from having
45                 dependencies on it.
46     -x          same as --exclude-module
47     --exclude-directory=<dirs> 
48                 Regard : separated list of directories as containing stable,
49                 don't generate any dependencies on modules therein.
50     -Xdirs      same as --exclude-directory
51     --include-prelude
52                 Regard prelude libraries as unstable, i.e., generate dependencies
53                 on prelude modules. This option is normally only used by the
54                 various system libraries. If a -syslib option is used, dependencies
55                 will also be generated on the library's interfaces.
56     --include-module=<file> 
57                 Regard <file> as not "stable"; i.e., generate dependencies
58                 on it (if any). This option is normally used in conjunction 
59                 with the --exclude-directory option.
60
61 EOUSAGE
62
63 $Status     = 0; # just used for exit() status
64 $Verbose    = 0; # 1 => verbose, 2 => very verbose
65 $Warnings   = 1; # 1 => warn about duplicate interface files
66 $Dashdashes_seen = 0;
67
68 $Cpp = ${RAWCPP};
69
70 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
71     $Tmp_prefix = $ENV{'TMPDIR'} . "/mkdependHS$$";
72 } else {
73     $Tmp_prefix ="${TMPDIR}/mkdependHS$$";
74     $ENV{'TMPDIR'} = "${TMPDIR}"; # set the env var as well
75 }
76
77 $TopPwd            = "${TOP_PWD}";
78 $InstLibDirGhc     = "${libdir}";
79 $InstLibExecDirGhc = "${libexecdir}";
80 $InstHsLibDirGhc   = "${libdir}/hslibs";
81 $InstDataDirGhc    = "${datadir}";
82
83 $Unlit = ($INSTALLING) ? "${InstLibExecDirGhc}/unlit" 
84                        : "${TopPwd}/ghc/utils/unlit/unlit";
85
86 $Begin_magic_str = "# DO NOT DELETE: Beginning of Haskell dependencies\n";
87 $End_magic_str = "# DO NOT DELETE: End of Haskell dependencies\n";
88 @Obj_suffix =  ("o");
89 @File_suffix = ();
90 $ghc_version_info = ${ProjectVersionInt};
91
92 $Import_dirs = '.';
93 %Syslibs = ();
94 %LibIfaces  = ();  # known prelude/syslib ifaces; read from a file
95 %IgnoreMe = ();
96 # directories to considered stable.
97 @Ignore_dirs = ();
98
99 $Include_dirs = '-I.';
100 $Makefile = '';
101 @Src_files = ();
102 $Include_prelude = 0;
103
104 &mangle_command_line_args();
105
106 if ( $Status ) {
107     print stderr $Usage;
108     exit(1);
109 }
110
111 push(@Defines,
112      ( #OLD: "-D__HASKELL1__=$Haskell_1",
113       "-D__GLASGOW_HASKELL__=$ghc_version_info"));
114
115 @Import_dirs  = split(/:/,$Import_dirs);
116 @Include_dirs = split(/\s+/,$Include_dirs); # still has -I's in it
117
118 # set up array of ignored modules
119 local(@dirs) = ($INSTALLING) ? 
120                ("$InstLibDirGhc/imports/std")
121              : ("$TopPwd/ghc/lib/std");
122 if (!$Include_prelude) {
123     push(@Ignore_dirs, @dirs);
124 } else {
125     push(@Import_dirs, @dirs);
126 }
127
128 foreach $lib ( @Syslibs ) {
129     local($dir) = 
130       ($INSTALLING) ? "${InstLibDirGhc}/imports/${lib}" 
131                     : "${TopPwd}/ghc/lib/${lib}";
132     if (!$Include_prelude) {
133        push(@Ignore_dirs,$dir);
134     } else {
135        push(@Import_dirs, @dirs);
136     }
137 }
138
139
140 # NB: We keep the scalar-variable equivalents to use in error messages
141
142 if ( ! $Makefile && -f 'makefile' ) {
143     $Makefile = 'makefile';
144 } elsif ( ! $Makefile && -f 'Makefile') {
145     $Makefile = 'Makefile';
146 } elsif ( ! $Makefile) {
147     die "$Pgm: no makefile or Makefile found\n";
148 }
149
150 print STDERR "CPP defines=@Defines\n" if $Verbose;
151 print STDERR "Import_dirs=@Import_dirs\n" if $Verbose;
152 print STDERR "Include_dirs=@Include_dirs\n" if $Verbose;
153
154 &preprocess_import_dirs();
155
156 @Depend_lines = ();
157
158 # Delete temp. file if script is halted.
159 sub quit_upon_signal { print STDERR "Deleting $Tmp_prefix.hs .. \n"; unlink "$Tmp_prefix.hs"; }
160 $SIG{'INT'}  = 'quit_upon_signal';
161 $SIG{'QUIT'} = 'quit_upon_signal';
162
163 foreach $sf (@Src_files) {
164
165     # just like lit-inputter
166     # except it puts each file through CPP and
167     # a de-commenter (not implemented);
168     # builds up @Depend_lines
169     print STDERR "Here we go for source file: $sf\n" if $Verbose;
170     ($bf = $sf) =~ s/\.l?(hs|y)$//;
171
172     local($str)="";
173     foreach $obj  (@Obj_suffix) {
174         $str .= "$bf.$obj ";
175         foreach $suff (@File_suffix) {
176            $str .= "$bf.${suff}_$obj ";
177         }
178     }
179     push(@Depend_lines, "$str: $sf\n");
180     # if it's a literate file, .lhs or .ly? (happy specs), then we de-literatize it: 
181     if ( $sf !~ /\.l(hs|y)$/ ) {
182         $file_to_read = $sf;
183     } else {
184         $file_to_read = "$Tmp_prefix.hs";
185         local($to_do) = "$Unlit $sf $file_to_read";
186         &run_something($to_do, 'unlit');
187     }
188     &slurp_file_for_imports($file_to_read, $sf);
189
190     if ( $sf =~ /\.l(hs|y)$/ ) {
191         unlink "$Tmp_prefix.hs";
192     }
193 }
194
195
196 #
197 # Create backup version of output file.
198
199 if ( ! -f $Makefile ) {
200    # truncate() may not be implemented, so we
201    # play it safe here.
202    local(*TRUNC);
203    open(TRUNC,"> $Makefile.bak") && close(TRUNC);
204 } else {
205    rename($Makefile,"$Makefile.bak");
206 }
207 # now copy Makefile.bak into Makefile, rm'ing old dependencies
208 # and adding the new
209 open(OMKF,"< $Makefile.bak") || die "$Pgm: can't open $Makefile.bak: $!\n";
210 open(NMKF,"> $Makefile") || die "$Pgm: can't open $Makefile: $!\n";
211 select(NMKF);
212 $_ = <OMKF>;
213 while ($_ && $_ ne $Begin_magic_str) { # copy through, 'til Begin_magic_str
214     print $_;
215     $_ = <OMKF>;
216 }
217 while ($_ && $_ ne $End_magic_str) { # delete 'til End_magic_str
218     $_ = <OMKF>;
219 }
220 # insert dependencies
221 print "\n$Begin_magic_str", @Depend_lines, $End_magic_str || die "Failed to write out dependencies ($!)";
222
223 while (<OMKF>) { # copy the rest through
224     print $_ || die "Failed to write out dependencies ($!)";
225 }
226 close(NMKF) || exit(1);
227 close(OMKF) || exit(1);
228 exit 0;
229
230 sub mangle_command_line_args {
231     while($_ = $ARGV[0]) {
232         shift(@ARGV);
233
234         if ( /^--$/ ) {
235             $Dashdashes_seen++;
236
237         } elsif ( /^-D(.*)/ ) { # recognized wherever they occur
238             push(@Defines, $_);
239         } elsif ( /^-i$/ ) {
240             $Import_dirs = ''; # import path cleared!
241         } elsif ( /^-i(.*)/ ) {
242             $Import_dirs = "$1:$Import_dirs";
243         } elsif ( /^-I/ ) {
244             $Include_dirs .= " $_";
245         } elsif ( /^-syslib$/ ) {
246             push(@Syslibs, &grab_arg_arg($_,''));
247         } elsif ( /^-fglasgow-exts$/ ) {
248             push(@Syslibs, 'exts');
249         } elsif ($Dashdashes_seen != 1) { # not between -- ... --
250             if ( /^-v$/ ) {
251                 $Verbose++;
252             } elsif ( /^-w$/ ) {
253                 $Warnings     = 0;
254             } elsif ( /^-f(.*)/ ) {
255                 $Makefile       = &grab_arg_arg('-f',$1);
256             } elsif ( /^-o(.*)/ ) {
257                 local($suff)    = &grab_arg_arg('-o',$1);
258                 # Weed out existing entry .. there must be a better way of doing this
259                 # with arrays (non-assoc) ! -- sof
260                 @Obj_suffix     = grep(!/$suff/,@Obj_suffix);
261                 push(@Obj_suffix, $suff);
262             #
263             # --exclude-module=mod => it's stable, trust me!
264             
265             } elsif ( /^-(x|-exclude-module=)(.*)/ ) { 
266                 local($thing) = &grab_arg_arg($1,$2);
267                 $IgnoreMe{$thing} = 'y';
268             } elsif ( /^-(X|-exclude-directory=)(.*)/ ) { 
269                 foreach $d ( split(/:/,&grab_arg_arg($1, $2)) ) {
270                    push(@Ignore_dirs,"$d");
271                 }
272             } elsif ( /^--include-module=(.*)/ ) { 
273                 local($thing) = &grab_arg_arg($1,$2);
274                 $IgnoreMe{$thing} = 'n';
275             } elsif ( /^--include-prelude$/ ) { 
276                 $Include_prelude = 1;
277             } elsif ( /^-s(.*)/ ) {
278                 local($suff)    =  &grab_arg_arg('-s',$1);
279                 push(@File_suffix, $suff);
280             } elsif ( /^-/ ) {
281                 print STDERR "$Pgm: unknown option ignored: $_\n";
282                 $Status++;
283             } else {
284                 push(@Src_files, $_);
285             }
286         }
287         # Removed support for picking up plausible source file 
288         # names inside the ghc options chunk of the command
289         # line. It failed to deal with `option-value' stuff present
290         # on some invocations of ghc (e.g., "-ohi foo.baz").
291         #  -- sof 12/97
292         #
293         # } elsif ($Dashdashes_seen == 1) {
294         #     push(@Src_files, $_) if ! /^-/;
295         # }
296     }
297     @File_suffix = sort (@File_suffix);
298 }
299
300 sub grab_arg_arg {
301     local($option, $rest_of_arg) = @_;
302     
303     if ($rest_of_arg) {
304         return($rest_of_arg);
305     } elsif ($#ARGV >= 0) {
306         local($temp) = $ARGV[0]; shift(@ARGV); 
307         return($temp);
308     } else {
309         print STDERR "$Pgm: no argument following $option option\n";
310         $Status++;
311     }
312 }
313
314 sub preprocess_import_dirs {
315     # it's probably cheaper to find out what's in all
316     # the @Import_dirs before we start processing.
317     local($d, $thing);
318     local($_);
319     %ModuleIn = ();
320
321     foreach $d ( @Import_dirs ) {
322         # Check to see if it can be ignored
323         #print STDERR "Ignore imports from $d\n" if $Verbose && $Ignore_dirs{$d};
324         #next if $Ignore_dirs{$d};
325
326         opendir(DIR, $d) || die "$Pgm: can't open directory $d\n";
327
328         for ($_ = readdir(DIR); $_; $_ = readdir(DIR)) {
329             next unless /(.*)\.hi$/;
330             $thing = $1;
331             if ($ModuleIn{$thing} && $ModuleIn{$thing} ne $d) {
332                 print STDERR "$Pgm: warning: $thing.hi appears in both $ModuleIn{$thing} and $d!\n" if ($Warnings);
333             } else {
334                 $ModuleIn{$thing} = $d;
335             }
336         }
337         closedir(DIR); # No, don't check the error code
338     }
339
340     # Add all the modules
341     # to the IgnoreMe array before we start scanning for imports.
342     foreach $d (@Ignore_dirs) {
343
344         opendir(DIR, $d) || die "$Pgm: can't open directory $d\n";
345
346         for ($_ = readdir(DIR); $_; $_ = readdir(DIR)) {
347             next unless /(.*)\.(hi|l?hs|l?y)$/;
348             #don't tag it twice or overwrite it with a diff. value
349             next if $IgnoreMe{$1};
350             print STDERR "Module $d/$1.$2 will be ignored\n" if $Verbose;
351
352             $IgnoreMe{$1} = 'y';
353         }
354         closedir(DIR); # No, don't check the error code
355     }
356 }
357
358 sub slurp_file_for_imports {
359     local($file_to_read, $orig_src_file) = @_;
360     local($follow_file);
361
362     local($last_seen_dir) = $orig_src_file;
363     $last_seen_dir =~ s/\/[^\/]+$//; # strip to dir name
364     $last_seen_dir = '.' if ($last_seen_dir eq $orig_src_file);
365
366     &process_dependency('import',0,'Prelude') if ($Include_prelude);
367
368     # we mangle #include's so they will also leave something
369     # behind to indicate the dependency on _them_
370     
371     print STDERR "${SED} -e '/^# *include/{p;s/^# *include/!include/;};s/'\\''//g;s/\"//g' $file_to_read | $Cpp $Include_dirs -I$last_seen_dir @Defines |\n" if $Verbose;
372
373     open(SRCFILE, "${SED} -e '/^# *include/{p;s/^# *include/!include/;};s/'\\''//g;s/\"//g' $file_to_read | $Cpp $Include_dirs -I$last_seen_dir @Defines |")
374         || die "$Pgm: Can't open $file_to_read: $!\n";
375
376     while (<SRCFILE>) {
377         #
378         # import {-# SOURCE #-} Foo (bar) generates dependencies on the source file only,
379         # the compiler will deal with the absence of Foo.hi by consulting the
380         # source for Foo directly. (for dealing with recursive modules).
381         #
382         next unless (/^>?\s*(import)(\s+{-#\s*SOURCE\s*#-})?(\s+qualified)?\s+([A-Z][A-Za-z0-9_']*)/ || /^!(include)(\s+)"(\S+)"/);
383         $todo    = $1;
384         $source  = ( $2 ne '') ? 1 : 0;
385         $modname = $4;
386
387         next if $modname eq '';
388         &process_dependency($todo,$source,$modname);
389     }
390     close(SRCFILE) || exit(1);
391 }
392
393 #
394 # Handle
395 sub process_dependency {
396   local($todo,$source,$modname) = @_;
397
398   if ($todo eq 'import') {
399     if ( $ModuleIn{$modname} ) {
400         $follow_file = "$ModuleIn{$modname}/$modname.hi";
401     } else { # hard way
402         $follow_file =
403           &find_in_Import_dirs($orig_src_file, $modname, $last_seen_dir, $source );
404     }
405   } else {
406         $follow_file
407           = &find_in_Include_dirs($orig_src_file, $modname, $last_seen_dir);
408   }
409
410   if (! $follow_file) { # it didnae find anything
411       die "$orig_src_file: Couldn't handle: $_\n";
412
413   } else { # it found something
414     if ($follow_file ne '__ignore__') {
415         local($int_file) = $follow_file;
416
417         if ( $int_file !~ /\.(l?hs|hi|l?y)$/ ) {
418             local($str) = "";
419             foreach $obj  (@Obj_suffix) {
420                 $str .= "$bf.$obj ";
421                 foreach $suff (@File_suffix) {
422                    $str .= "$bf.${suff}_$obj ";
423                 }
424             }
425             push(@Depend_lines, "$str: $int_file\n");
426         } else {
427             $int_file =~ s/\.l?hs$//;
428             $int_file =~ s/\.l?y$//;
429             $int_file =~ s/\.hi$//;
430             local($source_dep);
431
432             if ( $source ) {
433                 $source_dep = "$int_file.hi-boot";
434             } else {
435                 local($str)="";
436                 foreach $obj (@Obj_suffix) {
437                    $str .= "$bf.$obj ";
438                 }
439                 push(@Depend_lines, "$str: $int_file.hi\n");
440             }
441
442             if ( ! $source ) {
443                foreach $suff  (@File_suffix) {
444                   local($str) = "";
445                   foreach $obj (@Obj_suffix) {
446                     $str .= "$bf.${suff}_$obj ";
447                   }
448                   push(@Depend_lines, "$str: $int_file.${suff}_hi\n");
449                }
450             } else {
451                local($str) = "";
452                foreach $obj  (@Obj_suffix) {
453                    $str .= "$bf.$obj ";
454                    foreach $suff (@File_suffix) {
455                      $str .= "$bf.${suff}_$obj ";
456                    }
457                }
458                push(@Depend_lines, "$str: $source_dep\n");
459             }
460         }
461      }
462    }
463 }
464
465 # when we see something, we cache that fact ('y').
466 # also, when we get a miss, we cache that (so we don't try later); ('n')
467 %FileExists = ();
468
469 sub find_in_Import_dirs {
470     local($orig_src_file, $modname, $last_seen_dir, $source) = @_;
471     local($import_dir);
472     local($do_magical_check) = 0;
473     local($name_to_check);
474
475     # do it the old hard way: hop along Import_dir list
476     foreach $import_dir (@Import_dirs) {
477         # handle . magically
478         if ($import_dir eq '.') {
479             # record that we should do a SPECIAL try for a file in last_seen_dir (LAST)
480             $do_magical_check = 1;
481         }
482
483         $name_to_check = "$import_dir/$modname.hi";
484         if ( $FileExists{$name_to_check} ne 'n' ) { # either 'y' or nothing
485             print STDERR "trying $name_to_check...\n" if $Verbose >= 2; # very verbose
486             return($name_to_check) if $FileExists{$name_to_check} eq 'y';
487             if (-f $name_to_check) {
488                 $FileExists{$name_to_check} = 'y';
489                 return($name_to_check) ;
490             } else {
491                 $FileExists{$name_to_check} = 'n';
492             }
493         }
494
495         for $suff ('hs', 'lhs', 'ly', 'y') {
496             $name_to_check = "$import_dir/$modname.$suff";
497             print STDERR "trying... $name_to_check\n" if $Verbose >= 2; # very verbose
498             return($name_to_check) if -f $name_to_check;
499         }
500
501         if ( $source ) {
502             $name_to_check = "$import_dir/$modname.hi-boot";
503             print STDERR "trying... $name_to_check\n" if $Verbose >= 2; # very verbose
504             return($name_to_check) if -f $name_to_check;
505         }               
506     }
507     if ($do_magical_check == 1) {
508         $name_to_check = "$last_seen_dir/$modname.hi";
509
510         if ( $FileExists{$name_to_check} ne 'n' ) { # either 'y' or nothing
511             print STDERR "trying $name_to_check...\n" if $Verbose >= 2; # very verbose
512             return($name_to_check) if $FileExists{$name_to_check} eq 'y';
513             if (-f $name_to_check) {
514                 $FileExists{$name_to_check} = 'y';
515                 return($name_to_check) ;
516             } else {
517                 $FileExists{$name_to_check} = 'n';
518             }
519         }
520
521         for $suff ('lhs', 'hs', 'ly', 'y') {
522             $name_to_check = "$last_seen_dir/$modname.$suff";
523             print STDERR "trying... $name_to_check\n" if $Verbose >= 2; # very verbose
524             return($name_to_check) if -f $name_to_check;
525         }
526     }
527
528     # OK, maybe it's referring to something in a system library
529     #foreach $lib ( @Syslibs ) {
530     #   return('__ignore__') if $LibIfaces{"$lib:$modname"};
531     #}
532
533     # Last hope: referring to a Prelude interface
534     return('__ignore__') if ( $IgnoreMe{$modname} eq 'y' );
535
536     die "No file `$modname.hi', `$modname.lhs', `$modname.hs' (reqd from file `$orig_src_file')\namong import directories:\n\t$Import_dirs\n";
537 }
538
539 sub find_in_Include_dirs {
540     local($orig_src_file, $name, $last_seen_dir) = @_;
541     local($include_dir);
542     local($do_magical_check) = 0;
543
544     # no funny name guessing here
545
546     # hop along Include_dir list
547     foreach $include_dir (@Include_dirs) {
548         $include_dir =~ s/^-I//;
549
550         # handle . magically
551         if ($include_dir eq '.') {
552             # record that we should do a SPECIAL try for a file in last_seen_dir (LAST)
553             $do_magical_check = 1;
554         }
555         print STDERR "trying $include_dir/$name...\n" if $Verbose >= 2; # very verbose
556         if (-f "$include_dir/$name") {
557             return("$include_dir/$name");
558         }
559     }
560     if ($do_magical_check == 1) {
561         print STDERR "trying $last_seen_dir/$name...\n" if $Verbose >= 2; # very verbose
562         if (-f "$last_seen_dir/$name") {
563             return("$last_seen_dir/$name");
564         }
565     }
566     die "No file `$name' (reqd from file `$orig_src_file') among include directories: $Include_dirs\n";
567 }
568
569 # out of the driver, actually
570 sub run_something {
571     local($str_to_do, $tidy_name) = @_;
572
573     print STDERR "\n$tidy_name:\n\t" if $Verbose;
574     print STDERR "$str_to_do\n" if $Verbose;
575
576     local($return_val) = system($str_to_do) >> 8;
577
578     if ($return_val != 0) {
579         local($die_msg) = "$Pgm: execution of the $tidy_name had trouble";
580         $die_msg .= " (program not found)" if $return_val == 255;
581         $die_msg .= " ($!)" if $Verbose && $! != 0;
582         $die_msg .= "\n";
583         print STDERR $die_msg;
584         exit $return_val;
585     }
586 }