]> git.ipfire.org Git - thirdparty/gcc.git/blame - libstdc++-v3/include/bits/move.h
Daily bump.
[thirdparty/gcc.git] / libstdc++-v3 / include / bits / move.h
CommitLineData
4f5f9962 1// Move, forward and identity for C++11 + swap -*- C++ -*-
1476e59c 2
cbe34bb5 3// Copyright (C) 2007-2017 Free Software Foundation, Inc.
1476e59c
PC
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
748086b7 8// Free Software Foundation; either version 3, or (at your option)
1476e59c
PC
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
748086b7
JJ
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/>.
1476e59c 24
f910786b 25/** @file bits/move.h
1476e59c 26 * This is an internal header file, included by other library headers.
f910786b 27 * Do not attempt to use it directly. @headername{utility}
1476e59c
PC
28 */
29
caa8b3c6
PC
30#ifndef _MOVE_H
31#define _MOVE_H 1
1476e59c 32
e14e932b
PC
33#include <bits/c++config.h>
34#include <bits/concept_check.h>
35
12ffa228
BK
36namespace std _GLIBCXX_VISIBILITY(default)
37{
38_GLIBCXX_BEGIN_NAMESPACE_VERSION
882b3d5c
PC
39
40 // Used, in C++03 mode too, by allocators, etc.
13901e4b
JW
41 /**
42 * @brief Same as C++11 std::addressof
43 * @ingroup utilities
44 */
882b3d5c 45 template<typename _Tp>
9e023e33 46 inline _GLIBCXX_CONSTEXPR _Tp*
5d861bf2 47 __addressof(_Tp& __r) _GLIBCXX_NOEXCEPT
9e023e33 48 { return __builtin_addressof(__r); }
882b3d5c 49
12ffa228
BK
50_GLIBCXX_END_NAMESPACE_VERSION
51} // namespace
882b3d5c 52
734f5023 53#if __cplusplus >= 201103L
7274deff 54#include <type_traits> // Brings in std::declval too.
1476e59c 55
12ffa228
BK
56namespace std _GLIBCXX_VISIBILITY(default)
57{
58_GLIBCXX_BEGIN_NAMESPACE_VERSION
13901e4b
JW
59
60 /**
61 * @addtogroup utilities
62 * @{
63 */
64
13901e4b
JW
65 /**
66 * @brief Forward an lvalue.
67 * @return The parameter cast to the specified type.
68 *
69 * This function is used to implement "perfect forwarding".
70 */
4c7aaebf 71 template<typename _Tp>
a4eeb822 72 constexpr _Tp&&
5d861bf2 73 forward(typename std::remove_reference<_Tp>::type& __t) noexcept
4c7aaebf
PC
74 { return static_cast<_Tp&&>(__t); }
75
13901e4b
JW
76 /**
77 * @brief Forward an rvalue.
78 * @return The parameter cast to the specified type.
79 *
80 * This function is used to implement "perfect forwarding".
81 */
4c7aaebf 82 template<typename _Tp>
a4eeb822 83 constexpr _Tp&&
5d861bf2 84 forward(typename std::remove_reference<_Tp>::type&& __t) noexcept
ad269884
PC
85 {
86 static_assert(!std::is_lvalue_reference<_Tp>::value, "template argument"
87 " substituting _Tp is an lvalue reference type");
88 return static_cast<_Tp&&>(__t);
89 }
e7f1930f 90
fd9380a6 91 /**
13901e4b 92 * @brief Convert a value to an rvalue.
fd9380a6 93 * @param __t A thing of arbitrary type.
13901e4b 94 * @return The parameter cast to an rvalue-reference to allow moving it.
fd9380a6 95 */
1476e59c 96 template<typename _Tp>
a4eeb822 97 constexpr typename std::remove_reference<_Tp>::type&&
5d861bf2 98 move(_Tp&& __t) noexcept
e7f1930f 99 { return static_cast<typename std::remove_reference<_Tp>::type&&>(__t); }
1476e59c 100
74a2a1b4
PC
101
102 template<typename _Tp>
103 struct __move_if_noexcept_cond
104 : public __and_<__not_<is_nothrow_move_constructible<_Tp>>,
105 is_copy_constructible<_Tp>>::type { };
106
1f428429 107 /**
13901e4b 108 * @brief Conditionally convert a value to an rvalue.
1f428429 109 * @param __x A thing of arbitrary type.
13901e4b
JW
110 * @return The parameter, possibly cast to an rvalue-reference.
111 *
112 * Same as std::move unless the type's move constructor could throw and the
113 * type is copyable, in which case an lvalue-reference is returned instead.
1f428429
PC
114 */
115 template<typename _Tp>
fa409833 116 constexpr typename
74a2a1b4 117 conditional<__move_if_noexcept_cond<_Tp>::value, const _Tp&, _Tp&&>::type
1f428429
PC
118 move_if_noexcept(_Tp& __x) noexcept
119 { return std::move(__x); }
120
13901e4b 121 // declval, from type_traits.
7274deff 122
9e023e33
JW
123#if __cplusplus > 201402L
124 // _GLIBCXX_RESOLVE_LIB_DEFECTS
125 // 2296. std::addressof should be constexpr
126# define __cpp_lib_addressof_constexpr 201603
127#endif
882b3d5c
PC
128 /**
129 * @brief Returns the actual address of the object or function
130 * referenced by r, even in the presence of an overloaded
131 * operator&.
132 * @param __r Reference to an object or function.
133 * @return The actual address.
134 */
135 template<typename _Tp>
9e023e33 136 inline _GLIBCXX17_CONSTEXPR _Tp*
5d861bf2 137 addressof(_Tp& __r) noexcept
882b3d5c
PC
138 { return std::__addressof(__r); }
139
3ce96851
JW
140 // _GLIBCXX_RESOLVE_LIB_DEFECTS
141 // 2598. addressof works on temporaries
142 template<typename _Tp>
143 const _Tp* addressof(const _Tp&&) = delete;
144
9b817548
JW
145 // C++11 version of std::exchange for internal use.
146 template <typename _Tp, typename _Up = _Tp>
147 inline _Tp
148 __exchange(_Tp& __obj, _Up&& __new_val)
149 {
150 _Tp __old_val = std::move(__obj);
151 __obj = std::forward<_Up>(__new_val);
152 return __old_val;
153 }
154
13901e4b 155 /// @} group utilities
12ffa228
BK
156_GLIBCXX_END_NAMESPACE_VERSION
157} // namespace
1476e59c 158
5f1fd346 159#define _GLIBCXX_MOVE(__val) std::move(__val)
55dd8445 160#define _GLIBCXX_FORWARD(_Tp, __val) std::forward<_Tp>(__val)
d98f312c 161#else
5f1fd346 162#define _GLIBCXX_MOVE(__val) (__val)
55dd8445 163#define _GLIBCXX_FORWARD(_Tp, __val) (__val)
1476e59c
PC
164#endif
165
12ffa228
BK
166namespace std _GLIBCXX_VISIBILITY(default)
167{
168_GLIBCXX_BEGIN_NAMESPACE_VERSION
e14e932b 169
13901e4b
JW
170 /**
171 * @addtogroup utilities
172 * @{
173 */
174
e14e932b
PC
175 /**
176 * @brief Swaps two values.
fd9380a6
BK
177 * @param __a A thing of arbitrary type.
178 * @param __b Another thing of arbitrary type.
e14e932b
PC
179 * @return Nothing.
180 */
181 template<typename _Tp>
ddb63209 182 inline
734f5023 183#if __cplusplus >= 201103L
a2863bde
VV
184 typename enable_if<__and_<__not_<__is_tuple_like<_Tp>>,
185 is_move_constructible<_Tp>,
ddb63209
VV
186 is_move_assignable<_Tp>>::value>::type
187 swap(_Tp& __a, _Tp& __b)
6f59ea25
PC
188 noexcept(__and_<is_nothrow_move_constructible<_Tp>,
189 is_nothrow_move_assignable<_Tp>>::value)
ddb63209
VV
190#else
191 void
192 swap(_Tp& __a, _Tp& __b)
173f26ae 193#endif
e14e932b
PC
194 {
195 // concept requirements
196 __glibcxx_function_requires(_SGIAssignableConcept<_Tp>)
197
198 _Tp __tmp = _GLIBCXX_MOVE(__a);
199 __a = _GLIBCXX_MOVE(__b);
200 __b = _GLIBCXX_MOVE(__tmp);
201 }
202
caa8b3c6
PC
203 // _GLIBCXX_RESOLVE_LIB_DEFECTS
204 // DR 809. std::swap should be overloaded for array types.
13901e4b 205 /// Swap the contents of two arrays.
caa8b3c6 206 template<typename _Tp, size_t _Nm>
ddb63209 207 inline
734f5023 208#if __cplusplus >= 201103L
26b5ace7 209 typename enable_if<__is_swappable<_Tp>::value>::type
ddb63209 210 swap(_Tp (&__a)[_Nm], _Tp (&__b)[_Nm])
26b5ace7 211 noexcept(__is_nothrow_swappable<_Tp>::value)
ddb63209
VV
212#else
213 void
214 swap(_Tp (&__a)[_Nm], _Tp (&__b)[_Nm])
ccb4f5a7 215#endif
caa8b3c6
PC
216 {
217 for (size_t __n = 0; __n < _Nm; ++__n)
218 swap(__a[__n], __b[__n]);
219 }
220
13901e4b 221 /// @} group utilities
12ffa228
BK
222_GLIBCXX_END_NAMESPACE_VERSION
223} // namespace
e14e932b 224
caa8b3c6 225#endif /* _MOVE_H */