Blame view

3rdparty/boost_1_81_0/boost/url/params_base.hpp 12.7 KB
0b6a182c   Hu Chunming   添加无鉴权注册和注销
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
  //
  // 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_PARAMS_BASE_HPP
  #define BOOST_URL_PARAMS_BASE_HPP
  
  #include <boost/url/detail/config.hpp>
  #include <boost/url/encoding_opts.hpp>
  #include <boost/url/ignore_case.hpp>
  #include <boost/url/param.hpp>
  #include <boost/url/detail/params_iter_impl.hpp>
  #include <boost/url/detail/url_impl.hpp>
  #include <iosfwd>
  
  namespace boost {
  namespace urls {
  
  /** Common functionality for containers
  
      This base class is used by the library
      to provide common member functions for
      containers. This cannot be instantiated
      directly; Instead, use one of the
      containers or functions:
  
      @par Containers
      @li @ref params_ref
      @li @ref params_view
      @li @ref params_encoded_ref
      @li @ref params_encoded_view
  */
  class params_base
  {
      friend class url_view_base;
      friend class params_ref;
      friend class params_view;
  
      detail::query_ref ref_;
      encoding_opts opt_;
  
      params_base() noexcept;
      BOOST_URL_DECL
      params_base(
          detail::query_ref const& ref,
          encoding_opts opt) noexcept;
      params_base(
          params_base const&) = default;
      params_base& operator=(
          params_base const&) = default;
  
  public:
      /** A Bidirectional iterator to a query parameter
  
          Objects of this type allow iteration
          through the parameters in the query.
          Any percent-escapes in returned strings
          are decoded first.
          The values returned are read-only;
          changes to parameters must be made
          through the container instead, if the
          container supports modification.
  
          <br>
  
          The strings produced when iterators are
          dereferenced belong to the iterator and
          become invalidated when that particular
          iterator is incremented, decremented,
          or destroyed.
  
          @note
  
          The implementation may use temporary,
          recycled storage to store decoded
          strings. These iterators are meant
          to be used ephemerally. That is, for
          short durations such as within a
          function scope. Do not store
          iterators with static storage
          duration or as long-lived objects.
      */
  #ifdef BOOST_URL_DOCS
      using iterator = __see_below__;
  #else
      class iterator;
  #endif
  
      /// @copydoc iterator
      using const_iterator = iterator;
  
      /** The value type
  
          Values of this type represent parameters
          whose strings retain unique ownership by
          making a copy.
  
          @par Example
          @code
          params_view::value_type qp( *url_view( "?first=John&last=Doe" ).params().find( "first" ) );
          @endcode
  
          @see
              @ref param.
      */
      using value_type = param;
  
      /** The reference type
  
          This is the type of value returned when
          iterators of the view are dereferenced.
  
          @see
              @ref param_view.
      */
      using reference = param;
  
      /// @copydoc reference
      using const_reference = param;
  
      /** An unsigned integer type to represent sizes.
      */
      using size_type = std::size_t;
  
      /** A signed integer type used to represent differences.
      */
      using difference_type = std::ptrdiff_t;
  
      //--------------------------------------------
      //
      // Observers
      //
      //--------------------------------------------
  
      /** Return the maximum number of characters possible
  
          This represents the largest number of
          characters that are possible in a path,
          not including any null terminator.
  
          @par Exception Safety
          Throws nothing.
      */
      static
      constexpr
      std::size_t
      max_size() noexcept
      {
          return BOOST_URL_MAX_SIZE;
      }
  
      /** Return the referenced character buffer.
  
          This function returns the character
          buffer referenced by the view.
          The returned string may contain
          percent escapes.
  
          @par Example
          @code
          assert( url_view( "?first=John&last=Doe" ).params().buffer() == "?first=John&last=Doe" );
          @endcode
  
          @par Complexity
          Constant.
  
          @par Exception Safety
          Throws nothing.
      */
      BOOST_URL_DECL
      pct_string_view
      buffer() const noexcept;
  
      /** Return true if there are no params
  
          @par Example
          @code
          assert( ! url_view( "?key=value" ).params().empty() );
          @endcode
  
          @par Complexity
          Constant.
  
          @par Exception Safety
          Throws nothing.
      */
      BOOST_URL_DECL
      bool
      empty() const noexcept;
  
      /** Return the number of params
  
          @par Example
          @code
          assert( url_view( "?key=value").params().size() == 1 );
          @endcode
  
          @par Complexity
          Constant.
  
          @par Exception Safety
          Throws nothing.
      */
      BOOST_URL_DECL
      std::size_t
      size() const noexcept;
  
      /** Return an iterator to the beginning
  
          @par Complexity
          Linear in the size of the first param.
  
          @par Exception Safety
          Throws nothing.
      */
      BOOST_URL_DECL
      iterator
      begin() const noexcept;
  
      /** Return an iterator to the end
  
          @par Complexity
          Constant.
  
          @par Exception Safety
          Throws nothing.
      */
      BOOST_URL_DECL
      iterator
      end() const noexcept;
  
      //--------------------------------------------
  
      /** Return true if a matching key exists
  
          This function examines the parameters
          in the container to find a match for
          the specified key.
          The comparison is performed as if all
          escaped characters were decoded first.
  
          @par Example
          @code
          assert( url_view( "?first=John&last=Doe" ).params().contains( "first" ) );
          @endcode
  
          @par Complexity
          Linear in `this->buffer().size()`.
  
          @par Exception Safety
          Throws nothing.
  
          @param key The key to match.
          By default, a case-sensitive
          comparison is used.
  
          @param ic An optional parameter. If
          the value @ref ignore_case is passed
          here, the comparison is
          case-insensitive.
      */
      bool
      contains(
          string_view key,
          ignore_case_param ic = {}) const noexcept;
  
      /** Return the number of matching keys
  
          This function examines the
          parameters in the container to
          find the number of matches for
          the specified key.
          The comparison is performed as if all
          escaped characters were decoded first.
  
          @par Example
          @code
          assert( url_view( "?first=John&last=Doe" ).params().count( "first" ) == 1 );
          @endcode
  
          @par Complexity
          Linear in `this->buffer().size()`.
  
          @par Exception Safety
          Throws nothing.
  
          @param key The key to match.
          By default, a case-sensitive
          comparison is used.
  
          @param ic An optional parameter. If
          the value @ref ignore_case is passed
          here, the comparison is
          case-insensitive.
      */
      BOOST_URL_DECL
      std::size_t
      count(
          string_view key,
          ignore_case_param ic = {}) const noexcept;
  
      /** Find a matching key
  
          This function examines the parameters
          in the container to find a match for
          the specified key.
          The comparison is performed as if all
          escaped characters were decoded first.
  
          <br>
  
          The search starts from the first param
          and proceeds forward until either the
          key is found or the end of the range is
          reached, in which case `end()` is
          returned.
  
          @par Example
          @code
          assert( (*url_view( "?first=John&last=Doe" ).params().find( "First", ignore_case )).value == "John" );
          @endcode
  
          @par Effects
          @code
          return this->find( this->begin(), key, ic );
          @endcode
  
          @par Complexity
          Linear in `this->buffer().size()`.
  
          @return an iterator to the param
  
          @param key The key to match.
          By default, a case-sensitive
          comparison is used.
  
          @param ic An optional parameter. If
          the value @ref ignore_case is passed
          here, the comparison is
          case-insensitive.
      */
      iterator
      find(
          string_view key,
          ignore_case_param ic = {}) const noexcept;
  
      /** Find a matching key
  
          This function examines the
          parameters in the container to
          find a match for the specified key.
          The comparison is performed as if all
          escaped characters were decoded first.
  
          <br>
  
          The search starts at `from`
          and proceeds forward until either the
          key is found or the end of the range is
          reached, in which case `end()` is
          returned.
  
          @par Example
          @code
          url_view u( "?First=John&Last=Doe" );
  
          assert( u.params().find( "first" ) != u.params().find( "first", ignore_case ) );
          @endcode
  
          @par Complexity
          Linear in `this->buffer().size()`.
  
          @return an iterator to the param
  
          @param from The position to begin the
              search from. This can be `end()`.
  
          @param key The key to match.
          By default, a case-sensitive
          comparison is used.
  
          @param ic An optional parameter. If
          the value @ref ignore_case is passed
          here, the comparison is
          case-insensitive.
      */
      iterator
      find(
          iterator from,
          string_view key,
          ignore_case_param ic = {}) const noexcept;
  
      /** Find a matching key
      
          This function examines the
          parameters in the container to
          find a match for the specified key.
          The comparison is performed as if all
          escaped characters were decoded first.
  
          <br>
  
          The search starts from the last param
          and proceeds backwards until either the
          key is found or the beginning of the
          range is reached, in which case `end()`
          is returned.
  
          @par Example
          @code
          assert( (*url_view( "?first=John&last=Doe" ).params().find_last( "last" )).value == "Doe" );
          @endcode
  
          @par Complexity
          Linear in `this->buffer().size()`.
  
          @return an iterator to the param
  
          @param key The key to match.
          By default, a case-sensitive
          comparison is used.
  
          @param ic An optional parameter. If
          the value @ref ignore_case is passed
          here, the comparison is
          case-insensitive.
      */
      iterator
      find_last(
          string_view key,
          ignore_case_param ic = {}) const noexcept;
  
      /** Find a matching key
      
          This function examines the
          parameters in the container to
          find a match for the specified key.
          The comparison is performed as if all
          escaped characters were decoded first.
  
          <br>
  
          The search starts prior to `before`
          and proceeds backwards until either the
          key is found or the beginning of the
          range is reached, in which case `end()`
          is returned.
  
          @par Example
          @code
          url_view u( "?First=John&Last=Doe" );
  
          assert( u.params().find_last( "last" ) != u.params().find_last( "last", ignore_case ) );
          @endcode
  
          @par Complexity
          Linear in `this->buffer().size()`.
  
          @return an iterator to the param
  
          @param before One past the position
          to begin the search from. This can
          be `end()`.
  
          @param key The key to match.
          By default, a case-sensitive
          comparison is used.
  
          @param ic An optional parameter. If
          the value @ref ignore_case is passed
          here, the comparison is
          case-insensitive.
      */
      iterator
      find_last(
          iterator before,
          string_view key,
          ignore_case_param ic = {}) const noexcept;
  
  private:
      BOOST_URL_DECL
      detail::params_iter_impl
      find_impl(
          detail::params_iter_impl,
          string_view,
          ignore_case_param) const noexcept;
  
      BOOST_URL_DECL
      detail::params_iter_impl
      find_last_impl(
          detail::params_iter_impl,
          string_view,
          ignore_case_param) const noexcept;
  };
  
  //------------------------------------------------
  
  /** Format to an output stream
  
      Any percent-escapes are emitted as-is;
      no decoding is performed.
  
      @par Complexity
      Linear in `ps.buffer().size()`.
  
      @par Effects
      @code
      return os << ps.buffer();
      @endcode
  */
  BOOST_URL_DECL
  std::ostream&
  operator<<(
      std::ostream& os,
      params_base const& qp);
  
  } // urls
  } // boost
  
  #include <boost/url/impl/params_base.hpp>
  
  #endif