-
Notifications
You must be signed in to change notification settings - Fork 50
/
parse.hpp
284 lines (222 loc) · 7.65 KB
/
parse.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
//
// Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)
// Copyright (c) 2022 Alan de Freitas (alandefreitas@gmail.com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
// Official repository: https://github.com/boostorg/url
//
#ifndef BOOST_URL_PARSE_HPP
#define BOOST_URL_PARSE_HPP
#include <boost/url/detail/config.hpp>
#include <boost/url/error_types.hpp>
#include <boost/url/url_view.hpp>
namespace boost {
namespace urls {
/** Return a reference to a parsed URL string
This function parses a string according
to the grammar below and returns a view
referencing the passed string upon success,
else returns an error.
Ownership of the string is not transferred;
the caller is responsible for ensuring that
the lifetime of the character buffer extends
until the view is no longer being accessed.
@par Example
@code
system::result< url_view > rv = parse_absolute_uri( "http://example.com/index.htm?id=1" );
@endcode
@par BNF
@code
absolute-URI = scheme ":" hier-part [ "?" query ]
hier-part = "//" authority path-abempty
/ path-absolute
/ path-rootless
/ path-empty
@endcode
@throw std::length_error `s.size() > url_view::max_size`
@return A @ref result containing a value or an error
@param s The string to parse
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-4.3"
>4.3. Absolute URI (rfc3986)</a>
@see
@ref parse_origin_form,
@ref parse_relative_ref,
@ref parse_uri,
@ref parse_uri_reference,
@ref url_view.
*/
BOOST_URL_DECL
system::result<url_view>
parse_absolute_uri(
core::string_view s);
//------------------------------------------------
/** Return a reference to a parsed URL string
This function parses a string according
to the grammar below and returns a view
referencing the passed string upon success,
else returns an error.
Ownership of the string is not transferred;
the caller is responsible for ensuring that
the lifetime of the character buffer extends
until the view is no longer being accessed.
@par Example
@code
system::result< url_view > = parse_origin_form( "/index.htm?layout=mobile" );
@endcode
@par BNF
@code
origin-form = absolute-path [ "?" query ]
absolute-path = 1*( "/" segment )
@endcode
@throw std::length_error `s.size() > url_view::max_size`
@return A @ref result containing a value or an error
@param s The string to parse
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc7230#section-5.3.1"
>5.3.1. origin-form (rfc7230)</a>
@see
@ref parse_absolute_uri,
@ref parse_relative_ref,
@ref parse_uri,
@ref parse_uri_reference,
@ref url_view.
*/
BOOST_URL_DECL
system::result<url_view>
parse_origin_form(
core::string_view s);
//------------------------------------------------
/** Return a reference to a parsed URL string
This function parses a string according
to the grammar below and returns a view
referencing the passed string upon success,
else returns an error.
Ownership of the string is not transferred;
the caller is responsible for ensuring that
the lifetime of the character buffer extends
until the view is no longer being accessed.
@par Example
@code
system::result< url_view > = parse_relative_ref( "images/dot.gif?v=hide#a" );
@endcode
@par BNF
@code
relative-ref = relative-part [ "?" query ] [ "#" fragment ]
relative-part = "//" authority path-abempty
/ path-absolute
/ path-noscheme
/ path-abempty
/ path-empty
@endcode
@return A @ref result containing a value or an error
@param s The string to parse
@throw std::length_error `s.size() > url_view::max_size`
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-4.2"
>4.2. Relative Reference (rfc3986)</a>
@li <a href="https://www.rfc-editor.org/errata/eid5428"
>Errata ID: 5428 (rfc3986)</a>
@see
@ref parse_absolute_uri,
@ref parse_origin_form,
@ref parse_uri,
@ref parse_uri_reference,
@ref url_view.
*/
BOOST_URL_DECL
system::result<url_view>
parse_relative_ref(
core::string_view s);
//------------------------------------------------
/** Return a reference to a parsed URL string
This function parses a string according
to the grammar below and returns a view
referencing the passed string upon success,
else returns an error.
Ownership of the string is not transferred;
the caller is responsible for ensuring that
the lifetime of the character buffer extends
until the view is no longer being accessed.
@par Example
@code
system::result< url_view > = parse_uri( "https://www.example.com/index.htm?id=guest#s1" );
@endcode
@par BNF
@code
URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
hier-part = "//" authority path-abempty
/ path-absolute
/ path-rootless
/ path-empty
@endcode
@throw std::length_error `s.size() > url_view::max_size`
@return A @ref result containing a value or an error
@param s The string to parse
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-3"
>3. Syntax Components (rfc3986)</a>
@see
@ref parse_absolute_uri,
@ref parse_origin_form,
@ref parse_relative_ref,
@ref parse_uri_reference,
@ref url_view.
*/
BOOST_URL_DECL
system::result<url_view>
parse_uri(
core::string_view s);
//------------------------------------------------
/** Return a reference to a parsed URL string
This function parses a string according
to the grammar below and returns a view
referencing the passed string upon success,
else returns an error.
Ownership of the string is not transferred;
the caller is responsible for ensuring that
the lifetime of the character buffer extends
until the view is no longer being accessed.
@par Example
@code
system::result< url_view > = parse_uri_reference( "ws://echo.example.com/?name=boost#demo" );
@endcode
@par BNF
@code
URI-reference = URI / relative-ref
URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
relative-ref = relative-part [ "?" query ] [ "#" fragment ]
hier-part = "//" authority path-abempty
/ path-absolute
/ path-rootless
/ path-empty
relative-part = "//" authority path-abempty
/ path-absolute
/ path-noscheme
/ path-abempty
/ path-empty
@endcode
@throw std::length_error `s.size() > url_view::max_size`
@return A @ref result containing a value or an error
@param s The string to parse
@par Specification
@li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-4.1"
>4.1. URI Reference (rfc3986)</a>
@li <a href="https://www.rfc-editor.org/errata/eid5428"
>Errata ID: 5428 (rfc3986)</a>
@see
@ref parse_absolute_uri,
@ref parse_origin_form,
@ref parse_relative_ref,
@ref parse_uri,
@ref url_view.
*/
BOOST_URL_DECL
system::result<url_view>
parse_uri_reference(
core::string_view s);
} // url
} // boost
#endif