1// -*- C++ -*-
2//===----------------------------------------------------------------------===//
3//
4// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_STACK
11#define _LIBCPP_STACK
12
13/*
14    stack synopsis
15
16namespace std
17{
18
19template <class T, class Container = deque<T>>
20class stack
21{
22public:
23    typedef Container                                container_type;
24    typedef typename container_type::value_type      value_type;
25    typedef typename container_type::reference       reference;
26    typedef typename container_type::const_reference const_reference;
27    typedef typename container_type::size_type       size_type;
28
29protected:
30    container_type c;
31
32public:
33    stack() = default;
34    ~stack() = default;
35
36    stack(const stack& q) = default;
37    stack(stack&& q) = default;
38
39    stack& operator=(const stack& q) = default;
40    stack& operator=(stack&& q) = default;
41
42    explicit stack(const container_type& c);
43    explicit stack(container_type&& c);
44    template <class InputIterator> stack(InputIterator first, InputIterator last); // since C++23
45    template<container-compatible-range<T> R> stack(from_range_t, R&& rg); // since C++23
46    template <class Alloc> explicit stack(const Alloc& a);
47    template <class Alloc> stack(const container_type& c, const Alloc& a);
48    template <class Alloc> stack(container_type&& c, const Alloc& a);
49    template <class Alloc> stack(const stack& c, const Alloc& a);
50    template <class Alloc> stack(stack&& c, const Alloc& a);
51    template<class InputIterator, class Alloc>
52    stack(InputIterator first, InputIterator last, const Alloc&); // since C++23
53    template<container-compatible-range<T> R, class Alloc>
54      stack(from_range_t, R&& rg, const Alloc&); // since C++23
55
56    bool empty() const;
57    size_type size() const;
58    reference top();
59    const_reference top() const;
60
61    void push(const value_type& x);
62    void push(value_type&& x);
63    template<container-compatible-range<T> R>
64      void push_range(R&& rg); // C++23
65    template <class... Args> reference emplace(Args&&... args); // reference in C++17
66    void pop();
67
68    void swap(stack& c) noexcept(is_nothrow_swappable_v<Container>)
69};
70
71template<class Container>
72  stack(Container) -> stack<typename Container::value_type, Container>;  // C++17
73
74template<class InputIterator>
75  stack(InputIterator, InputIterator) -> stack<iter-value-type<InputIterator>>; // since C++23
76
77template<ranges::input_range R>
78  stack(from_range_t, R&&) -> stack<ranges::range_value_t<R>>; // since C++23
79
80template<class Container, class Allocator>
81  stack(Container, Allocator) -> stack<typename Container::value_type, Container>; // C++17
82
83template<class InputIterator, class Allocator>
84  stack(InputIterator, InputIterator, Allocator)
85    -> stack<iter-value-type<InputIterator>,
86             deque<iter-value-type<InputIterator>, Allocator>>; // since C++23
87
88template<ranges::input_range R, class Allocator>
89  stack(from_range_t, R&&, Allocator)
90    -> stack<ranges::range_value_t<R>, deque<ranges::range_value_t<R>, Allocator>>; // since C++23
91
92template <class T, class Container>
93  bool operator==(const stack<T, Container>& x, const stack<T, Container>& y);
94template <class T, class Container>
95  bool operator< (const stack<T, Container>& x, const stack<T, Container>& y);
96template <class T, class Container>
97  bool operator!=(const stack<T, Container>& x, const stack<T, Container>& y);
98template <class T, class Container>
99  bool operator> (const stack<T, Container>& x, const stack<T, Container>& y);
100template <class T, class Container>
101  bool operator>=(const stack<T, Container>& x, const stack<T, Container>& y);
102template <class T, class Container>
103  bool operator<=(const stack<T, Container>& x, const stack<T, Container>& y);
104template<class T, three_way_comparable Container>
105  compare_three_way_result_t<Container>
106    operator<=>(const stack<T, Container>& x, const stack<T, Container>& y); // since C++20
107
108template <class T, class Container>
109  void swap(stack<T, Container>& x, stack<T, Container>& y)
110  noexcept(noexcept(x.swap(y)));
111
112}  // std
113
114*/
115
116#include <__algorithm/ranges_copy.h>
117#include <__assert> // all public C++ headers provide the assertion handler
118#include <__config>
119#include <__iterator/back_insert_iterator.h>
120#include <__iterator/iterator_traits.h>
121#include <__memory/uses_allocator.h>
122#include <__ranges/access.h>
123#include <__ranges/concepts.h>
124#include <__ranges/container_compatible_range.h>
125#include <__ranges/from_range.h>
126#include <__type_traits/is_same.h>
127#include <__utility/forward.h>
128#include <deque>
129#include <version>
130
131// standard-mandated includes
132
133// [stack.syn]
134#include <compare>
135#include <initializer_list>
136
137#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
138#  pragma GCC system_header
139#endif
140
141_LIBCPP_BEGIN_NAMESPACE_STD
142
143template <class _Tp, class _Container = deque<_Tp> >
144class _LIBCPP_TEMPLATE_VIS stack;
145
146template <class _Tp, class _Container>
147_LIBCPP_HIDE_FROM_ABI bool operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
148
149template <class _Tp, class _Container>
150_LIBCPP_HIDE_FROM_ABI bool operator<(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
151
152template <class _Tp, class _Container /*= deque<_Tp>*/>
153class _LIBCPP_TEMPLATE_VIS stack {
154public:
155  typedef _Container container_type;
156  typedef typename container_type::value_type value_type;
157  typedef typename container_type::reference reference;
158  typedef typename container_type::const_reference const_reference;
159  typedef typename container_type::size_type size_type;
160  static_assert((is_same<_Tp, value_type>::value), "");
161
162protected:
163  container_type c;
164
165public:
166  _LIBCPP_HIDE_FROM_ABI stack() _NOEXCEPT_(is_nothrow_default_constructible<container_type>::value) : c() {}
167
168  _LIBCPP_HIDE_FROM_ABI stack(const stack& __q) : c(__q.c) {}
169
170  _LIBCPP_HIDE_FROM_ABI stack& operator=(const stack& __q) {
171    c = __q.c;
172    return *this;
173  }
174
175#ifndef _LIBCPP_CXX03_LANG
176  _LIBCPP_HIDE_FROM_ABI stack(stack&& __q) _NOEXCEPT_(is_nothrow_move_constructible<container_type>::value)
177      : c(std::move(__q.c)) {}
178
179  _LIBCPP_HIDE_FROM_ABI stack& operator=(stack&& __q) _NOEXCEPT_(is_nothrow_move_assignable<container_type>::value) {
180    c = std::move(__q.c);
181    return *this;
182  }
183
184  _LIBCPP_HIDE_FROM_ABI explicit stack(container_type&& __c) : c(std::move(__c)) {}
185#endif // _LIBCPP_CXX03_LANG
186
187  _LIBCPP_HIDE_FROM_ABI explicit stack(const container_type& __c) : c(__c) {}
188
189  template <class _Alloc>
190  _LIBCPP_HIDE_FROM_ABI explicit stack(const _Alloc& __a,
191                                       __enable_if_t<uses_allocator<container_type, _Alloc>::value>* = 0)
192      : c(__a) {}
193  template <class _Alloc>
194  _LIBCPP_HIDE_FROM_ABI
195  stack(const container_type& __c, const _Alloc& __a, __enable_if_t<uses_allocator<container_type, _Alloc>::value>* = 0)
196      : c(__c, __a) {}
197  template <class _Alloc>
198  _LIBCPP_HIDE_FROM_ABI
199  stack(const stack& __s, const _Alloc& __a, __enable_if_t<uses_allocator<container_type, _Alloc>::value>* = 0)
200      : c(__s.c, __a) {}
201#ifndef _LIBCPP_CXX03_LANG
202  template <class _Alloc>
203  _LIBCPP_HIDE_FROM_ABI
204  stack(container_type&& __c, const _Alloc& __a, __enable_if_t<uses_allocator<container_type, _Alloc>::value>* = 0)
205      : c(std::move(__c), __a) {}
206  template <class _Alloc>
207  _LIBCPP_HIDE_FROM_ABI
208  stack(stack&& __s, const _Alloc& __a, __enable_if_t<uses_allocator<container_type, _Alloc>::value>* = 0)
209      : c(std::move(__s.c), __a) {}
210#endif // _LIBCPP_CXX03_LANG
211
212#if _LIBCPP_STD_VER >= 23
213  template <class _InputIterator, class = __enable_if_t<__has_input_iterator_category<_InputIterator>::value>>
214  _LIBCPP_HIDE_FROM_ABI stack(_InputIterator __first, _InputIterator __last) : c(__first, __last) {}
215
216  template <_ContainerCompatibleRange<_Tp> _Range>
217  _LIBCPP_HIDE_FROM_ABI stack(from_range_t, _Range&& __range) : c(from_range, std::forward<_Range>(__range)) {}
218
219  template <class _InputIterator,
220            class _Alloc,
221            class = __enable_if_t<__has_input_iterator_category<_InputIterator>::value>,
222            class = __enable_if_t<uses_allocator<container_type, _Alloc>::value>>
223  _LIBCPP_HIDE_FROM_ABI stack(_InputIterator __first, _InputIterator __last, const _Alloc& __alloc)
224      : c(__first, __last, __alloc) {}
225
226  template <_ContainerCompatibleRange<_Tp> _Range,
227            class _Alloc,
228            class = __enable_if_t<uses_allocator<container_type, _Alloc>::value>>
229  _LIBCPP_HIDE_FROM_ABI stack(from_range_t, _Range&& __range, const _Alloc& __alloc)
230      : c(from_range, std::forward<_Range>(__range), __alloc) {}
231
232#endif
233
234  _LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_HIDE_FROM_ABI bool empty() const { return c.empty(); }
235  _LIBCPP_HIDE_FROM_ABI size_type size() const { return c.size(); }
236  _LIBCPP_HIDE_FROM_ABI reference top() { return c.back(); }
237  _LIBCPP_HIDE_FROM_ABI const_reference top() const { return c.back(); }
238
239  _LIBCPP_HIDE_FROM_ABI void push(const value_type& __v) { c.push_back(__v); }
240#ifndef _LIBCPP_CXX03_LANG
241  _LIBCPP_HIDE_FROM_ABI void push(value_type&& __v) { c.push_back(std::move(__v)); }
242
243#  if _LIBCPP_STD_VER >= 23
244  template <_ContainerCompatibleRange<_Tp> _Range>
245  _LIBCPP_HIDE_FROM_ABI void push_range(_Range&& __range) {
246    if constexpr (requires(container_type& __c) { __c.append_range(std::forward<_Range>(__range)); }) {
247      c.append_range(std::forward<_Range>(__range));
248    } else {
249      ranges::copy(std::forward<_Range>(__range), std::back_inserter(c));
250    }
251  }
252#  endif
253
254  template <class... _Args>
255  _LIBCPP_HIDE_FROM_ABI
256#  if _LIBCPP_STD_VER >= 17
257      decltype(auto)
258      emplace(_Args&&... __args) {
259    return c.emplace_back(std::forward<_Args>(__args)...);
260  }
261#  else
262      void
263      emplace(_Args&&... __args) {
264    c.emplace_back(std::forward<_Args>(__args)...);
265  }
266#  endif
267#endif // _LIBCPP_CXX03_LANG
268
269  _LIBCPP_HIDE_FROM_ABI void pop() { c.pop_back(); }
270
271  _LIBCPP_HIDE_FROM_ABI void swap(stack& __s) _NOEXCEPT_(__is_nothrow_swappable<container_type>::value) {
272    using std::swap;
273    swap(c, __s.c);
274  }
275
276  _LIBCPP_NODISCARD _LIBCPP_HIDE_FROM_ABI const _Container& __get_container() const { return c; }
277
278  template <class _T1, class _OtherContainer>
279  friend bool operator==(const stack<_T1, _OtherContainer>& __x, const stack<_T1, _OtherContainer>& __y);
280
281  template <class _T1, class _OtherContainer>
282  friend bool operator<(const stack<_T1, _OtherContainer>& __x, const stack<_T1, _OtherContainer>& __y);
283};
284
285#if _LIBCPP_STD_VER >= 17
286template <class _Container, class = enable_if_t<!__is_allocator<_Container>::value> >
287stack(_Container) -> stack<typename _Container::value_type, _Container>;
288
289template <class _Container,
290          class _Alloc,
291          class = enable_if_t<!__is_allocator<_Container>::value>,
292          class = enable_if_t<uses_allocator<_Container, _Alloc>::value> >
293stack(_Container, _Alloc) -> stack<typename _Container::value_type, _Container>;
294#endif
295
296#if _LIBCPP_STD_VER >= 23
297template <class _InputIterator, class = __enable_if_t<__has_input_iterator_category<_InputIterator>::value>>
298stack(_InputIterator, _InputIterator) -> stack<__iter_value_type<_InputIterator>>;
299
300template <ranges::input_range _Range>
301stack(from_range_t, _Range&&) -> stack<ranges::range_value_t<_Range>>;
302
303template <class _InputIterator,
304          class _Alloc,
305          class = __enable_if_t<__has_input_iterator_category<_InputIterator>::value>,
306          class = __enable_if_t<__is_allocator<_Alloc>::value>>
307stack(_InputIterator, _InputIterator, _Alloc)
308    -> stack<__iter_value_type<_InputIterator>, deque<__iter_value_type<_InputIterator>, _Alloc>>;
309
310template <ranges::input_range _Range, class _Alloc, class = __enable_if_t<__is_allocator<_Alloc>::value>>
311stack(from_range_t, _Range&&, _Alloc)
312    -> stack<ranges::range_value_t<_Range>, deque<ranges::range_value_t<_Range>, _Alloc>>;
313
314#endif
315
316template <class _Tp, class _Container>
317inline _LIBCPP_HIDE_FROM_ABI bool operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y) {
318  return __x.c == __y.c;
319}
320
321template <class _Tp, class _Container>
322inline _LIBCPP_HIDE_FROM_ABI bool operator<(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y) {
323  return __x.c < __y.c;
324}
325
326template <class _Tp, class _Container>
327inline _LIBCPP_HIDE_FROM_ABI bool operator!=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y) {
328  return !(__x == __y);
329}
330
331template <class _Tp, class _Container>
332inline _LIBCPP_HIDE_FROM_ABI bool operator>(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y) {
333  return __y < __x;
334}
335
336template <class _Tp, class _Container>
337inline _LIBCPP_HIDE_FROM_ABI bool operator>=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y) {
338  return !(__x < __y);
339}
340
341template <class _Tp, class _Container>
342inline _LIBCPP_HIDE_FROM_ABI bool operator<=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y) {
343  return !(__y < __x);
344}
345
346#if _LIBCPP_STD_VER >= 20
347
348template <class _Tp, three_way_comparable _Container>
349_LIBCPP_HIDE_FROM_ABI compare_three_way_result_t<_Container>
350operator<=>(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y) {
351  // clang 16 bug: declaring `friend operator<=>` causes "use of overloaded operator '*' is ambiguous" errors
352  return __x.__get_container() <=> __y.__get_container();
353}
354
355#endif
356
357template <class _Tp, class _Container, __enable_if_t<__is_swappable<_Container>::value, int> = 0>
358inline _LIBCPP_HIDE_FROM_ABI void swap(stack<_Tp, _Container>& __x, stack<_Tp, _Container>& __y)
359    _NOEXCEPT_(_NOEXCEPT_(__x.swap(__y))) {
360  __x.swap(__y);
361}
362
363template <class _Tp, class _Container, class _Alloc>
364struct _LIBCPP_TEMPLATE_VIS uses_allocator<stack<_Tp, _Container>, _Alloc> : public uses_allocator<_Container, _Alloc> {
365};
366
367_LIBCPP_END_NAMESPACE_STD
368
369#if !defined(_LIBCPP_REMOVE_TRANSITIVE_INCLUDES) && _LIBCPP_STD_VER <= 20
370#  include <concepts>
371#  include <functional>
372#  include <type_traits>
373#endif
374
375#endif // _LIBCPP_STACK
376