Merge pull request #1517 from ahoppen/document-module-purpose

Add documentation about each module's purpose and move some files between modules

Author: ahoppen

Documentation/Modules.md

@@ -0,0 +1,121 @@
+# Modules
+
+The SourceKit-LSP package contains the following non-testing modules.
+
+### BuildServerProtocol
+
+Swift types to represent the [Build Server Protocol (BSP) specification, version TODO](TODO). These types should also be usable when implementing a BSP client and thus this module should not have any dependencies other than the LanguageServerProtocol module, with which it shares some types.
+
+FIXME: Add link for BSP and version
+
+### CAtomics
+
+Implementation of atomics for Swift using C. Once we can raise our deployment target to use the `Atomic` type from the Swift standard library, this module should be removed.
+
+### CSKTestSupport
+
+FIXME: Can we remove this?
+
+### Csourcekitd
+
+Header file defining the interface to sourcekitd. This should stay in sync with [sourcekitd.h](TODO) in the Swift repository.
+
+### Diagnose
+
+A collection of subcommands to the `sourcekit-lsp` executable that help SourceKit-LSP diagnose issues.
+
+### InProcessClient
+
+A simple type that allows launching a SourceKit-LSP server in-process, communicating in terms of structs from the `LanguageServerProtocol` module.
+
+This should be the dedicated entry point for clients that want to run SourceKit-LSP in-process instead of launching a SourceKit-LSP server out-of-process and communicating with it using JSON RPC.
+
+### LanguageServerProtocol
+
+Swift types to represent the [Language Server Protocol (LSP) specification, version 3.17](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/). These types should also be usable when implementing an LSP client and thus this module should not have any dependencies.
+
+### LanguageServerProtocolJSONRPC
+
+A connection to or from a SourceKit-LSP server. Since message parsing can fail, it needs to handle errors in some way and the design decision here is to use LSPLogging, which hardcodes `org.swift.sourcekit-lsp` as the default logging subsystem and thus makes the module unsuitable for generic clients.
+
+### LSPLogging
+
+Types that are API-compatible with OSLog to allow logging to OSLog when building for Darwin platforms and logging to stderr or files on non-Darwin platforms. This should not be dependent on any LSP specific types and be portable to other packages.
+
+FIXME: Rename the module to SKLogging
+
+### LSPTestSupport
+
+FIXME: Merge this module with SKTestSupport
+
+### SemanticIndex
+
+Contains the interface with which SourceKit-LSP queries the semantic index, adding up-to-date checks on top of the indexstore-db API. Also implements the types that manage background indexing.
+
+### SKCore
+
+FIXME: Currently serves two independent purposes and should be split up into two modules
+
+#### BuildSystem
+
+Defines the queries SourceKit-LSP can ask of a a build system, like getting compiler arguments for a file. Finding a target’s dependencies or preparing a target.
+
+This includes:
+- BuildConfiguration.swift
+- BuildServerBuildSystem.swift
+- BuildSetup.swift
+- BuildSystem.swift
+- BuildSystemDelegate.swift
+- BuildSystemManager.swift
+- CompilationDatabase.swift
+- CompilationDatabaseBuildSystem.swift
+- FallbackBuildSystem.swift
+- FileBuildSettings.swift
+- IndexTaskID.swift
+- MainFilesProvider.swift
+- PathPrefixMapping.swift
+- SplitShellCommand.swift
+- WorkspaceType.swift
+
+#### ToolchainRegistry
+
+Discovers Swift toolchains on the system.
+
+- Toolchain.swift
+- ToolchainRegistry.swift
+- XCToolchainPlist.swift
+
+
+### SKSupport
+
+Contains SourceKit-LSP-specific helper functions. These fall into three different categories:
+-  Extensions on top of `swift-tools-support-core`
+- Functionality that can only be implemented by combining two lower-level modules that don't have a shared dependency, like `LSPLogging` + `LanguageServerProtocol`
+- Types that should be sharable by the different modules that implement SourceKit-LSP but that are not generic enough to fit into `SwiftExtensions`, like `ExperimentalFeatures`.
+
+### SKSwiftPMWorkspace
+
+Implements the `BuildSystem` protocol for Swift packages.
+
+FIXME: Merge this into the BuildSystem module once SKCore is split.
+
+### SKTestSupport
+
+A collection of utilities useful for writing tests for SourceKit-LSP and which are not specific to a single test module.
+
+### sourcekit-lsp
+
+This executable target that produces the `sourcekit-lsp` binary.
+
+### SourceKitD
+
+A Swift interface to talk to sourcekitd.
+
+### SourceKitLSP
+
+This is the core module that implements the SourceKit-LSP server.
+
+### SwiftExtensions
+
+Extensions to the Swift standard library and Foundation. Should not have any other dependencies. Any types in here should theoretically make senses to put in the Swift standard library or Foundation and they shouldn't be specific to SourceKit-LSP
+

Package.swift

@@ -220,7 +220,9 @@ let package = Package(
     .testTarget(
       name: "SemanticIndexTests",
       dependencies: [
-        "SemanticIndex"
+        "LSPLogging",
+        "SemanticIndex",
+        "SKTestSupport",
       ],
       swiftSettings: strictConcurrencySettings
     ),
@@ -343,7 +345,6 @@ let package = Package(
       dependencies: [
         "Csourcekitd",
         "LSPLogging",
-        "SKSupport",
         "SwiftExtensions",
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -399,6 +400,7 @@ let package = Package(
         "LSPLogging",
         "LSPTestSupport",
         "LanguageServerProtocol",
+        "SemanticIndex",
         "SKCore",
         "SKSupport",
         "SKTestSupport",

Sources/LanguageServerProtocolJSONRPC/JSONRPCConnection.swift

@@ -19,9 +19,12 @@ import LanguageServerProtocol
 import struct CDispatch.dispatch_fd_t
 #endif
 
-/// A connection between a message handler (e.g. language server) in the same process as the connection object and a remote message handler (e.g. language client) that may run in another process using JSON RPC messages sent over a pair of in/out file descriptors.
+/// A connection between a message handler (e.g. language server) in the same process as the connection object and a
+/// remote message handler (e.g. language client) that may run in another process using JSON RPC messages sent over a
+// pair of in/out file descriptors.
 ///
-/// For example, inside a language server, the `JSONRPCConnection` takes the language service implementation as its `receiveHandler` and itself provides the client connection for sending notifications and callbacks.
+/// For example, inside a language server, the `JSONRPCConnection` takes the language service implementation as its
+// `receiveHandler` and itself provides the client connection for sending notifications and callbacks.
 public final class JSONRPCConnection: Connection {
 
   /// A name of the endpoint for this connection, used for logging, e.g. `clangd`.

Sources/SKSupport/BuildConfiguration.swift renamed to Sources/SKCore/BuildConfiguration.swift

@@ -1,23 +1,22 @@
 
 add_library(SKCore STATIC
+  BuildConfiguration.swift
   BuildServerBuildSystem.swift
   BuildSetup.swift
   BuildSystem.swift
   BuildSystemDelegate.swift
   BuildSystemManager.swift
   CompilationDatabase.swift
   CompilationDatabaseBuildSystem.swift
-  Debouncer.swift
-  ExperimentalFeatures.swift
   FallbackBuildSystem.swift
   FileBuildSettings.swift
   IndexTaskID.swift
   MainFilesProvider.swift
   PathPrefixMapping.swift
   SplitShellCommand.swift
-  TaskScheduler.swift
   Toolchain.swift
   ToolchainRegistry.swift
+  WorkspaceType.swift
   XCToolchainPlist.swift)
 set_target_properties(SKCore PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})

Sources/SKCore/CMakeLists.txt

@@ -1,19 +1,15 @@
 
 add_library(SKSupport STATIC
   Atomics.swift
-  BuildConfiguration.swift
   ByteString.swift
   Connection+Send.swift
-  dlopen.swift
+  Debouncer.swift
   DocumentURI+CustomLogStringConvertible.swift
+  ExperimentalFeatures.swift
   FileSystem.swift
   LineTable.swift
-  PipeAsStringHandler.swift
   Process+Run.swift
-  Random.swift
-  Result.swift
   SwitchableProcessResultExitStatus.swift
-  WorkspaceType.swift
 )
 set_target_properties(SKSupport PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})

Sources/SKSupport/WorkspaceType.swift renamed to Sources/SKCore/WorkspaceType.swift

@@ -12,10 +12,6 @@
 
 import LSPLogging
 
-#if canImport(os)
-import os
-#endif
-
 public struct LineTable: Hashable, Sendable {
   @usableFromInline
   var impl: [String.Index]