Compute merged References only on demand by default, fallback to automatic computation available

Make sure the aggregation settings in References can be shared
Do not recompute merged References when the auto aggregation property changes
Do not display Count column in Fields / References for no selection

Author: jisedlac

visualvm/heapviewer.truffle/src/org/graalvm/visualvm/heapviewer/truffle/TruffleObjectPropertyPlugin.java

@@ -24,6 +24,10 @@
  */
 package org.graalvm.visualvm.heapviewer.truffle;
 
+import java.awt.BorderLayout;
+import java.awt.GridBagConstraints;
+import java.awt.GridBagLayout;
+import java.awt.Insets;
 import java.awt.event.ActionEvent;
 import java.util.List;
 import java.util.Objects;
@@ -42,9 +46,13 @@
 import org.graalvm.visualvm.heapviewer.ui.TreeTableView;
 import org.graalvm.visualvm.heapviewer.ui.TreeTableViewColumn;
 import javax.swing.Icon;
+import javax.swing.JButton;
 import javax.swing.JCheckBoxMenuItem;
+import javax.swing.JPanel;
 import javax.swing.JPopupMenu;
 import javax.swing.SwingUtilities;
+import org.graalvm.visualvm.heapviewer.truffle.swing.LinkButton;
+import org.graalvm.visualvm.lib.ui.UIUtils;
 import org.openide.util.NbBundle;
 import org.openide.util.NbPreferences;
 
@@ -54,15 +62,16 @@
  */
 @NbBundle.Messages({
     "TruffleObjectPropertyPlugin_NoSelection=<no object selected>",
+    "TruffleObjectPropertyPlugin_NoSelectionEx=<no object or type selected>",
     "TruffleObjectPropertyPlugin_NoItems=<no {0}>", // <no items>
-    "TruffleObjectPropertyPlugin_ShowMergedSwitch=Show merged {0}"
+    "TruffleObjectPropertyPlugin_AutoShowMergedSwitch=Compute merged {0} automatically",
+    "TruffleObjectPropertyPlugin_ComputeMergedReferencesLbl=Compute Merged {0}",
+    "TruffleObjectPropertyPlugin_ComputeMergedReferencesTtp=Compute merged {0} for the selected type",
+    "TruffleObjectPropertyPlugin_AutoComputeMergedReferencesLbl=Compute Merged {0} Automatically",
+    "TruffleObjectPropertyPlugin_AutoComputeMergedReferencesTtp=Compute merged {0} automatically for each selected type"
 })
 public class TruffleObjectPropertyPlugin<O extends TruffleObject, T extends TruffleType<O>, F extends TruffleLanguageHeapFragment<O, T>, L extends TruffleLanguage<O, T, F>> extends HeapViewPlugin {
 
-    private static final String KEY_TYPE_PROPERTIES_HISTOGRAM = "tPropertiesHisto"; // NOI18N
-    
-    private volatile boolean tPropertiesHisto = readItem(KEY_TYPE_PROPERTIES_HISTOGRAM, true);
-    
     private static final TreeTableView.ColumnConfiguration CCONF_TYPE = new TreeTableView.ColumnConfiguration(DataType.COUNT, null, DataType.COUNT, SortOrder.DESCENDING, Boolean.FALSE);
     private static final TreeTableView.ColumnConfiguration CCONF_OBJECT = new TreeTableView.ColumnConfiguration(null, DataType.COUNT, DataType.NAME, SortOrder.UNSORTED, null);
 
@@ -72,6 +81,8 @@ public class TruffleObjectPropertyPlugin<O extends TruffleObject, T extends Truf
 
     private HeapViewerNode selected;
 
+    private volatile boolean mergedRequest;
+    
     private final TreeTableView objectsView;
 
 
@@ -80,34 +91,45 @@ public TruffleObjectPropertyPlugin(String name, String description, Icon icon, S
 
         this.provider = provider;
 
-        if (!provider.supportsAggregation()) tPropertiesHisto = false;
+        final String mergedPropertiesKey = provider.getMergedPropertiesKey();
 
         heap = context.getFragment().getHeap();
 
-        TreeTableViewColumn[] columns = provider.supportsAggregation() ?
+        TreeTableViewColumn[] columns = mergedPropertiesKey == null ?
             new TreeTableViewColumn[] {
                 new TreeTableViewColumn.Name(heap),
                 new TreeTableViewColumn.LogicalValue(heap),
-                new TreeTableViewColumn.Count(heap, true, true),
                 new TreeTableViewColumn.OwnSize(heap, false, false),
                 new TreeTableViewColumn.RetainedSize(heap, false, false),
                 new TreeTableViewColumn.ObjectID(heap)
             } : new TreeTableViewColumn[] {
                 new TreeTableViewColumn.Name(heap),
                 new TreeTableViewColumn.LogicalValue(heap),
+                new TreeTableViewColumn.Count(heap, true, true),
                 new TreeTableViewColumn.OwnSize(heap, false, false),
                 new TreeTableViewColumn.RetainedSize(heap, false, false),
                 new TreeTableViewColumn.ObjectID(heap)
             };
         objectsView = new TreeTableView(viewID, context, actions, columns) {
             protected HeapViewerNode[] computeData(RootNode root, Heap heap, String viewID, HeapViewerNodeFilter viewFilter, List<DataType> dataTypes, List<SortOrder> sortOrders, Progress progress) throws InterruptedException {
+                if (mergedRequest) return HeapViewerNode.NO_NODES;
+                
                 HeapViewerNode _selected;
                 synchronized (objectsView) { _selected = selected; }
 
-                if (_selected == null) return new HeapViewerNode[] { new TextNode(Bundle.TruffleObjectPropertyPlugin_NoSelection()) };
+                if (_selected == null) {
+                    SwingUtilities.invokeLater(new Runnable() {
+                        public void run() {
+                            if (!CCONF_OBJECT.equals(objectsView.getCurrentColumnConfiguration()))
+                                objectsView.configureColumns(CCONF_OBJECT);
+                        }
+                    });
+                    
+                    return new HeapViewerNode[] { new TextNode(noSelectionString()) };
+                }
 
                 HeapViewerNode[] nodes;
-                TruffleObjectsWrapper wrapper = !tPropertiesHisto ? null : HeapViewerNode.getValue(_selected, TruffleObjectsWrapper.DATA_TYPE, heap);
+                TruffleObjectsWrapper wrapper = mergedPropertiesKey == null ? null : HeapViewerNode.getValue(_selected, TruffleObjectsWrapper.DATA_TYPE, heap);
                 if (wrapper != null) {
                     nodes = provider.getNodes(wrapper, _selected, heap, viewID, viewFilter, dataTypes, sortOrders, progress);
                     SwingUtilities.invokeLater(new Runnable() {
@@ -119,7 +141,7 @@ public void run() {
                 } else {
                     O selectedO = provider.getObject(_selected, heap);
                     if (selectedO != null) nodes = provider.getNodes(selectedO, root, heap, viewID, viewFilter, dataTypes, sortOrders, progress);
-                    else nodes = new HeapViewerNode[] { new TextNode(Bundle.TruffleObjectPropertyPlugin_NoSelection()) };
+                    else nodes = new HeapViewerNode[] { new TextNode(noSelectionString()) };
                     SwingUtilities.invokeLater(new Runnable() {
                         public void run() {
                             if (!CCONF_OBJECT.equals(objectsView.getCurrentColumnConfiguration()))
@@ -132,29 +154,114 @@ public void run() {
             }
             @Override
             protected void populatePopup(HeapViewerNode node, JPopupMenu popup) {
-                if (!provider.supportsAggregation()) return;
+                if (provider.getMergedPropertiesKey() == null) return;
 
                 if (popup.getComponentCount() > 0) popup.addSeparator();
 
-                popup.add(new JCheckBoxMenuItem(Bundle.TruffleObjectPropertyPlugin_ShowMergedSwitch(provider.getName()), tPropertiesHisto) {
+                popup.add(new JCheckBoxMenuItem(Bundle.TruffleObjectPropertyPlugin_AutoShowMergedSwitch(provider.getName()), isAutoMerge()) {
                     @Override
                     protected void fireActionPerformed(ActionEvent event) {
                         SwingUtilities.invokeLater(new Runnable() {
                             @Override
                             public void run() {
-                                tPropertiesHisto = isSelected();
-                                storeItem(KEY_TYPE_PROPERTIES_HISTOGRAM, tPropertiesHisto);
-                                reloadView();
+                                setAutoMerge(isSelected());
                             }
                         });
                     }
                 });
             }
         };
     }
+    
+    private String noSelectionString() {
+        return provider.getMergedPropertiesKey() == null ? Bundle.TruffleObjectPropertyPlugin_NoSelection() :
+                                                           Bundle.TruffleObjectPropertyPlugin_NoSelectionEx();
+    }
+    
+    private JComponent component;
+    
+    private void showObjectsView() {
+        JComponent c = objectsView.getComponent();
+        if (c.isVisible()) return;
+        
+        c.setVisible(true);
+        
+        component.removeAll();
+        component.add(c, BorderLayout.CENTER);
+        
+        mergedRequest = false;
+        
+        component.invalidate();
+        component.revalidate();
+        component.repaint();
+    }
+    
+    private void showMergedView() {
+        JComponent c = objectsView.getComponent();
+        if (!c.isVisible()) return;
+        
+        c.setVisible(false);
+        
+        component.removeAll();
+        
+        String name = provider.getName();
+        String _name = name.substring(0, 1).toUpperCase() + name.substring(1);
+        
+        JButton jb = new JButton(Bundle.TruffleObjectPropertyPlugin_ComputeMergedReferencesLbl(_name), getIcon()) {
+            protected void fireActionPerformed(ActionEvent e) {
+                showObjectsView();
+                objectsView.reloadView();
+            }
+        };
+        jb.setIconTextGap(jb.getIconTextGap() + 2);
+        jb.setToolTipText(Bundle.TruffleObjectPropertyPlugin_ComputeMergedReferencesTtp(name));
+        Insets margin = jb.getMargin();
+        if (margin != null) jb.setMargin(new Insets(margin.top + 3, margin.left + 3, margin.bottom + 3, margin.right + 3));
+        
+        
+        LinkButton lb = new LinkButton(Bundle.TruffleObjectPropertyPlugin_AutoComputeMergedReferencesLbl(_name)) {
+            protected void fireActionPerformed(ActionEvent e) {
+                setAutoMerge(true);
+                showObjectsView();
+                objectsView.reloadView();
+            }
+        };
+        lb.setToolTipText(Bundle.TruffleObjectPropertyPlugin_AutoComputeMergedReferencesTtp(name));
+                
+        
+        JPanel p = new JPanel(new GridBagLayout());
+        p.setOpaque(false);
+        GridBagConstraints g;
+        
+        g = new GridBagConstraints();
+        g.fill = GridBagConstraints.HORIZONTAL;
+        g.gridy = 0;
+        p.add(jb, g);
+        
+        g = new GridBagConstraints();
+        g.fill = GridBagConstraints.HORIZONTAL;
+        g.gridy = 1;
+        g.insets = new Insets(10, 0, 0, 0);
+        p.add(lb, g);
+        
+        component.add(p);
+        
+        mergedRequest = true;
+
+        component.invalidate();
+        component.revalidate();
+        component.repaint();
+    }
 
     protected JComponent createComponent() {
-        return objectsView.getComponent();
+        component = new JPanel(new BorderLayout());
+        component.setOpaque(true);
+        component.setBackground(UIUtils.getProfilerResultsBackground());
+        
+        objectsView.getComponent().setVisible(false); // force init in showObjectsView()
+        showObjectsView();
+        
+        return component;
     }
 
 
@@ -164,28 +271,25 @@ protected void closed() {
     }
 
 
-    protected final boolean supportsAggregation() {
-        return provider.supportsAggregation();
-    }
-    
-    
     protected void nodeSelected(HeapViewerNode node, boolean adjusting) {
         synchronized (objectsView) {
             if (Objects.equals(selected, node)) return;
-            
             selected = node;
         }
 
+        if (selected != null && provider.getMergedPropertiesKey() != null && !isAutoMerge() && HeapViewerNode.getValue(selected, TruffleObjectsWrapper.DATA_TYPE, heap) != null) showMergedView();
+        else showObjectsView();
+        
         objectsView.reloadView();
     }
 
 
-    private static boolean readItem(String itemName, boolean initial) {
-        return NbPreferences.forModule(TruffleObjectPropertyPlugin.class).getBoolean("TruffleObjectPropertyPlugin." + itemName, initial); // NOI18N
+    private boolean isAutoMerge() {
+        return NbPreferences.root().getBoolean(provider.getMergedPropertiesKey(), false);
     }
 
-    private static void storeItem(String itemName, boolean value) {
-        NbPreferences.forModule(TruffleObjectPropertyPlugin.class).putBoolean("TruffleObjectPropertyPlugin." + itemName, value); // NOI18N
+    private void setAutoMerge(boolean value) {
+        NbPreferences.root().putBoolean(provider.getMergedPropertiesKey(), value);
     }
 
 }

visualvm/heapviewer.truffle/src/org/graalvm/visualvm/heapviewer/truffle/TruffleObjectPropertyProvider.java

@@ -117,7 +117,7 @@ protected final L getLanguage() {
     protected abstract HeapViewerNode createNode(I item, Heap heap);
 
 
-    protected boolean supportsAggregation() { return true; }
+    protected String getMergedPropertiesKey() { return null; }
 
 
     protected final boolean filtersProperties() { return filtersProperties; }
@@ -253,9 +253,16 @@ protected HeapViewerNode createForeignFieldNode(Instance instance, FieldValue fi
             }
         }
 
+        
+        @Override
+        protected String getMergedPropertiesKey() {
+            return "HeapViewer.autoMergedFields"; // NOI18N
+        }
+        
+        
         @Override
         protected HeapViewerNode[] getNodes(TruffleObjectsWrapper<O> objects, HeapViewerNode parent, final Heap heap, String viewID, HeapViewerNodeFilter viewFilter, List<DataType> dataTypes, List<SortOrder> sortOrders, Progress progress) throws InterruptedException {
-            if (!supportsAggregation()) return null;
+            if (getMergedPropertiesKey() == null) return null;
 
             return new TruffleObjectMergedFields<O>(objects, heap) {
                 protected String getMoreNodesString(String moreNodesCount) { return moreNodesString(moreNodesCount); }
@@ -321,9 +328,15 @@ protected HeapViewerNode createForeignReferenceNode(Instance instance, FieldValu
         }
 
 
+        @Override
+        protected String getMergedPropertiesKey() {
+            return "HeapViewer.autoMergedReferences"; // NOI18N // Shared with org.graalvm.visualvm.heapviewer.java.impl.JavaReferencesPlugin
+        }
+        
+        
         @Override
         protected HeapViewerNode[] getNodes(final TruffleObjectsWrapper<O> objects, HeapViewerNode parent, final Heap heap, String viewID, HeapViewerNodeFilter viewFilter, List<DataType> dataTypes, List<SortOrder> sortOrders, Progress progress) throws InterruptedException {
-            if (!supportsAggregation()) return null;
+            if (getMergedPropertiesKey() == null) return null;
 
             return new TruffleObjectMergedReferences<O>(objects, heap) {
                 protected String getMoreNodesString(String moreNodesCount) { return moreNodesString(moreNodesCount); }

visualvm/heapviewer.truffle/src/org/graalvm/visualvm/heapviewer/truffle/lang/python/PythonObjectProperties.java

@@ -157,8 +157,8 @@ protected boolean includeInstance(Instance instance) {
         }
 
         @Override
-        protected boolean supportsAggregation() {
-            return false;
+        protected String getMergedPropertiesKey() {
+            return null;
         }
 
     }

visualvm/heapviewer.truffle/src/org/graalvm/visualvm/heapviewer/truffle/lang/r/RObjectProperties.java

@@ -179,8 +179,8 @@ protected boolean includeInstance(Instance instance) {
         }
 
         @Override
-        protected boolean supportsAggregation() {
-            return false;
+        protected String getMergedPropertiesKey() {
+            return null;
         }
 
     }