ParsedQuery.kt
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.room.parser
import androidx.room.parser.SectionType.BIND_VAR
import androidx.room.parser.SectionType.NEWLINE
import androidx.room.parser.SectionType.TEXT
import androidx.room.verifier.QueryResultInfo
import org.antlr.v4.runtime.tree.TerminalNode
enum class SectionType {
BIND_VAR,
TEXT,
NEWLINE
}
data class Section(val text: String, val type: SectionType) {
companion object {
fun text(text: String) = Section(text, SectionType.TEXT)
fun newline() = Section("", SectionType.NEWLINE)
fun bindVar(text: String) = Section(text, SectionType.BIND_VAR)
}
}
data class Table(val name: String, val alias: String)
data class ParsedQuery(
val original: String,
val type: QueryType,
val inputs: List<TerminalNode>,
val tables: Set<Table>, // pairs of table name and alias
val syntaxErrors: List<String>,
val runtimeQueryPlaceholder: Boolean
) {
companion object {
val STARTS_WITH_NUMBER = "^\?[0-9]".toRegex()
val MISSING = ParsedQuery(
original = "missing query",
type = QueryType.UNKNOWN,
inputs = emptyList(),
tables = emptySet(),
syntaxErrors = emptyList(),
runtimeQueryPlaceholder = false
)
}
/**
* Optional data that might be assigned when the query is parsed inside an annotation processor.
* User may turn this off or it might be disabled for any reason so generated code should
* always handle not having it.
*/
var resultInfo: QueryResultInfo? = null
val sections by lazy {
val lines = original.lines()
val inputsByLine = inputs.groupBy { it.symbol.line }
val sections = arrayListOf<Section>()
lines.forEachIndexed { index, line ->
var charInLine = 0
inputsByLine[index + 1]?.forEach { bindVar ->
if (charInLine < bindVar.symbol.charPositionInLine) {
sections.add(
Section.text(
line.substring(
charInLine,
bindVar.symbol.charPositionInLine
)
)
)
}
sections.add(Section.bindVar(bindVar.text))
charInLine = bindVar.symbol.charPositionInLine + bindVar.symbol.text.length
}
if (charInLine < line.length) {
sections.add(Section.text(line.substring(charInLine)))
}
if (index + 1 < lines.size) {
sections.add(Section.newline())
}
}
sections
}
val bindSections by lazy { sections.filter { it.type == BIND_VAR } }
private fun unnamedVariableErrors(): List<String> {
val anonymousBindError = if (inputs.any { it.text == "?" }) {
arrayListOf(ParserErrors.ANONYMOUS_BIND_ARGUMENT)
} else {
emptyList<String>()
}
return anonymousBindError + inputs.filter {
it.text.matches(STARTS_WITH_NUMBER)
}.map {
ParserErrors.cannotUseVariableIndices(it.text, it.symbol.charPositionInLine)
}
}
private fun unknownQueryTypeErrors(): List<String> {
return if (QueryType.SUPPORTED.contains(type)) {
emptyList()
} else {
listOf(ParserErrors.invalidQueryType(type))
}
}
val errors by lazy {
if (syntaxErrors.isNotEmpty()) {
// if there is a syntax error, don't report others since they might be misleading.
syntaxErrors
} else {
unnamedVariableErrors() + unknownQueryTypeErrors()
}
}
val queryWithReplacedBindParams by lazy {
sections.joinToString("") {
when (it.type) {
TEXT -> it.text
BIND_VAR -> "?"
NEWLINE -> "\n"
}
}
}
}