mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
e6fc0f017b
When testing the sourcekit-lsp binary, it is handy to be able to force requests to be handled synchronously. This only affects the protocol layer, not the implementation. This option is hidden from the help text and should only be used for testing/debugging.
83 lines
2.4 KiB
Swift
83 lines
2.4 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2018 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 Dispatch
|
|
|
|
public protocol MessageType: Codable {}
|
|
|
|
/// `RequestType` with no associated type or same-type requirements. Most users should prefer
|
|
/// `RequestType`.
|
|
public protocol _RequestType: MessageType {
|
|
|
|
/// The name of the request.
|
|
static var method: String { get }
|
|
|
|
/// *Implementation detail*. Dispatch `self` to the given handler and reply on `connection`.
|
|
///
|
|
/// `sync: true` should only be used for testing.
|
|
func _handle(
|
|
_ handler: MessageHandler,
|
|
id: RequestID,
|
|
connection: _IndirectConnection,
|
|
sync: Bool)
|
|
}
|
|
|
|
/// A request, which must have a unique `method` name as well as an associated response type.
|
|
public protocol RequestType: _RequestType {
|
|
|
|
/// The type of of the response to this request.
|
|
associatedtype Response: ResponseType
|
|
}
|
|
|
|
/// A notification, which must have a unique `method` name.
|
|
public protocol NotificationType: MessageType {
|
|
|
|
/// The name of the request.
|
|
static var method: String { get }
|
|
|
|
/// *Implementation detail*. Dispatch `self` to the given handler.
|
|
func _handle(_: MessageHandler, connection: Connection)
|
|
}
|
|
|
|
/// A response.
|
|
public protocol ResponseType: MessageType {}
|
|
|
|
extension RequestType {
|
|
public func _handle(
|
|
_ handler: MessageHandler,
|
|
id: RequestID,
|
|
connection: _IndirectConnection,
|
|
sync: Bool)
|
|
{
|
|
let semaphore: DispatchSemaphore? = sync ? .init(value: 0) : nil
|
|
|
|
handler.handle(self, id: id, from: ObjectIdentifier(connection)) { response in
|
|
connection.sendReply(response, id: id)
|
|
semaphore?.signal()
|
|
}
|
|
|
|
semaphore?.wait()
|
|
}
|
|
}
|
|
|
|
extension NotificationType {
|
|
public func _handle(_ handler: MessageHandler, connection: Connection) {
|
|
handler.handle(self, from: ObjectIdentifier(connection))
|
|
}
|
|
}
|
|
|
|
/// A `textDocument/*` request, which takes a text document identifier indicating which document it
|
|
/// operates in or on.
|
|
public protocol TextDocumentRequest: RequestType {
|
|
var textDocument: TextDocumentIdentifier { get }
|
|
}
|