eu.cqse.check.framework.shallowparser.util

Class ShallowParsingUtils

java.lang.Object

eu.cqse.check.framework.shallowparser.util.ShallowParsingUtils

public class ShallowParsingUtils
extends java.lang.Object

Utility methods used for dealing with ShallowEntitys.

Constructor Summary

Constructors

Constructor and Description
ShallowParsingUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	containsLoopReferenceWithoutLoop(java.util.List<ShallowEntity> block) Checks if continue or break are contained in a for or while loop in the given block.
static java.util.List<IToken>	extractParameterNameTokens(ShallowEntity entity) Returns the tokens of a method entity that correspond to parameter names.
static java.util.List<IToken>	extractVariableNameTokens(java.util.List<IToken> tokens) Returns the tokens corresponding to variable names.
static java.util.List<IToken>	extractVariablesDeclaredInFor(ShallowEntity entity) Returns the list of tokens corresponding to the names of variables newly declared within a for loop.
static java.util.List<java.lang.String>	getClassAttributes(java.util.List<ShallowEntity> classEntities) Extracts from a given token (that represents a file) all the attributes (variables) that are declared directly in a type (class) and not within a method etc.
static java.util.List<ShallowEntity>	getClassEntities(java.util.List<ShallowEntity> shallowEntities, int startLine, int endLine) Obtain all classes (including anonymous classes) that contain directly or indirectly the method corresponding to the given line numbers.
static java.util.List<ShallowEntity>	getCompleteStatement(ShallowEntity shallowEntity) Returns for a given entity that contains an if or try block a list of ShallowEntities that represents the corresponding else if or catch and else or finally block.
static ShallowEntity	getFirstEntityAfter(ShallowEntity candidate) Returns the entity which is directly after the given ShallowEntity.
static ELanguage	getLanguage(ShallowEntity entity) Determines the language of the given entity or null if it cannot be determined
static ShallowEntity	getLastEntityBefore(ShallowEntity candidate) Returns the entity which is directly before the given ShallowEntity.
static java.util.Optional<ShallowEntity>	getMethod(java.util.List<ShallowEntity> shallowEntities, LineBasedRegion region) Get a method by its region.
static java.util.Optional<ShallowEntity>	getMethod(java.util.List<ShallowEntity> shallowEntities, OffsetBasedRegion region) Get a method by its region.
static java.util.Optional<ShallowEntity>	getMethod(java.util.List<ShallowEntity> shallowEntities, java.util.function.Predicate<ShallowEntity> filter) Get a method using a predicate.
static java.util.List<ShallowEntity>	getMethods(java.util.List<ShallowEntity> shallowEntities) Obtain all methods.
static int	getNestingArea(java.util.List<ShallowEntity> shallowEntities) Returns the nesting area of a list of ShallowEntities.
static int	getNestingDepth(java.util.List<ShallowEntity> block) Returns the maximal nesting depth of the given block.
static int	getNestingDepth(ShallowEntity shallowEntity) Returns the maximal nesting depth of the given entity.
static int	getNumberOfBlankLinesOrCommentsAfter(ShallowEntity candidate) Returns the number of blank or commented lines after the given ShallowEntity.
static int	getNumberOfBlankLinesOrCommentsBefore(ShallowEntity candidate) Returns the number of blank or commented lines before the given ShallowEntity.
static java.util.List<java.lang.String>	getReturnParameters(java.util.List<ShallowEntity> block) Returns a list of variable names (identifiers) that must be returned from the specified block if it is extracted into a new method
static java.util.List<ShallowEntity>	getStatements(ShallowEntity entity) Returns all statements in the given entity
static boolean	isCppConstructor(ELanguage language, ShallowEntity entity) Checks whether the given method is a C++ constructor.
static boolean	isGlobalVariable(ShallowEntity entity) Returns whether the entity is a global variable.
static boolean	isLambdaMethod(ShallowEntity entity)
static boolean	isLocalVariable(ShallowEntity entity) Returns whether the entity is a local variable.
static boolean	isLoop(ShallowEntity entity) Checks if the entity is a loop (for, foreach, while).
static boolean	isSubpartOfBranchingStatement(ShallowEntity entity) Checks if the given entity is part of a branching statement but not the first option of the branches.
static java.util.List<ShallowEntity>	listNestedStatements(java.util.Collection<ShallowEntity> entities) Lists all nested statements (i.e.
static java.util.List<ShallowEntity>	listPrimitiveStatements(java.util.Collection<ShallowEntity> entities) Lists all primitive statements (i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShallowParsingUtils

public ShallowParsingUtils()

Method Detail

listPrimitiveStatements

public static java.util.List<ShallowEntity> listPrimitiveStatements(java.util.Collection<ShallowEntity> entities)

Lists all primitive statements (i.e. statements without children).

listNestedStatements

public static java.util.List<ShallowEntity> listNestedStatements(java.util.Collection<ShallowEntity> entities)

Lists all nested statements (i.e. statements with children).

extractParameterNameTokens

public static java.util.List<IToken> extractParameterNameTokens(ShallowEntity entity)

Returns the tokens of a method entity that correspond to parameter names.

extractVariableNameTokens

public static java.util.List<IToken> extractVariableNameTokens(java.util.List<IToken> tokens)

Returns the tokens corresponding to variable names.

extractVariablesDeclaredInFor

public static java.util.List<IToken> extractVariablesDeclaredInFor(ShallowEntity entity)

Returns the list of tokens corresponding to the names of variables newly declared within a for loop.

isLocalVariable

public static boolean isLocalVariable(ShallowEntity entity)

Returns whether the entity is a local variable.

isGlobalVariable

public static boolean isGlobalVariable(ShallowEntity entity)

Returns whether the entity is a global variable.

containsLoopReferenceWithoutLoop

public static boolean containsLoopReferenceWithoutLoop(java.util.List<ShallowEntity> block)

Checks if continue or break are contained in a for or while loop in the given block. If there is continue, break or return; in a code segment, it can not be extracted. (Note: return sth; may be extractable.)

Parameters:

block - the ShallowEntities that will be checked.

Returns:

true if there is continue or break

getCompleteStatement

public static java.util.List<ShallowEntity> getCompleteStatement(ShallowEntity shallowEntity)

Returns for a given entity that contains an if or try block a list of ShallowEntities that represents the corresponding else if or catch and else or finally block. That means that the complete statement is determined and returned.

Parameters:

shallowEntity - the entity that contains an if or try block

Returns:

The list of ShallowEntities that contains the corresponding block with all else if or catch and else or finally entities belonging to the given shallowEntity

getFirstEntityAfter

public static ShallowEntity getFirstEntityAfter(ShallowEntity candidate)

Returns the entity which is directly after the given ShallowEntity.

Parameters:

candidate - the last entity of the candidate

Returns:

The first entity which begins after the the given ShallowEntity. If there is no such entity, null will be returned.

getLastEntityBefore

public static ShallowEntity getLastEntityBefore(ShallowEntity candidate)

Returns the entity which is directly before the given ShallowEntity.

Parameters:

candidate - the first entity of the candidate

Returns:

The last entity which ends before the the given ShallowEntity. If there is no such entity, null will be returned.

getNestingArea

public static int getNestingArea(java.util.List<ShallowEntity> shallowEntities)

Returns the nesting area of a list of ShallowEntities. The nesting area is the sum of the nesting depth of all ShallowEntities.

Parameters:

shallowEntities - the ShallowEntities.

Returns:

The nesting area of the given entities.

getNestingDepth

public static int getNestingDepth(java.util.List<ShallowEntity> block)

Returns the maximal nesting depth of the given block.

Parameters:

block - the ShallowEntities that are taken into account for the maximal nesting depth.

Returns:

The maximal nesting depth

getNestingDepth

public static int getNestingDepth(ShallowEntity shallowEntity)

Returns the maximal nesting depth of the given entity.

Parameters:

shallowEntity - the ShallowEntity.

Returns:

The maximal nesting depth

getNumberOfBlankLinesOrCommentsAfter

public static int getNumberOfBlankLinesOrCommentsAfter(ShallowEntity candidate)

Returns the number of blank or commented lines after the given ShallowEntity.

Parameters:

candidate - if a refactoring candidate should be considered, take its last ShallowEntity.

Returns:

The number of blank or commented lines

getNumberOfBlankLinesOrCommentsBefore

public static int getNumberOfBlankLinesOrCommentsBefore(ShallowEntity candidate)

Returns the number of blank or commented lines before the given ShallowEntity.

Parameters:

candidate - if a refactoring candidate should be considered, take its first ShallowEntity.

Returns:

The number of blank or commented lines

getReturnParameters

public static java.util.List<java.lang.String> getReturnParameters(java.util.List<ShallowEntity> block)

Returns a list of variable names (identifiers) that must be returned from the specified block if it is extracted into a new method

Parameters:

block - ShallowEntities that might be extracted

Returns:

List of identifiers

getStatements

public static java.util.List<ShallowEntity> getStatements(ShallowEntity entity)

Returns all statements in the given entity

getClassEntities

public static java.util.List<ShallowEntity> getClassEntities(java.util.List<ShallowEntity> shallowEntities,
                                                             int startLine,
                                                             int endLine)

Obtain all classes (including anonymous classes) that contain directly or indirectly the method corresponding to the given line numbers.

Parameters:

shallowEntities - the ShallowEntities that represent the file in which the finding was found

startLine - the start line of the code area that must be covered by the classes

endLine - the end line of the code area that must be covered by the classes

Returns:

A list that contains at least one ShallowEntity with type TYPE.

getMethods

public static java.util.List<ShallowEntity> getMethods(java.util.List<ShallowEntity> shallowEntities)

Obtain all methods.

Parameters:

shallowEntities - the ShallowEntities that represent the file in which the finding was found

Returns:

all entities of type EShallowEntityType.METHOD

getMethod

public static java.util.Optional<ShallowEntity> getMethod(java.util.List<ShallowEntity> shallowEntities,
                                                          OffsetBasedRegion region)

Get a method by its region. The region must match exactly.

Parameters:

shallowEntities - the ShallowEntities that represent the file in which the finding was found

region - of the method

getMethod

public static java.util.Optional<ShallowEntity> getMethod(java.util.List<ShallowEntity> shallowEntities,
                                                          LineBasedRegion region)

Get a method by its region. The region must match exactly.

Parameters:

shallowEntities - the ShallowEntities that represent the file in which the finding was found

region - of the method

getMethod

public static java.util.Optional<ShallowEntity> getMethod(java.util.List<ShallowEntity> shallowEntities,
                                                          java.util.function.Predicate<ShallowEntity> filter)

Get a method using a predicate.

Parameters:

shallowEntities - the ShallowEntities that represent the file in which the finding was found

filter - to filter a method

getClassAttributes

public static java.util.List<java.lang.String> getClassAttributes(java.util.List<ShallowEntity> classEntities)

Extracts from a given token (that represents a file) all the attributes (variables) that are declared directly in a type (class) and not within a method etc.

Parameters:

classEntities - the ShallowEntity of the class that contains the method for which suggestions are to be generated

Returns:

A list containing all the names (identifiers) of the global variables

isLoop

public static boolean isLoop(ShallowEntity entity)

Checks if the entity is a loop (for, foreach, while).

isSubpartOfBranchingStatement

public static boolean isSubpartOfBranchingStatement(ShallowEntity entity)

Checks if the given entity is part of a branching statement but not the first option of the branches. Those statements must not be separated from the first part of the branching statement when we consider refactoring suggestions.

Returns:

For entities of subtype ELSE IF, ELSE, CATCH, FINALLY, CASE, DEFAULT, USING, DO will return true but for other subtypes (including IF, SWITCH, TRY) return false.

isCppConstructor

public static boolean isCppConstructor(ELanguage language,
                                       ShallowEntity entity)

Checks whether the given method is a C++ constructor.

isLambdaMethod

public static boolean isLambdaMethod(ShallowEntity entity)

Returns:

whether the given entity is a lambda method.

getLanguage

public static ELanguage getLanguage(ShallowEntity entity)

Determines the language of the given entity or null if it cannot be determined