Merge branch 'maint'
[automake.git] / automake.in
blob32389f4ae00b81ef3c9111a9fefc448d9f5eba68
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   my $perllibdir = $ENV{'perllibdir'} || '@datadir@/@PACKAGE@-@APIVERSION@';
33   unshift @INC, (split '@PATH_SEPARATOR@', $perllibdir);
35   # Override SHELL.  This is required on DJGPP so that system() uses
36   # bash, not COMMAND.COM which doesn't quote arguments properly.
37   # Other systems aren't expected to use $SHELL when Automake
38   # runs, but it should be safe to drop the "if DJGPP" guard if
39   # it turns up other systems need the same thing.  After all,
40   # if SHELL is used, ./configure's SHELL is always better than
41   # the user's SHELL (which may be something like tcsh).
42   $ENV{'SHELL'} = '@SHELL@' if exists $ENV{'DJDIR'};
45 use Class::Struct ();
46 Class::Struct::struct (
47         # Short name of the language (c, f77...).
48         'name' => "\$",
49         # Nice name of the language (C, Fortran 77...).
50         'Name' => "\$",
52         # List of configure variables which must be defined.
53         'config_vars' => '@',
55         # 'pure' is '1' or ''.  A 'pure' language is one where, if
56         # all the files in a directory are of that language, then we
57         # do not require the C compiler or any code to call it.
58         'pure'   => "\$",
60         'autodep' => "\$",
62         # Name of the compiling variable (COMPILE).
63         'compiler'  => "\$",
64         # Content of the compiling variable.
65         'compile'  => "\$",
66         # Flag to require compilation without linking (-c).
67         'compile_flag' => "\$",
68         'extensions' => '@',
69         # A subroutine to compute a list of possible extensions of
70         # the product given the input extensions.
71         # (defaults to a subroutine which returns ('.$(OBJEXT)', '.lo'))
72         'output_extensions' => "\$",
73         # A list of flag variables used in 'compile'.
74         # (defaults to [])
75         'flags' => "@",
77         # Any tag to pass to libtool while compiling.
78         'libtool_tag' => "\$",
80         # The file to use when generating rules for this language.
81         # The default is 'depend2'.
82         'rule_file' => "\$",
84         # Name of the linking variable (LINK).
85         'linker' => "\$",
86         # Content of the linking variable.
87         'link' => "\$",
89         # Name of the compiler variable (CC).
90         'ccer' => "\$",
92         # Name of the linker variable (LD).
93         'lder' => "\$",
94         # Content of the linker variable ($(CC)).
95         'ld' => "\$",
97         # Flag to specify the output file (-o).
98         'output_flag' => "\$",
99         '_finish' => "\$",
101         # This is a subroutine which is called whenever we finally
102         # determine the context in which a source file will be
103         # compiled.
104         '_target_hook' => "\$",
106         # If TRUE, nodist_ sources will be compiled using specific rules
107         # (i.e. not inference rules).  The default is FALSE.
108         'nodist_specific' => "\$");
111 sub finish ($)
113   my ($self) = @_;
114   if (defined $self->_finish)
115     {
116       &{$self->_finish} (@_);
117     }
120 sub target_hook ($$$$%)
122     my ($self) = @_;
123     if (defined $self->_target_hook)
124     {
125         &{$self->_target_hook} (@_);
126     }
129 package Automake;
131 use strict;
132 use Automake::Config;
133 BEGIN
135   if ($perl_threads)
136     {
137       require threads;
138       import threads;
139       require Thread::Queue;
140       import Thread::Queue;
141     }
143 use Automake::General;
144 use Automake::XFile;
145 use Automake::Channels;
146 use Automake::ChannelDefs;
147 use Automake::Configure_ac;
148 use Automake::FileUtils;
149 use Automake::Location;
150 use Automake::Condition qw/TRUE FALSE/;
151 use Automake::DisjConditions;
152 use Automake::Options;
153 use Automake::Variable;
154 use Automake::VarDef;
155 use Automake::Rule;
156 use Automake::RuleDef;
157 use Automake::Wrap 'makefile_wrap';
158 use File::Basename;
159 use File::Spec;
160 use Carp;
162 ## ----------- ##
163 ## Constants.  ##
164 ## ----------- ##
166 # Some regular expressions.  One reason to put them here is that it
167 # makes indentation work better in Emacs.
169 # Writing singled-quoted-$-terminated regexes is a pain because
170 # perl-mode thinks of $' as the ${'} variable (instead of a $ followed
171 # by a closing quote.  Letting perl-mode think the quote is not closed
172 # leads to all sort of misindentations.  On the other hand, defining
173 # regexes as double-quoted strings is far less readable.  So usually
174 # we will write:
176 #  $REGEX = '^regex_value' . "\$";
178 my $IGNORE_PATTERN = '^\s*##([^#\n].*)?\n';
179 my $WHITE_PATTERN = '^\s*' . "\$";
180 my $COMMENT_PATTERN = '^#';
181 my $TARGET_PATTERN='[$a-zA-Z0-9_.@%][-.a-zA-Z0-9_(){}/$+@%]*';
182 # A rule has three parts: a list of targets, a list of dependencies,
183 # and optionally actions.
184 my $RULE_PATTERN =
185   "^($TARGET_PATTERN(?:(?:\\\\\n|\\s)+$TARGET_PATTERN)*) *:([^=].*|)\$";
187 # Only recognize leading spaces, not leading tabs.  If we recognize
188 # leading tabs here then we need to make the reader smarter, because
189 # otherwise it will think rules like 'foo=bar; \' are errors.
190 my $ASSIGNMENT_PATTERN = '^ *([^ \t=:+]*)\s*([:+]?)=\s*(.*)' . "\$";
191 # This pattern recognizes a Gnits version id and sets $1 if the
192 # release is an alpha release.  We also allow a suffix which can be
193 # used to extend the version number with a "fork" identifier.
194 my $GNITS_VERSION_PATTERN = '\d+\.\d+([a-z]|\.\d+)?(-[A-Za-z0-9]+)?';
196 my $IF_PATTERN = '^if\s+(!?)\s*([A-Za-z][A-Za-z0-9_]*)\s*(?:#.*)?' . "\$";
197 my $ELSE_PATTERN =
198   '^else(?:\s+(!?)\s*([A-Za-z][A-Za-z0-9_]*))?\s*(?:#.*)?' . "\$";
199 my $ENDIF_PATTERN =
200   '^endif(?:\s+(!?)\s*([A-Za-z][A-Za-z0-9_]*))?\s*(?:#.*)?' . "\$";
201 my $PATH_PATTERN = '(\w|[+/.-])+';
202 # This will pass through anything not of the prescribed form.
203 my $INCLUDE_PATTERN = ('^include\s+'
204                        . '((\$\(top_srcdir\)/' . $PATH_PATTERN . ')'
205                        . '|(\$\(srcdir\)/' . $PATH_PATTERN . ')'
206                        . '|([^/\$]' . $PATH_PATTERN . '))\s*(#.*)?' . "\$");
208 # Directories installed during 'install-exec' phase.
209 my $EXEC_DIR_PATTERN =
210   '^(?:bin|sbin|libexec|sysconf|localstate|lib|pkglib|.*exec.*)' . "\$";
212 # Values for AC_CANONICAL_*
213 use constant AC_CANONICAL_BUILD  => 1;
214 use constant AC_CANONICAL_HOST   => 2;
215 use constant AC_CANONICAL_TARGET => 3;
217 # Values indicating when something should be cleaned.
218 use constant MOSTLY_CLEAN     => 0;
219 use constant CLEAN            => 1;
220 use constant DIST_CLEAN       => 2;
221 use constant MAINTAINER_CLEAN => 3;
223 # Libtool files.
224 my @libtool_files = qw(ltmain.sh config.guess config.sub);
225 # ltconfig appears here for compatibility with old versions of libtool.
226 my @libtool_sometimes = qw(ltconfig ltcf-c.sh ltcf-cxx.sh ltcf-gcj.sh);
228 # Commonly found files we look for and automatically include in
229 # DISTFILES.
230 my @common_files =
231     (qw(ABOUT-GNU ABOUT-NLS AUTHORS BACKLOG COPYING COPYING.DOC COPYING.LIB
232         COPYING.LESSER ChangeLog INSTALL NEWS README THANKS TODO
233         ar-lib compile config.guess config.rpath
234         config.sub depcomp install-sh libversion.in mdate-sh
235         missing mkinstalldirs py-compile texinfo.tex ylwrap),
236      @libtool_files, @libtool_sometimes);
238 # Commonly used files we auto-include, but only sometimes.  This list
239 # is used for the --help output only.
240 my @common_sometimes =
241   qw(aclocal.m4 acconfig.h config.h.top config.h.bot configure
242      configure.ac configure.in stamp-vti);
244 # Standard directories from the GNU Coding Standards, and additional
245 # pkg* directories from Automake.  Stored in a hash for fast member check.
246 my %standard_prefix =
247     map { $_ => 1 } (qw(bin data dataroot doc dvi exec html include info
248                         lib libexec lisp locale localstate man man1 man2
249                         man3 man4 man5 man6 man7 man8 man9 oldinclude pdf
250                         pkgdata pkginclude pkglib pkglibexec ps sbin
251                         sharedstate sysconf));
253 # Copyright on generated Makefile.ins.
254 my $gen_copyright = "\
255 # Copyright (C) 1994-$RELEASE_YEAR Free Software Foundation, Inc.
257 # This Makefile.in is free software; the Free Software Foundation
258 # gives unlimited permission to copy and/or distribute it,
259 # with or without modifications, as long as this notice is preserved.
261 # This program is distributed in the hope that it will be useful,
262 # but WITHOUT ANY WARRANTY, to the extent permitted by law; without
263 # even the implied warranty of MERCHANTABILITY or FITNESS FOR A
264 # PARTICULAR PURPOSE.
267 # These constants are returned by the lang_*_rewrite functions.
268 # LANG_SUBDIR means that the resulting object file should be in a
269 # subdir if the source file is.  In this case the file name cannot
270 # have '..' components.
271 use constant LANG_IGNORE  => 0;
272 use constant LANG_PROCESS => 1;
273 use constant LANG_SUBDIR  => 2;
275 # These are used when keeping track of whether an object can be built
276 # by two different paths.
277 use constant COMPILE_LIBTOOL  => 1;
278 use constant COMPILE_ORDINARY => 2;
280 # We can't always associate a location to a variable or a rule,
281 # when it's defined by Automake.  We use INTERNAL in this case.
282 use constant INTERNAL => new Automake::Location;
284 # Serialization keys for message queues.
285 use constant QUEUE_MESSAGE   => "msg";
286 use constant QUEUE_CONF_FILE => "conf file";
287 use constant QUEUE_LOCATION  => "location";
288 use constant QUEUE_STRING    => "string";
290 ## ---------------------------------- ##
291 ## Variables related to the options.  ##
292 ## ---------------------------------- ##
294 # TRUE if we should always generate Makefile.in.
295 my $force_generation = 1;
297 # From the Perl manual.
298 my $symlink_exists = (eval 'symlink ("", "");', $@ eq '');
300 # TRUE if missing standard files should be installed.
301 my $add_missing = 0;
303 # TRUE if we should copy missing files; otherwise symlink if possible.
304 my $copy_missing = 0;
306 # TRUE if we should always update files that we know about.
307 my $force_missing = 0;
310 ## ---------------------------------------- ##
311 ## Variables filled during files scanning.  ##
312 ## ---------------------------------------- ##
314 # Name of the configure.ac file.
315 my $configure_ac;
317 # Files found by scanning configure.ac for LIBOBJS.
318 my %libsources = ();
320 # Names used in AC_CONFIG_HEADER call.
321 my @config_headers = ();
323 # Names used in AC_CONFIG_LINKS call.
324 my @config_links = ();
326 # List of Makefile.am's to process, and their corresponding outputs.
327 my @input_files = ();
328 my %output_files = ();
330 # Complete list of Makefile.am's that exist.
331 my @configure_input_files = ();
333 # List of files in AC_CONFIG_FILES/AC_OUTPUT without Makefile.am's,
334 # and their outputs.
335 my @other_input_files = ();
336 # Where each AC_CONFIG_FILES/AC_OUTPUT/AC_CONFIG_LINK/AC_CONFIG_HEADER appears.
337 # The keys are the files created by these macros.
338 my %ac_config_files_location = ();
339 # The condition under which AC_CONFIG_FOOS appears.
340 my %ac_config_files_condition = ();
342 # Directory to search for configure-required files.  This
343 # will be computed by &locate_aux_dir and can be set using
344 # AC_CONFIG_AUX_DIR in configure.ac.
345 # $CONFIG_AUX_DIR is the 'raw' directory, valid only in the source-tree.
346 my $config_aux_dir = '';
347 my $config_aux_dir_set_in_configure_ac = 0;
348 # $AM_CONFIG_AUX_DIR is prefixed with $(top_srcdir), so it can be used
349 # in Makefiles.
350 my $am_config_aux_dir = '';
352 # Directory to search for AC_LIBSOURCE files, as set by AC_CONFIG_LIBOBJ_DIR
353 # in configure.ac.
354 my $config_libobj_dir = '';
356 # Whether AM_GNU_GETTEXT has been seen in configure.ac.
357 my $seen_gettext = 0;
358 # Whether AM_GNU_GETTEXT([external]) is used.
359 my $seen_gettext_external = 0;
360 # Where AM_GNU_GETTEXT appears.
361 my $ac_gettext_location;
362 # Whether AM_GNU_GETTEXT_INTL_SUBDIR has been seen.
363 my $seen_gettext_intl = 0;
365 # The arguments of the AM_EXTRA_RECURSIVE_TARGETS call (if any).
366 my @extra_recursive_targets = ();
368 # Lists of tags supported by Libtool.
369 my %libtool_tags = ();
370 # 1 if Libtool uses LT_SUPPORTED_TAG.  If it does, then it also
371 # uses AC_REQUIRE_AUX_FILE.
372 my $libtool_new_api = 0;
374 # Most important AC_CANONICAL_* macro seen so far.
375 my $seen_canonical = 0;
377 # Where AM_MAINTAINER_MODE appears.
378 my $seen_maint_mode;
380 # Actual version we've seen.
381 my $package_version = '';
383 # Where version is defined.
384 my $package_version_location;
386 # TRUE if we've seen AM_PROG_AR
387 my $seen_ar = 0;
389 # TRUE if we've seen AM_PROG_CC_C_O
390 my $seen_cc_c_o = 0;
392 # Location of AC_REQUIRE_AUX_FILE calls, indexed by their argument.
393 my %required_aux_file = ();
395 # Where AM_INIT_AUTOMAKE is called;
396 my $seen_init_automake = 0;
398 # TRUE if we've seen AM_AUTOMAKE_VERSION.
399 my $seen_automake_version = 0;
401 # Hash table of discovered configure substitutions.  Keys are names,
402 # values are 'FILE:LINE' strings which are used by error message
403 # generation.
404 my %configure_vars = ();
406 # Ignored configure substitutions (i.e., variables not to be output in
407 # Makefile.in)
408 my %ignored_configure_vars = ();
410 # Files included by $configure_ac.
411 my @configure_deps = ();
413 # Greatest timestamp of configure's dependencies.
414 my $configure_deps_greatest_timestamp = 0;
416 # Hash table of AM_CONDITIONAL variables seen in configure.
417 my %configure_cond = ();
419 # This maps extensions onto language names.
420 my %extension_map = ();
422 # List of the DIST_COMMON files we discovered while reading
423 # configure.ac.
424 my $configure_dist_common = '';
426 # This maps languages names onto objects.
427 my %languages = ();
428 # Maps each linker variable onto a language object.
429 my %link_languages = ();
431 # maps extensions to needed source flags.
432 my %sourceflags = ();
434 # List of targets we must always output.
435 # FIXME: Complete, and remove falsely required targets.
436 my %required_targets =
437   (
438    'all'          => 1,
439    'dvi'          => 1,
440    'pdf'          => 1,
441    'ps'           => 1,
442    'info'         => 1,
443    'install-info' => 1,
444    'install'      => 1,
445    'install-data' => 1,
446    'install-exec' => 1,
447    'uninstall'    => 1,
449    # FIXME: Not required, temporary hacks.
450    # Well, actually they are sort of required: the -recursive
451    # targets will run them anyway...
452    'html-am'         => 1,
453    'dvi-am'          => 1,
454    'pdf-am'          => 1,
455    'ps-am'           => 1,
456    'info-am'         => 1,
457    'install-data-am' => 1,
458    'install-exec-am' => 1,
459    'install-html-am' => 1,
460    'install-dvi-am'  => 1,
461    'install-pdf-am'  => 1,
462    'install-ps-am'   => 1,
463    'install-info-am' => 1,
464    'installcheck-am' => 1,
465    'uninstall-am'    => 1,
466    'tags-am'         => 1,
467    'ctags-am'        => 1,
468    'cscopelist-am'   => 1,
469    'install-man'     => 1,
470   );
472 # Queue to push require_conf_file requirements to.
473 my $required_conf_file_queue;
475 # The name of the Makefile currently being processed.
476 my $am_file = 'BUG';
478 ################################################################
480 ## ------------------------------------------ ##
481 ## Variables reset by &initialize_per_input.  ##
482 ## ------------------------------------------ ##
484 # Relative dir of the output makefile.
485 my $relative_dir;
487 # Greatest timestamp of the output's dependencies (excluding
488 # configure's dependencies).
489 my $output_deps_greatest_timestamp;
491 # These variables are used when generating each Makefile.in.
492 # They hold the Makefile.in until it is ready to be printed.
493 my $output_vars;
494 my $output_all;
495 my $output_header;
496 my $output_rules;
497 my $output_trailer;
499 # This is the conditional stack, updated on if/else/endif, and
500 # used to build Condition objects.
501 my @cond_stack;
503 # This holds the set of included files.
504 my @include_stack;
506 # List of dependencies for the obvious targets.
507 my @all;
508 my @check;
509 my @check_tests;
511 # Keys in this hash table are files to delete.  The associated
512 # value tells when this should happen (MOSTLY_CLEAN, DIST_CLEAN, etc.)
513 my %clean_files;
515 # Keys in this hash table are object files or other files in
516 # subdirectories which need to be removed.  This only holds files
517 # which are created by compilations.  The value in the hash indicates
518 # when the file should be removed.
519 my %compile_clean_files;
521 # Keys in this hash table are directories where we expect to build a
522 # libtool object.  We use this information to decide what directories
523 # to delete.
524 my %libtool_clean_directories;
526 # Value of $(SOURCES), used by tags.am.
527 my @sources;
528 # Sources which go in the distribution.
529 my @dist_sources;
531 # This hash maps object file names onto their corresponding source
532 # file names.  This is used to ensure that each object is created
533 # by a single source file.
534 my %object_map;
536 # This hash maps object file names onto an integer value representing
537 # whether this object has been built via ordinary compilation or
538 # libtool compilation (the COMPILE_* constants).
539 my %object_compilation_map;
542 # This keeps track of the directories for which we've already
543 # created dirstamp code.  Keys are directories, values are stamp files.
544 # Several keys can share the same stamp files if they are equivalent
545 # (as are './/foo' and 'foo').
546 my %directory_map;
548 # All .P files.
549 my %dep_files;
551 # This is a list of all targets to run during "make dist".
552 my @dist_targets;
554 # Keep track of all programs declared in this Makefile, without
555 # $(EXEEXT).  @substitutions@ are not listed.
556 my %known_programs;
557 my %known_libraries;
559 # This keeps track of which extensions we've seen (that we care
560 # about).
561 my %extension_seen;
563 # This is random scratch space for the language finish functions.
564 # Don't randomly overwrite it; examine other uses of keys first.
565 my %language_scratch;
567 # We keep track of which objects need special (per-executable)
568 # handling on a per-language basis.
569 my %lang_specific_files;
571 # This is set when 'handle_dist' has finished.  Once this happens,
572 # we should no longer push on dist_common.
573 my $handle_dist_run;
575 # Used to store a set of linkers needed to generate the sources currently
576 # under consideration.
577 my %linkers_used;
579 # True if we need 'LINK' defined.  This is a hack.
580 my $need_link;
582 # Does the generated Makefile have to build some compiled object
583 # (for binary programs, or plain or libtool libraries)?
584 my $must_handle_compiled_objects;
586 # Record each file processed by make_paragraphs.
587 my %transformed_files;
589 ################################################################
591 ## ---------------------------------------------- ##
592 ## Variables not reset by &initialize_per_input.  ##
593 ## ---------------------------------------------- ##
595 # Cache each file processed by make_paragraphs.
596 # (This is different from %transformed_files because
597 # %transformed_files is reset for each file while %am_file_cache
598 # it global to the run.)
599 my %am_file_cache;
601 ################################################################
603 # var_SUFFIXES_trigger ($TYPE, $VALUE)
604 # ------------------------------------
605 # This is called by Automake::Variable::define() when SUFFIXES
606 # is defined ($TYPE eq '') or appended ($TYPE eq '+').
607 # The work here needs to be performed as a side-effect of the
608 # macro_define() call because SUFFIXES definitions impact
609 # on $KNOWN_EXTENSIONS_PATTERN which is used used when parsing
610 # the input am file.
611 sub var_SUFFIXES_trigger ($$)
613     my ($type, $value) = @_;
614     accept_extensions (split (' ', $value));
616 Automake::Variable::hook ('SUFFIXES', \&var_SUFFIXES_trigger);
618 ################################################################
620 ## --------------------------------- ##
621 ## Forward subroutine declarations.  ##
622 ## --------------------------------- ##
623 sub register_language (%);
624 sub file_contents_internal ($$$%);
625 sub define_files_variable ($\@$$);
628 # &initialize_per_input ()
629 # ------------------------
630 # (Re)-Initialize per-Makefile.am variables.
631 sub initialize_per_input ()
633     reset_local_duplicates ();
635     $relative_dir = undef;
637     $output_deps_greatest_timestamp = 0;
639     $output_vars = '';
640     $output_all = '';
641     $output_header = '';
642     $output_rules = '';
643     $output_trailer = '';
645     Automake::Options::reset;
646     Automake::Variable::reset;
647     Automake::Rule::reset;
649     @cond_stack = ();
651     @include_stack = ();
653     @all = ();
654     @check = ();
655     @check_tests = ();
657     %clean_files = ();
658     %compile_clean_files = ();
660     # We always include '.'.  This isn't strictly correct.
661     %libtool_clean_directories = ('.' => 1);
663     @sources = ();
664     @dist_sources = ();
666     %object_map = ();
667     %object_compilation_map = ();
669     %directory_map = ();
671     %dep_files = ();
673     @dist_targets = ();
675     %known_programs = ();
676     %known_libraries= ();
678     %extension_seen = ();
680     %language_scratch = ();
682     %lang_specific_files = ();
684     $handle_dist_run = 0;
686     $need_link = 0;
688     $must_handle_compiled_objects = 0;
690     %transformed_files = ();
694 ################################################################
696 # Initialize our list of languages that are internally supported.
698 # C.
699 register_language ('name' => 'c',
700                    'Name' => 'C',
701                    'config_vars' => ['CC'],
702                    'autodep' => '',
703                    'flags' => ['CFLAGS', 'CPPFLAGS'],
704                    'ccer' => 'CC',
705                    'compiler' => 'COMPILE',
706                    'compile' => '$(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)',
707                    'lder' => 'CCLD',
708                    'ld' => '$(CC)',
709                    'linker' => 'LINK',
710                    'link' => '$(CCLD) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
711                    'compile_flag' => '-c',
712                    'libtool_tag' => 'CC',
713                    'extensions' => ['.c']);
715 # C++.
716 register_language ('name' => 'cxx',
717                    'Name' => 'C++',
718                    'config_vars' => ['CXX'],
719                    'linker' => 'CXXLINK',
720                    'link' => '$(CXXLD) $(AM_CXXFLAGS) $(CXXFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
721                    'autodep' => 'CXX',
722                    'flags' => ['CXXFLAGS', 'CPPFLAGS'],
723                    'compile' => '$(CXX) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CXXFLAGS) $(CXXFLAGS)',
724                    'ccer' => 'CXX',
725                    'compiler' => 'CXXCOMPILE',
726                    'compile_flag' => '-c',
727                    'output_flag' => '-o',
728                    'libtool_tag' => 'CXX',
729                    'lder' => 'CXXLD',
730                    'ld' => '$(CXX)',
731                    'pure' => 1,
732                    'extensions' => ['.c++', '.cc', '.cpp', '.cxx', '.C']);
734 # Objective C.
735 register_language ('name' => 'objc',
736                    'Name' => 'Objective C',
737                    'config_vars' => ['OBJC'],
738                    'linker' => 'OBJCLINK',
739                    'link' => '$(OBJCLD) $(AM_OBJCFLAGS) $(OBJCFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
740                    'autodep' => 'OBJC',
741                    'flags' => ['OBJCFLAGS', 'CPPFLAGS'],
742                    'compile' => '$(OBJC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_OBJCFLAGS) $(OBJCFLAGS)',
743                    'ccer' => 'OBJC',
744                    'compiler' => 'OBJCCOMPILE',
745                    'compile_flag' => '-c',
746                    'output_flag' => '-o',
747                    'lder' => 'OBJCLD',
748                    'ld' => '$(OBJC)',
749                    'pure' => 1,
750                    'extensions' => ['.m']);
752 # Objective C++.
753 register_language ('name' => 'objcxx',
754                    'Name' => 'Objective C++',
755                    'config_vars' => ['OBJCXX'],
756                    'linker' => 'OBJCXXLINK',
757                    'link' => '$(OBJCXXLD) $(AM_OBJCXXFLAGS) $(OBJCXXFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
758                    'autodep' => 'OBJCXX',
759                    'flags' => ['OBJCXXFLAGS', 'CPPFLAGS'],
760                    'compile' => '$(OBJCXX) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_OBJCXXFLAGS) $(OBJCXXFLAGS)',
761                    'ccer' => 'OBJCXX',
762                    'compiler' => 'OBJCXXCOMPILE',
763                    'compile_flag' => '-c',
764                    'output_flag' => '-o',
765                    'lder' => 'OBJCXXLD',
766                    'ld' => '$(OBJCXX)',
767                    'pure' => 1,
768                    'extensions' => ['.mm']);
770 # Unified Parallel C.
771 register_language ('name' => 'upc',
772                    'Name' => 'Unified Parallel C',
773                    'config_vars' => ['UPC'],
774                    'linker' => 'UPCLINK',
775                    'link' => '$(UPCLD) $(AM_UPCFLAGS) $(UPCFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
776                    'autodep' => 'UPC',
777                    'flags' => ['UPCFLAGS', 'CPPFLAGS'],
778                    'compile' => '$(UPC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_UPCFLAGS) $(UPCFLAGS)',
779                    'ccer' => 'UPC',
780                    'compiler' => 'UPCCOMPILE',
781                    'compile_flag' => '-c',
782                    'output_flag' => '-o',
783                    'lder' => 'UPCLD',
784                    'ld' => '$(UPC)',
785                    'pure' => 1,
786                    'extensions' => ['.upc']);
788 # Headers.
789 register_language ('name' => 'header',
790                    'Name' => 'Header',
791                    'extensions' => ['.h', '.H', '.hxx', '.h++', '.hh',
792                                     '.hpp', '.inc'],
793                    # No output.
794                    'output_extensions' => sub { return () },
795                    # Nothing to do.
796                    '_finish' => sub { });
798 # Vala
799 register_language ('name' => 'vala',
800                    'Name' => 'Vala',
801                    'config_vars' => ['VALAC'],
802                    'flags' => [],
803                    'compile' => '$(VALAC) $(AM_VALAFLAGS) $(VALAFLAGS)',
804                    'ccer' => 'VALAC',
805                    'compiler' => 'VALACOMPILE',
806                    'extensions' => ['.vala'],
807                    'output_extensions' => sub { (my $ext = $_[0]) =~ s/vala$/c/;
808                                                 return ($ext,) },
809                    'rule_file' => 'vala',
810                    '_finish' => \&lang_vala_finish,
811                    '_target_hook' => \&lang_vala_target_hook,
812                    'nodist_specific' => 1);
814 # Yacc (C & C++).
815 register_language ('name' => 'yacc',
816                    'Name' => 'Yacc',
817                    'config_vars' => ['YACC'],
818                    'flags' => ['YFLAGS'],
819                    'compile' => '$(YACC) $(AM_YFLAGS) $(YFLAGS)',
820                    'ccer' => 'YACC',
821                    'compiler' => 'YACCCOMPILE',
822                    'extensions' => ['.y'],
823                    'output_extensions' => sub { (my $ext = $_[0]) =~ tr/y/c/;
824                                                 return ($ext,) },
825                    'rule_file' => 'yacc',
826                    '_finish' => \&lang_yacc_finish,
827                    '_target_hook' => \&lang_yacc_target_hook,
828                    'nodist_specific' => 1);
829 register_language ('name' => 'yaccxx',
830                    'Name' => 'Yacc (C++)',
831                    'config_vars' => ['YACC'],
832                    'rule_file' => 'yacc',
833                    'flags' => ['YFLAGS'],
834                    'ccer' => 'YACC',
835                    'compiler' => 'YACCCOMPILE',
836                    'compile' => '$(YACC) $(AM_YFLAGS) $(YFLAGS)',
837                    'extensions' => ['.y++', '.yy', '.yxx', '.ypp'],
838                    'output_extensions' => sub { (my $ext = $_[0]) =~ tr/y/c/;
839                                                 return ($ext,) },
840                    '_finish' => \&lang_yacc_finish,
841                    '_target_hook' => \&lang_yacc_target_hook,
842                    'nodist_specific' => 1);
844 # Lex (C & C++).
845 register_language ('name' => 'lex',
846                    'Name' => 'Lex',
847                    'config_vars' => ['LEX'],
848                    'rule_file' => 'lex',
849                    'flags' => ['LFLAGS'],
850                    'compile' => '$(LEX) $(AM_LFLAGS) $(LFLAGS)',
851                    'ccer' => 'LEX',
852                    'compiler' => 'LEXCOMPILE',
853                    'extensions' => ['.l'],
854                    'output_extensions' => sub { (my $ext = $_[0]) =~ tr/l/c/;
855                                                 return ($ext,) },
856                    '_finish' => \&lang_lex_finish,
857                    '_target_hook' => \&lang_lex_target_hook,
858                    'nodist_specific' => 1);
859 register_language ('name' => 'lexxx',
860                    'Name' => 'Lex (C++)',
861                    'config_vars' => ['LEX'],
862                    'rule_file' => 'lex',
863                    'flags' => ['LFLAGS'],
864                    'compile' => '$(LEX) $(AM_LFLAGS) $(LFLAGS)',
865                    'ccer' => 'LEX',
866                    'compiler' => 'LEXCOMPILE',
867                    'extensions' => ['.l++', '.ll', '.lxx', '.lpp'],
868                    'output_extensions' => sub { (my $ext = $_[0]) =~ tr/l/c/;
869                                                 return ($ext,) },
870                    '_finish' => \&lang_lex_finish,
871                    '_target_hook' => \&lang_lex_target_hook,
872                    'nodist_specific' => 1);
874 # Assembler.
875 register_language ('name' => 'asm',
876                    'Name' => 'Assembler',
877                    'config_vars' => ['CCAS', 'CCASFLAGS'],
879                    'flags' => ['CCASFLAGS'],
880                    # Users can set AM_CCASFLAGS to include DEFS, INCLUDES,
881                    # or anything else required.  They can also set CCAS.
882                    # Or simply use Preprocessed Assembler.
883                    'compile' => '$(CCAS) $(AM_CCASFLAGS) $(CCASFLAGS)',
884                    'ccer' => 'CCAS',
885                    'compiler' => 'CCASCOMPILE',
886                    'compile_flag' => '-c',
887                    'output_flag' => '-o',
888                    'extensions' => ['.s']);
890 # Preprocessed Assembler.
891 register_language ('name' => 'cppasm',
892                    'Name' => 'Preprocessed Assembler',
893                    'config_vars' => ['CCAS', 'CCASFLAGS'],
895                    'autodep' => 'CCAS',
896                    'flags' => ['CCASFLAGS', 'CPPFLAGS'],
897                    'compile' => '$(CCAS) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CCASFLAGS) $(CCASFLAGS)',
898                    'ccer' => 'CPPAS',
899                    'compiler' => 'CPPASCOMPILE',
900                    'compile_flag' => '-c',
901                    'output_flag' => '-o',
902                    'extensions' => ['.S', '.sx']);
904 # Fortran 77
905 register_language ('name' => 'f77',
906                    'Name' => 'Fortran 77',
907                    'config_vars' => ['F77'],
908                    'linker' => 'F77LINK',
909                    'link' => '$(F77LD) $(AM_FFLAGS) $(FFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
910                    'flags' => ['FFLAGS'],
911                    'compile' => '$(F77) $(AM_FFLAGS) $(FFLAGS)',
912                    'ccer' => 'F77',
913                    'compiler' => 'F77COMPILE',
914                    'compile_flag' => '-c',
915                    'output_flag' => '-o',
916                    'libtool_tag' => 'F77',
917                    'lder' => 'F77LD',
918                    'ld' => '$(F77)',
919                    'pure' => 1,
920                    'extensions' => ['.f', '.for']);
922 # Fortran
923 register_language ('name' => 'fc',
924                    'Name' => 'Fortran',
925                    'config_vars' => ['FC'],
926                    'linker' => 'FCLINK',
927                    'link' => '$(FCLD) $(AM_FCFLAGS) $(FCFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
928                    'flags' => ['FCFLAGS'],
929                    'compile' => '$(FC) $(AM_FCFLAGS) $(FCFLAGS)',
930                    'ccer' => 'FC',
931                    'compiler' => 'FCCOMPILE',
932                    'compile_flag' => '-c',
933                    'output_flag' => '-o',
934                    'libtool_tag' => 'FC',
935                    'lder' => 'FCLD',
936                    'ld' => '$(FC)',
937                    'pure' => 1,
938                    'extensions' => ['.f90', '.f95', '.f03', '.f08']);
940 # Preprocessed Fortran
941 register_language ('name' => 'ppfc',
942                    'Name' => 'Preprocessed Fortran',
943                    'config_vars' => ['FC'],
944                    'linker' => 'FCLINK',
945                    'link' => '$(FCLD) $(AM_FCFLAGS) $(FCFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
946                    'lder' => 'FCLD',
947                    'ld' => '$(FC)',
948                    'flags' => ['FCFLAGS', 'CPPFLAGS'],
949                    'ccer' => 'PPFC',
950                    'compiler' => 'PPFCCOMPILE',
951                    'compile' => '$(FC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_FCFLAGS) $(FCFLAGS)',
952                    'compile_flag' => '-c',
953                    'output_flag' => '-o',
954                    'libtool_tag' => 'FC',
955                    'pure' => 1,
956                    'extensions' => ['.F90','.F95', '.F03', '.F08']);
958 # Preprocessed Fortran 77
960 # The current support for preprocessing Fortran 77 just involves
961 # passing "$(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS)
962 # $(CPPFLAGS)" as additional flags to the Fortran 77 compiler, since
963 # this is how GNU Make does it; see the "GNU Make Manual, Edition 0.51
964 # for 'make' Version 3.76 Beta" (specifically, from info file
965 # '(make)Catalogue of Rules').
967 # A better approach would be to write an Autoconf test
968 # (i.e. AC_PROG_FPP) for a Fortran 77 preprocessor, because not all
969 # Fortran 77 compilers know how to do preprocessing.  The Autoconf
970 # macro AC_PROG_FPP should test the Fortran 77 compiler first for
971 # preprocessing capabilities, and then fall back on cpp (if cpp were
972 # available).
973 register_language ('name' => 'ppf77',
974                    'Name' => 'Preprocessed Fortran 77',
975                    'config_vars' => ['F77'],
976                    'linker' => 'F77LINK',
977                    'link' => '$(F77LD) $(AM_FFLAGS) $(FFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
978                    'lder' => 'F77LD',
979                    'ld' => '$(F77)',
980                    'flags' => ['FFLAGS', 'CPPFLAGS'],
981                    'ccer' => 'PPF77',
982                    'compiler' => 'PPF77COMPILE',
983                    'compile' => '$(F77) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_FFLAGS) $(FFLAGS)',
984                    'compile_flag' => '-c',
985                    'output_flag' => '-o',
986                    'libtool_tag' => 'F77',
987                    'pure' => 1,
988                    'extensions' => ['.F']);
990 # Ratfor.
991 register_language ('name' => 'ratfor',
992                    'Name' => 'Ratfor',
993                    'config_vars' => ['F77'],
994                    'linker' => 'F77LINK',
995                    'link' => '$(F77LD) $(AM_FFLAGS) $(FFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
996                    'lder' => 'F77LD',
997                    'ld' => '$(F77)',
998                    'flags' => ['RFLAGS', 'FFLAGS'],
999                    # FIXME also FFLAGS.
1000                    'compile' => '$(F77) $(AM_FFLAGS) $(FFLAGS) $(AM_RFLAGS) $(RFLAGS)',
1001                    'ccer' => 'F77',
1002                    'compiler' => 'RCOMPILE',
1003                    'compile_flag' => '-c',
1004                    'output_flag' => '-o',
1005                    'libtool_tag' => 'F77',
1006                    'pure' => 1,
1007                    'extensions' => ['.r']);
1009 # Java via gcj.
1010 register_language ('name' => 'java',
1011                    'Name' => 'Java',
1012                    'config_vars' => ['GCJ'],
1013                    'linker' => 'GCJLINK',
1014                    'link' => '$(GCJLD) $(AM_GCJFLAGS) $(GCJFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@',
1015                    'autodep' => 'GCJ',
1016                    'flags' => ['GCJFLAGS'],
1017                    'compile' => '$(GCJ) $(AM_GCJFLAGS) $(GCJFLAGS)',
1018                    'ccer' => 'GCJ',
1019                    'compiler' => 'GCJCOMPILE',
1020                    'compile_flag' => '-c',
1021                    'output_flag' => '-o',
1022                    'libtool_tag' => 'GCJ',
1023                    'lder' => 'GCJLD',
1024                    'ld' => '$(GCJ)',
1025                    'pure' => 1,
1026                    'extensions' => ['.java', '.class', '.zip', '.jar']);
1028 ################################################################
1030 # Error reporting functions.
1032 # err_am ($MESSAGE, [%OPTIONS])
1033 # -----------------------------
1034 # Uncategorized errors about the current Makefile.am.
1035 sub err_am ($;%)
1037   msg_am ('error', @_);
1040 # err_ac ($MESSAGE, [%OPTIONS])
1041 # -----------------------------
1042 # Uncategorized errors about configure.ac.
1043 sub err_ac ($;%)
1045   msg_ac ('error', @_);
1048 # msg_am ($CHANNEL, $MESSAGE, [%OPTIONS])
1049 # ---------------------------------------
1050 # Messages about about the current Makefile.am.
1051 sub msg_am ($$;%)
1053   my ($channel, $msg, %opts) = @_;
1054   msg $channel, "${am_file}.am", $msg, %opts;
1057 # msg_ac ($CHANNEL, $MESSAGE, [%OPTIONS])
1058 # ---------------------------------------
1059 # Messages about about configure.ac.
1060 sub msg_ac ($$;%)
1062   my ($channel, $msg, %opts) = @_;
1063   msg $channel, $configure_ac, $msg, %opts;
1066 ################################################################
1068 # subst ($TEXT)
1069 # -------------
1070 # Return a configure-style substitution using the indicated text.
1071 # We do this to avoid having the substitutions directly in automake.in;
1072 # when we do that they are sometimes removed and this causes confusion
1073 # and bugs.
1074 sub subst ($)
1076     my ($text) = @_;
1077     return '@' . $text . '@';
1080 ################################################################
1083 # $BACKPATH
1084 # &backname ($RELDIR)
1085 # --------------------
1086 # If I "cd $RELDIR", then to come back, I should "cd $BACKPATH".
1087 # For instance 'src/foo' => '../..'.
1088 # Works with non strictly increasing paths, i.e., 'src/../lib' => '..'.
1089 sub backname ($)
1091     my ($file) = @_;
1092     my @res;
1093     foreach (split (/\//, $file))
1094     {
1095         next if $_ eq '.' || $_ eq '';
1096         if ($_ eq '..')
1097         {
1098             pop @res
1099               or prog_error ("trying to reverse path '$file' pointing outside tree");
1100         }
1101         else
1102         {
1103             push (@res, '..');
1104         }
1105     }
1106     return join ('/', @res) || '.';
1109 ################################################################
1111 # Silent rules handling functions.
1113 # verbose_var (NAME)
1114 # ------------------
1115 # The public variable stem used to implement silent rules.
1116 sub verbose_var ($)
1118     my ($name) = @_;
1119     return 'AM_V_' . $name;
1122 # verbose_private_var (NAME)
1123 # --------------------------
1124 # The naming policy for the private variables for silent rules.
1125 sub verbose_private_var ($)
1127     my ($name) = @_;
1128     return 'am__v_' . $name;
1131 # define_verbose_var (NAME, VAL-IF-SILENT, [VAL-IF-VERBOSE])
1132 # ----------------------------------------------------------
1133 # For  silent rules, setup VAR and dispatcher, to expand to
1134 # VAL-IF-SILENT if silent, to VAL-IF-VERBOSE (defaulting to
1135 # empty) if not.
1136 sub define_verbose_var ($$;$)
1138     my ($name, $silent_val, $verbose_val) = @_;
1139     $verbose_val = '' unless defined $verbose_val;
1140     my $var = verbose_var ($name);
1141     my $pvar = verbose_private_var ($name);
1142     my $silent_var = $pvar . '_0';
1143     my $verbose_var = $pvar . '_1';
1144     # For typical 'make's, 'configure' replaces AM_V (inside @@) with $(V)
1145     # and AM_DEFAULT_V (inside @@) with $(AM_DEFAULT_VERBOSITY).
1146     # For strict POSIX 2008 'make's, it replaces them with 0 or 1 instead.
1147     # See AM_SILENT_RULES in m4/silent.m4.
1148     define_variable ($var, '$(' . $pvar . '_@'.'AM_V'.'@)', INTERNAL);
1149     define_variable ($pvar . '_', '$(' . $pvar . '_@'.'AM_DEFAULT_V'.'@)',
1150                      INTERNAL);
1151     Automake::Variable::define ($silent_var, VAR_AUTOMAKE, '', TRUE,
1152                                 $silent_val, '', INTERNAL, VAR_ASIS)
1153       if (! vardef ($silent_var, TRUE));
1154     Automake::Variable::define ($verbose_var, VAR_AUTOMAKE, '', TRUE,
1155                                 $verbose_val, '', INTERNAL, VAR_ASIS)
1156       if (! vardef ($verbose_var, TRUE));
1159 # Above should not be needed in the general automake code.
1161 # verbose_flag (NAME)
1162 # -------------------
1163 # Contents of %VERBOSE%: variable to expand before rule command.
1164 sub verbose_flag ($)
1166     my ($name) = @_;
1167     return '$(' . verbose_var ($name) . ')';
1170 sub verbose_nodep_flag ($)
1172     my ($name) = @_;
1173     return '$(' . verbose_var ($name) . subst ('am__nodep') . ')';
1176 # silent_flag
1177 # -----------
1178 # Contents of %SILENT%: variable to expand to '@' when silent.
1179 sub silent_flag ()
1181     return verbose_flag ('at');
1184 # define_verbose_tagvar (NAME)
1185 # ----------------------------
1186 # Engage the needed silent rules machinery for tag NAME.
1187 sub define_verbose_tagvar ($)
1189     my ($name) = @_;
1190     define_verbose_var ($name, '@echo "  '. $name . ' ' x (8 - length ($name)) . '" $@;');
1193 # define_verbose_texinfo
1194 # ----------------------
1195 # Engage the needed silent rules machinery for assorted texinfo commands.
1196 sub define_verbose_texinfo ()
1198   my @tagvars = ('DVIPS', 'MAKEINFO', 'INFOHTML', 'TEXI2DVI', 'TEXI2PDF');
1199   foreach my $tag (@tagvars)
1200     {
1201       define_verbose_tagvar($tag);
1202     }
1203   define_verbose_var('texinfo', '-q');
1204   define_verbose_var('texidevnull', '> /dev/null');
1207 # define_verbose_libtool
1208 # ----------------------
1209 # Engage the needed silent rules machinery for 'libtool --silent'.
1210 sub define_verbose_libtool ()
1212     define_verbose_var ('lt', '--silent');
1213     return verbose_flag ('lt');
1216 sub handle_silent ()
1218     # Define "$(AM_V_P)", expanding to a shell conditional that can be
1219     # used in make recipes to determine whether we are being run in
1220     # silent mode or not.  The choice of the name derives from the LISP
1221     # convention of appending the letter 'P' to denote a predicate (see
1222     # also "the '-P' convention" in the Jargon File); we do so for lack
1223     # of a better convention.
1224     define_verbose_var ('P', 'false', ':');
1225     # *Always* provide the user with '$(AM_V_GEN)', unconditionally.
1226     define_verbose_tagvar ('GEN');
1227     define_verbose_var ('at', '@');
1231 ################################################################
1234 # Handle AUTOMAKE_OPTIONS variable.  Return 1 on error, 0 otherwise.
1235 sub handle_options
1237   my $var = var ('AUTOMAKE_OPTIONS');
1238   if ($var)
1239     {
1240       if ($var->has_conditional_contents)
1241         {
1242           msg_var ('unsupported', $var,
1243                    "'AUTOMAKE_OPTIONS' cannot have conditional contents");
1244         }
1245       my @options = map { { option => $_->[1], where => $_->[0] } }
1246                         $var->value_as_list_recursive (cond_filter => TRUE,
1247                                                        location => 1);
1248       return 1 if process_option_list (@options);
1249     }
1251   if ($strictness == GNITS)
1252     {
1253       set_option ('readme-alpha', INTERNAL);
1254       set_option ('std-options', INTERNAL);
1255       set_option ('check-news', INTERNAL);
1256     }
1258   return 0;
1261 # shadow_unconditionally ($varname, $where)
1262 # -----------------------------------------
1263 # Return a $(variable) that contains all possible values
1264 # $varname can take.
1265 # If the VAR wasn't defined conditionally, return $(VAR).
1266 # Otherwise we create an am__VAR_DIST variable which contains
1267 # all possible values, and return $(am__VAR_DIST).
1268 sub shadow_unconditionally ($$)
1270   my ($varname, $where) = @_;
1271   my $var = var $varname;
1272   if ($var->has_conditional_contents)
1273     {
1274       $varname = "am__${varname}_DIST";
1275       my @files = uniq ($var->value_as_list_recursive);
1276       define_pretty_variable ($varname, TRUE, $where, @files);
1277     }
1278   return "\$($varname)"
1281 # check_user_variables (@LIST)
1282 # ----------------------------
1283 # Make sure each variable VAR in @LIST does not exist, suggest using AM_VAR
1284 # otherwise.
1285 sub check_user_variables (@)
1287   my @dont_override = @_;
1288   foreach my $flag (@dont_override)
1289     {
1290       my $var = var $flag;
1291       if ($var)
1292         {
1293           for my $cond ($var->conditions->conds)
1294             {
1295               if ($var->rdef ($cond)->owner == VAR_MAKEFILE)
1296                 {
1297                   msg_cond_var ('gnu', $cond, $flag,
1298                                 "'$flag' is a user variable, "
1299                                 . "you should not override it;\n"
1300                                 . "use 'AM_$flag' instead");
1301                 }
1302             }
1303         }
1304     }
1307 # Call finish function for each language that was used.
1308 sub handle_languages
1310     if (! option 'no-dependencies')
1311     {
1312         # Include auto-dep code.  Don't include it if DEP_FILES would
1313         # be empty.
1314         if (keys %extension_seen && keys %dep_files)
1315         {
1316             # Set location of depcomp.
1317             &define_variable ('depcomp',
1318                               "\$(SHELL) $am_config_aux_dir/depcomp",
1319                               INTERNAL);
1320             &define_variable ('am__depfiles_maybe', 'depfiles', INTERNAL);
1322             require_conf_file ("$am_file.am", FOREIGN, 'depcomp');
1324             my @deplist = sort keys %dep_files;
1325             # Generate each 'include' individually.  Irix 6 make will
1326             # not properly include several files resulting from a
1327             # variable expansion; generating many separate includes
1328             # seems safest.
1329             $output_rules .= "\n";
1330             foreach my $iter (@deplist)
1331             {
1332                 $output_rules .= (subst ('AMDEP_TRUE')
1333                                   . subst ('am__include')
1334                                   . ' '
1335                                   . subst ('am__quote')
1336                                   . $iter
1337                                   . subst ('am__quote')
1338                                   . "\n");
1339             }
1341             # Compute the set of directories to remove in distclean-depend.
1342             my @depdirs = uniq (map { dirname ($_) } @deplist);
1343             $output_rules .= &file_contents ('depend',
1344                                              new Automake::Location,
1345                                              DEPDIRS => "@depdirs");
1346         }
1347     }
1348     else
1349     {
1350         &define_variable ('depcomp', '', INTERNAL);
1351         &define_variable ('am__depfiles_maybe', '', INTERNAL);
1352     }
1354     my %done;
1356     # Is the C linker needed?
1357     my $needs_c = 0;
1358     foreach my $ext (sort keys %extension_seen)
1359     {
1360         next unless $extension_map{$ext};
1362         my $lang = $languages{$extension_map{$ext}};
1364         my $rule_file = $lang->rule_file || 'depend2';
1366         # Get information on $LANG.
1367         my $pfx = $lang->autodep;
1368         my $fpfx = ($pfx eq '') ? 'CC' : $pfx;
1370         my ($AMDEP, $FASTDEP) =
1371           (option 'no-dependencies' || $lang->autodep eq 'no')
1372           ? ('FALSE', 'FALSE') : ('AMDEP', "am__fastdep$fpfx");
1374         my $verbose = verbose_flag ($lang->ccer || 'GEN');
1375         my $verbose_nodep = ($AMDEP eq 'FALSE')
1376           ? $verbose : verbose_nodep_flag ($lang->ccer || 'GEN');
1377         my $silent = silent_flag ();
1379         my %transform = ('EXT'     => $ext,
1380                          'PFX'     => $pfx,
1381                          'FPFX'    => $fpfx,
1382                          'AMDEP'   => $AMDEP,
1383                          'FASTDEP' => $FASTDEP,
1384                          '-c'      => $lang->compile_flag || '',
1385                          # These are not used, but they need to be defined
1386                          # so &transform do not complain.
1387                          SUBDIROBJ     => 0,
1388                          'DERIVED-EXT' => 'BUG',
1389                          DIST_SOURCE   => 1,
1390                          VERBOSE   => $verbose,
1391                          'VERBOSE-NODEP' => $verbose_nodep,
1392                          SILENT    => $silent,
1393                         );
1395         # Generate the appropriate rules for this extension.
1396         if (((! option 'no-dependencies') && $lang->autodep ne 'no')
1397             || defined $lang->compile)
1398         {
1399             # Some C compilers don't support -c -o.  Use it only if really
1400             # needed.
1401             my $output_flag = $lang->output_flag || '';
1402             $output_flag = '-o'
1403               if (! $output_flag
1404                   && $lang->name eq 'c'
1405                   && option 'subdir-objects');
1407             # Compute a possible derived extension.
1408             # This is not used by depend2.am.
1409             my $der_ext = (&{$lang->output_extensions} ($ext))[0];
1411             # When we output an inference rule like '.c.o:' we
1412             # have two cases to consider: either subdir-objects
1413             # is used, or it is not.
1414             #
1415             # In the latter case the rule is used to build objects
1416             # in the current directory, and dependencies always
1417             # go into './$(DEPDIR)/'.  We can hard-code this value.
1418             #
1419             # In the former case the rule can be used to build
1420             # objects in sub-directories too.  Dependencies should
1421             # go into the appropriate sub-directories, e.g.,
1422             # 'sub/$(DEPDIR)/'.  The value of this directory
1423             # needs to be computed on-the-fly.
1424             #
1425             # DEPBASE holds the name of this directory, plus the
1426             # basename part of the object file (extensions Po, TPo,
1427             # Plo, TPlo will be added later as appropriate).  It is
1428             # either hardcoded, or a shell variable ('$depbase') that
1429             # will be computed by the rule.
1430             my $depbase =
1431               option ('subdir-objects') ? '$$depbase' : '$(DEPDIR)/$*';
1432             $output_rules .=
1433               file_contents ($rule_file,
1434                              new Automake::Location,
1435                              %transform,
1436                              GENERIC   => 1,
1438                              'DERIVED-EXT' => $der_ext,
1440                              DEPBASE   => $depbase,
1441                              BASE      => '$*',
1442                              SOURCE    => '$<',
1443                              SOURCEFLAG => $sourceflags{$ext} || '',
1444                              OBJ       => '$@',
1445                              OBJOBJ    => '$@',
1446                              LTOBJ     => '$@',
1448                              COMPILE   => '$(' . $lang->compiler . ')',
1449                              LTCOMPILE => '$(LT' . $lang->compiler . ')',
1450                              -o        => $output_flag,
1451                              SUBDIROBJ => !! option 'subdir-objects');
1452         }
1454         # Now include code for each specially handled object with this
1455         # language.
1456         my %seen_files = ();
1457         foreach my $file (@{$lang_specific_files{$lang->name}})
1458         {
1459             my ($derived, $source, $obj, $myext, $srcext, %file_transform) = @$file;
1461             # We might see a given object twice, for instance if it is
1462             # used under different conditions.
1463             next if defined $seen_files{$obj};
1464             $seen_files{$obj} = 1;
1466             prog_error ("found " . $lang->name .
1467                         " in handle_languages, but compiler not defined")
1468               unless defined $lang->compile;
1470             my $obj_compile = $lang->compile;
1472             # Rewrite each occurrence of 'AM_$flag' in the compile
1473             # rule into '${derived}_$flag' if it exists.
1474             for my $flag (@{$lang->flags})
1475               {
1476                 my $val = "${derived}_$flag";
1477                 $obj_compile =~ s/\(AM_$flag\)/\($val\)/
1478                   if set_seen ($val);
1479               }
1481             my $libtool_tag = '';
1482             if ($lang->libtool_tag && exists $libtool_tags{$lang->libtool_tag})
1483               {
1484                 $libtool_tag = '--tag=' . $lang->libtool_tag . ' '
1485               }
1487             my $ptltflags = "${derived}_LIBTOOLFLAGS";
1488             $ptltflags = 'AM_LIBTOOLFLAGS' unless set_seen $ptltflags;
1490             my $ltverbose = define_verbose_libtool ();
1491             my $obj_ltcompile =
1492               "\$(LIBTOOL) $ltverbose $libtool_tag\$($ptltflags) \$(LIBTOOLFLAGS) "
1493               . "--mode=compile $obj_compile";
1495             # We _need_ '-o' for per object rules.
1496             my $output_flag = $lang->output_flag || '-o';
1498             my $depbase = dirname ($obj);
1499             $depbase = ''
1500                 if $depbase eq '.';
1501             $depbase .= '/'
1502                 unless $depbase eq '';
1503             $depbase .= '$(DEPDIR)/' . basename ($obj);
1505             $output_rules .=
1506               file_contents ($rule_file,
1507                              new Automake::Location,
1508                              %transform,
1509                              GENERIC   => 0,
1511                              DEPBASE   => $depbase,
1512                              BASE      => $obj,
1513                              SOURCE    => $source,
1514                              SOURCEFLAG => $sourceflags{$srcext} || '',
1515                              # Use $myext and not '.o' here, in case
1516                              # we are actually building a new source
1517                              # file -- e.g. via yacc.
1518                              OBJ       => "$obj$myext",
1519                              OBJOBJ    => "$obj.obj",
1520                              LTOBJ     => "$obj.lo",
1522                              VERBOSE   => $verbose,
1523                              'VERBOSE-NODEP'  => $verbose_nodep,
1524                              SILENT    => $silent,
1525                              COMPILE   => $obj_compile,
1526                              LTCOMPILE => $obj_ltcompile,
1527                              -o        => $output_flag,
1528                              %file_transform);
1529         }
1531         # The rest of the loop is done once per language.
1532         next if defined $done{$lang};
1533         $done{$lang} = 1;
1535         # Load the language dependent Makefile chunks.
1536         my %lang = map { uc ($_) => 0 } keys %languages;
1537         $lang{uc ($lang->name)} = 1;
1538         $output_rules .= file_contents ('lang-compile',
1539                                         new Automake::Location,
1540                                         %transform, %lang);
1542         # If the source to a program consists entirely of code from a
1543         # 'pure' language, for instance C++ or Fortran 77, then we
1544         # don't need the C compiler code.  However if we run into
1545         # something unusual then we do generate the C code.  There are
1546         # probably corner cases here that do not work properly.
1547         # People linking Java code to Fortran code deserve pain.
1548         $needs_c ||= ! $lang->pure;
1550         define_compiler_variable ($lang)
1551           if ($lang->compile);
1553         define_linker_variable ($lang)
1554           if ($lang->link);
1556         require_variables ("$am_file.am", $lang->Name . " source seen",
1557                            TRUE, @{$lang->config_vars});
1559         # Call the finisher.
1560         $lang->finish;
1562         # Flags listed in '->flags' are user variables (per GNU Standards),
1563         # they should not be overridden in the Makefile...
1564         my @dont_override = @{$lang->flags};
1565         # ... and so is LDFLAGS.
1566         push @dont_override, 'LDFLAGS' if $lang->link;
1568         check_user_variables @dont_override;
1569     }
1571     # If the project is entirely C++ or entirely Fortran 77 (i.e., 1
1572     # suffix rule was learned), don't bother with the C stuff.  But if
1573     # anything else creeps in, then use it.
1574     $needs_c = 1
1575       if $need_link || suffix_rules_count > 1;
1577     if ($needs_c)
1578       {
1579         &define_compiler_variable ($languages{'c'})
1580           unless defined $done{$languages{'c'}};
1581         define_linker_variable ($languages{'c'});
1582       }
1586 # append_exeext { PREDICATE } $MACRO
1587 # ----------------------------------
1588 # Append $(EXEEXT) to each filename in $F appearing in the Makefile
1589 # variable $MACRO if &PREDICATE($F) is true.  @substitutions@ are
1590 # ignored.
1592 # This is typically used on all filenames of *_PROGRAMS, and filenames
1593 # of TESTS that are programs.
1594 sub append_exeext (&$)
1596   my ($pred, $macro) = @_;
1598   transform_variable_recursively
1599     ($macro, $macro, 'am__EXEEXT', 0, INTERNAL,
1600      sub {
1601        my ($subvar, $val, $cond, $full_cond) = @_;
1602        # Append $(EXEEXT) unless the user did it already, or it's a
1603        # @substitution@.
1604        $val .= '$(EXEEXT)'
1605          if $val !~ /(?:\$\(EXEEXT\)$|^[@]\w+[@]$)/ && &$pred ($val);
1606        return $val;
1607      });
1611 # Check to make sure a source defined in LIBOBJS is not explicitly
1612 # mentioned.  This is a separate function (as opposed to being inlined
1613 # in handle_source_transform) because it isn't always appropriate to
1614 # do this check.
1615 sub check_libobjs_sources
1617   my ($one_file, $unxformed) = @_;
1619   foreach my $prefix ('', 'EXTRA_', 'dist_', 'nodist_',
1620                       'dist_EXTRA_', 'nodist_EXTRA_')
1621     {
1622       my @files;
1623       my $varname = $prefix . $one_file . '_SOURCES';
1624       my $var = var ($varname);
1625       if ($var)
1626         {
1627           @files = $var->value_as_list_recursive;
1628         }
1629       elsif ($prefix eq '')
1630         {
1631           @files = ($unxformed . '.c');
1632         }
1633       else
1634         {
1635           next;
1636         }
1638       foreach my $file (@files)
1639         {
1640           err_var ($prefix . $one_file . '_SOURCES',
1641                    "automatically discovered file '$file' should not" .
1642                    " be explicitly mentioned")
1643             if defined $libsources{$file};
1644         }
1645     }
1649 # @OBJECTS
1650 # handle_single_transform ($VAR, $TOPPARENT, $DERIVED, $OBJ, $FILE, %TRANSFORM)
1651 # -----------------------------------------------------------------------------
1652 # Does much of the actual work for handle_source_transform.
1653 # Arguments are:
1654 #   $VAR is the name of the variable that the source filenames come from
1655 #   $TOPPARENT is the name of the _SOURCES variable which is being processed
1656 #   $DERIVED is the name of resulting executable or library
1657 #   $OBJ is the object extension (e.g., '.lo')
1658 #   $FILE the source file to transform
1659 #   %TRANSFORM contains extras arguments to pass to file_contents
1660 #     when producing explicit rules
1661 # Result is a list of the names of objects
1662 # %linkers_used will be updated with any linkers needed
1663 sub handle_single_transform ($$$$$%)
1665     my ($var, $topparent, $derived, $obj, $_file, %transform) = @_;
1666     my @files = ($_file);
1667     my @result = ();
1669     # Turn sources into objects.  We use a while loop like this
1670     # because we might add to @files in the loop.
1671     while (scalar @files > 0)
1672     {
1673         $_ = shift @files;
1675         # Configure substitutions in _SOURCES variables are errors.
1676         if (/^\@.*\@$/)
1677         {
1678           my $parent_msg = '';
1679           $parent_msg = "\nand is referred to from '$topparent'"
1680             if $topparent ne $var->name;
1681           err_var ($var,
1682                    "'" . $var->name . "' includes configure substitution '$_'"
1683                    . $parent_msg . ";\nconfigure " .
1684                    "substitutions are not allowed in _SOURCES variables");
1685           next;
1686         }
1688         # If the source file is in a subdirectory then the '.o' is put
1689         # into the current directory, unless the subdir-objects option
1690         # is in effect.
1692         # Split file name into base and extension.
1693         next if ! /^(?:(.*)\/)?([^\/]*)($KNOWN_EXTENSIONS_PATTERN)$/;
1694         my $full = $_;
1695         my $directory = $1 || '';
1696         my $base = $2;
1697         my $extension = $3;
1699         # We must generate a rule for the object if it requires its own flags.
1700         my $renamed = 0;
1701         my ($linker, $object);
1703         # This records whether we've seen a derived source file (e.g.
1704         # yacc output).
1705         my $derived_source = 0;
1707         # This holds the 'aggregate context' of the file we are
1708         # currently examining.  If the file is compiled with
1709         # per-object flags, then it will be the name of the object.
1710         # Otherwise it will be 'AM'.  This is used by the target hook
1711         # language function.
1712         my $aggregate = 'AM';
1714         $extension = &derive_suffix ($extension, $obj);
1715         my $lang;
1716         if ($extension_map{$extension} &&
1717             ($lang = $languages{$extension_map{$extension}}))
1718         {
1719             # Found the language, so see what it says.
1720             &saw_extension ($extension);
1722             # Do we have per-executable flags for this executable?
1723             my $have_per_exec_flags = 0;
1724             my @peflags = @{$lang->flags};
1725             push @peflags, 'LIBTOOLFLAGS' if $obj eq '.lo';
1726             foreach my $flag (@peflags)
1727               {
1728                 if (set_seen ("${derived}_$flag"))
1729                   {
1730                     $have_per_exec_flags = 1;
1731                     last;
1732                   }
1733               }
1735             # Note: computed subr call.  The language rewrite function
1736             # should return one of the LANG_* constants.  It could
1737             # also return a list whose first value is such a constant
1738             # and whose second value is a new source extension which
1739             # should be applied.  This means this particular language
1740             # generates another source file which we must then process
1741             # further.
1742             my $subr = \&{'lang_' . $lang->name . '_rewrite'};
1743             defined &$subr or $subr = \&lang_sub_obj;
1744             my ($r, $source_extension)
1745                 = &$subr ($directory, $base, $extension,
1746                           $obj, $have_per_exec_flags, $var);
1747             # Skip this entry if we were asked not to process it.
1748             next if $r == LANG_IGNORE;
1750             # Now extract linker and other info.
1751             $linker = $lang->linker;
1753             my $this_obj_ext;
1754             if (defined $source_extension)
1755             {
1756                 $this_obj_ext = $source_extension;
1757                 $derived_source = 1;
1758             }
1759             else
1760             {
1761                 $this_obj_ext = $obj;
1762             }
1763             $object = $base . $this_obj_ext;
1765             if ($have_per_exec_flags)
1766             {
1767                 # We have a per-executable flag in effect for this
1768                 # object.  In this case we rewrite the object's
1769                 # name to ensure it is unique.
1771                 # We choose the name 'DERIVED_OBJECT' to ensure
1772                 # (1) uniqueness, and (2) continuity between
1773                 # invocations.  However, this will result in a
1774                 # name that is too long for losing systems, in
1775                 # some situations.  So we provide _SHORTNAME to
1776                 # override.
1778                 my $dname = $derived;
1779                 my $var = var ($derived . '_SHORTNAME');
1780                 if ($var)
1781                 {
1782                     # FIXME: should use the same Condition as
1783                     # the _SOURCES variable.  But this is really
1784                     # silly overkill -- nobody should have
1785                     # conditional shortnames.
1786                     $dname = $var->variable_value;
1787                 }
1788                 $object = $dname . '-' . $object;
1790                 prog_error ($lang->name . " flags defined without compiler")
1791                   if ! defined $lang->compile;
1793                 $renamed = 1;
1794             }
1796             # If rewrite said it was ok, put the object into a
1797             # subdir.
1798             if ($r == LANG_SUBDIR && $directory ne '')
1799             {
1800                 $object = $directory . '/' . $object;
1801             }
1803             # If the object file has been renamed (because per-target
1804             # flags are used) we cannot compile the file with an
1805             # inference rule: we need an explicit rule.
1806             #
1807             # If the source is in a subdirectory and the object is in
1808             # the current directory, we also need an explicit rule.
1809             #
1810             # If both source and object files are in a subdirectory
1811             # (this happens when the subdir-objects option is used),
1812             # then the inference will work.
1813             #
1814             # The latter case deserves a historical note.  When the
1815             # subdir-objects option was added on 1999-04-11 it was
1816             # thought that inferences rules would work for
1817             # subdirectory objects too.  Later, on 1999-11-22,
1818             # automake was changed to output explicit rules even for
1819             # subdir-objects.  Nobody remembers why, but this occurred
1820             # soon after the merge of the user-dep-gen-branch so it
1821             # might be related.  In late 2003 people complained about
1822             # the size of the generated Makefile.ins (libgcj, with
1823             # 2200+ subdir objects was reported to have a 9MB
1824             # Makefile), so we now rely on inference rules again.
1825             # Maybe we'll run across the same issue as in the past,
1826             # but at least this time we can document it.  However since
1827             # dependency tracking has evolved it is possible that
1828             # our old problem no longer exists.
1829             # Using inference rules for subdir-objects has been tested
1830             # with GNU make, Solaris make, Ultrix make, BSD make,
1831             # HP-UX make, and OSF1 make successfully.
1832             if ($renamed
1833                 || ($directory ne '' && ! option 'subdir-objects')
1834                 # We must also use specific rules for a nodist_ source
1835                 # if its language requests it.
1836                 || ($lang->nodist_specific && ! $transform{'DIST_SOURCE'}))
1837             {
1838                 my $obj_sans_ext = substr ($object, 0,
1839                                            - length ($this_obj_ext));
1840                 my $full_ansi;
1841                 if ($directory ne '')
1842                   {
1843                         $full_ansi = $directory . '/' . $base . $extension;
1844                   }
1845                 else
1846                   {
1847                         $full_ansi = $base . $extension;
1848                   }
1850                 my @specifics = ($full_ansi, $obj_sans_ext,
1851                                  # Only use $this_obj_ext in the derived
1852                                  # source case because in the other case we
1853                                  # *don't* want $(OBJEXT) to appear here.
1854                                  ($derived_source ? $this_obj_ext : '.o'),
1855                                  $extension);
1857                 # If we renamed the object then we want to use the
1858                 # per-executable flag name.  But if this is simply a
1859                 # subdir build then we still want to use the AM_ flag
1860                 # name.
1861                 if ($renamed)
1862                   {
1863                     unshift @specifics, $derived;
1864                     $aggregate = $derived;
1865                   }
1866                 else
1867                   {
1868                     unshift @specifics, 'AM';
1869                   }
1871                 # Each item on this list is a reference to a list consisting
1872                 # of four values followed by additional transform flags for
1873                 # file_contents.  The four values are the derived flag prefix
1874                 # (e.g. for 'foo_CFLAGS', it is 'foo'), the name of the
1875                 # source file, the base name of the output file, and
1876                 # the extension for the object file.
1877                 push (@{$lang_specific_files{$lang->name}},
1878                       [@specifics, %transform]);
1879             }
1880         }
1881         elsif ($extension eq $obj)
1882         {
1883             # This is probably the result of a direct suffix rule.
1884             # In this case we just accept the rewrite.
1885             $object = "$base$extension";
1886             $object = "$directory/$object" if $directory ne '';
1887             $linker = '';
1888         }
1889         else
1890         {
1891             # No error message here.  Used to have one, but it was
1892             # very unpopular.
1893             # FIXME: we could potentially do more processing here,
1894             # perhaps treating the new extension as though it were a
1895             # new source extension (as above).  This would require
1896             # more restructuring than is appropriate right now.
1897             next;
1898         }
1900         err_am "object '$object' created by '$full' and '$object_map{$object}'"
1901           if (defined $object_map{$object}
1902               && $object_map{$object} ne $full);
1904         my $comp_val = (($object =~ /\.lo$/)
1905                         ? COMPILE_LIBTOOL : COMPILE_ORDINARY);
1906         (my $comp_obj = $object) =~ s/\.lo$/.\$(OBJEXT)/;
1907         if (defined $object_compilation_map{$comp_obj}
1908             && $object_compilation_map{$comp_obj} != 0
1909             # Only see the error once.
1910             && ($object_compilation_map{$comp_obj}
1911                 != (COMPILE_LIBTOOL | COMPILE_ORDINARY))
1912             && $object_compilation_map{$comp_obj} != $comp_val)
1913           {
1914             err_am "object '$comp_obj' created both with libtool and without";
1915           }
1916         $object_compilation_map{$comp_obj} |= $comp_val;
1918         if (defined $lang)
1919         {
1920             # Let the language do some special magic if required.
1921             $lang->target_hook ($aggregate, $object, $full, %transform);
1922         }
1924         if ($derived_source)
1925           {
1926             prog_error ($lang->name . " has automatic dependency tracking")
1927               if $lang->autodep ne 'no';
1928             # Make sure this new source file is handled next.  That will
1929             # make it appear to be at the right place in the list.
1930             unshift (@files, $object);
1931             # Distribute derived sources unless the source they are
1932             # derived from is not.
1933             &push_dist_common ($object)
1934               unless ($topparent =~ /^(?:nobase_)?nodist_/);
1935             next;
1936           }
1938         $linkers_used{$linker} = 1;
1940         push (@result, $object);
1942         if (! defined $object_map{$object})
1943         {
1944             my @dep_list = ();
1945             $object_map{$object} = $full;
1947             # If resulting object is in subdir, we need to make
1948             # sure the subdir exists at build time.
1949             if ($object =~ /\//)
1950             {
1951                 # FIXME: check that $DIRECTORY is somewhere in the
1952                 # project
1954                 # For Java, the way we're handling it right now, a
1955                 # '..' component doesn't make sense.
1956                 if ($lang && $lang->name eq 'java' && $object =~ /(\/|^)\.\.\//)
1957                   {
1958                     err_am "'$full' should not contain a '..' component";
1959                   }
1961                 # Make sure *all* objects files in the subdirectory are
1962                 # removed by "make mostlyclean".  Not only this is more
1963                 # efficient than listing the object files to be removed
1964                 # individually (which would cause an 'rm' invocation for
1965                 # each of them -- very inefficient, see bug#10697), it
1966                 # would also leave stale object files in the subdirectory
1967                 # whenever a source file there is removed or renamed.
1968                 $compile_clean_files{"$directory/*.\$(OBJEXT)"} = MOSTLY_CLEAN;
1969                 if ($object =~ /\.lo$/)
1970                   {
1971                     # If we have a libtool object, then we also must remove
1972                     # any '.lo' objects in its same subdirectory.
1973                     $compile_clean_files{"$directory/*.lo"} = MOSTLY_CLEAN;
1974                     # Remember to cleanup .libs/ in this directory.
1975                     $libtool_clean_directories{$directory} = 1;
1976                   }
1978                 push (@dep_list, require_build_directory ($directory));
1980                 # If we're generating dependencies, we also want
1981                 # to make sure that the appropriate subdir of the
1982                 # .deps directory is created.
1983                 push (@dep_list,
1984                       require_build_directory ($directory . '/$(DEPDIR)'))
1985                   unless option 'no-dependencies';
1986             }
1988             &pretty_print_rule ($object . ':', "\t", @dep_list)
1989                 if scalar @dep_list > 0;
1990         }
1992         # Transform .o or $o file into .P file (for automatic
1993         # dependency code).
1994         # Properly flatten multiple adjacent slashes, as Solaris 10 make
1995         # might fail over them in an include statement.
1996         # Leading double slashes may be special, as per Posix, so deal
1997         # with them carefully.
1998         if ($lang && $lang->autodep ne 'no')
1999         {
2000             my $depfile = $object;
2001             $depfile =~ s/\.([^.]*)$/.P$1/;
2002             $depfile =~ s/\$\(OBJEXT\)$/o/;
2003             my $maybe_extra_leading_slash = '';
2004             $maybe_extra_leading_slash = '/' if $depfile =~ m,^//[^/],;
2005             $depfile =~ s,/+,/,g;
2006             my $basename = basename ($depfile);
2007             # This might make $dirname empty, but we account for that below.
2008             (my $dirname = dirname ($depfile)) =~ s/\/*$//;
2009             $dirname = $maybe_extra_leading_slash . $dirname;
2010             $dep_files{$dirname . '/$(DEPDIR)/' . $basename} = 1;
2011         }
2012     }
2014     return @result;
2018 # $LINKER
2019 # define_objects_from_sources ($VAR, $OBJVAR, $NODEFINE, $ONE_FILE,
2020 #                              $OBJ, $PARENT, $TOPPARENT, $WHERE, %TRANSFORM)
2021 # ---------------------------------------------------------------------------
2022 # Define an _OBJECTS variable for a _SOURCES variable (or subvariable)
2024 # Arguments are:
2025 #   $VAR is the name of the _SOURCES variable
2026 #   $OBJVAR is the name of the _OBJECTS variable if known (otherwise
2027 #     it will be generated and returned).
2028 #   $NODEFINE is a boolean: if true, $OBJVAR will not be defined (but
2029 #     work done to determine the linker will be).
2030 #   $ONE_FILE is the canonical (transformed) name of object to build
2031 #   $OBJ is the object extension (i.e. either '.o' or '.lo').
2032 #   $TOPPARENT is the _SOURCES variable being processed.
2033 #   $WHERE context into which this definition is done
2034 #   %TRANSFORM extra arguments to pass to file_contents when producing
2035 #     rules
2037 # Result is a pair ($LINKER, $OBJVAR):
2038 #    $LINKER is a boolean, true if a linker is needed to deal with the objects
2039 sub define_objects_from_sources ($$$$$$$%)
2041   my ($var, $objvar, $nodefine, $one_file,
2042       $obj, $topparent, $where, %transform) = @_;
2044   my $needlinker = "";
2046   transform_variable_recursively
2047     ($var, $objvar, 'am__objects', $nodefine, $where,
2048      # The transform code to run on each filename.
2049      sub {
2050        my ($subvar, $val, $cond, $full_cond) = @_;
2051        my @trans = handle_single_transform ($subvar, $topparent,
2052                                             $one_file, $obj, $val,
2053                                             %transform);
2054        $needlinker = "true" if @trans;
2055        return @trans;
2056      });
2058   return $needlinker;
2062 # handle_source_transform ($CANON_TARGET, $TARGET, $OBJEXT, $WHERE, %TRANSFORM)
2063 # -----------------------------------------------------------------------------
2064 # Handle SOURCE->OBJECT transform for one program or library.
2065 # Arguments are:
2066 #   canonical (transformed) name of target to build
2067 #   actual target of object to build
2068 #   object extension (i.e., either '.o' or '$o')
2069 #   location of the source variable
2070 #   extra arguments to pass to file_contents when producing rules
2071 # Return the name of the linker variable that must be used.
2072 # Empty return means just use 'LINK'.
2073 sub handle_source_transform ($$$$%)
2075     # one_file is canonical name.  unxformed is given name.  obj is
2076     # object extension.
2077     my ($one_file, $unxformed, $obj, $where, %transform) = @_;
2079     my $linker = '';
2081     # No point in continuing if _OBJECTS is defined.
2082     return if reject_var ($one_file . '_OBJECTS',
2083                           $one_file . '_OBJECTS should not be defined');
2085     my %used_pfx = ();
2086     my $needlinker;
2087     %linkers_used = ();
2088     foreach my $prefix ('', 'EXTRA_', 'dist_', 'nodist_',
2089                         'dist_EXTRA_', 'nodist_EXTRA_')
2090     {
2091         my $varname = $prefix . $one_file . "_SOURCES";
2092         my $var = var $varname;
2093         next unless $var;
2095         # We are going to define _OBJECTS variables using the prefix.
2096         # Then we glom them all together.  So we can't use the null
2097         # prefix here as we need it later.
2098         my $xpfx = ($prefix eq '') ? 'am_' : $prefix;
2100         # Keep track of which prefixes we saw.
2101         $used_pfx{$xpfx} = 1
2102           unless $prefix =~ /EXTRA_/;
2104         push @sources, "\$($varname)";
2105         push @dist_sources, shadow_unconditionally ($varname, $where)
2106           unless (option ('no-dist') || $prefix =~ /^nodist_/);
2108         $needlinker |=
2109             define_objects_from_sources ($varname,
2110                                          $xpfx . $one_file . '_OBJECTS',
2111                                          $prefix =~ /EXTRA_/,
2112                                          $one_file, $obj, $varname, $where,
2113                                          DIST_SOURCE => ($prefix !~ /^nodist_/),
2114                                          %transform);
2115     }
2116     if ($needlinker)
2117     {
2118         $linker ||= &resolve_linker (%linkers_used);
2119     }
2121     my @keys = sort keys %used_pfx;
2122     if (scalar @keys == 0)
2123     {
2124         # The default source for libfoo.la is libfoo.c, but for
2125         # backward compatibility we first look at libfoo_la.c,
2126         # if no default source suffix is given.
2127         my $old_default_source = "$one_file.c";
2128         my $ext_var = var ('AM_DEFAULT_SOURCE_EXT');
2129         my $default_source_ext = $ext_var ? variable_value ($ext_var) : '.c';
2130         msg_var ('unsupported', $ext_var, $ext_var->name . " can assume at most one value")
2131           if $default_source_ext =~ /[\t ]/;
2132         (my $default_source = $unxformed) =~ s,(\.[^./\\]*)?$,$default_source_ext,;
2133         if ($old_default_source ne $default_source
2134             && !$ext_var
2135             && (rule $old_default_source
2136                 || rule '$(srcdir)/' . $old_default_source
2137                 || rule '${srcdir}/' . $old_default_source
2138                 || -f $old_default_source))
2139           {
2140             my $loc = $where->clone;
2141             $loc->pop_context;
2142             msg ('obsolete', $loc,
2143                  "the default source for '$unxformed' has been changed "
2144                  . "to '$default_source'.\n(Using '$old_default_source' for "
2145                  . "backward compatibility.)");
2146             $default_source = $old_default_source;
2147           }
2148         # If a rule exists to build this source with a $(srcdir)
2149         # prefix, use that prefix in our variables too.  This is for
2150         # the sake of BSD Make.
2151         if (rule '$(srcdir)/' . $default_source
2152             || rule '${srcdir}/' . $default_source)
2153           {
2154             $default_source = '$(srcdir)/' . $default_source;
2155           }
2157         &define_variable ($one_file . "_SOURCES", $default_source, $where);
2158         push (@sources, $default_source);
2159         push (@dist_sources, $default_source);
2161         %linkers_used = ();
2162         my (@result) =
2163           handle_single_transform ($one_file . '_SOURCES',
2164                                    $one_file . '_SOURCES',
2165                                    $one_file, $obj,
2166                                    $default_source, %transform);
2167         $linker ||= &resolve_linker (%linkers_used);
2168         define_pretty_variable ($one_file . '_OBJECTS', TRUE, $where, @result);
2169     }
2170     else
2171     {
2172         @keys = map { '$(' . $_ . $one_file . '_OBJECTS)' } @keys;
2173         define_pretty_variable ($one_file . '_OBJECTS', TRUE, $where, @keys);
2174     }
2176     # If we want to use 'LINK' we must make sure it is defined.
2177     if ($linker eq '')
2178     {
2179         $need_link = 1;
2180     }
2182     return $linker;
2186 # handle_lib_objects ($XNAME, $VAR)
2187 # ---------------------------------
2188 # Special-case ALLOCA and LIBOBJS substitutions in _LDADD or _LIBADD variables.
2189 # Also, generate _DEPENDENCIES variable if appropriate.
2190 # Arguments are:
2191 #   transformed name of object being built, or empty string if no object
2192 #   name of _LDADD/_LIBADD-type variable to examine
2193 # Returns 1 if LIBOBJS seen, 0 otherwise.
2194 sub handle_lib_objects
2196   my ($xname, $varname) = @_;
2198   my $var = var ($varname);
2199   prog_error "'$varname' undefined"
2200     unless $var;
2201   prog_error "unexpected variable name '$varname'"
2202     unless $varname =~ /^(.*)(?:LIB|LD)ADD$/;
2203   my $prefix = $1 || 'AM_';
2205   my $seen_libobjs = 0;
2206   my $flagvar = 0;
2208   transform_variable_recursively
2209     ($varname, $xname . '_DEPENDENCIES', 'am__DEPENDENCIES',
2210      ! $xname, INTERNAL,
2211      # Transformation function, run on each filename.
2212      sub {
2213        my ($subvar, $val, $cond, $full_cond) = @_;
2215        if ($val =~ /^-/)
2216          {
2217            # Skip -lfoo and -Ldir silently; these are explicitly allowed.
2218            if ($val !~ /^-[lL]/ &&
2219                # Skip -dlopen and -dlpreopen; these are explicitly allowed
2220                # for Libtool libraries or programs.  (Actually we are a bit
2221                # lax here since this code also applies to non-libtool
2222                # libraries or programs, for which -dlopen and -dlopreopen
2223                # are pure nonsense.  Diagnosing this doesn't seem very
2224                # important: the developer will quickly get complaints from
2225                # the linker.)
2226                $val !~ /^-dl(?:pre)?open$/ &&
2227                # Only get this error once.
2228                ! $flagvar)
2229              {
2230                $flagvar = 1;
2231                # FIXME: should display a stack of nested variables
2232                # as context when $var != $subvar.
2233                err_var ($var, "linker flags such as '$val' belong in "
2234                         . "'${prefix}LDFLAGS'");
2235              }
2236            return ();
2237          }
2238        elsif ($val !~ /^\@.*\@$/)
2239          {
2240            # Assume we have a file of some sort, and output it into the
2241            # dependency variable.  Autoconf substitutions are not output;
2242            # rarely is a new dependency substituted into e.g. foo_LDADD
2243            # -- but bad things (e.g. -lX11) are routinely substituted.
2244            # Note that LIBOBJS and ALLOCA are exceptions to this rule,
2245            # and handled specially below.
2246            return $val;
2247          }
2248        elsif ($val =~ /^\@(LT)?LIBOBJS\@$/)
2249          {
2250            handle_LIBOBJS ($subvar, $cond, $1);
2251            $seen_libobjs = 1;
2252            return $val;
2253          }
2254        elsif ($val =~ /^\@(LT)?ALLOCA\@$/)
2255          {
2256            handle_ALLOCA ($subvar, $cond, $1);
2257            return $val;
2258          }
2259        else
2260          {
2261            return ();
2262          }
2263      });
2265   return $seen_libobjs;
2268 # handle_LIBOBJS_or_ALLOCA ($VAR)
2269 # -------------------------------
2270 # Definitions common to LIBOBJS and ALLOCA.
2271 # VAR should be one of LIBOBJS, LTLIBOBJS, ALLOCA, or LTALLOCA.
2272 sub handle_LIBOBJS_or_ALLOCA ($)
2274   my ($var) = @_;
2276   my $dir = '';
2278   # If LIBOBJS files must be built in another directory we have
2279   # to define LIBOBJDIR and ensure the files get cleaned.
2280   # Otherwise LIBOBJDIR can be left undefined, and the cleaning
2281   # is achieved by 'rm -f *.$(OBJEXT)' in compile.am.
2282   if ($config_libobj_dir
2283       && $relative_dir ne $config_libobj_dir)
2284     {
2285       if (option 'subdir-objects')
2286         {
2287           # In the top-level Makefile we do not use $(top_builddir), because
2288           # we are already there, and since the targets are built without
2289           # a $(top_builddir), it helps BSD Make to match them with
2290           # dependencies.
2291           $dir = "$config_libobj_dir/"
2292             if $config_libobj_dir ne '.';
2293           $dir = backname ($relative_dir) . "/$dir"
2294             if $relative_dir ne '.';
2295           define_variable ('LIBOBJDIR', "$dir", INTERNAL);
2296           $clean_files{"\$($var)"} = MOSTLY_CLEAN;
2297           # If LTLIBOBJS is used, we must also clear LIBOBJS (which might
2298           # be created by libtool as a side-effect of creating LTLIBOBJS).
2299           $clean_files{"\$($var)"} = MOSTLY_CLEAN if $var =~ s/^LT//;
2300         }
2301       else
2302         {
2303           error ("'\$($var)' cannot be used outside '$config_libobj_dir' if"
2304                  . " 'subdir-objects' is not set");
2305         }
2306     }
2308   return $dir;
2311 sub handle_LIBOBJS ($$$)
2313   my ($var, $cond, $lt) = @_;
2314   my $myobjext = $lt ? 'lo' : 'o';
2315   $lt ||= '';
2317   $var->requires_variables ("\@${lt}LIBOBJS\@ used", $lt . 'LIBOBJS')
2318     if ! keys %libsources;
2320   my $dir = handle_LIBOBJS_or_ALLOCA "${lt}LIBOBJS";
2322   foreach my $iter (keys %libsources)
2323     {
2324       if ($iter =~ /\.[cly]$/)
2325         {
2326           &saw_extension ($&);
2327           &saw_extension ('.c');
2328         }
2330       if ($iter =~ /\.h$/)
2331         {
2332           require_libsource_with_macro ($cond, $var, FOREIGN, $iter);
2333         }
2334       elsif ($iter ne 'alloca.c')
2335         {
2336           my $rewrite = $iter;
2337           $rewrite =~ s/\.c$/.P$myobjext/;
2338           $dep_files{$dir . '$(DEPDIR)/' . $rewrite} = 1;
2339           $rewrite = "^" . quotemeta ($iter) . "\$";
2340           # Only require the file if it is not a built source.
2341           my $bs = var ('BUILT_SOURCES');
2342           if (! $bs || ! grep (/$rewrite/, $bs->value_as_list_recursive))
2343             {
2344               require_libsource_with_macro ($cond, $var, FOREIGN, $iter);
2345             }
2346         }
2347     }
2350 sub handle_ALLOCA ($$$)
2352   my ($var, $cond, $lt) = @_;
2353   my $myobjext = $lt ? 'lo' : 'o';
2354   $lt ||= '';
2355   my $dir = handle_LIBOBJS_or_ALLOCA "${lt}ALLOCA";
2357   $var->requires_variables ("\@${lt}ALLOCA\@ used", $lt . 'ALLOCA');
2358   $dep_files{$dir . '$(DEPDIR)/alloca.P' . $myobjext} = 1;
2359   require_libsource_with_macro ($cond, $var, FOREIGN, 'alloca.c');
2360   &saw_extension ('.c');
2363 # Canonicalize the input parameter
2364 sub canonicalize
2366     my ($string) = @_;
2367     $string =~ tr/A-Za-z0-9_\@/_/c;
2368     return $string;
2371 # Canonicalize a name, and check to make sure the non-canonical name
2372 # is never used.  Returns canonical name.  Arguments are name and a
2373 # list of suffixes to check for.
2374 sub check_canonical_spelling
2376   my ($name, @suffixes) = @_;
2378   my $xname = &canonicalize ($name);
2379   if ($xname ne $name)
2380     {
2381       foreach my $xt (@suffixes)
2382         {
2383           reject_var ("$name$xt", "use '$xname$xt', not '$name$xt'");
2384         }
2385     }
2387   return $xname;
2391 # handle_compile ()
2392 # -----------------
2393 # Set up the compile suite.
2394 sub handle_compile ()
2396    return if ! $must_handle_compiled_objects;
2398     # Boilerplate.
2399     my $default_includes = '';
2400     if (! option 'nostdinc')
2401       {
2402         my @incs = ('-I.', subst ('am__isrc'));
2404         my $var = var 'CONFIG_HEADER';
2405         if ($var)
2406           {
2407             foreach my $hdr (split (' ', $var->variable_value))
2408               {
2409                 push @incs, '-I' . dirname ($hdr);
2410               }
2411           }
2412         # We want '-I. -I$(srcdir)', but the latter -I is redundant
2413         # and unaesthetic in non-VPATH builds.  We use `-I.@am__isrc@`
2414         # instead.  It will be replaced by '-I.' or '-I. -I$(srcdir)'.
2415         # Items in CONFIG_HEADER are never in $(srcdir) so it is safe
2416         # to just put @am__isrc@ right after '-I.', without a space.
2417         ($default_includes = ' ' . uniq (@incs)) =~ s/ @/@/;
2418       }
2420     my (@mostly_rms, @dist_rms);
2421     foreach my $item (sort keys %compile_clean_files)
2422     {
2423         if ($compile_clean_files{$item} == MOSTLY_CLEAN)
2424         {
2425             push (@mostly_rms, "\t-rm -f $item");
2426         }
2427         elsif ($compile_clean_files{$item} == DIST_CLEAN)
2428         {
2429             push (@dist_rms, "\t-rm -f $item");
2430         }
2431         else
2432         {
2433           prog_error 'invalid entry in %compile_clean_files';
2434         }
2435     }
2437     my ($coms, $vars, $rules) =
2438       &file_contents_internal (1, "$libdir/am/compile.am",
2439                                new Automake::Location,
2440                                ('DEFAULT_INCLUDES' => $default_includes,
2441                                 'MOSTLYRMS' => join ("\n", @mostly_rms),
2442                                 'DISTRMS' => join ("\n", @dist_rms)));
2443     $output_vars .= $vars;
2444     $output_rules .= "$coms$rules";
2447 # handle_libtool ()
2448 # -----------------
2449 # Handle libtool rules.
2450 sub handle_libtool
2452   return unless var ('LIBTOOL');
2454   # Libtool requires some files, but only at top level.
2455   # (Starting with Libtool 2.0 we do not have to bother.  These
2456   # requirements are done with AC_REQUIRE_AUX_FILE.)
2457   require_conf_file_with_macro (TRUE, 'LIBTOOL', FOREIGN, @libtool_files)
2458     if $relative_dir eq '.' && ! $libtool_new_api;
2460   my @libtool_rms;
2461   foreach my $item (sort keys %libtool_clean_directories)
2462     {
2463       my $dir = ($item eq '.') ? '' : "$item/";
2464       # .libs is for Unix, _libs for DOS.
2465       push (@libtool_rms, "\t-rm -rf ${dir}.libs ${dir}_libs");
2466     }
2468   check_user_variables 'LIBTOOLFLAGS';
2470   # Output the libtool compilation rules.
2471   $output_rules .= &file_contents ('libtool',
2472                                    new Automake::Location,
2473                                    LTRMS => join ("\n", @libtool_rms));
2476 # handle_programs ()
2477 # ------------------
2478 # Handle C programs.
2479 sub handle_programs
2481   my @proglist = &am_install_var ('progs', 'PROGRAMS',
2482                                   'bin', 'sbin', 'libexec', 'pkglibexec',
2483                                   'noinst', 'check');
2484   return if ! @proglist;
2485   $must_handle_compiled_objects = 1;
2487   my $seen_global_libobjs =
2488     var ('LDADD') && &handle_lib_objects ('', 'LDADD');
2490   foreach my $pair (@proglist)
2491     {
2492       my ($where, $one_file) = @$pair;
2494       my $seen_libobjs = 0;
2495       my $obj = '.$(OBJEXT)';
2497       $known_programs{$one_file} = $where;
2499       # Canonicalize names and check for misspellings.
2500       my $xname = &check_canonical_spelling ($one_file, '_LDADD', '_LDFLAGS',
2501                                              '_SOURCES', '_OBJECTS',
2502                                              '_DEPENDENCIES');
2504       $where->push_context ("while processing program '$one_file'");
2505       $where->set (INTERNAL->get);
2507       my $linker = &handle_source_transform ($xname, $one_file, $obj, $where,
2508                                              NONLIBTOOL => 1, LIBTOOL => 0);
2510       if (var ($xname . "_LDADD"))
2511         {
2512           $seen_libobjs = &handle_lib_objects ($xname, $xname . '_LDADD');
2513         }
2514       else
2515         {
2516           # User didn't define prog_LDADD override.  So do it.
2517           &define_variable ($xname . '_LDADD', '$(LDADD)', $where);
2519           # This does a bit too much work.  But we need it to
2520           # generate _DEPENDENCIES when appropriate.
2521           if (var ('LDADD'))
2522             {
2523               $seen_libobjs = &handle_lib_objects ($xname, 'LDADD');
2524             }
2525         }
2527       reject_var ($xname . '_LIBADD',
2528                   "use '${xname}_LDADD', not '${xname}_LIBADD'");
2530       set_seen ($xname . '_DEPENDENCIES');
2531       set_seen ('EXTRA_' . $xname . '_DEPENDENCIES');
2532       set_seen ($xname . '_LDFLAGS');
2534       # Determine program to use for link.
2535       my($xlink, $vlink) = &define_per_target_linker_variable ($linker, $xname);
2536       $vlink = verbose_flag ($vlink || 'GEN');
2538       # If the resulting program lies in a subdirectory,
2539       # ensure that the directory exists before we need it.
2540       my $dirstamp = require_build_directory_maybe ($one_file);
2542       $libtool_clean_directories{dirname ($one_file)} = 1;
2544       $output_rules .= &file_contents ('program',
2545                                        $where,
2546                                        PROGRAM  => $one_file,
2547                                        XPROGRAM => $xname,
2548                                        XLINK    => $xlink,
2549                                        VERBOSE  => $vlink,
2550                                        DIRSTAMP => $dirstamp,
2551                                        EXEEXT   => '$(EXEEXT)');
2553       if ($seen_libobjs || $seen_global_libobjs)
2554         {
2555           if (var ($xname . '_LDADD'))
2556             {
2557               &check_libobjs_sources ($xname, $xname . '_LDADD');
2558             }
2559           elsif (var ('LDADD'))
2560             {
2561               &check_libobjs_sources ($xname, 'LDADD');
2562             }
2563         }
2564     }
2568 # handle_libraries ()
2569 # -------------------
2570 # Handle libraries.
2571 sub handle_libraries
2573   my @liblist = &am_install_var ('libs', 'LIBRARIES',
2574                                  'lib', 'pkglib', 'noinst', 'check');
2575   return if ! @liblist;
2576   $must_handle_compiled_objects = 1;
2578   my @prefix = am_primary_prefixes ('LIBRARIES', 0, 'lib', 'pkglib',
2579                                     'noinst', 'check');
2581   if (@prefix)
2582     {
2583       my $var = rvar ($prefix[0] . '_LIBRARIES');
2584       $var->requires_variables ('library used', 'RANLIB');
2585     }
2587   &define_variable ('AR', 'ar', INTERNAL);
2588   &define_variable ('ARFLAGS', 'cru', INTERNAL);
2589   &define_verbose_tagvar ('AR');
2591   foreach my $pair (@liblist)
2592     {
2593       my ($where, $onelib) = @$pair;
2595       my $seen_libobjs = 0;
2596       # Check that the library fits the standard naming convention.
2597       my $bn = basename ($onelib);
2598       if ($bn !~ /^lib.*\.a$/)
2599         {
2600           $bn =~ s/^(?:lib)?(.*?)(?:\.[^.]*)?$/lib$1.a/;
2601           my $suggestion = dirname ($onelib) . "/$bn";
2602           $suggestion =~ s|^\./||g;
2603           msg ('error-gnu/warn', $where,
2604                "'$onelib' is not a standard library name\n"
2605                . "did you mean '$suggestion'?")
2606         }
2608       ($known_libraries{$onelib} = $bn) =~ s/\.a$//;
2610       $where->push_context ("while processing library '$onelib'");
2611       $where->set (INTERNAL->get);
2613       my $obj = '.$(OBJEXT)';
2615       # Canonicalize names and check for misspellings.
2616       my $xlib = &check_canonical_spelling ($onelib, '_LIBADD', '_SOURCES',
2617                                             '_OBJECTS', '_DEPENDENCIES',
2618                                             '_AR');
2620       if (! var ($xlib . '_AR'))
2621         {
2622           &define_variable ($xlib . '_AR', '$(AR) $(ARFLAGS)', $where);
2623         }
2625       # Generate support for conditional object inclusion in
2626       # libraries.
2627       if (var ($xlib . '_LIBADD'))
2628         {
2629           if (&handle_lib_objects ($xlib, $xlib . '_LIBADD'))
2630             {
2631               $seen_libobjs = 1;
2632             }
2633         }
2634       else
2635         {
2636           &define_variable ($xlib . "_LIBADD", '', $where);
2637         }
2639       reject_var ($xlib . '_LDADD',
2640                   "use '${xlib}_LIBADD', not '${xlib}_LDADD'");
2642       # Make sure we at look at this.
2643       set_seen ($xlib . '_DEPENDENCIES');
2644       set_seen ('EXTRA_' . $xlib . '_DEPENDENCIES');
2646       &handle_source_transform ($xlib, $onelib, $obj, $where,
2647                                 NONLIBTOOL => 1, LIBTOOL => 0);
2649       # If the resulting library lies in a subdirectory,
2650       # make sure this directory will exist.
2651       my $dirstamp = require_build_directory_maybe ($onelib);
2652       my $verbose = verbose_flag ('AR');
2653       my $silent = silent_flag ();
2655       $output_rules .= &file_contents ('library',
2656                                        $where,
2657                                        VERBOSE  => $verbose,
2658                                        SILENT   => $silent,
2659                                        LIBRARY  => $onelib,
2660                                        XLIBRARY => $xlib,
2661                                        DIRSTAMP => $dirstamp);
2663       if ($seen_libobjs)
2664         {
2665           if (var ($xlib . '_LIBADD'))
2666             {
2667               &check_libobjs_sources ($xlib, $xlib . '_LIBADD');
2668             }
2669         }
2671       if (! $seen_ar)
2672         {
2673           msg ('extra-portability', $where,
2674                "'$onelib': linking libraries using a non-POSIX\n"
2675                . "archiver requires 'AM_PROG_AR' in '$configure_ac'")
2676         }
2677     }
2681 # handle_ltlibraries ()
2682 # ---------------------
2683 # Handle shared libraries.
2684 sub handle_ltlibraries
2686   my @liblist = &am_install_var ('ltlib', 'LTLIBRARIES',
2687                                  'noinst', 'lib', 'pkglib', 'check');
2688   return if ! @liblist;
2689   $must_handle_compiled_objects = 1;
2691   my @prefix = am_primary_prefixes ('LTLIBRARIES', 0, 'lib', 'pkglib',
2692                                     'noinst', 'check');
2694   if (@prefix)
2695     {
2696       my $var = rvar ($prefix[0] . '_LTLIBRARIES');
2697       $var->requires_variables ('Libtool library used', 'LIBTOOL');
2698     }
2700   my %instdirs = ();
2701   my %instsubdirs = ();
2702   my %instconds = ();
2703   my %liblocations = ();        # Location (in Makefile.am) of each library.
2705   foreach my $key (@prefix)
2706     {
2707       # Get the installation directory of each library.
2708       my $dir = $key;
2709       my $strip_subdir = 1;
2710       if ($dir =~ /^nobase_/)
2711         {
2712           $dir =~ s/^nobase_//;
2713           $strip_subdir = 0;
2714         }
2715       my $var = rvar ($key . '_LTLIBRARIES');
2717       # We reject libraries which are installed in several places
2718       # in the same condition, because we can only specify one
2719       # '-rpath' option.
2720       $var->traverse_recursively
2721         (sub
2722          {
2723            my ($var, $val, $cond, $full_cond) = @_;
2724            my $hcond = $full_cond->human;
2725            my $where = $var->rdef ($cond)->location;
2726            my $ldir = '';
2727            $ldir = '/' . dirname ($val)
2728              if (!$strip_subdir);
2729            # A library cannot be installed in different directories
2730            # in overlapping conditions.
2731            if (exists $instconds{$val})
2732              {
2733                my ($msg, $acond) =
2734                  $instconds{$val}->ambiguous_p ($val, $full_cond);
2736                if ($msg)
2737                  {
2738                    error ($where, $msg, partial => 1);
2739                    my $dirtxt = "installed " . ($strip_subdir ? "in" : "below") . " '$dir'";
2740                    $dirtxt = "built for '$dir'"
2741                      if $dir eq 'EXTRA' || $dir eq 'noinst' || $dir eq 'check';
2742                    my $dircond =
2743                      $full_cond->true ? "" : " in condition $hcond";
2745                    error ($where, "'$val' should be $dirtxt$dircond ...",
2746                           partial => 1);
2748                    my $hacond = $acond->human;
2749                    my $adir = $instdirs{$val}{$acond};
2750                    my $adirtxt = "installed in '$adir'";
2751                    $adirtxt = "built for '$adir'"
2752                      if ($adir eq 'EXTRA' || $adir eq 'noinst'
2753                          || $adir eq 'check');
2754                    my $adircond = $acond->true ? "" : " in condition $hacond";
2756                    my $onlyone = ($dir ne $adir) ?
2757                      ("\nLibtool libraries can be built for only one "
2758                       . "destination") : "";
2760                    error ($liblocations{$val}{$acond},
2761                           "... and should also be $adirtxt$adircond.$onlyone");
2762                    return;
2763                  }
2764              }
2765            else
2766              {
2767                $instconds{$val} = new Automake::DisjConditions;
2768              }
2769            $instdirs{$val}{$full_cond} = $dir;
2770            $instsubdirs{$val}{$full_cond} = $ldir;
2771            $liblocations{$val}{$full_cond} = $where;
2772            $instconds{$val} = $instconds{$val}->merge ($full_cond);
2773          },
2774          sub
2775          {
2776            return ();
2777          },
2778          skip_ac_subst => 1);
2779     }
2781   foreach my $pair (@liblist)
2782     {
2783       my ($where, $onelib) = @$pair;
2785       my $seen_libobjs = 0;
2786       my $obj = '.lo';
2788       # Canonicalize names and check for misspellings.
2789       my $xlib = &check_canonical_spelling ($onelib, '_LIBADD', '_LDFLAGS',
2790                                             '_SOURCES', '_OBJECTS',
2791                                             '_DEPENDENCIES');
2793       # Check that the library fits the standard naming convention.
2794       my $libname_rx = '^lib.*\.la';
2795       my $ldvar = var ("${xlib}_LDFLAGS") || var ('AM_LDFLAGS');
2796       my $ldvar2 = var ('LDFLAGS');
2797       if (($ldvar && grep (/-module/, $ldvar->value_as_list_recursive))
2798           || ($ldvar2 && grep (/-module/, $ldvar2->value_as_list_recursive)))
2799         {
2800           # Relax name checking for libtool modules.
2801           $libname_rx = '\.la';
2802         }
2804       my $bn = basename ($onelib);
2805       if ($bn !~ /$libname_rx$/)
2806         {
2807           my $type = 'library';
2808           if ($libname_rx eq '\.la')
2809             {
2810               $bn =~ s/^(lib|)(.*?)(?:\.[^.]*)?$/$1$2.la/;
2811               $type = 'module';
2812             }
2813           else
2814             {
2815               $bn =~ s/^(?:lib)?(.*?)(?:\.[^.]*)?$/lib$1.la/;
2816             }
2817           my $suggestion = dirname ($onelib) . "/$bn";
2818           $suggestion =~ s|^\./||g;
2819           msg ('error-gnu/warn', $where,
2820                "'$onelib' is not a standard libtool $type name\n"
2821                . "did you mean '$suggestion'?")
2822         }
2824       ($known_libraries{$onelib} = $bn) =~ s/\.la$//;
2826       $where->push_context ("while processing Libtool library '$onelib'");
2827       $where->set (INTERNAL->get);
2829       # Make sure we look at these.
2830       set_seen ($xlib . '_LDFLAGS');
2831       set_seen ($xlib . '_DEPENDENCIES');
2832       set_seen ('EXTRA_' . $xlib . '_DEPENDENCIES');
2834       # Generate support for conditional object inclusion in
2835       # libraries.
2836       if (var ($xlib . '_LIBADD'))
2837         {
2838           if (&handle_lib_objects ($xlib, $xlib . '_LIBADD'))
2839             {
2840               $seen_libobjs = 1;
2841             }
2842         }
2843       else
2844         {
2845           &define_variable ($xlib . "_LIBADD", '', $where);
2846         }
2848       reject_var ("${xlib}_LDADD",
2849                   "use '${xlib}_LIBADD', not '${xlib}_LDADD'");
2852       my $linker = &handle_source_transform ($xlib, $onelib, $obj, $where,
2853                                              NONLIBTOOL => 0, LIBTOOL => 1);
2855       # Determine program to use for link.
2856       my($xlink, $vlink) = &define_per_target_linker_variable ($linker, $xlib);
2857       $vlink = verbose_flag ($vlink || 'GEN');
2859       my $rpathvar = "am_${xlib}_rpath";
2860       my $rpath = "\$($rpathvar)";
2861       foreach my $rcond ($instconds{$onelib}->conds)
2862         {
2863           my $val;
2864           if ($instdirs{$onelib}{$rcond} eq 'EXTRA'
2865               || $instdirs{$onelib}{$rcond} eq 'noinst'
2866               || $instdirs{$onelib}{$rcond} eq 'check')
2867             {
2868               # It's an EXTRA_ library, so we can't specify -rpath,
2869               # because we don't know where the library will end up.
2870               # The user probably knows, but generally speaking automake
2871               # doesn't -- and in fact configure could decide
2872               # dynamically between two different locations.
2873               $val = '';
2874             }
2875           else
2876             {
2877               $val = ('-rpath $(' . $instdirs{$onelib}{$rcond} . 'dir)');
2878               $val .= $instsubdirs{$onelib}{$rcond}
2879                 if defined $instsubdirs{$onelib}{$rcond};
2880             }
2881           if ($rcond->true)
2882             {
2883               # If $rcond is true there is only one condition and
2884               # there is no point defining an helper variable.
2885               $rpath = $val;
2886             }
2887           else
2888             {
2889               define_pretty_variable ($rpathvar, $rcond, INTERNAL, $val);
2890             }
2891         }
2893       # If the resulting library lies in a subdirectory,
2894       # make sure this directory will exist.
2895       my $dirstamp = require_build_directory_maybe ($onelib);
2897       # Remember to cleanup .libs/ in this directory.
2898       my $dirname = dirname $onelib;
2899       $libtool_clean_directories{$dirname} = 1;
2901       $output_rules .= &file_contents ('ltlibrary',
2902                                        $where,
2903                                        LTLIBRARY  => $onelib,
2904                                        XLTLIBRARY => $xlib,
2905                                        RPATH      => $rpath,
2906                                        XLINK      => $xlink,
2907                                        VERBOSE    => $vlink,
2908                                        DIRSTAMP   => $dirstamp);
2909       if ($seen_libobjs)
2910         {
2911           if (var ($xlib . '_LIBADD'))
2912             {
2913               &check_libobjs_sources ($xlib, $xlib . '_LIBADD');
2914             }
2915         }
2917       if (! $seen_ar)
2918         {
2919           msg ('extra-portability', $where,
2920                "'$onelib': linking libtool libraries using a non-POSIX\n"
2921                . "archiver requires 'AM_PROG_AR' in '$configure_ac'")
2922         }
2923     }
2926 # See if any _SOURCES variable were misspelled.
2927 sub check_typos ()
2929   # It is ok if the user sets this particular variable.
2930   set_seen 'AM_LDFLAGS';
2932   foreach my $primary ('SOURCES', 'LIBADD', 'LDADD', 'LDFLAGS', 'DEPENDENCIES')
2933     {
2934       foreach my $var (variables $primary)
2935         {
2936           my $varname = $var->name;
2937           # A configure variable is always legitimate.
2938           next if exists $configure_vars{$varname};
2940           for my $cond ($var->conditions->conds)
2941             {
2942               $varname =~ /^(?:EXTRA_)?(?:nobase_)?(?:dist_|nodist_)?(.*)_[[:alnum:]]+$/;
2943               msg_var ('syntax', $var, "variable '$varname' is defined but no"
2944                        . " program or\nlibrary has '$1' as canonical name"
2945                        . " (possible typo)")
2946                 unless $var->rdef ($cond)->seen;
2947             }
2948         }
2949     }
2953 # Handle scripts.
2954 sub handle_scripts
2956     # NOTE we no longer automatically clean SCRIPTS, because it is
2957     # useful to sometimes distribute scripts verbatim.  This happens
2958     # e.g. in Automake itself.
2959     &am_install_var ('-candist', 'scripts', 'SCRIPTS',
2960                      'bin', 'sbin', 'libexec', 'pkglibexec', 'pkgdata',
2961                      'noinst', 'check');
2967 ## ------------------------ ##
2968 ## Handling Texinfo files.  ##
2969 ## ------------------------ ##
2971 # ($OUTFILE, $VFILE)
2972 # &scan_texinfo_file ($FILENAME)
2973 # ------------------------------
2974 # $OUTFILE     - name of the info file produced by $FILENAME.
2975 # $VFILE       - name of the version.texi file used (undef if none).
2976 sub scan_texinfo_file ($)
2978   my ($filename) = @_;
2980   my $texi = new Automake::XFile "< $filename";
2981   verb "reading $filename";
2983   my ($outfile, $vfile);
2984   while ($_ = $texi->getline)
2985     {
2986       if (/^\@setfilename +(\S+)/)
2987         {
2988           # Honor only the first @setfilename.  (It's possible to have
2989           # more occurrences later if the manual shows examples of how
2990           # to use @setfilename...)
2991           next if $outfile;
2993           $outfile = $1;
2994           if ($outfile =~ /\.([^.]+)$/ && $1 ne 'info')
2995             {
2996               error ("$filename:$.",
2997                      "output '$outfile' has unrecognized extension");
2998               return;
2999             }
3000         }
3001       # A "version.texi" file is actually any file whose name matches
3002       # "vers*.texi".
3003       elsif (/^\@include\s+(vers[^.]*\.texi)\s*$/)
3004         {
3005           $vfile = $1;
3006         }
3007     }
3009   if (! $outfile)
3010     {
3011       err_am "'$filename' missing \@setfilename";
3012       return;
3013     }
3015   my $infobase = basename ($filename);
3016   $infobase =~ s/\.te?xi(nfo)?$//;
3017   return ($outfile, $vfile);
3021 # ($DIRSTAMP, @CLEAN_FILES)
3022 # output_texinfo_build_rules ($SOURCE, $DEST, $INSRC, @DEPENDENCIES)
3023 # ------------------------------------------------------------------
3024 # SOURCE - the source Texinfo file
3025 # DEST - the destination Info file
3026 # INSRC - whether DEST should be built in the source tree
3027 # DEPENDENCIES - known dependencies
3028 sub output_texinfo_build_rules ($$$@)
3030   my ($source, $dest, $insrc, @deps) = @_;
3032   # Split 'a.texi' into 'a' and '.texi'.
3033   my ($spfx, $ssfx) = ($source =~ /^(.*?)(\.[^.]*)?$/);
3034   my ($dpfx, $dsfx) = ($dest =~ /^(.*?)(\.[^.]*)?$/);
3036   $ssfx ||= "";
3037   $dsfx ||= "";
3039   # We can output two kinds of rules: the "generic" rules use Make
3040   # suffix rules and are appropriate when $source and $dest do not lie
3041   # in a sub-directory; the "specific" rules are needed in the other
3042   # case.
3043   #
3044   # The former are output only once (this is not really apparent here,
3045   # but just remember that some logic deeper in Automake will not
3046   # output the same rule twice); while the later need to be output for
3047   # each Texinfo source.
3048   my $generic;
3049   my $makeinfoflags;
3050   my $sdir = dirname $source;
3051   if ($sdir eq '.' && dirname ($dest) eq '.')
3052     {
3053       $generic = 1;
3054       $makeinfoflags = '-I $(srcdir)';
3055     }
3056   else
3057     {
3058       $generic = 0;
3059       $makeinfoflags = "-I $sdir -I \$(srcdir)/$sdir";
3060     }
3062   # A directory can contain two kinds of info files: some built in the
3063   # source tree, and some built in the build tree.  The rules are
3064   # different in each case.  However we cannot output two different
3065   # set of generic rules.  Because in-source builds are more usual, we
3066   # use generic rules in this case and fall back to "specific" rules
3067   # for build-dir builds.  (It should not be a problem to invert this
3068   # if needed.)
3069   $generic = 0 unless $insrc;
3071   # We cannot use a suffix rule to build info files with an empty
3072   # extension.  Otherwise we would output a single suffix inference
3073   # rule, with separate dependencies, as in
3074   #
3075   #    .texi:
3076   #             $(MAKEINFO) ...
3077   #    foo.info: foo.texi
3078   #
3079   # which confuse Solaris make.  (See the Autoconf manual for
3080   # details.)  Therefore we use a specific rule in this case.  This
3081   # applies to info files only (dvi and pdf files always have an
3082   # extension).
3083   my $generic_info = ($generic && $dsfx) ? 1 : 0;
3085   # If the resulting file lies in a subdirectory,
3086   # make sure this directory will exist.
3087   my $dirstamp = require_build_directory_maybe ($dest);
3089   my $dipfx = ($insrc ? '$(srcdir)/' : '') . $dpfx;
3091   $output_rules .= file_contents ('texibuild',
3092                                   new Automake::Location,
3093                                   AM_V_MAKEINFO    => verbose_flag('MAKEINFO'),
3094                                   AM_V_TEXI2DVI    => verbose_flag('TEXI2DVI'),
3095                                   AM_V_TEXI2PDF    => verbose_flag('TEXI2PDF'),
3096                                   DEPS             => "@deps",
3097                                   DEST_PREFIX      => $dpfx,
3098                                   DEST_INFO_PREFIX => $dipfx,
3099                                   DEST_SUFFIX      => $dsfx,
3100                                   DIRSTAMP         => $dirstamp,
3101                                   GENERIC          => $generic,
3102                                   GENERIC_INFO     => $generic_info,
3103                                   INSRC            => $insrc,
3104                                   MAKEINFOFLAGS    => $makeinfoflags,
3105                                   SILENT           => silent_flag(),
3106                                   SOURCE           => ($generic
3107                                                        ? '$<' : $source),
3108                                   SOURCE_INFO      => ($generic_info
3109                                                        ? '$<' : $source),
3110                                   SOURCE_REAL      => $source,
3111                                   SOURCE_SUFFIX    => $ssfx,
3112                                   TEXIQUIET        => verbose_flag('texinfo'),
3113                                   TEXIDEVNULL      => verbose_flag('texidevnull'),
3114                                   );
3115   return ($dirstamp, "$dpfx.dvi", "$dpfx.pdf", "$dpfx.ps", "$dpfx.html");
3119 # ($MOSTLYCLEAN, $TEXICLEAN, $MAINTCLEAN)
3120 # handle_texinfo_helper ($info_texinfos)
3121 # --------------------------------------
3122 # Handle all Texinfo source; helper for handle_texinfo.
3123 sub handle_texinfo_helper ($)
3125   my ($info_texinfos) = @_;
3126   my (@infobase, @info_deps_list, @texi_deps);
3127   my %versions;
3128   my $done = 0;
3129   my (@mostly_cleans, @texi_cleans, @maint_cleans) = ('', '', '');
3131   # Build a regex matching user-cleaned files.
3132   my $d = var 'DISTCLEANFILES';
3133   my $c = var 'CLEANFILES';
3134   my @f = ();
3135   push @f, $d->value_as_list_recursive (inner_expand => 1) if $d;
3136   push @f, $c->value_as_list_recursive (inner_expand => 1) if $c;
3137   @f = map { s|[^A-Za-z_0-9*\[\]\-]|\\$&|g; s|\*|[^/]*|g; $_; } @f;
3138   my $user_cleaned_files = '^(?:' . join ('|', @f) . ')$';
3140   foreach my $texi
3141       ($info_texinfos->value_as_list_recursive (inner_expand => 1))
3142     {
3143       my $infobase = $texi;
3144       $infobase =~ s/\.(txi|texinfo|texi)$//;
3146       if ($infobase eq $texi)
3147         {
3148           # FIXME: report line number.
3149           err_am "texinfo file '$texi' has unrecognized extension";
3150           next;
3151         }
3153       push @infobase, $infobase;
3155       # If 'version.texi' is referenced by input file, then include
3156       # automatic versioning capability.
3157       my ($out_file, $vtexi) =
3158         scan_texinfo_file ("$relative_dir/$texi")
3159         or next;
3160       # Directory of auxiliary files and build by-products used by texi2dvi
3161       # and texi2pdf.
3162       push @mostly_cleans, "$infobase.t2d";
3163       push @mostly_cleans, "$infobase.t2p";
3165       # If the Texinfo source is in a subdirectory, create the
3166       # resulting info in this subdirectory.  If it is in the current
3167       # directory, try hard to not prefix "./" because it breaks the
3168       # generic rules.
3169       my $outdir = dirname ($texi) . '/';
3170       $outdir = "" if $outdir eq './';
3171       $out_file =  $outdir . $out_file;
3173       # Until Automake 1.6.3, .info files were built in the
3174       # source tree.  This was an obstacle to the support of
3175       # non-distributed .info files, and non-distributed .texi
3176       # files.
3177       #
3178       # * Non-distributed .texi files is important in some packages
3179       #   where .texi files are built at make time, probably using
3180       #   other binaries built in the package itself, maybe using
3181       #   tools or information found on the build host.  Because
3182       #   these files are not distributed they are always rebuilt
3183       #   at make time; they should therefore not lie in the source
3184       #   directory.  One plan was to support this using
3185       #   nodist_info_TEXINFOS or something similar.  (Doing this
3186       #   requires some sanity checks.  For instance Automake should
3187       #   not allow:
3188       #      dist_info_TEXINFOS = foo.texi
3189       #      nodist_foo_TEXINFOS = included.texi
3190       #   because a distributed file should never depend on a
3191       #   non-distributed file.)
3192       #
3193       # * If .texi files are not distributed, then .info files should
3194       #   not be distributed either.  There are also cases where one
3195       #   wants to distribute .texi files, but does not want to
3196       #   distribute the .info files.  For instance the Texinfo package
3197       #   distributes the tool used to build these files; it would
3198       #   be a waste of space to distribute them.  It's not clear
3199       #   which syntax we should use to indicate that .info files should
3200       #   not be distributed.  Akim Demaille suggested that eventually
3201       #   we switch to a new syntax:
3202       #   |  Maybe we should take some inspiration from what's already
3203       #   |  done in the rest of Automake.  Maybe there is too much
3204       #   |  syntactic sugar here, and you want
3205       #   |     nodist_INFO = bar.info
3206       #   |     dist_bar_info_SOURCES = bar.texi
3207       #   |     bar_texi_DEPENDENCIES = foo.texi
3208       #   |  with a bit of magic to have bar.info represent the whole
3209       #   |  bar*info set.  That's a lot more verbose that the current
3210       #   |  situation, but it is # not new, hence the user has less
3211       #   |  to learn.
3212       #   |
3213       #   |  But there is still too much room for meaningless specs:
3214       #   |     nodist_INFO = bar.info
3215       #   |     dist_bar_info_SOURCES = bar.texi
3216       #   |     dist_PS = bar.ps something-written-by-hand.ps
3217       #   |     nodist_bar_ps_SOURCES = bar.texi
3218       #   |     bar_texi_DEPENDENCIES = foo.texi
3219       #   |  here bar.texi is dist_ in line 2, and nodist_ in 4.
3220       #
3221       # Back to the point, it should be clear that in order to support
3222       # non-distributed .info files, we need to build them in the
3223       # build tree, not in the source tree (non-distributed .texi
3224       # files are less of a problem, because we do not output build
3225       # rules for them).  In Automake 1.7 .info build rules have been
3226       # largely cleaned up so that .info files get always build in the
3227       # build tree, even when distributed.  The idea was that
3228       #   (1) if during a VPATH build the .info file was found to be
3229       #       absent or out-of-date (in the source tree or in the
3230       #       build tree), Make would rebuild it in the build tree.
3231       #       If an up-to-date source-tree of the .info file existed,
3232       #       make would not rebuild it in the build tree.
3233       #   (2) having two copies of .info files, one in the source tree
3234       #       and one (newer) in the build tree is not a problem
3235       #       because 'make dist' always pick files in the build tree
3236       #       first.
3237       # However it turned out the be a bad idea for several reasons:
3238       #   * Tru64, OpenBSD, and FreeBSD (not NetBSD) Make do not behave
3239       #     like GNU Make on point (1) above.  These implementations
3240       #     of Make would always rebuild .info files in the build
3241       #     tree, even if such files were up to date in the source
3242       #     tree.  Consequently, it was impossible to perform a VPATH
3243       #     build of a package containing Texinfo files using these
3244       #     Make implementations.
3245       #     (Refer to the Autoconf Manual, section "Limitation of
3246       #     Make", paragraph "VPATH", item "target lookup", for
3247       #     an account of the differences between these
3248       #     implementations.)
3249       #   * The GNU Coding Standards require these files to be built
3250       #     in the source-tree (when they are distributed, that is).
3251       #   * Keeping a fresher copy of distributed files in the
3252       #     build tree can be annoying during development because
3253       #     - if the files is kept under CVS, you really want it
3254       #       to be updated in the source tree
3255       #     - it is confusing that 'make distclean' does not erase
3256       #       all files in the build tree.
3257       #
3258       # Consequently, starting with Automake 1.8, .info files are
3259       # built in the source tree again.  Because we still plan to
3260       # support non-distributed .info files at some point, we
3261       # have a single variable ($INSRC) that controls whether
3262       # the current .info file must be built in the source tree
3263       # or in the build tree.  Actually this variable is switched
3264       # off for .info files that appear to be cleaned; this is
3265       # for backward compatibility with package such as Texinfo,
3266       # which do things like
3267       #   info_TEXINFOS = texinfo.txi info-stnd.texi info.texi
3268       #   DISTCLEANFILES = texinfo texinfo-* info*.info*
3269       #   # Do not create info files for distribution.
3270       #   dist-info:
3271       # in order not to distribute .info files.
3272       my $insrc = ($out_file =~ $user_cleaned_files) ? 0 : 1;
3274       my $soutdir = '$(srcdir)/' . $outdir;
3275       $outdir = $soutdir if $insrc;
3277       # If user specified file_TEXINFOS, then use that as explicit
3278       # dependency list.
3279       @texi_deps = ();
3280       push (@texi_deps, "$soutdir$vtexi") if $vtexi;
3282       my $canonical = canonicalize ($infobase);
3283       if (var ($canonical . "_TEXINFOS"))
3284         {
3285           push (@texi_deps, '$(' . $canonical . '_TEXINFOS)');
3286           push_dist_common ('$(' . $canonical . '_TEXINFOS)');
3287         }
3289       my ($dirstamp, @cfiles) =
3290         output_texinfo_build_rules ($texi, $out_file, $insrc, @texi_deps);
3291       push (@texi_cleans, @cfiles);
3293       push (@info_deps_list, $out_file);
3295       # If a vers*.texi file is needed, emit the rule.
3296       if ($vtexi)
3297         {
3298           err_am ("'$vtexi', included in '$texi', "
3299                   . "also included in '$versions{$vtexi}'")
3300             if defined $versions{$vtexi};
3301           $versions{$vtexi} = $texi;
3303           # We number the stamp-vti files.  This is doable since the
3304           # actual names don't matter much.  We only number starting
3305           # with the second one, so that the common case looks nice.
3306           my $vti = ($done ? $done : 'vti');
3307           ++$done;
3309           # This is ugly, but it is our historical practice.
3310           if ($config_aux_dir_set_in_configure_ac)
3311             {
3312               require_conf_file_with_macro (TRUE, 'info_TEXINFOS', FOREIGN,
3313                                             'mdate-sh');
3314             }
3315           else
3316             {
3317               require_file_with_macro (TRUE, 'info_TEXINFOS',
3318                                        FOREIGN, 'mdate-sh');
3319             }
3321           my $conf_dir;
3322           if ($config_aux_dir_set_in_configure_ac)
3323             {
3324               $conf_dir = "$am_config_aux_dir/";
3325             }
3326           else
3327             {
3328               $conf_dir = '$(srcdir)/';
3329             }
3330           $output_rules .= file_contents ('texi-vers',
3331                                           new Automake::Location,
3332                                           TEXI     => $texi,
3333                                           VTI      => $vti,
3334                                           STAMPVTI => "${soutdir}stamp-$vti",
3335                                           VTEXI    => "$soutdir$vtexi",
3336                                           MDDIR    => $conf_dir,
3337                                           DIRSTAMP => $dirstamp);
3338         }
3339     }
3341   # Handle location of texinfo.tex.
3342   my $need_texi_file = 0;
3343   my $texinfodir;
3344   if (var ('TEXINFO_TEX'))
3345     {
3346       # The user defined TEXINFO_TEX so assume he knows what he is
3347       # doing.
3348       $texinfodir = ('$(srcdir)/'
3349                      . dirname (variable_value ('TEXINFO_TEX')));
3350     }
3351   elsif ($config_aux_dir_set_in_configure_ac)
3352     {
3353       $texinfodir = $am_config_aux_dir;
3354       define_variable ('TEXINFO_TEX', "$texinfodir/texinfo.tex", INTERNAL);
3355       $need_texi_file = 2; # so that we require_conf_file later
3356     }
3357   else
3358     {
3359       $texinfodir = '$(srcdir)';
3360       $need_texi_file = 1;
3361     }
3362   define_variable ('am__TEXINFO_TEX_DIR', $texinfodir, INTERNAL);
3364   push (@dist_targets, 'dist-info');
3366   if (! option 'no-installinfo')
3367     {
3368       # Make sure documentation is made and installed first.  Use
3369       # $(INFO_DEPS), not 'info', because otherwise recursive makes
3370       # get run twice during "make all".
3371       unshift (@all, '$(INFO_DEPS)');
3372     }
3374   define_files_variable ("DVIS", @infobase, 'dvi', INTERNAL);
3375   define_files_variable ("PDFS", @infobase, 'pdf', INTERNAL);
3376   define_files_variable ("PSS", @infobase, 'ps', INTERNAL);
3377   define_files_variable ("HTMLS", @infobase, 'html', INTERNAL);
3379   # This next isn't strictly needed now -- the places that look here
3380   # could easily be changed to look in info_TEXINFOS.  But this is
3381   # probably better, in case noinst_TEXINFOS is ever supported.
3382   define_variable ("TEXINFOS", variable_value ('info_TEXINFOS'), INTERNAL);
3384   # Do some error checking.  Note that this file is not required
3385   # when in Cygnus mode; instead we defined TEXINFO_TEX explicitly
3386   # up above.
3387   if ($need_texi_file && ! option 'no-texinfo.tex')
3388     {
3389       if ($need_texi_file > 1)
3390         {
3391           require_conf_file_with_macro (TRUE, 'info_TEXINFOS', FOREIGN,
3392                                         'texinfo.tex');
3393         }
3394       else
3395         {
3396           require_file_with_macro (TRUE, 'info_TEXINFOS', FOREIGN,
3397                                    'texinfo.tex');
3398         }
3399     }
3401   return (makefile_wrap ("", "\t  ", @mostly_cleans),
3402           makefile_wrap ("", "\t  ", @texi_cleans),
3403           makefile_wrap ("", "\t  ", @maint_cleans));
3407 # handle_texinfo ()
3408 # -----------------
3409 # Handle all Texinfo source.
3410 sub handle_texinfo ()
3412   reject_var 'TEXINFOS', "'TEXINFOS' is an anachronism; use 'info_TEXINFOS'";
3413   # FIXME: I think this is an obsolete future feature name.
3414   reject_var 'html_TEXINFOS', "HTML generation not yet supported";
3416   my $info_texinfos = var ('info_TEXINFOS');
3417   my ($mostlyclean, $clean, $maintclean) = ('', '', '');
3418   if ($info_texinfos)
3419     {
3420       define_verbose_texinfo;
3421       ($mostlyclean, $clean, $maintclean) = handle_texinfo_helper ($info_texinfos);
3422       chomp $mostlyclean;
3423       chomp $clean;
3424       chomp $maintclean;
3425     }
3427   $output_rules .=  file_contents ('texinfos',
3428                                    new Automake::Location,
3429                                    AM_V_DVIPS    => verbose_flag('DVIPS'),
3430                                    MOSTLYCLEAN   => $mostlyclean,
3431                                    TEXICLEAN     => $clean,
3432                                    MAINTCLEAN    => $maintclean,
3433                                    'LOCAL-TEXIS' => !!$info_texinfos,
3434                                    TEXIQUIET     => verbose_flag('texinfo'));
3438 # Handle any man pages.
3439 sub handle_man_pages
3441   reject_var 'MANS', "'MANS' is an anachronism; use 'man_MANS'";
3443   # Find all the sections in use.  We do this by first looking for
3444   # "standard" sections, and then looking for any additional
3445   # sections used in man_MANS.
3446   my (%sections, %notrans_sections, %trans_sections,
3447       %notrans_vars, %trans_vars, %notrans_sect_vars, %trans_sect_vars);
3448   # We handle nodist_ for uniformity.  man pages aren't distributed
3449   # by default so it isn't actually very important.
3450   foreach my $npfx ('', 'notrans_')
3451     {
3452       foreach my $pfx ('', 'dist_', 'nodist_')
3453         {
3454           # Add more sections as needed.
3455           foreach my $section ('0'..'9', 'n', 'l')
3456             {
3457               my $varname = $npfx . $pfx . 'man' . $section . '_MANS';
3458               if (var ($varname))
3459                 {
3460                   $sections{$section} = 1;
3461                   $varname = '$(' . $varname . ')';
3462                   if ($npfx eq 'notrans_')
3463                     {
3464                       $notrans_sections{$section} = 1;
3465                       $notrans_sect_vars{$varname} = 1;
3466                     }
3467                   else
3468                     {
3469                       $trans_sections{$section} = 1;
3470                       $trans_sect_vars{$varname} = 1;
3471                     }
3473                   &push_dist_common ($varname)
3474                     if $pfx eq 'dist_';
3475                 }
3476             }
3478           my $varname = $npfx . $pfx . 'man_MANS';
3479           my $var = var ($varname);
3480           if ($var)
3481             {
3482               foreach ($var->value_as_list_recursive)
3483                 {
3484                   # A page like 'foo.1c' goes into man1dir.
3485                   if (/\.([0-9a-z])([a-z]*)$/)
3486                     {
3487                       $sections{$1} = 1;
3488                       if ($npfx eq 'notrans_')
3489                         {
3490                           $notrans_sections{$1} = 1;
3491                         }
3492                       else
3493                         {
3494                           $trans_sections{$1} = 1;
3495                         }
3496                     }
3497                 }
3499               $varname = '$(' . $varname . ')';
3500               if ($npfx eq 'notrans_')
3501                 {
3502                   $notrans_vars{$varname} = 1;
3503                 }
3504               else
3505                 {
3506                   $trans_vars{$varname} = 1;
3507                 }
3508               &push_dist_common ($varname)
3509                 if $pfx eq 'dist_';
3510             }
3511         }
3512     }
3514   return unless %sections;
3516   my @unsorted_deps;
3518   # Build section independent variables.
3519   my $have_notrans = %notrans_vars;
3520   my @notrans_list = sort keys %notrans_vars;
3521   my $have_trans = %trans_vars;
3522   my @trans_list = sort keys %trans_vars;
3524   # Now for each section, generate an install and uninstall rule.
3525   # Sort sections so output is deterministic.
3526   foreach my $section (sort keys %sections)
3527     {
3528       # Build section dependent variables.
3529       my $notrans_mans = $have_notrans || exists $notrans_sections{$section};
3530       my $trans_mans = $have_trans || exists $trans_sections{$section};
3531       my (%notrans_this_sect, %trans_this_sect);
3532       my $expr = 'man' . $section . '_MANS';
3533       foreach my $varname (keys %notrans_sect_vars)
3534         {
3535           if ($varname =~ /$expr/)
3536             {
3537               $notrans_this_sect{$varname} = 1;
3538             }
3539         }
3540       foreach my $varname (keys %trans_sect_vars)
3541         {
3542           if ($varname =~ /$expr/)
3543             {
3544               $trans_this_sect{$varname} = 1;
3545             }
3546         }
3547       my @notrans_sect_list = sort keys %notrans_this_sect;
3548       my @trans_sect_list = sort keys %trans_this_sect;
3549       @unsorted_deps = (keys %notrans_vars, keys %trans_vars,
3550                         keys %notrans_this_sect, keys %trans_this_sect);
3551       my @deps = sort @unsorted_deps;
3552       $output_rules .= &file_contents ('mans',
3553                                        new Automake::Location,
3554                                        SECTION           => $section,
3555                                        DEPS              => "@deps",
3556                                        NOTRANS_MANS      => $notrans_mans,
3557                                        NOTRANS_SECT_LIST => "@notrans_sect_list",
3558                                        HAVE_NOTRANS      => $have_notrans,
3559                                        NOTRANS_LIST      => "@notrans_list",
3560                                        TRANS_MANS        => $trans_mans,
3561                                        TRANS_SECT_LIST   => "@trans_sect_list",
3562                                        HAVE_TRANS        => $have_trans,
3563                                        TRANS_LIST        => "@trans_list");
3564     }
3566   @unsorted_deps  = (keys %notrans_vars, keys %trans_vars,
3567                      keys %notrans_sect_vars, keys %trans_sect_vars);
3568   my @mans = sort @unsorted_deps;
3569   $output_vars .= file_contents ('mans-vars',
3570                                  new Automake::Location,
3571                                  MANS => "@mans");
3573   push (@all, '$(MANS)')
3574     unless option 'no-installman';
3577 # Handle DATA variables.
3578 sub handle_data
3580     &am_install_var ('-noextra', '-candist', 'data', 'DATA',
3581                      'data', 'dataroot', 'doc', 'dvi', 'html', 'pdf',
3582                      'ps', 'sysconf', 'sharedstate', 'localstate',
3583                      'pkgdata', 'lisp', 'noinst', 'check');
3586 # Handle TAGS.
3587 sub handle_tags
3589     my @config;
3590     foreach my $spec (@config_headers)
3591       {
3592         my ($out, @ins) = split_config_file_spec ($spec);
3593         foreach my $in (@ins)
3594           {
3595             # If the config header source is in this directory,
3596             # require it.
3597             push @config, basename ($in)
3598               if $relative_dir eq dirname ($in);
3599            }
3600       }
3602     define_variable ('am__tagged_files',
3603                      '$(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)'
3604                      . "@config", INTERNAL);
3606     if (rvar('am__tagged_files')->value_as_list_recursive
3607           || var ('ETAGS_ARGS') || var ('SUBDIRS'))
3608       {
3609         $output_rules .= &file_contents ('tags', new Automake::Location);
3610         set_seen 'TAGS_DEPENDENCIES';
3611       }
3612     else
3613       {
3614         reject_var ('TAGS_DEPENDENCIES',
3615                     "it doesn't make sense to define 'TAGS_DEPENDENCIES'"
3616                     . " without\nsources or 'ETAGS_ARGS'");
3617         # Every Makefile must define some sort of TAGS rule.
3618         # Otherwise, it would be possible for a top-level "make TAGS"
3619         # to fail because some subdirectory failed.  Ditto ctags and
3620         # cscope.
3621         $output_rules .=
3622           "tags TAGS:\n\n" .
3623           "ctags CTAGS:\n\n" .
3624           "cscope cscopelist:\n\n";
3625       }
3629 # user_phony_rule ($NAME)
3630 # -----------------------
3631 # Return false if rule $NAME does not exist.  Otherwise,
3632 # declare it as phony, complete its definition (in case it is
3633 # conditional), and return its Automake::Rule instance.
3634 sub user_phony_rule ($)
3636   my ($name) = @_;
3637   my $rule = rule $name;
3638   if ($rule)
3639     {
3640       depend ('.PHONY', $name);
3641       # Define $NAME in all condition where it is not already defined,
3642       # so that it is always OK to depend on $NAME.
3643       for my $c ($rule->not_always_defined_in_cond (TRUE)->conds)
3644         {
3645           Automake::Rule::define ($name, 'internal', RULE_AUTOMAKE,
3646                                   $c, INTERNAL);
3647           $output_rules .= $c->subst_string . "$name:\n";
3648         }
3649     }
3650   return $rule;
3654 # handle_dist
3655 # -----------
3656 # Handle 'dist' target.
3657 sub handle_dist ()
3659   # Substitutions for distdir.am
3660   my %transform;
3662   # Define DIST_SUBDIRS.  This must always be done, regardless of the
3663   # no-dist setting: target like 'distclean' or 'maintainer-clean' use it.
3664   my $subdirs = var ('SUBDIRS');
3665   if ($subdirs)
3666     {
3667       # If SUBDIRS is conditionally defined, then set DIST_SUBDIRS
3668       # to all possible directories, and use it.  If DIST_SUBDIRS is
3669       # defined, just use it.
3671       # Note that we check DIST_SUBDIRS first on purpose, so that
3672       # we don't call has_conditional_contents for now reason.
3673       # (In the past one project used so many conditional subdirectories
3674       # that calling has_conditional_contents on SUBDIRS caused
3675       # automake to grow to 150Mb -- this should not happen with
3676       # the current implementation of has_conditional_contents,
3677       # but it's more efficient to avoid the call anyway.)
3678       if (var ('DIST_SUBDIRS'))
3679         {
3680         }
3681       elsif ($subdirs->has_conditional_contents)
3682         {
3683           define_pretty_variable
3684             ('DIST_SUBDIRS', TRUE, INTERNAL,
3685              uniq ($subdirs->value_as_list_recursive));
3686         }
3687       else
3688         {
3689           # We always define this because that is what 'distclean'
3690           # wants.
3691           define_pretty_variable ('DIST_SUBDIRS', TRUE, INTERNAL,
3692                                   '$(SUBDIRS)');
3693         }
3694     }
3696   # The remaining definitions are only required when a dist target is used.
3697   return if option 'no-dist';
3699   # At least one of the archive formats must be enabled.
3700   if ($relative_dir eq '.')
3701     {
3702       my $archive_defined = option 'no-dist-gzip' ? 0 : 1;
3703       $archive_defined ||=
3704         grep { option "dist-$_" } qw(shar zip tarZ bzip2 lzip xz);
3705       error (option 'no-dist-gzip',
3706              "no-dist-gzip specified but no dist-* specified,\n"
3707              . "at least one archive format must be enabled")
3708         unless $archive_defined;
3709     }
3711   # Look for common files that should be included in distribution.
3712   # If the aux dir is set, and it does not have a Makefile.am, then
3713   # we check for these files there as well.
3714   my $check_aux = 0;
3715   if ($relative_dir eq '.'
3716       && $config_aux_dir_set_in_configure_ac)
3717     {
3718       if (! &is_make_dir ($config_aux_dir))
3719         {
3720           $check_aux = 1;
3721         }
3722     }
3723   foreach my $cfile (@common_files)
3724     {
3725       if (dir_has_case_matching_file ($relative_dir, $cfile)
3726           # The file might be absent, but if it can be built it's ok.
3727           || rule $cfile)
3728         {
3729           &push_dist_common ($cfile);
3730         }
3732       # Don't use 'elsif' here because a file might meaningfully
3733       # appear in both directories.
3734       if ($check_aux && dir_has_case_matching_file ($config_aux_dir, $cfile))
3735         {
3736           &push_dist_common ("$config_aux_dir/$cfile")
3737         }
3738     }
3740   # We might copy elements from $configure_dist_common to
3741   # %dist_common if we think we need to.  If the file appears in our
3742   # directory, we would have discovered it already, so we don't
3743   # check that.  But if the file is in a subdir without a Makefile,
3744   # we want to distribute it here if we are doing '.'.  Ugly!
3745   # Also, in some corner cases, it's possible that the following code
3746   # will cause the same file to appear in the $(DIST_COMMON) variables
3747   # of two distinct Makefiles; but this is not a problem, since the
3748   # 'distdir' target in 'lib/am/distdir.am' can deal with the same
3749   # file being distributed multiple times.
3750   # See also automake bug#9651.
3751   if ($relative_dir eq '.')
3752     {
3753       foreach my $file (split (' ' , $configure_dist_common))
3754         {
3755           my $dir = dirname ($file);
3756           push_dist_common ($file)
3757             if ($dir eq '.' || ! is_make_dir ($dir));
3758         }
3759     }
3761   # Files to distributed.  Don't use ->value_as_list_recursive
3762   # as it recursively expands '$(dist_pkgdata_DATA)' etc.
3763   my @dist_common = split (' ', rvar ('DIST_COMMON')->variable_value);
3764   @dist_common = uniq @dist_common;
3765   variable_delete 'DIST_COMMON';
3766   define_pretty_variable ('DIST_COMMON', TRUE, INTERNAL, @dist_common);
3768   # Now that we've processed DIST_COMMON, disallow further attempts
3769   # to set it.
3770   $handle_dist_run = 1;
3772   $transform{'DISTCHECK-HOOK'} = !! rule 'distcheck-hook';
3773   $transform{'GETTEXT'} = $seen_gettext && !$seen_gettext_external;
3775   # If the target 'dist-hook' exists, make sure it is run.  This
3776   # allows users to do random weird things to the distribution
3777   # before it is packaged up.
3778   push (@dist_targets, 'dist-hook')
3779     if user_phony_rule 'dist-hook';
3780   $transform{'DIST-TARGETS'} = join (' ', @dist_targets);
3782   my $flm = option ('filename-length-max');
3783   my $filename_filter = $flm ? '.' x $flm->[1] : '';
3785   $output_rules .= &file_contents ('distdir',
3786                                    new Automake::Location,
3787                                    %transform,
3788                                    FILENAME_FILTER => $filename_filter);
3792 # check_directory ($NAME, $WHERE [, $RELATIVE_DIR = "."])
3793 # -------------------------------------------------------
3794 # Ensure $NAME is a directory (in $RELATIVE_DIR), and that it uses a sane
3795 # name.  Use $WHERE as a location in the diagnostic, if any.
3796 sub check_directory ($$;$)
3798   my ($dir, $where, $reldir) = @_;
3799   $reldir = '.' unless defined $reldir;
3801   error $where, "required directory $reldir/$dir does not exist"
3802     unless -d "$reldir/$dir";
3804   # If an 'obj/' directory exists, BSD make will enter it before
3805   # reading 'Makefile'.  Hence the 'Makefile' in the current directory
3806   # will not be read.
3807   #
3808   #  % cat Makefile
3809   #  all:
3810   #          echo Hello
3811   #  % cat obj/Makefile
3812   #  all:
3813   #          echo World
3814   #  % make      # GNU make
3815   #  echo Hello
3816   #  Hello
3817   #  % pmake     # BSD make
3818   #  echo World
3819   #  World
3820   msg ('portability', $where,
3821        "naming a subdirectory 'obj' causes troubles with BSD make")
3822     if $dir eq 'obj';
3824   # 'aux' is probably the most important of the following forbidden name,
3825   # since it's tempting to use it as an AC_CONFIG_AUX_DIR.
3826   msg ('portability', $where,
3827        "name '$dir' is reserved on W32 and DOS platforms")
3828     if grep (/^\Q$dir\E$/i, qw/aux lpt1 lpt2 lpt3 com1 com2 com3 com4 con prn/);
3831 # check_directories_in_var ($VARIABLE)
3832 # ------------------------------------
3833 # Recursively check all items in variables $VARIABLE as directories
3834 sub check_directories_in_var ($)
3836   my ($var) = @_;
3837   $var->traverse_recursively
3838     (sub
3839      {
3840        my ($var, $val, $cond, $full_cond) = @_;
3841        check_directory ($val, $var->rdef ($cond)->location, $relative_dir);
3842        return ();
3843      },
3844      undef,
3845      skip_ac_subst => 1);
3848 # &handle_subdirs ()
3849 # ------------------
3850 # Handle subdirectories.
3851 sub handle_subdirs ()
3853   my $subdirs = var ('SUBDIRS');
3854   return
3855     unless $subdirs;
3857   check_directories_in_var $subdirs;
3859   my $dsubdirs = var ('DIST_SUBDIRS');
3860   check_directories_in_var $dsubdirs
3861     if $dsubdirs;
3863   $output_rules .= &file_contents ('subdirs', new Automake::Location);
3864   rvar ('RECURSIVE_TARGETS')->rdef (TRUE)->{'pretty'} = VAR_SORTED; # Gross!
3868 # ($REGEN, @DEPENDENCIES)
3869 # &scan_aclocal_m4
3870 # ----------------
3871 # If aclocal.m4 creation is automated, return the list of its dependencies.
3872 sub scan_aclocal_m4 ()
3874   my $regen_aclocal = 0;
3876   set_seen 'CONFIG_STATUS_DEPENDENCIES';
3877   set_seen 'CONFIGURE_DEPENDENCIES';
3879   if (-f 'aclocal.m4')
3880     {
3881       &define_variable ("ACLOCAL_M4", '$(top_srcdir)/aclocal.m4', INTERNAL);
3883       my $aclocal = new Automake::XFile "< aclocal.m4";
3884       my $line = $aclocal->getline;
3885       $regen_aclocal = $line =~ 'generated automatically by aclocal';
3886     }
3888   my @ac_deps = ();
3890   if (set_seen ('ACLOCAL_M4_SOURCES'))
3891     {
3892       push (@ac_deps, '$(ACLOCAL_M4_SOURCES)');
3893       msg_var ('obsolete', 'ACLOCAL_M4_SOURCES',
3894                "'ACLOCAL_M4_SOURCES' is obsolete.\n"
3895                . "It should be safe to simply remove it");
3896     }
3898   # Note that it might be possible that aclocal.m4 doesn't exist but
3899   # should be auto-generated.  This case probably isn't very
3900   # important.
3902   return ($regen_aclocal, @ac_deps);
3906 # Helper function for substitute_ac_subst_variables.
3907 sub substitute_ac_subst_variables_worker($)
3909   my ($token) = @_;
3910   return "\@$token\@" if var $token;
3911   return "\${$token\}";
3914 # substitute_ac_subst_variables ($TEXT)
3915 # -------------------------------------
3916 # Replace any occurrence of ${FOO} in $TEXT by @FOO@ if FOO is an AC_SUBST
3917 # variable.
3918 sub substitute_ac_subst_variables ($)
3920   my ($text) = @_;
3921   $text =~ s/\${([^ \t=:+{}]+)}/&substitute_ac_subst_variables_worker ($1)/ge;
3922   return $text;
3925 # @DEPENDENCIES
3926 # &prepend_srcdir (@INPUTS)
3927 # -------------------------
3928 # Prepend $(srcdir) or $(top_srcdir) to all @INPUTS.  The idea is that
3929 # if an input file has a directory part the same as the current
3930 # directory, then the directory part is simply replaced by $(srcdir).
3931 # But if the directory part is different, then $(top_srcdir) is
3932 # prepended.
3933 sub prepend_srcdir (@)
3935   my (@inputs) = @_;
3936   my @newinputs;
3938   foreach my $single (@inputs)
3939     {
3940       if (dirname ($single) eq $relative_dir)
3941         {
3942           push (@newinputs, '$(srcdir)/' . basename ($single));
3943         }
3944       else
3945         {
3946           push (@newinputs, '$(top_srcdir)/' . $single);
3947         }
3948     }
3949   return @newinputs;
3952 # @DEPENDENCIES
3953 # rewrite_inputs_into_dependencies ($OUTPUT, @INPUTS)
3954 # ---------------------------------------------------
3955 # Compute a list of dependencies appropriate for the rebuild
3956 # rule of
3957 #   AC_CONFIG_FILES($OUTPUT:$INPUT[0]:$INPUTS[1]:...)
3958 # Also distribute $INPUTs which are not built by another AC_CONFIG_FOOs.
3959 sub rewrite_inputs_into_dependencies ($@)
3961   my ($file, @inputs) = @_;
3962   my @res = ();
3964   for my $i (@inputs)
3965     {
3966       # We cannot create dependencies on shell variables.
3967       next if (substitute_ac_subst_variables $i) =~ /\$/;
3969       if (exists $ac_config_files_location{$i} && $i ne $file)
3970         {
3971           my $di = dirname $i;
3972           if ($di eq $relative_dir)
3973             {
3974               $i = basename $i;
3975             }
3976           # In the top-level Makefile we do not use $(top_builddir), because
3977           # we are already there, and since the targets are built without
3978           # a $(top_builddir), it helps BSD Make to match them with
3979           # dependencies.
3980           elsif ($relative_dir ne '.')
3981             {
3982               $i = '$(top_builddir)/' . $i;
3983             }
3984         }
3985       else
3986         {
3987           msg ('error', $ac_config_files_location{$file},
3988                "required file '$i' not found")
3989             unless $i =~ /\$/ || exists $output_files{$i} || -f $i;
3990           ($i) = prepend_srcdir ($i);
3991           push_dist_common ($i);
3992         }
3993       push @res, $i;
3994     }
3995   return @res;
4000 # &handle_configure ($MAKEFILE_AM, $MAKEFILE_IN, $MAKEFILE, @INPUTS)
4001 # ------------------------------------------------------------------
4002 # Handle remaking and configure stuff.
4003 # We need the name of the input file, to do proper remaking rules.
4004 sub handle_configure ($$$@)
4006   my ($makefile_am, $makefile_in, $makefile, @inputs) = @_;
4008   prog_error 'empty @inputs'
4009     unless @inputs;
4011   my ($rel_makefile_am, $rel_makefile_in) = prepend_srcdir ($makefile_am,
4012                                                             $makefile_in);
4013   my $rel_makefile = basename $makefile;
4015   my $colon_infile = ':' . join (':', @inputs);
4016   $colon_infile = '' if $colon_infile eq ":$makefile.in";
4017   my @rewritten = rewrite_inputs_into_dependencies ($makefile, @inputs);
4018   my ($regen_aclocal_m4, @aclocal_m4_deps) = scan_aclocal_m4;
4019   define_pretty_variable ('am__aclocal_m4_deps', TRUE, INTERNAL,
4020                           @configure_deps, @aclocal_m4_deps,
4021                           '$(top_srcdir)/' . $configure_ac);
4022   my @configuredeps = ('$(am__aclocal_m4_deps)', '$(CONFIGURE_DEPENDENCIES)');
4023   push @configuredeps, '$(ACLOCAL_M4)' if -f 'aclocal.m4';
4024   define_pretty_variable ('am__configure_deps', TRUE, INTERNAL,
4025                           @configuredeps);
4027   my $automake_options = '--' . $strictness_name .
4028                          (global_option 'no-dependencies' ? ' --ignore-deps' : '');
4030   $output_rules .= file_contents
4031     ('configure',
4032      new Automake::Location,
4033      MAKEFILE              => $rel_makefile,
4034      'MAKEFILE-DEPS'       => "@rewritten",
4035      'CONFIG-MAKEFILE'     => ($relative_dir eq '.') ? '$@' : '$(subdir)/$@',
4036      'MAKEFILE-IN'         => $rel_makefile_in,
4037      'HAVE-MAKEFILE-IN-DEPS' => (@include_stack > 0),
4038      'MAKEFILE-IN-DEPS'    => "@include_stack",
4039      'MAKEFILE-AM'         => $rel_makefile_am,
4040      'AUTOMAKE-OPTIONS'    => $automake_options,
4041      'MAKEFILE-AM-SOURCES' => "$makefile$colon_infile",
4042      'REGEN-ACLOCAL-M4'    => $regen_aclocal_m4,
4043      VERBOSE               => verbose_flag ('GEN'));
4045   if ($relative_dir eq '.')
4046     {
4047       &push_dist_common ('acconfig.h')
4048         if -f 'acconfig.h';
4049     }
4051   # If we have a configure header, require it.
4052   my $hdr_index = 0;
4053   my @distclean_config;
4054   foreach my $spec (@config_headers)
4055     {
4056       $hdr_index += 1;
4057       # $CONFIG_H_PATH: config.h from top level.
4058       my ($config_h_path, @ins) = split_config_file_spec ($spec);
4059       my $config_h_dir = dirname ($config_h_path);
4061       # If the header is in the current directory we want to build
4062       # the header here.  Otherwise, if we're at the topmost
4063       # directory and the header's directory doesn't have a
4064       # Makefile, then we also want to build the header.
4065       if ($relative_dir eq $config_h_dir
4066           || ($relative_dir eq '.' && ! &is_make_dir ($config_h_dir)))
4067         {
4068           my ($cn_sans_dir, $stamp_dir);
4069           if ($relative_dir eq $config_h_dir)
4070             {
4071               $cn_sans_dir = basename ($config_h_path);
4072               $stamp_dir = '';
4073             }
4074           else
4075             {
4076               $cn_sans_dir = $config_h_path;
4077               if ($config_h_dir eq '.')
4078                 {
4079                   $stamp_dir = '';
4080                 }
4081               else
4082                 {
4083                   $stamp_dir = $config_h_dir . '/';
4084                 }
4085             }
4087           # This will also distribute all inputs.
4088           @ins = rewrite_inputs_into_dependencies ($config_h_path, @ins);
4090           # Cannot define rebuild rules for filenames with shell variables.
4091           next if (substitute_ac_subst_variables $config_h_path) =~ /\$/;
4093           # Header defined in this directory.
4094           my @files;
4095           if (-f $config_h_path . '.top')
4096             {
4097               push (@files, "$cn_sans_dir.top");
4098             }
4099           if (-f $config_h_path . '.bot')
4100             {
4101               push (@files, "$cn_sans_dir.bot");
4102             }
4104           push_dist_common (@files);
4106           # For now, acconfig.h can only appear in the top srcdir.
4107           if (-f 'acconfig.h')
4108             {
4109               push (@files, '$(top_srcdir)/acconfig.h');
4110             }
4112           my $stamp = "${stamp_dir}stamp-h${hdr_index}";
4113           $output_rules .=
4114             file_contents ('remake-hdr',
4115                            new Automake::Location,
4116                            FILES            => "@files",
4117                            'FIRST-HDR'      => ($hdr_index == 1),
4118                            CONFIG_H         => $cn_sans_dir,
4119                            CONFIG_HIN       => $ins[0],
4120                            CONFIG_H_DEPS    => "@ins",
4121                            CONFIG_H_PATH    => $config_h_path,
4122                            STAMP            => "$stamp");
4124           push @distclean_config, $cn_sans_dir, $stamp;
4125         }
4126     }
4128   $output_rules .= file_contents ('clean-hdr',
4129                                   new Automake::Location,
4130                                   FILES => "@distclean_config")
4131     if @distclean_config;
4133   # Distribute and define mkinstalldirs only if it is already present
4134   # in the package, for backward compatibility (some people may still
4135   # use $(mkinstalldirs)).
4136   my $mkidpath = "$config_aux_dir/mkinstalldirs";
4137   if (-f $mkidpath)
4138     {
4139       # Use require_file so that any existing script gets updated
4140       # by --force-missing.
4141       require_conf_file ($mkidpath, FOREIGN, 'mkinstalldirs');
4142       define_variable ('mkinstalldirs',
4143                        "\$(SHELL) $am_config_aux_dir/mkinstalldirs", INTERNAL);
4144     }
4145   else
4146     {
4147       # Use $(install_sh), not $(MKDIR_P) because the latter requires
4148       # at least one argument, and $(mkinstalldirs) used to work
4149       # even without arguments (e.g. $(mkinstalldirs) $(conditional_dir)).
4150       define_variable ('mkinstalldirs', '$(install_sh) -d', INTERNAL);
4151     }
4153   reject_var ('CONFIG_HEADER',
4154               "'CONFIG_HEADER' is an anachronism; now determined "
4155               . "automatically\nfrom '$configure_ac'");
4157   my @config_h;
4158   foreach my $spec (@config_headers)
4159     {
4160       my ($out, @ins) = split_config_file_spec ($spec);
4161       # Generate CONFIG_HEADER define.
4162       if ($relative_dir eq dirname ($out))
4163         {
4164           push @config_h, basename ($out);
4165         }
4166       else
4167         {
4168           push @config_h, "\$(top_builddir)/$out";
4169         }
4170     }
4171   define_variable ("CONFIG_HEADER", "@config_h", INTERNAL)
4172     if @config_h;
4174   # Now look for other files in this directory which must be remade
4175   # by config.status, and generate rules for them.
4176   my @actual_other_files = ();
4177   # These get cleaned only in a VPATH build.
4178   my @actual_other_vpath_files = ();
4179   foreach my $lfile (@other_input_files)
4180     {
4181       my $file;
4182       my @inputs;
4183       if ($lfile =~ /^([^:]*):(.*)$/)
4184         {
4185           # This is the ":" syntax of AC_OUTPUT.
4186           $file = $1;
4187           @inputs = split (':', $2);
4188         }
4189       else
4190         {
4191           # Normal usage.
4192           $file = $lfile;
4193           @inputs = $file . '.in';
4194         }
4196       # Automake files should not be stored in here, but in %MAKE_LIST.
4197       prog_error ("$lfile in \@other_input_files\n"
4198                   . "\@other_input_files = (@other_input_files)")
4199         if -f $file . '.am';
4201       my $local = basename ($file);
4203       # We skip files that aren't in this directory.  However, if
4204       # the file's directory does not have a Makefile, and we are
4205       # currently doing '.', then we create a rule to rebuild the
4206       # file in the subdir.
4207       my $fd = dirname ($file);
4208       if ($fd ne $relative_dir)
4209         {
4210           if ($relative_dir eq '.' && ! &is_make_dir ($fd))
4211             {
4212               $local = $file;
4213             }
4214           else
4215             {
4216               next;
4217             }
4218         }
4220       my @rewritten_inputs = rewrite_inputs_into_dependencies ($file, @inputs);
4222       # Cannot output rules for shell variables.
4223       next if (substitute_ac_subst_variables $local) =~ /\$/;
4225       my $condstr = '';
4226       my $cond = $ac_config_files_condition{$lfile};
4227       if (defined $cond)
4228         {
4229           $condstr = $cond->subst_string;
4230           Automake::Rule::define ($local, $configure_ac, RULE_AUTOMAKE, $cond,
4231                                   $ac_config_files_location{$file});
4232         }
4233       $output_rules .= ($condstr . $local . ': '
4234                         . '$(top_builddir)/config.status '
4235                         . "@rewritten_inputs\n"
4236                         . $condstr . "\t"
4237                         . 'cd $(top_builddir) && '
4238                         . '$(SHELL) ./config.status '
4239                         . ($relative_dir eq '.' ? '' : '$(subdir)/')
4240                         . '$@'
4241                         . "\n");
4242       push (@actual_other_files, $local);
4243     }
4245   # For links we should clean destinations and distribute sources.
4246   foreach my $spec (@config_links)
4247     {
4248       my ($link, $file) = split /:/, $spec;
4249       # Some people do AC_CONFIG_LINKS($computed).  We only handle
4250       # the DEST:SRC form.
4251       next unless $file;
4252       my $where = $ac_config_files_location{$link};
4254       # Skip destinations that contain shell variables.
4255       if ((substitute_ac_subst_variables $link) !~ /\$/)
4256         {
4257           # We skip links that aren't in this directory.  However, if
4258           # the link's directory does not have a Makefile, and we are
4259           # currently doing '.', then we add the link to CONFIG_CLEAN_FILES
4260           # in '.'s Makefile.in.
4261           my $local = basename ($link);
4262           my $fd = dirname ($link);
4263           if ($fd ne $relative_dir)
4264             {
4265               if ($relative_dir eq '.' && ! &is_make_dir ($fd))
4266                 {
4267                   $local = $link;
4268                 }
4269               else
4270                 {
4271                   $local = undef;
4272                 }
4273             }
4274           if ($file ne $link)
4275             {
4276               push @actual_other_files, $local if $local;
4277             }
4278           else
4279             {
4280               push @actual_other_vpath_files, $local if $local;
4281             }
4282         }
4284       # Do not process sources that contain shell variables.
4285       if ((substitute_ac_subst_variables $file) !~ /\$/)
4286         {
4287           my $fd = dirname ($file);
4289           # We distribute files that are in this directory.
4290           # At the top-level ('.') we also distribute files whose
4291           # directory does not have a Makefile.
4292           if (($fd eq $relative_dir)
4293               || ($relative_dir eq '.' && ! &is_make_dir ($fd)))
4294             {
4295               # The following will distribute $file as a side-effect when
4296               # it is appropriate (i.e., when $file is not already an output).
4297               # We do not need the result, just the side-effect.
4298               rewrite_inputs_into_dependencies ($link, $file);
4299             }
4300         }
4301     }
4303   # These files get removed by "make distclean".
4304   define_pretty_variable ('CONFIG_CLEAN_FILES', TRUE, INTERNAL,
4305                           @actual_other_files);
4306   define_pretty_variable ('CONFIG_CLEAN_VPATH_FILES', TRUE, INTERNAL,
4307                           @actual_other_vpath_files);
4310 # Handle C headers.
4311 sub handle_headers
4313     my @r = &am_install_var ('-defaultdist', 'header', 'HEADERS', 'include',
4314                              'oldinclude', 'pkginclude',
4315                              'noinst', 'check');
4316     foreach (@r)
4317     {
4318       next unless $_->[1] =~ /\..*$/;
4319       &saw_extension ($&);
4320     }
4323 sub handle_gettext
4325   return if ! $seen_gettext || $relative_dir ne '.';
4327   my $subdirs = var 'SUBDIRS';
4329   if (! $subdirs)
4330     {
4331       err_ac "AM_GNU_GETTEXT used but SUBDIRS not defined";
4332       return;
4333     }
4335   # Perform some sanity checks to help users get the right setup.
4336   # We disable these tests when po/ doesn't exist in order not to disallow
4337   # unusual gettext setups.
4338   #
4339   # Bruno Haible:
4340   # | The idea is:
4341   # |
4342   # |  1) If a package doesn't have a directory po/ at top level, it
4343   # |     will likely have multiple po/ directories in subpackages.
4344   # |
4345   # |  2) It is useful to warn for the absence of intl/ if AM_GNU_GETTEXT
4346   # |     is used without 'external'. It is also useful to warn for the
4347   # |     presence of intl/ if AM_GNU_GETTEXT([external]) is used. Both
4348   # |     warnings apply only to the usual layout of packages, therefore
4349   # |     they should both be disabled if no po/ directory is found at
4350   # |     top level.
4352   if (-d 'po')
4353     {
4354       my @subdirs = $subdirs->value_as_list_recursive;
4356       msg_var ('syntax', $subdirs,
4357                "AM_GNU_GETTEXT used but 'po' not in SUBDIRS")
4358         if ! grep ($_ eq 'po', @subdirs);
4360       # intl/ is not required when AM_GNU_GETTEXT is called with the
4361       # 'external' option and AM_GNU_GETTEXT_INTL_SUBDIR is not called.
4362       msg_var ('syntax', $subdirs,
4363                "AM_GNU_GETTEXT used but 'intl' not in SUBDIRS")
4364         if (! ($seen_gettext_external && ! $seen_gettext_intl)
4365             && ! grep ($_ eq 'intl', @subdirs));
4367       # intl/ should not be used with AM_GNU_GETTEXT([external]), except
4368       # if AM_GNU_GETTEXT_INTL_SUBDIR is called.
4369       msg_var ('syntax', $subdirs,
4370                "'intl' should not be in SUBDIRS when "
4371                . "AM_GNU_GETTEXT([external]) is used")
4372         if ($seen_gettext_external && ! $seen_gettext_intl
4373             && grep ($_ eq 'intl', @subdirs));
4374     }
4376   require_file ($ac_gettext_location, GNU, 'ABOUT-NLS');
4379 # Handle footer elements.
4380 sub handle_footer
4382     reject_rule ('.SUFFIXES',
4383                  "use variable 'SUFFIXES', not target '.SUFFIXES'");
4385     # Note: AIX 4.1 /bin/make will fail if any suffix rule appears
4386     # before .SUFFIXES.  So we make sure that .SUFFIXES appears before
4387     # anything else, by sticking it right after the default: target.
4388     $output_header .= ".SUFFIXES:\n";
4389     my $suffixes = var 'SUFFIXES';
4390     my @suffixes = Automake::Rule::suffixes;
4391     if (@suffixes || $suffixes)
4392     {
4393         # Make sure SUFFIXES has unique elements.  Sort them to ensure
4394         # the output remains consistent.  However, $(SUFFIXES) is
4395         # always at the start of the list, unsorted.  This is done
4396         # because make will choose rules depending on the ordering of
4397         # suffixes, and this lets the user have some control.  Push
4398         # actual suffixes, and not $(SUFFIXES).  Some versions of make
4399         # do not like variable substitutions on the .SUFFIXES line.
4400         my @user_suffixes = ($suffixes
4401                              ? $suffixes->value_as_list_recursive : ());
4403         my %suffixes = map { $_ => 1 } @suffixes;
4404         delete @suffixes{@user_suffixes};
4406         $output_header .= (".SUFFIXES: "
4407                            . join (' ', @user_suffixes, sort keys %suffixes)
4408                            . "\n");
4409     }
4411     $output_trailer .= file_contents ('footer', new Automake::Location);
4415 # Generate 'make install' rules.
4416 sub handle_install ()
4418   $output_rules .= &file_contents
4419     ('install',
4420      new Automake::Location,
4421      maybe_BUILT_SOURCES => (set_seen ('BUILT_SOURCES')
4422                              ? (" \$(BUILT_SOURCES)\n"
4423                                 . "\t\$(MAKE) \$(AM_MAKEFLAGS)")
4424                              : ''),
4425      'installdirs-local' => (user_phony_rule 'installdirs-local'
4426                              ? ' installdirs-local' : ''),
4427      am__installdirs => variable_value ('am__installdirs') || '');
4431 # Deal with all and all-am.
4432 sub handle_all ($)
4434     my ($makefile) = @_;
4436     # Output 'all-am'.
4438     # Put this at the beginning for the sake of non-GNU makes.  This
4439     # is still wrong if these makes can run parallel jobs.  But it is
4440     # right enough.
4441     unshift (@all, basename ($makefile));
4443     foreach my $spec (@config_headers)
4444       {
4445         my ($out, @ins) = split_config_file_spec ($spec);
4446         push (@all, basename ($out))
4447           if dirname ($out) eq $relative_dir;
4448       }
4450     # Install 'all' hooks.
4451     push (@all, "all-local")
4452       if user_phony_rule "all-local";
4454     &pretty_print_rule ("all-am:", "\t\t", @all);
4455     &depend ('.PHONY', 'all-am', 'all');
4458     # Output 'all'.
4460     my @local_headers = ();
4461     push @local_headers, '$(BUILT_SOURCES)'
4462       if var ('BUILT_SOURCES');
4463     foreach my $spec (@config_headers)
4464       {
4465         my ($out, @ins) = split_config_file_spec ($spec);
4466         push @local_headers, basename ($out)
4467           if dirname ($out) eq $relative_dir;
4468       }
4470     if (@local_headers)
4471       {
4472         # We need to make sure config.h is built before we recurse.
4473         # We also want to make sure that built sources are built
4474         # before any ordinary 'all' targets are run.  We can't do this
4475         # by changing the order of dependencies to the "all" because
4476         # that breaks when using parallel makes.  Instead we handle
4477         # things explicitly.
4478         $output_all .= ("all: @local_headers"
4479                         . "\n\t"
4480                         . '$(MAKE) $(AM_MAKEFLAGS) '
4481                         . (var ('SUBDIRS') ? 'all-recursive' : 'all-am')
4482                         . "\n\n");
4483         depend ('.MAKE', 'all');
4484       }
4485     else
4486       {
4487         $output_all .= "all: " . (var ('SUBDIRS')
4488                                   ? 'all-recursive' : 'all-am') . "\n\n";
4489       }
4492 # Generate helper targets for user recursion, where needed.
4493 sub handle_user_recursion ()
4495   return unless @extra_recursive_targets;
4497   define_pretty_variable ('am__extra_recursive_targets', TRUE, INTERNAL,
4498                           map { "$_-recursive" } @extra_recursive_targets);
4499   my $aux = var ('SUBDIRS') ? 'recursive' : 'am';
4500   foreach my $target (@extra_recursive_targets)
4501     {
4502       # This allows the default target's rules to be overridden in
4503       # Makefile.am.
4504       user_phony_rule ($target);
4505       depend ("$target", "$target-$aux");
4506       depend ("$target-am", "$target-local");
4507       # Every user-defined recursive target 'foo' *must* have a valid
4508       # associated 'foo-local' rule; we define it as an empty rule by
4509       # default, so that the user can transparently extend it in his
4510       # own Makefile.am.
4511       pretty_print_rule ("$target-local:");
4512       # $target-recursive might as well be undefined, so do not add
4513       # it here; it's taken care of in subdirs.am anyway.
4514       depend (".PHONY", "$target-am", "$target-local");
4515     }
4519 # &do_check_merge_target ()
4520 # -------------------------
4521 # Handle check merge target specially.
4522 sub do_check_merge_target ()
4524   # Include user-defined local form of target.
4525   push @check_tests, 'check-local'
4526     if user_phony_rule 'check-local';
4528   # The check target must depend on the local equivalent of
4529   # 'all', to ensure all the primary targets are built.  Then it
4530   # must build the local check rules.
4531   $output_rules .= "check-am: all-am\n";
4532   if (@check)
4533     {
4534       pretty_print_rule ("\t\$(MAKE) \$(AM_MAKEFLAGS)", "\t  ", @check);
4535       depend ('.MAKE', 'check-am');
4536     }
4538   if (@check_tests)
4539     {
4540       pretty_print_rule ("\t\$(MAKE) \$(AM_MAKEFLAGS)", "\t  ",
4541                          @check_tests);
4542       depend ('.MAKE', 'check-am');
4543     }
4545   depend '.PHONY', 'check', 'check-am';
4546   # Handle recursion.  We have to honor BUILT_SOURCES like for 'all:'.
4547   $output_rules .= ("check: "
4548                     . (var ('BUILT_SOURCES')
4549                        ? "\$(BUILT_SOURCES)\n\t\$(MAKE) \$(AM_MAKEFLAGS) "
4550                        : '')
4551                     . (var ('SUBDIRS') ? 'check-recursive' : 'check-am')
4552                     . "\n");
4553   depend ('.MAKE', 'check')
4554     if var ('BUILT_SOURCES');
4557 # handle_clean ($MAKEFILE)
4558 # ------------------------
4559 # Handle all 'clean' targets.
4560 sub handle_clean ($)
4562   my ($makefile) = @_;
4564   # Clean the files listed in user variables if they exist.
4565   $clean_files{'$(MOSTLYCLEANFILES)'} = MOSTLY_CLEAN
4566     if var ('MOSTLYCLEANFILES');
4567   $clean_files{'$(CLEANFILES)'} = CLEAN
4568     if var ('CLEANFILES');
4569   $clean_files{'$(DISTCLEANFILES)'} = DIST_CLEAN
4570     if var ('DISTCLEANFILES');
4571   $clean_files{'$(MAINTAINERCLEANFILES)'} = MAINTAINER_CLEAN
4572     if var ('MAINTAINERCLEANFILES');
4574   # Built sources are automatically removed by maintainer-clean.
4575   $clean_files{'$(BUILT_SOURCES)'} = MAINTAINER_CLEAN
4576     if var ('BUILT_SOURCES');
4578   # Compute a list of "rm"s to run for each target.
4579   my %rms = (MOSTLY_CLEAN, [],
4580              CLEAN, [],
4581              DIST_CLEAN, [],
4582              MAINTAINER_CLEAN, []);
4584   foreach my $file (keys %clean_files)
4585     {
4586       my $when = $clean_files{$file};
4587       prog_error 'invalid entry in %clean_files'
4588         unless exists $rms{$when};
4590       my $rm = "rm -f $file";
4591       # If file is a variable, make sure when don't call 'rm -f' without args.
4592       $rm ="test -z \"$file\" || $rm"
4593         if ($file =~ /^\s*\$(\(.*\)|\{.*\})\s*$/);
4595       push @{$rms{$when}}, "\t-$rm\n";
4596     }
4598   $output_rules .= &file_contents
4599     ('clean',
4600      new Automake::Location,
4601      MOSTLYCLEAN_RMS      => join ('', sort @{$rms{&MOSTLY_CLEAN}}),
4602      CLEAN_RMS            => join ('', sort @{$rms{&CLEAN}}),
4603      DISTCLEAN_RMS        => join ('', sort @{$rms{&DIST_CLEAN}}),
4604      MAINTAINER_CLEAN_RMS => join ('', sort @{$rms{&MAINTAINER_CLEAN}}),
4605      MAKEFILE             => basename $makefile,
4606      );
4610 # &target_cmp ($A, $B)
4611 # --------------------
4612 # Subroutine for &handle_factored_dependencies to let '.PHONY' and
4613 # other '.TARGETS' be last.
4614 sub target_cmp
4616   return 0 if $a eq $b;
4618   my $a1 = substr ($a, 0, 1);
4619   my $b1 = substr ($b, 0, 1);
4620   if ($a1 ne $b1)
4621     {
4622       return -1 if $b1 eq '.';
4623       return 1 if $a1 eq '.';
4624     }
4625   return $a cmp $b;
4629 # &handle_factored_dependencies ()
4630 # --------------------------------
4631 # Handle everything related to gathered targets.
4632 sub handle_factored_dependencies
4634   # Reject bad hooks.
4635   foreach my $utarg ('uninstall-data-local', 'uninstall-data-hook',
4636                      'uninstall-exec-local', 'uninstall-exec-hook',
4637                      'uninstall-dvi-local',
4638                      'uninstall-html-local',
4639                      'uninstall-info-local',
4640                      'uninstall-pdf-local',
4641                      'uninstall-ps-local')
4642     {
4643       my $x = $utarg;
4644       $x =~ s/-.*-/-/;
4645       reject_rule ($utarg, "use '$x', not '$utarg'");
4646     }
4648   reject_rule ('install-local',
4649                "use 'install-data-local' or 'install-exec-local', "
4650                . "not 'install-local'");
4652   reject_rule ('install-hook',
4653                "use 'install-data-hook' or 'install-exec-hook', "
4654                . "not 'install-hook'");
4656   # Install the -local hooks.
4657   foreach (keys %dependencies)
4658     {
4659       # Hooks are installed on the -am targets.
4660       s/-am$// or next;
4661       depend ("$_-am", "$_-local")
4662         if user_phony_rule "$_-local";
4663     }
4665   # Install the -hook hooks.
4666   # FIXME: Why not be as liberal as we are with -local hooks?
4667   foreach ('install-exec', 'install-data', 'uninstall')
4668     {
4669       if (user_phony_rule "$_-hook")
4670         {
4671           depend ('.MAKE', "$_-am");
4672           register_action("$_-am",
4673                           ("\t\@\$(NORMAL_INSTALL)\n"
4674                            . "\t\$(MAKE) \$(AM_MAKEFLAGS) $_-hook"));
4675         }
4676     }
4678   # All the required targets are phony.
4679   depend ('.PHONY', keys %required_targets);
4681   # Actually output gathered targets.
4682   foreach (sort target_cmp keys %dependencies)
4683     {
4684       # If there is nothing about this guy, skip it.
4685       next
4686         unless (@{$dependencies{$_}}
4687                 || $actions{$_}
4688                 || $required_targets{$_});
4690       # Define gathered targets in undefined conditions.
4691       # FIXME: Right now we must handle .PHONY as an exception,
4692       # because people write things like
4693       #    .PHONY: myphonytarget
4694       # to append dependencies.  This would not work if Automake
4695       # refrained from defining its own .PHONY target as it does
4696       # with other overridden targets.
4697       # Likewise for '.MAKE'.
4698       my @undefined_conds = (TRUE,);
4699       if ($_ ne '.PHONY' && $_ ne '.MAKE')
4700         {
4701           @undefined_conds =
4702             Automake::Rule::define ($_, 'internal',
4703                                     RULE_AUTOMAKE, TRUE, INTERNAL);
4704         }
4705       my @uniq_deps = uniq (sort @{$dependencies{$_}});
4706       foreach my $cond (@undefined_conds)
4707         {
4708           my $condstr = $cond->subst_string;
4709           &pretty_print_rule ("$condstr$_:", "$condstr\t", @uniq_deps);
4710           $output_rules .= $actions{$_} if defined $actions{$_};
4711           $output_rules .= "\n";
4712         }
4713     }
4717 # &handle_tests_dejagnu ()
4718 # ------------------------
4719 sub handle_tests_dejagnu
4721     push (@check_tests, 'check-DEJAGNU');
4722     $output_rules .= file_contents ('dejagnu', new Automake::Location);
4725 sub handle_per_suffix_test
4727   my ($test_suffix, %transform) = @_;
4728   my ($pfx, $generic, $am_exeext);
4729   if ($test_suffix eq '')
4730     {
4731       $pfx = '';
4732       $generic = 0;
4733       $am_exeext = 'FALSE';
4734     }
4735   else
4736     {
4737       prog_error ("test suffix '$test_suffix' lacks leading dot")
4738         unless $test_suffix =~ m/^\.(.*)/;
4739       $pfx = uc ($1) . '_';
4740       $generic = 1;
4741       $am_exeext = exists $configure_vars{'EXEEXT'} ? 'am__EXEEXT'
4742                                                     : 'FALSE';
4743     }
4744   # The "test driver" program, deputed to handle tests protocol used by
4745   # test scripts.  By default, it's assumed that no protocol is used, so
4746   # we fall back to the old behaviour, implemented by the 'test-driver'
4747   # auxiliary script.
4748   if (! var "${pfx}LOG_DRIVER")
4749     {
4750       require_conf_file ("parallel-tests", FOREIGN, 'test-driver');
4751       define_variable ("${pfx}LOG_DRIVER",
4752                        "\$(SHELL) $am_config_aux_dir/test-driver",
4753                        INTERNAL);
4754     }
4755   my $driver = '$(' . $pfx . 'LOG_DRIVER)';
4756   my $driver_flags = '$(AM_' . $pfx . 'LOG_DRIVER_FLAGS)'
4757                        . ' $(' . $pfx . 'LOG_DRIVER_FLAGS)';
4758   my $compile = "${pfx}LOG_COMPILE";
4759   define_variable ($compile,
4760                    '$(' . $pfx . 'LOG_COMPILER)'
4761                       . ' $(AM_' .  $pfx . 'LOG_FLAGS)'
4762                       . ' $(' . $pfx . 'LOG_FLAGS)',
4763                      INTERNAL);
4764   $output_rules .= file_contents ('check2', new Automake::Location,
4765                                    GENERIC => $generic,
4766                                    DRIVER => $driver,
4767                                    DRIVER_FLAGS => $driver_flags,
4768                                    COMPILE => '$(' . $compile . ')',
4769                                    EXT => $test_suffix,
4770                                    am__EXEEXT => $am_exeext,
4771                                    %transform);
4774 # is_valid_test_extension ($EXT)
4775 # ------------------------------
4776 # Return true if $EXT can appear in $(TEST_EXTENSIONS), return false
4777 # otherwise.
4778 sub is_valid_test_extension ($)
4780   my $ext = shift;
4781   return 1
4782     if ($ext =~ /^\.[a-zA-Z_][a-zA-Z0-9_]*$/);
4783   return 1
4784     if (exists $configure_vars{'EXEEXT'} && $ext eq subst ('EXEEXT'));
4785   return 0;
4788 # Handle TESTS variable and other checks.
4789 sub handle_tests
4791   if (option 'dejagnu')
4792     {
4793       &handle_tests_dejagnu;
4794     }
4795   else
4796     {
4797       foreach my $c ('DEJATOOL', 'RUNTEST', 'RUNTESTFLAGS')
4798         {
4799           reject_var ($c, "'$c' defined but 'dejagnu' not in "
4800                       . "'AUTOMAKE_OPTIONS'");
4801         }
4802     }
4804   if (var ('TESTS'))
4805     {
4806       push (@check_tests, 'check-TESTS');
4807       my $check_deps = "@check";
4808       $output_rules .= &file_contents ('check', new Automake::Location,
4809                                        SERIAL_TESTS => !! option 'serial-tests',
4810                                        CHECK_DEPS => $check_deps);
4812       # Tests that are known programs should have $(EXEEXT) appended.
4813       # For matching purposes, we need to adjust XFAIL_TESTS as well.
4814       append_exeext { exists $known_programs{$_[0]} } 'TESTS';
4815       append_exeext { exists $known_programs{$_[0]} } 'XFAIL_TESTS'
4816         if (var ('XFAIL_TESTS'));
4818       if (! option 'serial-tests')
4819         {
4820           define_variable ('TEST_SUITE_LOG', 'test-suite.log', INTERNAL);
4821           my $suff = '.test';
4822           my $at_exeext = '';
4823           my $handle_exeext = exists $configure_vars{'EXEEXT'};
4824           if ($handle_exeext)
4825             {
4826               $at_exeext = subst ('EXEEXT');
4827               $suff = $at_exeext  . ' ' . $suff;
4828             }
4829           if (! var 'TEST_EXTENSIONS')
4830             {
4831               define_variable ('TEST_EXTENSIONS', $suff, INTERNAL);
4832             }
4833           my $var = var 'TEST_EXTENSIONS';
4834           # Currently, we are not able to deal with conditional contents
4835           # in TEST_EXTENSIONS.
4836           if ($var->has_conditional_contents)
4837            {
4838              msg_var 'unsupported', $var,
4839                      "'TEST_EXTENSIONS' cannot have conditional contents";
4840            }
4841           my @test_suffixes = $var->value_as_list_recursive;
4842           if ((my @invalid_test_suffixes =
4843                   grep { !is_valid_test_extension $_ } @test_suffixes) > 0)
4844             {
4845               error $var->rdef (TRUE)->location,
4846                     "invalid test extensions: @invalid_test_suffixes";
4847             }
4848           @test_suffixes = grep { is_valid_test_extension $_ } @test_suffixes;
4849           if ($handle_exeext)
4850             {
4851               unshift (@test_suffixes, $at_exeext)
4852                 unless $test_suffixes[0] eq $at_exeext;
4853             }
4854           unshift (@test_suffixes, '');
4856           transform_variable_recursively
4857             ('TESTS', 'TEST_LOGS', 'am__testlogs', 1, INTERNAL,
4858               sub {
4859                 my ($subvar, $val, $cond, $full_cond) = @_;
4860                 my $obj = $val;
4861                 return $obj
4862                   if $val =~ /^\@.*\@$/;
4863                 $obj =~ s/\$\(EXEEXT\)$//o;
4865                 if ($val =~ /(\$\((top_)?srcdir\))\//o)
4866                   {
4867                     msg ('error', $subvar->rdef ($cond)->location,
4868                          "using '$1' in TESTS is currently broken: '$val'");
4869                   }
4871                 foreach my $test_suffix (@test_suffixes)
4872                   {
4873                     next
4874                       if $test_suffix eq $at_exeext || $test_suffix eq '';
4875                     return substr ($obj, 0, length ($obj) - length ($test_suffix)) . '.log'
4876                       if substr ($obj, - length ($test_suffix)) eq $test_suffix;
4877                   }
4878                 my $base = $obj;
4879                 $obj .= '.log';
4880                 handle_per_suffix_test ('',
4881                                         OBJ => $obj,
4882                                         BASE => $base,
4883                                         SOURCE => $val);
4884                 return $obj;
4885               });
4887           my $nhelper=1;
4888           my $prev = 'TESTS';
4889           my $post = '';
4890           my $last_suffix = $test_suffixes[$#test_suffixes];
4891           my $cur = '';
4892           foreach my $test_suffix (@test_suffixes)
4893             {
4894               if ($test_suffix eq $last_suffix)
4895                 {
4896                   $cur = 'TEST_LOGS';
4897                 }
4898               else
4899                 {
4900                   $cur = 'am__test_logs' . $nhelper;
4901                 }
4902               define_variable ($cur,
4903                 '$(' . $prev . ':' . $test_suffix . $post . '=.log)', INTERNAL);
4904               $post = '.log';
4905               $prev = $cur;
4906               $nhelper++;
4907               if ($test_suffix ne $at_exeext && $test_suffix ne '')
4908                 {
4909                   handle_per_suffix_test ($test_suffix,
4910                                           OBJ => '',
4911                                           BASE => '$*',
4912                                           SOURCE => '$<');
4913                 }
4914             }
4915           $clean_files{'$(TEST_LOGS)'} = MOSTLY_CLEAN;
4916           $clean_files{'$(TEST_LOGS:.log=.trs)'} = MOSTLY_CLEAN;
4917           $clean_files{'$(TEST_SUITE_LOG)'} = MOSTLY_CLEAN;
4918         }
4919     }
4922 # Handle Emacs Lisp.
4923 sub handle_emacs_lisp
4925   my @elfiles = &am_install_var ('-candist', 'lisp', 'LISP',
4926                                  'lisp', 'noinst');
4928   return if ! @elfiles;
4930   define_pretty_variable ('am__ELFILES', TRUE, INTERNAL,
4931                           map { $_->[1] } @elfiles);
4932   define_pretty_variable ('am__ELCFILES', TRUE, INTERNAL,
4933                           '$(am__ELFILES:.el=.elc)');
4934   # This one can be overridden by users.
4935   define_pretty_variable ('ELCFILES', TRUE, INTERNAL, '$(LISP:.el=.elc)');
4937   push @all, '$(ELCFILES)';
4939   require_variables ($elfiles[0][0], "Emacs Lisp sources seen", TRUE,
4940                      'EMACS', 'lispdir');
4943 # Handle Python
4944 sub handle_python
4946   my @pyfiles = &am_install_var ('-defaultdist', 'python', 'PYTHON',
4947                                  'noinst');
4948   return if ! @pyfiles;
4950   require_variables ($pyfiles[0][0], "Python sources seen", TRUE, 'PYTHON');
4951   require_conf_file ($pyfiles[0][0], FOREIGN, 'py-compile');
4952   &define_variable ('py_compile', "$am_config_aux_dir/py-compile", INTERNAL);
4955 # Handle Java.
4956 sub handle_java
4958     my @sourcelist = &am_install_var ('-candist',
4959                                       'java', 'JAVA',
4960                                       'noinst', 'check');
4961     return if ! @sourcelist;
4963     my @prefixes = am_primary_prefixes ('JAVA', 1,
4964                                         'noinst', 'check');
4966     my $dir;
4967     my @java_sources = ();
4968     foreach my $prefix (@prefixes)
4969       {
4970         (my $curs = $prefix) =~ s/^(?:nobase_)?(?:dist_|nodist_)?//;
4972         next
4973           if $curs eq 'EXTRA';
4975         push @java_sources, '$(' . $prefix . '_JAVA' . ')';
4977         if (defined $dir)
4978           {
4979             err_var "${curs}_JAVA", "multiple _JAVA primaries in use"
4980              unless $curs eq $dir;
4981           }
4983         $dir = $curs;
4984       }
4986     define_pretty_variable ('am__java_sources', TRUE, INTERNAL,
4987                             "@java_sources");
4989     if ($dir eq 'check')
4990       {
4991         push (@check, "class$dir.stamp");
4992       }
4993     else
4994       {
4995         push (@all, "class$dir.stamp");
4996       }
5000 # Handle some of the minor options.
5001 sub handle_minor_options
5003   if (option 'readme-alpha')
5004     {
5005       if ($relative_dir eq '.')
5006         {
5007           if ($package_version !~ /^$GNITS_VERSION_PATTERN$/)
5008             {
5009               msg ('error-gnits', $package_version_location,
5010                    "version '$package_version' doesn't follow " .
5011                    "Gnits standards");
5012             }
5013           if (defined $1 && -f 'README-alpha')
5014             {
5015               # This means we have an alpha release.  See
5016               # GNITS_VERSION_PATTERN for details.
5017               push_dist_common ('README-alpha');
5018             }
5019         }
5020     }
5023 ################################################################
5025 # ($OUTPUT, @INPUTS)
5026 # &split_config_file_spec ($SPEC)
5027 # -------------------------------
5028 # Decode the Autoconf syntax for config files (files, headers, links
5029 # etc.).
5030 sub split_config_file_spec ($)
5032   my ($spec) = @_;
5033   my ($output, @inputs) = split (/:/, $spec);
5035   push @inputs, "$output.in"
5036     unless @inputs;
5038   return ($output, @inputs);
5041 # $input
5042 # locate_am (@POSSIBLE_SOURCES)
5043 # -----------------------------
5044 # AC_CONFIG_FILES allow specifications such as Makefile:top.in:mid.in:bot.in
5045 # This functions returns the first *.in file for which a *.am exists.
5046 # It returns undef otherwise.
5047 sub locate_am (@)
5049   my (@rest) = @_;
5050   my $input;
5051   foreach my $file (@rest)
5052     {
5053       if (($file =~ /^(.*)\.in$/) && -f "$1.am")
5054         {
5055           $input = $file;
5056           last;
5057         }
5058     }
5059   return $input;
5062 my %make_list;
5064 # &scan_autoconf_config_files ($WHERE, $CONFIG-FILES)
5065 # ---------------------------------------------------
5066 # Study $CONFIG-FILES which is the first argument to AC_CONFIG_FILES
5067 # (or AC_OUTPUT).
5068 sub scan_autoconf_config_files ($$)
5070   my ($where, $config_files) = @_;
5072   # Look at potential Makefile.am's.
5073   foreach (split ' ', $config_files)
5074     {
5075       # Must skip empty string for Perl 4.
5076       next if $_ eq "\\" || $_ eq '';
5078       # Handle $local:$input syntax.
5079       my ($local, @rest) = split (/:/);
5080       @rest = ("$local.in",) unless @rest;
5081       # Keep in sync with 'conffile-leading-dot.test'.
5082       msg ('unsupported', $where,
5083            "omit leading './' from config file names such as '$local';"
5084            . "\nremake rules might be subtly broken otherwise")
5085         if ($local =~ /^\.\//);
5086       my $input = locate_am @rest;
5087       if ($input)
5088         {
5089           # We have a file that automake should generate.
5090           $make_list{$input} = join (':', ($local, @rest));
5091         }
5092       else
5093         {
5094           # We have a file that automake should cause to be
5095           # rebuilt, but shouldn't generate itself.
5096           push (@other_input_files, $_);
5097         }
5098       $ac_config_files_location{$local} = $where;
5099       $ac_config_files_condition{$local} =
5100         new Automake::Condition (@cond_stack)
5101           if (@cond_stack);
5102     }
5106 # &scan_autoconf_traces ($FILENAME)
5107 # ---------------------------------
5108 sub scan_autoconf_traces ($)
5110   my ($filename) = @_;
5112   # Macros to trace, with their minimal number of arguments.
5113   #
5114   # IMPORTANT: If you add a macro here, you should also add this macro
5115   # =========  to Automake-preselection in autoconf/lib/autom4te.in.
5116   my %traced = (
5117                 AC_CANONICAL_BUILD => 0,
5118                 AC_CANONICAL_HOST => 0,
5119                 AC_CANONICAL_TARGET => 0,
5120                 AC_CONFIG_AUX_DIR => 1,
5121                 AC_CONFIG_FILES => 1,
5122                 AC_CONFIG_HEADERS => 1,
5123                 AC_CONFIG_LIBOBJ_DIR => 1,
5124                 AC_CONFIG_LINKS => 1,
5125                 AC_FC_SRCEXT => 1,
5126                 AC_INIT => 0,
5127                 AC_LIBSOURCE => 1,
5128                 AC_REQUIRE_AUX_FILE => 1,
5129                 AC_SUBST_TRACE => 1,
5130                 AM_AUTOMAKE_VERSION => 1,
5131                 AM_PROG_MKDIR_P => 0, # FIXME: to be removed in 1.14
5132                 AM_CONDITIONAL => 2,
5133                 _AM_EXTRA_RECURSIVE_TARGETS => 1,
5134                 AM_GNU_GETTEXT => 0,
5135                 AM_GNU_GETTEXT_INTL_SUBDIR => 0,
5136                 AM_INIT_AUTOMAKE => 0,
5137                 AM_MAINTAINER_MODE => 0,
5138                 AM_PROG_AR => 0,
5139                 AM_PROG_CC_C_O => 0,
5140                 _AM_SUBST_NOTMAKE => 1,
5141                 _AM_COND_IF => 1,
5142                 _AM_COND_ELSE => 1,
5143                 _AM_COND_ENDIF => 1,
5144                 LT_SUPPORTED_TAG => 1,
5145                 _LT_AC_TAGCONFIG => 0,
5146                 m4_include => 1,
5147                 m4_sinclude => 1,
5148                 sinclude => 1,
5149               );
5151   my $traces = ($ENV{AUTOCONF} || '@am_AUTOCONF@') . " ";
5153   # Use a separator unlikely to be used, not ':', the default, which
5154   # has a precise meaning for AC_CONFIG_FILES and so on.
5155   $traces .= join (' ',
5156                    map { "--trace=$_" . ':\$f:\$l::\$d::\$n::\${::}%' }
5157                    (keys %traced));
5159   my $tracefh = new Automake::XFile ("$traces $filename |");
5160   verb "reading $traces";
5162   @cond_stack = ();
5163   my $where;
5165   while ($_ = $tracefh->getline)
5166     {
5167       chomp;
5168       my ($here, $depth, @args) = split (/::/);
5169       $where = new Automake::Location $here;
5170       my $macro = $args[0];
5172       prog_error ("unrequested trace '$macro'")
5173         unless exists $traced{$macro};
5175       # Skip and diagnose malformed calls.
5176       if ($#args < $traced{$macro})
5177         {
5178           msg ('syntax', $where, "not enough arguments for $macro");
5179           next;
5180         }
5182       # Alphabetical ordering please.
5183       if ($macro eq 'AC_CANONICAL_BUILD')
5184         {
5185           if ($seen_canonical <= AC_CANONICAL_BUILD)
5186             {
5187               $seen_canonical = AC_CANONICAL_BUILD;
5188             }
5189         }
5190       elsif ($macro eq 'AC_CANONICAL_HOST')
5191         {
5192           if ($seen_canonical <= AC_CANONICAL_HOST)
5193             {
5194               $seen_canonical = AC_CANONICAL_HOST;
5195             }
5196         }
5197       elsif ($macro eq 'AC_CANONICAL_TARGET')
5198         {
5199           $seen_canonical = AC_CANONICAL_TARGET;
5200         }
5201       elsif ($macro eq 'AC_CONFIG_AUX_DIR')
5202         {
5203           if ($seen_init_automake)
5204             {
5205               error ($where, "AC_CONFIG_AUX_DIR must be called before "
5206                      . "AM_INIT_AUTOMAKE ...", partial => 1);
5207               error ($seen_init_automake, "... AM_INIT_AUTOMAKE called here");
5208             }
5209           $config_aux_dir = $args[1];
5210           $config_aux_dir_set_in_configure_ac = 1;
5211           check_directory ($config_aux_dir, $where);
5212         }
5213       elsif ($macro eq 'AC_CONFIG_FILES')
5214         {
5215           # Look at potential Makefile.am's.
5216           scan_autoconf_config_files ($where, $args[1]);
5217         }
5218       elsif ($macro eq 'AC_CONFIG_HEADERS')
5219         {
5220           foreach my $spec (split (' ', $args[1]))
5221             {
5222               my ($dest, @src) = split (':', $spec);
5223               $ac_config_files_location{$dest} = $where;
5224               push @config_headers, $spec;
5225             }
5226         }
5227       elsif ($macro eq 'AC_CONFIG_LIBOBJ_DIR')
5228         {
5229           $config_libobj_dir = $args[1];
5230           check_directory ($config_libobj_dir, $where);
5231         }
5232       elsif ($macro eq 'AC_CONFIG_LINKS')
5233         {
5234           foreach my $spec (split (' ', $args[1]))
5235             {
5236               my ($dest, $src) = split (':', $spec);
5237               $ac_config_files_location{$dest} = $where;
5238               push @config_links, $spec;
5239             }
5240         }
5241       elsif ($macro eq 'AC_FC_SRCEXT')
5242         {
5243           my $suffix = $args[1];
5244           # These flags are used as %SOURCEFLAG% in depend2.am,
5245           # where the trailing space is important.
5246           $sourceflags{'.' . $suffix} = '$(FCFLAGS_' . $suffix . ') '
5247             if ($suffix eq 'f90' || $suffix eq 'f95' || $suffix eq 'f03' || $suffix eq 'f08');
5248         }
5249       elsif ($macro eq 'AC_INIT')
5250         {
5251           if (defined $args[2])
5252             {
5253               $package_version = $args[2];
5254               $package_version_location = $where;
5255             }
5256         }
5257       elsif ($macro eq 'AC_LIBSOURCE')
5258         {
5259           $libsources{$args[1]} = $here;
5260         }
5261       elsif ($macro eq 'AC_REQUIRE_AUX_FILE')
5262         {
5263           # Only remember the first time a file is required.
5264           $required_aux_file{$args[1]} = $where
5265             unless exists $required_aux_file{$args[1]};
5266         }
5267       elsif ($macro eq 'AC_SUBST_TRACE')
5268         {
5269           # Just check for alphanumeric in AC_SUBST_TRACE.  If you do
5270           # AC_SUBST(5), then too bad.
5271           $configure_vars{$args[1]} = $where
5272             if $args[1] =~ /^\w+$/;
5273         }
5274       elsif ($macro eq 'AM_AUTOMAKE_VERSION')
5275         {
5276           error ($where,
5277                  "version mismatch.  This is Automake $VERSION,\n" .
5278                  "but the definition used by this AM_INIT_AUTOMAKE\n" .
5279                  "comes from Automake $args[1].  You should recreate\n" .
5280                  "aclocal.m4 with aclocal and run automake again.\n",
5281                  # $? = 63 is used to indicate version mismatch to missing.
5282                  exit_code => 63)
5283             if $VERSION ne $args[1];
5285           $seen_automake_version = 1;
5286         }
5287       elsif ($macro eq 'AM_PROG_MKDIR_P') # FIXME: to be removed in 1.14
5288         {
5289           msg 'obsolete', $where, <<'EOF';
5290 The 'AM_PROG_MKDIR_P' macro is deprecated, and will soon be removed.
5291 You should use the Autoconf-provided 'AC_PROG_MKDIR_P' macro instead,
5292 and use '$(MKDIR_P)' instead of '$(mkdir_p)'in your Makefile.am files.
5294         }
5295       elsif ($macro eq 'AM_CONDITIONAL')
5296         {
5297           $configure_cond{$args[1]} = $where;
5298         }
5299       elsif ($macro eq '_AM_EXTRA_RECURSIVE_TARGETS')
5300         {
5301           push @extra_recursive_targets, split (' ', $args[1]);
5302         }
5303       elsif ($macro eq 'AM_GNU_GETTEXT')
5304         {
5305           $seen_gettext = $where;
5306           $ac_gettext_location = $where;
5307           $seen_gettext_external = grep ($_ eq 'external', @args);
5308         }
5309       elsif ($macro eq 'AM_GNU_GETTEXT_INTL_SUBDIR')
5310         {
5311           $seen_gettext_intl = $where;
5312         }
5313       elsif ($macro eq 'AM_INIT_AUTOMAKE')
5314         {
5315           $seen_init_automake = $where;
5316           if (defined $args[2])
5317             {
5318               msg 'obsolete', $where, <<'EOF';
5319 AM_INIT_AUTOMAKE: two- and three-arguments forms are deprecated.  For more info, see:
5320 http://www.gnu.org/software/automake/manual/automake.html#Modernize-AM_INIT_AUTOMAKE-invocation
5322               $package_version = $args[2];
5323               $package_version_location = $where;
5324             }
5325           elsif (defined $args[1])
5326             {
5327               my @opts = split (' ', $args[1]);
5328               @opts = map { { option => $_, where => $where } } @opts;
5329               exit $exit_code if process_global_option_list (@opts);
5330             }
5331         }
5332       elsif ($macro eq 'AM_MAINTAINER_MODE')
5333         {
5334           $seen_maint_mode = $where;
5335         }
5336       elsif ($macro eq 'AM_PROG_AR')
5337         {
5338           $seen_ar = $where;
5339         }
5340       elsif ($macro eq 'AM_PROG_CC_C_O')
5341         {
5342           $seen_cc_c_o = $where;
5343         }
5344       elsif ($macro eq '_AM_COND_IF')
5345         {
5346           cond_stack_if ('', $args[1], $where);
5347           error ($where, "missing m4 quoting, macro depth $depth")
5348             if ($depth != 1);
5349         }
5350       elsif ($macro eq '_AM_COND_ELSE')
5351         {
5352           cond_stack_else ('!', $args[1], $where);
5353           error ($where, "missing m4 quoting, macro depth $depth")
5354             if ($depth != 1);
5355         }
5356       elsif ($macro eq '_AM_COND_ENDIF')
5357         {
5358           cond_stack_endif (undef, undef, $where);
5359           error ($where, "missing m4 quoting, macro depth $depth")
5360             if ($depth != 1);
5361         }
5362       elsif ($macro eq '_AM_SUBST_NOTMAKE')
5363         {
5364           $ignored_configure_vars{$args[1]} = $where;
5365         }
5366       elsif ($macro eq 'm4_include'
5367              || $macro eq 'm4_sinclude'
5368              || $macro eq 'sinclude')
5369         {
5370           # Skip missing 'sinclude'd files.
5371           next if $macro ne 'm4_include' && ! -f $args[1];
5373           # Some modified versions of Autoconf don't use
5374           # frozen files.  Consequently it's possible that we see all
5375           # m4_include's performed during Autoconf's startup.
5376           # Obviously we don't want to distribute Autoconf's files
5377           # so we skip absolute filenames here.
5378           push @configure_deps, '$(top_srcdir)/' . $args[1]
5379             unless $here =~ m,^(?:\w:)?[\\/],;
5380           # Keep track of the greatest timestamp.
5381           if (-e $args[1])
5382             {
5383               my $mtime = mtime $args[1];
5384               $configure_deps_greatest_timestamp = $mtime
5385                 if $mtime > $configure_deps_greatest_timestamp;
5386             }
5387         }
5388       elsif ($macro eq 'LT_SUPPORTED_TAG')
5389         {
5390           $libtool_tags{$args[1]} = 1;
5391           $libtool_new_api = 1;
5392         }
5393       elsif ($macro eq '_LT_AC_TAGCONFIG')
5394         {
5395           # _LT_AC_TAGCONFIG is an old macro present in Libtool 1.5.
5396           # We use it to detect whether tags are supported.  Our
5397           # preferred interface is LT_SUPPORTED_TAG, but it was
5398           # introduced in Libtool 1.6.
5399           if (0 == keys %libtool_tags)
5400             {
5401               # Hardcode the tags supported by Libtool 1.5.
5402               %libtool_tags = (CC => 1, CXX => 1, GCJ => 1, F77 => 1);
5403             }
5404         }
5405     }
5407   error ($where, "condition stack not properly closed")
5408     if (@cond_stack);
5410   $tracefh->close;
5414 # &scan_autoconf_files ()
5415 # -----------------------
5416 # Check whether we use 'configure.ac' or 'configure.in'.
5417 # Scan it (and possibly 'aclocal.m4') for interesting things.
5418 # We must scan aclocal.m4 because there might be AC_SUBSTs and such there.
5419 sub scan_autoconf_files ()
5421   # Reinitialize libsources here.  This isn't really necessary,
5422   # since we currently assume there is only one configure.ac.  But
5423   # that won't always be the case.
5424   %libsources = ();
5426   # Keep track of the youngest configure dependency.
5427   $configure_deps_greatest_timestamp = mtime $configure_ac;
5428   if (-e 'aclocal.m4')
5429     {
5430       my $mtime = mtime 'aclocal.m4';
5431       $configure_deps_greatest_timestamp = $mtime
5432         if $mtime > $configure_deps_greatest_timestamp;
5433     }
5435   scan_autoconf_traces ($configure_ac);
5437   @configure_input_files = sort keys %make_list;
5438   # Set input and output files if not specified by user.
5439   if (! @input_files)
5440     {
5441       @input_files = @configure_input_files;
5442       %output_files = %make_list;
5443     }
5446   if (! $seen_init_automake)
5447     {
5448       err_ac ("no proper invocation of AM_INIT_AUTOMAKE was found.\nYou "
5449               . "should verify that $configure_ac invokes AM_INIT_AUTOMAKE,"
5450               . "\nthat aclocal.m4 is present in the top-level directory,\n"
5451               . "and that aclocal.m4 was recently regenerated "
5452               . "(using aclocal)");
5453     }
5454   else
5455     {
5456       if (! $seen_automake_version)
5457         {
5458           if (-f 'aclocal.m4')
5459             {
5460               error ($seen_init_automake,
5461                      "your implementation of AM_INIT_AUTOMAKE comes from " .
5462                      "an\nold Automake version.  You should recreate " .
5463                      "aclocal.m4\nwith aclocal and run automake again",
5464                      # $? = 63 is used to indicate version mismatch to missing.
5465                      exit_code => 63);
5466             }
5467           else
5468             {
5469               error ($seen_init_automake,
5470                      "no proper implementation of AM_INIT_AUTOMAKE was " .
5471                      "found,\nprobably because aclocal.m4 is missing.\n" .
5472                      "You should run aclocal to create this file, then\n" .
5473                      "run automake again");
5474             }
5475         }
5476     }
5478   locate_aux_dir ();
5480   # Look for some files we need.  Always check for these.  This
5481   # check must be done for every run, even those where we are only
5482   # looking at a subdir Makefile.  We must set relative_dir for
5483   # push_required_file to work.
5484   # Sort the files for stable verbose output.
5485   $relative_dir = '.';
5486   foreach my $file (sort keys %required_aux_file)
5487     {
5488       require_conf_file ($required_aux_file{$file}->get, FOREIGN, $file)
5489     }
5490   err_am "'install.sh' is an anachronism; use 'install-sh' instead"
5491     if -f $config_aux_dir . '/install.sh';
5493   # Preserve dist_common for later.
5494   $configure_dist_common = variable_value ('DIST_COMMON') || '';
5498 ################################################################
5500 # Do any extra checking for GNU standards.
5501 sub check_gnu_standards
5503   if ($relative_dir eq '.')
5504     {
5505       # In top level (or only) directory.
5506       require_file ("$am_file.am", GNU,
5507                     qw/INSTALL NEWS README AUTHORS ChangeLog/);
5509       # Accept one of these three licenses; default to COPYING.
5510       # Make sure we do not overwrite an existing license.
5511       my $license;
5512       foreach (qw /COPYING COPYING.LIB COPYING.LESSER/)
5513         {
5514           if (-f $_)
5515             {
5516               $license = $_;
5517               last;
5518             }
5519         }
5520       require_file ("$am_file.am", GNU, 'COPYING')
5521         unless $license;
5522     }
5524   for my $opt ('no-installman', 'no-installinfo')
5525     {
5526       msg ('error-gnu', option $opt,
5527            "option '$opt' disallowed by GNU standards")
5528         if option $opt;
5529     }
5532 # Do any extra checking for GNITS standards.
5533 sub check_gnits_standards
5535   if ($relative_dir eq '.')
5536     {
5537       # In top level (or only) directory.
5538       require_file ("$am_file.am", GNITS, 'THANKS');
5539     }
5542 ################################################################
5544 # Functions to handle files of each language.
5546 # Each 'lang_X_rewrite($DIRECTORY, $BASE, $EXT)' function follows a
5547 # simple formula: Return value is LANG_SUBDIR if the resulting object
5548 # file should be in a subdir if the source file is, LANG_PROCESS if
5549 # file is to be dealt with, LANG_IGNORE otherwise.
5551 # Much of the actual processing is handled in
5552 # handle_single_transform.  These functions exist so that
5553 # auxiliary information can be recorded for a later cleanup pass.
5554 # Note that the calls to these functions are computed, so don't bother
5555 # searching for their precise names in the source.
5557 # This is just a convenience function that can be used to determine
5558 # when a subdir object should be used.
5559 sub lang_sub_obj
5561     return option 'subdir-objects' ? LANG_SUBDIR : LANG_PROCESS;
5564 # Rewrite a single C source file.
5565 sub lang_c_rewrite
5567   my ($directory, $base, $ext, $obj, $have_per_exec_flags, $var) = @_;
5569   my $r = LANG_PROCESS;
5570   if (option 'subdir-objects')
5571     {
5572       $r = LANG_SUBDIR;
5573       if ($directory && $directory ne '.')
5574         {
5575           $base = $directory . '/' . $base;
5577           # libtool is always able to put the object at the proper place,
5578           # so we do not have to require AM_PROG_CC_C_O when building .lo files.
5579           msg_var ('portability', $var,
5580                    "compiling '$base.c' in subdir requires "
5581                    . "'AM_PROG_CC_C_O' in '$configure_ac'",
5582                    uniq_scope => US_GLOBAL,
5583                    uniq_part => 'AM_PROG_CC_C_O subdir')
5584             unless $seen_cc_c_o || $obj eq '.lo';
5585         }
5586     }
5588   if (! $seen_cc_c_o
5589       && $have_per_exec_flags
5590       && ! option 'subdir-objects'
5591       && $obj ne '.lo')
5592     {
5593       msg_var ('portability',
5594                $var, "compiling '$base.c' with per-target flags requires "
5595                . "'AM_PROG_CC_C_O' in '$configure_ac'",
5596                uniq_scope => US_GLOBAL,
5597                uniq_part => 'AM_PROG_CC_C_O per-target')
5598     }
5600     return $r;
5603 # Rewrite a single header file.
5604 sub lang_header_rewrite
5606     # Header files are simply ignored.
5607     return LANG_IGNORE;
5610 # Rewrite a single Vala source file.
5611 sub lang_vala_rewrite
5613     my ($directory, $base, $ext) = @_;
5615     (my $newext = $ext) =~ s/vala$/c/;
5616     return (LANG_SUBDIR, $newext);
5619 # Rewrite a single yacc/yacc++ file.
5620 sub lang_yacc_rewrite
5622     my ($directory, $base, $ext) = @_;
5624     my $r = &lang_sub_obj;
5625     (my $newext = $ext) =~ tr/y/c/;
5626     return ($r, $newext);
5628 sub lang_yaccxx_rewrite { lang_yacc_rewrite (@_); };
5630 # Rewrite a single lex/lex++ file.
5631 sub lang_lex_rewrite
5633     my ($directory, $base, $ext) = @_;
5635     my $r = &lang_sub_obj;
5636     (my $newext = $ext) =~ tr/l/c/;
5637     return ($r, $newext);
5639 sub lang_lexxx_rewrite { lang_lex_rewrite (@_); };
5641 # Rewrite a single Java file.
5642 sub lang_java_rewrite
5644     return LANG_SUBDIR;
5647 # The lang_X_finish functions are called after all source file
5648 # processing is done.  Each should handle defining rules for the
5649 # language, etc.  A finish function is only called if a source file of
5650 # the appropriate type has been seen.
5652 sub lang_vala_finish_target ($$)
5654   my ($self, $name) = @_;
5656   my $derived = canonicalize ($name);
5657   my $var = var "${derived}_SOURCES";
5658   return unless $var;
5660   my @vala_sources = grep { /\.(vala|vapi)$/ } ($var->value_as_list_recursive);
5662   # For automake bug#11229.
5663   return unless @vala_sources;
5665   foreach my $vala_file (@vala_sources)
5666     {
5667       my $c_file = $vala_file;
5668       if ($c_file =~ s/(.*)\.vala$/$1.c/)
5669         {
5670           $c_file = "\$(srcdir)/$c_file";
5671           $output_rules .= "$c_file: \$(srcdir)/${derived}_vala.stamp\n"
5672             . "\t\@if test -f \$@; then :; else rm -f \$(srcdir)/${derived}_vala.stamp; fi\n"
5673             . "\t\@if test -f \$@; then :; else \\\n"
5674             . "\t  \$(MAKE) \$(AM_MAKEFLAGS) \$(srcdir)/${derived}_vala.stamp; \\\n"
5675             . "\tfi\n";
5676           $clean_files{$c_file} = MAINTAINER_CLEAN;
5677         }
5678     }
5680   # Add rebuild rules for generated header and vapi files
5681   my $flags = var ($derived . '_VALAFLAGS');
5682   if ($flags)
5683     {
5684       my $lastflag = '';
5685       foreach my $flag ($flags->value_as_list_recursive)
5686         {
5687           if (grep (/$lastflag/, ('-H', '-h', '--header', '--internal-header',
5688                                   '--vapi', '--internal-vapi', '--gir')))
5689             {
5690               my $headerfile = "\$(srcdir)/$flag";
5691               $output_rules .= "$headerfile: \$(srcdir)/${derived}_vala.stamp\n"
5692                 . "\t\@if test -f \$@; then :; else rm -f \$(srcdir)/${derived}_vala.stamp; fi\n"
5693                 . "\t\@if test -f \$@; then :; else \\\n"
5694                 . "\t  \$(MAKE) \$(AM_MAKEFLAGS) \$(srcdir)/${derived}_vala.stamp; \\\n"
5695                 . "\tfi\n";
5697               # valac is not used when building from dist tarballs
5698               # distribute the generated files
5699               push_dist_common ($headerfile);
5700               $clean_files{$headerfile} = MAINTAINER_CLEAN;
5701             }
5702           $lastflag = $flag;
5703         }
5704     }
5706   my $compile = $self->compile;
5708   # Rewrite each occurrence of 'AM_VALAFLAGS' in the compile
5709   # rule into '${derived}_VALAFLAGS' if it exists.
5710   my $val = "${derived}_VALAFLAGS";
5711   $compile =~ s/\(AM_VALAFLAGS\)/\($val\)/
5712     if set_seen ($val);
5714   # VALAFLAGS is a user variable (per GNU Standards),
5715   # it should not be overridden in the Makefile...
5716   check_user_variables 'VALAFLAGS';
5718   my $dirname = dirname ($name);
5720   # Only generate C code, do not run C compiler
5721   $compile .= " -C";
5723   my $verbose = verbose_flag ('VALAC');
5724   my $silent = silent_flag ();
5725   my $stampfile = "\$(srcdir)/${derived}_vala.stamp";
5727   $output_rules .=
5728     "\$(srcdir)/${derived}_vala.stamp: @vala_sources\n".
5729 # Since the C files generated from the vala sources depend on the
5730 # ${derived}_vala.stamp file, we must ensure its timestamp is older than
5731 # those of the C files generated by the valac invocation below (this is
5732 # especially important on systems with sub-second timestamp resolution).
5733 # Thus we need to create the stamp file *before* invoking valac, and to
5734 # move it to its final location only after valac has been invoked.
5735     "\t${silent}rm -f \$\@ && echo stamp > \$\@-t\n".
5736     "\t${verbose}\$(am__cd) \$(srcdir) && $compile @vala_sources\n".
5737     "\t${silent}mv -f \$\@-t \$\@\n";
5739   push_dist_common ($stampfile);
5741   $clean_files{$stampfile} = MAINTAINER_CLEAN;
5744 # Add output rules to invoke valac and create stamp file as a witness
5745 # to handle multiple outputs. This function is called after all source
5746 # file processing is done.
5747 sub lang_vala_finish
5749   my ($self) = @_;
5751   foreach my $prog (keys %known_programs)
5752     {
5753       lang_vala_finish_target ($self, $prog);
5754     }
5756   while (my ($name) = each %known_libraries)
5757     {
5758       lang_vala_finish_target ($self, $name);
5759     }
5762 # The built .c files should be cleaned only on maintainer-clean
5763 # as the .c files are distributed. This function is called for each
5764 # .vala source file.
5765 sub lang_vala_target_hook
5767   my ($self, $aggregate, $output, $input, %transform) = @_;
5769   $clean_files{$output} = MAINTAINER_CLEAN;
5772 # This is a yacc helper which is called whenever we have decided to
5773 # compile a yacc file.
5774 sub lang_yacc_target_hook
5776     my ($self, $aggregate, $output, $input, %transform) = @_;
5778     # If some relevant *YFLAGS variable contains the '-d' flag, we'll
5779     # have to to generate special code.
5780     my $yflags_contains_minus_d = 0;
5782     foreach my $pfx ("", "${aggregate}_")
5783       {
5784         my $yflagsvar = var ("${pfx}YFLAGS");
5785         next unless $yflagsvar;
5786         # We cannot work reliably with conditionally-defined YFLAGS.
5787         if ($yflagsvar->has_conditional_contents)
5788           {
5789             msg_var ('unsupported', $yflagsvar,
5790                      "'${pfx}YFLAGS' cannot have conditional contents");
5791           }
5792         else
5793           {
5794             $yflags_contains_minus_d = 1
5795               if grep (/^-d$/, $yflagsvar->value_as_list_recursive);
5796           }
5797       }
5799     if ($yflags_contains_minus_d)
5800       {
5801         # Found a '-d' that applies to the compilation of this file.
5802         # Add a dependency for the generated header file, and arrange
5803         # for that file to be included in the distribution.
5805         # The extension of the output file (e.g., '.c' or '.cxx').
5806         # We'll need it to compute the name of the generated header file.
5807         (my $output_ext = basename ($output)) =~ s/.*(\.[^.]+)$/$1/;
5809         # We know that a yacc input should be turned into either a C or
5810         # C++ output file.  We depend on this fact (here and in yacc.am),
5811         # so check that it really holds.
5812         my $lang = $languages{$extension_map{$output_ext}};
5813         prog_error "invalid output name '$output' for yacc file '$input'"
5814           if (!$lang || ($lang->name ne 'c' && $lang->name ne 'cxx'));
5816         (my $header_ext = $output_ext) =~ s/c/h/g;
5817         # Quote $output_ext in the regexp, so that dots in it are taken
5818         # as literal dots, not as metacharacters.
5819         (my $header = $output) =~ s/\Q$output_ext\E$/$header_ext/;
5821         foreach my $cond (Automake::Rule::define (${header}, 'internal',
5822                                                   RULE_AUTOMAKE, TRUE,
5823                                                   INTERNAL))
5824           {
5825             my $condstr = $cond->subst_string;
5826             $output_rules .=
5827               "$condstr${header}: $output\n"
5828               # Recover from removal of $header
5829               . "$condstr\t\@if test ! -f \$@; then rm -f $output; else :; fi\n"
5830               . "$condstr\t\@if test ! -f \$@; then \$(MAKE) \$(AM_MAKEFLAGS) $output; else :; fi\n";
5831           }
5832         # Distribute the generated file, unless its .y source was
5833         # listed in a nodist_ variable.  (&handle_source_transform
5834         # will set DIST_SOURCE.)
5835         &push_dist_common ($header)
5836           if $transform{'DIST_SOURCE'};
5838         # The GNU rules say that yacc/lex output files should be removed
5839         # by maintainer-clean.  However, if the files are not distributed,
5840         # then we want to remove them with "make clean"; otherwise,
5841         # "make distcheck" will fail.
5842         $clean_files{$header} = $transform{'DIST_SOURCE'} ? MAINTAINER_CLEAN : CLEAN;
5843       }
5844     # See the comment above for $HEADER.
5845     $clean_files{$output} = $transform{'DIST_SOURCE'} ? MAINTAINER_CLEAN : CLEAN;
5848 # This is a lex helper which is called whenever we have decided to
5849 # compile a lex file.
5850 sub lang_lex_target_hook
5852     my ($self, $aggregate, $output, $input, %transform) = @_;
5853     # The GNU rules say that yacc/lex output files should be removed
5854     # by maintainer-clean.  However, if the files are not distributed,
5855     # then we want to remove them with "make clean"; otherwise,
5856     # "make distcheck" will fail.
5857     $clean_files{$output} = $transform{'DIST_SOURCE'} ? MAINTAINER_CLEAN : CLEAN;
5860 # This is a helper for both lex and yacc.
5861 sub yacc_lex_finish_helper
5863   return if defined $language_scratch{'lex-yacc-done'};
5864   $language_scratch{'lex-yacc-done'} = 1;
5866   # FIXME: for now, no line number.
5867   require_conf_file ($configure_ac, FOREIGN, 'ylwrap');
5868   &define_variable ('YLWRAP', "$am_config_aux_dir/ylwrap", INTERNAL);
5871 sub lang_yacc_finish
5873   return if defined $language_scratch{'yacc-done'};
5874   $language_scratch{'yacc-done'} = 1;
5876   reject_var 'YACCFLAGS', "'YACCFLAGS' obsolete; use 'YFLAGS' instead";
5878   yacc_lex_finish_helper;
5882 sub lang_lex_finish
5884   return if defined $language_scratch{'lex-done'};
5885   $language_scratch{'lex-done'} = 1;
5887   yacc_lex_finish_helper;
5891 # Given a hash table of linker names, pick the name that has the most
5892 # precedence.  This is lame, but something has to have global
5893 # knowledge in order to eliminate the conflict.  Add more linkers as
5894 # required.
5895 sub resolve_linker
5897     my (%linkers) = @_;
5899     foreach my $l (qw(GCJLINK OBJCXXLINK CXXLINK F77LINK FCLINK OBJCLINK UPCLINK))
5900     {
5901         return $l if defined $linkers{$l};
5902     }
5903     return 'LINK';
5906 # Called to indicate that an extension was used.
5907 sub saw_extension
5909     my ($ext) = @_;
5910     $extension_seen{$ext} = 1;
5913 # register_language (%ATTRIBUTE)
5914 # ------------------------------
5915 # Register a single language.
5916 # Each %ATTRIBUTE is of the form ATTRIBUTE => VALUE.
5917 sub register_language (%)
5919   my (%option) = @_;
5921   # Set the defaults.
5922   $option{'autodep'} = 'no'
5923     unless defined $option{'autodep'};
5924   $option{'linker'} = ''
5925     unless defined $option{'linker'};
5926   $option{'flags'} = []
5927     unless defined $option{'flags'};
5928   $option{'output_extensions'} = sub { return ( '.$(OBJEXT)', '.lo' ) }
5929     unless defined $option{'output_extensions'};
5930   $option{'nodist_specific'} = 0
5931     unless defined $option{'nodist_specific'};
5933   my $lang = new Language (%option);
5935   # Fill indexes.
5936   $extension_map{$_} = $lang->name foreach @{$lang->extensions};
5937   $languages{$lang->name} = $lang;
5938   my $link = $lang->linker;
5939   if ($link)
5940     {
5941       if (exists $link_languages{$link})
5942         {
5943           prog_error ("'$link' has different definitions in "
5944                       . $lang->name . " and " . $link_languages{$link}->name)
5945             if $lang->link ne $link_languages{$link}->link;
5946         }
5947       else
5948         {
5949           $link_languages{$link} = $lang;
5950         }
5951     }
5953   # Update the pattern of known extensions.
5954   accept_extensions (@{$lang->extensions});
5956   # Upate the $suffix_rule map.
5957   foreach my $suffix (@{$lang->extensions})
5958     {
5959       foreach my $dest (&{$lang->output_extensions} ($suffix))
5960         {
5961           register_suffix_rule (INTERNAL, $suffix, $dest);
5962         }
5963     }
5966 # derive_suffix ($EXT, $OBJ)
5967 # --------------------------
5968 # This function is used to find a path from a user-specified suffix $EXT
5969 # to $OBJ or to some other suffix we recognize internally, e.g. 'cc'.
5970 sub derive_suffix ($$)
5972   my ($source_ext, $obj) = @_;
5974   while (! $extension_map{$source_ext}
5975          && $source_ext ne $obj
5976          && exists $suffix_rules->{$source_ext}
5977          && exists $suffix_rules->{$source_ext}{$obj})
5978     {
5979       $source_ext = $suffix_rules->{$source_ext}{$obj}[0];
5980     }
5982   return $source_ext;
5986 ################################################################
5988 # Pretty-print something and append to output_rules.
5989 sub pretty_print_rule
5991     $output_rules .= &makefile_wrap (@_);
5995 ################################################################
5998 ## -------------------------------- ##
5999 ## Handling the conditional stack.  ##
6000 ## -------------------------------- ##
6003 # $STRING
6004 # make_conditional_string ($NEGATE, $COND)
6005 # ----------------------------------------
6006 sub make_conditional_string ($$)
6008   my ($negate, $cond) = @_;
6009   $cond = "${cond}_TRUE"
6010     unless $cond =~ /^TRUE|FALSE$/;
6011   $cond = Automake::Condition::conditional_negate ($cond)
6012     if $negate;
6013   return $cond;
6017 my %_am_macro_for_cond =
6018   (
6019   AMDEP => "one of the compiler tests\n"
6020            . "    AC_PROG_CC, AC_PROG_CXX, AC_PROG_OBJC, AC_PROG_OBJCXX,\n"
6021            . "    AM_PROG_AS, AM_PROG_GCJ, AM_PROG_UPC",
6022   am__fastdepCC => 'AC_PROG_CC',
6023   am__fastdepCCAS => 'AM_PROG_AS',
6024   am__fastdepCXX => 'AC_PROG_CXX',
6025   am__fastdepGCJ => 'AM_PROG_GCJ',
6026   am__fastdepOBJC => 'AC_PROG_OBJC',
6027   am__fastdepOBJCXX => 'AC_PROG_OBJCXX',
6028   am__fastdepUPC => 'AM_PROG_UPC'
6029   );
6031 # $COND
6032 # cond_stack_if ($NEGATE, $COND, $WHERE)
6033 # --------------------------------------
6034 sub cond_stack_if ($$$)
6036   my ($negate, $cond, $where) = @_;
6038   if (! $configure_cond{$cond} && $cond !~ /^TRUE|FALSE$/)
6039     {
6040       my $text = "$cond does not appear in AM_CONDITIONAL";
6041       my $scope = US_LOCAL;
6042       if (exists $_am_macro_for_cond{$cond})
6043         {
6044           my $mac = $_am_macro_for_cond{$cond};
6045           $text .= "\n  The usual way to define '$cond' is to add ";
6046           $text .= ($mac =~ / /) ? $mac : "'$mac'";
6047           $text .= "\n  to '$configure_ac' and run 'aclocal' and 'autoconf' again";
6048           # These warnings appear in Automake files (depend2.am),
6049           # so there is no need to display them more than once:
6050           $scope = US_GLOBAL;
6051         }
6052       error $where, $text, uniq_scope => $scope;
6053     }
6055   push (@cond_stack, make_conditional_string ($negate, $cond));
6057   return new Automake::Condition (@cond_stack);
6061 # $COND
6062 # cond_stack_else ($NEGATE, $COND, $WHERE)
6063 # ----------------------------------------
6064 sub cond_stack_else ($$$)
6066   my ($negate, $cond, $where) = @_;
6068   if (! @cond_stack)
6069     {
6070       error $where, "else without if";
6071       return FALSE;
6072     }
6074   $cond_stack[$#cond_stack] =
6075     Automake::Condition::conditional_negate ($cond_stack[$#cond_stack]);
6077   # If $COND is given, check against it.
6078   if (defined $cond)
6079     {
6080       $cond = make_conditional_string ($negate, $cond);
6082       error ($where, "else reminder ($negate$cond) incompatible with "
6083              . "current conditional: $cond_stack[$#cond_stack]")
6084         if $cond_stack[$#cond_stack] ne $cond;
6085     }
6087   return new Automake::Condition (@cond_stack);
6091 # $COND
6092 # cond_stack_endif ($NEGATE, $COND, $WHERE)
6093 # -----------------------------------------
6094 sub cond_stack_endif ($$$)
6096   my ($negate, $cond, $where) = @_;
6097   my $old_cond;
6099   if (! @cond_stack)
6100     {
6101       error $where, "endif without if";
6102       return TRUE;
6103     }
6105   # If $COND is given, check against it.
6106   if (defined $cond)
6107     {
6108       $cond = make_conditional_string ($negate, $cond);
6110       error ($where, "endif reminder ($negate$cond) incompatible with "
6111              . "current conditional: $cond_stack[$#cond_stack]")
6112         if $cond_stack[$#cond_stack] ne $cond;
6113     }
6115   pop @cond_stack;
6117   return new Automake::Condition (@cond_stack);
6124 ## ------------------------ ##
6125 ## Handling the variables.  ##
6126 ## ------------------------ ##
6129 # &define_pretty_variable ($VAR, $COND, $WHERE, @VALUE)
6130 # -----------------------------------------------------
6131 # Like define_variable, but the value is a list, and the variable may
6132 # be defined conditionally.  The second argument is the condition
6133 # under which the value should be defined; this should be the empty
6134 # string to define the variable unconditionally.  The third argument
6135 # is a list holding the values to use for the variable.  The value is
6136 # pretty printed in the output file.
6137 sub define_pretty_variable ($$$@)
6139     my ($var, $cond, $where, @value) = @_;
6141     if (! vardef ($var, $cond))
6142     {
6143         Automake::Variable::define ($var, VAR_AUTOMAKE, '', $cond, "@value",
6144                                     '', $where, VAR_PRETTY);
6145         rvar ($var)->rdef ($cond)->set_seen;
6146     }
6150 # define_variable ($VAR, $VALUE, $WHERE)
6151 # --------------------------------------
6152 # Define a new Automake Makefile variable VAR to VALUE, but only if
6153 # not already defined.
6154 sub define_variable ($$$)
6156     my ($var, $value, $where) = @_;
6157     define_pretty_variable ($var, TRUE, $where, $value);
6161 # define_files_variable ($VAR, \@BASENAME, $EXTENSION, $WHERE)
6162 # ------------------------------------------------------------
6163 # Define the $VAR which content is the list of file names composed of
6164 # a @BASENAME and the $EXTENSION.
6165 sub define_files_variable ($\@$$)
6167   my ($var, $basename, $extension, $where) = @_;
6168   define_variable ($var,
6169                    join (' ', map { "$_.$extension" } @$basename),
6170                    $where);
6174 # Like define_variable, but define a variable to be the configure
6175 # substitution by the same name.
6176 sub define_configure_variable ($)
6178   my ($var) = @_;
6179   # Some variables we do not want to output.  For instance it
6180   # would be a bad idea to output `U = @U@` when `@U@` can be
6181   # substituted as `\`.
6182   my $pretty = exists $ignored_configure_vars{$var} ? VAR_SILENT : VAR_ASIS;
6183   Automake::Variable::define ($var, VAR_CONFIGURE, '', TRUE, subst $var,
6184                               '', $configure_vars{$var}, $pretty);
6188 # define_compiler_variable ($LANG)
6189 # --------------------------------
6190 # Define a compiler variable.  We also handle defining the 'LT'
6191 # version of the command when using libtool.
6192 sub define_compiler_variable ($)
6194     my ($lang) = @_;
6196     my ($var, $value) = ($lang->compiler, $lang->compile);
6197     my $libtool_tag = '';
6198     $libtool_tag = '--tag=' . $lang->libtool_tag . ' '
6199       if $lang->libtool_tag && exists $libtool_tags{$lang->libtool_tag};
6200     &define_variable ($var, $value, INTERNAL);
6201     if (var ('LIBTOOL'))
6202       {
6203         my $verbose = define_verbose_libtool ();
6204         &define_variable ("LT$var",
6205                           "\$(LIBTOOL) $verbose $libtool_tag\$(AM_LIBTOOLFLAGS) "
6206                           . "\$(LIBTOOLFLAGS) --mode=compile $value",
6207                           INTERNAL);
6208       }
6209     define_verbose_tagvar ($lang->ccer || 'GEN');
6213 # define_linker_variable ($LANG)
6214 # ------------------------------
6215 # Define linker variables.
6216 sub define_linker_variable ($)
6218     my ($lang) = @_;
6220     my $libtool_tag = '';
6221     $libtool_tag = '--tag=' . $lang->libtool_tag . ' '
6222       if $lang->libtool_tag && exists $libtool_tags{$lang->libtool_tag};
6223     # CCLD = $(CC).
6224     &define_variable ($lang->lder, $lang->ld, INTERNAL);
6225     # CCLINK = $(CCLD) blah blah...
6226     my $link = '';
6227     if (var ('LIBTOOL'))
6228       {
6229         my $verbose = define_verbose_libtool ();
6230         $link = "\$(LIBTOOL) $verbose $libtool_tag\$(AM_LIBTOOLFLAGS) "
6231                 . "\$(LIBTOOLFLAGS) --mode=link ";
6232       }
6233     &define_variable ($lang->linker, $link . $lang->link, INTERNAL);
6234     &define_variable ($lang->compiler,  $lang);
6235     &define_verbose_tagvar ($lang->lder || 'GEN');
6238 sub define_per_target_linker_variable ($$)
6240   my ($linker, $target) = @_;
6242   # If the user wrote a custom link command, we don't define ours.
6243   return "${target}_LINK"
6244     if set_seen "${target}_LINK";
6246   my $xlink = $linker ? $linker : 'LINK';
6248   my $lang = $link_languages{$xlink};
6249   prog_error "Unknown language for linker variable '$xlink'"
6250     unless $lang;
6252   my $link_command = $lang->link;
6253   if (var 'LIBTOOL')
6254     {
6255       my $libtool_tag = '';
6256       $libtool_tag = '--tag=' . $lang->libtool_tag . ' '
6257         if $lang->libtool_tag && exists $libtool_tags{$lang->libtool_tag};
6259       my $verbose = define_verbose_libtool ();
6260       $link_command =
6261         "\$(LIBTOOL) $verbose $libtool_tag\$(AM_LIBTOOLFLAGS) \$(LIBTOOLFLAGS) "
6262         . "--mode=link " . $link_command;
6263     }
6265   # Rewrite each occurrence of 'AM_$flag' in the link
6266   # command into '${derived}_$flag' if it exists.
6267   my $orig_command = $link_command;
6268   my @flags = (@{$lang->flags}, 'LDFLAGS');
6269   push @flags, 'LIBTOOLFLAGS' if var 'LIBTOOL';
6270   for my $flag (@flags)
6271     {
6272       my $val = "${target}_$flag";
6273       $link_command =~ s/\(AM_$flag\)/\($val\)/
6274         if set_seen ($val);
6275     }
6277   # If the computed command is the same as the generic command, use
6278   # the command linker variable.
6279   return ($lang->linker, $lang->lder)
6280     if $link_command eq $orig_command;
6282   &define_variable ("${target}_LINK", $link_command, INTERNAL);
6283   return ("${target}_LINK", $lang->lder);
6286 ################################################################
6288 # &check_trailing_slash ($WHERE, $LINE)
6289 # -------------------------------------
6290 # Return 1 iff $LINE ends with a slash.
6291 # Might modify $LINE.
6292 sub check_trailing_slash ($\$)
6294   my ($where, $line) = @_;
6296   # Ignore '##' lines.
6297   return 0 if $$line =~ /$IGNORE_PATTERN/o;
6299   # Catch and fix a common error.
6300   msg "syntax", $where, "whitespace following trailing backslash"
6301     if $$line =~ s/\\\s+\n$/\\\n/;
6303   return $$line =~ /\\$/;
6307 # &read_am_file ($AMFILE, $WHERE)
6308 # -------------------------------
6309 # Read Makefile.am and set up %contents.  Simultaneously copy lines
6310 # from Makefile.am into $output_trailer, or define variables as
6311 # appropriate.  NOTE we put rules in the trailer section.  We want
6312 # user rules to come after our generated stuff.
6313 sub read_am_file ($$)
6315     my ($amfile, $where) = @_;
6317     my $am_file = new Automake::XFile ("< $amfile");
6318     verb "reading $amfile";
6320     # Keep track of the youngest output dependency.
6321     my $mtime = mtime $amfile;
6322     $output_deps_greatest_timestamp = $mtime
6323       if $mtime > $output_deps_greatest_timestamp;
6325     my $spacing = '';
6326     my $comment = '';
6327     my $blank = 0;
6328     my $saw_bk = 0;
6329     my $var_look = VAR_ASIS;
6331     use constant IN_VAR_DEF => 0;
6332     use constant IN_RULE_DEF => 1;
6333     use constant IN_COMMENT => 2;
6334     my $prev_state = IN_RULE_DEF;
6336     while ($_ = $am_file->getline)
6337     {
6338         $where->set ("$amfile:$.");
6339         if (/$IGNORE_PATTERN/o)
6340         {
6341             # Merely delete comments beginning with two hashes.
6342         }
6343         elsif (/$WHITE_PATTERN/o)
6344         {
6345             error $where, "blank line following trailing backslash"
6346               if $saw_bk;
6347             # Stick a single white line before the incoming macro or rule.
6348             $spacing = "\n";
6349             $blank = 1;
6350             # Flush all comments seen so far.
6351             if ($comment ne '')
6352             {
6353                 $output_vars .= $comment;
6354                 $comment = '';
6355             }
6356         }
6357         elsif (/$COMMENT_PATTERN/o)
6358         {
6359             # Stick comments before the incoming macro or rule.  Make
6360             # sure a blank line precedes the first block of comments.
6361             $spacing = "\n" unless $blank;
6362             $blank = 1;
6363             $comment .= $spacing . $_;
6364             $spacing = '';
6365             $prev_state = IN_COMMENT;
6366         }
6367         else
6368         {
6369             last;
6370         }
6371         $saw_bk = check_trailing_slash ($where, $_);
6372     }
6374     # We save the conditional stack on entry, and then check to make
6375     # sure it is the same on exit.  This lets us conditionally include
6376     # other files.
6377     my @saved_cond_stack = @cond_stack;
6378     my $cond = new Automake::Condition (@cond_stack);
6380     my $last_var_name = '';
6381     my $last_var_type = '';
6382     my $last_var_value = '';
6383     my $last_where;
6384     # FIXME: shouldn't use $_ in this loop; it is too big.
6385     while ($_)
6386     {
6387         $where->set ("$amfile:$.");
6389         # Make sure the line is \n-terminated.
6390         chomp;
6391         $_ .= "\n";
6393         # Don't look at MAINTAINER_MODE_TRUE here.  That shouldn't be
6394         # used by users.  @MAINT@ is an anachronism now.
6395         $_ =~ s/\@MAINT\@//g
6396             unless $seen_maint_mode;
6398         my $new_saw_bk = check_trailing_slash ($where, $_);
6400         if (/$IGNORE_PATTERN/o)
6401         {
6402             # Merely delete comments beginning with two hashes.
6404             # Keep any backslash from the previous line.
6405             $new_saw_bk = $saw_bk;
6406         }
6407         elsif (/$WHITE_PATTERN/o)
6408         {
6409             # Stick a single white line before the incoming macro or rule.
6410             $spacing = "\n";
6411             error $where, "blank line following trailing backslash"
6412               if $saw_bk;
6413         }
6414         elsif (/$COMMENT_PATTERN/o)
6415         {
6416             error $where, "comment following trailing backslash"
6417               if $saw_bk && $prev_state != IN_COMMENT;
6419             # Stick comments before the incoming macro or rule.
6420             $comment .= $spacing . $_;
6421             $spacing = '';
6422             $prev_state = IN_COMMENT;
6423         }
6424         elsif ($saw_bk)
6425         {
6426             if ($prev_state == IN_RULE_DEF)
6427             {
6428               my $cond = new Automake::Condition @cond_stack;
6429               $output_trailer .= $cond->subst_string;
6430               $output_trailer .= $_;
6431             }
6432             elsif ($prev_state == IN_COMMENT)
6433             {
6434                 # If the line doesn't start with a '#', add it.
6435                 # We do this because a continued comment like
6436                 #   # A = foo \
6437                 #         bar \
6438                 #         baz
6439                 # is not portable.  BSD make doesn't honor
6440                 # escaped newlines in comments.
6441                 s/^#?/#/;
6442                 $comment .= $spacing . $_;
6443             }
6444             else # $prev_state == IN_VAR_DEF
6445             {
6446               $last_var_value .= ' '
6447                 unless $last_var_value =~ /\s$/;
6448               $last_var_value .= $_;
6450               if (!/\\$/)
6451                 {
6452                   Automake::Variable::define ($last_var_name, VAR_MAKEFILE,
6453                                               $last_var_type, $cond,
6454                                               $last_var_value, $comment,
6455                                               $last_where, VAR_ASIS)
6456                     if $cond != FALSE;
6457                   $comment = $spacing = '';
6458                 }
6459             }
6460         }
6462         elsif (/$IF_PATTERN/o)
6463           {
6464             $cond = cond_stack_if ($1, $2, $where);
6465           }
6466         elsif (/$ELSE_PATTERN/o)
6467           {
6468             $cond = cond_stack_else ($1, $2, $where);
6469           }
6470         elsif (/$ENDIF_PATTERN/o)
6471           {
6472             $cond = cond_stack_endif ($1, $2, $where);
6473           }
6475         elsif (/$RULE_PATTERN/o)
6476         {
6477             # Found a rule.
6478             $prev_state = IN_RULE_DEF;
6480             # For now we have to output all definitions of user rules
6481             # and can't diagnose duplicates (see the comment in
6482             # Automake::Rule::define). So we go on and ignore the return value.
6483             Automake::Rule::define ($1, $amfile, RULE_USER, $cond, $where);
6485             check_variable_expansions ($_, $where);
6487             $output_trailer .= $comment . $spacing;
6488             my $cond = new Automake::Condition @cond_stack;
6489             $output_trailer .= $cond->subst_string;
6490             $output_trailer .= $_;
6491             $comment = $spacing = '';
6492         }
6493         elsif (/$ASSIGNMENT_PATTERN/o)
6494         {
6495             # Found a macro definition.
6496             $prev_state = IN_VAR_DEF;
6497             $last_var_name = $1;
6498             $last_var_type = $2;
6499             $last_var_value = $3;
6500             $last_where = $where->clone;
6501             if ($3 ne '' && substr ($3, -1) eq "\\")
6502               {
6503                 # We preserve the '\' because otherwise the long lines
6504                 # that are generated will be truncated by broken
6505                 # 'sed's.
6506                 $last_var_value = $3 . "\n";
6507               }
6508             # Normally we try to output variable definitions in the
6509             # same format they were input.  However, POSIX compliant
6510             # systems are not required to support lines longer than
6511             # 2048 bytes (most notably, some sed implementation are
6512             # limited to 4000 bytes, and sed is used by config.status
6513             # to rewrite Makefile.in into Makefile).  Moreover nobody
6514             # would really write such long lines by hand since it is
6515             # hardly maintainable.  So if a line is longer that 1000
6516             # bytes (an arbitrary limit), assume it has been
6517             # automatically generated by some tools, and flatten the
6518             # variable definition.  Otherwise, keep the variable as it
6519             # as been input.
6520             $var_look = VAR_PRETTY if length ($last_var_value) >= 1000;
6522             if (!/\\$/)
6523               {
6524                 Automake::Variable::define ($last_var_name, VAR_MAKEFILE,
6525                                             $last_var_type, $cond,
6526                                             $last_var_value, $comment,
6527                                             $last_where, $var_look)
6528                   if $cond != FALSE;
6529                 $comment = $spacing = '';
6530                 $var_look = VAR_ASIS;
6531               }
6532         }
6533         elsif (/$INCLUDE_PATTERN/o)
6534         {
6535             my $path = $1;
6537             if ($path =~ s/^\$\(top_srcdir\)\///)
6538               {
6539                 push (@include_stack, "\$\(top_srcdir\)/$path");
6540                 # Distribute any included file.
6542                 # Always use the $(top_srcdir) prefix in DIST_COMMON,
6543                 # otherwise OSF make will implicitly copy the included
6544                 # file in the build tree during "make distdir" to satisfy
6545                 # the dependency.
6546                 # (subdircond2.test and subdircond3.test will fail.)
6547                 push_dist_common ("\$\(top_srcdir\)/$path");
6548               }
6549             else
6550               {
6551                 $path =~ s/\$\(srcdir\)\///;
6552                 push (@include_stack, "\$\(srcdir\)/$path");
6553                 # Always use the $(srcdir) prefix in DIST_COMMON,
6554                 # otherwise OSF make will implicitly copy the included
6555                 # file in the build tree during "make distdir" to satisfy
6556                 # the dependency.
6557                 # (subdircond2.test and subdircond3.test will fail.)
6558                 push_dist_common ("\$\(srcdir\)/$path");
6559                 $path = $relative_dir . "/" . $path if $relative_dir ne '.';
6560               }
6561             $where->push_context ("'$path' included from here");
6562             &read_am_file ($path, $where);
6563             $where->pop_context;
6564         }
6565         else
6566         {
6567             # This isn't an error; it is probably a continued rule.
6568             # In fact, this is what we assume.
6569             $prev_state = IN_RULE_DEF;
6570             check_variable_expansions ($_, $where);
6571             $output_trailer .= $comment . $spacing;
6572             my $cond = new Automake::Condition @cond_stack;
6573             $output_trailer .= $cond->subst_string;
6574             $output_trailer .= $_;
6575             $comment = $spacing = '';
6576             error $where, "'#' comment at start of rule is unportable"
6577               if $_ =~ /^\t\s*\#/;
6578         }
6580         $saw_bk = $new_saw_bk;
6581         $_ = $am_file->getline;
6582     }
6584     $output_trailer .= $comment;
6586     error ($where, "trailing backslash on last line")
6587       if $saw_bk;
6589     error ($where, (@cond_stack ? "unterminated conditionals: @cond_stack"
6590                     : "too many conditionals closed in include file"))
6591       if "@saved_cond_stack" ne "@cond_stack";
6595 # define_standard_variables ()
6596 # ----------------------------
6597 # A helper for read_main_am_file which initializes configure variables
6598 # and variables from header-vars.am.
6599 sub define_standard_variables
6601   my $saved_output_vars = $output_vars;
6602   my ($comments, undef, $rules) =
6603     file_contents_internal (1, "$libdir/am/header-vars.am",
6604                             new Automake::Location);
6606   foreach my $var (sort keys %configure_vars)
6607     {
6608       &define_configure_variable ($var);
6609     }
6611   $output_vars .= $comments . $rules;
6614 # Read main am file.
6615 sub read_main_am_file ($$)
6617     my ($amfile, $infile) = @_;
6619     # This supports the strange variable tricks we are about to play.
6620     prog_error ("variable defined before read_main_am_file\n" . variables_dump ())
6621       if (scalar (variables) > 0);
6623     # Generate copyright header for generated Makefile.in.
6624     # We do discard the output of predefined variables, handled below.
6625     $output_vars = ("# " . basename ($infile) . " generated by automake "
6626                    . $VERSION . " from " . basename ($amfile) . ".\n");
6627     $output_vars .= '# ' . subst ('configure_input') . "\n";
6628     $output_vars .= $gen_copyright;
6630     # We want to predefine as many variables as possible.  This lets
6631     # the user set them with '+=' in Makefile.am.
6632     &define_standard_variables;
6634     # Read user file, which might override some of our values.
6635     &read_am_file ($amfile, new Automake::Location);
6640 ################################################################
6642 # $FLATTENED
6643 # &flatten ($STRING)
6644 # ------------------
6645 # Flatten the $STRING and return the result.
6646 sub flatten
6648   $_ = shift;
6650   s/\\\n//somg;
6651   s/\s+/ /g;
6652   s/^ //;
6653   s/ $//;
6655   return $_;
6659 # transform_token ($TOKEN, \%PAIRS, $KEY)
6660 # =======================================
6661 # Return the value associated to $KEY in %PAIRS, as used on $TOKEN
6662 # (which should be ?KEY? or any of the special %% requests)..
6663 sub transform_token ($$$)
6665   my ($token, $transform, $key) = @_;
6666   my $res = $transform->{$key};
6667   prog_error "Unknown key '$key' in '$token'" unless defined $res;
6668   return $res;
6672 # transform ($TOKEN, \%PAIRS)
6673 # ===========================
6674 # If ($TOKEN, $VAL) is in %PAIRS:
6675 #   - replaces %KEY% with $VAL,
6676 #   - enables/disables ?KEY? and ?!KEY?,
6677 #   - replaces %?KEY% with TRUE or FALSE.
6678 sub transform ($$)
6680   my ($token, $transform) = @_;
6682   # %KEY%.
6683   # Must be before the following pattern to exclude the case
6684   # when there is neither IFTRUE nor IFFALSE.
6685   if ($token =~ /^%([\w\-]+)%$/)
6686     {
6687       return transform_token ($token, $transform, $1);
6688     }
6689   # %?KEY%.
6690   elsif ($token =~ /^%\?([\w\-]+)%$/)
6691     {
6692       return transform_token ($token, $transform, $1) ? 'TRUE' : 'FALSE';
6693     }
6694   # ?KEY? and ?!KEY?.
6695   elsif ($token =~ /^ \? (!?) ([\w\-]+) \? $/x)
6696     {
6697       my $neg = ($1 eq '!') ? 1 : 0;
6698       my $val = transform_token ($token, $transform, $2);
6699       return (!!$val == $neg) ? '##%' : '';
6700     }
6701   else
6702     {
6703       prog_error "Unknown request format: $token";
6704     }
6707 # $TEXT
6708 # preprocess_file ($MAKEFILE, [%TRANSFORM])
6709 # -----------------------------------------
6710 # Load a $MAKEFILE, apply the %TRANSFORM, and return the result.
6711 # No extra parsing or post-processing is done (i.e., recognition of
6712 # rules declaration or of make variables definitions).
6713 sub preprocess_file ($%)
6715   my ($file, %transform) = @_;
6717   # Complete %transform with global options.
6718   # Note that %transform goes last, so it overrides global options.
6719   %transform = ( 'MAINTAINER-MODE'
6720                  => $seen_maint_mode ? subst ('MAINTAINER_MODE_TRUE') : '',
6722                  'XZ'          => !! option 'dist-xz',
6723                  'LZIP'        => !! option 'dist-lzip',
6724                  'BZIP2'       => !! option 'dist-bzip2',
6725                  'COMPRESS'    => !! option 'dist-tarZ',
6726                  'GZIP'        =>  ! option 'no-dist-gzip',
6727                  'SHAR'        => !! option 'dist-shar',
6728                  'ZIP'         => !! option 'dist-zip',
6730                  'INSTALL-INFO' =>  ! option 'no-installinfo',
6731                  'INSTALL-MAN'  =>  ! option 'no-installman',
6732                  'CK-NEWS'      => !! option 'check-news',
6734                  'SUBDIRS'      => !! var ('SUBDIRS'),
6735                  'TOPDIR_P'     => $relative_dir eq '.',
6737                  'BUILD'    => ($seen_canonical >= AC_CANONICAL_BUILD),
6738                  'HOST'     => ($seen_canonical >= AC_CANONICAL_HOST),
6739                  'TARGET'   => ($seen_canonical >= AC_CANONICAL_TARGET),
6741                  'LIBTOOL'      => !! var ('LIBTOOL'),
6742                  'NONLIBTOOL'   => 1,
6743                 %transform);
6745   if (! defined ($_ = $am_file_cache{$file}))
6746     {
6747       verb "reading $file";
6748       # Swallow the whole file.
6749       my $fc_file = new Automake::XFile "< $file";
6750       my $saved_dollar_slash = $/;
6751       undef $/;
6752       $_ = $fc_file->getline;
6753       $/ = $saved_dollar_slash;
6754       $fc_file->close;
6755       # Remove ##-comments.
6756       # Besides we don't need more than two consecutive new-lines.
6757       s/(?:$IGNORE_PATTERN|(?<=\n\n)\n+)//gom;
6758       # Remember the contents of the just-read file.
6759       $am_file_cache{$file} = $_;
6760     }
6762   # Substitute Automake template tokens.
6763   s/(?: % \?? [\w\-]+ %
6764       | \? !? [\w\-]+ \?
6765     )/transform($&, \%transform)/gex;
6766   # transform() may have added some ##%-comments to strip.
6767   # (we use '##%' instead of '##' so we can distinguish ##%##%##% from
6768   # ####### and do not remove the latter.)
6769   s/^[ \t]*(?:##%)+.*\n//gm;
6771   return $_;
6775 # @PARAGRAPHS
6776 # &make_paragraphs ($MAKEFILE, [%TRANSFORM])
6777 # ------------------------------------------
6778 # Load a $MAKEFILE, apply the %TRANSFORM, and return it as a list of
6779 # paragraphs.
6780 sub make_paragraphs ($%)
6782   my ($file, %transform) = @_;
6783   $transform{FIRST} = !$transformed_files{$file};
6784   $transformed_files{$file} = 1;
6786   my @lines = split /(?<!\\)\n/, preprocess_file ($file, %transform);
6787   my @res;
6789   while (defined ($_ = shift @lines))
6790     {
6791       my $paragraph = $_;
6792       # If we are a rule, eat as long as we start with a tab.
6793       if (/$RULE_PATTERN/smo)
6794         {
6795           while (defined ($_ = shift @lines) && $_ =~ /^\t/)
6796             {
6797               $paragraph .= "\n$_";
6798             }
6799           unshift (@lines, $_);
6800         }
6802       # If we are a comments, eat as much comments as you can.
6803       elsif (/$COMMENT_PATTERN/smo)
6804         {
6805           while (defined ($_ = shift @lines)
6806                  && $_ =~ /$COMMENT_PATTERN/smo)
6807             {
6808               $paragraph .= "\n$_";
6809             }
6810           unshift (@lines, $_);
6811         }
6813       push @res, $paragraph;
6814     }
6816   return @res;
6821 # ($COMMENT, $VARIABLES, $RULES)
6822 # &file_contents_internal ($IS_AM, $FILE, $WHERE, [%TRANSFORM])
6823 # -------------------------------------------------------------
6824 # Return contents of a file from $libdir/am, automatically skipping
6825 # macros or rules which are already known. $IS_AM iff the caller is
6826 # reading an Automake file (as opposed to the user's Makefile.am).
6827 sub file_contents_internal ($$$%)
6829     my ($is_am, $file, $where, %transform) = @_;
6831     $where->set ($file);
6833     my $result_vars = '';
6834     my $result_rules = '';
6835     my $comment = '';
6836     my $spacing = '';
6838     # The following flags are used to track rules spanning across
6839     # multiple paragraphs.
6840     my $is_rule = 0;            # 1 if we are processing a rule.
6841     my $discard_rule = 0;       # 1 if the current rule should not be output.
6843     # We save the conditional stack on entry, and then check to make
6844     # sure it is the same on exit.  This lets us conditionally include
6845     # other files.
6846     my @saved_cond_stack = @cond_stack;
6847     my $cond = new Automake::Condition (@cond_stack);
6849     foreach (make_paragraphs ($file, %transform))
6850     {
6851         # FIXME: no line number available.
6852         $where->set ($file);
6854         # Sanity checks.
6855         error $where, "blank line following trailing backslash:\n$_"
6856           if /\\$/;
6857         error $where, "comment following trailing backslash:\n$_"
6858           if /\\#/;
6860         if (/^$/)
6861         {
6862             $is_rule = 0;
6863             # Stick empty line before the incoming macro or rule.
6864             $spacing = "\n";
6865         }
6866         elsif (/$COMMENT_PATTERN/mso)
6867         {
6868             $is_rule = 0;
6869             # Stick comments before the incoming macro or rule.
6870             $comment = "$_\n";
6871         }
6873         # Handle inclusion of other files.
6874         elsif (/$INCLUDE_PATTERN/o)
6875         {
6876             if ($cond != FALSE)
6877               {
6878                 my $file = ($is_am ? "$libdir/am/" : '') . $1;
6879                 $where->push_context ("'$file' included from here");
6880                 # N-ary '.=' fails.
6881                 my ($com, $vars, $rules)
6882                   = file_contents_internal ($is_am, $file, $where, %transform);
6883                 $where->pop_context;
6884                 $comment .= $com;
6885                 $result_vars .= $vars;
6886                 $result_rules .= $rules;
6887               }
6888         }
6890         # Handling the conditionals.
6891         elsif (/$IF_PATTERN/o)
6892           {
6893             $cond = cond_stack_if ($1, $2, $file);
6894           }
6895         elsif (/$ELSE_PATTERN/o)
6896           {
6897             $cond = cond_stack_else ($1, $2, $file);
6898           }
6899         elsif (/$ENDIF_PATTERN/o)
6900           {
6901             $cond = cond_stack_endif ($1, $2, $file);
6902           }
6904         # Handling rules.
6905         elsif (/$RULE_PATTERN/mso)
6906         {
6907           $is_rule = 1;
6908           $discard_rule = 0;
6909           # Separate relationship from optional actions: the first
6910           # `new-line tab" not preceded by backslash (continuation
6911           # line).
6912           my $paragraph = $_;
6913           /^(.*?)(?:(?<!\\)\n(\t.*))?$/s;
6914           my ($relationship, $actions) = ($1, $2 || '');
6916           # Separate targets from dependencies: the first colon.
6917           $relationship =~ /^([^:]+\S+) *: *(.*)$/som;
6918           my ($targets, $dependencies) = ($1, $2);
6919           # Remove the escaped new lines.
6920           # I don't know why, but I have to use a tmp $flat_deps.
6921           my $flat_deps = &flatten ($dependencies);
6922           my @deps = split (' ', $flat_deps);
6924           foreach (split (' ', $targets))
6925             {
6926               # FIXME: 1. We are not robust to people defining several targets
6927               # at once, only some of them being in %dependencies.  The
6928               # actions from the targets in %dependencies are usually generated
6929               # from the content of %actions, but if some targets in $targets
6930               # are not in %dependencies the ELSE branch will output
6931               # a rule for all $targets (i.e. the targets which are both
6932               # in %dependencies and $targets will have two rules).
6934               # FIXME: 2. The logic here is not able to output a
6935               # multi-paragraph rule several time (e.g. for each condition
6936               # it is defined for) because it only knows the first paragraph.
6938               # FIXME: 3. We are not robust to people defining a subset
6939               # of a previously defined "multiple-target" rule.  E.g.
6940               # 'foo:' after 'foo bar:'.
6942               # Output only if not in FALSE.
6943               if (defined $dependencies{$_} && $cond != FALSE)
6944                 {
6945                   &depend ($_, @deps);
6946                   register_action ($_, $actions);
6947                 }
6948               else
6949                 {
6950                   # Free-lance dependency.  Output the rule for all the
6951                   # targets instead of one by one.
6952                   my @undefined_conds =
6953                     Automake::Rule::define ($targets, $file,
6954                                             $is_am ? RULE_AUTOMAKE : RULE_USER,
6955                                             $cond, $where);
6956                   for my $undefined_cond (@undefined_conds)
6957                     {
6958                       my $condparagraph = $paragraph;
6959                       $condparagraph =~ s/^/$undefined_cond->subst_string/gme;
6960                       $result_rules .= "$spacing$comment$condparagraph\n";
6961                     }
6962                   if (scalar @undefined_conds == 0)
6963                     {
6964                       # Remember to discard next paragraphs
6965                       # if they belong to this rule.
6966                       # (but see also FIXME: #2 above.)
6967                       $discard_rule = 1;
6968                     }
6969                   $comment = $spacing = '';
6970                   last;
6971                 }
6972             }
6973         }
6975         elsif (/$ASSIGNMENT_PATTERN/mso)
6976         {
6977             my ($var, $type, $val) = ($1, $2, $3);
6978             error $where, "variable '$var' with trailing backslash"
6979               if /\\$/;
6981             $is_rule = 0;
6983             Automake::Variable::define ($var,
6984                                         $is_am ? VAR_AUTOMAKE : VAR_MAKEFILE,
6985                                         $type, $cond, $val, $comment, $where,
6986                                         VAR_ASIS)
6987               if $cond != FALSE;
6989             $comment = $spacing = '';
6990         }
6991         else
6992         {
6993             # This isn't an error; it is probably some tokens which
6994             # configure is supposed to replace, such as '@SET-MAKE@',
6995             # or some part of a rule cut by an if/endif.
6996             if (! $cond->false && ! ($is_rule && $discard_rule))
6997               {
6998                 s/^/$cond->subst_string/gme;
6999                 $result_rules .= "$spacing$comment$_\n";
7000               }
7001             $comment = $spacing = '';
7002         }
7003     }
7005     error ($where, @cond_stack ?
7006            "unterminated conditionals: @cond_stack" :
7007            "too many conditionals closed in include file")
7008       if "@saved_cond_stack" ne "@cond_stack";
7010     return ($comment, $result_vars, $result_rules);
7014 # $CONTENTS
7015 # &file_contents ($BASENAME, $WHERE, [%TRANSFORM])
7016 # ------------------------------------------------
7017 # Return contents of a file from $libdir/am, automatically skipping
7018 # macros or rules which are already known.
7019 sub file_contents ($$%)
7021     my ($basename, $where, %transform) = @_;
7022     my ($comments, $variables, $rules) =
7023       file_contents_internal (1, "$libdir/am/$basename.am", $where,
7024                               %transform);
7025     return "$comments$variables$rules";
7029 # @PREFIX
7030 # &am_primary_prefixes ($PRIMARY, $CAN_DIST, @PREFIXES)
7031 # -----------------------------------------------------
7032 # Find all variable prefixes that are used for install directories.  A
7033 # prefix 'zar' qualifies iff:
7035 # * 'zardir' is a variable.
7036 # * 'zar_PRIMARY' is a variable.
7038 # As a side effect, it looks for misspellings.  It is an error to have
7039 # a variable ending in a "reserved" suffix whose prefix is unknown, e.g.
7040 # "bni_PROGRAMS".  However, unusual prefixes are allowed if a variable
7041 # of the same name (with "dir" appended) exists.  For instance, if the
7042 # variable "zardir" is defined, then "zar_PROGRAMS" becomes valid.
7043 # This is to provide a little extra flexibility in those cases which
7044 # need it.
7045 sub am_primary_prefixes ($$@)
7047   my ($primary, $can_dist, @prefixes) = @_;
7049   local $_;
7050   my %valid = map { $_ => 0 } @prefixes;
7051   $valid{'EXTRA'} = 0;
7052   foreach my $var (variables $primary)
7053     {
7054       # Automake is allowed to define variables that look like primaries
7055       # but which aren't.  E.g. INSTALL_sh_DATA.
7056       # Autoconf can also define variables like INSTALL_DATA, so
7057       # ignore all configure variables (at least those which are not
7058       # redefined in Makefile.am).
7059       # FIXME: We should make sure that these variables are not
7060       # conditionally defined (or else adjust the condition below).
7061       my $def = $var->def (TRUE);
7062       next if $def && $def->owner != VAR_MAKEFILE;
7064       my $varname = $var->name;
7066       if ($varname =~ /^(nobase_)?(dist_|nodist_)?(.*)_[[:alnum:]]+$/)
7067         {
7068           my ($base, $dist, $X) = ($1 || '', $2 || '', $3 || '');
7069           if ($dist ne '' && ! $can_dist)
7070             {
7071               err_var ($var,
7072                        "invalid variable '$varname': 'dist' is forbidden");
7073             }
7074           # Standard directories must be explicitly allowed.
7075           elsif (! defined $valid{$X} && exists $standard_prefix{$X})
7076             {
7077               err_var ($var,
7078                        "'${X}dir' is not a legitimate directory " .
7079                        "for '$primary'");
7080             }
7081           # A not explicitly valid directory is allowed if Xdir is defined.
7082           elsif (! defined $valid{$X} &&
7083                  $var->requires_variables ("'$varname' is used", "${X}dir"))
7084             {
7085               # Nothing to do.  Any error message has been output
7086               # by $var->requires_variables.
7087             }
7088           else
7089             {
7090               # Ensure all extended prefixes are actually used.
7091               $valid{"$base$dist$X"} = 1;
7092             }
7093         }
7094       else
7095         {
7096           prog_error "unexpected variable name: $varname";
7097         }
7098     }
7100   # Return only those which are actually defined.
7101   return sort grep { var ($_ . '_' . $primary) } keys %valid;
7105 # Handle 'where_HOW' variable magic.  Does all lookups, generates
7106 # install code, and possibly generates code to define the primary
7107 # variable.  The first argument is the name of the .am file to munge,
7108 # the second argument is the primary variable (e.g. HEADERS), and all
7109 # subsequent arguments are possible installation locations.
7111 # Returns list of [$location, $value] pairs, where
7112 # $value's are the values in all where_HOW variable, and $location
7113 # there associated location (the place here their parent variables were
7114 # defined).
7116 # FIXME: this should be rewritten to be cleaner.  It should be broken
7117 # up into multiple functions.
7119 # Usage is: am_install_var (OPTION..., file, HOW, where...)
7120 sub am_install_var
7122   my (@args) = @_;
7124   my $do_require = 1;
7125   my $can_dist = 0;
7126   my $default_dist = 0;
7127   while (@args)
7128     {
7129       if ($args[0] eq '-noextra')
7130         {
7131           $do_require = 0;
7132         }
7133       elsif ($args[0] eq '-candist')
7134         {
7135           $can_dist = 1;
7136         }
7137       elsif ($args[0] eq '-defaultdist')
7138         {
7139           $default_dist = 1;
7140           $can_dist = 1;
7141         }
7142       elsif ($args[0] !~ /^-/)
7143         {
7144           last;
7145         }
7146       shift (@args);
7147     }
7149   my ($file, $primary, @prefix) = @args;
7151   # Now that configure substitutions are allowed in where_HOW
7152   # variables, it is an error to actually define the primary.  We
7153   # allow 'JAVA', as it is customarily used to mean the Java
7154   # interpreter.  This is but one of several Java hacks.  Similarly,
7155   # 'PYTHON' is customarily used to mean the Python interpreter.
7156   reject_var $primary, "'$primary' is an anachronism"
7157     unless $primary eq 'JAVA' || $primary eq 'PYTHON';
7159   # Get the prefixes which are valid and actually used.
7160   @prefix = am_primary_prefixes ($primary, $can_dist, @prefix);
7162   # If a primary includes a configure substitution, then the EXTRA_
7163   # form is required.  Otherwise we can't properly do our job.
7164   my $require_extra;
7166   my @used = ();
7167   my @result = ();
7169   foreach my $X (@prefix)
7170     {
7171       my $nodir_name = $X;
7172       my $one_name = $X . '_' . $primary;
7173       my $one_var = var $one_name;
7175       my $strip_subdir = 1;
7176       # If subdir prefix should be preserved, do so.
7177       if ($nodir_name =~ /^nobase_/)
7178         {
7179           $strip_subdir = 0;
7180           $nodir_name =~ s/^nobase_//;
7181         }
7183       # If files should be distributed, do so.
7184       my $dist_p = 0;
7185       if ($can_dist)
7186         {
7187           $dist_p = (($default_dist && $nodir_name !~ /^nodist_/)
7188                      || (! $default_dist && $nodir_name =~ /^dist_/));
7189           $nodir_name =~ s/^(dist|nodist)_//;
7190         }
7193       # Use the location of the currently processed variable.
7194       # We are not processing a particular condition, so pick the first
7195       # available.
7196       my $tmpcond = $one_var->conditions->one_cond;
7197       my $where = $one_var->rdef ($tmpcond)->location->clone;
7199       # Append actual contents of where_PRIMARY variable to
7200       # @result, skipping @substitutions@.
7201       foreach my $locvals ($one_var->value_as_list_recursive (location => 1))
7202         {
7203           my ($loc, $value) = @$locvals;
7204           # Skip configure substitutions.
7205           if ($value =~ /^\@.*\@$/)
7206             {
7207               if ($nodir_name eq 'EXTRA')
7208                 {
7209                   error ($where,
7210                          "'$one_name' contains configure substitution, "
7211                          . "but shouldn't");
7212                 }
7213               # Check here to make sure variables defined in
7214               # configure.ac do not imply that EXTRA_PRIMARY
7215               # must be defined.
7216               elsif (! defined $configure_vars{$one_name})
7217                 {
7218                   $require_extra = $one_name
7219                     if $do_require;
7220                 }
7221             }
7222           else
7223             {
7224               # Strip any $(EXEEXT) suffix the user might have added, or this
7225               # will confuse &handle_source_transform and &check_canonical_spelling.
7226               # We'll add $(EXEEXT) back later anyway.
7227               # Do it here rather than in handle_programs so the uniquifying at the
7228               # end of this function works.
7229               ${$locvals}[1] =~ s/\$\(EXEEXT\)$//
7230                 if $primary eq 'PROGRAMS';
7232               push (@result, $locvals);
7233             }
7234         }
7235       # A blatant hack: we rewrite each _PROGRAMS primary to include
7236       # EXEEXT.
7237       append_exeext { 1 } $one_name
7238         if $primary eq 'PROGRAMS';
7239       # "EXTRA" shouldn't be used when generating clean targets,
7240       # all, or install targets.  We used to warn if EXTRA_FOO was
7241       # defined uselessly, but this was annoying.
7242       next
7243         if $nodir_name eq 'EXTRA';
7245       if ($nodir_name eq 'check')
7246         {
7247           push (@check, '$(' . $one_name . ')');
7248         }
7249       else
7250         {
7251           push (@used, '$(' . $one_name . ')');
7252         }
7254       # Is this to be installed?
7255       my $install_p = $nodir_name ne 'noinst' && $nodir_name ne 'check';
7257       # If so, with install-exec? (or install-data?).
7258       my $exec_p = ($nodir_name =~ /$EXEC_DIR_PATTERN/o);
7260       my $check_options_p = $install_p && !! option 'std-options';
7262       # Use the location of the currently processed variable as context.
7263       $where->push_context ("while processing '$one_name'");
7265       # The variable containing all files to distribute.
7266       my $distvar = "\$($one_name)";
7267       $distvar = shadow_unconditionally ($one_name, $where)
7268         if ($dist_p && $one_var->has_conditional_contents);
7270       # Singular form of $PRIMARY.
7271       (my $one_primary = $primary) =~ s/S$//;
7272       $output_rules .= &file_contents ($file, $where,
7273                                        PRIMARY     => $primary,
7274                                        ONE_PRIMARY => $one_primary,
7275                                        DIR         => $X,
7276                                        NDIR        => $nodir_name,
7277                                        BASE        => $strip_subdir,
7279                                        EXEC      => $exec_p,
7280                                        INSTALL   => $install_p,
7281                                        DIST      => $dist_p,
7282                                        DISTVAR   => $distvar,
7283                                        'CK-OPTS' => $check_options_p);
7284     }
7286   # The JAVA variable is used as the name of the Java interpreter.
7287   # The PYTHON variable is used as the name of the Python interpreter.
7288   if (@used && $primary ne 'JAVA' && $primary ne 'PYTHON')
7289     {
7290       # Define it.
7291       define_pretty_variable ($primary, TRUE, INTERNAL, @used);
7292       $output_vars .= "\n";
7293     }
7295   err_var ($require_extra,
7296            "'$require_extra' contains configure substitution,\n"
7297            . "but 'EXTRA_$primary' not defined")
7298     if ($require_extra && ! var ('EXTRA_' . $primary));
7300   # Push here because PRIMARY might be configure time determined.
7301   push (@all, '$(' . $primary . ')')
7302     if @used && $primary ne 'JAVA' && $primary ne 'PYTHON';
7304   # Make the result unique.  This lets the user use conditionals in
7305   # a natural way, but still lets us program lazily -- we don't have
7306   # to worry about handling a particular object more than once.
7307   # We will keep only one location per object.
7308   my %result = ();
7309   for my $pair (@result)
7310     {
7311       my ($loc, $val) = @$pair;
7312       $result{$val} = $loc;
7313     }
7314   my @l = sort keys %result;
7315   return map { [$result{$_}->clone, $_] } @l;
7319 ################################################################
7321 # Each key in this hash is the name of a directory holding a
7322 # Makefile.in.  These variables are local to 'is_make_dir'.
7323 my %make_dirs = ();
7324 my $make_dirs_set = 0;
7326 sub is_make_dir
7328     my ($dir) = @_;
7329     if (! $make_dirs_set)
7330     {
7331         foreach my $iter (@configure_input_files)
7332         {
7333             $make_dirs{dirname ($iter)} = 1;
7334         }
7335         # We also want to notice Makefile.in's.
7336         foreach my $iter (@other_input_files)
7337         {
7338             if ($iter =~ /Makefile\.in$/)
7339             {
7340                 $make_dirs{dirname ($iter)} = 1;
7341             }
7342         }
7343         $make_dirs_set = 1;
7344     }
7345     return defined $make_dirs{$dir};
7348 ################################################################
7350 # Find the aux dir.  This should match the algorithm used by
7351 # ./configure. (See the Autoconf documentation for for
7352 # AC_CONFIG_AUX_DIR.)
7353 sub locate_aux_dir ()
7355   if (! $config_aux_dir_set_in_configure_ac)
7356     {
7357       # The default auxiliary directory is the first
7358       # of ., .., or ../.. that contains install-sh.
7359       # Assume . if install-sh doesn't exist yet.
7360       for my $dir (qw (. .. ../..))
7361         {
7362           if (-f "$dir/install-sh")
7363             {
7364               $config_aux_dir = $dir;
7365               last;
7366             }
7367         }
7368       $config_aux_dir = '.' unless $config_aux_dir;
7369     }
7370   # Avoid unsightly '/.'s.
7371   $am_config_aux_dir =
7372     '$(top_srcdir)' . ($config_aux_dir eq '.' ? "" : "/$config_aux_dir");
7373   $am_config_aux_dir =~ s,/*$,,;
7377 # &push_required_file ($DIR, $FILE, $FULLFILE)
7378 # --------------------------------------------------
7379 # Push the given file onto DIST_COMMON.
7380 sub push_required_file
7382   my ($dir, $file, $fullfile) = @_;
7384   # If the file to be distributed is in the same directory of the
7385   # currently processed Makefile.am, then we want to distribute it
7386   # from this same Makefile.am.
7387   if ($dir eq $relative_dir)
7388     {
7389       push_dist_common ($file);
7390     }
7391   # This is needed to allow a construct in a non-top-level Makefile.am
7392   # to require a file in the build-aux directory (see at least the test
7393   # script 'test-driver-is-distributed.test').  This is related to the
7394   # automake bug#9546.  Note that the use of $config_aux_dir instead
7395   # of $am_config_aux_dir here is deliberate and necessary.
7396   elsif ($dir eq $config_aux_dir)
7397     {
7398       push_dist_common ("$am_config_aux_dir/$file");
7399     }
7400   # FIXME: another spacial case, for AC_LIBOBJ/AC_LIBSOURCE support.
7401   # We probably need some refactoring of this function and its callers,
7402   # to have a more explicit and systematic handling of all the special
7403   # cases; but, since there are only two of them, this is low-priority
7404   # ATM.
7405   elsif ($config_libobj_dir && $dir eq $config_libobj_dir)
7406     {
7407       # Avoid unsightly '/.'s.
7408       my $am_config_libobj_dir =
7409         '$(top_srcdir)' .
7410         ($config_libobj_dir eq '.' ? "" : "/$config_libobj_dir");
7411       $am_config_libobj_dir =~ s|/*$||;
7412       push_dist_common ("$am_config_libobj_dir/$file");
7413     }
7414   elsif ($relative_dir eq '.' && ! &is_make_dir ($dir))
7415     {
7416       # If we are doing the topmost directory, and the file is in a
7417       # subdir which does not have a Makefile, then we distribute it
7418       # here.
7420       # If a required file is above the source tree, it is important
7421       # to prefix it with '$(srcdir)' so that no VPATH search is
7422       # performed.  Otherwise problems occur with Make implementations
7423       # that rewrite and simplify rules whose dependencies are found in a
7424       # VPATH location.  Here is an example with OSF1/Tru64 Make.
7425       #
7426       #   % cat Makefile
7427       #   VPATH = sub
7428       #   distdir: ../a
7429       #           echo ../a
7430       #   % ls
7431       #   Makefile a
7432       #   % make
7433       #   echo a
7434       #   a
7435       #
7436       # Dependency '../a' was found in 'sub/../a', but this make
7437       # implementation simplified it as 'a'.  (Note that the sub/
7438       # directory does not even exist.)
7439       #
7440       # This kind of VPATH rewriting seems hard to cancel.  The
7441       # distdir.am hack against VPATH rewriting works only when no
7442       # simplification is done, i.e., for dependencies which are in
7443       # subdirectories, not in enclosing directories.  Hence, in
7444       # the latter case we use a full path to make sure no VPATH
7445       # search occurs.
7446       $fullfile = '$(srcdir)/' . $fullfile
7447         if $dir =~ m,^\.\.(?:$|/),;
7449       push_dist_common ($fullfile);
7450     }
7451   else
7452     {
7453       prog_error "a Makefile in relative directory $relative_dir " .
7454                  "can't add files in directory $dir to DIST_COMMON";
7455     }
7459 # If a file name appears as a key in this hash, then it has already
7460 # been checked for.  This allows us not to report the same error more
7461 # than once.
7462 my %required_file_not_found = ();
7464 # &required_file_check_or_copy ($WHERE, $DIRECTORY, $FILE)
7465 # --------------------------------------------------------
7466 # Verify that the file must exist in $DIRECTORY, or install it.
7467 sub required_file_check_or_copy ($$$)
7469   my ($where, $dir, $file) = @_;
7471   my $fullfile = "$dir/$file";
7472   my $found_it = 0;
7473   my $dangling_sym = 0;
7475   if (-l $fullfile && ! -f $fullfile)
7476     {
7477       $dangling_sym = 1;
7478     }
7479   elsif (dir_has_case_matching_file ($dir, $file))
7480     {
7481       $found_it = 1;
7482     }
7484   # '--force-missing' only has an effect if '--add-missing' is
7485   # specified.
7486   return
7487     if $found_it && (! $add_missing || ! $force_missing);
7489   # If we've already looked for it, we're done.  You might
7490   # wonder why we don't do this before searching for the
7491   # file.  If we do that, then something like
7492   # AC_OUTPUT(subdir/foo foo) will fail to put foo.in into
7493   # DIST_COMMON.
7494   if (! $found_it)
7495     {
7496       return if defined $required_file_not_found{$fullfile};
7497       $required_file_not_found{$fullfile} = 1;
7498     }
7499   if ($dangling_sym && $add_missing)
7500     {
7501       unlink ($fullfile);
7502     }
7504   my $trailer = '';
7505   my $trailer2 = '';
7506   my $suppress = 0;
7508   # Only install missing files according to our desired
7509   # strictness level.
7510   my $message = "required file '$fullfile' not found";
7511   if ($add_missing)
7512     {
7513       if (-f "$libdir/$file")
7514         {
7515           $suppress = 1;
7517           # Install the missing file.  Symlink if we
7518           # can, copy if we must.  Note: delete the file
7519           # first, in case it is a dangling symlink.
7520           $message = "installing '$fullfile'";
7522           # The license file should not be volatile.
7523           if ($file eq "COPYING")
7524             {
7525               $message .= " using GNU General Public License v3 file";
7526               $trailer2 = "\n    Consider adding the COPYING file"
7527                         . " to the version control system"
7528                         . "\n    for your code, to avoid questions"
7529                         . " about which license your project uses";
7530             }
7532           # Windows Perl will hang if we try to delete a
7533           # file that doesn't exist.
7534           unlink ($fullfile) if -f $fullfile;
7535           if ($symlink_exists && ! $copy_missing)
7536             {
7537               if (! symlink ("$libdir/$file", $fullfile)
7538                   || ! -e $fullfile)
7539                 {
7540                   $suppress = 0;
7541                   $trailer = "; error while making link: $!";
7542                 }
7543             }
7544           elsif (system ('cp', "$libdir/$file", $fullfile))
7545             {
7546               $suppress = 0;
7547               $trailer = "\n    error while copying";
7548             }
7549           set_dir_cache_file ($dir, $file);
7550         }
7551     }
7552   else
7553     {
7554       $trailer = "\n  'automake --add-missing' can install '$file'"
7555         if -f "$libdir/$file";
7556     }
7558   # If --force-missing was specified, and we have
7559   # actually found the file, then do nothing.
7560   return
7561     if $found_it && $force_missing;
7563   # If we couldn't install the file, but it is a target in
7564   # the Makefile, don't print anything.  This allows files
7565   # like README, AUTHORS, or THANKS to be generated.
7566   return
7567     if !$suppress && rule $file;
7569   msg ($suppress ? 'note' : 'error', $where, "$message$trailer$trailer2");
7573 # &require_file_internal ($WHERE, $MYSTRICT, $DIRECTORY, $QUEUE, @FILES)
7574 # ----------------------------------------------------------------------
7575 # Verify that the file must exist in $DIRECTORY, or install it.
7576 # $MYSTRICT is the strictness level at which this file becomes required.
7577 # Worker threads may queue up the action to be serialized by the master,
7578 # if $QUEUE is true
7579 sub require_file_internal ($$$@)
7581   my ($where, $mystrict, $dir, $queue, @files) = @_;
7583   return
7584     unless $strictness >= $mystrict;
7586   foreach my $file (@files)
7587     {
7588       push_required_file ($dir, $file, "$dir/$file");
7589       if ($queue)
7590         {
7591           queue_required_file_check_or_copy ($required_conf_file_queue,
7592                                              QUEUE_CONF_FILE, $relative_dir,
7593                                              $where, $mystrict, @files);
7594         }
7595       else
7596         {
7597           required_file_check_or_copy ($where, $dir, $file);
7598         }
7599     }
7602 # &require_file ($WHERE, $MYSTRICT, @FILES)
7603 # -----------------------------------------
7604 sub require_file ($$@)
7606     my ($where, $mystrict, @files) = @_;
7607     require_file_internal ($where, $mystrict, $relative_dir, 0, @files);
7610 # &require_file_with_macro ($COND, $MACRO, $MYSTRICT, @FILES)
7611 # -----------------------------------------------------------
7612 sub require_file_with_macro ($$$@)
7614     my ($cond, $macro, $mystrict, @files) = @_;
7615     $macro = rvar ($macro) unless ref $macro;
7616     require_file ($macro->rdef ($cond)->location, $mystrict, @files);
7619 # &require_libsource_with_macro ($COND, $MACRO, $MYSTRICT, @FILES)
7620 # ----------------------------------------------------------------
7621 # Require an AC_LIBSOURCEd file.  If AC_CONFIG_LIBOBJ_DIR was called, it
7622 # must be in that directory.  Otherwise expect it in the current directory.
7623 sub require_libsource_with_macro ($$$@)
7625     my ($cond, $macro, $mystrict, @files) = @_;
7626     $macro = rvar ($macro) unless ref $macro;
7627     if ($config_libobj_dir)
7628       {
7629         require_file_internal ($macro->rdef ($cond)->location, $mystrict,
7630                                $config_libobj_dir, 0, @files);
7631       }
7632     else
7633       {
7634         require_file ($macro->rdef ($cond)->location, $mystrict, @files);
7635       }
7638 # &queue_required_file_check_or_copy ($QUEUE, $KEY, $DIR, $WHERE,
7639 #                                     $MYSTRICT, @FILES)
7640 # ---------------------------------------------------------------
7641 sub queue_required_file_check_or_copy ($$$$@)
7643     my ($queue, $key, $dir, $where, $mystrict, @files) = @_;
7644     my @serial_loc;
7645     if (ref $where)
7646       {
7647         @serial_loc = (QUEUE_LOCATION, $where->serialize ());
7648       }
7649     else
7650       {
7651         @serial_loc = (QUEUE_STRING, $where);
7652       }
7653     $queue->enqueue ($key, $dir, @serial_loc, $mystrict, 0 + @files, @files);
7656 # &require_queued_file_check_or_copy ($QUEUE)
7657 # -------------------------------------------
7658 sub require_queued_file_check_or_copy ($)
7660     my ($queue) = @_;
7661     my $where;
7662     my $dir = $queue->dequeue ();
7663     my $loc_key = $queue->dequeue ();
7664     if ($loc_key eq QUEUE_LOCATION)
7665       {
7666         $where = Automake::Location::deserialize ($queue);
7667       }
7668     elsif ($loc_key eq QUEUE_STRING)
7669       {
7670         $where = $queue->dequeue ();
7671       }
7672     else
7673       {
7674         prog_error "unexpected key $loc_key";
7675       }
7676     my $mystrict = $queue->dequeue ();
7677     my $nfiles = $queue->dequeue ();
7678     my @files;
7679     push @files, $queue->dequeue ()
7680       foreach (1 .. $nfiles);
7681     return
7682       unless $strictness >= $mystrict;
7683     foreach my $file (@files)
7684       {
7685         required_file_check_or_copy ($where, $config_aux_dir, $file);
7686       }
7689 # &require_conf_file ($WHERE, $MYSTRICT, @FILES)
7690 # ----------------------------------------------
7691 # Looks in configuration path, as specified by AC_CONFIG_AUX_DIR.
7692 sub require_conf_file ($$@)
7694     my ($where, $mystrict, @files) = @_;
7695     my $queue = defined $required_conf_file_queue ? 1 : 0;
7696     require_file_internal ($where, $mystrict, $config_aux_dir,
7697                            $queue, @files);
7701 # &require_conf_file_with_macro ($COND, $MACRO, $MYSTRICT, @FILES)
7702 # ----------------------------------------------------------------
7703 sub require_conf_file_with_macro ($$$@)
7705     my ($cond, $macro, $mystrict, @files) = @_;
7706     require_conf_file (rvar ($macro)->rdef ($cond)->location,
7707                        $mystrict, @files);
7710 ################################################################
7712 # &require_build_directory ($DIRECTORY)
7713 # -------------------------------------
7714 # Emit rules to create $DIRECTORY if needed, and return
7715 # the file that any target requiring this directory should be made
7716 # dependent upon.
7717 # We don't want to emit the rule twice, and want to reuse it
7718 # for directories with equivalent names (e.g., 'foo/bar' and './foo//bar').
7719 sub require_build_directory ($)
7721   my $directory = shift;
7723   return $directory_map{$directory} if exists $directory_map{$directory};
7725   my $cdir = File::Spec->canonpath ($directory);
7727   if (exists $directory_map{$cdir})
7728     {
7729       my $stamp = $directory_map{$cdir};
7730       $directory_map{$directory} = $stamp;
7731       return $stamp;
7732     }
7734   my $dirstamp = "$cdir/\$(am__dirstamp)";
7736   $directory_map{$directory} = $dirstamp;
7737   $directory_map{$cdir} = $dirstamp;
7739   # Set a variable for the dirstamp basename.
7740   define_pretty_variable ('am__dirstamp', TRUE, INTERNAL,
7741                           '$(am__leading_dot)dirstamp');
7743   # Directory must be removed by 'make distclean'.
7744   $clean_files{$dirstamp} = DIST_CLEAN;
7746   $output_rules .= ("$dirstamp:\n"
7747                     . "\t\@\$(MKDIR_P) $directory\n"
7748                     . "\t\@: > $dirstamp\n");
7750   return $dirstamp;
7753 # &require_build_directory_maybe ($FILE)
7754 # --------------------------------------
7755 # If $FILE lies in a subdirectory, emit a rule to create this
7756 # directory and return the file that $FILE should be made
7757 # dependent upon.  Otherwise, just return the empty string.
7758 sub require_build_directory_maybe ($)
7760     my $file = shift;
7761     my $directory = dirname ($file);
7763     if ($directory ne '.')
7764     {
7765         return require_build_directory ($directory);
7766     }
7767     else
7768     {
7769         return '';
7770     }
7773 ################################################################
7775 # Push a list of files onto dist_common.
7776 sub push_dist_common
7778   prog_error "push_dist_common run after handle_dist"
7779     if $handle_dist_run;
7780   Automake::Variable::define ('DIST_COMMON', VAR_AUTOMAKE, '+', TRUE, "@_",
7781                               '', INTERNAL, VAR_PRETTY);
7785 ################################################################
7787 # generate_makefile ($MAKEFILE_AM, $MAKEFILE_IN)
7788 # ----------------------------------------------
7789 # Generate a Makefile.in given the name of the corresponding Makefile and
7790 # the name of the file output by config.status.
7791 sub generate_makefile ($$)
7793   my ($makefile_am, $makefile_in) = @_;
7795   # Reset all the Makefile.am related variables.
7796   initialize_per_input;
7798   # AUTOMAKE_OPTIONS can contains -W flags to disable or enable
7799   # warnings for this file.  So hold any warning issued before
7800   # we have processed AUTOMAKE_OPTIONS.
7801   buffer_messages ('warning');
7803   # $OUTPUT is encoded.  If it contains a ":" then the first element
7804   # is the real output file, and all remaining elements are input
7805   # files.  We don't scan or otherwise deal with these input files,
7806   # other than to mark them as dependencies.  See
7807   # &scan_autoconf_files for details.
7808   my ($makefile, @inputs) = split (/:/, $output_files{$makefile_in});
7810   $relative_dir = dirname ($makefile);
7812   read_main_am_file ($makefile_am, $makefile_in);
7813   if (handle_options)
7814     {
7815       # Process buffered warnings.
7816       flush_messages;
7817       # Fatal error.  Just return, so we can continue with next file.
7818       return;
7819     }
7820   # Process buffered warnings.
7821   flush_messages;
7823   # There are a few install-related variables that you should not define.
7824   foreach my $var ('PRE_INSTALL', 'POST_INSTALL', 'NORMAL_INSTALL')
7825     {
7826       my $v = var $var;
7827       if ($v)
7828         {
7829           my $def = $v->def (TRUE);
7830           prog_error "$var not defined in condition TRUE"
7831             unless $def;
7832           reject_var $var, "'$var' should not be defined"
7833             if $def->owner != VAR_AUTOMAKE;
7834         }
7835     }
7837   # Catch some obsolete variables.
7838   msg_var ('obsolete', 'INCLUDES',
7839            "'INCLUDES' is the old name for 'AM_CPPFLAGS' (or '*_CPPFLAGS')")
7840     if var ('INCLUDES');
7842   # Must do this after reading .am file.
7843   define_variable ('subdir', $relative_dir, INTERNAL);
7845   # If DIST_SUBDIRS is defined, make sure SUBDIRS is, so that
7846   # recursive rules are enabled.
7847   define_pretty_variable ('SUBDIRS', TRUE, INTERNAL, '')
7848     if var 'DIST_SUBDIRS' && ! var 'SUBDIRS';
7850   # Check first, because we might modify some state.
7851   check_gnu_standards;
7852   check_gnits_standards;
7854   handle_configure ($makefile_am, $makefile_in, $makefile, @inputs);
7855   handle_gettext;
7856   handle_libraries;
7857   handle_ltlibraries;
7858   handle_programs;
7859   handle_scripts;
7861   handle_silent;
7863   # These must be run after all the sources are scanned.  They
7864   # use variables defined by &handle_libraries, &handle_ltlibraries,
7865   # or &handle_programs.
7866   handle_compile;
7867   handle_languages;
7868   handle_libtool;
7870   # Variables used by distdir.am and tags.am.
7871   define_pretty_variable ('SOURCES', TRUE, INTERNAL, @sources);
7872   if (! option 'no-dist')
7873     {
7874       define_pretty_variable ('DIST_SOURCES', TRUE, INTERNAL, @dist_sources);
7875     }
7877   handle_texinfo;
7878   handle_emacs_lisp;
7879   handle_python;
7880   handle_java;
7881   handle_man_pages;
7882   handle_data;
7883   handle_headers;
7884   handle_subdirs;
7885   handle_user_recursion;
7886   handle_tags;
7887   handle_minor_options;
7888   # Must come after handle_programs so that %known_programs is up-to-date.
7889   handle_tests;
7891   # This must come after most other rules.
7892   handle_dist;
7894   handle_footer;
7895   do_check_merge_target;
7896   handle_all ($makefile);
7898   # FIXME: Gross!
7899   if (var ('lib_LTLIBRARIES') && var ('bin_PROGRAMS'))
7900     {
7901       $output_rules .= "install-binPROGRAMS: install-libLTLIBRARIES\n\n";
7902     }
7903   if (var ('nobase_lib_LTLIBRARIES') && var ('bin_PROGRAMS'))
7904     {
7905       $output_rules .= "install-binPROGRAMS: install-nobase_libLTLIBRARIES\n\n";
7906     }
7908   handle_install;
7909   handle_clean ($makefile);
7910   handle_factored_dependencies;
7912   # Comes last, because all the above procedures may have
7913   # defined or overridden variables.
7914   $output_vars .= output_variables;
7916   check_typos;
7918   if ($exit_code != 0)
7919     {
7920       verb "not writing $makefile_in because of earlier errors";
7921       return;
7922     }
7924   my $am_relative_dir = dirname ($makefile_am);
7925   mkdir ($am_relative_dir, 0755) if ! -d $am_relative_dir;
7927   # We make sure that 'all:' is the first target.
7928   my $output =
7929     "$output_vars$output_all$output_header$output_rules$output_trailer";
7931   # Decide whether we must update the output file or not.
7932   # We have to update in the following situations.
7933   #  * $force_generation is set.
7934   #  * any of the output dependencies is younger than the output
7935   #  * the contents of the output is different (this can happen
7936   #    if the project has been populated with a file listed in
7937   #    @common_files since the last run).
7938   # Output's dependencies are split in two sets:
7939   #  * dependencies which are also configure dependencies
7940   #    These do not change between each Makefile.am
7941   #  * other dependencies, specific to the Makefile.am being processed
7942   #    (such as the Makefile.am itself, or any Makefile fragment
7943   #    it includes).
7944   my $timestamp = mtime $makefile_in;
7945   if (! $force_generation
7946       && $configure_deps_greatest_timestamp < $timestamp
7947       && $output_deps_greatest_timestamp < $timestamp
7948       && $output eq contents ($makefile_in))
7949     {
7950       verb "$makefile_in unchanged";
7951       # No need to update.
7952       return;
7953     }
7955   if (-e $makefile_in)
7956     {
7957       unlink ($makefile_in)
7958         or fatal "cannot remove $makefile_in: $!";
7959     }
7961   my $gm_file = new Automake::XFile "> $makefile_in";
7962   verb "creating $makefile_in";
7963   print $gm_file $output;
7966 ################################################################
7971 ################################################################
7973 # Helper function for usage().
7974 sub print_autodist_files (@)
7976   my @lcomm = sort (&uniq (@_));
7978   my @four;
7979   format USAGE_FORMAT =
7980   @<<<<<<<<<<<<<<<<   @<<<<<<<<<<<<<<<<   @<<<<<<<<<<<<<<<<   @<<<<<<<<<<<<<<<<
7981   $four[0],           $four[1],           $four[2],           $four[3]
7983   local $~ = "USAGE_FORMAT";
7985   my $cols = 4;
7986   my $rows = int(@lcomm / $cols);
7987   my $rest = @lcomm % $cols;
7989   if ($rest)
7990     {
7991       $rows++;
7992     }
7993   else
7994     {
7995       $rest = $cols;
7996     }
7998   for (my $y = 0; $y < $rows; $y++)
7999     {
8000       @four = ("", "", "", "");
8001       for (my $x = 0; $x < $cols; $x++)
8002         {
8003           last if $y + 1 == $rows && $x == $rest;
8005           my $idx = (($x > $rest)
8006                ?  ($rows * $rest + ($rows - 1) * ($x - $rest))
8007                : ($rows * $x));
8009           $idx += $y;
8010           $four[$x] = $lcomm[$idx];
8011         }
8012       write;
8013     }
8017 # Print usage information.
8018 sub usage ()
8020     print "Usage: $0 [OPTION]... [Makefile]...
8022 Generate Makefile.in for configure from Makefile.am.
8024 Operation modes:
8025       --help               print this help, then exit
8026       --version            print version number, then exit
8027   -v, --verbose            verbosely list files processed
8028       --no-force           only update Makefile.in's that are out of date
8029   -W, --warnings=CATEGORY  report the warnings falling in CATEGORY
8031 Dependency tracking:
8032   -i, --ignore-deps      disable dependency tracking code
8033       --include-deps     enable dependency tracking code
8035 Flavors:
8036       --foreign          set strictness to foreign
8037       --gnits            set strictness to gnits
8038       --gnu              set strictness to gnu
8040 Library files:
8041   -a, --add-missing      add missing standard files to package
8042       --libdir=DIR       set directory storing library files
8043       --print-libdir     print directory storing library files
8044   -c, --copy             with -a, copy missing files (default is symlink)
8045   -f, --force-missing    force update of standard files
8048     Automake::ChannelDefs::usage;
8050     print "\nFiles automatically distributed if found " .
8051           "(always):\n";
8052     print_autodist_files @common_files;
8053     print "\nFiles automatically distributed if found " .
8054           "(under certain conditions):\n";
8055     print_autodist_files @common_sometimes;
8057     print '
8058 Report bugs to <@PACKAGE_BUGREPORT@>.
8059 GNU Automake home page: <@PACKAGE_URL@>.
8060 General help using GNU software: <http://www.gnu.org/gethelp/>.
8063     # --help always returns 0 per GNU standards.
8064     exit 0;
8068 # &version ()
8069 # -----------
8070 # Print version information
8071 sub version ()
8073   print <<EOF;
8074 automake (GNU $PACKAGE) $VERSION
8075 Copyright (C) $RELEASE_YEAR Free Software Foundation, Inc.
8076 License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl-2.0.html>
8077 This is free software: you are free to change and redistribute it.
8078 There is NO WARRANTY, to the extent permitted by law.
8080 Written by Tom Tromey <tromey\@redhat.com>
8081        and Alexandre Duret-Lutz <adl\@gnu.org>.
8083   # --version always returns 0 per GNU standards.
8084   exit 0;
8087 ################################################################
8089 # Parse command line.
8090 sub parse_arguments ()
8092   my $strict = 'gnu';
8093   my $ignore_deps = 0;
8094   my @warnings = ();
8096   my %cli_options =
8097     (
8098      'version' => \&version,
8099      'help'    => \&usage,
8100      'libdir=s' => \$libdir,
8101      'print-libdir'     => sub { print "$libdir\n"; exit 0; },
8102      'gnu'              => sub { $strict = 'gnu'; },
8103      'gnits'            => sub { $strict = 'gnits'; },
8104      'foreign'          => sub { $strict = 'foreign'; },
8105      'include-deps'     => sub { $ignore_deps = 0; },
8106      'i|ignore-deps'    => sub { $ignore_deps = 1; },
8107      'no-force' => sub { $force_generation = 0; },
8108      'f|force-missing'  => \$force_missing,
8109      'a|add-missing'    => \$add_missing,
8110      'c|copy'           => \$copy_missing,
8111      'v|verbose'        => sub { setup_channel 'verb', silent => 0; },
8112      'W|warnings=s'     => \@warnings,
8113      );
8115   use Automake::Getopt ();
8116   Automake::Getopt::parse_options %cli_options;
8118   set_strictness ($strict);
8119   my $cli_where = new Automake::Location;
8120   set_global_option ('no-dependencies', $cli_where) if $ignore_deps;
8121   for my $warning (@warnings)
8122     {
8123       &parse_warnings ('-W', $warning);
8124     }
8126   return unless @ARGV;
8128   my $errspec = 0;
8129   foreach my $arg (@ARGV)
8130     {
8131       fatal ("empty argument\nTry '$0 --help' for more information")
8132         if ($arg eq '');
8134       # Handle $local:$input syntax.
8135       my ($local, @rest) = split (/:/, $arg);
8136       @rest = ("$local.in",) unless @rest;
8137       my $input = locate_am @rest;
8138       if ($input)
8139         {
8140           push @input_files, $input;
8141           $output_files{$input} = join (':', ($local, @rest));
8142         }
8143       else
8144         {
8145           error "no Automake input file found for '$arg'";
8146           $errspec = 1;
8147         }
8148     }
8149   fatal "no input file found among supplied arguments"
8150     if $errspec && ! @input_files;
8154 # handle_makefile ($MAKEFILE_IN)
8155 # ------------------------------
8156 # Deal with $MAKEFILE_IN.
8157 sub handle_makefile ($)
8159   my ($file) =  @_;
8160   ($am_file = $file) =~ s/\.in$//;
8161   if (! -f ($am_file . '.am'))
8162     {
8163       error "'$am_file.am' does not exist";
8164     }
8165   else
8166     {
8167       # Any warning setting now local to this Makefile.am.
8168       dup_channel_setup;
8170       generate_makefile ($am_file . '.am', $file);
8172       # Back out any warning setting.
8173       drop_channel_setup;
8174     }
8177 # handle_makefiles_serial ()
8178 # --------------------------
8179 # Deal with all makefiles, without threads.
8180 sub handle_makefiles_serial ()
8182   foreach my $file (@input_files)
8183     {
8184       handle_makefile ($file);
8185     }
8188 # get_number_of_threads ()
8189 # ------------------------
8190 # Logic for deciding how many worker threads to use.
8191 sub get_number_of_threads
8193   my $nthreads = $ENV{'AUTOMAKE_JOBS'} || 0;
8195   $nthreads = 0
8196     unless $nthreads =~ /^[0-9]+$/;
8198   # It doesn't make sense to use more threads than makefiles,
8199   my $max_threads = @input_files;
8201   if ($nthreads > $max_threads)
8202     {
8203       $nthreads = $max_threads;
8204     }
8205   return $nthreads;
8208 # handle_makefiles_threaded ($NTHREADS)
8209 # -------------------------------------
8210 # Deal with all makefiles, using threads.  The general strategy is to
8211 # spawn NTHREADS worker threads, dispatch makefiles to them, and let the
8212 # worker threads push back everything that needs serialization:
8213 # * warning and (normal) error messages, for stable stderr output
8214 #   order and content (avoiding duplicates, for example),
8215 # * races when installing aux files (and respective messages),
8216 # * races when collecting aux files for distribution.
8218 # The latter requires that the makefile that deals with the aux dir
8219 # files be handled last, done by the master thread.
8220 sub handle_makefiles_threaded ($)
8222   my ($nthreads) = @_;
8224   # The file queue distributes all makefiles, the message queues
8225   # collect all serializations needed for respective files.
8226   my $file_queue = Thread::Queue->new;
8227   my %msg_queues;
8228   foreach my $file (@input_files)
8229     {
8230       $msg_queues{$file} = Thread::Queue->new;
8231     }
8233   verb "spawning $nthreads worker threads";
8234   my @threads = (1 .. $nthreads);
8235   foreach my $t (@threads)
8236     {
8237       $t = threads->new (sub
8238         {
8239           while (my $file = $file_queue->dequeue)
8240             {
8241               verb "handling $file";
8242               my $queue = $msg_queues{$file};
8243               setup_channel_queue ($queue, QUEUE_MESSAGE);
8244               $required_conf_file_queue = $queue;
8245               handle_makefile ($file);
8246               $queue->enqueue (undef);
8247               setup_channel_queue (undef, undef);
8248               $required_conf_file_queue = undef;
8249             }
8250           return $exit_code;
8251         });
8252     }
8254   # Queue all makefiles.
8255   verb "queuing " . @input_files . " input files";
8256   $file_queue->enqueue (@input_files, (undef) x @threads);
8258   # Collect and process serializations.
8259   foreach my $file (@input_files)
8260     {
8261       verb "dequeuing messages for " . $file;
8262       reset_local_duplicates ();
8263       my $queue = $msg_queues{$file};
8264       while (my $key = $queue->dequeue)
8265         {
8266           if ($key eq QUEUE_MESSAGE)
8267             {
8268               pop_channel_queue ($queue);
8269             }
8270           elsif ($key eq QUEUE_CONF_FILE)
8271             {
8272               require_queued_file_check_or_copy ($queue);
8273             }
8274           else
8275             {
8276               prog_error "unexpected key $key";
8277             }
8278         }
8279     }
8281   foreach my $t (@threads)
8282     {
8283       my @exit_thread = $t->join;
8284       $exit_code = $exit_thread[0]
8285         if ($exit_thread[0] > $exit_code);
8286     }
8289 ################################################################
8291 # Parse the WARNINGS environment variable.
8292 parse_WARNINGS;
8294 # Parse command line.
8295 parse_arguments;
8297 $configure_ac = require_configure_ac;
8299 # Do configure.ac scan only once.
8300 scan_autoconf_files;
8302 if (! @input_files)
8303   {
8304     my $msg = '';
8305     $msg = "\nDid you forget AC_CONFIG_FILES([Makefile]) in $configure_ac?"
8306       if -f 'Makefile.am';
8307     fatal ("no 'Makefile.am' found for any configure output$msg");
8308   }
8310 my $nthreads = get_number_of_threads ();
8312 if ($perl_threads && $nthreads >= 1)
8313   {
8314     handle_makefiles_threaded ($nthreads);
8315   }
8316 else
8317   {
8318     handle_makefiles_serial ();
8319   }
8321 exit $exit_code;
8324 ### Setup "GNU" style for perl-mode and cperl-mode.
8325 ## Local Variables:
8326 ## perl-indent-level: 2
8327 ## perl-continued-statement-offset: 2
8328 ## perl-continued-brace-offset: 0
8329 ## perl-brace-offset: 0
8330 ## perl-brace-imaginary-offset: 0
8331 ## perl-label-offset: -2
8332 ## cperl-indent-level: 2
8333 ## cperl-brace-offset: 0
8334 ## cperl-continued-brace-offset: 0
8335 ## cperl-label-offset: -2
8336 ## cperl-extra-newline-before-brace: t
8337 ## cperl-merge-trailing-else: nil
8338 ## cperl-continued-statement-offset: 2
8339 ## End: