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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
import SwiftBasicFormat
import SwiftSyntax
/// A format style for files generated by CodeGeneration.
public class CodeGenerationFormat: BasicFormat {
/// The maximum number of array/dictionary/function parameters/tuple elements
/// that should be put on the same line.
private let maxElementsOnSameLine: Int
public init(maxElementsOnSameLine: Int = 3) {
self.maxElementsOnSameLine = maxElementsOnSameLine
super.init(indentationWidth: .spaces(2))
}
var indentedNewline: Trivia {
.newline + currentIndentationLevel
}
public override func visit(_ node: ArrayElementListSyntax) -> ArrayElementListSyntax {
let children = node.children(viewMode: .all)
// Short array literals are presented on one line, list each element on a different line.
if children.count > maxElementsOnSameLine {
return ArrayElementListSyntax(
formatChildrenSeparatedByNewline(children: children, elementType: ArrayElementSyntax.self)
)
} else {
return super.visit(node)
}
}
public override func visit(_ node: CodeBlockItemSyntax) -> CodeBlockItemSyntax {
if node.parent?.parent?.is(SourceFileSyntax.self) == true, !shouldBeSeparatedByTwoNewlines(node: node) {
let formatted = super.visit(node)
return ensuringTwoLeadingNewlines(node: formatted)
} else {
return super.visit(node)
}
}
public override func visit(_ node: DictionaryElementListSyntax) -> DictionaryElementListSyntax {
let children = node.children(viewMode: .all)
// Short dictionary literals are presented on one line, list each element on a different line.
if children.count > maxElementsOnSameLine {
return DictionaryElementListSyntax(
formatChildrenSeparatedByNewline(children: children, elementType: DictionaryElementSyntax.self)
)
} else {
return super.visit(node)
}
}
public override func visit(_ node: FunctionParameterListSyntax) -> FunctionParameterListSyntax {
let children = node.children(viewMode: .all)
// Short function parameter literals are presented on one line, list each element on a different line.
if children.count > maxElementsOnSameLine {
return FunctionParameterListSyntax(
formatChildrenSeparatedByNewline(children: children, elementType: FunctionParameterSyntax.self)
)
} else {
return super.visit(node)
}
}
public override func visit(_ node: MemberBlockSyntax) -> MemberBlockSyntax {
if node.members.count == 0 {
return node.with(\.leftBrace, .leftBraceToken())
} else {
return super.visit(node)
}
}
public override func visit(_ node: MemberBlockItemSyntax) -> MemberBlockItemSyntax {
let formatted = super.visit(node)
if node != node.parent?.children(viewMode: .sourceAccurate).first?.as(MemberBlockItemSyntax.self)
&& !node.decl.is(EnumCaseDeclSyntax.self)
{
return ensuringTwoLeadingNewlines(node: formatted)
} else {
return formatted
}
}
public override func visit(_ node: LabeledExprListSyntax) -> LabeledExprListSyntax {
let children = node.children(viewMode: .all)
// Short tuple element list literals are presented on one line, list each element on a different line.
if children.count > maxElementsOnSameLine {
let inMethodCallThatStartsOnNewline =
node.parent?.as(FunctionCallExprSyntax.self)?.calledExpression.as(MemberAccessExprSyntax.self)?.period
.startsOnNewline ?? false
if inMethodCallThatStartsOnNewline {
increaseIndentationLevel()
}
defer {
if inMethodCallThatStartsOnNewline {
decreaseIndentationLevel()
}
}
return LabeledExprListSyntax(
formatChildrenSeparatedByNewline(children: children, elementType: LabeledExprSyntax.self)
)
} else {
return super.visit(node)
}
}
public override func requiresIndent(_ node: some SyntaxProtocol) -> Bool {
switch node.kind {
case .arrayElementList, .dictionaryElementList, .functionParameterList, .labeledExprList:
let indentManually = node.children(viewMode: .sourceAccurate).count > maxElementsOnSameLine
if indentManually {
return false
}
if !node.startsOnNewline {
return false
}
default:
break
}
return super.requiresIndent(node)
}
// MARK: - Private
private func shouldBeSeparatedByTwoNewlines(node: CodeBlockItemSyntax) -> Bool {
// First item in the ``CodeBlockItemListSyntax`` don't need a newline or indentation if the parent is a ``SourceFileSyntax``.
// We want to group imports so newline between them should be omitted
return node.parent?.as(CodeBlockItemListSyntax.self)?.first == node || node.item.is(ImportDeclSyntax.self)
}
private func ensuringTwoLeadingNewlines<NodeType: SyntaxProtocol>(node: NodeType) -> NodeType {
if node.leadingTrivia.first?.isNewline ?? false {
return node.with(\.leadingTrivia, .newline + node.leadingTrivia)
} else {
return node.with(\.leadingTrivia, .newlines(2) + node.leadingTrivia)
}
}
private func formatChildrenSeparatedByNewline<SyntaxType: SyntaxProtocol>(
children: SyntaxChildren,
elementType: SyntaxType.Type
) -> [SyntaxType] {
increaseIndentationLevel()
var formattedChildren = children.map {
return self.rewrite($0.cast(SyntaxType.self)).cast(SyntaxType.self)
}
formattedChildren = formattedChildren.map { child in
var child = child
if let firstNonSpaceOrTabIndex = child.trailingTrivia.firstIndex(where: { !$0.isSpaceOrTab }) {
if child.trailingTrivia[firstNonSpaceOrTabIndex].isNewline {
child.trailingTrivia = Trivia(pieces: child.trailingTrivia.suffix(from: firstNonSpaceOrTabIndex))
}
} else {
child.trailingTrivia = Trivia()
}
if !child.startsOnNewline {
child.leadingTrivia = indentedNewline + child.leadingTrivia
}
return child
}
decreaseIndentationLevel()
if let lastChild = formattedChildren.last,
!lastChild.trailingTrivia.contains(where: \.isNewline)
{
let nextTokenStartsWithNewline =
lastChild.nextToken(viewMode: .sourceAccurate)?.leadingTrivia.first?.isNewline ?? false
if !nextTokenStartsWithNewline {
formattedChildren[formattedChildren.count - 1] = lastChild.with(
\.trailingTrivia,
lastChild.trailingTrivia + indentedNewline
)
}
}
return formattedChildren
}
}
private extension SyntaxProtocol {
var startsOnNewline: Bool {
return self.leadingTrivia.contains(where: \.isNewline)
|| self.previousToken(viewMode: .sourceAccurate)?.trailingTrivia.contains(where: \.isNewline) ?? false
}
}
|
