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