3 // Copyright (C) 2007, 2008 Free Software Foundation, Inc.
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 2, or (at your option)
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.
16 // You should have received a copy of the GNU General Public License
17 // along with this library; see the file COPYING. If not, write to
18 // the Free Software Foundation, 51 Franklin Street, Fifth Floor,
19 // Boston, MA 02110-1301, USA.
21 // As a special exception, you may use this file as part of a free software
22 // library without restriction. Specifically, if other files instantiate
23 // templates or use macros or inline functions from this file, or you compile
24 // this file and link it with other files to produce an executable, this
25 // file does not by itself cause the resulting executable to be covered by
26 // the GNU General Public License. This exception does not however
27 // invalidate any other reasons why the executable file might be covered by
28 // the GNU General Public License.
30 /** @file include/tuple
31 * This is a Standard C++ Library header.
34 #ifndef _GLIBCXX_CXX0X_TUPLE
35 #define _GLIBCXX_CXX0X_TUPLE 1
37 #pragma GCC system_header
39 #ifndef __GXX_EXPERIMENTAL_CXX0X__
40 # include <c++0x_warning.h>
47 // Adds a const reference to a non-reference type.
48 template<typename _Tp>
50 { typedef const _Tp& type; };
52 template<typename _Tp>
53 struct __add_c_ref<_Tp&>
54 { typedef _Tp& type; };
56 // Adds a reference to a non-reference type.
57 template<typename _Tp>
59 { typedef _Tp& type; };
61 template<typename _Tp>
62 struct __add_ref<_Tp&>
63 { typedef _Tp& type; };
65 template<int _Idx, typename _Head, bool _IsEmpty>
68 template<int _Idx, typename _Head>
69 struct _Head_base<_Idx, _Head, true>
75 _Head_base(const _Head& __h)
78 template<typename _UHead>
79 _Head_base(_UHead&& __h)
80 : _Head(std::forward<_UHead>(__h)) { }
82 _Head& _M_head() { return *this; }
83 const _Head& _M_head() const { return *this; }
86 template<int _Idx, typename _Head>
87 struct _Head_base<_Idx, _Head, false>
92 _Head_base(const _Head& __h)
93 : _M_head_impl(__h) { }
95 template<typename _UHead>
96 _Head_base(_UHead&& __h)
97 : _M_head_impl(std::forward<_UHead>(__h)) { }
99 _Head& _M_head() { return _M_head_impl; }
100 const _Head& _M_head() const { return _M_head_impl; }
106 * Contains the actual implementation of the @c tuple template, stored
107 * as a recursive inheritance hierarchy from the first element (most
108 * derived class) to the last (least derived class). The @c Idx
109 * parameter gives the 0-based index of the element stored at this
110 * point in the hierarchy; we use it to implement a constant-time
113 template<int _Idx, typename... _Elements>
117 * Zero-element tuple implementation. This is the basis case for the
118 * inheritance recursion.
121 struct _Tuple_impl<_Idx> { };
124 * Recursive tuple implementation. Here we store the @c Head element
125 * and derive from a @c Tuple_impl containing the remaining elements
126 * (which contains the @c Tail).
128 template<int _Idx, typename _Head, typename... _Tail>
129 struct _Tuple_impl<_Idx, _Head, _Tail...>
130 : public _Tuple_impl<_Idx + 1, _Tail...>,
131 private _Head_base<_Idx, _Head, std::is_empty<_Head>::value>
133 typedef _Tuple_impl<_Idx + 1, _Tail...> _Inherited;
134 typedef _Head_base<_Idx, _Head, std::is_empty<_Head>::value> _Base;
136 _Head& _M_head() { return _Base::_M_head(); }
137 const _Head& _M_head() const { return _Base::_M_head(); }
139 _Inherited& _M_tail() { return *this; }
140 const _Inherited& _M_tail() const { return *this; }
143 : _Inherited(), _Base() { }
146 _Tuple_impl(const _Head& __head, const _Tail&... __tail)
147 : _Inherited(__tail...), _Base(__head) { }
149 template<typename _UHead, typename... _UTail>
151 _Tuple_impl(_UHead&& __head, _UTail&&... __tail)
152 : _Inherited(std::forward<_UTail>(__tail)...),
153 _Base(std::forward<_UHead>(__head)) { }
155 _Tuple_impl(const _Tuple_impl& __in)
156 : _Inherited(__in._M_tail()), _Base(__in._M_head()) { }
158 _Tuple_impl(_Tuple_impl&& __in)
159 : _Inherited(std::move<_Inherited&&>(__in._M_tail())),
160 _Base(std::forward<_Head>(__in._M_head())) { }
162 template<typename... _UElements>
163 _Tuple_impl(const _Tuple_impl<_Idx, _UElements...>& __in)
164 : _Inherited(__in._M_tail()), _Base(__in._M_head()) { }
166 template<typename... _UElements>
167 _Tuple_impl(_Tuple_impl<_Idx, _UElements...>&& __in)
168 : _Inherited(std::move<typename _Tuple_impl<_Idx, _UElements...>::
169 _Inherited&&>(__in._M_tail())),
170 _Base(std::forward<typename _Tuple_impl<_Idx, _UElements...>::
171 _Base>(__in._M_head())) { }
174 operator=(const _Tuple_impl& __in)
176 _M_head() = __in._M_head();
177 _M_tail() = __in._M_tail();
182 operator=(_Tuple_impl&& __in)
184 _M_head() = std::move(__in._M_head());
185 _M_tail() = std::move(__in._M_tail());
189 template<typename... _UElements>
191 operator=(const _Tuple_impl<_Idx, _UElements...>& __in)
193 _M_head() = __in._M_head();
194 _M_tail() = __in._M_tail();
198 template<typename... _UElements>
200 operator=(_Tuple_impl<_Idx, _UElements...>&& __in)
202 _M_head() = std::move(__in._M_head());
203 _M_tail() = std::move(__in._M_tail());
209 template<typename... _Elements>
210 class tuple : public _Tuple_impl<0, _Elements...>
212 typedef _Tuple_impl<0, _Elements...> _Inherited;
219 tuple(const _Elements&... __elements)
220 : _Inherited(__elements...) { }
222 template<typename... _UElements>
224 tuple(_UElements&&... __elements)
225 : _Inherited(std::forward<_UElements>(__elements)...) { }
227 tuple(const tuple& __in)
228 : _Inherited(static_cast<const _Inherited&>(__in)) { }
231 : _Inherited(std::move<_Inherited>(__in)) { }
233 template<typename... _UElements>
234 tuple(const tuple<_UElements...>& __in)
235 : _Inherited(static_cast<const _Tuple_impl<0, _UElements...>&>(__in))
238 template<typename... _UElements>
239 tuple(tuple<_UElements...>&& __in)
240 : _Inherited(std::move<_Tuple_impl<0, _UElements...> >(__in)) { }
242 // XXX http://gcc.gnu.org/ml/libstdc++/2008-02/msg00047.html
243 template<typename... _UElements>
244 tuple(tuple<_UElements...>& __in)
245 : _Inherited(static_cast<const _Tuple_impl<0, _UElements...>&>(__in))
249 operator=(const tuple& __in)
251 static_cast<_Inherited&>(*this) = __in;
256 operator=(tuple&& __in)
258 static_cast<_Inherited&>(*this) = std::move(__in);
262 template<typename... _UElements>
264 operator=(const tuple<_UElements...>& __in)
266 static_cast<_Inherited&>(*this) = __in;
270 template<typename... _UElements>
272 operator=(tuple<_UElements...>&& __in)
274 static_cast<_Inherited&>(*this) = std::move(__in);
283 /// tuple (2-element), with construction and assignment from a pair.
284 template<typename _T1, typename _T2>
285 class tuple<_T1, _T2> : public _Tuple_impl<0, _T1, _T2>
287 typedef _Tuple_impl<0, _T1, _T2> _Inherited;
294 tuple(const _T1& __a1, const _T2& __a2)
295 : _Inherited(__a1, __a2) { }
297 template<typename _U1, typename _U2>
299 tuple(_U1&& __a1, _U2&& __a2)
300 : _Inherited(std::forward<_U1>(__a1), std::forward<_U2>(__a2)) { }
302 tuple(const tuple& __in)
303 : _Inherited(static_cast<const _Inherited&>(__in)) { }
306 : _Inherited(std::move<_Inherited>(__in)) { }
308 template<typename _U1, typename _U2>
309 tuple(const tuple<_U1, _U2>& __in)
310 : _Inherited(static_cast<const _Tuple_impl<0, _U1, _U2>&>(__in)) { }
312 template<typename _U1, typename _U2>
313 tuple(tuple<_U1, _U2>&& __in)
314 : _Inherited(std::move<_Tuple_impl<0, _U1, _U2> >(__in)) { }
316 template<typename _U1, typename _U2>
317 tuple(const pair<_U1, _U2>& __in)
318 : _Inherited(__in.first, __in.second) { }
320 template<typename _U1, typename _U2>
321 tuple(pair<_U1, _U2>&& __in)
322 : _Inherited(std::move(__in.first), std::move(__in.second)) { }
325 operator=(const tuple& __in)
327 static_cast<_Inherited&>(*this) = __in;
332 operator=(tuple&& __in)
334 static_cast<_Inherited&>(*this) = std::move(__in);
338 template<typename _U1, typename _U2>
340 operator=(const tuple<_U1, _U2>& __in)
342 static_cast<_Inherited&>(*this) = __in;
346 template<typename _U1, typename _U2>
348 operator=(tuple<_U1, _U2>&& __in)
350 static_cast<_Inherited&>(*this) = std::move(__in);
354 template<typename _U1, typename _U2>
356 operator=(const pair<_U1, _U2>& __in)
358 this->_M_head() = __in.first;
359 this->_M_tail()._M_head() = __in.second;
363 template<typename _U1, typename _U2>
365 operator=(pair<_U1, _U2>&& __in)
367 this->_M_head() = std::move(__in.first);
368 this->_M_tail()._M_head() = std::move(__in.second);
374 /// Gives the type of the ith element of a given tuple type.
375 template<int __i, typename _Tp>
376 struct tuple_element;
379 * Recursive case for tuple_element: strip off the first element in
380 * the tuple and retrieve the (i-1)th element of the remaining tuple.
382 template<int __i, typename _Head, typename... _Tail>
383 struct tuple_element<__i, tuple<_Head, _Tail...> >
384 : tuple_element<__i - 1, tuple<_Tail...> > { };
387 * Basis case for tuple_element: The first element is the one we're seeking.
389 template<typename _Head, typename... _Tail>
390 struct tuple_element<0, tuple<_Head, _Tail...> >
395 /// Finds the size of a given tuple type.
396 template<typename _Tp>
400 template<typename... _Elements>
401 struct tuple_size<tuple<_Elements...> >
403 static const int value = sizeof...(_Elements);
406 template<typename... _Elements>
407 const int tuple_size<tuple<_Elements...> >::value;
409 template<int __i, typename _Head, typename... _Tail>
410 inline typename __add_ref<_Head>::type
411 __get_helper(_Tuple_impl<__i, _Head, _Tail...>& __t)
412 { return __t._M_head(); }
414 template<int __i, typename _Head, typename... _Tail>
415 inline typename __add_c_ref<_Head>::type
416 __get_helper(const _Tuple_impl<__i, _Head, _Tail...>& __t)
417 { return __t._M_head(); }
419 // Return a reference (const reference) to the ith element of a tuple.
420 // Any const or non-const ref elements are returned with their original type.
421 template<int __i, typename... _Elements>
422 inline typename __add_ref<
423 typename tuple_element<__i, tuple<_Elements...> >::type
425 get(tuple<_Elements...>& __t)
426 { return __get_helper<__i>(__t); }
428 template<int __i, typename... _Elements>
429 inline typename __add_c_ref<
430 typename tuple_element<__i, tuple<_Elements...> >::type
432 get(const tuple<_Elements...>& __t)
433 { return __get_helper<__i>(__t); }
435 // This class helps construct the various comparison operations on tuples
436 template<int __check_equal_size, int __i, int __j,
437 typename _Tp, typename _Up>
438 struct __tuple_compare;
440 template<int __i, int __j, typename _Tp, typename _Up>
441 struct __tuple_compare<0, __i, __j, _Tp, _Up>
443 static bool __eq(const _Tp& __t, const _Up& __u)
445 return (get<__i>(__t) == get<__i>(__u) &&
446 __tuple_compare<0, __i+1, __j, _Tp, _Up>::__eq(__t, __u));
449 static bool __less(const _Tp& __t, const _Up& __u)
451 return ((get<__i>(__t) < get<__i>(__u))
452 || !(get<__i>(__u) < get<__i>(__t)) &&
453 __tuple_compare<0, __i+1, __j, _Tp, _Up>::__less(__t, __u));
457 template<int __i, typename _Tp, typename _Up>
458 struct __tuple_compare<0, __i, __i, _Tp, _Up>
460 static bool __eq(const _Tp&, const _Up&)
463 static bool __less(const _Tp&, const _Up&)
467 template<typename... _TElements, typename... _UElements>
469 operator==(const tuple<_TElements...>& __t,
470 const tuple<_UElements...>& __u)
472 typedef tuple<_TElements...> _Tp;
473 typedef tuple<_UElements...> _Up;
474 return (__tuple_compare<tuple_size<_Tp>::value - tuple_size<_Up>::value,
475 0, tuple_size<_Tp>::value, _Tp, _Up>::__eq(__t, __u));
478 template<typename... _TElements, typename... _UElements>
480 operator<(const tuple<_TElements...>& __t,
481 const tuple<_UElements...>& __u)
483 typedef tuple<_TElements...> _Tp;
484 typedef tuple<_UElements...> _Up;
485 return (__tuple_compare<tuple_size<_Tp>::value - tuple_size<_Up>::value,
486 0, tuple_size<_Tp>::value, _Tp, _Up>::__less(__t, __u));
489 template<typename... _TElements, typename... _UElements>
491 operator!=(const tuple<_TElements...>& __t,
492 const tuple<_UElements...>& __u)
493 { return !(__t == __u); }
495 template<typename... _TElements, typename... _UElements>
497 operator>(const tuple<_TElements...>& __t,
498 const tuple<_UElements...>& __u)
499 { return __u < __t; }
501 template<typename... _TElements, typename... _UElements>
503 operator<=(const tuple<_TElements...>& __t,
504 const tuple<_UElements...>& __u)
505 { return !(__u < __t); }
507 template<typename... _TElements, typename... _UElements>
509 operator>=(const tuple<_TElements...>& __t,
510 const tuple<_UElements...>& __u)
511 { return !(__t < __u); }
514 template<typename... _Elements>
515 inline tuple<typename __decay_and_strip<_Elements>::__type...>
516 make_tuple(_Elements&&... __args)
518 typedef tuple<typename __decay_and_strip<_Elements>::__type...>
520 return __result_type(std::forward<_Elements>(__args)...);
523 template<int...> struct __index_holder { };
525 template<int __i, typename _IdxHolder, typename... _Elements>
526 struct __index_holder_impl;
528 template<int __i, int... _Indexes, typename _IdxHolder, typename... _Elements>
529 struct __index_holder_impl<__i, __index_holder<_Indexes...>,
530 _IdxHolder, _Elements...>
532 typedef typename __index_holder_impl<__i + 1,
533 __index_holder<_Indexes..., __i>,
534 _Elements...>::type type;
537 template<int __i, int... _Indexes>
538 struct __index_holder_impl<__i, __index_holder<_Indexes...> >
539 { typedef __index_holder<_Indexes...> type; };
541 template<typename... _Elements>
542 struct __make_index_holder
543 : __index_holder_impl<0, __index_holder<>, _Elements...> { };
545 template<typename... _TElements, int... _TIdx,
546 typename... _UElements, int... _UIdx>
547 inline tuple<_TElements..., _UElements...>
548 __tuple_cat_helper(const tuple<_TElements...>& __t,
549 const __index_holder<_TIdx...>&,
550 const tuple<_UElements...>& __u,
551 const __index_holder<_UIdx...>&)
552 { return tuple<_TElements..., _UElements...>(get<_TIdx>(__t)...,
553 get<_UIdx>(__u)...); }
555 template<typename... _TElements, int... _TIdx,
556 typename... _UElements, int... _UIdx>
557 inline tuple<_TElements..., _UElements...>
558 __tuple_cat_helper(tuple<_TElements...>&& __t,
559 const __index_holder<_TIdx...>&,
560 const tuple<_UElements...>& __u,
561 const __index_holder<_UIdx...>&)
562 { return tuple<_TElements..., _UElements...>
563 (std::move(get<_TIdx>(__t))..., get<_UIdx>(__u)...); }
565 template<typename... _TElements, int... _TIdx,
566 typename... _UElements, int... _UIdx>
567 inline tuple<_TElements..., _UElements...>
568 __tuple_cat_helper(const tuple<_TElements...>& __t,
569 const __index_holder<_TIdx...>&,
570 tuple<_UElements...>&& __u,
571 const __index_holder<_UIdx...>&)
572 { return tuple<_TElements..., _UElements...>
573 (get<_TIdx>(__t)..., std::move(get<_UIdx>(__u))...); }
575 template<typename... _TElements, int... _TIdx,
576 typename... _UElements, int... _UIdx>
577 inline tuple<_TElements..., _UElements...>
578 __tuple_cat_helper(tuple<_TElements...>&& __t,
579 const __index_holder<_TIdx...>&,
580 tuple<_UElements...>&& __u,
581 const __index_holder<_UIdx...>&)
582 { return tuple<_TElements..., _UElements...>
583 (std::move(get<_TIdx>(__t))..., std::move(get<_UIdx>(__u))...); }
585 template<typename... _TElements, typename... _UElements>
586 inline tuple<_TElements..., _UElements...>
587 tuple_cat(const tuple<_TElements...>& __t, const tuple<_UElements...>& __u)
589 return __tuple_cat_helper(__t, typename
590 __make_index_holder<_TElements...>::type(),
592 __make_index_holder<_UElements...>::type());
595 template<typename... _TElements, typename... _UElements>
596 inline tuple<_TElements..., _UElements...>
597 tuple_cat(tuple<_TElements...>&& __t, const tuple<_UElements...>& __u)
599 return __tuple_cat_helper(std::move(__t), typename
600 __make_index_holder<_TElements...>::type(),
602 __make_index_holder<_UElements...>::type());
605 template<typename... _TElements, typename... _UElements>
606 inline tuple<_TElements..., _UElements...>
607 tuple_cat(const tuple<_TElements...>& __t, tuple<_UElements...>&& __u)
609 return __tuple_cat_helper(__t, typename
610 __make_index_holder<_TElements...>::type(),
611 std::move(__u), typename
612 __make_index_holder<_UElements...>::type());
615 template<typename... _TElements, typename... _UElements>
616 inline tuple<_TElements..., _UElements...>
617 tuple_cat(tuple<_TElements...>&& __t, tuple<_UElements...>&& __u)
619 return __tuple_cat_helper(std::move(__t), typename
620 __make_index_holder<_TElements...>::type(),
621 std::move(__u), typename
622 __make_index_holder<_UElements...>::type());
625 template<typename... _Elements>
626 inline tuple<_Elements&...>
627 tie(_Elements&... __args)
628 { return tuple<_Elements&...>(__args...); }
630 // A class (and instance) which can be used in 'tie' when an element
631 // of a tuple is not required
632 struct _Swallow_assign
636 operator=(const _Tp&)
640 // TODO: Put this in some kind of shared file.
643 _Swallow_assign ignore;
644 }; // anonymous namespace
647 #endif // _GLIBCXX_CXX0X_TUPLE