[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / editors / TmfEventsEditor.java

/*******************************************************************************\r
 * Copyright (c) 2010 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Patrick Tasse - Initial API and implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.editors;\r
\r
import java.io.FileNotFoundException;\r
import java.lang.reflect.Constructor;\r
import java.lang.reflect.InvocationTargetException;\r
import java.util.List;\r
\r
import org.eclipse.core.resources.IFile;\r
import org.eclipse.core.resources.IMarker;\r
import org.eclipse.core.resources.IMarkerDelta;\r
import org.eclipse.core.resources.IResource;\r
import org.eclipse.core.resources.IResourceChangeEvent;\r
import org.eclipse.core.resources.IResourceChangeListener;\r
import org.eclipse.core.resources.IResourceDelta;\r
import org.eclipse.core.resources.ResourcesPlugin;\r
import org.eclipse.core.runtime.CoreException;\r
import org.eclipse.core.runtime.IConfigurationElement;\r
import org.eclipse.core.runtime.IProgressMonitor;\r
import org.eclipse.core.runtime.InvalidRegistryObjectException;\r
import org.eclipse.core.runtime.Platform;\r
import org.eclipse.linuxtools.internal.tmf.ui.parsers.custom.CustomEventsTable;\r
import org.eclipse.linuxtools.internal.tmf.ui.parsers.custom.CustomTxtTrace;\r
import org.eclipse.linuxtools.internal.tmf.ui.parsers.custom.CustomXmlTrace;\r
import org.eclipse.linuxtools.internal.tmf.ui.project.handlers.Messages;\r
import org.eclipse.linuxtools.tmf.core.event.TmfEvent;\r
import org.eclipse.linuxtools.tmf.core.experiment.TmfExperiment;\r
import org.eclipse.linuxtools.tmf.core.signal.TmfSignalHandler;\r
import org.eclipse.linuxtools.tmf.core.signal.TmfTraceSelectedSignal;\r
import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;\r
import org.eclipse.linuxtools.tmf.core.trace.TmfTrace;\r
import org.eclipse.linuxtools.tmf.ui.project.model.ITmfProjectModelElement;\r
import org.eclipse.linuxtools.tmf.ui.project.model.TmfExperimentElement;\r
import org.eclipse.linuxtools.tmf.ui.project.model.TmfNavigatorContentProvider;\r
import org.eclipse.linuxtools.tmf.ui.project.model.TmfProjectElement;\r
import org.eclipse.linuxtools.tmf.ui.project.model.TmfProjectRegistry;\r
import org.eclipse.linuxtools.tmf.ui.project.model.TmfTraceElement;\r
import org.eclipse.linuxtools.tmf.ui.project.model.TmfTraceType;\r
import org.eclipse.linuxtools.tmf.ui.signal.TmfTraceClosedSignal;\r
import org.eclipse.linuxtools.tmf.ui.signal.TmfTraceOpenedSignal;\r
import org.eclipse.linuxtools.tmf.ui.signal.TmfTraceParserUpdatedSignal;\r
import org.eclipse.linuxtools.tmf.ui.viewers.events.TmfEventsTable;\r
import org.eclipse.swt.widgets.Composite;\r
import org.eclipse.swt.widgets.Display;\r
import org.eclipse.ui.IEditorInput;\r
import org.eclipse.ui.IEditorPart;\r
import org.eclipse.ui.IEditorSite;\r
import org.eclipse.ui.IFileEditorInput;\r
import org.eclipse.ui.IPropertyListener;\r
import org.eclipse.ui.IReusableEditor;\r
import org.eclipse.ui.PartInitException;\r
import org.eclipse.ui.ide.IGotoMarker;\r
import org.eclipse.ui.part.FileEditorInput;\r
import org.osgi.framework.Bundle;\r
\r
/**\r
 * <b><u>TmfEventsEditor</u></b>\r
 */\r
public class TmfEventsEditor extends TmfEditor implements ITmfTraceEditor, IReusableEditor, IPropertyListener, IResourceChangeListener {\r
\r
    public static final String ID = "org.eclipse.linuxtools.tmf.ui.editors.events"; //$NON-NLS-1$\r
    \r
    private TmfEventsTable fEventsTable;\r
    private IFile fFile;\r
    @SuppressWarnings("rawtypes")\r
    private ITmfTrace fTrace;\r
    private Composite fParent;\r
\r
    @Override\r
    public void doSave(IProgressMonitor monitor) {\r
    }\r
\r
    @Override\r
    public void doSaveAs() {\r
    }\r
\r
    @SuppressWarnings({ "unchecked", "rawtypes" })\r
    @Override\r
    public void init(IEditorSite site, IEditorInput input) throws PartInitException {\r
        if (input instanceof TmfEditorInput) {\r
            fFile = ((TmfEditorInput) input).getFile();\r
            fTrace = ((TmfEditorInput) input).getTrace();\r
            input = new FileEditorInput(fFile);\r
        } else if (input instanceof IFileEditorInput) {\r
            fFile = ((IFileEditorInput) input).getFile();\r
            if (fFile == null) {\r
                throw new PartInitException("Invalid IFileEditorInput: " + input); //$NON-NLS-1$\r
            }\r
            try {\r
                String traceTypeId = fFile.getPersistentProperty(TmfTraceElement.TRACETYPE);\r
                if (traceTypeId == null) {\r
                    throw new PartInitException(Messages.OpenTraceHandler_NoTraceType);\r
                }\r
                if (traceTypeId.equals(TmfExperiment.class.getCanonicalName())) {\r
                    // Special case: experiment bookmark resource\r
                    TmfNavigatorContentProvider ncp = new TmfNavigatorContentProvider();\r
                    ncp.getChildren(fFile.getProject()); // force the model to be populated\r
                    TmfProjectElement project = TmfProjectRegistry.getProject(fFile.getProject());\r
                    if (project == null) {\r
                        throw new PartInitException(Messages.OpenExperimentHandler_NoTraceType);\r
                    }\r
                    for (ITmfProjectModelElement projectElement : project.getExperimentsFolder().getChildren()) {\r
                        String traceName = fFile.getParent().getName();\r
                        if (projectElement.getName().equals(traceName)) {\r
                            TmfExperimentElement experimentElement = (TmfExperimentElement) projectElement;\r
                            // Instantiate the experiment's traces\r
                            List<TmfTraceElement> traceEntries = experimentElement.getTraces();\r
                            int nbTraces = traceEntries.size();\r
                            int cacheSize = Integer.MAX_VALUE;\r
                            ITmfTrace<?>[] traces = new ITmfTrace[nbTraces];\r
                            for (int i = 0; i < nbTraces; i++) {\r
                                TmfTraceElement traceElement = traceEntries.get(i);\r
                                ITmfTrace trace = traceElement.instantiateTrace();\r
                                TmfEvent traceEvent = traceElement.instantiateEvent();\r
                                if (trace == null || traceEvent == null) {\r
                                    for (int j = 0; j < i; j++) {\r
                                        traces[j].dispose();\r
                                    }\r
                                    throw new PartInitException(Messages.OpenExperimentHandler_NoTraceType);\r
                                }\r
                                try {\r
                                    trace.initTrace(traceElement.getName(), traceElement.getLocation().getPath(), traceEvent.getClass(), 0);\r
                                } catch (FileNotFoundException e) {\r
                                }\r
                                trace.setResource(traceElement.getResource());\r
                                cacheSize = Math.min(cacheSize, trace.getCacheSize());\r
                                traces[i] = trace;\r
                            }\r
                            TmfExperiment experiment = new TmfExperiment(TmfEvent.class, experimentElement.getName(), traces, cacheSize);\r
                            experiment.setBookmarksFile(fFile);\r
                            fTrace = experiment;\r
                            experiment.initTrace(null, null, null, 0);\r
                            experiment.indexTrace(true);\r
                            break;\r
                        }\r
                    }\r
                } else if (traceTypeId.equals(TmfTrace.class.getCanonicalName())) {\r
                    // Special case: trace bookmark resource\r
                    TmfNavigatorContentProvider ncp = new TmfNavigatorContentProvider();\r
                    ncp.getChildren(fFile.getProject()); // force the model to be populated\r
                    TmfProjectElement project = TmfProjectRegistry.getProject(fFile.getProject());\r
                    for (ITmfProjectModelElement projectElement : project.getTracesFolder().getChildren()) {\r
                        String traceName = fFile.getParent().getName();\r
                        if (projectElement.getName().equals(traceName)) {\r
                            TmfTraceElement traceElement = (TmfTraceElement) projectElement;\r
                            // Instantiate the trace\r
                            ITmfTrace trace = traceElement.instantiateTrace();\r
                            TmfEvent traceEvent = traceElement.instantiateEvent();\r
                            if (trace == null || traceEvent == null) {\r
                                throw new PartInitException(Messages.OpenTraceHandler_NoTraceType);\r
                            }\r
                            try {\r
                                trace.initTrace(traceElement.getName(), traceElement.getLocation().getPath(), traceEvent.getClass(), 0);\r
                                trace.indexTrace(false);\r
                            } catch (FileNotFoundException e) {\r
                            }\r
                            trace.setResource(traceElement.getResource());\r
                            fTrace = trace;\r
                            break;\r
                        }\r
                    }\r
                } else {\r
                    TmfNavigatorContentProvider ncp = new TmfNavigatorContentProvider();\r
                    ncp.getChildren(fFile.getProject()); // force the model to be populated\r
                    TmfProjectElement project = TmfProjectRegistry.getProject(fFile.getProject());\r
                    for (ITmfProjectModelElement projectElement : project.getTracesFolder().getChildren()) {\r
                        if (projectElement.getResource().equals(fFile)) {\r
                            TmfTraceElement traceElement = (TmfTraceElement) projectElement;\r
                            // Instantiate the trace\r
                            ITmfTrace trace = traceElement.instantiateTrace();\r
                            TmfEvent traceEvent = traceElement.instantiateEvent();\r
                            if (trace == null || traceEvent == null) {\r
                                throw new PartInitException(Messages.OpenTraceHandler_NoTraceType);\r
                            }\r
                            try {\r
                                trace.initTrace(traceElement.getName(), traceElement.getLocation().getPath(), traceEvent.getClass(), 0);\r
                                trace.indexTrace(false);\r
                            } catch (FileNotFoundException e) {\r
                            }\r
                            if (trace instanceof TmfTrace) {\r
                                ((TmfTrace) trace).setResource(traceElement.getResource());\r
                            }\r
                            fTrace = trace;\r
                            break;\r
                        }\r
                    }\r
                }\r
            } catch (InvalidRegistryObjectException e) {\r
                e.printStackTrace();\r
            } catch (PartInitException e) {\r
                throw e;\r
            } catch (CoreException e) {\r
                e.printStackTrace();\r
            }\r
        } else {\r
            throw new PartInitException("Invalid IEditorInput: " + input.getClass()); //$NON-NLS-1$\r
        }\r
        if (fTrace == null) {\r
            throw new PartInitException("Invalid IEditorInput: " + fFile.getName()); //$NON-NLS-1$\r
        }\r
        super.setSite(site);\r
        super.setInput(input);\r
    }\r
\r
    @Override\r
    public boolean isDirty() {\r
        return false;\r
    }\r
\r
    @Override\r
    public boolean isSaveAsAllowed() {\r
        return false;\r
    }\r
\r
    @Override\r
    public void setInput(IEditorInput input) {\r
        super.setInput(input);\r
        firePropertyChange(IEditorPart.PROP_INPUT);\r
    }\r
\r
    @Override\r
	public void propertyChanged(Object source, int propId) {\r
        if (propId == IEditorPart.PROP_INPUT) {\r
            broadcast(new TmfTraceClosedSignal(this, fTrace));\r
            fFile = ((TmfEditorInput) getEditorInput()).getFile();\r
            fTrace = ((TmfEditorInput) getEditorInput()).getTrace();\r
            super.setInput(new FileEditorInput(fFile));\r
            fEventsTable.dispose();\r
            if (fTrace != null) {\r
                fEventsTable = createEventsTable(fParent, fTrace.getCacheSize());\r
                fEventsTable.setTrace(fTrace, true);\r
                fEventsTable.refreshBookmarks(fFile);\r
                broadcast(new TmfTraceOpenedSignal(this, fTrace, fFile, fEventsTable));\r
            } else {\r
                fEventsTable = new TmfEventsTable(fParent, 0);\r
            }\r
            fParent.layout();\r
        }\r
    }\r
\r
    @Override\r
    public void createPartControl(Composite parent) {\r
        fParent = parent;\r
        if (fTrace != null) {\r
            setPartName(fTrace.getName());\r
            fEventsTable = createEventsTable(parent, fTrace.getCacheSize());\r
            fEventsTable.setTrace(fTrace, true);\r
            fEventsTable.refreshBookmarks(fFile);\r
            broadcast(new TmfTraceOpenedSignal(this, fTrace, fFile, fEventsTable));\r
        } else {\r
            setPartName(getEditorInput().getName());\r
            fEventsTable = new TmfEventsTable(parent, 0);\r
        }\r
        addPropertyListener(this);\r
        ResourcesPlugin.getWorkspace().addResourceChangeListener(this, IResourceChangeEvent.POST_CHANGE);\r
    }\r
\r
    @Override\r
    public void dispose() {\r
    	ResourcesPlugin.getWorkspace().removeResourceChangeListener(this);\r
    	removePropertyListener(this);\r
        if (fTrace != null) {\r
            broadcast(new TmfTraceClosedSignal(this, fTrace));\r
        }\r
        if (fEventsTable != null) {\r
            fEventsTable.dispose();\r
        }\r
        super.dispose();\r
    }\r
\r
    protected TmfEventsTable createEventsTable(Composite parent, int cacheSize) {\r
        TmfEventsTable eventsTable = getEventsTable(parent, cacheSize);\r
        if (eventsTable == null) {\r
            eventsTable = new TmfEventsTable(parent, cacheSize);\r
        }\r
        return eventsTable;\r
    }\r
    \r
    private TmfEventsTable getEventsTable(Composite parent, int cacheSize) {\r
        if (fTrace instanceof TmfExperiment) {\r
            return getExperimentEventsTable((TmfExperiment<?>) fTrace, parent, cacheSize);\r
        }\r
        TmfEventsTable eventsTable = null;\r
        try {\r
            if (fTrace.getResource() == null) {\r
                return null;\r
            }\r
            String traceType = fTrace.getResource().getPersistentProperty(TmfTraceElement.TRACETYPE);\r
            if (traceType == null) {\r
                return null;\r
            }\r
            if (traceType.startsWith(CustomTxtTrace.class.getCanonicalName())) {\r
                return new CustomEventsTable(((CustomTxtTrace) fTrace).getDefinition(), parent, cacheSize);\r
            }\r
            if (traceType.startsWith(CustomXmlTrace.class.getCanonicalName())) {\r
                return new CustomEventsTable(((CustomXmlTrace) fTrace).getDefinition(), parent, cacheSize);\r
            }\r
            for (IConfigurationElement ce : TmfTraceType.getTypeElements()) {\r
                if (ce.getAttribute(TmfTraceType.ID_ATTR).equals(traceType)) {\r
                    IConfigurationElement[] eventsTableTypeCE = ce.getChildren(TmfTraceType.EVENTS_TABLE_TYPE_ELEM);\r
                    if (eventsTableTypeCE.length != 1) {\r
                        break;\r
                    }\r
                    String eventsTableType = eventsTableTypeCE[0].getAttribute(TmfTraceType.CLASS_ATTR);\r
                    if (eventsTableType == null || eventsTableType.length() == 0) {\r
                        break;\r
                    }\r
                    Bundle bundle = Platform.getBundle(ce.getContributor().getName());\r
                    Class<?> c = bundle.loadClass(eventsTableType);\r
                    Class<?>[] constructorArgs = new Class[] { Composite.class, int.class };\r
                    Constructor<?> constructor = c.getConstructor(constructorArgs);\r
                    Object[] args = new Object[] { parent, cacheSize };\r
                    eventsTable = (TmfEventsTable) constructor.newInstance(args);\r
                    break;\r
                }\r
            }\r
        } catch (InvalidRegistryObjectException e) {\r
            e.printStackTrace();\r
        } catch (CoreException e) {\r
            e.printStackTrace();\r
        } catch (ClassNotFoundException e) {\r
            e.printStackTrace();\r
        } catch (SecurityException e) {\r
            e.printStackTrace();\r
        } catch (NoSuchMethodException e) {\r
            e.printStackTrace();\r
        } catch (IllegalArgumentException e) {\r
            e.printStackTrace();\r
        } catch (InstantiationException e) {\r
            e.printStackTrace();\r
        } catch (IllegalAccessException e) {\r
            e.printStackTrace();\r
        } catch (InvocationTargetException e) {\r
            e.printStackTrace();\r
        }\r
        return eventsTable;\r
    }\r
\r
    /**\r
     * Get the events table for an experiment.\r
     * If all traces in the experiment are of the same type,\r
     * use the extension point specified event table\r
     * @param experiment the experiment\r
     * @param parent the parent Composite\r
     * @param cacheSize the event table cache size\r
     * @return an events table of the appropriate type\r
     */\r
    private TmfEventsTable getExperimentEventsTable(TmfExperiment<?> experiment, Composite parent, int cacheSize) {\r
        TmfEventsTable eventsTable = null;\r
        String commonTraceType = null;\r
        try {\r
            for (ITmfTrace<?> trace : experiment.getTraces()) {\r
                IResource resource = trace.getResource();\r
                if (resource == null) {\r
                    return null;\r
                }\r
                String traceType = resource.getPersistentProperty(TmfTraceElement.TRACETYPE);\r
                if (commonTraceType != null && !commonTraceType.equals(traceType)) {\r
                    return null;\r
                }\r
                commonTraceType = traceType;\r
            }\r
            if (commonTraceType == null) {\r
                return null;\r
            }\r
            if (commonTraceType.startsWith(CustomTxtTrace.class.getCanonicalName())) {\r
                return new CustomEventsTable(((CustomTxtTrace) experiment.getTraces()[0]).getDefinition(), parent, cacheSize);\r
            }\r
            if (commonTraceType.startsWith(CustomXmlTrace.class.getCanonicalName())) {\r
                return new CustomEventsTable(((CustomXmlTrace) experiment.getTraces()[0]).getDefinition(), parent, cacheSize);\r
            }\r
            for (IConfigurationElement ce : TmfTraceType.getTypeElements()) {\r
                if (ce.getAttribute(TmfTraceType.ID_ATTR).equals(commonTraceType)) {\r
                    IConfigurationElement[] eventsTableTypeCE = ce.getChildren(TmfTraceType.EVENTS_TABLE_TYPE_ELEM);\r
                    if (eventsTableTypeCE.length != 1) {\r
                        break;\r
                    }\r
                    String eventsTableType = eventsTableTypeCE[0].getAttribute(TmfTraceType.CLASS_ATTR);\r
                    if (eventsTableType == null || eventsTableType.length() == 0) {\r
                        break;\r
                    }\r
                    Bundle bundle = Platform.getBundle(ce.getContributor().getName());\r
                    Class<?> c = bundle.loadClass(eventsTableType);\r
                    Class<?>[] constructorArgs = new Class[] { Composite.class, int.class };\r
                    Constructor<?> constructor = c.getConstructor(constructorArgs);\r
                    Object[] args = new Object[] { parent, cacheSize };\r
                    eventsTable = (TmfEventsTable) constructor.newInstance(args);\r
                    break;\r
                }\r
            }\r
        } catch (CoreException e) {\r
            e.printStackTrace();\r
        } catch (InvalidRegistryObjectException e) {\r
            e.printStackTrace();\r
        } catch (SecurityException e) {\r
            e.printStackTrace();\r
        } catch (IllegalArgumentException e) {\r
            e.printStackTrace();\r
        } catch (ClassNotFoundException e) {\r
            e.printStackTrace();\r
        } catch (NoSuchMethodException e) {\r
            e.printStackTrace();\r
        } catch (InstantiationException e) {\r
            e.printStackTrace();\r
        } catch (IllegalAccessException e) {\r
            e.printStackTrace();\r
        } catch (InvocationTargetException e) {\r
            e.printStackTrace();\r
        }\r
        return eventsTable;\r
    }\r
\r
    @Override\r
	public ITmfTrace<?> getTrace() {\r
        return fTrace;\r
    }\r
\r
    @Override\r
    public IFile getBookmarksFile() {\r
    	return fFile;\r
    }\r
\r
    @Override\r
    public void setFocus() {\r
        fEventsTable.setFocus();\r
        if (fTrace != null) {\r
            broadcast(new TmfTraceSelectedSignal(this, fTrace));\r
        }\r
    }\r
\r
    @Override\r
    @SuppressWarnings("rawtypes")\r
    public Object getAdapter(Class adapter) {\r
    	if (IGotoMarker.class.equals(adapter)) {\r
    		return fEventsTable;\r
    	}\r
    	return super.getAdapter(adapter);\r
    }\r
\r
    @Override\r
    public void resourceChanged(IResourceChangeEvent event) {\r
        for (IMarkerDelta delta : event.findMarkerDeltas(IMarker.BOOKMARK, false)) {\r
            if (delta.getResource().equals(fFile)) {\r
                if (delta.getKind() == IResourceDelta.REMOVED) {\r
                    final IMarker bookmark = delta.getMarker();\r
                    Display.getDefault().asyncExec(new Runnable() {\r
                        @Override\r
                        public void run() {\r
                            fEventsTable.removeBookmark(bookmark);\r
                        }\r
                    });\r
                } else if (delta.getKind() == IResourceDelta.CHANGED) {\r
                    Display.getDefault().asyncExec(new Runnable() {\r
                        @Override\r
                        public void run() {\r
                            fEventsTable.getTable().refresh();\r
                        }\r
                    });\r
                }\r
            }\r
        }\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Global commands\r
    // ------------------------------------------------------------------------\r
\r
    public void addBookmark() {\r
    	fEventsTable.addBookmark(fFile);\r
    }\r
    \r
\r
    // ------------------------------------------------------------------------\r
    // Signal handlers\r
    // ------------------------------------------------------------------------\r
    \r
    @SuppressWarnings("unchecked")\r
    @TmfSignalHandler\r
    public void traceParserUpdated(TmfTraceParserUpdatedSignal signal) {\r
        if (signal.getTraceResource().equals(fFile)) {\r
            broadcast(new TmfTraceClosedSignal(this, fTrace));\r
            try {\r
                String name = fTrace.getName();\r
                fTrace = null;\r
                String traceTypeId = fFile.getPersistentProperty(TmfTraceElement.TRACETYPE);\r
                if (traceTypeId != null) {\r
                    for (IConfigurationElement ce : TmfTraceType.getTypeElements()) {\r
                        if (traceTypeId.equals(ce.getAttribute(TmfTraceType.ID_ATTR))) {\r
                            fTrace = (ITmfTrace<?>) ce.createExecutableExtension(TmfTraceType.TRACE_TYPE_ATTR);\r
                            TmfEvent event = (TmfEvent) ce.createExecutableExtension(TmfTraceType.EVENT_TYPE_ATTR);\r
                            String path = fFile.getLocationURI().getPath();\r
                            fTrace.initTrace(name, path, event.getClass(), 0);\r
                            fTrace.indexTrace(false);\r
                            break;\r
                        }\r
                    }\r
                }\r
            } catch (InvalidRegistryObjectException e) {\r
                e.printStackTrace();\r
            } catch (FileNotFoundException e) {\r
                e.printStackTrace();\r
            } catch (CoreException e) {\r
                e.printStackTrace();\r
            }\r
            fEventsTable.dispose();\r
            if (fTrace != null) {\r
                fEventsTable = createEventsTable(fParent, fTrace.getCacheSize());\r
                fEventsTable.setTrace(fTrace, true);\r
                broadcast(new TmfTraceOpenedSignal(this, fTrace, fFile, fEventsTable));\r
            } else {\r
                fEventsTable = new TmfEventsTable(fParent, 0);\r
            }\r
            fParent.layout();\r
        }\r
    }\r
\r
    @TmfSignalHandler\r
    public void traceSelected(TmfTraceSelectedSignal signal) {\r
        if (signal.getSource() != this && signal.getTrace().equals(fTrace)) {\r
            getSite().getPage().bringToTop(this);\r
        }\r
    }\r
\r
}\r