ChaiScript/include/chaiscript/dispatchkit/proxy_functions.hpp

// This file is distributed under the BSD License.
// See "license.txt" for details.
// Copyright 2009, Jonathan Turner (jturner@minnow-lang.org)
// and Jason Turner (lefticus@gmail.com)
// http://www.chaiscript.com

#include <boost/preprocessor.hpp>

#define gettypeinfo(z,n,text)  ti.push_back(Get_Type_Info<Param ## n>::get());
#define casthelper(z,n,text) ,chaiscript::boxed_cast< Param ## n >(params[n])
#define comparetype(z,n,text)  && ((Get_Type_Info<Param ## n>::get() == params[n].get_type_info()))
#define trycast(z,n,text) chaiscript::boxed_cast<Param ## n>(params[n]);


#ifndef  BOOST_PP_IS_ITERATING
#ifndef __proxy_functions_hpp__
#define __proxy_functions_hpp__

#include "boxed_value.hpp"
#include "type_info.hpp"
#include <string>
#include <boost/function.hpp>
#include <boost/bind.hpp>
#include <boost/lexical_cast.hpp>

#include <stdexcept>
#include <vector>

namespace chaiscript
{
  /**
   * Used internally for handling a return value from a Proxy_Function call
   */
  template<typename Ret>
    struct Handle_Return
    {
      Boxed_Value operator()(const boost::function<Ret ()> &f)
      {
        return Boxed_Value(f());
      }
    };

  template<typename Ret>
    struct Handle_Return<boost::shared_ptr<Ret> &>
    {
      Boxed_Value operator()(const boost::function<boost::shared_ptr<Ret> & ()> &f)
      {
        return Boxed_Value(f());
      }
    };

  template<typename Ret>
    struct Handle_Return<const boost::shared_ptr<Ret> &>
    {
      Boxed_Value operator()(const boost::function<const boost::shared_ptr<Ret> & ()> &f)
      {
        return Boxed_Value(f());
      }
    };

  /**
   * Used internally for handling a return value from a Proxy_Function call
   */
  template<typename Ret>
    struct Handle_Return<Ret &>
    {
      Boxed_Value operator()(const boost::function<Ret &()> &f)
      {
        return Boxed_Value(boost::ref(f()));
      }
    };

  /**
   * Used internally for handling a return value from a Proxy_Function call
   */
  template<>
    struct Handle_Return<Boxed_Value>
    {
      Boxed_Value operator()(const boost::function<Boxed_Value ()> &f)
      {
        return f();
      }
    };

  /**
   * Used internally for handling a return value from a Proxy_Function call
   */
  template<>
    struct Handle_Return<Boxed_Value &>
    {
      Boxed_Value operator()(const boost::function<Boxed_Value &()> &f)
      {
        return f();
      }
    };

  /**
   * Used internally for handling a return value from a Proxy_Function call
   */
  template<>
    struct Handle_Return<void>
    {
      Boxed_Value operator()(const boost::function<void ()> &f)
      {
        f();
        return Boxed_Value(Boxed_Value::Void_Type());
      }
    };

  /**
   * Helper for building a list of parameters for calling a Proxy_Function
   * it does automatic conversion to Boxed_Value types via operator<<
   *
   * example usage:
   * Boxed_Value retval = dispatch(dispatchengine.get_function("+"), 
   *                               chaiscript::Param_List_Builder() << 5 << 6);
   */
  struct Param_List_Builder
  {
    Param_List_Builder &operator<<(const Boxed_Value &so)
    {
      objects.push_back(so);
      return *this;
    }

    template<typename T>
      Param_List_Builder &operator<<(T t)
      {
        objects.push_back(Boxed_Value(t));
        return *this;
      }

    operator const std::vector<Boxed_Value> &() const
    {
      return objects;
    }

    std::vector<Boxed_Value> objects;
  };

  /**
   * Exception thrown when there is a mismatch in number of
   * parameters during Proxy_Function execution
   */
  struct arity_error : std::range_error
  {
    arity_error(int t_got, int t_expected)
      : std::range_error("Function dispatch arity mismatch"),
        got(t_got), expected(t_expected)
    {
    }

    virtual ~arity_error() throw() {}
    int got;
    int expected;
  };
}

#define BOOST_PP_ITERATION_LIMITS ( 0, 10 )
#define BOOST_PP_FILENAME_1 <chaiscript/dispatchkit/proxy_functions.hpp>
#include BOOST_PP_ITERATE()

namespace chaiscript
{
  /**
   * Pure virtual base class for all Proxy_Function implementations
   * Proxy_Functions are a type erasure of type safe C++
   * function calls. At runtime parameter types are expected to be
   * tested against passed in types.
   * Dispatch_Engine only knows how to work with Proxy_Function, no other
   * function classes.
   */
  class Proxy_Function_Base
  {
    public:
      virtual ~Proxy_Function_Base() {}
      virtual Boxed_Value operator()(const std::vector<Boxed_Value> &params) = 0;
      virtual std::vector<Type_Info> get_param_types() const = 0;
      virtual bool operator==(const Proxy_Function_Base &) const = 0;
      virtual bool call_match(const std::vector<Boxed_Value> &vals) const = 0;

      //! Return true if the function is a possible match
      //! to the passed in values
      bool filter(const std::vector<Boxed_Value> &vals) const
      {
        int arity = get_arity();

        if (arity < 0)
        {
          return true;
        } else if (size_t(arity) == vals.size()) {
          if (arity == 0)
          {
            return true;
          } else {
            const std::vector<Type_Info> &types = get_param_types();

            if (types.size() < 2)
            {
              return true;
            }

            const Type_Info &ti = types[1];

            if (!ti.m_bare_type_info || !(vals[0].get_type_info().m_bare_type_info)
                || (*ti.m_bare_type_info) == (*user_type<Boxed_Value>().m_bare_type_info)
                || (*ti.m_bare_type_info) == (*user_type<Boxed_POD_Value>().m_bare_type_info)
                || (*vals[0].get_type_info().m_bare_type_info) == (*ti.m_bare_type_info))
            {
              return true;
            } else {
              return false;
            }
          }
        } else {
          return false;
        }
      }

      virtual int get_arity() const = 0;

      virtual std::string annotation() const = 0;
  };

  typedef boost::shared_ptr<Proxy_Function_Base> Proxy_Function;

  /**
   * Exception thrown if a function's guard fails to execute
   */
  class guard_error : public std::runtime_error
  {
    public:
      guard_error() throw()
        : std::runtime_error("Guard evaluation failed")
      { }

      virtual ~guard_error() throw()
      { }
  };

  /**
   * A Proxy_Function implementation that is not type safe, the called function
   * is expecting a vector<Boxed_Value> that it works with how it chooses.
   */
  class Dynamic_Proxy_Function : public Proxy_Function_Base
  {
    public:
      Dynamic_Proxy_Function(
          const boost::function<Boxed_Value (const std::vector<Boxed_Value> &)> &t_f, 
          int t_arity=-1,
          const std::string &t_description = "",
          const Proxy_Function &t_guard = Proxy_Function())
        : m_f(t_f), m_arity(t_arity), m_description(t_description), m_guard(t_guard),
          m_types(build_param_type_list(t_arity))
      {
      }

      virtual bool operator==(const Proxy_Function_Base &) const
      {
        return false;
      }

      virtual bool call_match(const std::vector<Boxed_Value> &vals) const
      {
          return (m_arity < 0 || vals.size() == size_t(m_arity))
            && test_guard(vals);
      }    

      virtual ~Dynamic_Proxy_Function() {}

      virtual Boxed_Value operator()(const std::vector<Boxed_Value> &params)
      {
        if (m_arity < 0 || params.size() == size_t(m_arity))
        {

          if (test_guard(params))
          {
            return m_f(params);
          } else {
            throw guard_error();
          }

        } else {
          throw arity_error(params.size(), m_arity);
        } 
      }

      virtual int get_arity() const
      {
	return m_arity;
      }

      virtual std::vector<Type_Info> get_param_types() const
      {
	return m_types;
      }

      virtual std::string annotation() const
      {
        return m_description;
      }

    private:
      bool test_guard(const std::vector<Boxed_Value> &params) const
      {
        if (m_guard)
        {
          try {
            return boxed_cast<bool>((*m_guard)(params));
          } catch (const arity_error &) {
            return false;
          } catch (const bad_boxed_cast &) {
            return false;
          }
        } else {
          return true;
        }
      }

      static std::vector<Type_Info> build_param_type_list(int arity)
      {
        std::vector<Type_Info> types;

        types.push_back(Get_Type_Info<Boxed_Value>::get());

        if (arity >= 0)
        {
          for (int i = 0; i < arity; ++i)
          {
            types.push_back(Get_Type_Info<Boxed_Value>::get());
          }
        } else {
          types.push_back(Get_Type_Info<std::vector<Boxed_Value> >::get());
        }

        return types;
      }

      boost::function<Boxed_Value (const std::vector<Boxed_Value> &)> m_f;
      int m_arity;
      std::string m_description;
      Proxy_Function m_guard;
      std::vector<Type_Info> m_types;
  };

  /**
   * An object used by Bound_Function to represent "_" parameters
   * of a binding. This allows for unbound parameters during bind.
   */
  struct Placeholder_Object
  {
  };

  /**
   * An implementation of Proxy_Function that takes a Proxy_Function
   * and substitutes bound parameters into the parameter list
   * at runtime, when call() is executed.
   * it is used for bind(function, param1, _, param2) style calls
   */
  class Bound_Function : public Proxy_Function_Base
  {
    public:
      Bound_Function(const Proxy_Function &t_f, 
                     const std::vector<Boxed_Value> &t_args)
        : m_f(t_f), m_args(t_args), m_arity(m_f->get_arity()<0?-1:(m_f->get_arity() - m_args.size()))
      {
      }

      virtual bool operator==(const Proxy_Function_Base &) const
      {
        return false;
      }

      virtual ~Bound_Function() {}

      virtual bool call_match(const std::vector<Boxed_Value> &vals) const
      {
        return m_f->call_match(build_param_list(vals));
      }

      virtual Boxed_Value operator()(const std::vector<Boxed_Value> &params)
      {
        return (*m_f)(build_param_list(params));
      }

      std::vector<Boxed_Value> build_param_list(const std::vector<Boxed_Value> &params) const
      {
        typedef std::vector<Boxed_Value>::const_iterator pitr;

        pitr parg = params.begin();
        pitr barg = m_args.begin();

        std::vector<Boxed_Value> args;

        while (true)
        {
          while (barg != m_args.end() 
                 && !(barg->get_type_info() == Get_Type_Info<Placeholder_Object>::get()))
          {
            args.push_back(*barg);
            ++barg;
          }

          if (parg != params.end())
          {
            args.push_back(*parg);
            ++parg;
          }

          if (barg != m_args.end() 
              && barg->get_type_info() == Get_Type_Info<Placeholder_Object>::get())
          {
            ++barg;
          } 

          if (parg == params.end() && barg == m_args.end())
          {
            break;
          }
        }
        return args;
      }

      virtual std::vector<Type_Info> get_param_types() const
      {
        return std::vector<Type_Info>();
      }

      virtual int get_arity() const
      {
        return m_arity;
      }

      virtual std::string annotation() const
      {
        return "";
      }

    private:
      Proxy_Function m_f;
      std::vector<Boxed_Value> m_args;
      int m_arity;
  };

  /**
   * The standard typesafe function call implementation of Proxy_Function
   * It takes a boost::function<> object and performs runtime 
   * type checking of Boxed_Value parameters, in a type safe manner
   */
  template<typename Func>
    class Proxy_Function_Impl : public Proxy_Function_Base
  {
    public:
      Proxy_Function_Impl(const boost::function<Func> &f)
        : m_f(f), m_dummy_func(0), m_types(build_param_type_list(m_dummy_func))
      {
      }

      virtual ~Proxy_Function_Impl() {}

      virtual bool operator==(const Proxy_Function_Base &t_func) const
      {
        try {
          dynamic_cast<const Proxy_Function_Impl<Func> &>(t_func);
          return true; 
        } catch (const std::bad_cast &) {
          return false;
        }
      }
 
      virtual Boxed_Value operator()(const std::vector<Boxed_Value> &params)
      {
        return call_func(m_f, params);
      }

      virtual std::vector<Type_Info> get_param_types() const
      {
	return m_types;
      }

      virtual int get_arity() const
      {
        return m_types.size() - 1;
      }


      virtual bool call_match(const std::vector<Boxed_Value> &vals) const
      {
        return compare_types(m_dummy_func, vals);
      }

      virtual std::string annotation() const
      {
        return "";
      }

    private:
      boost::function<Func> m_f;
      Func *m_dummy_func;
      std::vector<Type_Info> m_types;
  };

  /**
   * Exception thrown in the case that a multi method dispatch fails
   * because no matching function was found
   * at runtime due to either an arity_error, a guard_error or a bad_boxed_cast
   * exception
   */
  struct dispatch_error : std::runtime_error
  {
    dispatch_error() throw()
      : std::runtime_error("No matching function to dispatch to")
    {
    }

    virtual ~dispatch_error() throw() {}
  };

  /**
   * Take a vector of functions and a vector of parameters. Attempt to execute
   * each function against the set of parameters, in order, until a matching
   * function is found or throw dispatch_error if no matching function is found
   */
  Boxed_Value dispatch(const std::vector<std::pair<std::string, Proxy_Function> > &funcs,
      const std::vector<Boxed_Value> &plist)
  {
    for (std::vector<std::pair<std::string, Proxy_Function> >::const_iterator itr = funcs.begin();
        itr != funcs.end();
        ++itr)
    {
      try {
        if (itr->second->filter(plist))
        {
          return (*itr->second)(plist);
        }
      } catch (const bad_boxed_cast &) {
        //parameter failed to cast, try again
      } catch (const arity_error &) {
        //invalid num params, try again
      } catch (const guard_error &) {
        //guard failed to allow the function to execute,
        //try again
      }
    }
    throw dispatch_error();
  }
}

# endif
#else
# define n BOOST_PP_ITERATION()

namespace chaiscript
{
  /**
   * Used by Proxy_Function_Impl to return a list of all param types
   * it contains.
   */
  template<typename Ret BOOST_PP_COMMA_IF(n) BOOST_PP_ENUM_PARAMS(n, typename Param) >
    std::vector<Type_Info> build_param_type_list(Ret (*)(BOOST_PP_ENUM_PARAMS(n, Param)))
    {
      std::vector<Type_Info> ti;
      ti.push_back(Get_Type_Info<Ret>::get());

      BOOST_PP_REPEAT(n, gettypeinfo, ~)

      return ti;
    }

  /**
   * Used by Proxy_Function_Impl to perform typesafe execution of a function.
   * The function attempts to unbox each paramter to the expected type.
   * if any unboxing fails the execution of the function fails and
   * the bad_boxed_cast is passed up to the caller.
   */
  template<typename Ret BOOST_PP_COMMA_IF(n) BOOST_PP_ENUM_PARAMS(n, typename Param)>
    Boxed_Value call_func(const boost::function<Ret (BOOST_PP_ENUM_PARAMS(n, Param))> &f,
        const std::vector<Boxed_Value> &params)
    {
      if (params.size() != n)
      {
        throw arity_error(params.size(), n);
      } else {
        return Handle_Return<Ret>()(boost::bind(f BOOST_PP_REPEAT(n, casthelper, ~)));
      }
    }

  /**
   * Used by Proxy_Function_Impl to determine if it is equivalent to another
   * Proxy_Function_Impl object. This function is primarly used to prevent
   * registration of two functions with the exact same signatures
   */
  template<typename Ret BOOST_PP_COMMA_IF(n) BOOST_PP_ENUM_PARAMS(n, typename Param)>
    bool compare_types(Ret (*)(BOOST_PP_ENUM_PARAMS(n, Param)),
        const std::vector<Boxed_Value> &params)
    {
      if (params.size() != n)
      {
        return false;
      } else {
        bool val = true BOOST_PP_REPEAT(n, comparetype, ~);
        if (val) return true;

        try {
          BOOST_PP_REPEAT(n, trycast, ~);
        } catch (const bad_boxed_cast &) {
          return false;
        }

        return true;
      }
    }
}

#endif