// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. // A Tuple is a generic templatized container, similar in concept to std::pair. // There are classes Tuple0 to Tuple6, cooresponding to the number of elements // it contains. The convenient MakeTuple() function takes 0 to 6 arguments, // and will construct and return the appropriate Tuple object. The functions // DispatchToMethod and DispatchToFunction take a function pointer or instance // and method pointer, and unpack a tuple into arguments to the call. // // Tuple elements are copied by value, and stored in the tuple. See the unit // tests for more details of how/when the values are copied. // // Example usage: // // These two methods of creating a Tuple are identical. // Tuple2 tuple_a(1, "wee"); // Tuple2 tuple_b = MakeTuple(1, "wee"); // // void SomeFunc(int a, const char* b) { } // DispatchToFunction(&SomeFunc, tuple_a); // SomeFunc(1, "wee") // DispatchToFunction( // &SomeFunc, MakeTuple(10, "foo")); // SomeFunc(10, "foo") // // struct { void SomeMeth(int a, int b, int c) { } } foo; // DispatchToMethod(&foo, &Foo::SomeMeth, MakeTuple(1, 2, 3)); // // foo->SomeMeth(1, 2, 3); #ifndef BASE_TUPLE_H__ #define BASE_TUPLE_H__ // Traits ---------------------------------------------------------------------- // // A simple traits class for tuple arguments. // // ValueType: the bare, nonref version of a type (same as the type for nonrefs). // RefType: the ref version of a type (same as the type for refs). // ParamType: what type to pass to functions (refs should not be constified). template struct TupleTraits { typedef P ValueType; typedef P& RefType; typedef const P& ParamType; }; template struct TupleTraits { typedef P ValueType; typedef P& RefType; typedef P& ParamType; }; // Tuple ----------------------------------------------------------------------- // // This set of classes is useful for bundling 0 or more heterogeneous data types // into a single variable. The advantage of this is that it greatly simplifies // function objects that need to take an arbitrary number of parameters; see // RunnableMethod and IPC::MessageWithTuple. // // Tuple0 is supplied to act as a 'void' type. It can be used, for example, // when dispatching to a function that accepts no arguments (see the // Dispatchers below). // Tuple1 is rarely useful. One such use is when A is non-const ref that you // want filled by the dispatchee, and the tuple is merely a container for that // output (a "tier"). See MakeRefTuple and its usages. struct Tuple0 { typedef Tuple0 ValueTuple; typedef Tuple0 RefTuple; }; template struct Tuple1 { public: typedef A TypeA; typedef Tuple1::ValueType> ValueTuple; typedef Tuple1::RefType> RefTuple; Tuple1() {} explicit Tuple1(typename TupleTraits::ParamType a) : a(a) {} A a; }; template struct Tuple2 { public: typedef A TypeA; typedef B TypeB; typedef Tuple2::ValueType, typename TupleTraits::ValueType> ValueTuple; typedef Tuple2::RefType, typename TupleTraits::RefType> RefTuple; Tuple2() {} Tuple2(typename TupleTraits::ParamType a, typename TupleTraits::ParamType b) : a(a), b(b) { } A a; B b; }; template struct Tuple3 { public: typedef A TypeA; typedef B TypeB; typedef C TypeC; typedef Tuple3::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType> ValueTuple; typedef Tuple3::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType> RefTuple; Tuple3() {} Tuple3(typename TupleTraits::ParamType a, typename TupleTraits::ParamType b, typename TupleTraits::ParamType c) : a(a), b(b), c(c){ } A a; B b; C c; }; template struct Tuple4 { public: typedef A TypeA; typedef B TypeB; typedef C TypeC; typedef D TypeD; typedef Tuple4::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType> ValueTuple; typedef Tuple4::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType> RefTuple; Tuple4() {} Tuple4(typename TupleTraits::ParamType a, typename TupleTraits::ParamType b, typename TupleTraits::ParamType c, typename TupleTraits::ParamType d) : a(a), b(b), c(c), d(d) { } A a; B b; C c; D d; }; template struct Tuple5 { public: typedef A TypeA; typedef B TypeB; typedef C TypeC; typedef D TypeD; typedef E TypeE; typedef Tuple5::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType> ValueTuple; typedef Tuple5::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType> RefTuple; Tuple5() {} Tuple5(typename TupleTraits::ParamType a, typename TupleTraits::ParamType b, typename TupleTraits::ParamType c, typename TupleTraits::ParamType d, typename TupleTraits::ParamType e) : a(a), b(b), c(c), d(d), e(e) { } A a; B b; C c; D d; E e; }; template struct Tuple6 { public: typedef A TypeA; typedef B TypeB; typedef C TypeC; typedef D TypeD; typedef E TypeE; typedef F TypeF; typedef Tuple6::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType> ValueTuple; typedef Tuple6::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType> RefTuple; Tuple6() {} Tuple6(typename TupleTraits::ParamType a, typename TupleTraits::ParamType b, typename TupleTraits::ParamType c, typename TupleTraits::ParamType d, typename TupleTraits::ParamType e, typename TupleTraits::ParamType f) : a(a), b(b), c(c), d(d), e(e), f(f) { } A a; B b; C c; D d; E e; F f; }; template struct Tuple7 { public: typedef A TypeA; typedef B TypeB; typedef C TypeC; typedef D TypeD; typedef E TypeE; typedef F TypeF; typedef G TypeG; typedef Tuple7::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType, typename TupleTraits::ValueType> ValueTuple; typedef Tuple7::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType, typename TupleTraits::RefType> RefTuple; Tuple7() {} Tuple7(typename TupleTraits::ParamType a, typename TupleTraits::ParamType b, typename TupleTraits::ParamType c, typename TupleTraits::ParamType d, typename TupleTraits::ParamType e, typename TupleTraits::ParamType f, typename TupleTraits::ParamType g) : a(a), b(b), c(c), d(d), e(e), f(f), g(g) { } A a; B b; C c; D d; E e; F f; G g; }; // Tuple creators ------------------------------------------------------------- // // Helper functions for constructing tuples while inferring the template // argument types. inline Tuple0 MakeTuple() { return Tuple0(); } template inline Tuple1 MakeTuple(const A& a) { return Tuple1(a); } template inline Tuple2 MakeTuple(const A& a, const B& b) { return Tuple2(a, b); } template inline Tuple3 MakeTuple(const A& a, const B& b, const C& c) { return Tuple3(a, b, c); } template inline Tuple4 MakeTuple(const A& a, const B& b, const C& c, const D& d) { return Tuple4(a, b, c, d); } template inline Tuple5 MakeTuple(const A& a, const B& b, const C& c, const D& d, const E& e) { return Tuple5(a, b, c, d, e); } template inline Tuple6 MakeTuple(const A& a, const B& b, const C& c, const D& d, const E& e, const F& f) { return Tuple6(a, b, c, d, e, f); } template inline Tuple7 MakeTuple(const A& a, const B& b, const C& c, const D& d, const E& e, const F& f, const G& g) { return Tuple7(a, b, c, d, e, f, g); } // The following set of helpers make what Boost refers to as "Tiers" - a tuple // of references. template inline Tuple1 MakeRefTuple(A& a) { return Tuple1(a); } template inline Tuple2 MakeRefTuple(A& a, B& b) { return Tuple2(a, b); } template inline Tuple3 MakeRefTuple(A& a, B& b, C& c) { return Tuple3(a, b, c); } template inline Tuple4 MakeRefTuple(A& a, B& b, C& c, D& d) { return Tuple4(a, b, c, d); } template inline Tuple5 MakeRefTuple(A& a, B& b, C& c, D& d, E& e) { return Tuple5(a, b, c, d, e); } template inline Tuple6 MakeRefTuple(A& a, B& b, C& c, D& d, E& e, F& f) { return Tuple6(a, b, c, d, e, f); } template inline Tuple7 MakeRefTuple(A& a, B& b, C& c, D& d, E& e, F& f, G& g) { return Tuple7(a, b, c, d, e, f, g); } // Dispatchers ---------------------------------------------------------------- // // Helper functions that call the given method on an object, with the unpacked // tuple arguments. Notice that they all have the same number of arguments, // so you need only write: // DispatchToMethod(object, &Object::method, args); // This is very useful for templated dispatchers, since they don't need to know // what type |args| is. // Non-Static Dispatchers with no out params. template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple0& arg) { (obj->*method)(); } template inline void DispatchToMethod(ObjT* obj, Method method, const A& arg) { (obj->*method)(arg); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple1& arg) { (obj->*method)(arg.a); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple2& arg) { (obj->*method)(arg.a, arg.b); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple3& arg) { (obj->*method)(arg.a, arg.b, arg.c); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple4& arg) { (obj->*method)(arg.a, arg.b, arg.c, arg.d); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple5& arg) { (obj->*method)(arg.a, arg.b, arg.c, arg.d, arg.e); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple6& arg) { (obj->*method)(arg.a, arg.b, arg.c, arg.d, arg.e, arg.f); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple7& arg) { (obj->*method)(arg.a, arg.b, arg.c, arg.d, arg.e, arg.f, arg.g); } // Static Dispatchers with no out params. template inline void DispatchToFunction(Function function, const Tuple0& arg) { (*function)(); } template inline void DispatchToFunction(Function function, const A& arg) { (*function)(arg); } template inline void DispatchToFunction(Function function, const Tuple1& arg) { (*function)(arg.a); } template inline void DispatchToFunction(Function function, const Tuple2& arg) { (*function)(arg.a, arg.b); } template inline void DispatchToFunction(Function function, const Tuple3& arg) { (*function)(arg.a, arg.b, arg.c); } template inline void DispatchToFunction(Function function, const Tuple4& arg) { (*function)(arg.a, arg.b, arg.c, arg.d); } template inline void DispatchToFunction(Function function, const Tuple5& arg) { (*function)(arg.a, arg.b, arg.c, arg.d, arg.e); } template inline void DispatchToFunction(Function function, const Tuple6& arg) { (*function)(arg.a, arg.b, arg.c, arg.d, arg.e, arg.f); } // Dispatchers with 0 out param (as a Tuple0). template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple0& arg, Tuple0*) { (obj->*method)(); } template inline void DispatchToMethod(ObjT* obj, Method method, const A& arg, Tuple0*) { (obj->*method)(arg); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple1& arg, Tuple0*) { (obj->*method)(arg.a); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple2& arg, Tuple0*) { (obj->*method)(arg.a, arg.b); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple3& arg, Tuple0*) { (obj->*method)(arg.a, arg.b, arg.c); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple4& arg, Tuple0*) { (obj->*method)(arg.a, arg.b, arg.c, arg.d); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple5& arg, Tuple0*) { (obj->*method)(arg.a, arg.b, arg.c, arg.d, arg.e); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple6& arg, Tuple0*) { (obj->*method)(arg.a, arg.b, arg.c, arg.d, arg.e, arg.f); } // Dispatchers with 1 out param. template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple0& in, Tuple1* out) { (obj->*method)(&out->a); } template inline void DispatchToMethod(ObjT* obj, Method method, const InA& in, Tuple1* out) { (obj->*method)(in, &out->a); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple1& in, Tuple1* out) { (obj->*method)(in.a, &out->a); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple2& in, Tuple1* out) { (obj->*method)(in.a, in.b, &out->a); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple3& in, Tuple1* out) { (obj->*method)(in.a, in.b, in.c, &out->a); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple4& in, Tuple1* out) { (obj->*method)(in.a, in.b, in.c, in.d, &out->a); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple5& in, Tuple1* out) { (obj->*method)(in.a, in.b, in.c, in.d, in.e, &out->a); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple6& in, Tuple1* out) { (obj->*method)(in.a, in.b, in.c, in.d, in.e, in.f, &out->a); } // Dispatchers with 2 out params. template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple0& in, Tuple2* out) { (obj->*method)(&out->a, &out->b); } template inline void DispatchToMethod(ObjT* obj, Method method, const InA& in, Tuple2* out) { (obj->*method)(in, &out->a, &out->b); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple1& in, Tuple2* out) { (obj->*method)(in.a, &out->a, &out->b); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple2& in, Tuple2* out) { (obj->*method)(in.a, in.b, &out->a, &out->b); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple3& in, Tuple2* out) { (obj->*method)(in.a, in.b, in.c, &out->a, &out->b); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple4& in, Tuple2* out) { (obj->*method)(in.a, in.b, in.c, in.d, &out->a, &out->b); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple5& in, Tuple2* out) { (obj->*method)(in.a, in.b, in.c, in.d, in.e, &out->a, &out->b); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple6& in, Tuple2* out) { (obj->*method)(in.a, in.b, in.c, in.d, in.e, in.f, &out->a, &out->b); } // Dispatchers with 3 out params. template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple0& in, Tuple3* out) { (obj->*method)(&out->a, &out->b, &out->c); } template inline void DispatchToMethod(ObjT* obj, Method method, const InA& in, Tuple3* out) { (obj->*method)(in, &out->a, &out->b, &out->c); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple1& in, Tuple3* out) { (obj->*method)(in.a, &out->a, &out->b, &out->c); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple2& in, Tuple3* out) { (obj->*method)(in.a, in.b, &out->a, &out->b, &out->c); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple3& in, Tuple3* out) { (obj->*method)(in.a, in.b, in.c, &out->a, &out->b, &out->c); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple4& in, Tuple3* out) { (obj->*method)(in.a, in.b, in.c, in.d, &out->a, &out->b, &out->c); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple5& in, Tuple3* out) { (obj->*method)(in.a, in.b, in.c, in.d, in.e, &out->a, &out->b, &out->c); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple6& in, Tuple3* out) { (obj->*method)(in.a, in.b, in.c, in.d, in.e, in.f, &out->a, &out->b, &out->c); } // Dispatchers with 4 out params. template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple0& in, Tuple4* out) { (obj->*method)(&out->a, &out->b, &out->c, &out->d); } template inline void DispatchToMethod(ObjT* obj, Method method, const InA& in, Tuple4* out) { (obj->*method)(in, &out->a, &out->b, &out->c, &out->d); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple1& in, Tuple4* out) { (obj->*method)(in.a, &out->a, &out->b, &out->c, &out->d); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple2& in, Tuple4* out) { (obj->*method)(in.a, in.b, &out->a, &out->b, &out->c, &out->d); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple3& in, Tuple4* out) { (obj->*method)(in.a, in.b, in.c, &out->a, &out->b, &out->c, &out->d); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple4& in, Tuple4* out) { (obj->*method)(in.a, in.b, in.c, in.d, &out->a, &out->b, &out->c, &out->d); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple5& in, Tuple4* out) { (obj->*method)(in.a, in.b, in.c, in.d, in.e, &out->a, &out->b, &out->c, &out->d); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple6& in, Tuple4* out) { (obj->*method)(in.a, in.b, in.c, in.d, in.e, in.f, &out->a, &out->b, &out->c, &out->d); } // Dispatchers with 5 out params. template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple0& in, Tuple5* out) { (obj->*method)(&out->a, &out->b, &out->c, &out->d, &out->e); } template inline void DispatchToMethod(ObjT* obj, Method method, const InA& in, Tuple5* out) { (obj->*method)(in, &out->a, &out->b, &out->c, &out->d, &out->e); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple1& in, Tuple5* out) { (obj->*method)(in.a, &out->a, &out->b, &out->c, &out->d, &out->e); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple2& in, Tuple5* out) { (obj->*method)(in.a, in.b, &out->a, &out->b, &out->c, &out->d, &out->e); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple3& in, Tuple5* out) { (obj->*method)(in.a, in.b, in.c, &out->a, &out->b, &out->c, &out->d, &out->e); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple4& in, Tuple5* out) { (obj->*method)(in.a, in.b, in.c, in.d, &out->a, &out->b, &out->c, &out->d, &out->e); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple5& in, Tuple5* out) { (obj->*method)(in.a, in.b, in.c, in.d, in.e, &out->a, &out->b, &out->c, &out->d, &out->e); } template inline void DispatchToMethod(ObjT* obj, Method method, const Tuple6& in, Tuple5* out) { (obj->*method)(in.a, in.b, in.c, in.d, in.e, in.f, &out->a, &out->b, &out->c, &out->d, &out->e); } #endif // BASE_TUPLE_H__