org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/editors/EventsViewEditor.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Patrick Tasse - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.ui.editors;
  14
  15 import java.io.FileNotFoundException;
  16 import java.util.List;
  17
  18 import org.eclipse.core.resources.IFile;
  19 import org.eclipse.core.resources.IMarker;
  20 import org.eclipse.core.runtime.CoreException;
  21 import org.eclipse.core.runtime.IProgressMonitor;
  22 import org.eclipse.core.runtime.InvalidRegistryObjectException;
  23 import org.eclipse.linuxtools.internal.tmf.ui.project.handlers.Messages;
  24 import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
  25 import org.eclipse.linuxtools.tmf.core.event.TmfEvent;
  26 import org.eclipse.linuxtools.tmf.core.experiment.TmfExperiment;
  27 import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentSelectedSignal;
  28 import org.eclipse.linuxtools.tmf.core.signal.TmfSignalManager;
  29 import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
  30 import org.eclipse.linuxtools.tmf.core.trace.TmfTrace;
  31 import org.eclipse.linuxtools.tmf.ui.project.model.ITmfProjectModelElement;
  32 import org.eclipse.linuxtools.tmf.ui.project.model.TmfExperimentElement;
  33 import org.eclipse.linuxtools.tmf.ui.project.model.TmfNavigatorContentProvider;
  34 import org.eclipse.linuxtools.tmf.ui.project.model.TmfProjectElement;
  35 import org.eclipse.linuxtools.tmf.ui.project.model.TmfProjectRegistry;
  36 import org.eclipse.linuxtools.tmf.ui.project.model.TmfTraceElement;
  37 import org.eclipse.linuxtools.tmf.ui.views.events.TmfEventsView;
  38 import org.eclipse.swt.widgets.Composite;
  39 import org.eclipse.swt.widgets.Display;
  40 import org.eclipse.ui.IEditorInput;
  41 import org.eclipse.ui.IEditorSite;
  42 import org.eclipse.ui.IFileEditorInput;
  43 import org.eclipse.ui.IViewPart;
  44 import org.eclipse.ui.IWorkbenchPage;
  45 import org.eclipse.ui.PartInitException;
  46 import org.eclipse.ui.ide.IGotoMarker;
  47 import org.eclipse.ui.part.EditorPart;
  48
  49 /**
  50  *
  51  * This editor is used to open a trace in the Events view
  52  * and set the trace as the current experiment.
  53  * It intercepts the IGotoMarker adapter and dispatches
  54  * the handling to the Events view' events table.
  55  * The editor then closes itself and hides the
  56  * editor area if no other editor is open.
  57  *
  58  */
  59 public class EventsViewEditor extends TmfEditor {
  60
  61     /**
  62      * The editor ID
  63      */
  64     public static final String ID = "org.eclipse.linuxtools.tmf.ui.editors.eventsView"; //$NON-NLS-1$
  65
  66     private IFile fFile;
  67     @SuppressWarnings("rawtypes")
  68     private ITmfTrace fTrace;
  69     private IMarker fGotoMarker;
  70     private boolean fEditorAreaVisible;
  71
  72     /*
  73      * (non-Javadoc)
  74      * @see org.eclipse.ui.part.EditorPart#doSave(org.eclipse.core.runtime.IProgressMonitor)
  75      */
  76     @Override
  77     public void doSave(final IProgressMonitor monitor) {
  78     }
  79
  80     @Override
  81     public void doSaveAs() {
  82     }
  83
  84     /*
  85      * (non-Javadoc)
  86      * @see org.eclipse.ui.part.EditorPart#init(org.eclipse.ui.IEditorSite, org.eclipse.ui.IEditorInput)
  87      */
  88     @SuppressWarnings({ "unchecked", "rawtypes" })
  89     @Override
  90     public void init(final IEditorSite site, IEditorInput input) throws PartInitException {
  91         fEditorAreaVisible = site.getPage().isEditorAreaVisible();
  92         if (input instanceof TmfEditorInput) {
  93             fFile = ((TmfEditorInput) input).getFile();
  94             fTrace = ((TmfEditorInput) input).getTrace();
  95         } else if (input instanceof IFileEditorInput) {
  96             fFile = ((IFileEditorInput) input).getFile();
  97             if (fFile == null)
  98                 throw new PartInitException("Invalid IFileEditorInput: " + input); //$NON-NLS-1$
  99             final TmfExperiment currentExperiment = TmfExperiment.getCurrentExperiment();
 100             if ((currentExperiment != null) && fFile.equals(currentExperiment.getBookmarksFile())) {
 101                 fTrace = currentExperiment;
 102                 super.setSite(site);
 103                 super.setInput(input);
 104                 return;
 105             }
 106             try {
 107                 final String traceTypeId = fFile.getPersistentProperty(TmfTraceElement.TRACETYPE);
 108                 if (traceTypeId == null)
 109                     throw new PartInitException(Messages.OpenTraceHandler_NoTraceType);
 110                 if (traceTypeId.equals(TmfExperiment.class.getCanonicalName())) {
 111                     // Special case: experiment bookmark resource
 112                     final TmfNavigatorContentProvider ncp = new TmfNavigatorContentProvider();
 113                     ncp.getChildren(fFile.getProject()); // force the model to be populated
 114                     final TmfProjectElement project = TmfProjectRegistry.getProject(fFile.getProject());
 115                     if (project == null)
 116                         throw new PartInitException(Messages.OpenExperimentHandler_NoTraceType);
 117                     for (final ITmfProjectModelElement projectElement : project.getExperimentsFolder().getChildren()) {
 118                         final String traceName = fFile.getParent().getName();
 119                         if (projectElement.getName().equals(traceName)) {
 120                             final TmfExperimentElement experimentElement = (TmfExperimentElement) projectElement;
 121                             // Instantiate the experiment's traces
 122                             final List<TmfTraceElement> traceEntries = experimentElement.getTraces();
 123                             final int nbTraces = traceEntries.size();
 124                             int cacheSize = Integer.MAX_VALUE;
 125                             final ITmfTrace<?>[] traces = new ITmfTrace[nbTraces];
 126                             for (int i = 0; i < nbTraces; i++) {
 127                                 final TmfTraceElement traceElement = traceEntries.get(i);
 128                                 final ITmfTrace trace = traceElement.instantiateTrace();
 129                                 final ITmfEvent traceEvent = traceElement.instantiateEvent();
 130                                 if ((trace == null) || (traceEvent == null)) {
 131                                     for (int j = 0; j < i; j++)
 132                                         traces[j].dispose();
 133                                     throw new PartInitException(Messages.OpenExperimentHandler_NoTraceType);
 134                                 }
 135                                 try {
 136                                     trace.initTrace(traceElement.getResource(), traceElement.getLocation().getPath(), traceEvent.getClass());
 137                                 } catch (final FileNotFoundException e) {
 138                                 }
 139                                 cacheSize = Math.min(cacheSize, trace.getCacheSize());
 140                                 traces[i] = trace;
 141                             }
 142                             final TmfExperiment experiment = new TmfExperiment(TmfEvent.class, experimentElement.getName(), traces, cacheSize);
 143                             experiment.setBookmarksFile(fFile);
 144                             fTrace = experiment;
 145                             TmfExperiment.setCurrentExperiment(experiment);
 146                             TmfSignalManager.dispatchSignal(new TmfExperimentSelectedSignal(this, experiment));
 147                             break;
 148                         }
 149                     }
 150                 } else if (traceTypeId.equals(TmfTrace.class.getCanonicalName())) {
 151                     // Special case: trace bookmark resource
 152                     final TmfNavigatorContentProvider ncp = new TmfNavigatorContentProvider();
 153                     ncp.getChildren(fFile.getProject()); // force the model to be populated
 154                     final TmfProjectElement project = TmfProjectRegistry.getProject(fFile.getProject());
 155                     for (final ITmfProjectModelElement projectElement : project.getTracesFolder().getChildren()) {
 156                         final String traceName = fFile.getParent().getName();
 157                         if (projectElement.getName().equals(traceName)) {
 158                             final TmfTraceElement traceElement = (TmfTraceElement) projectElement;
 159                             // Instantiate the experiment trace
 160                             final ITmfTrace trace = traceElement.instantiateTrace();
 161                             final ITmfEvent traceEvent = traceElement.instantiateEvent();
 162                             if ((trace == null) || (traceEvent == null))
 163                                 throw new PartInitException(Messages.OpenTraceHandler_NoTraceType);
 164                             try {
 165                                 trace.initTrace(traceElement.getResource(), traceElement.getLocation().getPath(), traceEvent.getClass());
 166                             } catch (final FileNotFoundException e) {
 167                             }
 168                             final ITmfTrace[] traces = new ITmfTrace[] { trace };
 169                             final TmfExperiment experiment = new TmfExperiment(traceEvent.getClass(), traceElement.getName(), traces, trace.getCacheSize());
 170                             experiment.setBookmarksFile(fFile);
 171                             fTrace = experiment;
 172                             TmfExperiment.setCurrentExperiment(experiment);
 173                             TmfSignalManager.dispatchSignal(new TmfExperimentSelectedSignal(this, experiment));
 174                             break;
 175                         }
 176                     }
 177                 } else {
 178                     final TmfNavigatorContentProvider ncp = new TmfNavigatorContentProvider();
 179                     ncp.getChildren(fFile.getProject()); // force the model to be populated
 180                     final TmfProjectElement project = TmfProjectRegistry.getProject(fFile.getProject());
 181                     for (final ITmfProjectModelElement projectElement : project.getTracesFolder().getChildren())
 182                         if (projectElement.getResource().equals(fFile)) {
 183                             final TmfTraceElement traceElement = (TmfTraceElement) projectElement;
 184                             // Instantiate the experiment trace
 185                             final ITmfTrace trace = traceElement.instantiateTrace();
 186                             final ITmfEvent traceEvent = traceElement.instantiateEvent();
 187                             if ((trace == null) || (traceEvent == null))
 188                                 throw new PartInitException(Messages.OpenTraceHandler_NoTraceType);
 189                             try {
 190                                 trace.initTrace(traceElement.getResource(), traceElement.getLocation().getPath(), traceEvent.getClass());
 191                             } catch (final FileNotFoundException e) {
 192                             }
 193                             final ITmfTrace[] traces = new ITmfTrace[] { trace };
 194                             final TmfExperiment experiment = new TmfExperiment(traceEvent.getClass(), traceElement.getName(), traces, trace.getCacheSize());
 195                             experiment.setBookmarksFile(fFile);
 196                             fTrace = experiment;
 197                             TmfExperiment.setCurrentExperiment(experiment);
 198                             TmfSignalManager.dispatchSignal(new TmfExperimentSelectedSignal(this, experiment));
 199                             break;
 200                         }
 201                 }
 202             } catch (final InvalidRegistryObjectException e) {
 203                 e.printStackTrace();
 204             } catch (final PartInitException e) {
 205                 throw e;
 206             } catch (final CoreException e) {
 207                 e.printStackTrace();
 208             }
 209             input = new TmfEditorInput(fFile, fTrace);
 210         } else
 211             throw new PartInitException("Invalid IEditorInput: " + input.getClass()); //$NON-NLS-1$
 212         if (fTrace == null)
 213             throw new PartInitException("Invalid IEditorInput: " + fFile.getName()); //$NON-NLS-1$
 214         super.setSite(site);
 215         super.setInput(input);
 216     }
 217
 218     /*
 219      * (non-Javadoc)
 220      * @see org.eclipse.ui.part.EditorPart#isDirty()
 221      */
 222     @Override
 223     public boolean isDirty() {
 224         return false;
 225     }
 226
 227     /*
 228      * (non-Javadoc)
 229      * @see org.eclipse.ui.part.EditorPart#isSaveAsAllowed()
 230      */
 231     @Override
 232     public boolean isSaveAsAllowed() {
 233         return false;
 234     }
 235
 236     /*
 237      * (non-Javadoc)
 238      * @see org.eclipse.ui.part.WorkbenchPart#createPartControl(org.eclipse.swt.widgets.Composite)
 239      */
 240     @Override
 241     public void createPartControl(final Composite parent) {
 242         setPartName(getEditorInput().getName());
 243     }
 244
 245     /*
 246      * (non-Javadoc)
 247      * @see org.eclipse.ui.part.WorkbenchPart#setFocus()
 248      */
 249     @Override
 250     public void setFocus() {
 251         Display.getDefault().asyncExec(new Runnable() {
 252             @Override
 253             public void run() {
 254                 final EditorPart editorPart = EventsViewEditor.this;
 255                 final IWorkbenchPage page = editorPart.getEditorSite().getPage();
 256                 page.closeEditor(editorPart, false);
 257                 if (page.getEditorReferences().length == 0)
 258                     page.setEditorAreaVisible(fEditorAreaVisible);
 259                 try {
 260                     final IViewPart viewPart = page.showView(TmfEventsView.ID);
 261                     if (fGotoMarker != null) {
 262                         final IGotoMarker adapter = (IGotoMarker) viewPart.getAdapter(IGotoMarker.class);
 263                         if (adapter != null)
 264                             adapter.gotoMarker(fGotoMarker);
 265                     }
 266                 } catch (final PartInitException e) {
 267                     e.printStackTrace();
 268                 }
 269             }
 270         });
 271     }
 272
 273     /* (non-Javadoc)
 274      * @see org.eclipse.ui.part.WorkbenchPart#getAdapter(java.lang.Class)
 275      */
 276     @SuppressWarnings("rawtypes")
 277     @Override
 278     public Object getAdapter(final Class adapter) {
 279         if (IGotoMarker.class.equals(adapter))
 280             return new IGotoMarker() {
 281             @Override
 282             public void gotoMarker(final IMarker marker) {
 283                 fGotoMarker = marker;
 284             }
 285         };
 286         return super.getAdapter(adapter);
 287     }
 288
 289 }