[GR-17457] Rename object primitives

PullRequest: truffleruby/3778

Author: eregon

doc/contributor/primitives.md

@@ -0,0 +1,12 @@
+# Primitives
+
+## Naming
+
+Primitives are generally named `#{module or class to which it belongs}_#{name of the operation}` such as `string_start_with?`.
+
+The `object_` prefix should only be used for instance variables-related operations, like `object_ivars`.
+
+For primitives which are not specific to a module or class, use no prefix, such as `Primitive.is_a?`/`Primitive.equal?`.
+
+For primitives used in many places it is nice to have a shorter name.
+OTOH for primitives used in a single place, e.g., to implement part of the logic in Ruby, then a longer name is fine.

lib/mri/monitor.rb

@@ -241,7 +241,7 @@ def initialize(...)
   # Initializes the MonitorMixin after being included in a class or when an
   # object has been extended with the MonitorMixin
   def mon_initialize
-    if defined?(@mon_mutex) && Primitive.object_equal(@mon_mutex_owner_object, self)
+    if defined?(@mon_mutex) && Primitive.equal?(@mon_mutex_owner_object, self)
       raise ThreadError, 'already initialized'
     end
     @mon_mutex = Thread::Mutex.new

lib/truffle/digest.rb

@@ -138,7 +138,7 @@ def size
     alias_method :length, :size
 
     def ==(other)
-      if Primitive.object_kind_of?(other, Digest::Instance)
+      if Primitive.is_a?(other, Digest::Instance)
         self_str = self.digest
         other_str = other.digest
       else

lib/truffle/io/wait.rb

@@ -52,12 +52,12 @@ def wait_priority(timeout = nil)
   def wait(*args)
     ensure_open
 
-    if args.size != 2 || Primitive.object_kind_of?(args[0], Symbol) || Primitive.object_kind_of?(args[1], Symbol)
+    if args.size != 2 || Primitive.is_a?(args[0], Symbol) || Primitive.is_a?(args[1], Symbol)
       # Slow/messy path:
       timeout = :undef
       events = 0
       args.each do |arg|
-        if Primitive.object_kind_of?(arg, Symbol)
+        if Primitive.is_a?(arg, Symbol)
           events |= case arg
                     when :r, :read, :readable then IO::READABLE
                     when :w, :write, :writable then IO::WRITABLE

lib/truffle/objspace.rb

@@ -56,7 +56,7 @@ def count_nodes(nodes = {})
 
   def count_objects_size(hash = {})
     ObjectSpace.each_object do |obj|
-      class_name = Primitive.object_class(obj).name
+      class_name = Primitive.class(obj).name
       if class_name
         class_name_sym = class_name.to_sym
         hash[class_name_sym] = hash.fetch(class_name_sym, 0) + ObjectSpace.memsize_of(obj)
@@ -69,7 +69,7 @@ def count_objects_size(hash = {})
 
   def count_tdata_objects(hash = {})
     ObjectSpace.each_object do |object|
-      klass = Primitive.object_class(object)
+      klass = Primitive.class(object)
       hash[klass] ||= 0
       hash[klass] += 1
     end
@@ -78,11 +78,11 @@ def count_tdata_objects(hash = {})
 
   # Helper method for ObjectSpace.dump
   def _dump(object, output)
-    if Primitive.object_kind_of?(output, String)
+    if Primitive.is_a?(output, String)
       require 'json'
       json = {
         address: '0x' + object.object_id.to_s(16),
-        class: '0x' + Primitive.object_class(object).object_id.to_s(16),
+        class: '0x' + Primitive.class(object).object_id.to_s(16),
         memsize: memsize_of(object),
         flags: { }
       }
@@ -120,7 +120,7 @@ def _dump(object, output)
 
   # Helper method for ObjectSpace.dump_all
   def _dump_all(output, full, since)
-    if Primitive.object_kind_of?(output, String)
+    if Primitive.is_a?(output, String)
       objects = []
       ObjectSpace.each_object do |object|
         objects.push dump(object)

lib/truffle/pathname.rb

@@ -1092,7 +1092,7 @@ module Kernel
   #
   # This method is available since 1.8.5.
   def Pathname(path) # :doc:
-    return path if Primitive.class_of(path) == Pathname
+    return path if Primitive.metaclass(path) == Pathname
     Pathname.new(path)
   end
   module_function :Pathname

lib/truffle/strscan.rb

@@ -333,7 +333,7 @@ def peep(len)
   private def scan_internal(pattern, advance_pos, getstr, headonly)
     scan_check_args(pattern, headonly)
 
-    if Primitive.object_kind_of?(pattern, String)
+    if Primitive.is_a?(pattern, String)
       md = scan_internal_string_pattern(pattern)
     else
       start = @fixed_anchor ? 0 : @pos

lib/truffle/truffle/cext.rb

@@ -266,7 +266,7 @@ def rbimpl_rtypeddata_p(obj)
   end
 
   def ensure_class(obj, klass, message = 'expected class %s, but object class is %s')
-    raise TypeError, format(message, klass, Primitive.object_class(obj)) unless Primitive.object_kind_of?(obj, klass)
+    raise TypeError, format(message, klass, Primitive.class(obj)) unless Primitive.is_a?(obj, klass)
   end
 
   def rb_method_boundp(klass, id, ex)
@@ -278,11 +278,11 @@ def rb_method_boundp(klass, id, ex)
   end
 
   def rb_obj_is_instance_of(object, ruby_class)
-    Primitive.object_class(object) == ruby_class
+    Primitive.class(object) == ruby_class
   end
 
   def rb_obj_is_kind_of(object, ruby_class)
-    Primitive.object_kind_of?(object, ruby_class)
+    Primitive.is_a?(object, ruby_class)
   end
 
   def SYMBOL_P(value)
@@ -310,7 +310,7 @@ def RB_FIXNUM_P(value)
   end
 
   def RB_FLOAT_TYPE_P(value)
-    Primitive.object_kind_of?(value, Float)
+    Primitive.is_a?(value, Float)
   end
 
   def rb_integer_type_p(value)
@@ -406,7 +406,7 @@ def rb_num_coerce_relop(x, y, func)
     if Primitive.nil?(ary) && !raise_error
       return nil
     end
-    if !Primitive.object_kind_of?(ary, Array) || ary.size != 2
+    if !Primitive.is_a?(ary, Array) || ary.size != 2
       raise TypeError, 'coerce must return [x, y]'
     end
     ary
@@ -443,15 +443,15 @@ def rb_hash_start(h)
   end
 
   def rb_obj_class(object)
-    Primitive.object_class(object)
+    Primitive.class(object)
   end
 
   def rb_obj_classname(object)
-    Primitive.object_class(object).name
+    Primitive.class(object).name
   end
 
   def rb_class_of(object)
-    Primitive.class_of(object)
+    Primitive.metaclass(object)
   end
 
   def rb_class_real(ruby_class)
@@ -785,7 +785,7 @@ def coderange_java_to_rb(cr)
   end
 
   def RB_ENC_CODERANGE(obj)
-    if Primitive.object_kind_of?(obj, String)
+    if Primitive.is_a?(obj, String)
       rb_enc_str_coderange(obj)
     else
       raise "Unknown coderange for obj with class `#{obj.class}`"
@@ -847,7 +847,7 @@ def rb_enc_get_index(obj)
               0
             end
           end
-    enc = rb_enc_to_index(enc) if Primitive.object_kind_of?(enc, Encoding)
+    enc = rb_enc_to_index(enc) if Primitive.is_a?(enc, Encoding)
     enc
   end
 
@@ -1007,7 +1007,7 @@ def rb_path_to_class(path)
     rescue NameError
       raise ArgumentError, "undefined class/module #{path}"
     end
-    unless Primitive.object_kind_of?(const, ::Module)
+    unless Primitive.is_a?(const, ::Module)
       raise TypeError, "#{path} does not refer to class/module"
     end
     const
@@ -1059,7 +1059,7 @@ def rb_protect(function, arg, write_status, status)
       res = Truffle::Interop.execute_without_conversion(function, arg)
     end
 
-    unless Primitive.object_equal(nil, e)
+    unless Primitive.equal?(nil, e)
       store_exception(e)
       pos = extract_tag(e)
       Primitive.thread_set_exception(extract_ruby_exception(e))
@@ -1129,7 +1129,7 @@ def rb_exc_raise(exception)
   end
 
   def rb_set_errinfo(error)
-    if Primitive.nil?(error) || Primitive.object_kind_of?(error, Exception)
+    if Primitive.nil?(error) || Primitive.is_a?(error, Exception)
       Primitive.thread_set_exception(error)
     else
       raise TypeError, 'assigning non-exception to ?!'
@@ -1255,7 +1255,7 @@ def rb_io_puts(out, args)
   end
 
   def rb_equal(a, b)
-    Primitive.object_same_or_equal(a, b)
+    Primitive.same_or_equal?(a, b)
   end
 
   def rb_obj_call_init(obj, args, block)
@@ -1487,7 +1487,7 @@ def rb_data_object_wrap(ruby_class, data, mark, free)
     data_holder = Primitive.data_holder_create(data, mark, free)
     Primitive.object_hidden_var_set object, DATA_HOLDER, data_holder
 
-    Primitive.object_space_define_data_finalizer object, data_holder unless Truffle::Interop.null?(free)
+    Primitive.objectspace_define_data_finalizer object, data_holder unless Truffle::Interop.null?(free)
 
     define_marker object, mark
 
@@ -1502,7 +1502,7 @@ def rb_data_typed_object_wrap(ruby_class, data, data_type, mark, free, size)
     Primitive.object_hidden_var_set object, DATA_HOLDER, data_holder
     Primitive.object_hidden_var_set object, DATA_MEMSIZER, data_sizer(size, data_holder) unless Truffle::Interop.null?(size)
 
-    Primitive.object_space_define_data_finalizer object, data_holder unless Truffle::Interop.null?(free)
+    Primitive.objectspace_define_data_finalizer object, data_holder unless Truffle::Interop.null?(free)
 
     define_marker object, mark
 
@@ -1544,7 +1544,7 @@ def rb_tr_error(message)
   def test_kwargs(kwargs, raise_error)
     return false if kwargs.nil?
 
-    if Primitive.object_kind_of?(kwargs, Hash) && kwargs.keys.all? { |k| Primitive.object_kind_of?(k, Symbol) }
+    if Primitive.is_a?(kwargs, Hash) && kwargs.keys.all? { |k| Primitive.is_a?(k, Symbol) }
       true
     elsif raise_error
       raise ArgumentError, "the value is not a Hash with all keys being Symbols as kwargs requires: #{kwargs}"
@@ -1698,7 +1698,7 @@ def rb_time_num_new(timev, off)
 
   def rb_time_interval_acceptable(time_val)
     # TODO (pitr-ch 09-Mar-2017): more precise error messages
-    raise TypeError, 'cannot be Time' if Primitive.object_kind_of?(time_val, Time)
+    raise TypeError, 'cannot be Time' if Primitive.is_a?(time_val, Time)
     raise ArgumentError, 'cannot be negative' if time_val < 0
   end
 
@@ -1789,7 +1789,7 @@ def rb_obj_as_string(object)
   end
 
   def rb_class_inherited_p(ruby_module, object)
-    if Primitive.object_kind_of?(object, Module)
+    if Primitive.is_a?(object, Module)
       ruby_module <= object
     else
       raise TypeError

lib/truffle/truffle/cext_structs.rb

@@ -244,7 +244,7 @@ def polyglot_read_member(name)
     when 'flags'
       compute_flags
     when 'klass'
-      Primitive.cext_wrap(Primitive.class_of(@object))
+      Primitive.cext_wrap(Primitive.metaclass(@object))
     else
       raise Truffle::Interop::UnknownIdentifierException
     end

src/main/java/org/truffleruby/core/array/ArrayNodes.java

@@ -2380,14 +2380,14 @@ private Entry(RubyArray array, int index) {
         @Specialization(guards = "!canContainObject.execute(array)", limit = "1")
         protected boolean flattenHelperPrimitive(RubyArray array, RubyArray out, int maxLevels,
                 @Cached @Exclusive ArrayAppendManyNode concat,
-                @Cached @Exclusive TypeNodes.CanContainObjectNode canContainObject) {
+                @Cached @Exclusive ArrayCanContainObjectNode canContainObject) {
             concat.executeAppendMany(out, array);
             return false;
         }
 
         @Specialization(replaces = "flattenHelperPrimitive")
         protected boolean flattenHelper(RubyArray array, RubyArray out, int maxLevels,
-                @Cached @Exclusive TypeNodes.CanContainObjectNode canContainObject,
+                @Cached @Exclusive ArrayCanContainObjectNode canContainObject,
                 @Cached @Exclusive ArrayAppendManyNode concat,
                 @Cached AtNode at,
                 @Cached DispatchNode convert,
@@ -2457,4 +2457,29 @@ private static void add(EconomicSet<RubyArray> set, RubyArray array) {
             set.add(array);
         }
     }
+
+    @Primitive(name = "array_can_contain_object?")
+    @ImportStatic(ArrayGuards.class)
+    public abstract static class ArrayCanContainObjectNode extends PrimitiveArrayArgumentsNode {
+
+        @NeverDefault
+        public static ArrayCanContainObjectNode create() {
+            return ArrayNodesFactory.ArrayCanContainObjectNodeFactory.create(null);
+        }
+
+        public abstract boolean execute(RubyArray array);
+
+        @Specialization(limit = "storageStrategyLimit()")
+        protected boolean array(RubyArray array,
+                @Bind("array.getStore()") Object store,
+                @CachedLibrary("store") ArrayStoreLibrary stores) {
+            return !stores.isPrimitive(store);
+        }
+
+        @Specialization(guards = "!isRubyArray(array)")
+        protected boolean other(Object array) {
+            return true;
+        }
+
+    }
 }