File: SyntaxNodeCasting.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 (95 lines) | stat: -rw-r--r-- 3,474 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
87
88
89
90
91
92
93
94
95
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 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 SwiftSyntax
import SwiftSyntaxBuilder
import SyntaxSupport

@MemberBlockItemListBuilder
func choiceNodeCastingMethods(for syntaxNodeKind: SyntaxNodeKind) -> MemberBlockItemListSyntax {
  let apiAttributes = SYNTAX_NODE_MAP[syntaxNodeKind]?.apiAttributes() ?? []
  if syntaxNodeKind.isBase {
    DeclSyntax(
      """
      /// Checks if the current syntax node can be cast to the type conforming to the ``\(syntaxNodeKind.protocolType)`` protocol.
      ///
      /// - Returns: `true` if the node can be cast, `false` otherwise.
      \(apiAttributes)\
      public func `is`<S: \(syntaxNodeKind.protocolType)>(_ syntaxType: S.Type) -> Bool {
        return self.as(syntaxType) != nil
      }
      """
    )

    DeclSyntax(
      """
      /// Attempts to cast the current syntax node to the type conforming to the ``\(syntaxNodeKind.protocolType)`` protocol.
      ///
      /// - Returns: An instance of the specialized type, or `nil` if the cast fails.
      \(apiAttributes)\
      public func `as`<S: \(syntaxNodeKind.protocolType)>(_ syntaxType: S.Type) -> S? {
        return S.init(self)
      }
      """
    )

    DeclSyntax(
      """
      /// Force-casts the current syntax node to the type conforming to the ``\(syntaxNodeKind.protocolType)`` protocol.
      ///
      /// - Returns: An instance of the specialized type.
      /// - Warning: This function will crash if the cast is not possible. Use `as` to safely attempt a cast.
      \(apiAttributes)\
      public func cast<S: \(syntaxNodeKind.protocolType)>(_ syntaxType: S.Type) -> S {
        return self.as(S.self)!
      }
      """
    )
  } else {
    DeclSyntax(
      """
      /// Checks if the current syntax node can be cast to \(raw: syntaxNodeKind.doccLink).
      ///
      /// - Returns: `true` if the node can be cast, `false` otherwise.
      \(apiAttributes)\
      public func `is`(_ syntaxType: \(syntaxNodeKind.syntaxType).Type) -> Bool {
        return self.as(syntaxType) != nil
      }
      """
    )

    DeclSyntax(
      """
      /// Attempts to cast the current syntax node to \(raw: syntaxNodeKind.doccLink).
      ///
      /// - Returns: An instance of \(raw: syntaxNodeKind.doccLink), or `nil` if the cast fails.
      \(apiAttributes)\
      public func `as`(_ syntaxType: \(syntaxNodeKind.syntaxType).Type) -> \(syntaxNodeKind.syntaxType)? {
        return \(syntaxNodeKind.syntaxType).init(self)
      }
      """
    )

    DeclSyntax(
      """
      /// Force-casts the current syntax node to \(raw: syntaxNodeKind.doccLink).
      ///
      /// - Returns: An instance of \(raw: syntaxNodeKind.doccLink).
      /// - Warning: This function will crash if the cast is not possible. Use `as` to safely attempt a cast.
      \(apiAttributes)\
      public func cast(_ syntaxType: \(syntaxNodeKind.syntaxType).Type) -> \(syntaxNodeKind.syntaxType) {
        return self.as(\(syntaxNodeKind.syntaxType).self)!
      }
      """
    )
  }
}