cannam@134: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
cannam@134: // Licensed under the MIT License:
cannam@134: //
cannam@134: // Permission is hereby granted, free of charge, to any person obtaining a copy
cannam@134: // of this software and associated documentation files (the "Software"), to deal
cannam@134: // in the Software without restriction, including without limitation the rights
cannam@134: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
cannam@134: // copies of the Software, and to permit persons to whom the Software is
cannam@134: // furnished to do so, subject to the following conditions:
cannam@134: //
cannam@134: // The above copyright notice and this permission notice shall be included in
cannam@134: // all copies or substantial portions of the Software.
cannam@134: //
cannam@134: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
cannam@134: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
cannam@134: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
cannam@134: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
cannam@134: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
cannam@134: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
cannam@134: // THE SOFTWARE.
cannam@134: 
cannam@134: #ifndef KJ_FUNCTION_H_
cannam@134: #define KJ_FUNCTION_H_
cannam@134: 
cannam@134: #if defined(__GNUC__) && !KJ_HEADER_WARNINGS
cannam@134: #pragma GCC system_header
cannam@134: #endif
cannam@134: 
cannam@134: #include "memory.h"
cannam@134: 
cannam@134: namespace kj {
cannam@134: 
cannam@134: template <typename Signature>
cannam@134: class Function;
cannam@134: // Function wrapper using virtual-based polymorphism.  Use this when template polymorphism is
cannam@134: // not possible.  You can, for example, accept a Function as a parameter:
cannam@134: //
cannam@134: //     void setFilter(Function<bool(const Widget&)> filter);
cannam@134: //
cannam@134: // The caller of `setFilter()` may then pass any callable object as the parameter.  The callable
cannam@134: // object does not have to have the exact signature specified, just one that is "compatible" --
cannam@134: // i.e. the return type is covariant and the parameters are contravariant.
cannam@134: //
cannam@134: // Unlike `std::function`, `kj::Function`s are movable but not copyable, just like `kj::Own`.  This
cannam@134: // is to avoid unexpected heap allocation or slow atomic reference counting.
cannam@134: //
cannam@134: // When a `Function` is constructed from an lvalue, it captures only a reference to the value.
cannam@134: // When constructed from an rvalue, it invokes the value's move constructor.  So, for example:
cannam@134: //
cannam@134: //     struct AddN {
cannam@134: //       int n;
cannam@134: //       int operator(int i) { return i + n; }
cannam@134: //     }
cannam@134: //
cannam@134: //     Function<int(int, int)> f1 = AddN{2};
cannam@134: //     // f1 owns an instance of AddN.  It may safely be moved out
cannam@134: //     // of the local scope.
cannam@134: //
cannam@134: //     AddN adder(2);
cannam@134: //     Function<int(int, int)> f2 = adder;
cannam@134: //     // f2 contains a reference to `adder`.  Thus, it becomes invalid
cannam@134: //     // when `adder` goes out-of-scope.
cannam@134: //
cannam@134: //     AddN adder2(2);
cannam@134: //     Function<int(int, int)> f3 = kj::mv(adder2);
cannam@134: //     // f3 owns an insatnce of AddN moved from `adder2`.  f3 may safely
cannam@134: //     // be moved out of the local scope.
cannam@134: //
cannam@134: // Additionally, a Function may be bound to a class method using KJ_BIND_METHOD(object, methodName).
cannam@134: // For example:
cannam@134: //
cannam@134: //     class Printer {
cannam@134: //     public:
cannam@134: //       void print(int i);
cannam@134: //       void print(kj::StringPtr s);
cannam@134: //     };
cannam@134: //
cannam@134: //     Printer p;
cannam@134: //
cannam@134: //     Function<void(uint)> intPrinter = KJ_BIND_METHOD(p, print);
cannam@134: //     // Will call Printer::print(int).
cannam@134: //
cannam@134: //     Function<void(const char*)> strPrinter = KJ_BIND_METHOD(p, print);
cannam@134: //     // Will call Printer::print(kj::StringPtr).
cannam@134: //
cannam@134: // Notice how KJ_BIND_METHOD is able to figure out which overload to use depending on the kind of
cannam@134: // Function it is binding to.
cannam@134: 
cannam@134: template <typename Signature>
cannam@134: class ConstFunction;
cannam@134: // Like Function, but wraps a "const" (i.e. thread-safe) call.
cannam@134: 
cannam@134: template <typename Return, typename... Params>
cannam@134: class Function<Return(Params...)> {
cannam@134: public:
cannam@134:   template <typename F>
cannam@134:   inline Function(F&& f): impl(heap<Impl<F>>(kj::fwd<F>(f))) {}
cannam@134:   Function() = default;
cannam@134: 
cannam@134:   // Make sure people don't accidentally end up wrapping a reference when they meant to return
cannam@134:   // a function.
cannam@134:   KJ_DISALLOW_COPY(Function);
cannam@134:   Function(Function&) = delete;
cannam@134:   Function& operator=(Function&) = delete;
cannam@134:   template <typename T> Function(const Function<T>&) = delete;
cannam@134:   template <typename T> Function& operator=(const Function<T>&) = delete;
cannam@134:   template <typename T> Function(const ConstFunction<T>&) = delete;
cannam@134:   template <typename T> Function& operator=(const ConstFunction<T>&) = delete;
cannam@134:   Function(Function&&) = default;
cannam@134:   Function& operator=(Function&&) = default;
cannam@134: 
cannam@134:   inline Return operator()(Params... params) {
cannam@134:     return (*impl)(kj::fwd<Params>(params)...);
cannam@134:   }
cannam@134: 
cannam@134:   Function reference() {
cannam@134:     // Forms a new Function of the same type that delegates to this Function by reference.
cannam@134:     // Therefore, this Function must outlive the returned Function, but otherwise they behave
cannam@134:     // exactly the same.
cannam@134: 
cannam@134:     return *impl;
cannam@134:   }
cannam@134: 
cannam@134: private:
cannam@134:   class Iface {
cannam@134:   public:
cannam@134:     virtual Return operator()(Params... params) = 0;
cannam@134:   };
cannam@134: 
cannam@134:   template <typename F>
cannam@134:   class Impl final: public Iface {
cannam@134:   public:
cannam@134:     explicit Impl(F&& f): f(kj::fwd<F>(f)) {}
cannam@134: 
cannam@134:     Return operator()(Params... params) override {
cannam@134:       return f(kj::fwd<Params>(params)...);
cannam@134:     }
cannam@134: 
cannam@134:   private:
cannam@134:     F f;
cannam@134:   };
cannam@134: 
cannam@134:   Own<Iface> impl;
cannam@134: };
cannam@134: 
cannam@134: template <typename Return, typename... Params>
cannam@134: class ConstFunction<Return(Params...)> {
cannam@134: public:
cannam@134:   template <typename F>
cannam@134:   inline ConstFunction(F&& f): impl(heap<Impl<F>>(kj::fwd<F>(f))) {}
cannam@134:   ConstFunction() = default;
cannam@134: 
cannam@134:   // Make sure people don't accidentally end up wrapping a reference when they meant to return
cannam@134:   // a function.
cannam@134:   KJ_DISALLOW_COPY(ConstFunction);
cannam@134:   ConstFunction(ConstFunction&) = delete;
cannam@134:   ConstFunction& operator=(ConstFunction&) = delete;
cannam@134:   template <typename T> ConstFunction(const ConstFunction<T>&) = delete;
cannam@134:   template <typename T> ConstFunction& operator=(const ConstFunction<T>&) = delete;
cannam@134:   template <typename T> ConstFunction(const Function<T>&) = delete;
cannam@134:   template <typename T> ConstFunction& operator=(const Function<T>&) = delete;
cannam@134:   ConstFunction(ConstFunction&&) = default;
cannam@134:   ConstFunction& operator=(ConstFunction&&) = default;
cannam@134: 
cannam@134:   inline Return operator()(Params... params) const {
cannam@134:     return (*impl)(kj::fwd<Params>(params)...);
cannam@134:   }
cannam@134: 
cannam@134:   ConstFunction reference() const {
cannam@134:     // Forms a new ConstFunction of the same type that delegates to this ConstFunction by reference.
cannam@134:     // Therefore, this ConstFunction must outlive the returned ConstFunction, but otherwise they
cannam@134:     // behave exactly the same.
cannam@134: 
cannam@134:     return *impl;
cannam@134:   }
cannam@134: 
cannam@134: private:
cannam@134:   class Iface {
cannam@134:   public:
cannam@134:     virtual Return operator()(Params... params) const = 0;
cannam@134:   };
cannam@134: 
cannam@134:   template <typename F>
cannam@134:   class Impl final: public Iface {
cannam@134:   public:
cannam@134:     explicit Impl(F&& f): f(kj::fwd<F>(f)) {}
cannam@134: 
cannam@134:     Return operator()(Params... params) const override {
cannam@134:       return f(kj::fwd<Params>(params)...);
cannam@134:     }
cannam@134: 
cannam@134:   private:
cannam@134:     F f;
cannam@134:   };
cannam@134: 
cannam@134:   Own<Iface> impl;
cannam@134: };
cannam@134: 
cannam@134: #if 1
cannam@134: 
cannam@134: namespace _ {  // private
cannam@134: 
cannam@134: template <typename T, typename Signature, Signature method>
cannam@134: class BoundMethod;
cannam@134: 
cannam@134: template <typename T, typename Return, typename... Params, Return (Decay<T>::*method)(Params...)>
cannam@134: class BoundMethod<T, Return (Decay<T>::*)(Params...), method> {
cannam@134: public:
cannam@134:   BoundMethod(T&& t): t(kj::fwd<T>(t)) {}
cannam@134: 
cannam@134:   Return operator()(Params&&... params) {
cannam@134:     return (t.*method)(kj::fwd<Params>(params)...);
cannam@134:   }
cannam@134: 
cannam@134: private:
cannam@134:   T t;
cannam@134: };
cannam@134: 
cannam@134: template <typename T, typename Return, typename... Params,
cannam@134:           Return (Decay<T>::*method)(Params...) const>
cannam@134: class BoundMethod<T, Return (Decay<T>::*)(Params...) const, method> {
cannam@134: public:
cannam@134:   BoundMethod(T&& t): t(kj::fwd<T>(t)) {}
cannam@134: 
cannam@134:   Return operator()(Params&&... params) const {
cannam@134:     return (t.*method)(kj::fwd<Params>(params)...);
cannam@134:   }
cannam@134: 
cannam@134: private:
cannam@134:   T t;
cannam@134: };
cannam@134: 
cannam@134: }  // namespace _ (private)
cannam@134: 
cannam@134: #define KJ_BIND_METHOD(obj, method) \
cannam@134:   ::kj::_::BoundMethod<KJ_DECLTYPE_REF(obj), \
cannam@134:                        decltype(&::kj::Decay<decltype(obj)>::method), \
cannam@134:                        &::kj::Decay<decltype(obj)>::method>(obj)
cannam@134: // Macro that produces a functor object which forwards to the method `obj.name`.  If `obj` is an
cannam@134: // lvalue, the functor will hold a reference to it.  If `obj` is an rvalue, the functor will
cannam@134: // contain a copy (by move) of it.
cannam@134: //
cannam@134: // The current implementation requires that the method is not overloaded.
cannam@134: //
cannam@134: // TODO(someday):  C++14's generic lambdas may be able to simplify this code considerably, and
cannam@134: //   probably make it work with overloaded methods.
cannam@134: 
cannam@134: #else
cannam@134: // Here's a better implementation of the above that doesn't work with GCC (but does with Clang)
cannam@134: // because it uses a local class with a template method.  Sigh.  This implementation supports
cannam@134: // overloaded methods.
cannam@134: 
cannam@134: #define KJ_BIND_METHOD(obj, method) \
cannam@134:   ({ \
cannam@134:     typedef KJ_DECLTYPE_REF(obj) T; \
cannam@134:     class F { \
cannam@134:     public: \
cannam@134:       inline F(T&& t): t(::kj::fwd<T>(t)) {} \
cannam@134:       template <typename... Params> \
cannam@134:       auto operator()(Params&&... params) \
cannam@134:           -> decltype(::kj::instance<T>().method(::kj::fwd<Params>(params)...)) { \
cannam@134:         return t.method(::kj::fwd<Params>(params)...); \
cannam@134:       } \
cannam@134:     private: \
cannam@134:       T t; \
cannam@134:     }; \
cannam@134:     (F(obj)); \
cannam@134:   })
cannam@134: // Macro that produces a functor object which forwards to the method `obj.name`.  If `obj` is an
cannam@134: // lvalue, the functor will hold a reference to it.  If `obj` is an rvalue, the functor will
cannam@134: // contain a copy (by move) of it.
cannam@134: 
cannam@134: #endif
cannam@134: 
cannam@134: }  // namespace kj
cannam@134: 
cannam@134: #endif  // KJ_FUNCTION_H_