* configure.ac, NEWS: Bump version to 1.8e.
[automake.git] / aclocal.in
blob3a3f45e1578059a47cb1f9dfffce7e2f87efe587
1 #!@PERL@
2 # -*- perl -*-
3 # @configure_input@
5 eval 'case $# in 0) exec @PERL@ -S "$0";; *) exec @PERL@ -S "$0" "$@";; esac'
6     if 0;
8 # aclocal - create aclocal.m4 by scanning configure.ac
10 # Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
11 #           Free Software Foundation, Inc.
13 # This program is free software; you can redistribute it and/or modify
14 # it under the terms of the GNU General Public License as published by
15 # the Free Software Foundation; either version 2, or (at your option)
16 # any later version.
18 # This program is distributed in the hope that it will be useful,
19 # but WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 # GNU General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
26 # 02111-1307, USA.
28 # Written by Tom Tromey <tromey@redhat.com>.
30 BEGIN
32   my $perllibdir = $ENV{'perllibdir'} || '@datadir@/@PACKAGE@-@APIVERSION@';
33   unshift @INC, (split '@PATH_SEPARATOR@', $perllibdir);
36 use Automake::Config;
37 use Automake::General;
38 use Automake::Configure_ac;
39 use Automake::Channels;
40 use Automake::XFile;
41 use Automake::FileUtils;
42 use File::Basename;
43 use File::stat;
44 use Cwd;
46 # Note that this isn't pkgdatadir, but a separate directory.
47 # Note also that the versioned directory is handled later.
48 $acdir = '@datadir@/aclocal';
49 $default_acdir = $acdir;
50 # contains a list of directories, one per line, to be added
51 # to the dirlist in addition to $acdir, as if -I had been
52 # added to the command line.  If acdir has been redirected,
53 # we will also check the specified acdir (this is done later).
54 $default_dirlist = "$default_acdir/dirlist";
56 # Some globals.
58 # configure.ac or configure.in.
59 my $configure_ac;
61 # Output file name.
62 $output_file = 'aclocal.m4';
64 # Modification time of the youngest dependency.
65 $greatest_mtime = 0;
67 # Option --force.
68 $force_output = 0;
70 # Which macros have been seen.
71 %macro_seen = ();
73 # Which files have been seen.
74 %file_seen = ();
76 # Remember the order into which we scanned the files.
77 # It's important to output the contents of aclocal.m4 in the opposite order.
78 # (Definitions in first files we have scanned should override those from
79 # later files.  So they must appear last in the output.)
80 @file_order = ();
82 # Map macro names to file names.
83 %map = ();
85 # Ditto, but records the last definition of each macro as returned by --trace.
86 %map_traced_defs = ();
88 # Map file names to file contents.
89 %file_contents = ();
91 # Map file names to included files (transitively closed).
92 %file_includes = ();
94 # How much to say.
95 $verbose = 0;
97 # Matches a macro definition.
98 #   AC_DEFUN([macroname], ...)
99 # or
100 #   AC_DEFUN(macroname, ...)
101 # When macroname is `['-quoted , we accept any character in the name,
102 # except `]'.  Otherwise macroname stops on the first `]', `,', `)',
103 # or `\n' encountered.
104 $ac_defun_rx = "A[CU]_DEFUN\\((?:\\[([^]]+)\\]|([^],)\n]+))";
106 # Matches an AC_REQUIRE line.
107 $ac_require_rx = "AC_REQUIRE\\((?:\\[([^]]+)\\]|([^],)\n]+))\\)";
109 # Matches an m4_include line
110 $m4_include_rx = "(?:m4_)?s?include\\((?:\\[([^]]+)\\]|([^],)\n]+))\\)";
113 ################################################################
115 # Check macros in acinclude.m4.  If one is not used, warn.
116 sub check_acinclude ()
118   foreach my $key (keys %map)
119     {
120       # FIXME: should print line number of acinclude.m4.
121       warn ("aclocal: warning: macro `$key' defined in "
122             . "acinclude.m4 but never used\n")
123         if $map{$key} eq 'acinclude.m4' && ! $macro_seen{$key};
124     }
127 ################################################################
129 # Scan all the installed m4 files and construct a map.
130 sub scan_m4_files (@)
132     local (@dirlist) = @_;
134     # First, scan configure.ac.  It may contain macro definitions,
135     # or may include other files that define macros.
136     &scan_file ($configure_ac, 'aclocal');
138     # Then, scan acinclude.m4 if it exists.
139     if (-f 'acinclude.m4')
140     {
141         &scan_file ('acinclude.m4', 'aclocal');
142     }
144     # Finally, scan all files in our search path.
145     local ($m4dir);
146     foreach $m4dir (@dirlist)
147     {
148         if (! opendir (DIR, $m4dir))
149           {
150             print STDERR "aclocal: couldn't open directory `$m4dir': $!\n";
151             exit 1;
152           }
154         local ($file, $fullfile);
155         # We reverse the directory contents so that foo2.m4 gets
156         # used in preference to foo1.m4.
157         foreach $file (reverse sort grep (! /^\./, readdir (DIR)))
158         {
159             # Only examine .m4 files.
160             next unless $file =~ /\.m4$/;
162             # Skip some files when running out of srcdir.
163             next if $file eq 'aclocal.m4';
165             $fullfile = File::Spec->canonpath ("$m4dir/$file");
166             &scan_file ($fullfile, 'aclocal');
167         }
168         closedir (DIR);
169     }
171     # Construct a new function that does the searching.  We use a
172     # function (instead of just evaluating $search in the loop) so that
173     # "die" is correctly and easily propagated if run.
174     my $search = "sub search {\nmy \$found = 0;\n";
175     foreach my $key (reverse sort keys %map)
176     {
177         $search .= ('if (/\b\Q' . $key . '\E(?!\w)/) { & add_macro ("' . $key
178                     . '"); $found = 1; }' . "\n");
179     }
180     $search .= "return \$found;\n};\n";
181     eval $search;
182     die "internal error: $@\n search is $search" if $@;
185 ################################################################
187 # Add a macro to the output.
188 sub add_macro ($)
190     local ($macro) = @_;
192     # Ignore unknown required macros.  Either they are not really
193     # needed (e.g., a conditional AC_REQUIRE), in which case aclocal
194     # should be quiet, or they are needed and Autoconf itself will
195     # complain when we trace for macro usage later.
196     return unless defined $map{$macro};
198     print STDERR "aclocal: saw macro $macro\n" if $verbose;
199     $macro_seen{$macro} = 1;
200     &add_file ($map{$macro});
203 # rel2abs ($file, $directory)
204 # ---------------------------
205 # Similar to File::Spec->rel2abs ($file, $directory), but
206 # work with Perl 5.005.  (File::Spec->rel2abs is available
207 # only in Perl 5.6.)
208 # Remove this once we require 5.6.
209 sub rel2abs ($$)
211   my ($file, $dir) = @_;
212   if (! File::Spec->file_name_is_absolute ($file))
213     {
214       $dir = cwd () . "/$dir"
215         unless File::Spec->file_name_is_absolute ($dir);
216       $file = "$dir/$file";
217     }
218   $file = File::Spec->canonpath ($file);
219   return $file;
222 # scan_configure_dep ($file)
223 # --------------------------
224 # Scan a configure dependency (configure.ac, or separate m4 files)
225 # for uses of know macros and AC_REQUIREs of possibly unknown macros.
226 # Recursively scan m4_included files.
227 my %scanned_configure_dep = ();
228 sub scan_configure_dep ($)
230   my ($file) = @_;
231   # Do not scan a file twice.
232   return ()
233     if exists $scanned_configure_dep{$file};
234   $scanned_configure_dep{$file} = 1;
236   my $mtime = mtime $file;
237   $greatest_mtime = $mtime if $greatest_mtime < $mtime;
239   my $contents = exists $file_contents{$file} ?
240     $file_contents{$file} : contents $file;
242   my $line = 0;
243   my @rlist = ();
244   my @ilist = ();
245   foreach (split ("\n", $contents))
246     {
247       ++$line;
248       # Remove comments from current line.
249       s/\bdnl\b.*$//;
250       s/\#.*$//;
252       while (/$m4_include_rx/go)
253         {
254           push (@ilist, $1 || $2);
255         }
257       while (/$ac_require_rx/go)
258         {
259           push (@rlist, $1 || $2);
260         }
262       # The search function is constructed dynamically by
263       # scan_m4_files.  The last parenthetical match makes sure we
264       # don't match things that look like macro assignments or
265       # AC_SUBSTs.
266       if (! &search && /(^|\s+)(AM_[A-Z0-9_]+)($|[^\]\)=A-Z0-9_])/)
267         {
268           # Macro not found, but AM_ prefix found.
269           # Make this just a warning, because we do not know whether
270           # the macro is actually used (it could be called conditionally).
271           warn ("aclocal:$file:$line: warning: "
272                 . "macro `$2' not found in library\n");
273         }
274     }
276   add_macro ($_) foreach (@rlist);
277   my $dirname = dirname $file;
278   &scan_configure_dep (rel2abs ($_, $dirname)) foreach (@ilist);
281 # Add a file to output.
282 sub add_file ($)
284   local ($file) = @_;
286   # Only add a file once.
287   return if ($file_seen{$file});
288   $file_seen{$file} = 1;
290   scan_configure_dep $file;
293 # Point to the documentation for underquoted AC_DEFUN only once.
294 my $underquoted_manual_once = 0;
296 # scan_file ($FILE, $WHERE)
297 # -------------------------
298 # Scan a single M4 file ($FILE), and all files it includes.
299 # Return the list of included files.
300 # $WHERE is the location to use in the diagnostic if the file
301 # does not exist.
302 sub scan_file ($$)
304   my ($file, $where) = @_;
305   my $base = dirname $file;
307   # Do not scan the same file twice.
308   return @$file_includes{$file} if exists $file_includes{$file};
309   # Prevent potential infinite recursion (if two files include each other).
310   return () if exists $file_contents{$file};
312   unshift @file_order, $file;
314   if (! -e $file)
315     {
316       print STDERR "$where: file `$file' does not exist\n";
317       exit 1;
318     }
320   my $fh = new Automake::XFile $file;
321   my $contents = '';
322   my @inc_files = ();
323   my %inc_lines = ();
324   while ($_ = $fh->getline)
325     {
326       # Ignore `##' lines.
327       next if /^##/;
329       $contents .= $_;
331       while (/$ac_defun_rx/go)
332         {
333           if (! defined $1)
334             {
335               print STDERR "$file:$.: warning: underquoted definition of $2\n";
336               print STDERR "  run info '(automake)Extending aclocal'\n"
337                 . "  or see http://sources.redhat.com/automake/"
338                 . "automake.html#Extending%20aclocal\n"
339                 unless $underquoted_manual_once;
340               $underquoted_manual_once = 1;
341             }
342           my $macro = $1 || $2;
343           if (! defined $map{$macro})
344             {
345               print STDERR "aclocal: found macro $macro in $file: $.\n"
346                 if $verbose;
347               $map{$macro} = $file;
348             }
349           else
350             {
351               # Note: we used to give an error here if we saw a
352               # duplicated macro.  However, this turns out to be
353               # extremely unpopular.  It causes actual problems which
354               # are hard to work around, especially when you must
355               # mix-and-match tool versions.
356               print STDERR "aclocal: ignoring macro $macro in $file: $.\n"
357                 if $verbose;
358             }
359         }
361       while (/$m4_include_rx/go)
362         {
363           my $ifile = $1 || $2;
364           # m4_include is relative to the directory of the file which
365           # perform the include, but we want paths relative to the
366           # directory where aclocal is run.  Do not use
367           # File::Spec->rel2abs, because we want to store relative
368           # paths (they might be used later of aclocal outputs an
369           # m4_include for this file, or if the user itself includes
370           # this file).
371           $ifile = "$base/$ifile"
372             unless $base eq '.' || File::Spec->file_name_is_absolute ($ifile);
373           push (@inc_files, $ifile);
374           $inc_lines{$ifile} = $.;
375         }
376     }
377   $file_contents{$file} = $contents;
379   # For some reason I don't understand, it does not work
380   # to do `map { scan_file ($_, ...) } @inc_files' below.
381   # With Perl 5.8.2 it undefines @inc_files.
382   my @copy = @inc_files;
383   my @all_inc_files = (@inc_files,
384                        map { scan_file ($_, "$file:$inc_lines{$_}") } @copy);
385   $file_includes{$file} = \@all_inc_files;
386   return @all_inc_files;
389 # strip_redundant_includes (%FILES)
390 # ---------------------------------
391 # Each key in %FILES is a file that must be present in the output.
392 # However some of these files might already include other files in %FILES,
393 # so there is no point in including them another time.
394 # This removes items of %FILES which are already included by another file.
395 sub strip_redundant_includes (%)
397   my %files = @_;
398   # Files at the end of @file_order should override those at the beginning,
399   # so it is important to preserve these trailing files.  We can remove
400   # a file A if it is going to be output before a file B that includes
401   # file A, not the converse.
402   foreach my $file (reverse @file_order)
403     {
404       next unless exists $files{$file};
405       foreach my $ifile (@{$file_includes{$file}})
406         {
407           next unless exists $files{$ifile};
408           delete $files{$ifile};
409           print STDERR "$ifile is already included by $file\n"
410             if $verbose;
411         }
412     }
413   return %files;
416 sub trace_used_macros ()
418   my %files = map { $map{$_} => 1 } keys %macro_seen;
419   $files{'acinclude.m4'} = 1 if -f 'acinclude.m4';
420   %files = strip_redundant_includes %files;
421   # configure.ac is implicitly included.
422   delete $files{$configure_ac};
424   my $traces = ($ENV{AUTOM4TE} || 'autom4te');
425   $traces .= " --language Autoconf-without-aclocal-m4 ";
426   # All candidate files.
427   $traces .= join (' ', grep { exists $files{$_} } @file_order) . " ";
428   # All candidate macros.
429   $traces .= join (' ', map { "--trace='$_:\$f:\$n:\$1'" } ('AC_DEFUN',
430                                                             'AU_DEFUN',
431                                                             keys %macro_seen));
433   print STDERR "aclocal: running $traces $configure_ac\n" if $verbose;
435   my $tracefh = new Automake::XFile ("$traces $configure_ac |");
437   my %traced = ();
439   while ($_ = $tracefh->getline)
440     {
441       chomp;
442       my ($file, $macro, $arg1) = split (/:/);
444       $traced{$macro} = 1 if $macro_seen{$macro};
446       $map_traced_defs{$arg1} = $file
447         if $macro eq 'AC_DEFUN' || $macro eq 'AU_DEFUN';
448     }
450   $tracefh->close;
452   return %traced;
455 sub scan_configure ()
457   # Make sure we include acinclude.m4 if it exists.
458   if (-f 'acinclude.m4')
459     {
460       add_file ('acinclude.m4');
461     }
462   scan_configure_dep ($configure_ac);
465 ################################################################
467 # Write output.
468 sub write_aclocal ($@)
470   my ($output_file, @macros) = @_;
471   my $output = '';
473   my %files = ();
474   # Get the list of files containing definitions for the macros used.
475   # (Filter out unused macro definitions with $map_traced_defs.  This
476   # can happen when an Autoconf macro is conditionally defined:
477   # aclocal sees the potential definition, but this definition is
478   # actually never processed and the Autoconf implementation is used
479   # instead.)
480   for my $m (@macros)
481     {
482       $files{$map{$m}} = 1 if $map{$m} eq $map_traced_defs{$m};
483     }
484   $files{'acinclude.m4'} = 1 if -f 'acinclude.m4';
485   %files = strip_redundant_includes %files;
486   delete $files{$configure_ac};
488   for $file (grep { exists $files{$_} } @file_order)
489     {
490       # Check the time stamp of this file, and all files it includes.
491       for my $ifile ($file, @{$file_includes{$file}})
492         {
493           my $mtime = mtime $ifile;
494           $greatest_mtime = $mtime if $greatest_mtime < $mtime;
495         }
497       # If the file to add looks like outside the project, copy it
498       # to the output.  The regex catches filenames starting with
499       # things like `/', `\', or `c:\'.
500       if ($file =~ m,^(?:\w:)?[\\/],)
501         {
502           $output .= $file_contents{$file} . "\n";
503         }
504       else
505         {
506           # Otherwise, simply include the file.
507           $output .= "m4_include([$file])\n";
508         }
509     }
511   # Nothing to output?!
512   # FIXME: Shouldn't we diagnose this?
513   return if ! length ($output);
515   # We used to print `# $output_file generated automatically etc.'  But
516   # this creates spurious differences when using autoreconf.  Autoreconf
517   # creates aclocal.m4t and then rename it to aclocal.m4, but the
518   # rebuild rules generated by Automake create aclocal.m4 directly --
519   # this would gives two ways to get the same file, with a different
520   # name in the header.
521   $output = "# generated automatically by aclocal $VERSION -*- Autoconf -*-
523 # Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
524 # Free Software Foundation, Inc.
525 # This file is free software; the Free Software Foundation
526 # gives unlimited permission to copy and/or distribute it,
527 # with or without modifications, as long as this notice is preserved.
529 # This program is distributed in the hope that it will be useful,
530 # but WITHOUT ANY WARRANTY, to the extent permitted by law; without
531 # even the implied warranty of MERCHANTABILITY or FITNESS FOR A
532 # PARTICULAR PURPOSE.
534 $output";
536   # We try not to update $output_file unless necessary, because
537   # doing so invalidate Autom4te's cache and therefore slows down
538   # tools called after aclocal.
539   #
540   # We need to overwrite $output_file in the following situations.
541   #   * The --force option is in use.
542   #   * One of the dependencies is younger.
543   #     (Not updating $output_file in this situation would cause
544   #     make to call aclocal in loop.)
545   #   * The contents of the current file are different from what
546   #     we have computed.
547   if (!$force_output
548       && $greatest_mtime < mtime ($output_file)
549       && $output eq contents ($output_file))
550     {
551       print STDERR "aclocal: $output_file unchanged\n" if $verbose;
552       return;
553     }
555   print STDERR "aclocal: writing $output_file\n" if $verbose;
557   my $out = new Automake::XFile "> $output_file";
558   print $out $output;
559   return;
562 ################################################################
564 # Print usage and exit.
565 sub usage ($)
567   local ($status) = @_;
569   print "Usage: aclocal [OPTIONS] ...\n\n";
570   print "\
571 Generate `aclocal.m4' by scanning `configure.ac' or `configure.in'
573   --acdir=DIR           directory holding config files
574   --help                print this help, then exit
575   -I DIR                add directory to search list for .m4 files
576   --force               always update output file
577   --output=FILE         put output in FILE (default aclocal.m4)
578   --print-ac-dir        print name of directory holding m4 files
579   --verbose             don't be silent
580   --version             print version number, then exit
582 Report bugs to <bug-automake\@gnu.org>.\n";
584   exit $status;
587 # Parse command line.
588 sub parse_arguments (@)
590   local (@arglist) = @_;
591   local (@dirlist);
592   local ($print_and_exit) = 0;
594   while (@arglist)
595     {
596       if ($arglist[0] =~ /^--acdir=(.+)$/)
597         {
598           $acdir = $1;
599         }
600       elsif ($arglist[0] =~/^--output=(.+)$/)
601         {
602           $output_file = $1;
603         }
604       elsif ($arglist[0] eq '-I')
605         {
606           shift (@arglist);
607           push (@dirlist, $arglist[0]);
608         }
609       elsif ($arglist[0] eq '--print-ac-dir')
610         {
611           $print_and_exit = 1;
612         }
613       elsif ($arglist[0] eq '--force')
614         {
615           $force_output = 1;
616         }
617       elsif ($arglist[0] eq '--verbose')
618         {
619           ++$verbose;
620         }
621       elsif ($arglist[0] eq '--version')
622         {
623           print "aclocal (GNU $PACKAGE) $VERSION\n";
624           print "Written by Tom Tromey <tromey\@redhat.com>\n\n";
625           print "Copyright (C) 2004 Free Software Foundation, Inc.\n";
626           print "This is free software; see the source for copying conditions.  There is NO\n";
627           print "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n";
628           exit 0;
629         }
630       elsif ($arglist[0] eq '--help')
631         {
632           &usage (0);
633         }
634       else
635         {
636           print STDERR "aclocal: unrecognized option -- `$arglist[0]'\nTry `aclocal --help' for more information.\n";
637           exit 1;
638         }
640       shift (@arglist);
641     }
643   if ($print_and_exit)
644     {
645       print $acdir, "\n";
646       exit 0;
647     }
649   $default_dirlist="$acdir/dirlist"
650     if $acdir ne $default_acdir;
652   # Search the versioned directory near the end, and then the
653   # unversioned directory last.  Only do this if the user didn't
654   # override acdir.
655   push (@dirlist, "$acdir-$APIVERSION")
656     if $acdir eq $default_acdir;
658   # By default $(datadir)/aclocal doesn't exist.  We don't want to
659   # get an error in the case where we are searching the default
660   # directory and it hasn't been created.
661   push (@dirlist, $acdir)
662     unless $acdir eq $default_acdir && ! -d $acdir;
664   # Finally, adds any directory listed in the `dirlist' file.
665   if (open (DEFAULT_DIRLIST, $default_dirlist))
666     {
667       while (<DEFAULT_DIRLIST>)
668         {
669           # Ignore '#' lines.
670           next if /^#/;
671           # strip off newlines and end-of-line comments
672           s/\s*\#.*$//;
673           chomp ($contents=$_);
674           if (-d $contents )
675             {
676               push (@dirlist, $contents);
677             }
678         }
679       close (DEFAULT_DIRLIST);
680     }
682   return @dirlist;
685 ################################################################
687 local (@dirlist) = parse_arguments (@ARGV);
688 $configure_ac = require_configure_ac;
689 scan_m4_files (@dirlist);
690 scan_configure;
691 if (! $exit_code)
692   {
693     my %macro_traced = trace_used_macros;
694     write_aclocal ($output_file, keys %macro_traced);
695   }
696 check_acinclude;
698 exit $exit_code;
700 ### Setup "GNU" style for perl-mode and cperl-mode.
701 ## Local Variables:
702 ## perl-indent-level: 2
703 ## perl-continued-statement-offset: 2
704 ## perl-continued-brace-offset: 0
705 ## perl-brace-offset: 0
706 ## perl-brace-imaginary-offset: 0
707 ## perl-label-offset: -2
708 ## cperl-indent-level: 2
709 ## cperl-brace-offset: 0
710 ## cperl-continued-brace-offset: 0
711 ## cperl-label-offset: -2
712 ## cperl-extra-newline-before-brace: t
713 ## cperl-merge-trailing-else: nil
714 ## cperl-continued-statement-offset: 2
715 ## End: