Eclipse CDT
Pre-release 3.0

org.eclipse.cdt.debug.core.cdi.model
Interface ICDITarget

All Superinterfaces:
ICDIBreakpointManagement, ICDIExecuteStep, ICDIExpressionManagement, ICDIMemoryBlockManagement, ICDIObject, ICDISessionObject, ICDISharedLibraryManagement, ICDISignalManagement, ICDISourceManagement, ICDISuspend, ICDIThreadGroup

public interface ICDITarget
extends ICDIThreadGroup, ICDIExpressionManagement, ICDISourceManagement, ICDISharedLibraryManagement, ICDIMemoryBlockManagement, ICDISessionObject

Represents a debuggable process. This is a root object of the CDI model.

Since:
Jul 8, 2002

Method Summary
 ICDIAddressLocation createAddressLocation(BigInteger address)
          Returns a ICDIAddressLocation
 ICDICondition createCondition(int ignoreCount, String expression)
          Return a ICDICondition
 ICDICondition createCondition(int ignoreCount, String expression, String[] threadIds)
          Return a ICDICondition
 ICDIFunctionLocation createFunctionLocation(String file, String function)
          Returns a ICDIFunctionLocation
 ICDIGlobalVariable createGlobalVariable(ICDIGlobalVariableDescriptor varDesc)
          Create a variable from the descriptor for evaluation.
 ICDILineLocation createLineLocation(String file, int line)
          Returns a ICDILineLocation
 ICDIRegister createRegister(ICDIRegisterDescriptor varDesc)
          Create a variable from the descriptor for evaluation.
 void disconnect()
          Disconnects this target from the debuggable process.
 String evaluateExpressionToString(ICDIStackFrame context, String expressionText)
          Evaluates the expression specified by the given string.
 ICDITargetConfiguration getConfiguration()
          Returns the configuration description of this debug session.
 ICDIGlobalVariableDescriptor getGlobalVariableDescriptors(String filename, String function, String name)
          A static/global variable in a particular function or file, filename or/and function is the context for the static ICDIVariableDescriptor.
 Process getProcess()
          Gets the target process.
 ICDIRegisterGroup[] getRegisterGroups()
          Return the register groups.
 ICDIRuntimeOptions getRuntimeOptions()
          Returns the Runtime options for this target debug session.
 boolean isDisconnected()
          Returns whether this target is disconnected.
 boolean isTerminated()
          Returns whether this target is terminated.
 void jump(ICDILocation location)
          Deprecated.  
 void restart()
          Restarts the execution of this target.
 void resume()
          Deprecated.  
 void resume(boolean passSignal)
          Causes this target to resume its execution.
 void resume(ICDILocation location)
          Resume execution at location.
 void resume(ICDISignal signal)
          Resume execution where the program stopped but immediately give the signal.
 void runUntil(ICDILocation location)
          Deprecated.  
 void signal()
          Deprecated.  
 void signal(ICDISignal signal)
          Deprecated.  
 void stepInto()
          Deprecated.  
 void stepIntoInstruction()
          Deprecated.  
 void stepOver()
          Deprecated.  
 void stepOverInstruction()
          Deprecated.  
 void terminate()
          Causes this target to terminate.
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIThreadGroup
getCurrentThread, getThreads
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIBreakpointManagement
deleteAllBreakpoints, deleteBreakpoints, getBreakpoints, setAddressBreakpoint, setExceptionBreakpoint, setFunctionBreakpoint, setLineBreakpoint, setWatchpoint
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIExecuteStep
stepInto, stepIntoInstruction, stepOver, stepOverInstruction, stepUntil
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDISuspend
isSuspended, suspend
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDISignalManagement
getSignals
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIObject
getTarget
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIExpressionManagement
createExpression, destroyAllExpressions, destroyExpressions, getExpressions
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDISourceManagement
getInstructions, getInstructions, getInstructions, getMixedInstructions, getMixedInstructions, getMixedInstructions, getSourcePaths, setSourcePaths
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDISharedLibraryManagement
getSharedLibraries
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIMemoryBlockManagement
createMemoryBlock, getMemoryBlocks, removeAllBlocks, removeBlocks
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.ICDISessionObject
getSession
 

Method Detail

getProcess

Process getProcess()
Gets the target process.

Returns:
the output stream connected to the normal input of the target process.

getConfiguration

ICDITargetConfiguration getConfiguration()
Returns the configuration description of this debug session.

Returns:
the configuration description

evaluateExpressionToString

String evaluateExpressionToString(ICDIStackFrame context,
                                  String expressionText)
                                  throws CDIException
Evaluates the expression specified by the given string. Returns the evaluation result as a String.

Parameters:
- - expression string to be evaluated
Returns:
the result of the evaluation
Throws:
CDIException - if this method fails. Reasons include:

getGlobalVariableDescriptors

ICDIGlobalVariableDescriptor getGlobalVariableDescriptors(String filename,
                                                          String function,
                                                          String name)
                                                          throws CDIException
A static/global variable in a particular function or file, filename or/and function is the context for the static ICDIVariableDescriptor.
 hello.c:
   int bar;
   int main() {
        static int bar;
   }
 file.c:
   int foo() {
        static int bar;
   }
 getVariableObject(null, null, "bar");
 getVariableObject(null, "main", "bar");
 getVariableObject("file.c", "foo", "bar");
 

Parameters:
filename -
function -
name -
Returns:
ICDIGlobalVariableDescriptor
Throws:
CDIException

createGlobalVariable

ICDIGlobalVariable createGlobalVariable(ICDIGlobalVariableDescriptor varDesc)
                                        throws CDIException
Create a variable from the descriptor for evaluation. A CreatedEvent will be trigger and ChangedEvent will also be trigger when the variable is assign a new value. DestroyedEvent is fired when the variable is out of scope and automatically removed from the manager list.

Parameters:
varDesc - ICDIGlobalVariableDescriptor
Returns:
ICDIGlobalVariable
Throws:
CDIException

getRegisterGroups

ICDIRegisterGroup[] getRegisterGroups()
                                      throws CDIException
Return the register groups.

Returns:
ICDIRegisterGroup[]
Throws:
CDIException

createRegister

ICDIRegister createRegister(ICDIRegisterDescriptor varDesc)
                            throws CDIException
Create a variable from the descriptor for evaluation. A CreatedEvent will be trigger and ChangedEvent will also be trigger when the variable is assign a new value. DestroyedEvent is fired when the variable is out of scope and automatically removed from the manager list.

Parameters:
varDesc - ICDThreadStorageDesc
Returns:
Throws:
CDIException

isTerminated

boolean isTerminated()
Returns whether this target is terminated.

Returns:
whether this target is terminated

terminate

void terminate()
               throws CDIException
Causes this target to terminate.

Throws:
CDIException - if this method fails. Reasons include:

isDisconnected

boolean isDisconnected()
Returns whether this target is disconnected.

Returns:
whether this target is disconnected

disconnect

void disconnect()
                throws CDIException
Disconnects this target from the debuggable process. Generally, disconnecting ends a debug session with this target, but allows the debuggable program to continue running.

Throws:
CDIException - if this method fails. Reasons include:

restart

void restart()
             throws CDIException
Restarts the execution of this target.

Throws:
CDIException - if this method fails. Reasons include:

resume

void resume()
            throws CDIException
Deprecated. 

Equivalent to resume(false)

Throws:
CDIException - if this method fails. Reasons include:

stepOver

void stepOver()
              throws CDIException
Deprecated. 

Equivalent to stepOver(1)

Throws:
CDIException - if this method fails. Reasons include:
See Also:
ICDIExecuteStep.stepOver(int)

stepInto

void stepInto()
              throws CDIException
Deprecated. 

Equivalent to stepInto(1)

Throws:
CDIException - if this method fails. Reasons include:
See Also:
ICDIExecuteStep.stepInto(int)

stepOverInstruction

void stepOverInstruction()
                         throws CDIException
Deprecated. 

Equivalent to stepOverInstruction(1)

Throws:
CDIException - if this method fails. Reasons include:
See Also:
ICDIExecuteStep.stepOverInstruction(int)

stepIntoInstruction

void stepIntoInstruction()
                         throws CDIException
Deprecated. 

Equivalent to stepIntoInstruction(1)

Throws:
CDIException - if this method fails. Reasons include:
See Also:
ICDIExecuteStep.stepIntoInstruction(int)

runUntil

void runUntil(ICDILocation location)
              throws CDIException
Deprecated. 

Equivaltent to stepUntil(location)

Throws:
CDIException - if this method fails. Reasons include:
See Also:
ICDIExecuteStep.stepUntil(ICDILocation)

jump

void jump(ICDILocation location)
          throws CDIException
Deprecated. 

Equivalent to resume(location

Throws:
CDIException - if this method fails. Reasons include:
See Also:
#resume(ICDLocation)

signal

void signal()
            throws CDIException
Deprecated. 

Equivalent to resume(false)

Throws:
CDIException

signal

void signal(ICDISignal signal)
            throws CDIException
Deprecated. 

Equivalent to resume(signal)

Parameters:
signal -
Throws:
CDIException
See Also:
resume(ICDISignal)

getRuntimeOptions

ICDIRuntimeOptions getRuntimeOptions()
Returns the Runtime options for this target debug session.

Returns:
the configuration description

createCondition

ICDICondition createCondition(int ignoreCount,
                              String expression)
Return a ICDICondition


createCondition

ICDICondition createCondition(int ignoreCount,
                              String expression,
                              String[] threadIds)
Return a ICDICondition


createLineLocation

ICDILineLocation createLineLocation(String file,
                                    int line)
Returns a ICDILineLocation


createFunctionLocation

ICDIFunctionLocation createFunctionLocation(String file,
                                            String function)
Returns a ICDIFunctionLocation


createAddressLocation

ICDIAddressLocation createAddressLocation(BigInteger address)
Returns a ICDIAddressLocation


resume

void resume(boolean passSignal)
            throws CDIException
Causes this target to resume its execution. if passSignal is fase and the target was suspended by a signal when resuming the signal will be discarded Has no effect on a target that is not suspended.

Parameters:
passSignal - whether to discar the signal
Throws:
CDIException - if this method fails. Reasons include:

resume

void resume(ICDILocation location)
            throws CDIException
Resume execution at location. Note the method does not change stackframe. The result is undefined if it jumps outside of the stacframe. Can only be called when the associated target is suspended.

Parameters:
location -
Throws:
CDIException - if this method fails. Reasons include:

resume

void resume(ICDISignal signal)
            throws CDIException
Resume execution where the program stopped but immediately give the signal.

Parameters:
signal -
Throws:
CDIException

Eclipse CDT
Pre-release 3.0

Copyright (c) IBM Corp. and others 2004. All Rights Reserved.