HHH-3404 introduce 'like regexp' and 'ilike regexp' syntax sugar

Author: gavinking

hibernate-core/src/main/antlr/org/hibernate/grammars/hql/HqlLexer.g4

@@ -292,6 +292,7 @@ POSITION			: [pP] [oO] [sS] [iI] [tT] [iI] [oO] [nN];
 PRECEDING			: [pP] [rR] [eE] [cC] [eE] [dD] [iI] [nN] [gG];
 QUARTER				: [qQ] [uU] [aA] [rR] [tT] [eE] [rR];
 RANGE				: [rR] [aA] [nN] [gG] [eE];
+REGEXP              : [rR] [eE] [gG] [eE] [xX] [pP];
 RESPECT				: [rR] [eE] [sS] [pP] [eE] [cC] [tT];
 RETURNING			: [rR] [eE] [tT] [uU] [rR] [nN] [iI] [nN] [gG];
 RIGHT				: [rR] [iI] [gG] [hH] [tT];

hibernate-core/src/main/antlr/org/hibernate/grammars/hql/HqlParser.g4

@@ -669,7 +669,7 @@ predicate
 	| expression NOT? MEMBER OF? path											# MemberOfPredicate
 	| expression NOT? IN inList													# InPredicate
 	| expression NOT? BETWEEN expression AND expression							# BetweenPredicate
-	| expression NOT? (LIKE | ILIKE) expression likeEscape?						# LikePredicate
+	| expression NOT? (LIKE | ILIKE) REGEXP expression likeEscape?				# LikePredicate
 	| expression NOT? CONTAINS expression										# ContainsPredicate
 	| expression NOT? INCLUDES expression										# IncludesPredicate
 	| expression NOT? INTERSECTS expression										# IntersectsPredicate
@@ -1998,6 +1998,7 @@ xmltableDefaultClause
 	| PRECEDING
 	| QUARTER
 	| RANGE
+	| REGEXP
 	| RESPECT
 	| RETURNING
 //	| RIGHT

hibernate-core/src/main/java/org/hibernate/query/hql/internal/SemanticQueryBuilder.java

@@ -3222,19 +3222,43 @@ public SqmPredicate visitIntersectsPredicate(HqlParser.IntersectsPredicateContex
 	public SqmPredicate visitLikePredicate(HqlParser.LikePredicateContext ctx) {
 		final boolean negated = ctx.NOT() != null;
 		final boolean caseSensitive = ctx.LIKE() != null;
-		if ( ctx.likeEscape() == null ) {
+		final SqmExpression<?> expression = (SqmExpression<?>) ctx.expression( 0 ).accept( this );
+		final SqmExpression<?> pattern = (SqmExpression<?>) ctx.expression( 1 ).accept( this );
+		if ( ctx.REGEXP() != null ) {
+			if ( ctx.likeEscape() != null ) {
+				throw new SemanticException( "'ESCAPE' may not be used with 'LIKE REGEXP'", query );
+			}
+			return new SqmBooleanExpressionPredicate(
+					getFunctionDescriptor( "regexp_like" )
+							.generateSqmExpression(
+									caseSensitive
+											? asList( expression, pattern )
+											: asList( expression, pattern,
+													new SqmLiteral<>( "i",
+															resolveExpressibleTypeBasic( String.class ),
+															nodeBuilder()
+													)
+											),
+									null,
+									queryEngine()
+							),
+					negated,
+					nodeBuilder()
+			);
+		}
+		else if ( ctx.likeEscape() == null ) {
 			return new SqmLikePredicate(
-					(SqmExpression<?>) ctx.expression(0).accept( this ),
-					(SqmExpression<?>) ctx.expression(1).accept( this ),
+					expression,
+					pattern,
 					negated,
 					caseSensitive,
 					nodeBuilder()
 			);
 		}
 		else {
 			return new SqmLikePredicate(
-					(SqmExpression<?>) ctx.expression(0).accept( this ),
-					(SqmExpression<?>) ctx.expression(1).accept( this ),
+					expression,
+					pattern,
 					(SqmExpression<?>) ctx.likeEscape().accept( this ),
 					negated,
 					caseSensitive,
@@ -4338,9 +4362,8 @@ private SqmLiteral<String> stringLiteral(String text) {
 	}
 
 	private SqmLiteral<String> javaStringLiteral(String text) {
-		String unquoted = unquoteJavaStringLiteral( text );
 		return new SqmLiteral<>(
-				unquoted,
+				unquoteJavaStringLiteral( text ),
 				resolveExpressibleTypeBasic( String.class ),
 				nodeBuilder()
 		);

hibernate-core/src/test/java/x/RegexTest.java

@@ -29,6 +29,7 @@ class RegexTest {
 	void testInSelect(EntityManagerFactoryScope scope) {
 		scope.inEntityManager( em -> {
 			assertTrue( em.createQuery( "select regexp_like('abcdef', 'ab.*')", Boolean.class ).getSingleResult() );
+			assertTrue( em.createQuery( "select 'abcdef' like regexp 'ab.*'", Boolean.class ).getSingleResult() );
 		} );
 	}
 	@Test
@@ -41,6 +42,7 @@ void testInSelect(EntityManagerFactoryScope scope) {
 	void testInSelectCaseInsensitive(EntityManagerFactoryScope scope) {
 		scope.inEntityManager( em -> {
 			assertTrue( em.createQuery( "select regexp_like('ABCDEF', 'ab.*', 'i')", Boolean.class ).getSingleResult() );
+			assertTrue( em.createQuery( "select 'abcdef' ilike regexp 'ab.*'", Boolean.class ).getSingleResult() );
 		} );
 	}
 	@Test
@@ -51,6 +53,7 @@ void testInSelectCaseInsensitive(EntityManagerFactoryScope scope) {
 	void testInWhere(EntityManagerFactoryScope scope) {
 		scope.inEntityManager( em -> {
 			assertEquals( 1, em.createQuery( "select 1 where regexp_like('abcdef', 'ab.*')", Integer.class ).getSingleResult() );
+			assertEquals( 1, em.createQuery( "select 1 where 'abcdef' like regexp 'ab.*'", Integer.class ).getSingleResult() );
 		} );
 	}
 }