All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.jetbrains.kotlin.diagnostics.PositioningStrategies.kt Maven / Gradle / Ivy
/*
* Copyright 2010-2020 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.openapi.util.TextRange
import com.intellij.psi.PsiComment
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiNameIdentifierOwner
import com.intellij.psi.PsiWhiteSpace
import com.intellij.psi.tree.TokenSet
import org.jetbrains.kotlin.KtNodeTypes
import org.jetbrains.kotlin.cfg.UnreachableCode
import org.jetbrains.kotlin.diagnostics.Errors.ACTUAL_WITHOUT_EXPECT
import org.jetbrains.kotlin.diagnostics.Errors.NO_ACTUAL_FOR_EXPECT
import org.jetbrains.kotlin.lexer.KtModifierKeywordToken
import org.jetbrains.kotlin.lexer.KtTokens
import org.jetbrains.kotlin.psi.*
import org.jetbrains.kotlin.psi.psiUtil.*
import org.jetbrains.kotlin.resolve.multiplatform.ExpectedActualResolver.Compatibility.Incompatible
import org.jetbrains.kotlin.resolve.multiplatform.ExpectedActualResolver.Compatibility.Incompatible.*
import org.jetbrains.kotlin.utils.sure
object PositioningStrategies {
private open class DeclarationHeader : PositioningStrategy() {
override fun isValid(element: T): Boolean {
if (element is KtNamedDeclaration &&
element !is KtObjectDeclaration &&
element !is KtSecondaryConstructor &&
element !is KtFunction
) {
if (element.nameIdentifier == null) {
return false
}
}
return super.isValid(element)
}
}
@JvmField
val DEFAULT: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: PsiElement): List {
when (element) {
is KtObjectLiteralExpression -> {
val objectDeclaration = element.objectDeclaration
val objectKeyword = objectDeclaration.getObjectKeyword()!!
val delegationSpecifierList = objectDeclaration.getSuperTypeList() ?: return markElement(objectKeyword)
return markRange(objectKeyword, delegationSpecifierList)
}
is KtObjectDeclaration -> {
return markRange(
element.getObjectKeyword()!!,
element.nameIdentifier ?: element.getObjectKeyword()!!
)
}
is KtConstructorDelegationCall -> {
return SECONDARY_CONSTRUCTOR_DELEGATION_CALL.mark(element)
}
else -> {
return super.mark(element)
}
}
}
}
@JvmField
val DECLARATION_RETURN_TYPE: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtDeclaration): List {
return markElement(getElementToMark(element))
}
override fun isValid(element: KtDeclaration): Boolean {
return !hasSyntaxErrors(getElementToMark(element))
}
private fun getElementToMark(declaration: KtDeclaration): PsiElement {
val (returnTypeRef, nameIdentifierOrPlaceholder) = when (declaration) {
is KtCallableDeclaration -> Pair(declaration.typeReference, declaration.nameIdentifier)
is KtPropertyAccessor -> Pair(declaration.returnTypeReference, declaration.namePlaceholder)
else -> Pair(null, null)
}
if (returnTypeRef != null) return returnTypeRef
if (nameIdentifierOrPlaceholder != null) return nameIdentifierOrPlaceholder
return declaration
}
}
@JvmField
val ACTUAL_DECLARATION_NAME: PositioningStrategy = object : DeclarationHeader() {
override fun mark(element: KtNamedDeclaration): List {
val nameIdentifier = element.nameIdentifier
return when {
nameIdentifier != null -> markElement(nameIdentifier)
element is KtNamedFunction -> DECLARATION_SIGNATURE.mark(element)
else -> DEFAULT.mark(element)
}
}
}
private val ParametrizedDiagnostic.firstIncompatibility: Incompatible?
get() {
val map = when (factory) {
NO_ACTUAL_FOR_EXPECT ->
NO_ACTUAL_FOR_EXPECT.cast(this).c
ACTUAL_WITHOUT_EXPECT ->
ACTUAL_WITHOUT_EXPECT.cast(this).b
else ->
return null
}
return map.keys.firstOrNull()
}
private val propertyKindTokens = TokenSet.create(KtTokens.VAL_KEYWORD, KtTokens.VAR_KEYWORD)
private val classKindTokens = TokenSet.create(KtTokens.CLASS_KEYWORD, KtTokens.OBJECT_KEYWORD, KtTokens.INTERFACE_KEYWORD)
@JvmField
val INCOMPATIBLE_DECLARATION: PositioningStrategy = object : DeclarationHeader() {
override fun markDiagnostic(diagnostic: ParametrizedDiagnostic): List {
val element = diagnostic.psiElement
val callableDeclaration = element as? KtCallableDeclaration
val incompatibility = diagnostic.firstIncompatibility
return when (incompatibility) {
null, Unknown, is ClassScopes, EnumEntries -> null
ClassKind -> {
val startElement =
element.modifierList?.getModifier(KtTokens.ENUM_KEYWORD)
?: element.modifierList?.getModifier(KtTokens.ANNOTATION_KEYWORD)
val endElement =
element.node.findChildByType(classKindTokens)?.psi
?: element.nameIdentifier
if (startElement != null && endElement != null) {
return markRange(startElement, endElement)
} else {
endElement
}
}
TypeParameterNames, TypeParameterCount,
TypeParameterUpperBounds, TypeParameterVariance, TypeParameterReified -> {
(element as? KtTypeParameterListOwner)?.typeParameterList
}
CallableKind -> {
(callableDeclaration as? KtNamedFunction)?.funKeyword
?: (callableDeclaration as? KtProperty)?.valOrVarKeyword
}
ParameterShape -> {
callableDeclaration?.let { it.receiverTypeReference ?: it.valueParameterList }
}
ParameterCount, ParameterTypes, ParameterNames,
ValueParameterVararg, ValueParameterNoinline, ValueParameterCrossinline -> {
callableDeclaration?.valueParameterList
}
ReturnType -> {
callableDeclaration?.typeReference
}
FunctionModifiersDifferent, FunctionModifiersNotSubset,
PropertyModifiers, ClassModifiers -> {
element.modifierList
}
PropertyKind -> {
element.node.findChildByType(propertyKindTokens)?.psi
}
Supertypes -> {
(element as? KtClassOrObject)?.getSuperTypeList()
}
Modality -> {
element.modalityModifier()
}
Visibility -> {
element.visibilityModifier()
}
}?.let { markElement(it) } ?: ACTUAL_DECLARATION_NAME.mark(element)
}
}
@JvmField
val DECLARATION_START_TO_NAME: PositioningStrategy = object : DeclarationHeader() {
private fun PsiElement.firstNonCommentNonAnnotationLeaf(): PsiElement? {
var child: PsiElement? = firstChild ?: return this // this is leaf
while (true) {
if (child is PsiComment || child is PsiWhiteSpace || child is KtAnnotationEntry) {
child = child.nextSibling
continue
}
if (child == null) return null // no children of accepted type in this
val leaf = child.firstNonCommentNonAnnotationLeaf()
if (leaf == null) {
child = child.nextSibling
continue
}
return leaf
}
}
override fun mark(element: KtDeclaration): List {
val startElement = element.firstNonCommentNonAnnotationLeaf() ?: element
val nameIdentifier = (element as? KtNamedDeclaration)?.nameIdentifier
return if (nameIdentifier != null) {
markRange(startElement, nameIdentifier)
} else when (element) {
// companion object/constructors without name
is KtConstructor<*> -> {
markRange(startElement, element.getConstructorKeyword() ?: element)
}
is KtObjectDeclaration -> {
markRange(startElement, element.getObjectKeyword() ?: element)
}
else -> DEFAULT.mark(element)
}
}
}
@JvmField
val DECLARATION_NAME: PositioningStrategy = object : DeclarationHeader() {
override fun mark(element: KtNamedDeclaration): List {
val nameIdentifier = element.nameIdentifier
if (nameIdentifier != null) {
if (element is KtClassOrObject) {
val startElement =
element.getModifierList()?.getModifier(KtTokens.ENUM_KEYWORD)
?: element.node.findChildByType(TokenSet.create(KtTokens.CLASS_KEYWORD, KtTokens.OBJECT_KEYWORD))?.psi
?: element
return markRange(startElement, nameIdentifier)
}
return markElement(nameIdentifier)
}
if (element is KtNamedFunction) {
return DECLARATION_SIGNATURE.mark(element)
}
return DEFAULT.mark(element)
}
}
@JvmField
val DECLARATION_SIGNATURE: PositioningStrategy = object : DeclarationHeader() {
override fun mark(element: KtDeclaration): List {
when (element) {
is KtConstructor<*> -> {
val begin = element.getConstructorKeyword() ?: element.getValueParameterList() ?: return markElement(element)
val end = element.getValueParameterList() ?: element.getConstructorKeyword() ?: return markElement(element)
return markRange(begin, end)
}
is KtFunction -> {
val endOfSignatureElement =
element.typeReference
?: element.valueParameterList
?: element.nameIdentifier
?: element
val startElement = if (element is KtFunctionLiteral) {
element.getReceiverTypeReference()
?: element.getValueParameterList()
?: element
} else element
return markRange(startElement, endOfSignatureElement)
}
is KtProperty -> {
val endOfSignatureElement = element.typeReference ?: element.nameIdentifier ?: element
return markRange(element, endOfSignatureElement)
}
is KtPropertyAccessor -> {
val endOfSignatureElement =
element.returnTypeReference
?: element.rightParenthesis
?: element.namePlaceholder
return markRange(element, endOfSignatureElement)
}
is KtClass -> {
val nameAsDeclaration = element.nameIdentifier ?: return markElement(element)
val primaryConstructorParameterList =
element.getPrimaryConstructorParameterList() ?: return markElement(nameAsDeclaration)
return markRange(nameAsDeclaration, primaryConstructorParameterList)
}
is KtObjectDeclaration -> {
return DECLARATION_NAME.mark(element)
}
is KtClassInitializer -> {
return markRange(element.initKeyword.textRange)
}
}
return super.mark(element)
}
}
@JvmField
val DECLARATION_SIGNATURE_OR_DEFAULT: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: PsiElement): List {
return if (element is KtDeclaration)
DECLARATION_SIGNATURE.mark(element)
else
DEFAULT.mark(element)
}
override fun isValid(element: PsiElement): Boolean {
return if (element is KtDeclaration)
DECLARATION_SIGNATURE.isValid(element)
else
DEFAULT.isValid(element)
}
}
@JvmField
val NOT_SUPPORTED_IN_INLINE_MOST_RELEVANT: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtDeclaration): List =
markElement(
when (element) {
is KtClassOrObject ->
element.getDeclarationKeyword() ?: element.nameIdentifier ?: element
is KtNamedFunction ->
element.modifierList?.getModifier(KtTokens.INLINE_KEYWORD) ?: element.funKeyword ?: element
else -> element
}
)
}
@JvmField
val TYPE_PARAMETERS_OR_DECLARATION_SIGNATURE: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtDeclaration): List {
if (element is KtTypeParameterListOwner) {
val jetTypeParameterList = element.typeParameterList
if (jetTypeParameterList != null) {
return markElement(jetTypeParameterList)
}
}
return DECLARATION_SIGNATURE.mark(element)
}
}
@JvmField
val ABSTRACT_MODIFIER: PositioningStrategy = modifierSetPosition(KtTokens.ABSTRACT_KEYWORD)
@JvmField
val OPEN_MODIFIER: PositioningStrategy = modifierSetPosition(KtTokens.OPEN_KEYWORD)
@JvmField
val OVERRIDE_MODIFIER: PositioningStrategy = modifierSetPosition(KtTokens.OVERRIDE_KEYWORD)
@JvmField
val PRIVATE_MODIFIER: PositioningStrategy = modifierSetPosition(KtTokens.PRIVATE_KEYWORD)
@JvmField
val LATEINIT_MODIFIER: PositioningStrategy = modifierSetPosition(KtTokens.LATEINIT_KEYWORD)
@JvmField
val VARIANCE_MODIFIER: PositioningStrategy = modifierSetPosition(KtTokens.IN_KEYWORD, KtTokens.OUT_KEYWORD)
@JvmField
val FOR_REDECLARATION: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: PsiElement): List {
val nameIdentifier = when (element) {
is KtNamedDeclaration -> element.nameIdentifier
is KtFile -> element.packageDirective!!.nameIdentifier
else -> null
}
if (nameIdentifier == null && element is KtObjectDeclaration) return DEFAULT.mark(element)
return markElement(nameIdentifier ?: element)
}
}
@JvmField
val FOR_UNRESOLVED_REFERENCE: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtReferenceExpression): List {
if (element is KtArrayAccessExpression) {
val ranges = element.bracketRanges
if (!ranges.isEmpty()) {
return ranges
}
}
return listOf(element.textRange)
}
}
@JvmStatic
fun modifierSetPosition(vararg tokens: KtModifierKeywordToken): PositioningStrategy {
return object : PositioningStrategy() {
override fun mark(element: KtModifierListOwner): List {
val modifierList = element.modifierList.sure { "No modifier list, but modifier has been found by the analyzer" }
for (token in tokens) {
val modifier = modifierList.getModifier(token)
if (modifier != null) {
return markElement(modifier)
}
}
throw IllegalStateException("None of the modifiers is found: " + listOf(*tokens))
}
}
}
@JvmField
val ARRAY_ACCESS: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtArrayAccessExpression): List {
return markElement(element.indicesNode)
}
}
@JvmField
val VISIBILITY_MODIFIER: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtModifierListOwner): List {
val visibilityTokens =
listOf(KtTokens.PRIVATE_KEYWORD, KtTokens.PROTECTED_KEYWORD, KtTokens.PUBLIC_KEYWORD, KtTokens.INTERNAL_KEYWORD)
val modifierList = element.modifierList
val result = visibilityTokens.mapNotNull { modifierList?.getModifier(it)?.textRange }
if (!result.isEmpty()) return result
// Try to resolve situation when there's no visibility modifiers written before element
if (element is PsiNameIdentifierOwner) {
val nameIdentifier = element.nameIdentifier
if (nameIdentifier != null) {
return markElement(nameIdentifier)
}
}
val elementToMark = when (element) {
is KtObjectDeclaration -> element.getObjectKeyword()!!
is KtPropertyAccessor -> element.namePlaceholder
is KtAnonymousInitializer -> element
else -> throw IllegalArgumentException(
"Can't find text range for element '${element::class.java.canonicalName}' with the text '${element.text}'"
)
}
return markElement(elementToMark)
}
}
@JvmField
val VARIANCE_IN_PROJECTION: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtTypeProjection): List {
return markElement(element.projectionToken!!)
}
}
@JvmField
val PARAMETER_DEFAULT_VALUE: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtParameter): List {
return markNode(element.defaultValue!!.node)
}
}
@JvmField
val PARAMETER_VARARG_MODIFIER: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtParameter): List {
val varargModifier = element.modifierList!!.getModifier(KtTokens.VARARG_KEYWORD)!!
return markNode(varargModifier.node)
}
}
@JvmField
val CALL_ELEMENT: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: PsiElement): List {
return markElement((element as? KtCallElement)?.calleeExpression ?: element)
}
}
@JvmField
val DECLARATION_WITH_BODY: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtDeclarationWithBody): List {
val lastBracketRange = element.bodyBlockExpression?.lastBracketRange
return if (lastBracketRange != null)
markRange(lastBracketRange)
else
markElement(element)
}
override fun isValid(element: KtDeclarationWithBody): Boolean {
return super.isValid(element) && element.bodyBlockExpression?.lastBracketRange != null
}
}
@JvmField
val VAL_OR_VAR_NODE: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtNamedDeclaration): List {
return when (element) {
is KtParameter -> markElement(element.valOrVarKeyword ?: element)
is KtProperty -> markElement(element.valOrVarKeyword)
else -> error("Declaration is neither a parameter nor a property: " + element.getElementTextWithContext())
}
}
}
@JvmField
val ELSE_ENTRY: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtWhenEntry): List {
return markElement(element.elseKeyword!!)
}
}
@JvmField
val WHEN_EXPRESSION: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtWhenExpression): List {
return markElement(element.whenKeyword)
}
}
@JvmField
val WHEN_CONDITION_IN_RANGE: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtWhenConditionInRange): List {
return markElement(element.operationReference)
}
}
@JvmField
val SPECIAL_CONSTRUCT_TOKEN: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtExpression): List =
when (element) {
is KtWhenExpression -> markElement(element.whenKeyword)
is KtIfExpression -> markElement(element.ifKeyword)
is KtOperationExpression -> markElement(element.operationReference)
else -> error("Expression is not an if, when or operation expression: ${element.getElementTextWithContext()}")
}
}
@JvmField
val NULLABLE_TYPE: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtNullableType): List {
return markNode(element.questionMarkNode)
}
}
@JvmField
val CALL_EXPRESSION: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: PsiElement): List {
if (element is KtCallExpression) {
return markRange(element, element.typeArgumentList ?: element.calleeExpression ?: element)
}
return markElement(element)
}
}
@JvmField
val VALUE_ARGUMENTS: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtElement): List {
return markElement((element as? KtValueArgumentList)?.rightParenthesis ?: element)
}
}
@JvmField
val FUNCTION_PARAMETERS: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtFunction): List {
val valueParameterList = element.valueParameterList
if (valueParameterList != null) {
return markElement(valueParameterList)
}
if (element is KtFunctionLiteral) {
return markNode(element.lBrace.node)
}
return DECLARATION_SIGNATURE_OR_DEFAULT.mark(element)
}
}
@JvmField
val CUT_CHAR_QUOTES: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtElement): List {
if (element is KtConstantExpression) {
if (element.node.elementType == KtNodeTypes.CHARACTER_CONSTANT) {
val elementTextRange = element.getTextRange()
return listOf(TextRange.create(elementTextRange.startOffset + 1, elementTextRange.endOffset - 1))
}
}
return markElement(element)
}
}
@JvmField
val LONG_LITERAL_SUFFIX: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtElement): List {
if (element is KtConstantExpression) {
if (element.node.elementType == KtNodeTypes.INTEGER_CONSTANT) {
val endOffset = element.endOffset
return listOf(TextRange.create(endOffset - 1, endOffset))
}
}
return markElement(element)
}
}
@JvmField
val UNREACHABLE_CODE: PositioningStrategy = object : PositioningStrategy() {
override fun markDiagnostic(diagnostic: ParametrizedDiagnostic): List {
val unreachableCode = Errors.UNREACHABLE_CODE.cast(diagnostic)
return UnreachableCode.getUnreachableTextRanges(unreachableCode.psiElement, unreachableCode.a, unreachableCode.b)
}
}
@JvmField
val AS_TYPE: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtBinaryExpressionWithTypeRHS): List {
return markRange(element.operationReference, element)
}
}
@JvmField
val COMPANION_OBJECT: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtObjectDeclaration): List {
if (element.hasModifier(KtTokens.COMPANION_KEYWORD)) {
return modifierSetPosition(KtTokens.COMPANION_KEYWORD).mark(element)
}
return DEFAULT.mark(element)
}
}
@JvmField
val SECONDARY_CONSTRUCTOR_DELEGATION_CALL: PositioningStrategy =
object : PositioningStrategy() {
override fun mark(element: PsiElement): List {
when (element) {
is KtSecondaryConstructor -> {
val valueParameterList = element.valueParameterList ?: return markElement(element)
return markRange(element.getConstructorKeyword(), valueParameterList.lastChild)
}
is KtConstructorDelegationCall -> {
if (element.isImplicit) {
// TODO: [VD] FIR collects for some reason implicit KtConstructorDelegationCall
// check(!element.isImplicit) { "Implicit KtConstructorDelegationCall should not be collected directly" }
val constructor = element.getStrictParentOfType()!!
val valueParameterList = constructor.valueParameterList ?: return markElement(constructor)
return markRange(constructor.getConstructorKeyword(), valueParameterList.lastChild)
}
return markElement(element.calleeExpression ?: element)
}
else -> error("unexpected element $element")
}
}
}
@JvmField
val DELEGATOR_SUPER_CALL: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtEnumEntry): List {
val specifiers = element.superTypeListEntries
return markElement(if (specifiers.isEmpty()) element else specifiers[0])
}
}
@JvmField
val UNUSED_VALUE: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtBinaryExpression): List {
return listOf(TextRange(element.left!!.startOffset, element.operationReference.endOffset))
}
}
@JvmField
val USELESS_ELVIS: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtBinaryExpression): List {
return listOf(TextRange(element.operationReference.startOffset, element.endOffset))
}
}
@JvmField
val IMPORT_ALIAS: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtImportDirective): List {
element.alias?.nameIdentifier?.let { return markElement(it) }
element.importedReference?.let {
if (it is KtQualifiedExpression) {
it.selectorExpression?.let { return markElement(it) }
}
return markElement(it)
}
return markElement(element)
}
}
@JvmField
val RETURN_WITH_LABEL: PositioningStrategy = object : PositioningStrategy() {
override fun mark(element: KtReturnExpression): List {
val labeledExpression = element.labeledExpression
if (labeledExpression != null) {
return markRange(element, labeledExpression)
}
return markElement(element.returnKeyword)
}
}
@JvmField
val RECEIVER: PositioningStrategy = object : DeclarationHeader() {
override fun mark(element: KtCallableDeclaration): List {
element.receiverTypeReference?.let { return markElement(it) }
return DEFAULT.mark(element)
}
}
}