5 eval 'case $# in 0) exec @PERL@ -S "$0";; *) exec @PERL@ -S "$0" "$@";; esac'
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)
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
28 # Written by Tom Tromey <tromey@redhat.com>, and
29 # Alexandre Duret-Lutz <adl@gnu.org>.
33 my $perllibdir = $ENV{'perllibdir'} || '@datadir@/@PACKAGE@-@APIVERSION@';
34 unshift @INC, (split '@PATH_SEPARATOR@', $perllibdir);
40 use Automake::General;
41 use Automake::Configure_ac;
42 use Automake::Channels;
44 use Automake::FileUtils;
49 # Note that this isn't pkgdatadir, but a separate directory.
50 # Note also that the versioned directory is handled later.
51 my $acdir = '@datadir@/aclocal';
52 my $default_acdir = $acdir;
53 # contains a list of directories, one per line, to be added
54 # to the dirlist in addition to $acdir, as if -I had been
55 # added to the command line. If acdir has been redirected,
56 # we will also check the specified acdir (this is done later).
57 my $default_dirlist = "$default_acdir/dirlist";
61 # configure.ac or configure.in.
65 my $output_file = 'aclocal.m4';
67 # Modification time of the youngest dependency.
68 my $greatest_mtime = 0;
73 # Which macros have been seen.
76 # Which files have been seen.
79 # Remember the order into which we scanned the files.
80 # It's important to output the contents of aclocal.m4 in the opposite order.
81 # (Definitions in first files we have scanned should override those from
82 # later files. So they must appear last in the output.)
85 # Map macro names to file names.
88 # Ditto, but records the last definition of each macro as returned by --trace.
89 my %map_traced_defs = ();
91 # Map file names to file contents.
92 my %file_contents = ();
94 # Map file names to included files (transitively closed).
95 my %file_includes = ();
100 # Matches a macro definition.
101 # AC_DEFUN([macroname], ...)
103 # AC_DEFUN(macroname, ...)
104 # When macroname is `['-quoted , we accept any character in the name,
105 # except `]'. Otherwise macroname stops on the first `]', `,', `)',
106 # or `\n' encountered.
108 "(?:A[CU]_DEFUN|AC_DEFUN_ONCE)\\((?:\\[([^]]+)\\]|([^],)\n]+))";
110 # Matches an AC_REQUIRE line.
111 my $ac_require_rx = "AC_REQUIRE\\((?:\\[([^]]+)\\]|([^],)\n]+))\\)";
113 # Matches an m4_include line
114 my $m4_include_rx = "(?:m4_)?s?include\\((?:\\[([^]]+)\\]|([^],)\n]+))\\)";
117 ################################################################
119 # Check macros in acinclude.m4. If one is not used, warn.
120 sub check_acinclude ()
122 foreach my $key (keys %map)
124 # FIXME: should print line number of acinclude.m4.
125 warn ("aclocal: warning: macro `$key' defined in "
126 . "acinclude.m4 but never used\n")
127 if $map{$key} eq 'acinclude.m4' && ! $macro_seen{$key};
131 ################################################################
133 # Scan all the installed m4 files and construct a map.
134 sub scan_m4_files (@)
138 # First, scan configure.ac. It may contain macro definitions,
139 # or may include other files that define macros.
140 &scan_file ($configure_ac, 'aclocal');
142 # Then, scan acinclude.m4 if it exists.
143 if (-f 'acinclude.m4')
145 &scan_file ('acinclude.m4', 'aclocal');
148 # Finally, scan all files in our search path.
149 foreach my $m4dir (@dirlist)
151 if (! opendir (DIR, $m4dir))
153 print STDERR "aclocal: couldn't open directory `$m4dir': $!\n";
157 # We reverse the directory contents so that foo2.m4 gets
158 # used in preference to foo1.m4.
159 foreach my $file (reverse sort grep (! /^\./, readdir (DIR)))
161 # Only examine .m4 files.
162 next unless $file =~ /\.m4$/;
164 # Skip some files when running out of srcdir.
165 next if $file eq 'aclocal.m4';
167 my $fullfile = File::Spec->canonpath ("$m4dir/$file");
168 &scan_file ($fullfile, 'aclocal');
173 # Construct a new function that does the searching. We use a
174 # function (instead of just evaluating $search in the loop) so that
175 # "die" is correctly and easily propagated if run.
176 my $search = "sub search {\nmy \$found = 0;\n";
177 foreach my $key (reverse sort keys %map)
179 $search .= ('if (/\b\Q' . $key . '\E(?!\w)/) { & add_macro ("' . $key
180 . '"); $found = 1; }' . "\n");
182 $search .= "return \$found;\n};\n";
184 die "internal error: $@\n search is $search" if $@;
187 ################################################################
189 # Add a macro to the output.
194 # Ignore unknown required macros. Either they are not really
195 # needed (e.g., a conditional AC_REQUIRE), in which case aclocal
196 # should be quiet, or they are needed and Autoconf itself will
197 # complain when we trace for macro usage later.
198 return unless defined $map{$macro};
200 print STDERR "aclocal: saw macro $macro\n" if $verbose;
201 $macro_seen{$macro} = 1;
202 &add_file ($map{$macro});
205 # scan_configure_dep ($file)
206 # --------------------------
207 # Scan a configure dependency (configure.ac, or separate m4 files)
208 # for uses of know macros and AC_REQUIREs of possibly unknown macros.
209 # Recursively scan m4_included files.
210 my %scanned_configure_dep = ();
211 sub scan_configure_dep ($)
214 # Do not scan a file twice.
216 if exists $scanned_configure_dep{$file};
217 $scanned_configure_dep{$file} = 1;
219 my $mtime = mtime $file;
220 $greatest_mtime = $mtime if $greatest_mtime < $mtime;
222 my $contents = exists $file_contents{$file} ?
223 $file_contents{$file} : contents $file;
228 foreach (split ("\n", $contents))
231 # Remove comments from current line.
235 while (/$m4_include_rx/go)
237 push (@ilist, $1 || $2);
240 while (/$ac_require_rx/go)
242 push (@rlist, $1 || $2);
245 # The search function is constructed dynamically by
246 # scan_m4_files. The last parenthetical match makes sure we
247 # don't match things that look like macro assignments or
249 if (! &search && /(^|\s+)(AM_[A-Z0-9_]+)($|[^\]\)=A-Z0-9_])/)
251 # Macro not found, but AM_ prefix found.
252 # Make this just a warning, because we do not know whether
253 # the macro is actually used (it could be called conditionally).
254 warn ("aclocal:$file:$line: warning: "
255 . "macro `$2' not found in library\n");
259 add_macro ($_) foreach (@rlist);
260 my $dirname = dirname $file;
261 &scan_configure_dep (File::Spec->rel2abs ($_, $dirname)) foreach (@ilist);
264 # Add a file to output.
269 # Only add a file once.
270 return if ($file_seen{$file});
271 $file_seen{$file} = 1;
273 scan_configure_dep $file;
276 # Point to the documentation for underquoted AC_DEFUN only once.
277 my $underquoted_manual_once = 0;
279 # scan_file ($FILE, $WHERE)
280 # -------------------------
281 # Scan a single M4 file ($FILE), and all files it includes.
282 # Return the list of included files.
283 # $WHERE is the location to use in the diagnostic if the file
287 my ($file, $where) = @_;
288 my $base = dirname $file;
290 # Do not scan the same file twice.
291 return @{$file_includes{$file}} if exists $file_includes{$file};
292 # Prevent potential infinite recursion (if two files include each other).
293 return () if exists $file_contents{$file};
295 unshift @file_order, $file;
299 print STDERR "$where: file `$file' does not exist\n";
303 my $fh = new Automake::XFile $file;
307 while ($_ = $fh->getline)
314 while (/$ac_defun_rx/go)
318 print STDERR "$file:$.: warning: underquoted definition of $2\n";
319 print STDERR " run info '(automake)Extending aclocal'\n"
320 . " or see http://sources.redhat.com/automake/"
321 . "automake.html#Extending-aclocal\n"
322 unless $underquoted_manual_once;
323 $underquoted_manual_once = 1;
325 my $macro = $1 || $2;
326 if (! defined $map{$macro})
328 print STDERR "aclocal: found macro $macro in $file: $.\n"
330 $map{$macro} = $file;
334 # Note: we used to give an error here if we saw a
335 # duplicated macro. However, this turns out to be
336 # extremely unpopular. It causes actual problems which
337 # are hard to work around, especially when you must
338 # mix-and-match tool versions.
339 print STDERR "aclocal: ignoring macro $macro in $file: $.\n"
344 while (/$m4_include_rx/go)
346 my $ifile = $1 || $2;
347 # m4_include is relative to the directory of the file which
348 # perform the include, but we want paths relative to the
349 # directory where aclocal is run. Do not use
350 # File::Spec->rel2abs, because we want to store relative
351 # paths (they might be used later of aclocal outputs an
352 # m4_include for this file, or if the user itself includes
354 $ifile = "$base/$ifile"
355 unless $base eq '.' || File::Spec->file_name_is_absolute ($ifile);
356 push (@inc_files, $ifile);
357 $inc_lines{$ifile} = $.;
360 $file_contents{$file} = $contents;
362 # For some reason I don't understand, it does not work
363 # to do `map { scan_file ($_, ...) } @inc_files' below.
364 # With Perl 5.8.2 it undefines @inc_files.
365 my @copy = @inc_files;
366 my @all_inc_files = (@inc_files,
367 map { scan_file ($_, "$file:$inc_lines{$_}") } @copy);
368 $file_includes{$file} = \@all_inc_files;
369 return @all_inc_files;
372 # strip_redundant_includes (%FILES)
373 # ---------------------------------
374 # Each key in %FILES is a file that must be present in the output.
375 # However some of these files might already include other files in %FILES,
376 # so there is no point in including them another time.
377 # This removes items of %FILES which are already included by another file.
378 sub strip_redundant_includes (%)
381 # Files at the end of @file_order should override those at the beginning,
382 # so it is important to preserve these trailing files. We can remove
383 # a file A if it is going to be output before a file B that includes
384 # file A, not the converse.
385 foreach my $file (reverse @file_order)
387 next unless exists $files{$file};
388 foreach my $ifile (@{$file_includes{$file}})
390 next unless exists $files{$ifile};
391 delete $files{$ifile};
392 print STDERR "$ifile is already included by $file\n"
399 sub trace_used_macros ()
401 my %files = map { $map{$_} => 1 } keys %macro_seen;
402 $files{'acinclude.m4'} = 1 if -f 'acinclude.m4';
403 %files = strip_redundant_includes %files;
404 # configure.ac is implicitly included.
405 delete $files{$configure_ac};
407 my $traces = ($ENV{AUTOM4TE} || 'autom4te');
408 $traces .= " --language Autoconf-without-aclocal-m4 ";
409 # All candidate files.
410 $traces .= join (' ', grep { exists $files{$_} } @file_order) . " ";
411 # All candidate macros.
412 $traces .= join (' ', map { "--trace='$_:\$f:\$n:\$1'" } ('AC_DEFUN',
417 print STDERR "aclocal: running $traces $configure_ac\n" if $verbose;
419 my $tracefh = new Automake::XFile ("$traces $configure_ac |");
423 while ($_ = $tracefh->getline)
426 my ($file, $macro, $arg1) = split (/:/);
428 $traced{$macro} = 1 if $macro_seen{$macro};
430 $map_traced_defs{$arg1} = $file
431 if ($macro eq 'AC_DEFUN'
432 || $macro eq 'AC_DEFUN_ONCE'
433 || $macro eq 'AU_DEFUN');
441 sub scan_configure ()
443 # Make sure we include acinclude.m4 if it exists.
444 if (-f 'acinclude.m4')
446 add_file ('acinclude.m4');
448 scan_configure_dep ($configure_ac);
451 ################################################################
454 sub write_aclocal ($@)
456 my ($output_file, @macros) = @_;
460 # Get the list of files containing definitions for the macros used.
461 # (Filter out unused macro definitions with $map_traced_defs. This
462 # can happen when an Autoconf macro is conditionally defined:
463 # aclocal sees the potential definition, but this definition is
464 # actually never processed and the Autoconf implementation is used
468 $files{$map{$m}} = 1 if $map{$m} eq $map_traced_defs{$m};
470 $files{'acinclude.m4'} = 1 if -f 'acinclude.m4';
471 %files = strip_redundant_includes %files;
472 delete $files{$configure_ac};
474 for my $file (grep { exists $files{$_} } @file_order)
476 # Check the time stamp of this file, and all files it includes.
477 for my $ifile ($file, @{$file_includes{$file}})
479 my $mtime = mtime $ifile;
480 $greatest_mtime = $mtime if $greatest_mtime < $mtime;
483 # If the file to add looks like outside the project, copy it
484 # to the output. The regex catches filenames starting with
485 # things like `/', `\', or `c:\'.
486 if ($file =~ m,^(?:\w:)?[\\/],)
488 $output .= $file_contents{$file} . "\n";
492 # Otherwise, simply include the file.
493 $output .= "m4_include([$file])\n";
497 # Nothing to output?!
498 # FIXME: Shouldn't we diagnose this?
499 return if ! length ($output);
501 # We used to print `# $output_file generated automatically etc.' But
502 # this creates spurious differences when using autoreconf. Autoreconf
503 # creates aclocal.m4t and then rename it to aclocal.m4, but the
504 # rebuild rules generated by Automake create aclocal.m4 directly --
505 # this would gives two ways to get the same file, with a different
506 # name in the header.
507 $output = "# generated automatically by aclocal $VERSION -*- Autoconf -*-
509 # Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
510 # Free Software Foundation, Inc.
511 # This file is free software; the Free Software Foundation
512 # gives unlimited permission to copy and/or distribute it,
513 # with or without modifications, as long as this notice is preserved.
515 # This program is distributed in the hope that it will be useful,
516 # but WITHOUT ANY WARRANTY, to the extent permitted by law; without
517 # even the implied warranty of MERCHANTABILITY or FITNESS FOR A
518 # PARTICULAR PURPOSE.
522 # We try not to update $output_file unless necessary, because
523 # doing so invalidate Autom4te's cache and therefore slows down
524 # tools called after aclocal.
526 # We need to overwrite $output_file in the following situations.
527 # * The --force option is in use.
528 # * One of the dependencies is younger.
529 # (Not updating $output_file in this situation would cause
530 # make to call aclocal in loop.)
531 # * The contents of the current file are different from what
534 && $greatest_mtime < mtime ($output_file)
535 && $output eq contents ($output_file))
537 print STDERR "aclocal: $output_file unchanged\n" if $verbose;
541 print STDERR "aclocal: writing $output_file\n" if $verbose;
543 my $out = new Automake::XFile "> $output_file";
548 ################################################################
550 # Print usage and exit.
555 print "Usage: aclocal [OPTIONS] ...\n\n";
557 Generate `aclocal.m4' by scanning `configure.ac' or `configure.in'
559 --acdir=DIR directory holding config files
560 --help print this help, then exit
561 -I DIR add directory to search list for .m4 files
562 --force always update output file
563 --output=FILE put output in FILE (default aclocal.m4)
564 --print-ac-dir print name of directory holding m4 files
565 --verbose don't be silent
566 --version print version number, then exit
568 Report bugs to <bug-automake\@gnu.org>.\n";
573 # Parse command line.
574 sub parse_arguments (@)
578 my $print_and_exit = 0;
582 if ($arglist[0] =~ /^--acdir=(.+)$/)
586 elsif ($arglist[0] =~/^--output=(.+)$/)
590 elsif ($arglist[0] eq '-I')
593 push (@dirlist, $arglist[0]);
595 elsif ($arglist[0] eq '--print-ac-dir')
599 elsif ($arglist[0] eq '--force')
603 elsif ($arglist[0] eq '--verbose')
607 elsif ($arglist[0] eq '--version')
609 print "aclocal (GNU $PACKAGE) $VERSION\n";
610 print "Written by Tom Tromey <tromey\@redhat.com>\n";
611 print " and Alexandre Duret-Lutz <adl\@gnu.org>\n\n";
612 print "Copyright (C) 2004 Free Software Foundation, Inc.\n";
613 print "This is free software; see the source for copying conditions. There is NO\n";
614 print "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n";
617 elsif ($arglist[0] eq '--help')
623 print STDERR "aclocal: unrecognized option -- `$arglist[0]'\nTry `aclocal --help' for more information.\n";
636 $default_dirlist="$acdir/dirlist"
637 if $acdir ne $default_acdir;
639 # Search the versioned directory near the end, and then the
640 # unversioned directory last. Only do this if the user didn't
642 push (@dirlist, "$acdir-$APIVERSION")
643 if $acdir eq $default_acdir;
645 # By default $(datadir)/aclocal doesn't exist. We don't want to
646 # get an error in the case where we are searching the default
647 # directory and it hasn't been created.
648 push (@dirlist, $acdir)
649 unless $acdir eq $default_acdir && ! -d $acdir;
651 # Finally, adds any directory listed in the `dirlist' file.
652 if (open (DEFAULT_DIRLIST, $default_dirlist))
654 while (<DEFAULT_DIRLIST>)
658 # strip off newlines and end-of-line comments
661 push (@dirlist, $_) if -d $_;
663 close (DEFAULT_DIRLIST);
669 ################################################################
671 my @dirlist = parse_arguments (@ARGV);
672 $configure_ac = require_configure_ac;
673 scan_m4_files (@dirlist);
677 my %macro_traced = trace_used_macros;
678 write_aclocal ($output_file, keys %macro_traced);
684 ### Setup "GNU" style for perl-mode and cperl-mode.
686 ## perl-indent-level: 2
687 ## perl-continued-statement-offset: 2
688 ## perl-continued-brace-offset: 0
689 ## perl-brace-offset: 0
690 ## perl-brace-imaginary-offset: 0
691 ## perl-label-offset: -2
692 ## cperl-indent-level: 2
693 ## cperl-brace-offset: 0
694 ## cperl-continued-brace-offset: 0
695 ## cperl-label-offset: -2
696 ## cperl-extra-newline-before-brace: t
697 ## cperl-merge-trailing-else: nil
698 ## cperl-continued-statement-offset: 2