/*

 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 

 * All rights reserved.

 * This component and the accompanying materials are made available

 * under the terms of the License "Eclipse Public License v1.0"

 * which accompanies this distribution, and is available

 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

 *

 * Initial Contributors:

 * Nokia Corporation - initial contribution.

 *

 * Contributors:

 *

 * Description: 

 *

 */

/**

 * 

 */

package com.nokia.carbide.cpp.pi.call;

//import java.awt.Color;

import java.awt.Toolkit;

import java.awt.datatransfer.Clipboard;

import java.awt.datatransfer.StringSelection;

import java.awt.event.MouseEvent;

import java.text.DecimalFormat;

import java.util.Vector;

import org.eclipse.jface.action.Action;

import org.eclipse.jface.action.ActionContributionItem;

import org.eclipse.jface.action.IAction;

import org.eclipse.jface.action.IContributionManager;

import org.eclipse.jface.action.IMenuManager;

import org.eclipse.jface.action.SubMenuManager;

import org.eclipse.jface.viewers.ArrayContentProvider;

import org.eclipse.jface.viewers.ITableLabelProvider;

import org.eclipse.jface.viewers.LabelProvider;

import org.eclipse.jface.viewers.TableViewer;

import org.eclipse.jface.viewers.Viewer;

import org.eclipse.jface.viewers.ViewerSorter;

import org.eclipse.jface.wizard.Wizard;

import org.eclipse.jface.wizard.WizardDialog;

import org.eclipse.swt.SWT;

import org.eclipse.swt.custom.SashForm;

import org.eclipse.swt.events.FocusListener;

import org.eclipse.swt.events.MouseListener;

import org.eclipse.swt.events.SelectionAdapter;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.events.SelectionListener;

import org.eclipse.swt.graphics.Image;

import org.eclipse.swt.layout.GridData;

import org.eclipse.swt.layout.GridLayout;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Label;

import org.eclipse.swt.widgets.Menu;

import org.eclipse.swt.widgets.MenuItem;

import org.eclipse.swt.widgets.Table;

import org.eclipse.swt.widgets.TableColumn;

import org.eclipse.swt.widgets.TableItem;

import org.eclipse.ui.IActionBars;

import org.eclipse.ui.PlatformUI;

import org.eclipse.ui.actions.ActionFactory;

import org.eclipse.ui.ide.IIDEActionConstants;

import com.nokia.carbide.cpp.internal.pi.interfaces.ISaveSamples;

import com.nokia.carbide.cpp.internal.pi.interfaces.ISaveTable;

import com.nokia.carbide.cpp.internal.pi.save.SaveTableWizard;

import com.nokia.carbide.cpp.internal.pi.visual.GenericTable;

import com.nokia.carbide.cpp.pi.editors.PIPageEditor;

import com.nokia.carbide.cpp.pi.util.SourceLookup;

public class CallVisualiser extends GenericTable

{

	private static final long serialVersionUID = 1L;

	// table column IDs in hopes it's quicker than comparing characters

	protected static final int COLUMN_ID_IS_CALLED       = 100;

	protected static final int COLUMN_ID_IS_CALLER       = 101;

	protected static final int COLUMN_ID_RECURSIVE_CALL  = 102;

	protected static final int COLUMN_ID_CALLER_PERCENT  = 103;

	protected static final int COLUMN_ID_CALLEE_PERCENT  = 104;

	protected static final int COLUMN_ID_IS_CALLED_COUNT = 105;

	protected static final int COLUMN_ID_IS_CALLER_COUNT = 106;

	// table column headings

	protected static final String COLUMN_HEAD_IS_CALLED       = Messages.getString("CallVisualiser.isCalled"); //$NON-NLS-1$

	protected static final String COLUMN_HEAD_IS_CALLER       = Messages.getString("CallVisualiser.isCaller"); //$NON-NLS-1$

	protected static final String COLUMN_HEAD_RECURSIVE_CALL  = Messages.getString("CallVisualiser.recursiveCaller"); //$NON-NLS-1$

	protected static final String COLUMN_HEAD_CALLER_PERCENT  = Messages.getString("CallVisualiser.percentOfCalls"); //$NON-NLS-1$

	protected static final String COLUMN_HEAD_CALLEE_PERCENT  = Messages.getString("CallVisualiser.percentOfCalls"); //$NON-NLS-1$

	protected static final String COLUMN_HEAD_IS_CALLED_COUNT = Messages.getString("CallVisualiser.calledSamples"); //$NON-NLS-1$

	protected static final String COLUMN_HEAD_IS_CALLER_COUNT = Messages.getString("CallVisualiser.callerSamples"); //$NON-NLS-1$

	protected static final String COLUMN_HEAD_IS_CALLED_COUNT2 = Messages.getString("CallVisualiser.calls"); //$NON-NLS-1$

	protected static final String COLUMN_HEAD_IS_CALLER_COUNT2 = Messages.getString("CallVisualiser.calls"); //$NON-NLS-1$

	// table column widths

	protected static final int COLUMN_WIDTH_IS_CALLED       = 70;

	protected static final int COLUMN_WIDTH_IS_CALLER       = 70;

	protected static final int COLUMN_WIDTH_RECURSIVE_CALL  = 105;

	protected static final int COLUMN_WIDTH_CALLER_PERCENT  = 98;

	protected static final int COLUMN_WIDTH_CALLEE_PERCENT  = 98;

	protected static final int COLUMN_WIDTH_IS_CALLED_COUNT = 113;

	protected static final int COLUMN_WIDTH_IS_CALLER_COUNT = 85;

	protected static final int COLUMN_WIDTH_IS_CALLED_COUNT2 = 65;

	protected static final int COLUMN_WIDTH_IS_CALLER_COUNT2 = 65;

	// SashForm to hold the tables and their titles

	private SashForm sashForm;

	// Table viewers and their tables

	private TableViewer callerTableViewer;

	private Table callerTable;

	private TableViewer currentFunctionTableViewer;

	private Table       currentFunctionTable;

	private TableColumn  currentFunctionDefaultColumn;

	private TableViewer calleeTableViewer;

	private Table calleeTable;

	// context menus

	private Menu callerMenu;

	private Menu currentFunctionMenu;

	private Menu calleeMenu;

	private Table currentMenuTable;

	private SashForm parent;

	// this display's editor and page

	private PIPageEditor pageEditor;

	private int pageIndex;

	// trace associated with this display

	private GfcTrace myTrace;

	// lists of functions, function callers, and function callees

	private GfcFunctionItem[]  functionArray;

	private CallerCalleeItem[] callerList;

	private CallerCalleeItem[] calleeList;

	// menu items

	protected Action copyAction;

	protected Action copyTableAction;

	protected Action functionCopyFunctionAction;

	protected Action saveTableAction;

	protected Action functionSaveFunctionAction;

	protected static int SAMPLES_AT_ONE_TIME = 1000;

	// class to pass sample data to the save wizard

    public class SaveSampleString implements ISaveSamples {

    	int startIndex = 0;

    	public SaveSampleString() {

		}

    	public String getData() {

    		return getData(SAMPLES_AT_ONE_TIME);

		}

		public String getData(int size) {

			String returnString = getSampleString(this.startIndex, this.startIndex + size);

    		if (returnString == null)

    			this.startIndex = 0;

    		else

    			this.startIndex += size;

			return returnString;

		}

		public int getIndex() {

			return this.startIndex;

		}

		public void clear() {

			this.startIndex = 0;

		}

    }

	/*

	 * return the call samples selected in the interval 

	 */

	protected String getSampleString(int startIndex, int endIndex)

	{

		int startTime = (int) (PIPageEditor.currentPageEditor().getStartTime() * 1000.0 + 0.0005);

		int endTime   = (int) (PIPageEditor.currentPageEditor().getEndTime()   * 1000.0 + 0.0005);

		// check if we have returned everything

		if (startIndex > (endTime - startTime))

			return null;

		GfcTrace trace = this.myTrace;

		Vector samples = trace.samples;

		String returnString = ""; //$NON-NLS-1$

		if (startIndex == 0)

			returnString = Messages.getString("CallVisualiser.callHeading"); //$NON-NLS-1$

		for (int i = startTime + startIndex; i < endTime && i < startTime + endIndex; i++) {

			GfcSample sample = (GfcSample) samples.get(i);

			returnString +=   sample.sampleSynchTime + ",0x" //$NON-NLS-1$

							+ Long.toHexString(sample.linkRegister)

							+ ",\"" //$NON-NLS-1$

							+ (sample.callerFunctionItt != null

								? sample.callerFunctionItt.functionName

								: sample.callerFunctionSym.functionName)

							+ "\"," //$NON-NLS-1$

							+ (sample.callerFunctionItt != null

								? sample.callerFunctionItt.functionBinary.binaryName

								: sample.callerFunctionSym.functionBinary.binaryName)

							+ ",0x" //$NON-NLS-1$

							+ Long.toHexString(sample.programCounter)

							+ ",\"" //$NON-NLS-1$

							+ (sample.currentFunctionItt != null

								? sample.currentFunctionItt.functionName

								: sample.currentFunctionSym.functionName)

							+ "\"," //$NON-NLS-1$

							+ (sample.currentFunctionItt != null

								? sample.currentFunctionItt.functionBinary.binaryName

								: sample.currentFunctionSym.functionBinary.binaryName)

							+ "\n"; //$NON-NLS-1$

		}

		return returnString;

	}

	protected MenuItem getSaveSamplesItem(Menu menu, boolean enabled) {

	    MenuItem saveSamplesItem = new MenuItem(menu, SWT.PUSH);

		saveSamplesItem.setText(Messages.getString("CallVisualiser.saveAllSamplesForInterval")); //$NON-NLS-1$

		saveSamplesItem.setEnabled(enabled);

		if (enabled) {

			saveSamplesItem.addSelectionListener(new SelectionAdapter() { 

				public void widgetSelected(SelectionEvent e) {

					action("saveSamples"); //$NON-NLS-1$

				}

			});

		}

		return saveSamplesItem;

	}

	public CallVisualiser(PIPageEditor pageEditor, int pageIndex, SashForm parent, GfcTrace trace)

	{

		this.pageEditor = pageEditor;

		this.pageIndex  = pageIndex;

		this.parent     = parent;

		this.myTrace    = trace;

		// let the trace know about the CallVisualiser so that unit tests can find it

		trace.setCallVisualiser(this);

		// create the 3 table viewers: caller functions, selected function, callee functions

		createTableViewers(parent);

	}

	public void createTableViewers(SashForm parent)

	{

		if (parent == null)

			return;

		/*

		 * Create a SashForm with three labeled tables:

		 * 

		 * 1. Functions called by

		 * 2. Functions (one checkbox selectable at a time)

		 * 3. Functions called

		 */

		// the 3 tables will be in a sashForm

		if (parent.getOrientation() != SWT.VERTICAL)

		{

			// put a SashForm in the SashForm

			this.sashForm = new SashForm(parent, SWT.VERTICAL);

			this.sashForm.SASH_WIDTH = 5; // 5 pixel wide sash

		} else

			this.sashForm = parent;

		createCallerTableViewer(sashForm);

		createCurrentFunctionTableViewer(sashForm);

		createCalleeTableViewer(sashForm);

		createDefaultActions(true);

	}

	private void createCurrentFunctionTableViewer(SashForm sashForm)

	{

		/*

		 * Functions (one checkbox selectable at a time)

		 *

		 * 		selected checkbox

		 *		percent load

		 *  	function name

		 *		function start address

		 *		binary containing function

		 *		sample count

		 */

		Label label;

		Composite holder;

		Table table;

		TableColumn column;

		// middle functionTable and title

		holder = new Composite(sashForm, SWT.NONE);

		GridLayout gridLayout = new GridLayout(1, true);

		gridLayout.marginWidth = 0;

		gridLayout.marginHeight = 0;

		holder.setLayout(gridLayout);

		label = new Label(holder, SWT.CENTER | SWT.BORDER);

		label.setBackground(parent.getDisplay().getSystemColor(SWT.COLOR_YELLOW));

		label.setFont(PIPageEditor.helvetica_10);

		label.setText(Messages.getString("CallVisualiser.selectFunction")); //$NON-NLS-1$

		label.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

		this.currentFunctionTableViewer = new TableViewer(holder,

  				SWT.BORDER | SWT.SINGLE | SWT.H_SCROLL | SWT.V_SCROLL | SWT.FULL_SELECTION);

		this.currentFunctionTable = currentFunctionTableViewer.getTable();

		// add the label provider and content provider

		this.currentFunctionTableViewer.setLabelProvider(new SharedLabelProvider(this.currentFunctionTable));

		this.currentFunctionTableViewer.setContentProvider(new ArrayContentProvider());

		this.currentFunctionTableViewer.setSorter(new SharedSorter());

		table = this.currentFunctionTable;

		table.setRedraw(false);

		// give the table a heading for use in copying and exported

		table.setData(Messages.getString("CallVisualiser.selectedFunction")); //$NON-NLS-1$

		// create the other table entries when a row in this table is selected

		table.addSelectionListener(new SelectionListener() {

			public void widgetSelected(SelectionEvent event) {

				if (!(event.item instanceof TableItem))

					return;

	       		// set the other tables based on this selection

	       		if (!(event.item.getData() instanceof GfcFunctionItem))

	       			return;

	       		updateCallerCalleeTables((GfcFunctionItem)event.item.getData());

			}

			public void widgetDefaultSelected(SelectionEvent e) {

				widgetSelected(e);

			}});

		// data associated with the TableViewer will note which columns contain hex values

		// Keep this in the order in which columns have been created

		boolean[] isHex = {false, false, false, true, false, false, false};

		this.currentFunctionTable.setData("isHex", isHex); //$NON-NLS-1$

		// is called percent column

		column = new TableColumn(table, SWT.RIGHT);

		column.setText(COLUMN_HEAD_IS_CALLED);

		column.setWidth(COLUMN_WIDTH_IS_CALLED);

		column.setData(new Integer(COLUMN_ID_IS_CALLED));

		column.setMoveable(true);

		column.setResizable(true);

		column.addSelectionListener(new CheckboxColumnSelectionHandler());

		// is caller percent column

		column = new TableColumn(table, SWT.RIGHT);

		column.setText(COLUMN_HEAD_IS_CALLER);

		column.setWidth(COLUMN_WIDTH_IS_CALLER);

		column.setData(new Integer(COLUMN_ID_IS_CALLER));

		column.setMoveable(true);

		column.setResizable(true);

		column.addSelectionListener(new CheckboxColumnSelectionHandler());

		// function name column

		column = new TableColumn(table, SWT.LEFT);

		column.setText(COLUMN_HEAD_FUNCTION);

		column.setWidth(COLUMN_WIDTH_FUNCTION_NAME);

		column.setData(new Integer(COLUMN_ID_FUNCTION));

		column.setMoveable(true);

		column.setResizable(true);

		column.addSelectionListener(new CheckboxColumnSelectionHandler());

		// function start address column

		column = new TableColumn(table, SWT.CENTER);

		column.setText(COLUMN_HEAD_START_ADDR);

		column.setWidth(COLUMN_WIDTH_START_ADDRESS);

		column.setData(new Integer(COLUMN_ID_START_ADDR));

		column.setMoveable(true);

		column.setResizable(true);

		column.addSelectionListener(new CheckboxColumnSelectionHandler());

		// binary containing function column

		column = new TableColumn(table, SWT.LEFT);

		column.setText(COLUMN_HEAD_IN_BINARY);

		column.setWidth(COLUMN_WIDTH_IN_BINARY);

		column.setData(new Integer(COLUMN_ID_IN_BINARY));

		column.setMoveable(true);

		column.setResizable(true);

		column.addSelectionListener(new CheckboxColumnSelectionHandler());

		// path to binary containing function column

		column = new TableColumn(table, SWT.LEFT);

		column.setText(COLUMN_HEAD_IN_BINARY_PATH);

		column.setWidth(COLUMN_WIDTH_IN_BINARY_PATH);

		column.setData(new Integer(COLUMN_ID_IN_BINARY_PATH));

		column.setMoveable(true);

		column.setResizable(true);

		column.addSelectionListener(new CheckboxColumnSelectionHandler());

		// sample count column

		column = new TableColumn(table, SWT.CENTER);

		column.setText(COLUMN_HEAD_IS_CALLED_COUNT);

		column.setWidth(COLUMN_WIDTH_IS_CALLED_COUNT);

		column.setData(new Integer(COLUMN_ID_IS_CALLED_COUNT));

		column.setMoveable(true);

		column.setResizable(true);

		column.addSelectionListener(new CheckboxColumnSelectionHandler());

		// set the default sort column to COLUMN_ID_IS_CALLED_COUNT

		currentFunctionDefaultColumn = column;

		// sample count column

		column = new TableColumn(table, SWT.CENTER);

		column.setText(COLUMN_HEAD_IS_CALLER_COUNT);

		column.setWidth(COLUMN_WIDTH_IS_CALLER_COUNT);

		column.setData(new Integer(COLUMN_ID_IS_CALLER_COUNT));

		column.setMoveable(true);

		column.setResizable(true);

		column.addSelectionListener(new CheckboxColumnSelectionHandler());

		table.setLayoutData(new GridData(GridData.FILL_BOTH));

		table.setHeaderVisible(true);

		table.setLinesVisible(true);

		table.setRedraw(true);

		// listen for mouse clicks: to select a row, pop up a menu, etc.

		table.addMouseListener(new CurrentFunctionMouseListener());

		table.addFocusListener(new FocusListener() {

			IAction oldCopyAction = null;

			public void focusGained(org.eclipse.swt.events.FocusEvent arg0) {

				IActionBars bars = PIPageEditor.getActionBars();

				// modify what is executed when Copy is called from the Edit menu

				oldCopyAction = bars.getGlobalActionHandler(ActionFactory.COPY.getId());

				bars.setGlobalActionHandler(ActionFactory.COPY.getId(), copyAction);

				copyAction.setEnabled(currentFunctionTable.getSelectionCount() > 0);

				bars.updateActionBars();

				// add to the Edit menu

		        IMenuManager editMenuManager = bars.getMenuManager().findMenuUsingPath(IIDEActionConstants.M_EDIT);

		        if (editMenuManager instanceof SubMenuManager)

		        {

		        	IContributionManager editManager = ((SubMenuManager)editMenuManager).getParent();

		        	ActionContributionItem item;

					editMenuManager.remove("PICopyFunction"); //$NON-NLS-1$

					functionCopyFunctionAction.setEnabled(currentFunctionTable.getSelectionCount() > 0);

		        	item = new ActionContributionItem(functionCopyFunctionAction);

		        	item.setVisible(true);

		        	editManager.prependToGroup(IIDEActionConstants.CUT_EXT, item);

					editMenuManager.remove("PICopyTable"); //$NON-NLS-1$

					copyTableAction.setEnabled(currentFunctionTable.getItemCount() > 0);

		        	item = new ActionContributionItem(copyTableAction);

		        	item.setVisible(true);

		        	editManager.prependToGroup(IIDEActionConstants.CUT_EXT, item);

		        }

				// add to the File menu

		        IMenuManager fileMenuManager = bars.getMenuManager().findMenuUsingPath(IIDEActionConstants.M_FILE);

		        if (fileMenuManager instanceof SubMenuManager)

		        {

		        	IContributionManager fileManager = ((SubMenuManager)fileMenuManager).getParent();

		        	ActionContributionItem item;

					fileMenuManager.remove("PISaveTable"); //$NON-NLS-1$

					saveTableAction.setEnabled(currentFunctionTable.getItemCount() > 0);

		        	item = new ActionContributionItem(saveTableAction);

		        	item.setVisible(true);

		        	fileManager.insertAfter("saveAll", item); //$NON-NLS-1$

					fileMenuManager.remove("PISaveFunction"); //$NON-NLS-1$

					functionSaveFunctionAction.setEnabled(currentFunctionTable.getSelectionCount() > 0);

		        	item = new ActionContributionItem(functionSaveFunctionAction);

		        	item.setVisible(true);

		        	fileManager.insertAfter("PISaveTable", item); //$NON-NLS-1$

		        }

		}

			public void focusLost(org.eclipse.swt.events.FocusEvent arg0) {

				IActionBars bars = PIPageEditor.getActionBars();

				bars.setGlobalActionHandler(ActionFactory.COPY.getId(), oldCopyAction);

				bars.updateActionBars();

				SubMenuManager editMenuManager = (SubMenuManager) PIPageEditor.getMenuManager().find(IIDEActionConstants.M_EDIT);

				editMenuManager.remove("PICopyTable"); //$NON-NLS-1$

				editMenuManager.remove("PICopyFunction"); //$NON-NLS-1$

				SubMenuManager fileMenuManager = (SubMenuManager) PIPageEditor.getMenuManager().find(IIDEActionConstants.M_FILE);

				fileMenuManager.remove("PISaveTable"); //$NON-NLS-1$

				fileMenuManager.remove("PISaveFunction"); //$NON-NLS-1$

			}

		});

	}

	private void createCallerTableViewer(SashForm sashForm)

	{

		/*

		 * Functions called by

		 * 

		 *		percent of calls

		 *		total percent

		 *		caller percent

		 *  	function name

		 *		function start address

		 *		binary containing function

		 *		sample count