CppLanguageFeatureParser (Teamscale Check Framework API)

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

All Implemented Interfaces:

ILanguageFeatureParser
```
public class CppLanguageFeatureParser
extends CLikeLanguageFeatureParserBase
```
Language feature parser for C/C++.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.EnumSet<ETokenType>`	`ADDITIONAL_TYPE_TOKENS` All token types that can be used to specify a type.
`static java.util.EnumSet<ETokenType>`	`PRIMITIVE_TYPE_TOKENS` All token types that can be used to specify a type.
`static java.util.HashSet<java.lang.String>`	`STD_LIB_PROGRAM_TERMINATION_FUNCTIONS` Names of functions in the C++ standard lib that cause program termination.
`static java.util.regex.Pattern`	`VALID_IDENTIFIER_PATTERN` Regular expression describing a valid C/C++ identifier.

Fields inherited from class eu.cqse.check.framework.util.CLikeLanguageFeatureParserBase
CONDITIONAL_OPERATOR_TYPES, packageSeparator, packageSeparatorText, POINTER_TYPES, primitiveTypeTokens, TYPE_MODIFICATIONS, typeTokens, useExtractor, validIdentifiers, variableSplitType

Constructor Summary

Constructors
Constructor and Description

CppLanguageFeatureParser()
Constructor.

Constructors
Constructor and Description
`CppLanguageFeatureParser()` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.Map<java.lang.String,java.util.List<IToken>>`	`getAliasMapping(java.util.List<IToken> tokens)` Extracts a mapping of types regarding the typedef instructions found in the given tokens.
`java.lang.String`	`getImportName(ShallowEntity entity)` Returns the imported name of the given import shallow entity.
`protected int`	`getMethodOpeningParenthesisIndex(java.util.List<IToken> methodTokens)` Returns the index of the opening parenthesis of a method from the given tokens.
`boolean`	`hasVoidReturnType(ShallowEntity method)` Returns whether the given method has a void return type.
`static boolean`	`isCaseOrDefaultExitStatement(ShallowEntity entity, java.util.Set<java.lang.String> additionalExitNames, boolean isNestedSwitch)` Returns whether the given entity is a valid exit statement for a case statement also considering if we are in a nested switch statement or not
`static boolean`	`isConstant(ShallowEntity entity)` Returns whether the given entity is a constant
`static boolean`	`isCpp(java.lang.String uniformPath, java.util.List<IToken> tokens)` Returns `true` if the given uniform path has C++ related file extension or the given list of tokens contains either `ETokenType.SCOPE` or `ETokenType.CLASS`.
`static boolean`	`isCpp11DeletedFunctionOrConstructor(ShallowEntity entity)` Returns whether the given `ShallowEntity` is a function, operator, or constructor declaration that has the C++11 `TRAILING_RETURN_TYPE_TOKENS_PATTERN`.
`static boolean`	`isCppMethod(ShallowEntity entity)` A C++ method outside of a class/struct must be scoped with ::.
`static boolean`	`isFunctionDeclaration(ShallowEntity entity)` Returns whether the given entity is a function declaration
`boolean`	`isImport(ShallowEntity entity)` Returns whether the given entity is an import.
`static boolean`	`isNoreturn(ShallowEntity entity)` Returns whether the given shallow entity is marked as "_Noreturn".
`static boolean`	`isPointerDeclaration(ShallowEntity entity)` Returns true if a variable is declared as a pointer.
`static boolean`	`isTopLevelClass(ShallowEntity entity)` Returns whether the given entity is a top-level class.
`static boolean`	`isUnconditionalSwitchExit(ShallowEntity lastEntity, java.util.Set<java.lang.String> additionalExitNames, boolean isNestedSwitch)` Returns whether the given entity is an unconditional exit statement for a case statement.
`static boolean`	`isVirtual(ShallowEntity entity)` Returns whether the given shallow entity is virtual.
`static java.util.List<IToken>`	`resolveAliases(java.util.List<IToken> tokens, java.util.Map<java.lang.String,java.util.List<IToken>> aliasMapping)` Replaces the aliases introduced by typedefs and usings with their respective original type.
`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.

Methods inherited from class eu.cqse.check.framework.util.CLikeLanguageFeatureParserBase
collectTokenFromTypePart, collectTokensFromModifiers, collectTokensFromPointers, collectTokensFromPrimitiveType, collectTokensFromType, collectTokensFromTypeAndModifications, extractConditionTokens, extractParameterTokens, filterGenericTokens, getBaseTypeName, getGenericNamesForMethod, getGenericNamesForType, getGenericTypeNames, getImportedNames, getLanguage, getModifiersAndTypeFromTokens, getParameterTokens, getParameterTypeNames, getPlainTypeName, getReturnType, getSplitParameterTokens, getTypeNameFromCatchTokens, getTypeNameStartIndex, getVariableNameFromCatchTokens, getVariableNameFromTokens, getVariableNamesFromTokens, getVariableReadsFromTokens, getVariableTokensFromForLikeTokens, getVariableTypeFromTokens, getVariableUsesFromTokens, getVariableWritesFromTokens, hasOnlyStaticMembers, hasVariableLengthArgumentList, isPrimitiveTypeToken, isStatic, isTypeToken, isVariableDeclaration, matchesFullQualifiedTypeName, splitVariableTokens

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

- Field Detail
  - ADDITIONAL_TYPE_TOKENS
```
public static final java.util.EnumSet<ETokenType> ADDITIONAL_TYPE_TOKENS
```
    All token types that can be used to specify a type.
  - PRIMITIVE_TYPE_TOKENS
```
public static final java.util.EnumSet<ETokenType> PRIMITIVE_TYPE_TOKENS
```
    All token types that can be used to specify a type.
  - VALID_IDENTIFIER_PATTERN
```
public static final java.util.regex.Pattern VALID_IDENTIFIER_PATTERN
```
    Regular expression describing a valid C/C++ identifier. It can contain alphabets, digits and underscores, but cannot start with a digit.
  - STD_LIB_PROGRAM_TERMINATION_FUNCTIONS
```
public static final java.util.HashSet<java.lang.String> STD_LIB_PROGRAM_TERMINATION_FUNCTIONS
```
    Names of functions in the C++ standard lib that cause program termination. The functions are called via fully qualified name (e.g., std::abort(...)).
- Constructor Detail
  - CppLanguageFeatureParser
```
public CppLanguageFeatureParser()
```
    Constructor.
- Method Detail
  - isCpp11DeletedFunctionOrConstructor
```
public static boolean isCpp11DeletedFunctionOrConstructor(ShallowEntity entity)
```
    Returns whether the given ShallowEntity is a function, operator, or constructor declaration that has the C++11 TRAILING_RETURN_TYPE_TOKENS_PATTERN. For example foobar(const foobar&) = delete; declares a deleted constructor that can't be called (typically it must be declared because of inheritance).
  - isImport
```
public boolean isImport(ShallowEntity entity)
```
    Returns whether the given entity is an import.
    
    Specified by:
    
    isImport in class CLikeLanguageFeatureParserBase
  - getImportName
```
public java.lang.String getImportName(ShallowEntity entity)
```
    Returns the imported name of the given import shallow entity.
    
    Specified by:
    
    getImportName in class CLikeLanguageFeatureParserBase
  - hasVoidReturnType
```
public boolean hasVoidReturnType(ShallowEntity method)
```
    Returns whether the given method has a void return type.
    
    Overrides:
    
    hasVoidReturnType in class CLikeLanguageFeatureParserBase
  - isVirtual
```
public static boolean isVirtual(ShallowEntity entity)
```
    Returns whether the given shallow entity is virtual.
  - isNoreturn
```
public static boolean isNoreturn(ShallowEntity entity)
```
    Returns whether the given shallow entity is marked as "_Noreturn".
  - isConstant
```
public static boolean isConstant(ShallowEntity entity)
```
    Returns whether the given entity is a constant
  - isPointerDeclaration
```
public static boolean isPointerDeclaration(ShallowEntity entity)
```
    Returns true if a variable is declared as a pointer.
  - isCppMethod
```
public static boolean isCppMethod(ShallowEntity entity)
```
    A C++ method outside of a class/struct must be scoped with ::. This method can be used to distinguish between a C and a C++ method.
  - isCpp
```
public static boolean isCpp(java.lang.String uniformPath,
                            java.util.List<IToken> tokens)
```
    Returns true if the given uniform path has C++ related file extension or the given list of tokens contains either ETokenType.SCOPE or ETokenType.CLASS. This is a heuristic method to distinguish C from C++.
  - isTopLevelClass
```
public static boolean isTopLevelClass(ShallowEntity entity)
```
    Returns whether the given entity is a top-level class.
  - reverseSkipToType
```
protected int reverseSkipToType(java.util.List<IToken> tokens)
```
    Description copied from class: CLikeLanguageFeatureParserBase
    
    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.
    
    Overrides:
    
    reverseSkipToType in class CLikeLanguageFeatureParserBase
  - 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. In C++ constructs like "std::vector<SomeType<(1>2)>>" are allowed, thus we cannot simply skip to the matching closing token.
    
    Overrides:
    
    skipGeneric in class CLikeLanguageFeatureParserBase
  - 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. In C++ constructs like "std::vector<SomeType<(1>2)>>" are allowed, thus we cannot simply skip to the matching closing token.
    
    Overrides:
    
    skipGenericReverse in class CLikeLanguageFeatureParserBase
  - getMethodOpeningParenthesisIndex
```
protected int getMethodOpeningParenthesisIndex(java.util.List<IToken> methodTokens)
```
    Description copied from class: CLikeLanguageFeatureParserBase
    
    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.
    
    Overrides:
    
    getMethodOpeningParenthesisIndex in class CLikeLanguageFeatureParserBase
  - isFunctionDeclaration
```
public static boolean isFunctionDeclaration(ShallowEntity entity)
```
    Returns whether the given entity is a function declaration
  - isCaseOrDefaultExitStatement
```
public static boolean isCaseOrDefaultExitStatement(ShallowEntity entity,
                                                   java.util.Set<java.lang.String> additionalExitNames,
                                                   boolean isNestedSwitch)
```
    Returns whether the given entity is a valid exit statement for a case statement also considering if we are in a nested switch statement or not
  - isUnconditionalSwitchExit
```
public static boolean isUnconditionalSwitchExit(ShallowEntity lastEntity,
                                                java.util.Set<java.lang.String> additionalExitNames,
                                                boolean isNestedSwitch)
```
    Returns whether the given entity is an unconditional exit statement for a case statement. This checks isCaseOrDefaultExitStatement(ShallowEntity, Set, boolean), but also recurses in case of blocks and conditionals.
    
    Parameters:
    
    additionalExitNames - names of functions that we know are unconditional exits.
  - getAliasMapping
```
public static java.util.Map<java.lang.String,java.util.List<IToken>> getAliasMapping(java.util.List<IToken> tokens)
```
    Extracts a mapping of types regarding the typedef instructions found in the given tokens. The returned aliases will already be fully expanded, i.e. not recursive expansion is needed anymore.
    
    Parameters:
    
    tokens - the tokens that may contain typedefs
    
    Returns:
    
    a mapping between the aliases (identifiers) and the tokens that get replaced by the aliases
  - resolveAliases
```
public static java.util.List<IToken> resolveAliases(java.util.List<IToken> tokens,
                                                    java.util.Map<java.lang.String,java.util.List<IToken>> aliasMapping)
```
    Replaces the aliases introduced by typedefs and usings with their respective original type.
    
    Parameters:
    
    tokens - The tokens in which the aliases are resolved
    
    aliasMapping - The resolved alias returned by @getAliasMapping(List).

Class CppLanguageFeatureParser

Field Summary

Fields inherited from class eu.cqse.check.framework.util.CLikeLanguageFeatureParserBase

Constructor Summary

Method Summary

Methods inherited from class eu.cqse.check.framework.util.CLikeLanguageFeatureParserBase

Methods inherited from class java.lang.Object

Field Detail

ADDITIONAL_TYPE_TOKENS

PRIMITIVE_TYPE_TOKENS

VALID_IDENTIFIER_PATTERN

STD_LIB_PROGRAM_TERMINATION_FUNCTIONS

Constructor Detail

CppLanguageFeatureParser

Method Detail

isCpp11DeletedFunctionOrConstructor

isImport

getImportName

hasVoidReturnType

isVirtual

isNoreturn

isConstant

isPointerDeclaration

isCppMethod

isCpp

isTopLevelClass

reverseSkipToType

skipGeneric

skipGenericReverse

getMethodOpeningParenthesisIndex

isFunctionDeclaration

isCaseOrDefaultExitStatement

isUnconditionalSwitchExit

getAliasMapping

resolveAliases