Add support for CompilerVersion in compiler directive expressions

cirras · cirras · commit 0110e7961e69 · 2025-04-07T11:48:18.000+10:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Improve support for evaluating name references in compiler directive expressions.
+
 ## [1.15.0] - 2025-04-03
 
 ### Added
diff --git a/delphi-checks-testkit/src/main/java/au/com/integradev/delphi/builders/AbstractDelphiTestFile.java b/delphi-checks-testkit/src/main/java/au/com/integradev/delphi/builders/AbstractDelphiTestFile.java
@@ -89,7 +89,8 @@ private static DelphiFileConfig mockConfig() {
     when(mock.getTypeFactory()).thenReturn(typeFactory);
     when(mock.getSearchPath()).thenReturn(SearchPath.create(Collections.emptyList()));
     when(mock.getDefinitions()).thenReturn(Collections.emptySet());
-    when(mock.getPreprocessorFactory()).thenReturn(new DelphiPreprocessorFactory(Platform.WINDOWS));
+    when(mock.getPreprocessorFactory())
+        .thenReturn(new DelphiPreprocessorFactory(mock(), Platform.WINDOWS));
     return mock;
   }
 }
diff --git a/delphi-checks-testkit/src/main/java/au/com/integradev/delphi/checks/verifier/CheckVerifierImpl.java b/delphi-checks-testkit/src/main/java/au/com/integradev/delphi/checks/verifier/CheckVerifierImpl.java
@@ -436,7 +436,7 @@ private ExecutionResult execute() {
     DelphiInputFile file = testFile.delphiFile();
     SymbolTable symbolTable =
         SymbolTable.builder()
-            .preprocessorFactory(new DelphiPreprocessorFactory(Platform.WINDOWS))
+            .preprocessorFactory(new DelphiPreprocessorFactory(compilerVersion, Platform.WINDOWS))
             .typeFactory(new TypeFactoryImpl(toolchain, compilerVersion))
             .standardLibraryPath(standardLibraryPath)
             .sourceFiles(List.of(file.getSourceCodeFile().toPath()))
diff --git a/delphi-frontend/src/main/java/au/com/integradev/delphi/preprocessor/DelphiPreprocessor.java b/delphi-frontend/src/main/java/au/com/integradev/delphi/preprocessor/DelphiPreprocessor.java
@@ -25,6 +25,7 @@
 import au.com.integradev.delphi.antlr.DelphiTokenStream;
 import au.com.integradev.delphi.antlr.ast.token.DelphiTokenImpl;
 import au.com.integradev.delphi.antlr.ast.token.IncludeToken;
+import au.com.integradev.delphi.compiler.CompilerVersion;
 import au.com.integradev.delphi.compiler.Platform;
 import au.com.integradev.delphi.file.DelphiFileConfig;
 import au.com.integradev.delphi.preprocessor.directive.BranchDirective;
@@ -63,6 +64,7 @@ public class DelphiPreprocessor {
   private static final Logger LOG = LoggerFactory.getLogger(DelphiPreprocessor.class);
   private final DelphiLexer lexer;
   private final DelphiFileConfig config;
+  private final CompilerVersion compilerVersion;
   private final Platform platform;
   private final Set<String> definitions;
   private final List<CompilerDirective> directives;
@@ -77,10 +79,15 @@ public class DelphiPreprocessor {
   private List<Token> rawTokens;
   private int tokenIndex;
 
-  DelphiPreprocessor(DelphiLexer lexer, DelphiFileConfig config, Platform platform) {
+  DelphiPreprocessor(
+      DelphiLexer lexer,
+      DelphiFileConfig config,
+      CompilerVersion compilerVersion,
+      Platform platform) {
     this(
         lexer,
         config,
+        compilerVersion,
         platform,
         caseInsensitiveSet(config.getDefinitions()),
         new EnumMap<>(SwitchKind.class),
@@ -96,6 +103,7 @@ public class DelphiPreprocessor {
   private DelphiPreprocessor(
       DelphiLexer lexer,
       DelphiFileConfig config,
+      CompilerVersion compilerVersion,
       Platform platform,
       Set<String> definitions,
       Map<SwitchKind, Integer> currentSwitches,
@@ -105,6 +113,7 @@ private DelphiPreprocessor(
       boolean processingIncludeFile) {
     this.lexer = lexer;
     this.config = config;
+    this.compilerVersion = compilerVersion;
     this.platform = platform;
     this.switchRegistry = switchRegistry;
     this.textBlockLineEndingModeRegistry = textBlockLineEndingModeRegistry;
@@ -258,6 +267,7 @@ private List<Token> preprocessIncludeFile(DelphiToken location, Path path) throw
         new DelphiPreprocessor(
             includeLexer,
             config,
+            compilerVersion,
             platform,
             definitions,
             currentSwitches,
@@ -345,6 +355,10 @@ private TextBlockLineEndingMode nativeLineEnding() {
     return platform == Platform.WINDOWS ? TextBlockLineEndingMode.CRLF : TextBlockLineEndingMode.LF;
   }
 
+  public CompilerVersion getCompilerVersion() {
+    return compilerVersion;
+  }
+
   public DelphiTokenStream getTokenStream() {
     return tokenStream;
   }
diff --git a/delphi-frontend/src/main/java/au/com/integradev/delphi/preprocessor/DelphiPreprocessorFactory.java b/delphi-frontend/src/main/java/au/com/integradev/delphi/preprocessor/DelphiPreprocessorFactory.java
@@ -19,17 +19,20 @@
 package au.com.integradev.delphi.preprocessor;
 
 import au.com.integradev.delphi.antlr.DelphiLexer;
+import au.com.integradev.delphi.compiler.CompilerVersion;
 import au.com.integradev.delphi.compiler.Platform;
 import au.com.integradev.delphi.file.DelphiFileConfig;
 
 public final class DelphiPreprocessorFactory {
+  private final CompilerVersion compilerVersion;
   private final Platform platform;
 
-  public DelphiPreprocessorFactory(Platform platform) {
+  public DelphiPreprocessorFactory(CompilerVersion compilerVersion, Platform platform) {
+    this.compilerVersion = compilerVersion;
     this.platform = platform;
   }
 
   public DelphiPreprocessor createPreprocessor(DelphiLexer lexer, DelphiFileConfig config) {
-    return new DelphiPreprocessor(lexer, config, platform);
+    return new DelphiPreprocessor(lexer, config, compilerVersion, platform);
   }
 }
diff --git a/delphi-frontend/src/main/java/au/com/integradev/delphi/preprocessor/directive/expression/Expressions.java b/delphi-frontend/src/main/java/au/com/integradev/delphi/preprocessor/directive/expression/Expressions.java
@@ -37,6 +37,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import javax.annotation.Nullable;
 import org.apache.commons.lang3.StringUtils;
@@ -45,6 +46,9 @@
 import org.sonar.plugins.communitydelphi.api.type.TypeFactory;
 
 public final class Expressions {
+  private static final Pattern SYSTEM_UNIT =
+      Pattern.compile("^System\\s*\\.\\s*", Pattern.CASE_INSENSITIVE);
+
   private Expressions() {
     // Utility class
   }
@@ -77,6 +81,10 @@ public static Expression invocation(String name, List<Expression> arguments) {
     return new InvocationExpression(name, arguments);
   }
 
+  private static String removeSystemUnit(String name) {
+    return SYSTEM_UNIT.matcher(name).replaceAll("");
+  }
+
   static class BinaryExpression implements Expression {
     private static final Map<TokenType, BinaryEvaluator> EVALUATORS;
 
@@ -226,10 +234,13 @@ private NameReferenceExpression(String name) {
 
     @Override
     public ExpressionValue evaluate(DelphiPreprocessor preprocessor) {
-      if (this.name.equalsIgnoreCase("True")) {
+      String identifier = removeSystemUnit(name);
+      if (identifier.equalsIgnoreCase("True")) {
         return createBoolean(true);
-      } else if (this.name.equalsIgnoreCase("False")) {
+      } else if (identifier.equalsIgnoreCase("False")) {
         return createBoolean(false);
+      } else if (identifier.equalsIgnoreCase("CompilerVersion")) {
+        return createReal(preprocessor.getCompilerVersion().number().doubleValue());
       }
       return unknownValue();
     }
@@ -297,8 +308,7 @@ private static int sizeOf(DelphiPreprocessor preprocessor, Expression expression
     }
 
     private boolean isIntrinsic(String intrinsic, int minArguments) {
-      return StringUtils.removeStartIgnoreCase(name, "System.").equalsIgnoreCase(intrinsic)
-          && arguments.size() >= minArguments;
+      return removeSystemUnit(name).equalsIgnoreCase(intrinsic) && arguments.size() >= minArguments;
     }
 
     @Override
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/antlr/GrammarTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/antlr/GrammarTest.java
@@ -24,6 +24,7 @@
 
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
+import au.com.integradev.delphi.DelphiProperties;
 import au.com.integradev.delphi.compiler.Platform;
 import au.com.integradev.delphi.file.DelphiFile;
 import au.com.integradev.delphi.file.DelphiFile.DelphiFileConstructionException;
@@ -275,7 +276,8 @@ void testUndefinedInaccessibleNestedIfDef() {
     fileConfig =
         DelphiFile.createConfig(
             StandardCharsets.UTF_8.name(),
-            new DelphiPreprocessorFactory(Platform.WINDOWS),
+            new DelphiPreprocessorFactory(
+                DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS),
             TypeFactoryUtils.defaultFactory(),
             SearchPath.create(Collections.emptyList()),
             Set.of("Defined"));
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/cfg/ControlFlowGraphTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/cfg/ControlFlowGraphTest.java
@@ -123,7 +123,9 @@ private ControlFlowGraph buildCfg(Map<String, List<String>> sections, String inp
       Path standardLibraryPath = createStandardLibrary();
       SymbolTable symbolTable =
           SymbolTable.builder()
-              .preprocessorFactory(new DelphiPreprocessorFactory(Platform.WINDOWS))
+              .preprocessorFactory(
+                  new DelphiPreprocessorFactory(
+                      DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS))
               .typeFactory(
                   new TypeFactoryImpl(
                       DelphiProperties.COMPILER_TOOLCHAIN_DEFAULT,
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/executor/DelphiMasterExecutorTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/executor/DelphiMasterExecutorTest.java
@@ -180,7 +180,10 @@ private static DelphiFileConfig mockConfig() {
             DelphiProperties.COMPILER_TOOLCHAIN_DEFAULT, DelphiProperties.COMPILER_VERSION_DEFAULT);
     DelphiFileConfig mock = mock(DelphiFileConfig.class);
     when(mock.getEncoding()).thenReturn(StandardCharsets.UTF_8.name());
-    when(mock.getPreprocessorFactory()).thenReturn(new DelphiPreprocessorFactory(Platform.WINDOWS));
+    when(mock.getPreprocessorFactory())
+        .thenReturn(
+            new DelphiPreprocessorFactory(
+                DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS));
     when(mock.getTypeFactory()).thenReturn(typeFactory);
     when(mock.getSearchPath()).thenReturn(SearchPath.create(Collections.emptyList()));
     when(mock.getDefinitions()).thenReturn(Collections.emptySet());
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/executor/DelphiMetricsExecutorTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/executor/DelphiMetricsExecutorTest.java
@@ -178,7 +178,10 @@ private static DelphiFileConfig mockConfig() {
             DelphiProperties.COMPILER_TOOLCHAIN_DEFAULT, DelphiProperties.COMPILER_VERSION_DEFAULT);
     DelphiFileConfig mock = mock(DelphiFileConfig.class);
     when(mock.getEncoding()).thenReturn(StandardCharsets.UTF_8.name());
-    when(mock.getPreprocessorFactory()).thenReturn(new DelphiPreprocessorFactory(Platform.WINDOWS));
+    when(mock.getPreprocessorFactory())
+        .thenReturn(
+            new DelphiPreprocessorFactory(
+                DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS));
     when(mock.getTypeFactory()).thenReturn(typeFactory);
     when(mock.getSearchPath()).thenReturn(SearchPath.create(Collections.emptyList()));
     when(mock.getDefinitions()).thenReturn(Collections.emptySet());
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/executor/DelphiSymbolTableExecutorTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/executor/DelphiSymbolTableExecutorTest.java
@@ -1474,7 +1474,8 @@ private void execute(String filename, String... searchPaths) {
       throw new UncheckedIOException(e);
     }
 
-    var preprocessorFactory = new DelphiPreprocessorFactory(Platform.WINDOWS);
+    var preprocessorFactory =
+        new DelphiPreprocessorFactory(DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS);
     var typeFactory =
         new TypeFactoryImpl(
             DelphiProperties.COMPILER_TOOLCHAIN_DEFAULT, DelphiProperties.COMPILER_VERSION_DEFAULT);
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/executor/DelphiTokenExecutorTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/executor/DelphiTokenExecutorTest.java
@@ -233,7 +233,9 @@ private DelphiInputFile makeDelphiFile(String filePath) {
       DelphiFileConfig fileConfig = mock(DelphiFileConfig.class);
       when(fileConfig.getEncoding()).thenReturn(StandardCharsets.UTF_8.name());
       when(fileConfig.getPreprocessorFactory())
-          .thenReturn(new DelphiPreprocessorFactory(Platform.WINDOWS));
+          .thenReturn(
+              new DelphiPreprocessorFactory(
+                  DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS));
       when(fileConfig.getTypeFactory()).thenReturn(typeFactory);
       when(fileConfig.getSearchPath()).thenReturn(SearchPath.create(Collections.emptyList()));
       when(fileConfig.getDefinitions()).thenReturn(Collections.emptySet());
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/file/DelphiFileTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/file/DelphiFileTest.java
@@ -20,6 +20,7 @@
 
 import static org.assertj.core.api.Assertions.*;
 
+import au.com.integradev.delphi.DelphiProperties;
 import au.com.integradev.delphi.compiler.Platform;
 import au.com.integradev.delphi.core.Delphi;
 import au.com.integradev.delphi.file.DelphiFile.DelphiFileConstructionException;
@@ -66,7 +67,8 @@ void testInputFileEncodingShouldOverrideProvidedEncoding() {
     DelphiFileConfig config =
         DelphiFile.createConfig(
             StandardCharsets.UTF_8.name(),
-            new DelphiPreprocessorFactory(Platform.WINDOWS),
+            new DelphiPreprocessorFactory(
+                DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS),
             TypeFactoryUtils.defaultFactory(),
             SearchPath.create(Collections.emptyList()),
             Collections.emptySet());
@@ -82,7 +84,8 @@ void testByteOrderMarkShouldOverrideProvidedEncoding() {
     DelphiFileConfig config =
         DelphiFile.createConfig(
             StandardCharsets.UTF_8.name(),
-            new DelphiPreprocessorFactory(Platform.WINDOWS),
+            new DelphiPreprocessorFactory(
+                DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS),
             TypeFactoryUtils.defaultFactory(),
             SearchPath.create(Collections.emptyList()),
             Collections.emptySet());
@@ -98,7 +101,8 @@ void testByteOrderMarkShouldBeStripped() {
     DelphiFileConfig config =
         DelphiFile.createConfig(
             StandardCharsets.UTF_8.name(),
-            new DelphiPreprocessorFactory(Platform.WINDOWS),
+            new DelphiPreprocessorFactory(
+                DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS),
             TypeFactoryUtils.defaultFactory(),
             SearchPath.create(Collections.emptyList()),
             Collections.emptySet());
@@ -116,7 +120,8 @@ void testShouldSkipImplementation(String filename) {
     DelphiFileConfig config =
         DelphiFile.createConfig(
             StandardCharsets.UTF_8.name(),
-            new DelphiPreprocessorFactory(Platform.WINDOWS),
+            new DelphiPreprocessorFactory(
+                DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS),
             TypeFactoryUtils.defaultFactory(),
             SearchPath.create(Collections.emptyList()),
             Collections.emptySet(),
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/preprocessor/DelphiPreprocessorTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/preprocessor/DelphiPreprocessorTest.java
@@ -23,6 +23,7 @@
 import static org.assertj.core.api.Assertions.assertThatCode;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
+import au.com.integradev.delphi.DelphiProperties;
 import au.com.integradev.delphi.antlr.DelphiFileStream;
 import au.com.integradev.delphi.antlr.DelphiLexer;
 import au.com.integradev.delphi.antlr.DelphiLexer.LexerException;
@@ -135,7 +136,9 @@ void testCallingProcessTwiceShouldThrowException() throws Exception {
     DelphiFileStream fileStream = new DelphiFileStream(filePath, config.getEncoding());
 
     DelphiLexer lexer = new DelphiLexer(fileStream);
-    DelphiPreprocessor preprocessor = new DelphiPreprocessor(lexer, config, Platform.WINDOWS);
+    DelphiPreprocessor preprocessor =
+        new DelphiPreprocessor(
+            lexer, config, DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS);
     preprocessor.process();
 
     assertThatThrownBy(preprocessor::process).isInstanceOf(IllegalStateException.class);
@@ -145,7 +148,8 @@ private static void executeWithDefines(String filename, String... defines) {
     DelphiFileConfig config =
         DelphiFile.createConfig(
             UTF_8.name(),
-            new DelphiPreprocessorFactory(Platform.WINDOWS),
+            new DelphiPreprocessorFactory(
+                DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS),
             TypeFactoryUtils.defaultFactory(),
             SearchPath.create(Collections.emptyList()),
             new HashSet<>(Arrays.asList(defines)));
@@ -164,7 +168,8 @@ private static void executeWithSearchPath(String filename, String... directories
         filename,
         DelphiFile.createConfig(
             UTF_8.name(),
-            new DelphiPreprocessorFactory(Platform.WINDOWS),
+            new DelphiPreprocessorFactory(
+                DelphiProperties.COMPILER_VERSION_DEFAULT, Platform.WINDOWS),
             typeFactory,
             searchPath,
             emptySet()));
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/preprocessor/directive/expression/ExpressionsTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/preprocessor/directive/expression/ExpressionsTest.java
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/reporting/QuickFixEditTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/reporting/QuickFixEditTest.java
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/symbol/SymbolTableBuilderTest.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/symbol/SymbolTableBuilderTest.java
diff --git a/delphi-frontend/src/test/java/au/com/integradev/delphi/utils/files/DelphiFileUtils.java b/delphi-frontend/src/test/java/au/com/integradev/delphi/utils/files/DelphiFileUtils.java
diff --git a/sonar-delphi-plugin/src/main/java/au/com/integradev/delphi/DelphiSensor.java b/sonar-delphi-plugin/src/main/java/au/com/integradev/delphi/DelphiSensor.java

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,8 @@ private static DelphiFileConfig mockConfig() {`
`89`	`89`	`when(mock.getTypeFactory()).thenReturn(typeFactory);`
`90`	`90`	`when(mock.getSearchPath()).thenReturn(SearchPath.create(Collections.emptyList()));`
`91`	`91`	`when(mock.getDefinitions()).thenReturn(Collections.emptySet());`
`92`		`- when(mock.getPreprocessorFactory()).thenReturn(new DelphiPreprocessorFactory(Platform.WINDOWS));`
	`92`	`+ when(mock.getPreprocessorFactory())`
	`93`	`+ .thenReturn(new DelphiPreprocessorFactory(mock(), Platform.WINDOWS));`
`93`	`94`	`return mock;`
`94`	`95`	`}`
`95`	`96`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,17 +19,20 @@`
`19`	`19`	`package au.com.integradev.delphi.preprocessor;`
`20`	`20`
`21`	`21`	`import au.com.integradev.delphi.antlr.DelphiLexer;`
	`22`	`+import au.com.integradev.delphi.compiler.CompilerVersion;`
`22`	`23`	`import au.com.integradev.delphi.compiler.Platform;`
`23`	`24`	`import au.com.integradev.delphi.file.DelphiFileConfig;`
`24`	`25`
`25`	`26`	`public final class DelphiPreprocessorFactory {`
	`27`	`+ private final CompilerVersion compilerVersion;`
`26`	`28`	`private final Platform platform;`
`27`	`29`
`28`		`- public DelphiPreprocessorFactory(Platform platform) {`
	`30`	`+ public DelphiPreprocessorFactory(CompilerVersion compilerVersion, Platform platform) {`
	`31`	`+ this.compilerVersion = compilerVersion;`
`29`	`32`	`this.platform = platform;`
`30`	`33`	`}`
`31`	`34`
`32`	`35`	`public DelphiPreprocessor createPreprocessor(DelphiLexer lexer, DelphiFileConfig config) {`
`33`		`- return new DelphiPreprocessor(lexer, config, platform);`
	`36`	`+ return new DelphiPreprocessor(lexer, config, compilerVersion, platform);`
`34`	`37`	`}`
`35`	`38`	`}`