Inline PropositionalFormulaParser

The interface `PropositionalFormulaParser` only ever had the one default
instance. Furthermore, there are no real use cases to change its
behaviour without changing the only user of it,
`PreprocessorAnnotationParser`, because the string syntax couples them
very extremely.

Note that the `WontfixTestCases` are actually parsed correctly by now.

Author: ibbem

src/main/java/org/variantsync/diffdetective/datasets/predefined/Marlin.java

@@ -3,7 +3,6 @@
 import org.variantsync.diffdetective.datasets.PatchDiffParseOptions;
 import org.variantsync.diffdetective.datasets.Repository;
 import org.variantsync.diffdetective.feature.PreprocessorAnnotationParser;
-import org.variantsync.diffdetective.feature.PropositionalFormulaParser;
 
 import java.nio.file.Path;
 
@@ -15,7 +14,6 @@
 public class Marlin {
     public static final PreprocessorAnnotationParser ANNOTATION_PARSER =
             PreprocessorAnnotationParser.CreateCppAnnotationParser(
-                    PropositionalFormulaParser.Default,
                     new MarlinCPPDiffLineFormulaExtractor()
             );
 

src/main/java/org/variantsync/diffdetective/feature/AbstractingFormulaExtractor.java

@@ -1,10 +1,12 @@
 package org.variantsync.diffdetective.feature;
 
+import org.prop4j.Literal;
+import org.prop4j.Node;
+import org.prop4j.NodeReader;
 import org.tinylog.Logger;
 import org.variantsync.diffdetective.error.UncheckedUnParseableFormulaException;
 import org.variantsync.diffdetective.error.UnparseableFormulaException;
-import org.variantsync.diffdetective.feature.cpp.AbstractingCExpressionVisitor;
-import org.variantsync.diffdetective.feature.cpp.ControllingCExpressionVisitor;
+import org.variantsync.diffdetective.util.fide.FixTrueFalse;
 
 import java.util.function.Supplier;
 import java.util.regex.Matcher;
@@ -43,7 +45,7 @@ public AbstractingFormulaExtractor(Pattern annotationPattern) {
      * @return The extracted and abstracted formula
      */
     @Override
-    public String extractFormula(final String text) throws UnparseableFormulaException {
+    public Node extractFormula(final String text) throws UnparseableFormulaException {
         final Matcher matcher = annotationPattern.matcher(text);
         final Supplier<UnparseableFormulaException> couldNotExtractFormula = () ->
                 new UnparseableFormulaException("Could not extract formula from line \"" + text + "\".");
@@ -74,7 +76,33 @@ public String extractFormula(final String text) throws UnparseableFormulaExcepti
             throw couldNotExtractFormula.get();
         }
 
-        return fm;
+        return parseFormula(fm);
+    }
+
+    /**
+     * Parser that uses the {@link NodeReader} from FeatureIDE and uses its
+     * {@link NodeReader#activateJavaSymbols() java symbols} to match operators.
+     */
+    protected Node parseFormula(String text) {
+        final NodeReader nodeReader = new NodeReader();
+        nodeReader.activateJavaSymbols();
+
+        Node node = nodeReader.stringToNode(text);
+
+        // if parsing succeeded
+        if (node != null) {
+            // TODO: Is this our desired behaviour?
+            //       If so, should we document it by not using get here
+            //       and instead keeping the witness that this call happened?
+            node = FixTrueFalse.EliminateTrueAndFalseInplace(node).get();
+        }
+
+        if (node == null) {
+//            Logger.warn("Could not parse expression '{}' to feature mapping. Usin>
+            node = new Literal(text);
+        }
+
+        return node;
     }
 
     /**

src/main/java/org/variantsync/diffdetective/feature/DiffLineFormulaExtractor.java

@@ -1,5 +1,6 @@
 package org.variantsync.diffdetective.feature;
 
+import org.prop4j.Node;
 import org.variantsync.diffdetective.error.UnparseableFormulaException;
 
 /**
@@ -21,7 +22,7 @@ public interface DiffLineFormulaExtractor {
      * @param line The line of which to get the feature mapping
      * @return The feature mapping as a String of the given line
      */
-    String extractFormula(final String line) throws UnparseableFormulaException;
+    Node extractFormula(final String line) throws UnparseableFormulaException;
 
     /**
      * Resolves any macros in the given formula that are relevant for feature annotations.

src/main/java/org/variantsync/diffdetective/feature/PreprocessorAnnotationParser.java

@@ -34,64 +34,49 @@ public class PreprocessorAnnotationParser implements AnnotationParser {
 
     /**
      * Default parser for C preprocessor annotations.
-     * Created by invoking {@link #PreprocessorAnnotationParser(Pattern, PropositionalFormulaParser, DiffLineFormulaExtractor)}.
+     * Created by invoking {@link #PreprocessorAnnotationParser(Pattern, DiffLineFormulaExtractor)}.
      */
     public static final PreprocessorAnnotationParser CPPAnnotationParser =
-            new PreprocessorAnnotationParser(CPP_PATTERN, PropositionalFormulaParser.Default, new CPPDiffLineFormulaExtractor());
+            new PreprocessorAnnotationParser(CPP_PATTERN, new CPPDiffLineFormulaExtractor());
 
     /**
      * Default parser for <a href="https://www.slashdev.ca/javapp/">JavaPP (Java PreProcessor)</a> annotations.
-     * Created by invoking {@link #PreprocessorAnnotationParser(Pattern, PropositionalFormulaParser, DiffLineFormulaExtractor)}.
+     * Created by invoking {@link #PreprocessorAnnotationParser(Pattern, DiffLineFormulaExtractor)}.
      */
     public static final PreprocessorAnnotationParser JPPAnnotationParser =
-            new PreprocessorAnnotationParser(JPP_PATTERN, PropositionalFormulaParser.Default, new JPPDiffLineFormulaExtractor());
+            new PreprocessorAnnotationParser(JPP_PATTERN, new JPPDiffLineFormulaExtractor());
 
     // Pattern that is used to identify the AnnotationType of a given annotation.
     private final Pattern annotationPattern;
-    private final PropositionalFormulaParser formulaParser;
     private final DiffLineFormulaExtractor extractor;
 
-    /**
-     * Invokes {@link #PreprocessorAnnotationParser(Pattern, PropositionalFormulaParser, DiffLineFormulaExtractor)} with
-     * the {@link PropositionalFormulaParser#Default default formula parser} and a new {@link DiffLineFormulaExtractor}.
-     *
-     * @param annotationPattern Pattern that is used to identify the AnnotationType of a given annotation; {@link #CPP_PATTERN} provides an example
-     */
-    public PreprocessorAnnotationParser(final Pattern annotationPattern, final DiffLineFormulaExtractor formulaExtractor) {
-        this(annotationPattern, PropositionalFormulaParser.Default, formulaExtractor);
-    }
-
     /**
      * Creates a new preprocessor annotation parser.
      *
      * @param annotationPattern Pattern that is used to identify the AnnotationType of a given annotation; {@link #CPP_PATTERN} provides an example
-     * @param formulaParser     Parser that is used to parse propositional formulas in conditional annotations (e.g., the formula <code>f</code> in <code>#if f</code>).
-     * @param formulaExtractor  An extractor that extracts the formula part of a preprocessor annotation that is then given to the formulaParser.
+     * @param formulaExtractor  An extractor that extracts the formula part of a preprocessor annotation
      */
-    public PreprocessorAnnotationParser(final Pattern annotationPattern, final PropositionalFormulaParser formulaParser, DiffLineFormulaExtractor formulaExtractor) {
+    public PreprocessorAnnotationParser(final Pattern annotationPattern, DiffLineFormulaExtractor formulaExtractor) {
         this.annotationPattern = annotationPattern;
-        this.formulaParser = formulaParser;
         this.extractor = formulaExtractor;
     }
 
     /**
      * Creates a new preprocessor annotation parser for C preprocessor annotations.
      *
-     * @param formulaParser    Parser that is used to parse propositional formulas in conditional annotations (e.g., the formula <code>f</code> in <code>#if f</code>).
-     * @param formulaExtractor An extractor that extracts the formula part of a preprocessor annotation that is then given to the formulaParser.
+     * @param formulaExtractor An extractor that extracts the formula part of a preprocessor annotation
      */
-    public static PreprocessorAnnotationParser CreateCppAnnotationParser(final PropositionalFormulaParser formulaParser, DiffLineFormulaExtractor formulaExtractor) {
-        return new PreprocessorAnnotationParser(CPP_PATTERN, formulaParser, formulaExtractor);
+    public static PreprocessorAnnotationParser CreateCppAnnotationParser(DiffLineFormulaExtractor formulaExtractor) {
+        return new PreprocessorAnnotationParser(CPP_PATTERN, formulaExtractor);
     }
 
     /**
      * Creates a new preprocessor annotation parser for <a href="https://www.slashdev.ca/javapp/">JavaPP (Java PreProcessor)</a> annotations.
      *
-     * @param formulaParser    Parser that is used to parse propositional formulas in conditional annotations (e.g., the formula <code>f</code> in <code>#if f</code>).
-     * @param formulaExtractor An extractor that extracts the formula part of a preprocessor annotation that is then given to the formulaParser.
+     * @param formulaExtractor An extractor that extracts the formula part of a preprocessor annotation
      */
-    public static PreprocessorAnnotationParser CreateJppAnnotationParser(final PropositionalFormulaParser formulaParser, DiffLineFormulaExtractor formulaExtractor) {
-        return new PreprocessorAnnotationParser(JPP_PATTERN, formulaParser, formulaExtractor);
+    public static PreprocessorAnnotationParser CreateJppAnnotationParser(DiffLineFormulaExtractor formulaExtractor) {
+        return new PreprocessorAnnotationParser(JPP_PATTERN, formulaExtractor);
     }
 
     /**
@@ -103,7 +88,7 @@ public static PreprocessorAnnotationParser CreateJppAnnotationParser(final Propo
      * @throws UnparseableFormulaException when {@link DiffLineFormulaExtractor#extractFormula(String)} throws.
      */
     public Node parseAnnotation(String line) throws UnparseableFormulaException {
-        return this.formulaParser.parse(extractor.extractFormula(line));
+        return extractor.extractFormula(line);
     }
 
     @Override

src/main/java/org/variantsync/diffdetective/feature/PropositionalFormulaParser.java

@@ -2,6 +2,8 @@
 
 import org.antlr.v4.runtime.CharStreams;
 import org.antlr.v4.runtime.CommonTokenStream;
+import org.prop4j.Node;
+import org.prop4j.Not;
 import org.variantsync.diffdetective.error.UnparseableFormulaException;
 import org.variantsync.diffdetective.feature.AbstractingFormulaExtractor;
 import org.variantsync.diffdetective.feature.ParseErrorListener;
@@ -36,14 +38,14 @@ public CPPDiffLineFormulaExtractor() {
      * @return The feature mapping as a String of the given line
      */
     @Override
-    public String extractFormula(final String line) throws UnparseableFormulaException {
+    public Node extractFormula(final String line) throws UnparseableFormulaException {
         // Delegate the formula extraction to AbstractingFormulaExtractor
-        String fm = super.extractFormula(line);
+        Node fm = super.extractFormula(line);
 
         // negate for ifndef
         final Matcher matcher = CPP_ANNOTATION_PATTERN.matcher(line);
         if (matcher.find() && "ifndef".equals(matcher.group(1))) {
-            fm = "!(" + fm + ")";
+            fm = new Not(fm);
         }
 
         return fm;