Fix EQL and JPQL LIKE with ESCAPE clause parsing.

Closes #3873

Author: mp911de

spring-data-jpa/src/main/antlr4/org/springframework/data/jpa/repository/query/Eql.g4

@@ -677,7 +677,8 @@ entity_type_literal
 
 escape_character
     : CHARACTER
-    | character_valued_input_parameter //
+    | string_literal
+    | character_valued_input_parameter
     ;
 
 numeric_literal

spring-data-jpa/src/main/antlr4/org/springframework/data/jpa/repository/query/Jpql.g4

@@ -653,7 +653,8 @@ entity_type_literal
 
 escape_character
     : CHARACTER
-    | character_valued_input_parameter //
+    | string_literal
+    | character_valued_input_parameter
     ;
 
 numeric_literal
@@ -949,7 +950,7 @@ NOT_EQUAL                   : '<>' | '!=' ;
 
 CHARACTER                   : '\'' (~ ('\'' | '\\')) '\'' ;
 IDENTIFICATION_VARIABLE     : ('a' .. 'z' | 'A' .. 'Z' | '\u0080' .. '\ufffe' | '$' | '_') ('a' .. 'z' | 'A' .. 'Z' | '\u0080' .. '\ufffe' | '0' .. '9' | '$' | '_')* ;
-STRINGLITERAL               : '\'' (~ ('\'' | '\\'))* '\'' ;
+STRINGLITERAL               : '\'' (~ ('\'' | '\\')|'\\')* '\'' ;
 JAVASTRINGLITERAL           : '"' ( ('\\' [btnfr"']) | ~('"'))* '"';
 FLOATLITERAL                : ('0' .. '9')* '.' ('0' .. '9')+ (E ('0' .. '9')+)* (F|D)?;
 INTLITERAL                  : ('0' .. '9')+ ;

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/EqlQueryRenderer.java

@@ -2418,7 +2418,16 @@ public List<JpaQueryParsingToken> visitEntity_type_literal(EqlParser.Entity_type
 
 	@Override
 	public List<JpaQueryParsingToken> visitEscape_character(EqlParser.Escape_characterContext ctx) {
-		return List.of(new JpaQueryParsingToken(ctx.CHARACTER()));
+
+		if (ctx.CHARACTER() != null) {
+			return List.of(new JpaQueryParsingToken(ctx.CHARACTER()));
+		} else if (ctx.character_valued_input_parameter() != null) {
+			return visit(ctx.character_valued_input_parameter());
+		} else if (ctx.string_literal() != null) {
+			return visit(ctx.string_literal());
+		}
+
+		return List.of();
 	}
 
 	@Override

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/JpqlQueryRenderer.java

@@ -2225,7 +2225,16 @@ public List<JpaQueryParsingToken> visitEntity_type_literal(JpqlParser.Entity_typ
 
 	@Override
 	public List<JpaQueryParsingToken> visitEscape_character(JpqlParser.Escape_characterContext ctx) {
-		return List.of(new JpaQueryParsingToken(ctx.CHARACTER()));
+
+		if (ctx.CHARACTER() != null) {
+			return List.of(new JpaQueryParsingToken(ctx.CHARACTER()));
+		} else if (ctx.character_valued_input_parameter() != null) {
+			return visit(ctx.character_valued_input_parameter());
+		} else if (ctx.string_literal() != null) {
+			return visit(ctx.string_literal());
+		}
+
+		return List.of();
 	}
 
 	@Override

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlQueryRendererTests.java

@@ -1038,6 +1038,14 @@ void signedExpressionsShouldWork(String query) {
 		assertQuery(query);
 	}
 
+	@Test // GH-3873
+	void escapeClauseShouldWork() {
+		assertQuery("select t.name from SomeDbo t where t.name LIKE :name escape '\\\\'");
+		assertQuery("SELECT e FROM SampleEntity e WHERE LOWER(e.label) LIKE LOWER(?1) ESCAPE '\\\\'");
+		assertQuery("SELECT e FROM SampleEntity e WHERE LOWER(e.label) LIKE LOWER(?1) ESCAPE ?1");
+		assertQuery("SELECT e FROM SampleEntity e WHERE LOWER(e.label) LIKE LOWER(?1) ESCAPE :param");
+	}
+
 	@ParameterizedTest // GH-3451
 	@MethodSource("reservedWords")
 	void entityNameWithPackageContainingReservedWord(String reservedWord) {

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/HqlQueryRendererTests.java

@@ -1569,6 +1569,9 @@ void binaryLiteralsShouldWork() {
 	@Test // GH-3040
 	void escapeClauseShouldWork() {
 		assertQuery("select t.name from SomeDbo t where t.name LIKE :name escape '\\\\'");
+		assertQuery("SELECT e FROM SampleEntity e WHERE LOWER(e.label) LIKE LOWER(?1) ESCAPE '\\\\'");
+		assertQuery("SELECT e FROM SampleEntity e WHERE LOWER(e.label) LIKE LOWER(?1) ESCAPE ?1");
+		assertQuery("SELECT e FROM SampleEntity e WHERE LOWER(e.label) LIKE LOWER(?1) ESCAPE :param");
 	}
 
 	@Test // GH-3062, GH-3056

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpqlQueryRendererTests.java

@@ -1046,6 +1046,14 @@ void signedExpressionsShouldWork(String query) {
 		assertQuery(query);
 	}
 
+	@Test // GH-3873
+	void escapeClauseShouldWork() {
+		assertQuery("select t.name from SomeDbo t where t.name LIKE :name escape '\\\\'");
+		assertQuery("SELECT e FROM SampleEntity e WHERE LOWER(e.label) LIKE LOWER(?1) ESCAPE '\\\\'");
+		assertQuery("SELECT e FROM SampleEntity e WHERE LOWER(e.label) LIKE LOWER(?1) ESCAPE ?1");
+		assertQuery("SELECT e FROM SampleEntity e WHERE LOWER(e.label) LIKE LOWER(?1) ESCAPE :param");
+	}
+
 	@ParameterizedTest // GH-3451
 	@MethodSource("reservedWords")
 	void entityNameWithPackageContainingReservedWord(String reservedWord) {