org.eth.cyril.bugfixer.rewriting

Class LoopAndMethodCounterRewrite

java.lang.Object

org.eth.cyril.bugfixer.rewriting.ASTRewriteRule

org.eth.cyril.bugfixer.rewriting.LoopAndMethodCounterRewrite

public class LoopAndMethodCounterRewrite
extends ASTRewriteRule

Rewrite rule to add loop counter variables for each loop, as well as method counter fields for each method. This makes sure that any infinite loops / recursion is detected for all the methods which are potentially rewritten. Note that methods which are not target of any rewrite don't get method counters (and the same for any loops within those methods).

Nested Class Summary

Nested classes/interfaces inherited from class org.eth.cyril.bugfixer.rewriting.ASTRewriteRule

ASTRewriteRule.RewriteArguments, ASTRewriteRule.RewritePossibilities

Constructor Summary

Constructors

Constructor and Description
LoopAndMethodCounterRewrite()

Method Summary

Modifier and Type	Method and Description
java.lang.String	describeRule() Returns a human-readable description of what this rule does.
static boolean	doesPairCheckCounter(Pair<org.eclipse.jdt.core.dom.Statement> statements) Returns whether the given pair of statements checks a loop counter.
java.util.Collection<ASTRewriteRule.RewritePossibilities>	getRewritePossibilities(org.eclipse.jdt.core.dom.ASTNode node) Return the collection of rewrite possibilities for the given node.
static boolean	isLoopCounter(org.eclipse.jdt.core.dom.VariableDeclarationStatement variable) Returns whether the given VariableDeclarationStatement instance declares a loop counter, and should therefore be removed before presenting the corrected code to the user again.
static boolean	isMethodCounter(org.eclipse.jdt.core.dom.FieldDeclaration field) Returns whether the given FieldDeclaration instance declares a method counter, and should therefore be removed before presenting the corrected code to the user again.
static void	resetStaticCounters(java.lang.Class<?> clazz) Resets all static method counters to the value of zero.
void	rewrite(org.eclipse.jdt.core.dom.ASTNode node, org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite, ASTRewriteRule.RewriteArguments args) Produce a rewrite according to the given ASTRewriteRule.RewriteArguments.

Methods inherited from class org.eth.cyril.bugfixer.rewriting.ASTRewriteRule

createRewritePossibilities, createRewritePossibilities, preProcess

Methods inherited from class java.lang.Object

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

Constructor Detail

LoopAndMethodCounterRewrite

public LoopAndMethodCounterRewrite()

Method Detail

resetStaticCounters

public static void resetStaticCounters(java.lang.Class<?> clazz)

Resets all static method counters to the value of zero. This is necessary, as these counters will otherwise increase while the class is loaded. Does not reset non-static method counters or loop counters.

Parameters:

clazz - The class to reset the static method counters in.

isMethodCounter

public static boolean isMethodCounter(org.eclipse.jdt.core.dom.FieldDeclaration field)

Returns whether the given FieldDeclaration instance declares a method counter, and should therefore be removed before presenting the corrected code to the user again.

isLoopCounter

public static boolean isLoopCounter(org.eclipse.jdt.core.dom.VariableDeclarationStatement variable)

Returns whether the given VariableDeclarationStatement instance declares a loop counter, and should therefore be removed before presenting the corrected code to the user again.

doesPairCheckCounter

public static boolean doesPairCheckCounter(Pair<org.eclipse.jdt.core.dom.Statement> statements)

Returns whether the given pair of statements checks a loop counter. In that case, the first element of the pair is an if-statement, and the second one increments the loop counter.

describeRule

public java.lang.String describeRule()

Description copied from class: ASTRewriteRule

Returns a human-readable description of what this rule does. This description should optimally be translatable with a Language instance.

Specified by:

describeRule in class ASTRewriteRule

Returns:

A human-readable description of what this rule does.

getRewritePossibilities

public java.util.Collection<ASTRewriteRule.RewritePossibilities> getRewritePossibilities(org.eclipse.jdt.core.dom.ASTNode node)

Description copied from class: ASTRewriteRule

Return the collection of rewrite possibilities for the given node. The collection may be empty, but the result will never be null.

Specified by:

getRewritePossibilities in class ASTRewriteRule

Parameters:

node - The node for which to get the collection of rewrite possibilities.

Returns:

A collection of rewrite possibilities. Can be empty but not null.

rewrite

public void rewrite(org.eclipse.jdt.core.dom.ASTNode node,
                    org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite,
                    ASTRewriteRule.RewriteArguments args)

Description copied from class: ASTRewriteRule

Produce a rewrite according to the given ASTRewriteRule.RewriteArguments. This rule must be the same as ASTRewriteRule.RewritePossibilities.getSource() for the given arguments' rewrite possibilites instance. Otherwise, the behavior is not determined. This method may not produce any rewrite, if the ASTRewriteRule.RewriteArguments.getVersion() is 0. In other cases, it will produce some rewrite.

Specified by:

rewrite in class ASTRewriteRule

Parameters:

node - The node for which to produce the rewrite.

rewrite - The ASTRewrite instance to use for rewriting the node.

args - The rewrite arguments. This rule must match the source of the arguments.