Skip to content

Do not display workspace link '_' for invisible project #210

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

Merged
jdneo merged 3 commits into from
Aug 31, 2020
Merged

Do not display workspace link '_' for invisible project #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4aa0b5
Do not display workspace link '_' for invisible project
Vigilans Nov 19, 2019
d050d24
Skip the package root node if its name is empty
jdneo Aug 26, 2020
e53e7d9
Fix typo
jdneo Aug 26, 2020
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
62 changes: 37 additions & 25 deletions jdtls.ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/PackageCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,12 @@ public static List<PackageNode> resolvePath(List<Object> arguments, IProgressMon
if (isClassFile) {
result.add(PackageNode.createNodeForVirtualContainer(pkgRoot));
}
result.add(PackageNode.createNodeForPackageFragmentRoot(pkgRoot));
// for invisible project, removing the '_' link name may cause an empty named package root
// in this case, we will avoid that 'empty' node from displaying
PackageNode pkgRootNode = PackageNode.createNodeForPackageFragmentRoot(pkgRoot);
if (StringUtils.isNotBlank(pkgRootNode.getName())) {
result.add(pkgRootNode);
}
result.add(PackageNode.createNodeForPackageFragment(packageFragment));
result.add(PackageNode.createNodeForPrimaryType(typeRoot.findPrimaryType()));
} else if (ExtUtils.isJarResourceUri(uri)) {
Expand Down Expand Up @@ -171,15 +176,16 @@ public static List<PackageNode> resolvePath(List<Object> arguments, IProgressMon
IJavaElement parentJavaElement = JavaCore.create(parent);
if (parent instanceof IFolder && parentJavaElement instanceof IPackageFragment) {
IPackageFragment packageFragment = (IPackageFragment) parentJavaElement;
IPackageFragmentRoot pkgRoot = (IPackageFragmentRoot) packageFragment.getParent();
PackageNode rootNode = null;

rootNode = new PackageRootNode(pkgRoot,
ExtUtils.removeProjectSegment(packageFragment.getJavaProject().getElementName(), pkgRoot.getPath()).toPortableString(),
NodeKind.PACKAGEROOT);

result.add(PackageNode.createNodeForProject(packageFragment));
result.add(rootNode);

IPackageFragmentRoot pkgRoot = (IPackageFragmentRoot) packageFragment.getAncestor(IJavaElement.PACKAGE_FRAGMENT_ROOT);
// for invisible project, removing the '_' link name may cause an empty named package root
// in this case, we will avoid that 'empty' node from displaying
PackageNode pkgRootNode = PackageNode.createNodeForPackageFragmentRoot(pkgRoot);
if (StringUtils.isNotBlank(pkgRootNode.getName())) {
result.add(pkgRootNode);
}
result.add(PackageNode.createNodeForPackageFragment(packageFragment));

PackageNode item = new PackageNode(resource.getName(), resource.getFullPath().toPortableString(), NodeKind.FILE);
Expand Down Expand Up @@ -276,24 +282,30 @@ private static List<PackageNode> getPackageFragmentRoots(PackageParams query, IP
if (containerEntry != null) {
IPackageFragmentRoot[] packageFragmentRoots = javaProject.findPackageFragmentRoots(containerEntry);
for (IPackageFragmentRoot fragmentRoot : packageFragmentRoots) {
String displayName = fragmentRoot.getElementName();
if (fragmentRoot.getKind() == IPackageFragmentRoot.K_SOURCE) {
displayName = ExtUtils.removeProjectSegment(javaProject.getElementName(), fragmentRoot.getPath()).toPortableString();
}
PackageRootNode node = new PackageRootNode(fragmentRoot, displayName, NodeKind.PACKAGEROOT);
node.setHandlerIdentifier(fragmentRoot.getHandleIdentifier());
children.add(node);
if (fragmentRoot instanceof JrtPackageFragmentRoot) {
node.setModuleName(fragmentRoot.getModuleDescription().getElementName());
}

IClasspathEntry resolvedClasspathEntry = fragmentRoot.getResolvedClasspathEntry();
if (resolvedClasspathEntry != null) {
Map<String, String> attributes = new HashMap<>();
for (IClasspathAttribute attribute : resolvedClasspathEntry.getExtraAttributes()) {
attributes.put(attribute.getName(), attribute.getValue());
PackageRootNode node = PackageNode.createNodeForPackageFragmentRoot(fragmentRoot);
if (StringUtils.isNotBlank(node.getName())) {
node.setHandlerIdentifier(fragmentRoot.getHandleIdentifier());
if (fragmentRoot instanceof JrtPackageFragmentRoot) {
node.setModuleName(fragmentRoot.getModuleDescription().getElementName());
}
node.setAttributes(attributes);

IClasspathEntry resolvedClasspathEntry = fragmentRoot.getResolvedClasspathEntry();
if (resolvedClasspathEntry != null) {
Map<String, String> attributes = new HashMap<>();
for (IClasspathAttribute attribute : resolvedClasspathEntry.getExtraAttributes()) {
attributes.put(attribute.getName(), attribute.getValue());
}
node.setAttributes(attributes);
}

children.add(node);
} else {
// for invisible project, the package root name may become empty after removing the '_',
// in this case, we skip this root node from showing in the explorer and keep finding its children.
PackageParams subQuery = new PackageParams(NodeKind.PACKAGEROOT, query.getProjectUri(),
query.getPath(), fragmentRoot.getHandleIdentifier());
List<PackageNode> packageNodes = getPackages(subQuery, pm);
children.addAll(packageNodes);
}
}
return children;
Expand Down
30 changes: 9 additions & 21 deletions jdtls.ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/PackageParams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,35 +27,22 @@ public class PackageParams {

private String handlerIdentifier;

private String rootPath;

public PackageParams() {
}

public String getHandlerIdentifier() {
return handlerIdentifier;
}

public void setHandlerIdentifier(String handlerIdentifier) {
this.handlerIdentifier = handlerIdentifier;
}

public PackageParams(NodeKind kind, String projectUri) {
this.kind = kind;
this.projectUri = projectUri;
}

public PackageParams(NodeKind kind, String projectUri, String path) {
this.kind = kind;
this.projectUri = projectUri;
this(kind, projectUri);
this.path = path;
}

public PackageParams(NodeKind kind, String projectUri, String path, String rootPath) {
this.kind = kind;
this.projectUri = projectUri;
this.path = path;
this.rootPath = rootPath;
public PackageParams(NodeKind kind, String projectUri, String path, String handlerIdentifier) {
this(kind, projectUri, path);
this.handlerIdentifier = handlerIdentifier;
}

public NodeKind getKind() {
Expand All @@ -82,11 +69,12 @@ public void setPath(String nodePath) {
this.path = nodePath;
}

public String getRootPath() {
return rootPath;
public String getHandlerIdentifier() {
return handlerIdentifier;
}

public void setRootPath(String rootPath) {
this.rootPath = rootPath;
public void setHandlerIdentifier(String handlerIdentifier) {
this.handlerIdentifier = handlerIdentifier;
}

}
13 changes: 10 additions & 3 deletions jdtls.ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/ProjectCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import java.io.File;
import java.io.FileOutputStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
Expand Down Expand Up @@ -84,13 +85,19 @@ public MainClassInfo(String name, String path) {

public static List<PackageNode> listProjects(List<Object> arguments, IProgressMonitor monitor) {
String workspaceUri = (String) arguments.get(0);
IPath workspacePath = ResourceUtils.canonicalFilePathFromURI(workspaceUri);
String invisibleProjectName = ProjectUtils.getWorkspaceInvisibleProjectName(workspacePath);
IPath workspaceFolderPath = ResourceUtils.canonicalFilePathFromURI(workspaceUri);
String invisibleProjectName = ProjectUtils.getWorkspaceInvisibleProjectName(workspaceFolderPath);

IProject[] projects = getWorkspaceRoot().getProjects();
ArrayList<PackageNode> children = new ArrayList<>();
List<IPath> paths = Collections.singletonList(workspaceFolderPath);
for (IProject project : projects) {
if (!project.isAccessible() || !ProjectUtils.isJavaProject(project) || Objects.equals(project, JavaLanguageServerPlugin.getProjectsManager().getDefaultProject())) {
if (!project.isAccessible() || !ProjectUtils.isJavaProject(project)) {
continue;
}
// Ignore all the projects that's not contained in the workspace folder, except for the invisible project.
// This check is needed in multi-root scenario.
if ((!ResourceUtils.isContainedIn(project.getLocation(), paths) && !Objects.equals(project.getName(), invisibleProjectName))) {
continue;
}
PackageNode projectNode = PackageNode.createNodeForProject(JavaCore.create(project));
Expand Down
21 changes: 16 additions & 5 deletions ....ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/model/PackageNode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
Expand All @@ -32,6 +33,7 @@
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.ls.core.internal.JDTUtils;
import org.eclipse.jdt.ls.core.internal.ProjectUtils;

import com.microsoft.jdtls.ext.core.ExtUtils;
import com.microsoft.jdtls.ext.core.JdtlsExtActivator;
Expand Down Expand Up @@ -194,19 +196,28 @@ public static PackageNode createNodeForVirtualContainer(IPackageFragmentRoot pkg

}

public static PackageNode createNodeForPackageFragmentRoot(IPackageFragmentRoot pkgRoot) throws JavaModelException {
public static PackageRootNode createNodeForPackageFragmentRoot(IPackageFragmentRoot pkgRoot) throws JavaModelException {
String displayName = pkgRoot.getElementName();
boolean isSourcePath = pkgRoot.getKind() == IPackageFragmentRoot.K_SOURCE;
if (!isSourcePath) {
IClasspathEntry entry = pkgRoot.getRawClasspathEntry();
// Process Referenced Variable
if (entry.getEntryKind() == IClasspathEntry.CPE_VARIABLE) {
return createNodeForClasspathVariable(entry);
} else {
return new PackageRootNode(pkgRoot, pkgRoot.getElementName(), NodeKind.PACKAGEROOT);
return new PackageRootNode(pkgRoot, displayName, NodeKind.PACKAGEROOT);
}
} else {
return new PackageRootNode(pkgRoot,
ExtUtils.removeProjectSegment(pkgRoot.getJavaProject().getElementName(), pkgRoot.getPath()).toPortableString(), NodeKind.PACKAGEROOT);
IJavaProject javaProject = pkgRoot.getJavaProject();
IPath relativePath = pkgRoot.getPath();
if (pkgRoot.getJavaProject().getPath().isPrefixOf(relativePath)) {
relativePath = relativePath.makeRelativeTo(javaProject.getPath());
}
if (Objects.equals(ProjectUtils.WORKSPACE_LINK, relativePath.segment(0))) {
relativePath = relativePath.removeFirstSegments(1); // Remove the '_' prefix
}
displayName = relativePath.toPortableString();
return new PackageRootNode(pkgRoot, displayName, NodeKind.PACKAGEROOT);
}
}

Expand Down Expand Up @@ -278,7 +289,7 @@ public static PackageNode createNodeForPrimaryType(IType type) {
* referenced variable's classpath entry
* @return correspond package node
*/
public static PackageNode createNodeForClasspathVariable(IClasspathEntry classpathEntry) {
public static PackageRootNode createNodeForClasspathVariable(IClasspathEntry classpathEntry) {
IClasspathEntry entry = JavaCore.getResolvedClasspathEntry(classpathEntry);
String name = classpathEntry.getPath().toPortableString();
String path = entry.getPath().toPortableString();
Expand Down
7 changes: 3 additions & 4 deletions src/syncHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,11 @@ import * as path from "path";
import { commands, Disposable, FileSystemWatcher, Uri, workspace } from "vscode";
import { instrumentOperation } from "vscode-extension-telemetry-wrapper";
import { Commands } from "./commands";
import { NodeKind } from "./java/nodeData";
import { Settings } from "./settings";
import { DataNode } from "./views/dataNode";
import { ExplorerNode } from "./views/explorerNode";
import { HierarchicalPackageRootNode } from "./views/hierarchicalPackageRootNode";
import { explorerNodeCache } from "./views/nodeCache/explorerNodeCache";
import { PackageRootNode } from "./views/packageRootNode";

const ENABLE_AUTO_REFRESH: string = "java.view.package.enableAutoRefresh";
const DISABLE_AUTO_REFRESH: string = "java.view.package.disableAutoRefresh";
Expand Down Expand Up @@ -75,7 +74,7 @@ class SyncHandler implements Disposable {
if (Settings.isHierarchicalView()) {
// TODO: has to get the hierarchical package root node due to the java side implementation
// because currently it will only get the types for a package node but no child packages.
while (!(node instanceof HierarchicalPackageRootNode)) {
while (node && node.nodeData.kind !== NodeKind.PackageRoot) {
node = <DataNode>node.getParent();
}
return node;
Expand All @@ -88,7 +87,7 @@ class SyncHandler implements Disposable {
} else {
// the direct parent is not rendered in the explorer, the returned node
// is other package fragment, we need to refresh the package fragment root.
while (!(node instanceof PackageRootNode)) {
while (node && node.nodeData.kind !== NodeKind.PackageRoot) {
node = <DataNode>node.getParent();
}
return node;
Expand Down
3 changes: 3 additions & 0 deletions src/views/dependencyDataProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,9 @@ export class DependencyDataProvider implements TreeDataProvider<ExplorerNode> {
}

private doRefresh(element?: ExplorerNode): void {
if (!element) {
this._rootItems = undefined;
}
explorerNodeCache.removeNodeChildren(element);
this._onDidChangeTreeData.fire(element);
}
Expand Down
1 change: 0 additions & 1 deletion src/views/folderNode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ export class FolderNode extends DataNode {
kind: NodeKind.Folder,
projectUri: this._project.uri,
path: this.path,
rootPath: this._rootNode.path,
handlerIdentifier: this._rootNode.handlerIdentifier,
});
}
Expand Down
3 changes: 1 addition & 2 deletions src/views/packageNode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ export class PackageNode extends DataNode {
kind: NodeKind.Package,
projectUri: this._project.nodeData.uri,
path: this.nodeData.name,
rootPath: this._rootNode.path,
handlerIdentifier: this.nodeData.handlerIdentifier,
});
}
Expand Down Expand Up @@ -49,7 +48,7 @@ export class PackageNode extends DataNode {

protected get contextValue(): string {
const parentData = <IPackageRootNodeData> this._rootNode.nodeData;
if (parentData.entryKind === PackageRootKind.K_SOURCE) {
if (parentData.entryKind === PackageRootKind.K_SOURCE || parentData.kind === NodeKind.Project) {
return `${Explorer.ContextValueType.Package}+source`;
} else if (parentData.entryKind === PackageRootKind.K_BINARY) {
return `${Explorer.ContextValueType.Package}+binary`;
Expand Down
1 change: 0 additions & 1 deletion src/views/packageRootNode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ export class PackageRootNode extends DataNode {
return Jdtls.getPackageData({
kind: NodeKind.PackageRoot,
projectUri: this._project.nodeData.uri,
rootPath: this.nodeData.path,
handlerIdentifier: this.nodeData.handlerIdentifier,
});
}
Expand Down
Loading