Internalize ANTLR sources; exclude from API checks

Author: alancai98

partiql-cli/src/main/kotlin/org/partiql/cli/shell/ShellHighlighter.kt

@@ -23,8 +23,8 @@ import org.jline.reader.LineReader
 import org.jline.utils.AttributedString
 import org.jline.utils.AttributedStringBuilder
 import org.jline.utils.AttributedStyle
-import org.partiql.parser.antlr.PartiQLParser
-import org.partiql.parser.antlr.PartiQLTokens
+import org.partiql.parser.internal.antlr.PartiQLParser
+import org.partiql.parser.internal.antlr.PartiQLTokens
 import java.nio.charset.StandardCharsets
 import java.util.regex.Pattern
 

partiql-lang/src/main/kotlin/org/partiql/lang/syntax/impl/PartiQLPigParser.kt

@@ -39,8 +39,8 @@ import org.partiql.lang.types.CustomType
 import org.partiql.lang.util.checkThreadInterrupted
 import org.partiql.lang.util.getAntlrDisplayString
 import org.partiql.lang.util.getIonValue
-import org.partiql.parser.antlr.PartiQLParser
-import org.partiql.parser.antlr.PartiQLTokens
+import org.partiql.parser.internal.antlr.PartiQLParser
+import org.partiql.parser.internal.antlr.PartiQLTokens
 import java.io.InputStream
 import java.nio.channels.ClosedByInterruptException
 import java.nio.charset.StandardCharsets

partiql-lang/src/main/kotlin/org/partiql/lang/syntax/impl/PartiQLPigVisitor.kt

@@ -60,8 +60,8 @@ import org.partiql.lang.util.checkThreadInterrupted
 import org.partiql.lang.util.error
 import org.partiql.lang.util.getPrecisionFromTimeString
 import org.partiql.lang.util.unaryMinus
-import org.partiql.parser.antlr.PartiQLBaseVisitor
-import org.partiql.parser.antlr.PartiQLParser
+import org.partiql.parser.internal.antlr.PartiQLBaseVisitor
+import org.partiql.parser.internal.antlr.PartiQLParser
 import org.partiql.pig.runtime.SymbolPrimitive
 import org.partiql.value.datetime.DateTimeException
 import org.partiql.value.datetime.TimeZone

partiql-lang/src/main/kotlin/org/partiql/lang/util/AntlrUtilities.kt

@@ -32,7 +32,7 @@ import org.partiql.errors.ErrorCode
 import org.partiql.errors.Property
 import org.partiql.errors.PropertyValueMap
 import org.partiql.lang.syntax.ParserException
-import org.partiql.parser.antlr.PartiQLParser
+import org.partiql.parser.internal.antlr.PartiQLParser
 import java.math.BigInteger
 
 // workaround until ErrorAndErrorContexts no longer uses IonSystem

partiql-lang/src/test/kotlin/org/partiql/lang/errors/ParserErrorsTest.kt

@@ -20,7 +20,7 @@ import org.partiql.errors.ErrorCode
 import org.partiql.errors.Property
 import org.partiql.lang.syntax.PartiQLParserTestBase
 import org.partiql.lang.util.getAntlrDisplayString
-import org.partiql.parser.antlr.PartiQLParser
+import org.partiql.parser.internal.antlr.PartiQLParser
 
 class ParserErrorsTest : PartiQLParserTestBase() {
 

partiql-lang/src/test/kotlin/org/partiql/lang/syntax/PartiQLParserDateTimeTests.kt

@@ -12,7 +12,7 @@ import org.partiql.lang.domains.PartiqlAst
 import org.partiql.lang.domains.id
 import org.partiql.lang.util.getAntlrDisplayString
 import org.partiql.lang.util.to
-import org.partiql.parser.antlr.PartiQLParser
+import org.partiql.parser.internal.antlr.PartiQLParser
 
 class PartiQLParserDateTimeTests : PartiQLParserTestBase() {
 

partiql-lang/src/test/kotlin/org/partiql/lang/syntax/PartiQLParserExplainTest.kt

@@ -22,7 +22,7 @@ import org.partiql.lang.ION
 import org.partiql.lang.domains.PartiqlAst
 import org.partiql.lang.util.ArgumentsProviderBase
 import org.partiql.lang.util.getAntlrDisplayString
-import org.partiql.parser.antlr.PartiQLParser
+import org.partiql.parser.internal.antlr.PartiQLParser
 
 class PartiQLParserExplainTest : PartiQLParserTestBase() {
 

partiql-lang/src/test/kotlin/org/partiql/lang/syntax/PartiQLParserTest.kt

@@ -29,7 +29,7 @@ import org.partiql.lang.ast.sourceLocation
 import org.partiql.lang.domains.PartiqlAst
 import org.partiql.lang.domains.id
 import org.partiql.lang.util.getAntlrDisplayString
-import org.partiql.parser.antlr.PartiQLParser
+import org.partiql.parser.internal.antlr.PartiQLParser
 import kotlin.concurrent.thread
 
 /**

partiql-lang/src/test/kotlin/org/partiql/lang/syntax/PartiQLParserWindowTests.kt

@@ -4,7 +4,7 @@ import org.junit.Test
 import org.partiql.errors.ErrorCode
 import org.partiql.errors.Property
 import org.partiql.lang.util.getAntlrDisplayString
-import org.partiql.parser.antlr.PartiQLParser
+import org.partiql.parser.internal.antlr.PartiQLParser
 
 class PartiQLParserWindowTests : PartiQLParserTestBase() {
 

partiql-lang/src/test/kotlin/org/partiql/lang/syntax/impl/PartiQLPigParserThreadInterruptTests.kt

@@ -31,7 +31,7 @@ import org.partiql.lang.StepContext
 import org.partiql.lang.domains.PartiqlAst
 import org.partiql.lang.eval.CompileOptions
 import org.partiql.lang.eval.visitors.VisitorTransformBase
-import org.partiql.parser.antlr.PartiQLTokens
+import org.partiql.parser.internal.antlr.PartiQLTokens
 import java.io.InputStream
 import java.util.concurrent.atomic.AtomicBoolean
 import kotlin.concurrent.thread

partiql-parser/README.adoc

@@ -3,6 +3,9 @@
 The PartiQL Parser can be used to parse PartiQL queries into an AST (`org.partiql.ast`).
 This interface expands the legacy `org.partiql.syntax.Parser` interface allowing for a richer return type as well as the latest AST.
 
+ANTLR-generated code is under the `internal` package namespace. It is not intended to be used outside of code within
+this library.
+
 == Interfaces
 
 [source,kotlin]

partiql-parser/api/partiql-parser.api

@@ -27,13 +27,21 @@ dependencies {
 }
 
 tasks.generateGrammarSource {
-    val antlrPackage = "org.partiql.parser.antlr"
+    val antlrPackage = "org.partiql.parser.internal.antlr"
     val antlrSources = "$buildDir/generated-src/${antlrPackage.replace('.', '/')}"
     maxHeapSize = "64m"
     arguments = listOf("-visitor", "-long-messages", "-package", antlrPackage)
     outputDirectory = File(antlrSources)
 }
 
+apiValidation {
+    ignoredPackages.addAll(
+        listOf(
+            "org.partiql.parser.internal"
+        )
+    )
+}
+
 tasks.javadoc {
     exclude("**/antlr/**")
 }

partiql-parser/build.gradle.kts

@@ -212,7 +212,7 @@ import org.partiql.parser.PartiQLParserException
 import org.partiql.parser.PartiQLSyntaxException
 import org.partiql.parser.SourceLocation
 import org.partiql.parser.SourceLocations
-import org.partiql.parser.antlr.PartiQLBaseVisitor
+import org.partiql.parser.internal.antlr.PartiQLBaseVisitor
 import org.partiql.parser.internal.util.DateTimeUtils
 import org.partiql.value.NumericValue
 import org.partiql.value.PartiQLValueExperimental
@@ -239,8 +239,8 @@ import java.nio.charset.StandardCharsets
 import java.time.LocalDate
 import java.time.format.DateTimeFormatter
 import java.time.format.DateTimeParseException
-import org.partiql.parser.antlr.PartiQLParser as GeneratedParser
-import org.partiql.parser.antlr.PartiQLTokens as GeneratedLexer
+import org.partiql.parser.internal.antlr.PartiQLParser as GeneratedParser
+import org.partiql.parser.internal.antlr.PartiQLTokens as GeneratedLexer
 
 /**
  * ANTLR Based Implementation of a PartiQLParser
@@ -574,7 +574,7 @@ internal class PartiQLParserDefault : PartiQLParser {
             }
         }
 
-        override fun visitQualifiedName(ctx: org.partiql.parser.antlr.PartiQLParser.QualifiedNameContext) = translate(ctx) {
+        override fun visitQualifiedName(ctx: org.partiql.parser.internal.antlr.PartiQLParser.QualifiedNameContext) = translate(ctx) {
             val qualifier = ctx.qualifier.map { visitSymbolPrimitive(it) }
             val name = visitSymbolPrimitive(ctx.name)
             if (qualifier.isEmpty()) {
@@ -1134,12 +1134,12 @@ internal class PartiQLParserDefault : PartiQLParser {
                 excludeStepStructField(identifier)
             }
 
-        override fun visitExcludeExprCollectionWildcard(ctx: org.partiql.parser.antlr.PartiQLParser.ExcludeExprCollectionWildcardContext) =
+        override fun visitExcludeExprCollectionWildcard(ctx: org.partiql.parser.internal.antlr.PartiQLParser.ExcludeExprCollectionWildcardContext) =
             translate(ctx) {
                 excludeStepCollWildcard()
             }
 
-        override fun visitExcludeExprTupleWildcard(ctx: org.partiql.parser.antlr.PartiQLParser.ExcludeExprTupleWildcardContext) =
+        override fun visitExcludeExprTupleWildcard(ctx: org.partiql.parser.internal.antlr.PartiQLParser.ExcludeExprTupleWildcardContext) =
             translate(ctx) {
                 excludeStepStructWildcard()
             }
@@ -1720,7 +1720,7 @@ internal class PartiQLParserDefault : PartiQLParser {
             exprSessionAttribute(Expr.SessionAttribute.Attribute.CURRENT_USER)
         }
 
-        override fun visitExprTermCurrentDate(ctx: org.partiql.parser.antlr.PartiQLParser.ExprTermCurrentDateContext) =
+        override fun visitExprTermCurrentDate(ctx: org.partiql.parser.internal.antlr.PartiQLParser.ExprTermCurrentDateContext) =
             translate(ctx) {
                 exprSessionAttribute(Expr.SessionAttribute.Attribute.CURRENT_DATE)
             }