Provides support for launching programs, breakpoint management, expression management, and debug events.
This package provides classes and interfaces to support facilities common among many debug architectures: launching programs, breakpoint management, expression management, and debug events. An extensible set of debug architectures and languages are supported by the definition of a "debug model" - a set of interfaces representing common artifacts in debuggable programs, which are defined in org.eclipse.debug.core.model. The debug plug-in itself does not provide an implementation of a debug model. It is intended that third parties providing an integrated set of development tools for a specific language will also implement a debug model for that language, using an underlying debug architecture of their choice. For example, Java development tooling provides an implementation of a debug model based on the standard Java Platform Debug Architecture (JPDA).
The debug platform defines and provides an implementation of the following managers:
- Launch Manager - The launch manager maintains the set of registered launches - that is, a collection of programs that have been launched in debuggable or non-debuggable (run) mode. Each launch contains its associated debug targets and system processes. A launch that represents a debuggable program may specify an associated source locator used to locate source elements associated with stack frames for a particular debug session. Clients may provide implementations of source locators, which are generally tied to the manner in which a program is launched.
- Breakpoint Manager - The breakpoint manager maintains, persists, and restores the collection of all registered breakpoints in the workspace. As well, it provides change notification for breakpoints.
- Expression Manager - The expression manager maintains a collection of registered expressions. Expressions are not automatically persisted, but a client could persist its own expressions if required.
A launch configuration is a persistable description of how to launch an application. Each launch configuration is an instance of a type of launch configuration - for example, a Java Application. The debug plug-in defines a launch configuration type extension point that clients can contribute to. A launch configuration is a set of attributes describing how to launch a program. The launching of an application is performed by an associated implementation of a launch configuration delegate, contributed by each launch configuration type extension.
A launch configuration may be stored as a file in the worksapce (and shared in a repository via standard team mechanisms), or may be stored locally, essentially making the launch configuration private for a single user.
New Features in the Debug Platform, Eclipse 3.0
Extensible Launch Modes
The debug platform supports an extensible set of launch modes. Prior releases only supported two launch modes - run and debug. The debug platform defines an extension point for contributing new launch modes (
org.eclipse.debug.core.launchModes), and contributes three basic launch modes itself: run, debug, and profile. The launch manager has API to retrieve all launch modes, and a human readable label for each launch mode.
The debug platform has an extension point to support the contribution of a launch delegate for a specific launch configuration type and launch mode -
org.eclipse.debug.core.launchDelegates. This allows launch configurations to be extended by third parties, to support new launch modes. For example, a client could contribute a launch delegate that launches a Java Application in profile mode (currently, the SDK does not provide a Java profiler).
For backwards compatibility, the launch delegate supplied by a launch configuration type extension is used for the launch modes specified by the launch configuration type. A launch delegate supplied for a specific mode, is used only for that mode.
Extensible Debug Events
The debug platform supports an extensible set of debug events. A debug event kind of
MODEL_SPECIFIChas been added to indicate an application specific debug event. When a debug event of kind
MODEL_SPECIFICis created, the detail code in the event is client defined. The source of the event (debug element that generated the event) identifies the debug model from which the event was generated. The debug platform and user interface ignores model specific debug events.
A data field has been added to debug events to allow clients to store application specific data in debug events.
The debug platform provides an extension point (
org.eclipse.debug.core.processFactories) for contributing process factories. A process factory can be used to override default process creation for a launch configuration when the debug plug-in creates a new process. A launch configuration can specify a process factory to use when creating a process, via the launch configuration attribute
Launch Termination Notification
The debug platform provides a mechanism for launch listeners to be notified when a launch terminates. A launch is a container of processes and debug targets. When all of the contained targets and processes terminate, a terminate notification is sent to those listeners implementing
Breakpoint Manager Enablement
The breakpoint manager defines the methods
isEnabled(). When the breakpoint manager is disabled, debuggers should ignore all registered breakpoints. The debug platform also provides a new listener mechanism,
IBreakpointManagerListenerwhich allows clients to register with the breakpoint manager to be notified when its enablement changes.
Interface Summary Interface Description IBinaryStreamListenerA stream listener is notified of changes to a binary stream monitor. IBreakpointListenerA breakpoint listener is notified of breakpoint additions, removals, and changes. IBreakpointManagerThe breakpoint manager manages the collection of breakpoints in the workspace. IBreakpointManagerListenerA breakpoint manager listener is notified when the breakpoint manager's enablement changes. IBreakpointsListenerA breakpoints listener is notified of breakpoint additions, removals, and changes. IDebugEventFilterAn event filter allows clients to intercept debug events. IDebugEventSetListenerA debug event set listener registers with the debug plug-in to receive event notification from programs being run or debugged. IExpressionListenerAn expression listener is notified of expression additions, removals, and changes. IExpressionManagerThe expression manager manages the collection of registered expressions in the workspace. IExpressionsListenerAn expression listener is notified of expression additions, removals, and changes. ILaunchA launch is the result of launching a debug session and/or one or more system processes. ILaunchConfigurationA launch configuration describes how to launch an application. ILaunchConfigurationListenerNotified when a launch configuration is created, deleted, or changed. ILaunchConfigurationMigrationDelegateResponsible for migrating launch configurations between different versions of Eclipse. ILaunchConfigurationTypeDescribes and creates instances of a specific type of launch configuration. ILaunchConfigurationWorkingCopyAn editable copy of a launch configuration. ILaunchDelegateA proxy to an
ILaunchesListenerA launches listener is notified of launches as they are added and removed from the launch manager. ILaunchesListener2Enhancements to the launches listener interface. ILaunchListenerA launch listener is notified of launches as they are added and removed from the launch manager. ILaunchManagerThe launch manager manages the set of registered launches, maintaining a collection of active processes and debug targets. ILaunchModeA launch mode. ILogicalStructureProviderProvides logical structure types applicable to a raw implementation value from a debug model. ILogicalStructureTypeProvides a value representing the logical structure of a raw implementation value from a debug model. IMemoryBlockListenerA memory block listener is notified of the addition and removal of memory blocks with the memory block manager. IMemoryBlockManagerManages registered memory blocks in the workspace. IProcessFactoryA process factory is used to override default process (
IProcess) creation by the debug plug-in, and can be contributed via plug-in XML.
IPrototypeAttributesLabelProviderA prototype attributes label provider is contributed as an optional attribute of a
launchConfigurationTypeextension and is responsible for displaying launch configurations prototype attributes of that type.
IRequestCommon base interface for an asynchronously processed request. IStatusHandlerA status handler registers to handle a specific status - error or otherwise. IStreamListenerA stream listener is notified of changes to a stream monitor.
Class Summary Class Description DebugEventA debug event describes an event in a program being debugged or in a running process. DebugPluginThere is one instance of the debug plug-in available from
LaunchA launch is the result of launching a debug session and/or one or more system processes. RefreshUtilUtilities for launch configurations that persist, restore, and refresh collections of resources.
Exception Summary Exception Description DebugExceptionA checked exception representing a failure.