fix(#3084): combined memory and malloc + added scope and remove memory leaks

.codacy.yml

@@ -3,8 +3,6 @@
 #  package name contains capital letter and such names are conventional.
 ---
 exclude_paths:
-  - "eo-runtime/src/main/java/EOorg/EOeolang/EOcage$EOencaged$EOencage.java"
-  - "eo-runtime/src/main/java/EOorg/EOeolang/Cages.java"
-  - "eo-runtime/src/main/java/EOorg/EOeolang/EOcage$EOencaged$EOφ.java"
-  - "eo-runtime/src/main/java/EOorg/EOeolang/EOcage$φ.java"
-  - "eo-runtime/src/test/java/EOorg/EOeolang/CagesTest.java"
+  - "eo-runtime/src/main/java/EOorg/EOeolang/EOmalloc$EOof$EOallocated$EOread.java"
+  - "eo-runtime/src/main/java/EOorg/EOeolang/EOmalloc$EOof$EOallocated$EOwrite.java"
+  - "eo-runtime/src/test/java/EOorg/EOeolang/EOmallocTest.java"

eo-maven-plugin/src/main/java/org/eolang/maven/optimization/OptTrain.java

@@ -29,8 +29,10 @@
 import com.yegor256.xsline.TrClasspath;
 import com.yegor256.xsline.TrDefault;
 import com.yegor256.xsline.TrFast;
+import com.yegor256.xsline.TrLambda;
 import com.yegor256.xsline.Train;
 import com.yegor256.xsline.Xsline;
+import org.eolang.parser.StEoLogged;
 
 /**
  * Optimisation train of XLS`s.
@@ -50,18 +52,21 @@ public final class OptTrain implements Optimization {
      * the hood in {@link TrClasspath}, is not thread-safe.
      */
     static final Train<Shift> DEFAULT_TRAIN = new TrFast(
-        new TrClasspath<>(
-            new TrDefault<>(),
-            "/org/eolang/parser/optimize/globals-to-abstracts.xsl",
-            "/org/eolang/parser/optimize/remove-refs.xsl",
-            "/org/eolang/parser/optimize/abstracts-float-up.xsl",
-            "/org/eolang/parser/optimize/remove-levels.xsl",
-            "/org/eolang/parser/add-refs.xsl",
-            "/org/eolang/parser/optimize/fix-missed-names.xsl",
-            "/org/eolang/parser/add-refs.xsl",
-            "/org/eolang/parser/errors/broken-refs.xsl",
-            "/org/eolang/parser/set-locators.xsl"
-        ).back(),
+        new TrLambda(
+            new TrClasspath<>(
+                new TrDefault<>(),
+                "/org/eolang/parser/optimize/globals-to-abstracts.xsl",
+                "/org/eolang/parser/optimize/remove-refs.xsl",
+                "/org/eolang/parser/optimize/abstracts-float-up.xsl",
+                "/org/eolang/parser/optimize/remove-levels.xsl",
+                "/org/eolang/parser/add-refs.xsl",
+                "/org/eolang/parser/optimize/fix-missed-names.xsl",
+                "/org/eolang/parser/add-refs.xsl",
+                "/org/eolang/parser/errors/broken-refs.xsl",
+                "/org/eolang/parser/set-locators.xsl"
+            ).back(),
+            StEoLogged::new
+        ),
         TrFast.class,
         500L
     );

eo-parser/src/main/antlr4/org/eolang/parser/Eo.g4

@@ -527,7 +527,7 @@ spacedArrow
 // Does not contain elements in vertical notation
 // Is used in happlicationArg, hmethodHead
 scope
-    : LB (happlication | hanonym) RB
+    : LB (happlication | hanonym | onlyphi) RB
     ;
 
 // Version

eo-parser/src/main/java/org/eolang/parser/StEoLogged.java

@@ -34,7 +34,7 @@
  *
  * @since 0.30
  */
-final class StEoLogged implements Shift {
+public final class StEoLogged implements Shift {
 
     /**
      * Origin shift.
@@ -50,7 +50,7 @@ final class StEoLogged implements Shift {
      * Ctor.
      * @param shift Origin shift
      */
-    StEoLogged(final Shift shift) {
+    public StEoLogged(final Shift shift) {
         this(shift, message -> Logger.error(StEoLogged.class, message));
     }
 

eo-parser/src/test/resources/org/eolang/parser/packs/onlyphi-bound.yaml

@@ -6,6 +6,7 @@ tests:
   - //o[@base='a']/o[@abstract and not(@name) and o[@abstract and @name='@' and o[@base='a' and @name='b']] and o[@name='c']]
   - //o[@base='a']/o[@abstract and not(@name) and o[@base='d' and @name='@']]
   - //o[@abstract and o[@base='z' and @name='@']]/following-sibling::o[@base='.x' and @method]
+  - //o[@base='m']/o[@abstract and not(@name) and o[@name='q' and not(@base)] and o[@base='q' and @name='@']]
 eo: |
   a > x
     a.b > [i]
@@ -14,3 +15,4 @@ eo: |
     d > []
   z > []
   .x
+  m (q > [q])

eo-runtime/src/main/eo/org/eolang/go.eo

@@ -54,7 +54,9 @@
 # ```
 # Go to.
 [] > go
-  (malloc 1).id.as-bytes > id
+  malloc.of > id!
+    8
+    m.put m.id > [m]
 
   # To.
   [body] > to

eo-runtime/src/main/eo/org/eolang/malloc.eo

@@ -26,34 +26,87 @@
 +rt jvm org.eolang:eo-runtime:0.0.0
 +version 0.0.0
 
-# Allocates a block in memory of `size` bytes.
-# You can use it like:
+# Storage of data in memory.
+#
+# There are two ways of usage `malloc`:
+# 1. of size:
+# ```
+# malloc.of
+#   8
+#   [m]
+#     m.put 10 > @
+# ```
+# Here, the first argument is a size of allocated block in memory, the second argument
+# is the scope where memory block is available for reading and writing. When `malloc.of` is
+# dataized it dataizes the scope, take the data from the block in memory, clears the block and
+# returns the data. So there's no need for end-user to care about clearing memory after allocation.
+#
+# 2. for object
 # ```
-# (malloc 8).pointer > p
-# seq
-#   *
-#     p.write 0 42 # write 8 bytes integer with offset 0
-#     p.read       # read from memory, 42 will be returned
-#     p.free       # free allocated block
+# malloc.for
+#   "Hello world!"
+#   [m]
+#     m.put "Hello, Jeff!" > @
 # ```
-# Clearing the block is optional and is up to programmer.
-[size] > malloc
-  @.pointer > pointer
+# Here, the first argument is an object which will be dataized, then a block in memory of given data
+# size is allocated and the data is written to the block. The second argument is the same scope as
+# in the p.1.
+#
+# The void attribute in the scope object is memory-block object which provides API to write and read
+# data to the memory.
+# ```
+# malloc.of
+#   8                         # allocate 8 bytes length block in memory
+#   [m]
+#     seq > @
+#       *
+#         m.write 2 "Hello"   # write object "Hello" with offset 2
+#         m.read 3 4          # read 4 bytes from offset 3 -> "ello"
+#         m.put 42            # write object 42 with offset 0
+#         m.get               # just get all the data from the memory block -> 42
+#         m.size              # get size of the block
+#         m.id                # get identifier of the block
+#         m.@                 # the same as m.get
+# ```
+# Malloc.
+[] > malloc
+  # Allocates block in memory for given `object`. After allocation the provided object is dataized
+  # and the data are written into memory.
+  [object scope] > for
+    (dataized object).as-bytes > bts
+    &.of > @
+      bts.size
+      [m]
+        seq > @
+          *
+            m.write 0 bts
+            scope m
+
+  # Allocates block in memory of given `size`. After allocation the `size` zero bytes bytes are
+  # written into memory.
+  [size scope] > of
+    # Allocates a memory block, initializes it, pass it to the `scope` and dataizes `scope` and
+    # at the end, even if the error is occurred, clears the block.
+    [] > @ /bytes
 
-  # Allocates a memory block in RAM and returns pointer to it.
-  [] > @ /memory-block-pointer
+    # Allocated block in memory that provides an API for writing and reading.
+    [id] > allocated
+      ^.size > size
+      get > @
 
-  # Pointer to allocated block in memory.
-  # Here `id` is identifier of pointer, `size` is length of the block.
-  [id] > memory-block-pointer
-    $ > pointer
-    ^.size > size
+      # Read `length` bytes with `offset` from the allocated block in memory.
+      [offset length] > read /bytes
 
-    # Read `length` bytes from `offset` from the block in memory by the pointer.
-    [offset length] > read /bytes
+      # Write `data` with `offset` to the allocated block in memory.
+      [offset data] > write /true
 
-    # Write `data` from `offset` to the block in memory by the pointer.
-    [offset data] > write /true
+      # Just get all the data from the allocated block in memory.
+      [] > get
+        ^.read 0 ^.size > @
 
-    # Free the block in memory by the pointer.
-    [] > free /true
+      # Put `object` into the allocated block in memory. The `object` is supposed to be dataizable.
+      [object] > put
+        seq > @
+          *
+            ^.write 0 object
+            ^.get

eo-runtime/src/main/java/EOorg/EOeolang/EOmalloc$EOmemory_block_pointer$EOread.java → eo-runtime/src/main/java/EOorg/EOeolang/EOmalloc$EOof$EOallocated$EOread.java

@@ -39,30 +39,32 @@
 import org.eolang.XmirObject;
 
 /**
- * Malloc.pointer.read object.
+ * Malloc.of.allocated.read object.
  * @since 0.36.0
  * @checkstyle TypeNameCheck (5 lines)
  */
 @Versionized
-@XmirObject(oname = "malloc.pointer.read")
-final class EOmalloc$EOmemory_block_pointer$EOread extends PhDefault implements Atom {
+@XmirObject(oname = "malloc.of.allocated.read")
+final class EOmalloc$EOof$EOallocated$EOread extends PhDefault implements Atom {
     /**
      * Ctor.
      * @param sigma Sigma
      */
-    EOmalloc$EOmemory_block_pointer$EOread(final Phi sigma) {
+    EOmalloc$EOof$EOallocated$EOread(final Phi sigma) {
         super(sigma);
         this.add("offset", new AtVoid("offset"));
         this.add("length", new AtVoid("length"));
     }
 
     @Override
     public Phi lambda() throws Exception {
+        final Phi rho = this.take(Attr.RHO);
+        final int length = Math.toIntExact(new Param(this, "length").strong(Long.class));
         return new Data.ToPhi(
             Heaps.INSTANCE.read(
-                Math.toIntExact(new Param(this.take(Attr.RHO), "id").strong(Long.class)),
+                Math.toIntExact(new Param(rho, "id").strong(Long.class)),
                 Math.toIntExact(new Param(this, "offset").strong(Long.class)),
-                Math.toIntExact(new Param(this, "length").strong(Long.class))
+                length
             )
         );
     }