rice 4.6.1 → 4.7.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rice
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.7.0
 platform: ruby
 authors:
 - Paul Brannan
@@ -11,6 +11,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +75,9 @@ email:
 - curlypaul924@gmail.com
 - jasongroelofs@gmail.com
 - cfis@savagexi.com
-executables: []
+executables:
+- rice-doc.rb
+- rice-rbs.rb
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -75,11 +91,23 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/rice-doc.rb
+- bin/rice-rbs.rb
 - include/rice/rice.hpp
 - include/rice/stl.hpp
-- lib/make_rice_headers.rb
 - lib/mkmf-rice.rb
 - lib/rice.rb
+- lib/rice/doc.rb
+- lib/rice/doc/cpp_reference.rb
+- lib/rice/doc/doxygen.rb
+- lib/rice/doc/mkdocs.rb
+- lib/rice/doc/rice.rb
+- lib/rice/doc/ruby.rb
+- lib/rice/make_rice_headers.rb
+- lib/rice/native.rb
+- lib/rice/native_registry.rb
+- lib/rice/parameter.rb
+- lib/rice/rbs.rb
 - lib/rice/version.rb
 - lib/rubygems/builder.rb
 - lib/rubygems/cmake_builder.rb
@@ -104,14 +132,17 @@ files:
 - rice/Enum.ipp
 - rice/Exception.hpp
 - rice/Exception.ipp
-- rice/Init.hpp
-- rice/Init.ipp
+- rice/Function.hpp
+- rice/Function.ipp
 - rice/JumpException.hpp
 - rice/JumpException.ipp
 - rice/MemoryView.hpp
 - rice/MemoryView.ipp
+- rice/Pointer.hpp
+- rice/Pointer.ipp
 - rice/Return.hpp
 - rice/Return.ipp
+- rice/api.hpp
 - rice/cpp_api/Array.hpp
 - rice/cpp_api/Array.ipp
 - rice/cpp_api/Builtin_Object.hpp
@@ -143,6 +174,8 @@ files:
 - rice/detail/InstanceRegistry.ipp
 - rice/detail/MethodInfo.hpp
 - rice/detail/MethodInfo.ipp
+- rice/detail/ModuleRegistry.hpp
+- rice/detail/ModuleRegistry.ipp
 - rice/detail/Native.hpp
 - rice/detail/Native.ipp
 - rice/detail/NativeAttributeGet.hpp
@@ -155,22 +188,29 @@ files:
 - rice/detail/NativeCallbackSimple.ipp
 - rice/detail/NativeFunction.hpp
 - rice/detail/NativeFunction.ipp
+- rice/detail/NativeInvoker.hpp
+- rice/detail/NativeInvoker.ipp
 - rice/detail/NativeIterator.hpp
 - rice/detail/NativeIterator.ipp
+- rice/detail/NativeMethod.hpp
+- rice/detail/NativeMethod.ipp
+- rice/detail/NativeProc.hpp
+- rice/detail/NativeProc.ipp
 - rice/detail/NativeRegistry.hpp
 - rice/detail/NativeRegistry.ipp
+- rice/detail/Parameter.hpp
+- rice/detail/Parameter.ipp
 - rice/detail/Proc.hpp
 - rice/detail/Proc.ipp
 - rice/detail/Registries.hpp
 - rice/detail/Registries.ipp
-- rice/detail/RubyFunction.hpp
-- rice/detail/RubyFunction.ipp
 - rice/detail/RubyType.hpp
 - rice/detail/RubyType.ipp
 - rice/detail/Type.hpp
 - rice/detail/Type.ipp
 - rice/detail/TypeRegistry.hpp
 - rice/detail/TypeRegistry.ipp
+- rice/detail/Types.ipp
 - rice/detail/Wrapper.hpp
 - rice/detail/Wrapper.ipp
 - rice/detail/cpp_protect.hpp
@@ -187,6 +227,20 @@ files:
 - rice/libc/file.hpp
 - rice/libc/file.ipp
 - rice/rice.hpp
+- rice/rice_api/Arg.hpp
+- rice/rice_api/Arg.ipp
+- rice/rice_api/ModuleRegistry.hpp
+- rice/rice_api/ModuleRegistry.ipp
+- rice/rice_api/Native.hpp
+- rice/rice_api/Native.ipp
+- rice/rice_api/NativeRegistry.hpp
+- rice/rice_api/NativeRegistry.ipp
+- rice/rice_api/Parameter.hpp
+- rice/rice_api/Parameter.ipp
+- rice/rice_api/Registries.hpp
+- rice/rice_api/Registries.ipp
+- rice/rice_api/TypeRegistry.hpp
+- rice/rice_api/TypeRegistry.ipp
 - rice/ruby_mark.hpp
 - rice/stl.hpp
 - rice/stl/complex.hpp
@@ -195,6 +249,8 @@ files:
 - rice/stl/exception.ipp
 - rice/stl/exception_ptr.hpp
 - rice/stl/exception_ptr.ipp
+- rice/stl/filesystem.hpp
+- rice/stl/filesystem.ipp
 - rice/stl/map.hpp
 - rice/stl/map.ipp
 - rice/stl/monostate.hpp
@@ -233,30 +289,9 @@ files:
 - rice/traits/function_traits.hpp
 - rice/traits/method_traits.hpp
 - rice/traits/rice_traits.hpp
-- sample/callbacks/extconf.rb
-- sample/callbacks/sample_callbacks.cpp
-- sample/callbacks/test.rb
-- sample/enum/extconf.rb
-- sample/enum/sample_enum.cpp
-- sample/enum/test.rb
-- sample/inheritance/animals.cpp
-- sample/inheritance/extconf.rb
-- sample/inheritance/test.rb
-- sample/map/extconf.rb
-- sample/map/map.cpp
-- sample/map/test.rb
 - test/embed_ruby.cpp
 - test/embed_ruby.hpp
-- test/ext/t1/Foo.hpp
-- test/ext/t1/extconf.rb
-- test/ext/t1/t1.cpp
-- test/ext/t2/extconf.rb
-- test/ext/t2/t2.cpp
 - test/extconf.rb
-- test/ruby/test_callbacks_sample.rb
-- test/ruby/test_multiple_extensions.rb
-- test/ruby/test_multiple_extensions_same_class.rb
-- test/ruby/test_multiple_extensions_with_inheritance.rb
 - test/test_Address_Registration_Guard.cpp
 - test/test_Array.cpp
 - test/test_Attribute.cpp
@@ -272,6 +307,7 @@ files:
 - test/test_Exception.cpp
 - test/test_File.cpp
 - test/test_From_Ruby.cpp
+- test/test_GVL.cpp
 - test/test_Hash.cpp
 - test/test_Identifier.cpp
 - test/test_Inheritance.cpp
@@ -298,7 +334,7 @@ files:
 - test/test_Stl_String.cpp
 - test/test_Stl_String_View.cpp
 - test/test_Stl_Tuple.cpp
-- test/test_Stl_Type.cpp
+- test/test_Stl_Type_Info.cpp
 - test/test_Stl_UniquePtr.cpp
 - test/test_Stl_Unordered_Map.cpp
 - test/test_Stl_Variant.cpp
@@ -338,8 +374,4 @@ requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby Interface for C++ Extensions
-test_files:
-- test/ruby/test_callbacks_sample.rb
-- test/ruby/test_multiple_extensions.rb
-- test/ruby/test_multiple_extensions_same_class.rb
-- test/ruby/test_multiple_extensions_with_inheritance.rb
+test_files: []

data/rice/Init.hpp

@@ -1,8 +0,0 @@
-#ifndef Rice__Init__hpp_
-#define Rice__Init__hpp_
-
-namespace Rice
-{
-  void init();
-}
-#endif // Rice__Init__hpp_

data/rice/Init.ipp

@@ -1,8 +0,0 @@
-namespace Rice
-{
-  inline void init()
-  {
-    detail::define_ruby_types();
-    define_fundamental_buffer_types();
-  };
-}

data/rice/detail/RubyFunction.hpp

@@ -1,31 +0,0 @@
-#ifndef Rice__detail__ruby_function__hpp_
-#define Rice__detail__ruby_function__hpp_
-
-namespace Rice::detail
-{
-  /* This is functor class that wraps calls to a Ruby C API method. It is needed because
-     rb_protect only supports calling methods that take one argument. Thus 
-     we invoke rb_protect telling it to invoke Ruby_Function::call with an 
-     instance of a Ruby_Function. That instance then in turn calls the original
-     Ruby method passing along its required arguments. */
-
-  template<typename Function_T, typename...Arg_Ts>
-  class RubyFunction
-  {
-  public:
-    using Return_T = typename function_traits<Function_T>::return_type;
-
-  public:
-    RubyFunction(Function_T func, const Arg_Ts&... args);
-    Return_T operator()();
-
-  private:
-    Function_T func_;
-    std::tuple<Arg_Ts...> args_;
-  };
-
-  template<typename Function_T, typename ...Arg_Ts>
-  auto protect(Function_T func, Arg_Ts...args);
-}
-
-#endif // Rice__detail__ruby_function__hpp_

data/rice/detail/RubyFunction.ipp

@@ -1,77 +0,0 @@
-
-#include <any>
-#include <tuple>
-
-namespace Rice::detail
-{
-  template<typename Function_T, typename...Arg_Ts>
-  inline RubyFunction<Function_T, Arg_Ts...>::RubyFunction(Function_T func, const Arg_Ts&... args)
-    : func_(func), args_(std::forward_as_tuple(args...))
-  {
-  }
-
-  template<typename Function_T, typename...Arg_Ts>
-  inline typename RubyFunction<Function_T, Arg_Ts...>::Return_T RubyFunction<Function_T, Arg_Ts...>::operator()()
-  {
-    // Setup a thread local variable to capture the result of the Ruby function call.
-    // We use thread_local because the lambda has to be captureless so it can
-    // be converted to a function pointer callable by C.
-    // The thread local variable avoids having to cast the result to VALUE and then 
-    // back again to Return_T. The problem with that is the translation is not lossless
-    // in some cases - for example a double with value of -1.0 does not roundrip.
-    // 
-    thread_local std::any result;
-
-    // Callback that will invoke the Ruby function
-    using Functor_T = RubyFunction<Function_T, Arg_Ts...>;
-    auto callback = [](VALUE value) -> VALUE
-    {
-      Functor_T* functor = (Functor_T*)value;
-
-      if constexpr (std::is_same_v<Return_T, void>)
-      {
-        std::apply(functor->func_, functor->args_);
-      }
-      else
-      {
-        result = std::apply(functor->func_, functor->args_);
-      }
-
-      return Qnil;
-    };
-
-    // Now call rb_protect which will invoke the callback lambda above
-    int state = (int)JumpException::RUBY_TAG_NONE;
-    rb_protect(callback, (VALUE)this, &state);
-
-    // Did anything go wrong?
-    if (state == JumpException::RUBY_TAG_NONE)
-    {
-      if constexpr (!std::is_same_v<Return_T, void>)
-      {
-        return std::any_cast<Return_T>(result);
-      }
-    }
-    else
-    {
-      VALUE err = rb_errinfo();
-      if (state == JumpException::RUBY_TAG_RAISE && RB_TEST(err))
-      {
-        rb_set_errinfo(Qnil);
-        throw Rice::Exception(err);
-      }
-      else
-      {
-        throw Rice::JumpException((Rice::JumpException::ruby_tag_type)state);
-      }
-    }
-  }
-    
-  // Create a functor for calling a Ruby function and define some aliases for readability.
-  template<typename Function_T, typename ...Arg_Ts>
-  auto protect(Function_T func, Arg_Ts...args)
-  {
-    auto rubyFunction = RubyFunction<Function_T, Arg_Ts...>(func, std::forward<Arg_Ts>(args)...);
-    return rubyFunction();
-  }
-}

data/sample/callbacks/extconf.rb

@@ -1,5 +0,0 @@
-require 'bundler/setup'
-require 'mkmf-rice'
-
-create_makefile('sample_callbacks')
-

data/sample/callbacks/sample_callbacks.cpp

@@ -1,35 +0,0 @@
-#include <rice/rice.hpp>
-
-using namespace Rice;
-
-namespace
-{
-
-  class CallbackHolder
-  {
-    public:
-
-    void registerCallback(Rice::Object cb)
-    {
-      callback_ = cb;
-    }
-
-    Rice::Object fireCallback(Rice::String param)
-    {
-      return callback_.call("call", param);
-    }
-
-    Rice::Object callback_;
-  };
-
-} // namespace
-
-extern "C"
-void Init_sample_callbacks()
-{
-    define_class<CallbackHolder>("CallbackHolder")
-      .define_constructor(Constructor<CallbackHolder>())
-      .define_method("register_callback", &CallbackHolder::registerCallback)
-      .define_method("fire_callback", &CallbackHolder::fireCallback);
-}
-

data/sample/callbacks/test.rb

@@ -1,28 +0,0 @@
-require 'sample_callbacks'
-
-def hello(message)
-  "Hello #{message}"
-end
-
-cb1 = CallbackHolder.new
-cb2 = CallbackHolder.new
-cb3 = CallbackHolder.new
-
-cb1.register_callback(lambda do |param|
-  "Callback 1 got param #{param}"
-end)
-
-cb2.register_callback(lambda do |param|
-  "Callback 2 got param #{param}"
-end)
-
-cb3.register_callback method(:hello)
-
-puts "Calling Callback 1"
-puts cb1.fire_callback("Hello")
-
-puts "Calling Callback 2"
-puts cb2.fire_callback("World")
-
-puts "Calling Callback 3"
-puts cb3.fire_callback("Ruby")

data/sample/enum/extconf.rb

@@ -1,5 +0,0 @@
-require 'bundler/setup'
-require 'mkmf-rice'
-
-create_makefile('sample_enum')
-

data/sample/enum/sample_enum.cpp

@@ -1,40 +0,0 @@
-#include <rice/rice.hpp>
-
-using namespace Rice;
-
-namespace
-{
-
-enum Sample_Enum
-{
-  SE_FOO = 1,
-  SE_BAR = 42,
-  SE_BAZ = 100,
-};
-
-char const * description(Sample_Enum e)
-{
-  switch(e)
-  {
-    case SE_FOO: return "Fairly Ordinary Object";
-    case SE_BAR: return "Beginner's All-purpose Ratchet";
-    case SE_BAZ: return "Better than A Zebra";
-  }
-  return "???";
-}
-
-} // namespace
-
-extern "C"
-void Init_sample_enum()
-{
-    Rice::Enum<Sample_Enum> sample_enum_type =
-      define_enum<Sample_Enum>("Sample_Enum")
-      .define_value("FOO", SE_FOO)
-      .define_value("BAR", SE_BAR)
-      .define_value("BAZ", SE_BAZ);
-
-    sample_enum_type
-      .define_method("description", description);
-}
-

data/sample/enum/test.rb

@@ -1,8 +0,0 @@
-require_relative 'sample_enum'
-
-Sample_Enum.each { |x| p x }
-s = Sample_Enum::FOO
-puts s
-puts s.inspect
-puts s < Sample_Enum::BAR
-s.description

data/sample/inheritance/animals.cpp

@@ -1,82 +0,0 @@
-#include <rice/rice.hpp>
-
-using namespace Rice;
-
-class Organism
-{
-public:
-  virtual ~Organism() = default;
-  virtual char const * name() = 0;
-};
-
-class Animal
-  : public Organism
-{
-public:
-  virtual char const * speak() = 0;
-};
-
-class Bear
-  : public Animal
-{
-public:
-  char const * name() override
-  {
-    return "Bear";
-  }
-
-  char const * speak() override
-  {
-    return "I'm smarter than the average bear";
-  }
-};
-
-class Dog
-  : public Animal
-{
-public:
-  char const * name() override
-  {
-    return "Dog";
-  }
-
-  char const * speak() override
-  {
-    return "Woof woof";
-  }
-};
-
-class Rabbit
-  : public Animal
-{
-public:
-  char const * name() override
-  {
-    return "Rabbit";
-  }
-
-  char const * speak() override
-  {
-    return "What's up, doc?";
-  }
-};
-
-extern "C"
-void Init_animals(void)
-{
-    define_class<Organism>("Organism")
-      .define_method("name", &Organism::name);
-
-    define_class<Animal, Organism>("Animal")
-      .define_method("speak", &Animal::speak);
-
-    define_class<Bear, Animal>("Bear")
-      .define_constructor(Constructor<Bear>());
-      
-    define_class<Dog, Animal>("Dog")
-      .define_constructor(Constructor<Dog>());
-
-    define_class<Rabbit, Animal>("Rabbit")
-      .define_constructor(Constructor<Rabbit>());
-}
-

data/sample/inheritance/extconf.rb

@@ -1,5 +0,0 @@
-require 'bundler/setup'
-require 'mkmf-rice'
-
-create_makefile('animals')
-

data/sample/inheritance/test.rb

@@ -1,7 +0,0 @@
-require_relative 'animals'
-
-[ Bear, Dog, Rabbit].each do |klass|
-  animal = klass.new
-  puts "A #{animal.name} says: #{animal.speak}"
-end
-

data/sample/map/extconf.rb

@@ -1,5 +0,0 @@
-require 'bundler/setup'
-require 'mkmf-rice'
-
-create_makefile('map')
-

data/sample/map/map.cpp

@@ -1,73 +0,0 @@
-#include <rice/rice.hpp>
-
-#include <map>
-
-using namespace Rice;
-
-namespace
-{
-
-class Map
-{
-private:
-  struct Ruby_Value_Compare
-  {
-    bool operator()(Object lhs, Object rhs) const
-    {
-      Object result = lhs.call("<", rhs);
-      return result.test();
-    }
-  };
-
-  typedef std::map<Object, Object, Ruby_Value_Compare> Value_Map;
-
-public:
-  Object bracket(Object k)
-  {
-    Value_Map::iterator it = map_.find(k);
-    return it == map_.end() ? Object(Qnil) : it->second;
-  }
-
-  Object bracket_equals(Object k, Object v)
-  {
-    map_[k] = v;
-    return Qnil;
-  }
-
-  Value_Map::iterator begin() { return map_.begin(); }
-  Value_Map::iterator end() { return map_.end(); }
-
-  typedef Value_Map::value_type value_type;
-  typedef Value_Map::iterator iterator;
-
-private:
-  Value_Map map_;
-};
-
-} // namespace
-
-template<>
-struct detail::To_Ruby<Map::value_type>
-{
-    static VALUE convert(Map::value_type const & pair)
-    {
-        return detail::protect(rb_assoc_new, pair.first.value(), pair.second.value());
-    }
-};
-
-#include <iostream>
-extern "C"
-void Init_map(void)
-{
-    Rice::Module rb_mStd = define_module("Std");
-
-    // TODO: no delete method on the map, because I'm not sure how to
-    // make delete work properly while iterating
-    Data_Type<Map> rb_cMap =
-      define_class_under<Map>(rb_mStd, "Map")
-      .define_constructor(Constructor<Map>())
-      .define_method("[]", &Map::bracket)
-      .define_method("[]=", &Map::bracket_equals)
-      .define_iterator(&Map::begin, &Map::end)
-      .include_module(rb_mEnumerable);
-}

data/sample/map/test.rb

@@ -1,7 +0,0 @@
-require_relative 'map.so'
-m = Std::Map.new
-m[0] = 1
-m[1] = 2
-m[3] = 3
-m.each { |x| p x }
-

data/test/ext/t1/Foo.hpp

@@ -1,10 +0,0 @@
-#ifndef T1__FOO__HPP_
-#define T1__FOO__HPP_
-
-class Foo
-{
-public:
-  int foo() { return 42; }
-};
-
-#endif // T1__FOO__HPP_

data/test/ext/t1/extconf.rb

@@ -1,4 +0,0 @@
-require 'bundler/setup'
-require 'mkmf-rice'
-
-create_makefile('t1')

data/test/ext/t1/t1.cpp

@@ -1,13 +0,0 @@
-#include "Foo.hpp"
-#include <rice/rice.hpp>
-
-using namespace Rice;
-
-extern "C"
-void Init_t1()
-{
-  define_class<Foo>("Foo")
-    .define_constructor(Constructor<Foo>())
-    .define_method("foo", &Foo::foo);
-}
-

data/test/ext/t2/extconf.rb

@@ -1,4 +0,0 @@
-require 'bundler/setup'
-require 'mkmf-rice'
-
-create_makefile('t2')