[GR-19839] Clean up primitives.

PullRequest: truffleruby/1170

Author: pitr-ch

.rubocop.yml

@@ -373,4 +373,4 @@ Style/StringLiterals:
 # Supports --auto-correct
 Style/UnlessElse:
   Description: Checks for unless expressions with else clauses.
-  Enabled: true
+  Enabled: true

doc/contributor/testing.md

@@ -117,7 +117,7 @@ The compiler tests include a sort of test suite for compilation, called the
 partial evaluation (*PE*) tests, as well as tests for more subtle things like
 on-stack-replacement.
 
-Special methods such as `Truffle::Graal.assert_constant` are used to implement
+Special methods such as `TrufflePrimitive.assert_compilation_constant` are used to implement
 this.
 
 Compiler tests are in `test/truffle/compiler`.

doc/samples/can-we-fold-yet.rb

@@ -19,11 +19,11 @@
 
   test_thread = Thread.new do
     begin
-      eval "loop { Truffle::Graal.assert_constant #{code}; Truffle::Graal.assert_not_compiled; Thread.pass }"
+      eval "loop { TrufflePrimitive.assert_compilation_constant #{code}; TrufflePrimitive.assert_not_compiled; Thread.pass }"
     rescue Truffle::GraalError => e
-      if e.message.include? 'Truffle::Graal.assert_not_compiled'
+      if e.message.include? 'TrufflePrimitive.assert_not_compiled'
         puts "Yes! Truffle can constant fold this to #{eval(code).inspect}"
-      elsif e.message.include? 'Truffle::Graal.assert_constant'
+      elsif e.message.include? 'TrufflePrimitive.assert_compilation_constant'
         puts "No :( Truffle can't constant fold that"
       else
         puts 'There was an error executing that :('

lib/truffle/digest.rb

@@ -83,13 +83,11 @@ def reset
 
     def digest(message = NO_MESSAGE)
       if NO_MESSAGE == message
-        Truffle.privately do
-          clone.finish
-        end
+        clone.__send__ :finish
       else
         reset
         update message
-        digested = Truffle.privately { finish }
+        digested = finish
         reset
         digested
       end

lib/truffle/truffle/cext.rb

@@ -616,7 +616,7 @@ def rb_obj_instance_variables(object)
   end
 
   def rb_copy_generic_ivar(clone, original)
-    Truffle.check_frozen(clone)
+    TrufflePrimitive.check_frozen clone
     original_ivars = original.instance_variables
     rb_free_generic_ivar(clone)
     original_ivars.each do |var|
@@ -625,7 +625,7 @@ def rb_copy_generic_ivar(clone, original)
   end
 
   def rb_free_generic_ivar(original)
-    Truffle.check_frozen(original)
+    TrufflePrimitive.check_frozen original
     original_ivars = original.instance_variables
     original_ivars.each do |var|
       original.__send__ :remove_instance_variable, var
@@ -1257,9 +1257,7 @@ def rb_io_puts(out, args)
   end
 
   def rb_obj_call_init(obj, args)
-    Truffle.privately do
-      obj.initialize(*args)
-    end
+    obj.__send__ :initialize, *args
   end
 
   def rb_obj_instance_eval(obj, args, block)
@@ -1363,15 +1361,11 @@ def rb_complex_polar(r, theta)
   end
 
   def rb_complex_set_real(complex, real)
-    Truffle.privately do
-      complex.real = real
-    end
+    complex.__send__ :real=, real
   end
 
   def rb_complex_set_imag(complex, imag)
-    Truffle.privately do
-      complex.imag = imag
-    end
+    complex.__send__ :imag=, imag
   end
 
   def rb_mutex_new

spec/truffle/graal/assert_constant_spec.rb

@@ -8,15 +8,15 @@
 
 require_relative '../../ruby/spec_helper'
 
-describe "Truffle::Graal.assert_constant" do
+describe "TrufflePrimitive.assert_compilation_constant" do
 
   it "raises a RuntimeError when called dynamically" do
-    -> { Truffle::Graal.send(:assert_constant, 14 + 2) }.should raise_error(RuntimeError)
+    -> { tp = TrufflePrimitive; tp.assert_constant(14 + 2) }.should raise_error(NoMethodError, /syntactically/)
   end
 
   guard -> { !TruffleRuby.jit? } do
     it "returns the value of the argument" do
-      Truffle::Graal.assert_constant(14 + 2).should == 16
+      TrufflePrimitive.assert_compilation_constant(14 + 2).should == 16
     end
   end
 

spec/truffle/graal/assert_not_compiled_spec.rb

@@ -8,15 +8,15 @@
 
 require_relative '../../ruby/spec_helper'
 
-describe "Truffle::Graal.assert_not_compiled" do
+describe "TrufflePrimitive.assert_not_compiled" do
 
   it "raises a RuntimeError when called dynamically" do
-    -> { Truffle::Graal.send(:assert_not_compiled) }.should raise_error(RuntimeError)
+    -> { tp = TrufflePrimitive; tp.assert_not_compiled }.should raise_error(NoMethodError, /syntactically/)
   end
 
   guard -> { !TruffleRuby.jit? } do
     it "returns nil" do
-      Truffle::Graal.assert_not_compiled.should be_nil
+      TrufflePrimitive.assert_not_compiled.should be_nil
     end
   end
 

spec/truffle/graal/bailout_spec.rb

@@ -8,15 +8,11 @@
 
 require_relative '../../ruby/spec_helper'
 
-describe "Truffle::Graal.bailout" do
-
-  it "raises a RuntimeError when called dynamically" do
-    -> { Truffle::Graal.send(:bailout, "message") }.should raise_error(RuntimeError)
-  end
+describe "TrufflePrimitive.compiler_bailout" do
 
   guard -> { !TruffleRuby.jit? } do
     it "returns nil" do
-      Truffle::Graal.bailout("message").should be_nil
+      TrufflePrimitive.compiler_bailout("message").should be_nil
     end
   end
 

src/annotations/java/org/truffleruby/builtins/CoreMethod.java

@@ -59,8 +59,10 @@
     boolean needsBlock() default false;
 
     /**
-     * Try to lower argument <code>i</code> (starting at 1) to an int if its value is a long.
-     * Use 0 for <code>self</code>.
+     * Try to lower argument <code>i</code> (starting at 0) to an int if its value is a long.
+     * The 0 is reserved for <code>self</code>.
+     * If {@link #needsSelf() needsSelf} is false then there is no 0 argument explicitly passed.
+     * Therefore the remaining arguments start at 1.
      */
     int[] lowerFixnum() default {};
 

src/annotations/java/org/truffleruby/builtins/Primitive.java

@@ -20,19 +20,17 @@
 
     String name();
 
-    // TODO (eregon, 28 Sept 2019): is this still needed?
-    boolean needsSelf() default true;
-
     /**
-     * Try to lower argument <code>i</code> (starting at 1) to an int if its value is a long.
-     * Use 0 for <code>self</code>.
+     * Try to lower argument <code>i</code> (starting at 0) to an int if its value is a long.
+     * The argument at 0 is usually the <code>receiver</code>.
      */
     int[] lowerFixnum() default {};
 
     /**
-     * Raise an error if self is frozen.
+     * Raise an error if any of the arguments with a given index is frozen.
+     * Indexation is same as for {@link #lowerFixnum()}.
      */
-    boolean raiseIfFrozenSelf() default false;
+    int[] raiseIfFrozen() default {};
 
     /**
      * Use these names in Ruby core methods stubs, ignore argument names in Java specializations.