plugins/net.mograsim.plugin.core/src/net/mograsim/plugin/tables/mi/InstructionTable.java

   1 package net.mograsim.plugin.tables.mi;
   2
   3 import java.util.Arrays;
   4
   5 import org.eclipse.jface.viewers.ColumnLabelProvider;
   6 import org.eclipse.jface.viewers.ColumnViewerEditor;
   7 import org.eclipse.jface.viewers.ColumnViewerEditorActivationEvent;
   8 import org.eclipse.jface.viewers.ColumnViewerEditorActivationStrategy;
   9 import org.eclipse.jface.viewers.EditingSupport;
  10 import org.eclipse.jface.viewers.FocusCellOwnerDrawHighlighter;
  11 import org.eclipse.jface.viewers.TableViewerColumn;
  12 import org.eclipse.jface.viewers.TableViewerEditor;
  13 import org.eclipse.jface.viewers.TableViewerFocusCellManager;
  14 import org.eclipse.swt.SWT;
  15 import org.eclipse.swt.graphics.Color;
  16 import org.eclipse.swt.graphics.Font;
  17 import org.eclipse.swt.layout.GridData;
  18 import org.eclipse.swt.widgets.Composite;
  19 import org.eclipse.swt.widgets.Display;
  20 import org.eclipse.swt.widgets.Table;
  21 import org.eclipse.swt.widgets.TableColumn;
  22 import org.eclipse.ui.themes.IThemeManager;
  23
  24 import net.mograsim.machine.mi.MicroInstructionDefinition;
  25 import net.mograsim.machine.mi.MicroInstructionMemory;
  26 import net.mograsim.machine.mi.parameters.MnemonicFamily;
  27 import net.mograsim.machine.mi.parameters.ParameterClassification;
  28 import net.mograsim.plugin.tables.AddressLabelProvider;
  29 import net.mograsim.plugin.tables.DisplaySettings;
  30 import net.mograsim.plugin.tables.LazyTableViewer;
  31 import net.mograsim.preferences.Preferences;
  32
  33 public class InstructionTable
  34 {
  35         protected final DisplaySettings displaySettings;
  36         protected final LazyTableViewer viewer;
  37         private TableViewerColumn[] columns = new TableViewerColumn[0];
  38         private MicroInstructionDefinition miDef;
  39         private MicroInstructionMemory memory;
  40         private InstructionTableContentProvider provider;
  41         private final RowHighlighter highlighter;
  42         private final FontAndColorHelper cProv;
  43
  44         private final boolean isEditable;
  45
  46         public InstructionTable(Composite parent, DisplaySettings displaySettings, IThemeManager themeManager)
  47         {
  48                 this(parent, displaySettings, themeManager, true);
  49         }
  50
  51         public InstructionTable(Composite parent, DisplaySettings displaySettings, IThemeManager themeManager, boolean allowEditing)
  52         {
  53                 viewer = new LazyTableViewer(parent, SWT.FULL_SELECTION | SWT.BORDER | SWT.VIRTUAL);
  54                 this.displaySettings = displaySettings;
  55                 this.cProv = new FontAndColorHelper(viewer, themeManager);
  56                 this.highlighter = new RowHighlighter(viewer, cProv);
  57                 this.isEditable = allowEditing;
  58
  59                 Table table = viewer.getTable();
  60                 table.setHeaderVisible(true);
  61                 table.setLinesVisible(true);
  62                 viewer.setUseHashlookup(true);
  63                 table.addDisposeListener(e -> dispose());
  64
  65                 TableViewerFocusCellManager focusCellManager = new TableViewerFocusCellManager(viewer, new FocusCellOwnerDrawHighlighter(viewer));
  66
  67                 ColumnViewerEditorActivationStrategy actSupport = new ColumnViewerEditorActivationStrategy(viewer)
  68                 {
  69                         @Override
  70                         protected boolean isEditorActivationEvent(ColumnViewerEditorActivationEvent event)
  71                         {
  72                                 return event.eventType == ColumnViewerEditorActivationEvent.TRAVERSAL
  73                                                 || event.eventType == ColumnViewerEditorActivationEvent.MOUSE_DOUBLE_CLICK_SELECTION
  74                                                 || (event.eventType == ColumnViewerEditorActivationEvent.KEY_PRESSED && event.keyCode == SWT.CR)
  75                                                 || event.eventType == ColumnViewerEditorActivationEvent.PROGRAMMATIC;
  76                         }
  77                 };
  78                 int features = ColumnViewerEditor.TABBING_HORIZONTAL | ColumnViewerEditor.TABBING_MOVE_TO_ROW_NEIGHBOR
  79                                 | ColumnViewerEditor.TABBING_VERTICAL | ColumnViewerEditor.KEYBOARD_ACTIVATION;
  80                 TableViewerEditor.create(viewer, focusCellManager, actSupport, features);
  81
  82                 GridData viewerData = new GridData(GridData.GRAB_HORIZONTAL | GridData.GRAB_VERTICAL | GridData.FILL_BOTH);
  83                 viewerData.horizontalSpan = 3;
  84                 viewer.getTable().setLayoutData(viewerData);
  85
  86                 displaySettings.addObserver(() -> viewer.refresh());
  87         }
  88
  89         private void deleteColumns()
  90         {
  91                 for (TableViewerColumn col : columns)
  92                         col.getColumn().dispose();
  93         }
  94
  95         private void createColumns()
  96         {
  97                 viewer.getTable().setVisible(false);
  98
  99                 int size = miDef.size();
 100                 columns = new TableViewerColumn[size + 1];
 101
 102                 TableViewerColumn col = createTableViewerColumn("Address", null);
 103                 columns[0] = col;
 104                 col.setLabelProvider(new AddressLabelProvider()
 105                 {
 106                         @Override
 107                         public Color getBackground(Object element)
 108                         {
 109                                 return cProv.getBackground(element, -1);
 110                         }
 111
 112                         @Override
 113                         public Color getForeground(Object element)
 114                         {
 115                                 return cProv.getForeground(element, -1);
 116                         }
 117
 118                         @Override
 119                         public Font getFont(Object element)
 120                         {
 121                                 return cProv.getFont(element, -1);
 122                         }
 123                 });
 124
 125                 String[] columnTitles = new String[size];
 126
 127                 int bit = miDef.sizeInBits();
 128                 ParameterClassification[] classes = miDef.getParameterClassifications();
 129
 130                 for (int i = 0; i < size; i++)
 131                 {
 132                         int startBit = bit - 1;
 133                         int endBit = bit = bit - classes[i].getExpectedBits();
 134
 135                         String description = miDef.getParameterDescription(i).orElse(null);
 136                         String bitString = startBit == endBit ? Integer.toString(startBit) : startBit + "..." + endBit;
 137                         String columnTitle, columnTooltip;
 138                         if (useDescriptionAsColumnTitle(description))
 139                         {
 140                                 columnTitle = description;
 141                                 columnTooltip = bitString;
 142                         } else
 143                         {
 144                                 columnTitle = bitString;
 145                                 columnTooltip = description;
 146                         }
 147                         columnTitles[i] = columnTitle;
 148
 149                         col = createTableViewerColumn(columnTitle, columnTooltip);
 150                         columns[i + 1] = col;
 151                         createEditingAndLabel(col, miDef, i);
 152                 }
 153
 154                 calculateOptimalColumnSize(0, "Address", generateLongestHexStrings(12));
 155
 156                 for (int i = 0; i < size; i++)
 157                 {
 158                         String[] longestPossibleContents;
 159                         switch (classes[i].getExpectedType())
 160                         {
 161                         case INTEGER_IMMEDIATE:
 162                                 longestPossibleContents = generateLongestHexStrings(classes[i].getExpectedBits());
 163                                 break;
 164                         case BOOLEAN_IMMEDIATE:
 165                         case MNEMONIC:
 166                                 longestPossibleContents = ((MnemonicFamily) classes[i]).getStringValues();
 167                                 break;
 168                         default:
 169                                 longestPossibleContents = new String[0];
 170                                 break;
 171                         }
 172                         calculateOptimalColumnSize(i + 1, columnTitles[i], longestPossibleContents);
 173                 }
 174
 175                 viewer.getTable().setVisible(true);
 176         }
 177
 178         private static boolean useDescriptionAsColumnTitle(String description)
 179         {
 180                 return description != null && Preferences.current().getBoolean("net.mograsim.plugin.core.editors.mpm.descriptionascolumnname");
 181         }
 182
 183         public void bindMicroInstructionMemory(MicroInstructionMemory memory)
 184         {
 185                 this.memory = memory;
 186                 if (memory != null)
 187                 {
 188                         this.miDef = memory.getDefinition().getMicroInstructionDefinition();
 189                         setViewerInput(memory);
 190                 }
 191         }
 192
 193         private static final String[] HEX_DIGITS = { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "A", "B", "C", "D", "E", "F" };
 194
 195         private static String[] generateLongestHexStrings(int bitWidth)
 196         {
 197                 return Arrays.stream(HEX_DIGITS).map(s -> "0x" + s.repeat((bitWidth + 3) / 4)).toArray(String[]::new);
 198         }
 199
 200         private void createEditingAndLabel(TableViewerColumn col, MicroInstructionDefinition miDef, int index)
 201         {
 202                 ParameterClassification parameterClassification = miDef.getParameterClassifications()[index];
 203                 EditingSupport support;
 204                 ColumnLabelProvider provider;
 205                 switch (parameterClassification.getExpectedType())
 206                 {
 207                 case BOOLEAN_IMMEDIATE:
 208                         support = isEditable ? new BooleanEditingSupport(viewer, miDef, index) : null;
 209                         provider = new ParameterLabelProvider(cProv, index);
 210                         break;
 211                 case INTEGER_IMMEDIATE:
 212                         support = isEditable ? new IntegerEditingSupport(viewer, miDef, index, displaySettings, this.provider) : null;
 213                         provider = new IntegerColumnLabelProvider(displaySettings, cProv, index);
 214                         break;
 215                 case MNEMONIC:
 216                         support = isEditable ? new MnemonicEditingSupport(viewer, miDef, index, this.provider) : null;
 217                         provider = new ParameterLabelProvider(cProv, index);
 218                         break;
 219                 default:
 220                         throw new IllegalStateException(
 221                                         "Unable to create EditingSupport for unknown ParameterType " + parameterClassification.getExpectedType());
 222                 }
 223                 if (isEditable)
 224                         col.setEditingSupport(support);
 225                 col.setLabelProvider(provider);
 226         }
 227
 228         private TableViewerColumn createTableViewerColumn(String title, String toolTip)
 229         {
 230                 TableViewerColumn viewerColumn = new TableViewerColumn(viewer, SWT.NONE);
 231                 TableColumn column = viewerColumn.getColumn();
 232                 column.setText(title);
 233                 column.setToolTipText(toolTip);
 234                 column.setResizable(true);
 235                 column.setMoveable(false);
 236                 return viewerColumn;
 237         }
 238
 239         private void calculateOptimalColumnSize(int i, String title, String... longestPossibleContents)
 240         {
 241                 TableColumn column = viewer.getTable().getColumn(i);
 242                 int maxWidth = 0;
 243                 for (String s : longestPossibleContents)
 244                 {
 245                         column.setText(s);
 246                         column.pack();
 247                         if (column.getWidth() > maxWidth)
 248                                 maxWidth = column.getWidth();
 249                 }
 250                 column.setText(title);
 251                 column.pack();
 252                 if (column.getWidth() < maxWidth)
 253                         column.setWidth(maxWidth);
 254         }
 255
 256         public LazyTableViewer getTableViewer()
 257         {
 258                 return viewer;
 259         }
 260
 261         public MicroInstructionMemory getMicroInstructionMemory()
 262         {
 263                 return memory;
 264         }
 265
 266         public void setContentProvider(InstructionTableContentProvider provider)
 267         {
 268                 this.provider = provider;
 269                 viewer.setContentProvider(provider);
 270         }
 271
 272         private void setViewerInput(MicroInstructionMemory memory)
 273         {
 274                 deleteColumns();
 275                 viewer.setInput(memory);
 276                 createColumns();
 277         }
 278
 279         public void refresh()
 280         {
 281                 Display.getDefault().asyncExec(() -> viewer.refresh());
 282         }
 283
 284         private void dispose()
 285         {
 286                 cProv.dispose();
 287                 viewer.getTable().dispose();
 288         }
 289
 290         public void highlight(int row)
 291         {
 292                 highlighter.highlight(row);
 293         }
 294 }