wurlinc-rice 1.4.0.1

data/rice/Struct.hpp

@@ -0,0 +1,162 @@
+#ifndef Rice__ruby_struct__hpp_
+#define Ruplu__ruby_struct__hpp_
+
+#include "Array.hpp"
+#include "Hash.hpp"
+#include "Module.hpp"
+#include "Class.hpp"
+#include "Builtin_Object.hpp"
+#include "Address_Registration_Guard.hpp"
+
+namespace Rice
+{
+	class Struct;
+
+//! Define a new Struct
+Struct define_struct();
+
+//! A wrapper for creating Struct classes.
+/*! The Struct class is used for creating new Classes.  Note that the
+ *  notation used here differs slightly from the notation inside the
+ *  interpreter.
+ *
+ *  Inside the interpreter, calling Struct.new creates a new Class:
+ *  \code
+ *  irb(main):001:0> MyStruct = Struct.new(:a, :b, :c)
+ *  => S
+ *  irb(main):002:0> MyStruct.class
+ *  => Class
+ *  \endcode
+ *
+ *  Instantiating that Class creates an instance of that Class:
+ *  \code
+ *  irb(main):003:0> mystruct_instance = MyStruct.new
+ *  => #<struct MyStruct a=nil, b=nil, c=nil>
+ *  irb(main):004:0> mystruct_instance.class
+ *  => MyStruct
+ *  irb(main):005:0> mystruct_instance.class.ancestors
+ *  => [MyStruct, Struct, Enumerable, Object, Kernel]
+ *  \endcode
+ *
+ *  Thus, inside the interpreter, MyStruct is a Class which inherits
+ *  from Struct, and mystruct_instance is an instance of MyStruct.
+ *
+ *  At the C++ level, we might do this instead:
+ *  \code
+ *  Struct rb_cMyStruct = define_struct()
+ *    .define_member("a")
+ *    .define_member("b")
+ *    .define_member("c")
+ *    .initialize("MyStruct");
+ *  Struct::Instance mystruct_instance(rb_cMyStruct.new_instance());
+ *  \endcode
+ *
+ * Here rb_cMyStruct is an instance of Struct and that mystruct_instance
+ * is an instance of Struct::Instance.
+ */
+class Struct
+  : public Module_impl<Class, Struct>
+{
+public:
+  //! Create a new Struct.
+  Struct();
+
+  //! Copy constructor.
+  Struct(Struct const & s);
+
+  //! Destructor.
+  virtual ~Struct();
+
+  //! Define a new Struct member.
+  /*! Defines a new member of the Struct.  Must be called before the
+   *  Struct is initialized.
+   *  \return *this
+   */
+  Struct & define_member(
+      Identifier name);
+
+  //! Initialize the Struct class.
+  /*! Must be called after all Struct members have been defined.
+   *  \param module the module under which to define the Struct.
+   *  \param name the name of the Class at the ruby level.
+   */
+  Struct & initialize(
+      Module module,
+      Identifier name);
+
+  //! Get the offset of a member in the Struct.
+  /*! Internally, Struct members are stored as a single array of VALUE.
+   *  This function determines the offset of a given member in that
+   *  array.
+   *  \param member the name of the desired member.
+   *  \return the index of the given member.
+   */
+  size_t offset_of(Identifier name) const;
+
+  class Instance;
+  friend class Instance;
+  friend Struct Rice::define_struct();
+
+  //! Create a new instance of the Struct
+  /*! \param args the arguments to the constructor.
+   *  \return a new Struct::Instance
+   */
+  Instance new_instance(Array args = Array()) const;
+
+  //! Swap with another Struct.
+  void swap(Struct & other);
+
+  Array members() const { return members_; }
+
+private:
+  Array members_;
+  Address_Registration_Guard members_guard_;
+
+  Hash member_offset_;
+  Address_Registration_Guard member_offset_guard_;
+};
+
+
+//! An instance of a Struct
+//! \sa Struct
+class Struct::Instance
+  : public Builtin_Object<RStruct, T_STRUCT>
+{
+public:
+  //! Create a new Instance of a Struct.
+  /*! \param type the Struct type to create.
+   *  \param args the initial values for the objects of the instance.
+   */
+  Instance(
+      Struct const & type,
+      Array args = Array());
+
+  //! Encapsulate an existing Struct instance.
+  /*! \param type the Struct type to encapsulate.
+   *  \param s the instance to encapsulate.
+   */
+  Instance(
+      Struct const & type,
+      Object s);
+
+  //! Get a member, given its offset.
+  /*! \param index the (integral) index into the Struct's internal
+   *  array or its name (an Identifier or char const *)
+   *  \return the member.
+   */
+  template<typename T>
+  Object operator[](T index);
+
+  //! Swap with another Struct::Instance.
+  void swap(Instance & other);
+
+private:
+  Struct type_;
+};
+
+} // namespace Rice
+
+#include "Struct.ipp"
+
+#endif // Rice__ruby_struct__hpp_
+

data/rice/Struct.ipp

@@ -0,0 +1,26 @@
+namespace Rice
+{
+
+template<typename T>
+inline Object Struct::Instance::
+operator[](T index)
+{
+  return rb_struct_aref(value(), ULONG2NUM(index));
+}
+
+template<>
+inline Object Struct::Instance::
+operator[]<Identifier>(Identifier member)
+{
+  size_t index = type_.offset_of(member);
+  return (*this)[index];
+}
+
+template<>
+inline Object Struct::Instance::
+operator[]<char const *>(char const * name)
+{
+  return (*this)[Identifier(name)];
+}
+
+} // Rice

data/rice/Symbol.cpp

@@ -0,0 +1,25 @@
+#include "Symbol.hpp"
+
+namespace
+{
+  VALUE check_type(Rice::Object value, int type)
+  {
+    rb_check_type(value, type);
+    return Qnil;
+  }
+}
+
+Rice::Symbol::
+Symbol(VALUE v)
+  : Object(v)
+{
+  protect(check_type, v, T_SYMBOL);
+}
+
+Rice::Symbol::
+Symbol(Object v)
+  : Object(v)
+{
+  protect(check_type, v, T_SYMBOL);
+}
+

data/rice/Symbol.hpp

@@ -0,0 +1,66 @@
+#ifndef Rice__Symbol__hpp_
+#define Rice__Symbol__hpp_
+
+#include "Identifier.hpp"
+#include "Object.hpp"
+#include "detail/ruby.hpp"
+#include <string>
+
+namespace Rice
+{
+
+//! A wrapper for ruby's Symbol class.
+/*! Symbols are internal identifiers in ruby.  They are singletons and
+ *  can be thought of as frozen strings.  They differ from an Identifier
+ *  in that they are in fact real Objects, but they can be converted
+ *  back and forth between Identifier and Symbol.
+ */
+class Symbol
+  : public Object
+{
+public:
+  //! Wrap an existing symbol.
+  Symbol(VALUE v);
+
+  //! Wrap an existing symbol.
+  Symbol(Object v);
+
+  //! Construct a Symbol from an Identifier.
+  Symbol(Identifier id);
+
+  //! Construct a Symbol from a null-terminated C string.
+  Symbol(char const * s = "");
+
+  //! Construct a Symbol from an std::string.
+  Symbol(std::string const & s);
+
+  //! Return a string representation of the Symbol.
+  char const * c_str() const;
+
+  //! Return a string representation of the Symbol.
+  std::string str() const;
+
+  //! Return the Symbol as an Identifier.
+  Identifier to_id() const;
+};
+
+} // namespace Rice
+
+template<>
+inline
+Rice::Symbol from_ruby<Rice::Symbol>(Rice::Object x)
+{
+  return Rice::Symbol(x);
+}
+
+template<>
+inline
+Rice::Object to_ruby<Rice::Symbol>(Rice::Symbol const & x)
+{
+  return x;
+}
+
+#include "Symbol.ipp"
+
+#endif // Rice__Symbol__hpp_
+

data/rice/Symbol.ipp

@@ -0,0 +1,44 @@
+#ifndef Rice__Symbol__ipp_
+#define Rice__Symbol__ipp_
+
+#include "protect.hpp"
+#include "detail/ruby.hpp"
+
+inline Rice::Symbol::
+Symbol(char const * s)
+  : Object(ID2SYM(rb_intern(s)))
+{
+}
+
+inline Rice::Symbol::
+Symbol(std::string const & s)
+  : Object(ID2SYM(rb_intern(s.c_str())))
+{
+}
+
+inline Rice::Symbol::
+Symbol(Identifier id)
+  : Object(ID2SYM(id))
+{
+}
+
+inline char const * Rice::Symbol::
+c_str() const
+{
+  return to_id().c_str();
+}
+
+inline std::string Rice::Symbol::
+str() const
+{
+  return to_id().str();
+}
+
+inline Rice::Identifier Rice::Symbol::
+to_id() const
+{
+  return rb_to_id(value());
+}
+
+#endif // Rice__Symbol__ipp_
+

data/rice/VM.cpp

@@ -0,0 +1,92 @@
+#include "VM.hpp"
+#include "detail/ruby.hpp"
+#include "detail/env.hpp" 
+#include "detail/ruby_version_code.hpp"
+
+#include <stdexcept>
+
+Rice::VM::
+VM(char * app_name)
+{
+  init_stack();
+  init(1, &app_name);
+}
+
+Rice::VM::
+VM(int argc, char * argv[])
+{
+  init_stack();
+  init(argc, argv);
+}
+
+Rice::VM::
+VM(std::vector<const char *> const & args)
+{
+  check_not_initialized();
+  init_stack();
+  init(args.size(), const_cast<char * *>(&args[0]));
+}
+
+Rice::VM::
+~VM()
+{
+  init_stack();
+}
+
+#if RICE__RUBY_VERSION_CODE < 186
+  extern "C"
+  void Init_stack(VALUE *);
+#endif
+
+void Rice::VM::
+init_stack()
+{
+#if RICE__RUBY_VERSION_CODE >= 186
+  RUBY_INIT_STACK;
+#else
+  VALUE v;
+  Init_stack(&v);
+#endif
+}
+
+void Rice::VM::
+run()
+{
+#if RICE__RUBY_VERSION_CODE >= 190
+  ruby_run_node(node_);
+#else
+  ruby_run();
+#endif
+}
+
+extern "C"
+{
+
+#if RICE__RUBY_VERSION_CODE < 190
+RUBY_EXTERN VALUE * rb_gc_stack_start;
+#endif
+
+}
+
+void Rice::VM::
+check_not_initialized() const
+{
+#if RICE__RUBY_VERSION_CODE < 190
+  if(rb_gc_stack_start)
+  {
+    throw std::runtime_error("Only one VM allowed per application");
+  }
+#endif
+  // TODO: how to do this check on 1.9?
+}
+
+void Rice::VM::
+init(int argc, char * argv[])
+{
+  ruby_init();
+#if RICE__RUBY_VERSION_CODE >= 190
+  node_ =
+#endif
+  ruby_options(argc, argv);
+}
+

data/rice/VM.hpp

@@ -0,0 +1,32 @@
+#ifndef VM__hpp
+#define VM__hpp
+
+#include <vector>
+#include "detail/ruby_version_code.hpp"
+
+namespace Rice
+{
+
+class VM
+{
+public:
+  VM(char * app_name);
+  VM(int argc, char * argv[]);
+  VM(std::vector<const char *> const & args);
+  ~VM();
+
+  void init_stack();
+  void run();
+
+private:
+  void check_not_initialized() const;
+  void init(int argc, char * argv[]);
+
+#if RICE__RUBY_VERSION_CODE >= 190
+  void * node_;
+#endif
+};
+
+}
+
+#endif // VM__hpp

data/rice/config.hpp.in

@@ -0,0 +1,40 @@
+/* rice/config.hpp.in.  Generated from configure.ac by autoheader.  */
+
+/* Define to 1 if you have the <env.h> header file. */
+#undef HAVE_ENV_H
+
+/* Define to 1 if you have the <node.h> header file. */
+#undef HAVE_NODE_H
+
+/* Define to 1 if you have the <ruby.h> header file. */
+#undef HAVE_RUBY_H
+
+/* Define to 1 if you have the <ruby/node.h> header file. */
+#undef HAVE_RUBY_NODE_H
+
+/* Define to 1 if you have the <version.h> header file. */
+#undef HAVE_VERSION_H
+
+/* Name of package */
+#undef PACKAGE
+
+/* Define to the address where bug reports for this package should be sent. */
+#undef PACKAGE_BUGREPORT
+
+/* Define to the full name of this package. */
+#undef PACKAGE_NAME
+
+/* Define to the full name and version of this package. */
+#undef PACKAGE_STRING
+
+/* Define to the one symbol short name of this package. */
+#undef PACKAGE_TARNAME
+
+/* Define to the version of this package. */
+#undef PACKAGE_VERSION
+
+/* Define this macro to use ruby/node.h */
+#undef REALLY_HAVE_RUBY_NODE_H
+
+/* Version number of package */
+#undef VERSION

data/rice/detail/Arguments.hpp

@@ -0,0 +1,118 @@
+#ifndef Rice__Arguments__hpp_
+#define Rice__Arguments__hpp_
+
+#include "../Arg_impl.hpp"
+#include <sstream>
+#include <vector>
+#include "../to_from_ruby_defn.hpp"
+
+namespace Rice {
+
+  class Arguments
+  {
+    public:
+      Arguments() {
+        required_ = 0;
+        optional_ = 0;
+      }
+
+      ~Arguments() {
+      }
+
+      /**
+       * Get the full argument count of this
+       * list of arguments.
+       * Returns -1 no defined arguments
+       */
+      int count() {
+        if(required_ == 0 && optional_ == 0) {
+          return -1;
+        } else {
+          return required_ + optional_;
+        }
+      }
+
+      /**
+       * Get the rb_scan_args format string for this
+       * list of arguments.
+       * In the case of no Args (default case), this
+       * method uses the passed in full argument count
+       */
+      std::string formatString(int fullArgCount)
+      {
+        std::stringstream s;
+        if(required_ == 0 && optional_ == 0)
+        {
+          s << fullArgCount << 0;
+        }
+        else
+        {
+          s << required_ << optional_;
+        }
+
+        return s.str();
+      }
+
+      /**
+       * Add a defined Arg to this list of Arguments
+       */
+      void add(const Arg& arg)
+      {
+        args_.push_back(arg);
+
+        if(arg.hasDefaultValue())
+        {
+          optional_++;
+        }
+        else
+        {
+          required_++;
+        }
+      }
+
+      /**
+       * Is the argument at the request location an optional
+       * argument?
+       */
+      bool isOptional(unsigned int pos)
+      {
+        if(required_ == 0 && optional_ == 0)
+        {
+          return false;
+        }
+        if(pos >= args_.size())
+        {
+          return false;
+        }
+        return args_[pos].hasDefaultValue();
+      }
+
+      /**
+       * Given a position, a type, and a ruby VALUE, figure out
+       * what argument value we need to return according to
+       * defaults and if that VALUE is nil or not
+       */
+      template<typename Arg_T>
+      Arg_T getArgumentOrDefault(int pos, VALUE in)
+      {
+        if(isOptional(pos) && NIL_P(in))
+        {
+          return args_[pos].getDefaultValue<Arg_T>();
+        }
+        else
+        {
+          return from_ruby<Arg_T>(in);
+        }
+      }
+
+    private:
+      std::vector<Arg> args_;
+
+      /** Keep counts of required and optional parameters */
+      int required_;
+      int optional_;
+  };
+
+}
+
+#endif // Rice__Arguments__hpp_