.kotlin.kotlin-compiler.1.3.11.source-code.KtFile.kt Maven / Gradle / Ivy
/*
* Copyright 2010-2015 JetBrains s.r.o.
*
* 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 org.jetbrains.kotlin.psi
import com.intellij.extapi.psi.PsiFileBase
import com.intellij.openapi.components.ServiceManager
import com.intellij.openapi.fileTypes.FileType
import com.intellij.psi.*
import com.intellij.psi.stubs.StubElement
import com.intellij.psi.util.PsiTreeUtil
import com.intellij.util.FileContentUtilCore
import com.intellij.util.IncorrectOperationException
import org.jetbrains.kotlin.KtNodeTypes
import org.jetbrains.kotlin.idea.KotlinFileType
import org.jetbrains.kotlin.idea.KotlinLanguage
import org.jetbrains.kotlin.name.FqName
import org.jetbrains.kotlin.parsing.KotlinParserDefinition
import org.jetbrains.kotlin.psi.psiUtil.getChildOfType
import org.jetbrains.kotlin.psi.psiUtil.hasExpectModifier
import org.jetbrains.kotlin.psi.stubs.KotlinFileStub
import org.jetbrains.kotlin.psi.stubs.elements.KtPlaceHolderStubElementType
import org.jetbrains.kotlin.psi.stubs.elements.KtStubElementTypes
open class KtFile(viewProvider: FileViewProvider, val isCompiled: Boolean) :
PsiFileBase(viewProvider, KotlinLanguage.INSTANCE),
KtDeclarationContainer,
KtAnnotated,
KtElement,
PsiClassOwner,
PsiNamedElement,
PsiModifiableCodeBlock {
@Volatile
private var isScript: Boolean? = null
@Volatile
private var hasTopLevelCallables: Boolean? = null
@Volatile
private var pathCached: String? = null
val importList: KtImportList?
get() = findChildByTypeOrClass(KtStubElementTypes.IMPORT_LIST, KtImportList::class.java)
val fileAnnotationList: KtFileAnnotationList?
get() = findChildByTypeOrClass(KtStubElementTypes.FILE_ANNOTATION_LIST, KtFileAnnotationList::class.java)
open val importDirectives: List
get() = importList?.imports ?: emptyList()
// scripts have no package directive, all other files must have package directives
val packageDirective: KtPackageDirective?
get() {
val stub = stub
if (stub != null) {
val packageDirectiveStub = stub.findChildStubByType(KtStubElementTypes.PACKAGE_DIRECTIVE)
return packageDirectiveStub?.psi
}
return packageDirectiveByTree
}
private val packageDirectiveByTree: KtPackageDirective?
get() {
val ast = node.findChildByType(KtNodeTypes.PACKAGE_DIRECTIVE)
return if (ast != null) ast.psi as KtPackageDirective else null
}
var packageFqName: FqName
get() = stub?.getPackageFqName() ?: packageFqNameByTree
set(value) {
val packageDirective = packageDirective
if (packageDirective != null) {
packageDirective.fqName = value
} else {
val newPackageDirective = KtPsiFactory(this).createPackageDirectiveIfNeeded(value) ?: return
addAfter(newPackageDirective, null)
}
}
val packageFqNameByTree: FqName
get() = packageDirectiveByTree?.fqName ?: FqName.ROOT
val script: KtScript?
get() {
stub?.let { if (!it.isScript()) return null }
isScript?.let { if (!it) return null }
val result = getChildOfType()
if (isScript == null) {
isScript = result != null
}
return result
}
val virtualFilePath
get(): String {
pathCached?.let { return it }
return virtualFile.path.also {
pathCached = it
}
}
val isScriptByTree: Boolean
get() = script != null
/**
* @return annotations that do not belong to any declaration due to incomplete code or syntax errors
*/
val danglingAnnotations: List
get() {
val stub = stub
val danglingModifierLists = stub?.getChildrenByType(
KtStubElementTypes.MODIFIER_LIST,
KtStubElementTypes.MODIFIER_LIST.arrayFactory
) ?: findChildrenByClass(KtModifierList::class.java)
return danglingModifierLists.flatMap { obj: KtModifierList -> obj.annotationEntries }
}
override fun getFileType(): FileType = KotlinFileType.INSTANCE
override fun toString(): String = "KtFile: " + name
override fun getDeclarations(): List {
val stub = stub
return stub?.getChildrenByType(KtStubElementTypes.DECLARATION_TYPES, KtDeclaration.ARRAY_FACTORY)?.toList()
?: PsiTreeUtil.getChildrenOfTypeAsList(this, KtDeclaration::class.java)
}
fun >> findChildByTypeOrClass(
elementType: KtPlaceHolderStubElementType,
elementClass: Class
): T? {
val stub = stub
if (stub != null) {
val importListStub = stub.findChildStubByType(elementType)
return importListStub?.psi
}
return findChildByClass(elementClass)
}
fun findImportByAlias(name: String): KtImportDirective? =
importDirectives.firstOrNull { name == it.aliasName }
@Deprecated("") // getPackageFqName should be used instead
override fun getPackageName(): String {
return packageFqName.asString()
}
override fun getStub(): KotlinFileStub? {
val stub = super.getStub()
if (stub is KotlinFileStub?) {
return stub
}
throw error("Illegal stub for KtFile: type=${this.javaClass}, stub=${stub?.javaClass} name=$name")
}
override fun getClasses(): Array {
val fileClassProvider = ServiceManager.getService(project, KtFileClassProvider::class.java)
return fileClassProvider?.getFileClasses(this) ?: PsiClass.EMPTY_ARRAY
}
override fun setPackageName(packageName: String) {}
override fun clearCaches() {
@Suppress("RemoveExplicitSuperQualifier")
super.clearCaches()
isScript = null
hasTopLevelCallables = null
pathCached = null
}
fun isScript(): Boolean = stub?.isScript() ?: isScriptByTree
fun hasTopLevelCallables(): Boolean {
hasTopLevelCallables?.let { return it }
val result = declarations.any {
(it is KtProperty ||
it is KtNamedFunction ||
it is KtScript ||
it is KtTypeAlias) && !it.hasExpectModifier()
}
hasTopLevelCallables = result
return result
}
override fun accept(visitor: PsiElementVisitor) {
if (visitor is KtVisitor<*, *>) {
@Suppress("UNCHECKED_CAST")
accept(visitor as KtVisitor, null)
} else {
visitor.visitFile(this)
}
}
override fun getContainingKtFile(): KtFile = this
override fun acceptChildren(visitor: KtVisitor, data: D) {
KtPsiUtil.visitChildren(this, visitor, data)
}
override fun accept(visitor: KtVisitor, data: D): R {
return visitor.visitKtFile(this, data)
}
override fun getAnnotations(): List =
fileAnnotationList?.annotations ?: emptyList()
override fun getAnnotationEntries(): List =
fileAnnotationList?.annotationEntries ?: emptyList()
@Throws(IncorrectOperationException::class)
override fun setName(name: String): PsiElement {
val result = super.setName(name)
val willBeScript = name.endsWith(KotlinParserDefinition.STD_SCRIPT_EXT)
if (isScript() != willBeScript) {
FileContentUtilCore.reparseFiles(listOfNotNull(virtualFile))
}
return result
}
override fun getPsiOrParent(): KtElement = this
override fun shouldChangeModificationCount(place: PsiElement): Boolean {
// Modification count for Kotlin files is tracked entirely by KotlinCodeBlockModificationListener
return false
}
}