Files
sourcekit-lsp/Sources/SourceKitLSP/DocumentSnapshot+FromFileContents.swift
Alex Hoppen 2877675bd5 Adopt package access level
Change a l public declarations to the `package` access level, accept for:
- The `LanguageServerProtocol` module
- The `BuildServerProtocol` module
- `InProcessClient.InProcessSourceKitLSPClient`
- `LanguageServerProtocolJSONRPC` (I would like to create a more ergonomic API for this like `InProcessSourceKitLSPClient` in the future, but for now, we’ll leave it public)

Unfortunately, our pattern of marking functions as `@_spi(Testing) public` no longer works with the `package` access level because declarations at the `package` access level cannot be marked as SPI. I have decided to just mark these functions as `package`. Alternatives would be:
- Add an underscore to these functions, like we did for functions exposed for testing before the introduction of `SPI`
- Use `@testable` import in the test targets and mark the methods as `internal`

Resolves #1315
rdar://128295618
2024-07-19 09:54:30 -07:00

36 lines
1.3 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import LanguageServerProtocol
import SKSupport
package extension DocumentSnapshot {
/// Creates a `DocumentSnapshot` with the file contents from disk.
///
/// Throws an error if the file could not be read.
/// Returns `nil` if the `uri` is not a file URL.
init?(withContentsFromDisk uri: DocumentURI, language: Language) throws {
guard let url = uri.fileURL else {
return nil
}
try self.init(withContentsFromDisk: url, language: language)
}
/// Creates a `DocumentSnapshot` with the file contents from disk.
///
/// Throws an error if the file could not be read.
init(withContentsFromDisk url: URL, language: Language) throws {
let contents = try String(contentsOf: url)
self.init(uri: DocumentURI(url), language: language, version: 0, lineTable: LineTable(contents))
}
}