eu.cqse.check.framework.util.cs

Class CsCheckUtils

java.lang.Object

eu.cqse.check.framework.util.cs.CsCheckUtils

public abstract class CsCheckUtils
extends java.lang.Object

Utility methods for analyzing C# code

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	INTERPOLATION_PATTERN Matches an interpolation in a C# 6 interpolation string.
static int	UNKNOWN_ARITY Value for a unknown method arity.

Constructor Summary

Constructors

Constructor and Description
CsCheckUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.Integer>	checkForVariableUseInStringInterpolation(java.util.List<IToken> tokens, java.lang.String variableName) Checks whether the given variable name was used in a string interpolation in the given tokens.
static java.util.List<IToken>	extractInterpolatedCalls(java.util.List<IToken> tokens) Filters a list of tokens for interpolated literal calls.
static boolean	isMainMethod(ShallowEntity method) Determines, if the given method is a valid Main method according to the Microsoft documentation
static SetMap<java.lang.String,java.lang.Integer>	retrieveMethodReferences(java.util.List<IToken> tokens) Retrieves all possible method references from the given tokens and adds them to the given SetMap.
static java.util.List<java.util.List<IToken>>	tokenizeInterpolatedCalls(java.util.List<IToken> interpolatedStringTokens) Tokenize the interpolated calls in string token.

Methods inherited from class java.lang.Object

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

Field Detail

INTERPOLATION_PATTERN

public static final java.util.regex.Pattern INTERPOLATION_PATTERN

Matches an interpolation in a C# 6 interpolation string.

UNKNOWN_ARITY

public static final int UNKNOWN_ARITY

Value for a unknown method arity. This value is used if a method name is found in a method reference.

See Also:

Constant Field Values

Constructor Detail

CsCheckUtils

public CsCheckUtils()

Method Detail

isMainMethod

public static boolean isMainMethod(ShallowEntity method)

Determines, if the given method is a valid Main method according to the Microsoft documentation

retrieveMethodReferences

public static SetMap<java.lang.String,java.lang.Integer> retrieveMethodReferences(java.util.List<IToken> tokens)

Retrieves all possible method references from the given tokens and adds them to the given SetMap. A method reference here means any instance where a method is basically handled like an object or a reference, so any actual method invocation is not included.

extractInterpolatedCalls

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

Filters a list of tokens for interpolated literal calls.

• Example of an interpolated literal: String string = $"{foo(a, b)} comment";

Parameters:

tokens - to check for interpolated literal tokens.

Returns:

interpolated literal tokens.

tokenizeInterpolatedCalls

public static java.util.List<java.util.List<IToken>> tokenizeInterpolatedCalls(java.util.List<IToken> interpolatedStringTokens)

Tokenize the interpolated calls in string token.

Parameters:

interpolatedStringToken - to be tokenized.

Returns:

interpolated variables and methods separated in a list of tokens.

checkForVariableUseInStringInterpolation

public static java.util.List<java.lang.Integer> checkForVariableUseInStringInterpolation(java.util.List<IToken> tokens,
                                                                                         java.lang.String variableName)

Checks whether the given variable name was used in a string interpolation in the given tokens. Returns a list with the indices of its occurrences.