Merge branch 'use-designer-bindings'

Author: oowekyala

.idea/runConfigurations/Designer__JRE_11_.xml

@@ -5,29 +5,37 @@
 package net.sourceforge.pmd.util.fxdesigner;
 
 import java.util.Arrays;
-import java.util.Collections;
+import java.util.Comparator;
 import java.util.Iterator;
 import java.util.List;
 
 import org.reactfx.EventStreams;
+import org.reactfx.collection.LiveList;
 import org.reactfx.value.Val;
 import org.reactfx.value.Var;
 
 import net.sourceforge.pmd.lang.ast.Node;
 import net.sourceforge.pmd.lang.ast.xpath.Attribute;
+import net.sourceforge.pmd.util.designerbindings.DesignerBindings;
+import net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo;
+import net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings;
 import net.sourceforge.pmd.util.fxdesigner.app.AbstractController;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRoot;
 import net.sourceforge.pmd.util.fxdesigner.app.NodeSelectionSource;
 import net.sourceforge.pmd.util.fxdesigner.util.DataHolder;
 import net.sourceforge.pmd.util.fxdesigner.util.DesignerUtil;
 import net.sourceforge.pmd.util.fxdesigner.util.beans.SettingsPersistenceUtil.PersistentProperty;
+import net.sourceforge.pmd.util.fxdesigner.util.controls.AttributeNameTableCell;
 
 import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
 import javafx.fxml.FXML;
 import javafx.scene.control.Label;
 import javafx.scene.control.ListView;
+import javafx.scene.control.TableColumn;
+import javafx.scene.control.TableView;
 import javafx.scene.control.ToggleButton;
+import javafx.scene.control.Tooltip;
 
 /**
  * The "Attributes" pane.
@@ -36,14 +44,22 @@
  */
 public class NodeDetailPaneController extends AbstractController implements NodeSelectionSource {
 
-    /** List of attribute names that are ignored if {@link #isHideCommonAttributes()} is true. */
+    /**
+     * List of attribute names that are ignored if {@link #isHideCommonAttributes()} is true.
+     */
     private static final List<String> IGNORABLE_ATTRIBUTES =
         Arrays.asList("BeginLine", "EndLine", "BeginColumn", "EndColumn", "FindBoundary", "SingleLine");
 
+    @FXML
+    private TableView<Attribute> xpathAttributesTableView;
+    @FXML
+    private TableColumn<Attribute, String> attrValueColumn;
+    @FXML
+    private TableColumn<Attribute, String> attrNameColumn;
     @FXML
     private ToggleButton hideCommonAttributesToggle;
     @FXML
-    private ListView<String> xpathAttributesListView;
+    private ListView<String> additionalInfoListView;
 
 
     protected NodeDetailPaneController(DesignerRoot root) {
@@ -52,7 +68,7 @@ protected NodeDetailPaneController(DesignerRoot root) {
 
     @Override
     protected void beforeParentInit() {
-        xpathAttributesListView.setPlaceholder(new Label("No available attributes"));
+        additionalInfoListView.setPlaceholder(new Label("No additional info"));
 
         Val<Node> currentSelection = initNodeSelectionHandling(getDesignerRoot(), EventStreams.never(), false);
 
@@ -64,42 +80,56 @@ protected void beforeParentInit() {
             .distinct()
             .subscribe(show -> setFocusNode(currentSelection.getValue(), new DataHolder()));
 
+
+        attrValueColumn.setCellValueFactory(param -> Val.constant(DesignerUtil.attrToXpathString(param.getValue())));
+        attrNameColumn.setCellValueFactory(param -> Val.constant("@" + param.getValue().getName()));
+        attrNameColumn.setCellFactory(col -> new AttributeNameTableCell());
+
+        Label valueColGraphic = new Label("Value");
+        valueColGraphic.setTooltip(new Tooltip("This is the XPath 2.0 representation"));
+        attrValueColumn.setGraphic(valueColGraphic);
     }
 
     @Override
     public void setFocusNode(final Node node, DataHolder options) {
-        xpathAttributesListView.setItems(getAttributes(node));
+        xpathAttributesTableView.setItems(getAttributes(node));
+        if (node == null) {
+            additionalInfoListView.setItems(FXCollections.emptyObservableList());
+            return;
+        }
+        DesignerBindings bindings = languageBindingsProperty().getOrElse(DefaultDesignerBindings.getInstance());
+        ObservableList<AdditionalInfo> additionalInfo = FXCollections.observableArrayList(bindings.getAdditionalInfo(node));
+        additionalInfo.sort(Comparator.comparing(AdditionalInfo::getSortKey));
+        additionalInfoListView.setItems(LiveList.map(additionalInfo, AdditionalInfo::getDisplayString));
     }
 
     /**
      * Gets the XPath attributes of the node for display within a listview.
      */
-    private ObservableList<String> getAttributes(Node node) {
+    private ObservableList<Attribute> getAttributes(Node node) {
         if (node == null) {
+            xpathAttributesTableView.setPlaceholder(new Label("Select a node to show its attributes"));
             return FXCollections.emptyObservableList();
         }
 
-        ObservableList<String> result = FXCollections.observableArrayList();
+        ObservableList<Attribute> result = FXCollections.observableArrayList();
         Iterator<Attribute> attributeAxisIterator = node.getXPathAttributesIterator();
         while (attributeAxisIterator.hasNext()) {
             Attribute attribute = attributeAxisIterator.next();
 
             if (!(isHideCommonAttributes() && IGNORABLE_ATTRIBUTES.contains(attribute.getName()))) {
 
                 try {
-                    // TODO the display should be handled in a ListCell
-                    result.add(attribute.getName() + " = "
-                                   + ((attribute.getValue() != null) ? attribute.getStringValue() : "null"));
+                    result.add(attribute);
                 } catch (Exception ignored) {
                     // some attributes throw eg numberformat exceptions
                 }
 
             }
         }
 
-        DesignerUtil.getResolvedType(node).map(t -> "typeIs() = " + t).ifPresent(result::add);
-
-        Collections.sort(result);
+        result.sort(Comparator.comparing(Attribute::getName));
+        xpathAttributesTableView.setPlaceholder(new Label("No available attributes"));
         return result;
     }
 

.idea/runConfigurations/Designer__JRE_8_.xml

@@ -11,6 +11,8 @@
 
 import net.sourceforge.pmd.lang.Language;
 import net.sourceforge.pmd.lang.LanguageVersion;
+import net.sourceforge.pmd.lang.LanguageVersionHandler;
+import net.sourceforge.pmd.util.designerbindings.DesignerBindings;
 import net.sourceforge.pmd.util.fxdesigner.SourceEditorController;
 import net.sourceforge.pmd.util.fxdesigner.app.services.AppServiceDescriptor;
 import net.sourceforge.pmd.util.fxdesigner.app.services.EventLogger;
@@ -61,6 +63,14 @@ default LanguageVersion getGlobalLanguageVersion() {
     }
 
 
+    default Val<DesignerBindings> languageBindingsProperty() {
+        return getService(DesignerRoot.AST_MANAGER)
+            .languageVersionProperty()
+            .map(LanguageVersion::getLanguageVersionHandler)
+            .map(LanguageVersionHandler::getDesignerBindings);
+    }
+
+
     /**
      * Gets the logger of the application. Events pushed to the logger
      * are filtered then forwarded to the Event Log control.

.idea/watcherTasks.xml

@@ -76,6 +76,7 @@ public interface DesignerRoot {
     AppServiceDescriptor<TreeRendererRegistry> TREE_RENDERER_REGISTRY = new AppServiceDescriptor<>(TreeRendererRegistry.class);
 
 
+
     /**
      * Gets the instance of a service shared by the app.
      *

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

@@ -5,7 +5,6 @@
 package net.sourceforge.pmd.util.fxdesigner.util;
 
 import java.io.PrintStream;
-import java.lang.reflect.InvocationTargetException;
 import java.net.URL;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -27,12 +26,14 @@
 import java.util.stream.Collectors;
 
 import org.apache.commons.lang3.ArrayUtils;
+import org.apache.commons.lang3.StringEscapeUtils;
 import org.apache.commons.lang3.exception.ExceptionUtils;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.reactfx.Subscription;
 import org.reactfx.value.Var;
 
 import net.sourceforge.pmd.lang.ast.Node;
+import net.sourceforge.pmd.lang.ast.xpath.Attribute;
 import net.sourceforge.pmd.lang.rule.xpath.XPathRuleQuery;
 import net.sourceforge.pmd.lang.symboltable.NameDeclaration;
 import net.sourceforge.pmd.lang.symboltable.NameOccurrence;
@@ -50,6 +51,7 @@
 import javafx.scene.control.Toggle;
 import javafx.scene.control.ToggleGroup;
 import javafx.scene.control.Tooltip;
+import javafx.scene.text.Text;
 import javafx.util.BuilderFactory;
 import javafx.util.Callback;
 import javafx.util.StringConverter;
@@ -396,26 +398,6 @@ private static void updateProgress(double progress) {
         System.out.print(builder);
     }
 
-    /**
-     * Attempts to retrieve the type of a java TypeNode reflectively.
-     */
-    public static Optional<Class<?>> getResolvedType(Node node) {
-        // TODO maybe put some equivalent to TypeNode inside pmd-core
-
-        try {
-            return Optional.of(node.getClass().getMethod("getType"))
-                           .filter(m -> m.getReturnType() == Class.class)
-                           .map(m -> {
-                               try {
-                                   return m.invoke(node);
-                               } catch (IllegalAccessException | InvocationTargetException e) {
-                                   return null;
-                               }
-                           }).map(type -> (Class<?>) type);
-        } catch (NoSuchMethodException e) {
-            return Optional.empty();
-        }
-    }
 
     public static BuilderFactory customBuilderFactory(@NonNull DesignerRoot owner) {
         return type -> {
@@ -434,4 +416,23 @@ public static BuilderFactory customBuilderFactory(@NonNull DesignerRoot owner) {
             }
         };
     }
+
+
+    public static String attrToXpathString(Attribute attr) {
+        String stringValue = attr.getStringValue();
+        Object v = attr.getValue();
+        if (v instanceof String || v instanceof Enum) {
+            stringValue = "\"" + StringEscapeUtils.escapeJava(stringValue) + "\"";
+        } else if (v instanceof Boolean) {
+            stringValue = v + "()";
+        }
+        return String.valueOf(stringValue);
+    }
+
+
+    public static Text makeStyledText(String text, String cssClass) {
+        Text matchLabel = new Text(text);
+        matchLabel.getStyleClass().add(cssClass);
+        return matchLabel;
+    }
 }

src/main/java/net/sourceforge/pmd/util/fxdesigner/app/ApplicationComponent.java

@@ -8,6 +8,8 @@
 import java.util.function.Function;
 import java.util.stream.Stream;
 
+import net.sourceforge.pmd.util.fxdesigner.util.DesignerUtil;
+
 import javafx.scene.text.Text;
 import javafx.scene.text.TextFlow;
 
@@ -28,10 +30,18 @@ private StringMatchUtil() {
     /**
      * Selects the best {@link MatchResult} given a list of candidates and a query.
      *
-     * The results are useless unless you provide the {@link MatchSelector} that
-     * suits your use case.
+     * <p>The results are useless unless you provide the {@link MatchSelector} that
+     * suits your use case (limiter).
+     *
+     * @param candidates     List of stuff to sort
+     * @param matchExtractor Extracts the searchable text from an item
+     * @param limiter        Selects the best candidates, may process them further to break ties
+     * @param query          Text to search for
      */
-    public static <T> Stream<MatchResult<T>> filterResults(List<T> candidates, Function<T, String> matchExtractor, String query, MatchSelector<T> limiter) {
+    public static <T> Stream<MatchResult<T>> filterResults(List<? extends T> candidates,
+                                                           Function<? super T, String> matchExtractor,
+                                                           String query,
+                                                           MatchSelector<T> limiter) {
         if (query.length() < MIN_QUERY_LENGTH) {
             return Stream.empty();
         }
@@ -53,9 +63,7 @@ static Text makeHighlightedText(String match) {
 
 
     static Text makeNormalText(String text) {
-        Text matchLabel = new Text(text);
-        matchLabel.getStyleClass().add("text");
-        return matchLabel;
+        return DesignerUtil.makeStyledText(text, "text");
     }
 
 }

src/main/java/net/sourceforge/pmd/util/fxdesigner/app/DesignerRoot.java

@@ -12,6 +12,7 @@
 import net.sourceforge.pmd.util.fxdesigner.app.ApplicationComponent;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRoot;
 import net.sourceforge.pmd.util.fxdesigner.util.controls.SearchableTreeView.SearchableTreeCell;
+import net.sourceforge.pmd.util.fxdesigner.util.controls.SearchableTreeView.SearchableTreeItem;
 
 import javafx.scene.control.ContextMenu;
 import javafx.scene.control.CustomMenuItem;
@@ -62,6 +63,16 @@ private ContextMenu buildContextMenu(Node item) {
     }
 
 
+    @Override
+    protected void setNonSearchState(SearchableTreeItem<Node> realItem) {
+        ASTTreeItem astItem = (ASTTreeItem) realItem;
+
+        Node node = realItem.getValue();
+        setText(null);
+        setGraphic(node == null ? null : astItem.styledPresentableText(node));
+    }
+
+
     @Override
     public void commonUpdate(Node item) {
         setContextMenu(buildContextMenu(item));