MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

IDEA-86204 Groovydoc: Allow to use non-qualified names at the groovydoc

Browse Source
This commit is contained in:
Maxim.Medvedev
2012-05-19 16:29:20 +04:00
parent 332460fd00
commit 2c31763520
5 changed files with 78 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/groovy/src/org/jetbrains/plugins/groovy/lang/GrReferenceAdjuster.java
+19 -17
View File
@@ -23,7 +23,6 @@ import com.intellij.psi.util.PsiTreeUtil;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.plugins.groovy.debugger.fragments.GroovyCodeFragment;
import org.jetbrains.plugins.groovy.lang.groovydoc.psi.api.GrDocComment;
import org.jetbrains.plugins.groovy.lang.groovydoc.psi.api.GrDocMemberReference;
import org.jetbrains.plugins.groovy.lang.lexer.GroovyTokenTypes;
import org.jetbrains.plugins.groovy.lang.psi.GrQualifiedReference;
import org.jetbrains.plugins.groovy.lang.psi.GrReferenceElement;
@@ -47,8 +46,8 @@ public class GrReferenceAdjuster {
shortenReferences(element, range.getStartOffset(), range.getEndOffset(), true, false);
}
public static void shortenReferences(PsiElement element, int start, int end, boolean addImports, boolean uncomplete) {
process(element, start, end, addImports, uncomplete);
public static void shortenReferences(PsiElement element, int start, int end, boolean addImports, boolean incomplete) {
process(element, start, end, addImports, incomplete);
}
public static void shortenReference(GrQualifiedReference ref) {
@@ -57,22 +56,22 @@ public class GrReferenceAdjuster {
process(ref, range.getStartOffset(), range.getEndOffset(), true, false);
}
private static void process(PsiElement element, int start, int end, boolean addImports, boolean uncomplete) {
private static void process(PsiElement element, int start, int end, boolean addImports, boolean incomplete) {
if (element instanceof GrQualifiedReference && ((GrQualifiedReference)element).resolve() instanceof PsiClass) {
shortenReferenceInner((GrQualifiedReference)element, addImports, uncomplete);
shortenReferenceInner((GrQualifiedReference)element, addImports, incomplete);
}
PsiElement child = element.getFirstChild();
while (child != null) {
final TextRange range = child.getTextRange();
if (start < range.getEndOffset() && range.getStartOffset() < end) {
process(child, start, end, addImports, uncomplete);
process(child, start, end, addImports, incomplete);
}
child = child.getNextSibling();
}
}
private static <Qualifier extends PsiElement> boolean shortenReferenceInner(GrQualifiedReference<Qualifier> ref, boolean addImports, boolean uncomplete) {
private static <Qualifier extends PsiElement> boolean shortenReferenceInner(GrQualifiedReference<Qualifier> ref, boolean addImports, boolean incomplete) {
final Qualifier qualifier = ref.getQualifier();
if (qualifier == null || qualifier instanceof GrSuperReferenceExpression || cannotShortenInContext(ref)) {
@@ -88,7 +87,7 @@ public class GrReferenceAdjuster {
if (!shorteningIsMeaningfully(ref)) return false;
final PsiElement resolved = resolveRef(ref, uncomplete);
final PsiElement resolved = resolveRef(ref, incomplete);
if (resolved == null) return false;
if (!checkCopyWithoutQualifier(ref, addImports, resolved)) return false;
@@ -124,8 +123,8 @@ public class GrReferenceAdjuster {
}
@Nullable
private static <Qualifier extends PsiElement> PsiElement resolveRef(GrQualifiedReference<Qualifier> ref, boolean uncomplete) {
if (!uncomplete) return ref.resolve();
private static <Qualifier extends PsiElement> PsiElement resolveRef(GrQualifiedReference<Qualifier> ref, boolean incomplete) {
if (!incomplete) return ref.resolve();
PsiResolveHelper helper = JavaPsiFacade.getInstance(ref.getProject()).getResolveHelper();
if (ref instanceof GrReferenceElement) {
@@ -148,8 +147,14 @@ public class GrReferenceAdjuster {
private static <Qualifier extends PsiElement> boolean shorteningIsMeaningfully(GrQualifiedReference<Qualifier> ref) {
if (ref instanceof GrReferenceElementImpl) {
if (((GrReferenceElementImpl)ref).isFullyQualified() && CodeStyleSettingsManager.getSettings(ref.getProject()).USE_FQ_CLASS_NAMES) return false;
if (ref instanceof GrReferenceElementImpl && ((GrReferenceElementImpl)ref).isFullyQualified()) {
final GrDocComment doc = PsiTreeUtil.getParentOfType(ref, GrDocComment.class);
if (doc != null) {
if (CodeStyleSettingsManager.getSettings(ref.getProject()).USE_FQ_CLASS_NAMES_IN_JAVADOC) return false;
}
else {
if (CodeStyleSettingsManager.getSettings(ref.getProject()).USE_FQ_CLASS_NAMES) return false;
}
}
final Qualifier qualifier = ref.getQualifier();
@@ -169,15 +174,12 @@ public class GrReferenceAdjuster {
}
private static <Qualifier extends PsiElement> boolean cannotShortenInContext(GrQualifiedReference<Qualifier> ref) {
return (PsiTreeUtil.getParentOfType(ref, GrDocMemberReference.class) == null &&
PsiTreeUtil.getParentOfType(ref, GrDocComment.class) != null) ||
PsiTreeUtil.getParentOfType(ref, GrImportStatement.class) != null ||
return PsiTreeUtil.getParentOfType(ref, GrImportStatement.class) != null ||
PsiTreeUtil.getParentOfType(ref, GroovyCodeFragment.class) != null;
}
private static <Qualifier extends PsiElement> boolean mayInsertImport(GrQualifiedReference<Qualifier> ref) {
return PsiTreeUtil.getParentOfType(ref, GrDocComment.class) == null &&
!(ref.getContainingFile() instanceof GroovyCodeFragment) &&
return !(ref.getContainingFile() instanceof GroovyCodeFragment) &&
PsiTreeUtil.getParentOfType(ref, GrImportStatement.class) == null &&
ref.getContainingFile() instanceof GroovyFileBase;
}
plugins/groovy/src/org/jetbrains/plugins/groovy/lang/completion/handlers/GroovyMethodSignatureInsertHandler.java
+2 -1
View File
@@ -34,6 +34,7 @@ import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.psi.util.TypeConversionUtil;
import com.intellij.util.IncorrectOperationException;
import com.intellij.util.text.CharArrayUtil;
import org.jetbrains.plugins.groovy.lang.GrReferenceAdjuster;
import org.jetbrains.plugins.groovy.lang.groovydoc.psi.api.GrDocMemberReference;
/**
@@ -109,7 +110,7 @@ public class GroovyMethodSignatureInsertHandler implements InsertHandler<LookupE
final GrDocMemberReference tagValue = PsiTreeUtil.getParentOfType(element, GrDocMemberReference.class);
if (tagValue != null) {
try {
//GrReferenceAdjuster.shortenReferences(tagValue);
GrReferenceAdjuster.shortenReferences(tagValue);
}
catch (IncorrectOperationException e) {
LOG.error(e);
plugins/groovy/test/org/jetbrains/plugins/groovy/completion/GrDocCompletionTest.groovy
+5
View File
@@ -15,6 +15,7 @@
*/
package org.jetbrains.plugins.groovy.completion
import com.intellij.psi.codeStyle.CodeStyleSettingsManager
import org.jetbrains.plugins.groovy.util.TestUtils
/**
@@ -27,4 +28,8 @@ class GrDocCompletionTest extends GroovyCompletionTestBase {
}
void testLinkCompletion() { doBasicTest() }
void testLinkCompletion1() {
CodeStyleSettingsManager.getSettings(project).USE_FQ_CLASS_NAMES_IN_JAVADOC = false
doBasicTest()
}
}
plugins/groovy/testdata/groovy/completion/gdoc/LinkCompletion1.groovy
Vendored
+26
View File
@@ -0,0 +1,26 @@
/*
* Copyright 2000-2012 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.
*/
class A {
def foo(String x) {}
/**
* {@link A#fo<caret>
*/
def bar() {
}
}
plugins/groovy/testdata/groovy/completion/gdoc/LinkCompletion1_after.groovy
Vendored
+26
View File
@@ -0,0 +1,26 @@
/*
* Copyright 2000-2012 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.
*/
class A {
def foo(String x) {}
/**
* {@link A#foo(String)} <caret>
*/
def bar() {
}
}