Spelling and minor grammar fixes.
[platform/upstream/automake.git] / aclocal.in
index 212ab35..e4465a8 100644 (file)
 # -*- perl -*-
 # @configure_input@
 
-eval 'exec @PERL@ -S $0 ${1+"$@"}'
+eval 'case $# in 0) exec @PERL@ -S "$0";; *) exec @PERL@ -S "$0" "$@";; esac'
     if 0;
 
-# aclocal - scan configure.in and generate aclocal.m4.
+# aclocal - create aclocal.m4 by scanning configure.ac
 
-# Some constants.
-$VERSION = "@VERSION@";
-$PACKAGE = "@PACKAGE@";
-$prefix = "@prefix@";
-$acdir = "@datadir@/@PACKAGE@";
+# Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
+#           Free Software Foundation, Inc.
+
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2, or (at your option)
+# any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+# 02111-1307, USA.
+
+# Written by Tom Tromey <tromey@redhat.com>.
+
+BEGIN
+{
+  my $perllibdir = $ENV{'perllibdir'} || '@datadir@/@PACKAGE@-@APIVERSION@';
+  unshift @INC, (split ':', $perllibdir);
+}
+
+use Automake::Config;
+use Automake::General;
+use Automake::Configure_ac;
+use Automake::XFile;
+use Automake::FileUtils;
+use File::stat;
+
+# Note that this isn't pkgdatadir, but a separate directory.
+# Note also that the versioned directory is handled later.
+$acdir = '@datadir@/aclocal';
+$default_acdir = $acdir;
+# contains a list of directories, one per line, to be added
+# to the dirlist in addition to $acdir, as if -I had been
+# added to the command line.  If acdir has been redirected,
+# we will also check the specified acdir (this is done later).
+$default_dirlist = "$default_acdir/dirlist";
 
 # Some globals.
 
+# configure.ac or configure.in.
+my $configure_ac = require_configure_ac;
+
 # Exit status.
 $exit_status = 0;
 
-# Text to output.
-$output = '';
-
 # Output file name.
 $output_file = 'aclocal.m4';
 
+# Modification time of the youngest dependency.
+$greatest_mtime = 0;
+
+# Option --force.
+$force_output = 0;
+
 # Which macros have been seen.
 %macro_seen = ();
 
 # Which files have been seen.
 %file_seen = ();
 
+# Remember the order into which we scanned the files.
+# It's important to output the contents of aclocal.m4 in the opposite order.
+@file_order = ();
+
+# Map macro names to file names.
+%map = ();
+
+# Map file names to file contents.
+%file_contents = ();
+
 # How much to say.
-$verbosity = 0;
-
-@obsolete_macros =
-    (
-     'AC_FEATURE_CTYPE',
-     'AC_FEATURE_ERRNO',
-     'AC_FEATURE_EXIT',
-     'AC_SYSTEM_HEADER',
-     'fp_C_PROTOTYPES',
-     'fp_FUNC_FNMATCH',
-     'fp_PROG_CC_STDC',
-     'fp_PROG_INSTALL',
-     'fp_WITH_DMALLOC',
-     'fp_WITH_REGEX',
-     'gm_PROG_LIBTOOL',
-     'jm_MAINTAINER_MODE',
-     'md_TYPE_PTRDIFF_T',
-     'ud_PATH_LISPDIR',
-# These aren't quite obsolete.
-#      'md_PATH_PROG',
-#      'ud_GNU_GETTEXT',
-#      'ud_LC_MESSAGES',
-#      'ud_WITH_NLS'
-     );
-
-$obsolete_rx = '(' . join ('|', @obsolete_macros) . ')';
+$verbose = 0;
+
+# Matches a macro definition.
+#   AC_DEFUN([macroname], ...)
+# or
+#   AC_DEFUN(macroname, ...)
+# When macroname is `['-quoted , we accept any character in the name,
+# except `]'.  Otherwise macroname stops on the first `]', `,', `)',
+# or `\n' encountered.
+$ac_defun_rx = "A[CU]_DEFUN\\((?:\\[([^]]+)\\]|([^],)\n]+))";
+
+# Matches an AC_REQUIRE line.
+$ac_require_rx = "AC_REQUIRE\\((?:\\[([^]]+)\\]|([^],)\n]+))\\)";
 
 \f
 
-&parse_arguments (@ARGV);
+local (@dirlist) = &parse_arguments (@ARGV);
+&scan_m4_files (@dirlist);
 &scan_configure;
 if (! $exit_status)
-{
-    &write_aclocal;
-}
+  {
+    my %macro_traced = &trace_used_macros;
+    &write_aclocal ($output_file, keys %macro_traced);
+  }
+&check_acinclude;
 
 exit $exit_status;
 
 ################################################################
 
 # Print usage and exit.
-sub usage
+sub usage ($)
 {
     local ($status) = @_;
 
-    print "Usage: aclocal [OPTIONS] ...\n";
+    print "Usage: aclocal [OPTIONS] ...\n\n";
     print "\
+Generate `aclocal.m4' by scanning `configure.ac' or `configure.in'
+
   --acdir=DIR           directory holding config files
   --help                print this help, then exit
+  -I DIR                add directory to search list for .m4 files
+  --force               always update output file
   --output=FILE         put output in FILE (default aclocal.m4)
+  --print-ac-dir        print name of directory holding m4 files
   --verbose             don't be silent
-  --version             print version number, then exit\n";
+  --version             print version number, then exit
+
+Report bugs to <bug-automake\@gnu.org>.\n";
 
     exit $status;
 }
 
 # Parse command line.
-sub parse_arguments
+sub parse_arguments (@)
 {
     local (@arglist) = @_;
+    local (@dirlist);
+    local ($print_and_exit) = 0;
 
     while (@arglist)
     {
@@ -102,13 +154,30 @@ sub parse_arguments
        {
            $output_file = $1;
        }
+       elsif ($arglist[0] eq '-I')
+       {
+           shift (@arglist);
+           push (@dirlist, $arglist[0]);
+       }
+       elsif ($arglist[0] eq '--print-ac-dir')
+       {
+           $print_and_exit = 1;
+       }
+       elsif ($arglist[0] eq '--force')
+       {
+           $force_output = 1;
+       }
        elsif ($arglist[0] eq '--verbose')
        {
-           ++$verbosity;
+           ++$verbose;
        }
        elsif ($arglist[0] eq '--version')
        {
-           print "aclocal - GNU $PACKAGE $VERSION\n";
+           print "aclocal (GNU $PACKAGE) $VERSION\n\n";
+           print "Copyright (C) 2003 Free Software Foundation, Inc.\n";
+           print "This is free software; see the source for copying conditions.  There is NO\n";
+           print "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n";
+           print "Written by Tom Tromey <tromey\@redhat.com>\n";
            exit 0;
        }
        elsif ($arglist[0] eq '--help')
@@ -117,145 +186,420 @@ sub parse_arguments
        }
        else
        {
-           &usage (1);
+           print STDERR "aclocal: unrecognized option -- `$arglist[0]'\nTry `aclocal --help' for more information.\n";
+           exit 1;
        }
 
        shift (@arglist);
     }
+
+    if ($print_and_exit)
+    {
+       print $acdir, "\n";
+       exit 0;
+    }
+
+    $default_dirlist="$acdir/dirlist"
+       if $acdir ne $default_acdir;
+
+    # Search the versioned directory near the end, and then the
+    # unversioned directory last.  Only do this if the user didn't
+    # override acdir.
+    push (@dirlist, "$acdir-$APIVERSION")
+       if $acdir eq $default_acdir;
+
+    # By default $(datadir)/aclocal doesn't exist.  We don't want to
+    # get an error in the case where we are searching the default
+    # directory and it hasn't been created.
+    push (@dirlist, $acdir)
+       unless $acdir eq $default_acdir && ! -d $acdir;
+
+    # Finally, adds any directory listed in the `dirlist' file.
+    if (open (DEFAULT_DIRLIST, $default_dirlist))
+    {
+       while (<DEFAULT_DIRLIST>)
+       {
+           # Ignore '#' lines.
+           next if /^#/;
+           # strip off newlines and end-of-line comments
+           s/\s*\#.*$//;
+           chomp ($contents=$_);
+           if (-d $contents )
+           {
+               push (@dirlist, $contents);
+           }
+       }
+       close (DEFAULT_DIRLIST);
+    }
+
+    return @dirlist;
 }
 
 ################################################################
 
-sub scan_configure
+sub scan_configure ()
 {
-    # First, construct list of regexps to match the things we actually
-    # have.
-    opendir (DIR, $acdir)
-       || die "aclocal: couldn't open directory \`$acdir': $!\n";
-    local ($search, $elt);
-    foreach (sort grep (! /^\./, readdir (DIR)))
+  if (! open (CONFIGURE, $configure_ac))
     {
-       # Only examine .m4 files.
-       next unless s/\.m4$//;
+      print STDERR "aclocal: couldn't open `$configure_ac': $!\n";
+      exit 1;
+    }
 
-       # Skip some files when running out of srcdir.  Eg "aclocal.m4"
-       # must be skipped.
-       next unless /^[A-Za-z]+_[A-Z_]+$/;
+  my $mtime = mtime $configure_ac;
+  $greatest_mtime = $mtime if $greatest_mtime < $mtime;
 
-       print STDERR "Finding $_\n" if $verbosity;
-       ($elt = $_) =~ s/(\W)/\\$1/g;
-       $search .= "&add_file (\"$elt\") if /$elt/;\n";
+  # Make sure we include acinclude.m4 if it exists.
+  if (-f 'acinclude.m4')
+    {
+      &add_file ('acinclude.m4');
     }
-    closedir (DIR);
 
-    # Construct a new function that does the searching.  We use a
-    # function (instead of just evalling $search in the loop) so that
-    # "die" is correctly and easily propagated if run.
-    eval 'sub search { ' . $search . '};';
+  while (<CONFIGURE>)
+    {
+      # Remove comments from current line.
+      s/\bdnl\b.*$//;
+      s/\#.*$//;
+
+      # Search for things we know about.  The "search" sub is
+      # constructed dynamically by scan_m4_files.  The last
+      # parenthetical match makes sure we don't match things that
+      # look like macro assignments or AC_SUBSTs.
+      if (! &search && /(^|\s+)(AM_[A-Z0-9_]+)($|[^\]\)=A-Z0-9_])/)
+       {
+         # Macro not found, but AM_ prefix found.
+         warn "aclocal: $configure_ac: $.: macro `$2' not found in library\n";
+         $exit_status = 1;
+       }
+    }
 
-    open (CONFIGURE, "configure.in")
-       || die "aclocal: couldn't open \`configure.in': $!\n";
+  close (CONFIGURE);
+}
 
-    while (<CONFIGURE>)
-    {
-       # Remove comments from current line.
-       s/\bdnl\b.*$//;
-       s/\#.*$//;
+################################################################
 
-       if (/$obsolete_rx/o)
+# Check macros in acinclude.m4.  If one is not used, warn.
+sub check_acinclude ()
+{
+    local ($key);
+
+    foreach $key (keys %map)
+    {
+       next unless $map{$key} eq 'acinclude.m4';
+       if (! $macro_seen{$key})
        {
-           chop;
-           warn "aclocal: configure.in: $.: obsolete macro \`$_'\n";
-           $exit_status = 1;
-           next;
+           # FIXME: should print line number of acinclude.m4.
+           warn "aclocal: macro `$key' defined in acinclude.m4 but never used\n";
        }
-
-       # Search for things we know about.  The "search" sub is
-       # constructed dynamically, above.
-       &search;
     }
+}
+
+################################################################
 
-    close (CONFIGURE);
+# Scan all the installed m4 files and construct a map.
+sub scan_m4_files (@)
+{
+    local (@dirlist) = @_;
 
-    # Include this file if it exists
+    # First, scan acinclude.m4 if it exists.
     if (-f 'acinclude.m4')
     {
-       &add_file ('acinclude.m4');
+       $file_contents{'acinclude.m4'} = &scan_file ('acinclude.m4');
+    }
+
+    local ($m4dir);
+    foreach $m4dir (@dirlist)
+    {
+       if (! opendir (DIR, $m4dir))
+         {
+           print STDERR "aclocal: couldn't open directory `$m4dir': $!\n";
+           exit 1;
+         }
+
+       local ($file, $fullfile);
+       # We reverse the directory contents so that foo2.m4 gets
+       # used in preference to foo1.m4.
+       foreach $file (reverse sort grep (! /^\./, readdir (DIR)))
+       {
+           # Only examine .m4 files.
+           next unless $file =~ /\.m4$/;
+
+           # Skip some files when running out of srcdir.
+           next if $file eq 'aclocal.m4';
+
+           $fullfile = $m4dir . '/' . $file;
+           $file_contents{$fullfile} = &scan_file ($fullfile);
+       }
+       closedir (DIR);
+    }
+
+    # Construct a new function that does the searching.  We use a
+    # function (instead of just evaluating $search in the loop) so that
+    # "die" is correctly and easily propagated if run.
+    my $search = "sub search {\nmy \$found = 0;\n";
+    foreach my $key (reverse sort keys %map)
+    {
+       $search .= ('if (/\b\Q' . $key . '\E(?!\w)/) { & add_macro ("' . $key
+                   . '"); $found = 1; }' . "\n");
     }
+    $search .= "return \$found;\n};\n";
+    eval $search;
+    die "internal error: $@\n search is $search" if $@;
 }
 
 ################################################################
 
+# Add a macro to the output.
+sub add_macro ($)
+{
+    local ($macro) = @_;
+
+    # We want to ignore AC_ macros.  However, if an AC_ macro is
+    # defined in (eg) acinclude.m4, then we want to make sure we mark
+    # it as seen.
+    return if $macro =~ /^AC_/ && ! defined $map{$macro};
+
+    if (! defined $map{$macro})
+    {
+       warn "aclocal: macro `$macro' required but not defined\n";
+       $exit_status = 1;
+       return;
+    }
+
+    print STDERR "aclocal: saw macro $macro\n" if $verbose;
+    $macro_seen{$macro} = 1;
+    &add_file ($map{$macro});
+}
+
 # Add a file to output.
-sub add_file
+sub add_file ($)
 {
-    local ($file) = @_;
-    local ($fullfile) = $file;
+  local ($file) = @_;
+
+  # Only add a file once.
+  return if ($file_seen{$file});
+  $file_seen{$file} = 1;
 
-    return if ($file_seen{$file});
-    $file_seen{$file} = 1;
+  my $mtime = mtime $file;
+  $greatest_mtime = $mtime if $greatest_mtime < $mtime;
 
-    if (! -f $file)
+  # If the file to add looks like path outside the project,
+  # copy it to the output.
+  # The regex catches filenames starting with things like
+  #   / \ c:\ ../ ./../ etc.
+  if ($file =~ m,^(?:(?:\w:)?[\\/]|(?:\.[\\/]+)*\.\.[\\/]),)
+    {
+      $output .= $file_contents{$file} . "\n";
+    }
+  else
     {
-       $fullfile = $acdir . '/' . $file . '.m4';
-       if (! -f $fullfile)
+      # Otherwise, simply include the file.
+      $output .= "m4_include([$file])\n";
+    }
+  my (@rlist);
+  foreach (split ("\n", $file_contents{$file}))
+    {
+      # Remove comments from current line.
+      s/\bdnl\b.*$//;
+      s/\#.*$//;
+
+      if (/$ac_require_rx/g)
+       {
+         push (@rlist, $1 || $2);
+       }
+
+      # The search function is constructed dynamically by
+      # scan_m4_files.  The last parenthetical match makes sure we
+      # don't match things that look like macro assignments or
+      # AC_SUBSTs.
+      if (! &search && /(^|\s+)(AM_[A-Z0-9_]+)($|[^\]\)=A-Z0-9_])/)
        {
-           # Maybe the file is an Autoconf built-in.  Check the only
-           # way we know how.  Suggestions on how to make this better
-           # are welcome.  FIXME should give file and line number of
-           # enclosing file.
-           return if $file =~ /^AC_[A-Z_]+$/;
-           die "aclocal: file \`$file' not found\n";
+         # Macro not found, but AM_ prefix found.
+         warn "aclocal: $configure_ac: $.: macro `$2' not found in library\n";
+         $exit_status = 1;
        }
     }
 
-    open (FILE, $fullfile)
-       || die "aclocal: couldn't open \`$fullfile': $!\n";
+  local ($macro);
+  foreach $macro (@rlist)
+    {
+      &add_macro ($macro);
+    }
+}
+
+# Point to the documentation for underquoted AC_DEFUN only once.
+my $underquoted_manual_once = 0;
+
+# Scan a single M4 file.  Return contents.
+sub scan_file ($)
+{
+  local ($file) = @_;
 
-    local (@rlist);
-    while (<FILE>)
+  unshift @file_order, $file;
+
+  my $fh = new Automake::XFile $file;
+  my $contents = '';
+  while ($_ = $fh->getline)
     {
-       $output .= $_;
+      # Ignore `##' lines.
+      next if /^##/;
 
-       # See if we're defining a macro that was already seen.  This
-       # is mostly a special case for `acinclude.m4'.
-       if (/AC_DEFUN\(\[?([^])]*)\]?/)
-        {
-           if ($1 ne $file && $file_seen{$1})
-           {
-               warn "aclocal: $fullfile: $.: duplicated macro \`$1'\n";
-               $exit_status = 1;
-           }
-           $macro_seen{$1} = 1;
-       }
+      $contents .= $_;
 
-       # See if some other macro is required.
-       if (/AC_REQUIRE\(\[?([^])]*)\]?\)/)
+      if (/$ac_defun_rx/)
        {
-           push (@rlist, $1) unless defined $macro_seen{$1};
+         if (! defined $1)
+           {
+             print STDERR "$file:$.: underquoted definition of $2\n";
+             print STDERR "$file:$.: run info '(automake)Extending aclocal'\n"
+               . "or see http://sources.redhat.com/automake/"
+               . "automake.html#Extending%20aclocal\n"
+               unless $underquoted_manual_once;
+             $underquoted_manual_once = 1;
+           }
+         if (! defined $map{$1 || $2})
+           {
+             print STDERR "aclocal: found macro $1 in $file: $.\n"
+               if $verbose;
+             $map{$1 || $2} = $file;
+           }
+         else
+           {
+             # Note: we used to give an error here if we saw a
+             # duplicated macro.  However, this turns out to be
+             # extremely unpopular.  It causes actual problems which
+             # are hard to work around, especially when you must
+             # mix-and-match tool versions.
+             print STDERR "aclocal: ignoring macro $1 in $file: $.\n"
+               if $verbose;
+           }
        }
     }
-    $output .= "\n";
-    close (FILE);
 
-    foreach $file (@rlist)
+  return $contents;
+}
+
+sub trace_used_macros ($)
+{
+  my ($filename) = @_;
+
+  my %files = map { $map{$_} => 1 } keys %macro_seen;
+
+  my $traces = ($ENV{AUTOM4TE} || 'autom4te');
+  $traces .= " --language Autoconf-without-aclocal-m4 $filename ";
+  # All candidate files.
+  $traces .= join (' ', grep { exists $files{$_} } @file_order) . " ";
+  # All candidate macros.
+  $traces .= join (' ', map { "--trace='$_:\$n'" } (keys %macro_seen));
+
+  print STDERR "aclocal: running $traces $configure_ac\n" if $verbose;
+
+  my $tracefh = new Automake::XFile ("$traces $configure_ac |");
+
+  my %traced = ();
+
+  while ($_ = $tracefh->getline)
     {
-       &add_file ($file);
+      chomp;
+      $traced{$_} = 1 if $macro_seen{$_};
     }
+  return %traced;
 }
 
 ################################################################
 
 # Write output.
-sub write_aclocal
+sub write_aclocal ($@)
 {
-    return if ! $output;
+  my ($output_file, @macros) = @_;
+  my $output = '';
 
-    print STDERR "Writing aclocal.m4\n" if $verbosity;
+  my %files = map { $map{$_} => 1 } @macros;
+  $files{'acinclude.m4'} = 1 if -f 'acinclude.m4';
 
-    open (ACLOCAL, "> aclocal.m4")
-       || die "aclocal: couldn't open \`aclocal.m4' for writing: $!\n";
-    print ACLOCAL "dnl aclocal.m4 generated automatically by aclocal $VERSION\n\n";
-    print ACLOCAL $output;
-    close (ACLOCAL);
+  for $file (grep { exists $files{$_} } @file_order)
+    {
+      my $mtime = mtime $file;
+      $greatest_mtime = $mtime if $greatest_mtime < $mtime;
+
+      # If the file to add looks like path outside the project,
+      # copy it to the output.
+      # The regex catches filenames starting with things like
+      #   / \ c:\ ../ ./../ etc.
+      if ($file =~ m,^(?:(?:\w:)?[\\/]|(?:\.[\\/]+)*\.\.[\\/]),)
+       {
+         $output .= $file_contents{$file} . "\n";
+       }
+      else
+       {
+         # Otherwise, simply include the file.
+         $output .= "m4_include([$file])\n";
+       }
+    }
+
+  # Nothing to output?!
+  # FIXME: Shouldn't we diagnose this?
+  return if ! length ($output);
+
+  # We used to print `# $output_file generated automatically etc.'  But
+  # this creates spurious differences when using autoreconf.  Autoreconf
+  # creates aclocal.m4t and then rename it to aclocal.m4, but the
+  # rebuild rules generated by Automake create aclocal.m4 directly --
+  # this would gives two ways to get the same file, with a different
+  # name in the header.
+  $output = "# generated automatically by aclocal $VERSION -*- Autoconf -*-
+
+# Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
+# Free Software Foundation, Inc.
+# This file is free software; the Free Software Foundation
+# gives unlimited permission to copy and/or distribute it,
+# with or without modifications, as long as this notice is preserved.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+# PARTICULAR PURPOSE.
+
+$output";
+
+  # We try not to update $output_file unless necessary, because
+  # doing so invalidate Autom4te's cache and therefore slows down
+  # tools called after aclocal.
+  #
+  # We need to overwrite $output_file in the following situations.
+  #   * The --force option is in use.
+  #   * One of the dependencies is younger.
+  #     (Not updating $output_file in this situation would cause
+  #     make to call aclocal in loop.)
+  #   * The contents of the current file are different from what
+  #     we have computed.
+  if (!$force_output
+      && $greatest_mtime < mtime ($output_file)
+      && $output eq contents ($output_file))
+    {
+      print STDERR "aclocal: $output_file unchanged\n" if $verbose;
+      return;
+    }
+
+  print STDERR "aclocal: writing $output_file\n" if $verbose;
+
+  my $out = new Automake::XFile "> $output_file";
+  print $out $output;
+  return;
 }
+
+### Setup "GNU" style for perl-mode and cperl-mode.
+## Local Variables:
+## perl-indent-level: 2
+## perl-continued-statement-offset: 2
+## perl-continued-brace-offset: 0
+## perl-brace-offset: 0
+## perl-brace-imaginary-offset: 0
+## perl-label-offset: -2
+## cperl-indent-level: 2
+## cperl-brace-offset: 0
+## cperl-continued-brace-offset: 0
+## cperl-label-offset: -2
+## cperl-extra-newline-before-brace: t
+## cperl-merge-trailing-else: nil
+## cperl-continued-statement-offset: 2
+## End: