rcx 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4074c5868fd711ee67726acd364d4aa243c5aeaf9fad6232756e9c1fde7539e3
-  data.tar.gz: e38a49e450466554a5845189cf2ae51ba31665f18389bf9a8d1a052fe6858353
+  metadata.gz: ce9f666d5afd1ffe424c7b8e5626537798e7a9dc4f19ab783f9989666ae4e31a
+  data.tar.gz: 87e2026fc88693d433d21dddbd337808f1b4ec15f3ffedfb80cb48fa257a7ead
 SHA512:
-  metadata.gz: cb13a7ca26f4caf50b3ad8038044f6abf7f932e612e1047df7c54bc543af07a4400a5f68fc64f37406eedff1234de7e99a58583a073c0cf4cbae916c0b03cdd8
-  data.tar.gz: 918833acbc1d6d1bc2b5c9678533ccd6a8bbdd8f5a6b2b87e18e0baf12443eb3887cb2b8b7ca5349f897e37eb9d0a2c06381e4501870db5e00c25317cc76a9f0
+  metadata.gz: d11fcf253149217c95c8f2be3e493607cba542ba9c991f0d55a067198b2e6d5ade3beea98c46a740363b87d91a4f4430b74d58b10c159ba5725ea61d33660bf9
+  data.tar.gz: 514a44dab049c8a7d854777f1ce8b8bec7cbc7a08acc322cda5b7d39d43d7f97053e3d7ee52476c8494914cd7ba5e9d8a9317ae9c578843b592ed2cae92d785d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## UNRELEASED
 
+## v0.4.1 (2025-09-06)
+- Improved the types of the builtin classes to properly relate to the value wrappers.
+
+## v0.4.0 (2025-09-03)
+- Renamed `rcx::arg` namespace to `rcx::args` to prevent conflit with `rcx::arg::arg`.
+
 ## v0.3.1 (2025-09-02)
 - Now `extconf.rb`'s can only `require 'rcx/mkmf/c++20'` to enable RCX.
 

data/Rakefile

@@ -39,6 +39,6 @@ task :yarn_install do
 end
 
 desc 'Format the source code'
-task :format => FileList['**/*.hpp'] do |t|
+task :format => FileList['**/*.[ch]pp'] do |t|
   sh 'clang-format', '-i', *t.prerequisites
 end

data/examples/class.cpp

@@ -3,7 +3,7 @@
 #include <rcx/rcx.hpp>
 
 void Init_examples_class() {
-  using namespace rcx::arg;
+  using namespace rcx::args;
 
   auto ruby = rcx::Ruby::get();
   auto cls =

data/include/rcx/internal/rcx.hpp

@@ -67,13 +67,9 @@ namespace rcx {
   /// Concepts
   ///
   namespace concepts {
+    /// Specifies the type `void`.
     template <typename T>
-    concept StringLike = requires {
-      typename std::remove_cvref_t<T>::value_type;
-      typename std::remove_cvref_t<T>::traits_type;
-      typename std::basic_string_view<typename std::remove_cvref_t<T>::value_type,
-          typename std::remove_cvref_t<T>::traits_type>;
-    };
+    concept Void = std::is_void_v<T>;
 
     /// Specifies the types that can be used as Ruby identifiers.
     ///
@@ -286,7 +282,7 @@ namespace rcx {
     /// Specifies the types that can be converted from Ruby values.
     ///
     template <typename T>
-    concept ConvertibleFromValue = requires(Value v) { from_Value<T>(v); };
+    concept ConvertibleFromValue = !std::is_void_v<T> && requires(Value v) { from_Value<T>(v); };
 
     /// Specifies the types that can be converted into Ruby values.
     ///
@@ -316,7 +312,7 @@ namespace rcx {
 
   /// Argument parsing.
   ///
-  namespace arg {
+  namespace args {
     template <concepts::ConvertibleFromValue T = Value> struct Self {
       using ResultType = detail::wrap_ref_t<T>;
       static ResultType parse(Ruby &, Value self, std::span<Value> &args);
@@ -406,6 +402,16 @@ namespace rcx {
       requires CharTraits<::rcx::CharTraits<std::remove_cvref_t<T>>>;
       typename std::basic_string_view<std::remove_cvref_t<T>>;
     };
+
+    /// Specifies the string types that can be mapped to Ruby strings.
+    ///
+    template <typename T>
+    concept StringLike = requires {
+      requires CharLike<typename std::remove_cvref_t<T>::value_type>;
+      typename std::remove_cvref_t<T>::traits_type;
+      typename std::basic_string_view<typename std::remove_cvref_t<T>::value_type,
+          typename std::remove_cvref_t<T>::traits_type>;
+    };
   };
 
   /// Literals
@@ -534,10 +540,40 @@ namespace rcx {
       ClassT<Derived> get_class() const;
       Derived freeze() const;
 
+      /// Defines a singleton method for the object.
+      ///
+      /// @warning Defining a method this way allocates a resource that will never be
+      ///   garbage-collected.
+      ///
+      /// @tparam Self The type of the receiver.
+      /// @tparam ArgSpec The types of the method arguments.
+      /// @param mid The name of the method.
+      /// @param function The C++ function to be invoked. It should accept `Self` as
+      ///   the first argument, followed by the arguments defined by `argspec`.
+      /// @param argspec The argument specifications for the method.
+      /// @return Returns the receiver.
       template <concepts::ConvertibleFromValue Self = Derived, concepts::ArgSpec... ArgSpec>
       Derived define_singleton_method(concepts::Identifier auto &&mid,
           std::invocable<Self, typename ArgSpec::ResultType...> auto &&function,
           ArgSpec... argspec) const;
+
+      /// @overload
+      ///
+      /// This overload defines a method that does not use the receiver.
+      ///
+      /// @warning Defining a method this way allocates a resource that will never be
+      ///   garbage-collected.
+      ///
+      /// @tparam Self Must be `void`.
+      /// @param mid The name of the method.
+      /// @param function The C++ function to be invoked. It should accept the
+      ///   arguments defined by `argspec`.
+      /// @param argspec The argument specifications for the method.
+      /// @return Returns the receiver.
+      template <concepts::Void Self, concepts::ArgSpec... ArgSpec>
+      Derived define_singleton_method(concepts::Identifier auto &&mid,
+          std::invocable<typename ArgSpec::ResultType...> auto &&function,
+          ArgSpec... argspec) const;
     };
 
     class Value: public ValueT<Value, ValueBase, Nilable> {
@@ -635,6 +671,23 @@ namespace rcx {
           std::invocable<Self, typename ArgSpec::ResultType...> auto &&function,
           ArgSpec... argspec) const;
 
+      /// @overload
+      ///
+      /// This overload defines a method that does not use the receiver.
+      ///
+      /// @warning Defining method this way allocates a resource that will never be
+      /// garbage-collected.
+      ///
+      /// @tparam Self Must be `void`.
+      /// @param mid The name of the method.
+      /// @param function The function to be called.
+      /// @param argspec List of argument specifications.
+      /// @return Self.
+      template <concepts::Void Self, concepts::ArgSpec... ArgSpec>
+      Module define_method(concepts::Identifier auto &&mid,
+          std::invocable<typename ArgSpec::ResultType...> auto &&function,
+          ArgSpec... argspec) const;
+
       /// Checks if a constant is defined under this module.
       ///
       /// @param name Name of the constant.
@@ -1101,7 +1154,8 @@ namespace rcx {
     inline value::Class const Encoding = detail::unsafe_coerce<value::Class>(::rb_cEncoding);
     /// `Symbol` class
     ///
-    inline value::Class const Symbol = detail::unsafe_coerce<value::Class>(::rb_cSymbol);
+    inline value::ClassT<value::Symbol> const Symbol =
+        detail::unsafe_coerce<value::ClassT<value::Symbol>>(::rb_cSymbol);
     /// `Regexp` class
     ///
     inline value::Class const Regexp = detail::unsafe_coerce<value::Class>(::rb_cRegexp);
@@ -1141,10 +1195,12 @@ namespace rcx {
     inline value::Class const Range = detail::unsafe_coerce<value::Class>(::rb_cRange);
     /// `IO` class
     ///
-    inline value::Class const IO = detail::unsafe_coerce<value::Class>(::rb_cIO);
+    inline value::ClassT<value::IO> const IO =
+        detail::unsafe_coerce<value::ClassT<value::IO>>(::rb_cIO);
     /// `File` class
     ///
-    inline value::Class const File = detail::unsafe_coerce<value::Class>(::rb_cFile);
+    inline value::ClassT<value::IO> const File =
+        detail::unsafe_coerce<value::ClassT<value::IO>>(::rb_cFile);
     /// `Thread` class
     ///
     inline value::Class const Thread = detail::unsafe_coerce<value::Class>(::rb_cThread);
@@ -1293,7 +1349,8 @@ namespace rcx {
 #ifdef RCX_IO_BUFFER
     /// `IO::Buffer` class
     ///
-    inline value::Class const IOBuffer = detail::unsafe_coerce<value::Class>(::rb_cIOBuffer);
+    inline value::ClassT<value::IOBuffer> const IOBuffer =
+        detail::unsafe_coerce<value::ClassT<value::IOBuffer>>(::rb_cIOBuffer);
 #endif
   };
 

data/include/rcx/internal/rcx_impl.hpp

@@ -235,7 +235,7 @@ namespace rcx {
         std::conditional_t<std::derived_from<T, typed_data::WrappedStructBase>, T const &, T const>;
   };
 
-  namespace arg {
+  namespace args {
     template <concepts::ConvertibleFromValue T>
     inline typename Self<T>::ResultType Self<T>::parse(Ruby &, Value self, std::span<Value> &) {
       return from_Value<T>(self);
@@ -611,7 +611,7 @@ namespace rcx {
     inline Derived ValueT<Derived, Super, nilable>::define_singleton_method(
         concepts::Identifier auto &&mid,
         std::invocable<Self, typename ArgSpec::ResultType...> auto &&function, ArgSpec...) const {
-      auto const callback = detail::method_callback<arg::Self<Self>, ArgSpec...>::alloc(
+      auto const callback = detail::method_callback<args::Self<Self>, ArgSpec...>::alloc(
           std::forward<decltype(function)>(function));
       detail::protect([&]() noexcept {
         auto const singleton = ::rb_singleton_class(this->as_VALUE());
@@ -621,6 +621,21 @@ namespace rcx {
       return *static_cast<Derived const *>(this);
     }
 
+    template <typename Derived, std::derived_from<ValueBase> Super, Nilability nilable>
+    template <concepts::Void, concepts::ArgSpec... ArgSpec>
+    inline Derived ValueT<Derived, Super, nilable>::define_singleton_method(
+        concepts::Identifier auto &&mid,
+        std::invocable<typename ArgSpec::ResultType...> auto &&function, ArgSpec...) const {
+      auto const callback =
+          detail::method_callback<ArgSpec...>::alloc(std::forward<decltype(function)>(function));
+      detail::protect([&]() noexcept {
+        auto const singleton = ::rb_singleton_class(this->as_VALUE());
+        rb_define_method_id(
+            singleton, detail::into_ID(std::forward<decltype(mid)>(mid)), callback, -1);
+      });
+      return *static_cast<Derived const *>(this);
+    }
+
     /// Value
 
     template <concepts::ConvertibleFromValue R>
@@ -707,7 +722,18 @@ namespace rcx {
     template <concepts::ConvertibleFromValue Self, concepts::ArgSpec... ArgSpec>
     inline Module Module::define_method(concepts::Identifier auto &&mid,
         std::invocable<Self, typename ArgSpec::ResultType...> auto &&function, ArgSpec...) const {
-      auto const callback = detail::method_callback<arg::Self<Self>, ArgSpec...>::alloc(function);
+      auto const callback = detail::method_callback<args::Self<Self>, ArgSpec...>::alloc(function);
+      detail::protect([&]() noexcept {
+        rb_define_method_id(
+            as_VALUE(), detail::into_ID(std::forward<decltype(mid)>(mid)), callback, -1);
+      });
+      return *this;
+    }
+
+    template <concepts::Void, concepts::ArgSpec... ArgSpec>
+    inline Module Module::define_method(concepts::Identifier auto &&mid,
+        std::invocable<typename ArgSpec::ResultType...> auto &&function, ArgSpec...) const {
+      auto const callback = detail::method_callback<ArgSpec...>::alloc(function);
       detail::protect([&]() noexcept {
         rb_define_method_id(
             as_VALUE(), detail::into_ID(std::forward<decltype(mid)>(mid)), callback, -1);
@@ -792,7 +818,7 @@ namespace rcx {
     inline ClassT<T> ClassT<T>::define_method(concepts::Identifier auto &&mid,
         std::invocable<T &, typename ArgSpec::ResultType...> auto &&function, ArgSpec...) const {
       auto const callback =
-          detail::method_callback<arg::Self<detail::self_type<T>>, ArgSpec...>::alloc(
+          detail::method_callback<args::Self<detail::self_type<T>>, ArgSpec...>::alloc(
               std::forward<decltype(function)>(function));
       detail::protect([&]() noexcept {
         rb_define_method_id(
@@ -807,7 +833,7 @@ namespace rcx {
         std::invocable<T const &, typename ArgSpec::ResultType...> auto &&function,
         ArgSpec...) const {
       auto const callback =
-          detail::method_callback<arg::Self<detail::self_type_const<T>>, ArgSpec...>::alloc(
+          detail::method_callback<args::Self<detail::self_type_const<T>>, ArgSpec...>::alloc(
               function);
       detail::protect([&]() noexcept {
         rb_define_method_id(
@@ -820,7 +846,7 @@ namespace rcx {
     template <concepts::ArgSpec... ArgSpec>
       requires std::constructible_from<T, typename ArgSpec::ResultType...>
     inline ClassT<T> ClassT<T>::define_constructor(ArgSpec...) const {
-      auto const callback = detail::method_callback<arg::Self<Value>, ArgSpec...>::alloc(
+      auto const callback = detail::method_callback<args::Self<Value>, ArgSpec...>::alloc(
           typed_data::DataType<T>::template initialize<typename ArgSpec::ResultType...>);
       detail::protect([&]() noexcept {
         using namespace literals;
@@ -833,7 +859,7 @@ namespace rcx {
     inline ClassT<T> ClassT<T>::define_copy_constructor() const
       requires std::copy_constructible<T>
     {
-      auto const callback = detail::method_callback<arg::Self<Value>, arg::Arg<T const &>>::alloc(
+      auto const callback = detail::method_callback<args::Self<Value>, args::Arg<T const &>>::alloc(
           typed_data::DataType<T>::initialize_copy);
       detail::protect([&]() noexcept {
         using namespace literals;

data/lib/rcx/version.rb

@@ -1,3 +1,3 @@
 module RCX
-  VERSION = -'0.3.1'
+  VERSION = -'0.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rcx
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Kasumi Hanazuki