function-closure.hpp

Go to the documentation of this file.

/*
  FUNCTION-CLOSURE.hpp  -  metaprogramming tools for closing a function over given arguments

  Copyright (C)         Lumiera.org
    2009,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/


#ifndef LIB_META_FUNCTION_CLOSURE_H
#define LIB_META_FUNCTION_CLOSURE_H

#include "lib/meta/function.hpp"
#include "lib/meta/tuple-helper.hpp"
#include "lib/util.hpp"

#include <functional>
#include <utility>
#include <tuple>



namespace lib {
namespace meta{
namespace func{
  
  using std::tuple;
  using std::function;
  using std::forward;
  using std::move;
  
  
  
  
  namespace { // helpers for binding and applying a function to an argument tuple
    
    using std::get;
    
    template<uint n>
    struct Apply;
    
    
    template<>                                            //__________________________________
    struct Apply<0>                                      
      {
        template<typename RET, class FUN, class TUP>
        static RET
        invoke (FUN& f, TUP&)
          {
            return f ();
          }
        
        template<typename RET, class FUN, class TUP>
        static RET
        bind (FUN& f, TUP&)
          {
            return std::bind (f);
          }
      };
    
    
    template<>                                            //_________________________________
    struct Apply<1>                                      
      {
        template<typename RET, class FUN, class TUP>
        static RET
        invoke (FUN& f, TUP & arg)
          {
            return f (get<0>(arg));
          }
        
        template<typename RET, class FUN, class TUP>
        static RET
        bind (FUN& f, TUP & arg)
          {
            return std::bind (f, get<0>(arg));
          }
      };
    
    
    template<>                                            //_________________________________
    struct Apply<2>                                      
      {
        template<typename RET, class FUN, class TUP>
        static RET
        invoke (FUN& f, TUP & arg)
          {
            return f ( get<0>(arg)
                     , get<1>(arg)
                     );
          }
        
        template<typename RET, class FUN, class TUP>
        static RET
        bind (FUN& f, TUP & arg)
          {
            return std::bind (f, get<0>(arg)
                               , get<1>(arg)
                              );
          }
      };
    
    
    template<>                                            //_________________________________
    struct Apply<3>                                      
      {
        template<typename RET, class FUN, class TUP>
        static RET
        invoke (FUN& f, TUP & arg)
          {
            return f ( get<0>(arg)
                     , get<1>(arg)
                     , get<2>(arg)
                     );
          }
        
        template<typename RET, class FUN, class TUP>
        static RET
        bind (FUN& f, TUP & arg)
          {
            return std::bind (f, get<0>(arg)
                               , get<1>(arg)
                               , get<2>(arg)
                              );
          }
      };
    
    
    template<>                                            //_________________________________
    struct Apply<4>                                      
      {
        template<typename RET, class FUN, class TUP>
        static RET
        invoke (FUN& f, TUP & arg)
          {
            return f ( get<0>(arg)
                     , get<1>(arg)
                     , get<2>(arg)
                     , get<3>(arg)
                     );
          }
        
        template<typename RET, class FUN, class TUP>
        static RET
        bind (FUN& f, TUP & arg)
          {
            return std::bind (f, get<0>(arg)
                               , get<1>(arg)
                               , get<2>(arg)
                               , get<3>(arg)
                              );
          }
      };
    
    
    template<>                                            //_________________________________
    struct Apply<5>                                      
      {
        template<typename RET, class FUN, class TUP>
        static RET
        invoke (FUN& f, TUP & arg)
          {
            return f ( get<0>(arg)
                     , get<1>(arg)
                     , get<2>(arg)
                     , get<3>(arg)
                     , get<4>(arg)
                     );
          }
        
        template<typename RET, class FUN, class TUP>
        static RET
        bind (FUN& f, TUP & arg)
          {
            return std::bind (f, get<0>(arg)
                               , get<1>(arg)
                               , get<2>(arg)
                               , get<3>(arg)
                               , get<4>(arg)
                              );
          }
      };
    
    
    template<>                                            //_________________________________
    struct Apply<6>                                      
      {
        template<typename RET, class FUN, class TUP>
        static RET
        invoke (FUN& f, TUP & arg)
          {
            return f ( get<0>(arg)
                     , get<1>(arg)
                     , get<2>(arg)
                     , get<3>(arg)
                     , get<4>(arg)
                     , get<5>(arg)
                     );
          }
        
        template<typename RET, class FUN, class TUP>
        static RET
        bind (FUN& f, TUP & arg)
          {
            return std::bind (f, get<0>(arg)
                               , get<1>(arg)
                               , get<2>(arg)
                               , get<3>(arg)
                               , get<4>(arg)
                               , get<5>(arg)
                              );
          }
      };
    
    
    template<>                                            //_________________________________
    struct Apply<7>                                      
      {
        template<typename RET, class FUN, class TUP>
        static RET
        invoke (FUN& f, TUP & arg)
          {
            return f ( get<0>(arg)
                     , get<1>(arg)
                     , get<2>(arg)
                     , get<3>(arg)
                     , get<4>(arg)
                     , get<5>(arg)
                     , get<6>(arg)
                     );
          }
        
        template<typename RET, class FUN, class TUP>
        static RET
        bind (FUN& f, TUP & arg)
          {
            return std::bind (f, get<0>(arg)
                               , get<1>(arg)
                               , get<2>(arg)
                               , get<3>(arg)
                               , get<4>(arg)
                               , get<5>(arg)
                               , get<6>(arg)
                              );
          }
      };
    
    
    template<>                                            //_________________________________
    struct Apply<8>                                      
      {
        template<typename RET, class FUN, class TUP>
        static RET
        invoke (FUN& f, TUP & arg)
          {
            return f ( get<0>(arg)
                     , get<1>(arg)
                     , get<2>(arg)
                     , get<3>(arg)
                     , get<4>(arg)
                     , get<5>(arg)
                     , get<6>(arg)
                     , get<7>(arg)
                     );
          }
        
        template<typename RET, class FUN, class TUP>
        static RET
        bind (FUN& f, TUP & arg)
          {
            return std::bind (f, get<0>(arg)
                               , get<1>(arg)
                               , get<2>(arg)
                               , get<3>(arg)
                               , get<4>(arg)
                               , get<5>(arg)
                               , get<6>(arg)
                               , get<7>(arg)
                              );
          }
      };
    
    
    template<>                                            //_________________________________
    struct Apply<9>                                      
      {
        template<typename RET, class FUN, class TUP>
        static RET
        invoke (FUN& f, TUP & arg)
          {
            return f ( get<0>(arg)
                     , get<1>(arg)
                     , get<2>(arg)
                     , get<3>(arg)
                     , get<4>(arg)
                     , get<5>(arg)
                     , get<6>(arg)
                     , get<7>(arg)
                     , get<8>(arg)
                     );
          }
        
        template<typename RET, class FUN, class TUP>
        static RET
        bind (FUN& f, TUP & arg)
          {
            return std::bind (f, get<0>(arg)
                               , get<1>(arg)
                               , get<2>(arg)
                               , get<3>(arg)
                               , get<4>(arg)
                               , get<5>(arg)
                               , get<6>(arg)
                               , get<7>(arg)
                               , get<8>(arg)
                              );
          }
      };
    
    
    
    
    
    
    /* ===== Helpers for partial function application ===== */
    
    using std::_Placeholder;
    
    
    template<typename TYPES, size_t i=1>
    struct PlaceholderTuple
      : PlaceholderTuple<typename TYPES::List>
      { };
    
    template<typename X, typename TAIL, size_t i>
    struct PlaceholderTuple<Node<X,TAIL>, i>
      {
        using TailPlaceholders = typename PlaceholderTuple<TAIL,i+1>::List;
        
        using List = Node<_Placeholder<i>, TailPlaceholders>;
      };
    
    template<size_t i>
    struct PlaceholderTuple<NullType, i>
      {
        using List = NullType;
      };
    
    
    
    using std::tuple_element;
    using std::tuple_size;
    using std::get;
    
    
    template<typename SRC, typename TAR, size_t start>
    struct PartiallyInitTuple
      {
        template<size_t i>
        using DestType = typename std::tuple_element<i, TAR>::type;
        
        
        static constexpr bool
        useArg (size_t idx)
          {
            return (start <= idx)
               and (idx < start + std::tuple_size<SRC>());
          }
        
        
        
        template<size_t idx,   bool doPick = PartiallyInitTuple::useArg(idx)>
        struct IndexMapper
          {
            SRC const& initArgs;
            
            operator DestType<idx>()
              {
                return std::get<idx-start> (initArgs);
              }
          };
        
        template<size_t idx>
        struct IndexMapper<idx, false>
          {
            SRC const& initArgs;
            
            operator DestType<idx>()
              {
                return DestType<idx>();
              }
          };
      };
    
  } // (END) impl-namespace
  
  
  
  
  /* ======= core operations: closures and partial application ========= */
  
  template<typename SIG>
  class TupleApplicator
    {
      using Args = typename _Fun<SIG>::Args;
      using Ret  = typename _Fun<SIG>::Ret;
      
      using BoundFunc = function<Ret()>;
      
      enum { ARG_CNT = count<typename Args::List>::value };
      
      
      Tuple<Args>& params_;
      
    public:
      TupleApplicator (Tuple<Args>& args)
        : params_(args)
        { }
      
      BoundFunc bind (SIG& f)                 { return Apply<ARG_CNT>::template bind<BoundFunc> (f, params_); }
      BoundFunc bind (function<SIG> const& f) { return Apply<ARG_CNT>::template bind<BoundFunc> (f, params_); }
      
      Ret operator() (SIG& f)                 { return Apply<ARG_CNT>::template invoke<Ret> (f, params_); }
      Ret operator() (function<SIG>& f)       { return Apply<ARG_CNT>::template invoke<Ret> (f, params_); }
    };
  
  
  
  template<typename SIG>
  class FunctionClosure
    {
      typedef typename _Fun<SIG>::Args Args;
      typedef typename _Fun<SIG>::Ret  Ret;
      
      function<Ret(void)> closure_;
      
    public:
      FunctionClosure (SIG& f, Tuple<Args>& arg)
        : closure_(TupleApplicator<SIG>(arg).bind(f))
        { }
      FunctionClosure (function<SIG> const& f, Tuple<Args>& arg)
        : closure_(TupleApplicator<SIG>(arg).bind(f))
        { }
      
      Ret operator() () { return closure_(); }
      
      typedef Ret  result_type;  
      typedef void argument_type;
    };
  
  
  
  
  template<typename SIG, typename VAL>
  class PApply
    {
      typedef typename _Fun<SIG>::Args Args;
      typedef typename _Fun<SIG>::Ret  Ret;
      typedef typename Args::List ArgsList;
      typedef typename VAL::List ValList;
      typedef typename Types<ValList>::Seq ValTypes;
      
      enum { ARG_CNT = count<ArgsList>::value
           , VAL_CNT = count<ValList> ::value
           , ROFFSET = (VAL_CNT < ARG_CNT)? ARG_CNT-VAL_CNT : 0
           };
      
      
      // create list of the *remaining* arguments, after applying the ValList
      typedef typename Splice<ArgsList, ValList>::Back           LeftReduced;
      typedef typename Splice<ArgsList, ValList, ROFFSET>::Front RightReduced;
      
      typedef typename Types<LeftReduced>::Seq  ArgsL;
      typedef typename Types<RightReduced>::Seq ArgsR;
      
      
      // build a list, where each of the *remaining* arguments is replaced by a placeholder marker
      typedef typename func::PlaceholderTuple<LeftReduced>::List  TrailingPlaceholders;
      typedef typename func::PlaceholderTuple<RightReduced>::List LeadingPlaceholders;
      
      // ... and splice these placeholders on top of the original argument type list,
      // thus retaining the types to be closed, but setting a placeholder for each remaining argument
      typedef typename Splice<ArgsList, TrailingPlaceholders, VAL_CNT>::List LeftReplaced;
      typedef typename Splice<ArgsList, LeadingPlaceholders, 0     >::List RightReplaced;
      
      typedef typename Types<LeftReplaced>::Seq  LeftReplacedTypes;
      typedef typename Types<RightReplaced>::Seq RightReplacedTypes;
      
      // create a "builder" helper, which accepts exactly the value tuple elements
      // and puts them at the right location, while default-constructing the remaining
      // (=placeholder)-arguments. Using this builder helper, we can finally set up
      // the argument tuples (Left/RightReplacedArgs) used for the std::bind call
      template<class SRC, class TAR, size_t i>
      using IdxSelectorL = typename PartiallyInitTuple<SRC, TAR, 0>::template IndexMapper<i>;
      
      template<class SRC, class TAR, size_t i>
      using IdxSelectorR = typename PartiallyInitTuple<SRC, TAR, ROFFSET>::template IndexMapper<i>;
      
      using BuildL = TupleConstructor<LeftReplacedTypes, IdxSelectorL>;
      using BuildR = TupleConstructor<RightReplacedTypes, IdxSelectorR>;
      
      
      using LeftReplacedArgs  = Tuple<LeftReplacedTypes>;
      
      using RightReplacedArgs = Tuple<RightReplacedTypes>;
      
      
    public:
      typedef function<typename BuildFunType<Ret,ArgsL>::Sig> LeftReducedFunc;
      typedef function<typename BuildFunType<Ret,ArgsR>::Sig> RightReducedFunc;
      
      
      static LeftReducedFunc
      bindFront (SIG const& f, Tuple<ValTypes> const& arg)
        {
          LeftReplacedArgs params {BuildL(arg)};
          return func::Apply<ARG_CNT>::template bind<LeftReducedFunc> (f, params);
        }
      
      static RightReducedFunc
      bindBack (SIG const& f, Tuple<ValTypes> const& arg)
        {
          RightReplacedArgs params {BuildR(arg)};
          return func::Apply<ARG_CNT>::template bind<RightReducedFunc> (f, params);
        }
    };
  
  
  
  template<typename SIG, typename X, uint pos>
  class BindToArgument
    {
      typedef typename _Fun<SIG>::Args Args;
      typedef typename _Fun<SIG>::Ret  Ret;
      typedef typename Args::List ArgsList;
      typedef typename Types<X>::List ValList;
      
      enum { ARG_CNT = count<ArgsList>::value };

      typedef typename Splice<ArgsList, ValList, pos>::Front RemainingFront;
      typedef typename Splice<ArgsList, ValList, pos>::Back  RemainingBack;
      typedef typename func::PlaceholderTuple<RemainingFront>::List PlaceholdersBefore;
      typedef typename func::PlaceholderTuple<RemainingBack,pos+1>::List PlaceholdersBehind;
      typedef typename Append< typename Append< PlaceholdersBefore
                                              , ValList >::List
                             , PlaceholdersBehind >::List          PreparedArgs;
      typedef typename Append<RemainingFront, RemainingBack>::List ReducedArgs;
      
      using PreparedArgTypes = typename Types<PreparedArgs>::Seq;
      using RemainingArgs    = typename Types<ReducedArgs>::Seq;
      
      using ReducedSig = typename BuildFunType<Ret,RemainingArgs>::Sig;
      
      template<class SRC, class TAR, size_t i>
      using IdxSelector = typename PartiallyInitTuple<SRC, TAR, pos>::template IndexMapper<i>;
      
      using BuildPreparedArgs = TupleConstructor<PreparedArgTypes, IdxSelector>;
      
      
      
    public:
      typedef function<ReducedSig> ReducedFunc;
      
      static ReducedFunc
      reduced (SIG& f, Tuple<Types<X>> const& val)
        {
          Tuple<PreparedArgTypes> params {BuildPreparedArgs(val)};
          return func::Apply<ARG_CNT>::template bind<ReducedFunc> (f, params);
        }
    };
  
  
  
  namespace { // ...helpers for specifying types in function declarations....
    
    using std::get;
    using util::unConst;
    
    
    template<typename RET, typename ARG>
    struct _Sig
      {
        typedef typename BuildFunType<RET, ARG>::Sig Type;
        typedef TupleApplicator<Type> Applicator;
      };
    
    template<typename SIG, typename ARG>
    struct _Clo
      {
        typedef typename _Fun<SIG>::Ret Ret;
        typedef typename _Sig<Ret,ARG>::Type Signature;
        typedef FunctionClosure<Signature> Type;
      };
    
    template<typename FUN1, typename FUN2>
    struct _Chain
      {
        using Ret  = typename _Fun<FUN2>::Ret;
        using Args = typename _Fun<FUN1>::Args;
        
        using FunType = typename BuildFunType<Ret,Args>::Fun;
        static auto adaptedFunType() { return FunType{}; }
        
        
        template<typename F1, typename F2
                ,typename RET, typename... ARGS>
        static auto
        composedFunctions (F1&& f1, F2&& f2, _Fun<RET(ARGS...)>)
          {
            tuple<F1,F2> binding{forward<F1> (f1)
                                ,forward<F2> (f2)
                                };
            return [binding = move(binding)]
                   (ARGS ...args) -> RET
                      {
                        auto& functor1 = get<0>(binding);
                        auto& functor2 = get<1>(binding);
                        //
                        return functor2 (functor1 (forward<ARGS> (args)...));
                      };
          }
      };
    
    template<typename FUN>
    struct _PapS
      {
        using Ret  = typename _Fun<FUN>::Ret;
        using Args = typename _Fun<FUN>::Args;
        using Arg  = typename Split<Args>::Head;
        using Rest = typename Split<Args>::Tail;
        
        using FunType = typename BuildFunType<Ret,Rest>::Fun;
        static auto adaptedFunType() { return FunType{}; }
        
        
        template<typename F, typename A
                ,typename RET, typename... ARGS>
        static auto
        bindFrontArg (F&& fun, A&& arg, _Fun<RET(ARGS...)>)
          {
            tuple<F,A> binding{forward<F> (fun)
                              ,forward<A> (arg)
                              };
            return [binding = move(binding)]
                   (ARGS ...args) -> RET
                      {
                        auto& functor = get<0>(binding);
                        //                           //Warning: might corrupt ownership
                        return functor ( forward<A> (unConst (get<1>(binding)))
                                       , forward<ARGS> (args)...);
                      };
          }
      };
    
    template<typename FUN>
    struct _PapE
      {
        using Ret  = typename _Fun<FUN>::Ret;
        using Args = typename _Fun<FUN>::Args;
        using Arg  = typename Split<Args>::End;
        using Rest = typename Split<Args>::Prefix;
        
        using FunType = typename BuildFunType<Ret,Rest>::Fun;
        static auto adaptedFunType() { return FunType{}; }
        
        
        template<typename F, typename A
                ,typename RET, typename... ARGS>
        static auto
        bindBackArg (F&& fun, A&& arg, _Fun<RET(ARGS...)>)
          {
            tuple<F,A> binding{forward<F> (fun)
                              ,forward<A> (arg)
                              };
            return [binding = move(binding)]
                   (ARGS ...args) -> RET
                      {
                        auto& functor = get<0>(binding);
                        //
                        return functor ( forward<ARGS> (args)...
                                       , forward<A> (unConst (get<1>(binding))));
                      };
          }
      };
    
  } // (End) argument type shortcuts
  
  
  
  
  /*  ========== function-style interface =============  */
  
  template<typename...ARG>
  inline
  typename _Sig<void, Types<ARG...>>::Applicator
  tupleApplicator (std::tuple<ARG...>& args)
  {
    typedef typename _Sig<void,Types<ARG...>>::Type Signature;
    return TupleApplicator<Signature> (args);
  }
  
  
  template<typename SIG, typename...ARG>
  inline
  typename _Fun<SIG>::Ret
  apply (SIG& f, std::tuple<ARG...>& args)
  {
    typedef typename _Fun<SIG>::Ret Ret;                          //
    typedef typename _Sig<Ret,Types<ARG...>>::Type Signature;    // Note: deliberately re-building the Signature Type
    return TupleApplicator<Signature> (args) (f);               //        in order to get better error messages here
  }
  
  template<typename SIG, typename...ARG>
  inline
  typename _Clo<SIG,Types<ARG...>>::Type
  closure (SIG& f, std::tuple<ARG...>& args)
  {
    typedef typename _Clo<SIG,Types<ARG...>>::Type Closure;
    return Closure (f,args);
  }
  
  
  template<typename FUN, typename ARG>
  inline auto
  applyFirst (FUN&& fun, ARG&& arg)
  {
    static_assert (_Fun<FUN>(), "expect something function-like");
    return _PapS<FUN>::bindFrontArg (forward<FUN> (fun)
                                    ,forward<ARG> (arg)
                                    ,_PapS<FUN>::adaptedFunType());
  }
  
  template<typename FUN, typename ARG>
  inline auto
  applyLast (FUN&& fun, ARG&& arg)
  {
    static_assert (_Fun<FUN>(), "expect something function-like");
    return _PapE<FUN>::bindBackArg (forward<FUN> (fun)
                                   ,forward<ARG> (arg)
                                   ,_PapE<FUN>::adaptedFunType());
  }
  
  
  template<typename SIG, typename TERM>
  inline
  typename _PapE<SIG>::FunType::Functor
  bindLast (SIG& f, TERM const& arg)
  {
    typedef Types<TERM>     ArgTypeSeq;
    typedef Tuple<ArgTypeSeq> ArgTuple;
    ArgTuple argT(arg);
    enum { LAST_POS = -1 + count<typename _Fun<SIG>::Args::List>::value };
    return BindToArgument<SIG,TERM,LAST_POS>::reduced (f, argT);
  }
  
  
  template<typename FUN1, typename FUN2>
  inline auto
  chained (FUN1&& f1, FUN2&& f2)
  {
    static_assert (_Fun<FUN1>(), "expect something function-like for function-1");
    static_assert (_Fun<FUN2>(), "expect something function-like for function-2");
    using Chain = _Chain<FUN1,FUN2>;
    return Chain::composedFunctions (forward<FUN1> (f1)
                                    ,forward<FUN2> (f2)
                                    ,Chain::adaptedFunType());
  }
  
  
  
}}} // namespace lib::meta::func
#endif