File: Argument.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 (97 lines) | stat: -rw-r--r-- 3,259 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
96
97
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 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 Swift project authors
//

import SwiftSyntax

/// A type describing an argument to a function, closure, etc.
///
/// This type is used as an intermediate form before being converted to an
/// instance of `LabeledExprSyntax`, `ClosureParameterSyntax`, etc.
///
/// - Bug: This type is needed because trimming a syntax node or copying it into
///   another node erases its source location information, so we cannot convert
///   expressions to `LabeledExprSyntax` instances until we no longer need that
///   information. ([swift-syntax-#1961](https://github.com/swiftlang/swift-syntax/issues/1961))
struct Argument {
  /// The argument's label, if present.
  var label: TokenSyntax?

  /// The argument expression.
  var expression: ExprSyntax

  init(label: TokenSyntax? = nil, expression: ExprSyntax) {
    self.label = label
    self.expression = expression
  }

  init(label: TokenSyntax? = nil, expression: some ExprSyntaxProtocol) {
    self.label = label
    self.expression = ExprSyntax(expression)
  }

  /// Initialize an instance of this type from a labeled expression.
  ///
  /// - Parameters:
  ///   - labeledExpr: The labeled expression.
  ///
  /// The resulting instance of ``Argument`` preserves any source location
  /// information present in `labeledExpr`.
  init(_ labeledExpr: LabeledExprSyntax) {
    self.init(label: labeledExpr.label, expression: labeledExpr.expression)
  }

  /// Initialize an instance of this type from an additional (i.e. labelled)
  /// trailing closure.
  ///
  /// - Parameters:
  ///   - trailingClosure: The trailing closure.
  ///
  /// The resulting instance of ``Argument`` preserves any source location
  /// information present in `trailingClosure`.
  init(_ trailingClosure: MultipleTrailingClosureElementSyntax) {
    self.init(label: trailingClosure.label, expression: trailingClosure.closure)
  }
}

// MARK: -

extension LabeledExprSyntax {
  /// Initialize an instance of this type from an instance of ``Argument``.
  ///
  /// - Parameters:
  ///   - argument: The argument to cast.
  ///
  /// The resulting instance of `LabeledExprSyntax` does _not_ preserve any
  /// source location information present in `argument`.
  init(_ argument: Argument) {
    self.init(label: argument.label?.text, expression: argument.expression.trimmed)
  }
}

// MARK: -

extension LabeledExprListSyntax {
  /// Initialize an instance of this type from a sequence of ``Argument``
  /// instances.
  ///
  /// - Parameters:
  ///   - arguments: The arguments to include in the resulting expression.
  ///
  /// The resulting instance of `LabeledExprListSyntax` is suitable for
  /// passing as arguments to a function such as `__check()`. It does not
  /// include leading or trailing parentheses, nor a final trailing comma.
  init(_ arguments: some Sequence<Argument>) {
    self.init {
      for labeledExpr in arguments.lazy.map(LabeledExprSyntax.init) {
        labeledExpr
      }
    }
  }
}