xref: /freebsd/contrib/llvm-project/libcxx/include/stack (revision 38a52bd3b5cac3da6f7f6eef3dd050e6aa08ebb3) 
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 <class Alloc> explicit stack(const Alloc& a);
46    template <class Alloc> stack(const container_type& c, const Alloc& a);
47    template <class Alloc> stack(container_type&& c, const Alloc& a);
48    template <class Alloc> stack(const stack& c, const Alloc& a);
49    template <class Alloc> stack(stack&& c, const Alloc& a);
50    template<class InputIterator, class Alloc>
51    stack(InputIterator first, InputIterator last, const Alloc&); // since C++23
52
53    bool empty() const;
54    size_type size() const;
55    reference top();
56    const_reference top() const;
57
58    void push(const value_type& x);
59    void push(value_type&& x);
60    template <class... Args> reference emplace(Args&&... args); // reference in C++17
61    void pop();
62
63    void swap(stack& c) noexcept(is_nothrow_swappable_v<Container>)
64};
65
66template<class Container>
67  stack(Container) -> stack<typename Container::value_type, Container>;  // C++17
68
69template<class InputIterator>
70  stack(InputIterator, InputIterator) -> stack<iter-value-type<InputIterator>>; // since C++23
71
72template<class Container, class Allocator>
73  stack(Container, Allocator) -> stack<typename Container::value_type, Container>; // C++17
74
75template<class InputIterator, class Allocator>
76  stack(InputIterator, InputIterator, Allocator)
77    -> stack<iter-value-type<InputIterator>,
78             deque<iter-value-type<InputIterator>, Allocator>>; // since C++23
79
80template <class T, class Container>
81  bool operator==(const stack<T, Container>& x, const stack<T, Container>& y);
82template <class T, class Container>
83  bool operator< (const stack<T, Container>& x, const stack<T, Container>& y);
84template <class T, class Container>
85  bool operator!=(const stack<T, Container>& x, const stack<T, Container>& y);
86template <class T, class Container>
87  bool operator> (const stack<T, Container>& x, const stack<T, Container>& y);
88template <class T, class Container>
89  bool operator>=(const stack<T, Container>& x, const stack<T, Container>& y);
90template <class T, class Container>
91  bool operator<=(const stack<T, Container>& x, const stack<T, Container>& y);
92
93template <class T, class Container>
94  void swap(stack<T, Container>& x, stack<T, Container>& y)
95  noexcept(noexcept(x.swap(y)));
96
97}  // std
98
99*/
100
101#include <__config>
102#include <__iterator/iterator_traits.h>
103#include <__memory/uses_allocator.h>
104#include <__utility/forward.h>
105#include <deque>
106#include <type_traits>
107#include <version>
108
109#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
110#pragma GCC system_header
111#endif
112
113_LIBCPP_BEGIN_NAMESPACE_STD
114
115template <class _Tp, class _Container = deque<_Tp> > class _LIBCPP_TEMPLATE_VIS stack;
116
117template <class _Tp, class _Container>
118_LIBCPP_INLINE_VISIBILITY
119bool
120operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
121
122template <class _Tp, class _Container>
123_LIBCPP_INLINE_VISIBILITY
124bool
125operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
126
127template <class _Tp, class _Container /*= deque<_Tp>*/>
128class _LIBCPP_TEMPLATE_VIS stack
129{
130public:
131    typedef _Container                               container_type;
132    typedef typename container_type::value_type      value_type;
133    typedef typename container_type::reference       reference;
134    typedef typename container_type::const_reference const_reference;
135    typedef typename container_type::size_type       size_type;
136    static_assert((is_same<_Tp, value_type>::value), "" );
137
138protected:
139    container_type c;
140
141public:
142    _LIBCPP_INLINE_VISIBILITY
143    stack()
144        _NOEXCEPT_(is_nothrow_default_constructible<container_type>::value)
145        : c() {}
146
147    _LIBCPP_INLINE_VISIBILITY
148    stack(const stack& __q) : c(__q.c) {}
149
150    _LIBCPP_INLINE_VISIBILITY
151    stack& operator=(const stack& __q) {c = __q.c; return *this;}
152
153
154#ifndef _LIBCPP_CXX03_LANG
155    _LIBCPP_INLINE_VISIBILITY
156    stack(stack&& __q)
157        _NOEXCEPT_(is_nothrow_move_constructible<container_type>::value)
158        : c(_VSTD::move(__q.c)) {}
159
160    _LIBCPP_INLINE_VISIBILITY
161    stack& operator=(stack&& __q)
162        _NOEXCEPT_(is_nothrow_move_assignable<container_type>::value)
163        {c = _VSTD::move(__q.c); return *this;}
164
165    _LIBCPP_INLINE_VISIBILITY
166    explicit stack(container_type&& __c) : c(_VSTD::move(__c)) {}
167#endif // _LIBCPP_CXX03_LANG
168
169    _LIBCPP_INLINE_VISIBILITY
170    explicit stack(const container_type& __c) : c(__c) {}
171
172    template <class _Alloc>
173        _LIBCPP_INLINE_VISIBILITY
174        explicit stack(const _Alloc& __a,
175                       __enable_if_t<uses_allocator<container_type, _Alloc>::value>* = 0)
176            : c(__a) {}
177    template <class _Alloc>
178        _LIBCPP_INLINE_VISIBILITY
179        stack(const container_type& __c, const _Alloc& __a,
180              __enable_if_t<uses_allocator<container_type, _Alloc>::value>* = 0)
181            : c(__c, __a) {}
182    template <class _Alloc>
183        _LIBCPP_INLINE_VISIBILITY
184        stack(const stack& __s, const _Alloc& __a,
185              __enable_if_t<uses_allocator<container_type, _Alloc>::value>* = 0)
186            : c(__s.c, __a) {}
187#ifndef _LIBCPP_CXX03_LANG
188    template <class _Alloc>
189        _LIBCPP_INLINE_VISIBILITY
190        stack(container_type&& __c, const _Alloc& __a,
191              __enable_if_t<uses_allocator<container_type, _Alloc>::value>* = 0)
192            : c(_VSTD::move(__c), __a) {}
193    template <class _Alloc>
194        _LIBCPP_INLINE_VISIBILITY
195        stack(stack&& __s, const _Alloc& __a,
196              __enable_if_t<uses_allocator<container_type, _Alloc>::value>* = 0)
197            : c(_VSTD::move(__s.c), __a) {}
198#endif // _LIBCPP_CXX03_LANG
199
200#if _LIBCPP_STD_VER > 20
201    template <class _InputIterator,
202              class = __enable_if_t<__is_cpp17_input_iterator<_InputIterator>::value>>
203    _LIBCPP_HIDE_FROM_ABI
204    stack(_InputIterator __first, _InputIterator __last) : c(__first, __last) {}
205
206    template <class _InputIterator,
207              class _Alloc,
208              class = __enable_if_t<__is_cpp17_input_iterator<_InputIterator>::value>,
209              class = __enable_if_t<uses_allocator<container_type, _Alloc>::value>>
210    _LIBCPP_HIDE_FROM_ABI
211    stack(_InputIterator __first, _InputIterator __last, const _Alloc& __alloc) : c(__first, __last, __alloc) {}
212#endif
213
214    _LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_INLINE_VISIBILITY
215    bool empty()     const      {return c.empty();}
216    _LIBCPP_INLINE_VISIBILITY
217    size_type size() const      {return c.size();}
218    _LIBCPP_INLINE_VISIBILITY
219    reference top()             {return c.back();}
220    _LIBCPP_INLINE_VISIBILITY
221    const_reference top() const {return c.back();}
222
223    _LIBCPP_INLINE_VISIBILITY
224    void push(const value_type& __v) {c.push_back(__v);}
225#ifndef _LIBCPP_CXX03_LANG
226    _LIBCPP_INLINE_VISIBILITY
227    void push(value_type&& __v) {c.push_back(_VSTD::move(__v));}
228
229    template <class... _Args>
230        _LIBCPP_INLINE_VISIBILITY
231#if _LIBCPP_STD_VER > 14
232        decltype(auto) emplace(_Args&&... __args)
233        { return c.emplace_back(_VSTD::forward<_Args>(__args)...);}
234#else
235        void      emplace(_Args&&... __args)
236        {        c.emplace_back(_VSTD::forward<_Args>(__args)...);}
237#endif
238#endif // _LIBCPP_CXX03_LANG
239
240    _LIBCPP_INLINE_VISIBILITY
241    void pop() {c.pop_back();}
242
243    _LIBCPP_INLINE_VISIBILITY
244    void swap(stack& __s)
245        _NOEXCEPT_(__is_nothrow_swappable<container_type>::value)
246    {
247        using _VSTD::swap;
248        swap(c, __s.c);
249    }
250
251    template <class T1, class _C1>
252    friend
253    bool
254    operator==(const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
255
256    template <class T1, class _C1>
257    friend
258    bool
259    operator< (const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
260};
261
262#if _LIBCPP_STD_VER > 14
263template<class _Container,
264         class = enable_if_t<!__is_allocator<_Container>::value>
265>
266stack(_Container)
267    -> stack<typename _Container::value_type, _Container>;
268
269template<class _Container,
270         class _Alloc,
271         class = enable_if_t<!__is_allocator<_Container>::value>,
272         class = enable_if_t<uses_allocator<_Container, _Alloc>::value>
273         >
274stack(_Container, _Alloc)
275    -> stack<typename _Container::value_type, _Container>;
276#endif
277
278#if _LIBCPP_STD_VER > 20
279template<class _InputIterator,
280         class = __enable_if_t<__is_cpp17_input_iterator<_InputIterator>::value>>
281stack(_InputIterator, _InputIterator)
282    -> stack<__iter_value_type<_InputIterator>>;
283
284template<class _InputIterator,
285         class _Alloc,
286         class = __enable_if_t<__is_cpp17_input_iterator<_InputIterator>::value>,
287         class = __enable_if_t<__is_allocator<_Alloc>::value>>
288stack(_InputIterator, _InputIterator, _Alloc)
289    -> stack<__iter_value_type<_InputIterator>, deque<__iter_value_type<_InputIterator>, _Alloc>>;
290#endif
291
292template <class _Tp, class _Container>
293inline _LIBCPP_INLINE_VISIBILITY
294bool
295operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
296{
297    return __x.c == __y.c;
298}
299
300template <class _Tp, class _Container>
301inline _LIBCPP_INLINE_VISIBILITY
302bool
303operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
304{
305    return __x.c < __y.c;
306}
307
308template <class _Tp, class _Container>
309inline _LIBCPP_INLINE_VISIBILITY
310bool
311operator!=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
312{
313    return !(__x == __y);
314}
315
316template <class _Tp, class _Container>
317inline _LIBCPP_INLINE_VISIBILITY
318bool
319operator> (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
320{
321    return __y < __x;
322}
323
324template <class _Tp, class _Container>
325inline _LIBCPP_INLINE_VISIBILITY
326bool
327operator>=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
328{
329    return !(__x < __y);
330}
331
332template <class _Tp, class _Container>
333inline _LIBCPP_INLINE_VISIBILITY
334bool
335operator<=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
336{
337    return !(__y < __x);
338}
339
340template <class _Tp, class _Container>
341inline _LIBCPP_INLINE_VISIBILITY
342__enable_if_t<__is_swappable<_Container>::value, void>
343swap(stack<_Tp, _Container>& __x, stack<_Tp, _Container>& __y)
344    _NOEXCEPT_(_NOEXCEPT_(__x.swap(__y)))
345{
346    __x.swap(__y);
347}
348
349template <class _Tp, class _Container, class _Alloc>
350struct _LIBCPP_TEMPLATE_VIS uses_allocator<stack<_Tp, _Container>, _Alloc>
351    : public uses_allocator<_Container, _Alloc>
352{
353};
354
355_LIBCPP_END_NAMESPACE_STD
356
357#endif // _LIBCPP_STACK
358