Add support for the browsing path

Author: cirras

CHANGELOG.md

@@ -9,15 +9,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Include the global browsing path in unit import resolution.
 - Reprioritize the analysis search path in the following order (highest to lowest):
   - Analysis source files (`sonar.sources`)
   - Referenced project files (`DCCReference`)
   - Search path (`DCC_UnitSearchPath`)
   - Debugger source path (`Debugger_DebugSourcePath`)
   - Library path (`DelphiLibraryPath`/`DelphiTranslatedLibraryPath`)
+  - Browsing path (`DelphiBrowsingPath`)
   - Standard library
 
-
 ## [1.12.2] - 2025-01-06
 
 ### Fixed

delphi-frontend/src/main/java/au/com/integradev/delphi/msbuild/DelphiProject.java

@@ -38,5 +38,9 @@ public interface DelphiProject {
 
   List<Path> getDebugSourceDirectories();
 
+  List<Path> getLibraryPathDirectories();
+
+  List<Path> getBrowsingPathDirectories();
+
   Map<String, String> getUnitAliases();
 }

delphi-frontend/src/main/java/au/com/integradev/delphi/msbuild/DelphiProjectHelper.java

@@ -69,6 +69,8 @@ public class DelphiProjectHelper {
   private final CompilerVersion compilerVersion;
   private final List<Path> searchDirectories;
   private final List<Path> debugSourceDirectories;
+  private final List<Path> libraryPathDirectories;
+  private final List<Path> browsingPathDirectories;
   private final List<Path> referencedFiles;
   private final Set<String> conditionalDefines;
   private final Set<String> unitScopeNames;
@@ -93,6 +95,8 @@ public DelphiProjectHelper(
     this.compilerVersion = getCompilerVersionFromSettings();
     this.searchDirectories = getSearchDirectoriesFromSettings();
     this.debugSourceDirectories = new ArrayList<>();
+    this.libraryPathDirectories = new ArrayList<>();
+    this.browsingPathDirectories = new ArrayList<>();
     this.referencedFiles = new ArrayList<>();
     this.conditionalDefines = getPredefinedConditionalDefines();
     this.unitScopeNames = getSetFromSettings(DelphiProperties.UNIT_SCOPE_NAMES_KEY);
@@ -201,6 +205,8 @@ private void indexProjects() {
     for (DelphiProject project : projects) {
       searchDirectories.addAll(project.getSearchDirectories());
       debugSourceDirectories.addAll(project.getDebugSourceDirectories());
+      libraryPathDirectories.addAll(project.getLibraryPathDirectories());
+      browsingPathDirectories.addAll(project.getBrowsingPathDirectories());
       conditionalDefines.addAll(project.getConditionalDefines());
       referencedFiles.addAll(project.getSourceFiles());
       unitScopeNames.addAll(project.getUnitScopeNames());
@@ -310,13 +316,33 @@ public List<Path> getSearchDirectories() {
   /**
    * Gets the debug source directories specified in project files
    *
-   * @return List of debug source directorie
+   * @return List of debug source directories
    */
   public List<Path> getDebugSourceDirectories() {
     indexProjects();
     return debugSourceDirectories;
   }
 
+  /**
+   * Gets the library path directories specified in project files
+   *
+   * @return List of library path directories
+   */
+  public List<Path> getLibraryPathDirectories() {
+    indexProjects();
+    return libraryPathDirectories;
+  }
+
+  /**
+   * Gets the browsing path directories specified in project files
+   *
+   * @return List of browsing path directories
+   */
+  public List<Path> getBrowsingPathDirectories() {
+    indexProjects();
+    return browsingPathDirectories;
+  }
+
   /**
    * Gets the set of conditional defines specified in settings and project files
    *

delphi-frontend/src/main/java/au/com/integradev/delphi/msbuild/DelphiProjectParser.java

@@ -66,6 +66,8 @@ public DelphiProject parse() {
     project.setUnitScopeNames(createUnitScopeNames(result.getProperties()));
     project.setSearchDirectories(createSearchDirectories(dprojDirectory, result.getProperties()));
     project.setDebugSourceDirectories(createDebugSourceDirectories(result.getProperties()));
+    project.setLibraryPath(createLibraryPathDirectories(result.getProperties()));
+    project.setBrowsingPath(createBrowsingPathDirectories(result.getProperties()));
     project.setUnitAliases(createUnitAliases(result.getProperties()));
     project.setSourceFiles(result.getSourceFiles());
 
@@ -81,31 +83,29 @@ private static Set<String> createUnitScopeNames(ProjectProperties properties) {
   }
 
   private List<Path> createSearchDirectories(Path dprojDirectory, ProjectProperties properties) {
-    /*
-     We manually append the library paths here, even though it's not strictly correct to do so.
+    List<Path> result = new ArrayList<>();
 
-     CodeGear.Delphi.Targets appends the library paths to DCC_UnitSearchPath to create a new
-     property called UnitSearchPath, which then gets passed through to the compiler.
+    result.add(dprojDirectory);
+    result.addAll(createPathList(properties, "DCC_UnitSearchPath"));
 
-     However, there are some good reasons not to just read the UnitSearchPath property:
+    return Collections.unmodifiableList(result);
+  }
 
-     - It would tie us to an implementation detail of the MSBuild glue in CodeGear.Delphi.Targets.
-     - If the UnitSearchPath property were ever renamed, we'd fall out of compatibility.
-     - Relying on CodeGear.Delphi.Targets details would require us to mock it up in testing.
-    */
+  private List<Path> createDebugSourceDirectories(ProjectProperties properties) {
+    return createPathList(properties, "Debugger_DebugSourcePath");
+  }
 
-    List<Path> allPaths = new ArrayList<>();
+  private List<Path> createLibraryPathDirectories(ProjectProperties properties) {
+    List<Path> result = new ArrayList<>();
 
-    allPaths.add(dprojDirectory);
-    allPaths.addAll(createPathList(properties, "DCC_UnitSearchPath"));
-    allPaths.addAll(createPathList(properties, "DelphiLibraryPath", false));
-    allPaths.addAll(createPathList(properties, "DelphiTranslatedLibraryPath", false));
+    result.addAll(createPathList(properties, "DelphiLibraryPath", false));
+    result.addAll(createPathList(properties, "DelphiTranslatedLibraryPath", false));
 
-    return Collections.unmodifiableList(allPaths);
+    return Collections.unmodifiableList(result);
   }
 
-  private List<Path> createDebugSourceDirectories(ProjectProperties properties) {
-    return createPathList(properties, "Debugger_DebugSourcePath");
+  private List<Path> createBrowsingPathDirectories(ProjectProperties properties) {
+    return createPathList(properties, "DelphiBrowsingPath", false);
   }
 
   private List<Path> createPathList(ProjectProperties properties, String propertyName) {
@@ -176,6 +176,8 @@ private static class DelphiProjectImpl implements DelphiProject {
     private List<Path> sourceFiles = Collections.emptyList();
     private List<Path> searchDirectories = Collections.emptyList();
     private List<Path> debugSourceDirectories = Collections.emptyList();
+    private List<Path> libraryPathDirectories = Collections.emptyList();
+    private List<Path> browsingPathDirectories = Collections.emptyList();
     private Map<String, String> unitAliases = Collections.emptyMap();
 
     private void setDefinitions(Set<String> definitions) {
@@ -199,6 +201,14 @@ private void setDebugSourceDirectories(List<Path> debugSourceDirectories) {
       this.debugSourceDirectories = List.copyOf(debugSourceDirectories);
     }
 
+    private void setLibraryPath(List<Path> libraryPathDirectories) {
+      this.libraryPathDirectories = List.copyOf(libraryPathDirectories);
+    }
+
+    private void setBrowsingPath(List<Path> browsingPathDirectories) {
+      this.browsingPathDirectories = List.copyOf(browsingPathDirectories);
+    }
+
     private void setUnitAliases(Map<String, String> unitAliases) {
       this.unitAliases = ImmutableSortedMap.copyOf(unitAliases, String.CASE_INSENSITIVE_ORDER);
     }
@@ -228,6 +238,16 @@ public List<Path> getDebugSourceDirectories() {
       return debugSourceDirectories;
     }
 
+    @Override
+    public List<Path> getLibraryPathDirectories() {
+      return libraryPathDirectories;
+    }
+
+    @Override
+    public List<Path> getBrowsingPathDirectories() {
+      return browsingPathDirectories;
+    }
+
     @Override
     public Map<String, String> getUnitAliases() {
       return unitAliases;

delphi-frontend/src/test/java/au/com/integradev/delphi/msbuild/DelphiProjectParserTest.java

@@ -57,6 +57,9 @@ class DelphiProjectParserTest {
   private static final String LIBRARY_PATH_PROJECT =
       "/au/com/integradev/delphi/msbuild/LibraryPath.dproj";
 
+  private static final String BROWSING_PATH_PROJECT =
+      "/au/com/integradev/delphi/msbuild/BrowsingPath.dproj";
+
   private EnvironmentVariableProvider environmentVariableProvider;
   private Path environmentProj;
 
@@ -158,14 +161,20 @@ void testBadSourceFileProjectShouldContainValidSourceFiles() {
   }
 
   @Test
-  void testLibraryPathShouldBeAppendedToSearchDirectories() {
+  void testLibraryPathProject() {
     DelphiProject project = parse(LIBRARY_PATH_PROJECT);
 
-    assertThat(project.getSearchDirectories())
+    assertThat(project.getLibraryPathDirectories())
         .containsExactly(
-            DelphiUtils.getResource("/au/com/integradev/delphi/msbuild").toPath(),
             DelphiUtils.getResource("/au/com/integradev/delphi").toPath(),
-            DelphiUtils.getResource("/au/com/integradev").toPath(),
-            DelphiUtils.getResource("/au/com").toPath());
+            DelphiUtils.getResource("/au/com/integradev").toPath());
+  }
+
+  @Test
+  void testBrowsingPathProject() {
+    DelphiProject project = parse(BROWSING_PATH_PROJECT);
+
+    assertThat(project.getBrowsingPathDirectories())
+        .containsExactly(DelphiUtils.getResource("/au/com/integradev/delphi").toPath());
   }
 }

delphi-frontend/src/test/resources/au/com/integradev/delphi/msbuild/BrowsingPath.dproj

@@ -0,0 +1,5 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+    <PropertyGroup>
+        <DelphiBrowsingPath>../</DelphiBrowsingPath>
+    </PropertyGroup>
+</Project>

delphi-frontend/src/test/resources/au/com/integradev/delphi/msbuild/LibraryPath.dproj

@@ -1,7 +1,6 @@
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
     <PropertyGroup>
-        <DelphiLibraryPath>../../</DelphiLibraryPath>
-        <DelphiTranslatedLibraryPath>../../../</DelphiTranslatedLibraryPath>
-        <DCC_UnitSearchPath>../</DCC_UnitSearchPath>
+        <DelphiLibraryPath>../</DelphiLibraryPath>
+        <DelphiTranslatedLibraryPath>../../</DelphiTranslatedLibraryPath>
     </PropertyGroup>
 </Project>

sonar-delphi-plugin/src/main/java/au/com/integradev/delphi/DelphiSensor.java

@@ -99,10 +99,7 @@ private void executeOnFiles(SensorContext sensorContext) {
     Iterable<InputFile> inputFiles = delphiProjectHelper.inputFiles();
     List<Path> sourceFiles = inputFilesToPaths(inputFiles);
     List<Path> referencedFiles = delphiProjectHelper.getReferencedFiles();
-    List<Path> searchPathDirectories = new ArrayList<>();
-    searchPathDirectories.addAll(delphiProjectHelper.getSearchDirectories());
-    searchPathDirectories.addAll(delphiProjectHelper.getDebugSourceDirectories());
-    SearchPath searchPath = SearchPath.create(searchPathDirectories);
+    SearchPath searchPath = createSearchPath();
 
     SymbolTable symbolTable =
         SymbolTable.builder()
@@ -153,6 +150,33 @@ private void executeOnFiles(SensorContext sensorContext) {
     }
   }
 
+  private SearchPath createSearchPath() {
+    /*
+     CodeGear.Delphi.Targets appends the library paths to DCC_UnitSearchPath to create a new
+     property called UnitSearchPath, which then gets passed through to the compiler.
+     If we were reading UnitSearchPath directly instead of DCC_UnitSearchPath, we could avoid
+     manually appending the library path here.
+
+     There's a major benefit though, as the current approach allows us to prioritize the debug
+     source paths in between DCC_UnitSearchPath and DelphiLibraryPath in the search path.
+     From the perspective of a static analysis tool, this is the more correct ordering since it's
+     common for the debug source path to contain corresponding source files for DCUs in the search
+     path. These debug sources are more local to the project than the library path and should be
+     prioritized higher.
+
+     Some more reasons not to just read the UnitSearchPath property...
+     - It would tie us to an implementation detail of the MSBuild glue in CodeGear.Delphi.Targets.
+     - If the UnitSearchPath property were ever renamed, we'd fall out of compatibility.
+     - Relying on CodeGear.Delphi.Targets details would require us to mock it up in testing.
+    */
+    List<Path> searchPathDirectories = new ArrayList<>();
+    searchPathDirectories.addAll(delphiProjectHelper.getSearchDirectories());
+    searchPathDirectories.addAll(delphiProjectHelper.getDebugSourceDirectories());
+    searchPathDirectories.addAll(delphiProjectHelper.getLibraryPathDirectories());
+    searchPathDirectories.addAll(delphiProjectHelper.getBrowsingPathDirectories());
+    return SearchPath.create(searchPathDirectories);
+  }
+
   private boolean shouldExecuteOnProject() {
     return delphiProjectHelper.shouldExecuteOnProject();
   }