rice2 2.2.0

data/rice/Builtin_Object.hpp

@@ -0,0 +1,8 @@
+#ifndef Rice__Builtin_Object__hpp_
+#define Rice__Builtin_Object__hpp_
+
+#include "Builtin_Object_defn.hpp"
+#include "Builtin_Object.ipp"
+
+#endif // Rice__Builtin_Object__hpp_
+

data/rice/Builtin_Object.ipp

@@ -0,0 +1,50 @@
+#ifndef Rice__Builtin_Object__ipp_
+#define Rice__Builtin_Object__ipp_
+
+#include "Object.hpp"
+#include "protect.hpp"
+#include "detail/check_ruby_type.hpp"
+
+#include <algorithm>
+
+namespace Rice
+{
+
+namespace detail
+{
+  inline VALUE check_type(Object value, int type)
+  {
+    rb_check_type(value, type);
+    return Qnil;
+  }
+}
+
+template<int Builtin_Type>
+inline Builtin_Object<Builtin_Type>::
+Builtin_Object(Object value)
+  : Object(value)
+  , obj_((RObject*)(value.value()))
+{
+  protect(detail::check_type, value, Builtin_Type);
+}
+
+template<int Builtin_Type>
+inline Builtin_Object<Builtin_Type>::
+Builtin_Object(Builtin_Object<Builtin_Type> const & other)
+  : Object(other.value())
+  , obj_(other.obj_)
+{
+}
+
+template<int Builtin_Type>
+inline void Builtin_Object<Builtin_Type>::
+swap(Builtin_Object<Builtin_Type> & ref)
+{
+  std::swap(obj_, ref.obj_);
+  Object::swap(ref);
+}
+
+} // namespace Rice
+
+#endif // Rice__Builtin_Object__ipp_
+

data/rice/Builtin_Object_defn.hpp

@@ -0,0 +1,50 @@
+#ifndef Rice__Builtin_Object_defn__hpp_
+#define Rice__Builtin_Object_defn__hpp_
+
+#include "Object_defn.hpp"
+#include "detail/ruby.hpp"
+
+namespace Rice
+{
+
+//! A smartpointer-like wrapper for Ruby builtin objects.
+/*! A builtin object is one of Ruby's internal types, e.g. RArray or
+ *  RString.  Every builtin type structure has a corresponding integer
+ *  type number (e.g T_ARRAY for RArray or T_STRING for RString).  This
+ *  class is a wrapper for those types of objects, primarily useful as a
+ *  base class for other wrapper classes like Array and Hash.
+ */
+template<int Builtin_Type>
+class Builtin_Object
+  : public Object
+{
+public:
+  //! Wrap an already allocated Ruby object.
+  /*! Checks to see if the object is an object of type Builtin_Type; a
+   *  C++ exception is thrown if this is not the case.
+   *  \param value the object to be wrapped.
+   */
+  Builtin_Object(Object value);
+
+  //! Make a copy of a Builtin_Object
+  /*! \param other the Builtin_Object to be copied.
+   */
+  Builtin_Object(Builtin_Object const & other);
+
+  RObject & operator*() const { return *obj_; } //!< Return a reference to obj_
+  RObject * operator->() const { return obj_; } //!< Return a pointer to obj_
+  RObject * get() const { return obj_; }        //!< Return a pointer to obj_
+
+  //! Swap with another builtin object of the same type
+  /*! \param ref the object with which to swap.
+   */
+  void swap(Builtin_Object<Builtin_Type> & ref);
+
+private:
+  RObject * obj_;
+};
+
+} // namespace Rice
+
+#endif // Rice__Builtin_Object_defn__hpp_
+

data/rice/Class.cpp

@@ -0,0 +1,57 @@
+#include "Class.hpp"
+#include "Exception.hpp"
+#include "detail/creation_funcs.hpp"
+
+Rice::Class::
+Class()
+  : Module_impl<Module, Class>()
+{
+}
+
+Rice::Class::
+Class(VALUE v)
+  : Module_impl<Module, Class>(v)
+{
+  if(::rb_type(v) != T_CLASS)
+  {
+    throw Exception(
+        rb_eTypeError,
+        "Expected a Class but got a %s",
+        rb_class2name(CLASS_OF(v))); // TODO: might raise an exception
+  }
+}
+
+Rice::Class & Rice::Class::
+undef_creation_funcs()
+{
+  detail::undef_creation_funcs(*this);
+  return *this;
+}
+
+Rice::Class Rice::
+define_class_under(
+    Rice::Object module,
+    char const * name,
+    Rice::Object superclass)
+{
+  VALUE v = rb_define_class_under(module, name, superclass);
+  return Class(v);
+}
+
+Rice::Class Rice::
+define_class(
+    char const * name,
+    Rice::Object superclass)
+{
+  VALUE v = rb_define_class(name, superclass);
+  return Class(v);
+}
+
+Rice::Class Rice::
+anonymous_class(
+    Rice::Object superclass)
+{
+  VALUE v = Class(rb_cClass).call("new");
+  return Class(v);
+}
+

data/rice/Class.hpp

@@ -0,0 +1,8 @@
+#ifndef Rice__Class__hpp_
+#define Rice__Class__hpp_
+
+#include "Class_defn.hpp"
+#include "Class.ipp"
+
+#endif // Rice__Class__hpp_
+

data/rice/Class.ipp

@@ -0,0 +1,6 @@
+#ifndef Rice__Class__ipp_
+#define Rice__Class__ipp_
+
+#include "Module.ipp"
+
+#endif // Rice__Class__ipp_

data/rice/Class_defn.hpp

@@ -0,0 +1,83 @@
+#ifndef Rice__Class_defn__hpp_
+#define Rice__Class_defn__hpp_
+
+#include "Object_defn.hpp"
+#include "Module_impl.hpp"
+#include "Module_defn.hpp"
+#include "to_from_ruby_defn.hpp"
+#include "Identifier.hpp"
+
+/*!
+ *  \example inheritance/animals.cpp
+ */
+
+namespace Rice
+{
+
+//! A helper for defining a Class and its methods.
+/*! This class provides a C++-style interface to ruby's Class class and
+ *  for defining methods on that class.
+ */
+class Class
+  : public Module_impl<Module, Class>
+{
+public:
+  //! Default construct a new class wrapper and initialize it to
+  //! rb_cObject.
+  Class();
+
+  //! Construct a new class wrapper from a ruby object of type T_CLASS.
+  Class(VALUE v);
+
+  //! Disallow creation of an instance from Ruby code.
+  /*! Undefines the singleton method allocate (or new, if using a
+   *  version of ruby prior to 1.7) and the instance method initialize.
+   */
+  Class & undef_creation_funcs();
+};
+
+//! Define a new class in the namespace given by module.
+/*! \param module the Module in which to define the class.
+ *  \param name the name of the class.
+ *  \param superclass the base class to use.
+ *  \return the new class.
+ */
+Class define_class_under(
+    Object module,
+    char const * name,
+    Object superclass = rb_cObject);
+
+//! Define a new class in the default namespace.
+/*! \param name the name of the class.
+ *  \param superclass the base class to use.
+ *  \return the new class.
+ */
+Class define_class(
+    char const * name,
+    Object superclass = rb_cObject);
+
+//! Create a new anonymous class.
+/*! \param superclass the base class to use.
+ *  \return the new class.
+ */
+Class anonymous_class(
+    Object superclass = rb_cObject);
+
+} // namespace Rice
+
+template<>
+inline
+Rice::Class from_ruby<Rice::Class>(Rice::Object x)
+{
+  return Rice::Class(x);
+}
+
+template<>
+inline
+Rice::Object to_ruby<Rice::Class>(Rice::Class const & x)
+{
+  return x;
+}
+
+#endif // Rice__Class_defn__hpp_
+

data/rice/Constructor.hpp

@@ -0,0 +1,47 @@
+#ifndef Rice__Constructor__hpp_
+#define Rice__Constructor__hpp_
+
+// This causes problems with certain C++ libraries
+#undef TYPE
+
+#include "to_from_ruby_defn.hpp"
+
+namespace Rice
+{
+  //! Define a Type's Constructor and it's arguments.
+  /*! E.g. for the default constructor on a Type:
+      \code
+        define_class<Test>()
+          .define_constructor(Constructor<Test>());
+      \endcode
+  *
+  *  The first template type must be the type being wrapped.
+  *  Afterwards any extra types must match the appropriate constructor
+  *  to be used in C++ when constructing the object.
+  *
+  *  For more information, see Rice::Data_Type::define_constructor.
+  */
+  template<typename T, typename ...Arg_T>
+  class Constructor
+  {
+  public:
+    static void construct(Object self, Arg_T... args)
+    {
+      DATA_PTR(self.value()) = new T(args...);
+    }
+  };
+
+  //! Special-case Constructor used when defining Directors.
+  template<typename T, typename ...Arg_T>
+  class Constructor<T, Object, Arg_T...>
+  {
+    public:
+      static void construct(Object self, Arg_T... args)
+      {
+        DATA_PTR(self.value()) = new T(self, args...);
+      }
+  };
+}
+
+#endif
+

data/rice/Data_Object.hpp

@@ -0,0 +1,8 @@
+#ifndef Rice__Data_Object__hpp_
+#define Rice__Data_Object__hpp_
+
+#include "Data_Object_defn.hpp"
+#include "Data_Object.ipp"
+
+#endif // Rice__Data_Object__hpp_
+

data/rice/Data_Object.ipp

@@ -0,0 +1,133 @@
+#ifndef Rice__Data_Object__ipp_
+#define Rice__Data_Object__ipp_
+
+#include "detail/check_ruby_type.hpp"
+#include "protect.hpp"
+
+#include <algorithm>
+
+template<typename T>
+const typename Rice::Default_Mark_Function<T>::Ruby_Data_Func
+Rice::Default_Mark_Function<T>::mark = ruby_mark<T>;
+
+namespace Rice
+{
+
+namespace detail
+{
+
+inline VALUE data_wrap_struct(
+    VALUE klass,
+    RUBY_DATA_FUNC mark,
+    RUBY_DATA_FUNC free,
+    void * obj)
+{
+  return Data_Wrap_Struct(klass, mark, free, obj);
+}
+
+template<typename T>
+inline VALUE wrap(
+    VALUE klass,
+    typename Data_Object<T>::Ruby_Data_Func mark,
+    typename Data_Object<T>::Ruby_Data_Func free,
+    T * obj)
+{
+  // We cast to obj void* here before passing to Data_Wrap_Struct,
+  // becuase otherwise compilation will fail if obj is const.  It's safe
+  // to do this, because unwrap() will always add the const back when
+  // the object is unwrapped.
+  return Rice::protect(data_wrap_struct,
+      klass,
+      reinterpret_cast<RUBY_DATA_FUNC>(mark),
+      reinterpret_cast<RUBY_DATA_FUNC>(free),
+      (void *)obj);
+}
+
+template<typename T>
+inline VALUE data_get_struct(VALUE value, T * * obj)
+{
+  Data_Get_Struct(value, T, *obj);
+  return Qnil;
+}
+
+template<typename T>
+inline T * unwrap(VALUE value)
+{
+  T * obj;
+  Rice::protect(data_get_struct<T>, value, &obj);
+  return obj;
+}
+
+} // namespace detail
+
+} // namespace Rice
+
+template<typename T>
+inline Rice::Data_Object<T>::
+Data_Object(
+    T * obj,
+    VALUE klass,
+    Ruby_Data_Func mark_func,
+    Ruby_Data_Func free_func)
+  : Object(detail::wrap(klass, mark_func, free_func, obj))
+  , obj_(obj)
+{
+}
+
+template<typename T>
+inline Rice::Data_Object<T>::
+Data_Object(
+    Object value)
+  : Object(value)
+  , obj_(detail::unwrap<T>(value))
+{  
+  Data_Type<T> klass;
+  check_cpp_type(klass);
+  detail::check_ruby_type(value, klass, true);
+}
+
+template<typename T>
+template<typename U>
+inline Rice::Data_Object<T>::
+Data_Object(
+    Object value,
+    Data_Type<U> const & klass)
+  : Object(value)
+  , obj_(detail::unwrap<T>(value))
+{  
+  check_cpp_type(klass);
+  detail::check_ruby_type(value, klass, true);
+}
+
+template<typename T>
+inline Rice::Data_Object<T>::
+Data_Object(Data_Object const & other)
+  : Object(other.value())
+  , obj_(other.obj_)
+{
+}
+
+template<typename T>
+template<typename U>
+inline void Rice::Data_Object<T>::
+swap(Data_Object<U> & ref)
+{
+  std::swap(obj_, ref.obj_);
+  Object::swap(ref);
+}
+
+template<typename T>
+inline void Rice::Data_Object<T>::
+check_cpp_type(Data_Type<T> const & /* klass */)
+{
+}
+
+template<typename T>
+Rice::Object Rice::detail::to_ruby_<Rice::Data_Object<T> >::
+convert(Rice::Data_Object<T> const & x)
+{
+  return x;
+}
+
+#endif // Rice__Data_Object__ipp_
+