Fix listener cleanup, reload monitoring, settings and commands

This commit is contained in:
eyck committed 2026-11-15 09:22:55 +01:00
1 parent 7bceaa0635
commit 4824d48828
17 files changed
+872 -245

No files matched your search

@@ -11,6 +11,7 @@
package com.minres.scviewer.e4.application.elements;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.inject.Inject;
import javax.inject.Named;
@@ -52,6 +53,8 @@ public class RelationTypeToolControl extends PartListener implements ISelectionC
/** The dummy. */
RelationType dummy = RelationTypeFactory.create(Messages.RelationTypeToolControl_0);
private boolean disposed;
/**
* Instantiates a new relation type tool control.
@@ -79,6 +82,16 @@ public class RelationTypeToolControl extends PartListener implements ISelectionC
comboViewer.setInput(new RelationType[] {dummy});
comboViewer.setSelection(new StructuredSelection(dummy));
comboViewer.addSelectionChangedListener(this);
comboBox.addDisposeListener(event -> dispose());
}
@PreDestroy
public void dispose() {
if (disposed) return;
disposed = true;
partService.removePartListener(this);
if (comboViewer != null) comboViewer.removeSelectionChangedListener(this);
waveformViewerPart = null;
}
/* (non-Javadoc)
@@ -86,6 +99,7 @@ public class RelationTypeToolControl extends PartListener implements ISelectionC
*/
@Override
public void partActivated(MPart part) {
if (disposed) return;
if(part.getObject() instanceof WaveformViewer){
waveformViewerPart=(WaveformViewer) part.getObject();
checkSelection(waveformViewerPart.getSelection());
@@ -115,6 +129,7 @@ public class RelationTypeToolControl extends PartListener implements ISelectionC
* @param selection the selection
*/
protected void checkSelection(ISelection selection) {
if (disposed || comboViewer == null || comboViewer.getCombo().isDisposed()) return;
if( selection instanceof IStructuredSelection) {
Object object= ((IStructuredSelection)selection).getFirstElement();
if(object instanceof ITx && waveformViewerPart!=null){
@@ -142,4 +157,4 @@ public class RelationTypeToolControl extends PartListener implements ISelectionC
}
}
}
}
@@ -11,7 +11,6 @@
package com.minres.scviewer.e4.application.handlers;
import javax.inject.Inject;
import javax.inject.Named;
import org.eclipse.e4.core.di.annotations.CanExecute;
@@ -24,52 +23,56 @@ import org.eclipse.jface.viewers.IStructuredSelection;
import com.minres.scviewer.database.IWaveform;
import com.minres.scviewer.e4.application.parts.DesignBrowser;
import com.minres.scviewer.e4.application.parts.WaveformViewer;
import java.util.Arrays;
import org.eclipse.jface.viewers.ISelection;
public class AddWaveformHandler {
public static final String PARAM_WHERE_ID="com.minres.scviewer.e4.application.command.addwaveform.where"; //$NON-NLS-1$
public static final String PARAM_ALL_ID="com.minres.scviewer.e4.application.command.addwaveform.all"; //$NON-NLS-1$
@Inject @Optional DesignBrowser designBrowser;
@CanExecute
public boolean canExecute(@Named(PARAM_WHERE_ID) String where, @Named(PARAM_ALL_ID) String all,
EPartService partService,
@Named(IServiceConstants.ACTIVE_SELECTION) @Optional IStructuredSelection selection) {
if(designBrowser==null) designBrowser = getListPart( partService);
if(designBrowser==null || designBrowser.getActiveWaveformViewerPart()==null) return false;
boolean before = "before".equalsIgnoreCase(where); //$NON-NLS-1$
IStructuredSelection waveformSelection = null;
if(designBrowser.getActiveWaveformViewerPart()!=null) {
if(!designBrowser.getActiveWaveformViewerPart().getDatabase().isLoaded())
return false;
waveformSelection = (IStructuredSelection)designBrowser.getActiveWaveformViewerPart().getSelection();
}
if("true".equalsIgnoreCase(all)) //$NON-NLS-1$
return designBrowser.getFilteredChildren().length>0 &&
(!before || (waveformSelection!=null && waveformSelection.size()>0));
else
return selection!=null && selection.size()>0 &&
(!before || (waveformSelection!=null && waveformSelection.size()>0));
DesignBrowser browser = getListPart(partService);
return canAdd(browser, where) && candidates(browser, all, selection).length > 0;
}
@Execute
public void execute(@Named(PARAM_WHERE_ID) String where, @Named(PARAM_ALL_ID) String all,
public void execute(@Named(PARAM_WHERE_ID) String where, @Named(PARAM_ALL_ID) String all,
EPartService partService,
@Named(IServiceConstants.ACTIVE_SELECTION) @Optional IStructuredSelection selection) {
if(designBrowser==null) designBrowser = getListPart( partService);
if(designBrowser!=null && selection.size()>0){
@SuppressWarnings("unchecked")
IWaveform[] sel=(IWaveform[]) selection.toList().stream().filter(t -> t instanceof IWaveform).toArray(IWaveform[]::new);
designBrowser.getActiveWaveformViewerPart().addStreamsToList(sel, "before".equalsIgnoreCase(where)); //$NON-NLS-1$
}
DesignBrowser browser = getListPart(partService);
if (!canAdd(browser, where)) return;
IWaveform[] waveforms = candidates(browser, all, selection);
if (waveforms.length > 0)
browser.getActiveWaveformViewerPart().addStreamsToList(waveforms, "before".equalsIgnoreCase(where));
}
protected DesignBrowser getListPart(EPartService partService){
MPart part = partService.getActivePart();
if(part.getObject() instanceof DesignBrowser)
return (DesignBrowser) part.getObject();
else
return null;
}
private boolean canAdd(DesignBrowser browser, String where) {
WaveformViewer target = browser == null ? null : browser.getActiveWaveformViewerPart();
if (target == null || target.getDatabase() == null || !target.getDatabase().isLoaded()) return false;
ISelection selection = target.getSelection();
return !"before".equalsIgnoreCase(where) || (selection != null && !selection.isEmpty());
}
private IWaveform[] candidates(DesignBrowser browser, String all, IStructuredSelection selection) {
Object[] entries = "true".equalsIgnoreCase(all) ? browser.getFilteredChildren()
: selection == null ? new Object[0] : selection.toArray();
if (entries == null) return new IWaveform[0];
return Arrays.stream(entries).filter(IWaveform.class::isInstance).toArray(IWaveform[]::new);
}
protected DesignBrowser getListPart(EPartService partService) {
MPart part = partService == null ? null : partService.getActivePart();
if (part == null) return null;
if (part.getObject() instanceof DesignBrowser browser) return browser;
if (part.getObject() instanceof WaveformViewer viewer) {
DesignBrowser browser = viewer.getDesignBrowser();
return browser != null && browser.getActiveWaveformViewerPart() == viewer ? browser : null;
}
return null;
}
}
@@ -42,14 +42,15 @@ public class LoadStoreSettingsHandler {
public void execute(@Named(PARAMETER_ID) String param, Shell shell, MApplication app, EModelService modelService,
EPartService partService){
MPart part = partService.getActivePart();
if (part == null || !(part.getObject() instanceof WaveformViewer)) return;
Object obj = part.getObject();
boolean load = "load".equals(param); //$NON-NLS-1$
FileDialog dialog = new FileDialog(shell, load?SWT.OPEN:SWT.SAVE);
dialog.setFilterExtensions (new String []{Messages.LoadStoreSettingsHandler_2});
if(!load) dialog.setFileName(Messages.LoadStoreSettingsHandler_3);
String fileName = null;
MPart part = partService.getActivePart();
Object obj = part.getObject();
// Save active tab settings
if(!load) {
@@ -33,8 +33,8 @@ public class ReloadHandler {
EPartService partService){
MPart part = partService.getActivePart();
Object obj = part.getObject();
if(part!=null && (obj instanceof WaveformViewer)) {
Object obj = part == null ? null : part.getObject();
if(obj instanceof WaveformViewer) {
((WaveformViewer)obj).reloadDatabase();
}
@@ -10,11 +10,12 @@
*******************************************************************************/
package com.minres.scviewer.e4.application.handlers;
import org.eclipse.e4.core.di.annotations.CanExecute;
import org.eclipse.e4.core.di.annotations.Evaluate;
import org.eclipse.e4.core.di.annotations.Execute;
import org.eclipse.e4.ui.model.application.ui.basic.MPart;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.swt.widgets.Shell;
import com.minres.scviewer.database.ui.TrackEntry;
@@ -22,39 +23,20 @@ import com.minres.scviewer.e4.application.parts.WaveformViewer;
public class SearchHandler {
@Evaluate
@CanExecute
public boolean evaluate(MPart activePart) {
Object obj = activePart.getObject();
if(obj instanceof WaveformViewer){
WaveformViewer wfv = (WaveformViewer)obj;
ISelection sel = wfv.getSelection();
if(sel instanceof StructuredSelection) {
Object[] elem = ((StructuredSelection)sel).toArray();
if(elem.length ==0) return false;
TrackEntry e = findTrackEntry(elem);
return e!=null && e.waveform.getType().isTransaction();
}
if (activePart == null || !(activePart.getObject() instanceof WaveformViewer viewer)) return false;
ISelection selection = viewer.getSelection();
if (selection instanceof IStructuredSelection structured) {
for (Object element : structured.toArray())
if (element instanceof TrackEntry track && track.waveform != null
&& track.waveform.getType().isTransaction()) return true;
}
return false;
}
@Execute
public void execute(Shell shell, MPart activePart){
Object obj = activePart.getObject();
if(obj instanceof WaveformViewer){
// ISelection sel = wfv.getSelection();
// if(sel instanceof StructuredSelection) {
// TrackEntry e = findTrackEntry(((StructuredSelection)sel).toArray());
// SearchTxDialog dlg = new SearchTxDialog(shell, e.getStream());
// if (dlg.open() != Window.OK) return;
// wfv.search(dlg.getPropName(), dlg.getPropType(), dlg.getPropValue());
// }
}
}
private TrackEntry findTrackEntry(Object[] elems) {
for(Object o: elems)
if(o instanceof TrackEntry)
return (TrackEntry)o;
return null;
public void execute(Shell shell, MPart activePart) {
if (evaluate(activePart)) ((WaveformViewer) activePart.getObject()).focusTransactionSearch();
}
}
@@ -13,7 +13,8 @@ package com.minres.scviewer.e4.application.internal.util;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Hashtable;
import java.util.IdentityHashMap;
import java.util.Map;
import java.util.List;
import java.util.Timer;
import java.util.TimerTask;
@@ -28,10 +29,12 @@ public class FileMonitor {
private Timer timer;
/** The enabled. */
private boolean enabled;
private volatile boolean enabled;
private boolean disposed;
/** The timer entries. */
private Hashtable<String, FileSetMonitorTask> timerEntries;
private final Map<IFileChangeListener, FileSetMonitorTask> timerEntries;
/**
* Constructor.
@@ -39,11 +42,15 @@ public class FileMonitor {
public FileMonitor() {
// Create timer, run timer thread as daemon.
timer = new Timer(true);
timerEntries = new Hashtable<String, FileSetMonitorTask>();
timerEntries = new IdentityHashMap<>();
enabled=true;
}
public void dispose() {
public synchronized void dispose() {
if (disposed) return;
disposed = true;
enabled = false;
timerEntries.values().forEach(FileSetMonitorTask::cancel);
timer.cancel();
timerEntries.clear();
}
@@ -69,10 +76,11 @@ public class FileMonitor {
* @param period polling period in milliseconds.
* @return the i modification checker
*/
public IModificationChecker addFileChangeListener(IFileChangeListener listener, List<File> files, long period) {
public synchronized IModificationChecker addFileChangeListener(IFileChangeListener listener, List<File> files, long period) {
if (disposed) throw new IllegalStateException("File monitor is disposed");
removeFileChangeListener(listener);
FileSetMonitorTask task = new FileSetMonitorTask(listener, files, period);
timerEntries.put(Integer.toHexString(listener.hashCode()), task);
timerEntries.put(listener, task);
timer.schedule(task, period, period);
return task;
}
@@ -83,9 +91,12 @@ public class FileMonitor {
* @param listener
* the listener to be removed.
*/
public void removeFileChangeListener(IFileChangeListener listener) {
FileSetMonitorTask task = timerEntries.remove(Integer.toHexString(listener.hashCode()));
if (task != null) task.cancel();
public synchronized void removeFileChangeListener(IFileChangeListener listener) {
FileSetMonitorTask task = timerEntries.remove(listener);
if (task != null) {
task.cancel();
timer.purge();
}
}
/**
@@ -114,8 +125,8 @@ public class FileMonitor {
*
* @param enabled the new enabled
*/
public void setEnabled(boolean enabled) {
this.enabled = enabled;
public synchronized void setEnabled(boolean enabled) {
this.enabled = !disposed && enabled;
}
/**
@@ -132,6 +143,8 @@ public class FileMonitor {
/** The last modified times. */
private List<Long> lastModifiedTimes;
private volatile boolean active = true;
/** The period. */
public final long period;
@@ -144,10 +157,10 @@ public class FileMonitor {
*/
public FileSetMonitorTask(IFileChangeListener listener, List<File> monitoredFiles, long period) {
this.period=period;
this.monitoredFiles = monitoredFiles;
this.monitoredFiles = List.copyOf(monitoredFiles);
this.listener = listener;
lastModifiedTimes= new ArrayList<>();
for(File monitoredFile:monitoredFiles){
for(File monitoredFile:this.monitoredFiles){
Long lmt = 0L;
try {
lmt=monitoredFile.lastModified();
@@ -163,10 +176,15 @@ public class FileMonitor {
check();
}
/* (non-Javadoc)
* @see com.minres.scviewer.e4.application.internal.util.IModificationChecker#check()
*/
public void check() {
@Override
public boolean cancel() {
active = false;
return super.cancel();
}
@Override
public synchronized void check() {
if (!active || !enabled) return;
boolean res = false;
for(int i=0; i<monitoredFiles.size(); ++i){
File file = monitoredFiles.get(i);
@@ -178,7 +196,7 @@ public class FileMonitor {
res |= true;
lastModifiedTimes.set(i, lmt);
}
if(res)
if(res && active)
fireFileChangeEvent(this.listener, monitoredFiles);
}
}
@@ -47,6 +47,7 @@ import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.SashForm;
import org.eclipse.swt.events.ControlAdapter;
import org.eclipse.swt.events.ControlEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.events.PaintListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
@@ -144,6 +145,13 @@ public class DesignBrowser {
}
});
private final DisposeListener viewerDisposed = event -> {
if (!treeViewer.getControl().isDisposed()) resetTreeViewer();
if (subscribedDatabase != null) subscribedDatabase.removePropertyChangeListener(treeViewerPCL);
subscribedDatabase = null;
waveformViewerPart = null;
};
/** The sash paint listener. */
protected PaintListener sashPaintListener= e -> {
int size=Math.min(e.width, e.height)-1;
@@ -171,6 +179,8 @@ public class DesignBrowser {
Composite bottom = new Composite(sashForm, SWT.NONE);
createTableComposite(bottom);
parent.addDisposeListener(event -> {
if (this.waveformViewerPart != null) this.waveformViewerPart.removeDisposeListener(viewerDisposed);
this.waveformViewerPart = null;
if (subscribedDatabase != null)
subscribedDatabase.removePropertyChangeListener(treeViewerPCL);
subscribedDatabase = null;
@@ -362,19 +372,16 @@ public class DesignBrowser {
if( this.waveformViewerPart == null || this.waveformViewerPart != waveformViewerPart ) {
if(this.waveformViewerPart!=null)
this.waveformViewerPart.storeDesignBrowerState(new DBState());
waveformViewerPart.addDisposeListener( e -> {
Control control = treeViewer.getControl();
// check if widget is already disposed (f.ex. because of workbench closing)
if (control == null || control.isDisposed()) { //if so: do nothing
}else { //reset tree- and tableviewer
resetTreeViewer();
}
});
setWaveformViewer(waveformViewerPart);
}
}
public void setWaveformViewer(WaveformViewer waveformViewerPart) {
if (this.waveformViewerPart != waveformViewerPart) {
if (this.waveformViewerPart != null) this.waveformViewerPart.removeDisposeListener(viewerDisposed);
waveformViewerPart.addDisposeListener(viewerDisposed);
}
this.waveformViewerPart=waveformViewerPart;
IWaveformDb database = waveformViewerPart.getDatabase();
setWaveformDb(database);
@@ -294,15 +294,23 @@ public class TransactionList extends Composite {
});
}
public void focusSearch() {
if (isDisposed()) return;
searchPropValue.setFocus();
searchPropValue.selectAll();
}
public void setSearchProps(String propName, DataType type, String propValue) {
for(int i=0; i<searchPropComboViewer.getCombo().getItemCount(); ++i) {
String itemName = searchPropComboViewer.getCombo().getItem(i);
if(propName.equals(itemName)) {
searchPropComboViewer.getCombo().select(i);
for (int i = 0; i < attrNames.size(); i++) {
if (propName.equals(attrNames.get(i).getName())) {
searchPropComboViewer.setSelection(new StructuredSelection(attrNames.get(i)));
break;
}
}
txFilter.setSearchProp(propName, type);
txFilter.setSearchValue(propValue);
searchPropValue.setText(propValue);
tableViewer.refresh();
}
}
@@ -12,7 +12,6 @@ import org.eclipse.e4.ui.services.IServiceConstants;
import org.eclipse.e4.ui.workbench.modeling.EPartService;
import org.eclipse.e4.ui.workbench.modeling.ESelectionService;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
@@ -64,7 +63,7 @@ public class TransactionListView {
if(selection==null || selection.isEmpty())
transactionList.setInput(null);
else if(selection instanceof IStructuredSelection) {
TrackEntry e = findTrackEntry(((StructuredSelection)selection).toArray());
TrackEntry e = findTrackEntry(selection.toArray());
if(e!=null)
transactionList.setInput(e);
}
@@ -0,0 +1,117 @@
package com.minres.scviewer.e4.application.parts;
import static com.minres.scviewer.e4.application.parts.WaveformViewer.*;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import com.minres.scviewer.database.IWaveform;
import com.minres.scviewer.database.IWaveformDb;
import com.minres.scviewer.database.WaveformType;
import com.minres.scviewer.database.EventEntry;
import com.minres.scviewer.database.IEvent;
import com.minres.scviewer.database.tx.ITx;
import com.minres.scviewer.database.tx.ITxEvent;
import com.minres.scviewer.database.ui.TrackEntry.ValueDisplay;
import com.minres.scviewer.database.ui.TrackEntry.WaveDisplay;
/** Validates the existing properties format before any viewer state is changed. */
record ViewerSettings(List<Track> tracks, List<Long> cursors, Long scale, Long baseline,
Long transactionId, String transactionTrack, Boolean detailsShown) {
record Track(String name, WaveformType type, ValueDisplay valueDisplay, WaveDisplay waveDisplay, boolean selected) {}
static ViewerSettings parse(Map<String, String> state) {
List<Track> tracks = new ArrayList<>();
int count = count(state, SHOWN_WAVEFORM + "S");
for (int i = 0; i < count; i++) {
String key = SHOWN_WAVEFORM + i;
String name = required(state, key);
WaveformType type = enumeration(state, key + WAVEFORM_TYPE, WaveformType.class, null);
tracks.add(new Track(name, type,
enumeration(state, key + VALUE_DISPLAY, ValueDisplay.class, ValueDisplay.DEFAULT),
enumeration(state, key + WAVE_DISPLAY, WaveDisplay.class, WaveDisplay.DEFAULT),
Boolean.TRUE.equals(bool(state, key + WAVEFORM_SELECTED))));
}
List<Long> cursors = new ArrayList<>();
for (int i = 0, n = count(state, SHOWN_CURSOR + "S"); i < n; i++) {
required(state, SHOWN_CURSOR + i);
cursors.add(number(state, SHOWN_CURSOR + i));
}
Long scale = number(state, SCALING_FACTOR);
if (scale != null && scale <= 0) throw invalid(SCALING_FACTOR, "must be positive");
Long baseline = number(state, BASE_LINE_TIME);
if (baseline != null && baseline < 0) throw invalid(BASE_LINE_TIME, "must not be negative");
Long tx = number(state, SELECTED_TX_ID);
String track = state.get(SELECTED_TRACKENTRY_NAME);
if (tx != null) required(state, SELECTED_TRACKENTRY_NAME);
return new ViewerSettings(List.copyOf(tracks), List.copyOf(cursors), scale, baseline,
tx, track, bool(state, TX_DETAILS_SHOWN));
}
static List<File> databaseFiles(Map<String, String> state) {
List<File> files = new ArrayList<>();
for (int i = 0, n = count(state, DATABASE_FILE + "S"); i < n; i++)
files.add(new File(required(state, DATABASE_FILE + i)));
return files;
}
static IWaveform resolveWaveform(IWaveformDb database, String name) {
IWaveform waveform = database.getStreamByName(name);
if (waveform != null) return waveform;
int separator = name.lastIndexOf('.');
if (separator <= 0 || separator == name.length() - 1) return null;
IWaveform parent = database.getStreamByName(name.substring(0, separator));
if (parent == null) return null;
return parent.getChildNodes().stream().filter(IWaveform.class::isInstance).map(IWaveform.class::cast)
.filter(child -> name.substring(separator + 1).equals(child.getName())).findFirst().orElse(null);
}
static ITx findTransaction(IWaveform waveform, long id) {
for (EventEntry entry : waveform.getEvents().entrySet()) {
if (entry.events == null) continue;
for (IEvent event : entry.events)
if (event instanceof ITxEvent txEvent && txEvent.getTransaction().getId() == id)
return txEvent.getTransaction();
}
return null;
}
private static int count(Map<String, String> state, String key) {
Long value = number(state, key);
if (value == null) return 0;
if (value < 0 || value > state.size()) throw invalid(key, "count exceeds the available entries");
return value.intValue();
}
private static String required(Map<String, String> state, String key) {
String value = state.get(key);
if (value == null) throw invalid(key, "is missing");
return value;
}
private static Long number(Map<String, String> state, String key) {
if (!state.containsKey(key)) return null;
try { return Long.valueOf(state.get(key)); }
catch (NumberFormatException e) { throw invalid(key, "must be an integer"); }
}
private static Boolean bool(Map<String, String> state, String key) {
if (!state.containsKey(key)) return null;
String value = state.get(key);
if ("true".equalsIgnoreCase(value)) return true;
if ("false".equalsIgnoreCase(value)) return false;
throw invalid(key, "must be true or false");
}
private static <E extends Enum<E>> E enumeration(Map<String, String> state, String key, Class<E> type, E fallback) {
if (!state.containsKey(key)) return fallback;
try { return Enum.valueOf(type, required(state, key)); }
catch (IllegalArgumentException e) { throw invalid(key, "has an unknown value: " + state.get(key)); }
}
private static IllegalArgumentException invalid(String key, String reason) {
return new IllegalArgumentException(key + " " + reason);
}
}
@@ -12,17 +12,14 @@ package com.minres.scviewer.e4.application.parts;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Properties;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
@@ -43,6 +40,7 @@ import org.eclipse.e4.core.contexts.IEclipseContext;
import org.eclipse.e4.core.di.annotations.Optional;
import org.eclipse.e4.core.di.extensions.Preference;
import org.eclipse.e4.core.services.events.IEventBroker;
import org.eclipse.e4.core.services.log.Logger;
import org.eclipse.e4.ui.di.Focus;
import org.eclipse.e4.ui.di.PersistState;
import org.eclipse.e4.ui.di.UIEventTopic;
@@ -87,15 +85,12 @@ import com.minres.scviewer.database.RelationTypeFactory;
import com.minres.scviewer.database.WaveformType;
import com.minres.scviewer.database.tx.ITx;
import com.minres.scviewer.database.tx.ITxAttribute;
import com.minres.scviewer.database.tx.ITxEvent;
import com.minres.scviewer.database.tx.ITxRelation;
import com.minres.scviewer.database.ui.GotoDirection;
import com.minres.scviewer.database.ui.ICursor;
import com.minres.scviewer.database.ui.IWaveformView;
import com.minres.scviewer.database.ui.IWaveformviewEventListener;
import com.minres.scviewer.database.ui.TrackEntry;
import com.minres.scviewer.database.ui.TrackEntry.ValueDisplay;
import com.minres.scviewer.database.ui.TrackEntry.WaveDisplay;
import com.minres.scviewer.database.ui.ZoomKind;
import com.minres.scviewer.database.ui.swt.Constants;
import com.minres.scviewer.database.ui.swt.IToolTipContentProvider;
@@ -113,7 +108,7 @@ import com.minres.scviewer.e4.application.preferences.PreferenceConstants;
/**
* The Class WaveformViewerPart.
*/
public class WaveformViewer implements IFileChangeListener, IPreferenceChangeListener, DisposeListener {
public class WaveformViewer implements IPreferenceChangeListener, DisposeListener {
/** The Constant ACTIVE_WAVEFORMVIEW. */
public static final String ACTIVE_WAVEFORMVIEW = "Active_Waveform_View"; //$NON-NLS-1$
@@ -183,6 +178,8 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
/** get UISynchronize injected as field */
@Inject UISynchronize sync;
@Inject @Optional private Logger logger;
/** The event broker. */
@Inject
private IEventBroker eventBroker;
@@ -208,8 +205,18 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
private volatile boolean disposed;
private boolean loadingDatabase;
/** The check for updates. */
private boolean checkForUpdates;
private volatile boolean checkForUpdates;
private IEclipsePreferences observedPreferences;
private PartListener partListener;
private IFileChangeListener fileChangeListener;
private long fileWatchGeneration;
/** The my part. */
@Inject private MPart myPart;
@@ -385,17 +392,17 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
checkForUpdates = store.getBoolean(PreferenceConstants.DATABASE_RELOAD, true);
filesToLoad = new ArrayList<>();
persistedState = part.getPersistedState();
Integer files = persistedState.containsKey(DATABASE_FILE + "S") //$NON-NLS-1$
? Integer.parseInt(persistedState.get(DATABASE_FILE + "S")) : 0; //$NON-NLS-1$
for (int i = 0; i < files; i++) {
filesToLoad.add(new File(persistedState.get(DATABASE_FILE + i)));
try {
filesToLoad.addAll(ViewerSettings.databaseFiles(persistedState));
} catch (IllegalArgumentException e) {
reportSettingsError("Cannot restore database files", e.getMessage());
}
if (!filesToLoad.isEmpty())
loadDatabase(persistedState);
menuService.registerContextMenu(waveformPane.getNameControl(), MENU_CONTEXT);
menuService.registerContextMenu(waveformPane.getValueControl(), MENU_CONTEXT);
menuService.registerContextMenu(waveformPane.getWaveformControl(), MENU_CONTEXT);
ePartService.addPartListener(new PartListener() {
partListener = new PartListener() {
@Override
public void partActivated(MPart part) {
if (part == myPart && !disposed) {
@@ -404,7 +411,8 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
updateAll();
}
}
});
};
ePartService.addPartListener(partListener);
waveformPane.addDisposeListener(this);
waveformPane.addEventListner(new IWaveformviewEventListener() {
@@ -507,7 +515,16 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
public void closeDatabase() {
if (disposed) return;
disposed = true;
stopFileMonitoring();
fileMonitor.dispose();
if (observedPreferences != null) {
observedPreferences.removePreferenceChangeListener(this);
observedPreferences = null;
}
if (partListener != null) {
ePartService.removePartListener(partListener);
partListener = null;
}
fileChecker = null;
if (loadSession != null) loadSession.close();
}
@@ -515,6 +532,9 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
@Inject
@Optional
public void reactOnPrefsChange(@Preference(nodePath = PreferenceConstants.PREFERENCES_SCOPE) IEclipsePreferences prefs) {
if (disposed || observedPreferences == prefs) return;
if (observedPreferences != null) observedPreferences.removePreferenceChangeListener(this);
observedPreferences = prefs;
prefs.addPreferenceChangeListener(this);
}
@@ -533,14 +553,45 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
@Inject
@Optional
public void reactOnReloadDatabaseChange(@Preference(nodePath = PreferenceConstants.PREFERENCES_SCOPE, value = PreferenceConstants.DATABASE_RELOAD) Boolean checkForUpdates) {
if (disposed) return;
if (checkForUpdates.booleanValue()) {
fileChecker = fileMonitor.addFileChangeListener(WaveformViewer.this, filesToLoad, FILE_CHECK_INTERVAL);
} else {
fileMonitor.removeFileChangeListener(WaveformViewer.this);
fileChecker = null;
}
public void reactOnReloadDatabaseChange(@Preference(nodePath = PreferenceConstants.PREFERENCES_SCOPE, value = PreferenceConstants.DATABASE_RELOAD) Boolean enabled) {
checkForUpdates = Boolean.TRUE.equals(enabled);
if (!disposed && waveformPane != null) sync.asyncExec(this::startFileMonitoring);
}
protected boolean isViewerDisposed() {
return disposed || myParent == null || myParent.isDisposed();
}
protected boolean confirmReload() {
return MessageDialog.openQuestion(myParent.getShell(), Messages.WaveformViewer_17, Messages.WaveformViewer_18);
}
private void stopFileMonitoring() {
++fileWatchGeneration;
if (fileChangeListener != null) fileMonitor.removeFileChangeListener(fileChangeListener);
fileChangeListener = null;
fileChecker = null;
}
private void startFileMonitoring() {
stopFileMonitoring();
if (disposed || loadingDatabase || !checkForUpdates || database == null || !database.isLoaded()
|| loadSession == null || loadSession.isCancelled()) return;
final long generation = fileWatchGeneration;
final DatabaseLoadSession requestedSession = loadSession;
fileChangeListener = files -> sync.asyncExec(() -> {
if (isViewerDisposed() || !checkForUpdates
|| loadSession != requestedSession || generation != fileWatchGeneration) return;
stopFileMonitoring();
boolean reload = false;
try {
reload = confirmReload();
} finally {
if (!reload && loadSession == requestedSession) startFileMonitoring();
}
if (reload && !disposed && loadSession == requestedSession) reloadDatabase();
});
fileChecker = fileMonitor.addFileChangeListener(fileChangeListener, List.copyOf(filesToLoad), FILE_CHECK_INTERVAL);
}
/* (non-Javadoc)
@@ -562,8 +613,7 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
protected void loadDatabase(final Map<String, String> state, long delay) {
if (disposed) return;
fileMonitor.removeFileChangeListener(this);
fileChecker = null;
stopFileMonitoring();
if (loadSession != null) {
setSelection(null);
loadSession.close();
@@ -571,10 +621,13 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
waveformPane.update();
database = dbFactory.getDatabase();
}
loadingDatabase = true;
final IWaveformDb requestedDatabase = database;
final List<File> requestedFiles = List.copyOf(filesToLoad);
final Map<String, String> requestedState = state == null ? Map.of() : new HashMap<>(state);
final String requestedConfig = partConfig;
// An input configuration applies once; reloads preserve the current layout.
partConfig = "";
requestedDatabase.setName(requestedFiles.stream().map(File::getName).collect(java.util.stream.Collectors.joining(",")));
myPart.getContext().set(IWaveformDb.class, requestedDatabase);
loadSession = new DatabaseLoadSession(requestedDatabase, requestedFiles, event -> {
@@ -587,17 +640,19 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
}
}, result -> sync.asyncExec(() -> {
if (!isCurrentDatabase(requestedDatabase)) return;
loadingDatabase = false;
if (!result.isOK()) {
MessageDialog.openWarning(myParent.getShell(), "Error loading database", result.getMessage());
ePartService.hidePart(myPart, true);
return;
}
waveformPane.setMaxTime(requestedDatabase.getMaxTime());
if (requestedConfig != null && !requestedConfig.isEmpty()) loadState(requestedConfig);
if (!requestedState.isEmpty()) restoreWaveformViewerState(requestedState);
if (!isCurrentDatabase(requestedDatabase)) return;
if (requestedConfig != null && !requestedConfig.isEmpty()) loadState(requestedConfig);
if (!isCurrentDatabase(requestedDatabase)) return;
if (designBrowser != null) designBrowser.setWaveformDb(requestedDatabase);
if (checkForUpdates)
fileChecker = fileMonitor.addFileChangeListener(this, requestedFiles, FILE_CHECK_INTERVAL);
startFileMonitoring();
}));
loadSession.schedule(delay);
}
@@ -607,22 +662,6 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
&& loadSession != null && !loadSession.isCancelled();
}
/* (non-Javadoc)
* @see com.minres.scviewer.e4.application.internal.util.IFileChangeListener#fileChanged(java.util.List)
*/
@Override
public void fileChanged(List<File> file) {
final DatabaseLoadSession requestedSession = loadSession;
fileMonitor.removeFileChangeListener(this);
sync.asyncExec(() -> {
if (disposed || myParent.isDisposed() || loadSession != requestedSession) return;
if (MessageDialog.openQuestion(myParent.getShell(), Messages.WaveformViewer_17,
Messages.WaveformViewer_18)) {
reloadDatabase();
}
});
}
public void reloadDatabase() {
Map<String, String> state = new HashMap<>();
saveWaveformViewerState(state);
@@ -691,28 +730,28 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
try (FileOutputStream out = new FileOutputStream(fileName)) {
props.store(out, "Written by SCViewer"); //$NON-NLS-1$
} catch (IOException e) {
e.printStackTrace();
reportSettingsError("Cannot save settings", fileName + ": " + e.getMessage());
}
}
public void loadState(String fileName){
//clear old streams before loading tab settings
if(!waveformPane.getStreamList().isEmpty()) {
waveformPane.getStreamList().clear();
waveformPane.getStreamList().stream().forEach(e -> e.selected=false);
}
public void loadState(String fileName) {
try (FileInputStream in = new FileInputStream(fileName)) {
Properties props = new Properties();
props.load(in);
@SuppressWarnings({ "unchecked", "rawtypes" })
HashMap<String, String> propMap = new HashMap<>((Map) props);
restoreWaveformViewerState(propMap);
} catch(FileNotFoundException e) {
} catch (IOException e) {
e.printStackTrace();
Map<String, String> state = new HashMap<>();
for (String key : props.stringPropertyNames()) state.put(key, props.getProperty(key));
applySettings(ViewerSettings.parse(state));
} catch (IOException | IllegalArgumentException e) {
reportSettingsError("Cannot load settings", fileName + ": " + e.getMessage());
}
}
protected void reportSettingsError(String title, String message) {
if (logger != null) logger.error(title + ": " + message);
if (!disposed && myParent != null && !myParent.isDisposed())
MessageDialog.openError(myParent.getShell(), title, message);
}
/**
* Save waveform viewer state.
*
@@ -741,6 +780,8 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
persistingState.put(SCALING_FACTOR, Long.toString(waveformPane.getWaveformZoom().getScale()));
persistingState.put(BASE_LINE_TIME, Long.toString(waveformPane.getWaveformZoom().getMinVisibleTime()));
persistingState.remove(SELECTED_TX_ID);
persistingState.remove(SELECTED_TRACKENTRY_NAME);
// get selected transaction of a stream
ISelection selection = waveformPane.getSelection();
if (!selection.isEmpty()) {
@@ -780,97 +821,61 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
* @param state the state
*/
protected void restoreWaveformViewerState(Map<String, String> state) {
Integer waves = state.containsKey(SHOWN_WAVEFORM+"S") ? Integer.parseInt(state.get(SHOWN_WAVEFORM + "S")):0; //$NON-NLS-1$ //$NON-NLS-2$
List<TrackEntry> trackEntries = new LinkedList<>();
List<TrackEntry> selectedTrackEntries = new LinkedList<>();
for (int i = 0; i < waves; i++) {
String wtString = state.get(SHOWN_WAVEFORM + i + WAVEFORM_TYPE);
if(wtString!=null && wtString.equals("EMPTY")) {
TrackEntry trackEntry = waveformPane.addWaveform(new EmptyWaveform(state.get(SHOWN_WAVEFORM + i)), -1);
//check if t is selected
trackEntries.add(trackEntry);
if(Boolean.parseBoolean(state.get(SHOWN_WAVEFORM + i + WAVEFORM_SELECTED)))
selectedTrackEntries.add(trackEntry);
} else {
String name = state.get(SHOWN_WAVEFORM + i);
IWaveform waveform = database.getStreamByName(name);
if (waveform == null) {
int pos = name.lastIndexOf('.');
waveform = database.getStreamByName(name.substring(0, pos));
if(waveform!=null) {
List<IHierNode> childs = waveform.getChildNodes();
waveform = (IWaveform) childs.stream().filter(node -> name.substring(pos+1).equals(node.getName()))
.findAny()
.orElse(null);
}
}
if (waveform != null) {
TrackEntry trackEntry = waveformPane.addWaveform(waveform, -1);
//check if t is selected
trackEntries.add(trackEntry);
if(Boolean.parseBoolean(state.get(SHOWN_WAVEFORM + i + WAVEFORM_SELECTED)))
selectedTrackEntries.add(trackEntry);
String v = state.get(SHOWN_WAVEFORM + i + VALUE_DISPLAY);
if(v!=null)
trackEntry.valueDisplay=ValueDisplay.valueOf(v);
String s = state.get(SHOWN_WAVEFORM + i + WAVE_DISPLAY);
if(s!=null)
trackEntry.waveDisplay=WaveDisplay.valueOf(s);
}
try {
applySettings(ViewerSettings.parse(state));
} catch (IllegalArgumentException e) {
reportSettingsError("Cannot restore settings", e.getMessage());
}
}
private record ResolvedTrack(IWaveform waveform, ViewerSettings.Track settings) {}
private void applySettings(ViewerSettings settings) {
// Resolve all references before replacing the current layout.
List<ResolvedTrack> resolved = new ArrayList<>();
List<String> missing = new ArrayList<>();
ITx selectedTransaction = null;
IWaveform selectedWaveform = null;
for (ViewerSettings.Track track : settings.tracks()) {
IWaveform waveform = track.type() == WaveformType.EMPTY ? new EmptyWaveform(track.name())
: ViewerSettings.resolveWaveform(database, track.name());
if (waveform == null) {
missing.add(track.name());
continue;
}
resolved.add(new ResolvedTrack(waveform, track));
if (settings.transactionId() != null && waveform.getType().isTransaction()
&& track.name().equals(settings.transactionTrack())) {
selectedTransaction = ViewerSettings.findTransaction(waveform, settings.transactionId());
selectedWaveform = waveform;
}
}
Integer cursorLength = state.containsKey(SHOWN_CURSOR+"S")?Integer.parseInt(state.get(SHOWN_CURSOR + "S")):0; //$NON-NLS-1$ //$NON-NLS-2$
waveformPane.setSelection(StructuredSelection.EMPTY);
waveformPane.getStreamList().clear();
List<TrackEntry> selectedTracks = new ArrayList<>();
TrackEntry transactionTrack = null;
for (ResolvedTrack track : resolved) {
TrackEntry entry = waveformPane.addWaveform(track.waveform(), -1);
entry.valueDisplay = track.settings().valueDisplay();
entry.waveDisplay = track.settings().waveDisplay();
if (track.settings().selected()) selectedTracks.add(entry);
if (track.waveform() == selectedWaveform) transactionTrack = entry;
}
List<ICursor> cursors = waveformPane.getCursorList();
if (cursorLength == cursors.size()) {
for (int i = 0; i < cursorLength; i++) {
Long time = Long.parseLong(state.get(SHOWN_CURSOR + i));
cursors.get(i).setTime(time);
}
if (settings.cursors().size() == cursors.size()) {
for (int i = 0; i < cursors.size(); i++) cursors.get(i).setTime(settings.cursors().get(i));
}
if (state.containsKey(SCALING_FACTOR)) {
try {
long scale = Long.parseLong(state.get(SCALING_FACTOR));
waveformPane.getWaveformZoom().setScale(scale);
} catch (NumberFormatException e) {
}
}
if (state.containsKey(BASE_LINE_TIME)) {
try {
Long scale = Long.parseLong(state.get(BASE_LINE_TIME));
waveformPane.getWaveformZoom().setMinVisibleTime(scale);
} catch (NumberFormatException e) {
}
}
if (state.containsKey(SELECTED_TX_ID) && state.containsKey(SELECTED_TRACKENTRY_NAME)) {
try {
Long txId = Long.parseLong(state.get(SELECTED_TX_ID));
String trackentryName = state.get(SELECTED_TRACKENTRY_NAME);
//get TrackEntry Object based on name and TX Object by id and put into selectionList
trackEntries.stream().filter(e->trackentryName.equals(e.waveform.getFullName())).forEach(trackEntry ->
trackEntry.waveform.getEvents().entrySet().stream()
.map(e->e.events)
.filter(Objects::nonNull)
.forEach(entries->
Arrays.stream(entries)
.filter(e->e instanceof ITxEvent && txId.equals(((ITxEvent)e).getTransaction().getId()))
.forEach(event ->
waveformPane.setSelection(new StructuredSelection(
new Object[] {((ITxEvent)event).getTransaction(), trackEntry}))
)
)
);
} catch (NumberFormatException e) {
}
}
if (state.containsKey(TX_DETAILS_SHOWN)) {
try {
showTxDetails(Boolean.parseBoolean(state.get(TX_DETAILS_SHOWN)));
} catch (NumberFormatException e) {
}
}
ISelection sel = new StructuredSelection(selectedTrackEntries);
waveformPane.setSelection(sel);
if (settings.scale() != null) waveformPane.getWaveformZoom().setScale(settings.scale());
if (settings.baseline() != null) waveformPane.getWaveformZoom().setMinVisibleTime(settings.baseline());
if (settings.detailsShown() != null) showTxDetails(settings.detailsShown());
waveformPane.update();
if (selectedTransaction != null && transactionTrack != null)
waveformPane.setSelection(new StructuredSelection(new Object[] {selectedTransaction, transactionTrack}));
else waveformPane.setSelection(new StructuredSelection(selectedTracks));
updateAll();
if (!missing.isEmpty() && !disposed && !myParent.isDisposed())
MessageDialog.openWarning(myParent.getShell(), "Missing waveforms",
"These waveforms are absent from the current database and were skipped:\n" + String.join("\n", missing));
}
/**
@@ -1212,7 +1217,12 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
* @param listener
*/
public void addDisposeListener (DisposeListener listener) {
waveformPane.getControl().addDisposeListener(listener);
myParent.addDisposeListener(listener);
}
public void removeDisposeListener(DisposeListener listener) {
if (myParent != null && !myParent.isDisposed())
myParent.removeDisposeListener(listener);
}
/**
@@ -1230,6 +1240,16 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
}
}
public DesignBrowser getDesignBrowser() {
return designBrowser;
}
public void focusTransactionSearch() {
if (disposed || transactionList == null) return;
showTxDetails(true);
transactionList.getControl().focusSearch();
}
public void search(String propName, DataType type, String propValue) {
transactionList.getControl().setSearchProps(propName, type, propValue);
}
@@ -1262,4 +1282,4 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
waveformPane.setSelection(sel);
designBrowser.selectAllWaveforms();
}
}
}
@@ -37,6 +37,7 @@ public class TxFilter extends ViewerFilter {
public void setSearchProp(String s, DataType type) {
this.searchProp = s;
this.searchType = type;
setSearchValue(searchValue);
}
/**
* Sets the search text.
@@ -45,7 +46,8 @@ public class TxFilter extends ViewerFilter {
*/
public void setSearchValue(String s) {
this.searchValue = s;
if(searchType==DataType.STRING) {
pattern = null;
if(searchType==DataType.STRING && searchValue != null) {
try {
//pattern = Pattern.compile(searchValue, Pattern.CASE_INSENSITIVE | Pattern.UNICODE_CASE);
pattern = Pattern.compile(searchValue);
@@ -75,7 +77,7 @@ public class TxFilter extends ViewerFilter {
switch(searchType) {
case BOOLEAN: // bool
case ENUMERATION:
return searchValue.equalsIgnoreCase((String) attr.getValue());
return searchValue.equalsIgnoreCase(String.valueOf(attr.getValue()));
case INTEGER:
case UNSIGNED:
BigInteger lval = new BigInteger(attr.getValue().toString());
@@ -0,0 +1,145 @@
package com.minres.scviewer.e4.application.handlers;
import static org.junit.Assert.*;
import java.lang.reflect.Proxy;
import java.util.List;
import java.util.concurrent.atomic.AtomicReference;
import org.eclipse.e4.ui.model.application.ui.basic.MPart;
import org.eclipse.e4.ui.workbench.modeling.EPartService;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.junit.Test;
import com.minres.scviewer.database.IWaveform;
import com.minres.scviewer.database.IWaveformDb;
import com.minres.scviewer.database.WaveformType;
import com.minres.scviewer.database.ui.TrackEntry;
import com.minres.scviewer.e4.application.parts.DesignBrowser;
import com.minres.scviewer.e4.application.parts.WaveformViewer;
public class CommandHandlersTest {
private static class Viewer extends WaveformViewer {
ISelection selection = StructuredSelection.EMPTY;
DesignBrowser browser;
IWaveform[] added;
boolean insert;
int searches;
final IWaveformDb db = (IWaveformDb) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveformDb.class},
(proxy, method, args) -> method.getName().equals("isLoaded") ? true : null);
@Override public ISelection getSelection() { return selection; }
@Override public IWaveformDb getDatabase() { return db; }
@Override public DesignBrowser getDesignBrowser() { return browser; }
@Override public void addStreamsToList(IWaveform[] waveforms, boolean before) { added = waveforms; insert = before; }
@Override public void focusTransactionSearch() { searches++; }
}
private DesignBrowser browser(Viewer viewer, Object... entries) {
return new DesignBrowser() {
@Override public WaveformViewer getActiveWaveformViewerPart() { return viewer; }
@Override public Object[] getFilteredChildren() { return entries; }
};
}
private IWaveform waveform(WaveformType type) {
return (IWaveform) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveform.class},
(proxy, method, args) -> switch (method.getName()) {
case "getType" -> type;
case "getChildNodes" -> List.of();
default -> null;
});
}
private MPart part(Object object) {
return (MPart) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{MPart.class},
(proxy, method, args) -> method.getName().equals("getObject") ? object : null);
}
private EPartService parts(AtomicReference<MPart> active) {
return (EPartService) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{EPartService.class},
(proxy, method, args) -> method.getName().equals("getActivePart") ? active.get() : null);
}
@Test
public void addAllUsesFilteredChildrenWithoutASelectionAndFollowsActiveTab() {
Viewer first = new Viewer(), second = new Viewer();
IWaveform a = waveform(WaveformType.STREAM), b = waveform(WaveformType.STREAM);
first.browser = browser(first, a, "unrelated"); second.browser = browser(second, b);
AtomicReference<MPart> active = new AtomicReference<>(part(first));
EPartService service = parts(active);
AddWaveformHandler handler = new AddWaveformHandler();
try {
assertTrue(handler.canExecute("after", "true", service, null));
handler.execute("after", "true", service, null);
assertArrayEquals(new IWaveform[]{a}, first.added);
active.set(part(second));
handler.execute("after", "true", service, null);
assertArrayEquals(new IWaveform[]{b}, second.added);
assertFalse(second.insert);
} finally { first.closeDatabase(); second.closeDatabase(); }
}
@Test
public void staleBrowserFromPreviousTabCannotReceiveAddCommands() {
Viewer previous = new Viewer(), activeViewer = new Viewer();
IWaveform wave = waveform(WaveformType.STREAM);
activeViewer.browser = browser(previous, wave);
EPartService service = parts(new AtomicReference<>(part(activeViewer)));
AddWaveformHandler handler = new AddWaveformHandler();
try {
assertFalse(handler.canExecute("after", "true", service, null));
handler.execute("after", "true", service, null);
assertNull(previous.added);
assertNull(activeViewer.added);
} finally { previous.closeDatabase(); activeViewer.closeDatabase(); }
}
@Test
public void executeRechecksInsertionAndRejectsMissingOrUnrelatedSelection() {
Viewer viewer = new Viewer();
IWaveform wave = waveform(WaveformType.STREAM);
viewer.browser = browser(viewer, wave);
EPartService service = parts(new AtomicReference<>(part(viewer)));
AddWaveformHandler handler = new AddWaveformHandler();
try {
handler.execute("before", "true", service, null);
assertNull(viewer.added);
assertFalse(handler.canExecute("after", "false", service, new StructuredSelection("unrelated")));
handler.execute("after", "false", service, null);
assertNull(viewer.added);
viewer.selection = new StructuredSelection(new TrackEntry(wave, null));
handler.execute("before", "false", service, new StructuredSelection(wave));
assertArrayEquals(new IWaveform[]{wave}, viewer.added);
assertTrue(viewer.insert);
} finally { viewer.closeDatabase(); }
}
@Test
public void searchRevealsExistingControlsOnlyForTransactionTracks() {
Viewer viewer = new Viewer();
SearchHandler handler = new SearchHandler();
MPart part = part(viewer);
try {
viewer.selection = new StructuredSelection(new TrackEntry(waveform(WaveformType.SIGNAL), null));
handler.execute(null, part);
assertEquals(0, viewer.searches);
viewer.selection = new StructuredSelection(new TrackEntry(waveform(WaveformType.STREAM), null));
assertTrue(handler.evaluate(part));
handler.execute(null, part);
assertEquals(1, viewer.searches);
assertFalse(handler.evaluate(null));
} finally { viewer.closeDatabase(); }
}
@Test
public void missingActivePartIsSafeDuringCommandExecution() {
EPartService service = parts(new AtomicReference<>());
AddWaveformHandler add = new AddWaveformHandler();
assertFalse(add.canExecute("after", "true", service, null));
add.execute("after", "true", service, null);
new ReloadHandler().execute(null, null, null, service);
new LoadStoreSettingsHandler().execute("load", null, null, null, service);
new SearchHandler().execute(null, null);
}
}
@@ -0,0 +1,50 @@
package com.minres.scviewer.e4.application.internal.util;
import static org.junit.Assert.*;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.FileTime;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import org.junit.Test;
public class FileMonitorTest {
@Test
public void collidingListenersAreIndependentAndCancelledCheckersStayInactive() throws Exception {
FileMonitor monitor = new FileMonitor();
Path file = Files.createTempFile("scviewer-watch", ".tmp");
AtomicInteger first = new AtomicInteger();
AtomicInteger second = new AtomicInteger();
IFileChangeListener a = listener(first);
IFileChangeListener b = listener(second);
try {
List<java.io.File> files = new ArrayList<>(List.of(file.toFile()));
IModificationChecker ca = monitor.addFileChangeListener(a, files, 60000);
IModificationChecker cb = monitor.addFileChangeListener(b, files, 60000);
files.clear();
Files.setLastModifiedTime(file, FileTime.fromMillis(Files.getLastModifiedTime(file).toMillis() + 10000));
ca.check(); cb.check();
assertEquals(1, first.get()); assertEquals(1, second.get());
monitor.removeFileChangeListener(a);
Files.setLastModifiedTime(file, FileTime.fromMillis(Files.getLastModifiedTime(file).toMillis() + 10000));
ca.check(); cb.check();
assertEquals(1, first.get()); assertEquals(2, second.get());
monitor.dispose();
monitor.setEnabled(true);
assertFalse(monitor.isEnabled());
Files.setLastModifiedTime(file, FileTime.fromMillis(Files.getLastModifiedTime(file).toMillis() + 10000));
cb.check();
assertEquals(2, second.get());
} finally { monitor.dispose(); Files.deleteIfExists(file); }
}
private IFileChangeListener listener(AtomicInteger count) {
return new IFileChangeListener() {
@Override public void fileChanged(List<java.io.File> files) { count.incrementAndGet(); }
@Override public int hashCode() { return 1; }
};
}
}
@@ -0,0 +1,125 @@
package com.minres.scviewer.e4.application.parts;
import static org.junit.Assert.*;
import java.lang.reflect.Proxy;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.FileTime;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.e4.ui.di.UISynchronize;
import org.eclipse.e4.ui.workbench.modeling.EPartService;
import org.junit.Test;
import com.minres.scviewer.database.IWaveformDb;
import com.minres.scviewer.database.ui.IWaveformView;
import com.minres.scviewer.e4.application.elements.RelationTypeToolControl;
import com.minres.scviewer.e4.application.internal.util.DatabaseLoadSession;
import com.minres.scviewer.e4.application.internal.util.IModificationChecker;
public class ViewerLifecycleTest {
private void set(WaveformViewer viewer, String name, Object value) throws Exception {
java.lang.reflect.Field field = WaveformViewer.class.getDeclaredField(name);
field.setAccessible(true); field.set(viewer, value);
}
private IEclipsePreferences preferences(AtomicInteger adds, AtomicInteger removes) {
return (IEclipsePreferences) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IEclipsePreferences.class},
(proxy, method, args) -> {
if (method.getName().equals("addPreferenceChangeListener")) adds.incrementAndGet();
if (method.getName().equals("removePreferenceChangeListener")) removes.incrementAndGet();
return null;
});
}
@Test
public void preferenceReinjectionAndRepeatedDisposalDoNotLeakListeners() throws Exception {
WaveformViewer viewer = new WaveformViewer();
AtomicInteger addsA = new AtomicInteger(), removesA = new AtomicInteger();
AtomicInteger addsB = new AtomicInteger(), removesB = new AtomicInteger();
AtomicInteger removedParts = new AtomicInteger();
IEclipsePreferences a = preferences(addsA, removesA), b = preferences(addsB, removesB);
viewer.ePartService = (EPartService) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{EPartService.class},
(proxy, method, args) -> {
if (method.getName().equals("removePartListener")) removedParts.incrementAndGet();
return null;
});
set(viewer, "partListener", new PartListener());
try {
viewer.reactOnPrefsChange(a); viewer.reactOnPrefsChange(a); viewer.reactOnPrefsChange(b);
assertEquals(1, addsA.get()); assertEquals(1, removesA.get());
assertEquals(1, addsB.get());
viewer.closeDatabase(); viewer.closeDatabase(); viewer.reactOnPrefsChange(a);
assertEquals(1, removesB.get()); assertEquals(1, removedParts.get()); assertEquals(1, addsA.get());
} finally { viewer.closeDatabase(); }
}
@Test
public void toolbarPartListenerIsRemovedEvenWhenDisposedBeforeGuiCreation() {
AtomicInteger added = new AtomicInteger(), removed = new AtomicInteger();
EPartService parts = (EPartService) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{EPartService.class},
(proxy, method, args) -> {
if (method.getName().equals("addPartListener")) added.incrementAndGet();
if (method.getName().equals("removePartListener")) removed.incrementAndGet();
return null;
});
RelationTypeToolControl control = new RelationTypeToolControl(parts);
control.dispose(); control.dispose();
assertEquals(1, added.get()); assertEquals(1, removed.get());
}
@Test
public void decliningReloadResumesMonitoringAndPreferenceChangesTakeEffect() throws Exception {
class Viewer extends WaveformViewer {
boolean closed;
int prompts;
@Override protected boolean isViewerDisposed() { return closed; }
@Override protected boolean confirmReload() { prompts++; return false; }
@Override public void closeDatabase() { closed = true; super.closeDatabase(); }
}
Viewer viewer = new Viewer();
Path file = Files.createTempFile("scviewer-reload", ".tmp");
IWaveformDb database = (IWaveformDb) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveformDb.class},
(proxy, method, args) -> method.getName().equals("isLoaded") ? true : null);
DatabaseLoadSession session = new DatabaseLoadSession(database, List.of(file.toFile()), event -> {}, result -> {});
try {
viewer.sync = new UISynchronize() {
@Override public void syncExec(Runnable task) { task.run(); }
@Override public void asyncExec(Runnable task) { task.run(); }
@Override protected boolean isUIThread(Thread thread) { return true; }
@Override protected void showBusyWhile(Runnable task) { task.run(); }
@Override protected boolean dispatchEvents() { return false; }
};
set(viewer, "database", database); set(viewer, "loadSession", session);
set(viewer, "waveformPane", Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveformView.class},
(proxy, method, args) -> null));
viewer.filesToLoad.add(file.toFile());
viewer.reactOnReloadDatabaseChange(true);
IModificationChecker first = viewer.fileChecker;
assertNotNull(first);
change(file); first.check();
assertEquals(1, viewer.prompts); assertNotNull(viewer.fileChecker); assertNotSame(first, viewer.fileChecker);
viewer.fileChecker.check();
assertEquals("Declined change must be acknowledged", 1, viewer.prompts);
change(file); viewer.fileChecker.check();
assertEquals(2, viewer.prompts);
IModificationChecker old = viewer.fileChecker;
viewer.reactOnReloadDatabaseChange(false);
assertNull(viewer.fileChecker);
change(file); old.check();
assertEquals(2, viewer.prompts);
viewer.reactOnReloadDatabaseChange(true);
assertNotNull(viewer.fileChecker);
viewer.closeDatabase();
viewer.reactOnReloadDatabaseChange(true);
assertNull(viewer.fileChecker);
} finally { viewer.closeDatabase(); Files.deleteIfExists(file); }
}
private void change(Path file) throws Exception {
Files.setLastModifiedTime(file, FileTime.fromMillis(Files.getLastModifiedTime(file).toMillis() + 10000));
}
}
@@ -0,0 +1,91 @@
package com.minres.scviewer.e4.application.parts;
import static org.junit.Assert.*;
import java.lang.reflect.Proxy;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.Map;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import org.junit.Test;
import com.minres.scviewer.database.EmptyWaveform;
import com.minres.scviewer.database.IWaveformDb;
import com.minres.scviewer.database.IHierNode;
import com.minres.scviewer.database.WaveformType;
import com.minres.scviewer.database.ui.IWaveformView;
import com.minres.scviewer.database.ui.TrackEntry.ValueDisplay;
public class ViewerSettingsTest {
private Map<String, String> state() {
return new HashMap<>(Map.of("SHOWN_WAVEFORMS", "1", "SHOWN_WAVEFORM0", "top.stream",
"SHOWN_WAVEFORM0.WAVEFORM_TYPE", "STREAM", "SHOWN_WAVEFORM0.VALUE_DISPLAY", "BINARY",
"SHOWN_WAVEFORM0.WAVEFORM_SELECTED", "TRUE", "SHOWN_CURSORS", "1", "SHOWN_CURSOR0", "123"));
}
@Test
public void readsExistingFormatIncludingOptionalAndUppercaseValues() {
ViewerSettings settings = ViewerSettings.parse(state());
assertEquals("top.stream", settings.tracks().get(0).name());
assertEquals(WaveformType.STREAM, settings.tracks().get(0).type());
assertEquals(ValueDisplay.BINARY, settings.tracks().get(0).valueDisplay());
assertTrue(settings.tracks().get(0).selected());
assertEquals(Long.valueOf(123), settings.cursors().get(0));
assertNull(settings.scale());
}
@Test
public void rejectsMalformedFieldsBeforeApplication() {
for (Map.Entry<String, String> entry : Map.of("SHOWN_WAVEFORMS", "-1", "SHOWN_CURSORS", "9999999999",
"SHOWN_CURSOR0", "time", "SCALING_FACTOR", "0", "BASE_LINE_TIME", "-1",
"SHOWN_WAVEFORM0.VALUE_DISPLAY", "invalid", "TX_DETAILS_SHOWN", "maybe").entrySet()) {
Map<String, String> invalid = state();
invalid.put(entry.getKey(), entry.getValue());
try { ViewerSettings.parse(invalid); fail("Accepted " + entry.getKey()); }
catch (IllegalArgumentException e) { assertTrue(e.getMessage().contains(entry.getKey())); }
}
Map<String, String> missing = state();
missing.remove("SHOWN_WAVEFORM0");
try { ViewerSettings.parse(missing); fail("Accepted missing waveform name"); }
catch (IllegalArgumentException e) { assertTrue(e.getMessage().contains("SHOWN_WAVEFORM0")); }
}
@Test
public void missingUnqualifiedWaveformDoesNotAttemptInvalidSubstring() {
EmptyWaveform child = new EmptyWaveform("child");
EmptyWaveform parent = new EmptyWaveform("top") {
@Override public List<IHierNode> getChildNodes() { return List.of(child); }
};
IWaveformDb db = (IWaveformDb) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveformDb.class},
(proxy, method, args) -> method.getName().equals("getStreamByName") && args[0].equals("top") ? parent : null);
assertNull(ViewerSettings.resolveWaveform(db, "missing"));
assertNull(ViewerSettings.resolveWaveform(db, "top.absent"));
assertSame(child, ViewerSettings.resolveWaveform(db, "top.child"));
}
@Test
public void invalidOrUnreadableFileLeavesViewerUntouchedAndReportsError() throws Exception {
AtomicInteger changes = new AtomicInteger();
IWaveformView pane = (IWaveformView) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{IWaveformView.class},
(proxy, method, args) -> { changes.incrementAndGet(); throw new AssertionError("Layout changed before validation"); });
class Viewer extends WaveformViewer {
int errors;
@Override protected void reportSettingsError(String title, String message) { errors++; assertFalse(message.isEmpty()); }
}
Viewer viewer = new Viewer();
Path file = Files.createTempFile("scviewer-settings", ".properties");
try {
java.lang.reflect.Field field = WaveformViewer.class.getDeclaredField("waveformPane");
field.setAccessible(true); field.set(viewer, pane);
Files.writeString(file, "SHOWN_WAVEFORMS=1\nSHOWN_WAVEFORM0=stream\nSHOWN_WAVEFORM0.WAVE_DISPLAY=unknown\n");
viewer.loadState(file.toString());
Files.delete(file);
viewer.loadState(file.toString());
assertEquals(2, viewer.errors);
assertEquals(0, changes.get());
} finally { viewer.closeDatabase(); Files.deleteIfExists(file); }
}
}
@@ -0,0 +1,44 @@
package com.minres.scviewer.e4.application.parts.txTableTree;
import static org.junit.Assert.*;
import java.lang.reflect.Proxy;
import java.util.List;
import org.junit.Test;
import com.minres.scviewer.database.DataType;
import com.minres.scviewer.database.tx.ITx;
import com.minres.scviewer.database.tx.ITxAttribute;
public class TxFilterTest {
private ITx transaction(String name, Object value) {
ITxAttribute attribute = (ITxAttribute) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{ITxAttribute.class},
(proxy, method, args) -> switch (method.getName()) {
case "getName" -> name;
case "getValue" -> value;
default -> null;
});
return (ITx) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{ITx.class},
(proxy, method, args) -> method.getName().equals("getAttributes") ? List.of(attribute) : null);
}
@Test
public void switchingToStringPropertyRecompilesExistingSearchText() {
TxFilter filter = new TxFilter();
filter.setSearchProp("number", DataType.INTEGER);
filter.setSearchValue("match");
filter.setSearchProp("text", DataType.STRING);
assertFalse(filter.select(null, null, transaction("text", "different")));
assertTrue(filter.select(null, null, transaction("text", "prefix match suffix")));
}
@Test
public void booleanValuesCanBeMatchedWithoutAStringCast() {
TxFilter filter = new TxFilter();
filter.setSearchProp("flag", DataType.BOOLEAN);
filter.setSearchValue("TRUE");
assertTrue(filter.select(null, null, transaction("flag", true)));
assertFalse(filter.select(null, null, transaction("flag", false)));
}
}