OSDN Git Service

a295e4ef9371b65a227c546cb72620999cf2ddc9
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / include / std / tuple
1 // <tuple> -*- C++ -*-
2
3 // Copyright (C) 2007, 2008 Free Software Foundation, Inc.
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
8 // Free Software Foundation; either version 2, or (at your option)
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
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.
20
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.
29
30 /** @file include/tuple
31  *  This is a Standard C++ Library header.
32  */
33
34 #ifndef _GLIBCXX_TUPLE
35 #define _GLIBCXX_TUPLE 1
36
37 #pragma GCC system_header
38
39 #ifndef __GXX_EXPERIMENTAL_CXX0X__
40 # include <c++0x_warning.h>
41 #else
42
43 #include <utility>
44
45 namespace std
46 {
47   // Adds a const reference to a non-reference type.
48   template<typename _Tp>
49     struct __add_c_ref
50     { typedef const _Tp& type; };
51
52   template<typename _Tp>
53     struct __add_c_ref<_Tp&>
54     { typedef _Tp& type; };
55
56   // Adds a reference to a non-reference type.
57   template<typename _Tp>
58     struct __add_ref
59     { typedef _Tp& type; };
60
61   template<typename _Tp>
62     struct __add_ref<_Tp&>
63     { typedef _Tp& type; };
64
65   template<std::size_t _Idx, typename _Head, bool _IsEmpty>
66     struct _Head_base;
67
68   template<std::size_t _Idx, typename _Head>
69     struct _Head_base<_Idx, _Head, true>
70     : public _Head
71     {
72       _Head_base()
73       : _Head() { }
74
75       _Head_base(const _Head& __h)
76       : _Head(__h) { }
77
78       template<typename _UHead>
79       _Head_base(_UHead&& __h)
80       : _Head(std::forward<_UHead>(__h)) { }
81
82       _Head&       _M_head()       { return *this; }
83       const _Head& _M_head() const { return *this; }
84     };
85
86   template<std::size_t _Idx, typename _Head>
87     struct _Head_base<_Idx, _Head, false>
88     {
89       _Head_base()
90       : _M_head_impl() { }
91
92       _Head_base(const _Head& __h)
93       : _M_head_impl(__h) { }
94
95       template<typename _UHead>
96       _Head_base(_UHead&& __h)
97       : _M_head_impl(std::forward<_UHead>(__h)) { }
98
99       _Head&       _M_head()       { return _M_head_impl; }
100       const _Head& _M_head() const { return _M_head_impl; }        
101
102       _Head _M_head_impl; 
103     };
104
105   /**
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
111    * get() operation.
112    */
113   template<std::size_t _Idx, typename... _Elements>
114     struct _Tuple_impl; 
115
116   /**
117    * Zero-element tuple implementation. This is the basis case for the 
118    * inheritance recursion.
119    */
120   template<std::size_t _Idx>
121     struct _Tuple_impl<_Idx> { };
122
123   /**
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).
127    */
128   template<std::size_t _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>
132     {
133       typedef _Tuple_impl<_Idx + 1, _Tail...> _Inherited;
134       typedef _Head_base<_Idx, _Head, std::is_empty<_Head>::value> _Base;
135
136       _Head&            _M_head()       { return _Base::_M_head(); }
137       const _Head&      _M_head() const { return _Base::_M_head(); }
138
139       _Inherited&       _M_tail()       { return *this; }
140       const _Inherited& _M_tail() const { return *this; }
141
142       _Tuple_impl()
143       : _Inherited(), _Base() { }
144
145       explicit 
146       _Tuple_impl(const _Head& __head, const _Tail&... __tail)
147       : _Inherited(__tail...), _Base(__head) { }
148
149       template<typename _UHead, typename... _UTail> 
150         explicit
151         _Tuple_impl(_UHead&& __head, _UTail&&... __tail)
152         : _Inherited(std::forward<_UTail>(__tail)...),
153           _Base(std::forward<_UHead>(__head)) { }
154
155       _Tuple_impl(const _Tuple_impl& __in)
156       : _Inherited(__in._M_tail()), _Base(__in._M_head()) { }
157
158       _Tuple_impl(_Tuple_impl&& __in)
159       : _Inherited(std::move<_Inherited&&>(__in._M_tail())),
160         _Base(std::forward<_Head>(__in._M_head())) { }
161
162       template<typename... _UElements>
163         _Tuple_impl(const _Tuple_impl<_Idx, _UElements...>& __in)
164         : _Inherited(__in._M_tail()), _Base(__in._M_head()) { }
165
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())) { }
172
173       _Tuple_impl&
174       operator=(const _Tuple_impl& __in)
175       {
176         _M_head() = __in._M_head();
177         _M_tail() = __in._M_tail();
178         return *this;
179       }
180
181       _Tuple_impl&
182       operator=(_Tuple_impl&& __in)
183       {
184         _M_head() = std::move(__in._M_head());
185         _M_tail() = std::move(__in._M_tail());
186         return *this;
187       }
188
189       template<typename... _UElements>
190         _Tuple_impl&
191         operator=(const _Tuple_impl<_Idx, _UElements...>& __in)
192         {
193           _M_head() = __in._M_head();
194           _M_tail() = __in._M_tail();
195           return *this;
196         }
197
198       template<typename... _UElements>
199         _Tuple_impl&
200         operator=(_Tuple_impl<_Idx, _UElements...>&& __in)
201         {
202           _M_head() = std::move(__in._M_head());
203           _M_tail() = std::move(__in._M_tail());
204           return *this;
205         }
206     };
207
208   /// tuple
209   template<typename... _Elements> 
210     class tuple : public _Tuple_impl<0, _Elements...>
211     {
212       typedef _Tuple_impl<0, _Elements...> _Inherited;
213
214     public:
215       tuple()
216       : _Inherited() { }
217
218       explicit
219       tuple(const _Elements&... __elements)
220       : _Inherited(__elements...) { }
221
222       template<typename... _UElements>
223         explicit
224         tuple(_UElements&&... __elements)
225         : _Inherited(std::forward<_UElements>(__elements)...) { }
226
227       tuple(const tuple& __in)
228       : _Inherited(static_cast<const _Inherited&>(__in)) { }
229
230       tuple(tuple&& __in)
231       : _Inherited(std::move<_Inherited>(__in)) { }
232
233       template<typename... _UElements>
234         tuple(const tuple<_UElements...>& __in)
235         : _Inherited(static_cast<const _Tuple_impl<0, _UElements...>&>(__in))
236         { }
237
238       template<typename... _UElements>
239         tuple(tuple<_UElements...>&& __in)
240         : _Inherited(std::move<_Tuple_impl<0, _UElements...> >(__in)) { }
241
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))
246         { }
247
248       tuple&
249       operator=(const tuple& __in)
250       {
251         static_cast<_Inherited&>(*this) = __in;
252         return *this;
253       }
254
255       tuple&
256       operator=(tuple&& __in)
257       {
258         static_cast<_Inherited&>(*this) = std::move(__in);
259         return *this;
260       }
261
262       template<typename... _UElements>
263         tuple&
264         operator=(const tuple<_UElements...>& __in)
265         {
266           static_cast<_Inherited&>(*this) = __in;
267           return *this;
268         }
269
270       template<typename... _UElements>
271         tuple&
272         operator=(tuple<_UElements...>&& __in)
273         {
274           static_cast<_Inherited&>(*this) = std::move(__in);
275           return *this;
276         }
277     };
278
279
280   template<>  
281     class tuple<> { };
282
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>
286     {
287       typedef _Tuple_impl<0, _T1, _T2> _Inherited;
288
289     public:
290       tuple()
291       : _Inherited() { }
292
293       explicit
294       tuple(const _T1& __a1, const _T2& __a2)
295       : _Inherited(__a1, __a2) { }
296
297       template<typename _U1, typename _U2>
298         explicit
299         tuple(_U1&& __a1, _U2&& __a2)
300         : _Inherited(std::forward<_U1>(__a1), std::forward<_U2>(__a2)) { }
301
302       tuple(const tuple& __in)
303       : _Inherited(static_cast<const _Inherited&>(__in)) { }
304
305       tuple(tuple&& __in)
306       : _Inherited(std::move<_Inherited>(__in)) { }
307
308       template<typename _U1, typename _U2>
309         tuple(const tuple<_U1, _U2>& __in)
310         : _Inherited(static_cast<const _Tuple_impl<0, _U1, _U2>&>(__in)) { }
311
312       template<typename _U1, typename _U2>
313         tuple(tuple<_U1, _U2>&& __in)
314         : _Inherited(std::move<_Tuple_impl<0, _U1, _U2> >(__in)) { }
315
316       template<typename _U1, typename _U2>
317         tuple(const pair<_U1, _U2>& __in)
318         : _Inherited(__in.first, __in.second) { }
319
320       template<typename _U1, typename _U2>
321         tuple(pair<_U1, _U2>&& __in)
322         : _Inherited(std::move(__in.first), std::move(__in.second)) { }
323
324       tuple&
325       operator=(const tuple& __in)
326       {
327         static_cast<_Inherited&>(*this) = __in;
328         return *this;
329       }
330
331       tuple&
332       operator=(tuple&& __in)
333       {
334         static_cast<_Inherited&>(*this) = std::move(__in);
335         return *this;
336       }
337
338       template<typename _U1, typename _U2>
339         tuple&
340         operator=(const tuple<_U1, _U2>& __in)
341         {
342           static_cast<_Inherited&>(*this) = __in;
343           return *this;
344         }
345
346       template<typename _U1, typename _U2>
347         tuple&
348         operator=(tuple<_U1, _U2>&& __in)
349         {
350           static_cast<_Inherited&>(*this) = std::move(__in);
351           return *this;
352         }
353
354       template<typename _U1, typename _U2>
355         tuple&
356         operator=(const pair<_U1, _U2>& __in)
357         {
358           this->_M_head() = __in.first;
359           this->_M_tail()._M_head() = __in.second;
360           return *this;
361         }
362
363       template<typename _U1, typename _U2>
364         tuple&
365         operator=(pair<_U1, _U2>&& __in)
366         {
367           this->_M_head() = std::move(__in.first);
368           this->_M_tail()._M_head() = std::move(__in.second);
369           return *this;
370         }
371     };
372
373
374   /// Gives the type of the ith element of a given tuple type.
375   template<std::size_t __i, typename _Tp>
376     struct tuple_element;
377
378   /**
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.
381    */
382   template<std::size_t __i, typename _Head, typename... _Tail>
383     struct tuple_element<__i, tuple<_Head, _Tail...> >
384     : tuple_element<__i - 1, tuple<_Tail...> > { };
385
386   /**
387    * Basis case for tuple_element: The first element is the one we're seeking.
388    */
389   template<typename _Head, typename... _Tail>
390     struct tuple_element<0, tuple<_Head, _Tail...> >
391     {
392       typedef _Head type;
393     };
394
395   /// Finds the size of a given tuple type.
396   template<typename _Tp>
397     struct tuple_size;
398
399   /// class tuple_size
400   template<typename... _Elements>
401     struct tuple_size<tuple<_Elements...> >
402     {
403       static const std::size_t value = sizeof...(_Elements);
404     };
405
406   template<typename... _Elements>
407     const std::size_t tuple_size<tuple<_Elements...> >::value;
408
409   template<std::size_t __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(); }
413
414   template<std::size_t __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(); }
418
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<std::size_t __i, typename... _Elements>
422     inline typename __add_ref<
423                       typename tuple_element<__i, tuple<_Elements...> >::type
424                     >::type
425     get(tuple<_Elements...>& __t)
426     { return __get_helper<__i>(__t); }
427
428   template<std::size_t __i, typename... _Elements>
429     inline typename __add_c_ref<
430                       typename tuple_element<__i, tuple<_Elements...> >::type
431                     >::type
432     get(const tuple<_Elements...>& __t)
433     { return __get_helper<__i>(__t); }
434
435   // This class helps construct the various comparison operations on tuples
436   template<std::size_t __check_equal_size, std::size_t __i, std::size_t __j,
437            typename _Tp, typename _Up>
438     struct __tuple_compare;
439
440   template<std::size_t __i, std::size_t __j, typename _Tp, typename _Up>
441     struct __tuple_compare<0, __i, __j, _Tp, _Up>
442     {
443       static bool __eq(const _Tp& __t, const _Up& __u)
444       {
445         return (get<__i>(__t) == get<__i>(__u) &&
446                 __tuple_compare<0, __i + 1, __j, _Tp, _Up>::__eq(__t, __u));
447       }
448      
449       static bool __less(const _Tp& __t, const _Up& __u)
450       {
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));
454       }
455     };
456
457   template<std::size_t __i, typename _Tp, typename _Up>
458     struct __tuple_compare<0, __i, __i, _Tp, _Up>
459     {
460       static bool __eq(const _Tp&, const _Up&)
461       { return true; }
462      
463       static bool __less(const _Tp&, const _Up&)
464       { return false; }
465     };
466
467   template<typename... _TElements, typename... _UElements>
468     bool
469     operator==(const tuple<_TElements...>& __t,
470                const tuple<_UElements...>& __u)
471     {
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));
476     }
477
478   template<typename... _TElements, typename... _UElements>
479     bool
480     operator<(const tuple<_TElements...>& __t,
481               const tuple<_UElements...>& __u)
482     {
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));
487     }
488
489   template<typename... _TElements, typename... _UElements>
490     inline bool
491     operator!=(const tuple<_TElements...>& __t,
492                const tuple<_UElements...>& __u)
493     { return !(__t == __u); }
494
495   template<typename... _TElements, typename... _UElements>
496     inline bool
497     operator>(const tuple<_TElements...>& __t,
498               const tuple<_UElements...>& __u)
499     { return __u < __t; }
500
501   template<typename... _TElements, typename... _UElements>
502     inline bool
503     operator<=(const tuple<_TElements...>& __t,
504                const tuple<_UElements...>& __u)
505     { return !(__u < __t); }
506
507   template<typename... _TElements, typename... _UElements>
508     inline bool
509     operator>=(const tuple<_TElements...>& __t,
510                const tuple<_UElements...>& __u)
511     { return !(__t < __u); }
512
513   // NB: DR 705.
514   template<typename... _Elements>
515     inline tuple<typename __decay_and_strip<_Elements>::__type...>
516     make_tuple(_Elements&&... __args)
517     {
518       typedef tuple<typename __decay_and_strip<_Elements>::__type...>
519         __result_type;
520       return __result_type(std::forward<_Elements>(__args)...);
521     }
522
523   template<std::size_t...> struct __index_holder { };    
524
525   template<std::size_t __i, typename _IdxHolder, typename... _Elements>
526     struct __index_holder_impl;
527
528   template<std::size_t __i, std::size_t... _Indexes, typename _IdxHolder,
529            typename... _Elements>
530     struct __index_holder_impl<__i, __index_holder<_Indexes...>,
531                                _IdxHolder, _Elements...> 
532     {
533       typedef typename __index_holder_impl<__i + 1,
534                                            __index_holder<_Indexes..., __i>,
535                                            _Elements...>::type type;
536     };
537  
538   template<std::size_t __i, std::size_t... _Indexes>
539     struct __index_holder_impl<__i, __index_holder<_Indexes...> >
540     { typedef __index_holder<_Indexes...> type; };
541
542   template<typename... _Elements>
543     struct __make_index_holder 
544     : __index_holder_impl<0, __index_holder<>, _Elements...> { };
545     
546   template<typename... _TElements, std::size_t... _TIdx,
547            typename... _UElements, std::size_t... _UIdx> 
548     inline tuple<_TElements..., _UElements...> 
549     __tuple_cat_helper(const tuple<_TElements...>& __t,
550                        const __index_holder<_TIdx...>&,
551                        const tuple<_UElements...>& __u,
552                        const __index_holder<_UIdx...>&)
553     { return tuple<_TElements..., _UElements...>(get<_TIdx>(__t)...,
554                                                  get<_UIdx>(__u)...); }
555
556   template<typename... _TElements, std::size_t... _TIdx,
557            typename... _UElements, std::size_t... _UIdx> 
558     inline tuple<_TElements..., _UElements...> 
559     __tuple_cat_helper(tuple<_TElements...>&& __t,
560                        const __index_holder<_TIdx...>&, 
561                        const tuple<_UElements...>& __u,
562                        const __index_holder<_UIdx...>&)
563     { return tuple<_TElements..., _UElements...>
564         (std::move(get<_TIdx>(__t))..., get<_UIdx>(__u)...); }
565
566   template<typename... _TElements, std::size_t... _TIdx,
567            typename... _UElements, std::size_t... _UIdx>
568     inline tuple<_TElements..., _UElements...> 
569     __tuple_cat_helper(const tuple<_TElements...>& __t,
570                        const __index_holder<_TIdx...>&, 
571                        tuple<_UElements...>&& __u,
572                        const __index_holder<_UIdx...>&)
573     { return tuple<_TElements..., _UElements...>
574         (get<_TIdx>(__t)..., std::move(get<_UIdx>(__u))...); }
575
576   template<typename... _TElements, std::size_t... _TIdx,
577            typename... _UElements, std::size_t... _UIdx> 
578     inline tuple<_TElements..., _UElements...> 
579     __tuple_cat_helper(tuple<_TElements...>&& __t,
580                        const __index_holder<_TIdx...>&, 
581                        tuple<_UElements...>&& __u,
582                        const __index_holder<_UIdx...>&)
583     { return tuple<_TElements..., _UElements...>
584         (std::move(get<_TIdx>(__t))..., std::move(get<_UIdx>(__u))...); }
585
586   template<typename... _TElements, typename... _UElements>
587     inline tuple<_TElements..., _UElements...> 
588     tuple_cat(const tuple<_TElements...>& __t, const tuple<_UElements...>& __u)
589     {
590       return __tuple_cat_helper(__t, typename
591                                 __make_index_holder<_TElements...>::type(),
592                                 __u, typename
593                                 __make_index_holder<_UElements...>::type());
594     }
595
596   template<typename... _TElements, typename... _UElements>
597     inline tuple<_TElements..., _UElements...> 
598     tuple_cat(tuple<_TElements...>&& __t, const tuple<_UElements...>& __u)
599     {
600       return __tuple_cat_helper(std::move(__t), typename
601                                  __make_index_holder<_TElements...>::type(),
602                                  __u, typename
603                                  __make_index_holder<_UElements...>::type());
604     }
605
606   template<typename... _TElements, typename... _UElements>
607     inline tuple<_TElements..., _UElements...> 
608     tuple_cat(const tuple<_TElements...>& __t, tuple<_UElements...>&& __u)
609     {
610       return __tuple_cat_helper(__t, typename
611                                 __make_index_holder<_TElements...>::type(),
612                                 std::move(__u), typename
613                                 __make_index_holder<_UElements...>::type());
614     }
615
616   template<typename... _TElements, typename... _UElements>
617     inline tuple<_TElements..., _UElements...>
618     tuple_cat(tuple<_TElements...>&& __t, tuple<_UElements...>&& __u)
619     {
620       return __tuple_cat_helper(std::move(__t), typename
621                                 __make_index_holder<_TElements...>::type(),
622                                 std::move(__u), typename
623                                 __make_index_holder<_UElements...>::type());
624     }
625
626   template<typename... _Elements>
627     inline tuple<_Elements&...>
628     tie(_Elements&... __args)
629     { return tuple<_Elements&...>(__args...); }
630
631   // A class (and instance) which can be used in 'tie' when an element
632   // of a tuple is not required
633   struct _Swallow_assign
634   {
635     template<class _Tp>
636       _Swallow_assign&
637       operator=(const _Tp&)
638       { return *this; }
639   };
640
641   // TODO: Put this in some kind of shared file.
642   namespace
643   {
644     _Swallow_assign ignore;
645   }; // anonymous namespace
646 }
647
648 #endif // __GXX_EXPERIMENTAL_CXX0X__
649
650 #endif // _GLIBCXX_TUPLE