Merge pull request #285 from benlangmuir/gmodules-workaround

[clang] Workaround module format issue with -gmodules

Author: benlangmuir

Sources/SourceKit/Clang/ClangLanguageServer.swift

@@ -120,7 +120,22 @@ extension ClangLanguageServerShim {
       return "settings for \(uri): \(settingsStr)"
     }
 
-    if let settings = settings {
+    if var settings = settings {
+      if settings.compilerArguments.contains("-fmodules") == true {
+        // Clangd is not built with support for the 'obj' format.
+        settings.compilerArguments.append(contentsOf: [
+          "-Xclang", "-fmodule-format=raw"
+        ])
+      }
+      if let workingDirectory = settings.workingDirectory {
+        // FIXME: this is a workaround for clangd not respecting the compilation
+        // database's "directory" field for relative -fmodules-cache-path.
+        // rdar://63984913
+        settings.compilerArguments.append(contentsOf: [
+          "-working-directory", workingDirectory
+        ])
+      }
+
       clangd.send(DidChangeConfigurationNotification(settings: .clangd(
         ClangWorkspaceSettings(
           compilationDatabaseChanges: [url.path: ClangCompileCommand(settings, clang: clang)]))))

Tests/INPUTS/ClangModules/ClangModuleA.h

@@ -0,0 +1,6 @@
+#ifndef ClangModuleA_h
+#define ClangModuleA_h
+
+void func_ClangModuleA(void);
+
+#endif /* ClangModuleA_h */

Tests/INPUTS/ClangModules/ClangModules_main.m

@@ -0,0 +1,6 @@
+/*main_file*/
+@import ClangModuleA;
+
+void test(void) {
+  func_ClangModuleA();
+}

Tests/INPUTS/ClangModules/module.modulemap

@@ -0,0 +1,3 @@
+module ClangModuleA {
+  header "ClangModuleA.h"
+}

Tests/INPUTS/ClangModules/project.json

@@ -0,0 +1,4 @@
+{
+  "clang_flags": ["-gmodules"],
+  "sources": ["ClangModules_main.m"]
+}

Tests/SourceKitTests/LocalClangTests.swift

@@ -164,4 +164,22 @@ final class LocalClangTests: XCTestCase {
       fatalError("error \(result) waiting for diagnostics notification")
     }
   }
+
+  func testClangModules() {
+    guard let ws = try! staticSourceKitTibsWorkspace(name: "ClangModules") else { return }
+    if ToolchainRegistry.shared.default?.clangd == nil { return }
+
+    let loc = ws.testLoc("main_file")
+
+    let expectation = self.expectation(description: "diagnostics")
+
+    ws.sk.handleNextNotification { (note: Notification<PublishDiagnosticsNotification>) in
+      XCTAssertEqual(note.params.diagnostics.count, 0)
+      expectation.fulfill()
+    }
+
+    try! ws.openDocument(loc.url, language: .objective_c)
+
+    waitForExpectations(timeout: 15)
+  }
 }

Tests/SourceKitTests/XCTestManifests.swift

@@ -92,6 +92,7 @@ extension LocalClangTests {
     //   `swift test --generate-linuxmain`
     // to regenerate.
     static let __allTests__LocalClangTests = [
+        ("testClangModules", testClangModules),
         ("testClangStdHeaderCanary", testClangStdHeaderCanary),
         ("testFoldingRange", testFoldingRange),
         ("testSymbolInfo", testSymbolInfo),