Package com.intellij.xdebugger

Interface XDebugSession

All Superinterfaces:

AbstractDebuggerSession

All Known Implementing Classes:

XDebugSessionImpl

public interface XDebugSession
extends AbstractDebuggerSession

Instances of this class are created by the debugging subsystem when XDebuggerManager.startSession(com.intellij.execution.runners.ExecutionEnvironment, com.intellij.xdebugger.XDebugProcessStarter) or XDebuggerManager.startSessionAndShowTab(java.lang.String, com.intellij.execution.ui.RunContentDescriptor, com.intellij.xdebugger.XDebugProcessStarter) method is called. It isn't supposed to be implemented by a plugin.

Instance of this class can be obtained from XDebugProcess.getSession() method and used to control debugging process

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<XDebugSession>	DATA_KEY

Method Summary

Modifier and Type	Method and Description
void	addSessionListener(XDebugSessionListener listener)
void	addSessionListener(XDebugSessionListener listener, Disposable parentDisposable)
boolean	areBreakpointsMuted()
boolean	breakpointReached(XBreakpoint<?> breakpoint, java.lang.String evaluatedLogExpression, XSuspendContext suspendContext) Call this method when a breakpoint is reached if its condition (XBreakpoint.getCondition()) evaluates to true.
boolean	breakpointReached(XBreakpoint<?> breakpoint, XSuspendContext suspendContext) Deprecated. use breakpointReached(XBreakpoint, String, XSuspendContext) instead
void	forceStepInto()
ConsoleView	getConsoleView()
XSourcePosition	getCurrentPosition() Position from the current frame
XStackFrame	getCurrentStackFrame()
XDebugProcess	getDebugProcess()
Project	getProject()
RunContentDescriptor	getRunContentDescriptor()
RunProfile	getRunProfile()
java.lang.String	getSessionName()
XSuspendContext	getSuspendContext()
XSourcePosition	getTopFramePosition() Position from the top frame
RunnerLayoutUi	getUI()
void	initBreakpoints()
boolean	isSuspended()
void	pause()
void	positionReached(XSuspendContext suspendContext) Call this method when position is reached (e.g.
void	rebuildViews()
void	removeSessionListener(XDebugSessionListener listener)
void	reportError(java.lang.String message)
void	reportMessage(java.lang.String message, MessageType type)
void	reportMessage(java.lang.String message, MessageType type, javax.swing.event.HyperlinkListener listener)
void	resume()
void	runToPosition(XSourcePosition position, boolean ignoreBreakpoints)
void	sessionResumed() Call this method when session resumed because of some external event, e.g.
void	setBreakpointInvalid(XLineBreakpoint<?> breakpoint, java.lang.String errorMessage) Marks the provide breakpoint as invalid in the current session
void	setBreakpointMuted(boolean muted)
void	setBreakpointVerified(XLineBreakpoint<?> breakpoint) Marks the provide breakpoint as verified in the current session
default void	setCurrentStackFrame(XExecutionStack executionStack, XStackFrame frame)
void	setCurrentStackFrame(XExecutionStack executionStack, XStackFrame frame, boolean isTopFrame)
void	setPauseActionSupported(boolean isSupported)
void	showExecutionPoint()
<V extends XSmartStepIntoVariant> void	smartStepInto(XSmartStepIntoHandler<V> handler, V variant)
void	stepInto()
void	stepOut()
void	stepOver(boolean ignoreBreakpoints)
void	stop()
void	updateBreakpointPresentation(XLineBreakpoint<?> breakpoint, javax.swing.Icon icon, java.lang.String errorMessage) Call this method to setup custom icon and/or error message (it will be shown in tooltip) for breakpoint.
void	updateExecutionPosition()

Methods inherited from interface com.intellij.xdebugger.AbstractDebuggerSession

isPaused, isStopped

Field Detail

DATA_KEY

static final DataKey<XDebugSession> DATA_KEY

Method Detail

getProject

Project getProject()

getDebugProcess

XDebugProcess getDebugProcess()

isSuspended

boolean isSuspended()

getCurrentStackFrame

XStackFrame getCurrentStackFrame()

getSuspendContext

XSuspendContext getSuspendContext()

getCurrentPosition

XSourcePosition getCurrentPosition()

Position from the current frame

Returns:

getTopFramePosition

XSourcePosition getTopFramePosition()

Position from the top frame

Returns:

stepOver

void stepOver(boolean ignoreBreakpoints)

stepInto

void stepInto()

stepOut

void stepOut()

forceStepInto

void forceStepInto()

runToPosition

void runToPosition(XSourcePosition position,
                   boolean ignoreBreakpoints)

pause

void pause()

resume

void resume()

showExecutionPoint

void showExecutionPoint()

setCurrentStackFrame

void setCurrentStackFrame(XExecutionStack executionStack,
                          XStackFrame frame,
                          boolean isTopFrame)

setCurrentStackFrame

default void setCurrentStackFrame(XExecutionStack executionStack,
                                  XStackFrame frame)

updateBreakpointPresentation

void updateBreakpointPresentation(XLineBreakpoint<?> breakpoint,
                                  javax.swing.Icon icon,
                                  java.lang.String errorMessage)

Call this method to setup custom icon and/or error message (it will be shown in tooltip) for breakpoint. Usually in your breakpoint handler you need setBreakpointVerified(XLineBreakpoint) or setBreakpointInvalid(XLineBreakpoint, String) instead.

Parameters:

breakpoint - breakpoint

icon - icon (null if default icon should be used). You can use icons from AllIcons.Debugger

errorMessage - an error message if breakpoint isn't successfully registered

See Also:

setBreakpointVerified(XLineBreakpoint)~, setBreakpointInvalid(XLineBreakpoint, String)

setBreakpointVerified

void setBreakpointVerified(XLineBreakpoint<?> breakpoint)

Marks the provide breakpoint as verified in the current session

setBreakpointInvalid

void setBreakpointInvalid(XLineBreakpoint<?> breakpoint,
                          java.lang.String errorMessage)

Marks the provide breakpoint as invalid in the current session

breakpointReached

boolean breakpointReached(XBreakpoint<?> breakpoint,
                          java.lang.String evaluatedLogExpression,
                          XSuspendContext suspendContext)

Call this method when a breakpoint is reached if its condition (XBreakpoint.getCondition()) evaluates to true.

The underlying debugging process should be suspended only if the method returns true.

Parameters:

breakpoint - reached breakpoint

evaluatedLogExpression - value of XBreakpoint.getLogExpression() evaluated in the current context

suspendContext - context

Returns:

true if the debug process should be suspended

breakpointReached

@Deprecated
boolean breakpointReached(XBreakpoint<?> breakpoint,
                          XSuspendContext suspendContext)

Deprecated. use breakpointReached(XBreakpoint, String, XSuspendContext) instead

positionReached

void positionReached(XSuspendContext suspendContext)

Call this method when position is reached (e.g. after "Run to cursor" or "Step over" command)

Parameters:

suspendContext - context

sessionResumed

void sessionResumed()

Call this method when session resumed because of some external event, e.g. from the debugger console

stop

void stop()

setBreakpointMuted

void setBreakpointMuted(boolean muted)

areBreakpointsMuted

boolean areBreakpointsMuted()

addSessionListener

void addSessionListener(XDebugSessionListener listener,
                        Disposable parentDisposable)

addSessionListener

void addSessionListener(XDebugSessionListener listener)

removeSessionListener

void removeSessionListener(XDebugSessionListener listener)

reportError

void reportError(java.lang.String message)

reportMessage

void reportMessage(java.lang.String message,
                   MessageType type)

reportMessage

void reportMessage(java.lang.String message,
                   MessageType type,
                   javax.swing.event.HyperlinkListener listener)

getSessionName

java.lang.String getSessionName()

getRunContentDescriptor

RunContentDescriptor getRunContentDescriptor()

getRunProfile

RunProfile getRunProfile()

setPauseActionSupported

void setPauseActionSupported(boolean isSupported)

rebuildViews

void rebuildViews()

smartStepInto

<V extends XSmartStepIntoVariant> void smartStepInto(XSmartStepIntoHandler<V> handler,
                                                     V variant)

updateExecutionPosition

void updateExecutionPosition()

initBreakpoints

void initBreakpoints()

getConsoleView

ConsoleView getConsoleView()

getUI

RunnerLayoutUi getUI()