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