averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-14 20:36:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

[Macros] Automatically format expanded macros

Browse Source 
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.
This commit is contained in:
Ben Barham
2023-04-26 15:06:18 -07:00
parent db14ae840e
commit fe2104ca99
9 changed files with 304 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
test/SourceKit/Macros/macro_basic.swift
View File

@@ -94,8 +94,8 @@ macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition"
// 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.expand.macro
// CURSOR_MACRO_EXPR-NEXT: Expand Macro
// CURSOR_MACRO_EXPR: source.refactoring.kind.inline.macro
// CURSOR_MACRO_EXPR-NEXT: Inline Macro
// CURSOR_MACRO_EXPR: ACTIONS END
//##-- Expansion on macro expression
@@ -119,8 +119,8 @@ macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition"
// CURSOR_MACRO_DECL-NEXT: },
// CURSOR_MACRO_DECL: SYMBOL GRAPH END
// CURSOR_MACRO_DECL-LABEL: ACTIONS BEGIN
// CURSOR_MACRO_DECL: source.refactoring.kind.expand.macro
// CURSOR_MACRO_DECL-NEXT: Expand Macro
// CURSOR_MACRO_DECL: source.refactoring.kind.inline.macro
// CURSOR_MACRO_DECL-NEXT: Inline Macro
// CURSOR_MACRO_DECL: ACTIONS END
//##-- Expansion on macro declaration
@@ -131,7 +131,10 @@ macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition"
// EXPAND_MACRO_DECL-NEXT: func hello() -> String {
// EXPAND_MACRO_DECL-NEXT: "hello"
// EXPAND_MACRO_DECL-NEXT: }
// EXPAND_MACRO_DECL: func getSelf() -> Any.Type { return Self.self }
// 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
@@ -157,27 +160,24 @@ macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition"
// CURSOR_ATTACHED-NEXT: },
// CURSOR_ATTACHED: SYMBOL GRAPH END
// CURSOR_ATTACHED-LABEL: ACTIONS BEGIN
// CURSOR_ATTACHED: source.refactoring.kind.expand.macro
// CURSOR_ATTACHED-NEXT: Expand Macro
// 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: 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: 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) "
// ATTACHED_EXPAND-EMPTY:
// ATTACHED_EXPAND-NEXT: private var _storage = _Storage()
// ATTACHED_EXPAND-NEXT: "
// 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=2 @__swiftmacro_9MacroUser1SV1x13myTypeWrapperfMA_.swift -primary-file %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=NESTED_ATTACHED_CURSOR %s
// 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
@@ -191,17 +191,21 @@ macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition"
// NESTED_ATTACHED_CURSOR-NEXT: },
// NESTED_ATTACHED_CURSOR: SYMBOL GRAPH END
// NESTED_ATTACHED_CURSOR-LABEL: ACTIONS BEGIN
// NESTED_ATTACHED_CURSOR-NEXT: source.refactoring.kind.expand.macro
// NESTED_ATTACHED_CURSOR-NEXT: Expand Macro
// 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:2 @__swiftmacro_9MacroUser1SV1x13myTypeWrapperfMA_.swift -primary-file %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=NESTED_ATTACHED_EXPAND %s
// 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 { _storage.x }
// NESTED_ATTACHED_EXPAND-NEXT: get {
// NESTED_ATTACHED_EXPAND-NEXT: _storage.x
// NESTED_ATTACHED_EXPAND-NEXT: }
// NESTED_ATTACHED_EXPAND-EMPTY:
// NESTED_ATTACHED_EXPAND-NEXT: set { _storage.x = newValue }
// 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 ""
@@ -210,9 +214,13 @@ macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition"
// 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 { _storage.x }
// ACCESSOR1_EXPAND-NEXT: get {
// ACCESSOR1_EXPAND-NEXT: _storage.x
// ACCESSOR1_EXPAND-NEXT: }
// ACCESSOR1_EXPAND-EMPTY:
// ACCESSOR1_EXPAND-NEXT: set { _storage.x = newValue }
// 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 ""
@@ -221,9 +229,13 @@ macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition"
// 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 { _storage.y }
// ACCESSOR2_EXPAND-NEXT: get {
// ACCESSOR2_EXPAND-NEXT: _storage.y
// ACCESSOR2_EXPAND-NEXT: }
// ACCESSOR2_EXPAND-EMPTY:
// ACCESSOR2_EXPAND-NEXT: set { _storage.y = newValue }
// 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 ""
@@ -231,24 +243,18 @@ macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition"
//##-- 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) "
// PEER_EXPAND-EMPTY:
// PEER_EXPAND-NEXT: func f(a: Int, for b: String, _ value: Double, completionHandler: @escaping (String) -> Void) {
// 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: "
// 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) "
// CONFORMANCE_EXPAND-EMPTY:
// CONFORMANCE_EXPAND-NEXT: extension S4 : Hashable {}
// CONFORMANCE_EXPAND-NEXT: "
// 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 ""