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