eu.cqse.check.framework.util.variable

Class CLikeVariableUseExtractor

java.lang.Object

eu.cqse.check.framework.util.variable.CLikeVariableUseExtractor

Direct Known Subclasses:

CSVariableUseExtractor

public class CLikeVariableUseExtractor
extends java.lang.Object

A variable use extractor extracts uses of variables from token streams. Thereby it differentiates between fields and local variables and considers shadowing of variables.

Constructor Summary

Constructors

Constructor and Description
CLikeVariableUseExtractor(java.util.EnumSet<ETokenType> accessOperators, java.util.EnumSet<ETokenType> noVariableSuccessorTypes) Constructor.
CLikeVariableUseExtractor(ETokenType accessOperator, java.util.EnumSet<ETokenType> noVariableSuccessorTypes) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Integer>	extractFilteredVariableUses(java.util.List<IToken> tokens, java.lang.String variableName, boolean isField, boolean isShadowed, IVariableUseFilter filter) Extracts all uses of the given variable name from the given tokens.
java.util.List<java.lang.Integer>	extractVariableReads(java.util.List<IToken> tokens, java.lang.String variableName, boolean isField, boolean isShadowed) Extracts all uses of the given variable name from the given tokens that read its value.
java.util.List<java.lang.Integer>	extractVariableUses(java.util.List<IToken> tokens, java.lang.String variableName, boolean isField, boolean isShadowed) Extracts all uses of the given variable name from the given tokens.
java.util.List<java.lang.Integer>	extractVariableWrites(java.util.List<IToken> tokens, java.lang.String variableName, boolean isField, boolean isShadowed) Extracts all uses of the given variable name from the given tokens that change its value.
java.util.List<java.lang.Integer>	filterUses(java.util.List<IToken> tokens, java.util.List<java.lang.Integer> useIndices, boolean isField, boolean isShadowed, IVariableUseFilter filter) Filters then given variable uses based on whether they are fields, shadowed and the given custom filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

CLikeVariableUseExtractor

public CLikeVariableUseExtractor(ETokenType accessOperator,
                                 java.util.EnumSet<ETokenType> noVariableSuccessorTypes)

Constructor.

CLikeVariableUseExtractor

public CLikeVariableUseExtractor(java.util.EnumSet<ETokenType> accessOperators,
                                 java.util.EnumSet<ETokenType> noVariableSuccessorTypes)

Constructor.

Method Detail

extractVariableUses

public java.util.List<java.lang.Integer> extractVariableUses(java.util.List<IToken> tokens,
                                                             java.lang.String variableName,
                                                             boolean isField,
                                                             boolean isShadowed)

Extracts all uses of the given variable name from the given tokens.

Parameters:

isField - whether the given variable name is a field of a type

isShadowed - whether the given variable name is shadowed by another variable with the same name

extractVariableReads

public java.util.List<java.lang.Integer> extractVariableReads(java.util.List<IToken> tokens,
                                                              java.lang.String variableName,
                                                              boolean isField,
                                                              boolean isShadowed)

Extracts all uses of the given variable name from the given tokens that read its value.

Parameters:

isField - whether the given variable name is a field of a type

isShadowed - whether the given variable name is shadowed by another variable with the same name

extractVariableWrites

public java.util.List<java.lang.Integer> extractVariableWrites(java.util.List<IToken> tokens,
                                                               java.lang.String variableName,
                                                               boolean isField,
                                                               boolean isShadowed)

Extracts all uses of the given variable name from the given tokens that change its value.

Parameters:

isField - whether the given variable name is a field of a type

isShadowed - whether the given variable name is shadowed by another variable with the same name

extractFilteredVariableUses

public java.util.List<java.lang.Integer> extractFilteredVariableUses(java.util.List<IToken> tokens,
                                                                     java.lang.String variableName,
                                                                     boolean isField,
                                                                     boolean isShadowed,
                                                                     IVariableUseFilter filter)

Extracts all uses of the given variable name from the given tokens.

Parameters:

isField - whether the given variable name is a field of a type

isShadowed - whether the given variable name is shadowed by another variable with the same name

filterUses

public java.util.List<java.lang.Integer> filterUses(java.util.List<IToken> tokens,
                                                    java.util.List<java.lang.Integer> useIndices,
                                                    boolean isField,
                                                    boolean isShadowed,
                                                    IVariableUseFilter filter)

Filters then given variable uses based on whether they are fields, shadowed and the given custom filter. The parameter useIndices is a list of indices to tokens in the given token list, that are possible variable uses.