-
Notifications
You must be signed in to change notification settings - Fork 54
/
Copy pathformat.hpp
457 lines (369 loc) · 12.6 KB
/
format.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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
//
// 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_FORMAT_HPP
#define BOOST_URL_FORMAT_HPP
#include <boost/url/detail/config.hpp>
#include <boost/core/detail/string_view.hpp>
#include <boost/url/url.hpp>
#include <boost/url/detail/vformat.hpp>
#include <initializer_list>
#ifdef BOOST_URL_HAS_CONCEPTS
#include <concepts>
#endif
namespace boost {
namespace urls {
/** A temporary reference to a named formatting argument
This class represents a temporary reference
to a named formatting argument used by the
@ref format function.
Named arguments should always be created
with the @ref arg function.
Any type that can be formatted into a URL
with the @ref format function can also be used
in a named argument. All named arguments
are convertible to @ref format_arg and
can be used in the @ref format function.
@see
@ref arg,
@ref format,
@ref format_to,
@ref format_arg.
*/
template <class T>
using named_arg = detail::named_arg<T>;
/** A temporary reference to a formatting argument
This class represents a temporary reference
to a formatting argument used by the
@ref format function.
A @ref format argument should always be
created by passing the argument to be
formatted directly to the @ref format function.
Any type that can be formatted into a URL
with the @ref format function is convertible
to this type.
This includes basic types, types convertible
to `core::string_view`, and @ref named_arg.
@see
@ref format,
@ref format_to,
@ref arg.
*/
using format_arg = detail::format_arg;
/** Format arguments into a URL
Format arguments according to the format
URL string into a @ref url.
The rules for a format URL string are the same
as for a `std::format_string`, where replacement
fields are delimited by curly braces.
The URL components to which replacement fields
belong are identified before replacement is
applied and any invalid characters for that
formatted argument are percent-escaped.
Hence, the delimiters between URL components,
such as `:`, `//`, `?`, and `#`, should be
included in the URL format string. Likewise,
a format string with a single `"{}"` is
interpreted as a path and any replacement
characters invalid in this component will be
encoded to form a valid URL.
@par Example
@code
assert(format("{}", "Hello world!").buffer() == "Hello%20world%21");
@endcode
@par Preconditions
All replacement fields must be valid and the
resulting URL should be valid after arguments
are formatted into the URL.
Because any invalid characters for a URL
component are encoded by this function, only
replacements in the scheme and port components
might be invalid, as these components do not
allow percent-encoding of arbitrary
characters.
@return A URL holding the formatted result.
@param fmt The format URL string.
@param args Arguments to be formatted.
@throws system_error
`fmt` contains an invalid format string and
the result contains an invalid URL after
replacements are applied.
@par BNF
@code
replacement_field ::= "{" [arg_id] [":" (format_spec | chrono_format_spec)] "}"
arg_id ::= integer | identifier
integer ::= digit+
digit ::= "0"..."9"
identifier ::= id_start id_continue*
id_start ::= "a"..."z" | "A"..."Z" | "_"
id_continue ::= id_start | digit
@endcode
@par Specification
@li <a href="https://fmt.dev/latest/syntax.html"
>Format String Syntax</a>
@see
@ref format_to,
@ref arg.
*/
template <BOOST_URL_CONSTRAINT(std::convertible_to<format_arg>)... Args>
url
format(
core::string_view fmt,
Args&&... args)
{
return detail::vformat(
fmt, detail::make_format_args(
std::forward<Args>(args)...));
}
/** Format arguments into a URL
Format arguments according to the format
URL string into a @ref url_base.
The rules for a format URL string are the same
as for a `std::format_string`, where replacement
fields are delimited by curly braces.
The URL components to which replacement fields
belong are identified before replacement is
applied and any invalid characters for that
formatted argument are percent-escaped.
Hence, the delimiters between URL components,
such as `:`, `//`, `?`, and `#`, should be
included in the URL format string. Likewise,
a format string with a single `"{}"` is
interpreted as a path and any replacement
characters invalid in this component will be
encoded to form a valid URL.
@par Example
@code
static_url<30> u;
format(u, "{}", "Hello world!");
assert(u.buffer() == "Hello%20world%21");
@endcode
@par Preconditions
All replacement fields must be valid and the
resulting URL should be valid after arguments
are formatted into the URL.
Because any invalid characters for a URL
component are encoded by this function, only
replacements in the scheme and port components
might be invalid, as these components do not
allow percent-encoding of arbitrary
characters.
@par Exception Safety
Strong guarantee.
@param u An object that derives from @ref url_base.
@param fmt The format URL string.
@param args Arguments to be formatted.
@throws system_error
`fmt` contains an invalid format string and
`u` contains an invalid URL after replacements
are applied.
@par BNF
@code
replacement_field ::= "{" [arg_id] [":" (format_spec | chrono_format_spec)] "}"
arg_id ::= integer | identifier
integer ::= digit+
digit ::= "0"..."9"
identifier ::= id_start id_continue*
id_start ::= "a"..."z" | "A"..."Z" | "_"
id_continue ::= id_start | digit
@endcode
@par Specification
@li <a href="https://fmt.dev/latest/syntax.html"
>Format String Syntax</a>
@see
@ref format.
*/
template <BOOST_URL_CONSTRAINT(std::convertible_to<format_arg>)... Args>
void
format_to(
url_base& u,
core::string_view fmt,
Args&&... args)
{
detail::vformat_to(
u, fmt, detail::make_format_args(
std::forward<Args>(args)...));
}
/** Format arguments into a URL
Format arguments according to the format
URL string into a @ref url.
This overload allows type-erased arguments
to be passed as an initializer_list, which
is mostly convenient for named parameters.
All arguments must be convertible to a
implementation defined type able to store a
type-erased reference to any valid format
argument.
The rules for a format URL string are the same
as for a `std::format_string`, where replacement
fields are delimited by curly braces.
The URL components to which replacement fields
belong are identified before replacement is
applied and any invalid characters for that
formatted argument are percent-escaped.
Hence, the delimiters between URL components,
such as `:`, `//`, `?`, and `#`, should be
included in the URL format string. Likewise,
a format string with a single `"{}"` is
interpreted as a path and any replacement
characters invalid in this component will be
encoded to form a valid URL.
@par Example
@code
assert(format("user/{id}", {{"id", 1}}).buffer() == "user/1");
@endcode
@par Preconditions
All replacement fields must be valid and the
resulting URL should be valid after arguments
are formatted into the URL.
Because any invalid characters for a URL
component are encoded by this function, only
replacements in the scheme and port components
might be invalid, as these components do not
allow percent-encoding of arbitrary
characters.
@return A URL holding the formatted result.
@param fmt The format URL string.
@param args Arguments to be formatted.
@throws system_error
`fmt` contains an invalid format string and
the result contains an invalid URL after
replacements are applied.
@par BNF
@code
replacement_field ::= "{" [arg_id] [":" (format_spec | chrono_format_spec)] "}"
arg_id ::= integer | identifier
integer ::= digit+
digit ::= "0"..."9"
identifier ::= id_start id_continue*
id_start ::= "a"..."z" | "A"..."Z" | "_"
id_continue ::= id_start | digit
@endcode
@par Specification
@li <a href="https://fmt.dev/latest/syntax.html"
>Format String Syntax</a>
@see
@ref format_to.
*/
inline
url
format(
core::string_view fmt,
std::initializer_list<format_arg> args)
{
return detail::vformat(
fmt, detail::format_args(
args.begin(), args.end()));
}
/** Format arguments into a URL
Format arguments according to the format
URL string into a @ref url_base.
This overload allows type-erased arguments
to be passed as an initializer_list, which
is mostly convenient for named parameters.
All arguments must be convertible to a
implementation defined type able to store a
type-erased reference to any valid format
argument.
The rules for a format URL string are the same
as for a `std::format_string`, where replacement
fields are delimited by curly braces.
The URL components to which replacement fields
belong are identified before replacement is
applied and any invalid characters for that
formatted argument are percent-escaped.
Hence, the delimiters between URL components,
such as `:`, `//`, `?`, and `#`, should be
included in the URL format string. Likewise,
a format string with a single `"{}"` is
interpreted as a path and any replacement
characters invalid in this component will be
encoded to form a valid URL.
@par Example
@code
static_url<30> u;
format_to(u, "user/{id}", {{"id", 1}})
assert(u.buffer() == "user/1");
@endcode
@par Preconditions
All replacement fields must be valid and the
resulting URL should be valid after arguments
are formatted into the URL.
Because any invalid characters for a URL
component are encoded by this function, only
replacements in the scheme and port components
might be invalid, as these components do not
allow percent-encoding of arbitrary
characters.
@par Exception Safety
Strong guarantee.
@param u An object that derives from @ref url_base.
@param fmt The format URL string.
@param args Arguments to be formatted.
@throws system_error
`fmt` contains an invalid format string and
`u` contains an invalid URL after replacements
are applied.
@par BNF
@code
replacement_field ::= "{" [arg_id] [":" (format_spec | chrono_format_spec)] "}"
arg_id ::= integer | identifier
integer ::= digit+
digit ::= "0"..."9"
identifier ::= id_start id_continue*
id_start ::= "a"..."z" | "A"..."Z" | "_"
id_continue ::= id_start | digit
@endcode
@par Specification
@li <a href="https://fmt.dev/latest/syntax.html"
>Format String Syntax</a>
@see
@ref format.
*/
inline
void
format_to(
url_base& u,
core::string_view fmt,
std::initializer_list<format_arg> args)
{
detail::vformat_to(
u, fmt, detail::format_args(
args.begin(), args.end()));
}
/** Designate a named argument for a replacement field
Construct a named argument for a format URL
string that contains named replacement fields.
The function parameters should be convertible
to an implementation defined type able to
store the name and a reference to any type
potentially used as a format argument.
@par Example
The function should be used to designate a named
argument for a replacement field in a format
URL string.
@code
assert(format("user/{id}", arg("id", 1)).buffer() == "user/1");
@endcode
@return A temporary object with reference
semantics for a named argument
@param name The format argument name
@param arg The format argument value
@see
@ref format,
@ref format_to.
*/
template <class T>
named_arg<T>
arg(core::string_view name, T const& arg)
{
return {name, arg};
}
} // url
} // boost
#endif