Move privately into TrufflePrimitive space

Author: pitr-ch

lib/truffle/digest.rb

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

lib/truffle/truffle/cext.rb

@@ -1257,7 +1257,7 @@ def rb_io_puts(out, args)
   end
 
   def rb_obj_call_init(obj, args)
-    Truffle.privately do
+    TrufflePrimitive.privately do
       obj.initialize(*args)
     end
   end
@@ -1363,13 +1363,13 @@ def rb_complex_polar(r, theta)
   end
 
   def rb_complex_set_real(complex, real)
-    Truffle.privately do
+    TrufflePrimitive.privately do
       complex.real = real
     end
   end
 
   def rb_complex_set_imag(complex, imag)
-    Truffle.privately do
+    TrufflePrimitive.privately do
       complex.imag = imag
     end
   end

lib/truffle/truffle/stubs.rb

@@ -0,0 +1,8 @@
+raise 'this file is a stub file for development and should never be loaded'
+
+module TrufflePrimitive
+  def self.privately(&block)
+    # language=java
+    /** @see org.truffleruby.parser.BodyTranslator.translateInvokePrimitive */
+  end
+end

src/main/java/org/truffleruby/parser/BodyTranslator.java

@@ -519,15 +519,7 @@ public RubyNode visitCallNode(CallParseNode node) {
             return addNewlineIfNeeded(node, ret);
         }
 
-        if (receiver instanceof ConstParseNode && ((ConstParseNode) receiver).getName().equals("Truffle")) {
-            // Truffle.<method>
-            // TODO (pitr-ch 29-Nov-2019): move under TrufflePrimitive ?
-            if ("privately".equals(methodName)) {
-                final RubyNode ret = translatePrivately(node);
-                return addNewlineIfNeeded(node, ret);
-            }
-
-        } else if (receiver instanceof Colon2ConstParseNode // Truffle::Graal.<method>
+        if (receiver instanceof Colon2ConstParseNode // Truffle::Graal.<method>
                 && ((Colon2ConstParseNode) receiver).getLeftNode() instanceof ConstParseNode &&
                 ((ConstParseNode) ((Colon2ConstParseNode) receiver).getLeftNode()).getName().equals("Truffle") &&
                 ((Colon2ConstParseNode) receiver).getName().equals("Graal")) {
@@ -578,23 +570,29 @@ private RubyNode translateInvokePrimitive(SourceIndexLength sourceSection, CallP
          */
 
         final String primitiveName = node.getName();
-        final PrimitiveNodeConstructor primitive = context.getPrimitiveManager().getPrimitive(primitiveName);
 
-        final ArrayParseNode args = (ArrayParseNode) node.getArgsNode();
-        final int size = args != null ? args.size() : 0;
-        final RubyNode[] arguments = new RubyNode[size];
-        for (int n = 0; n < size; n++) {
-            arguments[n] = args.get(n).accept(this);
-        }
+        if ("privately".equals(primitiveName)) {
+            final RubyNode ret = translatePrivately(node);
+            return addNewlineIfNeeded(node, ret);
+        } else {
+            final PrimitiveNodeConstructor primitive = context.getPrimitiveManager().getPrimitive(primitiveName);
+
+            final ArrayParseNode args = (ArrayParseNode) node.getArgsNode();
+            final int size = args != null ? args.size() : 0;
+            final RubyNode[] arguments = new RubyNode[size];
+            for (int n = 0; n < size; n++) {
+                arguments[n] = args.get(n).accept(this);
+            }
 
-        return primitive.createInvokePrimitiveNode(context, source, sourceSection, arguments);
+            return primitive.createInvokePrimitiveNode(context, source, sourceSection, arguments);
+        }
     }
 
     private RubyNode translatePrivately(CallParseNode node) {
         /*
          * Translates something that looks like
          *
-         *   Truffle.privately { foo }
+         *   TrufflePrimitive.privately { foo }
          *
          * into just
          *
@@ -604,12 +602,12 @@ private RubyNode translatePrivately(CallParseNode node) {
          */
 
         if (!(node.getIterNode() instanceof IterParseNode)) {
-            throw new UnsupportedOperationException("Truffle.privately needs a literal block");
+            throw new UnsupportedOperationException("TrufflePrimitive.privately needs a literal block");
         }
 
         final ArrayParseNode argsNode = (ArrayParseNode) node.getArgsNode();
         if (argsNode != null && argsNode.size() > 0) {
-            throw new UnsupportedOperationException("Truffle.privately should not have any arguments");
+            throw new UnsupportedOperationException("TrufflePrimitive.privately should not have any arguments");
         }
 
         /*
@@ -2828,7 +2826,7 @@ public RubyNode visitBigRationalNode(BigRationalParseNode node) {
     }
 
     private RubyNode translateRationalComplex(SourceIndexLength sourceSection, String name, RubyNode a, RubyNode b) {
-        // Translate as Truffle.privately { Rational.convert(a, b) }
+        // Translate as TrufflePrimitive.privately { Rational.convert(a, b) }
 
         final RubyNode moduleNode = new ObjectLiteralNode(context.getCoreLibrary().getObjectClass());
         ReadConstantNode receiver = new ReadConstantNode(moduleNode, name);

src/main/ruby/truffleruby/core/array.rb

@@ -725,7 +725,7 @@ def permutation(num=undefined, &block)
       if block
         # offensive (both definitions) copy.
         offensive = dup
-        Truffle.privately do
+        TrufflePrimitive.privately do
           offensive.__permute__(num, perm, 0, used, &block)
         end
       else
@@ -844,7 +844,7 @@ def repeated_combination(combination_size, &block)
     if combination_size < 0
       # yield nothing
     else
-      Truffle.privately do
+      TrufflePrimitive.privately do
         dup.compile_repeated_combinations(combination_size, [], 0, combination_size, &block)
       end
     end
@@ -878,7 +878,7 @@ def repeated_permutation(combination_size, &block)
     elsif combination_size == 0
       yield []
     else
-      Truffle.privately do
+      TrufflePrimitive.privately do
         dup.compile_repeated_permutations(combination_size, [], 0, &block)
       end
     end
@@ -1346,7 +1346,7 @@ def recursively_flatten(array, out, max_levels = -1)
     # Use this instead of #dup as we want an instance of Array
     sorted = Array.new(self)
 
-    Truffle.privately do
+    TrufflePrimitive.privately do
       if block
         sorted.mergesort_block!(block)
       else

src/main/ruby/truffleruby/core/channel.rb

@@ -50,7 +50,7 @@ def receive
     end
 
     def receive_timeout(duration)
-      Truffle.privately do
+      TrufflePrimitive.privately do
         @queue.receive_timeout(duration)
       end
     end

src/main/ruby/truffleruby/core/enumerator.rb

@@ -87,12 +87,12 @@ def each(*args)
       new_args = @args.empty? ? args : (@args + args)
     end
 
-    Truffle.privately do
+    TrufflePrimitive.privately do
       enumerator.args = new_args
     end
 
     if block_given?
-      Truffle.privately do
+      TrufflePrimitive.privately do
         enumerator.each_with_block do |*yield_args|
           yield(*yield_args)
         end
@@ -160,7 +160,7 @@ def next
     end
 
     exception = StopIteration.new 'iteration reached end'
-    Truffle.privately do
+    TrufflePrimitive.privately do
       exception.result = @generator.result
     end
 
@@ -282,7 +282,7 @@ def to_enum(method_name=:each, *method_args, &block)
       size = block_given? ? block : nil
       ret = Lazy.allocate
 
-      Truffle.privately do
+      TrufflePrimitive.privately do
         ret.initialize_enumerator self, size, method_name, *method_args
       end
 

src/main/ruby/truffleruby/core/exception.rb

@@ -137,7 +137,7 @@ def exception(message=nil)
         # Exception#initialize (via __initialize__) is exactly what MRI
         # does.
         e = clone
-        Truffle.privately do
+        TrufflePrimitive.privately do
           e.__initialize__(message)
         end
         return e

src/main/ruby/truffleruby/core/immediate.rb

@@ -35,7 +35,7 @@ def klass.__allocate__
       raise TypeError, "allocator undefined for #{self}"
     end
 
-    Truffle.privately do
+    TrufflePrimitive.privately do
       klass.singleton_class.undef_method(:new)
     end
   end

src/main/ruby/truffleruby/core/io.rb

@@ -433,7 +433,7 @@ def read_method(obj)
     end
 
     def run
-      Truffle.privately do
+      TrufflePrimitive.privately do
         @from.ensure_open_and_readable if @from.kind_of? IO
         @to.ensure_open_and_writable if @to.kind_of? IO
       end
@@ -537,7 +537,7 @@ def self.foreach(name, separator=undefined, limit=undefined, options=undefined,
       io = File.open(name, options)
     end
 
-    each_reader = Truffle.privately { io.create_each_reader(separator, limit) }
+    each_reader = TrufflePrimitive.privately { io.create_each_reader(separator, limit) }
 
     begin
       each_reader&.each(&block)
@@ -2090,7 +2090,7 @@ def reopen(other, mode=undefined)
       end
 
       if @descriptor != io.fileno
-        Truffle.privately do
+        TrufflePrimitive.privately do
           io.ensure_open
         end