add an option to not include any urlpattern code (#904)

anonrig · web-flow · commit 2c110e5c778b · 2025-03-01T14:25:55.000-05:00
diff --git a/cmake/ada-flags.cmake b/cmake/ada-flags.cmake
@@ -19,6 +19,7 @@ option(ADA_TOOLS "Build cli tools (adaparse)" OFF)
 option(ADA_BENCHMARKS "Build benchmarks" OFF)
 option(ADA_TESTING "Build tests" OFF)
 option(ADA_USE_UNSAFE_STD_REGEX_PROVIDER "Enable unsafe regex provider that uses std::regex" OFF)
+option(ADA_INCLUDE_URL_PATTERN "Include URL pattern implementation" ON)
 
 if (ADA_COVERAGE)
     message(STATUS "You want to compute coverage. We assume that you have installed gcovr.")
diff --git a/include/ada.h b/include/ada.h
@@ -29,11 +29,14 @@
 #include "ada/url_aggregator-inl.h"
 #include "ada/url_search_params.h"
 #include "ada/url_search_params-inl.h"
+
+#if ADA_INCLUDE_URL_PATTERN
 #include "ada/url_pattern.h"
 #include "ada/url_pattern-inl.h"
 #include "ada/url_pattern_helpers.h"
 #include "ada/url_pattern_helpers-inl.h"
 #include "ada/url_pattern_regex.h"
+#endif  // ADA_INCLUDE_URL_PATTERN
 
 // Public API
 #include "ada/ada_version.h"
diff --git a/include/ada/common_defs.h b/include/ada/common_defs.h
@@ -262,4 +262,8 @@ namespace ada {
 #endif
 #endif
 
+#ifndef ADA_INCLUDE_URL_PATTERN
+#define ADA_INCLUDE_URL_PATTERN 1
+#endif  // ADA_INCLUDE_URL_PATTERN
+
 #endif  // ADA_COMMON_DEFS_H
diff --git a/include/ada/implementation-inl.h b/include/ada/implementation-inl.h
@@ -4,7 +4,10 @@
 #ifndef ADA_IMPLEMENTATION_INL_H
 #define ADA_IMPLEMENTATION_INL_H
 
+#if ADA_INCLUDE_URL_PATTERN
 #include "ada/url_pattern_regex.h"
+#endif  // ADA_INCLUDE_URL_PATTERN
+
 #include "ada/expected.h"
 #include "ada/implementation.h"
 
@@ -13,6 +16,7 @@
 
 namespace ada {
 
+#if ADA_INCLUDE_URL_PATTERN
 template <url_pattern_regex::regex_concept regex_provider>
 ada_warn_unused tl::expected<url_pattern<regex_provider>, errors>
 parse_url_pattern(std::variant<std::string_view, url_pattern_init> input,
@@ -21,6 +25,7 @@ parse_url_pattern(std::variant<std::string_view, url_pattern_init> input,
   return parser::parse_url_pattern_impl<regex_provider>(std::move(input),
                                                         base_url, options);
 }
+#endif  // ADA_INCLUDE_URL_PATTERN
 
 }  // namespace ada
 
diff --git a/include/ada/implementation.h b/include/ada/implementation.h
@@ -13,7 +13,10 @@
 #include "ada/url.h"
 #include "ada/common_defs.h"
 #include "ada/errors.h"
+
+#if ADA_INCLUDE_URL_PATTERN
 #include "ada/url_pattern_init.h"
+#endif  // ADA_INCLUDE_URL_PATTERN
 
 namespace ada {
 
@@ -47,6 +50,7 @@ extern template ada::result<url_aggregator> parse<url_aggregator>(
 bool can_parse(std::string_view input,
                const std::string_view* base_input = nullptr);
 
+#if ADA_INCLUDE_URL_PATTERN
 /**
  * Implementation of the URL pattern parsing algorithm.
  * @see https://urlpattern.spec.whatwg.org
@@ -61,6 +65,7 @@ ada_warn_unused tl::expected<url_pattern<regex_provider>, errors>
 parse_url_pattern(std::variant<std::string_view, url_pattern_init> input,
                   const std::string_view* base_url = nullptr,
                   const url_pattern_options* options = nullptr);
+#endif  // ADA_INCLUDE_URL_PATTERN
 
 /**
  * Computes a href string from a file path. The function assumes
diff --git a/include/ada/parser-inl.h b/include/ada/parser-inl.h
@@ -5,15 +5,18 @@
 #define ADA_PARSER_INL_H
 
 #include "ada/expected.h"
+#if ADA_INCLUDE_URL_PATTERN
 #include "ada/url_pattern.h"
 #include "ada/url_pattern_helpers.h"
+#endif  // ADA_INCLUDE_URL_PATTERN
 #include "ada/parser.h"
 
 #include <string>
 #include <string_view>
 #include <variant>
 
 namespace ada::parser {
+#if ADA_INCLUDE_URL_PATTERN
 template <url_pattern_regex::regex_concept regex_provider>
 tl::expected<url_pattern<regex_provider>, errors> parse_url_pattern_impl(
     std::variant<std::string_view, url_pattern_init> input,
@@ -267,6 +270,7 @@ tl::expected<url_pattern<regex_provider>, errors> parse_url_pattern_impl(
   // Return urlPattern.
   return url_pattern_;
 }
+#endif  // ADA_INCLUDE_URL_PATTERN
 
 }  // namespace ada::parser
 
diff --git a/include/ada/parser.h b/include/ada/parser.h
@@ -9,18 +9,23 @@
 #include <variant>
 
 #include "ada/expected.h"
+
+#if ADA_INCLUDE_URL_PATTERN
 #include "ada/url_pattern_regex.h"
 #include "ada/url_pattern_init.h"
+#endif  // ADA_INCLUDE_URL_PATTERN
 
 /**
  * @private
  */
 namespace ada {
 struct url_aggregator;
 struct url;
+#if ADA_INCLUDE_URL_PATTERN
 template <url_pattern_regex::regex_concept regex_provider>
 class url_pattern;
 struct url_pattern_options;
+#endif  // ADA_INCLUDE_URL_PATTERN
 enum class errors : uint8_t;
 }  // namespace ada
 
@@ -53,10 +58,12 @@ extern template url_aggregator parse_url_impl<url_aggregator>(
 extern template url parse_url_impl<url>(std::string_view user_input,
                                         const url* base_url);
 
+#if ADA_INCLUDE_URL_PATTERN
 template <url_pattern_regex::regex_concept regex_provider>
 tl::expected<url_pattern<regex_provider>, errors> parse_url_pattern_impl(
     std::variant<std::string_view, url_pattern_init> input,
     const std::string_view* base_url, const url_pattern_options* options);
+#endif  // ADA_INCLUDE_URL_PATTERN
 
 }  // namespace ada::parser
 
diff --git a/include/ada/url_aggregator.h b/include/ada/url_aggregator.h
@@ -223,12 +223,15 @@ struct url_aggregator : url_base {
       std::string_view, const url_aggregator *);
   friend url_aggregator parser::parse_url_impl<url_aggregator, false>(
       std::string_view, const url_aggregator *);
+
+#if ADA_INCLUDE_URL_PATTERN
   // url_pattern methods
   template <url_pattern_regex::regex_concept regex_provider>
   friend tl::expected<url_pattern<regex_provider>, errors>
   parse_url_pattern_impl(std::variant<std::string_view, url_pattern_init> input,
                          const std::string_view *base_url,
                          const url_pattern_options *options);
+#endif  // ADA_INCLUDE_URL_PATTERN
 
   std::string buffer{};
   url_components components{};
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -59,3 +59,9 @@ endif()
 if(ADA_TESTING)
   target_compile_definitions(ada PRIVATE ADA_TESTING=1)
 endif()
+
+if(ADA_INCLUDE_URL_PATTERN)
+  target_compile_definitions(ada PRIVATE ADA_INCLUDE_URL_PATTERN=1)
+else()
+  target_compile_definitions(ada PRIVATE ADA_INCLUDE_URL_PATTERN=0)
+endif()
diff --git a/src/ada.cpp b/src/ada.cpp
@@ -8,7 +8,11 @@
 #include "parser.cpp"
 #include "url_components.cpp"
 #include "url_aggregator.cpp"
+
+#if ADA_INCLUDE_URL_PATTERN
 #include "url_pattern.cpp"
 #include "url_pattern_helpers.cpp"
 #include "url_pattern_regex.cpp"
+#endif  // ADA_INCLUDE_URL_PATTERN
+
 #include "ada_c.cpp"
diff --git a/src/url_pattern.cpp b/src/url_pattern.cpp
@@ -1,3 +1,5 @@
+#if ADA_INCLUDE_URL_PATTERN
+
 #include "ada/url_pattern-inl.h"
 
 #include <algorithm>
@@ -365,3 +367,5 @@ tl::expected<std::string, errors> url_pattern_init::process_hash(
 }
 
 }  // namespace ada
+
+#endif  // ADA_INCLUDE_URL_PATTERN
diff --git a/src/url_pattern_helpers.cpp b/src/url_pattern_helpers.cpp
@@ -1,3 +1,4 @@
+#if ADA_INCLUDE_URL_PATTERN
 #include "ada/url_pattern_helpers-inl.h"
 
 #include <algorithm>
@@ -1012,3 +1013,5 @@ std::string generate_pattern_string(
   return result;
 }
 }  // namespace ada::url_pattern_helpers
+
+#endif  // ADA_INCLUDE_URL_PATTERN
diff --git a/src/url_pattern_regex.cpp b/src/url_pattern_regex.cpp
@@ -1,3 +1,5 @@
+#if ADA_INCLUDE_URL_PATTERN
+
 #include "ada/url_pattern_regex.h"
 
 namespace ada::url_pattern_regex {
@@ -53,3 +55,5 @@ bool std_regex_provider::regex_match(std::string_view input,
 #endif  // ADA_USE_UNSAFE_STD_REGEX_PROVIDER
 
 }  // namespace ada::url_pattern_regex
+
+#endif  // ADA_INCLUDE_URL_PATTERN
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -26,6 +26,12 @@ if(ADA_LOGGING)
   add_compile_definitions(ADA_LOGGING=1)
 endif()
 
+if(ADA_INCLUDE_URL_PATTERN)
+  add_compile_definitions(ADA_INCLUDE_URL_PATTERN=1)
+else()
+  add_compile_definitions(ADA_INCLUDE_URL_PATTERN=0)
+endif()
+
 if(ADA_TESTING)
   add_compile_definitions(ADA_TESTING=1)
 endif()
@@ -49,23 +55,29 @@ if(MSVC AND BUILD_SHARED_LIBS)
 else()
   include(GoogleTest)
   add_executable(wpt_url_tests wpt_url_tests.cpp)
+  if(ADA_INCLUDE_URL_PATTERN)
   add_executable(wpt_urlpattern_tests wpt_urlpattern_tests.cpp)
+  endif()
   add_executable(url_components url_components.cpp)
   add_executable(basic_tests basic_tests.cpp)
   add_executable(from_file_tests from_file_tests.cpp)
   add_executable(ada_c ada_c.cpp)
   add_executable(url_search_params url_search_params.cpp)
 
   target_link_libraries(wpt_url_tests PRIVATE simdjson GTest::gtest_main)
+  if(ADA_INCLUDE_URL_PATTERN)
   target_link_libraries(wpt_urlpattern_tests PRIVATE simdjson GTest::gtest_main)
+  endif()
   target_link_libraries(url_components PRIVATE simdjson GTest::gtest_main)
   target_link_libraries(basic_tests PRIVATE simdjson GTest::gtest_main)
   target_link_libraries(from_file_tests PRIVATE simdjson GTest::gtest_main)
   target_link_libraries(ada_c PRIVATE simdjson GTest::gtest_main)
   target_link_libraries(url_search_params PRIVATE simdjson GTest::gtest_main)
 
   gtest_discover_tests(wpt_url_tests PROPERTIES TEST_DISCOVERY_TIMEOUT 600)
+  if(ADA_INCLUDE_URL_PATTERN)
   gtest_discover_tests(wpt_urlpattern_tests PROPERTIES TEST_DISCOVERY_TIMEOUT 600)
+  endif()
   gtest_discover_tests(url_components PROPERTIES TEST_DISCOVERY_TIMEOUT 600)
   gtest_discover_tests(basic_tests PROPERTIES TEST_DISCOVERY_TIMEOUT 600)
   gtest_discover_tests(from_file_tests PROPERTIES TEST_DISCOVERY_TIMEOUT 600)
