Merge branch 'topic/lkql_jit/add_create_from_template' into 'master'

Add the "create_from_template" method in "RewritingContext"

Closes #465

See merge request eng/libadalang/langkit-query-language!429

Author: HugoGGuerrier

lkql_checker/share/lkql/binary_case_statements.lkql

@@ -1,10 +1,4 @@
-# Flag a case statement if this statement has only two alternatives, one
-# containing exactly one choice, the other containing exactly one choice
-# or the `OTHERS' choice.
-# This rule has an optional parameter Except_Enums: exclude case statements on
-# enumerated types.
-
-fun to_if_stmt(case_stmt) =
+fun to_if_stmt(case_stmt, ctx) =
     |" This function turns the given "case" statement into a if statement.
     |" Assumes that the "case" has only 2 alternatives.
     {
@@ -16,33 +10,22 @@ fun to_if_stmt(case_stmt) =
         );
         match alts[2].f_choices[1]
         | OthersDesignator =>
-            new IfStmt(
-                f_cond_expr=cond,
-                f_then_stmts=alts[1].f_stmts,
-                f_alternatives=new ElsifStmtPartList(),
-                f_else_part=new ElsePart(alts[2].f_stmts)
+            ctx.create_from_template(
+                "if {} then {} else {} end if;",
+                "if_stmt_rule",
+                [cond, alts[1].f_stmts, alts[2].f_stmts]
             )
         | choice           =>
-            new IfStmt(
-                f_cond_expr=cond,
-                f_then_stmts=alts[1].f_stmts,
-                f_alternatives=new ElsifStmtPartList([
-                    new ElsifStmtPart(
-                        f_cond_expr=new RelationOp(
-                            f_left=case_stmt.f_expr,
-                            f_op=new OpEq(),
-                            f_right=choice
-                        ),
-                        f_stmts=alts[2].f_stmts
-                    )
-                ]),
-                f_else_part=null
+            ctx.create_from_template(
+                "if {} then {} elsif {} = {} then {} end if;",
+                "if_stmt_rule",
+                [cond, alts[1].f_stmts, case_stmt.f_expr, choice, alts[2].f_stmts]
             )
     }
 
 @check(message="CASE statement can be replaced with IF statement",
        category="Style", subcategory="Programming Practice",
-       auto_fix=(n, ctx) => ctx.replace(n, to_if_stmt(n)))
+       auto_fix=(n, ctx) => ctx.replace(n, to_if_stmt(n, ctx)))
 fun binary_case_statements(node, except_enums = false) =
     |" Flag a case statement if this statement has only two alternatives, one
     |" containing exactly one choice, the other containing exactly one choice

lkql_checker/share/lkql/use_if_expressions.lkql

@@ -10,29 +10,29 @@ fun replace_by_expr(if_stmt, ctx) =
     {
         val is_return = simple_return(if_stmt.f_then_stmts);
         val then_stmt = if_stmt.f_then_stmts[1];
-        val else_stmt = if_stmt.f_else_part.f_stmts[1];
-        val if_expr = new ParenExpr(new IfExpr(
-            f_cond_expr = if_stmt.f_cond_expr,
-            f_then_expr = if is_return then then_stmt.f_return_expr else then_stmt.f_expr,
-            f_else_expr = if is_return then else_stmt.f_return_expr else else_stmt.f_expr,
-            f_alternatives=new ElsifExprPartList([
-                {
-                    val stmt = part.f_stmts[1];
-                    new ElsifExprPart(
-                        f_cond_expr = part.f_cond_expr,
-                        f_then_expr = if is_return then stmt.f_return_expr else stmt.f_expr
-                    )
-                }
-                for part in if_stmt.f_alternatives.children
-            ].to_list)
-        ));
+        val expr_index = if is_return then 1 else 2;
+        val template_and_rule = (
+            if is_return
+            then ("return (if {} then {} {} else {});", "return_stmt_rule")
+            else (then_stmt.f_dest.text & " := (if {} then {} {} else {});", "assignment_stmt_rule")
+        );
         ctx.replace(
             if_stmt,
-            if is_return
-            then new ReturnStmt(if_expr)
-            else new AssignStmt(
-                f_dest = then_stmt.f_dest,
-                f_expr = if_expr
+            ctx.create_from_template(
+                template_and_rule[1],
+                template_and_rule[2],
+                [
+                    if_stmt.f_cond_expr,
+                    then_stmt[expr_index],
+                    new ElsifExprPartList([
+                        new ElsifExprPart(
+                            f_cond_expr = part.f_cond_expr,
+                            f_then_expr = part.f_stmts[1][expr_index]
+                        )
+                        for part in if_stmt.f_alternatives.children
+                    ].to_list),
+                    if_stmt.f_else_part.f_stmts[1][expr_index]
+                ]
             )
         )
     }

lkql_jit/language/src/main/java/com/adacore/lkql_jit/built_ins/methods/RewritingContextMethods.java

@@ -6,6 +6,7 @@
 package com.adacore.lkql_jit.built_ins.methods;
 
 import com.adacore.libadalang.Libadalang;
+import com.adacore.libadalang.Libadalang.GrammarRule;
 import com.adacore.libadalang.Libadalang.MemberReference;
 import com.adacore.libadalang.Libadalang.RewritingContext;
 import com.adacore.libadalang.Libadalang.RewritingNode;
@@ -15,7 +16,9 @@
 import com.adacore.lkql_jit.exception.LKQLRuntimeException;
 import com.adacore.lkql_jit.nodes.utils.RewritingNodeConverter;
 import com.adacore.lkql_jit.nodes.utils.RewritingNodeConverterNodeGen;
+import com.adacore.lkql_jit.runtime.values.lists.LKQLList;
 import com.adacore.lkql_jit.utils.LKQLTypesHelper;
+import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.dsl.Specialization;
 import com.oracle.truffle.api.frame.VirtualFrame;
 
@@ -181,4 +184,39 @@ public Object executeGeneric(VirtualFrame frame, RewritingContext ctx, Object ob
             return ctx;
         }
     }
+
+    @BuiltInMethod(
+        name = "create_from_template",
+        doc = "Create a new node from the provided template, filling '{}' with provided" +
+        " argument, and parsing the template with the specified grammar rule"
+    )
+    public abstract static class CreateFromTemplateExpr extends BaseRewritingContextExpr {
+
+        @TruffleBoundary
+        private static GrammarRule ruleFromString(String ruleName) {
+            return GrammarRule.valueOf(ruleName.toUpperCase());
+        }
+
+        @Specialization
+        public RewritingNode doGeneric(
+            VirtualFrame frame,
+            RewritingContext ctx,
+            String template,
+            String grammarRule,
+            LKQLList arguments
+        ) {
+            // Translate the provided LKQL list into a rewriting node list
+            final var args = new RewritingNode[(int) arguments.size()];
+            for (int i = 0; i < args.length; i++) {
+                args[i] = convert(frame, arguments.get(i), true);
+            }
+
+            // Then call the internal function to process the template
+            try {
+                return ctx.createFromTemplate(template, ruleFromString(grammarRule), args);
+            } catch (Exception e) {
+                throw LKQLRuntimeException.fromJavaException(e, this.callNode);
+            }
+        }
+    }
 }

testsuite/tests/checks/binary_case_statements/test.out

@@ -31,13 +31,7 @@ Patched "binary_case_statements.adb":
 procedure Main is
    procedure Test (I : Integer);
 begin
-   if 1 =1 then null;
-      else null;
-   end if;if 1 =1 then Test (2);
-      elsif 1 =2 then Test (1);
-   end if;if True =True then null;
-      elsif True =False then null;
-   end if;case 1 is  --  NOFLAG
+   if 1=1 then null;else null;end if;if 1=1 then Test(2);elsif 1=2 then Test(1);end if;if True=True then null;elsif True=False then null;end if;case 1 is  --  NOFLAG
       when 1 | 2 => null;
       when others => null;
    end case;

testsuite/tests/checks/binary_case_statements_enums/test.out

@@ -24,7 +24,5 @@ begin
       when others => null;
    end case;
 
-   if 1 =1 then null;
-      else null;
-   end if;end Paths;
+   if 1=1 then null;else null;end if;end Paths;
 

testsuite/tests/checks/use_if_expressions/test.out

@@ -31,13 +31,13 @@ Patched "stmt.adb":
 function Stmt (X : in out Integer) return Integer is
    Y : Integer;
 begin
-   return(if X = 1 then 1 else 2);if X = 1 then   --  NOFLAG
+   return(if X=1 then 1 else 2);if X = 1 then   --  NOFLAG
       null;
    else
       null;
    end if;
 
-   return(if X = 1 then 1 elsif X = 2 then 2 else 3);if X = 1 then   --  NOFLAG
+   return(if X=1 then 1 elsif X=2 then 2 else 3);if X = 1 then   --  NOFLAG
       return 1;
    elsif X = 2 then
       X := 2;
@@ -53,7 +53,7 @@ begin
       X := 0;
    end if;
 
-   X :=(if X >= 2 then X + 1 elsif X <= 0 then X - 1 else 0);if X > 0 then    --  NOFLAG
+   X:=(if X>=2 then X+1 elsif X<=0 then X-1 else 0);if X > 0 then    --  NOFLAG
       return 2;
    end if;
 

testsuite/tests/rewriting/rewriting_api/create_from_template/custom.lkql

@@ -0,0 +1,8 @@
+@check(
+    message="Custom rule violation",
+    auto_fix=(n, ctx) => ctx.replace(
+        n,
+        ctx.create_from_template("Call_Something ({});", "call_stmt_rule", [n.f_label_name])
+    )
+)
+fun custom(node) = node is GotoStmt

testsuite/tests/rewriting/rewriting_api/create_from_template/main.adb

@@ -0,0 +1,4 @@
+procedure Main is
+begin
+   goto lbl;   --  FLAG
+end Main;

testsuite/tests/rewriting/rewriting_api/create_from_template/test.out

@@ -0,0 +1,11 @@
+main.adb:3:4: rule violation: Custom rule violation
+3 |    goto lbl;   --  FLAG
+  |    ^^^^^^^^^
+
+Patched "main.adb":
+===================
+
+procedure Main is
+begin
+   Call_Something(lbl);end Main;
+

testsuite/tests/rewriting/rewriting_api/create_from_template/test.yaml

@@ -0,0 +1,5 @@
+driver: checker
+input_sources:
+  - main.adb
+rule_name: custom
+auto_fix: True