feat(objectionary#376) handlers -> agents

volodya-lombrozo · Aug 12, 2024 · 3d85e72 · 3d85e72
1 parent 43a4b88
commit 3d85e72
Show file tree

Hide file tree

Showing 35 changed files with 310 additions and 309 deletions.
diff --git a/src/main/java/org/eolang/opeo/SelectiveDecompiler.java b/src/main/java/org/eolang/opeo/SelectiveDecompiler.java
@@ -31,7 +31,7 @@
 import java.util.stream.Collectors;
 import org.eolang.opeo.decompilation.Decompiler;
 import org.eolang.opeo.decompilation.WithoutAliases;
-import org.eolang.opeo.decompilation.handlers.RouterHandler;
+import org.eolang.opeo.decompilation.agents.RouterAgent;
 import org.eolang.opeo.jeo.JeoDecompiler;
 import org.eolang.opeo.storage.FileStorage;
 import org.eolang.opeo.storage.Storage;
@@ -41,7 +41,7 @@
  * Selective decompiler.
  * Decompiler that decompiles ONLY fully understandable methods.
  * These methods contain only instructions that are
- * supported by {@link org.eolang.opeo.decompilation.handlers.RouterHandler}.
+ * supported by {@link RouterAgent}.
  *
  * @since 0.1
  */
@@ -69,7 +69,7 @@ public final class SelectiveDecompiler implements Decompiler {
      * @param modified Folder where to save the modified XMIRs.
      */
     public SelectiveDecompiler(final Path input, final Path output, final Path modified) {
-        this(input, output, modified, new RouterHandler(false).supportedOpcodes());
+        this(input, output, modified, new RouterAgent(false).supportedOpcodes());
     }
 
     /**
@@ -97,7 +97,7 @@ public SelectiveDecompiler(
     public SelectiveDecompiler(
         final Storage storage, final Storage modified
     ) {
-        this(storage, modified, new RouterHandler(false).supportedOpcodes());
+        this(storage, modified, new RouterAgent(false).supportedOpcodes());
     }
 
     /**

diff --git a/src/main/java/org/eolang/opeo/ast/Labeled.java b/src/main/java/org/eolang/opeo/ast/Labeled.java
@@ -30,6 +30,7 @@
 import lombok.EqualsAndHashCode;
 import lombok.ToString;
 import org.eolang.jeo.representation.xmir.XmlNode;
+import org.eolang.opeo.decompilation.agents.InvokespecialAgent;
 import org.objectweb.asm.Type;
 import org.xembly.Directive;
 import org.xembly.Directives;
@@ -39,7 +40,7 @@
  * This class needed to avoid considering labels as separate nodes.
  * Maybe it's wrong to do so, but it's easier to implement this way, at least for now.
  * Pay attention, that {@link Labeled} class violates class hierarchy.
- * It is the most visible within {@link org.eolang.opeo.decompilation.handlers.InvokespecialHandler}
+ * It is the most visible within {@link InvokespecialAgent}
  * implementation.
  * @since 0.2
  */

diff --git a/src/main/java/org/eolang/opeo/compilation/SelectiveCompiler.java b/src/main/java/org/eolang/opeo/compilation/SelectiveCompiler.java
@@ -27,7 +27,7 @@
 import java.nio.file.Path;
 import java.util.Arrays;
 import java.util.stream.Collectors;
-import org.eolang.opeo.decompilation.handlers.RouterHandler;
+import org.eolang.opeo.decompilation.agents.RouterAgent;
 import org.eolang.opeo.storage.CompilationStorage;
 import org.eolang.opeo.storage.Storage;
 import org.eolang.opeo.storage.XmirEntry;
@@ -65,7 +65,7 @@ public SelectiveCompiler(final Path xmirs, final Path output) {
      */
     public SelectiveCompiler(final Storage storage) {
         this.storage = storage;
-        this.supported = new RouterHandler(false).supportedOpcodes();
+        this.supported = new RouterAgent(false).supportedOpcodes();
     }
 
     @Override

diff --git a/...peo/decompilation/InstructionHandler.java → ...peo/decompilation/DecompilationAgent.java b/...peo/decompilation/InstructionHandler.java → ...peo/decompilation/DecompilationAgent.java
@@ -24,15 +24,15 @@
 package org.eolang.opeo.decompilation;
 
 /**
- * Instruction handler.
+ * An agent that tries to understand the current decompilation state and apply some changes to it.
  * @since 0.1
  */
 @FunctionalInterface
-public interface InstructionHandler {
+public interface DecompilationAgent {
 
     /**
-     * Handle instruction.
-     * @param state Current instruction to handle together with operand stack and variables.
+     * Handle the current state.
+     * @param state Current state to handle together with operand stack and variables.
      */
     void handle(DecompilerState state);
 }
diff --git a/src/main/java/org/eolang/opeo/decompilation/DecompilerMachine.java b/src/main/java/org/eolang/opeo/decompilation/DecompilerMachine.java
@@ -29,7 +29,7 @@
 import org.cactoos.list.ListOf;
 import org.eolang.opeo.Instruction;
 import org.eolang.opeo.ast.Root;
-import org.eolang.opeo.decompilation.handlers.RouterHandler;
+import org.eolang.opeo.decompilation.agents.RouterAgent;
 import org.xembly.Directive;
 
 /**
@@ -47,7 +47,7 @@ public final class DecompilerMachine {
     /**
      * Handler that redirects instructions.
      */
-    private final RouterHandler router;
+    private final RouterAgent router;
 
     /**
      * Constructor.
@@ -73,7 +73,7 @@ public final class DecompilerMachine {
      */
     public DecompilerMachine(final LocalVariables locals, final Map<String, String> arguments) {
         this.locals = locals;
-        this.router = new RouterHandler(
+        this.router = new RouterAgent(
             "true".equals(arguments.getOrDefault("counting", "true"))
         );
     }

diff --git a/...eo/decompilation/handlers/AddHandler.java → ...g/opeo/decompilation/agents/AddAgent.java b/...eo/decompilation/handlers/AddHandler.java → ...g/opeo/decompilation/agents/AddAgent.java
@@ -21,18 +21,18 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package org.eolang.opeo.decompilation.handlers;
+package org.eolang.opeo.decompilation.agents;
 
 import org.eolang.opeo.ast.Addition;
 import org.eolang.opeo.ast.AstNode;
 import org.eolang.opeo.decompilation.DecompilerState;
-import org.eolang.opeo.decompilation.InstructionHandler;
+import org.eolang.opeo.decompilation.DecompilationAgent;
 
 /**
  * Add instruction handler.
  * @since 0.1
  */
-public final class AddHandler implements InstructionHandler {
+public final class AddAgent implements DecompilationAgent {
 
     @Override
     public void handle(final DecompilerState state) {

diff --git a/...decompilation/handlers/BipushHandler.java → ...peo/decompilation/agents/BipushAgent.java b/...decompilation/handlers/BipushHandler.java → ...peo/decompilation/agents/BipushAgent.java
@@ -21,17 +21,17 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package org.eolang.opeo.decompilation.handlers;
+package org.eolang.opeo.decompilation.agents;
 
 import org.eolang.opeo.ast.Literal;
 import org.eolang.opeo.decompilation.DecompilerState;
-import org.eolang.opeo.decompilation.InstructionHandler;
+import org.eolang.opeo.decompilation.DecompilationAgent;
 
 /**
  * Bipush instruction handler.
  * @since 0.1
  */
-public final class BipushHandler implements InstructionHandler {
+public final class BipushAgent implements DecompilationAgent {
 
     @Override
     public void handle(final DecompilerState state) {

diff --git a/...o/decompilation/handlers/CastHandler.java → .../opeo/decompilation/agents/CastAgent.java b/...o/decompilation/handlers/CastHandler.java → .../opeo/decompilation/agents/CastAgent.java
@@ -21,18 +21,18 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package org.eolang.opeo.decompilation.handlers;
+package org.eolang.opeo.decompilation.agents;
 
 import org.eolang.opeo.ast.Cast;
 import org.eolang.opeo.decompilation.DecompilerState;
-import org.eolang.opeo.decompilation.InstructionHandler;
+import org.eolang.opeo.decompilation.DecompilationAgent;
 import org.objectweb.asm.Type;
 
 /**
  * Cast instruction handler.
  * @since 0.2
  */
-public final class CastHandler implements InstructionHandler {
+public final class CastAgent implements DecompilationAgent {
 
     /**
      * Target type.
@@ -43,7 +43,7 @@ public final class CastHandler implements InstructionHandler {
      * Constructor.
      * @param target Target type
      */
-    CastHandler(final Type target) {
+    CastAgent(final Type target) {
         this.target = target;
     }
 

diff --git a/...ompilation/handlers/CheckCastHandler.java → .../decompilation/agents/CheckCastAgent.java b/...ompilation/handlers/CheckCastHandler.java → .../decompilation/agents/CheckCastAgent.java
@@ -21,20 +21,20 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package org.eolang.opeo.decompilation.handlers;
+package org.eolang.opeo.decompilation.agents;
 
 import org.eolang.opeo.ast.AstNode;
 import org.eolang.opeo.ast.CheckCast;
 import org.eolang.opeo.decompilation.DecompilerState;
-import org.eolang.opeo.decompilation.InstructionHandler;
+import org.eolang.opeo.decompilation.DecompilationAgent;
 import org.objectweb.asm.Type;
 
 /**
  * CheckCast instruction handler.
  *
  * @since 0.5
  */
-public final class CheckCastHandler implements InstructionHandler {
+public final class CheckCastAgent implements DecompilationAgent {
 
     @Override
     public void handle(final DecompilerState state) {

diff --git a/.../decompilation/handlers/ConstHandler.java → ...opeo/decompilation/agents/ConstAgent.java b/.../decompilation/handlers/ConstHandler.java → ...opeo/decompilation/agents/ConstAgent.java
@@ -21,20 +21,20 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package org.eolang.opeo.decompilation.handlers;
+package org.eolang.opeo.decompilation.agents;
 
 import org.eolang.opeo.ast.AstNode;
 import org.eolang.opeo.ast.Literal;
 import org.eolang.opeo.decompilation.DecompilerState;
-import org.eolang.opeo.decompilation.InstructionHandler;
+import org.eolang.opeo.decompilation.DecompilationAgent;
 import org.objectweb.asm.Opcodes;
 import org.objectweb.asm.Type;
 
 /**
  * Iconst instruction handler.
  * @since 0.1
  */
-public final class ConstHandler implements InstructionHandler {
+public final class ConstAgent implements DecompilationAgent {
 
     /**
      * Type of constant.
@@ -45,7 +45,7 @@ public final class ConstHandler implements InstructionHandler {
      * Constructor.
      * @param type Type of constant
      */
-    ConstHandler(final Type type) {
+    ConstAgent(final Type type) {
         this.type = type;
     }
 
@@ -54,13 +54,13 @@ public void handle(final DecompilerState state) {
         final int opcode = state.instruction().opcode();
         final AstNode res;
         if (this.type.equals(Type.INT_TYPE)) {
-            res = ConstHandler.intConstant(opcode);
+            res = ConstAgent.intConstant(opcode);
         } else if (this.type.equals(Type.LONG_TYPE)) {
-            res = ConstHandler.longConstant(opcode);
+            res = ConstAgent.longConstant(opcode);
         } else if (this.type.equals(Type.FLOAT_TYPE)) {
-            res = ConstHandler.floatConstant(opcode);
+            res = ConstAgent.floatConstant(opcode);
         } else if (this.type.equals(Type.DOUBLE_TYPE)) {
-            res = ConstHandler.doubleConstant(opcode);
+            res = ConstAgent.doubleConstant(opcode);
         } else {
             throw new UnsupportedOperationException(
                 String.format("Type %s is not supported yet", this.type)

diff --git a/...eo/decompilation/handlers/DupHandler.java → ...g/opeo/decompilation/agents/DupAgent.java b/...eo/decompilation/handlers/DupHandler.java → ...g/opeo/decompilation/agents/DupAgent.java
@@ -21,18 +21,18 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package org.eolang.opeo.decompilation.handlers;
+package org.eolang.opeo.decompilation.agents;
 
 import org.eolang.opeo.ast.Duplicate;
 import org.eolang.opeo.decompilation.DecompilerState;
-import org.eolang.opeo.decompilation.InstructionHandler;
+import org.eolang.opeo.decompilation.DecompilationAgent;
 import org.eolang.opeo.decompilation.OperandStack;
 
 /**
  * Dup instruction handler.
  * @since 0.1
  */
-public final class DupHandler implements InstructionHandler {
+public final class DupAgent implements DecompilationAgent {
 
     @Override
     public void handle(final DecompilerState state) {

diff --git a/...compilation/handlers/GetFieldHandler.java → ...o/decompilation/agents/GetFieldAgent.java b/...compilation/handlers/GetFieldHandler.java → ...o/decompilation/agents/GetFieldAgent.java
@@ -21,18 +21,18 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package org.eolang.opeo.decompilation.handlers;
+package org.eolang.opeo.decompilation.agents;
 
 import org.eolang.opeo.ast.Attributes;
 import org.eolang.opeo.ast.FieldRetrieval;
 import org.eolang.opeo.decompilation.DecompilerState;
-import org.eolang.opeo.decompilation.InstructionHandler;
+import org.eolang.opeo.decompilation.DecompilationAgent;
 
 /**
  * Getfield instruction handler.
  * @since 0.1
  */
-public final class GetFieldHandler implements InstructionHandler {
+public final class GetFieldAgent implements DecompilationAgent {
 
     @Override
     public void handle(final DecompilerState state) {

diff --git a/...ompilation/handlers/GetStaticHnadler.java → .../decompilation/agents/GetStaticAgent.java b/...ompilation/handlers/GetStaticHnadler.java → .../decompilation/agents/GetStaticAgent.java
@@ -21,17 +21,17 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package org.eolang.opeo.decompilation.handlers;
+package org.eolang.opeo.decompilation.agents;
 
 import org.eolang.opeo.ast.ClassField;
 import org.eolang.opeo.decompilation.DecompilerState;
-import org.eolang.opeo.decompilation.InstructionHandler;
+import org.eolang.opeo.decompilation.DecompilationAgent;
 
 /**
  * Getstatic instruction handler.
  * @since 0.1
  */
-public final class GetStaticHnadler implements InstructionHandler {
+public final class GetStaticAgent implements DecompilationAgent {
     @Override
     public void handle(final DecompilerState state) {
         final String klass = (String) state.operand(0);

diff --git a/...peo/decompilation/handlers/IfHandler.java → ...ng/opeo/decompilation/agents/IfAgent.java b/...peo/decompilation/handlers/IfHandler.java → ...ng/opeo/decompilation/agents/IfAgent.java
@@ -21,12 +21,12 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package org.eolang.opeo.decompilation.handlers;
+package org.eolang.opeo.decompilation.agents;
 
 import org.eolang.opeo.ast.AstNode;
 import org.eolang.opeo.ast.If;
 import org.eolang.opeo.decompilation.DecompilerState;
-import org.eolang.opeo.decompilation.InstructionHandler;
+import org.eolang.opeo.decompilation.DecompilationAgent;
 import org.eolang.opeo.decompilation.OperandStack;
 import org.objectweb.asm.Label;
 import org.objectweb.asm.Opcodes;
@@ -38,7 +38,7 @@
  * (signed short constructed from unsigned bytes branchbyte1 << 8 | branchbyte2)
  * @since 0.2
  */
-public final class IfHandler implements InstructionHandler {
+public final class IfAgent implements DecompilationAgent {
 
     @Override
     public void handle(final DecompilerState state) {

diff --git a/...lation/handlers/InvokedynamicHandler.java → ...ompilation/agents/InvokedynamicAgent.java b/...lation/handlers/InvokedynamicHandler.java → ...ompilation/agents/InvokedynamicAgent.java
@@ -21,22 +21,22 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package org.eolang.opeo.decompilation.handlers;
+package org.eolang.opeo.decompilation.agents;
 
 import java.util.Collections;
 import java.util.List;
 import org.eolang.opeo.ast.AstNode;
 import org.eolang.opeo.ast.DynamicInvocation;
 import org.eolang.opeo.decompilation.DecompilerState;
-import org.eolang.opeo.decompilation.InstructionHandler;
+import org.eolang.opeo.decompilation.DecompilationAgent;
 import org.objectweb.asm.Handle;
 import org.objectweb.asm.Type;
 
 /**
  * Invokedynamic instruction handler.
  * @since 0.5
  */
-public final class InvokedynamicHandler implements InstructionHandler {
+public final class InvokedynamicAgent implements DecompilationAgent {
 
     @Override
     public void handle(final DecompilerState state) {