eu.cqse.check.framework.shallowparser.languages.cs

Class CsShallowParser

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.cs.CsShallowParser

All Implemented Interfaces:

IShallowParser

public class CsShallowParser
extends CStyleShallowParserBase

Shallow parser for C#

What this parser does and does not:

• The parser recognizes types (classes, enums, interfaces), methods and attributes, and individual statements.
• 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.
• Using statements and annotations are parsed as meta information.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.EnumSet<ETokenType>	VALID_IDENTIFIERS A set of all token types that can be used as valid identifiers.

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

OPERATORS_WITH_ALTERNATIVE_REPRESENTATION

Constructor Summary

Constructors

Constructor and Description
CsShallowParser()

Method Summary

Modifier and Type	Method and Description
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 void	createStatementRules() Creates parser rules for statements.
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.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>	getTypeModifier() Returns the valid type modifiers for the language.
protected java.util.EnumSet<ETokenType>	getValidIdentifiers() Returns the set of all valid identifiers, i.e.
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, createSimpleStatementRule, createTypedefRules, skipOptionalParameters, typePatternInState

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

createRecognizer, endWithPossibleContinuation, filterTokens, 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

VALID_IDENTIFIERS

public static final java.util.EnumSet<ETokenType> VALID_IDENTIFIERS

A set of all token types that can be used as valid identifiers. See http://msdn.microsoft.com/en-us/library/x53a06bb.aspx for the full list.

Constructor Detail

CsShallowParser

public CsShallowParser()

Method Detail

createMetaRules

protected void createMetaRules()

Creates rules for meta elements.

Overrides:

createMetaRules in class CStyleShallowParserBase

createTypeRules

protected void createTypeRules()

Parser rules for module/namespace and type creation.

Overrides:

createTypeRules in class CStyleShallowParserBase

getTypeKeywords

protected java.util.EnumSet<ETokenType> getTypeKeywords()

Returns the set of keywords that start a type.

Specified by:

getTypeKeywords in class CStyleShallowParserBase

getTypeModifier

protected java.util.EnumSet<ETokenType> getTypeModifier()

Returns the valid type modifiers for the language. Default implementation returns empty set. Override to use correct modifiers.

Overrides:

getTypeModifier in class CStyleShallowParserBase

createClassElementsRules

protected void createClassElementsRules()

Parser rules for both attributes and methods.

Specified by:

createClassElementsRules in class CStyleShallowParserBase

createStatementRules

protected void createStatementRules()

Description copied from class: CStyleShallowParserBase

Creates parser rules for statements.

Overrides:

createStatementRules in class CStyleShallowParserBase

createCaseRule

protected void createCaseRule()

Case statement is parsed as meta, as it is hardly a statement on its own.

Overrides:

createCaseRule in class CStyleShallowParserBase

getValidIdentifiers

protected java.util.EnumSet<ETokenType> getValidIdentifiers()

Returns the set of all valid identifiers, i.e. token types that can be used to name elements in the language.

Also returns all contextual keywords, as they are valid identifiers in the language. See http://msdn.microsoft.com/en-us/library/x53a06bb.aspx for the full list.

Overrides:

getValidIdentifiers in class CStyleShallowParserBase

getSimpleBlockKeywordsWithParentheses

protected java.util.EnumSet<ETokenType> getSimpleBlockKeywordsWithParentheses()

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()

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()

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)

Creates a recognizer that matches all valid types.

Specified by:

typePattern in class CStyleShallowParserBase

createSubExpressionRules

protected void createSubExpressionRules()

Creates rules for dealing with constructs in subexpressions, such as anonymous classes, lambdas, etc.

Overrides:

createSubExpressionRules in class CStyleShallowParserBase

getSubExpressionRecognizer

protected RecognizerBase<EGenericParserStates> getSubExpressionRecognizer()

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)

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.