Merge pull request #91 from sue445/rb_eval_string_protect

Add RbEvalStringProtect, RbAryNew, RbAryNewCapa, RbAryPush

Author: sue445

README.md

@@ -126,11 +126,12 @@ ref. https://docs.ruby-lang.org/ja/latest/function/index.html
 * [ ] `rb_ary_delete`
 * [ ] `rb_ary_entry`
 * [ ] `rb_ary_includes`
-* [ ] `rb_ary_new`
-* [ ] `rb_ary_new2`
+* [x] `rb_ary_new`
+* [x] `rb_ary_new2`
 * [ ] `rb_ary_new3`
+* [x] `rb_ary_new_capa`
 * [ ] `rb_ary_pop`
-* [ ] `rb_ary_push`
+* [x] `rb_ary_push`
 * [ ] `rb_ary_shift`
 * [ ] `rb_ary_sort`
 * [ ] `rb_ary_store`

ruby-internal-eval.go

@@ -5,6 +5,10 @@ package ruby
 */
 import "C"
 
+import (
+	"unsafe"
+)
+
 // c.f. https://github.com/ruby/ruby/blob/master/include/ruby/internal/eval.h
 
 // RbFuncallv calls `rb_funcallv` in C
@@ -46,3 +50,19 @@ func RbEvalString(str string) VALUE {
 
 	return VALUE(C.rb_eval_string(char))
 }
+
+// RbEvalStringProtect calls `rb_eval_string_protect` in C
+//
+// Original definition is following
+//
+//	VALUE rb_eval_string_protect(const char *str, int *state)
+func RbEvalStringProtect(str string, state *Int) VALUE {
+	char, clean := string2Char(str)
+	defer clean()
+
+	var cState C.int
+	ret := C.rb_eval_string_protect(char, (*C.int)(unsafe.Pointer(&cState)))
+	*state = Int(cState)
+
+	return VALUE(ret)
+}

ruby-internal-intern-array.go

@@ -0,0 +1,40 @@
+package ruby
+
+/*
+#include "ruby.h"
+*/
+import "C"
+
+// c.f. https://github.com/ruby/ruby/blob/master/include/ruby/internal/intern/array.h
+
+// RbAryNew calls `rb_ary_new` in C
+//
+// Original definition is following
+//
+//	VALUE rb_ary_new(void)
+func RbAryNew() VALUE {
+	return VALUE(C.rb_ary_new())
+}
+
+// RbAryNewCapa calls `rb_ary_new_capa` in C
+//
+// Original definition is following
+//
+//	VALUE rb_ary_new_capa(long capa)
+func RbAryNewCapa(capa int64) VALUE {
+	return VALUE(C.rb_ary_new_capa(C.long(capa)))
+}
+
+// RbAryNew2 is alias to [RbAryNewCapa]
+func RbAryNew2(capa int64) VALUE {
+	return RbAryNewCapa(capa)
+}
+
+// RbAryPush calls `rb_ary_push` in C
+//
+// Original definition is following
+//
+//	VALUE rb_ary_push(VALUE ary, VALUE elem)
+func RbAryPush(ary VALUE, elem VALUE) VALUE {
+	return VALUE(C.rb_ary_push(C.VALUE(ary), C.VALUE(elem)))
+}

testdata/dummy/ext/dummy/tests.go

@@ -18,6 +18,10 @@ void  rb_dummy_tests_rb_const_set(VALUE self, VALUE name, VALUE val);
 VALUE rb_dummy_tests_rb_const_defined(VALUE self, VALUE name);
 VALUE rb_dummy_tests_rb_const_defined_at(VALUE self, VALUE name);
 VALUE rb_dummy_tests_rb_eval_string(VALUE self, VALUE str);
+VALUE rb_dummy_tests_rb_eval_string_protect(VALUE self, VALUE str);
+VALUE rb_dummy_tests_rb_ary_new(VALUE self);
+VALUE rb_dummy_tests_rb_ary_new_capa(VALUE self, VALUE capa);
+VALUE rb_dummy_tests_rb_ary_push(VALUE self, VALUE ary, VALUE elem);
 */
 import "C"
 
@@ -163,6 +167,41 @@ func rb_dummy_tests_rb_eval_string(_ C.VALUE, str C.VALUE) C.VALUE {
 	return C.VALUE(ret)
 }
 
+//export rb_dummy_tests_rb_eval_string_protect
+func rb_dummy_tests_rb_eval_string_protect(_ C.VALUE, str C.VALUE) C.VALUE {
+	goStr := ruby.Value2String(ruby.VALUE(str))
+
+	var state ruby.Int
+	ret := ruby.RbEvalStringProtect(goStr, &state)
+
+	slice := []ruby.VALUE{ret, ruby.INT2NUM(state)}
+	ary := ruby.Slice2rbAry(slice)
+
+	return C.VALUE(ary)
+}
+
+//export rb_dummy_tests_rb_ary_new
+func rb_dummy_tests_rb_ary_new(_ C.VALUE) C.VALUE {
+	ret := ruby.RbAryNew()
+
+	return C.VALUE(ret)
+}
+
+//export rb_dummy_tests_rb_ary_new_capa
+func rb_dummy_tests_rb_ary_new_capa(_ C.VALUE, capa C.VALUE) C.VALUE {
+	longCapa := ruby.NUM2LONG(ruby.VALUE(capa))
+	ret := ruby.RbAryNewCapa(int64(longCapa))
+
+	return C.VALUE(ret)
+}
+
+//export rb_dummy_tests_rb_ary_push
+func rb_dummy_tests_rb_ary_push(_ C.VALUE, ary C.VALUE, elem C.VALUE) C.VALUE {
+	ret := ruby.RbAryPush(ruby.VALUE(ary), ruby.VALUE(elem))
+
+	return C.VALUE(ret)
+}
+
 // defineMethodsToDummyTests define methods in Dummy::Tests
 func defineMethodsToDummyTests(rb_mDummy ruby.VALUE) {
 	rb_cTests := ruby.RbDefineClassUnder(rb_mDummy, "Tests", ruby.VALUE(C.rb_cObject))
@@ -183,4 +222,8 @@ func defineMethodsToDummyTests(rb_mDummy ruby.VALUE) {
 	ruby.RbDefineSingletonMethod(rb_cTests, "rb_const_defined", C.rb_dummy_tests_rb_const_defined, 1)
 	ruby.RbDefineSingletonMethod(rb_cTests, "rb_const_defined_at", C.rb_dummy_tests_rb_const_defined_at, 1)
 	ruby.RbDefineSingletonMethod(rb_cTests, "rb_eval_string", C.rb_dummy_tests_rb_eval_string, 1)
+	ruby.RbDefineSingletonMethod(rb_cTests, "rb_eval_string_protect", C.rb_dummy_tests_rb_eval_string_protect, 1)
+	ruby.RbDefineSingletonMethod(rb_cTests, "rb_ary_new", C.rb_dummy_tests_rb_ary_new, 0)
+	ruby.RbDefineSingletonMethod(rb_cTests, "rb_ary_new_capa", C.rb_dummy_tests_rb_ary_new_capa, 1)
+	ruby.RbDefineSingletonMethod(rb_cTests, "rb_ary_push", C.rb_dummy_tests_rb_ary_push, 2)
 }

testdata/dummy/sig/dummy/tests.rbs

@@ -25,5 +25,9 @@ module Dummy
     def self.rb_const_defined: (string name) -> bool
     def self.rb_const_defined_at: (string name) -> bool
     def self.rb_eval_string: (string str) -> untyped
+    def self.rb_eval_string_protect: (string str) -> [untyped, Integer]
+    def self.rb_ary_new: () -> []
+    def self.rb_ary_new_capa: (Integer capa) -> []
+    def self.rb_ary_push: ([] ary, untyped elem) -> []
   end
 end

testdata/dummy/spec/dummy/tests_spec.rb

@@ -188,4 +188,32 @@
       expect(Dummy::Tests.rb_eval_string("1 + 2")).to eq 3
     end
   end
+
+  describe ".rb_eval_string_protect" do
+    it "works" do
+      ret, state = Dummy::Tests.rb_eval_string_protect("1 + 2")
+
+      expect(ret).to eq 3
+      expect(state).to eq 0
+    end
+  end
+
+  describe ".rb_ary_new" do
+    it "works" do
+      expect(Dummy::Tests.rb_ary_new).to eq []
+    end
+  end
+
+  describe ".rb_ary_new_capa" do
+    it "works" do
+      expect(Dummy::Tests.rb_ary_new_capa(1)).to eq []
+    end
+  end
+
+  describe ".rb_ary_push" do
+    it "works" do
+      ret = Dummy::Tests.rb_ary_push([1], 2)
+      expect(ret).to eq [1, 2]
+    end
+  end
 end

wrapper.go

@@ -131,3 +131,14 @@ func Int2Bool(i Int) bool {
 func int2Bool(i C.int) bool {
 	return i != 0
 }
+
+// Slice2rbAry convert from Go slice to rb_ary
+func Slice2rbAry(slice []VALUE) VALUE {
+	rbAry := RbAryNewCapa(int64(len(slice)))
+
+	for _, v := range slice {
+		RbAryPush(rbAry, v)
+	}
+
+	return rbAry
+}