lib/Automake/File.pm: Modifie file_contents_internal

This function now takes a list of paragraph as argument instead of building it
in its code.  This is the first step in the modification of this function to
be able to test it with files that don't "physically" exist in the actual file
system.

* lib/Automake/File.pm: Start the modification of file_contents_internal for
  unit testing

3 files changed, 237 insertions, 223 deletions

diff --git a/bin/automake.in b/bin/automake.in
index 761491fbf..6c79d1422 100755
--- a/bin/automake.in
+++ b/bin/automake.in
@@ -1738,54 +1738,59 @@ sub check_canonical_spelling
 # Set up the compile suite.
 sub handle_compile ()
 {
-   return if ! $must_handle_compiled_objects;
+  return if ! $must_handle_compiled_objects;
 
-    # Boilerplate.
-    my $default_includes = '';
-    if (! option 'nostdinc')
-      {
-	my @incs = ('-I.', subst ('am__isrc'));
+  # Boilerplate.
+  my $default_includes = '';
+  if (! option 'nostdinc')
+    {
+      my @incs = ('-I.', subst ('am__isrc'));
 
-	my $var = var 'CONFIG_HEADER';
-	if ($var)
-	  {
-	    foreach my $hdr (split (' ', $var->variable_value))
-	      {
-		push @incs, '-I' . dirname ($hdr);
-	      }
-	  }
-	# We want '-I. -I$(srcdir)', but the latter -I is redundant
-	# and unaesthetic in non-VPATH builds.  We use `-I.@am__isrc@`
-	# instead.  It will be replaced by '-I.' or '-I. -I$(srcdir)'.
-	# Items in CONFIG_HEADER are never in $(srcdir) so it is safe
-	# to just put @am__isrc@ right after '-I.', without a space.
-	($default_includes = ' ' . uniq (@incs)) =~ s/ @/@/;
-      }
+      my $var = var 'CONFIG_HEADER';
+      if ($var)
+        {
+          foreach my $hdr (split (' ', $var->variable_value))
+            {
+              push @incs, '-I' . dirname ($hdr);
+            }
+        }
+      # We want '-I. -I$(srcdir)', but the latter -I is redundant
+      # and unaesthetic in non-VPATH builds.  We use `-I.@am__isrc@`
+      # instead.  It will be replaced by '-I.' or '-I. -I$(srcdir)'.
+      # Items in CONFIG_HEADER are never in $(srcdir) so it is safe
+      # to just put @am__isrc@ right after '-I.', without a space.
+      ($default_includes = ' ' . uniq (@incs)) =~ s/ @/@/;
+    }
 
-    my (@mostly_rms, @dist_rms);
-    foreach my $item (sort keys %compile_clean_files)
+  my (@mostly_rms, @dist_rms);
+  foreach my $item (sort keys %compile_clean_files)
     {
-	if ($compile_clean_files{$item} == MOSTLY_CLEAN)
-	{
-	    push (@mostly_rms, "\t-rm -f $item");
-	}
-	elsif ($compile_clean_files{$item} == DIST_CLEAN)
-	{
-	    push (@dist_rms, "\t-rm -f $item");
-	}
-	else
-	{
-	  prog_error 'invalid entry in %compile_clean_files';
-	}
+      if ($compile_clean_files{$item} == MOSTLY_CLEAN)
+        {
+          push (@mostly_rms, "\t-rm -f $item");
+        }
+      elsif ($compile_clean_files{$item} == DIST_CLEAN)
+        {
+          push (@dist_rms, "\t-rm -f $item");
+        }
+      else
+        {
+          prog_error 'invalid entry in %compile_clean_files';
+        }
     }
 
-    my ($coms, $vars, $rules) =
-      file_contents_internal (1, "$libdir/am/compile.am",
-			      new Automake::Location,
-			      'DEFAULT_INCLUDES' => $default_includes,
-			      'MOSTLYRMS' => join ("\n", @mostly_rms),
-			      'DISTRMS' => join ("\n", @dist_rms));
-    $output_vars .= $vars;
+  my $filename = "$libdir/am/compile.am";
+  my %transform =
+    (
+     'DEFAULT_INCLUDES' => $default_includes,
+     'MOSTLYRMS' => join ("\n", @mostly_rms),
+     'DISTRMS' => join ("\n", @dist_rms)
+    );
+
+  my @paragraphs = make_paragraphs ($filename, %transform);
+  my ($coms, $vars, $rules) =
+      file_contents_internal (1, $filename, new Automake::Location,
+                              \@paragraphs, %transform);
     $output_rules .= "$coms$rules";
 }
 
diff --git a/lib/Automake/ConfVars.pm b/lib/Automake/ConfVars.pm
index 4a27184dd..73b0e1deb 100644
--- a/lib/Automake/ConfVars.pm
+++ b/lib/Automake/ConfVars.pm
@@ -65,10 +65,13 @@ sub _define_configure_variable ($)
 sub define_standard_variables ()
 {
   my $saved_output_vars = $output_vars;
-  my ($comments, undef, $rules) =
-    file_contents_internal (1, "$libdir/am/header-vars.am",
-			    new Automake::Location);
+  my $filename = "$libdir/am/header-vars.am";
+
+  my @paragraphs = make_paragraphs ($filename);
 
+  my ($comments, undef, $rules) =
+      file_contents_internal (1, $filename, new Automake::Location,
+                              \@paragraphs);
   foreach my $var (sort keys %configure_vars)
     {
       _define_configure_variable ($var);
diff --git a/lib/Automake/File.pm b/lib/Automake/File.pm
index a9ba70b21..b82e65fed 100644
--- a/lib/Automake/File.pm
+++ b/lib/Automake/File.pm
@@ -37,195 +37,199 @@ use vars qw (@EXPORT);
 @EXPORT = qw (file_contents_internal file_contents);
 
 # ($COMMENT, $VARIABLES, $RULES)
-# file_contents_internal ($IS_AM, $FILE, $WHERE, [%TRANSFORM])
+# file_contents_internal ($IS_AM, $FILENAME, $WHERE, \@PARAGRAPHS, [%TRANSFORM])
 # ------------------------------------------------------------
 # Return contents of a file from $libdir/am, automatically skipping
 # macros or rules which are already known. $IS_AM iff the caller is
 # reading an Automake file (as opposed to the user's Makefile.am).
 sub file_contents_internal
 {
-    my ($is_am, $file, $where, %transform) = @_;
+  my ($is_am, $filename, $where, $parsref, %transform) = @_;
 
-    $where->set ($file);
+  my @paragraphs = @{$parsref};
 
-    my $result_vars = '';
-    my $result_rules = '';
-    my $comment = '';
-    my $spacing = '';
+  my $result_vars = '';
+  my $result_rules = '';
+  my $comment = '';
+  my $spacing = '';
 
-    # The following flags are used to track rules spanning across
-    # multiple paragraphs.
-    my $is_rule = 0;		# 1 if we are processing a rule.
-    my $discard_rule = 0;	# 1 if the current rule should not be output.
+  # The following flags are used to track rules spanning across
+  # multiple paragraphs.
+  my $is_rule = 0;		# 1 if we are processing a rule.
+  my $discard_rule = 0;	# 1 if the current rule should not be output.
 
-    # We save the conditional stack on entry, and then check to make
-    # sure it is the same on exit.  This lets us conditionally include
-    # other files.
-    my @saved_cond_stack = @cond_stack;
-    my $cond = new Automake::Condition (@cond_stack);
+  # We save the conditional stack on entry, and then check to make
+  # sure it is the same on exit.  This lets us conditionally include
+  # other files.
+  my @saved_cond_stack = @cond_stack;
+  my $cond = new Automake::Condition (@cond_stack);
 
-    foreach (make_paragraphs ($file, %transform))
+  for my $i (0 .. $#paragraphs)
     {
-	# FIXME: no line number available.
-	$where->set ($file);
-
-	# Sanity checks.
-	error $where, "blank line following trailing backslash:\n$_"
-	  if /\\$/;
-	error $where, "comment following trailing backslash:\n$_"
-	  if /\\#/;
-
-	if (/^$/)
-	{
-	    $is_rule = 0;
-	    # Stick empty line before the incoming macro or rule.
-	    $spacing = "\n";
-	}
-	elsif (/$COMMENT_PATTERN/mso)
-	{
-	    $is_rule = 0;
-	    # Stick comments before the incoming macro or rule.
-	    $comment = "$_\n";
-	}
-
-	# Handle inclusion of other files.
-	elsif (/$INCLUDE_PATTERN/o)
-	{
-	    if ($cond != FALSE)
-	      {
-		my $file = ($is_am ? "$libdir/am/" : '') . $1;
-		$where->push_context ("'$file' included from here");
-		# N-ary '.=' fails.
-		my ($com, $vars, $rules)
-		  = file_contents_internal ($is_am, $file, $where, %transform);
-		$where->pop_context;
-		$comment .= $com;
-		$result_vars .= $vars;
-		$result_rules .= $rules;
-	      }
-	}
-
-	# Handling the conditionals.
-	elsif (/$IF_PATTERN/o)
-	  {
-	    $cond = cond_stack_if ($1, $2, $file);
-	  }
-	elsif (/$ELSE_PATTERN/o)
-	  {
-	    $cond = cond_stack_else ($1, $2, $file);
-	  }
-	elsif (/$ENDIF_PATTERN/o)
-	  {
-	    $cond = cond_stack_endif ($1, $2, $file);
-	  }
-
-	# Handling rules.
-	elsif (/$RULE_PATTERN/mso)
-	{
-	  $is_rule = 1;
-	  $discard_rule = 0;
-	  # Separate relationship from optional actions: the first
-	  # `new-line tab" not preceded by backslash (continuation
-	  # line).
-	  my $paragraph = $_;
-	  /^(.*?)(?:(?<!\\)\n(\t.*))?$/s;
-	  my ($relationship, $actions) = ($1, $2 || '');
-
-	  # Separate targets from dependencies: the first colon.
-	  $relationship =~ /^([^:]+\S+) *: *(.*)$/som;
-	  my ($targets, $dependencies) = ($1, $2);
-	  # Remove the escaped new lines.
-	  # I don't know why, but I have to use a tmp $flat_deps.
-	  my $flat_deps = flatten ($dependencies);
-	  my @deps = split (' ', $flat_deps);
-
-	  foreach (split (' ', $targets))
-	    {
-	      # FIXME: 1. We are not robust to people defining several targets
-	      # at once, only some of them being in %dependencies.  The
-	      # actions from the targets in %dependencies are usually generated
-	      # from the content of %actions, but if some targets in $targets
-	      # are not in %dependencies the ELSE branch will output
-	      # a rule for all $targets (i.e. the targets which are both
-	      # in %dependencies and $targets will have two rules).
-
-	      # FIXME: 2. The logic here is not able to output a
-	      # multi-paragraph rule several time (e.g. for each condition
-	      # it is defined for) because it only knows the first paragraph.
-
-	      # FIXME: 3. We are not robust to people defining a subset
-	      # of a previously defined "multiple-target" rule.  E.g.
-	      # 'foo:' after 'foo bar:'.
-
-	      # Output only if not in FALSE.
-	      if (defined $dependencies{$_} && $cond != FALSE)
-		{
-		  depend ($_, @deps);
-		  register_action ($_, $actions);
-		}
-	      else
-		{
-		  # Free-lance dependency.  Output the rule for all the
-		  # targets instead of one by one.
-		  my @undefined_conds =
-		    Automake::Rule::define ($targets, $file,
-					    $is_am ? RULE_AUTOMAKE : RULE_USER,
-					    $cond, $where);
-		  for my $undefined_cond (@undefined_conds)
-		    {
-		      my $condparagraph = $paragraph;
-		      $condparagraph =~ s/^/$undefined_cond->subst_string/gme;
-		      $result_rules .= "$spacing$comment$condparagraph\n";
-		    }
-		  if (scalar @undefined_conds == 0)
-		    {
-		      # Remember to discard next paragraphs
-		      # if they belong to this rule.
-		      # (but see also FIXME: #2 above.)
-		      $discard_rule = 1;
-		    }
-		  $comment = $spacing = '';
-		  last;
-		}
-	    }
-	}
-
-	elsif (/$ASSIGNMENT_PATTERN/mso)
-	{
-	    my ($var, $type, $val) = ($1, $2, $3);
-	    error $where, "variable '$var' with trailing backslash"
-	      if /\\$/;
-
-	    $is_rule = 0;
-
-	    Automake::Variable::define ($var,
-					$is_am ? VAR_AUTOMAKE : VAR_MAKEFILE,
-					$type, $cond, $val, $comment, $where,
-					VAR_ASIS)
-	      if $cond != FALSE;
-
-	    $comment = $spacing = '';
-	}
-	else
-	{
-	    # This isn't an error; it is probably some tokens which
-	    # configure is supposed to replace, such as '@SET-MAKE@',
-	    # or some part of a rule cut by an if/endif.
-	    if (! $cond->false && ! ($is_rule && $discard_rule))
-	      {
-		s/^/$cond->subst_string/gme;
-		$result_rules .= "$spacing$comment$_\n";
-	      }
-	    $comment = $spacing = '';
-	}
+      $_ = $paragraphs[$i];
+      # FIXME: Why is it needed to add the extension here when it was not
+      # before the changes in this commit. (see t/location)
+      $where->set ("$filename.am");
+
+      # Sanity checks.
+      error $where, "blank line following trailing backslash:\n$_"
+          if /\\$/;
+      error $where, "comment following trailing backslash:\n$_"
+          if /\\#/;
+
+      if (/^$/)
+        {
+          $is_rule = 0;
+          # Stick empty line before the incoming macro or rule.
+          $spacing = "\n";
+        }
+      elsif (/$COMMENT_PATTERN/mso)
+        {
+          $is_rule = 0;
+          # Stick comments before the incoming macro or rule.
+          $comment = "$_\n";
+        }
+
+      # Handle inclusion of other files.
+      elsif (/$INCLUDE_PATTERN/o)
+        {
+          if ($cond != FALSE)
+            {
+              my $filename = ($is_am ? "$libdir/am/" : '') . $1;
+              $where->push_context ("'$filename' included from here");
+              my @paragraphs = make_paragraphs ($filename, %transform);
+              # N-ary '.=' fails.
+              my ($com, $vars, $rules) =
+                  file_contents_internal ($is_am, $filename, $where,
+                                          \@paragraphs, %transform);
+              $where->pop_context;
+              $comment .= $com;
+              $result_vars .= $vars;
+              $result_rules .= $rules;
+            }
+        }
+
+      # Handling the conditionals.
+      elsif (/$IF_PATTERN/o)
+        {
+          $cond = cond_stack_if ($1, $2, $filename);
+        }
+      elsif (/$ELSE_PATTERN/o)
+        {
+          $cond = cond_stack_else ($1, $2, $filename);
+        }
+      elsif (/$ENDIF_PATTERN/o)
+        {
+          $cond = cond_stack_endif ($1, $2, $filename);
+        }
+
+      # Handling rules.
+      elsif (/$RULE_PATTERN/mso)
+        {
+          $is_rule = 1;
+          $discard_rule = 0;
+          # Separate relationship from optional actions: the first
+          # `new-line tab" not preceded by backslash (continuation
+          # line).
+          my $paragraph = $_;
+          /^(.*?)(?:(?<!\\)\n(\t.*))?$/s;
+          my ($relationship, $actions) = ($1, $2 || '');
+
+          # Separate targets from dependencies: the first colon.
+          $relationship =~ /^([^:]+\S+) *: *(.*)$/som;
+          my ($targets, $dependencies) = ($1, $2);
+          # Remove the escaped new lines.
+          # I don't know why, but I have to use a tmp $flat_deps.
+          my $flat_deps = flatten ($dependencies);
+          my @deps = split (' ', $flat_deps);
+
+          foreach (split (' ', $targets))
+            {
+              # FIXME: 1. We are not robust to people defining several targets
+              # at once, only some of them being in %dependencies.  The
+              # actions from the targets in %dependencies are usually generated
+              # from the content of %actions, but if some targets in $targets
+              # are not in %dependencies the ELSE branch will output
+              # a rule for all $targets (i.e. the targets which are both
+              # in %dependencies and $targets will have two rules).
+
+              # FIXME: 2. The logic here is not able to output a
+              # multi-paragraph rule several time (e.g. for each condition
+              # it is defined for) because it only knows the first paragraph.
+
+              # FIXME: 3. We are not robust to people defining a subset
+              # of a previously defined "multiple-target" rule.  E.g.
+              # 'foo:' after 'foo bar:'.
+
+              # Output only if not in FALSE.
+              if (defined $dependencies{$_} && $cond != FALSE)
+                {
+                  depend ($_, @deps);
+                  register_action ($_, $actions);
+                }
+              else
+                {
+                  # Free-lance dependency.  Output the rule for all the
+                  # targets instead of one by one.
+                  my @undefined_conds =
+                      Automake::Rule::define ($targets, $filename,
+                                            $is_am ? RULE_AUTOMAKE : RULE_USER,
+                                            $cond, $where);
+                  for my $undefined_cond (@undefined_conds)
+                    {
+                      my $condparagraph = $paragraph;
+                      $condparagraph =~ s/^/$undefined_cond->subst_string/gme;
+                      $result_rules .= "$spacing$comment$condparagraph\n";
+                    }
+                  if (scalar @undefined_conds == 0)
+                    {
+                      # Remember to discard next paragraphs
+                      # if they belong to this rule.
+                      # (but see also FIXME: #2 above.)
+                      $discard_rule = 1;
+                    }
+                  $comment = $spacing = '';
+                  last;
+                }
+            }
+        }
+
+      elsif (/$ASSIGNMENT_PATTERN/mso)
+        {
+          my ($var, $type, $val) = ($1, $2, $3);
+          error $where, "variable '$var' with trailing backslash"
+              if /\\$/;
+
+          $is_rule = 0;
+
+          Automake::Variable::define ($var,
+                                    $is_am ? VAR_AUTOMAKE : VAR_MAKEFILE,
+                                    $type, $cond, $val, $comment, $where,
+                                    VAR_ASIS)
+              if $cond != FALSE;
+
+          $comment = $spacing = '';
+        }
+      else
+        {
+          # This isn't an error; it is probably some tokens which
+          # configure is supposed to replace, such as '@SET-MAKE@',
+          # or some part of a rule cut by an if/endif.
+          if (! $cond->false && ! ($is_rule && $discard_rule))
+            {
+              s/^/$cond->subst_string/gme;
+              $result_rules .= "$spacing$comment$_\n";
+            }
+          $comment = $spacing = '';
+        }
     }
 
-    error ($where, @cond_stack ?
-	   "unterminated conditionals: @cond_stack" :
-	   "too many conditionals closed in include file")
+  error ($where, @cond_stack ?
+         "unterminated conditionals: @cond_stack" :
+         "too many conditionals closed in include file")
       if "@saved_cond_stack" ne "@cond_stack";
 
-    return ($comment, $result_vars, $result_rules);
+  return ($comment, $result_vars, $result_rules);
 }
 
 
@@ -236,11 +240,13 @@ sub file_contents_internal
 # macros or rules which are already known.
 sub file_contents
 {
-    my ($basename, $where, %transform) = @_;
-    my ($comments, $variables, $rules) =
-      file_contents_internal (1, "$libdir/am/$basename.am", $where,
-			      %transform);
-    return "$comments$variables$rules";
+  my ($basename, $where, %transform) = @_;
+  my @paragraphs = make_paragraphs ("$libdir/am/$basename.am", %transform);
+  my ($comments, $variables, $rules) =
+      file_contents_internal (1, $basename, $where,
+                              \@paragraphs, %transform);
+
+  return "$comments$variables$rules";
 }
 
 1;