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

   1 package net.mograsim.plugin.tables.mi;
   2
   3 import java.io.BufferedReader;
   4 import java.io.File;
   5 import java.io.FileReader;
   6 import java.io.IOException;
   7 import java.util.Arrays;
   8
   9 import org.eclipse.core.runtime.IProgressMonitor;
  10 import org.eclipse.jface.viewers.ColumnLabelProvider;
  11 import org.eclipse.jface.viewers.EditingSupport;
  12 import org.eclipse.jface.viewers.TableViewerColumn;
  13 import org.eclipse.swt.SWT;
  14 import org.eclipse.swt.events.SelectionEvent;
  15 import org.eclipse.swt.events.SelectionListener;
  16 import org.eclipse.swt.layout.GridData;
  17 import org.eclipse.swt.layout.GridLayout;
  18 import org.eclipse.swt.widgets.Button;
  19 import org.eclipse.swt.widgets.Composite;
  20 import org.eclipse.swt.widgets.FileDialog;
  21 import org.eclipse.swt.widgets.Table;
  22 import org.eclipse.swt.widgets.TableColumn;
  23 import org.eclipse.ui.IEditorInput;
  24 import org.eclipse.ui.IEditorSite;
  25 import org.eclipse.ui.IPathEditorInput;
  26 import org.eclipse.ui.PartInitException;
  27 import org.eclipse.ui.part.EditorPart;
  28
  29 import net.mograsim.machine.MemoryObserver;
  30 import net.mograsim.machine.mi.MicroInstructionDefinition;
  31 import net.mograsim.machine.mi.MicroInstructionMemory;
  32 import net.mograsim.machine.mi.MicroInstructionMemoryParseException;
  33 import net.mograsim.machine.mi.MicroInstructionMemoryParser;
  34 import net.mograsim.machine.mi.parameters.MnemonicFamily;
  35 import net.mograsim.machine.mi.parameters.ParameterClassification;
  36 import net.mograsim.plugin.MachineContext;
  37 import net.mograsim.plugin.tables.AddressLabelProvider;
  38 import net.mograsim.plugin.tables.DisplaySettings;
  39 import net.mograsim.plugin.tables.LazyTableViewer;
  40 import net.mograsim.plugin.tables.RadixSelector;
  41
  42 public class InstructionView extends EditorPart implements MemoryObserver
  43 {
  44         private LazyTableViewer viewer;
  45         private TableViewerColumn[] columns = new TableViewerColumn[0];
  46         private MicroInstructionDefinition miDef;
  47         private MicroInstructionMemory memory;
  48         private DisplaySettings displaySettings;
  49         private InstructionTableContentProvider provider;
  50         private int highlighted = 0;
  51         private boolean dirty = false;
  52         private String machineName;
  53
  54         @SuppressWarnings("unused")
  55         @Override
  56         public void createPartControl(Composite parent)
  57         {
  58                 provider = new InstructionTableContentProvider();
  59                 GridLayout layout = new GridLayout(3, false);
  60                 parent.setLayout(layout);
  61
  62                 displaySettings = new DisplaySettings();
  63                 new RadixSelector(parent, displaySettings);
  64
  65                 addActivationButton(parent);
  66                 viewer = new LazyTableViewer(parent, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL | SWT.FULL_SELECTION | SWT.BORDER | SWT.VIRTUAL);
  67
  68                 Table table = viewer.getTable();
  69                 table.setHeaderVisible(true);
  70                 table.setLinesVisible(true);
  71                 viewer.setUseHashlookup(true);
  72                 viewer.setContentProvider(provider);
  73                 setViewerInput(memory);
  74                 getSite().setSelectionProvider(viewer);
  75
  76                 GridData viewerData = new GridData(GridData.GRAB_HORIZONTAL | GridData.GRAB_VERTICAL | GridData.FILL_BOTH);
  77                 viewerData.horizontalSpan = 3;
  78                 viewer.getTable().setLayoutData(viewerData);
  79
  80                 displaySettings.addObserver(() -> viewer.refresh());
  81         }
  82
  83         private void addActivationButton(Composite parent)
  84         {
  85                 Button activationButton = new Button(parent, SWT.PUSH);
  86                 activationButton.setText("Set Active");
  87                 activationButton.addSelectionListener(new SelectionListener()
  88                 {
  89
  90                         @Override
  91                         public void widgetSelected(SelectionEvent e)
  92                         {
  93                                 if (e.detail == SWT.PUSH)
  94                                         MachineContext.getInstance().getMachine().getMicroInstructionMemory().bind(memory);
  95                                 // TODO register this in project context
  96                         }
  97
  98                         @Override
  99                         public void widgetDefaultSelected(SelectionEvent e)
 100                         {
 101                                 widgetSelected(e);
 102                         }
 103                 });
 104         }
 105
 106         public void highlight(int index)
 107         {
 108                 viewer.highlightRow(highlighted, false);
 109                 viewer.highlightRow(index, true);
 110                 viewer.getTable().setTopIndex(index);
 111         }
 112
 113         public void bindMicroInstructionMemory(MicroInstructionMemory memory)
 114         {
 115                 this.memory = memory;
 116                 this.miDef = memory.getDefinition().getMicroInstructionDefinition();
 117                 this.memory.registerObserver(this);
 118                 setViewerInput(memory);
 119         }
 120
 121         private void setViewerInput(MicroInstructionMemory memory)
 122         {
 123                 if (viewer != null)
 124                 {
 125                         deleteColumns();
 126                         viewer.setInput(memory);
 127                         createColumns();
 128                 }
 129         }
 130
 131         private void deleteColumns()
 132         {
 133                 for (TableViewerColumn col : columns)
 134                         col.getColumn().dispose();
 135         }
 136
 137         private void createColumns()
 138         {
 139                 int size = miDef.size();
 140                 columns = new TableViewerColumn[size + 1];
 141
 142                 TableViewerColumn col = createTableViewerColumn("Address", generateLongestHexStrings(12));
 143                 columns[0] = col;
 144                 col.setLabelProvider(new AddressLabelProvider());
 145
 146                 int bit = miDef.sizeInBits();
 147                 ParameterClassification[] classes = miDef.getParameterClassifications();
 148
 149                 for (int i = 0; i < size; i++)
 150                 {
 151                         int startBit = bit - 1;
 152                         int endBit = bit = bit - classes[i].getExpectedBits();
 153                         String name = startBit == endBit ? Integer.toString(startBit) : startBit + "..." + endBit;
 154
 155                         String[] longestPossibleContents;
 156                         switch (classes[i].getExpectedType())
 157                         {
 158                         case INTEGER_IMMEDIATE:
 159                                 longestPossibleContents = generateLongestHexStrings(classes[i].getExpectedBits());
 160                                 break;
 161                         case BOOLEAN_IMMEDIATE:
 162                         case MNEMONIC:
 163                                 longestPossibleContents = ((MnemonicFamily) classes[i]).getStringValues();
 164                                 break;
 165                         default:
 166                                 longestPossibleContents = new String[0];
 167                                 break;
 168                         }
 169
 170                         col = createTableViewerColumn(name, longestPossibleContents);
 171                         columns[i + 1] = col;
 172                         createEditingAndLabel(col, miDef, i);
 173                 }
 174         }
 175
 176         private static final String[] HEX_DIGITS = { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "A", "B", "C", "D", "E", "F" };
 177
 178         private static String[] generateLongestHexStrings(int bitWidth)
 179         {
 180                 return Arrays.stream(HEX_DIGITS).map(s -> "0x" + s.repeat((bitWidth + 3) / 4)).toArray(String[]::new);
 181         }
 182
 183         private void createEditingAndLabel(TableViewerColumn col, MicroInstructionDefinition miDef, int index)
 184         {
 185                 ParameterClassification parameterClassification = miDef.getParameterClassifications()[index];
 186                 EditingSupport support;
 187                 ColumnLabelProvider provider;
 188                 switch (parameterClassification.getExpectedType())
 189                 {
 190                 case BOOLEAN_IMMEDIATE:
 191                         support = new BooleanEditingSupport(viewer, miDef, index);
 192                         provider = new ParameterLabelProvider(index);
 193                         break;
 194                 case INTEGER_IMMEDIATE:
 195                         support = new IntegerEditingSupport(viewer, miDef, index, displaySettings, this.provider);
 196                         provider = new IntegerColumnLabelProvider(displaySettings, index);
 197                         break;
 198                 case MNEMONIC:
 199                         support = new MnemonicEditingSupport(viewer, miDef, index, this.provider);
 200                         provider = new ParameterLabelProvider(index);
 201                         break;
 202                 default:
 203                         throw new IllegalStateException(
 204                                         "Unable to create EditingSupport for unknown ParameterType " + parameterClassification.getExpectedType());
 205                 }
 206                 col.setEditingSupport(support);
 207                 col.setLabelProvider(provider);
 208                 col.getColumn().setToolTipText(miDef.getParameterDescription(index).orElse(""));
 209         }
 210
 211         private TableViewerColumn createTableViewerColumn(String title, String... longestPossibleContents)
 212         {
 213                 TableViewerColumn viewerColumn = new TableViewerColumn(viewer, SWT.NONE);
 214                 TableColumn column = viewerColumn.getColumn();
 215                 int maxWidth = 0;
 216                 for (String s : longestPossibleContents)
 217                 {
 218                         column.setText(s);
 219                         column.pack();
 220                         if (column.getWidth() > maxWidth)
 221                                 maxWidth = column.getWidth();
 222                 }
 223                 column.setText(title);
 224                 column.pack();
 225                 if (column.getWidth() < maxWidth)
 226                         column.setWidth(maxWidth);
 227                 column.setResizable(true);
 228                 column.setMoveable(false);
 229                 return viewerColumn;
 230         }
 231
 232         private void open(String file)
 233         {
 234                 try (BufferedReader bf = new BufferedReader(new FileReader(file)))
 235                 {
 236                         machineName = bf.readLine();
 237                         bindMicroInstructionMemory(MicroInstructionMemoryParser.parseMemory(machineName, bf));
 238                 }
 239                 catch (IOException | MicroInstructionMemoryParseException e)
 240                 {
 241                         e.printStackTrace();
 242                 }
 243         }
 244
 245         private void save(String file)
 246         {
 247                 if (memory == null)
 248                 {
 249                         System.err.println("Failed to write MicroprogrammingMemory to File. No MicroprogrammingMemory assigned.");
 250                         return;
 251                 }
 252                 try
 253                 {
 254                         MicroInstructionMemoryParser.write(memory, machineName, file);
 255                 }
 256                 catch (IOException e)
 257                 {
 258                         e.printStackTrace();
 259                 }
 260         }
 261
 262         @Override
 263         public void setFocus()
 264         {
 265                 viewer.getControl().setFocus();
 266         }
 267
 268         @Override
 269         public void doSave(IProgressMonitor progressMonitor)
 270         {
 271                 IEditorInput input = getEditorInput();
 272                 if (input instanceof IPathEditorInput)
 273                 {
 274                         IPathEditorInput pathInput = (IPathEditorInput) input;
 275                         save(pathInput.getPath().toOSString());
 276                         setDirty(false);
 277                 }
 278         }
 279
 280         @Override
 281         public void doSaveAs()
 282         {
 283                 openSaveAsDialog();
 284         }
 285
 286         private void openSaveAsDialog()
 287         {
 288                 FileDialog d = new FileDialog(viewer.getTable().getShell(), SWT.SAVE);
 289                 d.open();
 290                 String filename = d.getFileName();
 291                 if (!filename.equals(""))
 292                 {
 293                         save(d.getFilterPath() + File.separator + filename);
 294                         setDirty(false);
 295                 }
 296         }
 297
 298         @Override
 299         public void init(IEditorSite site, IEditorInput input) throws PartInitException
 300         {
 301                 setSite(site);
 302                 setInput(input);
 303                 if (input instanceof IPathEditorInput)
 304                 {
 305                         IPathEditorInput pathInput = (IPathEditorInput) input;
 306                         setPartName(pathInput.getName());
 307                         open(pathInput.getPath().toOSString());
 308                 }
 309         }
 310
 311         @Override
 312         public boolean isDirty()
 313         {
 314                 return dirty;
 315         }
 316
 317         @Override
 318         public boolean isSaveAsAllowed()
 319         {
 320                 return true;
 321         }
 322
 323         @Override
 324         public void update(long address)
 325         {
 326                 setDirty(true);
 327         }
 328
 329         private void setDirty(boolean value)
 330         {
 331                 dirty = value;
 332                 firePropertyChange(PROP_DIRTY);
 333         }
 334 }