quotedStringWithEscapes(char, Function)

Author: fluentfuture

dot-parse/src/main/java/com/google/common/labs/parse/Parser.java

@@ -145,19 +145,21 @@ public static Parser<String> string(String value) {
   }
 
   /**
-   * String literal quoted by {@code quoteChar} and allows backslash escapes (no Unicode escapes or
-   * C-style escapes like '\n', '\t' etc.).
+   * String literal quoted by {@code quoteChar} and allows backslash escapes (no Unicode escapes).
    *
-   * <p>For example, {@code "foo\\bar"} is parsed as {@code foo\bar}.
+   * <p>Any escaped character will be passed to the {@code escapeFunction} to translate. If you need
+   * ST-Query style escaping that doesn't treat '\t', '\n' etc. specially, just pass {@code
+   * Object::toString}.
    *
    * @since 9.4
    */
-  public static Parser<String> quotedStringWithEscapes(char quoteChar) {
+  public static Parser<String> quotedStringWithEscapes(
+      char quoteChar, Function<? super Character, String> escapeFunction) {
     checkArgument(quoteChar != '\\', "quoteChar cannot be \\");
     String quoteString = Character.toString(quoteChar);
     return anyOf(
             consecutive(isNot(quoteChar).and(isNot('\\')), "quoted chars"),
-            string("\\").then(single(CharPredicate.ANY, "escaped char").source()))
+            string("\\").then(single(CharPredicate.ANY, "escaped char").map(escapeFunction)))
         .zeroOrMore(joining())
         .immediatelyBetween(quoteString, quoteString);
   }

dot-parse/src/test/java/com/google/common/labs/parse/MiniSearchTest.java

@@ -67,7 +67,7 @@ static SearchCriteria parse(String input) {
       // A search term is either quoted, or unquoted (but cannot be a keyword)
       Parser<Term> unquoted =
           WORD.suchThat(w -> !keywords.contains(w), "search term").map(Term::new);
-      Parser<Term> quoted = Parser.quotedStringWithEscapes('"').map(Term::new);
+      Parser<Term> quoted = Parser.quotedStringWithEscapes('"', Object::toString).map(Term::new);
 
       // Leaf-level search term can be a quoted, unquoted term, or a sub-criteria inside parentheses.
       // They are then grouped by the boolean operators.

dot-parse/src/test/java/com/google/common/labs/parse/ParserTest.java

@@ -2305,7 +2305,7 @@ public void single_failure() {
 
   @Test
   public void quotedStringWithEscapes_singleQuote_success() {
-    Parser<String> singleQuoted = Parser.quotedStringWithEscapes('\'');
+    Parser<String> singleQuoted = Parser.quotedStringWithEscapes('\'', Object::toString);
     assertThat(singleQuoted.parse("''")).isEmpty();
     assertThat(singleQuoted.parse("'foo'")).isEqualTo("foo");
     assertThat(singleQuoted.parse("'foo\\'s'")).isEqualTo("foo's");
@@ -2316,7 +2316,7 @@ public void quotedStringWithEscapes_singleQuote_success() {
 
   @Test
   public void quotedStringWithEscapes_doubleQuote_success() {
-    Parser<String> doubleQuoted = Parser.quotedStringWithEscapes('"');
+    Parser<String> doubleQuoted = Parser.quotedStringWithEscapes('"', Object::toString);
     assertThat(doubleQuoted.parse("\"\"")).isEmpty();
     assertThat(doubleQuoted.parse("\"bar\"")).isEqualTo("bar");
     assertThat(doubleQuoted.parse("\"bar\\\"baz\"")).isEqualTo("bar\"baz");
@@ -2325,15 +2325,17 @@ public void quotedStringWithEscapes_doubleQuote_success() {
 
   @Test
   public void quotedStringWithEscapes_failures() {
-    Parser<String> singleQuoted = Parser.quotedStringWithEscapes('\'');
+    Parser<String> singleQuoted = Parser.quotedStringWithEscapes('\'', Object::toString);
     assertThrows(ParseException.class, () -> singleQuoted.parse("'foo")); // unclosed
     assertThrows(ParseException.class, () -> singleQuoted.parse("'foo'bar")); // leftover
     assertThrows(ParseException.class, () -> singleQuoted.parse("'foo\\")); // dangling escape
   }
 
   @Test
   public void quotedStringWithEscapes_backslashQuoteChar_throws() {
-    assertThrows(IllegalArgumentException.class, () -> Parser.quotedStringWithEscapes('\\'));
+    assertThrows(
+        IllegalArgumentException.class,
+        () -> Parser.quotedStringWithEscapes('\\', Object::toString));
   }
 
   @Test