Treat #ifdef A like #if defined(A) instead of #if A

Author: ibbem

src/main/java/org/variantsync/diffdetective/feature/cpp/CPPDiffLineFormulaExtractor.java

@@ -2,6 +2,7 @@
 
 import org.antlr.v4.runtime.CharStreams;
 import org.antlr.v4.runtime.CommonTokenStream;
+import org.prop4j.Literal;
 import org.prop4j.Node;
 import org.prop4j.Not;
 import org.tinylog.Logger;
@@ -62,9 +63,19 @@ public Node extractFormula(final String line) throws UnparseableFormulaException
             throw new UnparseableFormulaException(e);
         }
 
-        // negate for ifndef
-        if ("ifndef".equals(annotationType)) {
-            parsedFormula = new Not(parsedFormula);
+        // treat {@code #ifdef id} and {@code #ifndef id}
+        // like {@code defined(id)} and {@code !defined(id)}
+        if ("ifdef".equals(annotationType) || "ifndef".equals(annotationType)) {
+            if (parsedFormula instanceof Literal literal) {
+                literal.var = String.format("defined(%s)", literal.var);
+
+                // negate for ifndef
+                if ("ifndef".equals(annotationType)) {
+                    literal.positive = false;
+                }
+            } else {
+                throw new UnparseableFormulaException("When using #ifdef or #ifndef, only literals are allowed. Hence, \"" + line + "\" is disallowed.");
+            }
         }
 
         return parsedFormula;

src/test/java/CPPParserTest.java

@@ -23,8 +23,8 @@ private static record ThrowingTestCase(String formula) {
     private static List<TestCase> testCases() {
         return List.of(
                 new TestCase("#if A", new Literal("A")),
-                new TestCase("#ifdef A", new Literal("A")),
-                new TestCase("#ifndef A", new Not(new Literal("A"))),
+                new TestCase("#ifdef A", new Literal("defined(A)")),
+                new TestCase("#ifndef A", new Literal("defined(A)", false)),
                 new TestCase("#elif A", new Literal("A")),
 
                 new TestCase("#if !A", new Not(new Literal("A"))),
@@ -110,7 +110,7 @@ private static List<TestCase> testCases() {
                 new TestCase("#if ' ' == 32", new Literal("' '==32")),
                 new TestCase("#if (NAME<<1) > (1<<BITS)", new Literal("(NAME<<1)>(1<<BITS)")),
                 new TestCase("#if #cpu(sparc)", new Literal("cpu(sparc)")),
-                new TestCase("#ifdef \\U0001000", new Literal("\\U0001000")),
+                new TestCase("#ifdef \\U0001000", new Literal("defined(\\U0001000)")),
                 new TestCase("#if (defined(NAME) && (NAME >= 199905) && (NAME < 1991011)) ||     (NAME >= 300000) || defined(NAME)",
                         new Or(new And(new Literal("defined(NAME)"), new Literal("NAME>=199905"), new Literal("NAME<1991011")), new Literal("NAME>=300000"), new Literal("defined(NAME)"))),
                 new TestCase("#if __has_warning(\"-Wa-warning\"_foo)", new Literal("__has_warning(\"-Wa-warning\"_foo)")),

src/test/resources/diffs/differ/a032346092e47048becb36a7cb183b4739547370.lg

@@ -2,7 +2,7 @@ v 16 NON;IF;(old: -1, diff: -1, new: -1);(old: -1, diff: -1, new: -1);True
 v 147 NON;ARTIFACT;(old: 1, diff: 1, new: 1);(old: 2, diff: 2, new: 2);;
 v 211 NON;ARTIFACT;(old: 2, diff: 2, new: 2);(old: 3, diff: 3, new: 3);;
 v 275 NON;ARTIFACT;(old: 3, diff: 3, new: 3);(old: 4, diff: 4, new: 4);;
-v 336 NON;IF;(old: 4, diff: 4, new: 4);(old: 33, diff: 33, new: 33);-_DB_STL_RESOURCE_MANAGER_H__;#ifndef _DB_STL_RESOURCE_MANAGER_H__
+v 336 NON;IF;(old: 4, diff: 4, new: 4);(old: 33, diff: 33, new: 33);-defined(_DB_STL_RESOURCE_MANAGER_H__);#ifndef _DB_STL_RESOURCE_MANAGER_H__
 v 403 NON;ARTIFACT;(old: 5, diff: 5, new: 5);(old: 6, diff: 6, new: 6);;#include <stdio.h>
 v 467 NON;ARTIFACT;(old: 6, diff: 6, new: 6);(old: 7, diff: 7, new: 7);;
 v 528 NON;IF;(old: 7, diff: 7, new: 7);(old: 9, diff: 9, new: 9);-defined(MESSAGE);#if !defined (MESSAGE)

src/test/resources/diffs/linenumbers/deleteMLM.txt

@@ -1,4 +1,4 @@
--#ifdef d10 && \
+-#if d10 && \
 -  d11
 -  d12
 -#endif

src/test/resources/diffs/linenumbers/lineno1.txt

@@ -10,7 +10,7 @@
   b8a9
 +#endif
  b9a11
--#ifdef d10 && \
+-#if d10 && \
 -  d11
 -  d12
 -#endif

src/test/resources/diffs/parser/01_expected.lg

@@ -1,5 +1,5 @@
 v 16 NON;IF;(old: -1, diff: -1, new: -1);(old: -1, diff: -1, new: -1);True
-v 136 REM;IF;(old: 1, diff: 1, new: -1);(old: 3, diff: 3, new: -1);A;#ifdef \;  A
+v 136 REM;IF;(old: 1, diff: 1, new: -1);(old: 3, diff: 3, new: -1);defined(A);#ifdef \;  A
 v 195 ADD;ARTIFACT;(old: -1, diff: 2, new: 1);(old: -1, diff: 3, new: 2);;  A
 e 136 16 b;0,-1
 e 195 16 a;-1,0

src/test/resources/diffs/parser/04_expected.lg

@@ -1,5 +1,5 @@
 v 16 NON;IF;(old: -1, diff: -1, new: -1);(old: -1, diff: -1, new: -1);True
-v 144 NON;IF;(old: 1, diff: 1, new: 1);(old: 4, diff: 4, new: 4);A;#ifdef A
+v 144 NON;IF;(old: 1, diff: 1, new: 1);(old: 4, diff: 4, new: 4);defined(A);#ifdef A
 v 211 NON;ARTIFACT;(old: 2, diff: 2, new: 2);(old: 4, diff: 4, new: 4);;  a \;  b
 e 144 16 ba;0,0
 e 211 144 ba;0,0

src/test/resources/diffs/parser/05_expected.lg

@@ -1,5 +1,5 @@
 v 16 NON;IF;(old: -1, diff: -1, new: -1);(old: -1, diff: -1, new: -1);True
-v 144 NON;IF;(old: 1, diff: 1, new: 1);(old: 4, diff: 4, new: 4);A;#ifdef A
+v 144 NON;IF;(old: 1, diff: 1, new: 1);(old: 4, diff: 4, new: 4);defined(A);#ifdef A
 v 211 NON;ARTIFACT;(old: 2, diff: 2, new: 2);(old: 4, diff: 4, new: 4);;  a \;  b
 e 144 16 ba;0,0
 e 211 144 ba;0,0

src/test/resources/diffs/parser/08_expected.lg

@@ -1,7 +1,7 @@
 v 16 NON;IF;(old: -1, diff: -1, new: -1);(old: -1, diff: -1, new: -1);True
-v 136 REM;IF;(old: 1, diff: 1, new: -1);(old: 3, diff: 4, new: -1);A;#ifdef A
+v 136 REM;IF;(old: 1, diff: 1, new: -1);(old: 3, diff: 4, new: -1);defined(A);#ifdef A
 v 275 NON;ARTIFACT;(old: 2, diff: 3, new: 2);(old: 3, diff: 4, new: 3);;Code
-v 192 ADD;IF;(old: -1, diff: 2, new: 1);(old: -1, diff: 4, new: 3);B;#ifdef B
+v 192 ADD;IF;(old: -1, diff: 2, new: 1);(old: -1, diff: 4, new: 3);defined(B);#ifdef B
 e 136 16 b;0,-1
 e 275 136 b;0,-1
 e 275 192 a;-1,0

src/test/resources/diffs/parser/09_expected.lg

@@ -1,5 +1,5 @@
 v 16 NON;IF;(old: -1, diff: -1, new: -1);(old: -1, diff: -1, new: -1);True
-v 144 NON;IF;(old: 1, diff: 1, new: 1);(old: 3, diff: 5, new: 4);A;#ifdef A
+v 144 NON;IF;(old: 1, diff: 1, new: 1);(old: 3, diff: 5, new: 4);defined(A);#ifdef A
 v 211 NON;ARTIFACT;(old: 2, diff: 2, new: 2);(old: 3, diff: 3, new: 3);;Code 1
 v 339 NON;ARTIFACT;(old: 4, diff: 4, new: 3);(old: 5, diff: 5, new: 4);;Code 2
 e 144 16 ba;0,0