de.uka.ilkd.key.symbolic_execution.strategy

Class BreakpointStopCondition

java.lang.Object

de.uka.ilkd.key.symbolic_execution.strategy.BreakpointStopCondition

All Implemented Interfaces:

StopCondition, IBreakpointStopCondition

public class BreakpointStopCondition
extends java.lang.Object
implements IBreakpointStopCondition

An IBreakpointStopCondition which can be used during proof.

Author:

Martin Hentschel

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	breakpointHit Indicates that a breakpoint is hit.
private java.util.Set<IBreakpoint>	breakpoints The used IBreakpoints.

Constructor Summary

Constructors

Constructor and Description
BreakpointStopCondition(IBreakpoint... breakpoints) Creates a new BreakpointStopCondition.

Method Summary

Modifier and Type	Method and Description
void	addBreakpoint(IBreakpoint breakpoint) Adds a new IBreakpoint.
java.util.Set<IBreakpoint>	getBreakpoints() Returns all available IBreakpoints.
java.lang.String	getGoalNotAllowedMessage(int maxApplications, long timeout, Proof proof, long startTime, int countApplied, Goal goal) Returns the reason why the previous check via #isGoalAllowed(ApplyStrategy, int, long, Proof, GoalChooser, long, int, Goal) has stopped the apply strategy.
int	getMaximalWork(int maxApplications, long timeout, Proof proof) Returns the maximal amount of work needed to complete the task, used to display a progress bar.
java.lang.String	getStopMessage(int maxApplications, long timeout, Proof proof, long startTime, int countApplied, SingleRuleApplicationInfo singleRuleApplicationInfo) Returns a human readable message which explains why the previous #shouldStop(ApplyStrategy, Proof, GoalChooser, long, int, SingleRuleApplicationInfo) has stopped the strategy.
protected boolean	isBreakpointHit(SourceElement activeStatement, RuleApp ruleApp, Proof proof, Node node) Checks if a breakpoint is hit.
boolean	isGoalAllowed(int maxApplications, long timeout, Proof proof, long startTime, int countApplied, Goal goal) Checks if it is allowed to apply the next rule on the selected Goal chosen by the GoalChooser before it is applied.
void	removeBreakpoint(IBreakpoint breakpoint) Removes an IBreakpoint.
boolean	shouldStop(int maxApplications, long timeout, Proof proof, long startTime, int countApplied, SingleRuleApplicationInfo singleRuleApplicationInfo) Checks after each applied rule if more rules should be applied or if the strategy should stop.

Methods inherited from class java.lang.Object

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

Field Detail

breakpoints

private final java.util.Set<IBreakpoint> breakpoints

The used IBreakpoints.

breakpointHit

private boolean breakpointHit

Indicates that a breakpoint is hit.

Constructor Detail

BreakpointStopCondition

public BreakpointStopCondition(IBreakpoint... breakpoints)

Creates a new BreakpointStopCondition.

Parameters:

breakpoints - The IBreakpoint to use.

Method Detail

getMaximalWork

public int getMaximalWork(int maxApplications,
                          long timeout,
                          Proof proof)

Returns the maximal amount of work needed to complete the task, used to display a progress bar. Pass 0 to indicate unknown size.

Specified by:

getMaximalWork in interface StopCondition

Parameters:

maxApplications - The defined maximal number of rules to apply. Can be different to StrategySettings.getMaxSteps() in side proofs.

timeout - The defined timeout in ms or -1 if disabled. Can be different to StrategySettings.getTimeout() in side proofs.

proof - The current Proof.

Returns:

The maximal amount of work or 0 if it is unknown.

isGoalAllowed

public boolean isGoalAllowed(int maxApplications,
                             long timeout,
                             Proof proof,
                             long startTime,
                             int countApplied,
                             Goal goal)

Checks if it is allowed to apply the next rule on the selected Goal chosen by the GoalChooser before it is applied. If it is not allowed the apply strategy will stop.

Specified by:

isGoalAllowed in interface StopCondition

Parameters:

maxApplications - The defined maximal number of rules to apply. Can be different to StrategySettings.getMaxSteps() in side proofs.

timeout - The defined timeout in ms or -1 if disabled. Can be different to StrategySettings.getTimeout() in side proofs.

proof - The current Proof.

startTime - The timestamp when the apply strategy has started, computed via System.currentTimeMillis()

countApplied - The number of already applied rules.

goal - The current Goal on which the next rule will be applied.

Returns:

true rule application is allowed, false rule application is not allowed so stop apply strategy

getGoalNotAllowedMessage

public java.lang.String getGoalNotAllowedMessage(int maxApplications,
                                                 long timeout,
                                                 Proof proof,
                                                 long startTime,
                                                 int countApplied,
                                                 Goal goal)

Returns the reason why the previous check via #isGoalAllowed(ApplyStrategy, int, long, Proof, GoalChooser, long, int, Goal) has stopped the apply strategy.

Specified by:

getGoalNotAllowedMessage in interface StopCondition

Parameters:

maxApplications - The defined maximal number of rules to apply. Can be different to StrategySettings.getMaxSteps() in side proofs.

timeout - The defined timeout in ms or -1 if disabled. Can be different to StrategySettings.getTimeout() in side proofs.

proof - The current Proof.

startTime - The timestamp when the apply strategy has started, computed via System.currentTimeMillis()

countApplied - The number of already applied rules.

goal - The current Goal on which the next rule will be applied.

Returns:

shouldStop

public boolean shouldStop(int maxApplications,
                          long timeout,
                          Proof proof,
                          long startTime,
                          int countApplied,
                          SingleRuleApplicationInfo singleRuleApplicationInfo)

Checks after each applied rule if more rules should be applied or if the strategy should stop.

Specified by:

shouldStop in interface StopCondition

Parameters:

maxApplications - The defined maximal number of rules to apply. Can be different to StrategySettings.getMaxSteps() in side proofs.

timeout - The defined timeout in ms or -1 if disabled. Can be different to StrategySettings.getTimeout() in side proofs.

proof - The current Proof.

startTime - The timestamp when the apply strategy has started, computed via System.currentTimeMillis()

countApplied - The number of already applied rules.

singleRuleApplicationInfo - An optional SingleRuleApplicationInfo.

Returns:

true stop strategy, false continue strategy and apply next rule.

isBreakpointHit

protected boolean isBreakpointHit(SourceElement activeStatement,
                                  RuleApp ruleApp,
                                  Proof proof,
                                  Node node)

Checks if a breakpoint is hit.

Parameters:

activeStatement - the activeStatement of the node

ruleApp - the applied RuleApp

proof - the current proof

node - the current node

Returns:

true at least one breakpoint is hit, false all breakpoints are not hit.

getStopMessage

public java.lang.String getStopMessage(int maxApplications,
                                       long timeout,
                                       Proof proof,
                                       long startTime,
                                       int countApplied,
                                       SingleRuleApplicationInfo singleRuleApplicationInfo)

Returns a human readable message which explains why the previous #shouldStop(ApplyStrategy, Proof, GoalChooser, long, int, SingleRuleApplicationInfo) has stopped the strategy.

Specified by:

getStopMessage in interface StopCondition

Parameters:

maxApplications - The defined maximal number of rules to apply. Can be different to StrategySettings.getMaxSteps() in side proofs.

timeout - The defined timeout in ms or -1 if disabled. Can be different to StrategySettings.getTimeout() in side proofs.

proof - The current Proof.

startTime - The timestamp when the apply strategy has started, computed via System.currentTimeMillis()

countApplied - The number of already applied rules.

singleRuleApplicationInfo - An optional SingleRuleApplicationInfo.

Returns:

The human readable message which explains the stop reason.

addBreakpoint

public void addBreakpoint(IBreakpoint breakpoint)

Adds a new IBreakpoint.

Specified by:

addBreakpoint in interface IBreakpointStopCondition

Parameters:

breakpoint - The IBreakpoint to add.

removeBreakpoint

public void removeBreakpoint(IBreakpoint breakpoint)

Removes an IBreakpoint.

Specified by:

removeBreakpoint in interface IBreakpointStopCondition

Parameters:

breakpoint - The IBreakpoint to remove.

getBreakpoints

public java.util.Set<IBreakpoint> getBreakpoints()

Returns all available IBreakpoints.

Specified by:

getBreakpoints in interface IBreakpointStopCondition

Returns:

The available IBreakpoints.