Ada 4.1.1
Fast spec-compliant URL parser
Loading...
Searching...
No Matches
ada_c.h
Go to the documentation of this file.
1
5#ifndef ADA_C_H
6#define ADA_C_H
7
8#include <stdbool.h>
9#include <stdint.h>
10#include <stddef.h>
11
12// This is a reference to ada::url_components::omitted
13// It represents "uint32_t(-1)"
14#define ada_url_omitted 0xffffffff
15
16// string that points to data stored in the ada_url instance
17//
18// Lifetime rules:
19// - This pointer remains valid only while the underlying ada_url is unchanged.
20// - Any mutation (e.g., ada_set_* and ada_clear_*) may invalidate previously
21// returned ada_string pointers.
22typedef struct {
23 const char* data;
24 size_t length;
26
27// string that must be freed by the caller.
28// data is NUL-terminated. length does not include the trailing NUL.
29// data is null only when the call failed; an empty string is a non-null
30// pointer to a single '\0' with length 0.
31typedef struct {
32 const char* data;
33 size_t length;
35
36typedef struct {
37 uint32_t protocol_end;
38 uint32_t username_end;
39 uint32_t host_start;
40 uint32_t host_end;
41 uint32_t port;
43 uint32_t search_start;
44 uint32_t hash_start;
46
47typedef void* ada_url;
48
49// input should be a null terminated C string (ASCII or UTF-8)
50// you must call ada_free on the returned pointer
51ada_url ada_parse(const char* input, size_t length);
52ada_url ada_parse_with_base(const char* input, size_t input_length,
53 const char* base, size_t base_length);
54
55// input and base should be a null terminated C strings
56bool ada_can_parse(const char* input, size_t length);
57bool ada_can_parse_with_base(const char* input, size_t input_length,
58 const char* base, size_t base_length);
59
60void ada_free(ada_url result);
63
64bool ada_is_valid(ada_url result);
65
66// url_aggregator getters
67// if ada_is_valid(result)) is false, an empty string is returned
68//
69// Important: this invalidation rule applies only to getters that return
70// ada_string. The ada_get_origin getter returns ada_owned_string.
82uint8_t ada_get_host_type(ada_url result);
83uint8_t ada_get_scheme_type(ada_url result);
84
85// url_aggregator setters
86// if ada_is_valid(result)) is false, the setters have no effect
87// input should be a null terminated C string
88bool ada_set_href(ada_url result, const char* input, size_t length);
89bool ada_set_host(ada_url result, const char* input, size_t length);
90bool ada_set_hostname(ada_url result, const char* input, size_t length);
91bool ada_set_protocol(ada_url result, const char* input, size_t length);
92bool ada_set_username(ada_url result, const char* input, size_t length);
93bool ada_set_password(ada_url result, const char* input, size_t length);
94bool ada_set_port(ada_url result, const char* input, size_t length);
95bool ada_set_pathname(ada_url result, const char* input, size_t length);
96void ada_set_search(ada_url result, const char* input, size_t length);
97void ada_set_hash(ada_url result, const char* input, size_t length);
98
99// url_aggregator clear methods
100void ada_clear_port(ada_url result);
101void ada_clear_hash(ada_url result);
102void ada_clear_search(ada_url result);
103
104// url_aggregator functions
105// if ada_is_valid(result) is false, functions below will return false
106bool ada_has_credentials(ada_url result);
108bool ada_has_hostname(ada_url result);
111bool ada_has_port(ada_url result);
112bool ada_has_password(ada_url result);
113bool ada_has_hash(ada_url result);
114bool ada_has_search(ada_url result);
115
116// returns a pointer to the internal url_aggregator::url_components
118
119// idna methods
120ada_owned_string ada_idna_to_unicode(const char* input, size_t length);
121ada_owned_string ada_idna_to_ascii(const char* input, size_t length);
122
123// url search params
125
126// Represents an std::vector<std::string>
127typedef void* ada_strings;
130
135
137
138ada_url_search_params ada_parse_search_params(const char* input, size_t length);
140
144
145void ada_search_params_append(ada_url_search_params result, const char* key,
146 size_t key_length, const char* value,
147 size_t value_length);
148void ada_search_params_set(ada_url_search_params result, const char* key,
149 size_t key_length, const char* value,
150 size_t value_length);
151void ada_search_params_remove(ada_url_search_params result, const char* key,
152 size_t key_length);
154 const char* key, size_t key_length,
155 const char* value, size_t value_length);
156bool ada_search_params_has(ada_url_search_params result, const char* key,
157 size_t key_length);
158bool ada_search_params_has_value(ada_url_search_params result, const char* key,
159 size_t key_length, const char* value,
160 size_t value_length);
162 size_t key_length);
164 const char* key, size_t key_length);
165void ada_search_params_reset(ada_url_search_params result, const char* input,
166 size_t length);
168 ada_url_search_params result);
170 ada_url_search_params result);
172 ada_url_search_params result);
173
174void ada_free_strings(ada_strings result);
175size_t ada_strings_size(ada_strings result);
176ada_string ada_strings_get(ada_strings result, size_t index);
177
183
190
197
198// max URL length configuration
199void ada_set_max_input_length(uint32_t length);
200uint32_t ada_get_max_input_length(void);
201
202// Definitions for Ada's version number.
203typedef struct {
204 int major;
205 int minor;
208
209const char* ada_get_version();
211
212#endif // ADA_C_H
uint32_t ada_get_max_input_length(void)
Definition ada_c.cpp:769
ada_url_search_params ada_parse_search_params(const char *input, size_t length)
Definition ada_c.cpp:473
ada_string ada_get_hash(ada_url result)
Definition ada_c.cpp:171
bool ada_set_port(ada_url result, const char *input, size_t length)
Definition ada_c.cpp:293
void ada_set_max_input_length(uint32_t length)
Definition ada_c.cpp:765
ada_strings ada_search_params_get_all(ada_url_search_params result, const char *key, size_t key_length)
Definition ada_c.cpp:601
void ada_clear_search(ada_url result)
Definition ada_c.cpp:364
void ada_free_search_params_entries_iter(ada_url_search_params_entries_iter result)
Definition ada_c.cpp:737
bool ada_set_host(ada_url result, const char *input, size_t length)
Definition ada_c.cpp:249
bool ada_has_password(ada_url result)
Definition ada_c.cpp:419
bool ada_search_params_keys_iter_has_next(ada_url_search_params_keys_iter result)
Definition ada_c.cpp:700
ada_string ada_search_params_values_iter_next(ada_url_search_params_values_iter result)
Definition ada_c.cpp:715
void ada_free_search_params_keys_iter(ada_url_search_params_keys_iter result)
Definition ada_c.cpp:682
ada_string ada_get_pathname(ada_url result)
Definition ada_c.cpp:198
const ada_url_components * ada_get_components(ada_url result)
Definition ada_c.cpp:444
bool ada_search_params_has_value(ada_url_search_params result, const char *key, size_t key_length, const char *value, size_t value_length)
Definition ada_c.cpp:575
bool ada_has_empty_hostname(ada_url result)
Definition ada_c.cpp:379
void ada_free_strings(ada_strings result)
Definition ada_c.cpp:660
void ada_search_params_append(ada_url_search_params result, const char *key, size_t key_length, const char *value, size_t value_length)
Definition ada_c.cpp:523
bool ada_has_non_empty_password(ada_url result)
Definition ada_c.cpp:403
bool ada_set_password(ada_url result, const char *input, size_t length)
Definition ada_c.cpp:284
ada_url_search_params_entries_iter ada_search_params_get_entries(ada_url_search_params result)
Definition ada_c.cpp:650
void * ada_url_search_params_entries_iter
Definition ada_c.h:136
ada_string ada_get_hostname(ada_url result)
Definition ada_c.cpp:189
bool ada_can_parse_with_base(const char *input, size_t input_length, const char *base, size_t base_length)
Definition ada_c.cpp:92
ada_string ada_search_params_get(ada_url_search_params result, const char *key, size_t key_length)
Definition ada_c.cpp:587
uint8_t ada_get_host_type(ada_url result)
Definition ada_c.cpp:225
ada_string ada_get_password(ada_url result)
Definition ada_c.cpp:153
const char * ada_get_version()
Definition ada_c.cpp:779
ada_version_components ada_get_version_components()
Definition ada_c.cpp:781
void * ada_strings
Definition ada_c.h:127
void ada_search_params_sort(ada_url_search_params result)
Definition ada_c.cpp:506
ada_owned_string ada_idna_to_unicode(const char *input, size_t length)
Definition ada_c.cpp:453
void ada_search_params_remove_value(ada_url_search_params result, const char *key, size_t key_length, const char *value, size_t value_length)
Definition ada_c.cpp:554
bool ada_set_hostname(ada_url result, const char *input, size_t length)
Definition ada_c.cpp:257
ada_url ada_parse_with_base(const char *input, size_t input_length, const char *base, size_t base_length)
Definition ada_c.cpp:75
void ada_free_search_params(ada_url_search_params result)
Definition ada_c.cpp:479
ada_string ada_get_port(ada_url result)
Definition ada_c.cpp:162
bool ada_set_pathname(ada_url result, const char *input, size_t length)
Definition ada_c.cpp:301
ada_string ada_get_host(ada_url result)
Definition ada_c.cpp:180
void * ada_url_search_params
Definition ada_c.h:124
ada_url ada_parse(const char *input, size_t length)
Definition ada_c.cpp:70
bool ada_has_port(ada_url result)
Definition ada_c.cpp:411
void ada_clear_hash(ada_url result)
Definition ada_c.cpp:351
void ada_free_owned_string(ada_owned_string owned)
Definition ada_c.cpp:131
ada_owned_string ada_search_params_to_string(ada_url_search_params result)
Definition ada_c.cpp:484
ada_string ada_strings_get(ada_strings result, size_t index)
Definition ada_c.cpp:673
bool ada_set_href(ada_url result, const char *input, size_t length)
Definition ada_c.cpp:241
void ada_free(ada_url result)
Definition ada_c.cpp:98
void * ada_url
Definition ada_c.h:47
bool ada_search_params_entries_iter_has_next(ada_url_search_params_entries_iter result)
Definition ada_c.cpp:756
size_t ada_search_params_size(ada_url_search_params result)
Definition ada_c.cpp:497
ada_owned_string ada_get_origin(ada_url result)
Definition ada_c.cpp:114
ada_string ada_get_protocol(ada_url result)
Definition ada_c.cpp:216
void ada_free_search_params_values_iter(ada_url_search_params_values_iter result)
Definition ada_c.cpp:709
bool ada_set_username(ada_url result, const char *input, size_t length)
Definition ada_c.cpp:275
ada_string ada_get_username(ada_url result)
Definition ada_c.cpp:144
uint8_t ada_get_scheme_type(ada_url result)
Definition ada_c.cpp:233
ada_string ada_search_params_keys_iter_next(ada_url_search_params_keys_iter result)
Definition ada_c.cpp:687
ada_string_pair ada_search_params_entries_iter_next(ada_url_search_params_entries_iter result)
Definition ada_c.cpp:743
void ada_clear_port(ada_url result)
Definition ada_c.cpp:338
bool ada_is_valid(ada_url result)
Definition ada_c.cpp:108
ada_url_search_params_keys_iter ada_search_params_get_keys(ada_url_search_params result)
Definition ada_c.cpp:630
ada_owned_string ada_idna_to_ascii(const char *input, size_t length)
Definition ada_c.cpp:463
void ada_set_search(ada_url result, const char *input, size_t length)
Definition ada_c.cpp:317
void * ada_url_search_params_keys_iter
Definition ada_c.h:128
bool ada_search_params_values_iter_has_next(ada_url_search_params_values_iter result)
Definition ada_c.cpp:728
void ada_search_params_set(ada_url_search_params result, const char *key, size_t key_length, const char *value, size_t value_length)
Definition ada_c.cpp:534
ada_string ada_get_href(ada_url result)
Definition ada_c.cpp:135
bool ada_set_protocol(ada_url result, const char *input, size_t length)
Definition ada_c.cpp:266
size_t ada_strings_size(ada_strings result)
Definition ada_c.cpp:665
ada_url_search_params_values_iter ada_search_params_get_values(ada_url_search_params result)
Definition ada_c.cpp:640
bool ada_has_hash(ada_url result)
Definition ada_c.cpp:427
bool ada_search_params_has(ada_url_search_params result, const char *key, size_t key_length)
Definition ada_c.cpp:565
bool ada_has_hostname(ada_url result)
Definition ada_c.cpp:387
bool ada_has_credentials(ada_url result)
Definition ada_c.cpp:371
void * ada_url_search_params_values_iter
Definition ada_c.h:129
bool ada_can_parse(const char *input, size_t length)
Definition ada_c.cpp:88
ada_string ada_get_search(ada_url result)
Definition ada_c.cpp:207
void ada_search_params_reset(ada_url_search_params result, const char *input, size_t length)
Definition ada_c.cpp:514
void ada_search_params_remove(ada_url_search_params result, const char *key, size_t key_length)
Definition ada_c.cpp:545
bool ada_has_non_empty_username(ada_url result)
Definition ada_c.cpp:395
bool ada_has_search(ada_url result)
Definition ada_c.cpp:435
ada_url ada_copy(ada_url input)
Definition ada_c.cpp:103
void ada_set_hash(ada_url result, const char *input, size_t length)
Definition ada_c.cpp:331
size_t length
Definition ada_c.h:33
const char * data
Definition ada_c.h:32
ada_string value
Definition ada_c.h:133
ada_string key
Definition ada_c.h:132
const char * data
Definition ada_c.h:23
size_t length
Definition ada_c.h:24
uint32_t username_end
Definition ada_c.h:38
uint32_t host_end
Definition ada_c.h:40
uint32_t hash_start
Definition ada_c.h:44
uint32_t pathname_start
Definition ada_c.h:42
uint32_t port
Definition ada_c.h:41
uint32_t protocol_end
Definition ada_c.h:37
uint32_t search_start
Definition ada_c.h:43
uint32_t host_start
Definition ada_c.h:39