Make the SourceKit plugins work on Windows

Author: ahoppen

Documentation/Environment Variables.md

@@ -18,3 +18,4 @@ The following environment variables can be used to control some behavior in Sour
 - `SOURCEKIT_LSP_KEEP_TEST_SCRATCH_DIR`: Does not delete the temporary files created during test execution. Allows inspection of the test projects after the test finishes.
 - `SOURCEKIT_LSP_TEST_MODULE_CACHE`: Specifies where tests should store their shared module cache. Defaults to writing the module cache to a temporary directory. Intended so that CI systems can clean the module cache directory after running.
 - `SOURCEKIT_LSP_TEST_TIMEOUT`: Override the timeout duration for tests, in seconds.
+- `SOURCEKIT_LSP_TEST_PLUGIN_PATHS`: Load the SourceKit plugins from this path instead of relative to the package's build folder.

Package.swift

@@ -540,11 +540,13 @@ var targets: [Target] = [
     dependencies: [
       "Csourcekitd",
       "SourceKitDForPlugin",
+      "SwiftExtensionsForPlugin",
       "SwiftSourceKitPluginCommon",
     ],
     swiftSettings: globalSwiftSettings + [
       .unsafeFlags([
         "-module-alias", "SourceKitD=SourceKitDForPlugin",
+        "-module-alias", "SwiftExtensions=SwiftExtensionsForPlugin",
       ])
     ]
   ),
@@ -662,11 +664,11 @@ var targets: [Target] = [
 if buildOnlyTests {
   products = []
   targets = targets.compactMap { target in
-    guard target.isTest || target.name == "SKTestSupport" else {
+    guard target.isTest || target.name.contains("TestSupport") else {
       return nil
     }
     target.dependencies = target.dependencies.filter { dependency in
-      if case .byNameItem(name: "SKTestSupport", _) = dependency {
+      if case .byNameItem(name: let name, _) = dependency, name.contains("TestSupport") {
         return true
       }
       return false

Sources/CCompletionScoring/CMakeLists.txt

@@ -0,0 +1,2 @@
+add_library(CCompletionScoring INTERFACE)
+target_include_directories(CCompletionScoring INTERFACE "include")

Sources/CCompletionScoring/include/CCompletionScoring.h

@@ -16,8 +16,28 @@
 #define _GNU_SOURCE
 #include <string.h>
 
-static inline void *sourcekitlsp_memmem(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen) {
+static inline void *sourcekitlsp_memmem(const void *haystack, size_t haystack_len, const void *needle, size_t needle_len) {
+  #if defined(_WIN32) && !defined(__CYGWIN__)
+  // memmem is not available on Windows
+  if (!haystack || haystack_len == 0) {
+    return NULL;
+  }
+  if (!needle || needle_len == 0) {
+    return NULL;
+  }
+  if (needle_len > haystack_len) {
+    return NULL;
+  }
+
+  for (size_t offset = 0; offset <= haystack_len - needle_len; ++offset) {
+    if (memcmp(haystack + offset, needle, needle_len) == 0) {
+      return (void *)haystack + offset;
+    }
+  }
+  return NULL;
+  #else
   return memmem(haystack, haystacklen, needle, needlelen);
+  #endif
 }
 
 #endif // SOURCEKITLSP_CCOMPLETIONSCORING_H

Sources/CCompletionScoring/include/module.modulemap

@@ -0,0 +1,4 @@
+module CCompletionScoring {
+  header "CCompletionScoring.h"
+  export *
+}

Sources/CMakeLists.txt

@@ -4,6 +4,8 @@ add_compile_options("$<$<COMPILE_LANGUAGE:Swift>:SHELL:-swift-version 6>")
 add_subdirectory(BuildServerProtocol)
 add_subdirectory(BuildSystemIntegration)
 add_subdirectory(CAtomics)
+add_subdirectory(CCompletionScoring)
+add_subdirectory(CompletionScoring)
 add_subdirectory(Csourcekitd)
 add_subdirectory(Diagnose)
 add_subdirectory(InProcessClient)
@@ -18,5 +20,8 @@ add_subdirectory(SourceKitLSP)
 add_subdirectory(SourceKitD)
 add_subdirectory(sourcekit-lsp)
 add_subdirectory(SwiftExtensions)
+add_subdirectory(SwiftSourceKitClientPlugin)
+add_subdirectory(SwiftSourceKitPlugin)
+add_subdirectory(SwiftSourceKitPluginCommon)
 add_subdirectory(ToolchainRegistry)
 add_subdirectory(TSCExtensions)

Sources/CompletionScoring/CMakeLists.txt

@@ -0,0 +1,51 @@
+set(sources 
+  Semantics/SemanticClassification.swift
+  Semantics/CompletionScore.swift
+  Semantics/Components
+  Semantics/Components/TypeCompatibility.swift
+  Semantics/Components/StructuralProximity.swift
+  Semantics/Components/Flair.swift
+  Semantics/Components/CompletionKind.swift
+  Semantics/Components/Popularity.swift
+  Semantics/Components/ScopeProximity.swift
+  Semantics/Components/Availability.swift
+  Semantics/Components/SynchronicityCompatibility.swift
+  Semantics/Components/PopularityIndex.swift
+  Semantics/Components/ModuleProximity.swift
+  Semantics/Components/PopularityTable.swift
+  Utilities/UnsafeStackAllocator.swift
+  Utilities/Serialization
+  Utilities/Serialization/BinaryCodable.swift
+  Utilities/Serialization/BinaryEncoder.swift
+  Utilities/Serialization/BinaryDecoder.swift
+  Utilities/Serialization/Conformances
+  Utilities/Serialization/Conformances/Dictionary+BinaryCodable.swift
+  Utilities/Serialization/Conformances/OptionSet+BinaryCodable.swift
+  Utilities/Serialization/Conformances/Optional+BinaryCodable.swift
+  Utilities/Serialization/Conformances/Scalars+BinaryCodable.swift
+  Utilities/Serialization/Conformances/String+BinaryCodable.swift
+  Utilities/Serialization/Conformances/Array+BinaryCodable.swift
+  Utilities/SwiftExtensions.swift
+  Utilities/SelectTopK.swift
+  Utilities/UnsafeArray.swift
+  Text/CandidateBatch.swift
+  Text/MatchCollator.Match.swift
+  Text/UTF8Byte.swift
+  Text/MatchCollator.swift
+  Text/InfluencingIdentifiers.swift
+  Text/MatchCollator.Selection.swift
+  Text/ScoredMatchSelector.swift
+  Text/RejectionFilter.swift
+  Text/Pattern.swift)
+
+add_library(CompletionScoring STATIC ${sources})
+set_target_properties(CompletionScoring PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
+target_link_libraries(CompletionScoring PUBLIC
+  CCompletionScoring)
+
+add_library(CompletionScoringForPlugin STATIC ${sources})
+set_target_properties(CompletionScoringForPlugin PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
+target_link_libraries(CompletionScoringForPlugin PUBLIC
+  CCompletionScoring)

Sources/Csourcekitd/include/CodeCompletionSwiftInterop.h

@@ -24,7 +24,7 @@ typedef void *swiftide_api_connection_t;
 /// may be more expensive to compute.
 typedef void *swiftide_api_completion_item_t;
 
-typedef enum {
+enum swiftide_api_completion_kind_t: uint32_t {
   SWIFTIDE_COMPLETION_KIND_NONE = 0,
   SWIFTIDE_COMPLETION_KIND_IMPORT = 1,
   SWIFTIDE_COMPLETION_KIND_UNRESOLVEDMEMBER = 2,
@@ -69,17 +69,17 @@ typedef enum {
   SWIFTIDE_COMPLETION_KIND_TYPESIMPLEORCOMPOSITION = 41,
   SWIFTIDE_COMPLETION_KIND_TYPEPOSSIBLEFUNCTIONPARAMBEGINNING = 42,
   SWIFTIDE_COMPLETION_KIND_TYPEATTRINHERITANCEBEGINNING = 43,
-} swiftide_api_completion_kind_t;
+};
 
-typedef enum {
+enum swiftide_api_completion_item_kind_t: uint32_t {
   SWIFTIDE_COMPLETION_ITEM_KIND_DECLARATION = 0,
   SWIFTIDE_COMPLETION_ITEM_KIND_KEYWORD = 1,
   SWIFTIDE_COMPLETION_ITEM_KIND_PATTERN = 2,
   SWIFTIDE_COMPLETION_ITEM_KIND_LITERAL = 3,
   SWIFTIDE_COMPLETION_ITEM_KIND_BUILTINOPERATOR = 4,
-} swiftide_api_completion_item_kind_t;
+};
 
-typedef enum {
+enum swiftide_api_completion_item_decl_kind_t: uint32_t {
   SWIFTIDE_COMPLETION_ITEM_DECL_KIND_MODULE = 0,
   SWIFTIDE_COMPLETION_ITEM_DECL_KIND_CLASS = 1,
   SWIFTIDE_COMPLETION_ITEM_DECL_KIND_STRUCT = 2,
@@ -105,18 +105,18 @@ typedef enum {
   SWIFTIDE_COMPLETION_ITEM_DECL_KIND_PRECEDENCEGROUP = 22,
   SWIFTIDE_COMPLETION_ITEM_DECL_KIND_ACTOR = 23,
   SWIFTIDE_COMPLETION_ITEM_DECL_KIND_MACRO = 24,
-} swiftide_api_completion_item_decl_kind_t;
+};
 
-typedef enum {
+enum swiftide_api_completion_type_relation_t: uint32_t {
   SWIFTIDE_COMPLETION_TYPE_RELATION_NOTAPPLICABLE = 0,
   SWIFTIDE_COMPLETION_TYPE_RELATION_UNKNOWN = 1,
   SWIFTIDE_COMPLETION_TYPE_RELATION_UNRELATED = 2,
   SWIFTIDE_COMPLETION_TYPE_RELATION_INVALID = 3,
   SWIFTIDE_COMPLETION_TYPE_RELATION_CONVERTIBLE = 4,
   SWIFTIDE_COMPLETION_TYPE_RELATION_IDENTICAL = 5,
-} swiftide_api_completion_type_relation_t;
+};
 
-typedef enum {
+enum swiftide_api_completion_semantic_context_t: uint32_t {
   SWIFTIDE_COMPLETION_SEMANTIC_CONTEXT_NONE = 0,
   /* obsoleted */SWIFTIDE_COMPLETION_SEMANTIC_CONTEXT_EXPRESSIONSPECIFIC = 1,
   SWIFTIDE_COMPLETION_SEMANTIC_CONTEXT_LOCAL = 2,
@@ -125,19 +125,19 @@ typedef enum {
   SWIFTIDE_COMPLETION_SEMANTIC_CONTEXT_OUTSIDENOMINAL = 5,
   SWIFTIDE_COMPLETION_SEMANTIC_CONTEXT_CURRENTMODULE = 6,
   SWIFTIDE_COMPLETION_SEMANTIC_CONTEXT_OTHERMODULE = 7,
-} swiftide_api_completion_semantic_context_t;
+};
 
-typedef enum {
+enum swiftide_api_completion_flair_t: uint32_t {
   SWIFTIDE_COMPLETION_FLAIR_EXPRESSIONSPECIFIC = 1 << 0,
   SWIFTIDE_COMPLETION_FLAIR_SUPERCHAIN = 1 << 1,
   SWIFTIDE_COMPLETION_FLAIR_ARGUMENTLABELS = 1 << 2,
   SWIFTIDE_COMPLETION_FLAIR_COMMONKEYWORDATCURRENTPOSITION = 1 << 3,
   SWIFTIDE_COMPLETION_FLAIR_RAREKEYWORDATCURRENTPOSITION = 1 << 4,
   SWIFTIDE_COMPLETION_FLAIR_RARETYPEATCURRENTPOSITION = 1 << 5,
   SWIFTIDE_COMPLETION_FLAIR_EXPRESSIONATNONSCRIPTORMAINFILESCOPE = 1 << 6,
-} swiftide_api_completion_flair_t;
+};
 
-typedef enum {
+enum swiftide_api_completion_not_recommended_reason_t: uint32_t {
   SWIFTIDE_COMPLETION_NOT_RECOMMENDED_NONE = 0,
   SWIFTIDE_COMPLETION_NOT_RECOMMENDED_REDUNDANT_IMPORT = 1,
   SWIFTIDE_COMPLETION_NOT_RECOMMENDED_DEPRECATED = 2,
@@ -147,15 +147,15 @@ typedef enum {
   SWIFTIDE_COMPLETION_NOT_RECOMMENDED_REDUNDANT_IMPORT_INDIRECT = 6,
   SWIFTIDE_COMPLETION_NOT_RECOMMENDED_SOFTDEPRECATED = 7,
   SWIFTIDE_COMPLETION_NOT_RECOMMENDED_NON_ASYNC_ALTERNATIVE_USED_IN_ASYNC_CONTEXT = 8,
-} swiftide_api_completion_not_recommended_reason_t;
+};
 
-typedef enum {
+enum swiftide_api_completion_diagnostic_severity_t: uint32_t {
   SWIFTIDE_COMPLETION_DIAGNOSTIC_SEVERITY_NONE = 0,
   SWIFTIDE_COMPLETION_DIAGNOSTIC_SEVERITY_ERROR = 1,
   SWIFTIDE_COMPLETION_DIAGNOSTIC_SEVERITY_WARNING = 2,
   SWIFTIDE_COMPLETION_DIAGNOSTIC_SEVERITY_REMARK  = 3,
   SWIFTIDE_COMPLETION_DIAGNOSTIC_SEVERITY_NOTE  = 4,
-} swiftide_api_completion_diagnostic_severity_t;
+};
 
 typedef void *swiftide_api_completion_request_t;
 
@@ -278,7 +278,7 @@ typedef struct {
     uint64_t index
   );
 
-  swiftide_api_completion_kind_t (*_Nonnull completion_result_get_kind)(
+  enum swiftide_api_completion_kind_t (*_Nonnull completion_result_get_kind)(
     _Null_unspecified swiftide_api_completion_response_t
   );
 
@@ -361,7 +361,7 @@ typedef struct {
   void (*_Nonnull completion_item_get_diagnostic)(
     _Null_unspecified swiftide_api_completion_response_t,
     _Null_unspecified swiftide_api_completion_item_t,
-    void (^_Null_unspecified handler)(swiftide_api_completion_diagnostic_severity_t, const char *_Null_unspecified)
+    void (^_Null_unspecified handler)(enum swiftide_api_completion_diagnostic_severity_t, const char *_Null_unspecified)
   );
 
   bool (*_Nonnull completion_item_is_system)(

Sources/SKLogging/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_library(SKLogging STATIC
+set(sources
   CustomLogStringConvertible.swift
   Error+ForLogging.swift
   Logging.swift
@@ -7,10 +7,25 @@ add_library(SKLogging STATIC
   OrLog.swift
   SetGlobalLogFileHandler.swift
   SplitLogMessage.swift)
+
+add_library(SKLogging STATIC ${sources})
 set_target_properties(SKLogging PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 target_link_libraries(SKLogging PRIVATE
   $<$<NOT:$<PLATFORM_ID:Darwin>>:Foundation>)
 target_link_libraries(SKLogging PUBLIC
   SwiftExtensions
   Crypto)
+
+add_library(SKLoggingForPlugin STATIC ${sources})
+set_target_properties(SKLoggingForPlugin PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
+target_compile_options(SKLoggingForPlugin PRIVATE
+  $<$<COMPILE_LANGUAGE:Swift>:
+    -DNO_CRYPTO_DEPENDENCY;
+    "SHELL:-module-alias SwiftExtensions=SwiftExtensionsForPlugin"
+  >)
+target_link_libraries(SKLoggingForPlugin PRIVATE
+  $<$<NOT:$<PLATFORM_ID:Darwin>>:Foundation>)
+target_link_libraries(SKLoggingForPlugin PUBLIC
+  SwiftExtensionsForPlugin)

Sources/SKTestSupport/PluginPaths.swift

@@ -88,14 +88,17 @@ private func pluginPaths(relativeTo base: URL) -> PluginPaths? {
   // When building using 'swift test'
   do {
     #if canImport(Darwin)
-    let dylibExtension = "dylib"
+    let clientPluginName = "libSwiftSourceKitClientPlugin.dylib"
+    let servicePluginName = "libSwiftSourceKitPlugin.dylib"
     #elseif os(Windows)
-    let dylibExtension = "dll"
+    let clientPluginName = "SwiftSourceKitClientPlugin.dll"
+    let servicePluginName = "SwiftSourceKitPlugin.dll"
     #else
-    let dylibExtension = "so"
+    let clientPluginName = "libSwiftSourceKitClientPlugin.so"
+    let servicePluginName = "libSwiftSourceKitPlugin.so"
     #endif
-    let clientPlugin = base.appendingPathComponent("libSwiftSourceKitClientPlugin.\(dylibExtension)")
-    let servicePlugin = base.appendingPathComponent("libSwiftSourceKitPlugin.\(dylibExtension)")
+    let clientPlugin = base.appendingPathComponent(clientPluginName)
+    let servicePlugin = base.appendingPathComponent(servicePluginName)
     if fileExists(at: clientPlugin) && fileExists(at: servicePlugin) {
       return PluginPaths(clientPlugin: clientPlugin, servicePlugin: servicePlugin)
     }
@@ -113,16 +116,19 @@ package var sourceKitPluginPaths: PluginPaths {
         "Could not find SourceKit plugin. Ensure that you build the entire SourceKit-LSP package before running tests."
     }
 
-    var base = xctestBundle
+    var base =
+      if let pluginPaths = ProcessInfo.processInfo.environment["SOURCEKIT_LSP_TEST_PLUGIN_PATHS"] {
+        URL(fileURLWithPath: pluginPaths)
+      } else {
+        xctestBundle
+      }
     while base.pathComponents.count > 1 {
       if let paths = pluginPaths(relativeTo: base) {
         return paths
       }
       base = base.deletingLastPathComponent()
     }
 
-    // If we couldn't find the plugins, keep `didLoadPlugin = false`, which will throw an error in each test case's
-    // `setUp` function. We can't throw an error from the class `setUp` function.
     throw PluginLoadingError()
   }
 }