2010-07-20 Francois Chouinard <fchouinard@gmail.com>

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / viewers / events / TmfEventsTable.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
 *   Francois Chouinard - Initial API and implementation\r
 *   Patrick Tasse - Factored out from events view\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.viewers.events;\r
\r
import org.eclipse.linuxtools.tmf.component.ITmfDataProvider;\r
import org.eclipse.linuxtools.tmf.component.TmfComponent;\r
import org.eclipse.linuxtools.tmf.event.TmfEvent;\r
import org.eclipse.linuxtools.tmf.event.TmfTimestamp;\r
import org.eclipse.linuxtools.tmf.request.TmfDataRequest;\r
import org.eclipse.linuxtools.tmf.signal.TmfExperimentUpdatedSignal;\r
import org.eclipse.linuxtools.tmf.signal.TmfRangeSynchSignal;\r
import org.eclipse.linuxtools.tmf.signal.TmfSignalHandler;\r
import org.eclipse.linuxtools.tmf.signal.TmfTimeSynchSignal;\r
import org.eclipse.linuxtools.tmf.signal.TmfTraceUpdatedSignal;\r
import org.eclipse.linuxtools.tmf.trace.ITmfTrace;\r
import org.eclipse.swt.SWT;\r
import org.eclipse.swt.events.SelectionAdapter;\r
import org.eclipse.swt.events.SelectionEvent;\r
import org.eclipse.swt.layout.GridData;\r
import org.eclipse.swt.widgets.Composite;\r
import org.eclipse.swt.widgets.Event;\r
import org.eclipse.swt.widgets.Listener;\r
import org.eclipse.swt.widgets.Table;\r
import org.eclipse.swt.widgets.TableColumn;\r
import org.eclipse.swt.widgets.TableItem;\r
\r
/**\r
 * <b><u>TmfEventsTable</u></b>\r
 */\r
public class TmfEventsTable extends TmfComponent {\r
\r
//    private Shell fShell;\r
    \r
    // ------------------------------------------------------------------------\r
    // Table data\r
    // ------------------------------------------------------------------------\r
\r
    protected Table fTable;\r
    protected ITmfTrace fTrace;\r
    protected boolean fPackDone = false;\r
\r
    // Table column names\r
    private final String TIMESTAMP_COLUMN = "Timestamp";\r
    private final String SOURCE_COLUMN    = "Source";\r
    private final String TYPE_COLUMN      = "Type";\r
    private final String REFERENCE_COLUMN = "File";\r
    private final String CONTENT_COLUMN   = "Content";\r
    private final String[] columnProperties =  new String[] {\r
        TIMESTAMP_COLUMN,\r
        SOURCE_COLUMN,\r
        TYPE_COLUMN,\r
        REFERENCE_COLUMN,\r
        CONTENT_COLUMN\r
    };\r
\r
    // Column data\r
    private class ColumnData {\r
        public final String header;\r
        public final int    width;\r
        public final int    alignment;\r
\r
        public ColumnData(String h, int w, int a) {\r
            header = h;\r
            width = w;\r
            alignment = a;\r
        }\r
    };\r
\r
    private ColumnData[] columnData = new ColumnData[] {\r
        new ColumnData(columnProperties[0], 100, SWT.LEFT),\r
        new ColumnData(columnProperties[1], 100, SWT.LEFT),\r
        new ColumnData(columnProperties[2], 100, SWT.LEFT),\r
        new ColumnData(columnProperties[3], 100, SWT.LEFT),\r
        new ColumnData(columnProperties[4], 100, SWT.LEFT)\r
    };\r
\r
    // ------------------------------------------------------------------------\r
    // Event cache\r
    // ------------------------------------------------------------------------\r
\r
    private final int fCacheSize;\r
    private TmfEvent[] cache = new TmfEvent[1];\r
    private int cacheStartIndex = 0;\r
    private int cacheEndIndex = 0;\r
//    private IResourceChangeListener fResourceChangeListener;\r
\r
    // ------------------------------------------------------------------------\r
    // Constructor\r
    // ------------------------------------------------------------------------\r
\r
    public TmfEventsTable(Composite parent, int cacheSize) {\r
        super("TmfEventsTable");\r
        \r
        fCacheSize = cacheSize;\r
        \r
//        fShell = parent.getShell();\r
        \r
        // Create a virtual table\r
        // TODO: change SINGLE to MULTI line selection and adjust the selection listener\r
        final int style = SWT.SINGLE | SWT.FULL_SELECTION | SWT.H_SCROLL | SWT.V_SCROLL | SWT.BORDER | SWT.VIRTUAL;\r
        fTable = new Table(parent, style);\r
\r
        // Set the table layout\r
        GridData layoutData = new GridData(SWT.FILL, SWT.FILL, true, true);\r
        fTable.setLayoutData(layoutData);\r
\r
        // Some cosmetic enhancements\r
        fTable.setHeaderVisible(true);\r
        fTable.setLinesVisible(true);\r
\r
        // Set the columns\r
        createColumnHeaders(fTable);\r
\r
        // Handle the table item requests \r
        fTable.addSelectionListener(new SelectionAdapter() {\r
\r
            @Override\r
            public void widgetSelected(SelectionEvent e) {\r
                TmfTimestamp ts = (TmfTimestamp) fTable.getSelection()[0].getData();\r
                broadcast(new TmfTimeSynchSignal(fTable, ts));\r
            }\r
        });\r
\r
        // Handle the table item requests \r
        fTable.addListener(SWT.SetData, new Listener() {\r
\r
            @SuppressWarnings("unchecked")\r
			public void handleEvent(Event event) {\r
\r
                final TableItem item = (TableItem) event.item;\r
                final int index = fTable.indexOf(item);\r
\r
                // Note: this works because handleEvent() is called once for each row, in sequence  \r
                if ((index >= cacheStartIndex ) && (index < cacheEndIndex)) {\r
                    int i = index - cacheStartIndex;\r
                    item.setText(extractItemFields(cache[i]));\r
                    item.setData(new TmfTimestamp(cache[i].getTimestamp()));\r
                    return;\r
                }\r
\r
                TmfDataRequest<TmfEvent> request = new TmfDataRequest<TmfEvent>(TmfEvent.class, index, fCacheSize) {\r
                    @Override\r
                    public void handleData() {\r
                        TmfEvent[] tmpEvent = getData();\r
                        if ((tmpEvent != null) && (tmpEvent.length > 0)) {\r
                            cache = tmpEvent;\r
                            cacheStartIndex = index;\r
                            cacheEndIndex = index + tmpEvent.length;\r
                        }\r
                    }\r
                };\r
                ((ITmfDataProvider<TmfEvent>) fTrace).sendRequest(request);\r
                try {\r
                    request.waitForCompletion();\r
                } catch (InterruptedException e) {\r
                    e.printStackTrace();\r
                }\r
                \r
                if (cache[0] != null && cacheStartIndex == index) {\r
                    item.setText(extractItemFields(cache[0]));\r
                    item.setData(new TmfTimestamp(cache[0].getTimestamp()));\r
                    packColumns(fTable);\r
                }\r
                \r
            }\r
        });\r
\r
        fTable.setItemCount(0);\r
    }\r
\r
    public void dispose() {\r
        fTable.dispose();\r
        if (fTrace != null) {\r
            fTrace.dispose();\r
        }\r
        super.dispose();\r
    }\r
\r
    public Table getTable() {\r
        return fTable;\r
    }\r
    \r
    /**\r
     * @param table\r
     * \r
     * FIXME: Add support for column selection\r
     */\r
    protected void createColumnHeaders(Table table) {\r
        for (int i = 0; i < columnData.length; i++) {\r
            TableColumn column = new TableColumn(table, columnData[i].alignment, i);\r
            column.setText(columnData[i].header);\r
            column.setWidth(columnData[i].width);\r
        }\r
    }\r
\r
    protected void packColumns(Table table) {\r
        if (fPackDone) return;\r
        for (TableColumn column : fTable.getColumns()) {\r
            int headerWidth = column.getWidth();\r
            column.pack();\r
            if (column.getWidth() < headerWidth) {\r
                column.setWidth(headerWidth);\r
            }\r
        }\r
        fPackDone = true;\r
    }\r
    \r
    /**\r
     * @param event\r
     * @return\r
     * \r
     * FIXME: Add support for column selection\r
     */\r
    protected String[] extractItemFields(TmfEvent event) {\r
        String[] fields = new String[0];\r
        if (event != null) {\r
            fields = new String[] {\r
                new Long(event.getTimestamp().getValue()).toString(),       \r
                event.getSource().getSourceId().toString(),\r
                event.getType().getTypeId().toString(),\r
                event.getReference().getReference().toString(),\r
                event.getContent().toString()\r
            };\r
        }\r
        return fields;\r
    }\r
\r
    public void setFocus() {\r
        fTable.setFocus();\r
    }\r
\r
    public void setTrace(ITmfTrace trace) {\r
        fTrace = trace;\r
        \r
        // Perform the updates on the UI thread\r
        fTable.getDisplay().syncExec(new Runnable() {\r
            public void run() {\r
                //fTable.setSelection(0); PATA\r
                fTable.removeAll();\r
                cacheStartIndex = cacheEndIndex = 0; // Clear the cache\r
                \r
                if (!fTable.isDisposed() && fTrace != null) {\r
                    //int nbEvents = (int) fTrace.getNbEvents();\r
                    //fTable.setItemCount((nbEvents > 100) ? nbEvents : 100);\r
                    fTable.setItemCount((int) fTrace.getNbEvents());\r
                }\r
            }\r
        });\r
//        ProgressMonitorDialog dialog = new ProgressMonitorDialog(fShell);\r
//        try {\r
//            dialog.run(false, false, new IRunnableWithProgress() {\r
//                public void run(final IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {\r
//                    monitor.beginTask("Cleaning up, please wait", 0);\r
//\r
//\r
//                    monitor.done();\r
//                }\r
//              });\r
//        } catch (InvocationTargetException e) {\r
//        } catch (InterruptedException e) {\r
//        }\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Signal handlers\r
    // ------------------------------------------------------------------------\r
    \r
    @TmfSignalHandler\r
    public void experimentUpdated(TmfExperimentUpdatedSignal signal) {\r
        if (signal.getExperiment() != fTrace) return;\r
        // Perform the refresh on the UI thread\r
        fTable.getDisplay().asyncExec(new Runnable() {\r
            public void run() {\r
                if (!fTable.isDisposed() && fTrace != null) {\r
                    fTable.setItemCount((int) fTrace.getNbEvents());\r
                }\r
            }\r
        });\r
    }\r
    \r
    @TmfSignalHandler\r
    public void traceUpdated(TmfTraceUpdatedSignal signal) {\r
        if (signal.getTrace() != fTrace) return;\r
        // Perform the refresh on the UI thread\r
        fTable.getDisplay().asyncExec(new Runnable() {\r
            public void run() {\r
                if (!fTable.isDisposed() && fTrace != null) {\r
                    //int nbEvents = (int) fTrace.getNbEvents();\r
                    //fTable.setItemCount((nbEvents > 100) ? nbEvents : 100);\r
                    fTable.setItemCount((int) fTrace.getNbEvents());\r
                }\r
            }\r
        });\r
    }\r
\r
    private boolean fRefreshPending = false;\r
    @TmfSignalHandler\r
    public synchronized void rangeSynched(TmfRangeSynchSignal signal) {\r
        if (!fRefreshPending) {\r
            // Perform the refresh on the UI thread\r
            fRefreshPending = true;\r
            fTable.getDisplay().asyncExec(new Runnable() {\r
                public void run() {\r
                    fRefreshPending = false;\r
                    if (!fTable.isDisposed() && fTrace != null) {\r
                        fTable.setItemCount((int) fTrace.getNbEvents());\r
                    }\r
                }\r
            });\r
        }\r
    }\r
    \r
    @TmfSignalHandler\r
    public void currentTimeUpdated(TmfTimeSynchSignal signal) {\r
        if (signal.getSource() != fTable && fTrace != null) {\r
            final int index = (int) fTrace.getRank(signal.getCurrentTime());\r
            // Perform the updates on the UI thread\r
            fTable.getDisplay().asyncExec(new Runnable() {\r
                public void run() {\r
                    fTable.setSelection(index);\r
                    // The timestamp might not correspond to an actual event\r
                    // and the selection will point to the next experiment event.\r
                    // But we would like to display both the event before and\r
                    // after the selected timestamp.\r
                    // This works fine by default except when the selected event\r
                    // is the top displayed event. The following ensures that we\r
                    // always see both events.\r
                    if ((index > 0) && (index == fTable.getTopIndex())) {\r
                        fTable.setTopIndex(index - 1);\r
                    }\r
                }\r
            });\r
        }\r
    }\r
}\r