From 0baeb5209d3a111a53070c032d7cdb1e609e3516 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Mon, 31 May 2021 16:32:40 +0200
Subject: Implement ad hoc regex pattern rule support

An ad hoc pattern rule consists of a pattern that mimics a dependency
declaration followed by one or more recipes. For example:

exe{~'/(.*)/'}: cxx{~'/\1/'}
{{
  $cxx.path -o $path($>) $path($<[0])
}}

If a pattern matches a dependency declaration of a target, then the recipe is
used to perform the corresponding operation on this target. For example, the
following dependency declaration matches the above pattern which means the
rule's recipe will be used to update this target:

exe{hello}: cxx{hello}

While the following declarations do not match the above pattern:

exe{hello}:   c{hello}  # Type mismatch.
exe{hello}: cxx{howdy}  # Name mismatch.

On the left hand side of `:` in the pattern we can have a single target or an
ad hoc target group. The single target or the first (primary) ad hoc group
member must be a regex pattern (~). The rest of the ad hoc group members can
be patterns or substitutions (^). For example:

<exe{~'/(.*)/'} file{^'/\1.map/'}>: cxx{~'/\1/'}
{{
  $cxx.path -o $path($>[0]) "-Wl,-Map=$path($>[1])" $path($<[0])
}}

On the left hand side of `:` in the pattern we have prerequisites which can
be patterns, substitutions, or non-patterns. For example:

<exe{~'/(.*)/'} file{^'/\1.map/'}>: cxx{~'/\1/'} hxx{^'/\1/'} hxx{common}
{{
  $cxx.path -o $path($>[0]) "-Wl,-Map=$path($>[1])" $path($<[0])
}}

Substitutions on the left hand side of `:` and substitutions and non-patterns
on the right hand side are added to the dependency declaration. For example,
given the above rule and dependency declaration, the effective dependency is
going to be:

<exe{hello} file{hello.map>: cxx{hello} hxx{hello} hxx{common}
---
 tests/recipe/buildscript/testscript | 20 +++++++++++++++++++
 tests/recipe/cxx/testscript         | 39 +++++++++++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+)

(limited to 'tests/recipe')

diff --git a/tests/recipe/buildscript/testscript b/tests/recipe/buildscript/testscript
index 3ccfdd5..12c5717 100644
--- a/tests/recipe/buildscript/testscript
+++ b/tests/recipe/buildscript/testscript
@@ -724,3 +724,23 @@ if $posix
     }
   }
 }
+
+# @@ TODO: test $1 when implemented.
+#
+: rule
+:
+{
+  cat <<EOI >=buildfile;
+    alias{far}: alias{bar}
+    alias{bar}:
+
+    alias{~'/f(.+)/'}: alias{~'/b\1/'}
+    {{
+      diag $< $>
+    }}
+    EOI
+
+  $* 2>>EOE
+    alias{bar} alias{far}
+    EOE
+}
diff --git a/tests/recipe/cxx/testscript b/tests/recipe/cxx/testscript
index 323e049..9a87c24 100644
--- a/tests/recipe/cxx/testscript
+++ b/tests/recipe/cxx/testscript
@@ -165,6 +165,45 @@ if (!$static && $test.target == $build.host)
     $* clean 2>-
   }
 
+  : rule
+  :
+  {
+    cat <<EOI >=buildfile;
+      alias{far}: alias{bar}
+      alias{bar}:
+
+      alias{~'/f(.+)/'}: alias{~'/b\1/'}
+      {{ c++ 1 --
+
+        #include <iostream>
+
+        --
+
+        recipe
+        apply (action, target&) const override
+        {
+          return [this] (action a, const target& t)
+          {
+            return perform_update (a, t);
+          };
+        }
+
+        target_state
+        perform_update (action, const target& t) const
+        {
+          const auto& mr (t.data<regex_match_results> ());
+          text << pattern->rule_name << ": " << mr.str (1);
+          return target_state::changed;
+        }
+      }}
+      EOI
+
+    $* 2>>~%EOE%
+      %^(c\+\+|ld).*%+
+      <ad hoc pattern rule #1>: ar
+      EOE
+  }
+
   # Clean recipe builds if the testscript is enabled (see above for details).
   #
   -$* clean 2>-
-- 
cgit v1.1