eu.cqse.check.framework.preprocessor.c

Class ConditionalHandlingCPreprocessorBase

java.lang.Object

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

eu.cqse.check.framework.preprocessor.c.ConditionalHandlingCPreprocessorBase

All Implemented Interfaces:

IPreprocessor

Direct Known Subclasses:

CPreprocessor

public abstract class ConditionalHandlingCPreprocessorBase
extends MacroHandlingCPreprocessorBase

Base class of the C preprocessor that deals with conditionals in addition to 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 inherited from class eu.cqse.check.framework.preprocessor.c.MacroHandlingCPreprocessorBase

IS_MACRO_TOKEN, MACRO_ORIGIN, macroProvider

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected boolean	conditionIsTrue(java.lang.String condition) Evaluates an if condition and returns its boolean value.
protected void	decideRegionInclusion(java.util.List<eu.cqse.check.framework.preprocessor.c.IfRegionDescriptor> ifRegions) Decides for each ifRegion, whether it should be included or not.
protected void	processIfDirective(java.util.List<IToken> tokens, int ifIndex, RegionSet ignoredRegions) Processes an if/ifdef/ifndef directive.

Methods inherited from class eu.cqse.check.framework.preprocessor.c.MacroHandlingCPreprocessorBase

handleInclude, isIfDirective, isPragmaDirective, mergeExpansionIntoTokens, parseMacroContent, preprocess, preprocess, setUniformPath

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionalHandlingCPreprocessorBase

protected ConditionalHandlingCPreprocessorBase(IMacroProvider macroProvider)

Constructor.

Method Detail

processIfDirective

protected 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.

Specified by:

processIfDirective in class MacroHandlingCPreprocessorBase

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.

decideRegionInclusion

protected void decideRegionInclusion(java.util.List<eu.cqse.check.framework.preprocessor.c.IfRegionDescriptor> ifRegions)

Decides for each ifRegion, whether it should be included or not. The default implementation does this by checking each region's condition and selecting the first region with a true condition. Sub classes may change the behavior, by including one or multiple regions based on other criteria.

Parameters:

ifRegions - the regions to decide for. The inclusion of the regions is initially false and must be updated, if a region should be included.

conditionIsTrue

protected boolean conditionIsTrue(java.lang.String condition)

Evaluates an if condition and returns its boolean value.