tmf: Use tabs in statistics view for each traces

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.ui / src / org / eclipse / linuxtools / internal / lttng / ui / views / latency / LatencyView.java

/*******************************************************************************\r
 * Copyright (c) 2010, 2011 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
 *   Philippe Sawicki (INF4990.A2010@gmail.com)   - Initial API and implementation\r
 *   Mathieu Denis    (mathieu.denis55@gmail.com) - Refactored code\r
 *   Bernd Hufmann - Adapted to new model-view-controller design\r
 *******************************************************************************/\r
package org.eclipse.linuxtools.internal.lttng.ui.views.latency;\r
\r
import org.eclipse.jface.action.Action;\r
import org.eclipse.jface.action.IMenuManager;\r
import org.eclipse.jface.action.IToolBarManager;\r
import org.eclipse.jface.action.Separator;\r
import org.eclipse.linuxtools.internal.lttng.core.event.LttngEvent;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.dialogs.AddDialog;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.dialogs.DeleteDialog;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.dialogs.ListDialog;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.model.Config;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.model.IGraphModelListener;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.model.LatencyController;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.model.LatencyGraphModel;\r
import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;\r
import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;\r
import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp;\r
import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest.ExecutionType;\r
import org.eclipse.linuxtools.tmf.core.request.TmfEventRequest;\r
import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentDisposedSignal;\r
import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentRangeUpdatedSignal;\r
import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentSelectedSignal;\r
import org.eclipse.linuxtools.tmf.core.signal.TmfRangeSynchSignal;\r
import org.eclipse.linuxtools.tmf.core.signal.TmfSignalHandler;\r
import org.eclipse.linuxtools.tmf.core.signal.TmfTimeSynchSignal;\r
import org.eclipse.linuxtools.tmf.core.trace.TmfExperiment;\r
import org.eclipse.linuxtools.tmf.ui.views.TmfView;\r
import org.eclipse.swt.SWT;\r
import org.eclipse.swt.events.ControlEvent;\r
import org.eclipse.swt.events.ControlListener;\r
import org.eclipse.swt.layout.FillLayout;\r
import org.eclipse.swt.widgets.Composite;\r
import org.eclipse.ui.IActionBars;\r
import org.eclipse.ui.plugin.AbstractUIPlugin;\r
\r
/**\r
 * <b><u>LatencyView</u></b>\r
 * <p>\r
 * TmfView displaying the latency views (i.e. the two latency charts).\r
 *\r
 * @author Philippe Sawicki\r
 */\r
public class LatencyView extends TmfView implements IGraphModelListener {\r
\r
    // ------------------------------------------------------------------------\r
    // Attributes\r
    // ------------------------------------------------------------------------\r
\r
    // The initial window span (in nanoseconds)\r
    public static final long INITIAL_WINDOW_SPAN = (1L * 100 * 1000 * 1000); // .1sec\r
\r
    /**\r
     * The view's unique ID.\r
     */\r
    public static final String ID = "org.eclipse.linuxtools.lttng.ui.views.latency.LatencyView"; //$NON-NLS-1$\r
\r
    /**\r
     * A reference to the currently selected experiment.\r
     */\r
    protected TmfExperiment fExperiment = null;\r
\r
    /**\r
     * Parent composite.\r
     */\r
    protected Composite fParent;\r
\r
    /**\r
     * Graph view.\r
     */\r
    protected GraphViewer fGraphViewer;\r
\r
    /**\r
     * Histogram view.\r
     */\r
    protected HistogramViewer fHistogramViewer;\r
\r
    /**\r
     * Action executed when the user wants to see the list of matching events.\r
     */\r
    protected Action fListMatchingEvents;\r
\r
    /**\r
     * Action executed when the user wants to add matching events.\r
     */\r
    protected Action fAddMatchingEvents;\r
\r
    /**\r
     * Action executed when the user wants to delete matching events.\r
     */\r
    protected Action fDeleteMatchingEvents;\r
\r
    /**\r
     * Action executed when the user wants to increase the width of the histogram bars.\r
     */\r
    protected Action fIncreaseBarWidth;\r
\r
    /**\r
     * Action executed when the user wants to decrease the width of the histogram bars.\r
     */\r
    protected Action fDecreaseBarWidth;\r
\r
    /**\r
     * The current histogram window time range.\r
     */\r
    protected TmfTimeRange fTimeRange = null;\r
\r
    /**\r
     * Controller of the latency model which is responsible to retrieve data from the trace\r
     */\r
    final private LatencyController fController;\r
\r
    /**\r
     * Flag to notify that TimeSyncSignal was received and is being processed.\r
     */\r
    private boolean fSyncSignalReceived = false;\r
\r
    // ------------------------------------------------------------------------\r
    // Constructor\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Constructor.\r
     */\r
    public LatencyView() {\r
        super(Messages.LatencyView_ViewName);\r
        fController = LatencyController.getInstance();\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Operations\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Create the UI controls of this view.\r
     *\r
     * @param parent\r
     *            The composite parent of this view.\r
     */\r
    @Override\r
    public void createPartControl(Composite parent) {\r
        // Save the parent\r
        fParent = parent;\r
\r
        makeActions();\r
        contributeToActionBars();\r
\r
        // Add a control listener to handle the view resize events (to redraw the canvas)\r
        fParent.addControlListener(new ControlListener() {\r
            @Override\r
            public void controlMoved(ControlEvent event) {\r
                fHistogramViewer.clearBackground();\r
                fGraphViewer.clearBackground();\r
                fController.handleCompleted();\r
            }\r
\r
            @Override\r
            public void controlResized(ControlEvent event) {\r
                fHistogramViewer.clearBackground();\r
                fGraphViewer.clearBackground();\r
                fController.handleCompleted();\r
            }\r
        });\r
\r
        // ///////////////////////////////////////////////////////////////////////////////////\r
        // Layout for the whole view, other elements will be in a child composite of this one\r
        // Contains :\r
        // Composite layoutSelectionWindow\r
        // Composite layoutTimesSpinner\r
        // Composite layoutExperimentHistogram\r
        // ///////////////////////////////////////////////////////////////////////////////////\r
        Composite layoutFullView = new Composite(fParent, SWT.FILL);\r
        FillLayout gridFullView = new FillLayout();\r
        gridFullView.marginHeight = 0;\r
        gridFullView.marginWidth = 0;\r
        layoutFullView.setLayout(gridFullView);\r
\r
        // Create the graph views\r
        fGraphViewer = new GraphViewer(layoutFullView, SWT.DOUBLE_BUFFERED);\r
        fGraphViewer.setDrawLabelEachNTicks(2);\r
        fGraphViewer.setGraphTitle(Messages.LatencyView_Graphs_Graph_Title);\r
        fGraphViewer.setXAxisLabel(Messages.LatencyView_Graphs_Graph_XAxisLabel, 40);\r
        fGraphViewer.setYAxisLabel(Messages.LatencyView_Graphs_Graph_YAxisLabel);\r
\r
        fHistogramViewer = new HistogramViewer(layoutFullView, SWT.DOUBLE_BUFFERED);\r
        fHistogramViewer.setDrawLabelEachNTicks(2);\r
        fHistogramViewer.setGraphTitle(Messages.LatencyView_Graphs_Histogram_Title);\r
        fHistogramViewer.setXAxisLabel(Messages.LatencyView_Graphs_Histogram_XAxisLabel, 55);\r
        fHistogramViewer.setYAxisLabel(Messages.LatencyView_Graphs_Histogram_YAxisLabel);\r
\r
        fController.registerModel(fGraphViewer.getModel());\r
        fController.registerModel(fHistogramViewer.getModel());\r
\r
        ((LatencyGraphModel)fGraphViewer.getModel()).addGraphModelListener(this);\r
\r
        TmfExperiment experiment = TmfExperiment.getCurrentExperiment();\r
        if (experiment != null) {\r
\r
            TmfTimeRange experimentTRange = experiment.getTimeRange();\r
\r
            if (!experimentTRange.equals(TmfTimeRange.NULL_RANGE)) {\r
                TmfExperimentSelectedSignal signal = new TmfExperimentSelectedSignal(this, experiment);\r
                experimentSelected(signal);\r
            }\r
        }\r
    }\r
\r
    /* (non-Javadoc)\r
     * @see org.eclipse.ui.part.WorkbenchPart#setFocus()\r
     */\r
    @Override\r
    public void setFocus() {\r
        fGraphViewer.setFocus();\r
    }\r
\r
    @SuppressWarnings("nls")\r
    @Override\r
    public String toString() {\r
        return "["+ Messages.LatencyView_ViewName+"]";\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Signal handlers\r
    // ------------------------------------------------------------------------\r
\r
    @TmfSignalHandler\r
    public void experimentSelected(TmfExperimentSelectedSignal signal) {\r
        // Clear the views\r
        fGraphViewer.clear();\r
        fHistogramViewer.clear();\r
\r
        if (fParent != null) {\r
            // Update the trace reference\r
            fExperiment = signal.getExperiment();\r
\r
            fTimeRange = TmfTimeRange.NULL_RANGE;\r
            TmfTimeRange experimentTRange = fExperiment.getTimeRange();\r
\r
            if (!experimentTRange.equals(TmfTimeRange.NULL_RANGE)) {\r
                fTimeRange = new TmfTimeRange(experimentTRange.getStartTime(),\r
                        new TmfTimestamp(experimentTRange.getStartTime().getValue() + INITIAL_WINDOW_SPAN, experimentTRange.getStartTime().getScale(), experimentTRange.getStartTime().getPrecision()));\r
                fController.refreshModels(fExperiment, fTimeRange);\r
            }\r
        }\r
    }\r
    @TmfSignalHandler\r
    public void experimentRangeUpdated(TmfExperimentRangeUpdatedSignal signal) {\r
        if (fTimeRange.equals(TmfTimeRange.NULL_RANGE) && signal.getExperiment().equals(fExperiment)) {\r
            TmfTimeRange experimentTRange = signal.getRange();\r
\r
            if (!experimentTRange.equals(TmfTimeRange.NULL_RANGE)) {\r
                fTimeRange = new TmfTimeRange(experimentTRange.getStartTime(),\r
                        new TmfTimestamp(experimentTRange.getStartTime().getValue() + INITIAL_WINDOW_SPAN, experimentTRange.getStartTime().getScale(), experimentTRange.getStartTime().getPrecision()));\r
                fController.refreshModels(fExperiment, fTimeRange);\r
            }\r
        }\r
    }\r
\r
    @TmfSignalHandler\r
    public void experimentDisposed(TmfExperimentDisposedSignal signal) {\r
        if (signal.getExperiment() != fExperiment) {\r
            return;\r
        }\r
        fTimeRange = TmfTimeRange.NULL_RANGE;\r
        fExperiment = null;\r
        fController.clear();\r
    }\r
\r
    /**\r
     * Called when the LatencyView is closed: disposes of the canvas and unregisters models from views.\r
     */\r
    @Override\r
    public void dispose() {\r
        fController.dispose();\r
        fController.deregisterModel(fGraphViewer.getModel());\r
        fController.deregisterModel(fHistogramViewer.getModel());\r
        ((LatencyGraphModel)fGraphViewer.getModel()).removeGraphModelListener(this);\r
\r
        fGraphViewer.dispose();\r
        fHistogramViewer.dispose();\r
\r
        super.dispose();\r
    }\r
\r
    /**\r
     * Method called when synchronization is active and that the user select an event.\r
     *\r
     * The models will be updated with the new current selected time.\r
     *\r
     * @param signal\r
     *            Signal received from the framework. Contain the event.\r
     */\r
    @TmfSignalHandler\r
    public void currentTimeUpdated(TmfTimeSynchSignal signal) {\r
        if (signal.getSource() != this) {\r
            fSyncSignalReceived = true;\r
            fController.setCurrentEventTime(signal.getCurrentTime().getValue());\r
            fSyncSignalReceived = false;\r
        }\r
    }\r
\r
    /**\r
     * Method called when synchronization is active and that the user changed the current time range.\r
\r
     * The models will be updated with the new time range.\r
     *\r
     * @param signal\r
     *            Signal received from the framework. Contain the new time range.\r
     */\r
    @TmfSignalHandler\r
    public void synchToTimeRange(TmfRangeSynchSignal signal) {\r
        if (signal.getSource() != this) {\r
            // Erase the graph views\r
            fGraphViewer.clear();\r
            fHistogramViewer.clear();\r
\r
            ITmfTimestamp startTime = signal.getCurrentRange().getStartTime();\r
            ITmfTimestamp endTime = signal.getCurrentRange().getEndTime();\r
            fTimeRange = new TmfTimeRange(startTime, endTime);\r
\r
            fController.refreshModels(fExperiment, fTimeRange);\r
        }\r
    }\r
\r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.linuxtools.lttng.ui.views.latency.model.IGraphModelListener#graphModelUpdated()\r
     */\r
    @Override\r
    public void graphModelUpdated() {\r
        // Nothing to do - update of viewers will be done in the viewers\r
    }\r
\r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.linuxtools.lttng.ui.views.latency.model.IGraphModelListener#currentEventUpdated(long)\r
     */\r
    @Override\r
    public void currentEventUpdated(final long currentEventTime) {\r
        if (fExperiment != null &&\r
                !fSyncSignalReceived && // Don't broadcast the current time that was received just before with a time sync signal\r
                currentEventTime != Config.INVALID_EVENT_TIME) {\r
\r
            // Queue update in the event request queue\r
            TmfTimeRange timeRange = new TmfTimeRange(new TmfTimestamp(currentEventTime, Config.TIME_SCALE), TmfTimestamp.BIG_CRUNCH);\r
            TmfEventRequest request = new TmfEventRequest(LttngEvent.class, timeRange, 0, 1, ExecutionType.FOREGROUND) {\r
                @Override\r
                public void handleCompleted() {\r
                    broadcast(new TmfTimeSynchSignal(this, new TmfTimestamp(currentEventTime, Config.TIME_SCALE)));\r
                }\r
            };\r
            fExperiment.sendRequest(request);\r
        }\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Helper functions\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Fills the local pull down menu.\r
     * @param manager\r
     *            The menu manager.\r
     */\r
    private void fillLocalPullDown(IMenuManager manager) {\r
        manager.add(new Separator());\r
        manager.add(fIncreaseBarWidth);\r
        manager.add(fDecreaseBarWidth);\r
        manager.add(new Separator());\r
        manager.add(fListMatchingEvents);\r
        manager.add(fAddMatchingEvents);\r
        manager.add(fDeleteMatchingEvents);\r
        manager.add(new Separator());\r
    }\r
\r
    /**\r
     * Fills the local toolbar.\r
     * @param manager\r
     *            The toolbar manager\r
     */\r
    private void fillLocalToolBar(IToolBarManager manager) {\r
        manager.add(new Separator());\r
        manager.add(fIncreaseBarWidth);\r
        manager.add(fDecreaseBarWidth);\r
        manager.add(new Separator());\r
        manager.add(fListMatchingEvents);\r
        manager.add(fAddMatchingEvents);\r
        manager.add(fDeleteMatchingEvents);\r
        manager.add(new Separator());\r
    }\r
\r
    /**\r
     * Creates the actions required by the dialog events.\r
     */\r
    private void makeActions() {\r
        // Increase the histogram bar width\r
        fIncreaseBarWidth = new Action() {\r
            @Override\r
            public void run() {\r
                fHistogramViewer.increaseBarWidth();\r
                fGraphViewer.increaseBarWidth();\r
            }\r
        };\r
        String tooltipText = Messages.LatencyView_Action_IncreaseBarWidth_Tooltip;\r
        fIncreaseBarWidth.setText(tooltipText);\r
        fIncreaseBarWidth.setToolTipText(tooltipText);\r
        fIncreaseBarWidth.setImageDescriptor(AbstractUIPlugin.imageDescriptorFromPlugin(Messages.LatencyView_tmf_UI, "icons/elcl16/increasebar_button.gif")); //$NON-NLS-1$\r
\r
        // Decrease the histogram bar width\r
        fDecreaseBarWidth = new Action() {\r
            @Override\r
            public void run() {\r
                fHistogramViewer.decreaseBarWidth();\r
                fGraphViewer.decreaseBarWidth();\r
            }\r
        };\r
        tooltipText = Messages.LatencyView_Action_DecreaseBarWidth_Tooltip;\r
        fDecreaseBarWidth.setText(tooltipText);\r
        fDecreaseBarWidth.setToolTipText(tooltipText);\r
        fDecreaseBarWidth.setImageDescriptor(AbstractUIPlugin.imageDescriptorFromPlugin(Messages.LatencyView_tmf_UI, "icons/elcl16/decreasebar_button.gif")); //$NON-NLS-1$\r
\r
        // List matching events dialog\r
        fListMatchingEvents = new Action() {\r
            @Override\r
            public void run() {\r
                ListDialog listDialog = new ListDialog(fParent.getShell(), Messages.LatencyView_Dialogs_ListEvents_Title, Messages.LatencyView_Dialogs_ListEvents_Message);\r
                listDialog.create();\r
                listDialog.open();\r
            }\r
        };\r
        tooltipText = Messages.LatencyView_Action_ListEvents_Tooltip;\r
        fListMatchingEvents.setText(tooltipText);\r
        fListMatchingEvents.setToolTipText(tooltipText);\r
        fListMatchingEvents.setImageDescriptor(AbstractUIPlugin.imageDescriptorFromPlugin(Messages.LatencyView_tmf_UI, "icons/eview16/events_view.gif")); //$NON-NLS-1$\r
\r
        // Add matching events dialog\r
        fAddMatchingEvents = new Action() {\r
            @Override\r
            public void run() {\r
                AddDialog addDialog = new AddDialog(fParent.getShell(), Messages.LatencyView_Dialogs_AddEvents_Title, Messages.LatencyView_Dialogs_AddEvents_Message);\r
                addDialog.create();\r
                addDialog.open();\r
            }\r
        };\r
        tooltipText = Messages.LatencyView_Action_AddEvents_Tooltip;\r
        fAddMatchingEvents.setText(tooltipText);\r
        fAddMatchingEvents.setToolTipText(tooltipText);\r
        fAddMatchingEvents.setImageDescriptor(AbstractUIPlugin.imageDescriptorFromPlugin(Messages.LatencyView_tmf_UI, "icons/elcl16/add_button.gif")); //$NON-NLS-1$\r
\r
        // Remove matching events dialog\r
        fDeleteMatchingEvents = new Action() {\r
            @Override\r
            public void run() {\r
                DeleteDialog deleteDialog = new DeleteDialog(fParent.getShell(), Messages.LatencyView_Dialogs_DeleteEvents_Title,\r
                        Messages.LatencyView_Dialogs_DeleteEvents_Message);\r
                deleteDialog.create();\r
                deleteDialog.open();\r
            }\r
        };\r
        tooltipText = Messages.LatencyView_Action_DeleteEvents_Tooltip;\r
        fDeleteMatchingEvents.setText(tooltipText);\r
        fDeleteMatchingEvents.setToolTipText(tooltipText);\r
        fDeleteMatchingEvents.setImageDescriptor(AbstractUIPlugin.imageDescriptorFromPlugin(Messages.LatencyView_tmf_UI, "icons/elcl16/delete_button.gif")); //$NON-NLS-1$\r
    }\r
\r
    /**\r
     * Build the toolbar and menu by adding action buttons for dialogs.\r
     */\r
    private void contributeToActionBars() {\r
        IActionBars bars = getViewSite().getActionBars();\r
        fillLocalPullDown(bars.getMenuManager());\r
        fillLocalToolBar(bars.getToolBarManager());\r
    }\r
}