mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
fe2104ca99
Rather than requiring macro implementations to add required whitespace and indentation, basic format all macro expansions. Right now this uses the default four space indentation, we can consider having that inferred later. Macros can opt-out of automatic formatting by implementing `formatMode` and setting it to `.disabled`. Also moves the extra newlines before/after expansions to a new "Inline Macro" refactoring. Resolves rdar://107731047.
274 lines
14 KiB
Swift
274 lines
14 KiB
Swift
@freestanding(expression) macro stringify<T>(_ value: T) -> (T, String) = #externalMacro(module: "MacroDefinition", type: "StringifyMacro")
|
|
|
|
func testStringify(a: Int, b: Int) {
|
|
_ = #stringify(a + b).1
|
|
}
|
|
|
|
@attached(memberAttribute)
|
|
@attached(member)
|
|
macro myTypeWrapper() = #externalMacro(module: "MacroDefinition", type: "TypeWrapperMacro")
|
|
@attached(accessor) macro accessViaStorage() = #externalMacro(module: "MacroDefinition", type: "AccessViaStorageMacro")
|
|
|
|
struct _Storage {
|
|
var x: Int = 0 {
|
|
willSet { print("setting \(newValue)") }
|
|
}
|
|
var y: Int = 0 {
|
|
willSet { print("setting \(newValue)") }
|
|
}
|
|
}
|
|
|
|
@myTypeWrapper
|
|
struct S {
|
|
var x: Int
|
|
var y: Int
|
|
}
|
|
|
|
struct S2 {
|
|
private var _storage = _Storage()
|
|
|
|
@accessViaStorage
|
|
var x: Int
|
|
|
|
@accessViaStorage
|
|
var y: Int = 17
|
|
}
|
|
|
|
@attached(peer)
|
|
macro addCompletionHandler() = #externalMacro(module: "MacroDefinition", type: "AddCompletionHandler")
|
|
|
|
@available(macOS 10.15, *)
|
|
struct S3 {
|
|
@addCompletionHandler
|
|
func f(a: Int, for b: String, _ value: Double) async -> String {
|
|
return b
|
|
}
|
|
}
|
|
|
|
@attached(conformance)
|
|
macro Hashable() = #externalMacro(module: "MacroDefinition", type: "HashableMacro")
|
|
|
|
@Hashable
|
|
struct S4 { }
|
|
|
|
@freestanding(declaration)
|
|
macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition", type: "DefineAnonymousTypesMacro")
|
|
|
|
#anonymousTypes { "hello" }
|
|
|
|
// REQUIRES: swift_swift_parser, executable_test, shell
|
|
|
|
// RUN: %empty-directory(%t)
|
|
|
|
//##-- Prepare the macro plugin.
|
|
// RUN: %host-build-swift -swift-version 5 -emit-library -o %t/%target-library-name(MacroDefinition) -module-name=MacroDefinition %S/../../Macros/Inputs/syntax_macro_definitions.swift -g -no-toolchain-stdlib-rpath
|
|
|
|
// RUN: COMPILER_ARGS_WITHOUT_SOURCE=( \
|
|
// RUN: -swift-version 5 \
|
|
// RUN: -load-plugin-library %t/%target-library-name(MacroDefinition) \
|
|
// RUN: -module-name MacroUser \
|
|
// RUN: )
|
|
|
|
// RUN: COMPILER_ARGS=( \
|
|
// RUN: ${COMPILER_ARGS_WITHOUT_SOURCE[@]} \
|
|
// RUN: %s \
|
|
// RUN: )
|
|
|
|
//##-- cursor-info on macro expression
|
|
// RUN: %sourcekitd-test -req=cursor -pos=4:7 -cursor-action -req-opts=retrieve_symbol_graph=1 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=CURSOR_MACRO_EXPR %s
|
|
// RUN: %sourcekitd-test -req=cursor -pos=4:8 -cursor-action -req-opts=retrieve_symbol_graph=1 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=CURSOR_MACRO_EXPR %s
|
|
// CURSOR_MACRO_EXPR: source.lang.swift.ref.macro (1:33-1:42)
|
|
// CURSOR_MACRO_EXPR: (T) -> (T, String)
|
|
// CURSOR_MACRO_EXPR: <Declaration>@freestanding(expression) macro stringify<T>(_ value: <Type usr="s:9MacroUser1TL_xmfp">T</Type>) -> (<Type usr="s:9MacroUser1TL_xmfp">T</Type>, <Type usr="s:SS">String</Type>) = #externalMacro(module: "MacroDefinition", type: "StringifyMacro")</Declaration>
|
|
// CURSOR_MACRO_EXPR: <decl.macro><syntaxtype.attribute.builtin><syntaxtype.attribute.name>@freestanding</syntaxtype.attribute.name>(expression)</syntaxtype.attribute.builtin> <syntaxtype.keyword>macro</syntaxtype.keyword> <decl.name>stringify</decl.name><<decl.generic_type_param usr="s:9MacroUser1TL_xmfp"><decl.generic_type_param.name>T</decl.generic_type_param.name></decl.generic_type_param>>(<decl.var.parameter><decl.var.parameter.argument_label>_</decl.var.parameter.argument_label> <decl.var.parameter.name>value</decl.var.parameter.name>: <decl.var.parameter.type><ref.generic_type_param usr="s:9MacroUser1TL_xmfp">T</ref.generic_type_param></decl.var.parameter.type></decl.var.parameter>) -> <decl.function.returntype><tuple>(<tuple.element><tuple.element.type><ref.generic_type_param usr="s:9MacroUser1TL_xmfp">T</ref.generic_type_param></tuple.element.type></tuple.element>, <tuple.element><tuple.element.type><ref.struct usr="s:SS">String</ref.struct></tuple.element.type></tuple.element>)</tuple></decl.function.returntype> = #externalMacro(module: "MacroDefinition", type: "StringifyMacro")</decl.macro>
|
|
// CURSOR_MACRO_EXPR-LABEL: SYMBOL GRAPH BEGIN
|
|
// CURSOR_MACRO_EXPR: "identifier": {
|
|
// CURSOR_MACRO_EXPR-NEXT: "interfaceLanguage": "swift",
|
|
// CURSOR_MACRO_EXPR-NEXT: "precise": "s:9MacroUser9stringifyyx_SStxclufm"
|
|
// CURSOR_MACRO_EXPR-NEXT: },
|
|
// CURSOR_MACRO_EXPR-NEXT: "kind": {
|
|
// CURSOR_MACRO_EXPR-NEXT: "displayName": "Macro",
|
|
// CURSOR_MACRO_EXPR-NEXT: "identifier": "swift.macro"
|
|
// CURSOR_MACRO_EXPR-NEXT: },
|
|
// CURSOR_MACRO_EXPR: SYMBOL GRAPH END
|
|
// CURSOR_MACRO_EXPR-LABEL: ACTIONS BEGIN
|
|
// CURSOR_MACRO_EXPR: source.refactoring.kind.rename.global
|
|
// CURSOR_MACRO_EXPR-NEXT: Global Rename
|
|
// CURSOR_MACRO_EXPR: source.refactoring.kind.inline.macro
|
|
// CURSOR_MACRO_EXPR-NEXT: Inline Macro
|
|
// CURSOR_MACRO_EXPR: ACTIONS END
|
|
|
|
//##-- Expansion on macro expression
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=4:7 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=EXPAND %s
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=4:8 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=EXPAND %s
|
|
// EXPAND: source.edit.kind.active:
|
|
// EXPAND-NEXT: 4:7-4:24 (@__swiftmacro_9MacroUser13testStringify1a1bySi_SitF9stringifyfMf_.swift) "(a + b, "a + b")"
|
|
|
|
//##-- cursor-info on macro declaration
|
|
// RUN: %sourcekitd-test -req=cursor -pos=57:1 -cursor-action -req-opts=retrieve_symbol_graph=1 %s -- ${COMPILER_ARGS[@]} -parse-as-library -enable-experimental-feature FreestandingMacros | %FileCheck -check-prefix=CURSOR_MACRO_DECL %s
|
|
// RUN: %sourcekitd-test -req=cursor -pos=57:2 -cursor-action -req-opts=retrieve_symbol_graph=1 %s -- ${COMPILER_ARGS[@]} -parse-as-library -enable-experimental-feature FreestandingMacros | %FileCheck -check-prefix=CURSOR_MACRO_DECL %s
|
|
// CURSOR_MACRO_DECL: source.lang.swift.ref.macro (55:7-55:21)
|
|
// CURSOR_MACRO_DECL-LABEL: SYMBOL GRAPH BEGIN
|
|
// CURSOR_MACRO_DECL: "identifier": {
|
|
// CURSOR_MACRO_DECL-NEXT: "interfaceLanguage": "swift",
|
|
// CURSOR_MACRO_DECL-NEXT: "precise": "s:9MacroUser14anonymousTypesyySSyXEcfm"
|
|
// CURSOR_MACRO_DECL-NEXT: },
|
|
// CURSOR_MACRO_DECL-NEXT: "kind": {
|
|
// CURSOR_MACRO_DECL-NEXT: "displayName": "Macro",
|
|
// CURSOR_MACRO_DECL-NEXT: "identifier": "swift.macro"
|
|
// CURSOR_MACRO_DECL-NEXT: },
|
|
// CURSOR_MACRO_DECL: SYMBOL GRAPH END
|
|
// CURSOR_MACRO_DECL-LABEL: ACTIONS BEGIN
|
|
// CURSOR_MACRO_DECL: source.refactoring.kind.inline.macro
|
|
// CURSOR_MACRO_DECL-NEXT: Inline Macro
|
|
// CURSOR_MACRO_DECL: ACTIONS END
|
|
|
|
//##-- Expansion on macro declaration
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=57:1 %s -- ${COMPILER_ARGS[@]} -parse-as-library -enable-experimental-feature FreestandingMacros | %FileCheck -check-prefix=EXPAND_MACRO_DECL %s
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=57:2 %s -- ${COMPILER_ARGS[@]} -parse-as-library -enable-experimental-feature FreestandingMacros | %FileCheck -check-prefix=EXPAND_MACRO_DECL %s
|
|
// EXPAND_MACRO_DECL: source.edit.kind.active:
|
|
// EXPAND_MACRO_DECL-NEXT: 57:1-57:28 (@__swiftmacro_9MacroUser33_70D4178875715FB9B8B50C58F66F8D53Ll14anonymousTypesfMf0_.swift) "class $s9MacroUser33_70D4178875715FB9B8B50C58F66F8D53Ll14anonymousTypesfMf0_4namefMu_ {
|
|
// EXPAND_MACRO_DECL-NEXT: func hello() -> String {
|
|
// EXPAND_MACRO_DECL-NEXT: "hello"
|
|
// EXPAND_MACRO_DECL-NEXT: }
|
|
// EXPAND_MACRO_DECL-EMPTY:
|
|
// EXPAND_MACRO_DECL-NEXT: func getSelf() -> Any .Type {
|
|
// EXPAND_MACRO_DECL-NEXT: return Self.self
|
|
// EXPAND_MACRO_DECL-NEXT: }
|
|
// EXPAND_MACRO_DECL-NEXT: }
|
|
// EXPAND_MACRO_DECL-NEXT: enum $s9MacroUser33_70D4178875715FB9B8B50C58F66F8D53Ll14anonymousTypesfMf0_4namefMu0_ {
|
|
// EXPAND_MACRO_DECL-NEXT: case apple
|
|
// EXPAND_MACRO_DECL-NEXT: case banana
|
|
// EXPAND_MACRO_DECL-EMPTY:
|
|
// EXPAND_MACRO_DECL-NEXT: func hello() -> String {
|
|
// EXPAND_MACRO_DECL-NEXT: "hello"
|
|
// EXPAND_MACRO_DECL-NEXT: }
|
|
// EXPAND_MACRO_DECL-NEXT: }"
|
|
|
|
//##-- cursor-info on attached macro
|
|
// RUN: %sourcekitd-test -req=cursor -pos=21:1 -cursor-action -req-opts=retrieve_symbol_graph=1 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=CURSOR_ATTACHED %s
|
|
// RUN: %sourcekitd-test -req=cursor -pos=21:2 -cursor-action -req-opts=retrieve_symbol_graph=1 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=CURSOR_ATTACHED %s
|
|
// CURSOR_ATTACHED: source.lang.swift.ref.macro (9:7-9:20)
|
|
// CURSOR_ATTACHED-LABEL: SYMBOL GRAPH BEGIN
|
|
// CURSOR_ATTACHED: "identifier": {
|
|
// CURSOR_ATTACHED-NEXT: "interfaceLanguage": "swift",
|
|
// CURSOR_ATTACHED-NEXT: "precise": "s:9MacroUser13myTypeWrapperyycfm"
|
|
// CURSOR_ATTACHED-NEXT: },
|
|
// CURSOR_ATTACHED-NEXT: "kind": {
|
|
// CURSOR_ATTACHED-NEXT: "displayName": "Macro",
|
|
// CURSOR_ATTACHED-NEXT: "identifier": "swift.macro"
|
|
// CURSOR_ATTACHED-NEXT: },
|
|
// CURSOR_ATTACHED: SYMBOL GRAPH END
|
|
// CURSOR_ATTACHED-LABEL: ACTIONS BEGIN
|
|
// CURSOR_ATTACHED: source.refactoring.kind.inline.macro
|
|
// CURSOR_ATTACHED-NEXT: Inline Macro
|
|
// CURSOR_ATTACHED: ACTIONS END
|
|
|
|
//##-- Expansion on attached macro
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=21:1 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=ATTACHED_EXPAND %s
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=21:2 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=ATTACHED_EXPAND %s
|
|
// ATTACHED_EXPAND: source.edit.kind.active:
|
|
// ATTACHED_EXPAND-NEXT: 23:3-23:3 (@__swiftmacro_9MacroUser1SV1x13myTypeWrapperfMA_.swift) "@accessViaStorage"
|
|
// ATTACHED_EXPAND-NEXT: source.edit.kind.active:
|
|
// ATTACHED_EXPAND-NEXT: 24:3-24:3 (@__swiftmacro_9MacroUser1SV1y13myTypeWrapperfMA0_.swift) "@accessViaStorage"
|
|
// ATTACHED_EXPAND-NEXT: source.edit.kind.active:
|
|
// ATTACHED_EXPAND-NEXT: 25:1-25:1 (@__swiftmacro_9MacroUser1S13myTypeWrapperfMm_.swift) "private var _storage = _Storage()"
|
|
// ATTACHED_EXPAND-NEXT: source.edit.kind.active:
|
|
// ATTACHED_EXPAND-NEXT: 21:1-21:15 ""
|
|
|
|
//##-- Cursor info on the attribute expanded by @myTypeWrapper
|
|
// RUN: %sourcekitd-test -req=cursor -cursor-action -req-opts=retrieve_symbol_graph=1 -offset=1 @__swiftmacro_9MacroUser1SV1x13myTypeWrapperfMA_.swift -primary-file %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=NESTED_ATTACHED_CURSOR %s
|
|
// NESTED_ATTACHED_CURSOR: source.lang.swift.ref.macro
|
|
// NESTED_ATTACHED_CURSOR-SAME: macro_basic.swift:10:27-10:43
|
|
// NESTED_ATTACHED_CURSOR-LABEL: SYMBOL GRAPH BEGIN
|
|
// NESTED_ATTACHED_CURSOR: "identifier": {
|
|
// NESTED_ATTACHED_CURSOR-NEXT: "interfaceLanguage": "swift",
|
|
// NESTED_ATTACHED_CURSOR-NEXT: "precise": "s:9MacroUser16accessViaStorageyycfm"
|
|
// NESTED_ATTACHED_CURSOR-NEXT: },
|
|
// NESTED_ATTACHED_CURSOR-NEXT: "kind": {
|
|
// NESTED_ATTACHED_CURSOR-NEXT: "displayName": "Macro",
|
|
// NESTED_ATTACHED_CURSOR-NEXT: "identifier": "swift.macro"
|
|
// NESTED_ATTACHED_CURSOR-NEXT: },
|
|
// NESTED_ATTACHED_CURSOR: SYMBOL GRAPH END
|
|
// NESTED_ATTACHED_CURSOR-LABEL: ACTIONS BEGIN
|
|
// NESTED_ATTACHED_CURSOR-NEXT: source.refactoring.kind.inline.macro
|
|
// NESTED_ATTACHED_CURSOR-NEXT: Inline Macro
|
|
// NESTED_ATTACHED_CURSOR-NEXT: ACTIONS END
|
|
|
|
//##-- Expansion on the attribute expanded by @myTypeWrapper
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=1:1 @__swiftmacro_9MacroUser1SV1x13myTypeWrapperfMA_.swift -primary-file %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=NESTED_ATTACHED_EXPAND %s
|
|
// NESTED_ATTACHED_EXPAND: source.edit.kind.active:
|
|
// NESTED_ATTACHED_EXPAND-NEXT: Macros/macro_basic.swift 23:13-23:13 (@__swiftmacro_9MacroUser1SV1x16accessViaStoragefMa_.swift) "{
|
|
// NESTED_ATTACHED_EXPAND-NEXT: get {
|
|
// NESTED_ATTACHED_EXPAND-NEXT: _storage.x
|
|
// NESTED_ATTACHED_EXPAND-NEXT: }
|
|
// NESTED_ATTACHED_EXPAND-EMPTY:
|
|
// NESTED_ATTACHED_EXPAND-NEXT: set {
|
|
// NESTED_ATTACHED_EXPAND-NEXT: _storage.x = newValue
|
|
// NESTED_ATTACHED_EXPAND-NEXT: }
|
|
// NESTED_ATTACHED_EXPAND-NEXT: }"
|
|
// NESTED_ATTACHED_EXPAND-NEXT: source.edit.kind.active:
|
|
// NESTED_ATTACHED_EXPAND-NEXT: 1:1-1:18 ""
|
|
|
|
//##-- Expansion on the first accessor macro
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=30:4 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=ACCESSOR1_EXPAND %s
|
|
// ACCESSOR1_EXPAND: source.edit.kind.active:
|
|
// ACCESSOR1_EXPAND-NEXT: 31:13-31:13 (@__swiftmacro_9MacroUser2S2V1x16accessViaStoragefMa_.swift) "{
|
|
// ACCESSOR1_EXPAND-NEXT: get {
|
|
// ACCESSOR1_EXPAND-NEXT: _storage.x
|
|
// ACCESSOR1_EXPAND-NEXT: }
|
|
// ACCESSOR1_EXPAND-EMPTY:
|
|
// ACCESSOR1_EXPAND-NEXT: set {
|
|
// ACCESSOR1_EXPAND-NEXT: _storage.x = newValue
|
|
// ACCESSOR1_EXPAND-NEXT: }
|
|
// ACCESSOR1_EXPAND-NEXT: }"
|
|
// ACCESSOR1_EXPAND-NEXT: source.edit.kind.active:
|
|
// ACCESSOR1_EXPAND-NEXT: 30:3-30:20 ""
|
|
|
|
//##-- Expansion on the second accessor macro
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=33:13 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=ACCESSOR2_EXPAND %s
|
|
// ACCESSOR2_EXPAND: source.edit.kind.active:
|
|
// ACCESSOR2_EXPAND-NEXT: 34:14-34:18 (@__swiftmacro_9MacroUser2S2V1y16accessViaStoragefMa_.swift) "{
|
|
// ACCESSOR2_EXPAND-NEXT: get {
|
|
// ACCESSOR2_EXPAND-NEXT: _storage.y
|
|
// ACCESSOR2_EXPAND-NEXT: }
|
|
// ACCESSOR2_EXPAND-EMPTY:
|
|
// ACCESSOR2_EXPAND-NEXT: set {
|
|
// ACCESSOR2_EXPAND-NEXT: _storage.y = newValue
|
|
// ACCESSOR2_EXPAND-NEXT: }
|
|
// ACCESSOR2_EXPAND-NEXT: }"
|
|
// ACCESSOR2_EXPAND-NEXT: source.edit.kind.active:
|
|
// ACCESSOR2_EXPAND-NEXT: 33:3-33:20 ""
|
|
|
|
//##-- Expansion on the addCompletionHandler macro.
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=42:5 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=PEER_EXPAND %s
|
|
// PEER_EXPAND: source.edit.kind.active:
|
|
// PEER_EXPAND-NEXT: 45:4-45:4 (@__swiftmacro_9MacroUser2S3V1f20addCompletionHandlerfMp_.swift) "func f(a: Int, for b: String, _ value: Double, completionHandler: @escaping (String) -> Void) {
|
|
// PEER_EXPAND-NEXT: Task {
|
|
// PEER_EXPAND-NEXT: completionHandler(await f(a: a, for: b, value))
|
|
// PEER_EXPAND-NEXT: }
|
|
// PEER_EXPAND-NEXT: }"
|
|
// PEER_EXPAND-NEXT: source.edit.kind.active:
|
|
// PEER_EXPAND-NEXT: 42:3-42:24 ""
|
|
|
|
//##-- Expansion on a conformance macro.
|
|
// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=51:5 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=CONFORMANCE_EXPAND %s
|
|
// CONFORMANCE_EXPAND: source.edit.kind.active:
|
|
// CONFORMANCE_EXPAND-NEXT: 52:14-52:14 (@__swiftmacro_9MacroUser2S48HashablefMc_.swift) "extension S4 : Hashable {}"
|
|
// CONFORMANCE_EXPAND-NEXT: source.edit.kind.active:
|
|
// CONFORMANCE_EXPAND-NEXT: 51:1-51:10 ""
|
|
|
|
//##-- Doc info, mostly just checking we don't crash because of the separate buffers
|
|
// RUN: %sourcekitd-test -req=doc-info %s -- ${COMPILER_ARGS_WITHOUT_SOURCE[@]} | %FileCheck -check-prefix=DOCINFO %s
|
|
// DOCINFO: key.name: "myTypeWrapper()"
|
|
// DOCINFO-NEXT: key.usr: "s:9MacroUser13myTypeWrapperyycfm"
|
|
// DOCINFO-NEXT: key.offset: 623
|
|
// DOCINFO: key.name: "myTypeWrapper()"
|
|
// DOCINFO-NEXT: key.usr: "s:9MacroUser13myTypeWrapperyycfm"
|
|
// DOCINFO-NEXT: key.offset: 252
|
|
|
|
//##-- Formatting shouldn't include the added attribute (or crash)
|
|
// RUN: %sourcekitd-test -req=format -line=23 -length=1 %s | %FileCheck -check-prefix=FORMATTED %s
|
|
// FORMATTED: " var x: Int"
|
|
|