CLikeLanguageFeatureParserBase (Teamscale Check Framework API)

java.lang.Object
- eu.cqse.check.framework.util.CLikeLanguageFeatureParserBase

All Implemented Interfaces:

ILanguageFeatureParser

Direct Known Subclasses:

CppLanguageFeatureParser, CsLanguageFeatureParser, JavaLanguageFeatureParser, ObjcLanguageFeatureParser
```
public abstract class CLikeLanguageFeatureParserBase
extends java.lang.Object
implements ILanguageFeatureParser
```
Base class for clike language feature parsers.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.EnumSet<ETokenType>`	`CONDITIONAL_OPERATOR_TYPES` Conditional operator types.
`protected ETokenType`	`packageSeparator` The token type to separate packages/namespaces/scopes.
`protected java.lang.String`	`packageSeparatorText` The text of the package separator token.
`static java.util.EnumSet<ETokenType>`	`POINTER_TYPES` Token types that are used to declare a pointer or reference (C++).
`protected java.util.EnumSet<ETokenType>`	`primitiveTypeTokens` All token types that can be used to declare a primitive type.
`protected static java.lang.String[]`	`TYPE_MODIFICATIONS` All strings that modify a type name.
`protected java.util.EnumSet<ETokenType>`	`typeTokens` All token types that can be used to declare a type.
`protected CLikeVariableUseExtractor`	`useExtractor` The variable use extractor to find uses of names (e.g.
`protected java.util.EnumSet<ETokenType>`	`validIdentifiers` All token types that can be used as valid identifiers.
`protected ETokenType`	`variableSplitType` The type of variable split of splitVariableTokens method

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CLikeLanguageFeatureParserBase(ELanguage language, java.util.EnumSet<ETokenType> validIdentifiers, java.util.EnumSet<ETokenType> primitiveTypeTokens, java.util.EnumSet<ETokenType> additionalTypeTokens, ETokenType packageSeparator, java.lang.String packageSeparatorText, CLikeVariableUseExtractor useExtractor)` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`collectTokenFromTypePart(java.util.List<IToken> tokens, int endIndex, TypeNameTokenCollection typeName)` Collects a type name token from a part of a type name within a variable declaration.
`protected int`	`collectTokensFromModifiers(java.util.List<IToken> tokens, int endIndex, java.util.List<IToken> modifierTokens)` Collects modifier tokens from modifier specifications in front of the type name within a variable declaration.
`protected int`	`collectTokensFromPointers(java.util.List<IToken> tokens, int endIndex, java.util.List<IToken> modifierTokens, TypeNameTokenCollection typeName)` Collects modifier tokens from pointer or reference declarations (mainly const in C++).
`protected int`	`collectTokensFromPrimitiveType(java.util.List<IToken> tokens, int endIndex, TypeNameTokenCollection typeName)` Collects type name tokens from a primitive type within a variable declaration.
`protected int`	`collectTokensFromType(java.util.List<IToken> tokens, int endIndex, TypeNameTokenCollection typeName)` Collects type name tokens from a type name within a variable declaration.
`protected int`	`collectTokensFromTypeAndModifications(java.util.List<IToken> tokens, int endIndex, java.util.List<IToken> modifierTokens, TypeNameTokenCollection typeName)` Collects modifier and type tokens from type modifications like pointer or reference declarations and from the type type name tokens itself.
`java.util.List<IToken>`	`extractConditionTokens(ShallowEntity statement)` Extracts all tokens that are part of a condition from a statement.
`protected java.util.List<IToken>`	`extractParameterTokens(java.util.List<IToken> tokensAfterMethodName)` Returns a list of parameter tokens for the given tokens after the method name.
`protected java.util.List<IToken>`	`filterGenericTokens(java.util.List<IToken> genericTokens)` Filters the generic tokens before converting them to their token texts.
`java.lang.String`	`getBaseTypeName(java.lang.String typeName)` Returns the base name of the given type name.
`java.util.List<java.lang.String>`	`getGenericNamesForMethod(ShallowEntity method)` Returns a list of all generic names for the given method.
`java.util.List<java.lang.String>`	`getGenericNamesForType(ShallowEntity type)` Returns a list of all generic names for the given type.
`java.util.List<java.lang.String>`	`getGenericTypeNames(java.util.List<IToken> tokens)` Extracts type names that are used in generics from the given tokens.
`java.util.List<java.lang.String>`	`getImportedNames(java.util.List<ShallowEntity> importEntities)` Returns a list of names that are imported by the given "import" entities.
`abstract java.lang.String`	`getImportName(ShallowEntity entity)` Returns the imported name of the given import shallow entity.
`ELanguage`	`getLanguage()` Returns that language the feature parsers are implemented for.
`protected int`	`getMethodOpeningParenthesisIndex(java.util.List<IToken> methodTokens)` Returns the index of the opening parenthesis of a method from the given tokens.
`Pair<java.util.List<IToken>,java.lang.String>`	`getModifiersAndTypeFromTokens(java.util.List<IToken> tokens)` Extracts a list of modifiers and a type name from the given token list.
`java.util.List<IToken>`	`getParameterTokens(ShallowEntity method)` Returns a list of parameter tokens for the given method.
`java.util.List<java.util.Optional<java.lang.String>>`	`getParameterTypeNames(ShallowEntity method)` Returns all parameter type names of the given method.
`java.lang.String`	`getPlainTypeName(java.lang.String typeName)` Removes all pointer, array and reference declarations from the given typename.
`java.lang.String`	`getReturnType(ShallowEntity method)` Returns the type name of the return type of the given method.
`java.util.List<java.util.List<IToken>>`	`getSplitParameterTokens(ShallowEntity method)` Returns a list of lists of tokens that represent the parameters of the given method.
`java.lang.String`	`getTypeNameFromCatchTokens(java.util.List<IToken> catchTokens)` Returns the type name of an exception within a catch statement or null if none is found.
`protected int`	`getTypeNameStartIndex(java.util.List<IToken> tokens, int lastTypeTokenIndex)` Return the start index of the type name that ends at the given index within the given token list.
`IToken`	`getVariableNameFromCatchTokens(java.util.List<IToken> catchTokens)` Returns the variable name of an exception within a catch statement or null if the exception is not named.
`IToken`	`getVariableNameFromTokens(java.util.List<IToken> tokens)` Returns the variable name token from the given token list or `null` if none is found.
`java.util.List<IToken>`	`getVariableNamesFromTokens(java.util.List<IToken> variableTokens)` Returns all variable name tokens from the given variable tokens.
`java.util.List<java.lang.Integer>`	`getVariableReadsFromTokens(java.util.List<IToken> tokens, java.lang.String variableName, boolean isField, boolean isShadowed)` Returns all token indices from the given tokens that read the value of the variable with the given name.
`java.util.List<IToken>`	`getVariableTokensFromForLikeTokens(java.util.List<IToken> forLikeTokens, ETokenType endToken)` Returns all variable declaration tokens within a for-like statement.
`java.lang.String`	`getVariableTypeFromTokens(java.util.List<IToken> tokens)` Returns the type name of a variable from the declaring tokens.
`java.util.List<java.lang.Integer>`	`getVariableUsesFromTokens(java.util.List<IToken> tokens, java.lang.String variableName, boolean isField, boolean isShadowed)` Returns all token indices from the given tokens that are uses of the variable with the given name.
`java.util.List<java.lang.Integer>`	`getVariableWritesFromTokens(java.util.List<IToken> tokens, java.lang.String variableName, boolean isField, boolean isShadowed)` Returns all token indices from the given tokens that change the value of the variable with the given name.
`boolean`	`hasOnlyStaticMembers(ShallowEntity clazz)` Returns whether the given entity only has static members.
`boolean`	`hasVariableLengthArgumentList(java.util.List<IToken> tokens)` Returns whether the given tokens represent a variable length argument.
`boolean`	`hasVoidReturnType(ShallowEntity method)` Returns whether the given method has a void return type.
`abstract boolean`	`isImport(ShallowEntity entity)` Returns whether the given entity is an import.
`boolean`	`isPrimitiveTypeToken(IToken token)` Returns whether the given token is a primitive type token.
`boolean`	`isStatic(ShallowEntity entity)` Returns whether the given entity is static.
`boolean`	`isTypeToken(IToken token)` Returns whether the given token is a type token.
`boolean`	`isVariableDeclaration(java.util.List<IToken> variableTokens)` Returns whether the given tokens are a variable declaration.
`boolean`	`matchesFullQualifiedTypeName(java.lang.String typeName, java.util.Collection<java.lang.String> importedNamespaces, java.lang.String fullQualifiedTypeName)` Returns whether the given type name matches the given full qualified type name considering the given imported namespaces.
`protected int`	`reverseSkipToType(java.util.List<IToken> tokens)` Skips from the end of the given token list (that represents a variable definition) to the token after the last token that specifies the variables type.
`int`	`skipGeneric(java.util.List<IToken> tokens, int startIndex)` Skips a generic or template declaration in the given token list that begins at the given start index.
`int`	`skipGenericReverse(java.util.List<IToken> tokens, int startIndex)` Skips a generic parameter (nested < and >) in reverse direction and returns the index of the first opening < token.
`java.util.List<java.util.List<IToken>>`	`splitVariableTokens(java.util.List<IToken> variableTokens)` Splits the given variable declaration tokens at commas regarding nesting between parenthesis, brackets, braces and angle brackets.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONDITIONAL_OPERATOR_TYPES
```
public static final java.util.EnumSet<ETokenType> CONDITIONAL_OPERATOR_TYPES
```
    Conditional operator types.
  - POINTER_TYPES
```
public static final java.util.EnumSet<ETokenType> POINTER_TYPES
```
    Token types that are used to declare a pointer or reference (C++).
  - TYPE_MODIFICATIONS
```
protected static final java.lang.String[] TYPE_MODIFICATIONS
```
    All strings that modify a type name. This includes pointer, reference and array declarations.
  - validIdentifiers
```
protected final java.util.EnumSet<ETokenType> validIdentifiers
```
    All token types that can be used as valid identifiers.
  - primitiveTypeTokens
```
protected final java.util.EnumSet<ETokenType> primitiveTypeTokens
```
    All token types that can be used to declare a primitive type. Some primitive types can consist of multiple tokens.
  - typeTokens
```
protected final java.util.EnumSet<ETokenType> typeTokens
```
    All token types that can be used to declare a type.
  - useExtractor
```
protected final CLikeVariableUseExtractor useExtractor
```
    The variable use extractor to find uses of names (e.g. variables or fields).
  - packageSeparator
```
protected final ETokenType packageSeparator
```
    The token type to separate packages/namespaces/scopes.
  - packageSeparatorText
```
protected final java.lang.String packageSeparatorText
```
    The text of the package separator token.
  - variableSplitType
```
protected ETokenType variableSplitType
```
    The type of variable split of splitVariableTokens method
- Constructor Detail
  - CLikeLanguageFeatureParserBase
```
protected CLikeLanguageFeatureParserBase(ELanguage language,
                                         java.util.EnumSet<ETokenType> validIdentifiers,
                                         java.util.EnumSet<ETokenType> primitiveTypeTokens,
                                         java.util.EnumSet<ETokenType> additionalTypeTokens,
                                         ETokenType packageSeparator,
                                         java.lang.String packageSeparatorText,
                                         CLikeVariableUseExtractor useExtractor)
```
    Constructor.
    
    Parameters:
    
    language - the concrete language of this parser
    
    validIdentifiers - all token types that can be used as identifiers
    
    primitiveTypeTokens - all token types that can be part of a primitive type
    
    additionalTypeTokens - token types besides primitive ones that can be used to specify a type
    
    packageSeparator - the token that is used to separate packages/scopes/namespaces
    
    packageSeparatorText - the string representation of the package separator
- Method Detail
  - isVariableDeclaration
```
public boolean isVariableDeclaration(java.util.List<IToken> variableTokens)
```
    Returns whether the given tokens are a variable declaration.
  - matchesFullQualifiedTypeName
```
public boolean matchesFullQualifiedTypeName(java.lang.String typeName,
                                            java.util.Collection<java.lang.String> importedNamespaces,
                                            java.lang.String fullQualifiedTypeName)
```
    Returns whether the given type name matches the given full qualified type name considering the given imported namespaces. If the given type name is null, false is returned.
  - extractConditionTokens
```
public java.util.List<IToken> extractConditionTokens(ShallowEntity statement)
```
    Extracts all tokens that are part of a condition from a statement.
  - isStatic
```
public boolean isStatic(ShallowEntity entity)
```
    Returns whether the given entity is static.
  - hasOnlyStaticMembers
```
public boolean hasOnlyStaticMembers(ShallowEntity clazz)
```
    Returns whether the given entity only has static members. If there are no attribute and methods members, false is returned.
  - getGenericNamesForType
```
public java.util.List<java.lang.String> getGenericNamesForType(ShallowEntity type)
```
    Returns a list of all generic names for the given type.
  - getGenericNamesForMethod
```
public java.util.List<java.lang.String> getGenericNamesForMethod(ShallowEntity method)
```
    Returns a list of all generic names for the given method.
  - filterGenericTokens
```
protected java.util.List<IToken> filterGenericTokens(java.util.List<IToken> genericTokens)
```
    Filters the generic tokens before converting them to their token texts. The default implementation doesn't do any filtering.
  - hasVoidReturnType
```
public boolean hasVoidReturnType(ShallowEntity method)
```
    Returns whether the given method has a void return type.
  - getReturnType
```
public java.lang.String getReturnType(ShallowEntity method)
```
    Returns the type name of the return type of the given method.
  - getMethodOpeningParenthesisIndex
```
protected int getMethodOpeningParenthesisIndex(java.util.List<IToken> methodTokens)
```
    Returns the index of the opening parenthesis of a method from the given tokens. This method may be overwritten by subclasses to handle special nesting cases like in C++ templates.
  - getParameterTokens
```
public java.util.List<IToken> getParameterTokens(ShallowEntity method)
```
    Returns a list of parameter tokens for the given method. Given an anonymous method, i.e., lambda, we return an empty list of parameters.
  - extractParameterTokens
```
protected java.util.List<IToken> extractParameterTokens(java.util.List<IToken> tokensAfterMethodName)
```
    Returns a list of parameter tokens for the given tokens after the method name.
  - getModifiersAndTypeFromTokens
```
public Pair<java.util.List<IToken>,java.lang.String> getModifiersAndTypeFromTokens(java.util.List<IToken> tokens)
```
    Extracts a list of modifiers and a type name from the given token list. The given tokens must have the pattern of a variable declaration. If no type can be found, an empty list and null is returned. The generic part of types is omitted.
  - collectTokensFromTypeAndModifications
```
protected int collectTokensFromTypeAndModifications(java.util.List<IToken> tokens,
                                                    int endIndex,
                                                    java.util.List<IToken> modifierTokens,
                                                    TypeNameTokenCollection typeName)
```
    Collects modifier and type tokens from type modifications like pointer or reference declarations and from the type type name tokens itself.
  - collectTokensFromPointers
```
protected int collectTokensFromPointers(java.util.List<IToken> tokens,
                                        int endIndex,
                                        java.util.List<IToken> modifierTokens,
                                        TypeNameTokenCollection typeName)
```
    Collects modifier tokens from pointer or reference declarations (mainly const in C++).
  - collectTokensFromType
```
protected int collectTokensFromType(java.util.List<IToken> tokens,
                                    int endIndex,
                                    TypeNameTokenCollection typeName)
```
    Collects type name tokens from a type name within a variable declaration. Generic/templated parts of the type name are filtered.
  - collectTokensFromPrimitiveType
```
protected int collectTokensFromPrimitiveType(java.util.List<IToken> tokens,
                                             int endIndex,
                                             TypeNameTokenCollection typeName)
```
    Collects type name tokens from a primitive type within a variable declaration. The assumption is that a primitive type can consists of multiple primitiveTypeTokens like "unsigned long long" in C++.
  - collectTokenFromTypePart
```
protected int collectTokenFromTypePart(java.util.List<IToken> tokens,
                                       int endIndex,
                                       TypeNameTokenCollection typeName)
```
    Collects a type name token from a part of a type name within a variable declaration. A part is the name of a namespace/package or the type's name itself. E.g. the complete typename std::vector<int> consists of the parts std and vector. Generic/templated parts are skipped.
  - collectTokensFromModifiers
```
protected int collectTokensFromModifiers(java.util.List<IToken> tokens,
                                         int endIndex,
                                         java.util.List<IToken> modifierTokens)
```
    Collects modifier tokens from modifier specifications in front of the type name within a variable declaration.
  - isTypeToken
```
public boolean isTypeToken(IToken token)
```
    Returns whether the given token is a type token.
  - isPrimitiveTypeToken
```
public boolean isPrimitiveTypeToken(IToken token)
```
    Returns whether the given token is a primitive type token.
  - reverseSkipToType
```
protected int reverseSkipToType(java.util.List<IToken> tokens)
```
    Skips from the end of the given token list (that represents a variable definition) to the token after the last token that specifies the variables type.
  - skipGeneric
```
public int skipGeneric(java.util.List<IToken> tokens,
                       int startIndex)
```
    Skips a generic or template declaration in the given token list that begins at the given start index. The token at the given index must be of type ETokenType.LT. The index of the matching closing token is returned.
  - skipGenericReverse
```
public int skipGenericReverse(java.util.List<IToken> tokens,
                              int startIndex)
```
    Skips a generic parameter (nested < and >) in reverse direction and returns the index of the first opening < token. Tje token at the given index must be of type ETokenType.GT. The index of the matching opening token is returned.
  - getSplitParameterTokens
```
public java.util.List<java.util.List<IToken>> getSplitParameterTokens(ShallowEntity method)
```
    Returns a list of lists of tokens that represent the parameters of the given method.
  - getParameterTypeNames
```
public java.util.List<java.util.Optional<java.lang.String>> getParameterTypeNames(ShallowEntity method)
```
    Returns all parameter type names of the given method. If a parameter has no name, the entry in the list is empty.
  - getTypeNameStartIndex
```
protected int getTypeNameStartIndex(java.util.List<IToken> tokens,
                                    int lastTypeTokenIndex)
```
    Return the start index of the type name that ends at the given index within the given token list. This method is used to find type names that consist of multiple tokens, e. g. names that are prefixed with a namespace.
  - getGenericTypeNames
```
public java.util.List<java.lang.String> getGenericTypeNames(java.util.List<IToken> tokens)
```
    Extracts type names that are used in generics from the given tokens.
  - splitVariableTokens
```
public java.util.List<java.util.List<IToken>> splitVariableTokens(java.util.List<IToken> variableTokens)
```
    Splits the given variable declaration tokens at commas regarding nesting between parenthesis, brackets, braces and angle brackets.
  - getVariableNamesFromTokens
```
public java.util.List<IToken> getVariableNamesFromTokens(java.util.List<IToken> variableTokens)
```
    Returns all variable name tokens from the given variable tokens.
  - getVariableNameFromTokens
```
public IToken getVariableNameFromTokens(java.util.List<IToken> tokens)
```
    Returns the variable name token from the given token list or null if none is found. The list of tokens must have the pattern of a variable declaration.
  - getVariableTypeFromTokens
```
public java.lang.String getVariableTypeFromTokens(java.util.List<IToken> tokens)
```
    Returns the type name of a variable from the declaring tokens. If none is found, null is returned.
  - getVariableNameFromCatchTokens
```
public IToken getVariableNameFromCatchTokens(java.util.List<IToken> catchTokens)
```
    Returns the variable name of an exception within a catch statement or null if the exception is not named.
  - getTypeNameFromCatchTokens
```
public java.lang.String getTypeNameFromCatchTokens(java.util.List<IToken> catchTokens)
```
    Returns the type name of an exception within a catch statement or null if none is found.
  - getVariableTokensFromForLikeTokens
```
public java.util.List<IToken> getVariableTokensFromForLikeTokens(java.util.List<IToken> forLikeTokens,
                                                                 ETokenType endToken)
```
    Returns all variable declaration tokens within a for-like statement. For-like statements are for loops and similar constructs like using and catch statements in Cs. The given end token type specifies the token where the variable declaration tokens end.
  - getVariableUsesFromTokens
```
public java.util.List<java.lang.Integer> getVariableUsesFromTokens(java.util.List<IToken> tokens,
                                                                   java.lang.String variableName,
                                                                   boolean isField,
                                                                   boolean isShadowed)
```
    Returns all token indices from the given tokens that are uses of the variable with the given name. The heuristic is to look for all occurrences of the variable name in the given tokens. An occurrence is considered as variable usage, if the following token is not in validIdentifiers. Those token types are set from the subclass for a concrete language. Internally a CLikeVariableUseExtractor is used.
    
    Parameters:
    
    isField - if the variable is a field
    
    isShadowed - if the variable is a field and shadowed by another local variable
  - getVariableReadsFromTokens
```
public java.util.List<java.lang.Integer> getVariableReadsFromTokens(java.util.List<IToken> tokens,
                                                                    java.lang.String variableName,
                                                                    boolean isField,
                                                                    boolean isShadowed)
```
    Returns all token indices from the given tokens that read the value of the variable with the given name.
    
    Parameters:
    
    isField - if the variable is a field
    
    isShadowed - if the variable is a field and shadowed by another local variable
  - getVariableWritesFromTokens
```
public java.util.List<java.lang.Integer> getVariableWritesFromTokens(java.util.List<IToken> tokens,
                                                                     java.lang.String variableName,
                                                                     boolean isField,
                                                                     boolean isShadowed)
```
    Returns all token indices from the given tokens that change the value of the variable with the given name.
    
    Parameters:
    
    isField - if the variable is a field
    
    isShadowed - if the variable is a field and shadowed by another local variable
  - isImport
```
public abstract boolean isImport(ShallowEntity entity)
```
    Returns whether the given entity is an import.
  - getImportName
```
public abstract java.lang.String getImportName(ShallowEntity entity)
```
    Returns the imported name of the given import shallow entity.
  - hasVariableLengthArgumentList
```
public boolean hasVariableLengthArgumentList(java.util.List<IToken> tokens)
```
    Returns whether the given tokens represent a variable length argument.
  - getImportedNames
```
public java.util.List<java.lang.String> getImportedNames(java.util.List<ShallowEntity> importEntities)
```
    Returns a list of names that are imported by the given "import" entities. If the import is an aliasing import (in the case of C#) it is ignored.
  - getPlainTypeName
```
public java.lang.String getPlainTypeName(java.lang.String typeName)
```
    Removes all pointer, array and reference declarations from the given typename.
  - getBaseTypeName
```
public java.lang.String getBaseTypeName(java.lang.String typeName)
```
    Returns the base name of the given type name.
  - getLanguage
```
public ELanguage getLanguage()
```
    Returns that language the feature parsers are implemented for.
    
    Specified by:
    
    getLanguage in interface ILanguageFeatureParser

Class CLikeLanguageFeatureParserBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONDITIONAL_OPERATOR_TYPES

POINTER_TYPES

TYPE_MODIFICATIONS

validIdentifiers

primitiveTypeTokens

typeTokens

useExtractor

packageSeparator

packageSeparatorText

variableSplitType

Constructor Detail

CLikeLanguageFeatureParserBase

Method Detail

isVariableDeclaration

matchesFullQualifiedTypeName

extractConditionTokens

isStatic

hasOnlyStaticMembers

getGenericNamesForType

getGenericNamesForMethod

filterGenericTokens

hasVoidReturnType

getReturnType

getMethodOpeningParenthesisIndex

getParameterTokens

extractParameterTokens

getModifiersAndTypeFromTokens

collectTokensFromTypeAndModifications

collectTokensFromPointers

collectTokensFromType

collectTokensFromPrimitiveType

collectTokenFromTypePart

collectTokensFromModifiers

isTypeToken

isPrimitiveTypeToken

reverseSkipToType

skipGeneric

skipGenericReverse

getSplitParameterTokens

getParameterTypeNames

getTypeNameStartIndex

getGenericTypeNames

splitVariableTokens

getVariableNamesFromTokens

getVariableNameFromTokens

getVariableTypeFromTokens

getVariableNameFromCatchTokens

getTypeNameFromCatchTokens

getVariableTokensFromForLikeTokens

getVariableUsesFromTokens

getVariableReadsFromTokens

getVariableWritesFromTokens

isImport

getImportName

hasVariableLengthArgumentList

getImportedNames

getPlainTypeName

getBaseTypeName

getLanguage