Features/#462 gutter icons module case #465
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| package com.jetbrains.snakecharm | ||
|
|
||
| import com.intellij.codeInsight.daemon.RelatedItemLineMarkerInfo | ||
| import com.intellij.codeInsight.daemon.RelatedItemLineMarkerProvider | ||
| import com.intellij.codeInsight.navigation.NavigationGutterIconBuilder | ||
| import com.intellij.icons.AllIcons | ||
| import com.intellij.openapi.module.ModuleUtilCore | ||
| import com.intellij.psi.PsiElement | ||
| import com.intellij.psi.search.GlobalSearchScope | ||
| import com.intellij.psi.stubs.StubIndex | ||
| import com.jetbrains.snakecharm.lang.psi.* | ||
| import com.jetbrains.snakecharm.lang.psi.stubs.SmkUseInheritedRulesIndex | ||
| import com.jetbrains.snakecharm.lang.psi.stubs.SmkUseInheritedRulesIndex.Companion.INHERITED_RULES_DECLARATION_VIA_WILDCARD | ||
|
|
||
| class SnakemakeRuleInheritanceMarkerProvider : RelatedItemLineMarkerProvider() { | ||
|
|
||
| override fun collectNavigationMarkers( | ||
| element: PsiElement, | ||
| result: MutableCollection<in RelatedItemLineMarkerInfo<*>> | ||
| ) { | ||
| if (element !is SmkRuleOrCheckpoint) { | ||
| return | ||
| } | ||
| if (element is SmkUse) { | ||
| collectOverridingRulesOrCheckpoint(element, result) | ||
| } | ||
| collectOverriddenRuleOrCheckpoint(element, result) | ||
| } | ||
|
|
||
| private fun collectOverridingRulesOrCheckpoint( | ||
| use: SmkUse, | ||
| result: MutableCollection<in RelatedItemLineMarkerInfo<*>> | ||
| ) { | ||
| val name = (use.nameIdentifier as? SmkUseNameIdentifier)?.getNameBeforeWildcard() ?: return | ||
| val inheritedRulesDeclaredExplicitly = | ||
| use.getDefinedReferencesOfImportedRuleNames()?.mapNotNull { it.reference.resolve() } ?: emptyList() | ||
| val ruleModule = use.getModuleName()?.reference?.resolve() as? SmkModule | ||
| val importedFile = ruleModule?.getPsiFile() as? SmkFile | ||
| val inheritedRulesDeclaredViaWildcard = | ||
| importedFile?.advancedCollectRules(mutableSetOf())?.map { it.second } ?: emptyList() | ||
| val results = inheritedRulesDeclaredExplicitly.ifEmpty { inheritedRulesDeclaredViaWildcard } | ||
| if (results.isEmpty()) { | ||
| return | ||
| } | ||
| val builder = NavigationGutterIconBuilder.create(AllIcons.Gutter.OverridingMethod) | ||
| .setTargets(results) | ||
| .setTooltipText(SnakemakeBundle.message("smk.line.marker.provider.overriding.rules")) | ||
| result.add(builder.createLineMarkerInfo(name)) | ||
| } | ||
|
|
||
| private fun collectOverriddenRuleOrCheckpoint( | ||
| element: SmkRuleOrCheckpoint, | ||
| result: MutableCollection<in RelatedItemLineMarkerInfo<*>> | ||
| ) { | ||
| val identifier = when (val identifier = element.nameIdentifier) { | ||
| is SmkUseNameIdentifier -> identifier.getNameBeforeWildcard() | ||
| else -> identifier | ||
| } ?: return | ||
| val module = element.let { ModuleUtilCore.findModuleForPsiElement(it.originalElement) } ?: return | ||
| val descendantsDefinedExplicitly = StubIndex.getElements( | ||
| SmkUseInheritedRulesIndex.KEY, | ||
| identifier.text, | ||
| module.project, | ||
| GlobalSearchScope.moduleWithDependentsScope(module), | ||
| SmkUse::class.java | ||
| ) | ||
| val potentialDescendants = StubIndex.getElements( | ||
| SmkUseInheritedRulesIndex.KEY, | ||
| INHERITED_RULES_DECLARATION_VIA_WILDCARD, | ||
| module.project, | ||
| GlobalSearchScope.moduleWithDependentsScope(module), | ||
| SmkUse::class.java | ||
| ) | ||
| val overrides = mutableListOf<SmkRuleOrCheckpoint>() | ||
| (descendantsDefinedExplicitly + potentialDescendants).forEach { descendant -> | ||
| // We don't save it in stub because it requires 'resolve' | ||
| // We compare resolve results even for descendantsDefinedExplicitly | ||
| // Because there may be rules with the same names | ||
| if (descendant.getImportedRules()?.contains(element) == true) { | ||
| overrides.add(descendant) | ||
| } | ||
| } | ||
| if (overrides.isEmpty()) { | ||
| return | ||
| } | ||
| val builder = NavigationGutterIconBuilder.create(AllIcons.Gutter.OverridenMethod) | ||
| .setTargets(overrides) | ||
| .setTooltipText(SnakemakeBundle.message("smk.line.marker.provider.overridden.rules")) | ||
| result.add(builder.createLineMarkerInfo(identifier)) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| package com.jetbrains.snakecharm.lang.psi.impl | ||
|
|
||
| import com.intellij.lang.ASTNode | ||
| import com.intellij.psi.PsiElement | ||
| import com.jetbrains.python.psi.impl.PyElementImpl | ||
| import com.jetbrains.snakecharm.lang.psi.SmkUseNameIdentifier | ||
|
|
||
| class SmkUseNameIdentifierImpl(node: ASTNode) : PyElementImpl(node), SmkUseNameIdentifier { | ||
| override fun isWildcard(): Boolean = text.contains('*') | ||
|
|
||
| override fun getNameBeforeWildcard(): PsiElement = firstChild | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| package com.jetbrains.snakecharm.lang.psi.impl.stubs | ||
|
|
||
| import com.intellij.psi.stubs.* | ||
| import com.jetbrains.python.psi.PyElement | ||
| import com.jetbrains.python.psi.PyStubElementType | ||
| import com.jetbrains.snakecharm.lang.psi.SmkRuleLike | ||
| import com.jetbrains.snakecharm.lang.psi.stubs.RuleDescendantStub | ||
| import com.jetbrains.snakecharm.lang.psi.stubs.SmkUseInheritedRulesIndex | ||
|
|
||
| abstract class SmkRuleDescendantElementType<StubT : RuleDescendantStub<*>, PsiT : PyElement>( | ||
| debugName: String, | ||
| private val nameIndexKey: StubIndexKey<String, out SmkRuleLike<*>>? | ||
| ) : | ||
| PyStubElementType<StubT, PsiT>(debugName) { | ||
| abstract fun createStub(name: String?, inheritedRules: List<String?>, parentStub: StubElement<*>?): StubT | ||
|
|
||
| override fun serialize(stub: StubT, dataStream: StubOutputStream) { | ||
| dataStream.writeName(stub.name) | ||
| dataStream.writeInt(stub.getInheritedRulesNames().size) | ||
| stub.getInheritedRulesNames().forEach { name -> | ||
| dataStream.writeName(name) | ||
| } | ||
| } | ||
|
|
||
| override fun deserialize(dataStream: StubInputStream, parentStub: StubElement<*>?): StubT { | ||
| val name = dataStream.readNameString() | ||
| val size = dataStream.readInt() | ||
| val inheritedRules = mutableListOf<String?>() | ||
| for (x in 0 until size) { | ||
| inheritedRules.add(dataStream.readNameString()) | ||
| } | ||
| return createStub(name, inheritedRules, parentStub) | ||
| } | ||
|
|
||
| override fun indexStub(stub: StubT, sink: IndexSink) { | ||
| if (nameIndexKey != null) { | ||
| stub.name?.let { name -> | ||
| sink.occurrence(nameIndexKey, name) | ||
| } | ||
| } | ||
| stub.getInheritedRulesNames().forEach { inheritedName -> | ||
| if (inheritedName != null) { | ||
| sink.occurrence(SmkUseInheritedRulesIndex.KEY, inheritedName) | ||
| } | ||
| } | ||
| super.indexStub(stub, sink) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
getImportedRules()name sounds to innocent, like some simple filter on AST nodes, similar to other methods. Actually it is heavy method that does resolve. Let's emphasize that it isn't lightweight method and does resolve, e.g name ituse.getImportedRules().resolveNames()