File: OpenInterfaceRequest.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, 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 (57 lines) | stat: -rw-r--r-- 1,943 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
51
52
53
54
55
56
57
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2022 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
//
//===----------------------------------------------------------------------===//

/// Request a generated interface of a module to display in the IDE.
/// **(LSP Extension)**
public struct OpenGeneratedInterfaceRequest: TextDocumentRequest, Hashable {
  public static let method: String = "textDocument/openInterface"
  public typealias Response = GeneratedInterfaceDetails?

  /// The document whose compiler arguments should be used to generate the interface.
  public var textDocument: TextDocumentIdentifier

  /// The module to generate an index for.
  public var moduleName: String

  /// The module group name.
  public var groupName: String?

  /// The symbol USR to search for in the generated module interface.
  public var symbolUSR: String?

  public init(textDocument: TextDocumentIdentifier, name: String, groupName: String?, symbolUSR: String?) {
    self.textDocument = textDocument
    self.symbolUSR = symbolUSR
    self.moduleName = name
    self.groupName = groupName
  }

  /// Name of interface module name with group names appended
  public var name: String {
    if let groupName {
      return "\(self.moduleName).\(groupName.replacing("/", with: "."))"
    }
    return self.moduleName
  }
}

/// The textual output of a module interface.
public struct GeneratedInterfaceDetails: ResponseType, Hashable {

  public var uri: DocumentURI
  public var position: Position?

  public init(uri: DocumentURI, position: Position?) {
    self.uri = uri
    self.position = position
  }
}