Encapsulating array-like data and operations into a single package

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Array.enso

@@ -18,6 +18,7 @@ import project.Errors.Unimplemented.Unimplemented
 import project.Meta
 import project.Nothing.Nothing
 import project.Panic.Panic
+import project.Internal.Array_Like_Helpers
 from project.Data.Boolean import Boolean, False, True
 from project.Data.Index_Sub_Range import Index_Sub_Range
 from project.Data.Range.Extensions import all
@@ -42,7 +43,7 @@ type Array
 
              [1, 2, 3].to_array.at -1 == 3
     at : Integer -> Any ! Index_Out_Of_Bounds
-    at self index = @Builtin_Method "Array.at"
+    at self index = Array_Like_Helpers.at self index
 
     ## Returns the number of elements stored in this array.
 
@@ -51,7 +52,7 @@ type Array
 
              [1, 2, 3, 4].to_array.length
     length : Integer
-    length self = @Builtin_Method "Array.length"
+    length self = Array_Like_Helpers.length self
 
     ## Identity.
        This method is implemented purely for completeness with the runtime's

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Array_Proxy.enso

@@ -3,6 +3,8 @@ import project.Data.Array.Array
 import project.Data.Numbers.Integer
 import project.Errors.Illegal_Argument.Illegal_Argument
 
+import project.Internal.Array_Like_Helpers
+
 ## PRIVATE
    A helper type used for creating an array from a length and a callback
    providing its elements.
@@ -12,8 +14,10 @@ import project.Errors.Illegal_Argument.Illegal_Argument
    type returned from polyglot calls to other languages. The most common
    use-case for it is to pass it to `Vector.from_polyglot_array` to create a
    vector backed by such custom storage.
-@Builtin_Type
 type Array_Proxy
+    ## PRIVATE
+    Value ignore
+
     ## PRIVATE
        ADVANCED
        Creates a new `Array_Proxy` from a length and a callback.
@@ -28,21 +32,12 @@ type Array_Proxy
              Vector.from_polyglot_array (Array_Proxy.new 10000000 (i -> i))
     new : Integer -> (Integer -> Any) -> Array
     new length at = Illegal_Argument.handle_java_exception <|
-        Array_Proxy.new_builtin length at
-
-    ## PRIVATE
-       The builtin cannot throw `Illegal_Argument` as that type cannot be a
-       builtin, because they do not support default arguments in constructors.
-       So a wrapper is used which will translate a Java exception into the Enso
-       one. This indirection may be removed once the following story is done:
-       https://www.pivotaltracker.com/n/projects/2539304/stories/183817602
-    new_builtin : Integer -> (Integer -> Any) -> Array
-    new_builtin length at = @Builtin_Method "Array_Proxy.new_builtin"
+        Array_Like_Helpers.new_array_proxy_builtin length at
 
     ## PRIVATE
        ADVANCED
        Creates a new `Array_Proxy` from an object providing `length` and `at`
        methods.
     from_proxy_object : Any -> Array
     from_proxy_object proxy =
-        Array_Proxy.new proxy.length proxy.at
+        Array_Like_Helpers.new_array_proxy_builtin proxy.length proxy.at

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Vector.enso

@@ -23,6 +23,8 @@ import project.Nothing.Nothing
 import project.Panic.Panic
 import project.Random
 import project.Warning.Warning
+import project.Internal.Array_Like_Helpers
+
 from project.Data.Boolean import Boolean, False, True
 from project.Data.Filter_Condition import unify_condition_or_predicate, unify_condition_predicate_or_element
 from project.Data.Index_Sub_Range import drop_helper, Index_Sub_Range, take_helper
@@ -69,7 +71,7 @@ type Vector a
 
              Vector.new my_vec.length (ix -> my_vec.at ix)
     new : Integer -> (Integer -> Any) -> Vector Any
-    new length constructor = @Builtin_Method "Vector.new"
+    new length constructor = Array_Like_Helpers.vector_from_function length constructor
 
     ## PRIVATE
        ADVANCED
@@ -161,7 +163,7 @@ type Vector a
     ## PRIVATE
        ADVANCED
        Copies content of a vector into an Array.
-    to_array self = @Builtin_Method "Vector.to_array"
+    to_array self = Array_Like_Helpers.vector_to_array self
 
     ## Returns the number of elements stored in this vector.
 
@@ -170,7 +172,7 @@ type Vector a
 
              [1, 2, 3, 4].length
     length : Integer
-    length self = @Builtin_Method "Vector.length"
+    length self = Array_Like_Helpers.length self
 
     ## Gets an element from the vector at a specified index (0-based).
 
@@ -189,7 +191,7 @@ type Vector a
 
              [1, 2, 3].at -1 == 3
     at : Integer -> Any ! Index_Out_Of_Bounds
-    at self index = @Builtin_Method "Vector.at"
+    at self index = Array_Like_Helpers.at self index
 
     ## Gets an element from the vector at a specified index (0-based).
        If the index is invalid then `if_missing` is returned.

distribution/lib/Standard/Base/0.0.0-dev/src/Internal/Array_Like_Helpers.enso

@@ -0,0 +1,18 @@
+import project.Any.Any
+import project.Data.Array.Array
+import project.Data.Numbers.Integer
+
+## PRIVATE
+    The builtin cannot throw `Illegal_Argument` as that type cannot be a
+    builtin, because they do not support default arguments in constructors.
+    So a wrapper is used which will translate a Java exception into the Enso
+    one. This indirection may be removed once the following story is done:
+    https://www.pivotaltracker.com/n/projects/2539304/stories/183817602
+new_array_proxy_builtin : Integer -> (Integer -> Any) -> Array
+new_array_proxy_builtin length at = @Builtin_Method "Array_Like_Helpers.new_array_proxy_builtin"
+
+length array_like = @Builtin_Method "Array_Like_Helpers.length"
+at array_like index = @Builtin_Method "Array_Like_Helpers.at"
+
+vector_to_array array_like = @Builtin_Method "Array_Like_Helpers.vector_to_array"
+vector_from_function = @Builtin_Method "Array_Like_Helpers.vector_from_function"

engine/runtime-language-epb/src/main/java/org/enso/interpreter/epb/node/ReadOnlyArray.java

@@ -12,8 +12,8 @@
  * A primitive boxed array type to be used only in EPB.
  *
  * <p>{@link ReadOnlyArray} is essentially a stripped-down, read-only, version of {@link
- * org.enso.interpreter.runtime.data.Array}, used for passing arguments. The latter cannot be used
- * in EPB because EPB is a dependency of runtime.
+ * org.enso.interpreter.runtime.data.vector.Array}, used for passing arguments. The latter cannot be
+ * used in EPB because EPB is a dependency of runtime.
  */
 @ExportLibrary(InteropLibrary.class)
 public final class ReadOnlyArray implements TruffleObject {

engine/runtime/src/bench/java/org/enso/interpreter/bench/benchmarks/semantic/IfVsCaseBenchmarks.java

@@ -1,19 +1,17 @@
 package org.enso.interpreter.bench.benchmarks.semantic;
 
 import java.io.ByteArrayOutputStream;
-import java.io.File;
-import java.io.FileWriter;
 import java.io.IOException;
 import java.io.OutputStream;
 import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 import java.util.concurrent.TimeUnit;
+
 import org.enso.interpreter.test.TestBase;
 import org.enso.polyglot.MethodNames.Module;
 import org.graalvm.polyglot.Context;
-import org.graalvm.polyglot.Source;
 import org.graalvm.polyglot.Value;
 import org.graalvm.polyglot.io.IOAccess;
 import org.openjdk.jmh.annotations.Benchmark;

engine/runtime/src/main/java/org/enso/interpreter/node/callable/FunctionCallInstrumentationNode.java

@@ -16,12 +16,15 @@
 import com.oracle.truffle.api.nodes.Node;
 import com.oracle.truffle.api.nodes.NodeInfo;
 import com.oracle.truffle.api.source.SourceSection;
+
 import org.enso.interpreter.runtime.callable.function.Function;
 import org.enso.interpreter.runtime.tag.IdentifiedTag;
 
 import java.util.Arrays;
 import java.util.UUID;
+
 import org.enso.interpreter.node.ClosureRootNode;
+import org.enso.interpreter.runtime.data.EnsoObject;
 import org.enso.interpreter.runtime.tag.AvoidIdInstrumentationTag;
 
 /**
@@ -56,7 +59,7 @@ public boolean isInstrumentable() {
 
   /** A simple value class for function call information. */
   @ExportLibrary(InteropLibrary.class)
-  public static final class FunctionCall implements TruffleObject {
+  public static final class FunctionCall implements EnsoObject {
     private final Function function;
     private final Object state;
     private final @CompilerDirectives.CompilationFinal(dimensions = 1) Object[] arguments;

engine/runtime/src/main/java/org/enso/interpreter/node/callable/SequenceLiteralNode.java

@@ -1,8 +1,7 @@
 package org.enso.interpreter.node.callable;
 
 import org.enso.interpreter.node.ExpressionNode;
-import org.enso.interpreter.runtime.data.Array;
-import org.enso.interpreter.runtime.data.Vector;
+import org.enso.interpreter.runtime.data.vector.ArrayLikeHelpers;
 import org.enso.interpreter.runtime.error.PanicSentinel;
 
 import com.oracle.truffle.api.frame.VirtualFrame;
@@ -43,6 +42,6 @@ public Object executeGeneric(VirtualFrame frame) {
         throw sentinel;
       }
     }
-    return Vector.fromArray(new Array(itemValues));
+    return ArrayLikeHelpers.asVectorWithCheckAt(itemValues);
   }
 }

engine/runtime/src/main/java/org/enso/interpreter/node/controlflow/caseexpr/BranchResult.java

@@ -1,10 +1,11 @@
 package org.enso.interpreter.node.controlflow.caseexpr;
 
-import com.oracle.truffle.api.interop.TruffleObject;
 import com.oracle.truffle.api.nodes.Node;
+
 import org.enso.interpreter.runtime.EnsoContext;
+import org.enso.interpreter.runtime.data.EnsoObject;
 
-record BranchResult(boolean isMatched, Object result) implements TruffleObject {
+record BranchResult(boolean isMatched, Object result) implements EnsoObject {
   static BranchResult failure(Node node) {
     return new BranchResult(false, EnsoContext.get(node).getBuiltins().nothing());
   }

engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/error/GetAttachedStackTraceNode.java

@@ -6,15 +6,15 @@
 import org.enso.interpreter.node.expression.builtin.runtime.GetStackTraceNode;
 import org.enso.interpreter.runtime.EnsoContext;
 import org.enso.interpreter.runtime.builtin.Builtins;
-import org.enso.interpreter.runtime.data.Array;
+import org.enso.interpreter.runtime.data.EnsoObject;
 import org.enso.interpreter.runtime.error.PanicException;
 
 @BuiltinMethod(
     type = "Panic",
     name = "primitive_get_attached_stack_trace",
     description = "Gets the stack trace attached to the throwable.")
 public class GetAttachedStackTraceNode extends Node {
-  Array execute(@AcceptsError Object error) {
+  EnsoObject execute(@AcceptsError Object error) {
     if (error instanceof Throwable) {
       return GetStackTraceNode.stackTraceToArray((Throwable) error);
     } else {

engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/immutable/AtVectorNode.java

@@ -1,43 +1,39 @@
 package org.enso.interpreter.node.expression.builtin.immutable;
 
 import com.oracle.truffle.api.CompilerDirectives;
-import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.interop.InvalidArrayIndexException;
-import com.oracle.truffle.api.interop.UnsupportedMessageException;
 import com.oracle.truffle.api.nodes.Node;
 import org.enso.interpreter.dsl.BuiltinMethod;
-import org.enso.interpreter.node.expression.builtin.interop.syntax.HostValueToEnsoNode;
 import org.enso.interpreter.runtime.EnsoContext;
-import org.enso.interpreter.runtime.data.Vector;
+import org.enso.interpreter.runtime.data.vector.ArrayLikeAtNode;
+import org.enso.interpreter.runtime.data.vector.ArrayLikeLengthNode;
 import org.enso.interpreter.runtime.error.DataflowError;
-import org.enso.interpreter.runtime.error.WarningsLibrary;
 
 @BuiltinMethod(
-    type = "Vector",
+    type = "Array_Like_Helpers",
     name = "at",
     description = "Returns an element of Vector at the specified index.")
 public class AtVectorNode extends Node {
-  private @Child InteropLibrary interop = InteropLibrary.getFactory().createDispatched(3);
-  private @Child WarningsLibrary warnings = WarningsLibrary.getFactory().createDispatched(3);
-  private @Child HostValueToEnsoNode convert = HostValueToEnsoNode.build();
+  private @Child ArrayLikeAtNode at = ArrayLikeAtNode.create();
+  private @Child ArrayLikeLengthNode length;
 
-  Object execute(Vector self, long index) {
+  Object execute(Object arrayLike, long index) {
     try {
-      return readElement(self, index);
-    } catch (UnsupportedMessageException e) {
-      CompilerDirectives.transferToInterpreter();
-      throw new IllegalStateException(e);
+      long actualIndex = index < 0 ? index + len(arrayLike) : index;
+      return at.executeAt(arrayLike, actualIndex);
+    } catch (InvalidArrayIndexException e) {
+      var len = len(arrayLike);
+      var ctx = EnsoContext.get(this);
+      var payload = ctx.getBuiltins().error().makeIndexOutOfBounds(index, len);
+      return DataflowError.withoutTrace(payload, this);
     }
   }
 
-  private Object readElement(Vector self, long index) throws UnsupportedMessageException {
-    try {
-      long actualIndex = index < 0 ? index + self.length(interop) : index;
-      return self.readArrayElement(actualIndex, interop, warnings, convert);
-    } catch (InvalidArrayIndexException e) {
-      EnsoContext ctx = EnsoContext.get(this);
-      return DataflowError.withoutTrace(
-          ctx.getBuiltins().error().makeIndexOutOfBounds(index, self.length(interop)), this);
+  private long len(Object arrayLike) {
+    if (length == null) {
+      CompilerDirectives.transferToInterpreterAndInvalidate();
+      length = insert(ArrayLikeLengthNode.create());
     }
+    return length.executeLength(arrayLike);
   }
 }