Ada 2.9.2
Fast spec-compliant URL parser
|
Lightweight URL struct. More...
#include <url_aggregator.h>
Public Member Functions | |
url_aggregator ()=default | |
url_aggregator (const url_aggregator &u)=default | |
url_aggregator (url_aggregator &&u) noexcept=default | |
url_aggregator & | operator= (url_aggregator &&u) noexcept=default |
url_aggregator & | operator= (const url_aggregator &u)=default |
~url_aggregator () override=default | |
bool | set_href (std::string_view input) |
bool | set_host (std::string_view input) |
bool | set_hostname (std::string_view input) |
bool | set_protocol (std::string_view input) |
bool | set_username (std::string_view input) |
bool | set_password (std::string_view input) |
bool | set_port (std::string_view input) |
bool | set_pathname (std::string_view input) |
void | set_search (std::string_view input) |
void | set_hash (std::string_view input) |
bool | has_valid_domain () const noexcept override |
std::string | get_origin () const noexcept override |
std::string_view | get_href () const noexcept ada_lifetime_bound |
std::string_view | get_username () const noexcept ada_lifetime_bound |
std::string_view | get_password () const noexcept ada_lifetime_bound |
std::string_view | get_port () const noexcept ada_lifetime_bound |
std::string_view | get_hash () const noexcept ada_lifetime_bound |
std::string_view | get_host () const noexcept ada_lifetime_bound |
std::string_view | get_hostname () const noexcept ada_lifetime_bound |
std::string_view | get_pathname () const noexcept ada_lifetime_bound |
ada_really_inline uint32_t | get_pathname_length () const noexcept |
std::string_view | get_search () const noexcept ada_lifetime_bound |
std::string_view | get_protocol () const noexcept ada_lifetime_bound |
ada_really_inline bool | has_credentials () const noexcept |
ada_really_inline const ada::url_components & | get_components () const noexcept |
std::string | to_string () const override |
std::string | to_diagram () const |
bool | validate () const noexcept |
bool | has_empty_hostname () const noexcept |
bool | has_hostname () const noexcept |
bool | has_non_empty_username () const noexcept |
bool | has_non_empty_password () const noexcept |
bool | has_port () const noexcept |
bool | has_password () const noexcept |
bool | has_hash () const noexcept override |
bool | has_search () const noexcept override |
void | clear_port () |
void | clear_hash () |
void | clear_search () override |
![]() | |
virtual | ~url_base ()=default |
ada_really_inline bool | is_special () const noexcept |
Friends | |
ada::url_aggregator | ada::parser::parse_url (std::string_view, const ada::url_aggregator *) |
void | ada::helpers::strip_trailing_spaces_from_opaque_path (ada::url_aggregator &url) noexcept |
ada::url_aggregator | ada::parser::parse_url_impl (std::string_view, const ada::url_aggregator *) |
ada::url_aggregator | ada::parser::parse_url_impl (std::string_view, const ada::url_aggregator *) |
Additional Inherited Members | |
![]() | |
bool | is_valid {true} |
bool | has_opaque_path {false} |
url_host_type | host_type = url_host_type::DEFAULT |
Lightweight URL struct.
The url_aggregator class aims to minimize temporary memory allocation while representing a parsed URL. Internally, it contains a single normalized URL (the href), and it makes available the components, mostly using std::string_view.
Definition at line 25 of file url_aggregator.h.
|
default |
|
default |
|
defaultnoexcept |
|
overridedefault |
|
inline |
Definition at line 620 of file url_aggregator-inl.h.
References ADA_ASSERT_EQUAL, ADA_ASSERT_TRUE, get_hash(), ada::url_components::hash_start, ada::url_components::omitted, to_diagram(), ada::url_components::to_string(), and validate().
|
inline |
Definition at line 571 of file url_aggregator-inl.h.
References ADA_ASSERT_TRUE, ada::url_components::hash_start, ada::url_components::host_end, ada::url_components::omitted, ada::url_components::pathname_start, ada::url_components::port, ada::url_components::search_start, and validate().
Referenced by set_port().
|
inlineoverridevirtual |
Implements ada::url_base.
Definition at line 595 of file url_aggregator-inl.h.
References ADA_ASSERT_EQUAL, ADA_ASSERT_TRUE, get_search(), ada::url_components::hash_start, ada::url_components::omitted, ada::url_components::search_start, to_diagram(), ada::url_components::to_string(), and validate().
Referenced by set_search().
|
nodiscardnoexcept |
Useful for implementing efficient serialization for the URL.
https://user:[email protected]:1234/foo/bar?baz#quux | | | | ^^^^| | | | | | | | | | ----- hash_start | | | | | |
------— search_start | | | | | ----------------- pathname_start | | | |
------------------— port | | | ----------------------- host_end | |
-------------------------------— host_start | --------------------------------------- username_end
------------------------------------------— protocol_end
Inspired after servo/url
Definition at line 731 of file url_aggregator-inl.h.
|
nodiscardnoexcept |
Return U+0023 (#), followed by this's URL's fragment. This function does not allocate memory.
Definition at line 678 of file url_aggregator.cpp.
References ada::url_components::hash_start, and ada::url_components::omitted.
Referenced by clear_hash().
|
nodiscardnoexcept |
Return url's host, serialized, followed by U+003A (:) and url's port, serialized. This function does not allocate memory. When there is no host, this function returns the empty view.
Definition at line 692 of file url_aggregator.cpp.
References ada::url_components::host_end, ada::url_components::host_start, and ada::url_components::pathname_start.
Referenced by get_origin().
|
nodiscardnoexcept |
Return this's URL's host, serialized. This function does not allocate memory. When there is no host, this function returns the empty view.
Definition at line 711 of file url_aggregator.cpp.
References ada::url_components::host_end, and ada::url_components::host_start.
Referenced by has_valid_domain().
|
inlinenodiscardnoexcept |
Return the normalized string. This function does not allocate memory. It is highly efficient.
Definition at line 847 of file url_aggregator-inl.h.
|
nodiscardoverridevirtualnoexcept |
The origin getter steps are to return the serialization of this's URL's origin. [HTML]
Implements ada::url_base.
Definition at line 621 of file url_aggregator.cpp.
References ada::scheme::FILE, get_host(), get_pathname(), get_protocol(), ada::scheme::HTTP, ada::scheme::HTTPS, ada::url_base::is_special(), and ada::parse().
|
nodiscardnoexcept |
The password getter steps are to return this's URL's password. This function does not allocate memory.
Definition at line 658 of file url_aggregator.cpp.
References has_non_empty_password(), ada::url_components::host_start, and ada::url_components::username_end.
|
nodiscardnoexcept |
The pathname getter steps are to return the result of URL path serializing this's URL. This function does not allocate memory.
Definition at line 726 of file url_aggregator.cpp.
References ada::url_components::hash_start, ada::url_components::omitted, ada::url_components::pathname_start, and ada::url_components::search_start.
Referenced by get_origin(), and set_pathname().
|
nodiscardnoexcept |
Compute the pathname length in bytes without instantiating a view or a string.
Definition at line 156 of file url_aggregator-inl.h.
References ada::url_components::hash_start, ada::url_components::omitted, ada::url_components::pathname_start, and ada::url_components::search_start.
|
nodiscardnoexcept |
Return this's URL's port, serialized. This function does not allocate memory.
Definition at line 668 of file url_aggregator.cpp.
References ada::url_components::host_end, ada::url_components::omitted, ada::url_components::pathname_start, and ada::url_components::port.
|
nodiscardnoexcept |
The protocol getter steps are to return this's URL's scheme, followed by U+003A (:). This function does not allocate memory.
Definition at line 759 of file url_aggregator.cpp.
References ada::url_components::protocol_end.
Referenced by get_origin().
|
nodiscardnoexcept |
Return U+003F (?), followed by this's URL's query. This function does not allocate memory.
Definition at line 741 of file url_aggregator.cpp.
References ada::url_components::hash_start, ada::url_components::omitted, and ada::url_components::search_start.
Referenced by clear_search().
|
nodiscardnoexcept |
The username getter steps are to return this's URL's username. This function does not allocate memory.
Definition at line 648 of file url_aggregator.cpp.
References has_non_empty_username(), ada::url_components::protocol_end, and ada::url_components::username_end.
|
nodiscardnoexcept |
A URL includes credentials if its username or password is not the empty string.
Definition at line 719 of file url_aggregator-inl.h.
References has_non_empty_password(), and has_non_empty_username().
|
inlinenodiscardnoexcept |
Definition at line 791 of file url_aggregator-inl.h.
References has_hostname(), ada::url_components::host_end, ada::url_components::host_start, and ada::url_components::username_end.
|
inlinenodiscardoverridevirtualnoexcept |
Implements ada::url_base.
Definition at line 709 of file url_aggregator-inl.h.
References ada::url_components::hash_start, and ada::url_components::omitted.
|
inlinenodiscardnoexcept |
Definition at line 804 of file url_aggregator-inl.h.
Referenced by has_empty_hostname(), and has_port().
|
inlinenodiscardnoexcept |
Definition at line 779 of file url_aggregator-inl.h.
References ada::url_components::host_start, and ada::url_components::username_end.
Referenced by get_password(), and has_credentials().
|
inlinenodiscardnoexcept |
Definition at line 774 of file url_aggregator-inl.h.
References ada::url_components::protocol_end, and ada::url_components::username_end.
Referenced by get_username(), and has_credentials().
|
inlinenodiscardnoexcept |
Definition at line 784 of file url_aggregator-inl.h.
References ada::url_components::host_start, and ada::url_components::username_end.
|
inlinenodiscardnoexcept |
Definition at line 808 of file url_aggregator-inl.h.
References has_hostname(), ada::url_components::host_end, and ada::url_components::pathname_start.
|
inlinenodiscardoverridevirtualnoexcept |
Implements ada::url_base.
Definition at line 714 of file url_aggregator-inl.h.
References ada::url_components::omitted, and ada::url_components::search_start.
|
nodiscardoverridevirtualnoexcept |
Returns true if this URL has a valid domain as per RFC 1034 and corresponding specifications. Among other things, it requires that the domain string has fewer than 255 octets.
Implements ada::url_base.
Definition at line 858 of file url_aggregator.cpp.
References get_hostname(), ada::url_components::host_end, and ada::url_components::host_start.
|
default |
|
defaultnoexcept |
void ada::url_aggregator::set_hash | ( | std::string_view | input | ) |
Definition at line 389 of file url_aggregator.cpp.
References ADA_ASSERT_TRUE, ada::url_components::hash_start, ada::url_components::omitted, and validate().
bool ada::url_aggregator::set_host | ( | std::string_view | input | ) |
Definition at line 607 of file url_aggregator.cpp.
References ADA_ASSERT_TRUE, and validate().
bool ada::url_aggregator::set_hostname | ( | std::string_view | input | ) |
Definition at line 614 of file url_aggregator.cpp.
References ADA_ASSERT_TRUE, and validate().
bool ada::url_aggregator::set_href | ( | std::string_view | input | ) |
Definition at line 409 of file url_aggregator.cpp.
References ADA_ASSERT_TRUE, and ada::parse< url_aggregator >().
bool ada::url_aggregator::set_password | ( | std::string_view | input | ) |
Definition at line 255 of file url_aggregator.cpp.
References ADA_ASSERT_TRUE, ada::unicode::percent_encode_index(), ada::character_sets::USERINFO_PERCENT_ENCODE, and validate().
bool ada::url_aggregator::set_pathname | ( | std::string_view | input | ) |
Definition at line 309 of file url_aggregator.cpp.
References ADA_ASSERT_TRUE, get_pathname(), ada::url_base::has_opaque_path, ada::url_components::pathname_start, and validate().
bool ada::url_aggregator::set_port | ( | std::string_view | input | ) |
Definition at line 275 of file url_aggregator.cpp.
References ADA_ASSERT_TRUE, clear_port(), ada::url_base::is_valid, ada::url_components::port, and validate().
bool ada::url_aggregator::set_protocol | ( | std::string_view | input | ) |
Definition at line 208 of file url_aggregator.cpp.
References ADA_ASSERT_TRUE, ada::checkers::is_alpha(), and validate().
void ada::url_aggregator::set_search | ( | std::string_view | input | ) |
Definition at line 367 of file url_aggregator.cpp.
References ADA_ASSERT_TRUE, clear_search(), ada::url_base::is_special(), ada::character_sets::QUERY_PERCENT_ENCODE, ada::character_sets::SPECIAL_QUERY_PERCENT_ENCODE, and validate().
bool ada::url_aggregator::set_username | ( | std::string_view | input | ) |
Definition at line 235 of file url_aggregator.cpp.
References ADA_ASSERT_TRUE, ada::unicode::percent_encode_index(), ada::character_sets::USERINFO_PERCENT_ENCODE, and validate().
|
nodiscard |
Returns a string diagram of this URL.
Definition at line 1223 of file url_aggregator.cpp.
References ada::url_components::hash_start, ada::url_components::host_end, ada::url_components::host_start, ada::url_base::is_valid, ada::url_components::omitted, ada::url_components::pathname_start, ada::url_components::protocol_end, ada::url_components::search_start, and ada::url_components::username_end.
Referenced by clear_hash(), clear_search(), and validate().
|
nodiscardoverridevirtual |
Returns a string representation of this URL.
Implements ada::url_base.
Definition at line 765 of file url_aggregator.cpp.
References ada::url_components::omitted.
Referenced by ada::operator<<().
|
nodiscardnoexcept |
Verifies that the parsed URL could be valid. Useful for debugging purposes.
https://user:[email protected]:1234/foo/bar?baz#quux | | | | ^^^^| | | | | | | | | | ----- hash_start | | | | | |
------— search_start | | | | | ----------------- pathname_start | | | |
------------------— port | | | ----------------------- host_end | |
-------------------------------— host_start | --------------------------------------- username_end
------------------------------------------— protocol_end
Definition at line 1380 of file url_aggregator.cpp.
References ada::url_components::check_offset_consistency(), ada::url_base::has_opaque_path, ada::url_components::hash_start, ada::url_components::host_end, ada::url_components::host_start, ada::url_base::is_valid, ada::url_components::omitted, ada::url_components::pathname_start, ada::url_components::protocol_end, ada::url_components::search_start, to_diagram(), and ada::url_components::username_end.
Referenced by clear_hash(), clear_port(), clear_search(), set_hash(), set_host(), set_hostname(), set_password(), set_pathname(), set_port(), set_protocol(), set_search(), and set_username().
|
friend |
|
friend |
|
friend |
|
friend |