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

Escape Java string values when concatenating them in the generated code

Closes #463

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

Author: HugoGGuerrier

lkql_jit/builtins_annotations/src/main/java/com/adacore/lkql_jit/annotations/BuiltInProcessor.java

@@ -257,8 +257,10 @@ private String builtInArguments(TypeElement builtIn, boolean omitSelfParam) {
                         }
                     });
 
-                names.add("\"" + nameSB + "\"");
-                defaultVals.add(defaultVal != null ? "\"" + defaultVal + "\"" : "null");
+                names.add("\"" + escapeString(nameSB.toString()) + "\"");
+                defaultVals.add(
+                    (defaultVal != null ? "\"" + escapeString(defaultVal) + "\"" : "null")
+                );
             }
 
             return (
@@ -342,9 +344,9 @@ private void processBuiltInFactory(TypeElement builtInFactoryClass) throws IOExc
 
                         return (
                             "          new BuiltInFunctionValue(\"" +
-                            fnAnnot.name() +
+                            escapeString(fnAnnot.name()) +
                             "\", \"" +
-                            fnAnnot.doc() +
+                            escapeString(fnAnnot.doc()) +
                             "\", " +
                             builtInArguments(builtInFn, false) +
                             ", BuiltInBody.create(" +
@@ -416,9 +418,9 @@ private void processBuiltInFactory(TypeElement builtInFactoryClass) throws IOExc
                             "BuiltInMethodFactory." +
                             (isProperty ? "createAttribute" : "createMethod") +
                             "(\"" +
-                            name +
+                            escapeString(name) +
                             "\", \"" +
-                            doc +
+                            escapeString(doc) +
                             "\"" +
                             (isProperty ? "" : ", " + builtInArguments(builtInMethod, true)) +
                             ", BuiltInBody.create(" +
@@ -431,7 +433,7 @@ private void processBuiltInFactory(TypeElement builtInFactoryClass) throws IOExc
                         return (
                             "            Pair.create(new String[] {" +
                             Arrays.stream(targetTypes)
-                                .map(t -> "\"" + t + "\"")
+                                .map(t -> "\"" + escapeString(t) + "\"")
                                 .collect(Collectors.joining(", ")) +
                             " }," +
                             wrapper +
@@ -448,4 +450,15 @@ private void processBuiltInFactory(TypeElement builtInFactoryClass) throws IOExc
 
         builtInPackages.add(Pair.create(packageName, className));
     }
+
+    /** Return the `input` string with all special characters escaped. */
+    private static String escapeString(String input) {
+        return input
+            .replace("\n", "\\n")
+            .replace("\r", "\\r")
+            .replace("\t", "\\t")
+            .replace("\b", "\\b")
+            .replace("\f", "\\f")
+            .replace("\"", "\\\"");
+    }
 }