CppShallowParser (Teamscale Check Framework API)

java.lang.Object
- eu.cqse.check.framework.shallowparser.framework.ShallowParserBase<EGenericParserStates>
- - eu.cqse.check.framework.shallowparser.languages.base.CStyleShallowParserBase
  - - eu.cqse.check.framework.shallowparser.languages.cpp.CppShallowParser

All Implemented Interfaces:

IShallowParser

Direct Known Subclasses:

OpenCLShallowParser
```
public class CppShallowParser
extends CStyleShallowParserBase
```
Shallow parser for C/C++14.
What this parser does and does not:
- The parser recognizes types (classes, enums, interfaces), methods and attributes, individual statements and lambdas.
- It recognizes the nesting of statements (e.g. in loops), but does not parse into the statements. For example, it recognizes an if-statement and provides the list of sub-statements, but does not provide direct access to the if-condition.
- All preprocessor statements are parsed as meta information.
- Template declarations are parsed as preceding meta information.
- Forward declarations are handled as meta information.
- We heuristically filter code generating macros, such as "CREATE_STUFF(MyClass)".

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.util.EnumSet<ETokenType>`	`BASE_TYPE_OR_IDENTIFIER` Base token types for types or identifiers (without primitive types).
`protected static java.util.EnumSet<ETokenType>`	`METHOD_AND_TYPE_DECLARATION_MODIFIERS` Token types that are modifiers in front of a type declaration or method.
`protected static java.util.EnumSet<ETokenType>`	`PRIMITIVE_TYPES` Basic keywords used for primitive types in a C++ like language.

Fields inherited from class eu.cqse.check.framework.shallowparser.languages.base.CStyleShallowParserBase
OPERATORS_WITH_ALTERNATIVE_REPRESENTATION

Constructor Summary

Constructors
Constructor and Description

CppShallowParser()

Constructors
Constructor and Description
`CppShallowParser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`contributeExpandedMacroRule()` Rules for detecting expanded macros in C/C++ code.
`protected RecognizerBase<EGenericParserStates>`	`createAnnotationSubrecognizer()` Returns a subrecognizer for C++ annotations/attributes.
`protected void`	`createCaseRule()` Case statement is parsed as meta, as it is hardly a statement on its own.
`protected void`	`createClassElementsRules()` Parser rules for both attributes and methods.
`protected void`	`createMetaRules()` Creates rules for meta elements.
`protected RecognizerBase<EGenericParserStates>`	`createScopeRecognizer()` Creates a new recognizer that can match a scope prefix for a method-like construct.
`protected void`	`createSimpleStatementRule()` Simple statement.
`protected void`	`createSubExpressionRules()` Creates rules for dealing with constructs in subexpressions, such as anonymous classes, lambdas, etc.
`protected void`	`createTypeRules()` Parser rules for module/namespace and type creation.
`protected java.util.List<IToken>`	`filterTokens(java.util.List<IToken> tokens)` Creates a filtered view of the tokens.
`java.util.EnumSet<ETokenType>`	`getMethodAndTypeDeclarationModifiers()` Returns all method and type declaration modifiers.
`protected java.util.EnumSet<ETokenType>`	`getPrimitiveTypes()` Returns all primitive token types.
`protected java.util.EnumSet<ETokenType>`	`getSimpleBlockKeywordsWithoutParentheses()` Returns the set of all keywords that start a simple block but are never followed by parentheses (see implementers for examples).
`protected java.util.EnumSet<ETokenType>`	`getSimpleBlockKeywordsWithParentheses()` Returns the set of all keywords that start a simple block with optional parentheses (see implementers for examples).
`protected java.util.EnumSet<ETokenType>`	`getStatementStartTokens()` Returns a set of all tokens that can start a statement, besides a type (see `CStyleShallowParserBase.typePatternInState(EGenericParserStates...)` and a literal.
`protected RecognizerBase<EGenericParserStates>`	`getSubExpressionRecognizer()` Returns a recognizer used for detecting sub expressions (anonymous classes, lambdas, etc.) within expressions.
`protected java.util.EnumSet<ETokenType>`	`getTypeKeywords()` Returns the set of keywords that start a type.
`protected java.util.EnumSet<ETokenType>`	`getTypeOrIdentifier()` Returns all primitive token types.
`protected boolean`	`isFilteredToken(IToken token, IToken previousToken)` Template method that can be used to ignore/filter certain tokens.
`protected RecognizerBase<EGenericParserStates>`	`typePattern(RecognizerBase<EGenericParserStates> currentState)` Creates a recognizer that matches all valid types.

Methods inherited from class eu.cqse.check.framework.shallowparser.languages.base.CStyleShallowParserBase
completeSimpleStatement, completeSimpleStatement, contributeSimpleStatementRules, createBasicBlockRules, createBlockRuleWithContinuation, createDoWhileRule, createElseIfRule, createLambdaWithArrowRules, createStatementRules, createTypedefRules, getTypeModifier, getValidIdentifiers, skipOptionalParameters, typePatternInState

Methods inherited from class eu.cqse.check.framework.shallowparser.framework.ShallowParserBase
createRecognizer, endWithPossibleContinuation, inAnyState, inState, parse, parseFragment, parseTopLevel

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

- Field Detail
  - PRIMITIVE_TYPES
```
protected static final java.util.EnumSet<ETokenType> PRIMITIVE_TYPES
```
    Basic keywords used for primitive types in a C++ like language.
  - BASE_TYPE_OR_IDENTIFIER
```
protected static final java.util.EnumSet<ETokenType> BASE_TYPE_OR_IDENTIFIER
```
    Base token types for types or identifiers (without primitive types).
  - METHOD_AND_TYPE_DECLARATION_MODIFIERS
```
protected static final java.util.EnumSet<ETokenType> METHOD_AND_TYPE_DECLARATION_MODIFIERS
```
    Token types that are modifiers in front of a type declaration or method.
- Constructor Detail
  - CppShallowParser
```
public CppShallowParser()
```
- Method Detail
  - createMetaRules
```
protected void createMetaRules()
```
    Description copied from class: CStyleShallowParserBase
    
    Creates rules for meta elements.
    
    Overrides:
    
    createMetaRules in class CStyleShallowParserBase
  - createClassElementsRules
```
protected void createClassElementsRules()
```
    Description copied from class: CStyleShallowParserBase
    
    Parser rules for both attributes and methods.
    
    Specified by:
    
    createClassElementsRules in class CStyleShallowParserBase
  - createTypeRules
```
protected void createTypeRules()
```
    Description copied from class: CStyleShallowParserBase
    
    Parser rules for module/namespace and type creation.
    
    Overrides:
    
    createTypeRules in class CStyleShallowParserBase
  - createAnnotationSubrecognizer
```
protected RecognizerBase<EGenericParserStates> createAnnotationSubrecognizer()
```
    Returns a subrecognizer for C++ annotations/attributes.
  - getTypeKeywords
```
protected java.util.EnumSet<ETokenType> getTypeKeywords()
```
    Description copied from class: CStyleShallowParserBase
    
    Returns the set of keywords that start a type.
    
    Specified by:
    
    getTypeKeywords in class CStyleShallowParserBase
  - getPrimitiveTypes
```
protected java.util.EnumSet<ETokenType> getPrimitiveTypes()
```
    Returns all primitive token types.
  - getTypeOrIdentifier
```
protected java.util.EnumSet<ETokenType> getTypeOrIdentifier()
```
    Returns all primitive token types.
  - getMethodAndTypeDeclarationModifiers
```
public java.util.EnumSet<ETokenType> getMethodAndTypeDeclarationModifiers()
```
    Returns all method and type declaration modifiers.
  - createScopeRecognizer
```
protected RecognizerBase<EGenericParserStates> createScopeRecognizer()
```
    Creates a new recognizer that can match a scope prefix for a method-like construct. This includes sequences of identifiers with double colon, possibly intermixed with template arguments.
  - createCaseRule
```
protected void createCaseRule()
```
    Description copied from class: CStyleShallowParserBase
    
    Case statement is parsed as meta, as it is hardly a statement on its own.
    
    Overrides:
    
    createCaseRule in class CStyleShallowParserBase
  - contributeExpandedMacroRule
```
protected void contributeExpandedMacroRule()
```
    Rules for detecting expanded macros in C/C++ code.
  - createSimpleStatementRule
```
protected void createSimpleStatementRule()
```
    Description copied from class: CStyleShallowParserBase
    
    Simple statement.
    
    Overrides:
    
    createSimpleStatementRule in class CStyleShallowParserBase
  - getSimpleBlockKeywordsWithParentheses
```
protected java.util.EnumSet<ETokenType> getSimpleBlockKeywordsWithParentheses()
```
    Description copied from class: CStyleShallowParserBase
    
    Returns the set of all keywords that start a simple block with optional parentheses (see implementers for examples).
    
    Specified by:
    
    getSimpleBlockKeywordsWithParentheses in class CStyleShallowParserBase
  - getSimpleBlockKeywordsWithoutParentheses
```
protected java.util.EnumSet<ETokenType> getSimpleBlockKeywordsWithoutParentheses()
```
    Description copied from class: CStyleShallowParserBase
    
    Returns the set of all keywords that start a simple block but are never followed by parentheses (see implementers for examples).
    
    Specified by:
    
    getSimpleBlockKeywordsWithoutParentheses in class CStyleShallowParserBase
  - getStatementStartTokens
```
protected java.util.EnumSet<ETokenType> getStatementStartTokens()
```
    Description copied from class: CStyleShallowParserBase
    
    Returns a set of all tokens that can start a statement, besides a type (see CStyleShallowParserBase.typePatternInState(EGenericParserStates...) and a literal.
    
    Specified by:
    
    getStatementStartTokens in class CStyleShallowParserBase
  - typePattern
```
protected RecognizerBase<EGenericParserStates> typePattern(RecognizerBase<EGenericParserStates> currentState)
```
    Description copied from class: CStyleShallowParserBase
    
    Creates a recognizer that matches all valid types.
    
    Specified by:
    
    typePattern in class CStyleShallowParserBase
  - createSubExpressionRules
```
protected void createSubExpressionRules()
```
    Description copied from class: CStyleShallowParserBase
    
    Creates rules for dealing with constructs in subexpressions, such as anonymous classes, lambdas, etc.
    
    Overrides:
    
    createSubExpressionRules in class CStyleShallowParserBase
  - getSubExpressionRecognizer
```
protected RecognizerBase<EGenericParserStates> getSubExpressionRecognizer()
```
    Description copied from class: CStyleShallowParserBase
    
    Returns a recognizer used for detecting sub expressions (anonymous classes, lambdas, etc.) within expressions. This may return null (which is done by the default implementation).
    
    Overrides:
    
    getSubExpressionRecognizer in class CStyleShallowParserBase
  - isFilteredToken
```
protected boolean isFilteredToken(IToken token,
                                  IToken previousToken)
```
    Description copied from class: ShallowParserBase
    
    Template method that can be used to ignore/filter certain tokens. Default implementation ignores comments.
    
    Overrides:
    
    isFilteredToken in class ShallowParserBase<EGenericParserStates>
    
    previousToken - the last non-filtered token (can be used for context sensitive filtering). This may be null is no previous token exists.
  - filterTokens
```
protected java.util.List<IToken> filterTokens(java.util.List<IToken> tokens)
```
    Description copied from class: ShallowParserBase
    
    Creates a filtered view of the tokens.
    
    Overrides:
    
    filterTokens in class ShallowParserBase<EGenericParserStates>

Class CppShallowParser

Field Summary

Fields inherited from class eu.cqse.check.framework.shallowparser.languages.base.CStyleShallowParserBase

Constructor Summary

Method Summary

Methods inherited from class eu.cqse.check.framework.shallowparser.languages.base.CStyleShallowParserBase

Methods inherited from class eu.cqse.check.framework.shallowparser.framework.ShallowParserBase

Methods inherited from class java.lang.Object

Field Detail

PRIMITIVE_TYPES

BASE_TYPE_OR_IDENTIFIER

METHOD_AND_TYPE_DECLARATION_MODIFIERS

Constructor Detail

CppShallowParser

Method Detail

createMetaRules

createClassElementsRules

createTypeRules

createAnnotationSubrecognizer

getTypeKeywords

getPrimitiveTypes

getTypeOrIdentifier

getMethodAndTypeDeclarationModifiers

createScopeRecognizer

createCaseRule

contributeExpandedMacroRule

createSimpleStatementRule

getSimpleBlockKeywordsWithParentheses

getSimpleBlockKeywordsWithoutParentheses

getStatementStartTokens

typePattern

createSubExpressionRules

getSubExpressionRecognizer

isFilteredToken

filterTokens