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
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
/// Specifies how missing and unexpected nodes should be handled when traversing
/// a syntax tree.
public enum SyntaxTreeViewMode: Sendable {
/// Visit the tree in a way that reproduces the original source code.
/// Missing nodes will not be visited, unexpected nodes will be visited.
/// This mode is useful for source code transformations like a formatter.
case sourceAccurate
/// Views the syntax tree with fixes applied, that is missing nodes will be
/// visited but unexpected nodes will be skipped.
/// This views the tree in a way that's closer to being syntactical correct
/// and should be used for structural analysis of the syntax tree.
case fixedUp
/// Both missing and unexpected nodes will be traversed.
case all
/// Returns whether this traversal node should visit `node` or ignore it.
@_spi(RawSyntax)
public func shouldTraverse(node: RawSyntax) -> Bool {
switch self {
case .sourceAccurate:
if let tokenView = node.tokenView {
return tokenView.presence == .present
}
return true
case .fixedUp:
return node.kind != .unexpectedNodes
case .all:
return true
}
}
}
|
