/*******************************************************************************
* Copyright (c) 2004, 2010 QNX Software Systems and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* QNX Software Systems - Initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.debug.internal.ui.disassembly.rendering;
import java.util.Arrays;
import org.eclipse.cdt.core.IAddress;
import org.eclipse.cdt.debug.core.CDIDebugModel;
import org.eclipse.cdt.debug.core.model.IAsmInstruction;
import org.eclipse.cdt.debug.core.model.IAsmSourceLine;
import org.eclipse.cdt.debug.core.model.ICDebugTarget;
import org.eclipse.cdt.debug.core.model.ICLineBreakpoint;
import org.eclipse.cdt.debug.core.model.ICStackFrame;
import org.eclipse.cdt.debug.core.model.IDisassembly;
import org.eclipse.cdt.debug.core.model.IDisassemblyBlock;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IStorage;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.DebugException;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.model.IBreakpoint;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.Region;
import org.eclipse.core.runtime.Assert;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IPersistableElement;
/**
* Editor input associated with a debug element.
*/
public class DisassemblyEditorInput implements IEditorInput {
public static final IEditorInput EMPTY_EDITOR_INPUT = new DisassemblyEditorInput();
public static final IEditorInput PENDING_EDITOR_INPUT =
new DisassemblyEditorInput() {
public String getContents() {
return DisassemblyMessages.getString( "DisassemblyDocumentProvider.Pending_1" ); //$NON-NLS-1$
}
};
/**
* Disassembly block associated with this editor input
*/
private IDisassemblyBlock fBlock;
private String fContents = ""; //$NON-NLS-1$
private IRegion[] fSourceRegions = new IRegion[0];
/**
* Constructor for DisassemblyEditorInput.
*/
protected DisassemblyEditorInput() {
}
/**
* Constructor for DisassemblyEditorInput.
*
* @param disassembly
* @param instructions
*/
private DisassemblyEditorInput( IDisassemblyBlock block) {
fBlock = block;
createContents();
}
/* (non-Javadoc)
* @see org.eclipse.ui.IEditorInput#exists()
*/
public boolean exists() {
return true;
}
/* (non-Javadoc)
* @see org.eclipse.ui.IEditorInput#getImageDescriptor()
*/
public ImageDescriptor getImageDescriptor() {
return null;
}
/* (non-Javadoc)
* @see org.eclipse.ui.IEditorInput#getName()
*/
public String getName() {
return null;
}
/* (non-Javadoc)
* @see org.eclipse.ui.IEditorInput#getPersistable()
*/
public IPersistableElement getPersistable() {
return null;
}
/* (non-Javadoc)
* @see org.eclipse.ui.IEditorInput#getToolTipText()
*/
public String getToolTipText() {
return null;
}
/* (non-Javadoc)
* @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
*/
public Object getAdapter( Class adapter ) {
return null;
}
public boolean contains( ICStackFrame frame ) {
if ( fBlock != null ) {
return fBlock.contains( frame );
}
return false;
}
public String getContents() {
return fContents;
}
public int getInstructionLine( IAddress address ) {
if ( fBlock != null ) {
IAsmSourceLine[] lines = fBlock.getSourceLines();
int result = 0;
for ( int i = 0; i < lines.length; ++i ) {
IAsmInstruction[] instructions = lines[i].getInstructions();
if ( fBlock.isMixedMode() )
++result;
for ( int j = 0; j < instructions.length; ++j ) {
++result;
if ( address.equals( instructions[j].getAdress() ) ) {
return result;
}
}
}
}
return -1;
}
public int getInstructionLine( ICLineBreakpoint breakpoint ) {
if ( fBlock != null ) {
IDisassembly dis = fBlock.getDisassembly();
if ( dis != null ) {
ICDebugTarget target = (ICDebugTarget)dis.getDebugTarget().getAdapter( ICDebugTarget.class );
if ( target != null ) {
try {
IAddress address = target.getBreakpointAddress( breakpoint );
if ( address != null && !address.isZero() )
return getInstructionLine( address );
}
catch( DebugException e ) {
}
}
}
}
return -1;
}
public IAddress getAddress( int lineNumber ) {
if ( fBlock != null ) {
IAsmSourceLine[] lines = fBlock.getSourceLines();
int current = 0;
for ( int i = 0; i < lines.length; ++i ) {
IAsmInstruction[] instructions = lines[i].getInstructions();
if ( fBlock.isMixedMode() ) {
++current;
}
if ( lineNumber == current && instructions.length > 0 )
return instructions[0].getAdress();
if ( lineNumber > current && lineNumber <= current + instructions.length )
return instructions[lineNumber - current - 1].getAdress();
current += instructions.length;
}
}
return null;
}
public String getModuleFile() {
return ( fBlock != null ) ? fBlock.getModuleFile() : null;
}
public String getSourceFile() {
if ( fBlock != null ) {
Object element = fBlock.getSourceElement();
if ( element instanceof IFile ) {
return ((IFile)element).getLocation().toOSString();
}
else if ( element instanceof IStorage ) {
return ((IStorage)element).getFullPath().toOSString();
}
}
return null;
}
public int getSourceLine( int instrNumber ) {
if ( fBlock != null ) {
IAsmSourceLine[] sl = fBlock.getSourceLines();
int current = 0;
for ( int i = 0; i < sl.length; ++i ) {
++current;
IAsmInstruction[] ins = sl[i].getInstructions();
if ( instrNumber >= current && instrNumber <= current + ins.length )
return sl[i].getLineNumber();
current += ins.length;
}
}
return -1;
}
public static DisassemblyEditorInput create( ICStackFrame frame ) throws DebugException {
DisassemblyEditorInput input = null;
ICDebugTarget target = ((ICDebugTarget)frame.getDebugTarget());
IDisassembly disassembly = target.getDisassembly();
if ( disassembly != null ) {
IDisassemblyBlock block = disassembly.getDisassemblyBlock( frame );
input = new DisassemblyEditorInput( block);
}
return input;
}
public static DisassemblyEditorInput create( IDisassemblyBlock block) throws DebugException {
return new DisassemblyEditorInput(block);
}
private void createContents() {
fSourceRegions = new IRegion[0];
StringBuffer lines = new StringBuffer();
int maxFunctionName = 0;
int maxOpcodeLength = 0;
long maxOffset = 0;
if ( fBlock != null ) {
IAsmSourceLine[] mi = fBlock.getSourceLines();
for ( int j = 0; j < mi.length; ++j ) {
IAsmInstruction[] instructions = mi[j].getInstructions();
for( int i = 0; i < instructions.length; ++i ) {
String functionName = instructions[i].getFunctionName();
if ( functionName.length() > maxFunctionName ) {
maxFunctionName = functionName.length();
}
String opcode = instructions[i].getOpcode();
if ( opcode.length() > maxOpcodeLength )
maxOpcodeLength = opcode.length();
long offset = Math.abs( instructions[i].getOffset() );
if ( offset > maxOffset ) {
maxOffset = offset;
}
}
}
int instrPos = calculateInstructionPosition( maxFunctionName, maxOffset );
int argPosition = instrPos + maxOpcodeLength + 1;
if ( fBlock.isMixedMode() )
fSourceRegions = new IRegion[mi.length];
for ( int j = 0; j < mi.length; ++j ) {
if ( fBlock.isMixedMode() ) {
String sl = getSourceLineString( mi[j] );
fSourceRegions[j] = new Region( lines.length(), sl.length() );
lines.append( sl );
}
IAsmInstruction[] instructions = mi[j].getInstructions();
for( int i = 0; i < instructions.length; ++i ) {
lines.append( getInstructionString( instructions[i], instrPos, argPosition ) );
}
}
}
fContents = lines.toString();
}
private String getInstructionString( IAsmInstruction instruction, int instrPosition, int argPosition ) {
int worstCaseSpace = Math.max( instrPosition, argPosition );
char[] spaces = new char[worstCaseSpace];
Arrays.fill( spaces, ' ' );
StringBuffer sb = new StringBuffer();
if ( instruction != null ) {
sb.append( instruction.getAdress().toHexAddressString() );
sb.append( ' ' );
String functionName = instruction.getFunctionName();
if ( functionName != null && functionName.length() > 0 ) {
sb.append( '<' );
sb.append( functionName );
long offset = instruction.getOffset();
if ( offset != 0 ) {
if ( offset > 0 )
sb.append( '+' );
sb.append( instruction.getOffset() );
}
sb.append( ">:" ); //$NON-NLS-1$
sb.append( spaces, 0, instrPosition - sb.length() );
}
sb.append( instruction.getOpcode() );
sb.append( spaces, 0, argPosition - sb.length() );
sb.append( instruction.getArguments() );
sb.append( '\n' );
}
return sb.toString();
}
private int calculateInstructionPosition( int maxFunctionName, long maxOffset ) {
//(Address prefix address representation in chars) + (space) + (<) + (+) + (>) + (:) + (space)
int addressLength = getDisassembly().getAddressFactory().getMax().getCharsNum();
return ( addressLength + 6 + maxFunctionName + Long.toString( maxOffset ).length() );
}
private String getSourceLineString( IAsmSourceLine line ) {
String text = line.toString();
if ( text == null ) {
text = DisassemblyMessages.getString( "DisassemblyEditorInput.source_line_is_not_available_1" ) + '\n'; //$NON-NLS-1$
}
return text;
}
public IRegion[] getSourceRegions() {
return this.fSourceRegions;
}
protected IDisassembly getDisassembly() {
return ( fBlock != null ) ? fBlock.getDisassembly() : null;
}
/**
* @return the disassembly block
*/
public IDisassemblyBlock getDisassemblyBlock() {
return fBlock;
}
public ICLineBreakpoint breakpointExists( IAddress address ) throws CoreException {
Assert.isTrue( address != null );
IDisassembly dis = getDisassembly();
if ( dis != null ) {
ICDebugTarget bt = (ICDebugTarget)dis.getDebugTarget().getAdapter( ICDebugTarget.class );
if ( bt != null ) {
String modelId = CDIDebugModel.getPluginIdentifier();
IBreakpoint[] bps = DebugPlugin.getDefault().getBreakpointManager().getBreakpoints( modelId );
for ( int i = 0; i < bps.length; ++i ) {
if ( bps[i] instanceof ICLineBreakpoint ) {
ICLineBreakpoint b = (ICLineBreakpoint)bps[i];
try {
IAddress a = bt.getBreakpointAddress( b );
if ( a != null && address.compareTo( a ) == 0 )
return b;
}
catch( NumberFormatException e ) {
}
catch( CoreException e ) {
}
}
}
}
}
return null;
}
}