Skip to content

Adding support for import module in code completion; fixing handling of module names in the LSP server. #8974

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+134 −11
Open

Adding support for import module in code completion; fixing handling of module names in the LSP server. #8974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 53 additions & 7 deletions java/java.completion/src/org/netbeans/modules/java/completion/JavaCompletionTask.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,10 +731,21 @@ private void insideImport(Env env) throws IOException {
ImportTree im = (ImportTree) env.getPath().getLeaf();
SourcePositions sourcePositions = env.getSourcePositions();
CompilationUnitTree root = env.getRoot();
if (im.isModule()) {
if (offset >= sourcePositions.getStartPosition(root, im.getQualifiedIdentifier())) {
addModuleNamesFromGraph(env, null);
}
} else {
if (offset <= sourcePositions.getStartPosition(root, im.getQualifiedIdentifier())) {
TokenSequence<JavaTokenId> last = findLastNonWhitespaceToken(env, im, offset);
if (last != null && last.token().id() == JavaTokenId.IMPORT && Utilities.startsWith(STATIC_KEYWORD, prefix)) {
addKeyword(env, STATIC_KEYWORD, SPACE, false);
if (last != null && last.token().id() == JavaTokenId.IMPORT) {
if (Utilities.startsWith(STATIC_KEYWORD, prefix)) {
addKeyword(env, STATIC_KEYWORD, SPACE, false);
}
if (Utilities.startsWith(MODULE_KEYWORD, prefix) &&
env.getController().getSourceVersion().compareTo(SourceVersion.RELEASE_25) >= 0) {
addKeyword(env, MODULE_KEYWORD, SPACE, false);
}
}
if (options.contains(Options.ALL_COMPLETION) || options.contains(Options.COMBINED_COMPLETION)) {
EnumSet<ElementKind> classKinds = EnumSet.of(CLASS, INTERFACE, ENUM, ANNOTATION_TYPE);
Expand All @@ -746,6 +757,7 @@ private void insideImport(Env env) throws IOException {
addPackages(env, null, false);
}
}
}
}

private void insideClass(Env env) throws IOException {
Expand Down Expand Up @@ -1635,7 +1647,13 @@ private void insideMemberSelect(Env env) throws IOException {
}
if (!afterDot) {
if (expEndPos <= offset) {
insideExpression(env, new TreePath(path, fa.getExpression()));
if (fa.getExpression().getKind() == Kind.IDENTIFIER &&
((IdentifierTree) fa.getExpression()).getName().contentEquals(MODULE_KEYWORD)) {
controller.toPhase(Phase.ELEMENTS_RESOLVED);
addModuleNamesFromGraph(env, null);
} else {
insideExpression(env, new TreePath(path, fa.getExpression()));
}
}
return;
}
Expand All @@ -1656,10 +1674,15 @@ private void insideMemberSelect(Env env) throws IOException {
}
} else if (lastNonWhitespaceTokenId != JavaTokenId.STAR) {
controller.toPhase(Phase.RESOLVED);
if (withinModuleName(env)) {
boolean inModuleNameInImport = false;
if (withinModuleName(env) || (inModuleNameInImport = withinModuleNameInImport(env))) {
String fqnPrefix = fa.getExpression().toString() + '.';
anchorOffset = (int) sourcePositions.getStartPosition(root, fa);
addModuleNames(env, fqnPrefix, true);
if (inModuleNameInImport) {
addModuleNamesFromGraph(env, fqnPrefix);
} else {
addModuleNames(env, fqnPrefix, true);
}
return;
}
TreePath parentPath = path.getParentPath();
Expand Down Expand Up @@ -4458,12 +4481,20 @@ private void addPackages(Env env, String fqnPrefix, boolean srcOnly) {
}

private void addModuleNames(Env env, String fqnPrefix, boolean srcOnly) {
srcOnly = false;
addModuleNames(env, fqnPrefix, SourceUtils.getModuleNames(env.getController(), srcOnly ? EnumSet.of(ClassIndex.SearchScope.SOURCE) : EnumSet.allOf(ClassIndex.SearchScope.class)));
}

private void addModuleNamesFromGraph(Env env, String fqnPrefix) {
addModuleNames(env, fqnPrefix, env.getController().getElements().getAllModuleElements().stream().map(me -> me.getQualifiedName().toString()).toList());
}

private void addModuleNames(Env env, String fqnPrefix, Iterable<? extends String> modulesNames) {
if (fqnPrefix == null) {
fqnPrefix = EMPTY;
}
srcOnly = false;
String prefix = env.getPrefix() != null ? fqnPrefix + env.getPrefix() : fqnPrefix;
for (String name : SourceUtils.getModuleNames(env.getController(), srcOnly ? EnumSet.of(ClassIndex.SearchScope.SOURCE) : EnumSet.allOf(ClassIndex.SearchScope.class))) {
for (String name : modulesNames) {
if (startsWith(env, name, prefix) && itemFactory instanceof ModuleItemFactory) {
results.add(((ModuleItemFactory<T>)itemFactory).createModuleItem(name, anchorOffset));
}
Expand Down Expand Up @@ -6657,6 +6688,21 @@ private boolean withinModuleName(Env env) {
return false;
}

private boolean withinModuleNameInImport(Env env) {
TreePath path = env.getPath();
Tree last = null;
while (path != null) {
Tree tree = path.getLeaf();
if (last != null
&& tree.getKind() == Tree.Kind.IMPORT && ((ImportTree) tree).isModule() && ((ImportTree) tree).getQualifiedIdentifier() == last) {
return true;
}
path = path.getParentPath();
last = tree;
}
return false;
}

private boolean withinProvidesService(Env env) {
TreePath path = env.getPath();
Tree last = null;
Expand Down
6 changes: 6 additions & 0 deletions .../org/netbeans/modules/java/completion/JavaCompletionTaskTest/17/importModuleListFull.pass
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
java.base
java.compiler
java.xml
jdk.compiler
jdk.jartool
jdk.javadoc
2 changes: 2 additions & 0 deletions ...ans/modules/java/completion/JavaCompletionTaskTest/17/importModuleListFullJDKJPrefix.pass
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
jdk.jartool
jdk.javadoc
3 changes: 3 additions & 0 deletions ...eans/modules/java/completion/JavaCompletionTaskTest/17/importModuleListFullJDKPrefix.pass
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
jdk.compiler
jdk.jartool
jdk.javadoc
7 changes: 7 additions & 0 deletions ...dules/java/completion/JavaCompletionTaskTest/17/staticAndModuleKeywordAndAllPackages.pass
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module
static
com
java
javax
org
sun
58 changes: 58 additions & 0 deletions ...test/unit/src/org/netbeans/modules/java/completion/JavaCompletionTask125FeaturesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,13 @@

package org.netbeans.modules.java.completion;

import java.util.ArrayList;
import java.util.List;
import javax.swing.event.ChangeListener;
import org.netbeans.modules.java.source.parsing.JavacParser;
import org.netbeans.spi.java.queries.CompilerOptionsQueryImplementation;
import org.openide.filesystems.FileObject;
import org.openide.util.lookup.ServiceProvider;

public class JavaCompletionTask125FeaturesTest extends CompletionTestBase {

Expand All @@ -41,7 +47,59 @@ public void testCompactSourceFilesEnd() throws Exception {
performTest("CompactSourceFile", 883, null, "compactSourceFilesInsideClass.pass", SOURCE_LEVEL);
}

public void testImportModuleKeyword() throws Exception {
performTest("Import", 823, "import ", "staticAndModuleKeywordAndAllPackages.pass", SOURCE_LEVEL);
}

public void testImportModuleNoModuleName() throws Exception {
TestCompilerOptionsQueryImplementation.EXTRA_OPTIONS.add("--limit-modules=java.base,jdk.compiler,jdk.javadoc,jdk.jartool");
performTest("Import", 823, "import module ", "importModuleListFull.pass", SOURCE_LEVEL);
}

public void testImportModulePrefix1() throws Exception {
TestCompilerOptionsQueryImplementation.EXTRA_OPTIONS.add("--limit-modules=java.base,jdk.compiler,jdk.javadoc,jdk.jartool");
performTest("Import", 823, "import module jd", "importModuleListFullJDKPrefix.pass", SOURCE_LEVEL);
}

public void testImportModulePrefix2() throws Exception {
TestCompilerOptionsQueryImplementation.EXTRA_OPTIONS.add("--limit-modules=java.base,jdk.compiler,jdk.javadoc,jdk.jartool");
performTest("Import", 823, "import module jdk.", "importModuleListFullJDKPrefix.pass", SOURCE_LEVEL);
}

public void testImportModulePrefix3() throws Exception {
TestCompilerOptionsQueryImplementation.EXTRA_OPTIONS.add("--limit-modules=java.base,jdk.compiler,jdk.javadoc,jdk.jartool");
performTest("Import", 823, "import module jdk.j", "importModuleListFullJDKJPrefix.pass", SOURCE_LEVEL);
}

@Override
protected void tearDown() throws Exception {
super.tearDown();
TestCompilerOptionsQueryImplementation.EXTRA_OPTIONS.clear();
}

static {
JavacParser.DISABLE_SOURCE_LEVEL_DOWNGRADE = true;
}

@ServiceProvider(service = CompilerOptionsQueryImplementation.class, position = 100)
public static class TestCompilerOptionsQueryImplementation implements CompilerOptionsQueryImplementation {

private static final List<String> EXTRA_OPTIONS = new ArrayList<>();

@Override
public CompilerOptionsQueryImplementation.Result getOptions(FileObject file) {
return new CompilerOptionsQueryImplementation.Result() {
@Override
public List<? extends String> getArguments() {
return EXTRA_OPTIONS;
}

@Override
public void addChangeListener(ChangeListener listener) {}

@Override
public void removeChangeListener(ChangeListener listener) {}
};
}
}
}
8 changes: 4 additions & 4 deletions ...etion/test/unit/src/org/netbeans/modules/java/completion/JavaCompletionTaskBasicTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,15 +140,15 @@ public void testAfterImportKeyword() throws Exception {
}

public void testEmptyFileBeforeTypingImportedPackage() throws Exception {
performTest("Empty", 808, "import ", "staticKeywordAndAllPackages.pass");
performTest("Empty", 808, "import ", "staticKeywordAndAllPackages.pass", "24"); //24 - without "import module"
}

public void testBeforeTypingImportedPackage() throws Exception {
performTest("Simple", 823, "import ", "staticKeywordAndAllPackages.pass");
performTest("Simple", 823, "import ", "staticKeywordAndAllPackages.pass", "24"); //24 - without "import module"
}

public void testBeforeImportedPackage() throws Exception {
performTest("Import", 831, null, "staticKeywordAndAllPackages.pass");
performTest("Import", 831, null, "staticKeywordAndAllPackages.pass", "24"); //24 - without "import module"
}

public void testEmptyFileTypingImportedPackage() throws Exception {
Expand Down Expand Up @@ -264,7 +264,7 @@ public void testEmptyFileTypingImportedPackageAfterErrorInPackageDeclaration() t
}

public void testTypingStaticImportAfterErrorInPackageDeclaration() throws Exception {
performTest("SimpleNoPackage", 808, "package \nimport ", "staticKeywordAndAllPackages.pass");
performTest("SimpleNoPackage", 808, "package \nimport ", "staticKeywordAndAllPackages.pass", "24"); //24 - without "import module"
}

public void TODO_testTypingStaticImportAfterErrorInPreviousImportDeclaration() throws Exception {
Expand Down
1 change: 1 addition & 0 deletions java/java.editor/src/org/netbeans/modules/editor/java/JavaCompletionCollector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,7 @@ public Completion createModuleItem(String moduleName, int substitutionOffset) {
.kind(Completion.Kind.Folder)
.sortText(String.format("%04d%s", 1950, moduleName))
.insertTextFormat(Completion.TextFormat.PlainText)
.textEdit(new TextEdit(substitutionOffset, offset, moduleName))
.build();
}

Expand Down
Loading