Add new playground types

Needed to get playground support into SourceKit-LSP: swiftlang/sourcekit-lsp#2340

Author: award999

Sources/LanguageServerProtocol/SupportTypes/Location.swift

@@ -13,7 +13,9 @@
 /// Range within a particular document.
 ///
 /// For a location where the document is implied, use `Position` or `Range<Position>`.
-public struct Location: ResponseType, Hashable, Codable, CustomDebugStringConvertible, Comparable, Sendable {
+public struct Location: ResponseType, Hashable, Codable, CustomDebugStringConvertible, Comparable, Sendable,
+  LSPAnyCodable
+{
   public static func < (lhs: Location, rhs: Location) -> Bool {
     if lhs.uri != rhs.uri {
       return lhs.uri.stringValue < rhs.uri.stringValue
@@ -34,7 +36,27 @@ public struct Location: ResponseType, Hashable, Codable, CustomDebugStringConver
     self._range = CustomCodable<PositionRange>(wrappedValue: range)
   }
 
+  public init?(fromLSPDictionary dictionary: [String: LSPAny]) {
+    guard
+      case .string(let uriString) = dictionary["uri"],
+      case .dictionary(let rangeDict) = dictionary["range"],
+      let uri = try? DocumentURI(string: uriString),
+      let range = Range<Position>(fromLSPDictionary: rangeDict)
+    else {
+      return nil
+    }
+    self.uri = uri
+    self._range = CustomCodable<PositionRange>(wrappedValue: range)
+  }
+
   public var debugDescription: String {
     return "\(uri):\(range.lowerBound)-\(range.upperBound)"
   }
+
+  public func encodeToLSPAny() -> LSPAny {
+    return .dictionary([
+      "uri": .string(uri.stringValue),
+      "range": range.encodeToLSPAny(),
+    ])
+  }
 }

Sources/LanguageServerProtocol/SupportTypes/Playground.swift

@@ -0,0 +1,69 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2025 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
+//
+//===----------------------------------------------------------------------===//
+
+/// A `Playground` represents a usage of the #Playground macro, providing the editor with the
+/// location of the playground and identifiers to allow executing the playground through a "swift play" command.
+///
+/// **(LSP Extension)**
+public struct Playground: ResponseType, Equatable, LSPAnyCodable {
+  /// Unique identifier for the `Playground`. Client can run the playground by executing `swift play <id>`.
+  ///
+  /// This property is always present whether the `Playground` has a `label` or not.
+  ///
+  /// Follows the format output by `swift play --list`.
+  public var id: String
+
+  /// The label that can be used as a display name for the playground. This optional property is only available
+  /// for named playgrounds. For example: `#Playground("hello") { print("Hello!) }` would have a `label` of `"hello"`.
+  public var label: String?
+
+  /// The location of where the #Playground macro was used in the source code.
+  public var location: Location
+
+  public init(
+    id: String,
+    label: String?,
+    location: Location,
+  ) {
+    self.id = id
+    self.label = label
+    self.location = location
+  }
+
+  public init?(fromLSPDictionary dictionary: [String: LSPAny]) {
+    guard
+      case .string(let id) = dictionary["id"],
+      case .dictionary(let locationDict) = dictionary["location"],
+      let location = Location(fromLSPDictionary: locationDict)
+    else {
+      return nil
+    }
+    self.id = id
+    self.location = location
+    if case .string(let label) = dictionary["label"] {
+      self.label = label
+    }
+  }
+
+  public func encodeToLSPAny() -> LSPAny {
+    var dict: [String: LSPAny] = [
+      "id": .string(id),
+      "location": location.encodeToLSPAny(),
+    ]
+
+    if let label {
+      dict["label"] = .string(label)
+    }
+
+    return .dictionary(dict)
+  }
+}

Sources/LanguageServerProtocol/SupportTypes/TextDocumentPlayground.swift

@@ -0,0 +1,67 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2025 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
+//
+//===----------------------------------------------------------------------===//
+
+/// A `TextDocumentPlayground` item can be used to identify playground and identify it
+/// to allow executing the playground through a "swift play" command. Differs from `Playground`
+/// by only including the `range` instead of full `location` with the expectation being that
+/// it is only returned as part of a textDocument/* request such as textDocument/codelens
+public struct TextDocumentPlayground: ResponseType, Equatable, LSPAnyCodable {
+  /// Unique identifier for the `Playground`. Client can run the playground by executing `swift play <id>`.
+  ///
+  /// This property is always present whether the `Playground` has a `label` or not.
+  ///
+  /// Follows the format output by `swift play --list`.
+  public var id: String
+
+  /// The label that can be used as a display name for the playground. This optional property is only available
+  /// for named playgrounds. For example: `#Playground("hello") { print("Hello!) }` would have a `label` of `"hello"`.
+  public var label: String?
+
+  /// The full range of the #Playground macro body in the given file.
+  public var range: Range<Position>
+
+  public init(
+    id: String,
+    label: String?,
+    range: Range<Position>
+  ) {
+    self.id = id
+    self.label = label
+    self.range = range
+  }
+
+  public init?(fromLSPDictionary dictionary: [String: LSPAny]) {
+    guard
+      case .string(let id) = dictionary["id"],
+      case .dictionary(let rangeDict) = dictionary["range"],
+      let range = Range<Position>(fromLSPDictionary: rangeDict)
+    else {
+      return nil
+    }
+    self.id = id
+    self.range = range
+    if case .string(let label) = dictionary["label"] {
+      self.label = label
+    }
+  }
+
+  public func encodeToLSPAny() -> LSPAny {
+    var dict: [String: LSPAny] = [
+      "id": .string(id),
+      "range": range.encodeToLSPAny(),
+    ]
+    if let label {
+      dict["label"] = .string(label)
+    }
+    return .dictionary(dict)
+  }
+}