Merge pull request #868 from sampottinger/main

Formalize static analysis toolkit

Author: sampottinger

engine/src/main/java/org/kigalisim/lang/operation/AdditionOperation.java

@@ -16,6 +16,10 @@
  */
 public class AdditionOperation implements Operation {
 
+  private static final OperationStaticSemantics STATIC_SEMANTICS = new OperationStaticSemantics(
+      OperationType.ADDITION
+  );
+
   private final Operation left;
   private final Operation right;
 
@@ -37,4 +41,10 @@ public void execute(PushDownMachine machine) {
     right.execute(machine);
     machine.add();
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public OperationStaticSemantics getStaticSemantics() {
+    return STATIC_SEMANTICS;
+  }
 }

engine/src/main/java/org/kigalisim/lang/operation/CapDisplacingOperation.java

@@ -78,4 +78,13 @@ public void execute(PushDownMachine machine) {
     engine.cap(stream, result, yearMatcher, displaceTarget,
         DisplacementType.EQUIVALENT);
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public OperationStaticSemantics getStaticSemantics() {
+    return new OperationStaticSemanticsBuilder(OperationType.CAP_DISPLACING)
+        .addStream(stream)
+        .addIfStream(displaceTarget)
+        .build();
+  }
 }

engine/src/main/java/org/kigalisim/lang/operation/CapOperation.java

@@ -153,4 +153,14 @@ public void execute(PushDownMachine machine) {
     Engine engine = machine.getEngine();
     engine.cap(stream, result, yearMatcher, displaceTarget.orElse(null), displacementType);
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public OperationStaticSemantics getStaticSemantics() {
+    OperationStaticSemanticsBuilder builder = new OperationStaticSemanticsBuilder(
+        OperationType.CAP
+    ).addStream(stream);
+    displaceTarget.ifPresent(builder::addIfStream);
+    return builder.build();
+  }
 }

engine/src/main/java/org/kigalisim/lang/operation/ChangeOperation.java

@@ -71,18 +71,11 @@ public void execute(PushDownMachine machine) {
     engine.changeStream(stream, result, yearMatcher);
   }
 
-  /**
-   * The name of the stream this operation changes.
-   *
-   * @return the stream name.
-   */
-  public String getStream() {
-    return stream;
-  }
-
   /** {@inheritDoc} */
   @Override
-  public OperationType getOperationType() {
-    return OperationType.CHANGE;
+  public OperationStaticSemantics getStaticSemantics() {
+    return new OperationStaticSemanticsBuilder(OperationType.CHANGE)
+        .addStream(stream)
+        .build();
   }
 }

engine/src/main/java/org/kigalisim/lang/operation/ChangeUnitsOperation.java

@@ -18,6 +18,10 @@
  */
 public class ChangeUnitsOperation implements Operation {
 
+  private static final OperationStaticSemantics STATIC_SEMANTICS = new OperationStaticSemantics(
+      OperationType.CHANGE_UNITS
+  );
+
   private final Operation operand;
   private final String units;
 
@@ -39,4 +43,9 @@ public void execute(PushDownMachine machine) {
     machine.changeUnits(units);
   }
 
+  /** {@inheritDoc} */
+  @Override
+  public OperationStaticSemantics getStaticSemantics() {
+    return STATIC_SEMANTICS;
+  }
 }

engine/src/main/java/org/kigalisim/lang/operation/ComparisonOperation.java

@@ -16,6 +16,10 @@
  */
 public class ComparisonOperation implements Operation {
 
+  private static final OperationStaticSemantics STATIC_SEMANTICS = new OperationStaticSemantics(
+      OperationType.COMPARISON
+  );
+
   private final Operation left;
   private final Operation right;
   private final String operator;
@@ -49,4 +53,10 @@ public void execute(PushDownMachine machine) {
       default -> throw new RuntimeException("Unknown comparison operator: " + operator);
     }
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public OperationStaticSemantics getStaticSemantics() {
+    return STATIC_SEMANTICS;
+  }
 }

engine/src/main/java/org/kigalisim/lang/operation/ConditionalOperation.java

@@ -19,6 +19,10 @@
  */
 public class ConditionalOperation implements Operation {
 
+  private static final OperationStaticSemantics STATIC_SEMANTICS = new OperationStaticSemantics(
+      OperationType.CONDITIONAL
+  );
+
   private final Operation condition;
   private final Operation trueCase;
   private final Operation falseCase;
@@ -57,9 +61,20 @@ public void execute(PushDownMachine m) {
           falseCase.execute(m);
         }
       }
+
+      @Override
+      public OperationStaticSemantics getStaticSemantics() {
+        return STATIC_SEMANTICS;
+      }
     };
 
     // Execute the simple operation
     simpleOp.execute(machine);
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public OperationStaticSemantics getStaticSemantics() {
+    return STATIC_SEMANTICS;
+  }
 }

engine/src/main/java/org/kigalisim/lang/operation/DefineVariableOperation.java

@@ -16,6 +16,10 @@
  */
 public class DefineVariableOperation implements Operation {
 
+  private static final OperationStaticSemantics STATIC_SEMANTICS = new OperationStaticSemantics(
+      OperationType.DEFINE_VARIABLE
+  );
+
   private final String variableName;
   private final Operation valueOperation;
 
@@ -47,4 +51,10 @@ public void execute(PushDownMachine machine) {
 
     machine.getEngine().setVariable(variableName, value);
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public OperationStaticSemantics getStaticSemantics() {
+    return STATIC_SEMANTICS;
+  }
 }

engine/src/main/java/org/kigalisim/lang/operation/DivisionOperation.java

@@ -16,6 +16,10 @@
  */
 public class DivisionOperation implements Operation {
 
+  private static final OperationStaticSemantics STATIC_SEMANTICS = new OperationStaticSemantics(
+      OperationType.DIVISION
+  );
+
   private final Operation left;
   private final Operation right;
 
@@ -37,4 +41,10 @@ public void execute(PushDownMachine machine) {
     right.execute(machine);
     machine.divide();
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public OperationStaticSemantics getStaticSemantics() {
+    return STATIC_SEMANTICS;
+  }
 }

engine/src/main/java/org/kigalisim/lang/operation/DrawNormalOperation.java

@@ -17,6 +17,10 @@
  */
 public class DrawNormalOperation implements Operation {
 
+  private static final OperationStaticSemantics STATIC_SEMANTICS = new OperationStaticSemantics(
+      OperationType.DRAW_NORMAL
+  );
+
   private final Operation mean;
   private final Operation std;
 
@@ -38,4 +42,10 @@ public void execute(PushDownMachine machine) {
     std.execute(machine);
     machine.drawNormal();
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public OperationStaticSemantics getStaticSemantics() {
+    return STATIC_SEMANTICS;
+  }
 }