libstdc++: queue Source File

libstdc++

queue
Go to the documentation of this file.
1// <queue> -*- C++ -*-
2
3// Copyright (C) 2001-2026 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/*
26 *
27 * Copyright (c) 1994
28 * Hewlett-Packard Company
29 *
30 * Permission to use, copy, modify, distribute and sell this software
31 * and its documentation for any purpose is hereby granted without fee,
32 * provided that the above copyright notice appear in all copies and
33 * that both that copyright notice and this permission notice appear
34 * in supporting documentation. Hewlett-Packard Company makes no
35 * representations about the suitability of this software for any
36 * purpose. It is provided "as is" without express or implied warranty.
37 *
38 *
39 * Copyright (c) 1996,1997
40 * Silicon Graphics Computer Systems, Inc.
41 *
42 * Permission to use, copy, modify, distribute and sell this software
43 * and its documentation for any purpose is hereby granted without fee,
44 * provided that the above copyright notice appear in all copies and
45 * that both that copyright notice and this permission notice appear
46 * in supporting documentation. Silicon Graphics makes no
47 * representations about the suitability of this software for any
48 * purpose. It is provided "as is" without express or implied warranty.
49 */
50
51/** @file include/queue
52 * This is a Standard C++ Library header.
53 */
54
55#ifndef _GLIBCXX_QUEUE
56#define _GLIBCXX_QUEUE 1
57
58#ifdef _GLIBCXX_SYSHDR
59#pragma GCC system_header
60#endif
61
62#include <bits/requires_hosted.h> // containers
63
64#define __glibcxx_want_adaptor_iterator_pair_constructor
65#define __glibcxx_want_containers_ranges
66#include <bits/version.h>
67
68#include <deque>
69#include <vector>
70#include <bits/stl_heap.h>
71#include <bits/stl_function.h>
72#include <bits/stl_queue.h>
73
74#ifdef __glibcxx_format_ranges // C++ >= 23 && HOSTED
75#include <bits/formatfwd.h>
76
77namespace std _GLIBCXX_VISIBILITY(default)
78{
79_GLIBCXX_BEGIN_NAMESPACE_VERSION
80 // Standard does not constrain accepted _CharT, we do so we can
81 // befriend specializations.
82 template<__format::__char _CharT, typename _Tp,
83 formattable<_CharT> _Container>
84 struct formatter<queue<_Tp, _Container>, _CharT>
85 {
86 private:
87 using __maybe_const_adaptor
88 = __conditional_t<
89 __format::__const_formattable_range<_Container, _CharT>,
90 const queue<_Tp, _Container>, queue<_Tp, _Container>>;
91
92 public:
93 // Standard declares this as template accepting unconstrained
94 // ParseContext type.
95 constexpr typename basic_format_parse_context<_CharT>::iterator
96 parse(basic_format_parse_context<_CharT>& __pc)
97 { return _M_f.parse(__pc); }
98
99 // Standard declares this as template accepting unconstrained
100 // FormatContext type.
101 template<typename _Out>
102 typename basic_format_context<_Out, _CharT>::iterator
103 format(__maybe_const_adaptor& __a,
104 basic_format_context<_Out, _CharT>& __fc) const
105 { return _M_f.format(__a.c, __fc); }
106
107 private:
108 // Standard uses formatter<ref_view<_Container>, _CharT>, but range_formatter
109 // provides same behavior.
110 // _GLIBCXX_RESOLVE_LIB_DEFECTS
111 // 3881. Incorrect formatting of container adapters backed by std::string
112 range_formatter<_Tp, _CharT> _M_f;
113 };
114
115#if __glibcxx_print >= 202406L
116 // _GLIBCXX_RESOLVE_LIB_DEFECTS
117 // 4398. enable_nonlocking_formatter_optimization should be disabled for container adaptors
118 template<typename _Tp, typename _Container>
119 constexpr bool
120 enable_nonlocking_formatter_optimization<queue<_Tp, _Container>> = false;
121#endif
122
123 template<__format::__char _CharT, typename _Tp,
124 formattable<_CharT> _Container, typename _Compare>
125 struct formatter<priority_queue<_Tp, _Container, _Compare>, _CharT>
126 {
127 private:
128 using __maybe_const_adaptor
129 = __conditional_t<
130 __format::__const_formattable_range<_Container, _CharT>,
131 const priority_queue<_Tp, _Container, _Compare>,
132 priority_queue<_Tp, _Container, _Compare>>;
133
134 public:
135 // Standard declares this as template accepting unconstrained
136 // ParseContext type.
137 constexpr typename basic_format_parse_context<_CharT>::iterator
138 parse(basic_format_parse_context<_CharT>& __pc)
139 { return _M_f.parse(__pc); }
140
141 // Standard declares this as template accepting unconstrained
142 // FormatContext type.
143 template<typename _Out>
144 typename basic_format_context<_Out, _CharT>::iterator
145 format(__maybe_const_adaptor& __a,
146 basic_format_context<_Out, _CharT>& __fc) const
147 { return _M_f.format(__a.c, __fc); }
148
149 private:
150 // Standard uses formatter<ref_view<_Container>, _CharT>, but range_formatter
151 // provides same behavior.
152 // _GLIBCXX_RESOLVE_LIB_DEFECTS
153 // 3881. Incorrect formatting of container adapters backed by std::string
154 range_formatter<_Tp, _CharT> _M_f;
155 };
156
157#if __glibcxx_print >= 202406L
158 // _GLIBCXX_RESOLVE_LIB_DEFECTS
159 // 4398. enable_nonlocking_formatter_optimization should be disabled for container adaptors
160 template<typename _Tp, typename _Container, typename _Comparator>
161 constexpr bool
162 enable_nonlocking_formatter_optimization<
163 priority_queue<_Tp, _Container, _Comparator>> = false;
164#endif
165
166_GLIBCXX_END_NAMESPACE_VERSION
167} // namespace std
168#endif // __glibcxx_format_ranges
169
170
171#endif /* _GLIBCXX_QUEUE */
deque
vector
stl_function.h
stl_heap.h
version.h
formatfwd.h
requires_hosted.h
stl_queue.h
std
ISO C++ entities toplevel namespace is std.
std::queue
A standard container giving FIFO behavior.
Definition stl_queue.h:105
std::priority_queue
A standard container automatically sorting its contents.
Definition stl_queue.h:553