File: RegisterForChangeNotifications.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (50 lines) | stat: -rw-r--r-- 1,817 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 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

/// The register for changes request is sent from the language
/// server to the build server to register or unregister for
/// changes in file options or dependencies. On changes a
/// FileOptionsChangedNotification is sent.
public struct RegisterForChanges: RequestType {
  public static let method: String = "textDocument/registerForChanges"
  public typealias Response = VoidResponse

  /// The URI of the document to get options for.
  public var uri: URI

  /// Whether to register or unregister for the file.
  public var action: RegisterAction

  public init(uri: URI, action: RegisterAction) {
    self.uri = uri
    self.action = action
  }
}

public enum RegisterAction: String, Hashable, Codable, Sendable {
  case register = "register"
  case unregister = "unregister"
}

/// The FileOptionsChangedNotification is sent from the
/// build server to the language server when it detects
/// changes to a registered files build settings.
public struct FileOptionsChangedNotification: NotificationType {
  public static let method: String = "build/sourceKitOptionsChanged"

  /// The URI of the document that has changed settings.
  public var uri: URI

  /// The updated options for the registered file.
  public var updatedOptions: SourceKitOptionsResult
}