doc update from akim
[automake.git] / aclocal.in
blob5b11415682df9178114954b796c2fcef407a5e10
1 #!@PERL@
2 # -*- perl -*-
3 # @configure_input@
5 # aclocal - create aclocal.m4 by scanning configure.in
6 # Copyright (C) 1996, 1997 Free Software Foundation, Inc.
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 2, or (at your option)
11 # any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
21 # 02111-1307, USA.
23 # Written by Tom Tromey <tromey@cygnus.com>.
25 eval 'exec @PERL@ -S $0 ${1+"$@"}'
26     if 0;
28 # aclocal - scan configure.in and generate aclocal.m4.
30 # Some constants.
31 $VERSION = "@VERSION@";
32 $PACKAGE = "@PACKAGE@";
33 $prefix = "@prefix@";
34 # Note that this isn't pkgdatadir, but a separate directory.
35 $acdir = "@datadir@/aclocal";
37 # Some globals.
39 # Exit status.
40 $exit_status = 0;
42 # Text to output.
43 $output = '';
45 # Output file name.
46 $output_file = 'aclocal.m4';
48 # Which macros have been seen.
49 %macro_seen = ();
51 # Which files have been seen.
52 %file_seen = ();
54 # Map macro names to file names.
55 %map = ();
57 # Map file names to file contents.
58 %file_contents = ();
60 # How much to say.
61 $verbosity = 0;
63 @obsolete_macros =
64     (
65      'AC_FEATURE_CTYPE',
66      'AC_FEATURE_ERRNO',
67      'AC_FEATURE_EXIT',
68      'AC_SYSTEM_HEADER',
69      'fp_C_PROTOTYPES',
70      'fp_FUNC_FNMATCH',
71      'fp_PROG_CC_STDC',
72      'fp_PROG_INSTALL',
73      'fp_WITH_DMALLOC',
74      'fp_WITH_REGEX',
75      'gm_PROG_LIBTOOL',
76      'jm_MAINTAINER_MODE',
77      'md_TYPE_PTRDIFF_T',
78      'ud_PATH_LISPDIR',
79      'ud_GNU_GETTEXT',
81      # Now part of autoconf proper, under a different name.
82      'AM_FUNC_FNMATCH',
83      'AM_SANITY_CHECK_CC',
85 # These aren't quite obsolete.
86 #      'md_PATH_PROG',
87 #      'ud_LC_MESSAGES',
88 #      'ud_WITH_NLS'
89      );
91 $obsolete_rx = '(' . join ('|', @obsolete_macros) . ')';
93 # Matches a macro definition.
94 $ac_defun_rx = "AC_DEFUN\\(\\[?([^],)\n]+)\\]?";
96 # Matches an AC_REQUIRE line.
97 $ac_require_rx = "AC_REQUIRE\\(\\[?([^])]*)\\]?\\)";
101 local (@dirlist) = &parse_arguments (@ARGV);
102 &scan_m4_files ($acdir, @dirlist);
103 &scan_configure;
104 if (! $exit_status)
106     &write_aclocal;
108 &check_acinclude;
110 exit $exit_status;
112 ################################################################
114 # Print usage and exit.
115 sub usage
117     local ($status) = @_;
119     print "Usage: aclocal [OPTIONS] ...\n\n";
120     print "Generate aclocal.m4 by scanning configure.in\n
121   --acdir=DIR           directory holding config files
122   --help                print this help, then exit
123   -I DIR                add directory to search list for .m4 files
124   --output=FILE         put output in FILE (default aclocal.m4)
125   --verbose             don't be silent
126   --version             print version number, then exit
128 Report bugs to <automake-bugs\@prep.ai.mit.edu>.\n";
130     exit $status;
133 # Parse command line.
134 sub parse_arguments
136     local (@arglist) = @_;
137     local (@dirlist);
139     while (@arglist)
140     {
141         if ($arglist[0] =~ /^--acdir=(.+)$/)
142         {
143             $acdir = $1;
144         }
145         elsif ($arglist[0] =~/^--output=(.+)$/)
146         {
147             $output_file = $1;
148         }
149         elsif ($arglist[0] eq '-I')
150         {
151             shift (@arglist);
152             push (@dirlist, $arglist[0]);
153         }
154         elsif ($arglist[0] eq '--verbose')
155         {
156             ++$verbosity;
157         }
158         elsif ($arglist[0] eq '--version')
159         {
160             print "aclocal (GNU $PACKAGE) $VERSION\n\n";
161             print "Copyright (C) 1996, 1997 Free Software Foundation, Inc.\n";
162             print "This is free software; see the source for copying conditions.  There is NO\n";
163             print "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n";
164             print "Written by Tom Tromey <tromey\@cygnus.com>\n";
165             exit 0;
166         }
167         elsif ($arglist[0] eq '--help')
168         {
169             &usage (0);
170         }
171         else
172         {
173             die "aclocal: unrecognized option -- \`$arglist[0]'\nTry \`aclocal --help' for more information.\n";
174         }
176         shift (@arglist);
177     }
179     return @dirlist;
182 ################################################################
184 sub scan_configure
186     open (CONFIGURE, "configure.in")
187         || die "aclocal: couldn't open \`configure.in': $!\n";
189     # Make sure we include acinclude.m4 if it exists.
190     if (-f 'acinclude.m4')
191     {
192         &add_file ('acinclude.m4');
193     }
195     while (<CONFIGURE>)
196     {
197         # Remove comments from current line.
198         s/\bdnl\b.*$//;
199         s/\#.*$//;
201         if (/$obsolete_rx/o)
202         {
203             chop;
204             warn "aclocal: configure.in: $.: obsolete macro \`$_'\n";
205             $exit_status = 1;
206             next;
207         }
209         # Search for things we know about.  The "search" sub is
210         # constructed dynamically, above.
211         &search;
212     }
214     close (CONFIGURE);
217 ################################################################
219 # Check macros in acinclude.m4.  If one is not used, warn.
220 sub check_acinclude
222     local ($key);
224     foreach $key (keys %map)
225     {
226         next unless $map{$key} eq 'acinclude.m4';
227         if (! $macro_seen{$key})
228         {
229             # FIXME: should print line number of acinclude.m4.
230             warn "aclocal: macro \`$key' defined in acinclude.m4 but never used\n";
231         }
232     }
235 ################################################################
237 # Scan all the installed m4 files and construct a map.
238 sub scan_m4_files
240     local (@dirlist) = @_;
242     # First, scan acinclude.m4 if it exists.
243     if (-f 'acinclude.m4')
244     {
245         $file_contents{'acinclude.m4'} = &scan_file ('acinclude.m4');
246     }
248     local ($m4dir);
249     foreach $m4dir (@dirlist)
250     {
251         opendir (DIR, $m4dir)
252             || die "aclocal: couldn't open directory \`$m4dir': $!\n";
253         local ($file, $fullfile, $expr);
254         foreach $file (sort grep (! /^\./, readdir (DIR)))
255         {
256             # Only examine .m4 files.
257             next unless $file =~ /\.m4$/;
259             # Skip some files when running out of srcdir.
260             next if $file eq 'aclocal.m4';
262             $fullfile = $m4dir . '/' . $file;
263             $file_contents{$fullfile} = &scan_file ($fullfile);
264         }
265         closedir (DIR);
266     }
268     # Construct a new function that does the searching.  We use a
269     # function (instead of just evalling $search in the loop) so that
270     # "die" is correctly and easily propagated if run.
271     local ($search, $expr, $key) = '';
272     foreach $key (keys %map)
273     {
274         # EXPR is a regexp matching the name of the macro.
275         ($expr = $key) =~ s/(\W)/\\$1/g;
276         $search .= "&add_macro ('" . $key . "') if /" . $expr . "/;\n";
277     }
278     eval 'sub search { ' . $search . '};';
279     die "internal error: $@\n search is $search " if $@;
282 ################################################################
284 # Add a macro to the output.
285 sub add_macro
287     local ($macro) = @_;
289     # We want to ignore AC_ macros.  However, if an AC_ macro is
290     # defined in (eg) acinclude.m4, then we want to make sure we mark
291     # it as seen.
292     return if $macro =~ /^AC_/ && ! defined $map{$macro};
294     if (! defined $map{$macro})
295     {
296         warn "aclocal: macro \`$macro' required but not defined\n";
297         $exit_status = 1;
298         return;
299     }
301     print STDERR "saw macro $macro\n" if $verbosity;
302     $macro_seen{$macro} = 1;
303     &add_file ($map{$macro});
306 # Add a file to output.
307 sub add_file
309     local ($file) = @_;
311     # Only add a file once.
312     return if ($file_seen{$file});
313     $file_seen{$file} = 1;
315     $output .= $file_contents{$file} . "\n";
316     local (@rlist);
317     foreach (split ("\n", $file_contents{$file}))
318     {
319         if (/$ac_require_rx/g)
320         {
321             push (@rlist, $1);
322         }
324         # This function constructed dynamically.
325         &search;
326     }
328     local ($macro);
329     foreach $macro (@rlist)
330     {
331         &add_macro ($macro);
332     }
335 # Scan a single M4 file.  Return contents.
336 sub scan_file
338     local ($file) = @_;
340     open (FILE, $file)
341         || die "aclocal: couldn't open \`$file': $!\n";
342     local ($contents) = '';
343     while (<FILE>)
344     {
345         # Ignore `##' lines.
346         next if /^##/;
348         $contents .= $_;
350         if (/$ac_defun_rx/)
351         {
352             if (!defined $map{$1})
353             {
354                 $map{$1} = $file;
355             }
356             # Allow acinclude.m4 to override other macro files.
357             elsif ($map{$1} ne 'acinclude.m4' || $file eq 'acinclude.m4')
358             {
359                 warn "aclocal: $file: $.: duplicated macro \`$1'\n";
360                 $exit_status = 1;
361             }
362             print STDERR "Found macro $1 in $file: $.\n" if $verbosity;
363         }
364     }
365     close (FILE);
367     return $contents;
370 ################################################################
372 # Write output.
373 sub write_aclocal
375     return if ! length ($output);
377     print STDERR "Writing aclocal.m4\n" if $verbosity;
379     open (ACLOCAL, "> aclocal.m4")
380         || die "aclocal: couldn't open \`aclocal.m4' for writing: $!\n";
381     print ACLOCAL "dnl aclocal.m4 generated automatically by aclocal $VERSION\n";
382     print ACLOCAL "\
383 dnl Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
384 dnl This Makefile.in is free software; the Free Software Foundation
385 dnl gives unlimited permission to copy and/or distribute it,
386 dnl with or without modifications, as long as this notice is preserved.
388 dnl This program is distributed in the hope that it will be useful,
389 dnl but WITHOUT ANY WARRANTY, to the extent permitted by law; without
390 dnl even the implied warranty of MERCHANTABILITY or FITNESS FOR A
391 dnl PARTICULAR PURPOSE.
394     print ACLOCAL $output;
395     close (ACLOCAL);