Package com.intellij.xdebugger.evaluation

Class XDebuggerEvaluator

java.lang.Object

com.intellij.xdebugger.evaluation.XDebuggerEvaluator

Direct Known Subclasses:

JavaDebuggerEvaluator, PyDebuggerEvaluator

public abstract class XDebuggerEvaluator
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XDebuggerEvaluator.XEvaluationCallback

Constructor Summary

Constructors

Constructor and Description
XDebuggerEvaluator()

Method Summary

Modifier and Type	Method and Description
abstract void	evaluate(java.lang.String expression, XDebuggerEvaluator.XEvaluationCallback callback, XSourcePosition expressionPosition) Start evaluating expression.
void	evaluate(XExpression expression, XDebuggerEvaluator.XEvaluationCallback callback, XSourcePosition expressionPosition) Start evaluating expression.
java.lang.String	formatTextForEvaluation(java.lang.String text) Override this method to format selected text before it is shown in 'Evaluate' dialog
EvaluationMode	getEvaluationMode(java.lang.String text, int startOffset, int endOffset, PsiFile psiFile) Returns mode which should be used to evaluate the text
ExpressionInfo	getExpressionInfoAtOffset(Project project, Document document, int offset, boolean sideEffectsAllowed)
Promise<ExpressionInfo>	getExpressionInfoAtOffsetAsync(Project project, Document document, int offset, boolean sideEffectsAllowed) Async version of getExpressionInfoAtOffset(Project, Document, int, boolean).
TextRange	getExpressionRangeAtOffset(Project project, Document document, int offset, boolean sideEffectsAllowed) Return text range of expression which can be evaluated.
<T> Promise<T>	getWhenDataIsReady(Editor editor, T data)
boolean	isCodeFragmentEvaluationSupported() If this method returns true 'Code Fragment Mode' button will be shown in 'Evaluate' dialog allowing user to execute a set of statements

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XDebuggerEvaluator

public XDebuggerEvaluator()

Method Detail

evaluate

public abstract void evaluate(java.lang.String expression,
                              XDebuggerEvaluator.XEvaluationCallback callback,
                              XSourcePosition expressionPosition)

Start evaluating expression.

Parameters:

expression - expression to evaluate

callback - used to notify that the expression has been evaluated or an error occurs

evaluate

public void evaluate(XExpression expression,
                     XDebuggerEvaluator.XEvaluationCallback callback,
                     XSourcePosition expressionPosition)

Start evaluating expression.

Parameters:

expression - expression to evaluate

callback - used to notify that the expression has been evaluated or an error occurs

expressionPosition - position where this expression should be evaluated

isCodeFragmentEvaluationSupported

public boolean isCodeFragmentEvaluationSupported()

If this method returns true 'Code Fragment Mode' button will be shown in 'Evaluate' dialog allowing user to execute a set of statements

Returns:

true if debugger supports evaluation of code fragments (statements)

getExpressionRangeAtOffset

public TextRange getExpressionRangeAtOffset(Project project,
                                            Document document,
                                            int offset,
                                            boolean sideEffectsAllowed)

Return text range of expression which can be evaluated.

Parameters:

project - project

document - document

offset - offset

sideEffectsAllowed - if this parameter is false, the expression should not have any side effects when evaluated (such expressions are evaluated in quick popups)

Returns:

text range of expression

getExpressionInfoAtOffset

public ExpressionInfo getExpressionInfoAtOffset(Project project,
                                                Document document,
                                                int offset,
                                                boolean sideEffectsAllowed)

Parameters:

project - project

document - document

offset - offset

sideEffectsAllowed - if this parameter is false, the expression should not have any side effects when evaluated (such expressions are evaluated in quick popups)

Returns:

ExpressionInfo of expression which can be evaluated

getExpressionInfoAtOffsetAsync

public Promise<ExpressionInfo> getExpressionInfoAtOffsetAsync(Project project,
                                                              Document document,
                                                              int offset,
                                                              boolean sideEffectsAllowed)

Async version of getExpressionInfoAtOffset(Project, Document, int, boolean). Overload this method if you cannot evaluate ExpressionInfo in sync way. The value of the resulting Promise can be null

formatTextForEvaluation

public java.lang.String formatTextForEvaluation(java.lang.String text)

Override this method to format selected text before it is shown in 'Evaluate' dialog

getWhenDataIsReady

public <T> Promise<T> getWhenDataIsReady(Editor editor,
                                         T data)

getEvaluationMode

public EvaluationMode getEvaluationMode(java.lang.String text,
                                        int startOffset,
                                        int endOffset,
                                        PsiFile psiFile)

Returns mode which should be used to evaluate the text