[GR-30034] Make BiConsumerNode and BiFunctionNode not implement NodeInterface any longer and rename them to clarify they should PE.

PullRequest: truffleruby/2623

Author: eregon

src/main/java/org/truffleruby/collections/BiConsumerNode.java renamed to src/main/java/org/truffleruby/collections/PEBiConsumer.java

@@ -12,11 +12,8 @@
 import java.util.function.BiConsumer;
 
 import com.oracle.truffle.api.frame.VirtualFrame;
-import com.oracle.truffle.api.nodes.NodeInterface;
-
-/** {@link BiConsumer} as a Node */
-public interface BiConsumerNode extends NodeInterface {
 
+/** A {@link BiConsumer} that can be partially evaluated. */
+public interface PEBiConsumer {
     void accept(VirtualFrame frame, Object key, Object value, Object state);
-
 }

src/main/java/org/truffleruby/collections/BiFunctionNode.java renamed to src/main/java/org/truffleruby/collections/PEBiFunction.java

@@ -12,11 +12,8 @@
 import java.util.function.BiFunction;
 
 import com.oracle.truffle.api.frame.VirtualFrame;
-import com.oracle.truffle.api.nodes.NodeInterface;
-
-/** {@link BiFunction} as a Node */
-public interface BiFunctionNode extends NodeInterface {
 
+/** A {@link BiFunction} that can be partially evaluated. */
+public interface PEBiFunction {
     Object accept(VirtualFrame frame, Object hash, Object key);
-
 }

src/main/java/org/truffleruby/core/hash/HashNodes.java

@@ -21,8 +21,8 @@
 import org.truffleruby.builtins.Primitive;
 import org.truffleruby.builtins.PrimitiveArrayArgumentsNode;
 import org.truffleruby.builtins.YieldingCoreMethodNode;
-import org.truffleruby.collections.BiConsumerNode;
-import org.truffleruby.collections.BiFunctionNode;
+import org.truffleruby.collections.PEBiConsumer;
+import org.truffleruby.collections.PEBiFunction;
 import org.truffleruby.core.array.ArrayBuilderNode;
 import org.truffleruby.core.array.ArrayBuilderNode.BuilderState;
 import org.truffleruby.core.array.RubyArray;
@@ -183,24 +183,24 @@ public static HashLookupOrExecuteDefaultNode getUncached() {
         }
 
         public abstract Object executeGet(Frame frame, RubyHash hash, Object key,
-                BiFunctionNode defaultValueNode);
+                PEBiFunction defaultValueNode);
 
         @Specialization(guards = "isNullHash(hash)")
-        protected Object getNull(Frame frame, RubyHash hash, Object key, BiFunctionNode defaultValueNode) {
+        protected Object getNull(Frame frame, RubyHash hash, Object key, PEBiFunction defaultValueNode) {
             // frame should be virtual or null
             return defaultValueNode.accept((VirtualFrame) frame, hash, key);
         }
 
         @Specialization(guards = "isPackedHash(hash)")
-        protected Object getPackedArray(Frame frame, RubyHash hash, Object key, BiFunctionNode defaultValueNode,
+        protected Object getPackedArray(Frame frame, RubyHash hash, Object key, PEBiFunction defaultValueNode,
                 @Cached LookupPackedEntryNode lookupPackedEntryNode,
                 @Cached HashingNodes.ToHash hashNode) {
             int hashed = hashNode.execute(key, hash.compareByIdentity); // Call key.hash only once
             return lookupPackedEntryNode.executePackedLookup(frame, hash, key, hashed, defaultValueNode);
         }
 
         @Specialization(guards = "isBucketHash(hash)")
-        protected Object getBuckets(Frame frame, RubyHash hash, Object key, BiFunctionNode defaultValueNode,
+        protected Object getBuckets(Frame frame, RubyHash hash, Object key, PEBiFunction defaultValueNode,
                 @Cached LookupEntryNode lookupEntryNode,
                 @Cached BranchProfile notInHashProfile) {
             final HashLookupResult hashLookupResult = lookupEntryNode.lookup(hash, key);
@@ -217,7 +217,7 @@ protected Object getBuckets(Frame frame, RubyHash hash, Object key, BiFunctionNo
 
     @CoreMethod(names = "[]", required = 1)
     @ImportStatic(HashGuards.class)
-    public abstract static class GetIndexNode extends CoreMethodArrayArgumentsNode implements BiFunctionNode {
+    public abstract static class GetIndexNode extends CoreMethodArrayArgumentsNode implements PEBiFunction {
 
         @Child private DispatchNode callDefaultNode;
 
@@ -240,7 +240,7 @@ public Object accept(VirtualFrame frame, Object hash, Object key) {
     }
 
     @Primitive(name = "hash_get_or_undefined")
-    public abstract static class GetOrUndefinedNode extends PrimitiveArrayArgumentsNode implements BiFunctionNode {
+    public abstract static class GetOrUndefinedNode extends PrimitiveArrayArgumentsNode implements PEBiFunction {
 
         @Child private HashLookupOrExecuteDefaultNode lookupNode = HashLookupOrExecuteDefaultNode.create();
 
@@ -950,11 +950,11 @@ public static EachKeyValueNode create() {
             return EachKeyValueNodeGen.create();
         }
 
-        public abstract Object executeEachKeyValue(VirtualFrame frame, RubyHash hash, BiConsumerNode callbackNode,
+        public abstract Object executeEachKeyValue(VirtualFrame frame, RubyHash hash, PEBiConsumer callbackNode,
                 Object state);
 
         @Specialization(guards = "isNullHash(hash)")
-        protected Object eachNull(RubyHash hash, BiConsumerNode callbackNode, Object state) {
+        protected Object eachNull(RubyHash hash, PEBiConsumer callbackNode, Object state) {
             return state;
         }
 
@@ -963,7 +963,7 @@ protected Object eachNull(RubyHash hash, BiConsumerNode callbackNode, Object sta
                 guards = { "isPackedHash(hash)", "getSize(hash) == cachedSize" },
                 limit = "getPackedHashLimit()")
         protected Object eachPackedArrayCached(
-                VirtualFrame frame, RubyHash hash, BiConsumerNode callbackNode, Object state,
+                VirtualFrame frame, RubyHash hash, PEBiConsumer callbackNode, Object state,
                 @Cached("getSize(hash)") int cachedSize) {
             assert HashOperations.verifyStore(getContext(), hash);
             final Object[] store = (Object[]) hash.store;
@@ -980,7 +980,7 @@ protected Object eachPackedArrayCached(
         }
 
         @Specialization(guards = "isBucketHash(hash)")
-        protected Object eachBuckets(VirtualFrame frame, RubyHash hash, BiConsumerNode callbackNode, Object state) {
+        protected Object eachBuckets(VirtualFrame frame, RubyHash hash, PEBiConsumer callbackNode, Object state) {
             assert HashOperations.verifyStore(getContext(), hash);
 
             Entry entry = hash.firstInSequence;

src/main/java/org/truffleruby/core/hash/LookupPackedEntryNode.java

@@ -13,7 +13,7 @@
 import com.oracle.truffle.api.dsl.GenerateUncached;
 import com.oracle.truffle.api.frame.VirtualFrame;
 import org.truffleruby.RubyLanguage;
-import org.truffleruby.collections.BiFunctionNode;
+import org.truffleruby.collections.PEBiFunction;
 import org.truffleruby.core.basicobject.BasicObjectNodes.ReferenceEqualNode;
 import org.truffleruby.language.RubyBaseNode;
 
@@ -35,7 +35,7 @@ public static LookupPackedEntryNode create() {
     }
 
     public abstract Object executePackedLookup(Frame frame, RubyHash hash, Object key, int hashed,
-            BiFunctionNode defaultValueNode);
+            PEBiFunction defaultValueNode);
 
     @Specialization(
             guards = {
@@ -44,7 +44,7 @@ public abstract Object executePackedLookup(Frame frame, RubyHash hash, Object ke
                     "cachedIndex < getSize(hash)",
                     "sameKeysAtIndex(refEqual, hash, key, hashed, cachedIndex, cachedByIdentity)" },
             limit = "1")
-    protected Object getConstantIndexPackedArray(RubyHash hash, Object key, int hashed, BiFunctionNode defaultValueNode,
+    protected Object getConstantIndexPackedArray(RubyHash hash, Object key, int hashed, PEBiFunction defaultValueNode,
             @Cached ReferenceEqualNode refEqual,
             @Cached("isCompareByIdentity(hash)") boolean cachedByIdentity,
             @Cached("index(refEqual, hash, key, hashed, cachedByIdentity)") int cachedIndex) {
@@ -93,7 +93,7 @@ protected int getSize(RubyHash hash) {
 
     @ExplodeLoop(kind = LoopExplosionKind.FULL_UNROLL_UNTIL_RETURN)
     @Specialization(replaces = "getConstantIndexPackedArray")
-    protected Object getPackedArray(Frame frame, RubyHash hash, Object key, int hashed, BiFunctionNode defaultValueNode,
+    protected Object getPackedArray(Frame frame, RubyHash hash, Object key, int hashed, PEBiFunction defaultValueNode,
             @Cached CompareHashKeysNode compareHashKeys,
             @Cached BranchProfile notInHashProfile,
             @Cached ConditionProfile byIdentityProfile,

src/main/java/org/truffleruby/core/hash/RubyHash.java

@@ -26,7 +26,7 @@
 
 import com.oracle.truffle.api.profiles.ConditionProfile;
 import org.truffleruby.RubyContext;
-import org.truffleruby.collections.BiFunctionNode;
+import org.truffleruby.collections.PEBiFunction;
 import org.truffleruby.core.klass.RubyClass;
 import org.truffleruby.interop.ForeignToRubyNode;
 import org.truffleruby.language.RubyDynamicObject;
@@ -98,7 +98,7 @@ public long getHashSize() {
         return size;
     }
 
-    private static final class DefaultProvider implements BiFunctionNode {
+    private static final class DefaultProvider implements PEBiFunction {
         final Object defaultValue;
 
         private DefaultProvider(Object defaultValue) {

src/main/java/org/truffleruby/language/arguments/CheckKeywordArityNode.java

@@ -14,7 +14,7 @@
 import com.oracle.truffle.api.TruffleLanguage.ContextReference;
 import org.truffleruby.RubyContext;
 import org.truffleruby.RubyLanguage;
-import org.truffleruby.collections.BiConsumerNode;
+import org.truffleruby.collections.PEBiConsumer;
 import org.truffleruby.core.hash.RubyHash;
 import org.truffleruby.core.hash.HashNodes.EachKeyValueNode;
 import org.truffleruby.core.symbol.RubySymbol;
@@ -80,7 +80,7 @@ void checkKeywordArguments(VirtualFrame frame, RubyHash keywordArguments, Arity
         eachKeyNode.executeEachKeyValue(frame, keywordArguments, checkKeywordArgumentsNode, null);
     }
 
-    private static class CheckKeywordArgumentsNode extends RubyContextNode implements BiConsumerNode {
+    private static class CheckKeywordArgumentsNode extends RubyContextNode implements PEBiConsumer {
 
         private final boolean doesNotAcceptExtraArguments;
         private final int required;

src/main/java/org/truffleruby/language/arguments/ReadKeywordArgumentNode.java

@@ -9,7 +9,7 @@
  */
 package org.truffleruby.language.arguments;
 
-import org.truffleruby.collections.BiFunctionNode;
+import org.truffleruby.collections.PEBiFunction;
 import org.truffleruby.core.hash.RubyHash;
 import org.truffleruby.core.hash.HashNodes.HashLookupOrExecuteDefaultNode;
 import org.truffleruby.core.symbol.RubySymbol;
@@ -20,7 +20,7 @@
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.profiles.ConditionProfile;
 
-public class ReadKeywordArgumentNode extends RubyContextSourceNode implements BiFunctionNode {
+public class ReadKeywordArgumentNode extends RubyContextSourceNode implements PEBiFunction {
 
     private final RubySymbol name;
     private final ConditionProfile defaultProfile = ConditionProfile.create();

src/main/java/org/truffleruby/language/arguments/ReadKeywordRestArgumentNode.java

@@ -10,7 +10,7 @@
 package org.truffleruby.language.arguments;
 
 import org.truffleruby.RubyLanguage;
-import org.truffleruby.collections.BiConsumerNode;
+import org.truffleruby.collections.PEBiConsumer;
 import org.truffleruby.core.hash.HashNodes.EachKeyValueNode;
 import org.truffleruby.core.hash.HashOperations;
 import org.truffleruby.core.hash.RubyHash;
@@ -24,7 +24,7 @@
 import com.oracle.truffle.api.nodes.ExplodeLoop;
 import com.oracle.truffle.api.profiles.ConditionProfile;
 
-public class ReadKeywordRestArgumentNode extends RubyContextSourceNode implements BiConsumerNode {
+public class ReadKeywordRestArgumentNode extends RubyContextSourceNode implements PEBiConsumer {
 
     @CompilationFinal(dimensions = 1) private final RubySymbol[] excludedKeywords;
 

src/main/java/org/truffleruby/language/arguments/ReadRejectedKeywordArgumentsNode.java

@@ -9,7 +9,7 @@
  */
 package org.truffleruby.language.arguments;
 
-import org.truffleruby.collections.BiConsumerNode;
+import org.truffleruby.collections.PEBiConsumer;
 import org.truffleruby.core.hash.HashNodes.EachKeyValueNode;
 import org.truffleruby.core.hash.HashOperations;
 import org.truffleruby.core.hash.RubyHash;
@@ -20,7 +20,7 @@
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.profiles.ConditionProfile;
 
-public class ReadRejectedKeywordArgumentsNode extends RubyContextNode implements BiConsumerNode {
+public class ReadRejectedKeywordArgumentsNode extends RubyContextNode implements PEBiConsumer {
 
     @Child private EachKeyValueNode eachKeyNode = EachKeyValueNode.create();
     @Child private SetNode setNode = SetNode.create();