File: MacroSpec.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 (49 lines) | stat: -rw-r--r-- 1,787 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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

#if swift(>=6)
public import SwiftSyntax
public import SwiftSyntaxMacros
#else
import SwiftSyntax
import SwiftSyntaxMacros
#endif

/// The information of a macro declaration, to be used with `assertMacroExpansion`.
///
/// In addition to specifying the macro’s type, this allows the specification of conformances that will be passed to the macro’s `expansion` function.
public struct MacroSpec: Sendable {
  /// The type of macro.
  let type: Macro.Type
  /// The list of types for which the macro needs to add conformances.
  let conformances: [TypeSyntax]

  /// An `InheritedTypeListSytnax` containing all the types for which the macro needs to add conformances.
  var inheritedTypeList: InheritedTypeListSyntax {
    return InheritedTypeListSyntax {
      for conformance in conformances {
        InheritedTypeSyntax(type: conformance)
      }
    }
  }

  /// Creates a new specification from provided macro type
  /// and optional list of generated conformances.
  ///
  /// - Parameters:
  ///   - type: The type of macro.
  ///   - conformances: The list of types that will be passed to the macro’s `expansion` function.
  public init(type: Macro.Type, conformances: [TypeSyntax] = []) {
    self.type = type
    self.conformances = conformances
  }
}