Merge pull request #2254 from ahoppen/remove-pound-if

Author: ahoppen

Sources/BuildServerIntegration/BuildServerManager.swift

@@ -1349,36 +1349,36 @@ package actor BuildServerManager: QueueBasedMessageHandler {
       return [uri]
     }
     let mainFiles = Array(await mainFilesProvider.mainFiles(containing: uri, crossLanguage: false))
-    #if canImport(Darwin)
-    if let buildableSourceFiles = try? await self.buildableSourceFiles() {
-      return mainFiles.map { mainFile in
-        if mainFile == uri {
-          // Do not apply the standardized file normalization to the source file itself. Otherwise we would get the
-          // following behavior:
-          //  - We have a build server that uses standardized file paths and index a file as /tmp/test.c
-          //  - We are asking for the main files of /private/tmp/test.c
-          //  - Since indexstore-db uses realpath for everything, we find the unit for /tmp/test.c as a unit containg
-          //    /private/tmp/test.c, which has /private/tmp/test.c as the main file.
-          //  - If we applied the path normalization, we would normalize /private/tmp/test.c to /tmp/test.c, thus
-          //    reporting that /tmp/test.c is a main file containing /private/tmp/test.c,
-          // But that doesn't make sense (it would, in fact cause us to treat /private/tmp/test.c as a header file that
-          // we should index using /tmp/test.c as a main file.
-          return mainFile
-        }
-        if buildableSourceFiles.contains(mainFile) {
-          return mainFile
-        }
-        guard let fileURL = mainFile.fileURL else {
+    if Platform.current == .darwin {
+      if let buildableSourceFiles = try? await self.buildableSourceFiles() {
+        return mainFiles.map { mainFile in
+          if mainFile == uri {
+            // Do not apply the standardized file normalization to the source file itself. Otherwise we would get the
+            // following behavior:
+            //  - We have a build server that uses standardized file paths and index a file as /tmp/test.c
+            //  - We are asking for the main files of /private/tmp/test.c
+            //  - Since indexstore-db uses realpath for everything, we find the unit for /tmp/test.c as a unit containg
+            //    /private/tmp/test.c, which has /private/tmp/test.c as the main file.
+            //  - If we applied the path normalization, we would normalize /private/tmp/test.c to /tmp/test.c, thus
+            //    reporting that /tmp/test.c is a main file containing /private/tmp/test.c,
+            // But that doesn't make sense (it would, in fact cause us to treat /private/tmp/test.c as a header file that
+            // we should index using /tmp/test.c as a main file.
+            return mainFile
+          }
+          if buildableSourceFiles.contains(mainFile) {
+            return mainFile
+          }
+          guard let fileURL = mainFile.fileURL else {
+            return mainFile
+          }
+          let standardized = DocumentURI(fileURL.standardizedFileURL)
+          if buildableSourceFiles.contains(standardized) {
+            return standardized
+          }
           return mainFile
         }
-        let standardized = DocumentURI(fileURL.standardizedFileURL)
-        if buildableSourceFiles.contains(standardized) {
-          return standardized
-        }
-        return mainFile
       }
     }
-    #endif
     return mainFiles
   }
 

Sources/SKTestSupport/PluginPaths.swift

@@ -11,29 +11,31 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
+import SKLogging
 package import SourceKitD
+import SwiftExtensions
 import ToolchainRegistry
 
 // Anchor class to lookup the testing bundle when swiftpm-testing-helper is used.
 private final class TestingAnchor {}
 
 /// The path to the `SwiftSourceKitPluginTests` test bundle. This gives us a hook into the the build directory.
 private let xctestBundle: URL = {
-  #if canImport(Darwin)
-  for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(".xctest") {
-    return bundle.bundleURL
-  }
-  let bundle = Bundle(for: TestingAnchor.self)
-  if bundle.bundlePath.hasSuffix(".xctest") {
-    return bundle.bundleURL
+  if Platform.current == .darwin {
+    for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(".xctest") {
+      return bundle.bundleURL
+    }
+    let bundle = Bundle(for: TestingAnchor.self)
+    if bundle.bundlePath.hasSuffix(".xctest") {
+      return bundle.bundleURL
+    }
+    preconditionFailure("Failed to find xctest bundle")
+  } else {
+    return URL(
+      fileURLWithPath: CommandLine.arguments.first!,
+      relativeTo: URL(fileURLWithPath: FileManager.default.currentDirectoryPath)
+    )
   }
-  preconditionFailure("Failed to find xctest bundle")
-  #else
-  return URL(
-    fileURLWithPath: CommandLine.arguments.first!,
-    relativeTo: URL(fileURLWithPath: FileManager.default.currentDirectoryPath)
-  )
-  #endif
 }()
 
 /// When running tests from Xcode, determine the build configuration of the package.
@@ -90,16 +92,23 @@ private func pluginPaths(relativeTo base: URL) -> PluginPaths? {
 
   // When building using 'swift test'
   do {
-    #if canImport(Darwin)
-    let clientPluginName = "libSwiftSourceKitClientPlugin.dylib"
-    let servicePluginName = "libSwiftSourceKitPlugin.dylib"
-    #elseif os(Windows)
-    let clientPluginName = "SwiftSourceKitClientPlugin.dll"
-    let servicePluginName = "SwiftSourceKitPlugin.dll"
-    #else
-    let clientPluginName = "libSwiftSourceKitClientPlugin.so"
-    let servicePluginName = "libSwiftSourceKitPlugin.so"
-    #endif
+    let clientPluginName: String
+    let servicePluginName: String
+    switch Platform.current {
+    case .darwin:
+      clientPluginName = "libSwiftSourceKitClientPlugin.dylib"
+      servicePluginName = "libSwiftSourceKitPlugin.dylib"
+    case .windows:
+      clientPluginName = "SwiftSourceKitClientPlugin.dll"
+      servicePluginName = "SwiftSourceKitPlugin.dll"
+    case .linux:
+      clientPluginName = "libSwiftSourceKitClientPlugin.so"
+      servicePluginName = "libSwiftSourceKitPlugin.so"
+    case nil:
+      logger.fault("Could not determine host OS. Falling back to using '.so' as dynamic library extension")
+      clientPluginName = "libSwiftSourceKitClientPlugin.so"
+      servicePluginName = "libSwiftSourceKitPlugin.so"
+    }
     let clientPlugin = base.appendingPathComponent(clientPluginName)
     let servicePlugin = base.appendingPathComponent(servicePluginName)
     if fileExists(at: clientPlugin) && fileExists(at: servicePlugin) {

Sources/SKTestSupport/SkipUnless.swift

@@ -393,7 +393,10 @@ package actor SkipUnless {
     file: StaticString = #filePath,
     line: UInt = #line
   ) async throws {
-    return try await shared.skipUnlessSupported(file: file, line: line) {
+    // docc is supported on macOS and Linux. Do not perform a check on those platforms to avoid accidentally skipping
+    // the tests in CI on those platforms.
+    #if os(Windows)
+    return try await shared.skipUnlessSupported(allowSkippingInCI: true, file: file, line: line) {
       let server = try await SourceKitLSPServer(
         client: LocalConnection(receiverName: "client"),
         toolchainRegistry: .forTesting,
@@ -421,6 +424,7 @@ package actor SkipUnless {
       }
       return .featureSupported
     }
+    #endif
   }
 }
 

Sources/SwiftExtensions/URLExtensions.swift

@@ -40,9 +40,10 @@ extension URL {
         guard let realpath = Darwin.realpath(path, nil) else {
           return self
         }
-        let result = URL(fileURLWithPath: String(cString: realpath))
-        free(realpath)
-        return result
+        defer {
+          free(realpath)
+        }
+        return URL(fileURLWithPath: String(cString: realpath))
       }
       #else
       // Non-Darwin platforms don't have the `/private` stripping issue, so we can just use `self.resolvingSymlinksInPath`

Sources/sourcekit-lsp/SourceKitLSP.swift

@@ -184,19 +184,19 @@ struct SourceKitLSP: AsyncParsableCommand {
           .appendingPathComponent("config.json")
       )
     )
-    #if canImport(Darwin)
-    for applicationSupportDir in FileManager.default.urls(for: .applicationSupportDirectory, in: [.allDomainsMask]) {
-      options = SourceKitLSPOptions.merging(
-        base: options,
-        override: SourceKitLSPOptions(
-          path:
-            applicationSupportDir
-            .appendingPathComponent("org.swift.sourcekit-lsp")
-            .appendingPathComponent("config.json")
+    if Platform.current == .darwin {
+      for applicationSupportDir in FileManager.default.urls(for: .applicationSupportDirectory, in: [.allDomainsMask]) {
+        options = SourceKitLSPOptions.merging(
+          base: options,
+          override: SourceKitLSPOptions(
+            path:
+              applicationSupportDir
+              .appendingPathComponent("org.swift.sourcekit-lsp")
+              .appendingPathComponent("config.json")
+          )
         )
-      )
+      }
     }
-    #endif
     if let xdgConfigHome = ProcessInfo.processInfo.environment["XDG_CONFIG_HOME"] {
       options = SourceKitLSPOptions.merging(
         base: options,

Tests/SourceKitLSPTests/DocumentationLanguageServiceTests.swift

@@ -10,18 +10,19 @@
 //
 //===----------------------------------------------------------------------===//
 
-#if canImport(DocCDocumentation)
 import LanguageServerProtocol
 import SKTestSupport
 import SourceKitLSP
 import XCTest
 
 final class DocumentationLanguageServiceTests: XCTestCase {
   func testHandlesMarkdownFiles() async throws {
+    try await SkipUnless.doccSupported()
     try await assertHandles(language: .markdown)
   }
 
   func testHandlesTutorialFiles() async throws {
+    try await SkipUnless.doccSupported()
     try await assertHandles(language: .tutorial)
   }
 }
@@ -40,4 +41,3 @@ private func assertHandles(language: Language) async throws {
   )
   XCTAssertEqual(completions, .init(isIncomplete: false, items: []))
 }
-#endif