Package org.variantsync.diffdetective.feature

Class PreprocessorAnnotationParser

java.lang.Object

org.variantsync.diffdetective.feature.PreprocessorAnnotationParser

All Implemented Interfaces:

AnnotationParser

public class PreprocessorAnnotationParser
extends Object
implements AnnotationParser

A parser of preprocessor-like annotations.

Author:

Paul Bittner, Alexander Schultheiß

Field Summary

Fields

Modifier and Type	Field	Description
private final Pattern	annotationPattern
protected static final Pattern	CPP_PATTERN	Matches the beginning or end of CPP conditional macros.
static final PreprocessorAnnotationParser	CPPAnnotationParser	Default parser for C preprocessor annotations.
private final DiffLineFormulaExtractor	extractor
private final PropositionalFormulaParser	formulaParser
protected static final Pattern	JPP_PATTERN	Matches the beginning or end of JPP conditional macros.
static final PreprocessorAnnotationParser	JPPAnnotationParser	Default parser for JavaPP (Java PreProcessor) annotations.

Constructor Summary

Constructors

Constructor	Description
PreprocessorAnnotationParser(Pattern annotationPattern, DiffLineFormulaExtractor formulaExtractor)	Invokes PreprocessorAnnotationParser(Pattern, PropositionalFormulaParser, DiffLineFormulaExtractor) with the default formula parser and a new DiffLineFormulaExtractor.
PreprocessorAnnotationParser(Pattern annotationPattern, PropositionalFormulaParser formulaParser, DiffLineFormulaExtractor formulaExtractor)	Creates a new preprocessor annotation parser.

Method Summary

Modifier and Type	Method	Description
static PreprocessorAnnotationParser	CreateCppAnnotationParser(PropositionalFormulaParser formulaParser, DiffLineFormulaExtractor formulaExtractor)	Creates a new preprocessor annotation parser for C preprocessor annotations.
static PreprocessorAnnotationParser	CreateJppAnnotationParser(PropositionalFormulaParser formulaParser, DiffLineFormulaExtractor formulaExtractor)	Creates a new preprocessor annotation parser for JavaPP (Java PreProcessor) annotations.
AnnotationType	determineAnnotationType(String text)	Determine the annotation type for the given piece of text (typically a line of source code).
org.prop4j.Node	parseAnnotation(String line)	Parses the condition of the given line of source code that contains a preprocessor macro (i.e., IF, IFDEF, ELIF).

Methods inherited from class java.lang.Object

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

Field Details

CPP_PATTERN

protected static final Pattern CPP_PATTERN

Matches the beginning or end of CPP conditional macros. It doesn't match the whole macro name, for example for #ifdef only "#if" is matched and only "if" is captured.

Note that this pattern doesn't handle comments between # and the macro name.

JPP_PATTERN

protected static final Pattern JPP_PATTERN

Matches the beginning or end of JPP conditional macros. It doesn't match the whole macro name, for example for //#if defined(x) only "//#if" is matched and only "if" is captured.

CPPAnnotationParser

public static final PreprocessorAnnotationParser CPPAnnotationParser

Default parser for C preprocessor annotations. Created by invoking PreprocessorAnnotationParser(Pattern, PropositionalFormulaParser, DiffLineFormulaExtractor).

JPPAnnotationParser

public static final PreprocessorAnnotationParser JPPAnnotationParser

Default parser for JavaPP (Java PreProcessor) annotations. Created by invoking PreprocessorAnnotationParser(Pattern, PropositionalFormulaParser, DiffLineFormulaExtractor).

annotationPattern

private final Pattern annotationPattern

formulaParser

private final PropositionalFormulaParser formulaParser

extractor

private final DiffLineFormulaExtractor extractor

Constructor Details

PreprocessorAnnotationParser

public PreprocessorAnnotationParser(Pattern annotationPattern,
 DiffLineFormulaExtractor formulaExtractor)

Invokes PreprocessorAnnotationParser(Pattern, PropositionalFormulaParser, DiffLineFormulaExtractor) with the default formula parser and a new DiffLineFormulaExtractor.

Parameters:

annotationPattern - Pattern that is used to identify the AnnotationType of a given annotation; CPP_PATTERN provides an example

PreprocessorAnnotationParser

public PreprocessorAnnotationParser(Pattern annotationPattern,
 PropositionalFormulaParser formulaParser,
 DiffLineFormulaExtractor formulaExtractor)

Creates a new preprocessor annotation parser.

Parameters:

annotationPattern - Pattern that is used to identify the AnnotationType of a given annotation; CPP_PATTERN provides an example

formulaParser - Parser that is used to parse propositional formulas in conditional annotations (e.g., the formula f in #if f).

formulaExtractor - An extractor that extracts the formula part of a preprocessor annotation that is then given to the formulaParser.

Method Details

CreateCppAnnotationParser

public static PreprocessorAnnotationParser CreateCppAnnotationParser(PropositionalFormulaParser formulaParser,
 DiffLineFormulaExtractor formulaExtractor)

Creates a new preprocessor annotation parser for C preprocessor annotations.

Parameters:

formulaParser - Parser that is used to parse propositional formulas in conditional annotations (e.g., the formula f in #if f).

formulaExtractor - An extractor that extracts the formula part of a preprocessor annotation that is then given to the formulaParser.

CreateJppAnnotationParser

public static PreprocessorAnnotationParser CreateJppAnnotationParser(PropositionalFormulaParser formulaParser,
 DiffLineFormulaExtractor formulaExtractor)

Creates a new preprocessor annotation parser for JavaPP (Java PreProcessor) annotations.

Parameters:

formulaParser - Parser that is used to parse propositional formulas in conditional annotations (e.g., the formula f in #if f).

formulaExtractor - An extractor that extracts the formula part of a preprocessor annotation that is then given to the formulaParser.

parseAnnotation

public org.prop4j.Node parseAnnotation(String line)
                                throws UnparseableFormulaException

Parses the condition of the given line of source code that contains a preprocessor macro (i.e., IF, IFDEF, ELIF).

Specified by:

parseAnnotation in interface AnnotationParser

Parameters:

line - The line of code of a preprocessor annotation.

Returns:

The formula of the macro in the given line. If no such formula could be parsed, returns a Literal with the line's condition as name.

Throws:

UnparseableFormulaException - when DiffLineFormulaExtractor.extractFormula(String) throws.

determineAnnotationType

public AnnotationType determineAnnotationType(String text)

Description copied from interface: AnnotationParser

Determine the annotation type for the given piece of text (typically a line of source code).

Specified by:

determineAnnotationType in interface AnnotationParser

Parameters:

text - The text of which the type is determined.

Returns:

The annotation type of the piece of text.