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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2024 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
#else
import SwiftSyntax
#endif
extension SyntaxProtocol {
/// Indent this node’s lines by the provided amount.
///
/// - Parameter indentFirstLine: Whether the first token of this node should be indented.
/// Pass `true` if you know that this node will be placed at the beginning of a line, even if its
/// current leading trivia does not start with a newline (such as at the very start of a file).
public func indented(by indentation: Trivia, indentFirstLine: Bool = false) -> Self {
Indenter(indentation: indentation, indentFirstLine: indentFirstLine)
.rewrite(self)
.cast(Self.self)
}
}
private class Indenter: SyntaxRewriter {
private let indentation: Trivia
private var shouldIndent: Bool
init(indentation: Trivia, indentFirstLine: Bool) {
self.indentation = indentation
self.shouldIndent = indentFirstLine
}
private func indentationIfNeeded() -> [TriviaPiece] {
if shouldIndent {
shouldIndent = false
return indentation.pieces
} else {
return []
}
}
private func indentAfterNewlines(_ content: String) -> String {
content.split(separator: "\n").joined(separator: "\n" + indentation.description)
}
private func indent(_ trivia: Trivia, skipEmpty: Bool) -> Trivia {
if skipEmpty, trivia.isEmpty { return trivia }
var result: [TriviaPiece] = []
// most times, we won’t have anything to insert so this will
// reserve enough space
result.reserveCapacity(trivia.count)
for piece in trivia.pieces {
result.append(contentsOf: indentationIfNeeded())
switch piece {
case .newlines, .carriageReturns, .carriageReturnLineFeeds:
shouldIndent = true
// style decision: don’t indent totally blank lines
result.append(piece)
case .blockComment(let content):
result.append(.blockComment(indentAfterNewlines(content)))
case .docBlockComment(let content):
result.append(.docBlockComment(indentAfterNewlines(content)))
case .unexpectedText(let content):
result.append(.unexpectedText(indentAfterNewlines(content)))
default:
result.append(piece)
}
}
result.append(contentsOf: indentationIfNeeded())
return Trivia(pieces: result)
}
override func visit(_ token: TokenSyntax) -> TokenSyntax {
let indentedLeadingTrivia = indent(token.leadingTrivia, skipEmpty: false)
// compute this before indenting the trailing trivia since the
// newline here is before the start of the trailing trivia (since
// it is part of the string’s value)
if case .stringSegment(let content) = token.tokenKind,
let last = content.last,
last.isNewline
{
shouldIndent = true
}
return
token
.with(\.leadingTrivia, indentedLeadingTrivia)
// source files as parsed can’t have anything requiring indentation
// here, but it’s easy to do `.with(\.trailingTrivia, .newline)` so
// we should still check if there’s something to indent.
.with(\.trailingTrivia, indent(token.trailingTrivia, skipEmpty: true))
}
}
|
