fixup! Add ControlFlowGraph and implementation

jgardn3r · jgardn3r · commit 1058683ec44f · 2025-01-30T10:00:48.000+11:00
diff --git a/delphi-frontend/src/main/java/au/com/integradev/delphi/cfg/ControlFlowGraphVisitor.java b/delphi-frontend/src/main/java/au/com/integradev/delphi/cfg/ControlFlowGraphVisitor.java
@@ -63,6 +63,7 @@
 import org.sonar.plugins.communitydelphi.api.ast.SimpleNameDeclarationNode;
 import org.sonar.plugins.communitydelphi.api.ast.StatementListNode;
 import org.sonar.plugins.communitydelphi.api.ast.StatementNode;
+import org.sonar.plugins.communitydelphi.api.ast.TextLiteralNode;
 import org.sonar.plugins.communitydelphi.api.ast.TryStatementNode;
 import org.sonar.plugins.communitydelphi.api.ast.UnaryExpressionNode;
 import org.sonar.plugins.communitydelphi.api.ast.VarStatementNode;
@@ -102,6 +103,12 @@ public ControlFlowGraphBuilder visit(NilLiteralNode node, ControlFlowGraphBuilde
     return builder;
   }
 
+  @Override
+  public ControlFlowGraphBuilder visit(TextLiteralNode node, ControlFlowGraphBuilder builder) {
+    builder.addElement(node);
+    return builder;
+  }
+
   @Override
   public ControlFlowGraphBuilder visit(
       SimpleNameDeclarationNode node, ControlFlowGraphBuilder builder) {
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/cfg/ControlFlowGraphTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/cfg/ControlFlowGraphTest.java
@@ -71,6 +71,8 @@
 import org.sonar.plugins.communitydelphi.api.ast.RealLiteralNode;
 import org.sonar.plugins.communitydelphi.api.ast.RepeatStatementNode;
 import org.sonar.plugins.communitydelphi.api.ast.RoutineImplementationNode;
+import org.sonar.plugins.communitydelphi.api.ast.SimpleNameDeclarationNode;
+import org.sonar.plugins.communitydelphi.api.ast.TextLiteralNode;
 import org.sonar.plugins.communitydelphi.api.ast.TryStatementNode;
 import org.sonar.plugins.communitydelphi.api.ast.UnaryExpressionNode;
 import org.sonar.plugins.communitydelphi.api.ast.WhileStatementNode;
@@ -905,7 +907,9 @@ void testTryExceptRaise1stCatch() {
             + "end;",
         checker(
             block(element(TryStatementNode.class)).succeedsTo(4),
-            block(element(NameReferenceNode.class, "EAbort.Create"))
+            block(
+                    element(TextLiteralNode.class, "''"),
+                    element(NameReferenceNode.class, "EAbort.Create"))
                 .succeedsToWithExceptions(3, 0, 1, 2),
             terminator(RaiseStatementNode.class, TerminatorKind.RAISE).jumpsTo(2, 0),
             block(element(NameDeclarationNode.class, "E"), element(NameReferenceNode.class, "Bar"))
@@ -931,7 +935,9 @@ void testTryExceptRaise2ndCatch() {
             + "end;",
         checker(
             block(element(TryStatementNode.class)).succeedsTo(4),
-            block(element(NameReferenceNode.class, "Exception.Create"))
+            block(
+                    element(TextLiteralNode.class, "''"),
+                    element(NameReferenceNode.class, "Exception.Create"))
                 .succeedsToWithExceptions(3, 0, 1, 2),
             terminator(RaiseStatementNode.class, TerminatorKind.RAISE).jumpsTo(1, 0),
             block(element(NameDeclarationNode.class, "E"), element(NameReferenceNode.class, "Bar"))
@@ -947,7 +953,9 @@ void testTryBareExceptRaise() {
         "try raise Exception.Create(''); except Bar; end;",
         checker(
             block(element(TryStatementNode.class)).succeedsTo(3),
-            block(element(NameReferenceNode.class, "Exception.Create"))
+            block(
+                    element(TextLiteralNode.class, "''"),
+                    element(NameReferenceNode.class, "Exception.Create"))
                 .succeedsToWithExceptions(2, 1),
             terminator(RaiseStatementNode.class, TerminatorKind.RAISE).jumpsTo(1, 0),
             block(element(NameReferenceNode.class, "Bar")).succeedsTo(0)));
@@ -1035,7 +1043,9 @@ void testTryBareExcept() {
         "try raise Exception.Create('') except Foo end;",
         checker(
             block(element(TryStatementNode.class)).succeedsTo(3),
-            block(element(NameReferenceNode.class, "Exception.Create"))
+            block(
+                    element(TextLiteralNode.class, "''"),
+                    element(NameReferenceNode.class, "Exception.Create"))
                 .succeedsToWithExceptions(2, 1),
             terminator(RaiseStatementNode.class, TerminatorKind.RAISE).jumpsTo(1, 0),
             block(element(NameReferenceNode.class, "Foo")).succeedsTo(0)));
@@ -1323,4 +1333,99 @@ void testInlineAssemblyIsIgnored() {
         "Foo; asm XOR EAX, EAX end;",
         checker(block(element(NameReferenceNode.class, "Foo")).succeedsTo(0)));
   }
+
+  @Test
+  void testComplexConstructions() {
+    test(
+        Map.of("label", List.of("Label1")),
+        "Foo1;\n"
+            + "with TObject.Create do begin\n"
+            + "  WithBar1;\n"
+            + "  WithBar2;\n"
+            + "end;\n"
+            + "Foo2;\n"
+            + "for var A := 1 + +1 to 2 + 2 do begin\n"
+            + "  ForBar1;\n"
+            + "  ForBar2;\n"
+            + "  if A = 4 then goto Label1;\n"
+            + "end;\n"
+            + "Foo3;\n"
+            + "while A and B or C do begin\n"
+            + "  WhileBar1;\n"
+            + "  Label1:\n"
+            + "  WhileBar2;\n"
+            + "  try\n"
+            + "    Break;\n"
+            + "  finally\n"
+            + "    var X := '123';\n"
+            + "    if D or E then X := 'a'\n"
+            + "    else X := 'b';\n"
+            + "  end;\n"
+            + "end;\n"
+            + "Foo4;",
+        checker(
+            block(element(NameReferenceNode.class, "Foo1")).succeedsTo(21),
+            block(element(NameReferenceNode.class, "TObject.Create")).succeedsTo(20),
+            block(
+                    element(NameReferenceNode.class, "WithBar1"),
+                    element(NameReferenceNode.class, "WithBar2"))
+                .succeedsTo(19),
+            block(element(NameReferenceNode.class, "Foo2")).succeedsTo(18),
+            block(
+                    element(IntegerLiteralNode.class, "1"),
+                    element(IntegerLiteralNode.class, "1"),
+                    element(UnaryExpressionNode.class).withCheck(unaryOpTest(UnaryOperator.PLUS)),
+                    element(BinaryExpressionNode.class).withCheck(binaryOpTest(BinaryOperator.ADD)))
+                .succeedsTo(17),
+            block(
+                    element(IntegerLiteralNode.class, "2"),
+                    element(IntegerLiteralNode.class, "2"),
+                    element(BinaryExpressionNode.class).withCheck(binaryOpTest(BinaryOperator.ADD)))
+                .succeedsTo(14),
+            block(
+                    element(NameReferenceNode.class, "ForBar1"),
+                    element(NameReferenceNode.class, "ForBar2"),
+                    element(NameReferenceNode.class, "A"),
+                    element(IntegerLiteralNode.class, "4"),
+                    element(BinaryExpressionNode.class)
+                        .withCheck(binaryOpTest(BinaryOperator.EQUAL)))
+                .branchesTo(15, 14)
+                .withTerminator(IfStatementNode.class),
+            block().jumpsTo(8, 14).withTerminator(GotoStatementNode.class, TerminatorKind.GOTO),
+            block(element(SimpleNameDeclarationNode.class, "A"))
+                .branchesTo(16, 13)
+                .withTerminator(ForToStatementNode.class),
+            block(element(NameReferenceNode.class, "Foo3")).succeedsTo(12),
+            block(element(NameReferenceNode.class, "A"))
+                .branchesTo(11, 10)
+                .withTerminator(BinaryExpressionNode.class)
+                .withTerminatorNodeCheck(binaryOpTest(BinaryOperator.AND)),
+            block(element(NameReferenceNode.class, "B"))
+                .branchesTo(9, 10)
+                .withTerminator(BinaryExpressionNode.class)
+                .withTerminatorNodeCheck(binaryOpTest(BinaryOperator.OR)),
+            block(element(NameReferenceNode.class, "C"))
+                .branchesTo(9, 1)
+                .withTerminator(WhileStatementNode.class),
+            block(element(NameReferenceNode.class, "WhileBar1")).succeedsTo(8),
+            block(element(NameReferenceNode.class, "WhileBar2"), element(TryStatementNode.class))
+                .succeedsTo(7),
+            block().jumpsTo(6, 6).withTerminator(NameReferenceNode.class, TerminatorKind.BREAK),
+            block(
+                    element(TextLiteralNode.class, "'123'"),
+                    element(SimpleNameDeclarationNode.class, "X"),
+                    element(NameReferenceNode.class, "D"))
+                .branchesTo(4, 5)
+                .withTerminator(BinaryExpressionNode.class)
+                .withTerminatorNodeCheck(binaryOpTest(BinaryOperator.OR)),
+            block(element(NameReferenceNode.class, "E"))
+                .branchesTo(4, 3)
+                .withTerminator(IfStatementNode.class),
+            block(element(TextLiteralNode.class, "'a'"), element(NameReferenceNode.class, "X"))
+                .succeedsTo(2),
+            block(element(TextLiteralNode.class, "'b'"), element(NameReferenceNode.class, "X"))
+                .succeedsTo(2),
+            block().succeedsToWithExit(12, 0),
+            block(element(NameReferenceNode.class, "Foo4")).succeedsTo(0)));
+  }
 }
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/cfg/checker/BlockChecker.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/cfg/checker/BlockChecker.java
@@ -72,7 +72,10 @@ private BlockChecker(ElementChecker... elementCheckers) {
   public void check(final Block block) {
     assertThat(block.getElements()).as("elements count").hasSize(elementCheckers.size());
     for (int elementId = 0; elementId < elementCheckers.size(); elementId++) {
-      elementCheckers.get(elementId).check(block.getElements().get(elementId));
+      elementCheckers
+          .get(elementId)
+          .withBlockId(((BlockImpl) block).getId(), elementId)
+          .check(block.getElements().get(elementId));
     }
     assertThat(successorChecker)
         .withFailMessage("%s should have its successors declared", getBlockDisplay(block))
