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#define __glibcxx_want_constexpr_queue
67#include <bits/version.h>
68
69#include <deque>
70#include <vector>
71#include <bits/stl_heap.h>
72#include <bits/stl_function.h>
73#include <bits/stl_queue.h>
74
75#ifdef __glibcxx_format_ranges // C++ >= 23 && HOSTED
76#include <bits/formatfwd.h>
77
78#ifdef __glibcxx_constexpr_format // C++ >= 26 && HOSTED && CXX11 strings
79# define _GLIBCXX_CONSTEXPR_FORMAT constexpr
80#else
81# define _GLIBCXX_CONSTEXPR_FORMAT
82#endif
83
84namespace std _GLIBCXX_VISIBILITY(default)
85{
86_GLIBCXX_BEGIN_NAMESPACE_VERSION
87 // Standard does not constrain accepted _CharT, we do so we can
88 // befriend specializations.
89 template<__format::__char _CharT, typename _Tp,
90 formattable<_CharT> _Container>
91 struct formatter<queue<_Tp, _Container>, _CharT>
92 {
93 private:
94 using __maybe_const_adaptor
95 = __conditional_t<
96 __format::__const_formattable_range<_Container, _CharT>,
97 const queue<_Tp, _Container>, queue<_Tp, _Container>>;
98
99 public:
100 // Standard declares this as template accepting unconstrained
101 // ParseContext type.
102 constexpr typename basic_format_parse_context<_CharT>::iterator
103 parse(basic_format_parse_context<_CharT>& __pc)
104 { return _M_f.parse(__pc); }
105
106 // Standard declares this as template accepting unconstrained
107 // FormatContext type.
108 template<typename _Out>
109 _GLIBCXX_CONSTEXPR_FORMAT
110 typename basic_format_context<_Out, _CharT>::iterator
111 format(__maybe_const_adaptor& __a,
112 basic_format_context<_Out, _CharT>& __fc) const
113 { return _M_f.format(__a.c, __fc); }
114
115 private:
116 // Standard uses formatter<ref_view<_Container>, _CharT>, but range_formatter
117 // provides same behavior.
118 // _GLIBCXX_RESOLVE_LIB_DEFECTS
119 // 3881. Incorrect formatting of container adapters backed by std::string
120 range_formatter<_Tp, _CharT> _M_f;
121 };
122
123#if __glibcxx_print >= 202406L
124 // _GLIBCXX_RESOLVE_LIB_DEFECTS
125 // 4398. enable_nonlocking_formatter_optimization should be disabled for container adaptors
126 template<typename _Tp, typename _Container>
127 constexpr bool
128 enable_nonlocking_formatter_optimization<queue<_Tp, _Container>> = false;
129#endif
130
131 template<__format::__char _CharT, typename _Tp,
132 formattable<_CharT> _Container, typename _Compare>
133 struct formatter<priority_queue<_Tp, _Container, _Compare>, _CharT>
134 {
135 private:
136 using __maybe_const_adaptor
137 = __conditional_t<
138 __format::__const_formattable_range<_Container, _CharT>,
139 const priority_queue<_Tp, _Container, _Compare>,
140 priority_queue<_Tp, _Container, _Compare>>;
141
142 public:
143 // Standard declares this as template accepting unconstrained
144 // ParseContext type.
145 constexpr typename basic_format_parse_context<_CharT>::iterator
146 parse(basic_format_parse_context<_CharT>& __pc)
147 { return _M_f.parse(__pc); }
148
149 // Standard declares this as template accepting unconstrained
150 // FormatContext type.
151 template<typename _Out>
152 _GLIBCXX_CONSTEXPR_FORMAT
153 typename basic_format_context<_Out, _CharT>::iterator
154 format(__maybe_const_adaptor& __a,
155 basic_format_context<_Out, _CharT>& __fc) const
156 { return _M_f.format(__a.c, __fc); }
157
158 private:
159 // Standard uses formatter<ref_view<_Container>, _CharT>, but range_formatter
160 // provides same behavior.
161 // _GLIBCXX_RESOLVE_LIB_DEFECTS
162 // 3881. Incorrect formatting of container adapters backed by std::string
163 range_formatter<_Tp, _CharT> _M_f;
164 };
165
166#if __glibcxx_print >= 202406L
167 // _GLIBCXX_RESOLVE_LIB_DEFECTS
168 // 4398. enable_nonlocking_formatter_optimization should be disabled for container adaptors
169 template<typename _Tp, typename _Container, typename _Comparator>
170 constexpr bool
171 enable_nonlocking_formatter_optimization<
173#endif
174
175#undef _GLIBCXX_CONSTEXPR_FORMAT
176
177_GLIBCXX_END_NAMESPACE_VERSION
178} // namespace std
179#endif // __glibcxx_format_ranges
180
181
182#endif /* _GLIBCXX_QUEUE */
ISO C++ entities toplevel namespace is std.
A standard container giving FIFO behavior.
Definition stl_queue.h:105
A standard container automatically sorting its contents.
Definition stl_queue.h:563