libstdc++
elements_of.h
1 // Tag type for yielding ranges rather than values in <generator> -*- C++ -*-
2 
3 // Copyright (C) 2023-2024 Free Software Foundation, Inc.
4 //
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
9 // any later version.
10 
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
15 
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
19 
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
24 
25 #ifndef _GLIBCXX_BITS_ELEMENTS_OF
26 #define _GLIBCXX_BITS_ELEMENTS_OF
27 
28 #pragma GCC system_header
29 
30 #include <bits/c++config.h>
31 
32 #include <bits/version.h>
33 
34 // C++ >= 23 && __glibcxx_coroutine
35 #if defined(__glibcxx_ranges) && defined(__glibcxx_generator)
36 #include <bits/ranges_base.h>
37 #include <bits/memoryfwd.h>
38 
39 #if _GLIBCXX_HOSTED
40 # include <bits/allocator.h> // likely desirable if hosted.
41 #endif // HOSTED
42 
43 namespace std _GLIBCXX_VISIBILITY(default)
44 {
45 _GLIBCXX_BEGIN_NAMESPACE_VERSION
46 namespace ranges
47 {
48 
49  /**
50  * @ingroup ranges
51  * @since C++23
52  * @{
53  */
54 
55  template<range _Range, typename _Alloc = allocator<byte>>
56  struct elements_of
57  {
58  [[no_unique_address]] _Range range;
59  [[no_unique_address]] _Alloc allocator = _Alloc();
60  };
61 
62  template<typename _Range, typename _Alloc = allocator<byte>>
63  elements_of(_Range&&, _Alloc = _Alloc())
64  -> elements_of<_Range&&, _Alloc>;
65 
66  /// @}
67 }
68 _GLIBCXX_END_NAMESPACE_VERSION
69 } // namespace std
70 
71 #endif // __glibcxx_generator && __glibcxx_ranges
72 #endif // _GLIBCXX_BITS_ELEMENTS_OF
ISO C++ entities toplevel namespace is std.