File: DocumentColorRequest.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 (65 lines) | stat: -rw-r--r-- 2,351 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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

/// The document color request is sent from the client to the server to list
/// all color references found in a given text document. Along with the range,
/// a color value in RGB is returned.
/// Clients can use the result to decorate color references in an editor.
///
/// - Parameters:
///   - textDocument: The document to search for color references.
///
/// - Returns: A list of color references for the given document.
public struct DocumentColorRequest: TextDocumentRequest, Hashable {
  public static let method: String = "textDocument/documentColor"
  public typealias Response = [ColorInformation]

  /// The document in which to search for color references.
  public var textDocument: TextDocumentIdentifier

  public init(textDocument: TextDocumentIdentifier) {
    self.textDocument = textDocument
  }
}

public struct ColorInformation: ResponseType, Hashable {
  /// The range in the document where this color appears.
  @CustomCodable<PositionRange>
  public var range: Range<Position>

  /// The actual color value for this color range.
  public var color: Color

  public init(range: Range<Position>, color: Color) {
    self._range = CustomCodable<PositionRange>(wrappedValue: range)
    self.color = color
  }
}

/// Represents a color in RGBA space.
public struct Color: Hashable, Codable, Sendable {
  /// The red component of this color in the range [0-1].
  public var red: Double
  /// The green component of this color in the range [0-1].
  public var green: Double
  /// The blue component of this color in the range [0-1].
  public var blue: Double
  /// The alpha component of this color in the range [0-1].
  public var alpha: Double

  public init(red: Double, green: Double, blue: Double, alpha: Double) {
    self.red = red
    self.green = green
    self.blue = blue
    self.alpha = alpha
  }
}