de.uka.ilkd.key.symbolic_execution.strategy

Class CompoundStopCondition

java.lang.Object

de.uka.ilkd.key.symbolic_execution.strategy.CompoundStopCondition

All Implemented Interfaces:

ApplyStrategy.IStopCondition

public class CompoundStopCondition
extends Object
implements ApplyStrategy.IStopCondition

This ApplyStrategy.IStopCondition contains other ApplyStrategy.IStopCondition as children and stops the auto mode if at least on of its children force it.

Author:

Martin Hentschel

Field Summary

Fields

Modifier and Type	Field and Description
private List<ApplyStrategy.IStopCondition>	children The child ApplyStrategy.IStopConditions to use.
private ApplyStrategy.IStopCondition	lastGoalAllowedChild The last ApplyStrategy.IStopCondition treated in #isGoalAllowed(ApplyStrategy, int, long, Proof, IGoalChooser, long, int, Goal) which will provide the reason via #getGoalNotAllowedMessage(ApplyStrategy, int, long, Proof, IGoalChooser, long, int, Goal).
private ApplyStrategy.IStopCondition	lastShouldStopChild The last ApplyStrategy.IStopCondition treated in #shouldStop(ApplyStrategy, int, long, Proof, IGoalChooser, long, int, SingleRuleApplicationInfo) which will provide the reason via #getStopMessage(ApplyStrategy, int, long, Proof, IGoalChooser, long, int, SingleRuleApplicationInfo).

Constructor Summary

Constructors

Constructor and Description
CompoundStopCondition(ApplyStrategy.IStopCondition... children) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addChildren(ApplyStrategy.IStopCondition... children) Adds new child ApplyStrategy.IStopConditions.
List<ApplyStrategy.IStopCondition>	getChildren()
String	getGoalNotAllowedMessage(int maxApplications, long timeout, Proof proof, IGoalChooser goalChooser, long startTime, int countApplied, Goal goal) Returns the reason why the previous check via #isGoalAllowed(ApplyStrategy, int, long, Proof, IGoalChooser, long, int, Goal) has stopped the apply strategy.
int	getMaximalWork(int maxApplications, long timeout, Proof proof, IGoalChooser goalChooser) Returns the maximal amount of work needed to complete the task, used to display a progress bar.
String	getStopMessage(int maxApplications, long timeout, Proof proof, IGoalChooser goalChooser, long startTime, int countApplied, ApplyStrategy.SingleRuleApplicationInfo singleRuleApplicationInfo) Returns a human readable message which explains why the previous #shouldStop(ApplyStrategy, Proof, IGoalChooser, long, int, SingleRuleApplicationInfo) has stopped the strategy.
boolean	isGoalAllowed(int maxApplications, long timeout, Proof proof, IGoalChooser goalChooser, long startTime, int countApplied, Goal goal) Checks if it is allowed to apply the next rule on the selected Goal chosen by the IGoalChooser before it is applied.
void	removeChild(ApplyStrategy.IStopCondition child)
boolean	shouldStop(int maxApplications, long timeout, Proof proof, IGoalChooser goalChooser, long startTime, int countApplied, ApplyStrategy.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

children

private List<ApplyStrategy.IStopCondition> children

The child ApplyStrategy.IStopConditions to use.

lastGoalAllowedChild

private ApplyStrategy.IStopCondition lastGoalAllowedChild

The last ApplyStrategy.IStopCondition treated in #isGoalAllowed(ApplyStrategy, int, long, Proof, IGoalChooser, long, int, Goal) which will provide the reason via #getGoalNotAllowedMessage(ApplyStrategy, int, long, Proof, IGoalChooser, long, int, Goal).

lastShouldStopChild

private ApplyStrategy.IStopCondition lastShouldStopChild

The last ApplyStrategy.IStopCondition treated in #shouldStop(ApplyStrategy, int, long, Proof, IGoalChooser, long, int, SingleRuleApplicationInfo) which will provide the reason via #getStopMessage(ApplyStrategy, int, long, Proof, IGoalChooser, long, int, SingleRuleApplicationInfo).

Constructor Detail

CompoundStopCondition

public CompoundStopCondition(ApplyStrategy.IStopCondition... children)

Constructor.

Parameters:

children - The child ApplyStrategy.IStopConditions to use.

Method Detail

addChildren

public void addChildren(ApplyStrategy.IStopCondition... children)

Adds new child ApplyStrategy.IStopConditions.

Parameters:

children - The child ApplyStrategy.IStopConditions to use.

removeChild

public void removeChild(ApplyStrategy.IStopCondition child)

getMaximalWork

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

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 ApplyStrategy.IStopCondition

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.

goalChooser - The current IGoalChooser.

Returns:

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

isGoalAllowed

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

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

Specified by:

isGoalAllowed in interface ApplyStrategy.IStopCondition

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.

goalChooser - The current IGoalChooser.

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 String getGoalNotAllowedMessage(int maxApplications,
                                       long timeout,
                                       Proof proof,
                                       IGoalChooser goalChooser,
                                       long startTime,
                                       int countApplied,
                                       Goal goal)

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

Specified by:

getGoalNotAllowedMessage in interface ApplyStrategy.IStopCondition

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.

goalChooser - The current IGoalChooser.

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,
                          IGoalChooser goalChooser,
                          long startTime,
                          int countApplied,
                          ApplyStrategy.SingleRuleApplicationInfo singleRuleApplicationInfo)

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

Specified by:

shouldStop in interface ApplyStrategy.IStopCondition

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.

goalChooser - The current IGoalChooser.

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

countApplied - The number of already applied rules.

singleRuleApplicationInfo - An optional ApplyStrategy.SingleRuleApplicationInfo.

Returns:

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

getStopMessage

public String getStopMessage(int maxApplications,
                             long timeout,
                             Proof proof,
                             IGoalChooser goalChooser,
                             long startTime,
                             int countApplied,
                             ApplyStrategy.SingleRuleApplicationInfo singleRuleApplicationInfo)

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

Specified by:

getStopMessage in interface ApplyStrategy.IStopCondition

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.

goalChooser - The current IGoalChooser.

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

countApplied - The number of already applied rules.

singleRuleApplicationInfo - An optional ApplyStrategy.SingleRuleApplicationInfo.

Returns:

The human readable message which explains the stop reason.

getChildren

public List<ApplyStrategy.IStopCondition> getChildren()