File: ExtensionMacros.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 (56 lines) | stat: -rw-r--r-- 1,907 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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

// MARK: - Equatable Extension

@attached(extension, conformances: Equatable)
public macro equatable() = #externalMacro(module: "MacroExamplesImplementation", type: "EquatableExtensionMacro")

// MARK: - Default Fatal Error Implementation

/// A macro that provides default `fatalError` implementations for protocol methods.
///
/// This macro generates Swift extensions for the attached protocol,
/// adding a default `fatalError` implementation for each method defined within it.
///
/// ## Example usage:
/// ```swift
/// @defaultFatalErrorImplementation
/// protocol MyProtocol {
///   func someMethod()
/// }
/// ```
///
/// The generated code would look like:
/// ```swift
/// protocol MyProtocol {
///   func someMethod()
/// }
///
/// extension MyProtocol {
///   func someMethod() {
///     fatalError("whoops 😅")
///   }
/// }
/// ```
///
/// ## Edge Cases
/// - **No Methods in Protocol**: If the protocol does not contain any methods,
///   the macro will not generate an empty extension.
/// - **Incorrect Attachment**: If the macro is attached to a non-protocol declaration,
///   it will produce an error diagnostic stating that it can only be applied to a protocol.
@attached(extension, names: arbitrary)
public macro defaultFatalErrorImplementation() =
  #externalMacro(
    module: "MacroExamplesImplementation",
    type: "DefaultFatalErrorImplementationMacro"
  )