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
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
import SwiftIDEUtils
import SwiftParser
import SwiftSyntax
import XCTest
import _SwiftSyntaxTestSupport
/// Parse `source` and checks its `classifications` is the same as `expected`.
///
/// The `expected` classifications should only contain classifications that are not `none`. All uncovered ranges are expected to have no classification.
///
/// - Parameters:
/// - range: An optional parameter to specify the ``ByteSourceRange`` in `source` that we want to test the `classifications` in.
/// - expected: The element order should respect to the order of `ClassificationSpec.source` in `source`.
func assertClassification(
_ source: String,
in range: ByteSourceRange? = nil,
expected: [ClassificationSpec],
file: StaticString = #filePath,
line: UInt = #line
) {
let tree = Parser.parse(source: source)
var classifications: Array<SyntaxClassifiedRange>
if let range {
classifications = Array(tree.classifications(in: range))
} else {
classifications = Array(tree.classifications)
}
classifications = classifications.filter { $0.kind != .none }
if expected.count != classifications.count {
XCTFail("Expected \(expected.count) re-used nodes but received \(classifications.count)", file: file, line: line)
}
var lastRangeUpperBound = source.startIndex
for (classification, spec) in zip(classifications, expected) {
guard let range = byteSourceRange(for: spec.source, in: source, after: lastRangeUpperBound) else {
XCTFail("Fail to find string in original source,", file: spec.file, line: spec.line)
continue
}
XCTAssertEqual(
range,
classification.range,
"""
Expected \(range) but received \(classification.range)
""",
file: spec.file,
line: spec.line
)
XCTAssertEqual(
spec.kind,
classification.kind,
"""
Expected \(spec.kind) syntax classification kind but received \(classification.kind)
""",
file: spec.file,
line: spec.line
)
lastRangeUpperBound = source.utf8.index(source.utf8.startIndex, offsetBy: range.endOffset)
}
}
/// An abstract data structure to describe a source code snippet and its ``SyntaxClassification``.
struct ClassificationSpec {
/// Source code without any ``Trivia``
let source: String
/// The ``SyntaxClassification`` of the source code,
let kind: SyntaxClassification
/// The file and line at which this ``ClassificationSpec`` was created, so that assertion failures can be reported at its location.
let file: StaticString
let line: UInt
init(
source: String,
kind: SyntaxClassification,
file: StaticString = #filePath,
line: UInt = #line
) {
self.source = source
self.kind = kind
self.file = file
self.line = line
}
}
|
