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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 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
//
//===----------------------------------------------------------------------===//
import SwiftSyntax
extension SyntaxProtocol {
/// Returns all names that `for` refers to at this syntax node.
/// Optional configuration can be passed as `config` to customize the lookup behavior.
///
/// - Returns: An array of `LookupResult` for `identifier` at this syntax node,
/// ordered by visibility. If `identifier` is set to `nil`, returns all available names ordered by visibility.
/// The order is from the innermost to the outermost scope,
/// and within each result, names are ordered by their introduction
/// in the source code.
///
/// Example usage:
/// ```swift
/// class C {
/// var a = 42
///
/// func a(a: Int) {
/// a // <--- lookup here
///
/// let a = 0
/// }
///
/// func a() {
/// // ...
/// }
/// }
/// ```
/// When calling this function on the declaration reference `a` within its name,
/// the function returns the parameter first, then the identifier of the variable
/// declaration, followed by the first function name, and then the second function name,
/// in this exact order. The constant declaration within the function body is omitted
/// due to the ordering rules that prioritize visibility within the function body.
@_spi(Experimental) public func lookup(
_ identifier: Identifier?,
with config: LookupConfig = LookupConfig()
) -> [LookupResult] {
scope?.lookup(identifier, at: self.position, with: config) ?? []
}
}
@_spi(Experimental) public protocol ScopeSyntax: SyntaxProtocol {
/// Parent of this scope, or `nil` if it is the root.
var parentScope: ScopeSyntax? { get }
/// Names introduced by default in this scope.
/// Don't include names that might be added depending on the lookup position (like `self`).
/// Ordered from first to last introduced.
var defaultIntroducedNames: [LookupName] { get }
/// Debug description of this scope.
var scopeDebugName: String { get }
/// Finds all declarations `identifier` refers to. `syntax` specifies the node lookup was triggered with.
/// If `identifier` set to `nil`, returns all available names at the given node.
func lookup(
_ identifier: Identifier?,
at lookUpPosition: AbsolutePosition,
with config: LookupConfig
) -> [LookupResult]
}
@_spi(Experimental) extension ScopeSyntax {
@_spi(Experimental) public var parentScope: ScopeSyntax? {
self.parent?.scope
}
/// Returns `LookupResult` of all names introduced in this scope that `identifier`
/// refers to and is accessible at given syntax node then passes lookup to the parent.
/// If `identifier` set to `nil`, returns all available names at the given node.
@_spi(Experimental) public func lookup(
_ identifier: Identifier?,
at lookUpPosition: AbsolutePosition,
with config: LookupConfig
) -> [LookupResult] {
defaultLookupImplementation(identifier, at: lookUpPosition, with: config)
}
/// Returns `LookupResult` of all names introduced in this scope that `identifier`
/// refers to and is accessible at given syntax node then passes lookup to the parent.
/// If `identifier` set to `nil`, returns all available names at the given node.
func defaultLookupImplementation(
in names: [LookupName]? = nil,
_ identifier: Identifier?,
at lookUpPosition: AbsolutePosition,
with config: LookupConfig,
propagateToParent: Bool = true
) -> [LookupResult] {
let filteredNames =
(names ?? defaultIntroducedNames)
.filter { introducedName in
checkIdentifier(identifier, refersTo: introducedName, at: lookUpPosition)
}
return LookupResult.getResultArray(for: self, withNames: filteredNames)
+ (propagateToParent ? lookupInParent(identifier, at: lookUpPosition, with: config) : [])
}
/// Looks up in parent scope.
func lookupInParent(
_ identifier: Identifier?,
at lookUpPosition: AbsolutePosition,
with config: LookupConfig
) -> [LookupResult] {
parentScope?.lookup(identifier, at: lookUpPosition, with: config) ?? []
}
func checkIdentifier(
_ identifier: Identifier?,
refersTo introducedName: LookupName,
at lookUpPosition: AbsolutePosition
) -> Bool {
introducedName.isAccessible(at: lookUpPosition) && introducedName.refersTo(identifier)
}
var isMember: Bool {
if parentScope?.is(MemberBlockSyntax.self) ?? false {
return true
} else if let parentIfConfig = parentScope?.as(IfConfigDeclSyntax.self) {
return parentIfConfig.isMember
} else {
return false
}
}
/// Debug description of this scope.
@_spi(Experimental) public var scopeDebugDescription: String {
scopeDebugName + " " + debugLineWithColumnDescription
}
/// Hierarchy of scopes starting from this scope.
@_spi(Experimental) public var scopeDebugHierarchyDescription: String {
if let parentScope = parentScope {
return parentScope.scopeDebugHierarchyDescription + " <-- " + scopeDebugDescription
} else {
return scopeDebugDescription
}
}
}
|
