Package com.intellij.codeInspection.dataFlow

Class DataFlowRunner

java.lang.Object

com.intellij.codeInspection.dataFlow.DataFlowRunner

Direct Known Subclasses:

TrackingRunner

public class DataFlowRunner
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DataFlowRunner.TimeStats

Constructor Summary

Constructors

Constructor and Description
DataFlowRunner(Project project)
DataFlowRunner(Project project, PsiElement context)
DataFlowRunner(Project project, PsiElement context, boolean unknownMembersAreNullable, boolean ignoreAssertions)

Method Summary

Modifier and Type	Method and Description
protected DfaInstructionState []	acceptInstruction(InstructionVisitor visitor, DfaInstructionState instructionState)
protected void	afterInstruction(Instruction instruction)
RunnerResult	analyzeBlockRecursively(PsiElement block, java.util.Collection<? extends DfaMemoryState> states, StandardInstructionVisitor visitor)
RunnerResult	analyzeCodeBlock(PsiCodeBlock block, InstructionVisitor visitor) Analyze given code-block without analyzing any parent and children context
RunnerResult	analyzeMethod(PsiElement psiBlock, InstructionVisitor visitor) Analyze this particular method (lambda, class initializer) without inlining this method into parent one.
RunnerResult	analyzeMethodRecursively(PsiElement block, StandardInstructionVisitor visitor)
RunnerResult	analyzeMethodWithInlining(PsiElement psiBlock, InstructionVisitor visitor) Analyze this particular method (lambda, class initializer) trying to inline it into outer scope if possible.
protected void	beforeInstruction(Instruction instruction)
protected ControlFlow	buildFlow(PsiElement psiBlock)
void	cancel() Call this method from the visitor to cancel analysis (e.g.
protected java.util.List<DfaInstructionState>	createInitialInstructionStates(PsiElement psiBlock, java.util.Collection<? extends DfaMemoryState> memStates, ControlFlow flow)
protected DfaMemoryState	createMemoryState()
protected DataFlowRunner.TimeStats	createStatistics()
void	forNestedClosures(java.util.function.BiConsumer<? super PsiElement,? super java.util.Collection<? extends DfaMemoryState>> consumer)
DfaValueFactory	getFactory()
Instruction	getInstruction(int index)
Instruction []	getInstructions()
protected RunnerResult	interpret(PsiElement psiBlock, InstructionVisitor visitor, ControlFlow flow, java.util.List<DfaInstructionState> startingStates)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataFlowRunner

public DataFlowRunner(Project project)

DataFlowRunner

public DataFlowRunner(Project project,
                      PsiElement context)

DataFlowRunner

public DataFlowRunner(Project project,
                      PsiElement context,
                      boolean unknownMembersAreNullable,
                      boolean ignoreAssertions)

Parameters:

project - current project

context - analysis context element (code block, class, expression, etc.); used to determine whether we can trust field initializers (e.g. we usually cannot if context is a constructor)

unknownMembersAreNullable - if true every parameter or method return value without nullity annotation is assumed to be nullable

ignoreAssertions - if true, assertion statements will be ignored, as if JVM is started with -da.

Method Detail

getFactory

public DfaValueFactory getFactory()

cancel

public final void cancel()

Call this method from the visitor to cancel analysis (e.g. if wanted fact is already established and subsequent analysis is useless). In this case RunnerResult.CANCELLED will be returned.

analyzeMethod

public final RunnerResult analyzeMethod(PsiElement psiBlock,
                                        InstructionVisitor visitor)

Analyze this particular method (lambda, class initializer) without inlining this method into parent one. E.g. if supplied method is a lambda within Stream API call chain, it still will be analyzed as separate method. On the other hand, inlining will normally work inside the supplied method.

Parameters:

psiBlock - method/lambda/class initializer body

visitor - a visitor to use

Returns:

result status

analyzeMethodWithInlining

public final RunnerResult analyzeMethodWithInlining(PsiElement psiBlock,
                                                    InstructionVisitor visitor)

Analyze this particular method (lambda, class initializer) trying to inline it into outer scope if possible. Usually inlining works, e.g. for lambdas inside stream API calls.

Parameters:

psiBlock - method/lambda/class initializer body

visitor - a visitor to use

Returns:

result status

analyzeCodeBlock

public final RunnerResult analyzeCodeBlock(PsiCodeBlock block,
                                           InstructionVisitor visitor)

Analyze given code-block without analyzing any parent and children context

Parameters:

block - block to analyze

visitor - visitor to use

Returns:

result status

buildFlow

protected final ControlFlow buildFlow(PsiElement psiBlock)

interpret

protected final RunnerResult interpret(PsiElement psiBlock,
                                       InstructionVisitor visitor,
                                       ControlFlow flow,
                                       java.util.List<DfaInstructionState> startingStates)

createInitialInstructionStates

protected java.util.List<DfaInstructionState> createInitialInstructionStates(PsiElement psiBlock,
                                                                             java.util.Collection<? extends DfaMemoryState> memStates,
                                                                             ControlFlow flow)

beforeInstruction

protected void beforeInstruction(Instruction instruction)

afterInstruction

protected void afterInstruction(Instruction instruction)

analyzeMethodRecursively

public RunnerResult analyzeMethodRecursively(PsiElement block,
                                             StandardInstructionVisitor visitor)

analyzeBlockRecursively

public RunnerResult analyzeBlockRecursively(PsiElement block,
                                            java.util.Collection<? extends DfaMemoryState> states,
                                            StandardInstructionVisitor visitor)

acceptInstruction

protected DfaInstructionState [] acceptInstruction(InstructionVisitor visitor,
                                                   DfaInstructionState instructionState)

createStatistics

protected DataFlowRunner.TimeStats createStatistics()

createMemoryState

protected DfaMemoryState createMemoryState()

getInstructions

public Instruction [] getInstructions()

getInstruction

public Instruction getInstruction(int index)

forNestedClosures

public void forNestedClosures(java.util.function.BiConsumer<? super PsiElement,? super java.util.Collection<? extends DfaMemoryState>> consumer)