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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 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 LanguageServerProtocol
import SwiftSyntax
/// Scans a source file for classes or structs annotated with `@main` and returns a code lens for them.
final class SwiftCodeLensScanner: SyntaxVisitor {
/// The document snapshot of the syntax tree that is being walked.
private let snapshot: DocumentSnapshot
/// The collection of CodeLenses found in the document.
private var result: [CodeLens] = []
private let targetName: String?
/// The map of supported commands and their client side command names
private let supportedCommands: [SupportedCodeLensCommand: String]
private init(
snapshot: DocumentSnapshot,
targetName: String?,
supportedCommands: [SupportedCodeLensCommand: String]
) {
self.snapshot = snapshot
self.targetName = targetName
self.supportedCommands = supportedCommands
super.init(viewMode: .fixedUp)
}
/// Public entry point. Scans the syntax tree of the given snapshot for an `@main` annotation
/// and returns CodeLens's with Commands to run/debug the application.
public static func findCodeLenses(
in snapshot: DocumentSnapshot,
syntaxTreeManager: SyntaxTreeManager,
targetName: String? = nil,
supportedCommands: [SupportedCodeLensCommand: String]
) async -> [CodeLens] {
guard snapshot.text.contains("@main") && !supportedCommands.isEmpty else {
// This is intended to filter out files that obviously do not contain an entry point.
return []
}
let syntaxTree = await syntaxTreeManager.syntaxTree(for: snapshot)
let visitor = SwiftCodeLensScanner(snapshot: snapshot, targetName: targetName, supportedCommands: supportedCommands)
visitor.walk(syntaxTree)
return visitor.result
}
override func visit(_ node: ClassDeclSyntax) -> SyntaxVisitorContinueKind {
node.attributes.forEach(self.captureLensFromAttribute)
return .skipChildren
}
override func visit(_ node: StructDeclSyntax) -> SyntaxVisitorContinueKind {
node.attributes.forEach(self.captureLensFromAttribute)
return .skipChildren
}
private func captureLensFromAttribute(attribute: AttributeListSyntax.Element) {
if attribute.trimmedDescription == "@main" {
let range = self.snapshot.absolutePositionRange(of: attribute.trimmedRange)
var targetNameToAppend: String = ""
var arguments: [LSPAny] = []
if let targetName {
targetNameToAppend = " \(targetName)"
arguments.append(.string(targetName))
}
if let runCommand = supportedCommands[SupportedCodeLensCommand.run] {
// Return commands for running/debugging the executable.
// These command names must be recognized by the client and so should not be chosen arbitrarily.
self.result.append(
CodeLens(
range: range,
command: Command(title: "Run" + targetNameToAppend, command: runCommand, arguments: arguments)
)
)
}
if let debugCommand = supportedCommands[SupportedCodeLensCommand.debug] {
self.result.append(
CodeLens(
range: range,
command: Command(title: "Debug" + targetNameToAppend, command: debugCommand, arguments: arguments)
)
)
}
}
}
}
|
