eu.cqse.check.framework.preprocessor.c

Class CPreprocessor

java.lang.Object

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

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

eu.cqse.check.framework.preprocessor.c.CPreprocessor

All Implemented Interfaces:

IPreprocessor

public class CPreprocessor
extends ConditionalHandlingCPreprocessorBase

An implementation of the C preprocessor that is adjusted to application in static analysis. For this, various options of preprocessing can be adjusted. This class adds include handling to its base classes. 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.regex.Pattern	INCLUDE_PATTERN Patterns used for parsing include statements.

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

IS_MACRO_TOKEN, MACRO_ORIGIN, macroProvider

Constructor Summary

Constructors

Constructor and Description
CPreprocessor(IMacroProvider macroProvider) Constructor.

Method Summary

Modifier and Type	Method and Description
protected 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.
static void	removePreprocessorTokens(java.util.List<ShallowEntity> entities) A post processing operation that removes all tokens that have been inserted by the C++ preprocessor as result of the macro expansion.
protected Pair<java.lang.String,java.lang.String>	resolveIncludeContent(java.lang.String includingUniformPath, java.lang.String includedName) Returns the resolved uniform path and content of an included file.
protected IncludedTokens	resolveIncludedTokens(java.lang.String includingUniformPath, java.lang.String includedName) Returns the included tokens for a given include name.

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

conditionIsTrue, decideRegionInclusion, processIfDirective

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

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

Field Detail

INCLUDE_PATTERN

public static final java.util.regex.Pattern INCLUDE_PATTERN

Patterns used for parsing include statements.

Constructor Detail

CPreprocessor

public CPreprocessor(IMacroProvider macroProvider)

Constructor.

Method Detail

removePreprocessorTokens

public static void removePreprocessorTokens(java.util.List<ShallowEntity> entities)

A post processing operation that removes all tokens that have been inserted by the C++ preprocessor as result of the macro expansion. Modifies the given collection.

handleInclude

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

Specified by:

handleInclude in class MacroHandlingCPreprocessorBase

Parameters:

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

resolveIncludedTokens

protected IncludedTokens resolveIncludedTokens(java.lang.String includingUniformPath,
                                               java.lang.String includedName)

Returns the included tokens for a given include name.

Parameters:

includingUniformPath - the uniform path of the file that includes this. May be null if no information is available.

includedName - the name of the file to be included.

Returns:

the pair of the name of the resolved uniform path of the include file and the file's tokens. The resolved uniform path may be null, if it is not available.

resolveIncludeContent

protected Pair<java.lang.String,java.lang.String> resolveIncludeContent(java.lang.String includingUniformPath,
                                                                        java.lang.String includedName)

Returns the resolved uniform path and content of an included file. The default implementation returns a pair of null and the empty string.

Parameters:

includingUniformPath - the uniform path of the file that includes this. May be null if no information is available.

includedName - the name of the file to be included.

Returns:

the pair of the name of the resolved uniform path of the include file and the file's content. The resolved uniform path may be null, if it is not available.