org.jetbrains.kotlin.diagnostics.LightTreePositioningStrategies.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler-embeddable Show documentation
Show all versions of kotlin-compiler-embeddable Show documentation
the Kotlin compiler embeddable
/*
* Copyright 2010-2021 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
package org.jetbrains.kotlin.diagnostics
import com.intellij.lang.LighterASTNode
import com.intellij.openapi.util.Ref
import com.intellij.openapi.util.TextRange
import com.intellij.psi.tree.IElementType
import com.intellij.psi.tree.TokenSet
import com.intellij.util.diff.FlyweightCapableTreeStructure
import org.jetbrains.kotlin.KtNodeType
import org.jetbrains.kotlin.KtNodeTypes
import org.jetbrains.kotlin.KtSourceElement
import org.jetbrains.kotlin.lexer.KtTokens
import org.jetbrains.kotlin.lexer.KtTokens.*
import org.jetbrains.kotlin.psi.KtParameter.VAL_VAR_TOKEN_SET
import org.jetbrains.kotlin.psi.stubs.elements.KtConstantExpressionElementType
import org.jetbrains.kotlin.psi.stubs.elements.KtStringTemplateExpressionElementType
import org.jetbrains.kotlin.psi.stubs.elements.KtTokenSets
import org.jetbrains.kotlin.util.getChildren
import org.jetbrains.kotlin.utils.addToStdlib.runUnless
object LightTreePositioningStrategies {
val DEFAULT = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
when (node.tokenType) {
KtNodeTypes.OBJECT_LITERAL -> {
val objectDeclaration = tree.findDescendantByType(node, KtNodeTypes.OBJECT_DECLARATION)!!
val objectKeyword = tree.objectKeyword(objectDeclaration)!!
val supertypeList = tree.supertypesList(objectDeclaration)
return markRange(objectKeyword, supertypeList ?: objectKeyword, startOffset, endOffset, tree, node)
}
KtNodeTypes.OBJECT_DECLARATION -> {
val objectKeyword = tree.objectKeyword(node)!!
return markRange(
from = objectKeyword,
to = tree.nameIdentifier(node) ?: objectKeyword,
startOffset, endOffset, tree, node
)
}
KtNodeTypes.CONSTRUCTOR_DELEGATION_CALL -> {
return SECONDARY_CONSTRUCTOR_DELEGATION_CALL.mark(node, startOffset, endOffset, tree)
}
}
return super.mark(node, startOffset, endOffset, tree)
}
}
val SUPERTYPES_LIST = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val target = tree.supertypesList(node) ?: node
return markElement(target, startOffset, endOffset, tree, node)
}
}
val VAL_OR_VAR_NODE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val target = tree.valOrVarKeyword(node) ?: node
return markElement(target, startOffset, endOffset, tree, node)
}
}
val COMPANION_OBJECT: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val target = tree.companionKeyword(node) ?: node
return markElement(target, startOffset, endOffset, tree, node)
}
}
val SECONDARY_CONSTRUCTOR_DELEGATION_CALL: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
when (node.tokenType) {
KtNodeTypes.SECONDARY_CONSTRUCTOR -> {
val valueParameterList = tree.valueParameterList(node)
?: return markElement(node, startOffset, endOffset, tree)
return markRange(
tree.constructorKeyword(node)!!,
tree.lastChild(valueParameterList) ?: valueParameterList,
startOffset, endOffset, tree, node
)
}
KtNodeTypes.CONSTRUCTOR_DELEGATION_CALL -> {
val delegationReference = tree.findChildByType(node, KtNodeTypes.CONSTRUCTOR_DELEGATION_REFERENCE)
if (delegationReference != null && tree.firstChild(delegationReference) == null) {
val constructor = tree.findParentOfType(node, KtNodeTypes.SECONDARY_CONSTRUCTOR)!!
val valueParameterList = tree.valueParameterList(constructor)
?: return markElement(constructor, startOffset, endOffset, tree, node)
return markRange(
tree.constructorKeyword(constructor)!!,
tree.lastChild(valueParameterList) ?: valueParameterList,
startOffset, endOffset, tree, node
)
}
return markElement(delegationReference ?: node, startOffset, endOffset, tree, node)
}
else -> error("unexpected element $node")
}
}
}
val DECLARATION_RETURN_TYPE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List = markElement(getElementToMark(node, tree), startOffset, endOffset, tree, node)
override fun isValid(node: LighterASTNode, tree: FlyweightCapableTreeStructure): Boolean =
super.isValid(getElementToMark(node, tree), tree)
private fun getElementToMark(node: LighterASTNode, tree: FlyweightCapableTreeStructure): LighterASTNode {
val (returnTypeRef, nameIdentifierOrPlaceHolder) = when {
node.tokenType == KtNodeTypes.PROPERTY_ACCESSOR ->
tree.typeReference(node) to tree.accessorNamePlaceholder(node)
node.isDeclaration || node.tokenType == KtNodeTypes.VALUE_PARAMETER ->
tree.typeReference(node) to tree.nameIdentifier(node)
else ->
null to null
}
return returnTypeRef ?: (nameIdentifierOrPlaceHolder ?: node)
}
}
val DECLARATION_START_TO_NAME: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
private fun FlyweightCapableTreeStructure.firstNonCommentNonAnnotationLeaf(node: LighterASTNode): LighterASTNode? {
val childrenArray = getChildrenArray(node).filterNotNull()
// this is leaf
if (childrenArray.isEmpty()) return node
for (child in childrenArray) {
val childTokenType = child.tokenType ?: return null
if (childTokenType in KtTokens.WHITE_SPACE_OR_COMMENT_BIT_SET || childTokenType == KtNodeTypes.ANNOTATION_ENTRY) {
continue
}
return firstNonCommentNonAnnotationLeaf(child) ?: continue
}
return null
}
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val startNode = tree.firstNonCommentNonAnnotationLeaf(node) ?: node
val nameIdentifier = tree.nameIdentifier(node)
return if (nameIdentifier != null) {
markRange(startNode, nameIdentifier, startOffset, endOffset, tree, node)
} else {
val endNode = when (node.tokenType) {
KtNodeTypes.PRIMARY_CONSTRUCTOR, KtNodeTypes.SECONDARY_CONSTRUCTOR -> tree.constructorKeyword(node)
KtNodeTypes.OBJECT_DECLARATION -> tree.objectKeyword(node)
else -> return DEFAULT.mark(node, startOffset, endOffset, tree)
}
markRange(startNode, endNode ?: node, startOffset, endOffset, tree, node)
}
}
}
private open class BaseDeclarationNameStrategy : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val nameIdentifier = tree.nameIdentifier(node)
if (nameIdentifier != null) {
return markNameIdentifier(nameIdentifier, startOffset, endOffset, tree, node)
}
if (node.tokenType == KtNodeTypes.FUN) {
return DECLARATION_SIGNATURE.mark(node, startOffset, endOffset, tree)
}
return DEFAULT.mark(node, startOffset, endOffset, tree)
}
protected open fun markNameIdentifier(
nameIdentifier: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure,
node: LighterASTNode,
): List {
return markElement(nameIdentifier, startOffset, endOffset, tree, node)
}
}
private fun findStartingASTNodeForDeclarationName(
tree: FlyweightCapableTreeStructure,
node: LighterASTNode,
): LighterASTNode =
tree.modifierList(node)?.let { modifierList -> tree.findChildByType(modifierList, ENUM_KEYWORD) }
?: tree.findChildByType(node, TokenSet.create(CLASS_KEYWORD, KtTokens.OBJECT_KEYWORD))
?: node
val DECLARATION_NAME: LightTreePositioningStrategy = object : BaseDeclarationNameStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure,
): List {
if (node.tokenType == KtNodeTypes.PROPERTY_ACCESSOR) {
return markElement(tree.accessorNamePlaceholder(node), startOffset, endOffset, tree, node)
}
return super.mark(node, startOffset, endOffset, tree)
}
override fun markNameIdentifier(
nameIdentifier: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure,
node: LighterASTNode,
): List {
if (node.tokenType == KtNodeTypes.CLASS || node.tokenType == KtNodeTypes.OBJECT_DECLARATION) {
val startElement = findStartingASTNodeForDeclarationName(tree, node)
return markRange(startElement, nameIdentifier, startOffset, endOffset, tree, node)
}
return markElement(nameIdentifier, startOffset, endOffset, tree, node)
}
override fun isValid(node: LighterASTNode, tree: FlyweightCapableTreeStructure): Boolean {
//in FE 1.0 this is part of DeclarationHeader abstract strategy
if (node.tokenType != KtNodeTypes.OBJECT_DECLARATION
&& node.tokenType != KtNodeTypes.FUN
&& node.tokenType != KtNodeTypes.PRIMARY_CONSTRUCTOR
&& node.tokenType != KtNodeTypes.SECONDARY_CONSTRUCTOR
&& node.tokenType != KtNodeTypes.OBJECT_LITERAL
&& node.tokenType != KtNodeTypes.PROPERTY_ACCESSOR
) {
if (tree.nameIdentifier(node) == null) {
return false
}
}
return super.isValid(node, tree)
}
}
val DECLARATION_NAME_ONLY: LightTreePositioningStrategy = BaseDeclarationNameStrategy()
val ACTUAL_DECLARATION_NAME: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val nameIdentifier = tree.nameIdentifier(node)
if (nameIdentifier != null) {
return markElement(nameIdentifier, startOffset, endOffset, tree, node)
}
return DEFAULT.mark(node, startOffset, endOffset, tree)
}
}
val CONTEXT_KEYWORD: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List = tree.findDescendantByType(node, KtNodeTypes.CONTEXT_RECEIVER_LIST)?.getChildren(tree)?.firstOrNull()
?.let { markElement(it, startOffset, endOffset, tree, node) }
?: super.mark(node, startOffset, endOffset, tree)
}
val DECLARATION_SIGNATURE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
when (node.tokenType) {
KtNodeTypes.PRIMARY_CONSTRUCTOR, KtNodeTypes.SECONDARY_CONSTRUCTOR -> {
val begin = tree.constructorKeyword(node) ?: tree.valueParameterList(node)
?: return markElement(node, startOffset, endOffset, tree)
val end = tree.valueParameterList(node) ?: tree.constructorKeyword(node)
?: return markElement(node, startOffset, endOffset, tree)
return markRange(begin, end, startOffset, endOffset, tree, node)
}
KtNodeTypes.FUN, KtNodeTypes.FUNCTION_LITERAL -> {
val endOfSignatureElement =
tree.typeReference(node)
?: tree.valueParameterList(node)
?: tree.nameIdentifier(node)
?: node
val startElement = if (node.tokenType == KtNodeTypes.FUNCTION_LITERAL) {
tree.receiverTypeReference(node)
?: tree.valueParameterList(node)
?: node
} else node
return markRange(startElement, endOfSignatureElement, startOffset, endOffset, tree, node)
}
KtNodeTypes.PROPERTY -> {
val endOfSignatureElement = tree.typeReference(node) ?: tree.nameIdentifier(node) ?: node
return markRange(node, endOfSignatureElement, startOffset, endOffset, tree, node)
}
KtNodeTypes.PROPERTY_ACCESSOR -> {
val endOfSignatureElement =
tree.typeReference(node)
?: tree.rightParenthesis(node)
?: tree.accessorNamePlaceholder(node)
return markRange(node, endOfSignatureElement, startOffset, endOffset, tree, node)
}
KtNodeTypes.CLASS -> {
val nameAsDeclaration = tree.nameIdentifier(node)
?: return markElement(node, startOffset, endOffset, tree)
val primaryConstructorParameterList = tree.primaryConstructor(node)?.let { constructor ->
tree.valueParameterList(constructor)
} ?: return markElement(nameAsDeclaration, startOffset, endOffset, tree, node)
return markRange(nameAsDeclaration, primaryConstructorParameterList, startOffset, endOffset, tree, node)
}
KtNodeTypes.OBJECT_DECLARATION -> {
return DECLARATION_NAME.mark(node, startOffset, endOffset, tree)
}
KtNodeTypes.CLASS_INITIALIZER -> {
return markElement(tree.initKeyword(node)!!, startOffset, endOffset, tree, node)
}
}
return super.mark(node, startOffset, endOffset, tree)
}
}
val CALLABLE_DECLARATION_SIGNATURE_NO_MODIFIERS: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
when (node.tokenType) {
KtNodeTypes.FUN -> {
val startElement = tree.findChildByType(node, FUN_KEYWORD) ?: node
val endOfSignatureElement =
tree.typeReference(node)
?: tree.valueParameterList(node)
?: tree.nameIdentifier(node)
?: node
return markRange(startElement, endOfSignatureElement, startOffset, endOffset, tree, node)
}
KtNodeTypes.PROPERTY -> {
val start = tree.findChildByType(node, TokenSet.create(VAL_KEYWORD, VAR_KEYWORD)) ?: node
val endOfSignatureElement = tree.typeReference(node) ?: tree.nameIdentifier(node) ?: node
return markRange(start, endOfSignatureElement, startOffset, endOffset, tree, node)
}
KtNodeTypes.PROPERTY_ACCESSOR -> {
val endOfSignatureElement =
tree.typeReference(node)
?: tree.rightParenthesis(node)
?: tree.accessorNamePlaceholder(node)
return markRange(tree.accessorNamePlaceholder(node), endOfSignatureElement, startOffset, endOffset, tree, node)
}
}
return DECLARATION_SIGNATURE.mark(node, startOffset, endOffset, tree)
}
}
val DECLARATION_SIGNATURE_OR_DEFAULT: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List =
if (node.isDeclaration) {
DECLARATION_SIGNATURE.mark(node, startOffset, endOffset, tree)
} else {
DEFAULT.mark(node, startOffset, endOffset, tree)
}
}
val LAST_CHILD: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val value = node.nonFillerLastChildOrSelf(tree)
return markElement(value, startOffset, endOffset, tree, node)
}
}
private val LighterASTNode.isDeclaration: Boolean
get() =
when (tokenType) {
KtNodeTypes.PRIMARY_CONSTRUCTOR, KtNodeTypes.SECONDARY_CONSTRUCTOR,
KtNodeTypes.FUN, KtNodeTypes.FUNCTION_LITERAL,
KtNodeTypes.PROPERTY,
KtNodeTypes.PROPERTY_ACCESSOR,
KtNodeTypes.CLASS,
KtNodeTypes.OBJECT_DECLARATION,
KtNodeTypes.CLASS_INITIALIZER ->
true
else ->
false
}
private open class ModifierSetBasedLightTreePositioningStrategy(private val modifierSet: TokenSet) : LightTreePositioningStrategy() {
constructor(vararg tokens: IElementType) : this(TokenSet.create(*tokens))
protected fun markModifier(
node: LighterASTNode?,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure,
baseNode: LighterASTNode
): List? {
if (node == null) return null
val modifierList = tree.modifierList(node)
if (modifierList != null) {
tree.findChildByType(modifierList, modifierSet)?.let {
return markElement(it, startOffset, endOffset, tree, baseNode)
}
}
return null
}
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val modifierListRange = markModifier(node, startOffset, endOffset, tree, node)
if (modifierListRange != null) {
return modifierListRange
}
tree.nameIdentifier(node)?.let {
return markElement(it, startOffset, endOffset, tree, node)
}
return when (node.tokenType) {
KtNodeTypes.OBJECT_DECLARATION -> {
markElement(tree.objectKeyword(node)!!, startOffset, endOffset, tree, node)
}
KtNodeTypes.PROPERTY_ACCESSOR -> {
markElement(tree.accessorNamePlaceholder(node), startOffset, endOffset, tree, node)
}
else -> markElement(node, startOffset, endOffset, tree)
}
}
}
private class InlineFunLightTreePositioningStrategy : ModifierSetBasedLightTreePositioningStrategy(INLINE_KEYWORD) {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
if (node.tokenType == KtNodeTypes.PROPERTY) {
return markModifier(tree.getter(node), startOffset, endOffset, tree, node)
?: markModifier(tree.setter(node), startOffset, endOffset, tree, node)
?: super.mark(node, startOffset, endOffset, tree)
}
return super.mark(node, startOffset, endOffset, tree)
}
}
val VISIBILITY_MODIFIER: LightTreePositioningStrategy = ModifierSetBasedLightTreePositioningStrategy(VISIBILITY_MODIFIERS)
val MODALITY_MODIFIER: LightTreePositioningStrategy = ModifierSetBasedLightTreePositioningStrategy(MODALITY_MODIFIERS)
val ABSTRACT_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.ABSTRACT_KEYWORD)
val OPEN_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.OPEN_KEYWORD)
val OVERRIDE_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.OVERRIDE_KEYWORD)
val PRIVATE_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.PRIVATE_KEYWORD)
val LATEINIT_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.LATEINIT_KEYWORD)
val VARIANCE_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.IN_KEYWORD, KtTokens.OUT_KEYWORD)
val CONST_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.CONST_KEYWORD)
val FUN_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.FUN_KEYWORD)
val SUSPEND_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.SUSPEND_KEYWORD)
private val SUSPEND_OR_FUN_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.SUSPEND_KEYWORD, KtTokens.FUN_KEYWORD)
val INLINE_OR_VALUE_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(INLINE_KEYWORD, KtTokens.VALUE_KEYWORD)
val INNER_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.INNER_KEYWORD)
val DATA_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.DATA_KEYWORD)
val OPERATOR_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.OPERATOR_KEYWORD)
val INFIX_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.INFIX_KEYWORD)
val ENUM_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.ENUM_KEYWORD)
val TAILREC_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.TAILREC_KEYWORD)
val EXTERNAL_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.EXTERNAL_KEYWORD)
val EXPECT_ACTUAL_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.EXPECT_KEYWORD, KtTokens.ACTUAL_KEYWORD)
val OBJECT_KEYWORD: LightTreePositioningStrategy = keywordStrategy { objectKeyword(it) }
val FIELD_KEYWORD: LightTreePositioningStrategy = keywordStrategy { fieldKeyword(it) }
val PROPERTY_DELEGATE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val delegate = tree.findChildByType(node, KtNodeTypes.PROPERTY_DELEGATE)
return markElement(delegate ?: node, startOffset, endOffset, tree, node)
}
override fun isValid(node: LighterASTNode, tree: FlyweightCapableTreeStructure): Boolean {
return tree.findChildByType(node, KtNodeTypes.PROPERTY_DELEGATE) != null
}
}
val INLINE_PARAMETER_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.NOINLINE_KEYWORD, KtTokens.CROSSINLINE_KEYWORD)
val INLINE_FUN_MODIFIER: LightTreePositioningStrategy = InlineFunLightTreePositioningStrategy()
val OPERATOR: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return markElement(tree.operationReference(node) ?: node, startOffset, endOffset, tree, node)
}
}
val PARAMETER_DEFAULT_VALUE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val defaultValueElement = tree.defaultValue(node) ?: node
return markElement(defaultValueElement, startOffset, endOffset, tree, node)
}
}
val PARAMETERS_WITH_DEFAULT_VALUE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val newNodes = tree.valueParameters(node).filter { tree.defaultValue(it) != null }.takeIf(List<*>::isNotEmpty)
?: tree.valueParameterList(node)?.let(::listOf)
?: tree.nameIdentifier(node)?.let(::listOf)
?: listOf(node)
return newNodes.flatMap { markElement(it, startOffset, endOffset, tree, node) }
}
}
val PARAMETER_VARARG_MODIFIER: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val modifier = tree.modifierList(node)?.let { modifierList -> tree.findChildByType(modifierList, KtTokens.VARARG_KEYWORD) }
return markElement(modifier ?: node, startOffset, endOffset, tree, node)
}
}
val NAME_OF_NAMED_ARGUMENT: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return tree.findChildByType(node, KtNodeTypes.VALUE_ARGUMENT_NAME)?.let { valueArgumentName ->
markElement(valueArgumentName, startOffset, endOffset, tree, node)
} ?: markElement(node, startOffset, endOffset, tree, node)
}
}
val VALUE_ARGUMENTS_LIST: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure,
): List {
return markElement(
tree.findChildByType(node, KtNodeTypes.VALUE_ARGUMENT_LIST) ?: node,
startOffset,
endOffset,
tree,
node
)
}
}
val VALUE_ARGUMENTS: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
if (node.tokenType == KtNodeTypes.BINARY_EXPRESSION &&
tree.findDescendantByTypes(node, KtTokens.ALL_ASSIGNMENTS) != null
) {
val lhs = tree.firstChildExpression(node)
lhs?.let {
tree.unwrapParenthesesLabelsAndAnnotations(it).let { unwrapped ->
return markElement(unwrapped, startOffset, endOffset, tree, node)
}
}
}
val nodeToStart = when (node.tokenType) {
in QUALIFIED_ACCESS -> tree.findLastChildByType(node, KtNodeTypes.CALL_EXPRESSION) ?: node
KtNodeTypes.CLASS -> tree.findLastChildByType(node, KtNodeTypes.SUPER_TYPE_LIST) ?: node
else -> node
}
val argumentList = nodeToStart.takeIf { nodeToStart.tokenType == KtNodeTypes.VALUE_ARGUMENT_LIST }
?: tree.findChildByType(nodeToStart, KtNodeTypes.VALUE_ARGUMENT_LIST)
return when {
argumentList != null -> {
val rightParenthesis = tree.findLastChildByType(argumentList, RPAR)
?: return markElement(nodeToStart, startOffset, endOffset, tree, node)
val lastArgument = tree.findLastChildByType(argumentList, KtNodeTypes.VALUE_ARGUMENT)
if (lastArgument != null) {
markRange(lastArgument, rightParenthesis, startOffset, endOffset, tree, node)
} else {
val leftParenthesis = tree.findLastChildByType(argumentList, LPAR)
markRange(leftParenthesis?: nodeToStart, rightParenthesis, startOffset, endOffset, tree, node)
}
}
nodeToStart.tokenType == KtNodeTypes.CALL_EXPRESSION -> markElement(
tree.findChildByType(nodeToStart, KtNodeTypes.REFERENCE_EXPRESSION) ?: nodeToStart,
startOffset, endOffset, tree, node,
)
else -> markElement(nodeToStart, startOffset, endOffset, tree, node)
}
}
}
val DOT_BY_QUALIFIED: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
if (node.tokenType == KtNodeTypes.BINARY_EXPRESSION &&
tree.findDescendantByTypes(node, KtTokens.ALL_ASSIGNMENTS) != null
) {
tree.findDescendantByType(node, KtNodeTypes.DOT_QUALIFIED_EXPRESSION)?.let {
return markElement(tree.dotOperator(it) ?: it, startOffset, endOffset, tree, node)
}
}
if (node.tokenType == KtNodeTypes.DOT_QUALIFIED_EXPRESSION) {
return markElement(tree.dotOperator(node) ?: node, startOffset, endOffset, tree, node)
}
// Fallback to mark the callee reference.
return REFERENCE_BY_QUALIFIED.mark(node, startOffset, endOffset, tree)
}
}
val SELECTOR_BY_QUALIFIED: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
if (node.tokenType == KtNodeTypes.BINARY_EXPRESSION &&
tree.findDescendantByTypes(node, KtTokens.ALL_ASSIGNMENTS) != null
) {
tree.findExpressionDeep(node)?.let {
return mark(it, it.startOffset, it.endOffset, tree)
}
}
if (node.tokenType in KtTokens.QUALIFIED_ACCESS) {
val selector = tree.selector(node)
if (selector != null) {
return markElement(selector, startOffset, endOffset, tree, node)
}
return super.mark(node, startOffset, endOffset, tree)
}
if (node.tokenType == KtNodeTypes.IMPORT_DIRECTIVE) {
tree.collectDescendantsOfType(node, KtNodeTypes.REFERENCE_EXPRESSION).lastOrNull()?.let {
return mark(it, it.startOffset, it.endOffset, tree)
}
}
if (node.tokenType == KtNodeTypes.TYPE_REFERENCE) {
val typeElement = tree.findChildByType(node, KtTokenSets.TYPE_ELEMENT_TYPES)
if (typeElement != null) {
val referencedTypeExpression = tree.referencedTypeExpression(typeElement)
if (referencedTypeExpression != null) {
return markElement(referencedTypeExpression, startOffset, endOffset, tree, node)
}
}
}
return super.mark(node, startOffset, endOffset, tree)
}
}
private fun FlyweightCapableTreeStructure.referencedTypeExpression(node: LighterASTNode): LighterASTNode? {
return when (node.tokenType) {
KtNodeTypes.USER_TYPE -> findChildByType(node, KtNodeTypes.REFERENCE_EXPRESSION)
?: findChildByType(node, KtNodeTypes.ENUM_ENTRY_SUPERCLASS_REFERENCE_EXPRESSION)
KtNodeTypes.NULLABLE_TYPE -> findChildByType(node, KtTokenSets.TYPE_ELEMENT_TYPES)
?.let { referencedTypeExpression(it) }
else -> null
}
}
val FUN_INTERFACE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return when (node.tokenType) {
KtNodeTypes.CLASS -> FUN_MODIFIER.mark(node, startOffset, endOffset, tree)
KtNodeTypes.PROPERTY -> VAL_OR_VAR_NODE.mark(node, startOffset, endOffset, tree)
KtNodeTypes.FUN -> {
if (tree.typeParametersList(node) != null) {
TYPE_PARAMETERS_LIST.mark(node, startOffset, endOffset, tree)
} else {
SUSPEND_OR_FUN_MODIFIER.mark(node, startOffset, endOffset, tree)
}
}
else -> DEFAULT.mark(node, startOffset, endOffset, tree)
}
}
}
val REFERENCE_BY_QUALIFIED: LightTreePositioningStrategy = FindReferencePositioningStrategy(false)
val REFERENCED_NAME_BY_QUALIFIED: LightTreePositioningStrategy = FindReferencePositioningStrategy(true)
/**
* @param locateReferencedName see doc on [referenceExpression]
*/
class FindReferencePositioningStrategy(val locateReferencedName: Boolean) : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
if (node.tokenType == KtNodeTypes.BINARY_EXPRESSION) {
tree.findDescendantByTypes(node, KtTokens.AUGMENTED_ASSIGNMENTS)?.let {
return markElement(it, startOffset, endOffset, tree, node)
}
}
when {
node.tokenType == KtNodeTypes.BINARY_EXPRESSION && tree.findDescendantByType(node, KtTokens.EQ, followFunctions = false) != null -> {
// Look for reference in LHS of variable assignment.
tree.findExpressionDeep(node)?.let {
return markElement(it, startOffset, endOffset, tree, node)
}
}
node.tokenType == KtNodeTypes.CALL_EXPRESSION || node.tokenType == KtNodeTypes.CONSTRUCTOR_DELEGATION_CALL -> {
return markElement(tree.referenceExpression(node, locateReferencedName) ?: node, startOffset, endOffset, tree, node)
}
node.tokenType == KtNodeTypes.PROPERTY_DELEGATE -> {
return markElement(tree.findExpressionDeep(node) ?: node, startOffset, endOffset, tree, node)
}
node.tokenType == KtNodeTypes.ANNOTATION_ENTRY || node.tokenType == KtNodeTypes.SUPER_TYPE_CALL_ENTRY -> {
return markElement(
tree.findDescendantByType(node, KtNodeTypes.CONSTRUCTOR_CALLEE) ?: node,
startOffset,
endOffset,
tree,
node
)
}
node.tokenType in nodeTypesWithOperation -> {
return markElement(tree.operationReference(node) ?: node, startOffset, endOffset, tree, node)
}
node.tokenType == KtNodeTypes.TYPE_REFERENCE -> {
val nodeToMark =
tree.findChildByType(node, KtNodeTypes.NULLABLE_TYPE)
?.let { tree.findChildByType(it, KtNodeTypes.USER_TYPE) }
?: node
return markElement(nodeToMark, startOffset, endOffset, tree, node)
}
node.tokenType == KtNodeTypes.IMPORT_DIRECTIVE -> {
val nodeToMark = tree.findChildByType(node, KtTokenSets.INSIDE_DIRECTIVE_EXPRESSIONS) ?: node
return markElement(nodeToMark, startOffset, endOffset, tree, node)
}
node.tokenType == KtNodeTypes.CLASS || node.tokenType == KtNodeTypes.OBJECT_DECLARATION -> {
val nameIdentifier = tree.nameIdentifier(node)
if (nameIdentifier != null) {
val startElement = findStartingASTNodeForDeclarationName(tree, node)
return markRange(startElement, nameIdentifier, startOffset, endOffset, tree, node)
}
}
node.tokenType != KtNodeTypes.DOT_QUALIFIED_EXPRESSION &&
node.tokenType != KtNodeTypes.SAFE_ACCESS_EXPRESSION &&
node.tokenType != KtNodeTypes.CALLABLE_REFERENCE_EXPRESSION -> {
return super.mark(node, startOffset, endOffset, tree)
}
}
val selector = tree.selector(node)
if (selector != null) {
when (selector.tokenType) {
KtNodeTypes.REFERENCE_EXPRESSION ->
return markElement(selector, startOffset, endOffset, tree, node)
KtNodeTypes.CALL_EXPRESSION, KtNodeTypes.CONSTRUCTOR_DELEGATION_CALL, KtNodeTypes.SUPER_TYPE_CALL_ENTRY ->
return markElement(
tree.referenceExpression(selector, locateReferencedName) ?: selector,
startOffset,
endOffset,
tree,
node
)
}
}
return super.mark(node, startOffset, endOffset, tree)
}
}
private val nodeTypesWithOperation = setOf(
KtNodeTypes.IS_EXPRESSION,
KtNodeTypes.BINARY_WITH_TYPE,
KtNodeTypes.BINARY_EXPRESSION,
KtNodeTypes.POSTFIX_EXPRESSION,
KtNodeTypes.PREFIX_EXPRESSION,
KtNodeTypes.BINARY_EXPRESSION,
KtNodeTypes.WHEN_CONDITION_IN_RANGE
)
val WHEN_EXPRESSION = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return markElement(tree.whenKeyword(node) ?: node, startOffset, endOffset, tree, node)
}
}
val WHEN_GUARD = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return markElement(tree.findChildByType(node, KtNodeTypes.WHEN_ENTRY_GUARD) ?: node, startOffset, endOffset, tree, node)
}
}
val IF_EXPRESSION = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return markElement(tree.ifKeyword(node) ?: node, startOffset, endOffset, tree, node)
}
}
val ELSE_ENTRY = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return markElement(tree.elseKeyword(node) ?: node, startOffset, endOffset, tree, node)
}
}
val ARRAY_ACCESS = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return markElement(tree.findChildByType(node, KtNodeTypes.INDICES)!!, startOffset, endOffset, tree, node)
}
}
val SAFE_ACCESS = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return markElement(tree.safeAccess(node) ?: node, startOffset, endOffset, tree, node)
}
}
private val OPERATION_TO_END = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return markRange(tree.operationReference(node) ?: node, tree.lastChild(node) ?: node, startOffset, endOffset, tree, node)
}
}
val AS_TYPE = OPERATION_TO_END
val USELESS_ELVIS = OPERATION_TO_END
val RETURN_WITH_LABEL = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val labeledExpression = tree.findChildByType(node, KtNodeTypes.LABEL_QUALIFIER)
if (labeledExpression != null) {
return markRange(node, labeledExpression, startOffset, endOffset, tree, node)
}
return markElement(tree.returnKeyword(node) ?: node, startOffset, endOffset, tree, node)
}
}
val WHOLE_ELEMENT = object : LightTreePositioningStrategy() {}
val LONG_LITERAL_SUFFIX = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
if (node.tokenType == KtNodeTypes.INTEGER_CONSTANT) {
return listOf(TextRange.create(endOffset - 1, endOffset))
}
return super.mark(node, startOffset, endOffset, tree)
}
}
val REIFIED_MODIFIER: LightTreePositioningStrategy =
ModifierSetBasedLightTreePositioningStrategy(KtTokens.REIFIED_KEYWORD)
val TYPE_PARAMETERS_LIST: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return markElement(tree.typeParametersList(node) ?: node, startOffset, endOffset, tree, node)
}
}
val NAME_IDENTIFIER: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val nameIdentifier = tree.nameIdentifier(node)
if (nameIdentifier != null) {
return markElement(nameIdentifier, startOffset, endOffset, tree, node)
}
if (node.tokenType == KtNodeTypes.LABEL_QUALIFIER) {
return super.mark(node, startOffset, endOffset - 1, tree)
}
if (node.tokenType == KtNodeTypes.PACKAGE_DIRECTIVE) {
node.getChildren(tree).lastOrNull()?.let {
return markElement(it, startOffset, endOffset, tree, node)
}
}
return DEFAULT.mark(node, startOffset, endOffset, tree)
}
}
val REDUNDANT_NULLABLE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val ref = Ref>()
var child: LighterASTNode? = node
var lastQuest: LighterASTNode? = null
var prevQuest: LighterASTNode? = null
var quest: LighterASTNode? = null
while (child != null) {
child = getNullableChild(tree, child, ref)
prevQuest = quest
quest = ref.get().elementAtOrNull(1)
if (lastQuest == null) {
lastQuest = quest
}
}
return markRange(prevQuest ?: lastQuest ?: node, lastQuest ?: node, startOffset, endOffset, tree, node)
}
private fun getNullableChild(
tree: FlyweightCapableTreeStructure,
node: LighterASTNode,
ref: Ref>
): LighterASTNode? {
tree.getChildren(node, ref)
val firstChild = ref.get().firstOrNull() ?: return null
return if (firstChild.tokenType != KtNodeTypes.NULLABLE_TYPE) null else firstChild
}
}
val QUESTION_MARK_BY_TYPE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
if (node.tokenType == KtNodeTypes.TYPE_REFERENCE) {
val typeElement = tree.findChildByType(node, KtNodeTypes.NULLABLE_TYPE)
if (typeElement != null) {
val question = tree.findChildByType(typeElement, KtTokens.QUEST)
if (question != null) {
return markElement(question, startOffset, endOffset, tree, node)
}
}
}
return super.mark(node, startOffset, endOffset, tree)
}
}
val ANNOTATION_USE_SITE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val useSiteTarget = tree.findChildByType(node, KtNodeTypes.ANNOTATION_TARGET)
if (useSiteTarget != null) {
return markElement(useSiteTarget, startOffset, endOffset, tree, node)
}
return super.mark(node, startOffset, endOffset, tree)
}
}
val IMPORT_LAST_NAME: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val nodeToMark = tree.collectDescendantsOfType(node, KtNodeTypes.REFERENCE_EXPRESSION).lastOrNull() ?: node
return markElement(nodeToMark, startOffset, endOffset, tree, node)
}
}
val IMPORT_LAST_BUT_ONE_NAME: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val references = tree.collectDescendantsOfType(node, KtNodeTypes.REFERENCE_EXPRESSION)
val nodeToMark = references.elementAtOrNull(references.size - 2) ?: node
return markElement(nodeToMark, startOffset, endOffset, tree, node)
}
}
val IMPORT_ALIAS: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
tree.findChildByType(node, KtNodeTypes.IMPORT_ALIAS)?.let {
tree.findChildByType(it, KtTokens.IDENTIFIER)?.let {
return markElement(it, startOffset, endOffset, tree, node)
}
}
return IMPORT_LAST_NAME.mark(node, startOffset, endOffset, tree)
}
}
val SPREAD_OPERATOR: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return super.mark(node, startOffset, startOffset + 1, tree)
}
}
val DECLARATION_WITH_BODY: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val blockNode =
if (node.tokenType != KtNodeTypes.BLOCK) tree.findChildByType(node, KtNodeTypes.BLOCK)
else node
val bracket = tree.findLastChildByType(blockNode ?: node, KtTokens.RBRACE)
return when {
bracket != null -> markElement(bracket, startOffset, endOffset, tree, node)
blockNode != null -> markElement(blockNode, startOffset, endOffset, tree, node).map(::lastSymbol)
else -> super.mark(node, startOffset, endOffset, tree)
}
}
//body of block node is in the separate tree, so here is hack - mark last symbol of block
private fun lastSymbol(range: TextRange): TextRange =
if (range.isEmpty) range else TextRange.create(range.endOffset - 1, range.endOffset)
}
val UNREACHABLE_CODE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun markKtDiagnostic(element: KtSourceElement, diagnostic: KtDiagnostic): List {
@Suppress("UNCHECKED_CAST")
val typed = diagnostic as KtDiagnosticWithParameters2, Set>
with(UnreachableCodeLightTreeHelper(element.treeStructure)) {
val reachable = typed.a.map { it.lighterASTNode }.toSet()
val unreachable = typed.b.map { it.lighterASTNode }.toSet()
if (!element.lighterASTNode.hasChildrenInSet(reachable)) {
return super.markKtDiagnostic(element, diagnostic)
}
val nodesToMark = element.lighterASTNode.getLeavesOrReachableChildren(reachable, unreachable)
.removeReachableElementsWithMeaninglessSiblings(reachable)
if (nodesToMark.isEmpty()) {
return super.markKtDiagnostic(element, diagnostic)
}
val ranges = nodesToMark.flatMap {
markElement(it, element.startOffset, element.endOffset, element.treeStructure, element.lighterASTNode)
}
return ranges.mergeAdjacentTextRanges()
}
}
}
val NOT_SUPPORTED_IN_INLINE_MOST_RELEVANT: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val nodeToMark = when (node.tokenType) {
KtNodeTypes.CLASS ->
tree.findChildByType(node, KtTokens.CLASS_KEYWORD)
KtNodeTypes.OBJECT_DECLARATION ->
tree.findChildByType(node, KtTokens.OBJECT_KEYWORD)
KtNodeTypes.FUN ->
tree.inlineModifier(node) ?: tree.findChildByType(node, KtTokens.FUN_KEYWORD)
else -> node
}
return markElement(nodeToMark ?: node, startOffset, endOffset, tree, node)
}
}
val LABEL: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val nodeToMark = tree.findChildByType(node, KtNodeTypes.LABEL_QUALIFIER) ?: node
return markElement(nodeToMark, startOffset, endOffset, tree, node)
}
}
val COMMAS: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
return buildList {
val childrenRef = Ref>()
tree.getChildren(node, childrenRef)
for (child in childrenRef.get()) {
if (child != null && child.tokenType == KtTokens.COMMA) {
add(markSingleElement(child, child, startOffset, endOffset, tree, node))
}
}
}
}
override fun isValid(node: LighterASTNode, tree: FlyweightCapableTreeStructure): Boolean = true
}
val NON_FINAL_MODIFIER_OR_NAME: LightTreePositioningStrategy = ModifierSetBasedLightTreePositioningStrategy(
TokenSet.create(
KtTokens.ABSTRACT_KEYWORD,
KtTokens.OPEN_KEYWORD,
KtTokens.SEALED_KEYWORD
)
)
val DELEGATED_SUPERTYPE_BY_KEYWORD: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val parent = tree.getParent(node)
if (parent == null || parent.tokenType != KtNodeTypes.DELEGATED_SUPER_TYPE_ENTRY) {
return super.mark(node, startOffset, endOffset, tree)
}
val byKeyword = parent.getChildren(tree).firstOrNull { it.tokenType == KtTokens.BY_KEYWORD } ?: node
return markElement(byKeyword, startOffset, endOffset, tree, node)
}
}
val CALL_ELEMENT_WITH_DOT: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val callElementRanges = SELECTOR_BY_QUALIFIED.mark(node, startOffset, endOffset, tree)
val callElementRange = when (callElementRanges.size) {
1 -> callElementRanges.first()
else -> return callElementRanges
}
val dotRanges = SAFE_ACCESS.mark(node, startOffset, endOffset, tree)
val dotRange = when (dotRanges.size) {
1 -> dotRanges.first()
else -> return dotRanges
}
return listOf(TextRange(dotRange.startOffset, callElementRange.endOffset))
}
}
val TYPEALIAS_TYPE_REFERENCE: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val nodeToMark = tree.findChildByType(node, KtNodeTypes.TYPE_REFERENCE) ?: node
return markElement(nodeToMark, startOffset, endOffset, tree, node)
}
}
val SUPERTYPE_INITIALIZED_IN_EXPECTED_CLASS_DIAGNOSTIC: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val nodeToMark = when (node.tokenType) {
KtNodeTypes.ENUM_ENTRY -> {
tree.findChildByType(node, KtNodeTypes.INITIALIZER_LIST) ?: node
}
KtNodeTypes.TYPE_REFERENCE -> {
val valueArgList = node.getParentIfTypeIs(KtNodeTypes.CONSTRUCTOR_CALLEE, tree)
?.getParentIfTypeIs(KtNodeTypes.SUPER_TYPE_CALL_ENTRY, tree)
?.let { tree.findChildByType(it, KtNodeTypes.VALUE_ARGUMENT_LIST) }
valueArgList ?: node
}
else -> node
}
return markElement(nodeToMark, startOffset, endOffset, tree, node)
}
}
val TYPE_ARGUMENT_LIST_OR_SELF: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure,
): List {
val nodeToMark = tree.findChildByType(node, KtNodeTypes.TYPE_ARGUMENT_LIST) ?: node
return markElement(nodeToMark, startOffset, endOffset, tree, node)
}
}
val PACKAGE_DIRECTIVE_NAME_EXPRESSION: LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
if (node.tokenType == KtNodeTypes.PACKAGE_DIRECTIVE) {
val expression = tree.findChildByType(node, KtNodeTypes.DOT_QUALIFIED_EXPRESSION) ?: node
return super.mark(expression, expression.startOffset, expression.endOffset, tree)
}
return super.mark(node, startOffset, endOffset, tree)
}
}
}
fun KtSourceElement.hasValOrVar(): Boolean =
treeStructure.valOrVarKeyword(lighterASTNode) != null
fun KtSourceElement.hasVar(): Boolean =
treeStructure.findChildByType(lighterASTNode, KtTokens.VAR_KEYWORD) != null
fun KtSourceElement.hasPrimaryConstructor(): Boolean =
treeStructure.primaryConstructor(lighterASTNode) != null
private fun FlyweightCapableTreeStructure.companionKeyword(node: LighterASTNode): LighterASTNode? =
modifierList(node)?.let { findChildByType(it, KtTokens.COMPANION_KEYWORD) }
private fun FlyweightCapableTreeStructure.constructorKeyword(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.CONSTRUCTOR_KEYWORD)
private fun FlyweightCapableTreeStructure.dotOperator(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.DOT)
private fun FlyweightCapableTreeStructure.safeAccess(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.SAFE_ACCESS)
private fun FlyweightCapableTreeStructure.initKeyword(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.INIT_KEYWORD)
private fun FlyweightCapableTreeStructure.whenKeyword(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.WHEN_KEYWORD)
private fun FlyweightCapableTreeStructure.ifKeyword(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.IF_KEYWORD)
private fun FlyweightCapableTreeStructure.elseKeyword(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.ELSE_KEYWORD)
private fun FlyweightCapableTreeStructure.returnKeyword(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.RETURN_KEYWORD)
private fun FlyweightCapableTreeStructure.fieldKeyword(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.FIELD_KEYWORD)
private fun FlyweightCapableTreeStructure.byKeyword(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.BY_KEYWORD)
fun FlyweightCapableTreeStructure.nameIdentifier(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.IDENTIFIER)
private fun FlyweightCapableTreeStructure.operationReference(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtNodeTypes.OPERATION_REFERENCE)
private val EXPRESSIONS_SET = listOf(
KtNodeTypes.REFERENCE_EXPRESSION,
KtNodeTypes.DOT_QUALIFIED_EXPRESSION,
KtNodeTypes.LAMBDA_EXPRESSION,
KtNodeTypes.FUN
)
fun LighterASTNode.isExpression(): Boolean {
return when (this.tokenType) {
is KtNodeType,
is KtConstantExpressionElementType,
is KtStringTemplateExpressionElementType,
in EXPRESSIONS_SET -> true
else -> false
}
}
fun FlyweightCapableTreeStructure.getChildrenArray(node: LighterASTNode): Array {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get() ?: emptyArray()
}
/**
* @param locateReferencedName whether to remove any nested parentheses while locating the reference element. This is useful for diagnostics
* on super and unresolved references. For example, with the following, only the part inside the parentheses should be highlighted.
*
* ```
* fun foo() {
* (super)()
* ^^^^^
* (random123)()
* ^^^^^^^^^
* }
* ```
*/
private fun FlyweightCapableTreeStructure.referenceExpression(
node: LighterASTNode,
locateReferencedName: Boolean
): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
var result = childrenRef.get()?.firstOrNull {
it?.isExpression() == true || it?.tokenType == KtNodeTypes.PARENTHESIZED
}
while (locateReferencedName && result != null && result.tokenType == KtNodeTypes.PARENTHESIZED) {
result = referenceExpression(result, locateReferencedName = true)
}
return result
}
fun FlyweightCapableTreeStructure.unwrapParenthesesLabelsAndAnnotations(node: LighterASTNode): LighterASTNode {
var unwrapped = node
while (true) {
unwrapped = when (unwrapped.tokenType) {
KtNodeTypes.PARENTHESIZED -> firstChildExpression(unwrapped) ?: return unwrapped
KtNodeTypes.LABELED_EXPRESSION -> lastChildExpression(unwrapped) ?: return unwrapped
KtNodeTypes.ANNOTATED_EXPRESSION -> firstChildExpression(unwrapped) ?: return unwrapped
else -> return unwrapped
}
}
}
private fun FlyweightCapableTreeStructure.findExpressionDeep(node: LighterASTNode): LighterASTNode? =
findFirstDescendant(node) { it.isExpression() }
private fun FlyweightCapableTreeStructure.rightParenthesis(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.RPAR)
private fun FlyweightCapableTreeStructure.objectKeyword(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtTokens.OBJECT_KEYWORD)
fun FlyweightCapableTreeStructure.valOrVarKeyword(node: LighterASTNode): LighterASTNode? =
findChildByType(node, VAL_VAR_TOKEN_SET)
fun FlyweightCapableTreeStructure.visibilityModifier(declaration: LighterASTNode): LighterASTNode? =
modifierList(declaration)?.let { findChildByType(it, VISIBILITY_MODIFIERS) }
fun FlyweightCapableTreeStructure.modalityModifier(declaration: LighterASTNode): LighterASTNode? =
modifierList(declaration)?.let { findChildByType(it, MODALITY_MODIFIERS) }
fun FlyweightCapableTreeStructure.overrideModifier(declaration: LighterASTNode): LighterASTNode? =
modifierList(declaration)?.let { findChildByType(it, KtTokens.OVERRIDE_KEYWORD) }
fun FlyweightCapableTreeStructure.inlineModifier(declaration: LighterASTNode): LighterASTNode? =
modifierList(declaration)?.let { findChildByType(it, INLINE_KEYWORD) }
fun FlyweightCapableTreeStructure.typeParametersList(declaration: LighterASTNode): LighterASTNode? =
findChildByType(declaration, KtNodeTypes.TYPE_PARAMETER_LIST)
fun FlyweightCapableTreeStructure.annotations(node: LighterASTNode): List? {
val typeReference = findChildByType(node, KtNodeTypes.TYPE_REFERENCE) ?: return null
val modifiers = modifierList(typeReference) ?: return null
return collectDescendantsOfType(modifiers, KtNodeTypes.ANNOTATION_ENTRY)
}
fun FlyweightCapableTreeStructure.userType(node: LighterASTNode): LighterASTNode? {
val typeReference = findChildByType(node, KtNodeTypes.TYPE_REFERENCE) ?: return null
return findChildByType(typeReference, KtNodeTypes.USER_TYPE)
}
private fun FlyweightCapableTreeStructure.supertypesList(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtNodeTypes.SUPER_TYPE_LIST)
private fun FlyweightCapableTreeStructure.getter(node: LighterASTNode): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.firstOrNull {
it != null && it.tokenType == KtNodeTypes.PROPERTY_ACCESSOR && findChildByType(it, GET_KEYWORD) != null
}
}
private fun FlyweightCapableTreeStructure.setter(node: LighterASTNode): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.firstOrNull {
it != null && it.tokenType == KtNodeTypes.PROPERTY_ACCESSOR && findChildByType(it, SET_KEYWORD) != null
}
}
private fun FlyweightCapableTreeStructure.accessorNamePlaceholder(node: LighterASTNode): LighterASTNode =
findChildByType(node, KtTokens.GET_KEYWORD) ?: findChildByType(node, KtTokens.SET_KEYWORD)!!
private fun FlyweightCapableTreeStructure.modifierList(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtNodeTypes.MODIFIER_LIST)
private fun FlyweightCapableTreeStructure.primaryConstructor(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtNodeTypes.PRIMARY_CONSTRUCTOR)
private fun FlyweightCapableTreeStructure.valueParameterList(node: LighterASTNode): LighterASTNode? =
findChildByType(node, KtNodeTypes.VALUE_PARAMETER_LIST)
private fun FlyweightCapableTreeStructure.valueParameters(node: LighterASTNode): List =
valueParameterList(node)?.let { findChildrenByType(it, KtNodeTypes.VALUE_PARAMETER) }.orEmpty()
private fun FlyweightCapableTreeStructure.typeReference(node: LighterASTNode): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.filterNotNull()?.dropWhile { it.tokenType != KtTokens.COLON }?.firstOrNull {
it.tokenType == KtNodeTypes.TYPE_REFERENCE
}
}
private fun FlyweightCapableTreeStructure.receiverTypeReference(node: LighterASTNode): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.filterNotNull()?.firstOrNull {
if (it.tokenType == KtTokens.COLON || it.tokenType == KtTokens.LPAR) return null
it.tokenType == KtNodeTypes.TYPE_REFERENCE
}
}
private fun keywordStrategy(
keywordExtractor: FlyweightCapableTreeStructure.(LighterASTNode) -> LighterASTNode?
): LightTreePositioningStrategy = object : LightTreePositioningStrategy() {
override fun mark(
node: LighterASTNode,
startOffset: Int,
endOffset: Int,
tree: FlyweightCapableTreeStructure
): List {
val fieldKeyword = tree.keywordExtractor(node)
if (fieldKeyword != null) {
return markElement(fieldKeyword, startOffset, endOffset, tree, node)
}
return LightTreePositioningStrategies.DEFAULT.mark(node, startOffset, endOffset, tree)
}
override fun isValid(node: LighterASTNode, tree: FlyweightCapableTreeStructure): Boolean {
return tree.keywordExtractor(node) != null
}
}
private fun FlyweightCapableTreeStructure.defaultValue(node: LighterASTNode): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
// p : T = v
val children = childrenRef.get()?.reversed() ?: return null
for (child in children) {
if (child == null || child.tokenType == KtTokens.WHITE_SPACE) continue
if (child.tokenType == KtNodeTypes.TYPE_REFERENCE || child.tokenType == KtTokens.COLON) return null
return child
}
return null
}
fun FlyweightCapableTreeStructure.selector(node: LighterASTNode): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
val children = childrenRef.get() ?: return null
var dotOrDoubleColonFound = false
for (child in children) {
if (child == null) continue
val tokenType = child.tokenType
if (tokenType == KtTokens.DOT || tokenType == KtTokens.COLONCOLON || tokenType == KtTokens.SAFE_ACCESS) {
dotOrDoubleColonFound = true
continue
}
if (dotOrDoubleColonFound && child.isExpression()) {
return child
}
}
return null
}
fun FlyweightCapableTreeStructure.firstChildExpression(node: LighterASTNode): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.firstOrNull { it?.isExpression() == true }
}
fun FlyweightCapableTreeStructure.lastChildExpression(node: LighterASTNode): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.lastOrNull { it?.isExpression() == true }
}
fun FlyweightCapableTreeStructure.findChildByType(node: LighterASTNode, type: IElementType): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.firstOrNull { it?.tokenType == type }
}
fun FlyweightCapableTreeStructure.findChildrenByType(node: LighterASTNode, type: IElementType): List {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.filter { it?.tokenType == type }?.filterNotNull().orEmpty()
}
fun FlyweightCapableTreeStructure.findLastChildByType(node: LighterASTNode, type: IElementType): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.lastOrNull { it?.tokenType == type }
}
fun FlyweightCapableTreeStructure.findDescendantByType(
node: LighterASTNode,
type: IElementType,
followFunctions: Boolean = true
): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.firstOrNull { it?.tokenType == type } ?: childrenRef.get()
?.firstNotNullOfOrNull { child ->
runUnless(!followFunctions && child?.tokenType == KtNodeTypes.FUN) {
child?.let { findDescendantByType(it, type, followFunctions) }
}
}
}
fun FlyweightCapableTreeStructure.findDescendantByTypes(node: LighterASTNode, types: TokenSet): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.firstOrNull { types.contains(it?.tokenType) } ?: childrenRef.get()
?.firstNotNullOfOrNull { child -> child?.let { findDescendantByTypes(it, types) } }
}
fun FlyweightCapableTreeStructure.findFirstDescendant(
node: LighterASTNode,
predicate: (LighterASTNode) -> Boolean
): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
val nodes = childrenRef.get()
return nodes?.firstOrNull { it != null && predicate(it) }
?: nodes?.firstNotNullOfOrNull { child -> child?.let { findFirstDescendant(it, predicate) } }
}
fun FlyweightCapableTreeStructure.findLastDescendant(
node: LighterASTNode,
predicate: (LighterASTNode) -> Boolean
): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
val nodes = childrenRef.get()
return nodes?.lastOrNull { it != null && predicate(it) }
?: run {
for (child in nodes.reversed()) {
val result = child?.let { findLastDescendant(it, predicate) }
if (result != null) {
return result
}
}
return null
}
}
fun FlyweightCapableTreeStructure.collectDescendantsOfType(
node: LighterASTNode, type: IElementType,
predicate: (LighterASTNode) -> Boolean = { true }
): List {
val result = mutableListOf()
fun FlyweightCapableTreeStructure.collectDescendantByType(node: LighterASTNode) {
val childrenRef = Ref>()
getChildren(node, childrenRef)
val childrenRefGet = childrenRef.get()
if (childrenRefGet != null) {
for (child in childrenRefGet) {
if (child?.tokenType == type && predicate(child)) {
result.add(child)
}
if (child != null) {
collectDescendantByType(child)
}
}
}
}
collectDescendantByType(node)
return result
}
fun FlyweightCapableTreeStructure.traverseDescendants(
node: LighterASTNode,
acceptor: (LighterASTNode) -> Boolean
) {
fun FlyweightCapableTreeStructure.traverse(node: LighterASTNode) {
val childrenRef = Ref>()
getChildren(node, childrenRef)
val childrenRefGet = childrenRef.get()
if (childrenRefGet != null) {
for (child in childrenRefGet) {
if (child != null) {
if (acceptor(child)) {
traverse(child)
}
}
}
}
}
traverse(node)
}
fun FlyweightCapableTreeStructure.findChildByType(node: LighterASTNode, type: TokenSet): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.firstOrNull { it?.tokenType in type }
}
private fun FlyweightCapableTreeStructure.findParentOfType(
node: LighterASTNode,
type: IElementType,
strict: Boolean = true
): LighterASTNode? {
if (!strict && node.tokenType == type) return node
var parent = getParent(node)
while (parent != null) {
if (parent.tokenType == type) return parent
parent = getParent(parent)
}
return null
}
fun FlyweightCapableTreeStructure.getAncestors(node: LighterASTNode): Sequence =
generateSequence(getParent(node)) { getParent(it) }
private fun FlyweightCapableTreeStructure.firstChild(node: LighterASTNode): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get()?.firstOrNull()
}
private fun FlyweightCapableTreeStructure.lastChild(node: LighterASTNode): LighterASTNode? {
val childrenRef = Ref>()
getChildren(node, childrenRef)
return childrenRef.get().lastOrNull { it != null }
}
private fun LighterASTNode.getParentIfTypeIs(
tokenType: IElementType,
tree: FlyweightCapableTreeStructure,
): LighterASTNode? {
return tree.getParent(this)?.takeIf { it.tokenType == tokenType }
}