Implement related node selection generically

Author: oowekyala

src/main/java/net/sourceforge/pmd/util/fxdesigner/util/DesignerUtil.java

@@ -38,6 +38,7 @@
 import net.sourceforge.pmd.lang.symboltable.NameOccurrence;
 import net.sourceforge.pmd.lang.symboltable.Scope;
 import net.sourceforge.pmd.lang.symboltable.ScopedNode;
+import net.sourceforge.pmd.util.designerbindings.RelatedNodesSelector;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRoot;
 
 import com.sun.javafx.fxml.builder.ProxyBuilder;
@@ -305,7 +306,11 @@ public static Optional<String> stackTraceToXPath(Throwable e) {
     }
 
 
-    public static List<NameOccurrence> getNameOccurrences(ScopedNode node) {
+    public static RelatedNodesSelector getDefaultRelatedNodesSelector() {
+        return node -> node instanceof ScopedNode ? getNameOccurrences((ScopedNode) node) : Collections.emptyList();
+    }
+
+    private static List<Node> getNameOccurrences(ScopedNode node) {
 
         // For MethodNameDeclaration the scope is the method scope, which is not the scope it is declared
         // in but the scope it declares! That means that getDeclarations().get(declaration) returns null
@@ -336,6 +341,7 @@ public static List<NameOccurrence> getNameOccurrences(ScopedNode node) {
 
                              return usages;
                          })
+                         .map(it -> it.stream().<Node>map(NameOccurrence::getLocation).collect(Collectors.toList()))
                          .orElse(Collections.emptyList());
     }
 

src/main/java/net/sourceforge/pmd/util/fxdesigner/util/controls/NodeEditionCodeArea.java

@@ -21,7 +21,6 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.function.IntFunction;
-import java.util.stream.Collectors;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.fxmisc.richtext.LineNumberFactory;
@@ -34,9 +33,11 @@
 import org.reactfx.value.Var;
 
 import net.sourceforge.pmd.lang.Language;
+import net.sourceforge.pmd.lang.LanguageVersion;
+import net.sourceforge.pmd.lang.LanguageVersionHandler;
 import net.sourceforge.pmd.lang.ast.Node;
-import net.sourceforge.pmd.lang.symboltable.NameOccurrence;
-import net.sourceforge.pmd.lang.symboltable.ScopedNode;
+import net.sourceforge.pmd.util.designerbindings.DesignerBindings;
+import net.sourceforge.pmd.util.designerbindings.RelatedNodesSelector;
 import net.sourceforge.pmd.util.fxdesigner.SourceEditorController;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRoot;
 import net.sourceforge.pmd.util.fxdesigner.app.NodeSelectionSource;
@@ -84,28 +85,37 @@ public class NodeEditionCodeArea extends HighlightLayerCodeArea<StyleLayerIds> i
     private final Var<Node> currentFocusNode = Var.newSimpleVar(null);
     private final Var<List<Node>> currentRuleResults = Var.newSimpleVar(Collections.emptyList());
     private final Var<List<Node>> currentErrorNodes = Var.newSimpleVar(Collections.emptyList());
-    private final Var<List<NameOccurrence>> currentNameOccurrences = Var.newSimpleVar(Collections.emptyList());
+    private final Var<List<Node>> currentRelatedNodes = Var.newSimpleVar(Collections.emptyList());
     private final DesignerRoot designerRoot;
     private final EventSource<NodeSelectionEvent> selectionEvts = new EventSource<>();
 
-
+    private final Val<RelatedNodesSelector> relatedNodesSelector;
 
     /** Only provided for scenebuilder, not used at runtime. */
     public NodeEditionCodeArea() {
         super(StyleLayerIds.class);
-        designerRoot = null;
+        this.designerRoot = null;
+        this.relatedNodesSelector = null;
     }
 
     public NodeEditionCodeArea(@NamedArg("designerRoot") DesignerRoot root) {
         super(StyleLayerIds.class);
 
         this.designerRoot = root;
+        this.relatedNodesSelector =
+            root.getService(DesignerRoot.AST_MANAGER)
+                .languageVersionProperty()
+                .map(LanguageVersion::getLanguageVersionHandler)
+                .map(LanguageVersionHandler::getDesignerBindings)
+                .map(DesignerBindings::getRelatedNodesSelector)
+                .orElseConst(DesignerUtil.getDefaultRelatedNodesSelector());
+
 
         setParagraphGraphicFactory(defaultLineNumberFactory());
 
         currentRuleResultsProperty().values().subscribe(this::highlightXPathResults);
         currentErrorNodesProperty().values().subscribe(this::highlightErrorNodes);
-        currentNameOccurrences.values().subscribe(this::highlightNameOccurrences);
+        currentRelatedNodesProperty().values().subscribe(this::highlightRelatedNodes);
 
         initNodeSelectionHandling(designerRoot, selectionEvts, true);
 
@@ -251,8 +261,8 @@ public final Var<List<Node>> currentErrorNodesProperty() {
     }
 
 
-    public Var<List<NameOccurrence>> currentNameOccurrencesProperty() {
-        return currentNameOccurrences;
+    public Var<List<Node>> currentRelatedNodesProperty() {
+        return currentRelatedNodes;
     }
 
 
@@ -263,8 +273,8 @@ private void highlightXPathResults(Collection<? extends Node> nodes) {
 
 
     /** Highlights name occurrences (secondary highlight). */
-    private void highlightNameOccurrences(Collection<? extends NameOccurrence> occs) {
-        styleNodes(occs.stream().map(NameOccurrence::getLocation).collect(Collectors.toList()), StyleLayerIds.NAME_OCCURRENCE, true);
+    private void highlightRelatedNodes(Collection<? extends Node> occs) {
+        styleNodes(occs, StyleLayerIds.NAME_OCCURRENCE, true);
     }
 
 
@@ -305,10 +315,13 @@ public void setFocusNode(final Node node, DataHolder options) {
         // editor is only restyled if the selection has changed
         Platform.runLater(() -> styleNodes(node == null ? emptyList() : singleton(node), StyleLayerIds.FOCUS, true));
 
-        if (node instanceof ScopedNode) {
-            // not null as well
-            Platform.runLater(() -> highlightNameOccurrences(DesignerUtil.getNameOccurrences((ScopedNode) node)));
-        }
+        Platform.runLater(() -> relatedNodesSelector.ifPresent(selector -> {
+            List<Node> nodes = selector.getHighlightedNodesWhenSelecting(node);
+            highlightRelatedNodes(Objects.requireNonNull(nodes,
+                                                         "RelatedNodesSelection for language "
+                                                             + globalLanguageProperty().getValue().getName()
+                                                             + " returned null"));
+        }));
     }