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);
38 use Automake::General;
39 use Automake::Configure_ac;
40 use Automake::Channels;
42 use Automake::FileUtils;
47 # Note that this isn't pkgdatadir, but a separate directory.
48 # Note also that the versioned directory is handled later.
49 $acdir = '@datadir@/aclocal';
50 $default_acdir = $acdir;
51 # contains a list of directories, one per line, to be added
52 # to the dirlist in addition to $acdir, as if -I had been
53 # added to the command line. If acdir has been redirected,
54 # we will also check the specified acdir (this is done later).
55 $default_dirlist = "$default_acdir/dirlist";
59 # configure.ac or configure.in.
63 $output_file = 'aclocal.m4';
65 # Modification time of the youngest dependency.
71 # Which macros have been seen.
74 # Which files have been seen.
77 # Remember the order into which we scanned the files.
78 # It's important to output the contents of aclocal.m4 in the opposite order.
79 # (Definitions in first files we have scanned should override those from
80 # later files. So they must appear last in the output.)
83 # Map macro names to file names.
86 # Ditto, but records the last definition of each macro as returned by --trace.
87 %map_traced_defs = ();
89 # Map file names to file contents.
92 # Map file names to included files (transitively closed).
98 # Matches a macro definition.
99 # AC_DEFUN([macroname], ...)
101 # AC_DEFUN(macroname, ...)
102 # When macroname is `['-quoted , we accept any character in the name,
103 # except `]'. Otherwise macroname stops on the first `]', `,', `)',
104 # or `\n' encountered.
105 $ac_defun_rx = "A[CU]_DEFUN\\((?:\\[([^]]+)\\]|([^],)\n]+))";
107 # Matches an AC_REQUIRE line.
108 $ac_require_rx = "AC_REQUIRE\\((?:\\[([^]]+)\\]|([^],)\n]+))\\)";
110 # Matches an m4_include line
111 $m4_include_rx = "(?:m4_)?s?include\\((?:\\[([^]]+)\\]|([^],)\n]+))\\)";
114 ################################################################
116 # Check macros in acinclude.m4. If one is not used, warn.
117 sub check_acinclude ()
119 foreach my $key (keys %map)
121 # FIXME: should print line number of acinclude.m4.
122 warn ("aclocal: warning: macro `$key' defined in "
123 . "acinclude.m4 but never used\n")
124 if $map{$key} eq 'acinclude.m4' && ! $macro_seen{$key};
128 ################################################################
130 # Scan all the installed m4 files and construct a map.
131 sub scan_m4_files (@)
133 local (@dirlist) = @_;
135 # First, scan configure.ac. It may contain macro definitions,
136 # or may include other files that define macros.
137 &scan_file ($configure_ac, 'aclocal');
139 # Then, scan acinclude.m4 if it exists.
140 if (-f 'acinclude.m4')
142 &scan_file ('acinclude.m4', 'aclocal');
145 # Finally, scan all files in our search path.
147 foreach $m4dir (@dirlist)
149 if (! opendir (DIR, $m4dir))
151 print STDERR "aclocal: couldn't open directory `$m4dir': $!\n";
155 local ($file, $fullfile);
156 # We reverse the directory contents so that foo2.m4 gets
157 # used in preference to foo1.m4.
158 foreach $file (reverse sort grep (! /^\./, readdir (DIR)))
160 # Only examine .m4 files.
161 next unless $file =~ /\.m4$/;
163 # Skip some files when running out of srcdir.
164 next if $file eq 'aclocal.m4';
166 $fullfile = File::Spec->canonpath ("$m4dir/$file");
167 &scan_file ($fullfile, 'aclocal');
172 # Construct a new function that does the searching. We use a
173 # function (instead of just evaluating $search in the loop) so that
174 # "die" is correctly and easily propagated if run.
175 my $search = "sub search {\nmy \$found = 0;\n";
176 foreach my $key (reverse sort keys %map)
178 $search .= ('if (/\b\Q' . $key . '\E(?!\w)/) { & add_macro ("' . $key
179 . '"); $found = 1; }' . "\n");
181 $search .= "return \$found;\n};\n";
183 die "internal error: $@\n search is $search" if $@;
186 ################################################################
188 # Add a macro to the output.
193 # Ignore unknown required macros. Either they are not really
194 # needed (e.g., a conditional AC_REQUIRE), in which case aclocal
195 # should be quiet, or they are needed and Autoconf itself will
196 # complain when we trace for macro usage later.
197 return unless defined $map{$macro};
199 print STDERR "aclocal: saw macro $macro\n" if $verbose;
200 $macro_seen{$macro} = 1;
201 &add_file ($map{$macro});
204 # rel2abs ($file, $directory)
205 # ---------------------------
206 # Similar to File::Spec->rel2abs ($file, $directory), but
207 # work with Perl 5.005. (File::Spec->rel2abs is available
209 # Remove this once we require 5.6.
212 my ($file, $dir) = @_;
213 if (! File::Spec->file_name_is_absolute ($file))
215 $dir = cwd () . "/$dir"
216 unless File::Spec->file_name_is_absolute ($dir);
217 $file = "$dir/$file";
219 $file = File::Spec->canonpath ($file);
223 # scan_configure_dep ($file)
224 # --------------------------
225 # Scan a configure dependency (configure.ac, or separate m4 files)
226 # for uses of know macros and AC_REQUIREs of possibly unknown macros.
227 # Recursively scan m4_included files.
228 my %scanned_configure_dep = ();
229 sub scan_configure_dep ($)
232 # Do not scan a file twice.
234 if exists $scanned_configure_dep{$file};
235 $scanned_configure_dep{$file} = 1;
237 my $mtime = mtime $file;
238 $greatest_mtime = $mtime if $greatest_mtime < $mtime;
240 my $contents = exists $file_contents{$file} ?
241 $file_contents{$file} : contents $file;
246 foreach (split ("\n", $contents))
249 # Remove comments from current line.
253 while (/$m4_include_rx/go)
255 push (@ilist, $1 || $2);
258 while (/$ac_require_rx/go)
260 push (@rlist, $1 || $2);
263 # The search function is constructed dynamically by
264 # scan_m4_files. The last parenthetical match makes sure we
265 # don't match things that look like macro assignments or
267 if (! &search && /(^|\s+)(AM_[A-Z0-9_]+)($|[^\]\)=A-Z0-9_])/)
269 # Macro not found, but AM_ prefix found.
270 # Make this just a warning, because we do not know whether
271 # the macro is actually used (it could be called conditionally).
272 warn ("aclocal:$file:$line: warning: "
273 . "macro `$2' not found in library\n");
277 add_macro ($_) foreach (@rlist);
278 my $dirname = dirname $file;
279 &scan_configure_dep (rel2abs ($_, $dirname)) foreach (@ilist);
282 # Add a file to output.
287 # Only add a file once.
288 return if ($file_seen{$file});
289 $file_seen{$file} = 1;
291 scan_configure_dep $file;
294 # Point to the documentation for underquoted AC_DEFUN only once.
295 my $underquoted_manual_once = 0;
297 # scan_file ($FILE, $WHERE)
298 # -------------------------
299 # Scan a single M4 file ($FILE), and all files it includes.
300 # Return the list of included files.
301 # $WHERE is the location to use in the diagnostic if the file
305 my ($file, $where) = @_;
306 my $base = dirname $file;
308 # Do not scan the same file twice.
309 return @$file_includes{$file} if exists $file_includes{$file};
310 # Prevent potential infinite recursion (if two files include each other).
311 return () if exists $file_contents{$file};
313 unshift @file_order, $file;
317 print STDERR "$where: file `$file' does not exist\n";
321 my $fh = new Automake::XFile $file;
325 while ($_ = $fh->getline)
332 while (/$ac_defun_rx/go)
336 print STDERR "$file:$.: warning: underquoted definition of $2\n";
337 print STDERR " run info '(automake)Extending aclocal'\n"
338 . " or see http://sources.redhat.com/automake/"
339 . "automake.html#Extending-aclocal\n"
340 unless $underquoted_manual_once;
341 $underquoted_manual_once = 1;
343 my $macro = $1 || $2;
344 if (! defined $map{$macro})
346 print STDERR "aclocal: found macro $macro in $file: $.\n"
348 $map{$macro} = $file;
352 # Note: we used to give an error here if we saw a
353 # duplicated macro. However, this turns out to be
354 # extremely unpopular. It causes actual problems which
355 # are hard to work around, especially when you must
356 # mix-and-match tool versions.
357 print STDERR "aclocal: ignoring macro $macro in $file: $.\n"
362 while (/$m4_include_rx/go)
364 my $ifile = $1 || $2;
365 # m4_include is relative to the directory of the file which
366 # perform the include, but we want paths relative to the
367 # directory where aclocal is run. Do not use
368 # File::Spec->rel2abs, because we want to store relative
369 # paths (they might be used later of aclocal outputs an
370 # m4_include for this file, or if the user itself includes
372 $ifile = "$base/$ifile"
373 unless $base eq '.' || File::Spec->file_name_is_absolute ($ifile);
374 push (@inc_files, $ifile);
375 $inc_lines{$ifile} = $.;
378 $file_contents{$file} = $contents;
380 # For some reason I don't understand, it does not work
381 # to do `map { scan_file ($_, ...) } @inc_files' below.
382 # With Perl 5.8.2 it undefines @inc_files.
383 my @copy = @inc_files;
384 my @all_inc_files = (@inc_files,
385 map { scan_file ($_, "$file:$inc_lines{$_}") } @copy);
386 $file_includes{$file} = \@all_inc_files;
387 return @all_inc_files;
390 # strip_redundant_includes (%FILES)
391 # ---------------------------------
392 # Each key in %FILES is a file that must be present in the output.
393 # However some of these files might already include other files in %FILES,
394 # so there is no point in including them another time.
395 # This removes items of %FILES which are already included by another file.
396 sub strip_redundant_includes (%)
399 # Files at the end of @file_order should override those at the beginning,
400 # so it is important to preserve these trailing files. We can remove
401 # a file A if it is going to be output before a file B that includes
402 # file A, not the converse.
403 foreach my $file (reverse @file_order)
405 next unless exists $files{$file};
406 foreach my $ifile (@{$file_includes{$file}})
408 next unless exists $files{$ifile};
409 delete $files{$ifile};
410 print STDERR "$ifile is already included by $file\n"
417 sub trace_used_macros ()
419 my %files = map { $map{$_} => 1 } keys %macro_seen;
420 $files{'acinclude.m4'} = 1 if -f 'acinclude.m4';
421 %files = strip_redundant_includes %files;
422 # configure.ac is implicitly included.
423 delete $files{$configure_ac};
425 my $traces = ($ENV{AUTOM4TE} || 'autom4te');
426 $traces .= " --language Autoconf-without-aclocal-m4 ";
427 # All candidate files.
428 $traces .= join (' ', grep { exists $files{$_} } @file_order) . " ";
429 # All candidate macros.
430 $traces .= join (' ', map { "--trace='$_:\$f:\$n:\$1'" } ('AC_DEFUN',
434 print STDERR "aclocal: running $traces $configure_ac\n" if $verbose;
436 my $tracefh = new Automake::XFile ("$traces $configure_ac |");
440 while ($_ = $tracefh->getline)
443 my ($file, $macro, $arg1) = split (/:/);
445 $traced{$macro} = 1 if $macro_seen{$macro};
447 $map_traced_defs{$arg1} = $file
448 if $macro eq 'AC_DEFUN' || $macro eq 'AU_DEFUN';
456 sub scan_configure ()
458 # Make sure we include acinclude.m4 if it exists.
459 if (-f 'acinclude.m4')
461 add_file ('acinclude.m4');
463 scan_configure_dep ($configure_ac);
466 ################################################################
469 sub write_aclocal ($@)
471 my ($output_file, @macros) = @_;
475 # Get the list of files containing definitions for the macros used.
476 # (Filter out unused macro definitions with $map_traced_defs. This
477 # can happen when an Autoconf macro is conditionally defined:
478 # aclocal sees the potential definition, but this definition is
479 # actually never processed and the Autoconf implementation is used
483 $files{$map{$m}} = 1 if $map{$m} eq $map_traced_defs{$m};
485 $files{'acinclude.m4'} = 1 if -f 'acinclude.m4';
486 %files = strip_redundant_includes %files;
487 delete $files{$configure_ac};
489 for $file (grep { exists $files{$_} } @file_order)
491 # Check the time stamp of this file, and all files it includes.
492 for my $ifile ($file, @{$file_includes{$file}})
494 my $mtime = mtime $ifile;
495 $greatest_mtime = $mtime if $greatest_mtime < $mtime;
498 # If the file to add looks like outside the project, copy it
499 # to the output. The regex catches filenames starting with
500 # things like `/', `\', or `c:\'.
501 if ($file =~ m,^(?:\w:)?[\\/],)
503 $output .= $file_contents{$file} . "\n";
507 # Otherwise, simply include the file.
508 $output .= "m4_include([$file])\n";
512 # Nothing to output?!
513 # FIXME: Shouldn't we diagnose this?
514 return if ! length ($output);
516 # We used to print `# $output_file generated automatically etc.' But
517 # this creates spurious differences when using autoreconf. Autoreconf
518 # creates aclocal.m4t and then rename it to aclocal.m4, but the
519 # rebuild rules generated by Automake create aclocal.m4 directly --
520 # this would gives two ways to get the same file, with a different
521 # name in the header.
522 $output = "# generated automatically by aclocal $VERSION -*- Autoconf -*-
524 # Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
525 # Free Software Foundation, Inc.
526 # This file is free software; the Free Software Foundation
527 # gives unlimited permission to copy and/or distribute it,
528 # with or without modifications, as long as this notice is preserved.
530 # This program is distributed in the hope that it will be useful,
531 # but WITHOUT ANY WARRANTY, to the extent permitted by law; without
532 # even the implied warranty of MERCHANTABILITY or FITNESS FOR A
533 # PARTICULAR PURPOSE.
537 # We try not to update $output_file unless necessary, because
538 # doing so invalidate Autom4te's cache and therefore slows down
539 # tools called after aclocal.
541 # We need to overwrite $output_file in the following situations.
542 # * The --force option is in use.
543 # * One of the dependencies is younger.
544 # (Not updating $output_file in this situation would cause
545 # make to call aclocal in loop.)
546 # * The contents of the current file are different from what
549 && $greatest_mtime < mtime ($output_file)
550 && $output eq contents ($output_file))
552 print STDERR "aclocal: $output_file unchanged\n" if $verbose;
556 print STDERR "aclocal: writing $output_file\n" if $verbose;
558 my $out = new Automake::XFile "> $output_file";
563 ################################################################
565 # Print usage and exit.
568 local ($status) = @_;
570 print "Usage: aclocal [OPTIONS] ...\n\n";
572 Generate `aclocal.m4' by scanning `configure.ac' or `configure.in'
574 --acdir=DIR directory holding config files
575 --help print this help, then exit
576 -I DIR add directory to search list for .m4 files
577 --force always update output file
578 --output=FILE put output in FILE (default aclocal.m4)
579 --print-ac-dir print name of directory holding m4 files
580 --verbose don't be silent
581 --version print version number, then exit
583 Report bugs to <bug-automake\@gnu.org>.\n";
588 # Parse command line.
589 sub parse_arguments (@)
591 local (@arglist) = @_;
593 local ($print_and_exit) = 0;
597 if ($arglist[0] =~ /^--acdir=(.+)$/)
601 elsif ($arglist[0] =~/^--output=(.+)$/)
605 elsif ($arglist[0] eq '-I')
608 push (@dirlist, $arglist[0]);
610 elsif ($arglist[0] eq '--print-ac-dir')
614 elsif ($arglist[0] eq '--force')
618 elsif ($arglist[0] eq '--verbose')
622 elsif ($arglist[0] eq '--version')
624 print "aclocal (GNU $PACKAGE) $VERSION\n";
625 print "Written by Tom Tromey <tromey\@redhat.com>\n";
626 print " and Alexandre Duret-Lutz <adl\@gnu.org>\n\n";
627 print "Copyright (C) 2004 Free Software Foundation, Inc.\n";
628 print "This is free software; see the source for copying conditions. There is NO\n";
629 print "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n";
632 elsif ($arglist[0] eq '--help')
638 print STDERR "aclocal: unrecognized option -- `$arglist[0]'\nTry `aclocal --help' for more information.\n";
651 $default_dirlist="$acdir/dirlist"
652 if $acdir ne $default_acdir;
654 # Search the versioned directory near the end, and then the
655 # unversioned directory last. Only do this if the user didn't
657 push (@dirlist, "$acdir-$APIVERSION")
658 if $acdir eq $default_acdir;
660 # By default $(datadir)/aclocal doesn't exist. We don't want to
661 # get an error in the case where we are searching the default
662 # directory and it hasn't been created.
663 push (@dirlist, $acdir)
664 unless $acdir eq $default_acdir && ! -d $acdir;
666 # Finally, adds any directory listed in the `dirlist' file.
667 if (open (DEFAULT_DIRLIST, $default_dirlist))
669 while (<DEFAULT_DIRLIST>)
673 # strip off newlines and end-of-line comments
675 chomp ($contents=$_);
678 push (@dirlist, $contents);
681 close (DEFAULT_DIRLIST);
687 ################################################################
689 local (@dirlist) = parse_arguments (@ARGV);
690 $configure_ac = require_configure_ac;
691 scan_m4_files (@dirlist);
695 my %macro_traced = trace_used_macros;
696 write_aclocal ($output_file, keys %macro_traced);
702 ### Setup "GNU" style for perl-mode and cperl-mode.
704 ## perl-indent-level: 2
705 ## perl-continued-statement-offset: 2
706 ## perl-continued-brace-offset: 0
707 ## perl-brace-offset: 0
708 ## perl-brace-imaginary-offset: 0
709 ## perl-label-offset: -2
710 ## cperl-indent-level: 2
711 ## cperl-brace-offset: 0
712 ## cperl-continued-brace-offset: 0
713 ## cperl-label-offset: -2
714 ## cperl-extra-newline-before-brace: t
715 ## cperl-merge-trailing-else: nil
716 ## cperl-continued-statement-offset: 2