xref: /freebsd-12.1/contrib/libc++/include/stack (revision 2b375b4e) 
1// -*- C++ -*-
2//===---------------------------- stack -----------------------------------===//
3//
4//                     The LLVM Compiler Infrastructure
5//
6// This file is dual licensed under the MIT and the University of Illinois Open
7// Source Licenses. See LICENSE.TXT for details.
8//
9//===----------------------------------------------------------------------===//
10
11#ifndef _LIBCPP_STACK
12#define _LIBCPP_STACK
13
14/*
15    stack synopsis
16
17namespace std
18{
19
20template <class T, class Container = deque<T>>
21class stack
22{
23public:
24    typedef Container                                container_type;
25    typedef typename container_type::value_type      value_type;
26    typedef typename container_type::reference       reference;
27    typedef typename container_type::const_reference const_reference;
28    typedef typename container_type::size_type       size_type;
29
30protected:
31    container_type c;
32
33public:
34    stack() = default;
35    ~stack() = default;
36
37    stack(const stack& q) = default;
38    stack(stack&& q) = default;
39
40    stack& operator=(const stack& q) = default;
41    stack& operator=(stack&& q) = default;
42
43    explicit stack(const container_type& c);
44    explicit stack(container_type&& c);
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
51    bool empty() const;
52    size_type size() const;
53    reference top();
54    const_reference top() const;
55
56    void push(const value_type& x);
57    void push(value_type&& x);
58    template <class... Args> void emplace(Args&&... args);
59    void pop();
60
61    void swap(stack& c) noexcept(is_nothrow_swappable_v<Container>)
62};
63
64template <class T, class Container>
65  bool operator==(const stack<T, Container>& x, const stack<T, Container>& y);
66template <class T, class Container>
67  bool operator< (const stack<T, Container>& x, const stack<T, Container>& y);
68template <class T, class Container>
69  bool operator!=(const stack<T, Container>& x, const stack<T, Container>& y);
70template <class T, class Container>
71  bool operator> (const stack<T, Container>& x, const stack<T, Container>& y);
72template <class T, class Container>
73  bool operator>=(const stack<T, Container>& x, const stack<T, Container>& y);
74template <class T, class Container>
75  bool operator<=(const stack<T, Container>& x, const stack<T, Container>& y);
76
77template <class T, class Container>
78  void swap(stack<T, Container>& x, stack<T, Container>& y)
79  noexcept(noexcept(x.swap(y)));
80
81}  // std
82
83*/
84
85#include <__config>
86#include <deque>
87
88#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
89#pragma GCC system_header
90#endif
91
92_LIBCPP_BEGIN_NAMESPACE_STD
93
94template <class _Tp, class _Container = deque<_Tp> > class _LIBCPP_TYPE_VIS_ONLY stack;
95
96template <class _Tp, class _Container>
97_LIBCPP_INLINE_VISIBILITY
98bool
99operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
100
101template <class _Tp, class _Container>
102_LIBCPP_INLINE_VISIBILITY
103bool
104operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
105
106template <class _Tp, class _Container /*= deque<_Tp>*/>
107class _LIBCPP_TYPE_VIS_ONLY stack
108{
109public:
110    typedef _Container                               container_type;
111    typedef typename container_type::value_type      value_type;
112    typedef typename container_type::reference       reference;
113    typedef typename container_type::const_reference const_reference;
114    typedef typename container_type::size_type       size_type;
115    static_assert((is_same<_Tp, value_type>::value), "" );
116
117protected:
118    container_type c;
119
120public:
121    _LIBCPP_INLINE_VISIBILITY
122    stack()
123        _NOEXCEPT_(is_nothrow_default_constructible<container_type>::value)
124        : c() {}
125
126    _LIBCPP_INLINE_VISIBILITY
127    stack(const stack& __q) : c(__q.c) {}
128
129#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
130    _LIBCPP_INLINE_VISIBILITY
131    stack(stack&& __q)
132        _NOEXCEPT_(is_nothrow_move_constructible<container_type>::value)
133        : c(_VSTD::move(__q.c)) {}
134#endif  // _LIBCPP_HAS_NO_RVALUE_REFERENCES
135
136    _LIBCPP_INLINE_VISIBILITY
137    stack& operator=(const stack& __q) {c = __q.c; return *this;}
138
139#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
140    _LIBCPP_INLINE_VISIBILITY
141    stack& operator=(stack&& __q)
142        _NOEXCEPT_(is_nothrow_move_assignable<container_type>::value)
143        {c = _VSTD::move(__q.c); return *this;}
144#endif  // _LIBCPP_HAS_NO_RVALUE_REFERENCES
145
146    _LIBCPP_INLINE_VISIBILITY
147    explicit stack(const container_type& __c) : c(__c) {}
148#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
149    _LIBCPP_INLINE_VISIBILITY
150    explicit stack(container_type&& __c) : c(_VSTD::move(__c)) {}
151#endif  // _LIBCPP_HAS_NO_RVALUE_REFERENCES
152    template <class _Alloc>
153        _LIBCPP_INLINE_VISIBILITY
154        explicit stack(const _Alloc& __a,
155                       typename enable_if<uses_allocator<container_type,
156                                                         _Alloc>::value>::type* = 0)
157            : c(__a) {}
158    template <class _Alloc>
159        _LIBCPP_INLINE_VISIBILITY
160        stack(const container_type& __c, const _Alloc& __a,
161              typename enable_if<uses_allocator<container_type,
162                                                _Alloc>::value>::type* = 0)
163            : c(__c, __a) {}
164    template <class _Alloc>
165        _LIBCPP_INLINE_VISIBILITY
166        stack(const stack& __s, const _Alloc& __a,
167              typename enable_if<uses_allocator<container_type,
168                                                _Alloc>::value>::type* = 0)
169            : c(__s.c, __a) {}
170#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
171    template <class _Alloc>
172        _LIBCPP_INLINE_VISIBILITY
173        stack(container_type&& __c, const _Alloc& __a,
174              typename enable_if<uses_allocator<container_type,
175                                                _Alloc>::value>::type* = 0)
176            : c(_VSTD::move(__c), __a) {}
177    template <class _Alloc>
178        _LIBCPP_INLINE_VISIBILITY
179        stack(stack&& __s, const _Alloc& __a,
180              typename enable_if<uses_allocator<container_type,
181                                                _Alloc>::value>::type* = 0)
182            : c(_VSTD::move(__s.c), __a) {}
183#endif  // _LIBCPP_HAS_NO_RVALUE_REFERENCES
184
185    _LIBCPP_INLINE_VISIBILITY
186    bool empty()     const      {return c.empty();}
187    _LIBCPP_INLINE_VISIBILITY
188    size_type size() const      {return c.size();}
189    _LIBCPP_INLINE_VISIBILITY
190    reference top()             {return c.back();}
191    _LIBCPP_INLINE_VISIBILITY
192    const_reference top() const {return c.back();}
193
194    _LIBCPP_INLINE_VISIBILITY
195    void push(const value_type& __v) {c.push_back(__v);}
196#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
197    _LIBCPP_INLINE_VISIBILITY
198    void push(value_type&& __v) {c.push_back(_VSTD::move(__v));}
199#ifndef _LIBCPP_HAS_NO_VARIADICS
200    template <class... _Args>
201        _LIBCPP_INLINE_VISIBILITY
202        void emplace(_Args&&... __args)
203        {c.emplace_back(_VSTD::forward<_Args>(__args)...);}
204#endif  // _LIBCPP_HAS_NO_VARIADICS
205#endif  // _LIBCPP_HAS_NO_RVALUE_REFERENCES
206    _LIBCPP_INLINE_VISIBILITY
207    void pop() {c.pop_back();}
208
209    _LIBCPP_INLINE_VISIBILITY
210    void swap(stack& __s)
211        _NOEXCEPT_(__is_nothrow_swappable<container_type>::value)
212    {
213        using _VSTD::swap;
214        swap(c, __s.c);
215    }
216
217    template <class T1, class _C1>
218    friend
219    bool
220    operator==(const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
221
222    template <class T1, class _C1>
223    friend
224    bool
225    operator< (const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
226};
227
228template <class _Tp, class _Container>
229inline _LIBCPP_INLINE_VISIBILITY
230bool
231operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
232{
233    return __x.c == __y.c;
234}
235
236template <class _Tp, class _Container>
237inline _LIBCPP_INLINE_VISIBILITY
238bool
239operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
240{
241    return __x.c < __y.c;
242}
243
244template <class _Tp, class _Container>
245inline _LIBCPP_INLINE_VISIBILITY
246bool
247operator!=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
248{
249    return !(__x == __y);
250}
251
252template <class _Tp, class _Container>
253inline _LIBCPP_INLINE_VISIBILITY
254bool
255operator> (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
256{
257    return __y < __x;
258}
259
260template <class _Tp, class _Container>
261inline _LIBCPP_INLINE_VISIBILITY
262bool
263operator>=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
264{
265    return !(__x < __y);
266}
267
268template <class _Tp, class _Container>
269inline _LIBCPP_INLINE_VISIBILITY
270bool
271operator<=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
272{
273    return !(__y < __x);
274}
275
276template <class _Tp, class _Container>
277inline _LIBCPP_INLINE_VISIBILITY
278typename enable_if<
279    __is_swappable<_Container>::value,
280    void
281>::type
282swap(stack<_Tp, _Container>& __x, stack<_Tp, _Container>& __y)
283    _NOEXCEPT_(_NOEXCEPT_(__x.swap(__y)))
284{
285    __x.swap(__y);
286}
287
288template <class _Tp, class _Container, class _Alloc>
289struct _LIBCPP_TYPE_VIS_ONLY uses_allocator<stack<_Tp, _Container>, _Alloc>
290    : public uses_allocator<_Container, _Alloc>
291{
292};
293
294_LIBCPP_END_NAMESPACE_STD
295
296#endif  // _LIBCPP_STACK
297