/
StandaloneSymbolSearch.scala
242 lines (221 loc) Β· 6.85 KB
/
StandaloneSymbolSearch.scala
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
package scala.meta.internal.metals
import java.net.URI
import java.nio.file.Path
import java.{util => ju}
import scala.collection.concurrent.TrieMap
import scala.meta.internal.metals.MetalsEnrichments._
import scala.meta.internal.mtags.Mtags
import scala.meta.internal.mtags.OnDemandSymbolIndex
import scala.meta.internal.parsing.Trees
import scala.meta.io.AbsolutePath
import scala.meta.pc.ParentSymbols
import scala.meta.pc.SymbolDocumentation
import scala.meta.pc.SymbolSearch
import scala.meta.pc.SymbolSearch.Result
import scala.meta.pc.SymbolSearchVisitor
import org.eclipse.lsp4j.Location
class StandaloneSymbolSearch(
workspace: AbsolutePath,
classpath: Seq[AbsolutePath],
sources: Seq[AbsolutePath],
buffers: Buffers,
excludedPackages: () => ExcludedPackagesHandler,
trees: Trees,
buildTargets: BuildTargets,
saveSymbolFileToDisk: Boolean,
sourceMapper: SourceMapper,
workspaceFallback: Option[SymbolSearch] = None,
)(implicit rc: ReportContext)
extends SymbolSearch {
private val dependencySourceCache =
new TrieMap[AbsolutePath, ju.List[String]]()
private val classpathSearch =
ClasspathSearch.fromClasspath(
classpath.map(_.toNIO),
excludedPackages(),
)
private val index = OnDemandSymbolIndex.empty()
sources.foreach(s =>
index.addSourceJar(s, ScalaVersions.dialectForDependencyJar(s.filename))
)
private val docs = new Docstrings(index)
private val mtags = new Mtags()
private val destinationProvider =
new DestinationProvider(
index,
buffers,
mtags,
workspace,
semanticdbsFallback = None,
trees,
buildTargets,
saveSymbolFileToDisk,
sourceMapper,
)
def documentation(
symbol: String,
parents: ParentSymbols,
): ju.Optional[SymbolDocumentation] =
docs
.documentation(symbol, parents)
.asScala
.orElse(
workspaceFallback.flatMap(_.documentation(symbol, parents).asScala)
)
.asJava
override def definition(x: String, source: URI): ju.List[Location] = {
val sourcePath = Option(source).map(AbsolutePath.fromAbsoluteUri)
destinationProvider
.fromSymbol(x, sourcePath)
.map(_.locations)
.orElse(workspaceFallback.map(_.definition(x, source)))
.getOrElse(ju.Collections.emptyList())
}
def definitionSourceToplevels(sym: String, source: URI): ju.List[String] = {
val sourcePath = Option(source).map(AbsolutePath.fromAbsoluteUri)
destinationProvider
.definition(sym, sourcePath)
.map { symDef =>
dependencySourceCache.getOrElseUpdate(
symDef.path,
mtags.topLevelSymbols(symDef.path).asJava,
)
}
.orElse(workspaceFallback.map(_.definitionSourceToplevels(sym, source)))
.getOrElse(ju.Collections.emptyList())
}
def search(
query: String,
buildTargetIdentifier: String,
visitor: SymbolSearchVisitor,
): Result = {
val (res, _) =
classpathSearch.search(WorkspaceSymbolQuery.exact(query), visitor)
workspaceFallback
.map(_.search(query, buildTargetIdentifier, visitor))
.getOrElse(res)
}
def searchMethods(
query: String,
buildTargetIdentifier: String,
visitor: SymbolSearchVisitor,
): Result = {
workspaceFallback
.map(_.searchMethods(query, buildTargetIdentifier, visitor))
.getOrElse(Result.COMPLETE)
}
}
object StandaloneSymbolSearch {
def apply(
scalaVersion: String,
workspace: AbsolutePath,
buffers: Buffers,
sources: Seq[Path],
classpath: Seq[Path],
excludedPackages: () => ExcludedPackagesHandler,
userConfig: () => UserConfiguration,
trees: Trees,
buildTargets: BuildTargets,
saveSymbolFileToDisk: Boolean,
sourceMapper: SourceMapper,
)(implicit rc: ReportContext): StandaloneSymbolSearch = {
val (sourcesWithExtras, classpathWithExtras) =
addScalaAndJava(
scalaVersion,
sources.map(AbsolutePath(_)),
classpath.map(AbsolutePath(_)),
userConfig().javaHome,
)
new StandaloneSymbolSearch(
workspace,
classpathWithExtras,
sourcesWithExtras,
buffers,
excludedPackages,
trees,
buildTargets,
saveSymbolFileToDisk,
sourceMapper,
)
}
def apply(
scalaVersion: String,
workspace: AbsolutePath,
buffers: Buffers,
excludedPackages: () => ExcludedPackagesHandler,
userConfig: () => UserConfiguration,
trees: Trees,
buildTargets: BuildTargets,
saveSymbolFileToDisk: Boolean,
sourceMapper: SourceMapper,
)(implicit rc: ReportContext): StandaloneSymbolSearch = {
val (sourcesWithExtras, classpathWithExtras) =
addScalaAndJava(scalaVersion, Nil, Nil, userConfig().javaHome)
new StandaloneSymbolSearch(
workspace,
classpathWithExtras,
sourcesWithExtras,
buffers,
excludedPackages,
trees,
buildTargets,
saveSymbolFileToDisk,
sourceMapper,
)
}
/**
* When creating the standalone check to see if the sources have Scala. If
* not, we add the sources and the classpath. We also add in the JDK sources.
*
* @param sources the original sources that may be included.
* @param classpath the current classpath.
* @param javaHome possible JavaHome to get the JDK sources from.
* @return (scalaSources, scalaClasspath)
*/
private def addScalaAndJava(
scalaVersion: String,
sources: Seq[AbsolutePath],
classpath: Seq[AbsolutePath],
javaHome: Option[String],
): (Seq[AbsolutePath], Seq[AbsolutePath]) = {
val missingScala: Boolean = {
val libraryName =
if (ScalaVersions.isScala3Version(scalaVersion))
"scala-library"
else
"scala3-library"
sources.filter(_.toString.contains(libraryName)).isEmpty
}
(missingScala, JdkSources(javaHome)) match {
case (true, Left(_)) =>
val (scalaSources, scalaClasspath) = getScala(scalaVersion)
(sources ++ scalaSources, classpath ++ scalaClasspath)
case (true, Right(absPath)) =>
val (scalaSources, scalaClasspath) = getScala(scalaVersion)
(
(scalaSources :+ absPath) ++ sources,
classpath ++ scalaClasspath,
)
case (false, Left(_)) => (sources, classpath)
case (false, Right(absPath)) =>
(sources :+ absPath, classpath)
}
}
/**
* Retrieve scala for the given version and partition sources.
* @param scalaVersion
* @return (scalaSources, scalaClasspath)
*/
private def getScala(
scalaVersion: String
): (Seq[AbsolutePath], Seq[AbsolutePath]) = {
val download =
if (ScalaVersions.isScala3Version(scalaVersion))
Embedded.downloadScala3Sources _
else
Embedded.downloadScalaSources _
download(scalaVersion).toSeq
.map(path => AbsolutePath(path))
.partition(_.isSourcesJar)
}
}