File: GeneratedInterfaceDocumentURLData.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (86 lines) | stat: -rw-r--r-- 3,231 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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
//===----------------------------------------------------------------------===//
//
// 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 Foundation
import LanguageServerProtocol

/// Represents url of generated interface reference document.
package struct GeneratedInterfaceDocumentURLData: Hashable, ReferenceURLData {
  package static let documentType = "generated-swift-interface"

  private struct Parameters {
    static let moduleName = "moduleName"
    static let groupName = "groupName"
    static let sourcekitdDocumentName = "sourcekitdDocument"
    static let buildSettingsFrom = "buildSettingsFrom"
  }

  /// The module that should be shown in this generated interface.
  let moduleName: String

  /// The group that should be shown in this generated interface, if applicable.
  let groupName: String?

  /// The name by which this document is referred to in sourcekitd.
  let sourcekitdDocumentName: String

  /// The document from which the build settings for the generated interface should be inferred.
  let buildSettingsFrom: DocumentURI

  var displayName: String {
    if let groupName {
      return "\(moduleName).\(groupName.replacing("/", with: ".")).swiftinterface"
    }
    return "\(moduleName).swiftinterface"
  }

  var queryItems: [URLQueryItem] {
    var result = [
      URLQueryItem(name: Parameters.moduleName, value: moduleName)
    ]
    if let groupName {
      result.append(URLQueryItem(name: Parameters.groupName, value: groupName))
    }
    result += [
      URLQueryItem(name: Parameters.sourcekitdDocumentName, value: sourcekitdDocumentName),
      URLQueryItem(name: Parameters.buildSettingsFrom, value: buildSettingsFrom.stringValue),
    ]
    return result
  }

  var uri: DocumentURI {
    get throws {
      try ReferenceDocumentURL.generatedInterface(self).uri
    }
  }

  init(moduleName: String, groupName: String?, sourcekitdDocumentName: String, primaryFile: DocumentURI) {
    self.moduleName = moduleName
    self.groupName = groupName
    self.sourcekitdDocumentName = sourcekitdDocumentName
    self.buildSettingsFrom = primaryFile
  }

  init(queryItems: [URLQueryItem]) throws {
    guard let moduleName = queryItems.last(where: { $0.name == Parameters.moduleName })?.value,
      let sourcekitdDocumentName = queryItems.last(where: { $0.name == Parameters.sourcekitdDocumentName })?.value,
      let primaryFile = queryItems.last(where: { $0.name == Parameters.buildSettingsFrom })?.value
    else {
      throw ReferenceDocumentURLError(description: "Invalid queryItems for generated interface reference document url")
    }

    self.moduleName = moduleName
    self.groupName = queryItems.last(where: { $0.name == Parameters.groupName })?.value
    self.sourcekitdDocumentName = sourcekitdDocumentName
    self.buildSettingsFrom = try DocumentURI(string: primaryFile)
  }
}