// Copyright (c) 2014 Marshall A. Greenblatt. Portions copyright (c) 2011
// Google Inc. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the name Chromium Embedded
// Framework nor the names of its contributors may be used to endorse
// or promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 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 CEF_INCLUDE_BASE_CEF_TUPLE_H_
#define CEF_INCLUDE_BASE_CEF_TUPLE_H_
#pragma once
#if defined(BASE_TUPLE_H_)
// Do nothing if the Chromium header has already been included.
// This can happen in cases where Chromium code is used directly by the
// client application. When using Chromium code directly always include
// the Chromium header first to avoid type conflicts.
#elif defined(USING_CHROMIUM_INCLUDES)
// When building CEF include the Chromium header directly.
#include "base/tuple.h"
#else // !USING_CHROMIUM_INCLUDES
// The following is substantially similar to the Chromium implementation.
// If the Chromium implementation diverges the below implementation should be
// updated to match.
#include "include/base/cef_bind_helpers.h"
namespace base {
// 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;
};
template
struct TupleTypes { };
// 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;
typedef Tuple0 ParamTuple;
};
template
struct Tuple1 {
public:
typedef A TypeA;
Tuple1() {}
explicit Tuple1(typename TupleTraits::ParamType a) : a(a) {}
A a;
};
template
struct Tuple2 {
public:
typedef A TypeA;
typedef B TypeB;
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;
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;
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;
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;
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;
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;
};
template
struct Tuple8 {
public:
typedef A TypeA;
typedef B TypeB;
typedef C TypeC;
typedef D TypeD;
typedef E TypeE;
typedef F TypeF;
typedef G TypeG;
typedef H TypeH;
Tuple8() {}
Tuple8(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,
typename TupleTraits::ParamType h)
: a(a), b(b), c(c), d(d), e(e), f(f), g(g), h(h) {
}
A a;
B b;
C c;
D d;
E e;
F f;
G g;
H h;
};
// Tuple types ----------------------------------------------------------------
//
// Allows for selection of ValueTuple/RefTuple/ParamTuple without needing the
// definitions of class types the tuple takes as parameters.
template <>
struct TupleTypes< Tuple0 > {
typedef Tuple0 ValueTuple;
typedef Tuple0 RefTuple;
typedef Tuple0 ParamTuple;
};
template
struct TupleTypes< Tuple1 > {
typedef Tuple1::ValueType> ValueTuple;
typedef Tuple1::RefType> RefTuple;
typedef Tuple1::ParamType> ParamTuple;
};
template
struct TupleTypes< Tuple2 > {
typedef Tuple2::ValueType,
typename TupleTraits::ValueType> ValueTuple;
typedef Tuple2::RefType,
typename TupleTraits::RefType> RefTuple;
typedef Tuple2::ParamType,
typename TupleTraits::ParamType> ParamTuple;
};
template
struct TupleTypes< Tuple3 > {
typedef Tuple3::ValueType,
typename TupleTraits::ValueType,
typename TupleTraits::ValueType> ValueTuple;
typedef Tuple3::RefType,
typename TupleTraits::RefType,
typename TupleTraits::RefType> RefTuple;
typedef Tuple3::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType> ParamTuple;
};
template
struct TupleTypes< Tuple4 > {
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;
typedef Tuple4::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType> ParamTuple;
};
template
struct TupleTypes< Tuple5 > {
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;
typedef Tuple5::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType> ParamTuple;
};
template
struct TupleTypes< Tuple6 > {
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;
typedef Tuple6::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType> ParamTuple;
};
template
struct TupleTypes< Tuple7 > {
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;
typedef Tuple7::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType> ParamTuple;
};
template
struct TupleTypes< Tuple8 > {
typedef Tuple8::ValueType,
typename TupleTraits::ValueType,
typename TupleTraits::ValueType,
typename TupleTraits::ValueType,
typename TupleTraits::ValueType,
typename TupleTraits::ValueType,
typename TupleTraits::ValueType,
typename TupleTraits::ValueType> ValueTuple;
typedef Tuple8::RefType,
typename TupleTraits::RefType,
typename TupleTraits::RefType,
typename TupleTraits::RefType,
typename TupleTraits::RefType,
typename TupleTraits::RefType,
typename TupleTraits::RefType,
typename TupleTraits::RefType> RefTuple;
typedef Tuple8::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType,
typename TupleTraits::ParamType> ParamTuple;
};
// 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);
}
template
inline Tuple8 MakeTuple(const A& a, const B& b,
const C& c, const D& d,
const E& e, const F& f,
const G& g, const H& h) {
return Tuple8(a, b, c, d, e, f, g, h);
}
// 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);
}
template
inline Tuple8 MakeRefTuple(A& a, B& b, C& c,
D& d, E& e, F& f,
G& g, H& h) {
return Tuple8(a, b, c, d, e, f, g, h);
}
// 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)(base::cef_internal::UnwrapTraits::Unwrap(arg));
}
template
inline void DispatchToMethod(ObjT* obj, Method method, const Tuple1& arg) {
(obj->*method)(base::cef_internal::UnwrapTraits::Unwrap(arg.a));
}
template
inline void DispatchToMethod(ObjT* obj,
Method method,
const Tuple2& arg) {
(obj->*method)(base::cef_internal::UnwrapTraits::Unwrap(arg.a),
base::cef_internal::UnwrapTraits::Unwrap(arg.b));
}
template
inline void DispatchToMethod(ObjT* obj, Method method,
const Tuple3& arg) {
(obj->*method)(base::cef_internal::UnwrapTraits::Unwrap(arg.a),
base::cef_internal::UnwrapTraits::Unwrap(arg.b),
base::cef_internal::UnwrapTraits::Unwrap(arg.c));
}
template
inline void DispatchToMethod(ObjT* obj, Method method,
const Tuple4& arg) {
(obj->*method)(base::cef_internal::UnwrapTraits::Unwrap(arg.a),
base::cef_internal::UnwrapTraits::Unwrap(arg.b),
base::cef_internal::UnwrapTraits::Unwrap(arg.c),
base::cef_internal::UnwrapTraits::Unwrap(arg.d));
}
template
inline void DispatchToMethod(ObjT* obj, Method method,
const Tuple5& arg) {
(obj->*method)(base::cef_internal::UnwrapTraits::Unwrap(arg.a),
base::cef_internal::UnwrapTraits::Unwrap(arg.b),
base::cef_internal::UnwrapTraits::Unwrap(arg.c),
base::cef_internal::UnwrapTraits::Unwrap(arg.d),
base::cef_internal::UnwrapTraits::Unwrap(arg.e));
}
template
inline void DispatchToMethod(ObjT* obj, Method method,
const Tuple6& arg) {
(obj->*method)(base::cef_internal::UnwrapTraits::Unwrap(arg.a),
base::cef_internal::UnwrapTraits::Unwrap(arg.b),
base::cef_internal::UnwrapTraits::Unwrap(arg.c),
base::cef_internal::UnwrapTraits::Unwrap(arg.d),
base::cef_internal::UnwrapTraits::Unwrap(arg.e),
base::cef_internal::UnwrapTraits::Unwrap(arg.f));
}
template
inline void DispatchToMethod(ObjT* obj, Method method,
const Tuple7& arg) {
(obj->*method)(base::cef_internal::UnwrapTraits::Unwrap(arg.a),
base::cef_internal::UnwrapTraits::Unwrap(arg.b),
base::cef_internal::UnwrapTraits::Unwrap(arg.c),
base::cef_internal::UnwrapTraits::Unwrap(arg.d),
base::cef_internal::UnwrapTraits::Unwrap(arg.e),
base::cef_internal::UnwrapTraits::Unwrap(arg.f),
base::cef_internal::UnwrapTraits::Unwrap(arg.g));
}
template
inline void DispatchToMethod(ObjT* obj, Method method,
const Tuple8& arg) {
(obj->*method)(base::cef_internal::UnwrapTraits::Unwrap(arg.a),
base::cef_internal::UnwrapTraits::Unwrap(arg.b),
base::cef_internal::UnwrapTraits::Unwrap(arg.c),
base::cef_internal::UnwrapTraits::Unwrap(arg.d),
base::cef_internal::UnwrapTraits::Unwrap(arg.e),
base::cef_internal::UnwrapTraits