eu.cqse.check.framework.preprocessor.c

Class MacroHandlingCPreprocessorBase

java.lang.Object

eu.cqse.check.framework.preprocessor.c.MacroHandlingCPreprocessorBase

All Implemented Interfaces:

IPreprocessor

Direct Known Subclasses:

ConditionalHandlingCPreprocessorBase

public abstract class MacroHandlingCPreprocessorBase
extends java.lang.Object
implements IPreprocessor

Base class of the C preprocessor that deals with macro handling and the overall parsing. The design of the preprocessor uses inheritance to separate the aspects macro handling, include handling, and conditionals to separate classes. This is meant to keep the classes small and easier to understand, while still providing a final common class, that can be easily extended by subclassing and overriding certain methods, which would be hard when using delegation/composition.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Predicate<IToken>	IS_MACRO_TOKEN Returns whether the given token is inserted by macro expansion.
static java.lang.String	MACRO_ORIGIN The origin name used for macro tokens.
protected OverlayMacroProvider	macroProvider The macro provider used.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MacroHandlingCPreprocessorBase(IMacroProvider macroProvider) Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract void	handleInclude(java.lang.String uniformPath, IToken token, java.util.List<IToken> result, int inclusionLimit, java.util.Set<java.lang.String> seenPaths) Handles the include directive.
protected static boolean	isIfDirective(IToken token) Returns whether the given token is an if/ifdef/ifndef directive.
protected static boolean	isPragmaDirective(IToken token) Returns whether the given token is the start of a pragma directive.
protected static int	mergeExpansionIntoTokens(java.util.List<IToken> tokens, int index, java.util.List<IToken> expanded, int tokensConsumed) Merges the expanded tokens back into the tokens.
protected static java.util.List<IToken>	parseMacroContent(java.lang.String content) Parses a macor's content.
java.util.List<IToken>	preprocess(java.lang.String uniformPath, java.util.List<IToken> tokens) Performs the actual preprocessing of the given tokens.
protected java.util.List<IToken>	preprocess(java.lang.String uniformPath, java.util.List<IToken> tokens, int inclusionLimit, java.util.Set<java.lang.String> seenPaths) Performs the actual preprocessing of the given tokens.
protected abstract void	processIfDirective(java.util.List<IToken> tokens, int ifIndex, RegionSet ignoredRegions) Processes an if/ifdef/ifndef directive.
void	setUniformPath(java.lang.String uniformPath) Sets the uniform path which is used in warning messages.

Methods inherited from class java.lang.Object

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

Field Detail

MACRO_ORIGIN

public static final java.lang.String MACRO_ORIGIN

The origin name used for macro tokens.

See Also:

Constant Field Values

IS_MACRO_TOKEN

public static final java.util.function.Predicate<IToken> IS_MACRO_TOKEN

Returns whether the given token is inserted by macro expansion.

macroProvider

protected final OverlayMacroProvider macroProvider

The macro provider used.

Constructor Detail

MacroHandlingCPreprocessorBase

protected MacroHandlingCPreprocessorBase(IMacroProvider macroProvider)

Constructor.

Method Detail

preprocess

public java.util.List<IToken> preprocess(java.lang.String uniformPath,
                                         java.util.List<IToken> tokens)

Performs the actual preprocessing of the given tokens.

Specified by:

preprocess in interface IPreprocessor

Parameters:

uniformPath - may be null if this information is not available.

tokens - A list of tokens that need to be preprocessed. The given list may get modified.

Returns:

A new list with the preprocessed tokens.

setUniformPath

public void setUniformPath(java.lang.String uniformPath)

Sets the uniform path which is used in warning messages.

preprocess

protected java.util.List<IToken> preprocess(java.lang.String uniformPath,
                                            java.util.List<IToken> tokens,
                                            int inclusionLimit,
                                            java.util.Set<java.lang.String> seenPaths)

Performs the actual preprocessing of the given tokens. The given list of tokens might be changed.

Parameters:

uniformPath - may be null if this information is not available.

mergeExpansionIntoTokens

protected static int mergeExpansionIntoTokens(java.util.List<IToken> tokens,
                                              int index,
                                              java.util.List<IToken> expanded,
                                              int tokensConsumed)

Merges the expanded tokens back into the tokens. The size of the tokens list will be preserved, but parts before index might be replaced with null.

Returns:

one before the index to continue scanning from.

isIfDirective

protected static boolean isIfDirective(IToken token)

Returns whether the given token is an if/ifdef/ifndef directive.

isPragmaDirective

protected static boolean isPragmaDirective(IToken token)

Returns whether the given token is the start of a pragma directive.

handleInclude

protected abstract void handleInclude(java.lang.String uniformPath,
                                      IToken token,
                                      java.util.List<IToken> result,
                                      int inclusionLimit,
                                      java.util.Set<java.lang.String> seenPaths)

Handles the include directive.

Parameters:

uniformPath - the uniform path of the file with the include.

processIfDirective

protected abstract void processIfDirective(java.util.List<IToken> tokens,
                                           int ifIndex,
                                           RegionSet ignoredRegions)

Processes an if/ifdef/ifndef directive. This only updates ignored regions, to exclude parts of the tokens.

Parameters:

tokens - the tokens being processed.

ifIndex - the index in the tokens list, where the if directive is found.

ignoredRegions - the regions of indexes to be ignored during parsing.

parseMacroContent

protected static java.util.List<IToken> parseMacroContent(java.lang.String content)

Parses a macor's content.