azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

KotlinQuickDocumentationProvider: J2K

Browse Source
This commit is contained in:
Dmitry Jemerov
2015-04-15 19:43:34 +02:00
parent 3d21824929
commit b1b138b424
3 changed files with 117 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files
idea/src/META-INF/plugin.xml
+2 -2
View File
@@ -349,8 +349,8 @@
<copyPastePostProcessor implementation="org.jetbrains.kotlin.idea.conversion.copy.ConvertJavaCopyPastePostProcessor"/> <copyPastePostProcessor implementation="org.jetbrains.kotlin.idea.conversion.copy.ConvertJavaCopyPastePostProcessor"/>
<copyPastePostProcessor implementation="org.jetbrains.kotlin.idea.codeInsight.KotlinCopyPasteReferenceProcessor"/> <copyPastePostProcessor implementation="org.jetbrains.kotlin.idea.codeInsight.KotlinCopyPasteReferenceProcessor"/>
<lang.documentationProvider language="JAVA" implementationClass="org.jetbrains.kotlin.idea.JetQuickDocumentationProvider" order="first"/> <lang.documentationProvider language="JAVA" implementationClass="org.jetbrains.kotlin.idea.KotlinQuickDocumentationProvider" order="first"/>
<documentationProvider implementation="org.jetbrains.kotlin.idea.JetQuickDocumentationProvider"/> <documentationProvider implementation="org.jetbrains.kotlin.idea.KotlinQuickDocumentationProvider"/>
<configurationType implementation="org.jetbrains.kotlin.idea.run.JetRunConfigurationType"/> <configurationType implementation="org.jetbrains.kotlin.idea.run.JetRunConfigurationType"/>
<configurationType implementation="org.jetbrains.kotlin.idea.k2jsrun.K2JSRunConfigurationType"/> <configurationType implementation="org.jetbrains.kotlin.idea.k2jsrun.K2JSRunConfigurationType"/>
<programRunner implementation="org.jetbrains.kotlin.idea.k2jsrun.K2JSBrowserProgramRunner"/> <programRunner implementation="org.jetbrains.kotlin.idea.k2jsrun.K2JSBrowserProgramRunner"/>
idea/src/org/jetbrains/kotlin/idea/KotlinQuickDocumentationProvider.kt
+113 -119
View File
@@ -14,138 +14,132 @@
* limitations under the License. * limitations under the License.
*/ */
package org.jetbrains.kotlin.idea; package org.jetbrains.kotlin.idea
import com.intellij.lang.documentation.AbstractDocumentationProvider; import com.intellij.lang.documentation.AbstractDocumentationProvider
import com.intellij.lang.java.JavaDocumentationProvider; import com.intellij.lang.java.JavaDocumentationProvider
import com.intellij.openapi.diagnostic.Logger; import com.intellij.openapi.diagnostic.Logger
import com.intellij.openapi.project.Project; import com.intellij.openapi.project.Project
import com.intellij.openapi.util.text.StringUtil; import com.intellij.openapi.util.text.StringUtil
import com.intellij.psi.PsiElement; import com.intellij.psi.PsiElement
import com.intellij.psi.PsiManager; import com.intellij.psi.PsiManager
import com.intellij.psi.util.PsiTreeUtil; import com.intellij.psi.util.PsiTreeUtil
import org.jetbrains.annotations.NotNull; import org.jetbrains.kotlin.asJava.KotlinLightMethod
import org.jetbrains.kotlin.asJava.KotlinLightMethod; import org.jetbrains.kotlin.descriptors.DeclarationDescriptor
import org.jetbrains.kotlin.descriptors.DeclarationDescriptor; import org.jetbrains.kotlin.descriptors.DeclarationDescriptorWithSource
import org.jetbrains.kotlin.descriptors.DeclarationDescriptorWithSource; import org.jetbrains.kotlin.descriptors.SourceElement
import org.jetbrains.kotlin.descriptors.SourceElement; import org.jetbrains.kotlin.idea.caches.resolve.KotlinCacheService
import org.jetbrains.kotlin.idea.caches.resolve.KotlinCacheService; import org.jetbrains.kotlin.idea.caches.resolve.ResolutionFacade
import org.jetbrains.kotlin.idea.caches.resolve.ResolutionFacade; import org.jetbrains.kotlin.idea.caches.resolve.*
import org.jetbrains.kotlin.idea.caches.resolve.ResolvePackage; import org.jetbrains.kotlin.idea.kdoc.KDocFinder
import org.jetbrains.kotlin.idea.kdoc.KDocFinder; import org.jetbrains.kotlin.idea.kdoc.KDocRenderer
import org.jetbrains.kotlin.idea.kdoc.KDocRenderer; import org.jetbrains.kotlin.idea.kdoc.*
import org.jetbrains.kotlin.idea.kdoc.KdocPackage; import org.jetbrains.kotlin.idea.project.ResolveSessionForBodies
import org.jetbrains.kotlin.kdoc.psi.impl.KDocTag; import org.jetbrains.kotlin.kdoc.psi.impl.KDocTag
import org.jetbrains.kotlin.psi.JetDeclaration; import org.jetbrains.kotlin.psi.JetDeclaration
import org.jetbrains.kotlin.psi.JetElement; import org.jetbrains.kotlin.psi.JetElement
import org.jetbrains.kotlin.psi.JetPsiUtil; import org.jetbrains.kotlin.psi.JetPsiUtil
import org.jetbrains.kotlin.psi.JetReferenceExpression; import org.jetbrains.kotlin.psi.JetReferenceExpression
import org.jetbrains.kotlin.renderer.DescriptorRenderer; import org.jetbrains.kotlin.renderer.DescriptorRenderer
import org.jetbrains.kotlin.resolve.BindingContext; import org.jetbrains.kotlin.resolve.BindingContext
import org.jetbrains.kotlin.resolve.lazy.BodyResolveMode; import org.jetbrains.kotlin.resolve.lazy.BodyResolveMode
import org.jetbrains.kotlin.resolve.source.PsiSourceElement; import org.jetbrains.kotlin.resolve.source.PsiSourceElement
import java.util.Collections
import java.util.Collection; public class KotlinQuickDocumentationProvider : AbstractDocumentationProvider() {
import java.util.Collections;
public class JetQuickDocumentationProvider extends AbstractDocumentationProvider { override fun getQuickNavigateInfo(element: PsiElement, originalElement: PsiElement): String? {
private static final Logger LOG = Logger.getInstance(JetQuickDocumentationProvider.class); return getText(element, originalElement, true)
@Override
public String getQuickNavigateInfo(PsiElement element, PsiElement originalElement) {
return getText(element, originalElement, true);
} }
@Override override fun generateDoc(element: PsiElement, originalElement: PsiElement): String? {
public String generateDoc(PsiElement element, PsiElement originalElement) { return getText(element, originalElement, false)
return getText(element, originalElement, false);
} }
private static String getText(PsiElement element, PsiElement originalElement, boolean quickNavigation) { override fun getDocumentationElementForLink(psiManager: PsiManager, link: String, context: PsiElement?): PsiElement? {
if (element instanceof JetDeclaration) { if (context !is JetElement) {
return renderKotlinDeclaration((JetDeclaration) element, quickNavigation); return null
} }
else if (element instanceof KotlinLightMethod) { val project = psiManager.getProject()
return renderKotlinDeclaration(((KotlinLightMethod) element).getOrigin(), quickNavigation); val cacheService = KotlinCacheService.getInstance(project)
} val session = cacheService.getLazyResolveSession(context)
val facade = cacheService.getResolutionFacade(listOf(context))
if (quickNavigation) { val bindingContext = facade.analyze(context, BodyResolveMode.PARTIAL)
JetReferenceExpression referenceExpression = PsiTreeUtil.getParentOfType(originalElement, JetReferenceExpression.class, false); val contextDescriptor = bindingContext.get<PsiElement, DeclarationDescriptor>(BindingContext.DECLARATION_TO_DESCRIPTOR, context)
if (referenceExpression != null) {
BindingContext context = ResolvePackage.analyze(referenceExpression, BodyResolveMode.PARTIAL);
DeclarationDescriptor declarationDescriptor = context.get(BindingContext.REFERENCE_TARGET, referenceExpression);
if (declarationDescriptor != null) {
return mixKotlinToJava(declarationDescriptor, element, originalElement);
}
}
}
else {
// This element was resolved to non-kotlin element, it will be rendered with own provider
}
return null;
}
private static String renderKotlinDeclaration(JetDeclaration declaration, boolean quickNavigation) {
BindingContext context = ResolvePackage.analyze(declaration, BodyResolveMode.PARTIAL);
DeclarationDescriptor declarationDescriptor = context.get(BindingContext.DECLARATION_TO_DESCRIPTOR, declaration);
if (declarationDescriptor == null) {
LOG.info("Failed to find descriptor for declaration " + JetPsiUtil.getElementTextWithContext(declaration));
return "No documentation available";
}
String renderedDecl = DescriptorRenderer.HTML_NAMES_WITH_SHORT_TYPES.render(declarationDescriptor);
if (!quickNavigation) {
renderedDecl = "<pre>" + DescriptorRenderer.HTML_NAMES_WITH_SHORT_TYPES.render(declarationDescriptor) + "</pre>";
}
KDocTag comment = KDocFinder.INSTANCE$.findKDoc(declarationDescriptor);
if (comment != null) {
renderedDecl = renderedDecl + "<br/>" + KDocRenderer.INSTANCE$.renderKDoc(comment);
}
return renderedDecl;
}
private static String mixKotlinToJava(
@NotNull DeclarationDescriptor declarationDescriptor,
PsiElement element, PsiElement originalElement
) {
String originalInfo = new JavaDocumentationProvider().getQuickNavigateInfo(element, originalElement);
if (originalInfo != null) {
String renderedDecl = DescriptorRenderer.HTML_NAMES_WITH_SHORT_TYPES.render(declarationDescriptor);
return renderedDecl + "<br/>Java declaration:<br/>" + originalInfo;
}
return null;
}
@Override
public PsiElement getDocumentationElementForLink(PsiManager psiManager, String link, PsiElement context) {
if (!(context instanceof JetElement)) {
return null;
}
JetElement jetElement = (JetElement) context;
Project project = psiManager.getProject();
KotlinCacheService cacheService = KotlinCacheService.getInstance(project);
ResolutionFacade facade = cacheService.getResolutionFacade(Collections.singletonList(jetElement));
BindingContext bindingContext = facade.analyze(jetElement, BodyResolveMode.PARTIAL);
DeclarationDescriptor contextDescriptor = bindingContext.get(BindingContext.DECLARATION_TO_DESCRIPTOR, context);
if (contextDescriptor == null) { if (contextDescriptor == null) {
return null; return null
} }
Collection<DeclarationDescriptor> descriptors = val descriptors = resolveKDocLink(session, contextDescriptor, null, StringUtil.split(link, ","))
KdocPackage.resolveKDocLink(facade, contextDescriptor, null, StringUtil.split(link, ","));
if (!descriptors.isEmpty()) { if (!descriptors.isEmpty()) {
DeclarationDescriptor target = descriptors.iterator().next(); val target = descriptors.iterator().next()
if (target instanceof DeclarationDescriptorWithSource) { if (target is DeclarationDescriptorWithSource) {
SourceElement source = ((DeclarationDescriptorWithSource) target).getSource(); val source = target.getSource()
if (source instanceof PsiSourceElement) { if (source is PsiSourceElement) {
return ((PsiSourceElement) source).getPsi(); return source.psi
} }
} }
} }
return null; return null
}
companion object {
private val LOG = Logger.getInstance(javaClass<KotlinQuickDocumentationProvider>())
private fun getText(element: PsiElement, originalElement: PsiElement, quickNavigation: Boolean): String? {
if (element is JetDeclaration) {
return renderKotlinDeclaration(element, quickNavigation)
}
else if (element is KotlinLightMethod) {
return renderKotlinDeclaration(element.getOrigin(), quickNavigation)
}
if (quickNavigation) {
val referenceExpression = PsiTreeUtil.getParentOfType<JetReferenceExpression>(originalElement, javaClass<JetReferenceExpression>(), false)
if (referenceExpression != null) {
val context = referenceExpression.analyze(BodyResolveMode.PARTIAL)
val declarationDescriptor = context.get<JetReferenceExpression, DeclarationDescriptor>(BindingContext.REFERENCE_TARGET, referenceExpression)
if (declarationDescriptor != null) {
return mixKotlinToJava(declarationDescriptor, element, originalElement)
}
}
}
else {
// This element was resolved to non-kotlin element, it will be rendered with own provider
}
return null
}
private fun renderKotlinDeclaration(declaration: JetDeclaration, quickNavigation: Boolean): String {
val context = declaration.analyze(BodyResolveMode.PARTIAL)
val declarationDescriptor = context.get<PsiElement, DeclarationDescriptor>(BindingContext.DECLARATION_TO_DESCRIPTOR, declaration)
if (declarationDescriptor == null) {
LOG.info("Failed to find descriptor for declaration " + JetPsiUtil.getElementTextWithContext(declaration))
return "No documentation available"
}
var renderedDecl = DescriptorRenderer.HTML_NAMES_WITH_SHORT_TYPES.render(declarationDescriptor)
if (!quickNavigation) {
renderedDecl = "<pre>" + DescriptorRenderer.HTML_NAMES_WITH_SHORT_TYPES.render(declarationDescriptor) + "</pre>"
}
val comment = KDocFinder.findKDoc(declarationDescriptor)
if (comment != null) {
renderedDecl = renderedDecl + "<br/>" + KDocRenderer.renderKDoc(comment)
}
return renderedDecl
}
private fun mixKotlinToJava(declarationDescriptor: DeclarationDescriptor, element: PsiElement, originalElement: PsiElement): String? {
val originalInfo = JavaDocumentationProvider().getQuickNavigateInfo(element, originalElement)
if (originalInfo != null) {
val renderedDecl = DescriptorRenderer.HTML_NAMES_WITH_SHORT_TYPES.render(declarationDescriptor)
return renderedDecl + "<br/>Java declaration:<br/>" + originalInfo
}
return null
}
} }
} }
idea/tests/org/jetbrains/kotlin/idea/editor/quickDoc/QuickDocNavigationTest.kt
+2 -2
View File
@@ -17,7 +17,7 @@
package org.jetbrains.kotlin.idea.editor.quickDoc package org.jetbrains.kotlin.idea.editor.quickDoc
import com.intellij.testFramework.fixtures.LightPlatformCodeInsightFixtureTestCase import com.intellij.testFramework.fixtures.LightPlatformCodeInsightFixtureTestCase
import org.jetbrains.kotlin.idea.JetQuickDocumentationProvider import org.jetbrains.kotlin.idea.KotlinQuickDocumentationProvider
import org.jetbrains.kotlin.idea.test.PluginTestCaseBase import org.jetbrains.kotlin.idea.test.PluginTestCaseBase
import org.jetbrains.kotlin.psi.JetClass import org.jetbrains.kotlin.psi.JetClass
import org.jetbrains.kotlin.psi.JetFunction import org.jetbrains.kotlin.psi.JetFunction
@@ -32,7 +32,7 @@ public class QuickDocNavigationTest() : LightPlatformCodeInsightFixtureTestCase(
public fun testSimple() { public fun testSimple() {
myFixture.configureByFile(getTestName(true) + ".kt") myFixture.configureByFile(getTestName(true) + ".kt")
val source = myFixture.getElementAtCaret().getParentOfType<JetFunction>(false) val source = myFixture.getElementAtCaret().getParentOfType<JetFunction>(false)
val target = JetQuickDocumentationProvider().getDocumentationElementForLink( val target = KotlinQuickDocumentationProvider().getDocumentationElementForLink(
myFixture.getPsiManager(), "C", source); myFixture.getPsiManager(), "C", source);
Assert.assertTrue(target is JetClass) Assert.assertTrue(target is JetClass)
Assert.assertEquals("C", (target as JetClass).getName()) Assert.assertEquals("C", (target as JetClass).getName())