org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/CopyViewTabToClipboardAction.java

/*******************************************************************************
 * Copyright (c) 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/


package org.eclipse.debug.internal.ui.views.memory;

import org.eclipse.debug.core.model.IMemoryBlock;
import org.eclipse.debug.internal.core.memory.IExtendedMemoryBlock;
import org.eclipse.debug.internal.ui.DebugPluginImages;
import org.eclipse.debug.internal.ui.DebugUIMessages;
import org.eclipse.debug.internal.ui.IInternalDebugUIConstants;
import org.eclipse.jface.viewers.ITableLabelProvider;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.swt.dnd.Clipboard;
import org.eclipse.swt.dnd.TextTransfer;
import org.eclipse.swt.dnd.Transfer;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.swt.widgets.TableItem;


/**
 * Toobar Copy View Tab to Clipboard action
 * 
 * @since 3.0
 */
public class CopyViewTabToClipboardAction extends AbstractMemoryAction
{
	private final String PREFIX = "CopyViewToClipboardAction."; //$NON-NLS-1$
	private final String TITLE = PREFIX + "title"; //$NON-NLS-1$
	private final String TOOLTIP = PREFIX + "tooltip"; //$NON-NLS-1$
	
	private final String COLUMN_SEPERATOR = "  "; //$NON-NLS-1$
	
	public CopyViewTabToClipboardAction()
	{
		super();
		
		setText(DebugUIMessages.getString(TITLE));
		setToolTipText(DebugUIMessages.getString(TOOLTIP));
		setImageDescriptor(DebugPluginImages.getImageDescriptor(IInternalDebugUIConstants.IMG_ELCL_COPY_VIEW_TO_CLIPBOARD));
		setHoverImageDescriptor(DebugPluginImages.getImageDescriptor(IInternalDebugUIConstants.IMG_LCL_COPY_VIEW_TO_CLIPBOARD));
		setDisabledImageDescriptor(DebugPluginImages.getImageDescriptor(IInternalDebugUIConstants.IMG_DLCL_COPY_VIEW_TO_CLIPBOARD));
	}

	private String concatenateTableAsString(TableItem[] itemList) {
		if (itemList.length == 0) return null;

		StringBuffer tableContents = new StringBuffer();
		TableViewer viewer = ((MemoryViewTab)getViewTab()).getTableViewer();
		Table table = viewer.getTable();
		int numColumns = table.getColumnCount();
		ITableLabelProvider labelProvider = (ITableLabelProvider)viewer.getLabelProvider();		
		TableColumn columns[] = table.getColumns();
		
		// get title of view tab
		String tabLabel = getViewTab().getTabLabel();
		tableContents.append(tabLabel);
		tableContents.append(System.getProperty("line.separator")); //$NON-NLS-1$
		tableContents.append(COLUMN_SEPERATOR);
		
		int charPerByte = 4;
		if (labelProvider instanceof AbstractTableViewTabLabelProvider)
		{
			AbstractMemoryRenderer renderer = ((AbstractTableViewTabLabelProvider)labelProvider).getRenderer();
			if (renderer instanceof IFixedLengthOutputRenderer)
			{
				charPerByte = ((IFixedLengthOutputRenderer)renderer).getNumCharPerByte();
			}
		}
		
		//get the column headers and line them up properly
		for (int k=0; k < numColumns; k++) {
			
			StringBuffer columnLabel = new StringBuffer(columns[k].getText());
			int numBytes = 0;
			int numChars = 0;
			
			if (k > 0)
			{
				if (!(getViewTab() instanceof ITableMemoryViewTab))
				{	
					return ""; //$NON-NLS-1$
				}
				
				numBytes = ((ITableMemoryViewTab)getViewTab()).getColumnSize();
				numChars = numBytes * charPerByte;
			}
			else
			{
				// special for address column
				IMemoryBlock memBlock = getViewTab().getMemoryBlock();
				
				
				if (memBlock instanceof IExtendedMemoryBlock)
				{
					numBytes = ((IExtendedMemoryBlock)memBlock).getAddressSize();
					
					// check address size
					if (numBytes <= 0)
						numBytes = 4;
				}
				else
				{
					numBytes = 4;
				}
				numChars = numBytes*2;
				
			}
			
			 while (columnLabel.length() < numChars)
			 {
				 columnLabel.append(" "); //$NON-NLS-1$
			 }
				
			tableContents.append(columnLabel);	
			tableContents.append(COLUMN_SEPERATOR);
		}
		
		tableContents.append(System.getProperty("line.separator")); //$NON-NLS-1$
		StringBuffer temp;
			
		//get the column contents from all the rows
		for (int i=0; i < itemList.length; i++) {
			for (int j=0; j < numColumns; j++) {
				tableContents.append(COLUMN_SEPERATOR);
				
				temp = new StringBuffer(labelProvider.getColumnText(itemList[i].getData(), j));
				
				if (j>0)
				{
					if (!(getViewTab() instanceof ITableMemoryViewTab))
						return ""; //$NON-NLS-1$
					
					int numBytes = ((ITableMemoryViewTab)getViewTab()).getColumnSize();
					int numChars = numBytes * charPerByte;
					while (temp.length() < numChars)
					{
						temp.append(" "); //$NON-NLS-1$
					}
				}
				
				tableContents.append(temp);
			}
			tableContents.append(System.getProperty("line.separator")); //$NON-NLS-1$
		}
		return tableContents.toString();
	}
	
	/* (non-Javadoc)
	 * @see org.eclipse.jface.action.IAction#run()
	 */
	public void run() {
		
		if (getViewTab() == null)
			return;
		
		TableViewer viewer = ((MemoryViewTab)getViewTab()).getTableViewer();
		
		if (viewer == null)
			return;
		
		Table table = viewer.getTable();
		
		if (table == null)
			return;
		
		Clipboard clip = new Clipboard(table.getDisplay());
		TableItem[] tableItems = table.getItems();
		String tableAsString = new String();
		tableAsString = concatenateTableAsString(tableItems);
		if (!tableAsString.equals("")) { //$NON-NLS-1$
			TextTransfer plainTextTransfer = TextTransfer.getInstance();
			clip.setContents(new Object[] {tableAsString}, new Transfer[] {plainTextTransfer});
		}
	}

	/* (non-Javadoc)
	 * @see org.eclipse.debug.ui.internal.actions.AbstractMemoryAction#getViewTab()
	 */
	IMemoryViewTab getViewTab()
	{
		return getTopViewTabFromView(IInternalDebugUIConstants.ID_MEMORY_VIEW);
	}
}