Package org.variantsync.diffdetective.feature

Class PreprocessorAnnotationParser

java.lang.Object

org.variantsync.diffdetective.feature.PreprocessorAnnotationParser

All Implemented Interfaces:

AnnotationParser

Direct Known Subclasses:

CPPAnnotationParser, JPPAnnotationParser

public abstract class PreprocessorAnnotationParser
extends Object
implements AnnotationParser

A parser of preprocessor-like annotations.

Author:

Paul Bittner, Alexander Schultheiß

See Also:

• CPPAnnotationParser
• JPPAnnotationParser

Field Summary

Fields

Modifier and Type	Field	Description
protected final Pattern	annotationPattern	Pattern that is used to extract the AnnotationType and the associated formula.

Constructor Summary

Constructors

Constructor	Description
PreprocessorAnnotationParser(Pattern annotationPattern)	Creates a new preprocessor annotation parser.

Method Summary

Modifier and Type	Method	Description
Annotation	parseAnnotation(String line)	Parse the given line as an annotation.
protected AnnotationType	parseAnnotationType(String directive)	Converts the string captured by the named capture group directive of annotationPattern into an AnnotationType.
protected abstract org.prop4j.Node	parseFormula(String directive, String formula)	Parses the feature formula of a preprocessor annotation line.

Methods inherited from class java.lang.Object

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

Field Details

annotationPattern

protected final Pattern annotationPattern

Pattern that is used to extract the AnnotationType and the associated formula.

The pattern needs to contain at least the two named capture groups directive and formula. The directive group must match a string that can be processed by parseAnnotationType(java.lang.String) and whenever the resulting annotation type requires a formula, the capture group formula needs to match the formula that should be processed by parseFormula(java.lang.String,java.lang.String).

Constructor Details

PreprocessorAnnotationParser

public PreprocessorAnnotationParser(Pattern annotationPattern)

Creates a new preprocessor annotation parser.

Parameters:

annotationPattern - pattern that identifies the AnnotationType and the associated formula of an annotation

See Also:

• annotationPattern

Method Details

parseAnnotation

public Annotation parseAnnotation(String line)
                           throws UnparseableFormulaException

Description copied from interface: AnnotationParser

Parse the given line as an annotation. Note that line might also be a line in a diff (i.e., preceded by - or +).

Specified by:

parseAnnotation in interface AnnotationParser

Parameters:

line - that might contain an annotation

Returns:

the annotation type and the associated formula. If line doesn't contain an annotation, returns Annotation(AnnotationType.NONE).

Throws:

UnparseableFormulaException - if an annotation is detected but it is malformed

parseAnnotationType

protected AnnotationType parseAnnotationType(String directive)

Converts the string captured by the named capture group directive of annotationPattern into an AnnotationType.

parseFormula

protected abstract org.prop4j.Node parseFormula(String directive,
 String formula)
                                         throws UnparseableFormulaException

Parses the feature formula of a preprocessor annotation line. It should abstract complex formulas (e.g., if they contain arithmetics or macro calls) as desired. For example, for the line "#if A && B == C", this method is should be called like parseFormula("if", "A && B == C") (the exact arguments are determined by annotationPattern and it should return something like and(var("A"), var("B==C")).

This method is only called if directive actually requires a formula as determined by parseAnnotationType(java.lang.String).

Parameters:

directive - as matched by the named capture group directive of annotationPattern

formula - as matched by the named capture group formula of annotationPattern

Returns:

the feature mapping

Throws:

UnparseableFormulaException - if formula is ill-formed.