Merge pull request #11 from VariantSync/defliterals

Defliterals

Author: AlexanderSchultheiss

src/main/java/org/variantsync/vevos/simulation/io/kernelhaven/ArtefactCSVExporter.java

@@ -59,9 +59,9 @@ public CSV export() {
     private String[] toRow(final LineBasedAnnotation annotation) {
         final String[] row = makeRow();
         row[0] = currentFile.getFile().toString();
-        row[1] = FormulaUtils.toString(currentFile.getPresenceCondition(), NodeWriter.javaSymbols);
-        row[2] = FormulaUtils.toString(annotation.getFeatureMapping(), NodeWriter.javaSymbols);
-        row[3] = FormulaUtils.toString(annotation.getPresenceCondition(), NodeWriter.javaSymbols);
+        row[1] = FormulaUtils.toFormulaString(currentFile.getPresenceCondition(), NodeWriter.javaSymbols);
+        row[2] = FormulaUtils.toFormulaString(annotation.getFeatureMapping(), NodeWriter.javaSymbols);
+        row[3] = FormulaUtils.toFormulaString(annotation.getPresenceCondition(), NodeWriter.javaSymbols);
         row[4] = "" + annotation.getLineFrom();
         // -1 because Kernelhaven stores annotations as [#if, #endif) intervals, so we have to point one line before the annotation end (#endif).
         row[5] = "" + (annotation.getLineTo() - (annotation.isMacro() ? 1 : 0));

src/main/java/org/variantsync/vevos/simulation/util/fide/FormulaUtils.java

@@ -103,10 +103,39 @@ public static Node replaceAllInplace(final Node root, final Predicate<Node> who,
         }
     }
 
-    public static String toString(Node formula, final String[] symbols) {
+    /**
+     * Wraps a literal name in a defined statement.
+     * x -> defined(x)
+     * !x -> !defined(x)
+     */
+    private static Node ifdef(final Literal l) {
+        final Function<Object, Literal> toDefinedLiteral = s -> new Literal("defined(" + s + ")");
+
+        if (l.positive) {
+            return toDefinedLiteral.apply(l);
+        } else {
+            return new Not(toDefinedLiteral.apply(new Literal(l.var, true)));
+        }
+    }
+
+    /**
+     * Serializes the given formula to a string usable in C preprocessor conditions.
+     * True and false will be converted to 1 and 0, respectively.
+     * Variables will be wrapped in a defined expression.
+     * @see FixTrueFalse#TrueAs1
+     * @see FixTrueFalse#FalseAs0
+     */
+    public static String toCPPString(Node formula) {
         formula = replaceAll(formula, FixTrueFalse::isTrue, n -> FixTrueFalse.TrueAs1);
         formula = replaceAllInplace(formula, FixTrueFalse::isFalse, n -> FixTrueFalse.FalseAs0);
+        formula = replaceAllInplace(formula, FixTrueFalse::isVariable,
+                // we know that n is a literal because FixTureFalse::isVariable returned true
+                n -> ifdef((Literal) n)
+        );
+        return toFormulaString(formula, NodeWriter.javaSymbols);
+    }
 
+    public static String toFormulaString(final Node formula, final String[] symbols) {
         final NodeWriter writer = new NodeWriter(formula);
         writer.setNotation(NodeWriter.Notation.INFIX);
         writer.setEnquoteWhitespace(false);

src/main/java/org/variantsync/vevos/simulation/util/fide/bugfix/FixTrueFalse.java

@@ -50,6 +50,13 @@ public static boolean isFalse(final Node n) {
         return n instanceof Literal l && isFalseLiteral(l);
     }
 
+    /**
+     * @return True iff the given formula is a literal that neither {@link #isTrue} nor {@link #isFalse}.
+     */
+    public static boolean isVariable(final Node n) {
+        return n instanceof Literal l && !isTrueLiteral(l) && !isFalseLiteral(l);
+    }
+
     /**
      * @return True iff the given name represents the atomic value true w.r.t. the constant TrueNames.
      */

src/main/java/org/variantsync/vevos/simulation/variability/pc/variantlines/VariantAnnotation.java

@@ -1,8 +1,8 @@
 package org.variantsync.vevos.simulation.variability.pc.variantlines;
 
 import org.prop4j.Node;
-import org.prop4j.NodeWriter;
 import org.variantsync.vevos.simulation.util.fide.FormulaUtils;
+import org.variantsync.vevos.simulation.util.fide.bugfix.FixTrueFalse;
 import org.variantsync.vevos.simulation.variability.pc.options.VariantGenerationOptions;
 
 import java.util.ArrayList;
@@ -16,18 +16,24 @@ public record VariantAnnotation(
     public List<String> project(final VariantGenerationOptions projectionOptions, final List<String> splFileLines) {
         final List<String> result = new ArrayList<>();
 
-        if (projectionOptions.withMacros()) {
-            result.add("#if " + FormulaUtils.toString(condition, NodeWriter.javaSymbols));
+        final boolean genMacro = projectionOptions.withMacros() && !isTrue();
+
+        if (genMacro) {
+            result.add("#if " + FormulaUtils.toCPPString(condition));
         }
 
         for (final VariantLineChunk child : lines) {
             result.addAll(child.project(projectionOptions, splFileLines));
         }
 
-        if (projectionOptions.withMacros()) {
+        if (genMacro) {
             result.add("#endif");
         }
 
         return result;
     }
+
+    public boolean isTrue() {
+        return FixTrueFalse.isTrue(condition);
+    }
 }