cleanup: drop a redundant %?FIRST% transform
[automake.git] / automake.in
blob805e0e9c2a5cde082953c822dc44726bf46e0100
1 #!@PERL@ -w
2 # -*- perl -*-
3 # @configure_input@
5 eval 'case $# in 0) exec @PERL@ -S "$0";; *) exec @PERL@ -S "$0" "$@";; esac'
6     if 0;
8 # automake - create Makefile.in from Makefile.am
9 # Copyright (C) 1994-2012 Free Software Foundation, Inc.
11 # This program is free software; you can redistribute it and/or modify
12 # it under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 2, or (at your option)
14 # any later version.
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 # GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License
22 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
24 # Originally written by David Mackenzie <djm@gnu.ai.mit.edu>.
25 # Perl reimplementation by Tom Tromey <tromey@redhat.com>, and
26 # Alexandre Duret-Lutz <adl@gnu.org>.
28 package Language;
30 BEGIN
32   @Automake::perl_libdirs = ('@datadir@/@PACKAGE@-@APIVERSION@')
33     unless @Automake::perl_libdirs;
34   unshift @INC, @Automake::perl_libdirs;
36   # Override SHELL.  This is required on DJGPP so that system() uses
37   # bash, not COMMAND.COM which doesn't quote arguments properly.
38   # Other systems aren't expected to use $SHELL when Automake
39   # runs, but it should be safe to drop the "if DJGPP" guard if
40   # it turns up other systems need the same thing.  After all,
41   # if SHELL is used, ./configure's SHELL is always better than
42   # the user's SHELL (which may be something like tcsh).
43   $ENV{'SHELL'} = '@SHELL@' if exists $ENV{'DJDIR'};
46 use Class::Struct ();
47 Class::Struct::struct (
48         # Short name of the language (c, f77...).
49         'name' => "\$",
50         # Nice name of the language (C, Fortran 77...).
51         'Name' => "\$",
53         # List of configure variables which must be defined.
54         'config_vars' => '@',
56         # 'pure' is '1' or ''.  A 'pure' language is one where, if
57         # all the files in a directory are of that language, then we
58         # do not require the C compiler or any code to call it.
59         'pure'   => "\$",
61         'autodep' => "\$",
63         # Name of the compiling variable (COMPILE).
64         'compiler'  => "\$",
65         # Content of the compiling variable.
66         'compile'  => "\$",
67         # Flag to require compilation without linking (-c).
68         'compile_flag' => "\$",
69         'extensions' => '@',
70         # A subroutine to compute a list of possible extensions of
71         # the product given the input extensions.
72         # (defaults to a subroutine which returns ('.$(OBJEXT)', '.lo'))
73         'output_extensions' => "\$",
74         # A list of flag variables used in 'compile'.
75         # (defaults to [])
76         'flags' => "@",
78         # Any tag to pass to libtool while compiling.
79         'libtool_tag' => "\$",
81         # The file to use when generating rules for this language.
82         # The default is 'depend2'.
83         'rule_file' => "\$",
85         # Name of the linking variable (LINK).
86         'linker' => "\$",
87         # Content of the linking variable.
88         'link' => "\$",
90         # Name of the compiler variable (CC).
91         'ccer' => "\$",
93         # Name of the linker variable (LD).
94         'lder' => "\$",
95         # Content of the linker variable ($(CC)).
96         'ld' => "\$",
98         # Flag to specify the output file (-o).
99         'output_flag' => "\$",
100         '_finish' => "\$",
102         # This is a subroutine which is called whenever we finally
103         # determine the context in which a source file will be
104         # compiled.
105         '_target_hook' => "\$",
107         # If TRUE, nodist_ sources will be compiled using specific rules
108         # (i.e. not inference rules).  The default is FALSE.
109         'nodist_specific' => "\$");
112 sub finish ($)
114   my ($self) = @_;
115   if (defined $self->_finish)
116     {
117       &{$self->_finish} (@_);
118     }
121 sub target_hook ($$$$%)
123     my ($self) = @_;
124     if (defined $self->_target_hook)
125     {
126         &{$self->_target_hook} (@_);
127     }
130 package Automake;
132 use strict;
133 use Automake::Config;
134 BEGIN
136   if ($perl_threads)
137     {
138       require threads;
139       import threads;
140       require Thread::Queue;
141       import Thread::Queue;
142     }
144 use Automake::General;
145 use Automake::XFile;
146 use Automake::Channels;
147 use Automake::ChannelDefs;
148 use Automake::Configure_ac;
149 use Automake::FileUtils;
150 use Automake::Location;
151 use Automake::Condition qw/TRUE FALSE/;
152 use Automake::DisjConditions;
153 use Automake::Options;
154 use Automake::Variable;
155 use Automake::VarDef;
156 use Automake::Rule;
157 use Automake::RuleDef;
158 use Automake::Wrap 'makefile_wrap';
159 use File::Basename;
160 use File::Spec;
161 use Carp;
163 ## ----------- ##
164 ## Constants.  ##
165 ## ----------- ##
167 # Some regular expressions.  One reason to put them here is that it
168 # makes indentation work better in Emacs.
170 # Writing singled-quoted-$-terminated regexes is a pain because
171 # perl-mode thinks of $' as the ${'} variable (instead of a $ followed
172 # by a closing quote.  Letting perl-mode think the quote is not closed
173 # leads to all sort of misindentations.  On the other hand, defining
174 # regexes as double-quoted strings is far less readable.  So usually
175 # we will write:
177 #  $REGEX = '^regex_value' . "\$";
179 my $IGNORE_PATTERN = '^\s*##([^#\n].*)?\n';
180 my $WHITE_PATTERN = '^\s*' . "\$";
181 my $COMMENT_PATTERN = '^#';
182 my $TARGET_PATTERN='[$a-zA-Z0-9_.@%][-.a-zA-Z0-9_(){}/$+@%]*';
183 # A rule has three parts: a list of targets, a list of dependencies,
184 # and optionally actions.
185 my $RULE_PATTERN =
186   "^($TARGET_PATTERN(?:(?:\\\\\n|\\s)+$TARGET_PATTERN)*) *:([^=].*|)\$";
188 # Only recognize leading spaces, not leading tabs.  If we recognize
189 # leading tabs here then we need to make the reader smarter, because
190 # otherwise it will think rules like 'foo=bar; \' are errors.
191 my $ASSIGNMENT_PATTERN = '^ *([^ \t=:+]*)\s*([:+]?)=\s*(.*)' . "\$";
192 # This pattern recognizes a Gnits version id and sets $1 if the
193 # release is an alpha release.  We also allow a suffix which can be
194 # used to extend the version number with a "fork" identifier.
195 my $GNITS_VERSION_PATTERN = '\d+\.\d+([a-z]|\.\d+)?(-[A-Za-z0-9]+)?';
197 my $IF_PATTERN = '^if\s+(!?)\s*([A-Za-z][A-Za-z0-9_]*)\s*(?:#.*)?' . "\$";
198 my $ELSE_PATTERN =
199   '^else(?:\s+(!?)\s*([A-Za-z][A-Za-z0-9_]*))?\s*(?:#.*)?' . "\$";
200 my $ENDIF_PATTERN =
201   '^endif(?:\s+(!?)\s*([A-Za-z][A-Za-z0-9_]*))?\s*(?:#.*)?' . "\$";
202 my $PATH_PATTERN = '(\w|[+/.-])+';
203 # This will pass through anything not of the prescribed form.
204 my $INCLUDE_PATTERN = ('^include\s+'
205                        . '((\$\(top_srcdir\)/' . $PATH_PATTERN . ')'
206                        . '|(\$\(srcdir\)/' . $PATH_PATTERN . ')'
207                        . '|([^/\$]' . $PATH_PATTERN . '))\s*(#.*)?' . "\$");
209 # Directories installed during 'install-exec' phase.
210 my $EXEC_DIR_PATTERN =
211   '^(?:bin|sbin|libexec|sysconf|localstate|lib|pkglib|.*exec.*)' . "\$";
213 # Values for AC_CANONICAL_*
214 use constant AC_CANONICAL_BUILD  => 1;
215 use constant AC_CANONICAL_HOST   => 2;
216 use constant AC_CANONICAL_TARGET => 3;
218 # Values indicating when something should be cleaned.
219 use constant MOSTLY_CLEAN     => 0;
220 use constant CLEAN            => 1;
221 use constant DIST_CLEAN       => 2;
222 use constant MAINTAINER_CLEAN => 3;
224 # Libtool files.
225 my @libtool_files = qw(ltmain.sh config.guess config.sub);
226 # ltconfig appears here for compatibility with old versions of libtool.
227 my @libtool_sometimes = qw(ltconfig ltcf-c.sh ltcf-cxx.sh ltcf-gcj.sh);
229 # Commonly found files we look for and automatically include in
230 # DISTFILES.
231 my @common_files =
232     (qw(ABOUT-GNU ABOUT-NLS AUTHORS BACKLOG COPYING COPYING.DOC COPYING.LIB
233         COPYING.LESSER ChangeLog INSTALL NEWS README THANKS TODO
234         ar-lib compile config.guess config.rpath
235         config.sub depcomp install-sh libversion.in mdate-sh
236         missing mkinstalldirs py-compile texinfo.tex ylwrap),
237      @libtool_files, @libtool_sometimes);
239 # Commonly used files we auto-include, but only sometimes.  This list
240 # is used for the --help output only.
241 my @common_sometimes =
242   qw(aclocal.m4 acconfig.h config.h.top config.h.bot configure
243      configure.ac configure.in stamp-vti);
245 # Standard directories from the GNU Coding Standards, and additional
246 # pkg* directories from Automake.  Stored in a hash for fast member check.
247 my %standard_prefix =
248     map { $_ => 1 } (qw(bin data dataroot doc dvi exec html include info
249                         lib libexec lisp locale localstate man man1 man2
250                         man3 man4 man5 man6 man7 man8 man9 oldinclude pdf
251                         pkgdata pkginclude pkglib pkglibexec ps sbin
252                         sharedstate sysconf));
254 # Copyright on generated Makefile.ins.
255 my $gen_copyright = "\
256 # Copyright (C) 1994-$RELEASE_YEAR Free Software Foundation, Inc.
258 # This Makefile.in is free software; the Free Software Foundation
259 # gives unlimited permission to copy and/or distribute it,
260 # with or without modifications, as long as this notice is preserved.
262 # This program is distributed in the hope that it will be useful,
263 # but WITHOUT ANY WARRANTY, to the extent permitted by law; without
264 # even the implied warranty of MERCHANTABILITY or FITNESS FOR A
265 # PARTICULAR PURPOSE.
268 # These constants are returned by the lang_*_rewrite functions.
269 # LANG_SUBDIR means that the resulting object file should be in a
270 # subdir if the source file is.  In this case the file name cannot
271 # have '..' components.
272 use constant LANG_IGNORE  => 0;
273 use constant LANG_PROCESS => 1;
274 use constant LANG_SUBDIR  => 2;
276 # These are used when keeping track of whether an object can be built
277 # by two different paths.
278 use constant COMPILE_LIBTOOL  => 1;
279 use constant COMPILE_ORDINARY => 2;
281 # We can't always associate a location to a variable or a rule,
282 # when it's defined by Automake.  We use INTERNAL in this case.
283 use constant INTERNAL => new Automake::Location;
285 # Serialization keys for message queues.
286 use constant QUEUE_MESSAGE   => "msg";
287 use constant QUEUE_CONF_FILE => "conf file";
288 use constant QUEUE_LOCATION  => "location";
289 use constant QUEUE_STRING    => "string";
291 ## ---------------------------------- ##
292 ## Variables related to the options.  ##
293 ## ---------------------------------- ##
295 # TRUE if we should always generate Makefile.in.
296 my $force_generation = 1;
298 # From the Perl manual.
299 my $symlink_exists = (eval 'symlink ("", "");', $@ eq '');
301 # TRUE if missing standard files should be installed.
302 my $add_missing = 0;
304 # TRUE if we should copy missing files; otherwise symlink if possible.
305 my $copy_missing = 0;
307 # TRUE if we should always update files that we know about.
308 my $force_missing = 0;
311 ## ---------------------------------------- ##
312 ## Variables filled during files scanning.  ##
313 ## ---------------------------------------- ##
315 # Name of the configure.ac file.
316 my $configure_ac;
318 # Files found by scanning configure.ac for LIBOBJS.
319 my %libsources = ();
321 # Names used in AC_CONFIG_HEADER call.
322 my @config_headers = ();
324 # Names used in AC_CONFIG_LINKS call.
325 my @config_links = ();
327 # List of Makefile.am's to process, and their corresponding outputs.
328 my @input_files = ();
329 my %output_files = ();
331 # Complete list of Makefile.am's that exist.
332 my @configure_input_files = ();
334 # List of files in AC_CONFIG_FILES/AC_OUTPUT without Makefile.am's,
335 # and their outputs.
336 my @other_input_files = ();
337 # Where each AC_CONFIG_FILES/AC_OUTPUT/AC_CONFIG_LINK/AC_CONFIG_HEADER appears.
338 # The keys are the files created by these macros.
339 my %ac_config_files_location = ();
340 # The condition under which AC_CONFIG_FOOS appears.
341 my %ac_config_files_condition = ();
343 # Directory to search for configure-required files.  This
344 # will be computed by &locate_aux_dir and can be set using
345 # AC_CONFIG_AUX_DIR in configure.ac.
346 # $CONFIG_AUX_DIR is the 'raw' directory, valid only in the source-tree.
347 my $config_aux_dir = '';
348 my $config_aux_dir_set_in_configure_ac = 0;
349 # $AM_CONFIG_AUX_DIR is prefixed with $(top_srcdir), so it can be used
350 # in Makefiles.
351 my $am_config_aux_dir = '';
353 # Directory to search for AC_LIBSOURCE files, as set by AC_CONFIG_LIBOBJ_DIR
354 # in configure.ac.
355 my $config_libobj_dir = '';
357 # Whether AM_GNU_GETTEXT has been seen in configure.ac.
358 my $seen_gettext = 0;
359 # Whether AM_GNU_GETTEXT([external]) is used.
360 my $seen_gettext_external = 0;
361 # Where AM_GNU_GETTEXT appears.
362 my $ac_gettext_location;
363 # Whether AM_GNU_GETTEXT_INTL_SUBDIR has been seen.
364 my $seen_gettext_intl = 0;
366 # The arguments of the AM_EXTRA_RECURSIVE_TARGETS call (if any).
367 my @extra_recursive_targets = ();
369 # Lists of tags supported by Libtool.
370 my %libtool_tags = ();
371 # 1 if Libtool uses LT_SUPPORTED_TAG.  If it does, then it also
372 # uses AC_REQUIRE_AUX_FILE.
373 my $libtool_new_api = 0;
375 # Most important AC_CANONICAL_* macro seen so far.
376 my $seen_canonical = 0;
378 # Where AM_MAINTAINER_MODE appears.
379 my $seen_maint_mode;
381 # Actual version we've seen.
382 my $package_version = '';
384 # Where version is defined.
385 my $package_version_location;
387 # TRUE if we've seen AM_PROG_AR
388 my $seen_ar = 0;
390 # TRUE if we've seen AM_PROG_CC_C_O
391 my $seen_cc_c_o = 0;
393 # Location of AC_REQUIRE_AUX_FILE calls, indexed by their argument.
394 my %required_aux_file = ();
396 # Where AM_INIT_AUTOMAKE is called;
397 my $seen_init_automake = 0;
399 # TRUE if we've seen AM_AUTOMAKE_VERSION.
400 my $seen_automake_version = 0;
402 # Hash table of discovered configure substitutions.  Keys are names,
403 # values are 'FILE:LINE' strings which are used by error message
404 # generation.
405 my %configure_vars = ();
407 # Ignored configure substitutions (i.e., variables not to be output in
408 # Makefile.in)
409 my %ignored_configure_vars = ();
411 # Files included by $configure_ac.
412 my @configure_deps = ();
414 # Greatest timestamp of configure's dependencies.
415 my $configure_deps_greatest_timestamp = 0;
417 # Hash table of AM_CONDITIONAL variables seen in configure.
418 my %configure_cond = ();
420 # This maps extensions onto language names.
421 my %extension_map = ();
423 # List of the DIST_COMMON files we discovered while reading
424 # configure.ac.
425 my $configure_dist_common = '';
427 # This maps languages names onto objects.
428 my %languages = ();
429 # Maps each linker variable onto a language object.
430 my %link_languages = ();
432 # maps extensions to needed source flags.
433 my %sourceflags = ();
435 # List of targets we must always output.
436 # FIXME: Complete, and remove falsely required targets.
437 my %required_targets =
438   (
439    'all'          => 1,
440    'dvi'          => 1,
441    'pdf'          => 1,
442    'ps'           => 1,
443    'info'         => 1,
444    'install-info' => 1,
445    'install'      => 1,
446    'install-data' => 1,
447    'install-exec' => 1,
448    'uninstall'    => 1,
450    # FIXME: Not required, temporary hacks.
451    # Well, actually they are sort of required: the -recursive
452    # targets will run them anyway...
453    'html-am'         => 1,
454    'dvi-am'          => 1,
455    'pdf-am'          => 1,
456    'ps-am'           => 1,
457    'info-am'         => 1,
458    'install-data-am' => 1,
459    'install-exec-am' => 1,
460    'install-html-am' => 1,
461    'install-dvi-am'  => 1,
462    'install-pdf-am'  => 1,
463    'install-ps-am'   => 1,
464    'install-info-am' => 1,
465    'installcheck-am' => 1,
466    'uninstall-am'    => 1,
467    'tags-am'         => 1,
468    'ctags-am'        => 1,
469    'cscopelist-am'   => 1,
470    'install-man'     => 1,
471   );
473 # Queue to push require_conf_file requirements to.
474 my $required_conf_file_queue;
476 # The name of the Makefile currently being processed.
477 my $am_file = 'BUG';
479 ################################################################
481 ## ------------------------------------------ ##
482 ## Variables reset by &initialize_per_input.  ##
483 ## ------------------------------------------ ##
485 # Relative dir of the output makefile.
486 my $relative_dir;
488 # Greatest timestamp of the output's dependencies (excluding
489 # configure's dependencies).
490 my $output_deps_greatest_timestamp;
492 # These variables are used when generating each Makefile.in.
493 # They hold the Makefile.in until it is ready to be printed.
494 my $output_vars;
495 my $output_all;
496 my $output_header;
497 my $output_rules;
498 my $output_trailer;
500 # This is the conditional stack, updated on if/else/endif, and
501 # used to build Condition objects.
502 my @cond_stack;
504 # This holds the set of included files.
505 my @include_stack;
507 # List of dependencies for the obvious targets.
508 my @all;
509 my @check;
510 my @check_tests;
512 # Keys in this hash table are files to delete.  The associated
513 # value tells when this should happen (MOSTLY_CLEAN, DIST_CLEAN, etc.)
514 my %clean_files;
516 # Keys in this hash table are object files or other files in
517 # subdirectories which need to be removed.  This only holds files
518 # which are created by compilations.  The value in the hash indicates
519 # when the file should be removed.
520 my %compile_clean_files;
522 # Keys in this hash table are directories where we expect to build a
523 # libtool object.  We use this information to decide what directories
524 # to delete.
525 my %libtool_clean_directories;
527 # Value of $(SOURCES), used by tags.am.
528 my @sources;
529 # Sources which go in the distribution.
530 my @dist_sources;
532 # This hash maps object file names onto their corresponding source
533 # file names.  This is used to ensure that each object is created
534 # by a single source file.
535 my %object_map;
537 # This hash maps object file names onto an integer value representing
538 # whether this object has been built via ordinary compilation or
539 # libtool compilation (the COMPILE_* constants).
540 my %object_compilation_map;
543 # This keeps track of the directories for which we've already
544 # created dirstamp code.  Keys are directories, values are stamp files.
545 # Several keys can share the same stamp files if they are equivalent
546 # (as are './/foo' and 'foo').
547 my %directory_map;
549 # All .P files.
550 my %dep_files;
552 # This is a list of all targets to run during "make dist".
553 my @dist_targets;
555 # Keep track of all programs declared in this Makefile, without
556 # $(EXEEXT).  @substitutions@ are not listed.
557 my %known_programs;
558 my %known_libraries;
560 # This keeps track of which extensions we've seen (that we care
561 # about).
562 my %extension_seen;
564 # This is random scratch space for the language finish functions.
565 # Don't randomly overwrite it; examine other uses of keys first.
566 my %language_scratch;
568 # We keep track of which objects need special (per-executable)
569 # handling on a per-language basis.
570 my %lang_specific_files;
572 # This is set when 'handle_dist' has finished.  Once this happens,
573 # we should no longer push on dist_common.
574 my $handle_dist_run;
576 # Used to store a set of linkers needed to generate the sources currently
577 # under consideration.
578 my %linkers_used;
580 # True if we need 'LINK' defined.  This is a hack.
581 my $need_link;
583 # Does the generated Makefile have to build some compiled object
584 # (for binary programs, or plain or libtool libraries)?
585 my $must_handle_compiled_objects;
587 # Record each file processed by make_paragraphs.
588 my %transformed_files;
590 ################################################################
592 ## ---------------------------------------------- ##
593 ## Variables not reset by &initialize_per_input.  ##
594 ## ---------------------------------------------- ##
596 # Cache each file processed by make_paragraphs.
597 # (This is different from %transformed_files because
598 # %transformed_files is reset for each file while %am_file_cache
599 # it global to the run.)
600 my %am_file_cache;
602 ################################################################
604 # var_SUFFIXES_trigger ($TYPE, $VALUE)
605 # ------------------------------------
606 # This is called by Automake::Variable::define() when SUFFIXES
607 # is defined ($TYPE eq '') or appended ($TYPE eq '+').
608 # The work here needs to be performed as a side-effect of the
609 # macro_define() call because SUFFIXES definitions impact
610 # on $KNOWN_EXTENSIONS_PATTERN which is used used when parsing
611 # the input am file.
612 sub var_SUFFIXES_trigger ($$)
614     my ($type, $value) = @_;
615     accept_extensions (split (' ', $value));
617 Automake::Variable::hook ('SUFFIXES', \&var_SUFFIXES_trigger);
619 ################################################################
621 ## --------------------------------- ##
622 ## Forward subroutine declarations.  ##
623 ## --------------------------------- ##
624 sub register_language (%);
625 sub file_contents_internal ($$$%);
626 sub define_files_variable ($\@$$);
629 # &initialize_per_input ()
630 # ------------------------
631 # (Re)-Initialize per-Makefile.am variables.
632 sub initialize_per_input ()
634     reset_local_duplicates ();
636     $relative_dir = undef;
638     $output_deps_greatest_timestamp = 0;
640     $output_vars = '';
641     $output_all = '';
642     $output_header = '';
643     $output_rules = '';
644     $output_trailer = '';
646     Automake::Options::reset;
647     Automake::Variable::reset;
648     Automake::Rule::reset;
650     @cond_stack = ();
652     @include_stack = ();
654     @all = ();
655     @check = ();
656     @check_tests = ();
658     %clean_files = ();
659     %compile_clean_files = ();
661     # We always include '.'.  This isn't strictly correct.
662     %libtool_clean_directories = ('.' => 1);
664     @sources = ();
665     @dist_sources = ();
667     %object_map = ();
668     %object_compilation_map = ();
670     %directory_map = ();
672     %dep_files = ();
674     @dist_targets = ();
676     %known_programs = ();
677     %known_libraries= ();
679     %extension_seen = ();
681     %language_scratch = ();
683     %lang_specific_files = ();
685     $handle_dist_run = 0;
687     $need_link = 0;
689     $must_handle_compiled_objects = 0;
691     %transformed_files = ();
695 ################################################################
697 # Initialize our list of languages that are internally supported.
699 # C.
700 register_language ('name' => 'c',
701                    'Name' => 'C',
702                    'config_vars' => ['CC'],
703                    'autodep' => '',
704                    'flags' => ['CFLAGS', 'CPPFLAGS'],
705                    'ccer' => 'CC',
706                    'compiler' => 'COMPILE',
707                    'compile' => '$(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)',
708                    'lder' => 'CCLD',
709                    'ld' => '$(CC)',
710                    'linker' => 'LINK',
711                    'link' => '$(CCLD) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
712                    'compile_flag' => '-c',
713                    'libtool_tag' => 'CC',
714                    'extensions' => ['.c']);
716 # C++.
717 register_language ('name' => 'cxx',
718                    'Name' => 'C++',
719                    'config_vars' => ['CXX'],
720                    'linker' => 'CXXLINK',
721                    'link' => '$(CXXLD) $(AM_CXXFLAGS) $(CXXFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
722                    'autodep' => 'CXX',
723                    'flags' => ['CXXFLAGS', 'CPPFLAGS'],
724                    'compile' => '$(CXX) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CXXFLAGS) $(CXXFLAGS)',
725                    'ccer' => 'CXX',
726                    'compiler' => 'CXXCOMPILE',
727                    'compile_flag' => '-c',
728                    'output_flag' => '-o',
729                    'libtool_tag' => 'CXX',
730                    'lder' => 'CXXLD',
731                    'ld' => '$(CXX)',
732                    'pure' => 1,
733                    'extensions' => ['.c++', '.cc', '.cpp', '.cxx', '.C']);
735 # Objective C.
736 register_language ('name' => 'objc',
737                    'Name' => 'Objective C',
738                    'config_vars' => ['OBJC'],
739                    'linker' => 'OBJCLINK',
740                    'link' => '$(OBJCLD) $(AM_OBJCFLAGS) $(OBJCFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
741                    'autodep' => 'OBJC',
742                    'flags' => ['OBJCFLAGS', 'CPPFLAGS'],
743                    'compile' => '$(OBJC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_OBJCFLAGS) $(OBJCFLAGS)',
744                    'ccer' => 'OBJC',
745                    'compiler' => 'OBJCCOMPILE',
746                    'compile_flag' => '-c',
747                    'output_flag' => '-o',
748                    'lder' => 'OBJCLD',
749                    'ld' => '$(OBJC)',
750                    'pure' => 1,
751                    'extensions' => ['.m']);
753 # Objective C++.
754 register_language ('name' => 'objcxx',
755                    'Name' => 'Objective C++',
756                    'config_vars' => ['OBJCXX'],
757                    'linker' => 'OBJCXXLINK',
758                    'link' => '$(OBJCXXLD) $(AM_OBJCXXFLAGS) $(OBJCXXFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
759                    'autodep' => 'OBJCXX',
760                    'flags' => ['OBJCXXFLAGS', 'CPPFLAGS'],
761                    'compile' => '$(OBJCXX) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_OBJCXXFLAGS) $(OBJCXXFLAGS)',
762                    'ccer' => 'OBJCXX',
763                    'compiler' => 'OBJCXXCOMPILE',
764                    'compile_flag' => '-c',
765                    'output_flag' => '-o',
766                    'lder' => 'OBJCXXLD',
767                    'ld' => '$(OBJCXX)',
768                    'pure' => 1,
769                    'extensions' => ['.mm']);
771 # Unified Parallel C.
772 register_language ('name' => 'upc',
773                    'Name' => 'Unified Parallel C',
774                    'config_vars' => ['UPC'],
775                    'linker' => 'UPCLINK',
776                    'link' => '$(UPCLD) $(AM_UPCFLAGS) $(UPCFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
777                    'autodep' => 'UPC',
778                    'flags' => ['UPCFLAGS', 'CPPFLAGS'],
779                    'compile' => '$(UPC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_UPCFLAGS) $(UPCFLAGS)',
780                    'ccer' => 'UPC',
781                    'compiler' => 'UPCCOMPILE',
782                    'compile_flag' => '-c',
783                    'output_flag' => '-o',
784                    'lder' => 'UPCLD',
785                    'ld' => '$(UPC)',
786                    'pure' => 1,
787                    'extensions' => ['.upc']);
789 # Headers.
790 register_language ('name' => 'header',
791                    'Name' => 'Header',
792                    'extensions' => ['.h', '.H', '.hxx', '.h++', '.hh',
793                                     '.hpp', '.inc'],
794                    # No output.
795                    'output_extensions' => sub { return () },
796                    # Nothing to do.
797                    '_finish' => sub { });
799 # Vala
800 register_language ('name' => 'vala',
801                    'Name' => 'Vala',
802                    'config_vars' => ['VALAC'],
803                    'flags' => [],
804                    'compile' => '$(VALAC) $(AM_VALAFLAGS) $(VALAFLAGS)',
805                    'ccer' => 'VALAC',
806                    'compiler' => 'VALACOMPILE',
807                    'extensions' => ['.vala'],
808                    'output_extensions' => sub { (my $ext = $_[0]) =~ s/vala$/c/;
809                                                 return ($ext,) },
810                    'rule_file' => 'vala',
811                    '_finish' => \&lang_vala_finish,
812                    '_target_hook' => \&lang_vala_target_hook,
813                    'nodist_specific' => 1);
815 # Yacc (C & C++).
816 register_language ('name' => 'yacc',
817                    'Name' => 'Yacc',
818                    'config_vars' => ['YACC'],
819                    'flags' => ['YFLAGS'],
820                    'compile' => '$(YACC) $(AM_YFLAGS) $(YFLAGS)',
821                    'ccer' => 'YACC',
822                    'compiler' => 'YACCCOMPILE',
823                    'extensions' => ['.y'],
824                    'output_extensions' => sub { (my $ext = $_[0]) =~ tr/y/c/;
825                                                 return ($ext,) },
826                    'rule_file' => 'yacc',
827                    '_finish' => \&lang_yacc_finish,
828                    '_target_hook' => \&lang_yacc_target_hook,
829                    'nodist_specific' => 1);
830 register_language ('name' => 'yaccxx',
831                    'Name' => 'Yacc (C++)',
832                    'config_vars' => ['YACC'],
833                    'rule_file' => 'yacc',
834                    'flags' => ['YFLAGS'],
835                    'ccer' => 'YACC',
836                    'compiler' => 'YACCCOMPILE',
837                    'compile' => '$(YACC) $(AM_YFLAGS) $(YFLAGS)',
838                    'extensions' => ['.y++', '.yy', '.yxx', '.ypp'],
839                    'output_extensions' => sub { (my $ext = $_[0]) =~ tr/y/c/;
840                                                 return ($ext,) },
841                    '_finish' => \&lang_yacc_finish,
842                    '_target_hook' => \&lang_yacc_target_hook,
843                    'nodist_specific' => 1);
845 # Lex (C & C++).
846 register_language ('name' => 'lex',
847                    'Name' => 'Lex',
848                    'config_vars' => ['LEX'],
849                    'rule_file' => 'lex',
850                    'flags' => ['LFLAGS'],
851                    'compile' => '$(LEX) $(AM_LFLAGS) $(LFLAGS)',
852                    'ccer' => 'LEX',
853                    'compiler' => 'LEXCOMPILE',
854                    'extensions' => ['.l'],
855                    'output_extensions' => sub { (my $ext = $_[0]) =~ tr/l/c/;
856                                                 return ($ext,) },
857                    '_finish' => \&lang_lex_finish,
858                    '_target_hook' => \&lang_lex_target_hook,
859                    'nodist_specific' => 1);
860 register_language ('name' => 'lexxx',
861                    'Name' => 'Lex (C++)',
862                    'config_vars' => ['LEX'],
863                    'rule_file' => 'lex',
864                    'flags' => ['LFLAGS'],
865                    'compile' => '$(LEX) $(AM_LFLAGS) $(LFLAGS)',
866                    'ccer' => 'LEX',
867                    'compiler' => 'LEXCOMPILE',
868                    'extensions' => ['.l++', '.ll', '.lxx', '.lpp'],
869                    'output_extensions' => sub { (my $ext = $_[0]) =~ tr/l/c/;
870                                                 return ($ext,) },
871                    '_finish' => \&lang_lex_finish,
872                    '_target_hook' => \&lang_lex_target_hook,
873                    'nodist_specific' => 1);
875 # Assembler.
876 register_language ('name' => 'asm',
877                    'Name' => 'Assembler',
878                    'config_vars' => ['CCAS', 'CCASFLAGS'],
880                    'flags' => ['CCASFLAGS'],
881                    # Users can set AM_CCASFLAGS to include DEFS, INCLUDES,
882                    # or anything else required.  They can also set CCAS.
883                    # Or simply use Preprocessed Assembler.
884                    'compile' => '$(CCAS) $(AM_CCASFLAGS) $(CCASFLAGS)',
885                    'ccer' => 'CCAS',
886                    'compiler' => 'CCASCOMPILE',
887                    'compile_flag' => '-c',
888                    'output_flag' => '-o',
889                    'extensions' => ['.s']);
891 # Preprocessed Assembler.
892 register_language ('name' => 'cppasm',
893                    'Name' => 'Preprocessed Assembler',
894                    'config_vars' => ['CCAS', 'CCASFLAGS'],
896                    'autodep' => 'CCAS',
897                    'flags' => ['CCASFLAGS', 'CPPFLAGS'],
898                    'compile' => '$(CCAS) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CCASFLAGS) $(CCASFLAGS)',
899                    'ccer' => 'CPPAS',
900                    'compiler' => 'CPPASCOMPILE',
901                    'compile_flag' => '-c',
902                    'output_flag' => '-o',
903                    'extensions' => ['.S', '.sx']);
905 # Fortran 77
906 register_language ('name' => 'f77',
907                    'Name' => 'Fortran 77',
908                    'config_vars' => ['F77'],
909                    'linker' => 'F77LINK',
910                    'link' => '$(F77LD) $(AM_FFLAGS) $(FFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
911                    'flags' => ['FFLAGS'],
912                    'compile' => '$(F77) $(AM_FFLAGS) $(FFLAGS)',
913                    'ccer' => 'F77',
914                    'compiler' => 'F77COMPILE',
915                    'compile_flag' => '-c',
916                    'output_flag' => '-o',
917                    'libtool_tag' => 'F77',
918                    'lder' => 'F77LD',
919                    'ld' => '$(F77)',
920                    'pure' => 1,
921                    'extensions' => ['.f', '.for']);
923 # Fortran
924 register_language ('name' => 'fc',
925                    'Name' => 'Fortran',
926                    'config_vars' => ['FC'],
927                    'linker' => 'FCLINK',
928                    'link' => '$(FCLD) $(AM_FCFLAGS) $(FCFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
929                    'flags' => ['FCFLAGS'],
930                    'compile' => '$(FC) $(AM_FCFLAGS) $(FCFLAGS)',
931                    'ccer' => 'FC',
932                    'compiler' => 'FCCOMPILE',
933                    'compile_flag' => '-c',
934                    'output_flag' => '-o',
935                    'libtool_tag' => 'FC',
936                    'lder' => 'FCLD',
937                    'ld' => '$(FC)',
938                    'pure' => 1,
939                    'extensions' => ['.f90', '.f95', '.f03', '.f08']);
941 # Preprocessed Fortran
942 register_language ('name' => 'ppfc',
943                    'Name' => 'Preprocessed Fortran',
944                    'config_vars' => ['FC'],
945                    'linker' => 'FCLINK',
946                    'link' => '$(FCLD) $(AM_FCFLAGS) $(FCFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
947                    'lder' => 'FCLD',
948                    'ld' => '$(FC)',
949                    'flags' => ['FCFLAGS', 'CPPFLAGS'],
950                    'ccer' => 'PPFC',
951                    'compiler' => 'PPFCCOMPILE',
952                    'compile' => '$(FC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_FCFLAGS) $(FCFLAGS)',
953                    'compile_flag' => '-c',
954                    'output_flag' => '-o',
955                    'libtool_tag' => 'FC',
956                    'pure' => 1,
957                    'extensions' => ['.F90','.F95', '.F03', '.F08']);
959 # Preprocessed Fortran 77
961 # The current support for preprocessing Fortran 77 just involves
962 # passing "$(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS)
963 # $(CPPFLAGS)" as additional flags to the Fortran 77 compiler, since
964 # this is how GNU Make does it; see the "GNU Make Manual, Edition 0.51
965 # for 'make' Version 3.76 Beta" (specifically, from info file
966 # '(make)Catalogue of Rules').
968 # A better approach would be to write an Autoconf test
969 # (i.e. AC_PROG_FPP) for a Fortran 77 preprocessor, because not all
970 # Fortran 77 compilers know how to do preprocessing.  The Autoconf
971 # macro AC_PROG_FPP should test the Fortran 77 compiler first for
972 # preprocessing capabilities, and then fall back on cpp (if cpp were
973 # available).
974 register_language ('name' => 'ppf77',
975                    'Name' => 'Preprocessed Fortran 77',
976                    'config_vars' => ['F77'],
977                    'linker' => 'F77LINK',
978                    'link' => '$(F77LD) $(AM_FFLAGS) $(FFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
979                    'lder' => 'F77LD',
980                    'ld' => '$(F77)',
981                    'flags' => ['FFLAGS', 'CPPFLAGS'],
982                    'ccer' => 'PPF77',
983                    'compiler' => 'PPF77COMPILE',
984                    'compile' => '$(F77) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_FFLAGS) $(FFLAGS)',
985                    'compile_flag' => '-c',
986                    'output_flag' => '-o',
987                    'libtool_tag' => 'F77',
988                    'pure' => 1,
989                    'extensions' => ['.F']);
991 # Ratfor.
992 register_language ('name' => 'ratfor',
993                    'Name' => 'Ratfor',
994                    'config_vars' => ['F77'],
995                    'linker' => 'F77LINK',
996                    'link' => '$(F77LD) $(AM_FFLAGS) $(FFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
997                    'lder' => 'F77LD',
998                    'ld' => '$(F77)',
999                    'flags' => ['RFLAGS', 'FFLAGS'],
1000                    # FIXME also FFLAGS.
1001                    'compile' => '$(F77) $(AM_FFLAGS) $(FFLAGS) $(AM_RFLAGS) $(RFLAGS)',
1002                    'ccer' => 'F77',
1003                    'compiler' => 'RCOMPILE',
1004                    'compile_flag' => '-c',
1005                    'output_flag' => '-o',
1006                    'libtool_tag' => 'F77',
1007                    'pure' => 1,
1008                    'extensions' => ['.r']);
1010 # Java via gcj.
1011 register_language ('name' => 'java',
1012                    'Name' => 'Java',
1013                    'config_vars' => ['GCJ'],
1014                    'linker' => 'GCJLINK',
1015                    'link' => '$(GCJLD) $(AM_GCJFLAGS) $(GCJFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
1016                    'autodep' => 'GCJ',
1017                    'flags' => ['GCJFLAGS'],
1018                    'compile' => '$(GCJ) $(AM_GCJFLAGS) $(GCJFLAGS)',
1019                    'ccer' => 'GCJ',
1020                    'compiler' => 'GCJCOMPILE',
1021                    'compile_flag' => '-c',
1022                    'output_flag' => '-o',
1023                    'libtool_tag' => 'GCJ',
1024                    'lder' => 'GCJLD',
1025                    'ld' => '$(GCJ)',
1026                    'pure' => 1,
1027                    'extensions' => ['.java', '.class', '.zip', '.jar']);
1029 ################################################################
1031 # Error reporting functions.
1033 # err_am ($MESSAGE, [%OPTIONS])
1034 # -----------------------------
1035 # Uncategorized errors about the current Makefile.am.
1036 sub err_am ($;%)
1038   msg_am ('error', @_);
1041 # err_ac ($MESSAGE, [%OPTIONS])
1042 # -----------------------------
1043 # Uncategorized errors about configure.ac.
1044 sub err_ac ($;%)
1046   msg_ac ('error', @_);
1049 # msg_am ($CHANNEL, $MESSAGE, [%OPTIONS])
1050 # ---------------------------------------
1051 # Messages about about the current Makefile.am.
1052 sub msg_am ($$;%)
1054   my ($channel, $msg, %opts) = @_;
1055   msg $channel, "${am_file}.am", $msg, %opts;
1058 # msg_ac ($CHANNEL, $MESSAGE, [%OPTIONS])
1059 # ---------------------------------------
1060 # Messages about about configure.ac.
1061 sub msg_ac ($$;%)
1063   my ($channel, $msg, %opts) = @_;
1064   msg $channel, $configure_ac, $msg, %opts;
1067 ################################################################
1069 # subst ($TEXT)
1070 # -------------
1071 # Return a configure-style substitution using the indicated text.
1072 # We do this to avoid having the substitutions directly in automake.in;
1073 # when we do that they are sometimes removed and this causes confusion
1074 # and bugs.
1075 sub subst ($)
1077     my ($text) = @_;
1078     return '@' . $text . '@';
1081 ################################################################
1084 # $BACKPATH
1085 # &backname ($RELDIR)
1086 # --------------------
1087 # If I "cd $RELDIR", then to come back, I should "cd $BACKPATH".
1088 # For instance 'src/foo' => '../..'.
1089 # Works with non strictly increasing paths, i.e., 'src/../lib' => '..'.
1090 sub backname ($)
1092     my ($file) = @_;
1093     my @res;
1094     foreach (split (/\//, $file))
1095     {
1096         next if $_ eq '.' || $_ eq '';
1097         if ($_ eq '..')
1098         {
1099             pop @res
1100               or prog_error ("trying to reverse path '$file' pointing outside tree");
1101         }
1102         else
1103         {
1104             push (@res, '..');
1105         }
1106     }
1107     return join ('/', @res) || '.';
1110 ################################################################
1112 # Silent rules handling functions.
1114 # verbose_var (NAME)
1115 # ------------------
1116 # The public variable stem used to implement silent rules.
1117 sub verbose_var ($)
1119     my ($name) = @_;
1120     return 'AM_V_' . $name;
1123 # verbose_private_var (NAME)
1124 # --------------------------
1125 # The naming policy for the private variables for silent rules.
1126 sub verbose_private_var ($)
1128     my ($name) = @_;
1129     return 'am__v_' . $name;
1132 # define_verbose_var (NAME, VAL-IF-SILENT, [VAL-IF-VERBOSE])
1133 # ----------------------------------------------------------
1134 # For  silent rules, setup VAR and dispatcher, to expand to
1135 # VAL-IF-SILENT if silent, to VAL-IF-VERBOSE (defaulting to
1136 # empty) if not.
1137 sub define_verbose_var ($$;$)
1139     my ($name, $silent_val, $verbose_val) = @_;
1140     $verbose_val = '' unless defined $verbose_val;
1141     my $var = verbose_var ($name);
1142     my $pvar = verbose_private_var ($name);
1143     my $silent_var = $pvar . '_0';
1144     my $verbose_var = $pvar . '_1';
1145     # For typical 'make's, 'configure' replaces AM_V (inside @@) with $(V)
1146     # and AM_DEFAULT_V (inside @@) with $(AM_DEFAULT_VERBOSITY).
1147     # For strict POSIX 2008 'make's, it replaces them with 0 or 1 instead.
1148     # See AM_SILENT_RULES in m4/silent.m4.
1149     define_variable ($var, '$(' . $pvar . '_@'.'AM_V'.'@)', INTERNAL);
1150     define_variable ($pvar . '_', '$(' . $pvar . '_@'.'AM_DEFAULT_V'.'@)',
1151                      INTERNAL);
1152     Automake::Variable::define ($silent_var, VAR_AUTOMAKE, '', TRUE,
1153                                 $silent_val, '', INTERNAL, VAR_ASIS)
1154       if (! vardef ($silent_var, TRUE));
1155     Automake::Variable::define ($verbose_var, VAR_AUTOMAKE, '', TRUE,
1156                                 $verbose_val, '', INTERNAL, VAR_ASIS)
1157       if (! vardef ($verbose_var, TRUE));
1160 # Above should not be needed in the general automake code.
1162 # verbose_flag (NAME)
1163 # -------------------
1164 # Contents of %VERBOSE%: variable to expand before rule command.
1165 sub verbose_flag ($)
1167     my ($name) = @_;
1168     return '$(' . verbose_var ($name) . ')';
1171 sub verbose_nodep_flag ($)
1173     my ($name) = @_;
1174     return '$(' . verbose_var ($name) . subst ('am__nodep') . ')';
1177 # silent_flag
1178 # -----------
1179 # Contents of %SILENT%: variable to expand to '@' when silent.
1180 sub silent_flag ()
1182     return verbose_flag ('at');
1185 # define_verbose_tagvar (NAME)
1186 # ----------------------------
1187 # Engage the needed silent rules machinery for tag NAME.
1188 sub define_verbose_tagvar ($)
1190     my ($name) = @_;
1191     define_verbose_var ($name, '@echo "  '. $name . ' ' x (8 - length ($name)) . '" $@;');
1194 # define_verbose_texinfo
1195 # ----------------------
1196 # Engage the needed silent rules machinery for assorted texinfo commands.
1197 sub define_verbose_texinfo ()
1199   my @tagvars = ('DVIPS', 'MAKEINFO', 'INFOHTML', 'TEXI2DVI', 'TEXI2PDF');
1200   foreach my $tag (@tagvars)
1201     {
1202       define_verbose_tagvar($tag);
1203     }
1204   define_verbose_var('texinfo', '-q');
1205   define_verbose_var('texidevnull', '> /dev/null');
1208 # define_verbose_libtool
1209 # ----------------------
1210 # Engage the needed silent rules machinery for 'libtool --silent'.
1211 sub define_verbose_libtool ()
1213     define_verbose_var ('lt', '--silent');
1214     return verbose_flag ('lt');
1217 sub handle_silent ()
1219     # Define "$(AM_V_P)", expanding to a shell conditional that can be
1220     # used in make recipes to determine whether we are being run in
1221     # silent mode or not.  The choice of the name derives from the LISP
1222     # convention of appending the letter 'P' to denote a predicate (see
1223     # also "the '-P' convention" in the Jargon File); we do so for lack
1224     # of a better convention.
1225     define_verbose_var ('P', 'false', ':');
1226     # *Always* provide the user with '$(AM_V_GEN)', unconditionally.
1227     define_verbose_tagvar ('GEN');
1228     define_verbose_var ('at', '@');
1232 ################################################################
1235 # Handle AUTOMAKE_OPTIONS variable.  Return 1 on error, 0 otherwise.
1236 sub handle_options
1238   my $var = var ('AUTOMAKE_OPTIONS');
1239   if ($var)
1240     {
1241       if ($var->has_conditional_contents)
1242         {
1243           msg_var ('unsupported', $var,
1244                    "'AUTOMAKE_OPTIONS' cannot have conditional contents");
1245         }
1246       my @options = map { { option => $_->[1], where => $_->[0] } }
1247                         $var->value_as_list_recursive (cond_filter => TRUE,
1248                                                        location => 1);
1249       return 1 if process_option_list (@options);
1250     }
1252   if ($strictness == GNITS)
1253     {
1254       set_option ('readme-alpha', INTERNAL);
1255       set_option ('std-options', INTERNAL);
1256       set_option ('check-news', INTERNAL);
1257     }
1259   return 0;
1262 # shadow_unconditionally ($varname, $where)
1263 # -----------------------------------------
1264 # Return a $(variable) that contains all possible values
1265 # $varname can take.
1266 # If the VAR wasn't defined conditionally, return $(VAR).
1267 # Otherwise we create an am__VAR_DIST variable which contains
1268 # all possible values, and return $(am__VAR_DIST).
1269 sub shadow_unconditionally ($$)
1271   my ($varname, $where) = @_;
1272   my $var = var $varname;
1273   if ($var->has_conditional_contents)
1274     {
1275       $varname = "am__${varname}_DIST";
1276       my @files = uniq ($var->value_as_list_recursive);
1277       define_pretty_variable ($varname, TRUE, $where, @files);
1278     }
1279   return "\$($varname)"
1282 # check_user_variables (@LIST)
1283 # ----------------------------
1284 # Make sure each variable VAR in @LIST does not exist, suggest using AM_VAR
1285 # otherwise.
1286 sub check_user_variables (@)
1288   my @dont_override = @_;
1289   foreach my $flag (@dont_override)
1290     {
1291       my $var = var $flag;
1292       if ($var)
1293         {
1294           for my $cond ($var->conditions->conds)
1295             {
1296               if ($var->rdef ($cond)->owner == VAR_MAKEFILE)
1297                 {
1298                   msg_cond_var ('gnu', $cond, $flag,
1299                                 "'$flag' is a user variable, "
1300                                 . "you should not override it;\n"
1301                                 . "use 'AM_$flag' instead");
1302                 }
1303             }
1304         }
1305     }
1308 # Call finish function for each language that was used.
1309 sub handle_languages
1311     if (! option 'no-dependencies')
1312     {
1313         # Include auto-dep code.  Don't include it if DEP_FILES would
1314         # be empty.
1315         if (keys %extension_seen && keys %dep_files)
1316         {
1317             # Set location of depcomp.
1318             &define_variable ('depcomp',
1319                               "\$(SHELL) $am_config_aux_dir/depcomp",
1320                               INTERNAL);
1321             &define_variable ('am__depfiles_maybe', 'depfiles', INTERNAL);
1323             require_conf_file ("$am_file.am", FOREIGN, 'depcomp');
1325             my @deplist = sort keys %dep_files;
1326             # Generate each 'include' individually.  Irix 6 make will
1327             # not properly include several files resulting from a
1328             # variable expansion; generating many separate includes
1329             # seems safest.
1330             $output_rules .= "\n";
1331             foreach my $iter (@deplist)
1332             {
1333                 $output_rules .= (subst ('AMDEP_TRUE')
1334                                   . subst ('am__include')
1335                                   . ' '
1336                                   . subst ('am__quote')
1337                                   . $iter
1338                                   . subst ('am__quote')
1339                                   . "\n");
1340             }
1342             # Compute the set of directories to remove in distclean-depend.
1343             my @depdirs = uniq (map { dirname ($_) } @deplist);
1344             $output_rules .= &file_contents ('depend',
1345                                              new Automake::Location,
1346                                              DEPDIRS => "@depdirs");
1347         }
1348     }
1349     else
1350     {
1351         &define_variable ('depcomp', '', INTERNAL);
1352         &define_variable ('am__depfiles_maybe', '', INTERNAL);
1353     }
1355     my %done;
1357     # Is the C linker needed?
1358     my $needs_c = 0;
1359     foreach my $ext (sort keys %extension_seen)
1360     {
1361         next unless $extension_map{$ext};
1363         my $lang = $languages{$extension_map{$ext}};
1365         my $rule_file = $lang->rule_file || 'depend2';
1367         # Get information on $LANG.
1368         my $pfx = $lang->autodep;
1369         my $fpfx = ($pfx eq '') ? 'CC' : $pfx;
1371         my ($AMDEP, $FASTDEP) =
1372           (option 'no-dependencies' || $lang->autodep eq 'no')
1373           ? ('FALSE', 'FALSE') : ('AMDEP', "am__fastdep$fpfx");
1375         my $verbose = verbose_flag ($lang->ccer || 'GEN');
1376         my $verbose_nodep = ($AMDEP eq 'FALSE')
1377           ? $verbose : verbose_nodep_flag ($lang->ccer || 'GEN');
1378         my $silent = silent_flag ();
1380         my %transform = ('EXT'     => $ext,
1381                          'PFX'     => $pfx,
1382                          'FPFX'    => $fpfx,
1383                          'AMDEP'   => $AMDEP,
1384                          'FASTDEP' => $FASTDEP,
1385                          '-c'      => $lang->compile_flag || '',
1386                          # These are not used, but they need to be defined
1387                          # so &transform do not complain.
1388                          SUBDIROBJ     => 0,
1389                          'DERIVED-EXT' => 'BUG',
1390                          DIST_SOURCE   => 1,
1391                          VERBOSE   => $verbose,
1392                          'VERBOSE-NODEP' => $verbose_nodep,
1393                          SILENT    => $silent,
1394                         );
1396         # Generate the appropriate rules for this extension.
1397         if (((! option 'no-dependencies') && $lang->autodep ne 'no')
1398             || defined $lang->compile)
1399         {
1400             # Some C compilers don't support -c -o.  Use it only if really
1401             # needed.
1402             my $output_flag = $lang->output_flag || '';
1403             $output_flag = '-o'
1404               if (! $output_flag
1405                   && $lang->name eq 'c'
1406                   && option 'subdir-objects');
1408             # Compute a possible derived extension.
1409             # This is not used by depend2.am.
1410             my $der_ext = (&{$lang->output_extensions} ($ext))[0];
1412             # When we output an inference rule like '.c.o:' we
1413             # have two cases to consider: either subdir-objects
1414             # is used, or it is not.
1415             #
1416             # In the latter case the rule is used to build objects
1417             # in the current directory, and dependencies always
1418             # go into './$(DEPDIR)/'.  We can hard-code this value.
1419             #
1420             # In the former case the rule can be used to build
1421             # objects in sub-directories too.  Dependencies should
1422             # go into the appropriate sub-directories, e.g.,
1423             # 'sub/$(DEPDIR)/'.  The value of this directory
1424             # needs to be computed on-the-fly.
1425             #
1426             # DEPBASE holds the name of this directory, plus the
1427             # basename part of the object file (extensions Po, TPo,
1428             # Plo, TPlo will be added later as appropriate).  It is
1429             # either hardcoded, or a shell variable ('$depbase') that
1430             # will be computed by the rule.
1431             my $depbase =
1432               option ('subdir-objects') ? '$$depbase' : '$(DEPDIR)/$*';
1433             $output_rules .=
1434               file_contents ($rule_file,
1435                              new Automake::Location,
1436                              %transform,
1437                              GENERIC   => 1,
1439                              'DERIVED-EXT' => $der_ext,
1441                              DEPBASE   => $depbase,
1442                              BASE      => '$*',
1443                              SOURCE    => '$<',
1444                              SOURCEFLAG => $sourceflags{$ext} || '',
1445                              OBJ       => '$@',
1446                              OBJOBJ    => '$@',
1447                              LTOBJ     => '$@',
1449                              COMPILE   => '$(' . $lang->compiler . ')',
1450                              LTCOMPILE => '$(LT' . $lang->compiler . ')',
1451                              -o        => $output_flag,
1452                              SUBDIROBJ => !! option 'subdir-objects');
1453         }
1455         # Now include code for each specially handled object with this
1456         # language.
1457         my %seen_files = ();
1458         foreach my $file (@{$lang_specific_files{$lang->name}})
1459         {
1460             my ($derived, $source, $obj, $myext, $srcext, %file_transform) = @$file;
1462             # We might see a given object twice, for instance if it is
1463             # used under different conditions.
1464             next if defined $seen_files{$obj};
1465             $seen_files{$obj} = 1;
1467             prog_error ("found " . $lang->name .
1468                         " in handle_languages, but compiler not defined")
1469               unless defined $lang->compile;
1471             my $obj_compile = $lang->compile;
1473             # Rewrite each occurrence of 'AM_$flag' in the compile
1474             # rule into '${derived}_$flag' if it exists.
1475             for my $flag (@{$lang->flags})
1476               {
1477                 my $val = "${derived}_$flag";
1478                 $obj_compile =~ s/\(AM_$flag\)/\($val\)/
1479                   if set_seen ($val);
1480               }
1482             my $libtool_tag = '';
1483             if ($lang->libtool_tag && exists $libtool_tags{$lang->libtool_tag})
1484               {
1485                 $libtool_tag = '--tag=' . $lang->libtool_tag . ' '
1486               }
1488             my $ptltflags = "${derived}_LIBTOOLFLAGS";
1489             $ptltflags = 'AM_LIBTOOLFLAGS' unless set_seen $ptltflags;
1491             my $ltverbose = define_verbose_libtool ();
1492             my $obj_ltcompile =
1493               "\$(LIBTOOL) $ltverbose $libtool_tag\$($ptltflags) \$(LIBTOOLFLAGS) "
1494               . "--mode=compile $obj_compile";
1496             # We _need_ '-o' for per object rules.
1497             my $output_flag = $lang->output_flag || '-o';
1499             my $depbase = dirname ($obj);
1500             $depbase = ''
1501                 if $depbase eq '.';
1502             $depbase .= '/'
1503                 unless $depbase eq '';
1504             $depbase .= '$(DEPDIR)/' . basename ($obj);
1506             $output_rules .=
1507               file_contents ($rule_file,
1508                              new Automake::Location,
1509                              %transform,
1510                              GENERIC   => 0,
1512                              DEPBASE   => $depbase,
1513                              BASE      => $obj,
1514                              SOURCE    => $source,
1515                              SOURCEFLAG => $sourceflags{$srcext} || '',
1516                              # Use $myext and not '.o' here, in case
1517                              # we are actually building a new source
1518                              # file -- e.g. via yacc.
1519                              OBJ       => "$obj$myext",
1520                              OBJOBJ    => "$obj.obj",
1521                              LTOBJ     => "$obj.lo",
1523                              VERBOSE   => $verbose,
1524                              'VERBOSE-NODEP'  => $verbose_nodep,
1525                              SILENT    => $silent,
1526                              COMPILE   => $obj_compile,
1527                              LTCOMPILE => $obj_ltcompile,
1528                              -o        => $output_flag,
1529                              %file_transform);
1530         }
1532         # The rest of the loop is done once per language.
1533         next if defined $done{$lang};
1534         $done{$lang} = 1;
1536         # Load the language dependent Makefile chunks.
1537         my %lang = map { uc ($_) => 0 } keys %languages;
1538         $lang{uc ($lang->name)} = 1;
1539         $output_rules .= file_contents ('lang-compile',
1540                                         new Automake::Location,
1541                                         %transform, %lang);
1543         # If the source to a program consists entirely of code from a
1544         # 'pure' language, for instance C++ or Fortran 77, then we
1545         # don't need the C compiler code.  However if we run into
1546         # something unusual then we do generate the C code.  There are
1547         # probably corner cases here that do not work properly.
1548         # People linking Java code to Fortran code deserve pain.
1549         $needs_c ||= ! $lang->pure;
1551         define_compiler_variable ($lang)
1552           if ($lang->compile);
1554         define_linker_variable ($lang)
1555           if ($lang->link);
1557         require_variables ("$am_file.am", $lang->Name . " source seen",
1558                            TRUE, @{$lang->config_vars});
1560         # Call the finisher.
1561         $lang->finish;
1563         # Flags listed in '->flags' are user variables (per GNU Standards),
1564         # they should not be overridden in the Makefile...
1565         my @dont_override = @{$lang->flags};
1566         # ... and so is LDFLAGS.
1567         push @dont_override, 'LDFLAGS' if $lang->link;
1569         check_user_variables @dont_override;
1570     }
1572     # If the project is entirely C++ or entirely Fortran 77 (i.e., 1
1573     # suffix rule was learned), don't bother with the C stuff.  But if
1574     # anything else creeps in, then use it.
1575     $needs_c = 1
1576       if $need_link || suffix_rules_count > 1;
1578     if ($needs_c)
1579       {
1580         &define_compiler_variable ($languages{'c'})
1581           unless defined $done{$languages{'c'}};
1582         define_linker_variable ($languages{'c'});
1583       }
1587 # append_exeext { PREDICATE } $MACRO
1588 # ----------------------------------
1589 # Append $(EXEEXT) to each filename in $F appearing in the Makefile
1590 # variable $MACRO if &PREDICATE($F) is true.  @substitutions@ are
1591 # ignored.
1593 # This is typically used on all filenames of *_PROGRAMS, and filenames
1594 # of TESTS that are programs.
1595 sub append_exeext (&$)
1597   my ($pred, $macro) = @_;
1599   transform_variable_recursively
1600     ($macro, $macro, 'am__EXEEXT', 0, INTERNAL,
1601      sub {
1602        my ($subvar, $val, $cond, $full_cond) = @_;
1603        # Append $(EXEEXT) unless the user did it already, or it's a
1604        # @substitution@.
1605        $val .= '$(EXEEXT)'
1606          if $val !~ /(?:\$\(EXEEXT\)$|^[@]\w+[@]$)/ && &$pred ($val);
1607        return $val;
1608      });
1612 # Check to make sure a source defined in LIBOBJS is not explicitly
1613 # mentioned.  This is a separate function (as opposed to being inlined
1614 # in handle_source_transform) because it isn't always appropriate to
1615 # do this check.
1616 sub check_libobjs_sources
1618   my ($one_file, $unxformed) = @_;
1620   foreach my $prefix ('', 'EXTRA_', 'dist_', 'nodist_',
1621                       'dist_EXTRA_', 'nodist_EXTRA_')
1622     {
1623       my @files;
1624       my $varname = $prefix . $one_file . '_SOURCES';
1625       my $var = var ($varname);
1626       if ($var)
1627         {
1628           @files = $var->value_as_list_recursive;
1629         }
1630       elsif ($prefix eq '')
1631         {
1632           @files = ($unxformed . '.c');
1633         }
1634       else
1635         {
1636           next;
1637         }
1639       foreach my $file (@files)
1640         {
1641           err_var ($prefix . $one_file . '_SOURCES',
1642                    "automatically discovered file '$file' should not" .
1643                    " be explicitly mentioned")
1644             if defined $libsources{$file};
1645         }
1646     }
1650 # @OBJECTS
1651 # handle_single_transform ($VAR, $TOPPARENT, $DERIVED, $OBJ, $FILE, %TRANSFORM)
1652 # -----------------------------------------------------------------------------
1653 # Does much of the actual work for handle_source_transform.
1654 # Arguments are:
1655 #   $VAR is the name of the variable that the source filenames come from
1656 #   $TOPPARENT is the name of the _SOURCES variable which is being processed
1657 #   $DERIVED is the name of resulting executable or library
1658 #   $OBJ is the object extension (e.g., '.lo')
1659 #   $FILE the source file to transform
1660 #   %TRANSFORM contains extras arguments to pass to file_contents
1661 #     when producing explicit rules
1662 # Result is a list of the names of objects
1663 # %linkers_used will be updated with any linkers needed
1664 sub handle_single_transform ($$$$$%)
1666     my ($var, $topparent, $derived, $obj, $_file, %transform) = @_;
1667     my @files = ($_file);
1668     my @result = ();
1670     # Turn sources into objects.  We use a while loop like this
1671     # because we might add to @files in the loop.
1672     while (scalar @files > 0)
1673     {
1674         $_ = shift @files;
1676         # Configure substitutions in _SOURCES variables are errors.
1677         if (/^\@.*\@$/)
1678         {
1679           my $parent_msg = '';
1680           $parent_msg = "\nand is referred to from '$topparent'"
1681             if $topparent ne $var->name;
1682           err_var ($var,
1683                    "'" . $var->name . "' includes configure substitution '$_'"
1684                    . $parent_msg . ";\nconfigure " .
1685                    "substitutions are not allowed in _SOURCES variables");
1686           next;
1687         }
1689         # If the source file is in a subdirectory then the '.o' is put
1690         # into the current directory, unless the subdir-objects option
1691         # is in effect.
1693         # Split file name into base and extension.
1694         next if ! /^(?:(.*)\/)?([^\/]*)($KNOWN_EXTENSIONS_PATTERN)$/;
1695         my $full = $_;
1696         my $directory = $1 || '';
1697         my $base = $2;
1698         my $extension = $3;
1700         # We must generate a rule for the object if it requires its own flags.
1701         my $renamed = 0;
1702         my ($linker, $object);
1704         # This records whether we've seen a derived source file (e.g.
1705         # yacc output).
1706         my $derived_source = 0;
1708         # This holds the 'aggregate context' of the file we are
1709         # currently examining.  If the file is compiled with
1710         # per-object flags, then it will be the name of the object.
1711         # Otherwise it will be 'AM'.  This is used by the target hook
1712         # language function.
1713         my $aggregate = 'AM';
1715         $extension = &derive_suffix ($extension, $obj);
1716         my $lang;
1717         if ($extension_map{$extension} &&
1718             ($lang = $languages{$extension_map{$extension}}))
1719         {
1720             # Found the language, so see what it says.
1721             &saw_extension ($extension);
1723             # Do we have per-executable flags for this executable?
1724             my $have_per_exec_flags = 0;
1725             my @peflags = @{$lang->flags};
1726             push @peflags, 'LIBTOOLFLAGS' if $obj eq '.lo';
1727             foreach my $flag (@peflags)
1728               {
1729                 if (set_seen ("${derived}_$flag"))
1730                   {
1731                     $have_per_exec_flags = 1;
1732                     last;
1733                   }
1734               }
1736             # Note: computed subr call.  The language rewrite function
1737             # should return one of the LANG_* constants.  It could
1738             # also return a list whose first value is such a constant
1739             # and whose second value is a new source extension which
1740             # should be applied.  This means this particular language
1741             # generates another source file which we must then process
1742             # further.
1743             my $subr = \&{'lang_' . $lang->name . '_rewrite'};
1744             defined &$subr or $subr = \&lang_sub_obj;
1745             my ($r, $source_extension)
1746                 = &$subr ($directory, $base, $extension,
1747                           $obj, $have_per_exec_flags, $var);
1748             # Skip this entry if we were asked not to process it.
1749             next if $r == LANG_IGNORE;
1751             # Now extract linker and other info.
1752             $linker = $lang->linker;
1754             my $this_obj_ext;
1755             if (defined $source_extension)
1756             {
1757                 $this_obj_ext = $source_extension;
1758                 $derived_source = 1;
1759             }
1760             else
1761             {
1762                 $this_obj_ext = $obj;
1763             }
1764             $object = $base . $this_obj_ext;
1766             if ($have_per_exec_flags)
1767             {
1768                 # We have a per-executable flag in effect for this
1769                 # object.  In this case we rewrite the object's
1770                 # name to ensure it is unique.
1772                 # We choose the name 'DERIVED_OBJECT' to ensure
1773                 # (1) uniqueness, and (2) continuity between
1774                 # invocations.  However, this will result in a
1775                 # name that is too long for losing systems, in
1776                 # some situations.  So we provide _SHORTNAME to
1777                 # override.
1779                 my $dname = $derived;
1780                 my $var = var ($derived . '_SHORTNAME');
1781                 if ($var)
1782                 {
1783                     # FIXME: should use the same Condition as
1784                     # the _SOURCES variable.  But this is really
1785                     # silly overkill -- nobody should have
1786                     # conditional shortnames.
1787                     $dname = $var->variable_value;
1788                 }
1789                 $object = $dname . '-' . $object;
1791                 prog_error ($lang->name . " flags defined without compiler")
1792                   if ! defined $lang->compile;
1794                 $renamed = 1;
1795             }
1797             # If rewrite said it was ok, put the object into a
1798             # subdir.
1799             if ($r == LANG_SUBDIR && $directory ne '')
1800             {
1801                 $object = $directory . '/' . $object;
1802             }
1804             # If the object file has been renamed (because per-target
1805             # flags are used) we cannot compile the file with an
1806             # inference rule: we need an explicit rule.
1807             #
1808             # If the source is in a subdirectory and the object is in
1809             # the current directory, we also need an explicit rule.
1810             #
1811             # If both source and object files are in a subdirectory
1812             # (this happens when the subdir-objects option is used),
1813             # then the inference will work.
1814             #
1815             # The latter case deserves a historical note.  When the
1816             # subdir-objects option was added on 1999-04-11 it was
1817             # thought that inferences rules would work for
1818             # subdirectory objects too.  Later, on 1999-11-22,
1819             # automake was changed to output explicit rules even for
1820             # subdir-objects.  Nobody remembers why, but this occurred
1821             # soon after the merge of the user-dep-gen-branch so it
1822             # might be related.  In late 2003 people complained about
1823             # the size of the generated Makefile.ins (libgcj, with
1824             # 2200+ subdir objects was reported to have a 9MB
1825             # Makefile), so we now rely on inference rules again.
1826             # Maybe we'll run across the same issue as in the past,
1827             # but at least this time we can document it.  However since
1828             # dependency tracking has evolved it is possible that
1829             # our old problem no longer exists.
1830             # Using inference rules for subdir-objects has been tested
1831             # with GNU make, Solaris make, Ultrix make, BSD make,
1832             # HP-UX make, and OSF1 make successfully.
1833             if ($renamed
1834                 || ($directory ne '' && ! option 'subdir-objects')
1835                 # We must also use specific rules for a nodist_ source
1836                 # if its language requests it.
1837                 || ($lang->nodist_specific && ! $transform{'DIST_SOURCE'}))
1838             {
1839                 my $obj_sans_ext = substr ($object, 0,
1840                                            - length ($this_obj_ext));
1841                 my $full_ansi;
1842                 if ($directory ne '')
1843                   {
1844                         $full_ansi = $directory . '/' . $base . $extension;
1845                   }
1846                 else
1847                   {
1848                         $full_ansi = $base . $extension;
1849                   }
1851                 my @specifics = ($full_ansi, $obj_sans_ext,
1852                                  # Only use $this_obj_ext in the derived
1853                                  # source case because in the other case we
1854                                  # *don't* want $(OBJEXT) to appear here.
1855                                  ($derived_source ? $this_obj_ext : '.o'),
1856                                  $extension);
1858                 # If we renamed the object then we want to use the
1859                 # per-executable flag name.  But if this is simply a
1860                 # subdir build then we still want to use the AM_ flag
1861                 # name.
1862                 if ($renamed)
1863                   {
1864                     unshift @specifics, $derived;
1865                     $aggregate = $derived;
1866                   }
1867                 else
1868                   {
1869                     unshift @specifics, 'AM';
1870                   }
1872                 # Each item on this list is a reference to a list consisting
1873                 # of four values followed by additional transform flags for
1874                 # file_contents.  The four values are the derived flag prefix
1875                 # (e.g. for 'foo_CFLAGS', it is 'foo'), the name of the
1876                 # source file, the base name of the output file, and
1877                 # the extension for the object file.
1878                 push (@{$lang_specific_files{$lang->name}},
1879                       [@specifics, %transform]);
1880             }
1881         }
1882         elsif ($extension eq $obj)
1883         {
1884             # This is probably the result of a direct suffix rule.
1885             # In this case we just accept the rewrite.
1886             $object = "$base$extension";
1887             $object = "$directory/$object" if $directory ne '';
1888             $linker = '';
1889         }
1890         else
1891         {
1892             # No error message here.  Used to have one, but it was
1893             # very unpopular.
1894             # FIXME: we could potentially do more processing here,
1895             # perhaps treating the new extension as though it were a
1896             # new source extension (as above).  This would require
1897             # more restructuring than is appropriate right now.
1898             next;
1899         }
1901         err_am "object '$object' created by '$full' and '$object_map{$object}'"
1902           if (defined $object_map{$object}
1903               && $object_map{$object} ne $full);
1905         my $comp_val = (($object =~ /\.lo$/)
1906                         ? COMPILE_LIBTOOL : COMPILE_ORDINARY);
1907         (my $comp_obj = $object) =~ s/\.lo$/.\$(OBJEXT)/;
1908         if (defined $object_compilation_map{$comp_obj}
1909             && $object_compilation_map{$comp_obj} != 0
1910             # Only see the error once.
1911             && ($object_compilation_map{$comp_obj}
1912                 != (COMPILE_LIBTOOL | COMPILE_ORDINARY))
1913             && $object_compilation_map{$comp_obj} != $comp_val)
1914           {
1915             err_am "object '$comp_obj' created both with libtool and without";
1916           }
1917         $object_compilation_map{$comp_obj} |= $comp_val;
1919         if (defined $lang)
1920         {
1921             # Let the language do some special magic if required.
1922             $lang->target_hook ($aggregate, $object, $full, %transform);
1923         }
1925         if ($derived_source)
1926           {
1927             prog_error ($lang->name . " has automatic dependency tracking")
1928               if $lang->autodep ne 'no';
1929             # Make sure this new source file is handled next.  That will
1930             # make it appear to be at the right place in the list.
1931             unshift (@files, $object);
1932             # Distribute derived sources unless the source they are
1933             # derived from is not.
1934             &push_dist_common ($object)
1935               unless ($topparent =~ /^(?:nobase_)?nodist_/);
1936             next;
1937           }
1939         $linkers_used{$linker} = 1;
1941         push (@result, $object);
1943         if (! defined $object_map{$object})
1944         {
1945             my @dep_list = ();
1946             $object_map{$object} = $full;
1948             # If resulting object is in subdir, we need to make
1949             # sure the subdir exists at build time.
1950             if ($object =~ /\//)
1951             {
1952                 # FIXME: check that $DIRECTORY is somewhere in the
1953                 # project
1955                 # For Java, the way we're handling it right now, a
1956                 # '..' component doesn't make sense.
1957                 if ($lang && $lang->name eq 'java' && $object =~ /(\/|^)\.\.\//)
1958                   {
1959                     err_am "'$full' should not contain a '..' component";
1960                   }
1962                 # Make sure *all* objects files in the subdirectory are
1963                 # removed by "make mostlyclean".  Not only this is more
1964                 # efficient than listing the object files to be removed
1965                 # individually (which would cause an 'rm' invocation for
1966                 # each of them -- very inefficient, see bug#10697), it
1967                 # would also leave stale object files in the subdirectory
1968                 # whenever a source file there is removed or renamed.
1969                 $compile_clean_files{"$directory/*.\$(OBJEXT)"} = MOSTLY_CLEAN;
1970                 if ($object =~ /\.lo$/)
1971                   {
1972                     # If we have a libtool object, then we also must remove
1973                     # any '.lo' objects in its same subdirectory.
1974                     $compile_clean_files{"$directory/*.lo"} = MOSTLY_CLEAN;
1975                     # Remember to cleanup .libs/ in this directory.
1976                     $libtool_clean_directories{$directory} = 1;
1977                   }
1979                 push (@dep_list, require_build_directory ($directory));
1981                 # If we're generating dependencies, we also want
1982                 # to make sure that the appropriate subdir of the
1983                 # .deps directory is created.
1984                 push (@dep_list,
1985                       require_build_directory ($directory . '/$(DEPDIR)'))
1986                   unless option 'no-dependencies';
1987             }
1989             &pretty_print_rule ($object . ':', "\t", @dep_list)
1990                 if scalar @dep_list > 0;
1991         }
1993         # Transform .o or $o file into .P file (for automatic
1994         # dependency code).
1995         # Properly flatten multiple adjacent slashes, as Solaris 10 make
1996         # might fail over them in an include statement.
1997         # Leading double slashes may be special, as per Posix, so deal
1998         # with them carefully.
1999         if ($lang && $lang->autodep ne 'no')
2000         {
2001             my $depfile = $object;
2002             $depfile =~ s/\.([^.]*)$/.P$1/;
2003             $depfile =~ s/\$\(OBJEXT\)$/o/;
2004             my $maybe_extra_leading_slash = '';
2005             $maybe_extra_leading_slash = '/' if $depfile =~ m,^//[^/],;
2006             $depfile =~ s,/+,/,g;
2007             my $basename = basename ($depfile);
2008             # This might make $dirname empty, but we account for that below.
2009             (my $dirname = dirname ($depfile)) =~ s/\/*$//;
2010             $dirname = $maybe_extra_leading_slash . $dirname;
2011             $dep_files{$dirname . '/$(DEPDIR)/' . $basename} = 1;
2012         }
2013     }
2015     return @result;
2019 # $LINKER
2020 # define_objects_from_sources ($VAR, $OBJVAR, $NODEFINE, $ONE_FILE,
2021 #                              $OBJ, $PARENT, $TOPPARENT, $WHERE, %TRANSFORM)
2022 # ---------------------------------------------------------------------------
2023 # Define an _OBJECTS variable for a _SOURCES variable (or subvariable)
2025 # Arguments are:
2026 #   $VAR is the name of the _SOURCES variable
2027 #   $OBJVAR is the name of the _OBJECTS variable if known (otherwise
2028 #     it will be generated and returned).
2029 #   $NODEFINE is a boolean: if true, $OBJVAR will not be defined (but
2030 #     work done to determine the linker will be).
2031 #   $ONE_FILE is the canonical (transformed) name of object to build
2032 #   $OBJ is the object extension (i.e. either '.o' or '.lo').
2033 #   $TOPPARENT is the _SOURCES variable being processed.
2034 #   $WHERE context into which this definition is done
2035 #   %TRANSFORM extra arguments to pass to file_contents when producing
2036 #     rules
2038 # Result is a pair ($LINKER, $OBJVAR):
2039 #    $LINKER is a boolean, true if a linker is needed to deal with the objects
2040 sub define_objects_from_sources ($$$$$$$%)
2042   my ($var, $objvar, $nodefine, $one_file,
2043       $obj, $topparent, $where, %transform) = @_;
2045   my $needlinker = "";
2047   transform_variable_recursively
2048     ($var, $objvar, 'am__objects', $nodefine, $where,
2049      # The transform code to run on each filename.
2050      sub {
2051        my ($subvar, $val, $cond, $full_cond) = @_;
2052        my @trans = handle_single_transform ($subvar, $topparent,
2053                                             $one_file, $obj, $val,
2054                                             %transform);
2055        $needlinker = "true" if @trans;
2056        return @trans;
2057      });
2059   return $needlinker;
2063 # handle_source_transform ($CANON_TARGET, $TARGET, $OBJEXT, $WHERE, %TRANSFORM)
2064 # -----------------------------------------------------------------------------
2065 # Handle SOURCE->OBJECT transform for one program or library.
2066 # Arguments are:
2067 #   canonical (transformed) name of target to build
2068 #   actual target of object to build
2069 #   object extension (i.e., either '.o' or '$o')
2070 #   location of the source variable
2071 #   extra arguments to pass to file_contents when producing rules
2072 # Return the name of the linker variable that must be used.
2073 # Empty return means just use 'LINK'.
2074 sub handle_source_transform ($$$$%)
2076     # one_file is canonical name.  unxformed is given name.  obj is
2077     # object extension.
2078     my ($one_file, $unxformed, $obj, $where, %transform) = @_;
2080     my $linker = '';
2082     # No point in continuing if _OBJECTS is defined.
2083     return if reject_var ($one_file . '_OBJECTS',
2084                           $one_file . '_OBJECTS should not be defined');
2086     my %used_pfx = ();
2087     my $needlinker;
2088     %linkers_used = ();
2089     foreach my $prefix ('', 'EXTRA_', 'dist_', 'nodist_',
2090                         'dist_EXTRA_', 'nodist_EXTRA_')
2091     {
2092         my $varname = $prefix . $one_file . "_SOURCES";
2093         my $var = var $varname;
2094         next unless $var;
2096         # We are going to define _OBJECTS variables using the prefix.
2097         # Then we glom them all together.  So we can't use the null
2098         # prefix here as we need it later.
2099         my $xpfx = ($prefix eq '') ? 'am_' : $prefix;
2101         # Keep track of which prefixes we saw.
2102         $used_pfx{$xpfx} = 1
2103           unless $prefix =~ /EXTRA_/;
2105         push @sources, "\$($varname)";
2106         push @dist_sources, shadow_unconditionally ($varname, $where)
2107           unless (option ('no-dist') || $prefix =~ /^nodist_/);
2109         $needlinker |=
2110             define_objects_from_sources ($varname,
2111                                          $xpfx . $one_file . '_OBJECTS',
2112                                          $prefix =~ /EXTRA_/,
2113                                          $one_file, $obj, $varname, $where,
2114                                          DIST_SOURCE => ($prefix !~ /^nodist_/),
2115                                          %transform);
2116     }
2117     if ($needlinker)
2118     {
2119         $linker ||= &resolve_linker (%linkers_used);
2120     }
2122     my @keys = sort keys %used_pfx;
2123     if (scalar @keys == 0)
2124     {
2125         # The default source for libfoo.la is libfoo.c, but for
2126         # backward compatibility we first look at libfoo_la.c,
2127         # if no default source suffix is given.
2128         my $old_default_source = "$one_file.c";
2129         my $ext_var = var ('AM_DEFAULT_SOURCE_EXT');
2130         my $default_source_ext = $ext_var ? variable_value ($ext_var) : '.c';
2131         msg_var ('unsupported', $ext_var, $ext_var->name . " can assume at most one value")
2132           if $default_source_ext =~ /[\t ]/;
2133         (my $default_source = $unxformed) =~ s,(\.[^./\\]*)?$,$default_source_ext,;
2134         # TODO: Remove this backward-compatibility hack in Automake 1.14.
2135         if ($old_default_source ne $default_source
2136             && !$ext_var
2137             && (rule $old_default_source
2138                 || rule '$(srcdir)/' . $old_default_source
2139                 || rule '${srcdir}/' . $old_default_source
2140                 || -f $old_default_source))
2141           {
2142             my $loc = $where->clone;
2143             $loc->pop_context;
2144             msg ('obsolete', $loc,
2145                  "the default source for '$unxformed' has been changed "
2146                  . "to '$default_source'.\n(Using '$old_default_source' for "
2147                  . "backward compatibility.)");
2148             $default_source = $old_default_source;
2149           }
2150         # If a rule exists to build this source with a $(srcdir)
2151         # prefix, use that prefix in our variables too.  This is for
2152         # the sake of BSD Make.
2153         if (rule '$(srcdir)/' . $default_source
2154             || rule '${srcdir}/' . $default_source)
2155           {
2156             $default_source = '$(srcdir)/' . $default_source;
2157           }
2159         &define_variable ($one_file . "_SOURCES", $default_source, $where);
2160         push (@sources, $default_source);
2161         push (@dist_sources, $default_source);
2163         %linkers_used = ();
2164         my (@result) =
2165           handle_single_transform ($one_file . '_SOURCES',
2166                                    $one_file . '_SOURCES',
2167                                    $one_file, $obj,
2168                                    $default_source, %transform);
2169         $linker ||= &resolve_linker (%linkers_used);
2170         define_pretty_variable ($one_file . '_OBJECTS', TRUE, $where, @result);
2171     }
2172     else
2173     {
2174         @keys = map { '$(' . $_ . $one_file . '_OBJECTS)' } @keys;
2175         define_pretty_variable ($one_file . '_OBJECTS', TRUE, $where, @keys);
2176     }
2178     # If we want to use 'LINK' we must make sure it is defined.
2179     if ($linker eq '')
2180     {
2181         $need_link = 1;
2182     }
2184     return $linker;
2188 # handle_lib_objects ($XNAME, $VAR)
2189 # ---------------------------------
2190 # Special-case ALLOCA and LIBOBJS substitutions in _LDADD or _LIBADD variables.
2191 # Also, generate _DEPENDENCIES variable if appropriate.
2192 # Arguments are:
2193 #   transformed name of object being built, or empty string if no object
2194 #   name of _LDADD/_LIBADD-type variable to examine
2195 # Returns 1 if LIBOBJS seen, 0 otherwise.
2196 sub handle_lib_objects
2198   my ($xname, $varname) = @_;
2200   my $var = var ($varname);
2201   prog_error "'$varname' undefined"
2202     unless $var;
2203   prog_error "unexpected variable name '$varname'"
2204     unless $varname =~ /^(.*)(?:LIB|LD)ADD$/;
2205   my $prefix = $1 || 'AM_';
2207   my $seen_libobjs = 0;
2208   my $flagvar = 0;
2210   transform_variable_recursively
2211     ($varname, $xname . '_DEPENDENCIES', 'am__DEPENDENCIES',
2212      ! $xname, INTERNAL,
2213      # Transformation function, run on each filename.
2214      sub {
2215        my ($subvar, $val, $cond, $full_cond) = @_;
2217        if ($val =~ /^-/)
2218          {
2219            # Skip -lfoo and -Ldir silently; these are explicitly allowed.
2220            if ($val !~ /^-[lL]/ &&
2221                # Skip -dlopen and -dlpreopen; these are explicitly allowed
2222                # for Libtool libraries or programs.  (Actually we are a bit
2223                # lax here since this code also applies to non-libtool
2224                # libraries or programs, for which -dlopen and -dlopreopen
2225                # are pure nonsense.  Diagnosing this doesn't seem very
2226                # important: the developer will quickly get complaints from
2227                # the linker.)
2228                $val !~ /^-dl(?:pre)?open$/ &&
2229                # Only get this error once.
2230                ! $flagvar)
2231              {
2232                $flagvar = 1;
2233                # FIXME: should display a stack of nested variables
2234                # as context when $var != $subvar.
2235                err_var ($var, "linker flags such as '$val' belong in "
2236                         . "'${prefix}LDFLAGS'");
2237              }
2238            return ();
2239          }
2240        elsif ($val !~ /^\@.*\@$/)
2241          {
2242            # Assume we have a file of some sort, and output it into the
2243            # dependency variable.  Autoconf substitutions are not output;
2244            # rarely is a new dependency substituted into e.g. foo_LDADD
2245            # -- but bad things (e.g. -lX11) are routinely substituted.
2246            # Note that LIBOBJS and ALLOCA are exceptions to this rule,
2247            # and handled specially below.
2248            return $val;
2249          }
2250        elsif ($val =~ /^\@(LT)?LIBOBJS\@$/)
2251          {
2252            handle_LIBOBJS ($subvar, $cond, $1);
2253            $seen_libobjs = 1;
2254            return $val;
2255          }
2256        elsif ($val =~ /^\@(LT)?ALLOCA\@$/)
2257          {
2258            handle_ALLOCA ($subvar, $cond, $1);
2259            return $val;
2260          }
2261        else
2262          {
2263            return ();
2264          }
2265      });
2267   return $seen_libobjs;
2270 # handle_LIBOBJS_or_ALLOCA ($VAR)
2271 # -------------------------------
2272 # Definitions common to LIBOBJS and ALLOCA.
2273 # VAR should be one of LIBOBJS, LTLIBOBJS, ALLOCA, or LTALLOCA.
2274 sub handle_LIBOBJS_or_ALLOCA ($)
2276   my ($var) = @_;
2278   my $dir = '';
2280   # If LIBOBJS files must be built in another directory we have
2281   # to define LIBOBJDIR and ensure the files get cleaned.
2282   # Otherwise LIBOBJDIR can be left undefined, and the cleaning
2283   # is achieved by 'rm -f *.$(OBJEXT)' in compile.am.
2284   if ($config_libobj_dir
2285       && $relative_dir ne $config_libobj_dir)
2286     {
2287       if (option 'subdir-objects')
2288         {
2289           # In the top-level Makefile we do not use $(top_builddir), because
2290           # we are already there, and since the targets are built without
2291           # a $(top_builddir), it helps BSD Make to match them with
2292           # dependencies.
2293           $dir = "$config_libobj_dir/"
2294             if $config_libobj_dir ne '.';
2295           $dir = backname ($relative_dir) . "/$dir"
2296             if $relative_dir ne '.';
2297           define_variable ('LIBOBJDIR', "$dir", INTERNAL);
2298           $clean_files{"\$($var)"} = MOSTLY_CLEAN;
2299           # If LTLIBOBJS is used, we must also clear LIBOBJS (which might
2300           # be created by libtool as a side-effect of creating LTLIBOBJS).
2301           $clean_files{"\$($var)"} = MOSTLY_CLEAN if $var =~ s/^LT//;
2302         }
2303       else
2304         {
2305           error ("'\$($var)' cannot be used outside '$config_libobj_dir' if"
2306                  . " 'subdir-objects' is not set");
2307         }
2308     }
2310   return $dir;
2313 sub handle_LIBOBJS ($$$)
2315   my ($var, $cond, $lt) = @_;
2316   my $myobjext = $lt ? 'lo' : 'o';
2317   $lt ||= '';
2319   $var->requires_variables ("\@${lt}LIBOBJS\@ used", $lt . 'LIBOBJS')
2320     if ! keys %libsources;
2322   my $dir = handle_LIBOBJS_or_ALLOCA "${lt}LIBOBJS";
2324   foreach my $iter (keys %libsources)
2325     {
2326       if ($iter =~ /\.[cly]$/)
2327         {
2328           &saw_extension ($&);
2329           &saw_extension ('.c');
2330         }
2332       if ($iter =~ /\.h$/)
2333         {
2334           require_libsource_with_macro ($cond, $var, FOREIGN, $iter);
2335         }
2336       elsif ($iter ne 'alloca.c')
2337         {
2338           my $rewrite = $iter;
2339           $rewrite =~ s/\.c$/.P$myobjext/;
2340           $dep_files{$dir . '$(DEPDIR)/' . $rewrite} = 1;
2341           $rewrite = "^" . quotemeta ($iter) . "\$";
2342           # Only require the file if it is not a built source.
2343           my $bs = var ('BUILT_SOURCES');
2344           if (! $bs || ! grep (/$rewrite/, $bs->value_as_list_recursive))
2345             {
2346               require_libsource_with_macro ($cond, $var, FOREIGN, $iter);
2347             }
2348         }
2349     }
2352 sub handle_ALLOCA ($$$)
2354   my ($var, $cond, $lt) = @_;
2355   my $myobjext = $lt ? 'lo' : 'o';
2356   $lt ||= '';
2357   my $dir = handle_LIBOBJS_or_ALLOCA "${lt}ALLOCA";
2359   $var->requires_variables ("\@${lt}ALLOCA\@ used", $lt . 'ALLOCA');
2360   $dep_files{$dir . '$(DEPDIR)/alloca.P' . $myobjext} = 1;
2361   require_libsource_with_macro ($cond, $var, FOREIGN, 'alloca.c');
2362   &saw_extension ('.c');
2365 # Canonicalize the input parameter
2366 sub canonicalize
2368     my ($string) = @_;
2369     $string =~ tr/A-Za-z0-9_\@/_/c;
2370     return $string;
2373 # Canonicalize a name, and check to make sure the non-canonical name
2374 # is never used.  Returns canonical name.  Arguments are name and a
2375 # list of suffixes to check for.
2376 sub check_canonical_spelling
2378   my ($name, @suffixes) = @_;
2380   my $xname = &canonicalize ($name);
2381   if ($xname ne $name)
2382     {
2383       foreach my $xt (@suffixes)
2384         {
2385           reject_var ("$name$xt", "use '$xname$xt', not '$name$xt'");
2386         }
2387     }
2389   return $xname;
2393 # handle_compile ()
2394 # -----------------
2395 # Set up the compile suite.
2396 sub handle_compile ()
2398    return if ! $must_handle_compiled_objects;
2400     # Boilerplate.
2401     my $default_includes = '';
2402     if (! option 'nostdinc')
2403       {
2404         my @incs = ('-I.', subst ('am__isrc'));
2406         my $var = var 'CONFIG_HEADER';
2407         if ($var)
2408           {
2409             foreach my $hdr (split (' ', $var->variable_value))
2410               {
2411                 push @incs, '-I' . dirname ($hdr);
2412               }
2413           }
2414         # We want '-I. -I$(srcdir)', but the latter -I is redundant
2415         # and unaesthetic in non-VPATH builds.  We use `-I.@am__isrc@`
2416         # instead.  It will be replaced by '-I.' or '-I. -I$(srcdir)'.
2417         # Items in CONFIG_HEADER are never in $(srcdir) so it is safe
2418         # to just put @am__isrc@ right after '-I.', without a space.
2419         ($default_includes = ' ' . uniq (@incs)) =~ s/ @/@/;
2420       }
2422     my (@mostly_rms, @dist_rms);
2423     foreach my $item (sort keys %compile_clean_files)
2424     {
2425         if ($compile_clean_files{$item} == MOSTLY_CLEAN)
2426         {
2427             push (@mostly_rms, "\t-rm -f $item");
2428         }
2429         elsif ($compile_clean_files{$item} == DIST_CLEAN)
2430         {
2431             push (@dist_rms, "\t-rm -f $item");
2432         }
2433         else
2434         {
2435           prog_error 'invalid entry in %compile_clean_files';
2436         }
2437     }
2439     my ($coms, $vars, $rules) =
2440       &file_contents_internal (1, "$libdir/am/compile.am",
2441                                new Automake::Location,
2442                                ('DEFAULT_INCLUDES' => $default_includes,
2443                                 'MOSTLYRMS' => join ("\n", @mostly_rms),
2444                                 'DISTRMS' => join ("\n", @dist_rms)));
2445     $output_vars .= $vars;
2446     $output_rules .= "$coms$rules";
2449 # handle_libtool ()
2450 # -----------------
2451 # Handle libtool rules.
2452 sub handle_libtool
2454   return unless var ('LIBTOOL');
2456   # Libtool requires some files, but only at top level.
2457   # (Starting with Libtool 2.0 we do not have to bother.  These
2458   # requirements are done with AC_REQUIRE_AUX_FILE.)
2459   require_conf_file_with_macro (TRUE, 'LIBTOOL', FOREIGN, @libtool_files)
2460     if $relative_dir eq '.' && ! $libtool_new_api;
2462   my @libtool_rms;
2463   foreach my $item (sort keys %libtool_clean_directories)
2464     {
2465       my $dir = ($item eq '.') ? '' : "$item/";
2466       # .libs is for Unix, _libs for DOS.
2467       push (@libtool_rms, "\t-rm -rf ${dir}.libs ${dir}_libs");
2468     }
2470   check_user_variables 'LIBTOOLFLAGS';
2472   # Output the libtool compilation rules.
2473   $output_rules .= &file_contents ('libtool',
2474                                    new Automake::Location,
2475                                    LTRMS => join ("\n", @libtool_rms));
2478 # handle_programs ()
2479 # ------------------
2480 # Handle C programs.
2481 sub handle_programs
2483   my @proglist = &am_install_var ('progs', 'PROGRAMS',
2484                                   'bin', 'sbin', 'libexec', 'pkglibexec',
2485                                   'noinst', 'check');
2486   return if ! @proglist;
2487   $must_handle_compiled_objects = 1;
2489   my $seen_global_libobjs =
2490     var ('LDADD') && &handle_lib_objects ('', 'LDADD');
2492   foreach my $pair (@proglist)
2493     {
2494       my ($where, $one_file) = @$pair;
2496       my $seen_libobjs = 0;
2497       my $obj = '.$(OBJEXT)';
2499       $known_programs{$one_file} = $where;
2501       # Canonicalize names and check for misspellings.
2502       my $xname = &check_canonical_spelling ($one_file, '_LDADD', '_LDFLAGS',
2503                                              '_SOURCES', '_OBJECTS',
2504                                              '_DEPENDENCIES');
2506       $where->push_context ("while processing program '$one_file'");
2507       $where->set (INTERNAL->get);
2509       my $linker = &handle_source_transform ($xname, $one_file, $obj, $where,
2510                                              NONLIBTOOL => 1, LIBTOOL => 0);
2512       if (var ($xname . "_LDADD"))
2513         {
2514           $seen_libobjs = &handle_lib_objects ($xname, $xname . '_LDADD');
2515         }
2516       else
2517         {
2518           # User didn't define prog_LDADD override.  So do it.
2519           &define_variable ($xname . '_LDADD', '$(LDADD)', $where);
2521           # This does a bit too much work.  But we need it to
2522           # generate _DEPENDENCIES when appropriate.
2523           if (var ('LDADD'))
2524             {
2525               $seen_libobjs = &handle_lib_objects ($xname, 'LDADD');
2526             }
2527         }
2529       reject_var ($xname . '_LIBADD',
2530                   "use '${xname}_LDADD', not '${xname}_LIBADD'");
2532       set_seen ($xname . '_DEPENDENCIES');
2533       set_seen ('EXTRA_' . $xname . '_DEPENDENCIES');
2534       set_seen ($xname . '_LDFLAGS');
2536       # Determine program to use for link.
2537       my($xlink, $vlink) = &define_per_target_linker_variable ($linker, $xname);
2538       $vlink = verbose_flag ($vlink || 'GEN');
2540       # If the resulting program lies in a subdirectory,
2541       # ensure that the directory exists before we need it.
2542       my $dirstamp = require_build_directory_maybe ($one_file);
2544       $libtool_clean_directories{dirname ($one_file)} = 1;
2546       $output_rules .= &file_contents ('program',
2547                                        $where,
2548                                        PROGRAM  => $one_file,
2549                                        XPROGRAM => $xname,
2550                                        XLINK    => $xlink,
2551                                        VERBOSE  => $vlink,
2552                                        DIRSTAMP => $dirstamp,
2553                                        EXEEXT   => '$(EXEEXT)');
2555       if ($seen_libobjs || $seen_global_libobjs)
2556         {
2557           if (var ($xname . '_LDADD'))
2558             {
2559               &check_libobjs_sources ($xname, $xname . '_LDADD');
2560             }
2561           elsif (var ('LDADD'))
2562             {
2563               &check_libobjs_sources ($xname, 'LDADD');
2564             }
2565         }
2566     }
2570 # handle_libraries ()
2571 # -------------------
2572 # Handle libraries.
2573 sub handle_libraries
2575   my @liblist = &am_install_var ('libs', 'LIBRARIES',
2576                                  'lib', 'pkglib', 'noinst', 'check');
2577   return if ! @liblist;
2578   $must_handle_compiled_objects = 1;
2580   my @prefix = am_primary_prefixes ('LIBRARIES', 0, 'lib', 'pkglib',
2581                                     'noinst', 'check');
2583   if (@prefix)
2584     {
2585       my $var = rvar ($prefix[0] . '_LIBRARIES');
2586       $var->requires_variables ('library used', 'RANLIB');
2587     }
2589   &define_variable ('AR', 'ar', INTERNAL);
2590   &define_variable ('ARFLAGS', 'cru', INTERNAL);
2591   &define_verbose_tagvar ('AR');
2593   foreach my $pair (@liblist)
2594     {
2595       my ($where, $onelib) = @$pair;
2597       my $seen_libobjs = 0;
2598       # Check that the library fits the standard naming convention.
2599       my $bn = basename ($onelib);
2600       if ($bn !~ /^lib.*\.a$/)
2601         {
2602           $bn =~ s/^(?:lib)?(.*?)(?:\.[^.]*)?$/lib$1.a/;
2603           my $suggestion = dirname ($onelib) . "/$bn";
2604           $suggestion =~ s|^\./||g;
2605           msg ('error-gnu/warn', $where,
2606                "'$onelib' is not a standard library name\n"
2607                . "did you mean '$suggestion'?")
2608         }
2610       ($known_libraries{$onelib} = $bn) =~ s/\.a$//;
2612       $where->push_context ("while processing library '$onelib'");
2613       $where->set (INTERNAL->get);
2615       my $obj = '.$(OBJEXT)';
2617       # Canonicalize names and check for misspellings.
2618       my $xlib = &check_canonical_spelling ($onelib, '_LIBADD', '_SOURCES',
2619                                             '_OBJECTS', '_DEPENDENCIES',
2620                                             '_AR');
2622       if (! var ($xlib . '_AR'))
2623         {
2624           &define_variable ($xlib . '_AR', '$(AR) $(ARFLAGS)', $where);
2625         }
2627       # Generate support for conditional object inclusion in
2628       # libraries.
2629       if (var ($xlib . '_LIBADD'))
2630         {
2631           if (&handle_lib_objects ($xlib, $xlib . '_LIBADD'))
2632             {
2633               $seen_libobjs = 1;
2634             }
2635         }
2636       else
2637         {
2638           &define_variable ($xlib . "_LIBADD", '', $where);
2639         }
2641       reject_var ($xlib . '_LDADD',
2642                   "use '${xlib}_LIBADD', not '${xlib}_LDADD'");
2644       # Make sure we at look at this.
2645       set_seen ($xlib . '_DEPENDENCIES');
2646       set_seen ('EXTRA_' . $xlib . '_DEPENDENCIES');
2648       &handle_source_transform ($xlib, $onelib, $obj, $where,
2649                                 NONLIBTOOL => 1, LIBTOOL => 0);
2651       # If the resulting library lies in a subdirectory,
2652       # make sure this directory will exist.
2653       my $dirstamp = require_build_directory_maybe ($onelib);
2654       my $verbose = verbose_flag ('AR');
2655       my $silent = silent_flag ();
2657       $output_rules .= &file_contents ('library',
2658                                        $where,
2659                                        VERBOSE  => $verbose,
2660                                        SILENT   => $silent,
2661                                        LIBRARY  => $onelib,
2662                                        XLIBRARY => $xlib,
2663                                        DIRSTAMP => $dirstamp);
2665       if ($seen_libobjs)
2666         {
2667           if (var ($xlib . '_LIBADD'))
2668             {
2669               &check_libobjs_sources ($xlib, $xlib . '_LIBADD');
2670             }
2671         }
2673       if (! $seen_ar)
2674         {
2675           msg ('extra-portability', $where,
2676                "'$onelib': linking libraries using a non-POSIX\n"
2677                . "archiver requires 'AM_PROG_AR' in '$configure_ac'")
2678         }
2679     }
2683 # handle_ltlibraries ()
2684 # ---------------------
2685 # Handle shared libraries.
2686 sub handle_ltlibraries
2688   my @liblist = &am_install_var ('ltlib', 'LTLIBRARIES',
2689                                  'noinst', 'lib', 'pkglib', 'check');
2690   return if ! @liblist;
2691   $must_handle_compiled_objects = 1;
2693   my @prefix = am_primary_prefixes ('LTLIBRARIES', 0, 'lib', 'pkglib',
2694                                     'noinst', 'check');
2696   if (@prefix)
2697     {
2698       my $var = rvar ($prefix[0] . '_LTLIBRARIES');
2699       $var->requires_variables ('Libtool library used', 'LIBTOOL');
2700     }
2702   my %instdirs = ();
2703   my %instsubdirs = ();
2704   my %instconds = ();
2705   my %liblocations = ();        # Location (in Makefile.am) of each library.
2707   foreach my $key (@prefix)
2708     {
2709       # Get the installation directory of each library.
2710       my $dir = $key;
2711       my $strip_subdir = 1;
2712       if ($dir =~ /^nobase_/)
2713         {
2714           $dir =~ s/^nobase_//;
2715           $strip_subdir = 0;
2716         }
2717       my $var = rvar ($key . '_LTLIBRARIES');
2719       # We reject libraries which are installed in several places
2720       # in the same condition, because we can only specify one
2721       # '-rpath' option.
2722       $var->traverse_recursively
2723         (sub
2724          {
2725            my ($var, $val, $cond, $full_cond) = @_;
2726            my $hcond = $full_cond->human;
2727            my $where = $var->rdef ($cond)->location;
2728            my $ldir = '';
2729            $ldir = '/' . dirname ($val)
2730              if (!$strip_subdir);
2731            # A library cannot be installed in different directories
2732            # in overlapping conditions.
2733            if (exists $instconds{$val})
2734              {
2735                my ($msg, $acond) =
2736                  $instconds{$val}->ambiguous_p ($val, $full_cond);
2738                if ($msg)
2739                  {
2740                    error ($where, $msg, partial => 1);
2741                    my $dirtxt = "installed " . ($strip_subdir ? "in" : "below") . " '$dir'";
2742                    $dirtxt = "built for '$dir'"
2743                      if $dir eq 'EXTRA' || $dir eq 'noinst' || $dir eq 'check';
2744                    my $dircond =
2745                      $full_cond->true ? "" : " in condition $hcond";
2747                    error ($where, "'$val' should be $dirtxt$dircond ...",
2748                           partial => 1);
2750                    my $hacond = $acond->human;
2751                    my $adir = $instdirs{$val}{$acond};
2752                    my $adirtxt = "installed in '$adir'";
2753                    $adirtxt = "built for '$adir'"
2754                      if ($adir eq 'EXTRA' || $adir eq 'noinst'
2755                          || $adir eq 'check');
2756                    my $adircond = $acond->true ? "" : " in condition $hacond";
2758                    my $onlyone = ($dir ne $adir) ?
2759                      ("\nLibtool libraries can be built for only one "
2760                       . "destination") : "";
2762                    error ($liblocations{$val}{$acond},
2763                           "... and should also be $adirtxt$adircond.$onlyone");
2764                    return;
2765                  }
2766              }
2767            else
2768              {
2769                $instconds{$val} = new Automake::DisjConditions;
2770              }
2771            $instdirs{$val}{$full_cond} = $dir;
2772            $instsubdirs{$val}{$full_cond} = $ldir;
2773            $liblocations{$val}{$full_cond} = $where;
2774            $instconds{$val} = $instconds{$val}->merge ($full_cond);
2775          },
2776          sub
2777          {
2778            return ();
2779          },
2780          skip_ac_subst => 1);
2781     }
2783   foreach my $pair (@liblist)
2784     {
2785       my ($where, $onelib) = @$pair;
2787       my $seen_libobjs = 0;
2788       my $obj = '.lo';
2790       # Canonicalize names and check for misspellings.
2791       my $xlib = &check_canonical_spelling ($onelib, '_LIBADD', '_LDFLAGS',
2792                                             '_SOURCES', '_OBJECTS',
2793                                             '_DEPENDENCIES');
2795       # Check that the library fits the standard naming convention.
2796       my $libname_rx = '^lib.*\.la';
2797       my $ldvar = var ("${xlib}_LDFLAGS") || var ('AM_LDFLAGS');
2798       my $ldvar2 = var ('LDFLAGS');
2799       if (($ldvar && grep (/-module/, $ldvar->value_as_list_recursive))
2800           || ($ldvar2 && grep (/-module/, $ldvar2->value_as_list_recursive)))
2801         {
2802           # Relax name checking for libtool modules.
2803           $libname_rx = '\.la';
2804         }
2806       my $bn = basename ($onelib);
2807       if ($bn !~ /$libname_rx$/)
2808         {
2809           my $type = 'library';
2810           if ($libname_rx eq '\.la')
2811             {
2812               $bn =~ s/^(lib|)(.*?)(?:\.[^.]*)?$/$1$2.la/;
2813               $type = 'module';
2814             }
2815           else
2816             {
2817               $bn =~ s/^(?:lib)?(.*?)(?:\.[^.]*)?$/lib$1.la/;
2818             }
2819           my $suggestion = dirname ($onelib) . "/$bn";
2820           $suggestion =~ s|^\./||g;
2821           msg ('error-gnu/warn', $where,
2822                "'$onelib' is not a standard libtool $type name\n"
2823                . "did you mean '$suggestion'?")
2824         }
2826       ($known_libraries{$onelib} = $bn) =~ s/\.la$//;
2828       $where->push_context ("while processing Libtool library '$onelib'");
2829       $where->set (INTERNAL->get);
2831       # Make sure we look at these.
2832       set_seen ($xlib . '_LDFLAGS');
2833       set_seen ($xlib . '_DEPENDENCIES');
2834       set_seen ('EXTRA_' . $xlib . '_DEPENDENCIES');
2836       # Generate support for conditional object inclusion in
2837       # libraries.
2838       if (var ($xlib . '_LIBADD'))
2839         {
2840           if (&handle_lib_objects ($xlib, $xlib . '_LIBADD'))
2841             {
2842               $seen_libobjs = 1;
2843             }
2844         }
2845       else
2846         {
2847           &define_variable ($xlib . "_LIBADD", '', $where);
2848         }
2850       reject_var ("${xlib}_LDADD",
2851                   "use '${xlib}_LIBADD', not '${xlib}_LDADD'");
2854       my $linker = &handle_source_transform ($xlib, $onelib, $obj, $where,
2855                                              NONLIBTOOL => 0, LIBTOOL => 1);
2857       # Determine program to use for link.
2858       my($xlink, $vlink) = &define_per_target_linker_variable ($linker, $xlib);
2859       $vlink = verbose_flag ($vlink || 'GEN');
2861       my $rpathvar = "am_${xlib}_rpath";
2862       my $rpath = "\$($rpathvar)";
2863       foreach my $rcond ($instconds{$onelib}->conds)
2864         {
2865           my $val;
2866           if ($instdirs{$onelib}{$rcond} eq 'EXTRA'
2867               || $instdirs{$onelib}{$rcond} eq 'noinst'
2868               || $instdirs{$onelib}{$rcond} eq 'check')
2869             {
2870               # It's an EXTRA_ library, so we can't specify -rpath,
2871               # because we don't know where the library will end up.
2872               # The user probably knows, but generally speaking automake
2873               # doesn't -- and in fact configure could decide
2874               # dynamically between two different locations.
2875               $val = '';
2876             }
2877           else
2878             {
2879               $val = ('-rpath $(' . $instdirs{$onelib}{$rcond} . 'dir)');
2880               $val .= $instsubdirs{$onelib}{$rcond}
2881                 if defined $instsubdirs{$onelib}{$rcond};
2882             }
2883           if ($rcond->true)
2884             {
2885               # If $rcond is true there is only one condition and
2886               # there is no point defining an helper variable.
2887               $rpath = $val;
2888             }
2889           else
2890             {
2891               define_pretty_variable ($rpathvar, $rcond, INTERNAL, $val);
2892             }
2893         }
2895       # If the resulting library lies in a subdirectory,
2896       # make sure this directory will exist.
2897       my $dirstamp = require_build_directory_maybe ($onelib);
2899       # Remember to cleanup .libs/ in this directory.
2900       my $dirname = dirname $onelib;
2901       $libtool_clean_directories{$dirname} = 1;
2903       $output_rules .= &file_contents ('ltlibrary',
2904                                        $where,
2905                                        LTLIBRARY  => $onelib,
2906                                        XLTLIBRARY => $xlib,
2907                                        RPATH      => $rpath,
2908                                        XLINK      => $xlink,
2909                                        VERBOSE    => $vlink,
2910                                        DIRSTAMP   => $dirstamp);
2911       if ($seen_libobjs)
2912         {
2913           if (var ($xlib . '_LIBADD'))
2914             {
2915               &check_libobjs_sources ($xlib, $xlib . '_LIBADD');
2916             }
2917         }
2919       if (! $seen_ar)
2920         {
2921           msg ('extra-portability', $where,
2922                "'$onelib': linking libtool libraries using a non-POSIX\n"
2923                . "archiver requires 'AM_PROG_AR' in '$configure_ac'")
2924         }
2925     }
2928 # See if any _SOURCES variable were misspelled.
2929 sub check_typos ()
2931   # It is ok if the user sets this particular variable.
2932   set_seen 'AM_LDFLAGS';
2934   foreach my $primary ('SOURCES', 'LIBADD', 'LDADD', 'LDFLAGS', 'DEPENDENCIES')
2935     {
2936       foreach my $var (variables $primary)
2937         {
2938           my $varname = $var->name;
2939           # A configure variable is always legitimate.
2940           next if exists $configure_vars{$varname};
2942           for my $cond ($var->conditions->conds)
2943             {
2944               $varname =~ /^(?:EXTRA_)?(?:nobase_)?(?:dist_|nodist_)?(.*)_[[:alnum:]]+$/;
2945               msg_var ('syntax', $var, "variable '$varname' is defined but no"
2946                        . " program or\nlibrary has '$1' as canonical name"
2947                        . " (possible typo)")
2948                 unless $var->rdef ($cond)->seen;
2949             }
2950         }
2951     }
2955 # Handle scripts.
2956 sub handle_scripts
2958     # NOTE we no longer automatically clean SCRIPTS, because it is
2959     # useful to sometimes distribute scripts verbatim.  This happens
2960     # e.g. in Automake itself.
2961     &am_install_var ('-candist', 'scripts', 'SCRIPTS',
2962                      'bin', 'sbin', 'libexec', 'pkglibexec', 'pkgdata',
2963                      'noinst', 'check');
2969 ## ------------------------ ##
2970 ## Handling Texinfo files.  ##
2971 ## ------------------------ ##
2973 # ($OUTFILE, $VFILE)
2974 # &scan_texinfo_file ($FILENAME)
2975 # ------------------------------
2976 # $OUTFILE     - name of the info file produced by $FILENAME.
2977 # $VFILE       - name of the version.texi file used (undef if none).
2978 sub scan_texinfo_file ($)
2980   my ($filename) = @_;
2982   my $texi = new Automake::XFile "< $filename";
2983   verb "reading $filename";
2985   my ($outfile, $vfile);
2986   while ($_ = $texi->getline)
2987     {
2988       if (/^\@setfilename +(\S+)/)
2989         {
2990           # Honor only the first @setfilename.  (It's possible to have
2991           # more occurrences later if the manual shows examples of how
2992           # to use @setfilename...)
2993           next if $outfile;
2995           $outfile = $1;
2996           # TODO: In Automake 1.14 (or even 1.13.2), start warning against
2997           # TODO: suffixes != ".info", to ease transition to Automake-NG.
2998           if ($outfile =~ /\.([^.]+)$/ && $1 ne 'info')
2999             {
3000               error ("$filename:$.",
3001                      "output '$outfile' has unrecognized extension");
3002               return;
3003             }
3004         }
3005       # A "version.texi" file is actually any file whose name matches
3006       # "vers*.texi".
3007       elsif (/^\@include\s+(vers[^.]*\.texi)\s*$/)
3008         {
3009           $vfile = $1;
3010         }
3011     }
3013   if (! $outfile)
3014     {
3015       err_am "'$filename' missing \@setfilename";
3016       return;
3017     }
3019   my $infobase = basename ($filename);
3020   # TODO: In Automake 1.14 (or even 1.13.2), start warning against
3021   # TODO: suffixes != ".texi", to ease transition to Automake-NG.
3022   $infobase =~ s/\.te?xi(nfo)?$//;
3023   return ($outfile, $vfile);
3027 # ($DIRSTAMP, @CLEAN_FILES)
3028 # output_texinfo_build_rules ($SOURCE, $DEST, $INSRC, @DEPENDENCIES)
3029 # ------------------------------------------------------------------
3030 # SOURCE - the source Texinfo file
3031 # DEST - the destination Info file
3032 # INSRC - whether DEST should be built in the source tree
3033 # DEPENDENCIES - known dependencies
3034 sub output_texinfo_build_rules ($$$@)
3036   my ($source, $dest, $insrc, @deps) = @_;
3038   # Split 'a.texi' into 'a' and '.texi'.
3039   my ($spfx, $ssfx) = ($source =~ /^(.*?)(\.[^.]*)?$/);
3040   my ($dpfx, $dsfx) = ($dest =~ /^(.*?)(\.[^.]*)?$/);
3042   $ssfx ||= "";
3043   $dsfx ||= "";
3045   # We can output two kinds of rules: the "generic" rules use Make
3046   # suffix rules and are appropriate when $source and $dest do not lie
3047   # in a sub-directory; the "specific" rules are needed in the other
3048   # case.
3049   #
3050   # The former are output only once (this is not really apparent here,
3051   # but just remember that some logic deeper in Automake will not
3052   # output the same rule twice); while the later need to be output for
3053   # each Texinfo source.
3054   my $generic;
3055   my $makeinfoflags;
3056   my $sdir = dirname $source;
3057   if ($sdir eq '.' && dirname ($dest) eq '.')
3058     {
3059       $generic = 1;
3060       $makeinfoflags = '-I $(srcdir)';
3061     }
3062   else
3063     {
3064       $generic = 0;
3065       $makeinfoflags = "-I $sdir -I \$(srcdir)/$sdir";
3066     }
3068   # A directory can contain two kinds of info files: some built in the
3069   # source tree, and some built in the build tree.  The rules are
3070   # different in each case.  However we cannot output two different
3071   # set of generic rules.  Because in-source builds are more usual, we
3072   # use generic rules in this case and fall back to "specific" rules
3073   # for build-dir builds.  (It should not be a problem to invert this
3074   # if needed.)
3075   $generic = 0 unless $insrc;
3077   # We cannot use a suffix rule to build info files with an empty
3078   # extension.  Otherwise we would output a single suffix inference
3079   # rule, with separate dependencies, as in
3080   #
3081   #    .texi:
3082   #             $(MAKEINFO) ...
3083   #    foo.info: foo.texi
3084   #
3085   # which confuse Solaris make.  (See the Autoconf manual for
3086   # details.)  Therefore we use a specific rule in this case.  This
3087   # applies to info files only (dvi and pdf files always have an
3088   # extension).
3089   my $generic_info = ($generic && $dsfx) ? 1 : 0;
3091   # If the resulting file lies in a subdirectory,
3092   # make sure this directory will exist.
3093   my $dirstamp = require_build_directory_maybe ($dest);
3095   my $dipfx = ($insrc ? '$(srcdir)/' : '') . $dpfx;
3097   $output_rules .= file_contents ('texibuild',
3098                                   new Automake::Location,
3099                                   AM_V_MAKEINFO    => verbose_flag('MAKEINFO'),
3100                                   AM_V_TEXI2DVI    => verbose_flag('TEXI2DVI'),
3101                                   AM_V_TEXI2PDF    => verbose_flag('TEXI2PDF'),
3102                                   DEPS             => "@deps",
3103                                   DEST_PREFIX      => $dpfx,
3104                                   DEST_INFO_PREFIX => $dipfx,
3105                                   DEST_SUFFIX      => $dsfx,
3106                                   DIRSTAMP         => $dirstamp,
3107                                   GENERIC          => $generic,
3108                                   GENERIC_INFO     => $generic_info,
3109                                   INSRC            => $insrc,
3110                                   MAKEINFOFLAGS    => $makeinfoflags,
3111                                   SILENT           => silent_flag(),
3112                                   SOURCE           => ($generic
3113                                                        ? '$<' : $source),
3114                                   SOURCE_INFO      => ($generic_info
3115                                                        ? '$<' : $source),
3116                                   SOURCE_REAL      => $source,
3117                                   SOURCE_SUFFIX    => $ssfx,
3118                                   TEXIQUIET        => verbose_flag('texinfo'),
3119                                   TEXIDEVNULL      => verbose_flag('texidevnull'),
3120                                   );
3121   return ($dirstamp, "$dpfx.dvi", "$dpfx.pdf", "$dpfx.ps", "$dpfx.html");
3125 # ($MOSTLYCLEAN, $TEXICLEAN, $MAINTCLEAN)
3126 # handle_texinfo_helper ($info_texinfos)
3127 # --------------------------------------
3128 # Handle all Texinfo source; helper for handle_texinfo.
3129 sub handle_texinfo_helper ($)
3131   my ($info_texinfos) = @_;
3132   my (@infobase, @info_deps_list, @texi_deps);
3133   my %versions;
3134   my $done = 0;
3135   my (@mostly_cleans, @texi_cleans, @maint_cleans) = ('', '', '');
3137   # Build a regex matching user-cleaned files.
3138   my $d = var 'DISTCLEANFILES';
3139   my $c = var 'CLEANFILES';
3140   my @f = ();
3141   push @f, $d->value_as_list_recursive (inner_expand => 1) if $d;
3142   push @f, $c->value_as_list_recursive (inner_expand => 1) if $c;
3143   @f = map { s|[^A-Za-z_0-9*\[\]\-]|\\$&|g; s|\*|[^/]*|g; $_; } @f;
3144   my $user_cleaned_files = '^(?:' . join ('|', @f) . ')$';
3146   foreach my $texi
3147       ($info_texinfos->value_as_list_recursive (inner_expand => 1))
3148     {
3149       my $infobase = $texi;
3150       # TODO: In Automake 1.14 (or even 1.13.2), start warning against
3151       # TODO: suffixes != ".texi", to ease transition to Automake-NG.
3152       $infobase =~ s/\.(txi|texinfo|texi)$//;
3154       if ($infobase eq $texi)
3155         {
3156           # FIXME: report line number.
3157           err_am "texinfo file '$texi' has unrecognized extension";
3158           next;
3159         }
3161       push @infobase, $infobase;
3163       # If 'version.texi' is referenced by input file, then include
3164       # automatic versioning capability.
3165       my ($out_file, $vtexi) =
3166         scan_texinfo_file ("$relative_dir/$texi")
3167         or next;
3168       # Directory of auxiliary files and build by-products used by texi2dvi
3169       # and texi2pdf.
3170       push @mostly_cleans, "$infobase.t2d";
3171       push @mostly_cleans, "$infobase.t2p";
3173       # If the Texinfo source is in a subdirectory, create the
3174       # resulting info in this subdirectory.  If it is in the current
3175       # directory, try hard to not prefix "./" because it breaks the
3176       # generic rules.
3177       my $outdir = dirname ($texi) . '/';
3178       $outdir = "" if $outdir eq './';
3179       $out_file =  $outdir . $out_file;
3181       # Until Automake 1.6.3, .info files were built in the
3182       # source tree.  This was an obstacle to the support of
3183       # non-distributed .info files, and non-distributed .texi
3184       # files.
3185       #
3186       # * Non-distributed .texi files is important in some packages
3187       #   where .texi files are built at make time, probably using
3188       #   other binaries built in the package itself, maybe using
3189       #   tools or information found on the build host.  Because
3190       #   these files are not distributed they are always rebuilt
3191       #   at make time; they should therefore not lie in the source
3192       #   directory.  One plan was to support this using
3193       #   nodist_info_TEXINFOS or something similar.  (Doing this
3194       #   requires some sanity checks.  For instance Automake should
3195       #   not allow:
3196       #      dist_info_TEXINFOS = foo.texi
3197       #      nodist_foo_TEXINFOS = included.texi
3198       #   because a distributed file should never depend on a
3199       #   non-distributed file.)
3200       #
3201       # * If .texi files are not distributed, then .info files should
3202       #   not be distributed either.  There are also cases where one
3203       #   wants to distribute .texi files, but does not want to
3204       #   distribute the .info files.  For instance the Texinfo package
3205       #   distributes the tool used to build these files; it would
3206       #   be a waste of space to distribute them.  It's not clear
3207       #   which syntax we should use to indicate that .info files should
3208       #   not be distributed.  Akim Demaille suggested that eventually
3209       #   we switch to a new syntax:
3210       #   |  Maybe we should take some inspiration from what's already
3211       #   |  done in the rest of Automake.  Maybe there is too much
3212       #   |  syntactic sugar here, and you want
3213       #   |     nodist_INFO = bar.info
3214       #   |     dist_bar_info_SOURCES = bar.texi
3215       #   |     bar_texi_DEPENDENCIES = foo.texi
3216       #   |  with a bit of magic to have bar.info represent the whole
3217       #   |  bar*info set.  That's a lot more verbose that the current
3218       #   |  situation, but it is # not new, hence the user has less
3219       #   |  to learn.
3220       #   |
3221       #   |  But there is still too much room for meaningless specs:
3222       #   |     nodist_INFO = bar.info
3223       #   |     dist_bar_info_SOURCES = bar.texi
3224       #   |     dist_PS = bar.ps something-written-by-hand.ps
3225       #   |     nodist_bar_ps_SOURCES = bar.texi
3226       #   |     bar_texi_DEPENDENCIES = foo.texi
3227       #   |  here bar.texi is dist_ in line 2, and nodist_ in 4.
3228       #
3229       # Back to the point, it should be clear that in order to support
3230       # non-distributed .info files, we need to build them in the
3231       # build tree, not in the source tree (non-distributed .texi
3232       # files are less of a problem, because we do not output build
3233       # rules for them).  In Automake 1.7 .info build rules have been
3234       # largely cleaned up so that .info files get always build in the
3235       # build tree, even when distributed.  The idea was that
3236       #   (1) if during a VPATH build the .info file was found to be
3237       #       absent or out-of-date (in the source tree or in the
3238       #       build tree), Make would rebuild it in the build tree.
3239       #       If an up-to-date source-tree of the .info file existed,
3240       #       make would not rebuild it in the build tree.
3241       #   (2) having two copies of .info files, one in the source tree
3242       #       and one (newer) in the build tree is not a problem
3243       #       because 'make dist' always pick files in the build tree
3244       #       first.
3245       # However it turned out the be a bad idea for several reasons:
3246       #   * Tru64, OpenBSD, and FreeBSD (not NetBSD) Make do not behave
3247       #     like GNU Make on point (1) above.  These implementations
3248       #     of Make would always rebuild .info files in the build
3249       #     tree, even if such files were up to date in the source
3250       #     tree.  Consequently, it was impossible to perform a VPATH
3251       #     build of a package containing Texinfo files using these
3252       #     Make implementations.
3253       #     (Refer to the Autoconf Manual, section "Limitation of
3254       #     Make", paragraph "VPATH", item "target lookup", for
3255       #     an account of the differences between these
3256       #     implementations.)
3257       #   * The GNU Coding Standards require these files to be built
3258       #     in the source-tree (when they are distributed, that is).
3259       #   * Keeping a fresher copy of distributed files in the
3260       #     build tree can be annoying during development because
3261       #     - if the files is kept under CVS, you really want it
3262       #       to be updated in the source tree
3263       #     - it is confusing that 'make distclean' does not erase
3264       #       all files in the build tree.
3265       #
3266       # Consequently, starting with Automake 1.8, .info files are
3267       # built in the source tree again.  Because we still plan to
3268       # support non-distributed .info files at some point, we
3269       # have a single variable ($INSRC) that controls whether
3270       # the current .info file must be built in the source tree
3271       # or in the build tree.  Actually this variable is switched
3272       # off for .info files that appear to be cleaned; this is
3273       # for backward compatibility with package such as Texinfo,
3274       # which do things like
3275       #   info_TEXINFOS = texinfo.txi info-stnd.texi info.texi
3276       #   DISTCLEANFILES = texinfo texinfo-* info*.info*
3277       #   # Do not create info files for distribution.
3278       #   dist-info:
3279       # in order not to distribute .info files.
3280       my $insrc = ($out_file =~ $user_cleaned_files) ? 0 : 1;
3282       my $soutdir = '$(srcdir)/' . $outdir;
3283       $outdir = $soutdir if $insrc;
3285       # If user specified file_TEXINFOS, then use that as explicit
3286       # dependency list.
3287       @texi_deps = ();
3288       push (@texi_deps, "$soutdir$vtexi") if $vtexi;
3290       my $canonical = canonicalize ($infobase);
3291       if (var ($canonical . "_TEXINFOS"))
3292         {
3293           push (@texi_deps, '$(' . $canonical . '_TEXINFOS)');
3294           push_dist_common ('$(' . $canonical . '_TEXINFOS)');
3295         }
3297       my ($dirstamp, @cfiles) =
3298         output_texinfo_build_rules ($texi, $out_file, $insrc, @texi_deps);
3299       push (@texi_cleans, @cfiles);
3301       push (@info_deps_list, $out_file);
3303       # If a vers*.texi file is needed, emit the rule.
3304       if ($vtexi)
3305         {
3306           err_am ("'$vtexi', included in '$texi', "
3307                   . "also included in '$versions{$vtexi}'")
3308             if defined $versions{$vtexi};
3309           $versions{$vtexi} = $texi;
3311           # We number the stamp-vti files.  This is doable since the
3312           # actual names don't matter much.  We only number starting
3313           # with the second one, so that the common case looks nice.
3314           my $vti = ($done ? $done : 'vti');
3315           ++$done;
3317           # This is ugly, but it is our historical practice.
3318           if ($config_aux_dir_set_in_configure_ac)
3319             {
3320               require_conf_file_with_macro (TRUE, 'info_TEXINFOS', FOREIGN,
3321                                             'mdate-sh');
3322             }
3323           else
3324             {
3325               require_file_with_macro (TRUE, 'info_TEXINFOS',
3326                                        FOREIGN, 'mdate-sh');
3327             }
3329           my $conf_dir;
3330           if ($config_aux_dir_set_in_configure_ac)
3331             {
3332               $conf_dir = "$am_config_aux_dir/";
3333             }
3334           else
3335             {
3336               $conf_dir = '$(srcdir)/';
3337             }
3338           $output_rules .= file_contents ('texi-vers',
3339                                           new Automake::Location,
3340                                           TEXI     => $texi,
3341                                           VTI      => $vti,
3342                                           STAMPVTI => "${soutdir}stamp-$vti",
3343                                           VTEXI    => "$soutdir$vtexi",
3344                                           MDDIR    => $conf_dir,
3345                                           DIRSTAMP => $dirstamp);
3346         }
3347     }
3349   # Handle location of texinfo.tex.
3350   my $need_texi_file = 0;
3351   my $texinfodir;
3352   if (var ('TEXINFO_TEX'))
3353     {
3354       # The user defined TEXINFO_TEX so assume he knows what he is
3355       # doing.
3356       $texinfodir = ('$(srcdir)/'
3357                      . dirname (variable_value ('TEXINFO_TEX')));
3358     }
3359   elsif ($config_aux_dir_set_in_configure_ac)
3360     {
3361       $texinfodir = $am_config_aux_dir;
3362       define_variable ('TEXINFO_TEX', "$texinfodir/texinfo.tex", INTERNAL);
3363       $need_texi_file = 2; # so that we require_conf_file later
3364     }
3365   else
3366     {
3367       $texinfodir = '$(srcdir)';
3368       $need_texi_file = 1;
3369     }
3370   define_variable ('am__TEXINFO_TEX_DIR', $texinfodir, INTERNAL);
3372   push (@dist_targets, 'dist-info');
3374   if (! option 'no-installinfo')
3375     {
3376       # Make sure documentation is made and installed first.  Use
3377       # $(INFO_DEPS), not 'info', because otherwise recursive makes
3378       # get run twice during "make all".
3379       unshift (@all, '$(INFO_DEPS)');
3380     }
3382   define_files_variable ("DVIS", @infobase, 'dvi', INTERNAL);
3383   define_files_variable ("PDFS", @infobase, 'pdf', INTERNAL);
3384   define_files_variable ("PSS", @infobase, 'ps', INTERNAL);
3385   define_files_variable ("HTMLS", @infobase, 'html', INTERNAL);
3387   # This next isn't strictly needed now -- the places that look here
3388   # could easily be changed to look in info_TEXINFOS.  But this is
3389   # probably better, in case noinst_TEXINFOS is ever supported.
3390   define_variable ("TEXINFOS", variable_value ('info_TEXINFOS'), INTERNAL);
3392   # Do some error checking.  Note that this file is not required
3393   # when in Cygnus mode; instead we defined TEXINFO_TEX explicitly
3394   # up above.
3395   if ($need_texi_file && ! option 'no-texinfo.tex')
3396     {
3397       if ($need_texi_file > 1)
3398         {
3399           require_conf_file_with_macro (TRUE, 'info_TEXINFOS', FOREIGN,
3400                                         'texinfo.tex');
3401         }
3402       else
3403         {
3404           require_file_with_macro (TRUE, 'info_TEXINFOS', FOREIGN,
3405                                    'texinfo.tex');
3406         }
3407     }
3409   return (makefile_wrap ("", "\t  ", @mostly_cleans),
3410           makefile_wrap ("", "\t  ", @texi_cleans),
3411           makefile_wrap ("", "\t  ", @maint_cleans));
3415 # handle_texinfo ()
3416 # -----------------
3417 # Handle all Texinfo source.
3418 sub handle_texinfo ()
3420   reject_var 'TEXINFOS', "'TEXINFOS' is an anachronism; use 'info_TEXINFOS'";
3421   # FIXME: I think this is an obsolete future feature name.
3422   reject_var 'html_TEXINFOS', "HTML generation not yet supported";
3424   my $info_texinfos = var ('info_TEXINFOS');
3425   my ($mostlyclean, $clean, $maintclean) = ('', '', '');
3426   if ($info_texinfos)
3427     {
3428       define_verbose_texinfo;
3429       ($mostlyclean, $clean, $maintclean) = handle_texinfo_helper ($info_texinfos);
3430       chomp $mostlyclean;
3431       chomp $clean;
3432       chomp $maintclean;
3433     }
3435   $output_rules .=  file_contents ('texinfos',
3436                                    new Automake::Location,
3437                                    AM_V_DVIPS    => verbose_flag('DVIPS'),
3438                                    MOSTLYCLEAN   => $mostlyclean,
3439                                    TEXICLEAN     => $clean,
3440                                    MAINTCLEAN    => $maintclean,
3441                                    'LOCAL-TEXIS' => !!$info_texinfos,
3442                                    TEXIQUIET     => verbose_flag('texinfo'));
3446 # Handle any man pages.
3447 sub handle_man_pages
3449   reject_var 'MANS', "'MANS' is an anachronism; use 'man_MANS'";
3451   # Find all the sections in use.  We do this by first looking for
3452   # "standard" sections, and then looking for any additional
3453   # sections used in man_MANS.
3454   my (%sections, %notrans_sections, %trans_sections,
3455       %notrans_vars, %trans_vars, %notrans_sect_vars, %trans_sect_vars);
3456   # We handle nodist_ for uniformity.  man pages aren't distributed
3457   # by default so it isn't actually very important.
3458   foreach my $npfx ('', 'notrans_')
3459     {
3460       foreach my $pfx ('', 'dist_', 'nodist_')
3461         {
3462           # Add more sections as needed.
3463           foreach my $section ('0'..'9', 'n', 'l')
3464             {
3465               my $varname = $npfx . $pfx . 'man' . $section . '_MANS';
3466               if (var ($varname))
3467                 {
3468                   $sections{$section} = 1;
3469                   $varname = '$(' . $varname . ')';
3470                   if ($npfx eq 'notrans_')
3471                     {
3472                       $notrans_sections{$section} = 1;
3473                       $notrans_sect_vars{$varname} = 1;
3474                     }
3475                   else
3476                     {
3477                       $trans_sections{$section} = 1;
3478                       $trans_sect_vars{$varname} = 1;
3479                     }
3481                   &push_dist_common ($varname)
3482                     if $pfx eq 'dist_';
3483                 }
3484             }
3486           my $varname = $npfx . $pfx . 'man_MANS';
3487           my $var = var ($varname);
3488           if ($var)
3489             {
3490               foreach ($var->value_as_list_recursive)
3491                 {
3492                   # A page like 'foo.1c' goes into man1dir.
3493                   if (/\.([0-9a-z])([a-z]*)$/)
3494                     {
3495                       $sections{$1} = 1;
3496                       if ($npfx eq 'notrans_')
3497                         {
3498                           $notrans_sections{$1} = 1;
3499                         }
3500                       else
3501                         {
3502                           $trans_sections{$1} = 1;
3503                         }
3504                     }
3505                 }
3507               $varname = '$(' . $varname . ')';
3508               if ($npfx eq 'notrans_')
3509                 {
3510                   $notrans_vars{$varname} = 1;
3511                 }
3512               else
3513                 {
3514                   $trans_vars{$varname} = 1;
3515                 }
3516               &push_dist_common ($varname)
3517                 if $pfx eq 'dist_';
3518             }
3519         }
3520     }
3522   return unless %sections;
3524   my @unsorted_deps;
3526   # Build section independent variables.
3527   my $have_notrans = %notrans_vars;
3528   my @notrans_list = sort keys %notrans_vars;
3529   my $have_trans = %trans_vars;
3530   my @trans_list = sort keys %trans_vars;
3532   # Now for each section, generate an install and uninstall rule.
3533   # Sort sections so output is deterministic.
3534   foreach my $section (sort keys %sections)
3535     {
3536       # Build section dependent variables.
3537       my $notrans_mans = $have_notrans || exists $notrans_sections{$section};
3538       my $trans_mans = $have_trans || exists $trans_sections{$section};
3539       my (%notrans_this_sect, %trans_this_sect);
3540       my $expr = 'man' . $section . '_MANS';
3541       foreach my $varname (keys %notrans_sect_vars)
3542         {
3543           if ($varname =~ /$expr/)
3544             {
3545               $notrans_this_sect{$varname} = 1;
3546             }
3547         }
3548       foreach my $varname (keys %trans_sect_vars)
3549         {
3550           if ($varname =~ /$expr/)
3551             {
3552               $trans_this_sect{$varname} = 1;
3553             }
3554         }
3555       my @notrans_sect_list = sort keys %notrans_this_sect;
3556       my @trans_sect_list = sort keys %trans_this_sect;
3557       @unsorted_deps = (keys %notrans_vars, keys %trans_vars,
3558                         keys %notrans_this_sect, keys %trans_this_sect);
3559       my @deps = sort @unsorted_deps;
3560       $output_rules .= &file_contents ('mans',
3561                                        new Automake::Location,
3562                                        SECTION           => $section,
3563                                        DEPS              => "@deps",
3564                                        NOTRANS_MANS      => $notrans_mans,
3565                                        NOTRANS_SECT_LIST => "@notrans_sect_list",
3566                                        HAVE_NOTRANS      => $have_notrans,
3567                                        NOTRANS_LIST      => "@notrans_list",
3568                                        TRANS_MANS        => $trans_mans,
3569                                        TRANS_SECT_LIST   => "@trans_sect_list",
3570                                        HAVE_TRANS        => $have_trans,
3571                                        TRANS_LIST        => "@trans_list");
3572     }
3574   @unsorted_deps  = (keys %notrans_vars, keys %trans_vars,
3575                      keys %notrans_sect_vars, keys %trans_sect_vars);
3576   my @mans = sort @unsorted_deps;
3577   $output_vars .= file_contents ('mans-vars',
3578                                  new Automake::Location,
3579                                  MANS => "@mans");
3581   push (@all, '$(MANS)')
3582     unless option 'no-installman';
3585 # Handle DATA variables.
3586 sub handle_data
3588     &am_install_var ('-noextra', '-candist', 'data', 'DATA',
3589                      'data', 'dataroot', 'doc', 'dvi', 'html', 'pdf',
3590                      'ps', 'sysconf', 'sharedstate', 'localstate',
3591                      'pkgdata', 'lisp', 'noinst', 'check');
3594 # Handle TAGS.
3595 sub handle_tags
3597     my @config;
3598     foreach my $spec (@config_headers)
3599       {
3600         my ($out, @ins) = split_config_file_spec ($spec);
3601         foreach my $in (@ins)
3602           {
3603             # If the config header source is in this directory,
3604             # require it.
3605             push @config, basename ($in)
3606               if $relative_dir eq dirname ($in);
3607            }
3608       }
3610     define_variable ('am__tagged_files',
3611                      '$(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)'
3612                      . "@config", INTERNAL);
3614     if (rvar('am__tagged_files')->value_as_list_recursive
3615           || var ('ETAGS_ARGS') || var ('SUBDIRS'))
3616       {
3617         $output_rules .= &file_contents ('tags', new Automake::Location);
3618         set_seen 'TAGS_DEPENDENCIES';
3619       }
3620     else
3621       {
3622         reject_var ('TAGS_DEPENDENCIES',
3623                     "it doesn't make sense to define 'TAGS_DEPENDENCIES'"
3624                     . " without\nsources or 'ETAGS_ARGS'");
3625         # Every Makefile must define some sort of TAGS rule.
3626         # Otherwise, it would be possible for a top-level "make TAGS"
3627         # to fail because some subdirectory failed.  Ditto ctags and
3628         # cscope.
3629         $output_rules .=
3630           "tags TAGS:\n\n" .
3631           "ctags CTAGS:\n\n" .
3632           "cscope cscopelist:\n\n";
3633       }
3637 # user_phony_rule ($NAME)
3638 # -----------------------
3639 # Return false if rule $NAME does not exist.  Otherwise,
3640 # declare it as phony, complete its definition (in case it is
3641 # conditional), and return its Automake::Rule instance.
3642 sub user_phony_rule ($)
3644   my ($name) = @_;
3645   my $rule = rule $name;
3646   if ($rule)
3647     {
3648       depend ('.PHONY', $name);
3649       # Define $NAME in all condition where it is not already defined,
3650       # so that it is always OK to depend on $NAME.
3651       for my $c ($rule->not_always_defined_in_cond (TRUE)->conds)
3652         {
3653           Automake::Rule::define ($name, 'internal', RULE_AUTOMAKE,
3654                                   $c, INTERNAL);
3655           $output_rules .= $c->subst_string . "$name:\n";
3656         }
3657     }
3658   return $rule;
3662 # handle_dist
3663 # -----------
3664 # Handle 'dist' target.
3665 sub handle_dist ()
3667   # Substitutions for distdir.am
3668   my %transform;
3670   # Define DIST_SUBDIRS.  This must always be done, regardless of the
3671   # no-dist setting: target like 'distclean' or 'maintainer-clean' use it.
3672   my $subdirs = var ('SUBDIRS');
3673   if ($subdirs)
3674     {
3675       # If SUBDIRS is conditionally defined, then set DIST_SUBDIRS
3676       # to all possible directories, and use it.  If DIST_SUBDIRS is
3677       # defined, just use it.
3679       # Note that we check DIST_SUBDIRS first on purpose, so that
3680       # we don't call has_conditional_contents for now reason.
3681       # (In the past one project used so many conditional subdirectories
3682       # that calling has_conditional_contents on SUBDIRS caused
3683       # automake to grow to 150Mb -- this should not happen with
3684       # the current implementation of has_conditional_contents,
3685       # but it's more efficient to avoid the call anyway.)
3686       if (var ('DIST_SUBDIRS'))
3687         {
3688         }
3689       elsif ($subdirs->has_conditional_contents)
3690         {
3691           define_pretty_variable
3692             ('DIST_SUBDIRS', TRUE, INTERNAL,
3693              uniq ($subdirs->value_as_list_recursive));
3694         }
3695       else
3696         {
3697           # We always define this because that is what 'distclean'
3698           # wants.
3699           define_pretty_variable ('DIST_SUBDIRS', TRUE, INTERNAL,
3700                                   '$(SUBDIRS)');
3701         }
3702     }
3704   # The remaining definitions are only required when a dist target is used.
3705   return if option 'no-dist';
3707   # At least one of the archive formats must be enabled.
3708   if ($relative_dir eq '.')
3709     {
3710       my $archive_defined = option 'no-dist-gzip' ? 0 : 1;
3711       $archive_defined ||=
3712         grep { option "dist-$_" } qw(shar zip tarZ bzip2 lzip xz);
3713       error (option 'no-dist-gzip',
3714              "no-dist-gzip specified but no dist-* specified,\n"
3715              . "at least one archive format must be enabled")
3716         unless $archive_defined;
3717     }
3719   # Look for common files that should be included in distribution.
3720   # If the aux dir is set, and it does not have a Makefile.am, then
3721   # we check for these files there as well.
3722   my $check_aux = 0;
3723   if ($relative_dir eq '.'
3724       && $config_aux_dir_set_in_configure_ac)
3725     {
3726       if (! &is_make_dir ($config_aux_dir))
3727         {
3728           $check_aux = 1;
3729         }
3730     }
3731   foreach my $cfile (@common_files)
3732     {
3733       if (dir_has_case_matching_file ($relative_dir, $cfile)
3734           # The file might be absent, but if it can be built it's ok.
3735           || rule $cfile)
3736         {
3737           &push_dist_common ($cfile);
3738         }
3740       # Don't use 'elsif' here because a file might meaningfully
3741       # appear in both directories.
3742       if ($check_aux && dir_has_case_matching_file ($config_aux_dir, $cfile))
3743         {
3744           &push_dist_common ("$config_aux_dir/$cfile")
3745         }
3746     }
3748   # We might copy elements from $configure_dist_common to
3749   # %dist_common if we think we need to.  If the file appears in our
3750   # directory, we would have discovered it already, so we don't
3751   # check that.  But if the file is in a subdir without a Makefile,
3752   # we want to distribute it here if we are doing '.'.  Ugly!
3753   # Also, in some corner cases, it's possible that the following code
3754   # will cause the same file to appear in the $(DIST_COMMON) variables
3755   # of two distinct Makefiles; but this is not a problem, since the
3756   # 'distdir' target in 'lib/am/distdir.am' can deal with the same
3757   # file being distributed multiple times.
3758   # See also automake bug#9651.
3759   if ($relative_dir eq '.')
3760     {
3761       foreach my $file (split (' ' , $configure_dist_common))
3762         {
3763           my $dir = dirname ($file);
3764           push_dist_common ($file)
3765             if ($dir eq '.' || ! is_make_dir ($dir));
3766         }
3767     }
3769   # Files to distributed.  Don't use ->value_as_list_recursive
3770   # as it recursively expands '$(dist_pkgdata_DATA)' etc.
3771   my @dist_common = split (' ', rvar ('DIST_COMMON')->variable_value);
3772   @dist_common = uniq @dist_common;
3773   variable_delete 'DIST_COMMON';
3774   define_pretty_variable ('DIST_COMMON', TRUE, INTERNAL, @dist_common);
3776   # Now that we've processed DIST_COMMON, disallow further attempts
3777   # to set it.
3778   $handle_dist_run = 1;
3780   $transform{'DISTCHECK-HOOK'} = !! rule 'distcheck-hook';
3781   $transform{'GETTEXT'} = $seen_gettext && !$seen_gettext_external;
3783   # If the target 'dist-hook' exists, make sure it is run.  This
3784   # allows users to do random weird things to the distribution
3785   # before it is packaged up.
3786   push (@dist_targets, 'dist-hook')
3787     if user_phony_rule 'dist-hook';
3788   $transform{'DIST-TARGETS'} = join (' ', @dist_targets);
3790   my $flm = option ('filename-length-max');
3791   my $filename_filter = $flm ? '.' x $flm->[1] : '';
3793   $output_rules .= &file_contents ('distdir',
3794                                    new Automake::Location,
3795                                    %transform,
3796                                    FILENAME_FILTER => $filename_filter);
3800 # check_directory ($NAME, $WHERE [, $RELATIVE_DIR = "."])
3801 # -------------------------------------------------------
3802 # Ensure $NAME is a directory (in $RELATIVE_DIR), and that it uses a sane
3803 # name.  Use $WHERE as a location in the diagnostic, if any.
3804 sub check_directory ($$;$)
3806   my ($dir, $where, $reldir) = @_;
3807   $reldir = '.' unless defined $reldir;
3809   error $where, "required directory $reldir/$dir does not exist"
3810     unless -d "$reldir/$dir";
3812   # If an 'obj/' directory exists, BSD make will enter it before
3813   # reading 'Makefile'.  Hence the 'Makefile' in the current directory
3814   # will not be read.
3815   #
3816   #  % cat Makefile
3817   #  all:
3818   #          echo Hello
3819   #  % cat obj/Makefile
3820   #  all:
3821   #          echo World
3822   #  % make      # GNU make
3823   #  echo Hello
3824   #  Hello
3825   #  % pmake     # BSD make
3826   #  echo World
3827   #  World
3828   msg ('portability', $where,
3829        "naming a subdirectory 'obj' causes troubles with BSD make")
3830     if $dir eq 'obj';
3832   # 'aux' is probably the most important of the following forbidden name,
3833   # since it's tempting to use it as an AC_CONFIG_AUX_DIR.
3834   msg ('portability', $where,
3835        "name '$dir' is reserved on W32 and DOS platforms")
3836     if grep (/^\Q$dir\E$/i, qw/aux lpt1 lpt2 lpt3 com1 com2 com3 com4 con prn/);
3839 # check_directories_in_var ($VARIABLE)
3840 # ------------------------------------
3841 # Recursively check all items in variables $VARIABLE as directories
3842 sub check_directories_in_var ($)
3844   my ($var) = @_;
3845   $var->traverse_recursively
3846     (sub
3847      {
3848        my ($var, $val, $cond, $full_cond) = @_;
3849        check_directory ($val, $var->rdef ($cond)->location, $relative_dir);
3850        return ();
3851      },
3852      undef,
3853      skip_ac_subst => 1);
3856 # &handle_subdirs ()
3857 # ------------------
3858 # Handle subdirectories.
3859 sub handle_subdirs ()
3861   my $subdirs = var ('SUBDIRS');
3862   return
3863     unless $subdirs;
3865   check_directories_in_var $subdirs;
3867   my $dsubdirs = var ('DIST_SUBDIRS');
3868   check_directories_in_var $dsubdirs
3869     if $dsubdirs;
3871   $output_rules .= &file_contents ('subdirs', new Automake::Location);
3872   rvar ('RECURSIVE_TARGETS')->rdef (TRUE)->{'pretty'} = VAR_SORTED; # Gross!
3876 # ($REGEN, @DEPENDENCIES)
3877 # &scan_aclocal_m4
3878 # ----------------
3879 # If aclocal.m4 creation is automated, return the list of its dependencies.
3880 sub scan_aclocal_m4 ()
3882   my $regen_aclocal = 0;
3884   set_seen 'CONFIG_STATUS_DEPENDENCIES';
3885   set_seen 'CONFIGURE_DEPENDENCIES';
3887   if (-f 'aclocal.m4')
3888     {
3889       &define_variable ("ACLOCAL_M4", '$(top_srcdir)/aclocal.m4', INTERNAL);
3891       my $aclocal = new Automake::XFile "< aclocal.m4";
3892       my $line = $aclocal->getline;
3893       $regen_aclocal = $line =~ 'generated automatically by aclocal';
3894     }
3896   my @ac_deps = ();
3898   if (set_seen ('ACLOCAL_M4_SOURCES'))
3899     {
3900       push (@ac_deps, '$(ACLOCAL_M4_SOURCES)');
3901       msg_var ('obsolete', 'ACLOCAL_M4_SOURCES',
3902                "'ACLOCAL_M4_SOURCES' is obsolete.\n"
3903                . "It should be safe to simply remove it");
3904     }
3906   # Note that it might be possible that aclocal.m4 doesn't exist but
3907   # should be auto-generated.  This case probably isn't very
3908   # important.
3910   return ($regen_aclocal, @ac_deps);
3914 # Helper function for substitute_ac_subst_variables.
3915 sub substitute_ac_subst_variables_worker($)
3917   my ($token) = @_;
3918   return "\@$token\@" if var $token;
3919   return "\${$token\}";
3922 # substitute_ac_subst_variables ($TEXT)
3923 # -------------------------------------
3924 # Replace any occurrence of ${FOO} in $TEXT by @FOO@ if FOO is an AC_SUBST
3925 # variable.
3926 sub substitute_ac_subst_variables ($)
3928   my ($text) = @_;
3929   $text =~ s/\${([^ \t=:+{}]+)}/&substitute_ac_subst_variables_worker ($1)/ge;
3930   return $text;
3933 # @DEPENDENCIES
3934 # &prepend_srcdir (@INPUTS)
3935 # -------------------------
3936 # Prepend $(srcdir) or $(top_srcdir) to all @INPUTS.  The idea is that
3937 # if an input file has a directory part the same as the current
3938 # directory, then the directory part is simply replaced by $(srcdir).
3939 # But if the directory part is different, then $(top_srcdir) is
3940 # prepended.
3941 sub prepend_srcdir (@)
3943   my (@inputs) = @_;
3944   my @newinputs;
3946   foreach my $single (@inputs)
3947     {
3948       if (dirname ($single) eq $relative_dir)
3949         {
3950           push (@newinputs, '$(srcdir)/' . basename ($single));
3951         }
3952       else
3953         {
3954           push (@newinputs, '$(top_srcdir)/' . $single);
3955         }
3956     }
3957   return @newinputs;
3960 # @DEPENDENCIES
3961 # rewrite_inputs_into_dependencies ($OUTPUT, @INPUTS)
3962 # ---------------------------------------------------
3963 # Compute a list of dependencies appropriate for the rebuild
3964 # rule of
3965 #   AC_CONFIG_FILES($OUTPUT:$INPUT[0]:$INPUTS[1]:...)
3966 # Also distribute $INPUTs which are not built by another AC_CONFIG_FOOs.
3967 sub rewrite_inputs_into_dependencies ($@)
3969   my ($file, @inputs) = @_;
3970   my @res = ();
3972   for my $i (@inputs)
3973     {
3974       # We cannot create dependencies on shell variables.
3975       next if (substitute_ac_subst_variables $i) =~ /\$/;
3977       if (exists $ac_config_files_location{$i} && $i ne $file)
3978         {
3979           my $di = dirname $i;
3980           if ($di eq $relative_dir)
3981             {
3982               $i = basename $i;
3983             }
3984           # In the top-level Makefile we do not use $(top_builddir), because
3985           # we are already there, and since the targets are built without
3986           # a $(top_builddir), it helps BSD Make to match them with
3987           # dependencies.
3988           elsif ($relative_dir ne '.')
3989             {
3990               $i = '$(top_builddir)/' . $i;
3991             }
3992         }
3993       else
3994         {
3995           msg ('error', $ac_config_files_location{$file},
3996                "required file '$i' not found")
3997             unless $i =~ /\$/ || exists $output_files{$i} || -f $i;
3998           ($i) = prepend_srcdir ($i);
3999           push_dist_common ($i);
4000         }
4001       push @res, $i;
4002     }
4003   return @res;
4008 # &handle_configure ($MAKEFILE_AM, $MAKEFILE_IN, $MAKEFILE, @INPUTS)
4009 # ------------------------------------------------------------------
4010 # Handle remaking and configure stuff.
4011 # We need the name of the input file, to do proper remaking rules.
4012 sub handle_configure ($$$@)
4014   my ($makefile_am, $makefile_in, $makefile, @inputs) = @_;
4016   prog_error 'empty @inputs'
4017     unless @inputs;
4019   my ($rel_makefile_am, $rel_makefile_in) = prepend_srcdir ($makefile_am,
4020                                                             $makefile_in);
4021   my $rel_makefile = basename $makefile;
4023   my $colon_infile = ':' . join (':', @inputs);
4024   $colon_infile = '' if $colon_infile eq ":$makefile.in";
4025   my @rewritten = rewrite_inputs_into_dependencies ($makefile, @inputs);
4026   my ($regen_aclocal_m4, @aclocal_m4_deps) = scan_aclocal_m4;
4027   define_pretty_variable ('am__aclocal_m4_deps', TRUE, INTERNAL,
4028                           @configure_deps, @aclocal_m4_deps,
4029                           '$(top_srcdir)/' . $configure_ac);
4030   my @configuredeps = ('$(am__aclocal_m4_deps)', '$(CONFIGURE_DEPENDENCIES)');
4031   push @configuredeps, '$(ACLOCAL_M4)' if -f 'aclocal.m4';
4032   define_pretty_variable ('am__configure_deps', TRUE, INTERNAL,
4033                           @configuredeps);
4035   my $automake_options = '--' . $strictness_name .
4036                          (global_option 'no-dependencies' ? ' --ignore-deps' : '');
4038   $output_rules .= file_contents
4039     ('configure',
4040      new Automake::Location,
4041      MAKEFILE              => $rel_makefile,
4042      'MAKEFILE-DEPS'       => "@rewritten",
4043      'CONFIG-MAKEFILE'     => ($relative_dir eq '.') ? '$@' : '$(subdir)/$@',
4044      'MAKEFILE-IN'         => $rel_makefile_in,
4045      'HAVE-MAKEFILE-IN-DEPS' => (@include_stack > 0),
4046      'MAKEFILE-IN-DEPS'    => "@include_stack",
4047      'MAKEFILE-AM'         => $rel_makefile_am,
4048      'AUTOMAKE-OPTIONS'    => $automake_options,
4049      'MAKEFILE-AM-SOURCES' => "$makefile$colon_infile",
4050      'REGEN-ACLOCAL-M4'    => $regen_aclocal_m4,
4051      VERBOSE               => verbose_flag ('GEN'));
4053   if ($relative_dir eq '.')
4054     {
4055       &push_dist_common ('acconfig.h')
4056         if -f 'acconfig.h';
4057     }
4059   # If we have a configure header, require it.
4060   my $hdr_index = 0;
4061   my @distclean_config;
4062   foreach my $spec (@config_headers)
4063     {
4064       $hdr_index += 1;
4065       # $CONFIG_H_PATH: config.h from top level.
4066       my ($config_h_path, @ins) = split_config_file_spec ($spec);
4067       my $config_h_dir = dirname ($config_h_path);
4069       # If the header is in the current directory we want to build
4070       # the header here.  Otherwise, if we're at the topmost
4071       # directory and the header's directory doesn't have a
4072       # Makefile, then we also want to build the header.
4073       if ($relative_dir eq $config_h_dir
4074           || ($relative_dir eq '.' && ! &is_make_dir ($config_h_dir)))
4075         {
4076           my ($cn_sans_dir, $stamp_dir);
4077           if ($relative_dir eq $config_h_dir)
4078             {
4079               $cn_sans_dir = basename ($config_h_path);
4080               $stamp_dir = '';
4081             }
4082           else
4083             {
4084               $cn_sans_dir = $config_h_path;
4085               if ($config_h_dir eq '.')
4086                 {
4087                   $stamp_dir = '';
4088                 }
4089               else
4090                 {
4091                   $stamp_dir = $config_h_dir . '/';
4092                 }
4093             }
4095           # This will also distribute all inputs.
4096           @ins = rewrite_inputs_into_dependencies ($config_h_path, @ins);
4098           # Cannot define rebuild rules for filenames with shell variables.
4099           next if (substitute_ac_subst_variables $config_h_path) =~ /\$/;
4101           # Header defined in this directory.
4102           my @files;
4103           if (-f $config_h_path . '.top')
4104             {
4105               push (@files, "$cn_sans_dir.top");
4106             }
4107           if (-f $config_h_path . '.bot')
4108             {
4109               push (@files, "$cn_sans_dir.bot");
4110             }
4112           push_dist_common (@files);
4114           # For now, acconfig.h can only appear in the top srcdir.
4115           if (-f 'acconfig.h')
4116             {
4117               push (@files, '$(top_srcdir)/acconfig.h');
4118             }
4120           my $stamp = "${stamp_dir}stamp-h${hdr_index}";
4121           $output_rules .=
4122             file_contents ('remake-hdr',
4123                            new Automake::Location,
4124                            FILES            => "@files",
4125                            'FIRST-HDR'      => ($hdr_index == 1),
4126                            CONFIG_H         => $cn_sans_dir,
4127                            CONFIG_HIN       => $ins[0],
4128                            CONFIG_H_DEPS    => "@ins",
4129                            CONFIG_H_PATH    => $config_h_path,
4130                            STAMP            => "$stamp");
4132           push @distclean_config, $cn_sans_dir, $stamp;
4133         }
4134     }
4136   $output_rules .= file_contents ('clean-hdr',
4137                                   new Automake::Location,
4138                                   FILES => "@distclean_config")
4139     if @distclean_config;
4141   # Distribute and define mkinstalldirs only if it is already present
4142   # in the package, for backward compatibility (some people may still
4143   # use $(mkinstalldirs)).
4144   # TODO: start warning about this in Automake 1.13.2, and have
4145   # TODO: Automake 1.14 or 1.15 drop it (and the mkinstalldirs script
4146   # TODO: as well).
4147   my $mkidpath = "$config_aux_dir/mkinstalldirs";
4148   if (-f $mkidpath)
4149     {
4150       # Use require_file so that any existing script gets updated
4151       # by --force-missing.
4152       require_conf_file ($mkidpath, FOREIGN, 'mkinstalldirs');
4153       define_variable ('mkinstalldirs',
4154                        "\$(SHELL) $am_config_aux_dir/mkinstalldirs", INTERNAL);
4155     }
4156   else
4157     {
4158       # Use $(install_sh), not $(MKDIR_P) because the latter requires
4159       # at least one argument, and $(mkinstalldirs) used to work
4160       # even without arguments (e.g. $(mkinstalldirs) $(conditional_dir)).
4161       define_variable ('mkinstalldirs', '$(install_sh) -d', INTERNAL);
4162     }
4164   reject_var ('CONFIG_HEADER',
4165               "'CONFIG_HEADER' is an anachronism; now determined "
4166               . "automatically\nfrom '$configure_ac'");
4168   my @config_h;
4169   foreach my $spec (@config_headers)
4170     {
4171       my ($out, @ins) = split_config_file_spec ($spec);
4172       # Generate CONFIG_HEADER define.
4173       if ($relative_dir eq dirname ($out))
4174         {
4175           push @config_h, basename ($out);
4176         }
4177       else
4178         {
4179           push @config_h, "\$(top_builddir)/$out";
4180         }
4181     }
4182   define_variable ("CONFIG_HEADER", "@config_h", INTERNAL)
4183     if @config_h;
4185   # Now look for other files in this directory which must be remade
4186   # by config.status, and generate rules for them.
4187   my @actual_other_files = ();
4188   # These get cleaned only in a VPATH build.
4189   my @actual_other_vpath_files = ();
4190   foreach my $lfile (@other_input_files)
4191     {
4192       my $file;
4193       my @inputs;
4194       if ($lfile =~ /^([^:]*):(.*)$/)
4195         {
4196           # This is the ":" syntax of AC_OUTPUT.
4197           $file = $1;
4198           @inputs = split (':', $2);
4199         }
4200       else
4201         {
4202           # Normal usage.
4203           $file = $lfile;
4204           @inputs = $file . '.in';
4205         }
4207       # Automake files should not be stored in here, but in %MAKE_LIST.
4208       prog_error ("$lfile in \@other_input_files\n"
4209                   . "\@other_input_files = (@other_input_files)")
4210         if -f $file . '.am';
4212       my $local = basename ($file);
4214       # We skip files that aren't in this directory.  However, if
4215       # the file's directory does not have a Makefile, and we are
4216       # currently doing '.', then we create a rule to rebuild the
4217       # file in the subdir.
4218       my $fd = dirname ($file);
4219       if ($fd ne $relative_dir)
4220         {
4221           if ($relative_dir eq '.' && ! &is_make_dir ($fd))
4222             {
4223               $local = $file;
4224             }
4225           else
4226             {
4227               next;
4228             }
4229         }
4231       my @rewritten_inputs = rewrite_inputs_into_dependencies ($file, @inputs);
4233       # Cannot output rules for shell variables.
4234       next if (substitute_ac_subst_variables $local) =~ /\$/;
4236       my $condstr = '';
4237       my $cond = $ac_config_files_condition{$lfile};
4238       if (defined $cond)
4239         {
4240           $condstr = $cond->subst_string;
4241           Automake::Rule::define ($local, $configure_ac, RULE_AUTOMAKE, $cond,
4242                                   $ac_config_files_location{$file});
4243         }
4244       $output_rules .= ($condstr . $local . ': '
4245                         . '$(top_builddir)/config.status '
4246                         . "@rewritten_inputs\n"
4247                         . $condstr . "\t"
4248                         . 'cd $(top_builddir) && '
4249                         . '$(SHELL) ./config.status '
4250                         . ($relative_dir eq '.' ? '' : '$(subdir)/')
4251                         . '$@'
4252                         . "\n");
4253       push (@actual_other_files, $local);
4254     }
4256   # For links we should clean destinations and distribute sources.
4257   foreach my $spec (@config_links)
4258     {
4259       my ($link, $file) = split /:/, $spec;
4260       # Some people do AC_CONFIG_LINKS($computed).  We only handle
4261       # the DEST:SRC form.
4262       next unless $file;
4263       my $where = $ac_config_files_location{$link};
4265       # Skip destinations that contain shell variables.
4266       if ((substitute_ac_subst_variables $link) !~ /\$/)
4267         {
4268           # We skip links that aren't in this directory.  However, if
4269           # the link's directory does not have a Makefile, and we are
4270           # currently doing '.', then we add the link to CONFIG_CLEAN_FILES
4271           # in '.'s Makefile.in.
4272           my $local = basename ($link);
4273           my $fd = dirname ($link);
4274           if ($fd ne $relative_dir)
4275             {
4276               if ($relative_dir eq '.' && ! &is_make_dir ($fd))
4277                 {
4278                   $local = $link;
4279                 }
4280               else
4281                 {
4282                   $local = undef;
4283                 }
4284             }
4285           if ($file ne $link)
4286             {
4287               push @actual_other_files, $local if $local;
4288             }
4289           else
4290             {
4291               push @actual_other_vpath_files, $local if $local;
4292             }
4293         }
4295       # Do not process sources that contain shell variables.
4296       if ((substitute_ac_subst_variables $file) !~ /\$/)
4297         {
4298           my $fd = dirname ($file);
4300           # We distribute files that are in this directory.
4301           # At the top-level ('.') we also distribute files whose
4302           # directory does not have a Makefile.
4303           if (($fd eq $relative_dir)
4304               || ($relative_dir eq '.' && ! &is_make_dir ($fd)))
4305             {
4306               # The following will distribute $file as a side-effect when
4307               # it is appropriate (i.e., when $file is not already an output).
4308               # We do not need the result, just the side-effect.
4309               rewrite_inputs_into_dependencies ($link, $file);
4310             }
4311         }
4312     }
4314   # These files get removed by "make distclean".
4315   define_pretty_variable ('CONFIG_CLEAN_FILES', TRUE, INTERNAL,
4316                           @actual_other_files);
4317   define_pretty_variable ('CONFIG_CLEAN_VPATH_FILES', TRUE, INTERNAL,
4318                           @actual_other_vpath_files);
4321 # Handle C headers.
4322 sub handle_headers
4324     my @r = &am_install_var ('-defaultdist', 'header', 'HEADERS', 'include',
4325                              'oldinclude', 'pkginclude',
4326                              'noinst', 'check');
4327     foreach (@r)
4328     {
4329       next unless $_->[1] =~ /\..*$/;
4330       &saw_extension ($&);
4331     }
4334 sub handle_gettext
4336   return if ! $seen_gettext || $relative_dir ne '.';
4338   my $subdirs = var 'SUBDIRS';
4340   if (! $subdirs)
4341     {
4342       err_ac "AM_GNU_GETTEXT used but SUBDIRS not defined";
4343       return;
4344     }
4346   # Perform some sanity checks to help users get the right setup.
4347   # We disable these tests when po/ doesn't exist in order not to disallow
4348   # unusual gettext setups.
4349   #
4350   # Bruno Haible:
4351   # | The idea is:
4352   # |
4353   # |  1) If a package doesn't have a directory po/ at top level, it
4354   # |     will likely have multiple po/ directories in subpackages.
4355   # |
4356   # |  2) It is useful to warn for the absence of intl/ if AM_GNU_GETTEXT
4357   # |     is used without 'external'. It is also useful to warn for the
4358   # |     presence of intl/ if AM_GNU_GETTEXT([external]) is used. Both
4359   # |     warnings apply only to the usual layout of packages, therefore
4360   # |     they should both be disabled if no po/ directory is found at
4361   # |     top level.
4363   if (-d 'po')
4364     {
4365       my @subdirs = $subdirs->value_as_list_recursive;
4367       msg_var ('syntax', $subdirs,
4368                "AM_GNU_GETTEXT used but 'po' not in SUBDIRS")
4369         if ! grep ($_ eq 'po', @subdirs);
4371       # intl/ is not required when AM_GNU_GETTEXT is called with the
4372       # 'external' option and AM_GNU_GETTEXT_INTL_SUBDIR is not called.
4373       msg_var ('syntax', $subdirs,
4374                "AM_GNU_GETTEXT used but 'intl' not in SUBDIRS")
4375         if (! ($seen_gettext_external && ! $seen_gettext_intl)
4376             && ! grep ($_ eq 'intl', @subdirs));
4378       # intl/ should not be used with AM_GNU_GETTEXT([external]), except
4379       # if AM_GNU_GETTEXT_INTL_SUBDIR is called.
4380       msg_var ('syntax', $subdirs,
4381                "'intl' should not be in SUBDIRS when "
4382                . "AM_GNU_GETTEXT([external]) is used")
4383         if ($seen_gettext_external && ! $seen_gettext_intl
4384             && grep ($_ eq 'intl', @subdirs));
4385     }
4387   require_file ($ac_gettext_location, GNU, 'ABOUT-NLS');
4390 # Handle footer elements.
4391 sub handle_footer
4393     reject_rule ('.SUFFIXES',
4394                  "use variable 'SUFFIXES', not target '.SUFFIXES'");
4396     # Note: AIX 4.1 /bin/make will fail if any suffix rule appears
4397     # before .SUFFIXES.  So we make sure that .SUFFIXES appears before
4398     # anything else, by sticking it right after the default: target.
4399     $output_header .= ".SUFFIXES:\n";
4400     my $suffixes = var 'SUFFIXES';
4401     my @suffixes = Automake::Rule::suffixes;
4402     if (@suffixes || $suffixes)
4403     {
4404         # Make sure SUFFIXES has unique elements.  Sort them to ensure
4405         # the output remains consistent.  However, $(SUFFIXES) is
4406         # always at the start of the list, unsorted.  This is done
4407         # because make will choose rules depending on the ordering of
4408         # suffixes, and this lets the user have some control.  Push
4409         # actual suffixes, and not $(SUFFIXES).  Some versions of make
4410         # do not like variable substitutions on the .SUFFIXES line.
4411         my @user_suffixes = ($suffixes
4412                              ? $suffixes->value_as_list_recursive : ());
4414         my %suffixes = map { $_ => 1 } @suffixes;
4415         delete @suffixes{@user_suffixes};
4417         $output_header .= (".SUFFIXES: "
4418                            . join (' ', @user_suffixes, sort keys %suffixes)
4419                            . "\n");
4420     }
4422     $output_trailer .= file_contents ('footer', new Automake::Location);
4426 # Generate 'make install' rules.
4427 sub handle_install ()
4429   $output_rules .= &file_contents
4430     ('install',
4431      new Automake::Location,
4432      maybe_BUILT_SOURCES => (set_seen ('BUILT_SOURCES')
4433                              ? (" \$(BUILT_SOURCES)\n"
4434                                 . "\t\$(MAKE) \$(AM_MAKEFLAGS)")
4435                              : ''),
4436      'installdirs-local' => (user_phony_rule 'installdirs-local'
4437                              ? ' installdirs-local' : ''),
4438      am__installdirs => variable_value ('am__installdirs') || '');
4442 # Deal with all and all-am.
4443 sub handle_all ($)
4445     my ($makefile) = @_;
4447     # Output 'all-am'.
4449     # Put this at the beginning for the sake of non-GNU makes.  This
4450     # is still wrong if these makes can run parallel jobs.  But it is
4451     # right enough.
4452     unshift (@all, basename ($makefile));
4454     foreach my $spec (@config_headers)
4455       {
4456         my ($out, @ins) = split_config_file_spec ($spec);
4457         push (@all, basename ($out))
4458           if dirname ($out) eq $relative_dir;
4459       }
4461     # Install 'all' hooks.
4462     push (@all, "all-local")
4463       if user_phony_rule "all-local";
4465     &pretty_print_rule ("all-am:", "\t\t", @all);
4466     &depend ('.PHONY', 'all-am', 'all');
4469     # Output 'all'.
4471     my @local_headers = ();
4472     push @local_headers, '$(BUILT_SOURCES)'
4473       if var ('BUILT_SOURCES');
4474     foreach my $spec (@config_headers)
4475       {
4476         my ($out, @ins) = split_config_file_spec ($spec);
4477         push @local_headers, basename ($out)
4478           if dirname ($out) eq $relative_dir;
4479       }
4481     if (@local_headers)
4482       {
4483         # We need to make sure config.h is built before we recurse.
4484         # We also want to make sure that built sources are built
4485         # before any ordinary 'all' targets are run.  We can't do this
4486         # by changing the order of dependencies to the "all" because
4487         # that breaks when using parallel makes.  Instead we handle
4488         # things explicitly.
4489         $output_all .= ("all: @local_headers"
4490                         . "\n\t"
4491                         . '$(MAKE) $(AM_MAKEFLAGS) '
4492                         . (var ('SUBDIRS') ? 'all-recursive' : 'all-am')
4493                         . "\n\n");
4494         depend ('.MAKE', 'all');
4495       }
4496     else
4497       {
4498         $output_all .= "all: " . (var ('SUBDIRS')
4499                                   ? 'all-recursive' : 'all-am') . "\n\n";
4500       }
4503 # Generate helper targets for user recursion, where needed.
4504 sub handle_user_recursion ()
4506   return unless @extra_recursive_targets;
4508   define_pretty_variable ('am__extra_recursive_targets', TRUE, INTERNAL,
4509                           map { "$_-recursive" } @extra_recursive_targets);
4510   my $aux = var ('SUBDIRS') ? 'recursive' : 'am';
4511   foreach my $target (@extra_recursive_targets)
4512     {
4513       # This allows the default target's rules to be overridden in
4514       # Makefile.am.
4515       user_phony_rule ($target);
4516       depend ("$target", "$target-$aux");
4517       depend ("$target-am", "$target-local");
4518       # Every user-defined recursive target 'foo' *must* have a valid
4519       # associated 'foo-local' rule; we define it as an empty rule by
4520       # default, so that the user can transparently extend it in his
4521       # own Makefile.am.
4522       pretty_print_rule ("$target-local:");
4523       # $target-recursive might as well be undefined, so do not add
4524       # it here; it's taken care of in subdirs.am anyway.
4525       depend (".PHONY", "$target-am", "$target-local");
4526     }
4530 # &do_check_merge_target ()
4531 # -------------------------
4532 # Handle check merge target specially.
4533 sub do_check_merge_target ()
4535   # Include user-defined local form of target.
4536   push @check_tests, 'check-local'
4537     if user_phony_rule 'check-local';
4539   # The check target must depend on the local equivalent of
4540   # 'all', to ensure all the primary targets are built.  Then it
4541   # must build the local check rules.
4542   $output_rules .= "check-am: all-am\n";
4543   if (@check)
4544     {
4545       pretty_print_rule ("\t\$(MAKE) \$(AM_MAKEFLAGS)", "\t  ", @check);
4546       depend ('.MAKE', 'check-am');
4547     }
4549   if (@check_tests)
4550     {
4551       pretty_print_rule ("\t\$(MAKE) \$(AM_MAKEFLAGS)", "\t  ",
4552                          @check_tests);
4553       depend ('.MAKE', 'check-am');
4554     }
4556   depend '.PHONY', 'check', 'check-am';
4557   # Handle recursion.  We have to honor BUILT_SOURCES like for 'all:'.
4558   $output_rules .= ("check: "
4559                     . (var ('BUILT_SOURCES')
4560                        ? "\$(BUILT_SOURCES)\n\t\$(MAKE) \$(AM_MAKEFLAGS) "
4561                        : '')
4562                     . (var ('SUBDIRS') ? 'check-recursive' : 'check-am')
4563                     . "\n");
4564   depend ('.MAKE', 'check')
4565     if var ('BUILT_SOURCES');
4568 # handle_clean ($MAKEFILE)
4569 # ------------------------
4570 # Handle all 'clean' targets.
4571 sub handle_clean ($)
4573   my ($makefile) = @_;
4575   # Clean the files listed in user variables if they exist.
4576   $clean_files{'$(MOSTLYCLEANFILES)'} = MOSTLY_CLEAN
4577     if var ('MOSTLYCLEANFILES');
4578   $clean_files{'$(CLEANFILES)'} = CLEAN
4579     if var ('CLEANFILES');
4580   $clean_files{'$(DISTCLEANFILES)'} = DIST_CLEAN
4581     if var ('DISTCLEANFILES');
4582   $clean_files{'$(MAINTAINERCLEANFILES)'} = MAINTAINER_CLEAN
4583     if var ('MAINTAINERCLEANFILES');
4585   # Built sources are automatically removed by maintainer-clean.
4586   $clean_files{'$(BUILT_SOURCES)'} = MAINTAINER_CLEAN
4587     if var ('BUILT_SOURCES');
4589   # Compute a list of "rm"s to run for each target.
4590   my %rms = (MOSTLY_CLEAN, [],
4591              CLEAN, [],
4592              DIST_CLEAN, [],
4593              MAINTAINER_CLEAN, []);
4595   foreach my $file (keys %clean_files)
4596     {
4597       my $when = $clean_files{$file};
4598       prog_error 'invalid entry in %clean_files'
4599         unless exists $rms{$when};
4601       my $rm = "rm -f $file";
4602       # If file is a variable, make sure when don't call 'rm -f' without args.
4603       $rm ="test -z \"$file\" || $rm"
4604         if ($file =~ /^\s*\$(\(.*\)|\{.*\})\s*$/);
4606       push @{$rms{$when}}, "\t-$rm\n";
4607     }
4609   $output_rules .= &file_contents
4610     ('clean',
4611      new Automake::Location,
4612      MOSTLYCLEAN_RMS      => join ('', sort @{$rms{&MOSTLY_CLEAN}}),
4613      CLEAN_RMS            => join ('', sort @{$rms{&CLEAN}}),
4614      DISTCLEAN_RMS        => join ('', sort @{$rms{&DIST_CLEAN}}),
4615      MAINTAINER_CLEAN_RMS => join ('', sort @{$rms{&MAINTAINER_CLEAN}}),
4616      MAKEFILE             => basename $makefile,
4617      );
4621 # &target_cmp ($A, $B)
4622 # --------------------
4623 # Subroutine for &handle_factored_dependencies to let '.PHONY' and
4624 # other '.TARGETS' be last.
4625 sub target_cmp
4627   return 0 if $a eq $b;
4629   my $a1 = substr ($a, 0, 1);
4630   my $b1 = substr ($b, 0, 1);
4631   if ($a1 ne $b1)
4632     {
4633       return -1 if $b1 eq '.';
4634       return 1 if $a1 eq '.';
4635     }
4636   return $a cmp $b;
4640 # &handle_factored_dependencies ()
4641 # --------------------------------
4642 # Handle everything related to gathered targets.
4643 sub handle_factored_dependencies
4645   # Reject bad hooks.
4646   foreach my $utarg ('uninstall-data-local', 'uninstall-data-hook',
4647                      'uninstall-exec-local', 'uninstall-exec-hook',
4648                      'uninstall-dvi-local',
4649                      'uninstall-html-local',
4650                      'uninstall-info-local',
4651                      'uninstall-pdf-local',
4652                      'uninstall-ps-local')
4653     {
4654       my $x = $utarg;
4655       $x =~ s/-.*-/-/;
4656       reject_rule ($utarg, "use '$x', not '$utarg'");
4657     }
4659   reject_rule ('install-local',
4660                "use 'install-data-local' or 'install-exec-local', "
4661                . "not 'install-local'");
4663   reject_rule ('install-hook',
4664                "use 'install-data-hook' or 'install-exec-hook', "
4665                . "not 'install-hook'");
4667   # Install the -local hooks.
4668   foreach (keys %dependencies)
4669     {
4670       # Hooks are installed on the -am targets.
4671       s/-am$// or next;
4672       depend ("$_-am", "$_-local")
4673         if user_phony_rule "$_-local";
4674     }
4676   # Install the -hook hooks.
4677   # FIXME: Why not be as liberal as we are with -local hooks?
4678   foreach ('install-exec', 'install-data', 'uninstall')
4679     {
4680       if (user_phony_rule "$_-hook")
4681         {
4682           depend ('.MAKE', "$_-am");
4683           register_action("$_-am",
4684                           ("\t\@\$(NORMAL_INSTALL)\n"
4685                            . "\t\$(MAKE) \$(AM_MAKEFLAGS) $_-hook"));
4686         }
4687     }
4689   # All the required targets are phony.
4690   depend ('.PHONY', keys %required_targets);
4692   # Actually output gathered targets.
4693   foreach (sort target_cmp keys %dependencies)
4694     {
4695       # If there is nothing about this guy, skip it.
4696       next
4697         unless (@{$dependencies{$_}}
4698                 || $actions{$_}
4699                 || $required_targets{$_});
4701       # Define gathered targets in undefined conditions.
4702       # FIXME: Right now we must handle .PHONY as an exception,
4703       # because people write things like
4704       #    .PHONY: myphonytarget
4705       # to append dependencies.  This would not work if Automake
4706       # refrained from defining its own .PHONY target as it does
4707       # with other overridden targets.
4708       # Likewise for '.MAKE'.
4709       my @undefined_conds = (TRUE,);
4710       if ($_ ne '.PHONY' && $_ ne '.MAKE')
4711         {
4712           @undefined_conds =
4713             Automake::Rule::define ($_, 'internal',
4714                                     RULE_AUTOMAKE, TRUE, INTERNAL);
4715         }
4716       my @uniq_deps = uniq (sort @{$dependencies{$_}});
4717       foreach my $cond (@undefined_conds)
4718         {
4719           my $condstr = $cond->subst_string;
4720           &pretty_print_rule ("$condstr$_:", "$condstr\t", @uniq_deps);
4721           $output_rules .= $actions{$_} if defined $actions{$_};
4722           $output_rules .= "\n";
4723         }
4724     }
4728 # &handle_tests_dejagnu ()
4729 # ------------------------
4730 sub handle_tests_dejagnu
4732     push (@check_tests, 'check-DEJAGNU');
4733     $output_rules .= file_contents ('dejagnu', new Automake::Location);
4736 sub handle_per_suffix_test
4738   my ($test_suffix, %transform) = @_;
4739   my ($pfx, $generic, $am_exeext);
4740   if ($test_suffix eq '')
4741     {
4742       $pfx = '';
4743       $generic = 0;
4744       $am_exeext = 'FALSE';
4745     }
4746   else
4747     {
4748       prog_error ("test suffix '$test_suffix' lacks leading dot")
4749         unless $test_suffix =~ m/^\.(.*)/;
4750       $pfx = uc ($1) . '_';
4751       $generic = 1;
4752       $am_exeext = exists $configure_vars{'EXEEXT'} ? 'am__EXEEXT'
4753                                                     : 'FALSE';
4754     }
4755   # The "test driver" program, deputed to handle tests protocol used by
4756   # test scripts.  By default, it's assumed that no protocol is used, so
4757   # we fall back to the old behaviour, implemented by the 'test-driver'
4758   # auxiliary script.
4759   if (! var "${pfx}LOG_DRIVER")
4760     {
4761       require_conf_file ("parallel-tests", FOREIGN, 'test-driver');
4762       define_variable ("${pfx}LOG_DRIVER",
4763                        "\$(SHELL) $am_config_aux_dir/test-driver",
4764                        INTERNAL);
4765     }
4766   my $driver = '$(' . $pfx . 'LOG_DRIVER)';
4767   my $driver_flags = '$(AM_' . $pfx . 'LOG_DRIVER_FLAGS)'
4768                        . ' $(' . $pfx . 'LOG_DRIVER_FLAGS)';
4769   my $compile = "${pfx}LOG_COMPILE";
4770   define_variable ($compile,
4771                    '$(' . $pfx . 'LOG_COMPILER)'
4772                       . ' $(AM_' .  $pfx . 'LOG_FLAGS)'
4773                       . ' $(' . $pfx . 'LOG_FLAGS)',
4774                      INTERNAL);
4775   $output_rules .= file_contents ('check2', new Automake::Location,
4776                                    GENERIC => $generic,
4777                                    DRIVER => $driver,
4778                                    DRIVER_FLAGS => $driver_flags,
4779                                    COMPILE => '$(' . $compile . ')',
4780                                    EXT => $test_suffix,
4781                                    am__EXEEXT => $am_exeext,
4782                                    %transform);
4785 # is_valid_test_extension ($EXT)
4786 # ------------------------------
4787 # Return true if $EXT can appear in $(TEST_EXTENSIONS), return false
4788 # otherwise.
4789 sub is_valid_test_extension ($)
4791   my $ext = shift;
4792   return 1
4793     if ($ext =~ /^\.[a-zA-Z_][a-zA-Z0-9_]*$/);
4794   return 1
4795     if (exists $configure_vars{'EXEEXT'} && $ext eq subst ('EXEEXT'));
4796   return 0;
4799 # Handle TESTS variable and other checks.
4800 sub handle_tests
4802   if (option 'dejagnu')
4803     {
4804       &handle_tests_dejagnu;
4805     }
4806   else
4807     {
4808       foreach my $c ('DEJATOOL', 'RUNTEST', 'RUNTESTFLAGS')
4809         {
4810           reject_var ($c, "'$c' defined but 'dejagnu' not in "
4811                       . "'AUTOMAKE_OPTIONS'");
4812         }
4813     }
4815   if (var ('TESTS'))
4816     {
4817       push (@check_tests, 'check-TESTS');
4818       my $check_deps = "@check";
4819       $output_rules .= &file_contents ('check', new Automake::Location,
4820                                        SERIAL_TESTS => !! option 'serial-tests',
4821                                        CHECK_DEPS => $check_deps);
4823       # Tests that are known programs should have $(EXEEXT) appended.
4824       # For matching purposes, we need to adjust XFAIL_TESTS as well.
4825       append_exeext { exists $known_programs{$_[0]} } 'TESTS';
4826       append_exeext { exists $known_programs{$_[0]} } 'XFAIL_TESTS'
4827         if (var ('XFAIL_TESTS'));
4829       if (! option 'serial-tests')
4830         {
4831           define_variable ('TEST_SUITE_LOG', 'test-suite.log', INTERNAL);
4832           my $suff = '.test';
4833           my $at_exeext = '';
4834           my $handle_exeext = exists $configure_vars{'EXEEXT'};
4835           if ($handle_exeext)
4836             {
4837               $at_exeext = subst ('EXEEXT');
4838               $suff = $at_exeext  . ' ' . $suff;
4839             }
4840           if (! var 'TEST_EXTENSIONS')
4841             {
4842               define_variable ('TEST_EXTENSIONS', $suff, INTERNAL);
4843             }
4844           my $var = var 'TEST_EXTENSIONS';
4845           # Currently, we are not able to deal with conditional contents
4846           # in TEST_EXTENSIONS.
4847           if ($var->has_conditional_contents)
4848            {
4849              msg_var 'unsupported', $var,
4850                      "'TEST_EXTENSIONS' cannot have conditional contents";
4851            }
4852           my @test_suffixes = $var->value_as_list_recursive;
4853           if ((my @invalid_test_suffixes =
4854                   grep { !is_valid_test_extension $_ } @test_suffixes) > 0)
4855             {
4856               error $var->rdef (TRUE)->location,
4857                     "invalid test extensions: @invalid_test_suffixes";
4858             }
4859           @test_suffixes = grep { is_valid_test_extension $_ } @test_suffixes;
4860           if ($handle_exeext)
4861             {
4862               unshift (@test_suffixes, $at_exeext)
4863                 unless $test_suffixes[0] eq $at_exeext;
4864             }
4865           unshift (@test_suffixes, '');
4867           transform_variable_recursively
4868             ('TESTS', 'TEST_LOGS', 'am__testlogs', 1, INTERNAL,
4869               sub {
4870                 my ($subvar, $val, $cond, $full_cond) = @_;
4871                 my $obj = $val;
4872                 return $obj
4873                   if $val =~ /^\@.*\@$/;
4874                 $obj =~ s/\$\(EXEEXT\)$//o;
4876                 if ($val =~ /(\$\((top_)?srcdir\))\//o)
4877                   {
4878                     msg ('error', $subvar->rdef ($cond)->location,
4879                          "using '$1' in TESTS is currently broken: '$val'");
4880                   }
4882                 foreach my $test_suffix (@test_suffixes)
4883                   {
4884                     next
4885                       if $test_suffix eq $at_exeext || $test_suffix eq '';
4886                     return substr ($obj, 0, length ($obj) - length ($test_suffix)) . '.log'
4887                       if substr ($obj, - length ($test_suffix)) eq $test_suffix;
4888                   }
4889                 my $base = $obj;
4890                 $obj .= '.log';
4891                 handle_per_suffix_test ('',
4892                                         OBJ => $obj,
4893                                         BASE => $base,
4894                                         SOURCE => $val);
4895                 return $obj;
4896               });
4898           my $nhelper=1;
4899           my $prev = 'TESTS';
4900           my $post = '';
4901           my $last_suffix = $test_suffixes[$#test_suffixes];
4902           my $cur = '';
4903           foreach my $test_suffix (@test_suffixes)
4904             {
4905               if ($test_suffix eq $last_suffix)
4906                 {
4907                   $cur = 'TEST_LOGS';
4908                 }
4909               else
4910                 {
4911                   $cur = 'am__test_logs' . $nhelper;
4912                 }
4913               define_variable ($cur,
4914                 '$(' . $prev . ':' . $test_suffix . $post . '=.log)', INTERNAL);
4915               $post = '.log';
4916               $prev = $cur;
4917               $nhelper++;
4918               if ($test_suffix ne $at_exeext && $test_suffix ne '')
4919                 {
4920                   handle_per_suffix_test ($test_suffix,
4921                                           OBJ => '',
4922                                           BASE => '$*',
4923                                           SOURCE => '$<');
4924                 }
4925             }
4926           $clean_files{'$(TEST_LOGS)'} = MOSTLY_CLEAN;
4927           $clean_files{'$(TEST_LOGS:.log=.trs)'} = MOSTLY_CLEAN;
4928           $clean_files{'$(TEST_SUITE_LOG)'} = MOSTLY_CLEAN;
4929         }
4930     }
4933 # Handle Emacs Lisp.
4934 sub handle_emacs_lisp
4936   my @elfiles = &am_install_var ('-candist', 'lisp', 'LISP',
4937                                  'lisp', 'noinst');
4939   return if ! @elfiles;
4941   define_pretty_variable ('am__ELFILES', TRUE, INTERNAL,
4942                           map { $_->[1] } @elfiles);
4943   define_pretty_variable ('am__ELCFILES', TRUE, INTERNAL,
4944                           '$(am__ELFILES:.el=.elc)');
4945   # This one can be overridden by users.
4946   define_pretty_variable ('ELCFILES', TRUE, INTERNAL, '$(LISP:.el=.elc)');
4948   push @all, '$(ELCFILES)';
4950   require_variables ($elfiles[0][0], "Emacs Lisp sources seen", TRUE,
4951                      'EMACS', 'lispdir');
4954 # Handle Python
4955 sub handle_python
4957   my @pyfiles = &am_install_var ('-defaultdist', 'python', 'PYTHON',
4958                                  'noinst');
4959   return if ! @pyfiles;
4961   require_variables ($pyfiles[0][0], "Python sources seen", TRUE, 'PYTHON');
4962   require_conf_file ($pyfiles[0][0], FOREIGN, 'py-compile');
4963   &define_variable ('py_compile', "$am_config_aux_dir/py-compile", INTERNAL);
4966 # Handle Java.
4967 sub handle_java
4969     my @sourcelist = &am_install_var ('-candist',
4970                                       'java', 'JAVA',
4971                                       'noinst', 'check');
4972     return if ! @sourcelist;
4974     my @prefixes = am_primary_prefixes ('JAVA', 1,
4975                                         'noinst', 'check');
4977     my $dir;
4978     my @java_sources = ();
4979     foreach my $prefix (@prefixes)
4980       {
4981         (my $curs = $prefix) =~ s/^(?:nobase_)?(?:dist_|nodist_)?//;
4983         next
4984           if $curs eq 'EXTRA';
4986         push @java_sources, '$(' . $prefix . '_JAVA' . ')';
4988         if (defined $dir)
4989           {
4990             err_var "${curs}_JAVA", "multiple _JAVA primaries in use"
4991              unless $curs eq $dir;
4992           }
4994         $dir = $curs;
4995       }
4997     define_pretty_variable ('am__java_sources', TRUE, INTERNAL,
4998                             "@java_sources");
5000     if ($dir eq 'check')
5001       {
5002         push (@check, "class$dir.stamp");
5003       }
5004     else
5005       {
5006         push (@all, "class$dir.stamp");
5007       }
5011 # Handle some of the minor options.
5012 sub handle_minor_options
5014   if (option 'readme-alpha')
5015     {
5016       if ($relative_dir eq '.')
5017         {
5018           if ($package_version !~ /^$GNITS_VERSION_PATTERN$/)
5019             {
5020               msg ('error-gnits', $package_version_location,
5021                    "version '$package_version' doesn't follow " .
5022                    "Gnits standards");
5023             }
5024           if (defined $1 && -f 'README-alpha')
5025             {
5026               # This means we have an alpha release.  See
5027               # GNITS_VERSION_PATTERN for details.
5028               push_dist_common ('README-alpha');
5029             }
5030         }
5031     }
5034 ################################################################
5036 # ($OUTPUT, @INPUTS)
5037 # &split_config_file_spec ($SPEC)
5038 # -------------------------------
5039 # Decode the Autoconf syntax for config files (files, headers, links
5040 # etc.).
5041 sub split_config_file_spec ($)
5043   my ($spec) = @_;
5044   my ($output, @inputs) = split (/:/, $spec);
5046   push @inputs, "$output.in"
5047     unless @inputs;
5049   return ($output, @inputs);
5052 # $input
5053 # locate_am (@POSSIBLE_SOURCES)
5054 # -----------------------------
5055 # AC_CONFIG_FILES allow specifications such as Makefile:top.in:mid.in:bot.in
5056 # This functions returns the first *.in file for which a *.am exists.
5057 # It returns undef otherwise.
5058 sub locate_am (@)
5060   my (@rest) = @_;
5061   my $input;
5062   foreach my $file (@rest)
5063     {
5064       if (($file =~ /^(.*)\.in$/) && -f "$1.am")
5065         {
5066           $input = $file;
5067           last;
5068         }
5069     }
5070   return $input;
5073 my %make_list;
5075 # &scan_autoconf_config_files ($WHERE, $CONFIG-FILES)
5076 # ---------------------------------------------------
5077 # Study $CONFIG-FILES which is the first argument to AC_CONFIG_FILES
5078 # (or AC_OUTPUT).
5079 sub scan_autoconf_config_files ($$)
5081   my ($where, $config_files) = @_;
5083   # Look at potential Makefile.am's.
5084   foreach (split ' ', $config_files)
5085     {
5086       # Must skip empty string for Perl 4.
5087       next if $_ eq "\\" || $_ eq '';
5089       # Handle $local:$input syntax.
5090       my ($local, @rest) = split (/:/);
5091       @rest = ("$local.in",) unless @rest;
5092       # Keep in sync with 'conffile-leading-dot.test'.
5093       msg ('unsupported', $where,
5094            "omit leading './' from config file names such as '$local';"
5095            . "\nremake rules might be subtly broken otherwise")
5096         if ($local =~ /^\.\//);
5097       my $input = locate_am @rest;
5098       if ($input)
5099         {
5100           # We have a file that automake should generate.
5101           $make_list{$input} = join (':', ($local, @rest));
5102         }
5103       else
5104         {
5105           # We have a file that automake should cause to be
5106           # rebuilt, but shouldn't generate itself.
5107           push (@other_input_files, $_);
5108         }
5109       $ac_config_files_location{$local} = $where;
5110       $ac_config_files_condition{$local} =
5111         new Automake::Condition (@cond_stack)
5112           if (@cond_stack);
5113     }
5117 # &scan_autoconf_traces ($FILENAME)
5118 # ---------------------------------
5119 sub scan_autoconf_traces ($)
5121   my ($filename) = @_;
5123   # Macros to trace, with their minimal number of arguments.
5124   #
5125   # IMPORTANT: If you add a macro here, you should also add this macro
5126   # =========  to Automake-preselection in autoconf/lib/autom4te.in.
5127   my %traced = (
5128                 AC_CANONICAL_BUILD => 0,
5129                 AC_CANONICAL_HOST => 0,
5130                 AC_CANONICAL_TARGET => 0,
5131                 AC_CONFIG_AUX_DIR => 1,
5132                 AC_CONFIG_FILES => 1,
5133                 AC_CONFIG_HEADERS => 1,
5134                 AC_CONFIG_LIBOBJ_DIR => 1,
5135                 AC_CONFIG_LINKS => 1,
5136                 AC_FC_SRCEXT => 1,
5137                 AC_INIT => 0,
5138                 AC_LIBSOURCE => 1,
5139                 AC_REQUIRE_AUX_FILE => 1,
5140                 AC_SUBST_TRACE => 1,
5141                 AM_AUTOMAKE_VERSION => 1,
5142                 AM_PROG_MKDIR_P => 0, # FIXME: to be removed in 1.14
5143                 AM_CONDITIONAL => 2,
5144                 AM_EXTRA_RECURSIVE_TARGETS => 1,
5145                 AM_GNU_GETTEXT => 0,
5146                 AM_GNU_GETTEXT_INTL_SUBDIR => 0,
5147                 AM_INIT_AUTOMAKE => 0,
5148                 AM_MAINTAINER_MODE => 0,
5149                 AM_PROG_AR => 0,
5150                 AM_PROG_CC_C_O => 0,
5151                 _AM_SUBST_NOTMAKE => 1,
5152                 _AM_COND_IF => 1,
5153                 _AM_COND_ELSE => 1,
5154                 _AM_COND_ENDIF => 1,
5155                 LT_SUPPORTED_TAG => 1,
5156                 _LT_AC_TAGCONFIG => 0,
5157                 m4_include => 1,
5158                 m4_sinclude => 1,
5159                 sinclude => 1,
5160               );
5162   my $traces = ($ENV{AUTOCONF} || '@am_AUTOCONF@') . " ";
5164   # Use a separator unlikely to be used, not ':', the default, which
5165   # has a precise meaning for AC_CONFIG_FILES and so on.
5166   $traces .= join (' ',
5167                    map { "--trace=$_" . ':\$f:\$l::\$d::\$n::\${::}%' }
5168                    (keys %traced));
5170   my $tracefh = new Automake::XFile ("$traces $filename |");
5171   verb "reading $traces";
5173   @cond_stack = ();
5174   my $where;
5176   while ($_ = $tracefh->getline)
5177     {
5178       chomp;
5179       my ($here, $depth, @args) = split (/::/);
5180       $where = new Automake::Location $here;
5181       my $macro = $args[0];
5183       prog_error ("unrequested trace '$macro'")
5184         unless exists $traced{$macro};
5186       # Skip and diagnose malformed calls.
5187       if ($#args < $traced{$macro})
5188         {
5189           msg ('syntax', $where, "not enough arguments for $macro");
5190           next;
5191         }
5193       # Alphabetical ordering please.
5194       if ($macro eq 'AC_CANONICAL_BUILD')
5195         {
5196           if ($seen_canonical <= AC_CANONICAL_BUILD)
5197             {
5198               $seen_canonical = AC_CANONICAL_BUILD;
5199             }
5200         }
5201       elsif ($macro eq 'AC_CANONICAL_HOST')
5202         {
5203           if ($seen_canonical <= AC_CANONICAL_HOST)
5204             {
5205               $seen_canonical = AC_CANONICAL_HOST;
5206             }
5207         }
5208       elsif ($macro eq 'AC_CANONICAL_TARGET')
5209         {
5210           $seen_canonical = AC_CANONICAL_TARGET;
5211         }
5212       elsif ($macro eq 'AC_CONFIG_AUX_DIR')
5213         {
5214           if ($seen_init_automake)
5215             {
5216               error ($where, "AC_CONFIG_AUX_DIR must be called before "
5217                      . "AM_INIT_AUTOMAKE ...", partial => 1);
5218               error ($seen_init_automake, "... AM_INIT_AUTOMAKE called here");
5219             }
5220           $config_aux_dir = $args[1];
5221           $config_aux_dir_set_in_configure_ac = 1;
5222           check_directory ($config_aux_dir, $where);
5223         }
5224       elsif ($macro eq 'AC_CONFIG_FILES')
5225         {
5226           # Look at potential Makefile.am's.
5227           scan_autoconf_config_files ($where, $args[1]);
5228         }
5229       elsif ($macro eq 'AC_CONFIG_HEADERS')
5230         {
5231           foreach my $spec (split (' ', $args[1]))
5232             {
5233               my ($dest, @src) = split (':', $spec);
5234               $ac_config_files_location{$dest} = $where;
5235               push @config_headers, $spec;
5236             }
5237         }
5238       elsif ($macro eq 'AC_CONFIG_LIBOBJ_DIR')
5239         {
5240           $config_libobj_dir = $args[1];
5241           check_directory ($config_libobj_dir, $where);
5242         }
5243       elsif ($macro eq 'AC_CONFIG_LINKS')
5244         {
5245           foreach my $spec (split (' ', $args[1]))
5246             {
5247               my ($dest, $src) = split (':', $spec);
5248               $ac_config_files_location{$dest} = $where;
5249               push @config_links, $spec;
5250             }
5251         }
5252       elsif ($macro eq 'AC_FC_SRCEXT')
5253         {
5254           my $suffix = $args[1];
5255           # These flags are used as %SOURCEFLAG% in depend2.am,
5256           # where the trailing space is important.
5257           $sourceflags{'.' . $suffix} = '$(FCFLAGS_' . $suffix . ') '
5258             if ($suffix eq 'f90' || $suffix eq 'f95' || $suffix eq 'f03' || $suffix eq 'f08');
5259         }
5260       elsif ($macro eq 'AC_INIT')
5261         {
5262           if (defined $args[2])
5263             {
5264               $package_version = $args[2];
5265               $package_version_location = $where;
5266             }
5267         }
5268       elsif ($macro eq 'AC_LIBSOURCE')
5269         {
5270           $libsources{$args[1]} = $here;
5271         }
5272       elsif ($macro eq 'AC_REQUIRE_AUX_FILE')
5273         {
5274           # Only remember the first time a file is required.
5275           $required_aux_file{$args[1]} = $where
5276             unless exists $required_aux_file{$args[1]};
5277         }
5278       elsif ($macro eq 'AC_SUBST_TRACE')
5279         {
5280           # Just check for alphanumeric in AC_SUBST_TRACE.  If you do
5281           # AC_SUBST(5), then too bad.
5282           $configure_vars{$args[1]} = $where
5283             if $args[1] =~ /^\w+$/;
5284         }
5285       elsif ($macro eq 'AM_AUTOMAKE_VERSION')
5286         {
5287           error ($where,
5288                  "version mismatch.  This is Automake $VERSION,\n" .
5289                  "but the definition used by this AM_INIT_AUTOMAKE\n" .
5290                  "comes from Automake $args[1].  You should recreate\n" .
5291                  "aclocal.m4 with aclocal and run automake again.\n",
5292                  # $? = 63 is used to indicate version mismatch to missing.
5293                  exit_code => 63)
5294             if $VERSION ne $args[1];
5296           $seen_automake_version = 1;
5297         }
5298       elsif ($macro eq 'AM_PROG_MKDIR_P') # FIXME: to be removed in 1.14
5299         {
5300           msg 'obsolete', $where, <<'EOF';
5301 The 'AM_PROG_MKDIR_P' macro is deprecated, and will soon be removed.
5302 You should use the Autoconf-provided 'AC_PROG_MKDIR_P' macro instead,
5303 and use '$(MKDIR_P)' instead of '$(mkdir_p)'in your Makefile.am files.
5305         }
5306       elsif ($macro eq 'AM_CONDITIONAL')
5307         {
5308           $configure_cond{$args[1]} = $where;
5309         }
5310       elsif ($macro eq 'AM_EXTRA_RECURSIVE_TARGETS')
5311         {
5312           # Empty leading/trailing fields might be produced by split,
5313           # hence the grep is really needed.
5314           push @extra_recursive_targets,
5315                grep (/./, (split /\s+/, $args[1]));
5316         }
5317       elsif ($macro eq 'AM_GNU_GETTEXT')
5318         {
5319           $seen_gettext = $where;
5320           $ac_gettext_location = $where;
5321           $seen_gettext_external = grep ($_ eq 'external', @args);
5322         }
5323       elsif ($macro eq 'AM_GNU_GETTEXT_INTL_SUBDIR')
5324         {
5325           $seen_gettext_intl = $where;
5326         }
5327       elsif ($macro eq 'AM_INIT_AUTOMAKE')
5328         {
5329           $seen_init_automake = $where;
5330           if (defined $args[2])
5331             {
5332               msg 'obsolete', $where, <<'EOF';
5333 AM_INIT_AUTOMAKE: two- and three-arguments forms are deprecated.  For more info, see:
5334 http://www.gnu.org/software/automake/manual/automake.html#Modernize-AM_INIT_AUTOMAKE-invocation
5336               $package_version = $args[2];
5337               $package_version_location = $where;
5338             }
5339           elsif (defined $args[1])
5340             {
5341               my @opts = split (' ', $args[1]);
5342               @opts = map { { option => $_, where => $where } } @opts;
5343               exit $exit_code if process_global_option_list (@opts);
5344             }
5345         }
5346       elsif ($macro eq 'AM_MAINTAINER_MODE')
5347         {
5348           $seen_maint_mode = $where;
5349         }
5350       elsif ($macro eq 'AM_PROG_AR')
5351         {
5352           $seen_ar = $where;
5353         }
5354       elsif ($macro eq 'AM_PROG_CC_C_O')
5355         {
5356           $seen_cc_c_o = $where;
5357         }
5358       elsif ($macro eq '_AM_COND_IF')
5359         {
5360           cond_stack_if ('', $args[1], $where);
5361           error ($where, "missing m4 quoting, macro depth $depth")
5362             if ($depth != 1);
5363         }
5364       elsif ($macro eq '_AM_COND_ELSE')
5365         {
5366           cond_stack_else ('!', $args[1], $where);
5367           error ($where, "missing m4 quoting, macro depth $depth")
5368             if ($depth != 1);
5369         }
5370       elsif ($macro eq '_AM_COND_ENDIF')
5371         {
5372           cond_stack_endif (undef, undef, $where);
5373           error ($where, "missing m4 quoting, macro depth $depth")
5374             if ($depth != 1);
5375         }
5376       elsif ($macro eq '_AM_SUBST_NOTMAKE')
5377         {
5378           $ignored_configure_vars{$args[1]} = $where;
5379         }
5380       elsif ($macro eq 'm4_include'
5381              || $macro eq 'm4_sinclude'
5382              || $macro eq 'sinclude')
5383         {
5384           # Skip missing 'sinclude'd files.
5385           next if $macro ne 'm4_include' && ! -f $args[1];
5387           # Some modified versions of Autoconf don't use
5388           # frozen files.  Consequently it's possible that we see all
5389           # m4_include's performed during Autoconf's startup.
5390           # Obviously we don't want to distribute Autoconf's files
5391           # so we skip absolute filenames here.
5392           push @configure_deps, '$(top_srcdir)/' . $args[1]
5393             unless $here =~ m,^(?:\w:)?[\\/],;
5394           # Keep track of the greatest timestamp.
5395           if (-e $args[1])
5396             {
5397               my $mtime = mtime $args[1];
5398               $configure_deps_greatest_timestamp = $mtime
5399                 if $mtime > $configure_deps_greatest_timestamp;
5400             }
5401         }
5402       elsif ($macro eq 'LT_SUPPORTED_TAG')
5403         {
5404           $libtool_tags{$args[1]} = 1;
5405           $libtool_new_api = 1;
5406         }
5407       elsif ($macro eq '_LT_AC_TAGCONFIG')
5408         {
5409           # _LT_AC_TAGCONFIG is an old macro present in Libtool 1.5.
5410           # We use it to detect whether tags are supported.  Our
5411           # preferred interface is LT_SUPPORTED_TAG, but it was
5412           # introduced in Libtool 1.6.
5413           if (0 == keys %libtool_tags)
5414             {
5415               # Hardcode the tags supported by Libtool 1.5.
5416               %libtool_tags = (CC => 1, CXX => 1, GCJ => 1, F77 => 1);
5417             }
5418         }
5419     }
5421   error ($where, "condition stack not properly closed")
5422     if (@cond_stack);
5424   $tracefh->close;
5428 # &scan_autoconf_files ()
5429 # -----------------------
5430 # Check whether we use 'configure.ac' or 'configure.in'.
5431 # Scan it (and possibly 'aclocal.m4') for interesting things.
5432 # We must scan aclocal.m4 because there might be AC_SUBSTs and such there.
5433 sub scan_autoconf_files ()
5435   # Reinitialize libsources here.  This isn't really necessary,
5436   # since we currently assume there is only one configure.ac.  But
5437   # that won't always be the case.
5438   %libsources = ();
5440   # Keep track of the youngest configure dependency.
5441   $configure_deps_greatest_timestamp = mtime $configure_ac;
5442   if (-e 'aclocal.m4')
5443     {
5444       my $mtime = mtime 'aclocal.m4';
5445       $configure_deps_greatest_timestamp = $mtime
5446         if $mtime > $configure_deps_greatest_timestamp;
5447     }
5449   scan_autoconf_traces ($configure_ac);
5451   @configure_input_files = sort keys %make_list;
5452   # Set input and output files if not specified by user.
5453   if (! @input_files)
5454     {
5455       @input_files = @configure_input_files;
5456       %output_files = %make_list;
5457     }
5460   if (! $seen_init_automake)
5461     {
5462       err_ac ("no proper invocation of AM_INIT_AUTOMAKE was found.\nYou "
5463               . "should verify that $configure_ac invokes AM_INIT_AUTOMAKE,"
5464               . "\nthat aclocal.m4 is present in the top-level directory,\n"
5465               . "and that aclocal.m4 was recently regenerated "
5466               . "(using aclocal)");
5467     }
5468   else
5469     {
5470       if (! $seen_automake_version)
5471         {
5472           if (-f 'aclocal.m4')
5473             {
5474               error ($seen_init_automake,
5475                      "your implementation of AM_INIT_AUTOMAKE comes from " .
5476                      "an\nold Automake version.  You should recreate " .
5477                      "aclocal.m4\nwith aclocal and run automake again",
5478                      # $? = 63 is used to indicate version mismatch to missing.
5479                      exit_code => 63);
5480             }
5481           else
5482             {
5483               error ($seen_init_automake,
5484                      "no proper implementation of AM_INIT_AUTOMAKE was " .
5485                      "found,\nprobably because aclocal.m4 is missing.\n" .
5486                      "You should run aclocal to create this file, then\n" .
5487                      "run automake again");
5488             }
5489         }
5490     }
5492   locate_aux_dir ();
5494   # Look for some files we need.  Always check for these.  This
5495   # check must be done for every run, even those where we are only
5496   # looking at a subdir Makefile.  We must set relative_dir for
5497   # push_required_file to work.
5498   # Sort the files for stable verbose output.
5499   $relative_dir = '.';
5500   foreach my $file (sort keys %required_aux_file)
5501     {
5502       require_conf_file ($required_aux_file{$file}->get, FOREIGN, $file)
5503     }
5504   err_am "'install.sh' is an anachronism; use 'install-sh' instead"
5505     if -f $config_aux_dir . '/install.sh';
5507   # Preserve dist_common for later.
5508   $configure_dist_common = variable_value ('DIST_COMMON') || '';
5512 ################################################################
5514 # Do any extra checking for GNU standards.
5515 sub check_gnu_standards
5517   if ($relative_dir eq '.')
5518     {
5519       # In top level (or only) directory.
5520       require_file ("$am_file.am", GNU,
5521                     qw/INSTALL NEWS README AUTHORS ChangeLog/);
5523       # Accept one of these three licenses; default to COPYING.
5524       # Make sure we do not overwrite an existing license.
5525       my $license;
5526       foreach (qw /COPYING COPYING.LIB COPYING.LESSER/)
5527         {
5528           if (-f $_)
5529             {
5530               $license = $_;
5531               last;
5532             }
5533         }
5534       require_file ("$am_file.am", GNU, 'COPYING')
5535         unless $license;
5536     }
5538   for my $opt ('no-installman', 'no-installinfo')
5539     {
5540       msg ('error-gnu', option $opt,
5541            "option '$opt' disallowed by GNU standards")
5542         if option $opt;
5543     }
5546 # Do any extra checking for GNITS standards.
5547 sub check_gnits_standards
5549   if ($relative_dir eq '.')
5550     {
5551       # In top level (or only) directory.
5552       require_file ("$am_file.am", GNITS, 'THANKS');
5553     }
5556 ################################################################
5558 # Functions to handle files of each language.
5560 # Each 'lang_X_rewrite($DIRECTORY, $BASE, $EXT)' function follows a
5561 # simple formula: Return value is LANG_SUBDIR if the resulting object
5562 # file should be in a subdir if the source file is, LANG_PROCESS if
5563 # file is to be dealt with, LANG_IGNORE otherwise.
5565 # Much of the actual processing is handled in
5566 # handle_single_transform.  These functions exist so that
5567 # auxiliary information can be recorded for a later cleanup pass.
5568 # Note that the calls to these functions are computed, so don't bother
5569 # searching for their precise names in the source.
5571 # This is just a convenience function that can be used to determine
5572 # when a subdir object should be used.
5573 sub lang_sub_obj
5575     return option 'subdir-objects' ? LANG_SUBDIR : LANG_PROCESS;
5578 # Rewrite a single C source file.
5579 sub lang_c_rewrite
5581   my ($directory, $base, $ext, $obj, $have_per_exec_flags, $var) = @_;
5583   my $r = LANG_PROCESS;
5584   if (option 'subdir-objects')
5585     {
5586       $r = LANG_SUBDIR;
5587       if ($directory && $directory ne '.')
5588         {
5589           $base = $directory . '/' . $base;
5591           # libtool is always able to put the object at the proper place,
5592           # so we do not have to require AM_PROG_CC_C_O when building .lo files.
5593           msg_var ('portability', $var,
5594                    "compiling '$base.c' in subdir requires "
5595                    . "'AM_PROG_CC_C_O' in '$configure_ac'",
5596                    uniq_scope => US_GLOBAL,
5597                    uniq_part => 'AM_PROG_CC_C_O subdir')
5598             unless $seen_cc_c_o || $obj eq '.lo';
5599         }
5600     }
5602   if (! $seen_cc_c_o
5603       && $have_per_exec_flags
5604       && ! option 'subdir-objects'
5605       && $obj ne '.lo')
5606     {
5607       msg_var ('portability',
5608                $var, "compiling '$base.c' with per-target flags requires "
5609                . "'AM_PROG_CC_C_O' in '$configure_ac'",
5610                uniq_scope => US_GLOBAL,
5611                uniq_part => 'AM_PROG_CC_C_O per-target')
5612     }
5614     return $r;
5617 # Rewrite a single header file.
5618 sub lang_header_rewrite
5620     # Header files are simply ignored.
5621     return LANG_IGNORE;
5624 # Rewrite a single Vala source file.
5625 sub lang_vala_rewrite
5627     my ($directory, $base, $ext) = @_;
5629     (my $newext = $ext) =~ s/vala$/c/;
5630     return (LANG_SUBDIR, $newext);
5633 # Rewrite a single yacc/yacc++ file.
5634 sub lang_yacc_rewrite
5636     my ($directory, $base, $ext) = @_;
5638     my $r = &lang_sub_obj;
5639     (my $newext = $ext) =~ tr/y/c/;
5640     return ($r, $newext);
5642 sub lang_yaccxx_rewrite { lang_yacc_rewrite (@_); };
5644 # Rewrite a single lex/lex++ file.
5645 sub lang_lex_rewrite
5647     my ($directory, $base, $ext) = @_;
5649     my $r = &lang_sub_obj;
5650     (my $newext = $ext) =~ tr/l/c/;
5651     return ($r, $newext);
5653 sub lang_lexxx_rewrite { lang_lex_rewrite (@_); };
5655 # Rewrite a single Java file.
5656 sub lang_java_rewrite
5658     return LANG_SUBDIR;
5661 # The lang_X_finish functions are called after all source file
5662 # processing is done.  Each should handle defining rules for the
5663 # language, etc.  A finish function is only called if a source file of
5664 # the appropriate type has been seen.
5666 sub lang_vala_finish_target ($$)
5668   my ($self, $name) = @_;
5670   my $derived = canonicalize ($name);
5671   my $var = var "${derived}_SOURCES";
5672   return unless $var;
5674   my @vala_sources = grep { /\.(vala|vapi)$/ } ($var->value_as_list_recursive);
5676   # For automake bug#11229.
5677   return unless @vala_sources;
5679   foreach my $vala_file (@vala_sources)
5680     {
5681       my $c_file = $vala_file;
5682       if ($c_file =~ s/(.*)\.vala$/$1.c/)
5683         {
5684           $c_file = "\$(srcdir)/$c_file";
5685           $output_rules .= "$c_file: \$(srcdir)/${derived}_vala.stamp\n"
5686             . "\t\@if test -f \$@; then :; else rm -f \$(srcdir)/${derived}_vala.stamp; fi\n"
5687             . "\t\@if test -f \$@; then :; else \\\n"
5688             . "\t  \$(MAKE) \$(AM_MAKEFLAGS) \$(srcdir)/${derived}_vala.stamp; \\\n"
5689             . "\tfi\n";
5690           $clean_files{$c_file} = MAINTAINER_CLEAN;
5691         }
5692     }
5694   # Add rebuild rules for generated header and vapi files
5695   my $flags = var ($derived . '_VALAFLAGS');
5696   if ($flags)
5697     {
5698       my $lastflag = '';
5699       foreach my $flag ($flags->value_as_list_recursive)
5700         {
5701           if (grep (/$lastflag/, ('-H', '-h', '--header', '--internal-header',
5702                                   '--vapi', '--internal-vapi', '--gir')))
5703             {
5704               my $headerfile = "\$(srcdir)/$flag";
5705               $output_rules .= "$headerfile: \$(srcdir)/${derived}_vala.stamp\n"
5706                 . "\t\@if test -f \$@; then :; else rm -f \$(srcdir)/${derived}_vala.stamp; fi\n"
5707                 . "\t\@if test -f \$@; then :; else \\\n"
5708                 . "\t  \$(MAKE) \$(AM_MAKEFLAGS) \$(srcdir)/${derived}_vala.stamp; \\\n"
5709                 . "\tfi\n";
5711               # valac is not used when building from dist tarballs
5712               # distribute the generated files
5713               push_dist_common ($headerfile);
5714               $clean_files{$headerfile} = MAINTAINER_CLEAN;
5715             }
5716           $lastflag = $flag;
5717         }
5718     }
5720   my $compile = $self->compile;
5722   # Rewrite each occurrence of 'AM_VALAFLAGS' in the compile
5723   # rule into '${derived}_VALAFLAGS' if it exists.
5724   my $val = "${derived}_VALAFLAGS";
5725   $compile =~ s/\(AM_VALAFLAGS\)/\($val\)/
5726     if set_seen ($val);
5728   # VALAFLAGS is a user variable (per GNU Standards),
5729   # it should not be overridden in the Makefile...
5730   check_user_variables 'VALAFLAGS';
5732   my $dirname = dirname ($name);
5734   # Only generate C code, do not run C compiler
5735   $compile .= " -C";
5737   my $verbose = verbose_flag ('VALAC');
5738   my $silent = silent_flag ();
5739   my $stampfile = "\$(srcdir)/${derived}_vala.stamp";
5741   $output_rules .=
5742     "\$(srcdir)/${derived}_vala.stamp: @vala_sources\n".
5743 # Since the C files generated from the vala sources depend on the
5744 # ${derived}_vala.stamp file, we must ensure its timestamp is older than
5745 # those of the C files generated by the valac invocation below (this is
5746 # especially important on systems with sub-second timestamp resolution).
5747 # Thus we need to create the stamp file *before* invoking valac, and to
5748 # move it to its final location only after valac has been invoked.
5749     "\t${silent}rm -f \$\@ && echo stamp > \$\@-t\n".
5750     "\t${verbose}\$(am__cd) \$(srcdir) && $compile @vala_sources\n".
5751     "\t${silent}mv -f \$\@-t \$\@\n";
5753   push_dist_common ($stampfile);
5755   $clean_files{$stampfile} = MAINTAINER_CLEAN;
5758 # Add output rules to invoke valac and create stamp file as a witness
5759 # to handle multiple outputs. This function is called after all source
5760 # file processing is done.
5761 sub lang_vala_finish
5763   my ($self) = @_;
5765   foreach my $prog (keys %known_programs)
5766     {
5767       lang_vala_finish_target ($self, $prog);
5768     }
5770   while (my ($name) = each %known_libraries)
5771     {
5772       lang_vala_finish_target ($self, $name);
5773     }
5776 # The built .c files should be cleaned only on maintainer-clean
5777 # as the .c files are distributed. This function is called for each
5778 # .vala source file.
5779 sub lang_vala_target_hook
5781   my ($self, $aggregate, $output, $input, %transform) = @_;
5783   $clean_files{$output} = MAINTAINER_CLEAN;
5786 # This is a yacc helper which is called whenever we have decided to
5787 # compile a yacc file.
5788 sub lang_yacc_target_hook
5790     my ($self, $aggregate, $output, $input, %transform) = @_;
5792     # If some relevant *YFLAGS variable contains the '-d' flag, we'll
5793     # have to to generate special code.
5794     my $yflags_contains_minus_d = 0;
5796     foreach my $pfx ("", "${aggregate}_")
5797       {
5798         my $yflagsvar = var ("${pfx}YFLAGS");
5799         next unless $yflagsvar;
5800         # We cannot work reliably with conditionally-defined YFLAGS.
5801         if ($yflagsvar->has_conditional_contents)
5802           {
5803             msg_var ('unsupported', $yflagsvar,
5804                      "'${pfx}YFLAGS' cannot have conditional contents");
5805           }
5806         else
5807           {
5808             $yflags_contains_minus_d = 1
5809               if grep (/^-d$/, $yflagsvar->value_as_list_recursive);
5810           }
5811       }
5813     if ($yflags_contains_minus_d)
5814       {
5815         # Found a '-d' that applies to the compilation of this file.
5816         # Add a dependency for the generated header file, and arrange
5817         # for that file to be included in the distribution.
5819         # The extension of the output file (e.g., '.c' or '.cxx').
5820         # We'll need it to compute the name of the generated header file.
5821         (my $output_ext = basename ($output)) =~ s/.*(\.[^.]+)$/$1/;
5823         # We know that a yacc input should be turned into either a C or
5824         # C++ output file.  We depend on this fact (here and in yacc.am),
5825         # so check that it really holds.
5826         my $lang = $languages{$extension_map{$output_ext}};
5827         prog_error "invalid output name '$output' for yacc file '$input'"
5828           if (!$lang || ($lang->name ne 'c' && $lang->name ne 'cxx'));
5830         (my $header_ext = $output_ext) =~ s/c/h/g;
5831         # Quote $output_ext in the regexp, so that dots in it are taken
5832         # as literal dots, not as metacharacters.
5833         (my $header = $output) =~ s/\Q$output_ext\E$/$header_ext/;
5835         foreach my $cond (Automake::Rule::define (${header}, 'internal',
5836                                                   RULE_AUTOMAKE, TRUE,
5837                                                   INTERNAL))
5838           {
5839             my $condstr = $cond->subst_string;
5840             $output_rules .=
5841               "$condstr${header}: $output\n"
5842               # Recover from removal of $header
5843               . "$condstr\t\@if test ! -f \$@; then rm -f $output; else :; fi\n"
5844               . "$condstr\t\@if test ! -f \$@; then \$(MAKE) \$(AM_MAKEFLAGS) $output; else :; fi\n";
5845           }
5846         # Distribute the generated file, unless its .y source was
5847         # listed in a nodist_ variable.  (&handle_source_transform
5848         # will set DIST_SOURCE.)
5849         &push_dist_common ($header)
5850           if $transform{'DIST_SOURCE'};
5852         # The GNU rules say that yacc/lex output files should be removed
5853         # by maintainer-clean.  However, if the files are not distributed,
5854         # then we want to remove them with "make clean"; otherwise,
5855         # "make distcheck" will fail.
5856         $clean_files{$header} = $transform{'DIST_SOURCE'} ? MAINTAINER_CLEAN : CLEAN;
5857       }
5858     # See the comment above for $HEADER.
5859     $clean_files{$output} = $transform{'DIST_SOURCE'} ? MAINTAINER_CLEAN : CLEAN;
5862 # This is a lex helper which is called whenever we have decided to
5863 # compile a lex file.
5864 sub lang_lex_target_hook
5866     my ($self, $aggregate, $output, $input, %transform) = @_;
5867     # The GNU rules say that yacc/lex output files should be removed
5868     # by maintainer-clean.  However, if the files are not distributed,
5869     # then we want to remove them with "make clean"; otherwise,
5870     # "make distcheck" will fail.
5871     $clean_files{$output} = $transform{'DIST_SOURCE'} ? MAINTAINER_CLEAN : CLEAN;
5874 # This is a helper for both lex and yacc.
5875 sub yacc_lex_finish_helper
5877   return if defined $language_scratch{'lex-yacc-done'};
5878   $language_scratch{'lex-yacc-done'} = 1;
5880   # FIXME: for now, no line number.
5881   require_conf_file ($configure_ac, FOREIGN, 'ylwrap');
5882   &define_variable ('YLWRAP', "$am_config_aux_dir/ylwrap", INTERNAL);
5885 sub lang_yacc_finish
5887   return if defined $language_scratch{'yacc-done'};
5888   $language_scratch{'yacc-done'} = 1;
5890   reject_var 'YACCFLAGS', "'YACCFLAGS' obsolete; use 'YFLAGS' instead";
5892   yacc_lex_finish_helper;
5896 sub lang_lex_finish
5898   return if defined $language_scratch{'lex-done'};
5899   $language_scratch{'lex-done'} = 1;
5901   yacc_lex_finish_helper;
5905 # Given a hash table of linker names, pick the name that has the most
5906 # precedence.  This is lame, but something has to have global
5907 # knowledge in order to eliminate the conflict.  Add more linkers as
5908 # required.
5909 sub resolve_linker
5911     my (%linkers) = @_;
5913     foreach my $l (qw(GCJLINK OBJCXXLINK CXXLINK F77LINK FCLINK OBJCLINK UPCLINK))
5914     {
5915         return $l if defined $linkers{$l};
5916     }
5917     return 'LINK';
5920 # Called to indicate that an extension was used.
5921 sub saw_extension
5923     my ($ext) = @_;
5924     $extension_seen{$ext} = 1;
5927 # register_language (%ATTRIBUTE)
5928 # ------------------------------
5929 # Register a single language.
5930 # Each %ATTRIBUTE is of the form ATTRIBUTE => VALUE.
5931 sub register_language (%)
5933   my (%option) = @_;
5935   # Set the defaults.
5936   $option{'autodep'} = 'no'
5937     unless defined $option{'autodep'};
5938   $option{'linker'} = ''
5939     unless defined $option{'linker'};
5940   $option{'flags'} = []
5941     unless defined $option{'flags'};
5942   $option{'output_extensions'} = sub { return ( '.$(OBJEXT)', '.lo' ) }
5943     unless defined $option{'output_extensions'};
5944   $option{'nodist_specific'} = 0
5945     unless defined $option{'nodist_specific'};
5947   my $lang = new Language (%option);
5949   # Fill indexes.
5950   $extension_map{$_} = $lang->name foreach @{$lang->extensions};
5951   $languages{$lang->name} = $lang;
5952   my $link = $lang->linker;
5953   if ($link)
5954     {
5955       if (exists $link_languages{$link})
5956         {
5957           prog_error ("'$link' has different definitions in "
5958                       . $lang->name . " and " . $link_languages{$link}->name)
5959             if $lang->link ne $link_languages{$link}->link;
5960         }
5961       else
5962         {
5963           $link_languages{$link} = $lang;
5964         }
5965     }
5967   # Update the pattern of known extensions.
5968   accept_extensions (@{$lang->extensions});
5970   # Upate the $suffix_rule map.
5971   foreach my $suffix (@{$lang->extensions})
5972     {
5973       foreach my $dest (&{$lang->output_extensions} ($suffix))
5974         {
5975           register_suffix_rule (INTERNAL, $suffix, $dest);
5976         }
5977     }
5980 # derive_suffix ($EXT, $OBJ)
5981 # --------------------------
5982 # This function is used to find a path from a user-specified suffix $EXT
5983 # to $OBJ or to some other suffix we recognize internally, e.g. 'cc'.
5984 sub derive_suffix ($$)
5986   my ($source_ext, $obj) = @_;
5988   while (! $extension_map{$source_ext}
5989          && $source_ext ne $obj
5990          && exists $suffix_rules->{$source_ext}
5991          && exists $suffix_rules->{$source_ext}{$obj})
5992     {
5993       $source_ext = $suffix_rules->{$source_ext}{$obj}[0];
5994     }
5996   return $source_ext;
6000 ################################################################
6002 # Pretty-print something and append to output_rules.
6003 sub pretty_print_rule
6005     $output_rules .= &makefile_wrap (@_);
6009 ################################################################
6012 ## -------------------------------- ##
6013 ## Handling the conditional stack.  ##
6014 ## -------------------------------- ##
6017 # $STRING
6018 # make_conditional_string ($NEGATE, $COND)
6019 # ----------------------------------------
6020 sub make_conditional_string ($$)
6022   my ($negate, $cond) = @_;
6023   $cond = "${cond}_TRUE"
6024     unless $cond =~ /^TRUE|FALSE$/;
6025   $cond = Automake::Condition::conditional_negate ($cond)
6026     if $negate;
6027   return $cond;
6031 my %_am_macro_for_cond =
6032   (
6033   AMDEP => "one of the compiler tests\n"
6034            . "    AC_PROG_CC, AC_PROG_CXX, AC_PROG_OBJC, AC_PROG_OBJCXX,\n"
6035            . "    AM_PROG_AS, AM_PROG_GCJ, AM_PROG_UPC",
6036   am__fastdepCC => 'AC_PROG_CC',
6037   am__fastdepCCAS => 'AM_PROG_AS',
6038   am__fastdepCXX => 'AC_PROG_CXX',
6039   am__fastdepGCJ => 'AM_PROG_GCJ',
6040   am__fastdepOBJC => 'AC_PROG_OBJC',
6041   am__fastdepOBJCXX => 'AC_PROG_OBJCXX',
6042   am__fastdepUPC => 'AM_PROG_UPC'
6043   );
6045 # $COND
6046 # cond_stack_if ($NEGATE, $COND, $WHERE)
6047 # --------------------------------------
6048 sub cond_stack_if ($$$)
6050   my ($negate, $cond, $where) = @_;
6052   if (! $configure_cond{$cond} && $cond !~ /^TRUE|FALSE$/)
6053     {
6054       my $text = "$cond does not appear in AM_CONDITIONAL";
6055       my $scope = US_LOCAL;
6056       if (exists $_am_macro_for_cond{$cond})
6057         {
6058           my $mac = $_am_macro_for_cond{$cond};
6059           $text .= "\n  The usual way to define '$cond' is to add ";
6060           $text .= ($mac =~ / /) ? $mac : "'$mac'";
6061           $text .= "\n  to '$configure_ac' and run 'aclocal' and 'autoconf' again";
6062           # These warnings appear in Automake files (depend2.am),
6063           # so there is no need to display them more than once:
6064           $scope = US_GLOBAL;
6065         }
6066       error $where, $text, uniq_scope => $scope;
6067     }
6069   push (@cond_stack, make_conditional_string ($negate, $cond));
6071   return new Automake::Condition (@cond_stack);
6075 # $COND
6076 # cond_stack_else ($NEGATE, $COND, $WHERE)
6077 # ----------------------------------------
6078 sub cond_stack_else ($$$)
6080   my ($negate, $cond, $where) = @_;
6082   if (! @cond_stack)
6083     {
6084       error $where, "else without if";
6085       return FALSE;
6086     }
6088   $cond_stack[$#cond_stack] =
6089     Automake::Condition::conditional_negate ($cond_stack[$#cond_stack]);
6091   # If $COND is given, check against it.
6092   if (defined $cond)
6093     {
6094       $cond = make_conditional_string ($negate, $cond);
6096       error ($where, "else reminder ($negate$cond) incompatible with "
6097              . "current conditional: $cond_stack[$#cond_stack]")
6098         if $cond_stack[$#cond_stack] ne $cond;
6099     }
6101   return new Automake::Condition (@cond_stack);
6105 # $COND
6106 # cond_stack_endif ($NEGATE, $COND, $WHERE)
6107 # -----------------------------------------
6108 sub cond_stack_endif ($$$)
6110   my ($negate, $cond, $where) = @_;
6111   my $old_cond;
6113   if (! @cond_stack)
6114     {
6115       error $where, "endif without if";
6116       return TRUE;
6117     }
6119   # If $COND is given, check against it.
6120   if (defined $cond)
6121     {
6122       $cond = make_conditional_string ($negate, $cond);
6124       error ($where, "endif reminder ($negate$cond) incompatible with "
6125              . "current conditional: $cond_stack[$#cond_stack]")
6126         if $cond_stack[$#cond_stack] ne $cond;
6127     }
6129   pop @cond_stack;
6131   return new Automake::Condition (@cond_stack);
6138 ## ------------------------ ##
6139 ## Handling the variables.  ##
6140 ## ------------------------ ##
6143 # &define_pretty_variable ($VAR, $COND, $WHERE, @VALUE)
6144 # -----------------------------------------------------
6145 # Like define_variable, but the value is a list, and the variable may
6146 # be defined conditionally.  The second argument is the condition
6147 # under which the value should be defined; this should be the empty
6148 # string to define the variable unconditionally.  The third argument
6149 # is a list holding the values to use for the variable.  The value is
6150 # pretty printed in the output file.
6151 sub define_pretty_variable ($$$@)
6153     my ($var, $cond, $where, @value) = @_;
6155     if (! vardef ($var, $cond))
6156     {
6157         Automake::Variable::define ($var, VAR_AUTOMAKE, '', $cond, "@value",
6158                                     '', $where, VAR_PRETTY);
6159         rvar ($var)->rdef ($cond)->set_seen;
6160     }
6164 # define_variable ($VAR, $VALUE, $WHERE)
6165 # --------------------------------------
6166 # Define a new Automake Makefile variable VAR to VALUE, but only if
6167 # not already defined.
6168 sub define_variable ($$$)
6170     my ($var, $value, $where) = @_;
6171     define_pretty_variable ($var, TRUE, $where, $value);
6175 # define_files_variable ($VAR, \@BASENAME, $EXTENSION, $WHERE)
6176 # ------------------------------------------------------------
6177 # Define the $VAR which content is the list of file names composed of
6178 # a @BASENAME and the $EXTENSION.
6179 sub define_files_variable ($\@$$)
6181   my ($var, $basename, $extension, $where) = @_;
6182   define_variable ($var,
6183                    join (' ', map { "$_.$extension" } @$basename),
6184                    $where);
6188 # Like define_variable, but define a variable to be the configure
6189 # substitution by the same name.
6190 sub define_configure_variable ($)
6192   my ($var) = @_;
6193   # Some variables we do not want to output.  For instance it
6194   # would be a bad idea to output `U = @U@` when `@U@` can be
6195   # substituted as `\`.
6196   my $pretty = exists $ignored_configure_vars{$var} ? VAR_SILENT : VAR_ASIS;
6197   Automake::Variable::define ($var, VAR_CONFIGURE, '', TRUE, subst $var,
6198                               '', $configure_vars{$var}, $pretty);
6202 # define_compiler_variable ($LANG)
6203 # --------------------------------
6204 # Define a compiler variable.  We also handle defining the 'LT'
6205 # version of the command when using libtool.
6206 sub define_compiler_variable ($)
6208     my ($lang) = @_;
6210     my ($var, $value) = ($lang->compiler, $lang->compile);
6211     my $libtool_tag = '';
6212     $libtool_tag = '--tag=' . $lang->libtool_tag . ' '
6213       if $lang->libtool_tag && exists $libtool_tags{$lang->libtool_tag};
6214     &define_variable ($var, $value, INTERNAL);
6215     if (var ('LIBTOOL'))
6216       {
6217         my $verbose = define_verbose_libtool ();
6218         &define_variable ("LT$var",
6219                           "\$(LIBTOOL) $verbose $libtool_tag\$(AM_LIBTOOLFLAGS) "
6220                           . "\$(LIBTOOLFLAGS) --mode=compile $value",
6221                           INTERNAL);
6222       }
6223     define_verbose_tagvar ($lang->ccer || 'GEN');
6227 # define_linker_variable ($LANG)
6228 # ------------------------------
6229 # Define linker variables.
6230 sub define_linker_variable ($)
6232     my ($lang) = @_;
6234     my $libtool_tag = '';
6235     $libtool_tag = '--tag=' . $lang->libtool_tag . ' '
6236       if $lang->libtool_tag && exists $libtool_tags{$lang->libtool_tag};
6237     # CCLD = $(CC).
6238     &define_variable ($lang->lder, $lang->ld, INTERNAL);
6239     # CCLINK = $(CCLD) blah blah...
6240     my $link = '';
6241     if (var ('LIBTOOL'))
6242       {
6243         my $verbose = define_verbose_libtool ();
6244         $link = "\$(LIBTOOL) $verbose $libtool_tag\$(AM_LIBTOOLFLAGS) "
6245                 . "\$(LIBTOOLFLAGS) --mode=link ";
6246       }
6247     &define_variable ($lang->linker, $link . $lang->link, INTERNAL);
6248     &define_variable ($lang->compiler,  $lang);
6249     &define_verbose_tagvar ($lang->lder || 'GEN');
6252 sub define_per_target_linker_variable ($$)
6254   my ($linker, $target) = @_;
6256   # If the user wrote a custom link command, we don't define ours.
6257   return "${target}_LINK"
6258     if set_seen "${target}_LINK";
6260   my $xlink = $linker ? $linker : 'LINK';
6262   my $lang = $link_languages{$xlink};
6263   prog_error "Unknown language for linker variable '$xlink'"
6264     unless $lang;
6266   my $link_command = $lang->link;
6267   if (var 'LIBTOOL')
6268     {
6269       my $libtool_tag = '';
6270       $libtool_tag = '--tag=' . $lang->libtool_tag . ' '
6271         if $lang->libtool_tag && exists $libtool_tags{$lang->libtool_tag};
6273       my $verbose = define_verbose_libtool ();
6274       $link_command =
6275         "\$(LIBTOOL) $verbose $libtool_tag\$(AM_LIBTOOLFLAGS) \$(LIBTOOLFLAGS) "
6276         . "--mode=link " . $link_command;
6277     }
6279   # Rewrite each occurrence of 'AM_$flag' in the link
6280   # command into '${derived}_$flag' if it exists.
6281   my $orig_command = $link_command;
6282   my @flags = (@{$lang->flags}, 'LDFLAGS');
6283   push @flags, 'LIBTOOLFLAGS' if var 'LIBTOOL';
6284   for my $flag (@flags)
6285     {
6286       my $val = "${target}_$flag";
6287       $link_command =~ s/\(AM_$flag\)/\($val\)/
6288         if set_seen ($val);
6289     }
6291   # If the computed command is the same as the generic command, use
6292   # the command linker variable.
6293   return ($lang->linker, $lang->lder)
6294     if $link_command eq $orig_command;
6296   &define_variable ("${target}_LINK", $link_command, INTERNAL);
6297   return ("${target}_LINK", $lang->lder);
6300 ################################################################
6302 # &check_trailing_slash ($WHERE, $LINE)
6303 # -------------------------------------
6304 # Return 1 iff $LINE ends with a slash.
6305 # Might modify $LINE.
6306 sub check_trailing_slash ($\$)
6308   my ($where, $line) = @_;
6310   # Ignore '##' lines.
6311   return 0 if $$line =~ /$IGNORE_PATTERN/o;
6313   # Catch and fix a common error.
6314   msg "syntax", $where, "whitespace following trailing backslash"
6315     if $$line =~ s/\\\s+\n$/\\\n/;
6317   return $$line =~ /\\$/;
6321 # &read_am_file ($AMFILE, $WHERE)
6322 # -------------------------------
6323 # Read Makefile.am and set up %contents.  Simultaneously copy lines
6324 # from Makefile.am into $output_trailer, or define variables as
6325 # appropriate.  NOTE we put rules in the trailer section.  We want
6326 # user rules to come after our generated stuff.
6327 sub read_am_file ($$)
6329     my ($amfile, $where) = @_;
6331     my $am_file = new Automake::XFile ("< $amfile");
6332     verb "reading $amfile";
6334     # Keep track of the youngest output dependency.
6335     my $mtime = mtime $amfile;
6336     $output_deps_greatest_timestamp = $mtime
6337       if $mtime > $output_deps_greatest_timestamp;
6339     my $spacing = '';
6340     my $comment = '';
6341     my $blank = 0;
6342     my $saw_bk = 0;
6343     my $var_look = VAR_ASIS;
6345     use constant IN_VAR_DEF => 0;
6346     use constant IN_RULE_DEF => 1;
6347     use constant IN_COMMENT => 2;
6348     my $prev_state = IN_RULE_DEF;
6350     while ($_ = $am_file->getline)
6351     {
6352         $where->set ("$amfile:$.");
6353         if (/$IGNORE_PATTERN/o)
6354         {
6355             # Merely delete comments beginning with two hashes.
6356         }
6357         elsif (/$WHITE_PATTERN/o)
6358         {
6359             error $where, "blank line following trailing backslash"
6360               if $saw_bk;
6361             # Stick a single white line before the incoming macro or rule.
6362             $spacing = "\n";
6363             $blank = 1;
6364             # Flush all comments seen so far.
6365             if ($comment ne '')
6366             {
6367                 $output_vars .= $comment;
6368                 $comment = '';
6369             }
6370         }
6371         elsif (/$COMMENT_PATTERN/o)
6372         {
6373             # Stick comments before the incoming macro or rule.  Make
6374             # sure a blank line precedes the first block of comments.
6375             $spacing = "\n" unless $blank;
6376             $blank = 1;
6377             $comment .= $spacing . $_;
6378             $spacing = '';
6379             $prev_state = IN_COMMENT;
6380         }
6381         else
6382         {
6383             last;
6384         }
6385         $saw_bk = check_trailing_slash ($where, $_);
6386     }
6388     # We save the conditional stack on entry, and then check to make
6389     # sure it is the same on exit.  This lets us conditionally include
6390     # other files.
6391     my @saved_cond_stack = @cond_stack;
6392     my $cond = new Automake::Condition (@cond_stack);
6394     my $last_var_name = '';
6395     my $last_var_type = '';
6396     my $last_var_value = '';
6397     my $last_where;
6398     # FIXME: shouldn't use $_ in this loop; it is too big.
6399     while ($_)
6400     {
6401         $where->set ("$amfile:$.");
6403         # Make sure the line is \n-terminated.
6404         chomp;
6405         $_ .= "\n";
6407         # Don't look at MAINTAINER_MODE_TRUE here.  That shouldn't be
6408         # used by users.  @MAINT@ is an anachronism now.
6409         $_ =~ s/\@MAINT\@//g
6410             unless $seen_maint_mode;
6412         my $new_saw_bk = check_trailing_slash ($where, $_);
6414         if (/$IGNORE_PATTERN/o)
6415         {
6416             # Merely delete comments beginning with two hashes.
6418             # Keep any backslash from the previous line.
6419             $new_saw_bk = $saw_bk;
6420         }
6421         elsif (/$WHITE_PATTERN/o)
6422         {
6423             # Stick a single white line before the incoming macro or rule.
6424             $spacing = "\n";
6425             error $where, "blank line following trailing backslash"
6426               if $saw_bk;
6427         }
6428         elsif (/$COMMENT_PATTERN/o)
6429         {
6430             error $where, "comment following trailing backslash"
6431               if $saw_bk && $prev_state != IN_COMMENT;
6433             # Stick comments before the incoming macro or rule.
6434             $comment .= $spacing . $_;
6435             $spacing = '';
6436             $prev_state = IN_COMMENT;
6437         }
6438         elsif ($saw_bk)
6439         {
6440             if ($prev_state == IN_RULE_DEF)
6441             {
6442               my $cond = new Automake::Condition @cond_stack;
6443               $output_trailer .= $cond->subst_string;
6444               $output_trailer .= $_;
6445             }
6446             elsif ($prev_state == IN_COMMENT)
6447             {
6448                 # If the line doesn't start with a '#', add it.
6449                 # We do this because a continued comment like
6450                 #   # A = foo \
6451                 #         bar \
6452                 #         baz
6453                 # is not portable.  BSD make doesn't honor
6454                 # escaped newlines in comments.
6455                 s/^#?/#/;
6456                 $comment .= $spacing . $_;
6457             }
6458             else # $prev_state == IN_VAR_DEF
6459             {
6460               $last_var_value .= ' '
6461                 unless $last_var_value =~ /\s$/;
6462               $last_var_value .= $_;
6464               if (!/\\$/)
6465                 {
6466                   Automake::Variable::define ($last_var_name, VAR_MAKEFILE,
6467                                               $last_var_type, $cond,
6468                                               $last_var_value, $comment,
6469                                               $last_where, VAR_ASIS)
6470                     if $cond != FALSE;
6471                   $comment = $spacing = '';
6472                 }
6473             }
6474         }
6476         elsif (/$IF_PATTERN/o)
6477           {
6478             $cond = cond_stack_if ($1, $2, $where);
6479           }
6480         elsif (/$ELSE_PATTERN/o)
6481           {
6482             $cond = cond_stack_else ($1, $2, $where);
6483           }
6484         elsif (/$ENDIF_PATTERN/o)
6485           {
6486             $cond = cond_stack_endif ($1, $2, $where);
6487           }
6489         elsif (/$RULE_PATTERN/o)
6490         {
6491             # Found a rule.
6492             $prev_state = IN_RULE_DEF;
6494             # For now we have to output all definitions of user rules
6495             # and can't diagnose duplicates (see the comment in
6496             # Automake::Rule::define). So we go on and ignore the return value.
6497             Automake::Rule::define ($1, $amfile, RULE_USER, $cond, $where);
6499             check_variable_expansions ($_, $where);
6501             $output_trailer .= $comment . $spacing;
6502             my $cond = new Automake::Condition @cond_stack;
6503             $output_trailer .= $cond->subst_string;
6504             $output_trailer .= $_;
6505             $comment = $spacing = '';
6506         }
6507         elsif (/$ASSIGNMENT_PATTERN/o)
6508         {
6509             # Found a macro definition.
6510             $prev_state = IN_VAR_DEF;
6511             $last_var_name = $1;
6512             $last_var_type = $2;
6513             $last_var_value = $3;
6514             $last_where = $where->clone;
6515             if ($3 ne '' && substr ($3, -1) eq "\\")
6516               {
6517                 # We preserve the '\' because otherwise the long lines
6518                 # that are generated will be truncated by broken
6519                 # 'sed's.
6520                 $last_var_value = $3 . "\n";
6521               }
6522             # Normally we try to output variable definitions in the
6523             # same format they were input.  However, POSIX compliant
6524             # systems are not required to support lines longer than
6525             # 2048 bytes (most notably, some sed implementation are
6526             # limited to 4000 bytes, and sed is used by config.status
6527             # to rewrite Makefile.in into Makefile).  Moreover nobody
6528             # would really write such long lines by hand since it is
6529             # hardly maintainable.  So if a line is longer that 1000
6530             # bytes (an arbitrary limit), assume it has been
6531             # automatically generated by some tools, and flatten the
6532             # variable definition.  Otherwise, keep the variable as it
6533             # as been input.
6534             $var_look = VAR_PRETTY if length ($last_var_value) >= 1000;
6536             if (!/\\$/)
6537               {
6538                 Automake::Variable::define ($last_var_name, VAR_MAKEFILE,
6539                                             $last_var_type, $cond,
6540                                             $last_var_value, $comment,
6541                                             $last_where, $var_look)
6542                   if $cond != FALSE;
6543                 $comment = $spacing = '';
6544                 $var_look = VAR_ASIS;
6545               }
6546         }
6547         elsif (/$INCLUDE_PATTERN/o)
6548         {
6549             my $path = $1;
6551             if ($path =~ s/^\$\(top_srcdir\)\///)
6552               {
6553                 push (@include_stack, "\$\(top_srcdir\)/$path");
6554                 # Distribute any included file.
6556                 # Always use the $(top_srcdir) prefix in DIST_COMMON,
6557                 # otherwise OSF make will implicitly copy the included
6558                 # file in the build tree during "make distdir" to satisfy
6559                 # the dependency.
6560                 # (subdircond2.test and subdircond3.test will fail.)
6561                 push_dist_common ("\$\(top_srcdir\)/$path");
6562               }
6563             else
6564               {
6565                 $path =~ s/\$\(srcdir\)\///;
6566                 push (@include_stack, "\$\(srcdir\)/$path");
6567                 # Always use the $(srcdir) prefix in DIST_COMMON,
6568                 # otherwise OSF make will implicitly copy the included
6569                 # file in the build tree during "make distdir" to satisfy
6570                 # the dependency.
6571                 # (subdircond2.test and subdircond3.test will fail.)
6572                 push_dist_common ("\$\(srcdir\)/$path");
6573                 $path = $relative_dir . "/" . $path if $relative_dir ne '.';
6574               }
6575             $where->push_context ("'$path' included from here");
6576             &read_am_file ($path, $where);
6577             $where->pop_context;
6578         }
6579         else
6580         {
6581             # This isn't an error; it is probably a continued rule.
6582             # In fact, this is what we assume.
6583             $prev_state = IN_RULE_DEF;
6584             check_variable_expansions ($_, $where);
6585             $output_trailer .= $comment . $spacing;
6586             my $cond = new Automake::Condition @cond_stack;
6587             $output_trailer .= $cond->subst_string;
6588             $output_trailer .= $_;
6589             $comment = $spacing = '';
6590             error $where, "'#' comment at start of rule is unportable"
6591               if $_ =~ /^\t\s*\#/;
6592         }
6594         $saw_bk = $new_saw_bk;
6595         $_ = $am_file->getline;
6596     }
6598     $output_trailer .= $comment;
6600     error ($where, "trailing backslash on last line")
6601       if $saw_bk;
6603     error ($where, (@cond_stack ? "unterminated conditionals: @cond_stack"
6604                     : "too many conditionals closed in include file"))
6605       if "@saved_cond_stack" ne "@cond_stack";
6609 # define_standard_variables ()
6610 # ----------------------------
6611 # A helper for read_main_am_file which initializes configure variables
6612 # and variables from header-vars.am.
6613 sub define_standard_variables
6615   my $saved_output_vars = $output_vars;
6616   my ($comments, undef, $rules) =
6617     file_contents_internal (1, "$libdir/am/header-vars.am",
6618                             new Automake::Location);
6620   foreach my $var (sort keys %configure_vars)
6621     {
6622       &define_configure_variable ($var);
6623     }
6625   $output_vars .= $comments . $rules;
6628 # Read main am file.
6629 sub read_main_am_file ($$)
6631     my ($amfile, $infile) = @_;
6633     # This supports the strange variable tricks we are about to play.
6634     prog_error ("variable defined before read_main_am_file\n" . variables_dump ())
6635       if (scalar (variables) > 0);
6637     # Generate copyright header for generated Makefile.in.
6638     # We do discard the output of predefined variables, handled below.
6639     $output_vars = ("# " . basename ($infile) . " generated by automake "
6640                    . $VERSION . " from " . basename ($amfile) . ".\n");
6641     $output_vars .= '# ' . subst ('configure_input') . "\n";
6642     $output_vars .= $gen_copyright;
6644     # We want to predefine as many variables as possible.  This lets
6645     # the user set them with '+=' in Makefile.am.
6646     &define_standard_variables;
6648     # Read user file, which might override some of our values.
6649     &read_am_file ($amfile, new Automake::Location);
6654 ################################################################
6656 # $FLATTENED
6657 # &flatten ($STRING)
6658 # ------------------
6659 # Flatten the $STRING and return the result.
6660 sub flatten
6662   $_ = shift;
6664   s/\\\n//somg;
6665   s/\s+/ /g;
6666   s/^ //;
6667   s/ $//;
6669   return $_;
6673 # transform_token ($TOKEN, \%PAIRS, $KEY)
6674 # =======================================
6675 # Return the value associated to $KEY in %PAIRS, as used on $TOKEN
6676 # (which should be ?KEY? or any of the special %% requests)..
6677 sub transform_token ($$$)
6679   my ($token, $transform, $key) = @_;
6680   my $res = $transform->{$key};
6681   prog_error "Unknown key '$key' in '$token'" unless defined $res;
6682   return $res;
6686 # transform ($TOKEN, \%PAIRS)
6687 # ===========================
6688 # If ($TOKEN, $VAL) is in %PAIRS:
6689 #   - replaces %KEY% with $VAL,
6690 #   - enables/disables ?KEY? and ?!KEY?,
6691 #   - replaces %?KEY% with TRUE or FALSE.
6692 sub transform ($$)
6694   my ($token, $transform) = @_;
6696   # %KEY%.
6697   # Must be before the following pattern to exclude the case
6698   # when there is neither IFTRUE nor IFFALSE.
6699   if ($token =~ /^%([\w\-]+)%$/)
6700     {
6701       return transform_token ($token, $transform, $1);
6702     }
6703   # %?KEY%.
6704   elsif ($token =~ /^%\?([\w\-]+)%$/)
6705     {
6706       return transform_token ($token, $transform, $1) ? 'TRUE' : 'FALSE';
6707     }
6708   # ?KEY? and ?!KEY?.
6709   elsif ($token =~ /^ \? (!?) ([\w\-]+) \? $/x)
6710     {
6711       my $neg = ($1 eq '!') ? 1 : 0;
6712       my $val = transform_token ($token, $transform, $2);
6713       return (!!$val == $neg) ? '##%' : '';
6714     }
6715   else
6716     {
6717       prog_error "Unknown request format: $token";
6718     }
6721 # $TEXT
6722 # preprocess_file ($MAKEFILE, [%TRANSFORM])
6723 # -----------------------------------------
6724 # Load a $MAKEFILE, apply the %TRANSFORM, and return the result.
6725 # No extra parsing or post-processing is done (i.e., recognition of
6726 # rules declaration or of make variables definitions).
6727 sub preprocess_file ($%)
6729   my ($file, %transform) = @_;
6731   # Complete %transform with global options.
6732   # Note that %transform goes last, so it overrides global options.
6733   %transform = ( 'MAINTAINER-MODE'
6734                  => $seen_maint_mode ? subst ('MAINTAINER_MODE_TRUE') : '',
6736                  'XZ'          => !! option 'dist-xz',
6737                  'LZIP'        => !! option 'dist-lzip',
6738                  'BZIP2'       => !! option 'dist-bzip2',
6739                  'COMPRESS'    => !! option 'dist-tarZ',
6740                  'GZIP'        =>  ! option 'no-dist-gzip',
6741                  'SHAR'        => !! option 'dist-shar',
6742                  'ZIP'         => !! option 'dist-zip',
6744                  'INSTALL-INFO' =>  ! option 'no-installinfo',
6745                  'INSTALL-MAN'  =>  ! option 'no-installman',
6746                  'CK-NEWS'      => !! option 'check-news',
6748                  'SUBDIRS'      => !! var ('SUBDIRS'),
6749                  'TOPDIR_P'     => $relative_dir eq '.',
6751                  'BUILD'    => ($seen_canonical >= AC_CANONICAL_BUILD),
6752                  'HOST'     => ($seen_canonical >= AC_CANONICAL_HOST),
6753                  'TARGET'   => ($seen_canonical >= AC_CANONICAL_TARGET),
6755                  'LIBTOOL'      => !! var ('LIBTOOL'),
6756                  'NONLIBTOOL'   => 1,
6757                 %transform);
6759   if (! defined ($_ = $am_file_cache{$file}))
6760     {
6761       verb "reading $file";
6762       # Swallow the whole file.
6763       my $fc_file = new Automake::XFile "< $file";
6764       my $saved_dollar_slash = $/;
6765       undef $/;
6766       $_ = $fc_file->getline;
6767       $/ = $saved_dollar_slash;
6768       $fc_file->close;
6769       # Remove ##-comments.
6770       # Besides we don't need more than two consecutive new-lines.
6771       s/(?:$IGNORE_PATTERN|(?<=\n\n)\n+)//gom;
6772       # Remember the contents of the just-read file.
6773       $am_file_cache{$file} = $_;
6774     }
6776   # Substitute Automake template tokens.
6777   s/(?: % \?? [\w\-]+ %
6778       | \? !? [\w\-]+ \?
6779     )/transform($&, \%transform)/gex;
6780   # transform() may have added some ##%-comments to strip.
6781   # (we use '##%' instead of '##' so we can distinguish ##%##%##% from
6782   # ####### and do not remove the latter.)
6783   s/^[ \t]*(?:##%)+.*\n//gm;
6785   return $_;
6789 # @PARAGRAPHS
6790 # &make_paragraphs ($MAKEFILE, [%TRANSFORM])
6791 # ------------------------------------------
6792 # Load a $MAKEFILE, apply the %TRANSFORM, and return it as a list of
6793 # paragraphs.
6794 sub make_paragraphs ($%)
6796   my ($file, %transform) = @_;
6797   $transform{FIRST} = !$transformed_files{$file};
6798   $transformed_files{$file} = 1;
6800   my @lines = split /(?<!\\)\n/, preprocess_file ($file, %transform);
6801   my @res;
6803   while (defined ($_ = shift @lines))
6804     {
6805       my $paragraph = $_;
6806       # If we are a rule, eat as long as we start with a tab.
6807       if (/$RULE_PATTERN/smo)
6808         {
6809           while (defined ($_ = shift @lines) && $_ =~ /^\t/)
6810             {
6811               $paragraph .= "\n$_";
6812             }
6813           unshift (@lines, $_);
6814         }
6816       # If we are a comments, eat as much comments as you can.
6817       elsif (/$COMMENT_PATTERN/smo)
6818         {
6819           while (defined ($_ = shift @lines)
6820                  && $_ =~ /$COMMENT_PATTERN/smo)
6821             {
6822               $paragraph .= "\n$_";
6823             }
6824           unshift (@lines, $_);
6825         }
6827       push @res, $paragraph;
6828     }
6830   return @res;
6835 # ($COMMENT, $VARIABLES, $RULES)
6836 # &file_contents_internal ($IS_AM, $FILE, $WHERE, [%TRANSFORM])
6837 # -------------------------------------------------------------
6838 # Return contents of a file from $libdir/am, automatically skipping
6839 # macros or rules which are already known. $IS_AM iff the caller is
6840 # reading an Automake file (as opposed to the user's Makefile.am).
6841 sub file_contents_internal ($$$%)
6843     my ($is_am, $file, $where, %transform) = @_;
6845     $where->set ($file);
6847     my $result_vars = '';
6848     my $result_rules = '';
6849     my $comment = '';
6850     my $spacing = '';
6852     # The following flags are used to track rules spanning across
6853     # multiple paragraphs.
6854     my $is_rule = 0;            # 1 if we are processing a rule.
6855     my $discard_rule = 0;       # 1 if the current rule should not be output.
6857     # We save the conditional stack on entry, and then check to make
6858     # sure it is the same on exit.  This lets us conditionally include
6859     # other files.
6860     my @saved_cond_stack = @cond_stack;
6861     my $cond = new Automake::Condition (@cond_stack);
6863     foreach (make_paragraphs ($file, %transform))
6864     {
6865         # FIXME: no line number available.
6866         $where->set ($file);
6868         # Sanity checks.
6869         error $where, "blank line following trailing backslash:\n$_"
6870           if /\\$/;
6871         error $where, "comment following trailing backslash:\n$_"
6872           if /\\#/;
6874         if (/^$/)
6875         {
6876             $is_rule = 0;
6877             # Stick empty line before the incoming macro or rule.
6878             $spacing = "\n";
6879         }
6880         elsif (/$COMMENT_PATTERN/mso)
6881         {
6882             $is_rule = 0;
6883             # Stick comments before the incoming macro or rule.
6884             $comment = "$_\n";
6885         }
6887         # Handle inclusion of other files.
6888         elsif (/$INCLUDE_PATTERN/o)
6889         {
6890             if ($cond != FALSE)
6891               {
6892                 my $file = ($is_am ? "$libdir/am/" : '') . $1;
6893                 $where->push_context ("'$file' included from here");
6894                 # N-ary '.=' fails.
6895                 my ($com, $vars, $rules)
6896                   = file_contents_internal ($is_am, $file, $where, %transform);
6897                 $where->pop_context;
6898                 $comment .= $com;
6899                 $result_vars .= $vars;
6900                 $result_rules .= $rules;
6901               }
6902         }
6904         # Handling the conditionals.
6905         elsif (/$IF_PATTERN/o)
6906           {
6907             $cond = cond_stack_if ($1, $2, $file);
6908           }
6909         elsif (/$ELSE_PATTERN/o)
6910           {
6911             $cond = cond_stack_else ($1, $2, $file);
6912           }
6913         elsif (/$ENDIF_PATTERN/o)
6914           {
6915             $cond = cond_stack_endif ($1, $2, $file);
6916           }
6918         # Handling rules.
6919         elsif (/$RULE_PATTERN/mso)
6920         {
6921           $is_rule = 1;
6922           $discard_rule = 0;
6923           # Separate relationship from optional actions: the first
6924           # `new-line tab" not preceded by backslash (continuation
6925           # line).
6926           my $paragraph = $_;
6927           /^(.*?)(?:(?<!\\)\n(\t.*))?$/s;
6928           my ($relationship, $actions) = ($1, $2 || '');
6930           # Separate targets from dependencies: the first colon.
6931           $relationship =~ /^([^:]+\S+) *: *(.*)$/som;
6932           my ($targets, $dependencies) = ($1, $2);
6933           # Remove the escaped new lines.
6934           # I don't know why, but I have to use a tmp $flat_deps.
6935           my $flat_deps = &flatten ($dependencies);
6936           my @deps = split (' ', $flat_deps);
6938           foreach (split (' ', $targets))
6939             {
6940               # FIXME: 1. We are not robust to people defining several targets
6941               # at once, only some of them being in %dependencies.  The
6942               # actions from the targets in %dependencies are usually generated
6943               # from the content of %actions, but if some targets in $targets
6944               # are not in %dependencies the ELSE branch will output
6945               # a rule for all $targets (i.e. the targets which are both
6946               # in %dependencies and $targets will have two rules).
6948               # FIXME: 2. The logic here is not able to output a
6949               # multi-paragraph rule several time (e.g. for each condition
6950               # it is defined for) because it only knows the first paragraph.
6952               # FIXME: 3. We are not robust to people defining a subset
6953               # of a previously defined "multiple-target" rule.  E.g.
6954               # 'foo:' after 'foo bar:'.
6956               # Output only if not in FALSE.
6957               if (defined $dependencies{$_} && $cond != FALSE)
6958                 {
6959                   &depend ($_, @deps);
6960                   register_action ($_, $actions);
6961                 }
6962               else
6963                 {
6964                   # Free-lance dependency.  Output the rule for all the
6965                   # targets instead of one by one.
6966                   my @undefined_conds =
6967                     Automake::Rule::define ($targets, $file,
6968                                             $is_am ? RULE_AUTOMAKE : RULE_USER,
6969                                             $cond, $where);
6970                   for my $undefined_cond (@undefined_conds)
6971                     {
6972                       my $condparagraph = $paragraph;
6973                       $condparagraph =~ s/^/$undefined_cond->subst_string/gme;
6974                       $result_rules .= "$spacing$comment$condparagraph\n";
6975                     }
6976                   if (scalar @undefined_conds == 0)
6977                     {
6978                       # Remember to discard next paragraphs
6979                       # if they belong to this rule.
6980                       # (but see also FIXME: #2 above.)
6981                       $discard_rule = 1;
6982                     }
6983                   $comment = $spacing = '';
6984                   last;
6985                 }
6986             }
6987         }
6989         elsif (/$ASSIGNMENT_PATTERN/mso)
6990         {
6991             my ($var, $type, $val) = ($1, $2, $3);
6992             error $where, "variable '$var' with trailing backslash"
6993               if /\\$/;
6995             $is_rule = 0;
6997             Automake::Variable::define ($var,
6998                                         $is_am ? VAR_AUTOMAKE : VAR_MAKEFILE,
6999                                         $type, $cond, $val, $comment, $where,
7000                                         VAR_ASIS)
7001               if $cond != FALSE;
7003             $comment = $spacing = '';
7004         }
7005         else
7006         {
7007             # This isn't an error; it is probably some tokens which
7008             # configure is supposed to replace, such as '@SET-MAKE@',
7009             # or some part of a rule cut by an if/endif.
7010             if (! $cond->false && ! ($is_rule && $discard_rule))
7011               {
7012                 s/^/$cond->subst_string/gme;
7013                 $result_rules .= "$spacing$comment$_\n";
7014               }
7015             $comment = $spacing = '';
7016         }
7017     }
7019     error ($where, @cond_stack ?
7020            "unterminated conditionals: @cond_stack" :
7021            "too many conditionals closed in include file")
7022       if "@saved_cond_stack" ne "@cond_stack";
7024     return ($comment, $result_vars, $result_rules);
7028 # $CONTENTS
7029 # &file_contents ($BASENAME, $WHERE, [%TRANSFORM])
7030 # ------------------------------------------------
7031 # Return contents of a file from $libdir/am, automatically skipping
7032 # macros or rules which are already known.
7033 sub file_contents ($$%)
7035     my ($basename, $where, %transform) = @_;
7036     my ($comments, $variables, $rules) =
7037       file_contents_internal (1, "$libdir/am/$basename.am", $where,
7038                               %transform);
7039     return "$comments$variables$rules";
7043 # @PREFIX
7044 # &am_primary_prefixes ($PRIMARY, $CAN_DIST, @PREFIXES)
7045 # -----------------------------------------------------
7046 # Find all variable prefixes that are used for install directories.  A
7047 # prefix 'zar' qualifies iff:
7049 # * 'zardir' is a variable.
7050 # * 'zar_PRIMARY' is a variable.
7052 # As a side effect, it looks for misspellings.  It is an error to have
7053 # a variable ending in a "reserved" suffix whose prefix is unknown, e.g.
7054 # "bni_PROGRAMS".  However, unusual prefixes are allowed if a variable
7055 # of the same name (with "dir" appended) exists.  For instance, if the
7056 # variable "zardir" is defined, then "zar_PROGRAMS" becomes valid.
7057 # This is to provide a little extra flexibility in those cases which
7058 # need it.
7059 sub am_primary_prefixes ($$@)
7061   my ($primary, $can_dist, @prefixes) = @_;
7063   local $_;
7064   my %valid = map { $_ => 0 } @prefixes;
7065   $valid{'EXTRA'} = 0;
7066   foreach my $var (variables $primary)
7067     {
7068       # Automake is allowed to define variables that look like primaries
7069       # but which aren't.  E.g. INSTALL_sh_DATA.
7070       # Autoconf can also define variables like INSTALL_DATA, so
7071       # ignore all configure variables (at least those which are not
7072       # redefined in Makefile.am).
7073       # FIXME: We should make sure that these variables are not
7074       # conditionally defined (or else adjust the condition below).
7075       my $def = $var->def (TRUE);
7076       next if $def && $def->owner != VAR_MAKEFILE;
7078       my $varname = $var->name;
7080       if ($varname =~ /^(nobase_)?(dist_|nodist_)?(.*)_[[:alnum:]]+$/)
7081         {
7082           my ($base, $dist, $X) = ($1 || '', $2 || '', $3 || '');
7083           if ($dist ne '' && ! $can_dist)
7084             {
7085               err_var ($var,
7086                        "invalid variable '$varname': 'dist' is forbidden");
7087             }
7088           # Standard directories must be explicitly allowed.
7089           elsif (! defined $valid{$X} && exists $standard_prefix{$X})
7090             {
7091               err_var ($var,
7092                        "'${X}dir' is not a legitimate directory " .
7093                        "for '$primary'");
7094             }
7095           # A not explicitly valid directory is allowed if Xdir is defined.
7096           elsif (! defined $valid{$X} &&
7097                  $var->requires_variables ("'$varname' is used", "${X}dir"))
7098             {
7099               # Nothing to do.  Any error message has been output
7100               # by $var->requires_variables.
7101             }
7102           else
7103             {
7104               # Ensure all extended prefixes are actually used.
7105               $valid{"$base$dist$X"} = 1;
7106             }
7107         }
7108       else
7109         {
7110           prog_error "unexpected variable name: $varname";
7111         }
7112     }
7114   # Return only those which are actually defined.
7115   return sort grep { var ($_ . '_' . $primary) } keys %valid;
7119 # Handle 'where_HOW' variable magic.  Does all lookups, generates
7120 # install code, and possibly generates code to define the primary
7121 # variable.  The first argument is the name of the .am file to munge,
7122 # the second argument is the primary variable (e.g. HEADERS), and all
7123 # subsequent arguments are possible installation locations.
7125 # Returns list of [$location, $value] pairs, where
7126 # $value's are the values in all where_HOW variable, and $location
7127 # there associated location (the place here their parent variables were
7128 # defined).
7130 # FIXME: this should be rewritten to be cleaner.  It should be broken
7131 # up into multiple functions.
7133 # Usage is: am_install_var (OPTION..., file, HOW, where...)
7134 sub am_install_var
7136   my (@args) = @_;
7138   my $do_require = 1;
7139   my $can_dist = 0;
7140   my $default_dist = 0;
7141   while (@args)
7142     {
7143       if ($args[0] eq '-noextra')
7144         {
7145           $do_require = 0;
7146         }
7147       elsif ($args[0] eq '-candist')
7148         {
7149           $can_dist = 1;
7150         }
7151       elsif ($args[0] eq '-defaultdist')
7152         {
7153           $default_dist = 1;
7154           $can_dist = 1;
7155         }
7156       elsif ($args[0] !~ /^-/)
7157         {
7158           last;
7159         }
7160       shift (@args);
7161     }
7163   my ($file, $primary, @prefix) = @args;
7165   # Now that configure substitutions are allowed in where_HOW
7166   # variables, it is an error to actually define the primary.  We
7167   # allow 'JAVA', as it is customarily used to mean the Java
7168   # interpreter.  This is but one of several Java hacks.  Similarly,
7169   # 'PYTHON' is customarily used to mean the Python interpreter.
7170   reject_var $primary, "'$primary' is an anachronism"
7171     unless $primary eq 'JAVA' || $primary eq 'PYTHON';
7173   # Get the prefixes which are valid and actually used.
7174   @prefix = am_primary_prefixes ($primary, $can_dist, @prefix);
7176   # If a primary includes a configure substitution, then the EXTRA_
7177   # form is required.  Otherwise we can't properly do our job.
7178   my $require_extra;
7180   my @used = ();
7181   my @result = ();
7183   foreach my $X (@prefix)
7184     {
7185       my $nodir_name = $X;
7186       my $one_name = $X . '_' . $primary;
7187       my $one_var = var $one_name;
7189       my $strip_subdir = 1;
7190       # If subdir prefix should be preserved, do so.
7191       if ($nodir_name =~ /^nobase_/)
7192         {
7193           $strip_subdir = 0;
7194           $nodir_name =~ s/^nobase_//;
7195         }
7197       # If files should be distributed, do so.
7198       my $dist_p = 0;
7199       if ($can_dist)
7200         {
7201           $dist_p = (($default_dist && $nodir_name !~ /^nodist_/)
7202                      || (! $default_dist && $nodir_name =~ /^dist_/));
7203           $nodir_name =~ s/^(dist|nodist)_//;
7204         }
7207       # Use the location of the currently processed variable.
7208       # We are not processing a particular condition, so pick the first
7209       # available.
7210       my $tmpcond = $one_var->conditions->one_cond;
7211       my $where = $one_var->rdef ($tmpcond)->location->clone;
7213       # Append actual contents of where_PRIMARY variable to
7214       # @result, skipping @substitutions@.
7215       foreach my $locvals ($one_var->value_as_list_recursive (location => 1))
7216         {
7217           my ($loc, $value) = @$locvals;
7218           # Skip configure substitutions.
7219           if ($value =~ /^\@.*\@$/)
7220             {
7221               if ($nodir_name eq 'EXTRA')
7222                 {
7223                   error ($where,
7224                          "'$one_name' contains configure substitution, "
7225                          . "but shouldn't");
7226                 }
7227               # Check here to make sure variables defined in
7228               # configure.ac do not imply that EXTRA_PRIMARY
7229               # must be defined.
7230               elsif (! defined $configure_vars{$one_name})
7231                 {
7232                   $require_extra = $one_name
7233                     if $do_require;
7234                 }
7235             }
7236           else
7237             {
7238               # Strip any $(EXEEXT) suffix the user might have added, or this
7239               # will confuse &handle_source_transform and &check_canonical_spelling.
7240               # We'll add $(EXEEXT) back later anyway.
7241               # Do it here rather than in handle_programs so the uniquifying at the
7242               # end of this function works.
7243               ${$locvals}[1] =~ s/\$\(EXEEXT\)$//
7244                 if $primary eq 'PROGRAMS';
7246               push (@result, $locvals);
7247             }
7248         }
7249       # A blatant hack: we rewrite each _PROGRAMS primary to include
7250       # EXEEXT.
7251       append_exeext { 1 } $one_name
7252         if $primary eq 'PROGRAMS';
7253       # "EXTRA" shouldn't be used when generating clean targets,
7254       # all, or install targets.  We used to warn if EXTRA_FOO was
7255       # defined uselessly, but this was annoying.
7256       next
7257         if $nodir_name eq 'EXTRA';
7259       if ($nodir_name eq 'check')
7260         {
7261           push (@check, '$(' . $one_name . ')');
7262         }
7263       else
7264         {
7265           push (@used, '$(' . $one_name . ')');
7266         }
7268       # Is this to be installed?
7269       my $install_p = $nodir_name ne 'noinst' && $nodir_name ne 'check';
7271       # If so, with install-exec? (or install-data?).
7272       my $exec_p = ($nodir_name =~ /$EXEC_DIR_PATTERN/o);
7274       my $check_options_p = $install_p && !! option 'std-options';
7276       # Use the location of the currently processed variable as context.
7277       $where->push_context ("while processing '$one_name'");
7279       # The variable containing all files to distribute.
7280       my $distvar = "\$($one_name)";
7281       $distvar = shadow_unconditionally ($one_name, $where)
7282         if ($dist_p && $one_var->has_conditional_contents);
7284       # Singular form of $PRIMARY.
7285       (my $one_primary = $primary) =~ s/S$//;
7286       $output_rules .= &file_contents ($file, $where,
7287                                        PRIMARY     => $primary,
7288                                        ONE_PRIMARY => $one_primary,
7289                                        DIR         => $X,
7290                                        NDIR        => $nodir_name,
7291                                        BASE        => $strip_subdir,
7293                                        EXEC      => $exec_p,
7294                                        INSTALL   => $install_p,
7295                                        DIST      => $dist_p,
7296                                        DISTVAR   => $distvar,
7297                                        'CK-OPTS' => $check_options_p);
7298     }
7300   # The JAVA variable is used as the name of the Java interpreter.
7301   # The PYTHON variable is used as the name of the Python interpreter.
7302   if (@used && $primary ne 'JAVA' && $primary ne 'PYTHON')
7303     {
7304       # Define it.
7305       define_pretty_variable ($primary, TRUE, INTERNAL, @used);
7306       $output_vars .= "\n";
7307     }
7309   err_var ($require_extra,
7310            "'$require_extra' contains configure substitution,\n"
7311            . "but 'EXTRA_$primary' not defined")
7312     if ($require_extra && ! var ('EXTRA_' . $primary));
7314   # Push here because PRIMARY might be configure time determined.
7315   push (@all, '$(' . $primary . ')')
7316     if @used && $primary ne 'JAVA' && $primary ne 'PYTHON';
7318   # Make the result unique.  This lets the user use conditionals in
7319   # a natural way, but still lets us program lazily -- we don't have
7320   # to worry about handling a particular object more than once.
7321   # We will keep only one location per object.
7322   my %result = ();
7323   for my $pair (@result)
7324     {
7325       my ($loc, $val) = @$pair;
7326       $result{$val} = $loc;
7327     }
7328   my @l = sort keys %result;
7329   return map { [$result{$_}->clone, $_] } @l;
7333 ################################################################
7335 # Each key in this hash is the name of a directory holding a
7336 # Makefile.in.  These variables are local to 'is_make_dir'.
7337 my %make_dirs = ();
7338 my $make_dirs_set = 0;
7340 sub is_make_dir
7342     my ($dir) = @_;
7343     if (! $make_dirs_set)
7344     {
7345         foreach my $iter (@configure_input_files)
7346         {
7347             $make_dirs{dirname ($iter)} = 1;
7348         }
7349         # We also want to notice Makefile.in's.
7350         foreach my $iter (@other_input_files)
7351         {
7352             if ($iter =~ /Makefile\.in$/)
7353             {
7354                 $make_dirs{dirname ($iter)} = 1;
7355             }
7356         }
7357         $make_dirs_set = 1;
7358     }
7359     return defined $make_dirs{$dir};
7362 ################################################################
7364 # Find the aux dir.  This should match the algorithm used by
7365 # ./configure. (See the Autoconf documentation for for
7366 # AC_CONFIG_AUX_DIR.)
7367 sub locate_aux_dir ()
7369   if (! $config_aux_dir_set_in_configure_ac)
7370     {
7371       # The default auxiliary directory is the first
7372       # of ., .., or ../.. that contains install-sh.
7373       # Assume . if install-sh doesn't exist yet.
7374       for my $dir (qw (. .. ../..))
7375         {
7376           if (-f "$dir/install-sh")
7377             {
7378               $config_aux_dir = $dir;
7379               last;
7380             }
7381         }
7382       $config_aux_dir = '.' unless $config_aux_dir;
7383     }
7384   # Avoid unsightly '/.'s.
7385   $am_config_aux_dir =
7386     '$(top_srcdir)' . ($config_aux_dir eq '.' ? "" : "/$config_aux_dir");
7387   $am_config_aux_dir =~ s,/*$,,;
7391 # &push_required_file ($DIR, $FILE, $FULLFILE)
7392 # --------------------------------------------------
7393 # Push the given file onto DIST_COMMON.
7394 sub push_required_file
7396   my ($dir, $file, $fullfile) = @_;
7398   # If the file to be distributed is in the same directory of the
7399   # currently processed Makefile.am, then we want to distribute it
7400   # from this same Makefile.am.
7401   if ($dir eq $relative_dir)
7402     {
7403       push_dist_common ($file);
7404     }
7405   # This is needed to allow a construct in a non-top-level Makefile.am
7406   # to require a file in the build-aux directory (see at least the test
7407   # script 'test-driver-is-distributed.test').  This is related to the
7408   # automake bug#9546.  Note that the use of $config_aux_dir instead
7409   # of $am_config_aux_dir here is deliberate and necessary.
7410   elsif ($dir eq $config_aux_dir)
7411     {
7412       push_dist_common ("$am_config_aux_dir/$file");
7413     }
7414   # FIXME: another spacial case, for AC_LIBOBJ/AC_LIBSOURCE support.
7415   # We probably need some refactoring of this function and its callers,
7416   # to have a more explicit and systematic handling of all the special
7417   # cases; but, since there are only two of them, this is low-priority
7418   # ATM.
7419   elsif ($config_libobj_dir && $dir eq $config_libobj_dir)
7420     {
7421       # Avoid unsightly '/.'s.
7422       my $am_config_libobj_dir =
7423         '$(top_srcdir)' .
7424         ($config_libobj_dir eq '.' ? "" : "/$config_libobj_dir");
7425       $am_config_libobj_dir =~ s|/*$||;
7426       push_dist_common ("$am_config_libobj_dir/$file");
7427     }
7428   elsif ($relative_dir eq '.' && ! &is_make_dir ($dir))
7429     {
7430       # If we are doing the topmost directory, and the file is in a
7431       # subdir which does not have a Makefile, then we distribute it
7432       # here.
7434       # If a required file is above the source tree, it is important
7435       # to prefix it with '$(srcdir)' so that no VPATH search is
7436       # performed.  Otherwise problems occur with Make implementations
7437       # that rewrite and simplify rules whose dependencies are found in a
7438       # VPATH location.  Here is an example with OSF1/Tru64 Make.
7439       #
7440       #   % cat Makefile
7441       #   VPATH = sub
7442       #   distdir: ../a
7443       #           echo ../a
7444       #   % ls
7445       #   Makefile a
7446       #   % make
7447       #   echo a
7448       #   a
7449       #
7450       # Dependency '../a' was found in 'sub/../a', but this make
7451       # implementation simplified it as 'a'.  (Note that the sub/
7452       # directory does not even exist.)
7453       #
7454       # This kind of VPATH rewriting seems hard to cancel.  The
7455       # distdir.am hack against VPATH rewriting works only when no
7456       # simplification is done, i.e., for dependencies which are in
7457       # subdirectories, not in enclosing directories.  Hence, in
7458       # the latter case we use a full path to make sure no VPATH
7459       # search occurs.
7460       $fullfile = '$(srcdir)/' . $fullfile
7461         if $dir =~ m,^\.\.(?:$|/),;
7463       push_dist_common ($fullfile);
7464     }
7465   else
7466     {
7467       prog_error "a Makefile in relative directory $relative_dir " .
7468                  "can't add files in directory $dir to DIST_COMMON";
7469     }
7473 # If a file name appears as a key in this hash, then it has already
7474 # been checked for.  This allows us not to report the same error more
7475 # than once.
7476 my %required_file_not_found = ();
7478 # &required_file_check_or_copy ($WHERE, $DIRECTORY, $FILE)
7479 # --------------------------------------------------------
7480 # Verify that the file must exist in $DIRECTORY, or install it.
7481 sub required_file_check_or_copy ($$$)
7483   my ($where, $dir, $file) = @_;
7485   my $fullfile = "$dir/$file";
7486   my $found_it = 0;
7487   my $dangling_sym = 0;
7489   if (-l $fullfile && ! -f $fullfile)
7490     {
7491       $dangling_sym = 1;
7492     }
7493   elsif (dir_has_case_matching_file ($dir, $file))
7494     {
7495       $found_it = 1;
7496     }
7498   # '--force-missing' only has an effect if '--add-missing' is
7499   # specified.
7500   return
7501     if $found_it && (! $add_missing || ! $force_missing);
7503   # If we've already looked for it, we're done.  You might
7504   # wonder why we don't do this before searching for the
7505   # file.  If we do that, then something like
7506   # AC_OUTPUT(subdir/foo foo) will fail to put foo.in into
7507   # DIST_COMMON.
7508   if (! $found_it)
7509     {
7510       return if defined $required_file_not_found{$fullfile};
7511       $required_file_not_found{$fullfile} = 1;
7512     }
7513   if ($dangling_sym && $add_missing)
7514     {
7515       unlink ($fullfile);
7516     }
7518   my $trailer = '';
7519   my $trailer2 = '';
7520   my $suppress = 0;
7522   # Only install missing files according to our desired
7523   # strictness level.
7524   my $message = "required file '$fullfile' not found";
7525   if ($add_missing)
7526     {
7527       if (-f "$libdir/$file")
7528         {
7529           $suppress = 1;
7531           # Install the missing file.  Symlink if we
7532           # can, copy if we must.  Note: delete the file
7533           # first, in case it is a dangling symlink.
7534           $message = "installing '$fullfile'";
7536           # The license file should not be volatile.
7537           if ($file eq "COPYING")
7538             {
7539               $message .= " using GNU General Public License v3 file";
7540               $trailer2 = "\n    Consider adding the COPYING file"
7541                         . " to the version control system"
7542                         . "\n    for your code, to avoid questions"
7543                         . " about which license your project uses";
7544             }
7546           # Windows Perl will hang if we try to delete a
7547           # file that doesn't exist.
7548           unlink ($fullfile) if -f $fullfile;
7549           if ($symlink_exists && ! $copy_missing)
7550             {
7551               if (! symlink ("$libdir/$file", $fullfile)
7552                   || ! -e $fullfile)
7553                 {
7554                   $suppress = 0;
7555                   $trailer = "; error while making link: $!";
7556                 }
7557             }
7558           elsif (system ('cp', "$libdir/$file", $fullfile))
7559             {
7560               $suppress = 0;
7561               $trailer = "\n    error while copying";
7562             }
7563           set_dir_cache_file ($dir, $file);
7564         }
7565     }
7566   else
7567     {
7568       $trailer = "\n  'automake --add-missing' can install '$file'"
7569         if -f "$libdir/$file";
7570     }
7572   # If --force-missing was specified, and we have
7573   # actually found the file, then do nothing.
7574   return
7575     if $found_it && $force_missing;
7577   # If we couldn't install the file, but it is a target in
7578   # the Makefile, don't print anything.  This allows files
7579   # like README, AUTHORS, or THANKS to be generated.
7580   return
7581     if !$suppress && rule $file;
7583   msg ($suppress ? 'note' : 'error', $where, "$message$trailer$trailer2");
7587 # &require_file_internal ($WHERE, $MYSTRICT, $DIRECTORY, $QUEUE, @FILES)
7588 # ----------------------------------------------------------------------
7589 # Verify that the file must exist in $DIRECTORY, or install it.
7590 # $MYSTRICT is the strictness level at which this file becomes required.
7591 # Worker threads may queue up the action to be serialized by the master,
7592 # if $QUEUE is true
7593 sub require_file_internal ($$$@)
7595   my ($where, $mystrict, $dir, $queue, @files) = @_;
7597   return
7598     unless $strictness >= $mystrict;
7600   foreach my $file (@files)
7601     {
7602       push_required_file ($dir, $file, "$dir/$file");
7603       if ($queue)
7604         {
7605           queue_required_file_check_or_copy ($required_conf_file_queue,
7606                                              QUEUE_CONF_FILE, $relative_dir,
7607                                              $where, $mystrict, @files);
7608         }
7609       else
7610         {
7611           required_file_check_or_copy ($where, $dir, $file);
7612         }
7613     }
7616 # &require_file ($WHERE, $MYSTRICT, @FILES)
7617 # -----------------------------------------
7618 sub require_file ($$@)
7620     my ($where, $mystrict, @files) = @_;
7621     require_file_internal ($where, $mystrict, $relative_dir, 0, @files);
7624 # &require_file_with_macro ($COND, $MACRO, $MYSTRICT, @FILES)
7625 # -----------------------------------------------------------
7626 sub require_file_with_macro ($$$@)
7628     my ($cond, $macro, $mystrict, @files) = @_;
7629     $macro = rvar ($macro) unless ref $macro;
7630     require_file ($macro->rdef ($cond)->location, $mystrict, @files);
7633 # &require_libsource_with_macro ($COND, $MACRO, $MYSTRICT, @FILES)
7634 # ----------------------------------------------------------------
7635 # Require an AC_LIBSOURCEd file.  If AC_CONFIG_LIBOBJ_DIR was called, it
7636 # must be in that directory.  Otherwise expect it in the current directory.
7637 sub require_libsource_with_macro ($$$@)
7639     my ($cond, $macro, $mystrict, @files) = @_;
7640     $macro = rvar ($macro) unless ref $macro;
7641     if ($config_libobj_dir)
7642       {
7643         require_file_internal ($macro->rdef ($cond)->location, $mystrict,
7644                                $config_libobj_dir, 0, @files);
7645       }
7646     else
7647       {
7648         require_file ($macro->rdef ($cond)->location, $mystrict, @files);
7649       }
7652 # &queue_required_file_check_or_copy ($QUEUE, $KEY, $DIR, $WHERE,
7653 #                                     $MYSTRICT, @FILES)
7654 # ---------------------------------------------------------------
7655 sub queue_required_file_check_or_copy ($$$$@)
7657     my ($queue, $key, $dir, $where, $mystrict, @files) = @_;
7658     my @serial_loc;
7659     if (ref $where)
7660       {
7661         @serial_loc = (QUEUE_LOCATION, $where->serialize ());
7662       }
7663     else
7664       {
7665         @serial_loc = (QUEUE_STRING, $where);
7666       }
7667     $queue->enqueue ($key, $dir, @serial_loc, $mystrict, 0 + @files, @files);
7670 # &require_queued_file_check_or_copy ($QUEUE)
7671 # -------------------------------------------
7672 sub require_queued_file_check_or_copy ($)
7674     my ($queue) = @_;
7675     my $where;
7676     my $dir = $queue->dequeue ();
7677     my $loc_key = $queue->dequeue ();
7678     if ($loc_key eq QUEUE_LOCATION)
7679       {
7680         $where = Automake::Location::deserialize ($queue);
7681       }
7682     elsif ($loc_key eq QUEUE_STRING)
7683       {
7684         $where = $queue->dequeue ();
7685       }
7686     else
7687       {
7688         prog_error "unexpected key $loc_key";
7689       }
7690     my $mystrict = $queue->dequeue ();
7691     my $nfiles = $queue->dequeue ();
7692     my @files;
7693     push @files, $queue->dequeue ()
7694       foreach (1 .. $nfiles);
7695     return
7696       unless $strictness >= $mystrict;
7697     foreach my $file (@files)
7698       {
7699         required_file_check_or_copy ($where, $config_aux_dir, $file);
7700       }
7703 # &require_conf_file ($WHERE, $MYSTRICT, @FILES)
7704 # ----------------------------------------------
7705 # Looks in configuration path, as specified by AC_CONFIG_AUX_DIR.
7706 sub require_conf_file ($$@)
7708     my ($where, $mystrict, @files) = @_;
7709     my $queue = defined $required_conf_file_queue ? 1 : 0;
7710     require_file_internal ($where, $mystrict, $config_aux_dir,
7711                            $queue, @files);
7715 # &require_conf_file_with_macro ($COND, $MACRO, $MYSTRICT, @FILES)
7716 # ----------------------------------------------------------------
7717 sub require_conf_file_with_macro ($$$@)
7719     my ($cond, $macro, $mystrict, @files) = @_;
7720     require_conf_file (rvar ($macro)->rdef ($cond)->location,
7721                        $mystrict, @files);
7724 ################################################################
7726 # &require_build_directory ($DIRECTORY)
7727 # -------------------------------------
7728 # Emit rules to create $DIRECTORY if needed, and return
7729 # the file that any target requiring this directory should be made
7730 # dependent upon.
7731 # We don't want to emit the rule twice, and want to reuse it
7732 # for directories with equivalent names (e.g., 'foo/bar' and './foo//bar').
7733 sub require_build_directory ($)
7735   my $directory = shift;
7737   return $directory_map{$directory} if exists $directory_map{$directory};
7739   my $cdir = File::Spec->canonpath ($directory);
7741   if (exists $directory_map{$cdir})
7742     {
7743       my $stamp = $directory_map{$cdir};
7744       $directory_map{$directory} = $stamp;
7745       return $stamp;
7746     }
7748   my $dirstamp = "$cdir/\$(am__dirstamp)";
7750   $directory_map{$directory} = $dirstamp;
7751   $directory_map{$cdir} = $dirstamp;
7753   # Set a variable for the dirstamp basename.
7754   define_pretty_variable ('am__dirstamp', TRUE, INTERNAL,
7755                           '$(am__leading_dot)dirstamp');
7757   # Directory must be removed by 'make distclean'.
7758   $clean_files{$dirstamp} = DIST_CLEAN;
7760   $output_rules .= ("$dirstamp:\n"
7761                     . "\t\@\$(MKDIR_P) $directory\n"
7762                     . "\t\@: > $dirstamp\n");
7764   return $dirstamp;
7767 # &require_build_directory_maybe ($FILE)
7768 # --------------------------------------
7769 # If $FILE lies in a subdirectory, emit a rule to create this
7770 # directory and return the file that $FILE should be made
7771 # dependent upon.  Otherwise, just return the empty string.
7772 sub require_build_directory_maybe ($)
7774     my $file = shift;
7775     my $directory = dirname ($file);
7777     if ($directory ne '.')
7778     {
7779         return require_build_directory ($directory);
7780     }
7781     else
7782     {
7783         return '';
7784     }
7787 ################################################################
7789 # Push a list of files onto dist_common.
7790 sub push_dist_common
7792   prog_error "push_dist_common run after handle_dist"
7793     if $handle_dist_run;
7794   Automake::Variable::define ('DIST_COMMON', VAR_AUTOMAKE, '+', TRUE, "@_",
7795                               '', INTERNAL, VAR_PRETTY);
7799 ################################################################
7801 # generate_makefile ($MAKEFILE_AM, $MAKEFILE_IN)
7802 # ----------------------------------------------
7803 # Generate a Makefile.in given the name of the corresponding Makefile and
7804 # the name of the file output by config.status.
7805 sub generate_makefile ($$)
7807   my ($makefile_am, $makefile_in) = @_;
7809   # Reset all the Makefile.am related variables.
7810   initialize_per_input;
7812   # AUTOMAKE_OPTIONS can contains -W flags to disable or enable
7813   # warnings for this file.  So hold any warning issued before
7814   # we have processed AUTOMAKE_OPTIONS.
7815   buffer_messages ('warning');
7817   # $OUTPUT is encoded.  If it contains a ":" then the first element
7818   # is the real output file, and all remaining elements are input
7819   # files.  We don't scan or otherwise deal with these input files,
7820   # other than to mark them as dependencies.  See
7821   # &scan_autoconf_files for details.
7822   my ($makefile, @inputs) = split (/:/, $output_files{$makefile_in});
7824   $relative_dir = dirname ($makefile);
7826   read_main_am_file ($makefile_am, $makefile_in);
7827   if (handle_options)
7828     {
7829       # Process buffered warnings.
7830       flush_messages;
7831       # Fatal error.  Just return, so we can continue with next file.
7832       return;
7833     }
7834   # Process buffered warnings.
7835   flush_messages;
7837   # There are a few install-related variables that you should not define.
7838   foreach my $var ('PRE_INSTALL', 'POST_INSTALL', 'NORMAL_INSTALL')
7839     {
7840       my $v = var $var;
7841       if ($v)
7842         {
7843           my $def = $v->def (TRUE);
7844           prog_error "$var not defined in condition TRUE"
7845             unless $def;
7846           reject_var $var, "'$var' should not be defined"
7847             if $def->owner != VAR_AUTOMAKE;
7848         }
7849     }
7851   # Catch some obsolete variables.
7852   msg_var ('obsolete', 'INCLUDES',
7853            "'INCLUDES' is the old name for 'AM_CPPFLAGS' (or '*_CPPFLAGS')")
7854     if var ('INCLUDES');
7856   # Must do this after reading .am file.
7857   define_variable ('subdir', $relative_dir, INTERNAL);
7859   # If DIST_SUBDIRS is defined, make sure SUBDIRS is, so that
7860   # recursive rules are enabled.
7861   define_pretty_variable ('SUBDIRS', TRUE, INTERNAL, '')
7862     if var 'DIST_SUBDIRS' && ! var 'SUBDIRS';
7864   # Check first, because we might modify some state.
7865   check_gnu_standards;
7866   check_gnits_standards;
7868   handle_configure ($makefile_am, $makefile_in, $makefile, @inputs);
7869   handle_gettext;
7870   handle_libraries;
7871   handle_ltlibraries;
7872   handle_programs;
7873   handle_scripts;
7875   handle_silent;
7877   # These must be run after all the sources are scanned.  They
7878   # use variables defined by &handle_libraries, &handle_ltlibraries,
7879   # or &handle_programs.
7880   handle_compile;
7881   handle_languages;
7882   handle_libtool;
7884   # Variables used by distdir.am and tags.am.
7885   define_pretty_variable ('SOURCES', TRUE, INTERNAL, @sources);
7886   if (! option 'no-dist')
7887     {
7888       define_pretty_variable ('DIST_SOURCES', TRUE, INTERNAL, @dist_sources);
7889     }
7891   handle_texinfo;
7892   handle_emacs_lisp;
7893   handle_python;
7894   handle_java;
7895   handle_man_pages;
7896   handle_data;
7897   handle_headers;
7898   handle_subdirs;
7899   handle_user_recursion;
7900   handle_tags;
7901   handle_minor_options;
7902   # Must come after handle_programs so that %known_programs is up-to-date.
7903   handle_tests;
7905   # This must come after most other rules.
7906   handle_dist;
7908   handle_footer;
7909   do_check_merge_target;
7910   handle_all ($makefile);
7912   # FIXME: Gross!
7913   if (var ('lib_LTLIBRARIES') && var ('bin_PROGRAMS'))
7914     {
7915       $output_rules .= "install-binPROGRAMS: install-libLTLIBRARIES\n\n";
7916     }
7917   if (var ('nobase_lib_LTLIBRARIES') && var ('bin_PROGRAMS'))
7918     {
7919       $output_rules .= "install-binPROGRAMS: install-nobase_libLTLIBRARIES\n\n";
7920     }
7922   handle_install;
7923   handle_clean ($makefile);
7924   handle_factored_dependencies;
7926   # Comes last, because all the above procedures may have
7927   # defined or overridden variables.
7928   $output_vars .= output_variables;
7930   check_typos;
7932   if ($exit_code != 0)
7933     {
7934       verb "not writing $makefile_in because of earlier errors";
7935       return;
7936     }
7938   my $am_relative_dir = dirname ($makefile_am);
7939   mkdir ($am_relative_dir, 0755) if ! -d $am_relative_dir;
7941   # We make sure that 'all:' is the first target.
7942   my $output =
7943     "$output_vars$output_all$output_header$output_rules$output_trailer";
7945   # Decide whether we must update the output file or not.
7946   # We have to update in the following situations.
7947   #  * $force_generation is set.
7948   #  * any of the output dependencies is younger than the output
7949   #  * the contents of the output is different (this can happen
7950   #    if the project has been populated with a file listed in
7951   #    @common_files since the last run).
7952   # Output's dependencies are split in two sets:
7953   #  * dependencies which are also configure dependencies
7954   #    These do not change between each Makefile.am
7955   #  * other dependencies, specific to the Makefile.am being processed
7956   #    (such as the Makefile.am itself, or any Makefile fragment
7957   #    it includes).
7958   my $timestamp = mtime $makefile_in;
7959   if (! $force_generation
7960       && $configure_deps_greatest_timestamp < $timestamp
7961       && $output_deps_greatest_timestamp < $timestamp
7962       && $output eq contents ($makefile_in))
7963     {
7964       verb "$makefile_in unchanged";
7965       # No need to update.
7966       return;
7967     }
7969   if (-e $makefile_in)
7970     {
7971       unlink ($makefile_in)
7972         or fatal "cannot remove $makefile_in: $!";
7973     }
7975   my $gm_file = new Automake::XFile "> $makefile_in";
7976   verb "creating $makefile_in";
7977   print $gm_file $output;
7980 ################################################################
7985 ################################################################
7987 # Helper function for usage().
7988 sub print_autodist_files (@)
7990   my @lcomm = sort (&uniq (@_));
7992   my @four;
7993   format USAGE_FORMAT =
7994   @<<<<<<<<<<<<<<<<   @<<<<<<<<<<<<<<<<   @<<<<<<<<<<<<<<<<   @<<<<<<<<<<<<<<<<
7995   $four[0],           $four[1],           $four[2],           $four[3]
7997   local $~ = "USAGE_FORMAT";
7999   my $cols = 4;
8000   my $rows = int(@lcomm / $cols);
8001   my $rest = @lcomm % $cols;
8003   if ($rest)
8004     {
8005       $rows++;
8006     }
8007   else
8008     {
8009       $rest = $cols;
8010     }
8012   for (my $y = 0; $y < $rows; $y++)
8013     {
8014       @four = ("", "", "", "");
8015       for (my $x = 0; $x < $cols; $x++)
8016         {
8017           last if $y + 1 == $rows && $x == $rest;
8019           my $idx = (($x > $rest)
8020                ?  ($rows * $rest + ($rows - 1) * ($x - $rest))
8021                : ($rows * $x));
8023           $idx += $y;
8024           $four[$x] = $lcomm[$idx];
8025         }
8026       write;
8027     }
8031 # Print usage information.
8032 sub usage ()
8034     print "Usage: $0 [OPTION]... [Makefile]...
8036 Generate Makefile.in for configure from Makefile.am.
8038 Operation modes:
8039       --help               print this help, then exit
8040       --version            print version number, then exit
8041   -v, --verbose            verbosely list files processed
8042       --no-force           only update Makefile.in's that are out of date
8043   -W, --warnings=CATEGORY  report the warnings falling in CATEGORY
8045 Dependency tracking:
8046   -i, --ignore-deps      disable dependency tracking code
8047       --include-deps     enable dependency tracking code
8049 Flavors:
8050       --foreign          set strictness to foreign
8051       --gnits            set strictness to gnits
8052       --gnu              set strictness to gnu
8054 Library files:
8055   -a, --add-missing      add missing standard files to package
8056       --libdir=DIR       set directory storing library files
8057       --print-libdir     print directory storing library files
8058   -c, --copy             with -a, copy missing files (default is symlink)
8059   -f, --force-missing    force update of standard files
8062     Automake::ChannelDefs::usage;
8064     print "\nFiles automatically distributed if found " .
8065           "(always):\n";
8066     print_autodist_files @common_files;
8067     print "\nFiles automatically distributed if found " .
8068           "(under certain conditions):\n";
8069     print_autodist_files @common_sometimes;
8071     print '
8072 Report bugs to <@PACKAGE_BUGREPORT@>.
8073 GNU Automake home page: <@PACKAGE_URL@>.
8074 General help using GNU software: <http://www.gnu.org/gethelp/>.
8077     # --help always returns 0 per GNU standards.
8078     exit 0;
8082 # &version ()
8083 # -----------
8084 # Print version information
8085 sub version ()
8087   print <<EOF;
8088 automake (GNU $PACKAGE) $VERSION
8089 Copyright (C) $RELEASE_YEAR Free Software Foundation, Inc.
8090 License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl-2.0.html>
8091 This is free software: you are free to change and redistribute it.
8092 There is NO WARRANTY, to the extent permitted by law.
8094 Written by Tom Tromey <tromey\@redhat.com>
8095        and Alexandre Duret-Lutz <adl\@gnu.org>.
8097   # --version always returns 0 per GNU standards.
8098   exit 0;
8101 ################################################################
8103 # Parse command line.
8104 sub parse_arguments ()
8106   my $strict = 'gnu';
8107   my $ignore_deps = 0;
8108   my @warnings = ();
8110   my %cli_options =
8111     (
8112      'version' => \&version,
8113      'help'    => \&usage,
8114      'libdir=s' => \$libdir,
8115      'print-libdir'     => sub { print "$libdir\n"; exit 0; },
8116      'gnu'              => sub { $strict = 'gnu'; },
8117      'gnits'            => sub { $strict = 'gnits'; },
8118      'foreign'          => sub { $strict = 'foreign'; },
8119      'include-deps'     => sub { $ignore_deps = 0; },
8120      'i|ignore-deps'    => sub { $ignore_deps = 1; },
8121      'no-force' => sub { $force_generation = 0; },
8122      'f|force-missing'  => \$force_missing,
8123      'a|add-missing'    => \$add_missing,
8124      'c|copy'           => \$copy_missing,
8125      'v|verbose'        => sub { setup_channel 'verb', silent => 0; },
8126      'W|warnings=s'     => \@warnings,
8127      );
8129   use Automake::Getopt ();
8130   Automake::Getopt::parse_options %cli_options;
8132   set_strictness ($strict);
8133   my $cli_where = new Automake::Location;
8134   set_global_option ('no-dependencies', $cli_where) if $ignore_deps;
8135   for my $warning (@warnings)
8136     {
8137       &parse_warnings ('-W', $warning);
8138     }
8140   return unless @ARGV;
8142   my $errspec = 0;
8143   foreach my $arg (@ARGV)
8144     {
8145       fatal ("empty argument\nTry '$0 --help' for more information")
8146         if ($arg eq '');
8148       # Handle $local:$input syntax.
8149       my ($local, @rest) = split (/:/, $arg);
8150       @rest = ("$local.in",) unless @rest;
8151       my $input = locate_am @rest;
8152       if ($input)
8153         {
8154           push @input_files, $input;
8155           $output_files{$input} = join (':', ($local, @rest));
8156         }
8157       else
8158         {
8159           error "no Automake input file found for '$arg'";
8160           $errspec = 1;
8161         }
8162     }
8163   fatal "no input file found among supplied arguments"
8164     if $errspec && ! @input_files;
8168 # handle_makefile ($MAKEFILE_IN)
8169 # ------------------------------
8170 # Deal with $MAKEFILE_IN.
8171 sub handle_makefile ($)
8173   my ($file) =  @_;
8174   ($am_file = $file) =~ s/\.in$//;
8175   if (! -f ($am_file . '.am'))
8176     {
8177       error "'$am_file.am' does not exist";
8178     }
8179   else
8180     {
8181       # Any warning setting now local to this Makefile.am.
8182       dup_channel_setup;
8184       generate_makefile ($am_file . '.am', $file);
8186       # Back out any warning setting.
8187       drop_channel_setup;
8188     }
8191 # handle_makefiles_serial ()
8192 # --------------------------
8193 # Deal with all makefiles, without threads.
8194 sub handle_makefiles_serial ()
8196   foreach my $file (@input_files)
8197     {
8198       handle_makefile ($file);
8199     }
8202 # get_number_of_threads ()
8203 # ------------------------
8204 # Logic for deciding how many worker threads to use.
8205 sub get_number_of_threads
8207   my $nthreads = $ENV{'AUTOMAKE_JOBS'} || 0;
8209   $nthreads = 0
8210     unless $nthreads =~ /^[0-9]+$/;
8212   # It doesn't make sense to use more threads than makefiles,
8213   my $max_threads = @input_files;
8215   if ($nthreads > $max_threads)
8216     {
8217       $nthreads = $max_threads;
8218     }
8219   return $nthreads;
8222 # handle_makefiles_threaded ($NTHREADS)
8223 # -------------------------------------
8224 # Deal with all makefiles, using threads.  The general strategy is to
8225 # spawn NTHREADS worker threads, dispatch makefiles to them, and let the
8226 # worker threads push back everything that needs serialization:
8227 # * warning and (normal) error messages, for stable stderr output
8228 #   order and content (avoiding duplicates, for example),
8229 # * races when installing aux files (and respective messages),
8230 # * races when collecting aux files for distribution.
8232 # The latter requires that the makefile that deals with the aux dir
8233 # files be handled last, done by the master thread.
8234 sub handle_makefiles_threaded ($)
8236   my ($nthreads) = @_;
8238   # The file queue distributes all makefiles, the message queues
8239   # collect all serializations needed for respective files.
8240   my $file_queue = Thread::Queue->new;
8241   my %msg_queues;
8242   foreach my $file (@input_files)
8243     {
8244       $msg_queues{$file} = Thread::Queue->new;
8245     }
8247   verb "spawning $nthreads worker threads";
8248   my @threads = (1 .. $nthreads);
8249   foreach my $t (@threads)
8250     {
8251       $t = threads->new (sub
8252         {
8253           while (my $file = $file_queue->dequeue)
8254             {
8255               verb "handling $file";
8256               my $queue = $msg_queues{$file};
8257               setup_channel_queue ($queue, QUEUE_MESSAGE);
8258               $required_conf_file_queue = $queue;
8259               handle_makefile ($file);
8260               $queue->enqueue (undef);
8261               setup_channel_queue (undef, undef);
8262               $required_conf_file_queue = undef;
8263             }
8264           return $exit_code;
8265         });
8266     }
8268   # Queue all makefiles.
8269   verb "queuing " . @input_files . " input files";
8270   $file_queue->enqueue (@input_files, (undef) x @threads);
8272   # Collect and process serializations.
8273   foreach my $file (@input_files)
8274     {
8275       verb "dequeuing messages for " . $file;
8276       reset_local_duplicates ();
8277       my $queue = $msg_queues{$file};
8278       while (my $key = $queue->dequeue)
8279         {
8280           if ($key eq QUEUE_MESSAGE)
8281             {
8282               pop_channel_queue ($queue);
8283             }
8284           elsif ($key eq QUEUE_CONF_FILE)
8285             {
8286               require_queued_file_check_or_copy ($queue);
8287             }
8288           else
8289             {
8290               prog_error "unexpected key $key";
8291             }
8292         }
8293     }
8295   foreach my $t (@threads)
8296     {
8297       my @exit_thread = $t->join;
8298       $exit_code = $exit_thread[0]
8299         if ($exit_thread[0] > $exit_code);
8300     }
8303 ################################################################
8305 # Parse the WARNINGS environment variable.
8306 parse_WARNINGS;
8308 # Parse command line.
8309 parse_arguments;
8311 $configure_ac = require_configure_ac;
8313 # Do configure.ac scan only once.
8314 scan_autoconf_files;
8316 if (! @input_files)
8317   {
8318     my $msg = '';
8319     $msg = "\nDid you forget AC_CONFIG_FILES([Makefile]) in $configure_ac?"
8320       if -f 'Makefile.am';
8321     fatal ("no 'Makefile.am' found for any configure output$msg");
8322   }
8324 my $nthreads = get_number_of_threads ();
8326 if ($perl_threads && $nthreads >= 1)
8327   {
8328     handle_makefiles_threaded ($nthreads);
8329   }
8330 else
8331   {
8332     handle_makefiles_serial ();
8333   }
8335 exit $exit_code;
8338 ### Setup "GNU" style for perl-mode and cperl-mode.
8339 ## Local Variables:
8340 ## perl-indent-level: 2
8341 ## perl-continued-statement-offset: 2
8342 ## perl-continued-brace-offset: 0
8343 ## perl-brace-offset: 0
8344 ## perl-brace-imaginary-offset: 0
8345 ## perl-label-offset: -2
8346 ## cperl-indent-level: 2
8347 ## cperl-brace-offset: 0
8348 ## cperl-continued-brace-offset: 0
8349 ## cperl-label-offset: -2
8350 ## cperl-extra-newline-before-brace: t
8351 ## cperl-merge-trailing-else: nil
8352 ## cperl-continued-statement-offset: 2
8353 ## End: