File: EditorPlaceholderExprSyntaxAdditions.swift

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (54 lines) | stat: -rw-r--r-- 2,072 bytes parent folder | download | duplicates (3)
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
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 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 Swift project authors
//

import SwiftSyntax

extension EditorPlaceholderExprSyntax {
  /// Initialize an instance of this type with the given placeholder string and
  /// optional type.
  ///
  /// - Parameters:
  ///   - placeholder: The placeholder string, not including surrounding angle
  ///     brackets or pound characters.
  ///   - type: The type which this placeholder have, if any. When non-`nil`,
  ///     the expression will use typed placeholder syntax.
  init(_ placeholder: String, type: String? = nil) {
    let placeholderContent = if let type {
      // These use typed placeholder syntax, which allows the compiler to
      // type-check the expression successfully. The resulting code still does
      // not compile due to the placeholder, but it makes the diagnostic more
      // clear. See
      // https://developer.apple.com/documentation/swift-playgrounds/specifying-editable-regions-in-a-playground-page#Mark-Editable-Areas-with-Placeholder-Tokens
      if placeholder == type {
        // When the placeholder string is exactly the same as the type string,
        // use the shorter typed placeholder format.
        "T##\(placeholder)"
      } else {
        "T##\(placeholder)##\(type)"
      }
    } else {
      placeholder
    }

    // Manually concatenate the string to avoid it being interpreted as a
    // placeholder when editing this file.
    self.init(placeholder: .identifier("<#\(placeholderContent)#" + ">"))
  }

  /// Initialize an instance of this type with the given type, using that as the
  /// placeholder string.
  ///
  /// - Parameters:
  ///   - type: The type to use both as the placeholder text and as the
  ///     expression's type.
  init(type: String) {
    self.init(type, type: type)
  }
}