Lightweight URL struct. More...

#include <url_aggregator.h>

Inheritance diagram for ada::url_aggregator:

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

constexpr 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

constexpr 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 constexpr bool	has_credentials () const noexcept

ada_really_inline const url_components &	get_components () const noexcept

std::string	to_string () const override

std::string	to_diagram () const

constexpr bool	validate () const noexcept

constexpr bool	has_empty_hostname () const noexcept

constexpr bool	has_hostname () const noexcept

constexpr bool	has_non_empty_username () const noexcept

constexpr bool	has_non_empty_password () const noexcept

constexpr bool	has_port () const noexcept

constexpr bool	has_password () const noexcept

constexpr bool	has_hash () const noexcept override

constexpr bool	has_search () const noexcept override

void	clear_port ()

void	clear_hash ()

void	clear_search () override

Public Member Functions inherited from ada::url_base
virtual	~url_base ()=default

ada_really_inline constexpr bool	is_special () const noexcept

Friends
void	helpers::strip_trailing_spaces_from_opaque_path (url_aggregator &url) noexcept

url_aggregator	parser::parse_url (std::string_view, const url_aggregator *)

url_aggregator	parser::parse_url_impl (std::string_view, const url_aggregator *)

url_aggregator	parser::parse_url_impl (std::string_view, const url_aggregator *)

Additional Inherited Members
Public Attributes inherited from ada::url_base
bool	is_valid {true}

bool	has_opaque_path {false}

url_host_type	host_type = url_host_type::DEFAULT

Detailed Description

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. These views are only valid as long as the url_aggregator is not modified or deleted.

Definition at line 30 of file url_aggregator.h.

Constructor & Destructor Documentation

◆ url_aggregator() [1/3]

ada::url_aggregator::url_aggregator ( )

default

Referenced by helpers::strip_trailing_spaces_from_opaque_path, operator=(), operator=(), parser::parse_url, parser::parse_url_impl, url_aggregator(), and url_aggregator().

◆ url_aggregator() [2/3]

ada::url_aggregator::url_aggregator ( const url_aggregator & u )

default

References url_aggregator().

◆ url_aggregator() [3/3]

ada::url_aggregator::url_aggregator ( url_aggregator && u )

defaultnoexcept

References url_aggregator().

◆ ~url_aggregator()

ada::url_aggregator::~url_aggregator ( )

overridedefault

Member Function Documentation

◆ clear_hash()

void ada::url_aggregator::clear_hash ( )

inline

Definition at line 615 of file url_aggregator-inl.h.

References ADA_ASSERT_EQUAL, ADA_ASSERT_TRUE, get_hash(), ada::url_components::omitted, to_diagram(), and validate().

Referenced by ~url_aggregator().

◆ clear_port()

void ada::url_aggregator::clear_port ( )

inline

Definition at line 566 of file url_aggregator-inl.h.

References ADA_ASSERT_TRUE, ada::url_components::omitted, and validate().

Referenced by set_port(), and ~url_aggregator().

◆ clear_search()

void ada::url_aggregator::clear_search ( )

inlineoverridevirtual

Implements ada::url_base.

Definition at line 590 of file url_aggregator-inl.h.

References ADA_ASSERT_EQUAL, ADA_ASSERT_TRUE, get_search(), ada::url_components::omitted, to_diagram(), and validate().

Referenced by set_search(), and ~url_aggregator().

◆ get_components()

ada_really_inline const ada::url_components & ada::url_aggregator::get_components ( ) const

nodiscardnoexcept

Useful for implementing efficient serialization for the URL.

Inspired after servo/url

Returns: a constant reference to the underlying component attribute.

See also: https://github.com/servo/rust-url/blob/b65a45515c10713f6d212e6726719a020203cc98/url/src/quirks.rs#L31

Definition at line 726 of file url_aggregator-inl.h.

Referenced by ~url_aggregator().

◆ get_hash()

std::string_view ada::url_aggregator::get_hash ( ) const

nodiscardnoexcept

Return U+0023 (#), followed by this's URL's fragment. This function does not allocate memory. Note that the returned view becomes invalid if the url_aggregator is modified or deleted.

Returns: a lightweight std::string_view..

See also: https://url.spec.whatwg.org/#dom-url-hash

Definition at line 721 of file url_aggregator.cpp.

References ada_lifetime_bound, and ada::url_components::omitted.

Referenced by clear_hash(), to_string(), and ~url_aggregator().

◆ get_host()

std::string_view ada::url_aggregator::get_host ( ) const

nodiscardnoexcept

Return url's host, serialized, followed by U+003A (:) and url's port, serialized. This function does not allocate memory. Note that the returned view becomes invalid if the url_aggregator is modified or deleted. When there is no host, this function returns the empty view.

Returns: a lightweight std::string_view.

See also: https://url.spec.whatwg.org/#dom-url-host

Definition at line 735 of file url_aggregator.cpp.

References ada_lifetime_bound.

Referenced by get_origin(), to_string(), and ~url_aggregator().

◆ get_hostname()

std::string_view ada::url_aggregator::get_hostname ( ) const

nodiscardnoexcept

Return this's URL's host, serialized. This function does not allocate memory. Note that the returned view becomes invalid if the url_aggregator is modified or deleted. When there is no host, this function returns the empty view.

Returns: a lightweight std::string_view.

See also: https://url.spec.whatwg.org/#dom-url-hostname

Definition at line 754 of file url_aggregator.cpp.

References ada_lifetime_bound.

Referenced by has_valid_domain(), and ~url_aggregator().

◆ get_href()

std::string_view ada::url_aggregator::get_href ( ) const

nodiscardconstexprnoexcept

Return the normalized string. This function does not allocate memory. It is highly efficient. Note that the returned view becomes invalid if the url_aggregator is modified or deleted.

Returns: a constant reference to the underlying normalized URL.

See also: https://url.spec.whatwg.org/#dom-url-href; https://url.spec.whatwg.org/#concept-url-serializer

Definition at line 843 of file url_aggregator-inl.h.

References ada_lifetime_bound.

Referenced by ~url_aggregator().

◆ get_origin()

std::string ada::url_aggregator::get_origin ( ) const

nodiscardoverridevirtualnoexcept

The origin getter steps are to return the serialization of this's URL's origin. [HTML]

Returns: a newly allocated string.

See also: https://url.spec.whatwg.org/#concept-url-origin

Implements ada::url_base.

Definition at line 664 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().

Referenced by ~url_aggregator().

◆ get_password()

std::string_view ada::url_aggregator::get_password ( ) const

nodiscardnoexcept

The password getter steps are to return this's URL's password. This function does not allocate memory. Note that the returned view becomes invalid if the url_aggregator is modified or deleted.

Returns: a lightweight std::string_view.

See also: https://url.spec.whatwg.org/#dom-url-password

Definition at line 701 of file url_aggregator.cpp.

References ada_lifetime_bound, and has_non_empty_password().

Referenced by to_string(), and ~url_aggregator().

◆ get_pathname()

std::string_view ada::url_aggregator::get_pathname ( ) const

nodiscardconstexprnoexcept

The pathname getter steps are to return the result of URL path serializing this's URL. This function does not allocate memory. Note that the returned view becomes invalid if the url_aggregator is modified or deleted.

Returns: a lightweight std::string_view.

See also: https://url.spec.whatwg.org/#dom-url-pathname

Definition at line 1088 of file url_aggregator-inl.h.

References ada_lifetime_bound, and ada::url_components::omitted.

Referenced by get_origin(), set_pathname(), to_string(), and ~url_aggregator().

◆ get_pathname_length()

ada_really_inline uint32_t ada::url_aggregator::get_pathname_length ( ) const

nodiscardnoexcept

Compute the pathname length in bytes without instantiating a view or a string.

Returns: size of the pathname in bytes

See also: https://url.spec.whatwg.org/#dom-url-pathname

Definition at line 154 of file url_aggregator-inl.h.

References ada::url_components::omitted.

Referenced by ~url_aggregator().

◆ get_port()

std::string_view ada::url_aggregator::get_port ( ) const

nodiscardnoexcept

Return this's URL's port, serialized. This function does not allocate memory. Note that the returned view becomes invalid if the url_aggregator is modified or deleted.

Returns: a lightweight std::string_view.

See also: https://url.spec.whatwg.org/#dom-url-port

Definition at line 711 of file url_aggregator.cpp.

References ada_lifetime_bound, and ada::url_components::omitted.

Referenced by ~url_aggregator().

◆ get_protocol()

std::string_view ada::url_aggregator::get_protocol ( ) const

nodiscardnoexcept

The protocol getter steps are to return this's URL's scheme, followed by U+003A (:). This function does not allocate memory. Note that the returned view becomes invalid if the url_aggregator is modified or deleted.

Returns: a lightweight std::string_view.

See also: https://url.spec.whatwg.org/#dom-url-protocol

Definition at line 787 of file url_aggregator.cpp.

References ada_lifetime_bound.

Referenced by get_origin(), to_string(), and ~url_aggregator().

◆ get_search()

std::string_view ada::url_aggregator::get_search ( ) const

nodiscardnoexcept

Return U+003F (?), followed by this's URL's query. This function does not allocate memory. Note that the returned view becomes invalid if the url_aggregator is modified or deleted.

Returns: a lightweight std::string_view.

See also: https://url.spec.whatwg.org/#dom-url-search

Definition at line 769 of file url_aggregator.cpp.

References ada_lifetime_bound, and ada::url_components::omitted.

Referenced by clear_search(), to_string(), and ~url_aggregator().

◆ get_username()

std::string_view ada::url_aggregator::get_username ( ) const

nodiscardnoexcept

The username getter steps are to return this's URL's username. This function does not allocate memory. Note that the returned view becomes invalid if the url_aggregator is modified or deleted.

Returns: a lightweight std::string_view.

See also: https://url.spec.whatwg.org/#dom-url-username

Definition at line 691 of file url_aggregator.cpp.

References ada_lifetime_bound, and has_non_empty_username().

Referenced by to_string(), and ~url_aggregator().

◆ has_credentials()

bool ada::url_aggregator::has_credentials ( ) const

nodiscardconstexprnoexcept

A URL includes credentials if its username or password is not the empty string.

Definition at line 714 of file url_aggregator-inl.h.

References has_non_empty_password(), and has_non_empty_username().

Referenced by to_string(), and ~url_aggregator().

◆ has_empty_hostname()

bool ada::url_aggregator::has_empty_hostname ( ) const

nodiscardconstexprnoexcept

Returns: true if it has an host but it is the empty string

Definition at line 787 of file url_aggregator-inl.h.

References has_hostname().

Referenced by ~url_aggregator().

◆ has_hash()

bool ada::url_aggregator::has_hash ( ) const

nodiscardconstexproverridevirtualnoexcept

Returns: true if the URL has a hash component

Implements ada::url_base.

Definition at line 704 of file url_aggregator-inl.h.

References ada::url_components::omitted.

Referenced by ~url_aggregator().

◆ has_hostname()

bool ada::url_aggregator::has_hostname ( ) const

nodiscardconstexprnoexcept

Returns: true if it has a host (included an empty host)

Definition at line 800 of file url_aggregator-inl.h.

Referenced by has_empty_hostname(), has_port(), and ~url_aggregator().

◆ has_non_empty_password()

bool ada::url_aggregator::has_non_empty_password ( ) const

nodiscardconstexprnoexcept

Returns: true if the URL has a non-empty password

Definition at line 775 of file url_aggregator-inl.h.

Referenced by get_password(), has_credentials(), and ~url_aggregator().

◆ has_non_empty_username()

bool ada::url_aggregator::has_non_empty_username ( ) const

nodiscardconstexprnoexcept

Returns: true if the URL has a non-empty username

Definition at line 770 of file url_aggregator-inl.h.

Referenced by get_username(), has_credentials(), and ~url_aggregator().

◆ has_password()

bool ada::url_aggregator::has_password ( ) const

nodiscardconstexprnoexcept

Returns: true if the URL has a password

Definition at line 780 of file url_aggregator-inl.h.

Referenced by ~url_aggregator().

◆ has_port()

bool ada::url_aggregator::has_port ( ) const

nodiscardconstexprnoexcept

Returns: true if the URL has a (non default) port

Definition at line 804 of file url_aggregator-inl.h.

References has_hostname().

Referenced by ~url_aggregator().

◆ has_search()

bool ada::url_aggregator::has_search ( ) const

nodiscardconstexproverridevirtualnoexcept

Returns: true if the URL has a search component

Implements ada::url_base.

Definition at line 709 of file url_aggregator-inl.h.

References ada::url_components::omitted.

Referenced by ~url_aggregator().

◆ has_valid_domain()

bool ada::url_aggregator::has_valid_domain ( ) const

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 886 of file url_aggregator.cpp.

References get_hostname().

◆ operator=() [1/2]

url_aggregator & ada::url_aggregator::operator= ( const url_aggregator & u )

default

References url_aggregator().

◆ operator=() [2/2]

url_aggregator & ada::url_aggregator::operator= ( url_aggregator && u )

defaultnoexcept

References url_aggregator().

◆ set_hash()

void ada::url_aggregator::set_hash ( std::string_view input )

Definition at line 400 of file url_aggregator.cpp.

References ADA_ASSERT_TRUE, ada::url_components::omitted, and validate().

◆ set_host()

bool ada::url_aggregator::set_host ( std::string_view input )

Definition at line 650 of file url_aggregator.cpp.

References ADA_ASSERT_TRUE, and validate().

◆ set_hostname()

bool ada::url_aggregator::set_hostname ( std::string_view input )

Definition at line 657 of file url_aggregator.cpp.

References ADA_ASSERT_TRUE, and validate().

◆ set_href()

bool ada::url_aggregator::set_href ( std::string_view input )

The setter functions follow the steps defined in the URL Standard.

The url_aggregator has a single buffer that contains the entire normalized URL. The various components are represented as offsets into that buffer. When you call get_pathname(), for example, you get a std::string_view that points into that buffer. If the url_aggregator is modified, the buffer may be reallocated, and the std::string_view you obtained earlier may become invalid. In particular, this implies that you cannot modify the URL using a setter function with a std::string_view that points into the url_aggregator E.g., the following is incorrect: url->set_hostname(url->get_pathname()). You must first copy the pathname to a separate string. std::string pathname(url->get_pathname()); url->set_hostname(pathname);

The caller is responsible for ensuring that the url_aggregator is not modified while any std::string_view obtained from it is in use.

Definition at line 420 of file url_aggregator.cpp.

References ADA_ASSERT_TRUE, and ada::parse< url_aggregator >().