Separation of metafunction and runtime regex code. (#1219)

MaxSagebaum · hsutter · web-flow · commit d70601eb96a5 · 2024-08-11T14:03:47.000-07:00
* Separation of metafunction and runtime regex code.

* Move metafunction work into reflect.h2

Instead of a separate file in ./source

* Update of regression tests.

* Merge regex metafunction into cpp2::meta namespace

The run-time support library stays in `cpp2util.h` and can use the `cpp2::regex::` subnamespace there

The compile-time parts stay in `reflect.h2` and use the `cpp2::meta::` namespace there

Eventually this can be generalized for user-written metafunctions when those are supported, but for right now this keeps things consistent for the metafunctions supplied in-the-box with cppfront

* Add `add_runtime_support_include` to meta

For metafunctions that require runtime support via #includes to be injected into lowered Cpp1 programs

Also cleanup while I'm at it:
- remove headers from `common.h` that are now already included via `cpp2util.h`
- line up some thing that got un-lined-up (OCD)

---------

Co-authored-by: Herb Sutter &lt;herb.sutter@gmail.com&gt;
diff --git a/include/cpp2regex.h b/include/cpp2regex.h
diff --git a/include/cpp2regex.h2 b/include/cpp2regex.h2
diff --git a/include/cpp2util.h b/include/cpp2util.h
@@ -2824,8 +2824,6 @@ inline constexpr auto as_() -> decltype(auto)
 
 }
 
-#include "cpp2regex.h"
-
 using cpp2::cpp2_new;
 
 
diff --git a/regression-tests/test-results/apple-clang-14-c++2b/pure2-default-arguments.cpp.output b/regression-tests/test-results/apple-clang-14-c++2b/pure2-default-arguments.cpp.output
@@ -0,0 +1,4 @@
+pure2-default-arguments.cpp2:6:61: error: no member named 'source_location' in namespace 'std'
+    char const* fn = CPP2_UFCS_NONLOCAL(function_name)(std::source_location::current())
+                                                       ~~~~~^
+1 error generated.
diff --git a/regression-tests/test-results/apple-clang-15-c++2b/pure2-default-arguments.cpp.execution b/regression-tests/test-results/apple-clang-15-c++2b/pure2-default-arguments.cpp.execution
@@ -0,0 +1,2 @@
+calling: 
+012
diff --git a/regression-tests/test-results/clang-15-c++20-libcpp/pure2-default-arguments.cpp.output b/regression-tests/test-results/clang-15-c++20-libcpp/pure2-default-arguments.cpp.output
@@ -0,0 +1,4 @@
+pure2-default-arguments.cpp2:6:61: error: no member named 'source_location' in namespace 'std'
+    char const* fn = CPP2_UFCS_NONLOCAL(function_name)(std::source_location::current())
+                                                       ~~~~~^
+1 error generated.
diff --git a/regression-tests/test-results/clang-15-c++20/pure2-default-arguments.cpp.execution b/regression-tests/test-results/clang-15-c++20/pure2-default-arguments.cpp.execution
@@ -0,0 +1,2 @@
+calling: 
+012
diff --git a/regression-tests/test-results/clang-18-c++20/pure2-default-arguments.cpp.output b/regression-tests/test-results/clang-18-c++20/pure2-default-arguments.cpp.output
@@ -0,0 +1,7 @@
+pure2-default-arguments.cpp2:6:56: error: cannot take address of consteval function 'current' outside of an immediate invocation
+    6 |     char const* fn = CPP2_UFCS_NONLOCAL(function_name)(std::source_location::current())
+      |                                                        ^
+/usr/bin/../lib/gcc/x86_64-linux-gnu/14/../../../../include/c++/14/source_location:60:5: note: declared here
+   60 |     current(__builtin_ret_type __p = __builtin_source_location()) noexcept
+      |     ^
+1 error generated.
diff --git a/regression-tests/test-results/clang-18-c++23-libcpp/pure2-default-arguments.cpp.output b/regression-tests/test-results/clang-18-c++23-libcpp/pure2-default-arguments.cpp.output
@@ -0,0 +1,7 @@
+pure2-default-arguments.cpp2:6:56: error: cannot take address of consteval function 'current' outside of an immediate invocation
+    6 |     char const* fn = CPP2_UFCS_NONLOCAL(function_name)(std::source_location::current())
+      |                                                        ^
+/usr/lib/llvm-18/bin/../include/c++/v1/source_location:60:36: note: declared here
+   60 |   static consteval source_location current(__bsl_ty __ptr = __builtin_source_location()) noexcept {
+      |                                    ^
+1 error generated.
diff --git a/regression-tests/test-results/gcc-10-c++20/pure2-bugfix-for-requires-clause-in-forward-declaration.cpp.output b/regression-tests/test-results/gcc-10-c++20/pure2-bugfix-for-requires-clause-in-forward-declaration.cpp.output
@@ -6,12 +6,12 @@ pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:3:46: error: expect
 In file included from pure2-bugfix-for-requires-clause-in-forward-declaration.cpp:7:
 ../../../include/cpp2util.h:10005:47: error: static assertion failed: GCC 11 or higher is required to support variables and type-scope functions that have a 'requires' clause. This includes a type-scope 'forward' parameter of non-wildcard type, such as 'func: (this, forward s: std::string)', which relies on being able to add a 'requires' clause - in that case, use 'forward s: _' instead if you need the result to compile with GCC 10.
 pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:4:1: note: in expansion of macro ‘CPP2_REQUIRES_’
-pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:3:3: error: no declaration matches ‘element::element(auto:261&&) requires  is_same_v<std::__cxx11::string, typename std::remove_cv<typename std::remove_reference<decltype(element::__ct ::n)>::type>::type>’
+pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:3:3: error: no declaration matches ‘element::element(auto:95&&) requires  is_same_v<std::__cxx11::string, typename std::remove_cv<typename std::remove_reference<decltype(element::__ct ::n)>::type>::type>’
 pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:5:11: note: candidates are: ‘element::element(const element&)’
-pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:3:20: note:                 ‘template<class auto:259> element::element(auto:259&&)’
+pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:3:20: note:                 ‘template<class auto:93> element::element(auto:93&&)’
 pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:1:7: note: ‘class element’ defined here
 pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:5:78: error: expected unqualified-id before ‘{’ token
-pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:3:8: error: no declaration matches ‘element& element::operator=(auto:262&&) requires  is_same_v<std::__cxx11::string, typename std::remove_cv<typename std::remove_reference<decltype(element::operator=::n)>::type>::type>’
+pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:3:8: error: no declaration matches ‘element& element::operator=(auto:96&&) requires  is_same_v<std::__cxx11::string, typename std::remove_cv<typename std::remove_reference<decltype(element::operator=::n)>::type>::type>’
 pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:6:16: note: candidates are: ‘void element::operator=(const element&)’
-pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:3:16: note:                 ‘template<class auto:260> element& element::operator=(auto:260&&)’
+pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:3:16: note:                 ‘template<class auto:94> element& element::operator=(auto:94&&)’
 pure2-bugfix-for-requires-clause-in-forward-declaration.cpp2:1:7: note: ‘class element’ defined here
diff --git a/regression-tests/test-results/gcc-10-c++20/pure2-print.cpp.output b/regression-tests/test-results/gcc-10-c++20/pure2-print.cpp.output
@@ -9,8 +9,8 @@ pure2-print.cpp2:68:1: note: in expansion of macro ‘CPP2_REQUIRES_’
 pure2-print.cpp2:97:1: note: in expansion of macro ‘CPP2_REQUIRES_’
 pure2-print.cpp2:9:41: error: ‘constexpr const T outer::object_alias’ is not a static data member of ‘class outer’
 pure2-print.cpp2:9:48: error: template definition of non-template ‘constexpr const T outer::object_alias’
-pure2-print.cpp2:67:14: error: no declaration matches ‘void outer::mytype::variadic(const auto:260& ...) requires (is_convertible_v<typename std::remove_cv<typename std::remove_reference<decltype(outer::mytype::variadic::x)>::type>::type, int> && ...)’
-pure2-print.cpp2:67:29: note: candidate is: ‘template<class ... auto:259> static void outer::mytype::variadic(const auto:259& ...)’
+pure2-print.cpp2:67:14: error: no declaration matches ‘void outer::mytype::variadic(const auto:94& ...) requires (is_convertible_v<typename std::remove_cv<typename std::remove_reference<decltype(outer::mytype::variadic::x)>::type>::type, int> && ...)’
+pure2-print.cpp2:67:29: note: candidate is: ‘template<class ... auto:93> static void outer::mytype::variadic(const auto:93& ...)’
 pure2-print.cpp2:10:19: note: ‘class outer::mytype’ defined here
 pure2-print.cpp2:96:37: error: no declaration matches ‘void outer::print(std::ostream&, const Args& ...) requires  cpp2::impl::cmp_greater_eq(sizeof ... (Args ...), 0)’
 pure2-print.cpp2:96:37: note: no functions named ‘void outer::print(std::ostream&, const Args& ...) requires  cpp2::impl::cmp_greater_eq(sizeof ... (Args ...), 0)’
diff --git a/regression-tests/test-results/gcc-13-c++2b/mixed-bounds-safety-with-assert.cpp.execution b/regression-tests/test-results/gcc-13-c++2b/mixed-bounds-safety-with-assert.cpp.execution
@@ -1 +1 @@
-mixed-bounds-safety-with-assert.cpp2(11) void print_subrange(const auto:263&, cpp2::impl::in<int>, cpp2::impl::in<int>) [with auto:263 = std::vector<int>; cpp2::impl::in<int> = const int]: Bounds safety violation
+mixed-bounds-safety-with-assert.cpp2(11) void print_subrange(const auto:243&, cpp2::impl::in<int>, cpp2::impl::in<int>) [with auto:243 = std::vector<int>; cpp2::impl::in<int> = const int]: Bounds safety violation
diff --git a/regression-tests/test-results/gcc-13-c++2b/pure2-default-arguments.cpp.execution b/regression-tests/test-results/gcc-13-c++2b/pure2-default-arguments.cpp.execution
@@ -0,0 +1,2 @@
+calling: int main(int, char**)
+012
diff --git a/regression-tests/test-results/gcc-14-c++2b/gcc-version.output b/regression-tests/test-results/gcc-14-c++2b/gcc-version.output
@@ -1,4 +1,4 @@
-g++ (GCC) 14.1.1 20240701 (Red Hat 14.1.1-7)
+g++ (GCC) 14.2.1 20240801 (Red Hat 14.2.1-1)
 Copyright (C) 2024 Free Software Foundation, Inc.
 This is free software; see the source for copying conditions.  There is NO
 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/regression-tests/test-results/gcc-14-c++2b/mixed-bounds-safety-with-assert.cpp.execution b/regression-tests/test-results/gcc-14-c++2b/mixed-bounds-safety-with-assert.cpp.execution
@@ -1 +1 @@
-mixed-bounds-safety-with-assert.cpp2(11) void print_subrange(const auto:257&, cpp2::impl::in<int>, cpp2::impl::in<int>) [with auto:257 = std::vector<int>; cpp2::impl::in<int> = const int]: Bounds safety violation
+mixed-bounds-safety-with-assert.cpp2(11) void print_subrange(const auto:91&, cpp2::impl::in<int>, cpp2::impl::in<int>) [with auto:91 = std::vector<int>; cpp2::impl::in<int> = const int]: Bounds safety violation
diff --git a/regression-tests/test-results/msvc-2022-c++20/pure2-default-arguments.cpp.execution b/regression-tests/test-results/msvc-2022-c++20/pure2-default-arguments.cpp.execution
@@ -0,0 +1,2 @@
+calling: int __cdecl main(const int,char **)
+012
diff --git a/regression-tests/test-results/msvc-2022-c++20/pure2-default-arguments.cpp.output b/regression-tests/test-results/msvc-2022-c++20/pure2-default-arguments.cpp.output
@@ -0,0 +1 @@
+pure2-default-arguments.cpp
diff --git a/regression-tests/test-results/pure2-regex_01_char_matcher.cpp b/regression-tests/test-results/pure2-regex_01_char_matcher.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_02_ranges.cpp b/regression-tests/test-results/pure2-regex_02_ranges.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_03_wildcard.cpp b/regression-tests/test-results/pure2-regex_03_wildcard.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_04_start_end.cpp b/regression-tests/test-results/pure2-regex_04_start_end.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_05_classes.cpp b/regression-tests/test-results/pure2-regex_05_classes.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_06_boundaries.cpp b/regression-tests/test-results/pure2-regex_06_boundaries.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_07_short_classes.cpp b/regression-tests/test-results/pure2-regex_07_short_classes.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_08_alternatives.cpp b/regression-tests/test-results/pure2-regex_08_alternatives.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_09_groups.cpp b/regression-tests/test-results/pure2-regex_09_groups.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_10_escapes.cpp b/regression-tests/test-results/pure2-regex_10_escapes.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_11_group_references.cpp b/regression-tests/test-results/pure2-regex_11_group_references.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_12_case_insensitive.cpp b/regression-tests/test-results/pure2-regex_12_case_insensitive.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_13_possessive_modifier.cpp b/regression-tests/test-results/pure2-regex_13_possessive_modifier.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_14_multiline_modifier.cpp b/regression-tests/test-results/pure2-regex_14_multiline_modifier.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_15_group_modifiers.cpp b/regression-tests/test-results/pure2-regex_15_group_modifiers.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_16_perl_syntax_modifier.cpp b/regression-tests/test-results/pure2-regex_16_perl_syntax_modifier.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_17_comments.cpp b/regression-tests/test-results/pure2-regex_17_comments.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_18_branch_reset.cpp b/regression-tests/test-results/pure2-regex_18_branch_reset.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/regression-tests/test-results/pure2-regex_19_lookahead.cpp b/regression-tests/test-results/pure2-regex_19_lookahead.cpp
@@ -1,5 +1,6 @@
 
 #define CPP2_IMPORT_STD          Yes
+#include "cpp2regex.h"
 
 //=== Cpp2 type declarations ====================================================
 
diff --git a/source/common.h b/source/common.h
@@ -47,20 +47,11 @@
 #ifndef CPP2_COMMON_H
 #define CPP2_COMMON_H
 
-#include <algorithm>
 #include <cassert>
 #include <cctype>
 #include <chrono>
-#include <compare>
-#include <cstdint>
 #include <iomanip>
-#include <iterator>
-#include <memory>
-#include <map>
-#include <string>
-#include <string_view>
 #include <unordered_map>
-#include <vector>
 
 namespace cpp2 {
 
diff --git a/source/parse.h b/source/parse.h
@@ -5539,6 +5539,7 @@ auto pretty_print_visualize(translation_unit_node const& n)
 class parser
 {
     std::vector<error_entry>& errors;
+    std::set<std::string>&    includes;
 
     std::unique_ptr<translation_unit_node> parse_tree = {};
 
@@ -5584,10 +5585,10 @@ class parser
         }
     };
 
-    std::vector<token> const* tokens = {};
+    std::vector<token> const* tokens           = {};
     stable_vector<token>*     generated_tokens = {};
-    int pos = 0;
-    std::string parse_kind = {};
+    int                       pos              = 0;
+    std::string               parse_kind       = {};
 
     //  Keep track of the function bodies' locations - used to emit comments
     //  in the right pass (decide whether it's a comment that belongs with
@@ -5663,13 +5664,18 @@ class parser
     //
     //  errors      error list
     //
-    parser( std::vector<error_entry>& errors_ )
+    parser( 
+        std::vector<error_entry>& errors_,
+        std::set<std::string>&    includes_
+    )
         : errors{ errors_ }
+        , includes{ includes_ }
         , parse_tree{std::make_unique<translation_unit_node>()}
     { }
 
     parser( parser const& that )
         : errors{ that.errors }
+        , includes{ that.includes }
         , parse_tree{std::make_unique<translation_unit_node>()}
     { }
 
diff --git a/source/reflect.h b/source/reflect.h
diff --git a/source/reflect.h2 b/source/reflect.h2
diff --git a/source/sema.h b/source/sema.h
diff --git a/source/to_cpp1.h b/source/to_cpp1.h

Original file line number	Diff line number	Diff line change
`@@ -2824,8 +2824,6 @@ inline constexpr auto as_() -> decltype(auto)`
`2824`	`2824`
`2825`	`2825`	`}`
`2826`	`2826`
`2827`		`-#include "cpp2regex.h"`
`2828`		`-`
`2829`	`2827`	`using cpp2::cpp2_new;`
`2830`	`2828`
`2831`	`2829`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-mixed-bounds-safety-with-assert.cpp2(11) void print_subrange(const auto:263&, cpp2::impl::in<int>, cpp2::impl::in<int>) [with auto:263 = std::vector<int>; cpp2::impl::in<int> = const int]: Bounds safety violation`
	`1`	`+mixed-bounds-safety-with-assert.cpp2(11) void print_subrange(const auto:243&, cpp2::impl::in<int>, cpp2::impl::in<int>) [with auto:243 = std::vector<int>; cpp2::impl::in<int> = const int]: Bounds safety violation`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+calling: int main(int, char**)`
	`2`	`+012`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-g++ (GCC) 14.1.1 20240701 (Red Hat 14.1.1-7)`
	`1`	`+g++ (GCC) 14.2.1 20240801 (Red Hat 14.2.1-1)`
`2`	`2`	`Copyright (C) 2024 Free Software Foundation, Inc.`
`3`	`3`	`This is free software; see the source for copying conditions. There is NO`
`4`	`4`	`warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+calling: int __cdecl main(const int,char **)`
	`2`	`+012`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`
`2`	`2`	`#define CPP2_IMPORT_STD Yes`
	`3`	`+#include "cpp2regex.h"`
`3`	`4`
`4`	`5`	`//=== Cpp2 type declarations ====================================================`
`5`	`6`