Ada 2.9.0
Fast spec-compliant URL parser
Loading...
Searching...
No Matches
url_aggregator.h
Go to the documentation of this file.
1
5#ifndef ADA_URL_AGGREGATOR_H
6#define ADA_URL_AGGREGATOR_H
7
8#include <string>
9#include <string_view>
10
11#include "ada/common_defs.h"
12#include "ada/url_base.h"
13#include "ada/url_components.h"
14
15namespace ada {
16
26 url_aggregator() = default;
27 url_aggregator(const url_aggregator &u) = default;
28 url_aggregator(url_aggregator &&u) noexcept = default;
29 url_aggregator &operator=(url_aggregator &&u) noexcept = default;
31 ~url_aggregator() override = default;
32
33 bool set_href(std::string_view input);
34 bool set_host(std::string_view input);
35 bool set_hostname(std::string_view input);
36 bool set_protocol(std::string_view input);
37 bool set_username(std::string_view input);
38 bool set_password(std::string_view input);
39 bool set_port(std::string_view input);
40 bool set_pathname(std::string_view input);
41 void set_search(std::string_view input);
42 void set_hash(std::string_view input);
43
44 [[nodiscard]] bool has_valid_domain() const noexcept override;
51 [[nodiscard]] std::string get_origin() const noexcept override;
60 [[nodiscard]] inline std::string_view get_href() const noexcept;
67 [[nodiscard]] std::string_view get_username() const noexcept;
74 [[nodiscard]] std::string_view get_password() const noexcept;
81 [[nodiscard]] std::string_view get_port() const noexcept;
88 [[nodiscard]] std::string_view get_hash() const noexcept;
97 [[nodiscard]] std::string_view get_host() const noexcept;
105 [[nodiscard]] std::string_view get_hostname() const noexcept;
113 [[nodiscard]] std::string_view get_pathname() const noexcept;
120 [[nodiscard]] ada_really_inline uint32_t get_pathname_length() const noexcept;
127 [[nodiscard]] std::string_view get_search() const noexcept;
135 [[nodiscard]] std::string_view get_protocol() const noexcept;
136
141 [[nodiscard]] ada_really_inline bool has_credentials() const noexcept;
142
164 [[nodiscard]] ada_really_inline const ada::url_components &get_components()
165 const noexcept;
169 [[nodiscard]] std::string to_string() const override;
173 [[nodiscard]] std::string to_diagram() const;
174
180 [[nodiscard]] bool validate() const noexcept;
181
183 [[nodiscard]] inline bool has_empty_hostname() const noexcept;
185 [[nodiscard]] inline bool has_hostname() const noexcept;
187 [[nodiscard]] inline bool has_non_empty_username() const noexcept;
189 [[nodiscard]] inline bool has_non_empty_password() const noexcept;
191 [[nodiscard]] inline bool has_port() const noexcept;
193 [[nodiscard]] inline bool has_password() const noexcept;
195 [[nodiscard]] inline bool has_hash() const noexcept override;
197 [[nodiscard]] inline bool has_search() const noexcept override;
198
199 inline void clear_port();
200 inline void clear_hash();
201 inline void clear_search() override;
202
203 private:
205 std::string_view, const ada::url_aggregator *);
209 ada::url_aggregator, true>(std::string_view, const ada::url_aggregator *);
211 ada::parser::parse_url_impl<ada::url_aggregator, false>(
212 std::string_view, const ada::url_aggregator *);
213
214 std::string buffer{};
215 url_components components{};
216
222 [[nodiscard]] ada_really_inline bool is_at_path() const noexcept;
223
224 inline void add_authority_slashes_if_needed() noexcept;
225
230 inline void reserve(uint32_t capacity);
231
232 ada_really_inline size_t parse_port(
233 std::string_view view, bool check_trailing_content) noexcept override;
234
235 ada_really_inline size_t parse_port(std::string_view view) noexcept override {
236 return this->parse_port(view, false);
237 }
238
245 [[nodiscard]] bool parse_ipv4(std::string_view input, bool in_place);
246
251 [[nodiscard]] bool parse_ipv6(std::string_view input);
252
257 [[nodiscard]] bool parse_opaque_host(std::string_view input);
258
259 ada_really_inline void parse_path(std::string_view input);
260
265 [[nodiscard]] inline bool cannot_have_credentials_or_port() const;
266
267 template <bool override_hostname = false>
268 bool set_host_or_hostname(std::string_view input);
269
270 ada_really_inline bool parse_host(std::string_view input);
271
272 inline void update_base_authority(std::string_view base_buffer,
273 const ada::url_components &base);
274 inline void update_unencoded_base_hash(std::string_view input);
275 inline void update_base_hostname(std::string_view input);
276 inline void update_base_search(std::string_view input);
277 inline void update_base_search(std::string_view input,
278 const uint8_t *query_percent_encode_set);
279 inline void update_base_pathname(std::string_view input);
280 inline void update_base_username(std::string_view input);
281 inline void append_base_username(std::string_view input);
282 inline void update_base_password(std::string_view input);
283 inline void append_base_password(std::string_view input);
284 inline void update_base_port(uint32_t input);
285 inline void append_base_pathname(std::string_view input);
286 [[nodiscard]] inline uint32_t retrieve_base_port() const;
287 inline void clear_hostname();
288 inline void clear_password();
289 inline void clear_pathname() override;
290 [[nodiscard]] inline bool has_dash_dot() const noexcept;
291 void delete_dash_dot();
292 inline void consume_prepared_path(std::string_view input);
293 template <bool has_state_override = false>
294 [[nodiscard]] ada_really_inline bool parse_scheme_with_colon(
295 std::string_view input);
296 ada_really_inline uint32_t replace_and_resize(uint32_t start, uint32_t end,
297 std::string_view input);
298 [[nodiscard]] inline bool has_authority() const noexcept;
299 inline void set_protocol_as_file();
300 inline void set_scheme(std::string_view new_scheme) noexcept;
305 inline void set_scheme_from_view_with_colon(
306 std::string_view new_scheme_with_colon) noexcept;
307 inline void copy_scheme(const url_aggregator &u) noexcept;
308
309}; // url_aggregator
310
311inline std::ostream &operator<<(std::ostream &out, const ada::url &u);
312} // namespace ada
313
314#endif
Common definitions for cross-platform compiler support.
#define ada_really_inline
Definition common_defs.h:84
Definition ada_idna.h:13
Lightweight URL struct.
url_aggregator & operator=(const url_aggregator &u)=default
url_aggregator & operator=(url_aggregator &&u) noexcept=default
bool has_non_empty_username() const noexcept
std::string_view get_pathname() const noexcept
ada_really_inline const ada::url_components & get_components() const noexcept
void set_hash(std::string_view input)
void clear_search() override
url_aggregator()=default
std::string_view get_host() const noexcept
bool has_hostname() const noexcept
bool has_non_empty_password() const noexcept
friend void ada::helpers::strip_trailing_spaces_from_opaque_path(ada::url_aggregator &url) noexcept
ada_really_inline bool has_credentials() const noexcept
friend ada::url_aggregator ada::parser::parse_url(std::string_view, const ada::url_aggregator *)
std::string_view get_search() const noexcept
std::string_view get_username() const noexcept
std::string to_string() const override
bool has_empty_hostname() const noexcept
bool has_search() const noexcept override
std::string to_diagram() const
bool set_protocol(std::string_view input)
std::string get_origin() const noexcept override
bool validate() const noexcept
std::string_view get_protocol() const noexcept
bool has_password() const noexcept
std::string_view get_port() const noexcept
std::string_view get_hostname() const noexcept
ada_really_inline uint32_t get_pathname_length() const noexcept
bool has_valid_domain() const noexcept override
bool set_hostname(std::string_view input)
std::string_view get_href() const noexcept
bool set_password(std::string_view input)
~url_aggregator() override=default
bool set_pathname(std::string_view input)
std::string_view get_password() const noexcept
bool has_hash() const noexcept override
bool set_href(std::string_view input)
void set_search(std::string_view input)
bool has_port() const noexcept
url_aggregator(url_aggregator &&u) noexcept=default
std::string_view get_hash() const noexcept
friend ada::url_aggregator ada::parser::parse_url_impl(std::string_view, const ada::url_aggregator *)
bool set_host(std::string_view input)
bool set_port(std::string_view input)
url_aggregator(const url_aggregator &u)=default
bool set_username(std::string_view input)
Base class of URL implementations.
Definition url_base.h:44
URL Component representations using offsets.
Generic URL struct reliant on std::string instantiation.
Definition url.h:38
Declaration for the basic URL definitions.
Declaration for the URL Components.