XDebugProcess (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.xdebugger.XDebugProcess

Direct Known Subclasses:

JavaDebugProcess, PyDebugProcess, XsltDebugProcess
```
public abstract class XDebugProcess
extends java.lang.Object
```
Extends this class to provide debugging capabilities for custom language/framework. In order to start debugger by 'Debug' action for a specific run configuration implement ProgramRunner and call XDebuggerManager.startSession(com.intellij.execution.runners.ExecutionEnvironment, com.intellij.xdebugger.XDebugProcessStarter) from ProgramRunner.execute(ExecutionEnvironment) method Otherwise use method XDebuggerManager.startSessionAndShowTab(java.lang.String, com.intellij.execution.ui.RunContentDescriptor, com.intellij.xdebugger.XDebugProcessStarter) to start new debugging session

Constructor Summary

Constructors
Modifier Constructor and Description

protected XDebugProcess(XDebugSession session)

Constructors
Modifier	Constructor and Description
`protected`	`XDebugProcess(XDebugSession session)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`checkCanInitBreakpoints()` Check is it is possible to init breakpoints.
`boolean`	`checkCanPerformCommands()` Check is it is possible to perform commands such as resume, step etc.
`ExecutionConsole`	`createConsole()`
`XDebugTabLayouter`	`createTabLayouter()` Override this method to customize content of tab in 'Debug' tool window
`XValueMarkerProvider<?,?>`	`createValueMarkerProvider()` Override this method to enable 'Mark Object' action
`boolean`	`dependsOnPlugin(IdeaPluginDescriptor descriptor)`
`protected ProcessHandler`	`doGetProcessHandler()`
`XBreakpointHandler<?> []`	`getBreakpointHandlers()`
`javax.swing.event.HyperlinkListener`	`getCurrentStateHyperlinkListener()`
`java.lang.String`	`getCurrentStateMessage()`
`abstract XDebuggerEditorsProvider`	`getEditorsProvider()`
`XDebuggerEvaluator`	`getEvaluator()`
`ProcessHandler`	`getProcessHandler()`
`XDebugSession`	`getSession()`
`XSmartStepIntoHandler<?>`	`getSmartStepIntoHandler()` Implement `XSmartStepIntoHandler` and return its instance from this method to enable Smart Step Into action
`boolean`	`isLibraryFrameFilterSupported()` Is "isShowLibraryStackFrames" setting respected.
`boolean`	`isValuesCustomSorted()` Add or not SortValuesAction (alphabetically sort)
`void`	`logStack(XSuspendContext suspendContext, XDebugSession session)` Called to log the stacktrace on breakpoint hit if `XBreakpoint.isLogStack()` is true
`void`	`registerAdditionalActions(DefaultActionGroup leftToolbar, DefaultActionGroup topToolbar, DefaultActionGroup settings)` Override this method to provide additional actions in 'Debug' tool window
`void`	`resume()` Deprecated. Use `resume(XSuspendContext)` instead
`void`	`resume(XSuspendContext context)` Resume execution.
`void`	`runToPosition(XSourcePosition position)` Deprecated. Use `runToPosition(XSourcePosition, XSuspendContext)` instead
`void`	`runToPosition(XSourcePosition position, XSuspendContext context)` Resume execution and call `XDebugSession.positionReached(XSuspendContext)` when `position` is reached.
`void`	`sessionInitialized()` Called when `XDebugSession` is initialized and breakpoints are registered in `XBreakpointHandler`
`void`	`startForceStepInto()` Deprecated. Use `startForceStepInto(XSuspendContext)` instead
`void`	`startForceStepInto(XSuspendContext context)` Steps into suppressed call
`void`	`startPausing()` Interrupt debugging process and call `XDebugSession.positionReached(com.intellij.xdebugger.frame.XSuspendContext)` when next line in current method/function is reached.
`void`	`startStepInto()` Deprecated. Use `startStepInto(XSuspendContext)` instead
`void`	`startStepInto(XSuspendContext context)` Resume execution and call `XDebugSession.positionReached(com.intellij.xdebugger.frame.XSuspendContext)` when next line is reached.
`void`	`startStepOut()` Deprecated. Use `startStepOut(XSuspendContext)` instead
`void`	`startStepOut(XSuspendContext context)` Resume execution and call `XDebugSession.positionReached(com.intellij.xdebugger.frame.XSuspendContext)` after returning from current method/function.
`void`	`startStepOver()` Deprecated. Use `startStepOver(XSuspendContext)` instead
`void`	`startStepOver(XSuspendContext context)` Resume execution and call `XDebugSession.positionReached(com.intellij.xdebugger.frame.XSuspendContext)` when next line in current method/function is reached.
`void`	`stop()` Stop debugging and dispose resources.
`Promise<java.lang.Object>`	`stopAsync()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XDebugProcess
```
protected XDebugProcess(XDebugSession session)
```
    Parameters:
    
    session - pass session parameter of XDebugProcessStarter.start(com.intellij.xdebugger.XDebugSession) method to this constructor
- Method Detail
  - getSession
```
public final XDebugSession getSession()
```
  - getBreakpointHandlers
```
public XBreakpointHandler<?> [] getBreakpointHandlers()
```
    Returns:
    
    breakpoint handlers which will be used to set/clear breakpoints in the underlying debugging process
  - getEditorsProvider
```
public abstract XDebuggerEditorsProvider getEditorsProvider()
```
    Returns:
    
    editor provider which will be used to produce editors for "Evaluate" and "Set Value" actions
  - sessionInitialized
```
public void sessionInitialized()
```
    Called when XDebugSession is initialized and breakpoints are registered in XBreakpointHandler
  - startPausing
```
public void startPausing()
```
    Interrupt debugging process and call XDebugSession.positionReached(com.intellij.xdebugger.frame.XSuspendContext) when next line in current method/function is reached. Do not call this method directly. Use XDebugSession.pause() instead
  - startStepOver
```
@Deprecated
public void startStepOver()
```
    Deprecated. Use startStepOver(XSuspendContext) instead
  - startStepOver
```
public void startStepOver(XSuspendContext context)
```
    Resume execution and call XDebugSession.positionReached(com.intellij.xdebugger.frame.XSuspendContext) when next line in current method/function is reached. Do not call this method directly. Use XDebugSession.stepOver(boolean) instead
  - startForceStepInto
```
@Deprecated
public void startForceStepInto()
```
    Deprecated. Use startForceStepInto(XSuspendContext) instead
  - startForceStepInto
```
public void startForceStepInto(XSuspendContext context)
```
    Steps into suppressed call
    Resume execution and call XDebugSession.positionReached(com.intellij.xdebugger.frame.XSuspendContext) when next line is reached. Do not call this method directly. Use XDebugSession.forceStepInto() instead
  - startStepInto
```
@Deprecated
public void startStepInto()
```
    Deprecated. Use startStepInto(XSuspendContext) instead
  - startStepInto
```
public void startStepInto(XSuspendContext context)
```
    Resume execution and call XDebugSession.positionReached(com.intellij.xdebugger.frame.XSuspendContext) when next line is reached. Do not call this method directly. Use XDebugSession.stepInto() instead
  - startStepOut
```
@Deprecated
public void startStepOut()
```
    Deprecated. Use startStepOut(XSuspendContext) instead
  - startStepOut
```
public void startStepOut(XSuspendContext context)
```
    Resume execution and call XDebugSession.positionReached(com.intellij.xdebugger.frame.XSuspendContext) after returning from current method/function. Do not call this method directly. Use XDebugSession.stepOut() instead
  - getSmartStepIntoHandler
```
public XSmartStepIntoHandler<?> getSmartStepIntoHandler()
```
    Implement XSmartStepIntoHandler and return its instance from this method to enable Smart Step Into action
    
    Returns:
    
    XSmartStepIntoHandler instance
  - stop
```
public void stop()
```
    Stop debugging and dispose resources. Do not call this method directly. Use XDebugSession.stop() instead
  - stopAsync
```
public Promise<java.lang.Object> stopAsync()
```
  - resume
```
@Deprecated
public void resume()
```
    Deprecated. Use resume(XSuspendContext) instead
  - resume
```
public void resume(XSuspendContext context)
```
    Resume execution. Do not call this method directly. Use XDebugSession.resume() instead
  - runToPosition
```
@Deprecated
public void runToPosition(XSourcePosition position)
```
    Deprecated. Use runToPosition(XSourcePosition, XSuspendContext) instead
  - runToPosition
```
public void runToPosition(XSourcePosition position,
                          XSuspendContext context)
```
    Resume execution and call XDebugSession.positionReached(XSuspendContext) when position is reached. Do not call this method directly. Use XDebugSession.runToPosition(com.intellij.xdebugger.XSourcePosition, boolean) instead
    
    Parameters:
    
    position - position in source code
  - checkCanPerformCommands
```
public boolean checkCanPerformCommands()
```
    Check is it is possible to perform commands such as resume, step etc. And notify user if necessary
    
    Returns:
    
    true if process can actually perform user requests at this moment
  - checkCanInitBreakpoints
```
public boolean checkCanInitBreakpoints()
```
    Check is it is possible to init breakpoints. Otherwise you should call XDebugSession.initBreakpoints() at the appropriate time
  - doGetProcessHandler
```
protected ProcessHandler doGetProcessHandler()
```
  - getProcessHandler
```
public final ProcessHandler getProcessHandler()
```
  - createConsole
```
public ExecutionConsole createConsole()
```
  - createValueMarkerProvider
```
public XValueMarkerProvider<?,?> createValueMarkerProvider()
```
    Override this method to enable 'Mark Object' action
    
    Returns:
    
    new instance of XValueMarkerProvider's implementation or null if 'Mark Object' feature isn't supported
  - registerAdditionalActions
```
public void registerAdditionalActions(DefaultActionGroup leftToolbar,
                                      DefaultActionGroup topToolbar,
                                      DefaultActionGroup settings)
```
    Override this method to provide additional actions in 'Debug' tool window
  - getCurrentStateMessage
```
public java.lang.String getCurrentStateMessage()
```
    Returns:
    
    message to show in Variables View when debugger isn't paused
  - getCurrentStateHyperlinkListener
```
public javax.swing.event.HyperlinkListener getCurrentStateHyperlinkListener()
```
  - createTabLayouter
```
public XDebugTabLayouter createTabLayouter()
```
    Override this method to customize content of tab in 'Debug' tool window
  - isValuesCustomSorted
```
public boolean isValuesCustomSorted()
```
    Add or not SortValuesAction (alphabetically sort)
  - getEvaluator
```
public XDebuggerEvaluator getEvaluator()
```
  - isLibraryFrameFilterSupported
```
public boolean isLibraryFrameFilterSupported()
```
    Is "isShowLibraryStackFrames" setting respected. If true, ShowLibraryFramesAction will be shown, for example.
  - logStack
```
public void logStack(XSuspendContext suspendContext,
                     XDebugSession session)
```
    Called to log the stacktrace on breakpoint hit if XBreakpoint.isLogStack() is true
  - dependsOnPlugin
```
public boolean dependsOnPlugin(IdeaPluginDescriptor descriptor)
```

Class XDebugProcess

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XDebugProcess

Method Detail

getSession

getBreakpointHandlers

getEditorsProvider

sessionInitialized

startPausing

startStepOver

startStepOver

startForceStepInto

startForceStepInto

startStepInto

startStepInto

startStepOut

startStepOut

getSmartStepIntoHandler

stop

stopAsync

resume

resume

runToPosition

runToPosition

checkCanPerformCommands

checkCanInitBreakpoints

doGetProcessHandler

getProcessHandler

createConsole

createValueMarkerProvider

registerAdditionalActions

getCurrentStateMessage

getCurrentStateHyperlinkListener

createTabLayouter

isValuesCustomSorted

getEvaluator

isLibraryFrameFilterSupported

logStack

dependsOnPlugin