fix: No context menu when explorer is in hierarchical mode (#435)

Author: jdneo

jdtls.ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/PackageCommand.java

@@ -63,6 +63,8 @@
 import com.microsoft.jdtls.ext.core.model.NodeKind;
 import com.microsoft.jdtls.ext.core.model.PackageNode;
 import com.microsoft.jdtls.ext.core.model.PackageRootNode;
+import com.microsoft.jdtls.ext.core.model.Trie;
+import com.microsoft.jdtls.ext.core.model.TrieNode;
 
 public class PackageCommand {
 
@@ -347,7 +349,7 @@ private static List<PackageNode> getPackages(PackageParams query, IProgressMonit
                 throw new CoreException(
                         new Status(IStatus.ERROR, JdtlsExtActivator.PLUGIN_ID, String.format("No package root found for %s", query.getPath())));
             }
-            Object[] result = getPackageFragmentRootContent(packageRoot, pm);
+            Object[] result = getPackageFragmentRootContent(packageRoot, query.isHierarchicalView(), pm);
             return convertToPackageNode(result, packageRoot, pm);
         } catch (CoreException e) {
             JdtlsExtActivator.logException("Problem load project package ", e);
@@ -461,18 +463,45 @@ private static List<PackageNode> getFolderChildren(PackageParams query, IProgres
         return Collections.emptyList();
     }
 
-    private static Object[] getPackageFragmentRootContent(IPackageFragmentRoot root, IProgressMonitor pm) throws CoreException {
+    /**
+     * Return the packages of the package root. Note that when the explorer is in hierarchical mode,
+     * We also need to return the deepest common parent packages, for example:
+     * - com.microsoft.example <-- this common parent package should be returned.
+     *   +-- model
+     *   +-- handler
+     * Here we use a Trie to find all these packages.
+     *
+     * @param root the package fragment root
+     * @param isHierarchicalView whether the explorer is in hierarchical mode or not
+     * @param pm the progress monitor
+     */
+    private static Object[] getPackageFragmentRootContent(IPackageFragmentRoot root, boolean isHierarchicalView, IProgressMonitor pm) throws CoreException {
         ArrayList<Object> result = new ArrayList<>();
-        for (IJavaElement child : root.getChildren()) {
-            IPackageFragment fragment = (IPackageFragment) child;
-            if (fragment.hasChildren()) {
-                result.add(child);
-            } else if (fragment.getNonJavaResources().length > 0) { // some package has non-java files
-                result.add(fragment);
-            } else if (!fragment.hasSubpackages()) {
-                result.add(fragment);
+        if (isHierarchicalView) {
+            Map<String, IJavaElement> map = new HashMap<>();
+            for (IJavaElement child : root.getChildren()) {
+                map.put(child.getElementName(), child);
+            }
+            Trie<IJavaElement> trie = new Trie<>(map);
+            for (TrieNode<IJavaElement> node : trie.getAllNodes()) {
+                if (node.value == null) {
+                    continue;
+                }
+                IPackageFragment fragment = (IPackageFragment) node.value;
+                if (fragment.hasChildren() || fragment.getNonJavaResources().length > 0
+                        || !fragment.hasSubpackages() || node.children.size() > 1) {
+                    result.add(fragment);
+                }
+            }
+        } else {
+            for (IJavaElement child : root.getChildren()) {
+                IPackageFragment fragment = (IPackageFragment) child;
+                if (fragment.hasChildren() || fragment.getNonJavaResources().length > 0 || !fragment.hasSubpackages()) {
+                    result.add(fragment);
+                }
             }
         }
+
         Object[] nonJavaResources = root.getNonJavaResources();
         Collections.addAll(result, nonJavaResources);
 

jdtls.ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/PackageParams.java

@@ -29,9 +29,19 @@ public class PackageParams {
 
     private String rootPath;
 
+    private boolean isHierarchicalView;
+
     public PackageParams() {
     }
 
+    public boolean isHierarchicalView() {
+        return isHierarchicalView;
+    }
+
+    public void setHierarchicalView(boolean isHierarchicalView) {
+        this.isHierarchicalView = isHierarchicalView;
+    }
+
     public PackageParams(NodeKind kind, String projectUri) {
         this.kind = kind;
         this.projectUri = projectUri;

jdtls.ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/model/Trie.java

@@ -0,0 +1,57 @@
+/*******************************************************************************
+ * Copyright (c) 2021 Microsoft Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     Microsoft Corporation - initial API and implementation
+ *******************************************************************************/
+
+package com.microsoft.jdtls.ext.core.model;
+
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import org.apache.commons.lang3.StringUtils;
+
+public class Trie<T> {
+    private TrieNode<T> root = new TrieNode<>();
+    private Set<TrieNode<T>> allNodes = new HashSet<>();
+
+    public Trie(Map<String, T> entries) {
+        for (Map.Entry<String, T> entry : entries.entrySet()) {
+            insert(entry.getKey(), entry.getValue());
+        }
+    }
+
+    public Set<TrieNode<T>> getAllNodes() {
+        return allNodes;
+    }
+
+    public void insert(String name, T value) {
+        if (StringUtils.isBlank(name)) {
+            return;
+        }
+
+        String[] names = name.split("\\.");
+        TrieNode<T> currentNode = this.root;
+        for (int i = 0; i < names.length; i++) {
+            TrieNode<T> node;
+            if (currentNode.children.containsKey(names[i])) {
+                node = currentNode.children.get(names[i]);
+            } else {
+                node = new TrieNode<T>(names[i], null);
+                currentNode.children.put(names[i], node);
+                allNodes.add(node);
+            }
+            if (i == names.length - 1) {
+                node.value = value;
+            }
+
+            currentNode = node;
+        }
+    }
+}

jdtls.ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/model/TrieNode.java

@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright (c) 2021 Microsoft Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     Microsoft Corporation - initial API and implementation
+ *******************************************************************************/
+
+package com.microsoft.jdtls.ext.core.model;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+public class TrieNode<T> {
+    public String name;
+    public Map<String, TrieNode<T>> children = new LinkedHashMap<>();
+    public T value;
+
+    public TrieNode() {
+    }
+
+    public TrieNode(String name, T value) {
+        this.name = name;
+        this.value = value;
+    }
+}

src/views/packageRootNode.ts

@@ -6,6 +6,7 @@ import { Explorer } from "../constants";
 import { Jdtls } from "../java/jdtls";
 import { INodeData, NodeKind } from "../java/nodeData";
 import { IPackageRootNodeData, PackageRootKind } from "../java/packageRootNodeData";
+import { Settings } from "../settings";
 import { ContainerNode } from "./containerNode";
 import { DataNode } from "./dataNode";
 import { ExplorerNode } from "./explorerNode";
@@ -27,6 +28,7 @@ export class PackageRootNode extends DataNode {
             projectUri: this._project.nodeData.uri,
             rootPath: this.nodeData.path,
             handlerIdentifier: this.nodeData.handlerIdentifier,
+            isHierarchicalView: Settings.isHierarchicalView(),
         });
     }