org.jetbrains.kotlin.psi.KtNamedDeclarationStub 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.google.common.collect.ImmutableSet;
import com.intellij.lang.ASTNode;
import com.intellij.openapi.project.Project;
import com.intellij.psi.JavaPsiFacade;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiPackage;
import com.intellij.psi.search.*;
import com.intellij.psi.stubs.IStubElementType;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.util.IncorrectOperationException;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.kotlin.idea.KotlinFileType;
import org.jetbrains.kotlin.lexer.KtTokens;
import org.jetbrains.kotlin.name.FqName;
import org.jetbrains.kotlin.name.Name;
import org.jetbrains.kotlin.psi.psiUtil.KtPsiUtilKt;
import org.jetbrains.kotlin.psi.stubs.KotlinStubWithFqName;
import org.jetbrains.kotlin.types.expressions.OperatorConventions;
import org.jetbrains.kotlin.util.OperatorNameConventions;
import java.util.Set;
import static org.jetbrains.kotlin.psi.KtPsiFactoryKt.KtPsiFactory;
abstract class KtNamedDeclarationStub> extends KtDeclarationStub implements KtNamedDeclaration {
public KtNamedDeclarationStub(@NotNull T stub, @NotNull IStubElementType nodeType) {
super(stub, nodeType);
}
public KtNamedDeclarationStub(@NotNull ASTNode node) {
super(node);
}
@Override
public String getName() {
T stub = getStub();
if (stub != null) {
return stub.getName();
}
PsiElement identifier = getNameIdentifier();
if (identifier != null) {
String text = identifier.getText();
return text != null ? KtPsiUtil.unquoteIdentifier(text) : null;
}
else {
return null;
}
}
@Override
public Name getNameAsName() {
String name = getName();
return name != null ? Name.identifier(name) : null;
}
@Override
@NotNull
public Name getNameAsSafeName() {
return KtPsiUtil.safeName(getName());
}
@Override
public PsiElement getNameIdentifier() {
return findChildByType(KtTokens.IDENTIFIER);
}
private static final Set FUNCTIONLIKE_CONVENTIONS = ImmutableSet.of(
OperatorNameConventions.INVOKE.asString(),
OperatorNameConventions.GET.asString()
);
private static boolean shouldDropOperatorKeyword(String oldName, String newName) {
return !OperatorConventions.isConventionName(Name.identifier(newName)) ||
FUNCTIONLIKE_CONVENTIONS.contains(oldName) != FUNCTIONLIKE_CONVENTIONS.contains(newName);
}
@Override
public PsiElement setName(@NonNls @NotNull String name) throws IncorrectOperationException {
PsiElement identifier = getNameIdentifier();
if (identifier == null) return null;
KtModifierList modifierList = getModifierList();
if (modifierList != null && modifierList.hasModifier(KtTokens.OPERATOR_KEYWORD)) {
if (shouldDropOperatorKeyword(getName(), name)) {
removeModifier(KtTokens.OPERATOR_KEYWORD);
}
}
PsiElement newIdentifier =
KtPsiFactory(this).createNameIdentifierIfPossible(KtPsiUtilKt.quoteIfNeeded(name));
if (newIdentifier != null) {
KtPsiUtilKt.astReplace(identifier, newIdentifier);
}
else {
identifier.delete();
}
return this;
}
@Override
public int getTextOffset() {
PsiElement identifier = getNameIdentifier();
return identifier != null ? identifier.getTextRange().getStartOffset() : getTextRange().getStartOffset();
}
@NotNull
@Override
public SearchScope getUseScope() {
KtElement enclosingBlock = KtPsiUtil.getEnclosingElementForLocalDeclaration(this, false);
if (enclosingBlock != null) {
PsiElement enclosingParent = enclosingBlock.getParent();
KtObjectDeclaration containingObject = PsiTreeUtil.getParentOfType(this, KtObjectDeclaration.class);
if (containingObject != null && containingObject.isObjectLiteral()) {
KtDeclarationWithInitializer declaration =
PsiTreeUtil.getParentOfType(containingObject, KtDeclarationWithInitializer.class);
if (declaration != null && declaration.hasModifier(KtTokens.PRIVATE_KEYWORD)) {
if (enclosingParent instanceof KtFile) {
return new LocalSearchScope(enclosingParent);
}
if (enclosingParent instanceof KtObjectDeclaration && ((KtObjectDeclaration) enclosingParent).isCompanion()) {
return new LocalSearchScope(enclosingParent.getParent());
}
}
}
if (enclosingParent instanceof KtContainerNode) {
enclosingParent = enclosingParent.getParent();
}
if (enclosingBlock instanceof KtBlockExpression && enclosingParent instanceof KtDoWhileExpression) {
KtExpression condition = ((KtDoWhileExpression) enclosingParent).getCondition();
if (condition != null) return new LocalSearchScope(new PsiElement[] { enclosingBlock, condition });
}
return new LocalSearchScope(enclosingBlock);
}
PsiElement parent = getParent();
PsiElement grandParent = parent != null ? parent.getParent() : null;
if (parent instanceof KtBlockExpression && grandParent instanceof KtScript) {
return new LocalSearchScope(getContainingFile());
}
if (hasModifier(KtTokens.PRIVATE_KEYWORD)) {
KtElement containingClass = PsiTreeUtil.getParentOfType(this, KtClassOrObject.class);
if (containingClass instanceof KtObjectDeclaration && ((KtObjectDeclaration) containingClass).isCompanion()) {
KtElement companionObjectClass = PsiTreeUtil.getParentOfType(containingClass, KtClassOrObject.class);
if (companionObjectClass != null) {
containingClass = companionObjectClass;
}
}
if (containingClass != null) {
return new LocalSearchScope(containingClass);
}
KtFile ktFile = getContainingKtFile();
if (this instanceof KtClassOrObject) {
// Private top-level class may be used in non-Kotlin JVM code
Project project = getProject();
GlobalSearchScope kotlinFilesScope = GlobalSearchScope.getScopeRestrictedByFileTypes(
GlobalSearchScope.allScope(project),
KotlinFileType.INSTANCE
);
PsiPackage psiPackage = JavaPsiFacade.getInstance(project).findPackage(ktFile.getPackageFqName().asString());
SearchScope baseScope = psiPackage != null
? new PackageScope(psiPackage, false, true)
: super.getUseScope();
baseScope.intersectWith(GlobalSearchScope.notScope(kotlinFilesScope));
}
else {
return new LocalSearchScope(ktFile);
}
}
SearchScope scope = super.getUseScope();
KtClassOrObject classOrObject = KtPsiUtilKt.getContainingClassOrObject(this);
if (classOrObject != null) {
scope = scope.intersectWith(classOrObject.getUseScope());
}
return scope;
}
@Nullable
@Override
public FqName getFqName() {
// TODO: stubs do not agree with PSI here in case where there's no name:
// stubs return a normalized name, and PSI returns null
T stub = getStub();
if (stub != null) {
return stub.getFqName();
}
return KtNamedDeclarationUtil.getFQName(this);
}
}