5#ifndef ADA_URL_PATTERN_HELPERS_H
6#define ADA_URL_PATTERN_HELPERS_H
8#include "ada/expected.h"
18#include <unordered_set>
22#if ADA_INCLUDE_URL_PATTERN
24enum class errors : uint8_t;
27namespace ada::url_pattern_helpers {
30enum class token_type : uint8_t {
48enum class token_policy {
56 token(token_type _type,
size_t _index, std::string_view _value)
57 :
type(_type), index(_index), value(_value) {}
60 token_type
type = token_type::INVALID_CHAR;
68 std::string_view value{};
72template <url_pattern_encoding_callback F>
73class url_pattern_parser {
75 url_pattern_parser(F& encoding_callback_,
76 std::string_view segment_wildcard_regexp_)
77 : encoding_callback(encoding_callback_),
78 segment_wildcard_regexp(segment_wildcard_regexp_) {}
80 bool can_continue()
const {
return index < tokens.size(); }
83 token* try_consume_token(token_type type);
85 token* try_consume_modifier_token();
88 token* try_consume_regexp_or_wildcard_token(
const token* name_token);
90 std::string consume_text();
92 bool consume_required_token(token_type type);
95 std::optional<errors> maybe_add_part_from_the_pending_fixed_value()
98 std::optional<errors> add_part(std::string_view prefix, token* name_token,
99 token* regexp_or_wildcard_token,
100 std::string_view suyffix,
103 std::vector<token> tokens{};
104 F& encoding_callback;
105 std::string segment_wildcard_regexp;
106 std::vector<url_pattern_part> parts{};
107 std::string pending_fixed_value{};
109 size_t next_numeric_name = 0;
113 std::unordered_set<std::string> seen_names{};
119 explicit Tokenizer(std::string_view new_input, token_policy new_policy)
120 : input(new_input), policy(new_policy) {}
123 constexpr void get_next_code_point();
126 bool had_invalid_code_point()
const {
return invalid_code_point; }
129 constexpr void seek_and_get_next_code_point(
size_t index);
133 void add_token(token_type type,
size_t next_position,
size_t value_position,
134 size_t value_length);
137 void add_token_with_default_length(token_type type,
size_t next_position,
138 size_t value_position);
142 void add_token_with_defaults(token_type type);
145 std::optional<errors> process_tokenizing_error(
148 friend tl::expected<std::vector<token>,
errors> tokenize(
149 std::string_view input, token_policy policy);
153 std::string_view input;
157 std::vector<token> token_list{};
161 size_t next_index = 0;
163 char32_t code_point{};
165 bool invalid_code_point =
false;
169template <url_pattern_regex::regex_concept regex_prov
ider>
170struct constructor_string_parser {
171 explicit constructor_string_parser(std::string_view new_input,
172 std::vector<token>&& new_token_list)
173 : input(new_input), token_list(std::move(new_token_list)) {}
175 static tl::expected<url_pattern_init, errors>
parse(std::string_view input);
194 std::optional<errors> compute_protocol_matches_special_scheme_flag();
198 constexpr void rewind();
201 constexpr bool is_hash_prefix();
204 constexpr bool is_search_prefix();
207 void change_state(State state,
size_t skip);
210 constexpr bool is_group_open()
const;
213 constexpr bool is_group_close()
const;
216 constexpr bool is_protocol_suffix()
const;
219 constexpr bool next_is_authority_slashes()
const;
222 constexpr bool is_an_identity_terminator()
const;
225 constexpr bool is_pathname_start()
const;
228 constexpr bool is_password_prefix()
const;
231 constexpr bool is_an_ipv6_open()
const;
234 constexpr bool is_an_ipv6_close()
const;
237 constexpr bool is_port_prefix()
const;
240 constexpr bool is_non_special_pattern_char(
size_t index,
241 uint32_t value)
const;
244 constexpr const token* get_safe_token(
size_t index)
const;
247 std::string make_component_string();
249 std::string_view input;
252 std::vector<token> token_list;
255 url_pattern_init
result{};
257 size_t component_start = 0;
259 size_t token_index = 0;
261 size_t token_increment = 1;
263 size_t group_depth = 0;
266 size_t hostname_ipv6_bracket_depth = 0;
269 bool protocol_matches_a_special_scheme_flag =
false;
271 State
state = State::INIT;
275tl::expected<std::string, errors> canonicalize_protocol(std::string_view input);
278tl::expected<std::string, errors> canonicalize_username(std::string_view input);
281tl::expected<std::string, errors> canonicalize_password(std::string_view input);
284tl::expected<std::string, errors> canonicalize_hostname(std::string_view input);
287tl::expected<std::string, errors> canonicalize_ipv6_hostname(
288 std::string_view input);
291tl::expected<std::string, errors> canonicalize_port(std::string_view input);
294tl::expected<std::string, errors> canonicalize_port_with_protocol(
295 std::string_view input, std::string_view protocol);
298tl::expected<std::string, errors> canonicalize_pathname(std::string_view input);
301tl::expected<std::string, errors> canonicalize_opaque_pathname(
302 std::string_view input);
305tl::expected<std::string, errors> canonicalize_search(std::string_view input);
308tl::expected<std::string, errors> canonicalize_hash(std::string_view input);
311tl::expected<std::vector<token>,
errors> tokenize(std::string_view input,
312 token_policy policy);
315std::string process_base_url_string(std::string_view input,
316 url_pattern_init::process_type type);
319std::string escape_pattern_string(std::string_view input);
322std::string escape_regexp_string(std::string_view input);
325constexpr bool is_absolute_pathname(
326 std::string_view input, url_pattern_init::process_type type)
noexcept;
329template <url_pattern_encoding_callback F>
330tl::expected<std::vector<url_pattern_part>,
errors> parse_pattern_string(
331 std::string_view input, url_pattern_compile_component_options& options,
332 F& encoding_callback);
335std::string generate_pattern_string(
336 std::vector<url_pattern_part>& part_list,
337 url_pattern_compile_component_options& options);
341std::tuple<std::string, std::vector<std::string>>
342generate_regular_expression_and_name_list(
343 const std::vector<url_pattern_part>& part_list,
344 url_pattern_compile_component_options options);
347bool is_ipv6_address(std::string_view input)
noexcept;
351template <url_pattern_regex::regex_concept regex_prov
ider>
352bool protocol_component_matches_special_scheme(
353 ada::url_pattern_component<regex_provider>& input);
356std::string_view convert_modifier_to_string(url_pattern_part_modifier modifier);
359std::string generate_segment_wildcard_regexp(
360 url_pattern_compile_component_options options);
Cross-platform compiler macros and common definitions.
type
Enumeration of URL scheme types.
errors
Error codes for URL parsing operations.
state
States in the URL parsing state machine.
ada_warn_unused std::string_view to_string(encoding_type type)
tl::expected< result_type, ada::errors > result
ada_warn_unused ada::result< result_type > parse(std::string_view input, const result_type *base_url=nullptr)
URLPattern API implementation.