eu.cqse.check.framework.util.abap

Class AbapLanguageFeatureParser

java.lang.Object

eu.cqse.check.framework.util.abap.AbapLanguageFeatureParser

All Implemented Interfaces:

ILanguageFeatureParser

public class AbapLanguageFeatureParser
extends java.lang.Object
implements ILanguageFeatureParser

Language feature parser for ABAP. Since ABAP is case-insensitive, all variables and types are lower-cased.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.EnumSet<ETokenType>	PARAMETER_SECTION_TOKENS EnumSet containing all token types which can appear as section headers in a parameter declaration.

Constructor Summary

Constructors

Constructor and Description
AbapLanguageFeatureParser()

Method Summary

Modifier and Type	Method and Description
static ShallowEntity	getClassDeclaration(java.util.List<ShallowEntity> rootEntities, ShallowEntity classImplementation) Gets the corresponding class declaration for the given class implementation.
java.util.List<IToken>	getDeclarationTokensForMethod(java.util.List<ShallowEntity> rootEntities, ShallowEntity methodEntity) Returns the method declaration which belongs to the given method implementation entity.
java.util.Optional<FunctionCallInfo>	getFunctionCallInfo(ShallowEntity callFunctionStatement) Parses a function call string.
ELanguage	getLanguage() Returns that language the feature parsers are implemented for.
static ShallowEntity	getMethodDeclaration(java.util.List<ShallowEntity> rootEntities, ShallowEntity methodImplementation) Gets the corresponding method declaration for the given method implementation implementation.
Pair<java.lang.String,java.lang.Integer>	getNextTypeName(java.util.List<IToken> tokens, int startIndex) Gets the type name from the given list of tokens.
java.util.List<TypedVariable>	getTypeInfoForMethodParameters(ShallowEntity entity, java.util.List<IToken> tokens) Gets type information from a list of tokens holding a method's parameter declaration part, which may either use the FOR EVENT ...
static boolean	isPossiblyIdentifier(IToken token) Checks if a token is possibly an identifier.
static java.lang.String	normalizeVariable(java.lang.String name) Lower-cases and removes leading '!', since this does not belong to the variable name.

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_SECTION_TOKENS

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

EnumSet containing all token types which can appear as section headers in a parameter declaration.

Constructor Detail

AbapLanguageFeatureParser

public AbapLanguageFeatureParser()

Method Detail

getLanguage

public ELanguage getLanguage()

Returns that language the feature parsers are implemented for.

Specified by:

getLanguage in interface ILanguageFeatureParser

getNextTypeName

public Pair<java.lang.String,java.lang.Integer> getNextTypeName(java.util.List<IToken> tokens,
                                                                int startIndex)

Gets the type name from the given list of tokens.

Parameters:

tokens - List of tokens. For example v1 TYPE t value(v2) LIKE c v TYPE t v3.

Returns:

Returns a tuple of the type name and the corresponding index of the last type token. The index is ensured to be bigger or equal to startIndex-1. If no further type is found, ("", startIndex-1) is returned.

getTypeInfoForMethodParameters

public java.util.List<TypedVariable> getTypeInfoForMethodParameters(ShallowEntity entity,
                                                                    java.util.List<IToken> tokens)

Gets type information from a list of tokens holding a method's parameter declaration part, which may either use the FOR EVENT ... OF ... IMPORTING or the normal sectioned parameter style. The given ShallowEntity is stored as declaring entity in the returned TypedVariables.

getDeclarationTokensForMethod

public java.util.List<IToken> getDeclarationTokensForMethod(java.util.List<ShallowEntity> rootEntities,
                                                            ShallowEntity methodEntity)

Returns the method declaration which belongs to the given method implementation entity. May return null if the declaration was not found, because the rootEntities given are incomplete.

getClassDeclaration

public static ShallowEntity getClassDeclaration(java.util.List<ShallowEntity> rootEntities,
                                                ShallowEntity classImplementation)

Gets the corresponding class declaration for the given class implementation. This may return null if the rootEntities are incomplete.

getMethodDeclaration

public static ShallowEntity getMethodDeclaration(java.util.List<ShallowEntity> rootEntities,
                                                 ShallowEntity methodImplementation)

Gets the corresponding method declaration for the given method implementation implementation. This may return null if the rootEntities are incomplete.

getFunctionCallInfo

public java.util.Optional<FunctionCallInfo> getFunctionCallInfo(ShallowEntity callFunctionStatement)
                                                         throws CheckException

Parses a function call string.

Returns:

Optional, empty if the given entity is not a CALL FUNCTION statement otherwise containing a FunctionCallInfo

Throws:

CheckException - if the given statement can not be parsed

normalizeVariable

public static java.lang.String normalizeVariable(java.lang.String name)

Lower-cases and removes leading '!', since this does not belong to the variable name.

isPossiblyIdentifier

public static boolean isPossiblyIdentifier(IToken token)

Checks if a token is possibly an identifier. This also considers tokens which are wrongly parsed as keyword or operator.

Returns:

true if 1) the type of the given token is either an identifier (regardless if the text is a valid ABAP identifier name) 2) the type is a keyword or an operator and the token text is a possible variable name. false otherwise.