eu.cqse.check.framework.shallowparser.prettyprint

Class PrettyPrintingUtils

java.lang.Object

eu.cqse.check.framework.shallowparser.prettyprint.PrettyPrintingUtils

public class PrettyPrintingUtils
extends java.lang.Object

Utility functionality for pretty-printing source code.

Constructor Summary

Constructors

Constructor and Description
PrettyPrintingUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	determineAdditionalIndent(IToken token, ELanguage language) Determines any additional indentation that should be used.
static eu.cqse.check.framework.shallowparser.prettyprint.ECasing	determineCasing(IToken token) Returns the casing to use for a token.
static boolean	determineNoIndent(IToken token) Determines whether no indentation should be used.
static eu.cqse.check.framework.shallowparser.prettyprint.ESpacing	getPostTokenSpacing(IToken token, int abapChainedStatementDepth) Returns the spacing to be used after the given token.
static eu.cqse.check.framework.shallowparser.prettyprint.ESpacing	getStatementSpacing(ShallowEntity entity, ELanguage language) Returns the spacing to be used based on the given entity.
static boolean	isDelimiter(IToken token)
static boolean	isMultiLine(IToken token) Returns if the token is a multiline token.
static boolean	isOutsideOfProcedureDivision(ShallowEntity entity) Returns true if the given entity is outside of a procedure division otherwise false.
static eu.cqse.check.framework.shallowparser.prettyprint.ESpacing	maxSpacing(eu.cqse.check.framework.shallowparser.prettyprint.ESpacing spacing1, eu.cqse.check.framework.shallowparser.prettyprint.ESpacing spacing2) Returns the larger of two spacings.
static boolean	methodEntityIsNotSectionOrParagraph(EShallowEntityType type, java.lang.String subType) Returns true if a method entity is not a section or paragraph otherwise false
static java.lang.String	trimTokenTextLine(java.lang.String line, ELanguage language) Trims a line of token text if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrettyPrintingUtils

public PrettyPrintingUtils()

Method Detail

methodEntityIsNotSectionOrParagraph

public static boolean methodEntityIsNotSectionOrParagraph(EShallowEntityType type,
                                                          java.lang.String subType)

Returns true if a method entity is not a section or paragraph otherwise false

isMultiLine

public static boolean isMultiLine(IToken token)

Returns if the token is a multiline token.

maxSpacing

public static eu.cqse.check.framework.shallowparser.prettyprint.ESpacing maxSpacing(eu.cqse.check.framework.shallowparser.prettyprint.ESpacing spacing1,
                                                                                    eu.cqse.check.framework.shallowparser.prettyprint.ESpacing spacing2)

Returns the larger of two spacings.

isOutsideOfProcedureDivision

public static boolean isOutsideOfProcedureDivision(ShallowEntity entity)

Returns true if the given entity is outside of a procedure division otherwise false.

getStatementSpacing

public static eu.cqse.check.framework.shallowparser.prettyprint.ESpacing getStatementSpacing(ShallowEntity entity,
                                                                                             ELanguage language)

Returns the spacing to be used based on the given entity.

trimTokenTextLine

public static java.lang.String trimTokenTextLine(java.lang.String line,
                                                 ELanguage language)

Trims a line of token text if necessary.

determineAdditionalIndent

public static java.lang.String determineAdditionalIndent(IToken token,
                                                         ELanguage language)

Determines any additional indentation that should be used. We use a space for Java comments.

determineNoIndent

public static boolean determineNoIndent(IToken token)

Determines whether no indentation should be used.

determineCasing

public static eu.cqse.check.framework.shallowparser.prettyprint.ECasing determineCasing(IToken token)

Returns the casing to use for a token.

isDelimiter

public static boolean isDelimiter(IToken token)

getPostTokenSpacing

public static eu.cqse.check.framework.shallowparser.prettyprint.ESpacing getPostTokenSpacing(IToken token,
                                                                                             int abapChainedStatementDepth)

Returns the spacing to be used after the given token.