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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 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 SwiftSyntax
extension SyntaxProtocol {
/// Returns the absolute position of the trivia piece at the given index in the receiver's leading
/// trivia collection.
///
/// If the trivia piece spans multiple characters, the value returned is the position of the first
/// character.
///
/// - Precondition: `index` is a valid index in the receiver's leading trivia collection.
///
/// - Parameter index: The index of the trivia piece in the leading trivia whose position should
/// be returned.
/// - Returns: The absolute position of the trivia piece.
func position(ofLeadingTriviaAt index: Trivia.Index) -> AbsolutePosition {
guard leadingTrivia.indices.contains(index) else {
preconditionFailure("Index was out of bounds in the node's leading trivia.")
}
var offset = SourceLength.zero
for currentIndex in leadingTrivia.startIndex..<index {
offset += leadingTrivia[currentIndex].sourceLength
}
return self.position + offset
}
/// Returns the absolute position of the trivia piece at the given index in the receiver's
/// trailing trivia collection.
///
/// If the trivia piece spans multiple characters, the value returned is the position of the first
/// character.
///
/// - Precondition: `index` is a valid index in the receiver's trailing trivia collection.
///
/// - Parameter index: The index of the trivia piece in the trailing trivia whose position should
/// be returned.
/// - Returns: The absolute position of the trivia piece.
func position(ofTrailingTriviaAt index: Trivia.Index) -> AbsolutePosition {
guard trailingTrivia.indices.contains(index) else {
preconditionFailure("Index was out of bounds in the node's trailing trivia.")
}
var offset = SourceLength.zero
for currentIndex in trailingTrivia.startIndex..<index {
offset += trailingTrivia[currentIndex].sourceLength
}
return self.endPositionBeforeTrailingTrivia + offset
}
/// Returns the source location of the trivia piece at the given index in the receiver's leading
/// trivia collection.
///
/// If the trivia piece spans multiple characters, the value returned is the location of the first
/// character.
///
/// - Precondition: `index` is a valid index in the receiver's leading trivia collection.
///
/// - Parameters:
/// - index: The index of the trivia piece in the leading trivia whose location should be
/// returned.
/// - converter: The `SourceLocationConverter` that was previously initialized using the root
/// tree of this node.
/// - Returns: The source location of the trivia piece.
func startLocation(
ofLeadingTriviaAt index: Trivia.Index,
converter: SourceLocationConverter
) -> SourceLocation {
return converter.location(for: position(ofLeadingTriviaAt: index))
}
/// Returns the source location of the trivia piece at the given index in the receiver's trailing
/// trivia collection.
///
/// If the trivia piece spans multiple characters, the value returned is the location of the first
/// character.
///
/// - Precondition: `index` is a valid index in the receiver's trailing trivia collection.
///
/// - Parameters:
/// - index: The index of the trivia piece in the trailing trivia whose location should be
/// returned.
/// - converter: The `SourceLocationConverter` that was previously initialized using the root
/// tree of this node.
/// - Returns: The source location of the trivia piece.
func startLocation(
ofTrailingTriviaAt index: Trivia.Index,
converter: SourceLocationConverter
) -> SourceLocation {
return converter.location(for: position(ofTrailingTriviaAt: index))
}
/// The collection of all contiguous trivia preceding this node; that is, the trailing trivia of
/// the node before it and the leading trivia of the node itself.
var allPrecedingTrivia: Trivia {
var result: Trivia
if let previousTrailingTrivia = previousToken(viewMode: .sourceAccurate)?.trailingTrivia {
result = previousTrailingTrivia
} else {
result = Trivia()
}
result += leadingTrivia
return result
}
/// The collection of all contiguous trivia following this node; that is, the trailing trivia of
/// the node and the leading trivia of the node after it.
var allFollowingTrivia: Trivia {
var result = trailingTrivia
if let nextLeadingTrivia = nextToken(viewMode: .sourceAccurate)?.leadingTrivia {
result += nextLeadingTrivia
}
return result
}
/// Indicates whether the node has any preceding line comments.
///
/// Due to the way trivia is parsed, a preceding comment might be in either the leading trivia of
/// the node or the trailing trivia of the previous token.
var hasPrecedingLineComment: Bool {
if let previousTrailingTrivia = previousToken(viewMode: .sourceAccurate)?.trailingTrivia,
previousTrailingTrivia.hasLineComment
{
return true
}
return leadingTrivia.hasLineComment
}
/// Indicates whether the node has any preceding comments of any kind.
///
/// Due to the way trivia is parsed, a preceding comment might be in either the leading trivia of
/// the node or the trailing trivia of the previous token.
var hasAnyPrecedingComment: Bool {
if let previousTrailingTrivia = previousToken(viewMode: .sourceAccurate)?.trailingTrivia,
previousTrailingTrivia.hasAnyComments
{
return true
}
return leadingTrivia.hasAnyComments
}
}
extension SyntaxCollection {
/// The first element in the syntax collection if it is the *only* element, or nil otherwise.
var firstAndOnly: Element? {
var iterator = makeIterator()
guard let first = iterator.next() else { return nil }
guard iterator.next() == nil else { return nil }
return first
}
}
|
