Added possibility to swap column tooltip and title in MPM editor
[Mograsim.git] / plugins / net.mograsim.plugin.core / src / net / mograsim / plugin / tables / mi / InstructionTable.java
index 936ba5c..2632f39 100644 (file)
@@ -3,14 +3,23 @@ package net.mograsim.plugin.tables.mi;
 import java.util.Arrays;
 
 import org.eclipse.jface.viewers.ColumnLabelProvider;
+import org.eclipse.jface.viewers.ColumnViewerEditor;
+import org.eclipse.jface.viewers.ColumnViewerEditorActivationEvent;
+import org.eclipse.jface.viewers.ColumnViewerEditorActivationStrategy;
 import org.eclipse.jface.viewers.EditingSupport;
+import org.eclipse.jface.viewers.FocusCellOwnerDrawHighlighter;
 import org.eclipse.jface.viewers.TableViewerColumn;
+import org.eclipse.jface.viewers.TableViewerEditor;
+import org.eclipse.jface.viewers.TableViewerFocusCellManager;
 import org.eclipse.swt.SWT;
+import org.eclipse.swt.graphics.Color;
+import org.eclipse.swt.graphics.Font;
 import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Table;
 import org.eclipse.swt.widgets.TableColumn;
+import org.eclipse.ui.themes.IThemeManager;
 
 import net.mograsim.machine.mi.MicroInstructionDefinition;
 import net.mograsim.machine.mi.MicroInstructionMemory;
@@ -19,25 +28,56 @@ import net.mograsim.machine.mi.parameters.ParameterClassification;
 import net.mograsim.plugin.tables.AddressLabelProvider;
 import net.mograsim.plugin.tables.DisplaySettings;
 import net.mograsim.plugin.tables.LazyTableViewer;
+import net.mograsim.preferences.Preferences;
 
 public class InstructionTable
 {
-       protected DisplaySettings displaySettings;
-       protected LazyTableViewer viewer;
+       protected final DisplaySettings displaySettings;
+       protected final LazyTableViewer viewer;
        private TableViewerColumn[] columns = new TableViewerColumn[0];
        private MicroInstructionDefinition miDef;
        private MicroInstructionMemory memory;
        private InstructionTableContentProvider provider;
+       private final RowHighlighter highlighter;
+       private final FontAndColorHelper cProv;
 
-       public InstructionTable(Composite parent, DisplaySettings displaySettings)
+       private final boolean isEditable;
+
+       public InstructionTable(Composite parent, DisplaySettings displaySettings, IThemeManager themeManager)
+       {
+               this(parent, displaySettings, themeManager, true);
+       }
+
+       public InstructionTable(Composite parent, DisplaySettings displaySettings, IThemeManager themeManager, boolean allowEditing)
        {
-               viewer = new LazyTableViewer(parent, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL | SWT.FULL_SELECTION | SWT.BORDER | SWT.VIRTUAL);
+               viewer = new LazyTableViewer(parent, SWT.FULL_SELECTION | SWT.BORDER | SWT.VIRTUAL);
                this.displaySettings = displaySettings;
+               this.cProv = new FontAndColorHelper(viewer, themeManager);
+               this.highlighter = new RowHighlighter(viewer, cProv);
+               this.isEditable = allowEditing;
 
                Table table = viewer.getTable();
                table.setHeaderVisible(true);
                table.setLinesVisible(true);
                viewer.setUseHashlookup(true);
+               table.addDisposeListener(e -> dispose());
+
+               TableViewerFocusCellManager focusCellManager = new TableViewerFocusCellManager(viewer, new FocusCellOwnerDrawHighlighter(viewer));
+
+               ColumnViewerEditorActivationStrategy actSupport = new ColumnViewerEditorActivationStrategy(viewer)
+               {
+                       @Override
+                       protected boolean isEditorActivationEvent(ColumnViewerEditorActivationEvent event)
+                       {
+                               return event.eventType == ColumnViewerEditorActivationEvent.TRAVERSAL
+                                               || event.eventType == ColumnViewerEditorActivationEvent.MOUSE_DOUBLE_CLICK_SELECTION
+                                               || (event.eventType == ColumnViewerEditorActivationEvent.KEY_PRESSED && event.keyCode == SWT.CR)
+                                               || event.eventType == ColumnViewerEditorActivationEvent.PROGRAMMATIC;
+                       }
+               };
+               int features = ColumnViewerEditor.TABBING_HORIZONTAL | ColumnViewerEditor.TABBING_MOVE_TO_ROW_NEIGHBOR
+                               | ColumnViewerEditor.TABBING_VERTICAL | ColumnViewerEditor.KEYBOARD_ACTIVATION;
+               TableViewerEditor.create(viewer, focusCellManager, actSupport, features);
 
                GridData viewerData = new GridData(GridData.GRAB_HORIZONTAL | GridData.GRAB_VERTICAL | GridData.FILL_BOTH);
                viewerData.horizontalSpan = 3;
@@ -54,12 +94,33 @@ public class InstructionTable
 
        private void createColumns()
        {
+               viewer.getTable().setVisible(false);
+
                int size = miDef.size();
                columns = new TableViewerColumn[size + 1];
 
-               TableViewerColumn col = createTableViewerColumn("Address");
+               TableViewerColumn col = createTableViewerColumn("Address", null);
                columns[0] = col;
-               col.setLabelProvider(new AddressLabelProvider());
+               col.setLabelProvider(new AddressLabelProvider()
+               {
+                       @Override
+                       public Color getBackground(Object element)
+                       {
+                               return cProv.getBackground(element, -1);
+                       }
+
+                       @Override
+                       public Color getForeground(Object element)
+                       {
+                               return cProv.getForeground(element, -1);
+                       }
+
+                       @Override
+                       public Font getFont(Object element)
+                       {
+                               return cProv.getFont(element, -1);
+                       }
+               });
 
                String[] columnTitles = new String[size];
 
@@ -70,9 +131,22 @@ public class InstructionTable
                {
                        int startBit = bit - 1;
                        int endBit = bit = bit - classes[i].getExpectedBits();
-                       String columnTitle = calculateColumnTitle(startBit, endBit);
+
+                       String description = miDef.getParameterDescription(i).orElse(null);
+                       String bitString = startBit == endBit ? Integer.toString(startBit) : startBit + "..." + endBit;
+                       String columnTitle, columnTooltip;
+                       if (useDescriptionAsColumnTitle(description))
+                       {
+                               columnTitle = description;
+                               columnTooltip = bitString;
+                       } else
+                       {
+                               columnTitle = bitString;
+                               columnTooltip = description;
+                       }
                        columnTitles[i] = columnTitle;
-                       col = createTableViewerColumn(columnTitle);
+
+                       col = createTableViewerColumn(columnTitle, columnTooltip);
                        columns[i + 1] = col;
                        createEditingAndLabel(col, miDef, i);
                }
@@ -97,11 +171,13 @@ public class InstructionTable
                        }
                        calculateOptimalColumnSize(i + 1, columnTitles[i], longestPossibleContents);
                }
+
+               viewer.getTable().setVisible(true);
        }
 
-       private static String calculateColumnTitle(int startBit, int endBit)
+       private static boolean useDescriptionAsColumnTitle(String description)
        {
-               return startBit == endBit ? Integer.toString(startBit) : startBit + "..." + endBit;
+               return description != null && Preferences.current().getBoolean("net.mograsim.plugin.core.editors.mpm.descriptionascolumnname");
        }
 
        public void bindMicroInstructionMemory(MicroInstructionMemory memory)
@@ -129,32 +205,32 @@ public class InstructionTable
                switch (parameterClassification.getExpectedType())
                {
                case BOOLEAN_IMMEDIATE:
-                       support = new BooleanEditingSupport(viewer, miDef, index);
-                       provider = new ParameterLabelProvider(index);
+                       support = isEditable ? new BooleanEditingSupport(viewer, miDef, index) : null;
+                       provider = new ParameterLabelProvider(cProv, index);
                        break;
                case INTEGER_IMMEDIATE:
-                       support = new IntegerEditingSupport(viewer, miDef, index, displaySettings, this.provider);
-                       provider = new IntegerColumnLabelProvider(displaySettings, index);
+                       support = isEditable ? new IntegerEditingSupport(viewer, miDef, index, displaySettings, this.provider) : null;
+                       provider = new IntegerColumnLabelProvider(displaySettings, cProv, index);
                        break;
                case MNEMONIC:
-//                     viewerColumn.setEditingSupport(editingSupport)
-                       support = new MnemonicEditingSupport(viewer, miDef, index, this.provider);
-                       provider = new ParameterLabelProvider(index);
+                       support = isEditable ? new MnemonicEditingSupport(viewer, miDef, index, this.provider) : null;
+                       provider = new ParameterLabelProvider(cProv, index);
                        break;
                default:
                        throw new IllegalStateException(
                                        "Unable to create EditingSupport for unknown ParameterType " + parameterClassification.getExpectedType());
                }
-               col.setEditingSupport(support);
+               if (isEditable)
+                       col.setEditingSupport(support);
                col.setLabelProvider(provider);
-               col.getColumn().setToolTipText(miDef.getParameterDescription(index).orElse(""));
        }
 
-       private TableViewerColumn createTableViewerColumn(String title)
+       private TableViewerColumn createTableViewerColumn(String title, String toolTip)
        {
                TableViewerColumn viewerColumn = new TableViewerColumn(viewer, SWT.NONE);
                TableColumn column = viewerColumn.getColumn();
                column.setText(title);
+               column.setToolTipText(toolTip);
                column.setResizable(true);
                column.setMoveable(false);
                return viewerColumn;
@@ -204,4 +280,15 @@ public class InstructionTable
        {
                Display.getDefault().asyncExec(() -> viewer.refresh());
        }
+
+       private void dispose()
+       {
+               cProv.dispose();
+               viewer.getTable().dispose();
+       }
+
+       public void highlight(int row)
+       {
+               highlighter.highlight(row);
+       }
 }