Skip to content

Commit 51e29a0

Browse files
minleejaeminleejae
authored
fix(parser): resolve shadowed contextual keyword tokens (#2597)
Share contextual keyword consumption for MATCHING and DISTRIBUTED RECOVERY, and remove unreachable dedicated-keyword alternatives from DATA_TYPE. Keep these words usable as identifiers and preserve existing type parsing. Fixes #2403.
1 parent 78cff6b commit 51e29a0

2 files changed

Lines changed: 99 additions & 7 deletions

File tree

‎src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt‎

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2357,6 +2357,8 @@ TOKEN : /* Date/Time with time zones */
23572357

23582358
TOKEN : /* Data Types */
23592359
{
2360+
// Dedicated keyword tokens (e.g. K_BINARY/K_CHAR) are consumed by DataType().
2361+
// Repeating them here cannot match DATA_TYPE and causes unreachable-token warnings.
23602362
<DATA_TYPE: ( <TYPE_BIT> | <TYPE_BLOB> | <TYPE_BOOLEAN> | <TYPE_ENUM>
23612363
| <TYPE_REAL> | <TYPE_DOUBLE> | <TYPE_UUID> | <TYPE_MAP>| <TYPE_TINYINT> | <TYPE_SMALLINT>
23622364
| <TYPE_INTEGER> | <TYPE_BIGINT> | <TYPE_HUGEINT> | <TYPE_UTINYINT> | <TYPE_USMALLINT>
@@ -2365,15 +2367,15 @@ TOKEN : /* Data Types */
23652367
) >
23662368

23672369
| <#TYPE_BIT: "BISTRING">
2368-
| <#TYPE_BLOB: "BLOB" | "BYTEA" | <K_BINARY> | "VARBINARY" | <K_BYTES> >
2369-
| <#TYPE_BOOLEAN: <K_BOOLEAN> | "BOOL" >
2370+
| <#TYPE_BLOB: "BLOB" | "BYTEA" | "VARBINARY" >
2371+
| <#TYPE_BOOLEAN: "BOOL" >
23702372
| <#TYPE_CLOB: "CLOB">
23712373
| <#TYPE_ENUM: "ENUM" >
23722374
| <#TYPE_MAP: "MAP" >
23732375
| <#TYPE_DECIMAL: "DECIMAL" | "NUMBER" | "NUMERIC" >
23742376
| <#TYPE_TINYINT: "TINYINT" | "INT1" >
23752377
| <#TYPE_SMALLINT: "SMALLINT" | "INT2" | "SHORT" >
2376-
| <#TYPE_INTEGER: ( "INTEGER" | "INT" | "INT4" | <K_SIGNED> | <K_UNSIGNED> ) >
2378+
| <#TYPE_INTEGER: ( "INTEGER" | "INT" | "INT4" ) >
23772379
| <#TYPE_BIGINT: "BIGINT" | "INT8" | "LONG" >
23782380
| <#TYPE_HUGEINT: "HUGEINT" >
23792381
| <#TYPE_UTINYINT: "UTINYINT" >
@@ -2383,7 +2385,7 @@ TOKEN : /* Data Types */
23832385
| <#TYPE_UHUGEINT: "UHUGEINT" >
23842386
| <#TYPE_REAL: "REAL" | "FLOAT4" | "FLOAT">
23852387
| <#TYPE_DOUBLE: "DOUBLE" | "PRECISION" | "FLOAT8" | "FLOAT64">
2386-
| <#TYPE_VARCHAR: "NVARCHAR" | "VARCHAR" | "NCHAR" | <K_CHAR> | "BPCHAR" | "TEXT" | "STRING" | <K_CHARACTER> | "VARYING">
2388+
| <#TYPE_VARCHAR: "NVARCHAR" | "VARCHAR" | "NCHAR" | "BPCHAR" | "TEXT" | "STRING" | "VARYING">
23872389
| <#TYPE_TIME: "TIMETZ" >
23882390
| <#TYPE_TIMESTAMP: "TIMESTAMP_NS" | "TIMESTAMP_MS" | "TIMESTAMP_S" >
23892391

@@ -5858,7 +5860,8 @@ String SetOperationModifier():
58585860
[ ( tk=<K_ALL> | tk="DISTINCT") { modifier+=tk.image; } ]
58595861
<K_BY> <K_NAME> { modifier+= " BY NAME"; }
58605862
[
5861-
"MATCHING" { modifier+= " MATCHING"; }
5863+
LOOKAHEAD({ isKeywordAhead("MATCHING") })
5864+
ContextualKeyword("MATCHING") { modifier+= " MATCHING"; }
58625865
"("
58635866
identifier = RelObjectName() { modifier+="(" + identifier; }
58645867
("," identifier = RelObjectName() { modifier+=", " + identifier; })*
@@ -15729,14 +15732,14 @@ AlterSystemStatement AlterSystemStatement():
1572915732
|
1573015733
(
1573115734
<K_ENABLE> (
15732-
"DISTRIBUTED" "RECOVERY" { operation = AlterSystemOperation.ENABLE_DISTRIBUTED_RECOVERY; }
15735+
ContextualKeyword("DISTRIBUTED") ContextualKeyword("RECOVERY") { operation = AlterSystemOperation.ENABLE_DISTRIBUTED_RECOVERY; }
1573315736
| <K_RESTRICTED> <K_SESSION> { operation = AlterSystemOperation.ENABLE_DISTRIBUTED_RECOVERY; }
1573415737
)
1573515738
)
1573615739
|
1573715740
(
1573815741
<K_DISABLE> (
15739-
"DISTRIBUTED" "RECOVERY" { operation = AlterSystemOperation.DISABLE_DISTRIBUTED_RECOVERY; }
15742+
ContextualKeyword("DISTRIBUTED") ContextualKeyword("RECOVERY") { operation = AlterSystemOperation.DISABLE_DISTRIBUTED_RECOVERY; }
1574015743
| <K_RESTRICTED> <K_SESSION> { operation = AlterSystemOperation.DISABLE_RESTRICTED_SESSION; }
1574115744
)
1574215745
)
@@ -15892,6 +15895,17 @@ Comment Comment():
1589215895
}
1589315896
}
1589415897

15898+
/** Consumes a keyword that remains an ordinary identifier outside this grammar context. */
15899+
void ContextualKeyword(String expected):
15900+
{ Token keyword; }
15901+
{
15902+
keyword=<S_IDENTIFIER> {
15903+
if (!expected.equalsIgnoreCase(keyword.image)) {
15904+
throw new ParseException("Expected " + expected + " but found " + keyword.image);
15905+
}
15906+
}
15907+
}
15908+
1589515909
void AccessKeyword(String expected):
1589615910
{ Token token; }
1589715911
{ (token=<S_IDENTIFIER> | token=<DATA_TYPE>) { requireAccessSyntax(expected.equalsIgnoreCase(token.image), "Expected " + expected); } }

‎src/test/java/net/sf/jsqlparser/parser/ContextualTokenTest.java‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
/*-
2+
* #%L
3+
* JSQLParser library
4+
* %%
5+
* Copyright (C) 2004 - 2026 JSQLParser
6+
* %%
7+
* Dual licensed under GNU LGPL 2.1 or Apache License 2.0
8+
* #L%
9+
*/
10+
package net.sf.jsqlparser.parser;
11+
12+
import net.sf.jsqlparser.JSQLParserException;
13+
import net.sf.jsqlparser.statement.alter.AlterSystemStatement;
14+
import net.sf.jsqlparser.statement.alter.AlterSystemOperation;
15+
import org.junit.jupiter.api.Test;
16+
import org.junit.jupiter.params.ParameterizedTest;
17+
import org.junit.jupiter.params.provider.ValueSource;
18+
19+
import static net.sf.jsqlparser.test.TestUtils.assertSqlCanBeParsedAndDeparsed;
20+
import static org.junit.jupiter.api.Assertions.*;
21+
22+
class ContextualTokenTest {
23+
@ParameterizedTest
24+
@ValueSource(strings = {
25+
"SELECT a FROM t UNION ALL BY NAME MATCHING (a) SELECT a FROM u",
26+
"SELECT a FROM t UNION DISTINCT BY NAME MATCHING (a, b) SELECT a FROM u",
27+
"ALTER SYSTEM ENABLE DISTRIBUTED RECOVERY",
28+
"ALTER SYSTEM DISABLE DISTRIBUTED RECOVERY"
29+
})
30+
void parsesPreviouslyShadowedContextualKeywords(String sql) throws Exception {
31+
for (boolean complex : new boolean[] {false, true}) {
32+
String parsed = assertSqlCanBeParsedAndDeparsed(sql, true,
33+
parser -> parser.withAllowComplexParsing(complex)).toString();
34+
assertEquals(parsed, CCJSqlParserUtil.parse(parsed).toString());
35+
}
36+
}
37+
38+
@Test
39+
void preservesAlterSystemOperation() throws Exception {
40+
assertEquals(AlterSystemOperation.ENABLE_DISTRIBUTED_RECOVERY,
41+
((AlterSystemStatement) CCJSqlParserUtil.parse(
42+
"alter system enable distributed recovery")).getOperation());
43+
assertEquals(AlterSystemOperation.DISABLE_DISTRIBUTED_RECOVERY,
44+
((AlterSystemStatement) CCJSqlParserUtil.parse(
45+
"alter system disable distributed recovery")).getOperation());
46+
}
47+
48+
@ParameterizedTest
49+
@ValueSource(strings = {"MATCHING", "DISTRIBUTED", "RECOVERY"})
50+
void keepsContextualWordsUsableAsIdentifiers(String word) throws Exception {
51+
assertEquals(CCJSqlParserConstants.S_IDENTIFIER,
52+
CCJSqlParserUtil.newParser(word).getNextToken().kind);
53+
assertSqlCanBeParsedAndDeparsed("SELECT " + word + ", " + word
54+
+ "(a) FROM " + word + " AS x", true);
55+
}
56+
57+
@ParameterizedTest
58+
@ValueSource(
59+
strings = {"BYTES", "BINARY", "BOOLEAN", "UNSIGNED", "SIGNED", "CHARACTER", "CHAR"})
60+
void retainsDedicatedTypeTokensAndTypeParsing(String type) throws Exception {
61+
assertNotEquals(CCJSqlParserConstants.DATA_TYPE,
62+
CCJSqlParserUtil.newParser(type).getNextToken().kind);
63+
assertSqlCanBeParsedAndDeparsed("CREATE TABLE t (c " + type + ")", true);
64+
assertSqlCanBeParsedAndDeparsed("SELECT CAST(c AS " + type + ") FROM t", true);
65+
}
66+
67+
@ParameterizedTest
68+
@ValueSource(strings = {
69+
"ALTER SYSTEM ENABLE other RECOVERY",
70+
"ALTER SYSTEM DISABLE DISTRIBUTED other",
71+
"ALTER SYSTEM ENABLE DISTRIBUTED",
72+
"SELECT a FROM t UNION ALL BY NAME other (a) SELECT a FROM u",
73+
"SELECT a FROM t UNION ALL BY NAME MATCHING () SELECT a FROM u"
74+
})
75+
void rejectsWrongContextualKeywords(String sql) {
76+
assertThrows(JSQLParserException.class, () -> CCJSqlParserUtil.parse(sql));
77+
}
78+
}

0 commit comments

Comments
 (0)