This repository was archived by the owner on Sep 9, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 162
Expand file tree
/
Copy pathassert.rs
More file actions
293 lines (274 loc) · 9.07 KB
/
assert.rs
File metadata and controls
293 lines (274 loc) · 9.07 KB
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
// -*- coding: utf-8 -*-
// ------------------------------------------------------------------------------------------------
// Copyright © 2022, stack-graphs authors.
// Licensed under either of Apache License, Version 2.0, or MIT license, at your option.
// Please see the LICENSE-APACHE or LICENSE-MIT files in this distribution for license details.
// ------------------------------------------------------------------------------------------------
//! Defines assertions that can be run against a stack graph.
use itertools::Itertools;
use lsp_positions::Position;
use crate::arena::Handle;
use crate::graph::File;
use crate::graph::Node;
use crate::graph::StackGraph;
use crate::graph::Symbol;
use crate::partial::PartialPath;
use crate::partial::PartialPaths;
use crate::stitching::Database;
use crate::stitching::ForwardPartialPathStitcher;
use crate::CancellationError;
use crate::CancellationFlag;
/// A stack graph assertion
#[derive(Debug, Clone)]
pub enum Assertion {
Defined {
source: AssertionSource,
targets: Vec<AssertionTarget>,
},
Defines {
source: AssertionSource,
symbols: Vec<Handle<Symbol>>,
},
Refers {
source: AssertionSource,
symbols: Vec<Handle<Symbol>>,
},
}
/// Source position of an assertion
#[derive(Debug, Clone)]
pub struct AssertionSource {
pub file: Handle<File>,
pub position: Position,
}
impl AssertionSource {
pub fn definitions_iter<'a>(
&'a self,
graph: &'a StackGraph,
) -> impl Iterator<Item = Handle<Node>> + 'a {
graph.nodes_for_file(self.file).filter(move |n| {
graph[*n].is_definition()
&& graph
.source_info(*n)
.map(|s| s.span.contains(&self.position))
.unwrap_or(false)
})
}
pub fn references_iter<'a>(
&'a self,
graph: &'a StackGraph,
) -> impl Iterator<Item = Handle<Node>> + 'a {
graph.nodes_for_file(self.file).filter(move |n| {
graph[*n].is_reference()
&& graph
.source_info(*n)
.map(|s| s.span.contains(&self.position))
.unwrap_or(false)
})
}
pub fn display<'a>(&'a self, graph: &'a StackGraph) -> impl std::fmt::Display + 'a {
struct Displayer<'a>(&'a AssertionSource, &'a StackGraph);
impl std::fmt::Display for Displayer<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}:{}:{}",
self.1[self.0.file],
self.0.position.line + 1,
self.0.position.column.grapheme_offset + 1
)
}
}
Displayer(self, graph)
}
}
/// Target line of an assertion
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AssertionTarget {
pub file: Handle<File>,
pub line: usize,
}
impl AssertionTarget {
/// Checks if the target matches the node corresponding to the handle in the given graph.
pub fn matches_node(&self, node: Handle<Node>, graph: &StackGraph) -> bool {
let file = graph[node].file().unwrap();
let si = graph.source_info(node).unwrap();
let start_line = si.span.start.line;
let end_line = si.span.end.line;
file == self.file && start_line <= self.line && self.line <= end_line
}
}
/// Error describing assertion failures.
#[derive(Clone)]
pub enum AssertionError {
NoReferences {
source: AssertionSource,
},
IncorrectlyDefined {
source: AssertionSource,
references: Vec<Handle<Node>>,
missing_targets: Vec<AssertionTarget>,
unexpected_paths: Vec<PartialPath>,
},
IncorrectDefinitions {
source: AssertionSource,
missing_symbols: Vec<Handle<Symbol>>,
unexpected_symbols: Vec<Handle<Symbol>>,
},
IncorrectReferences {
source: AssertionSource,
missing_symbols: Vec<Handle<Symbol>>,
unexpected_symbols: Vec<Handle<Symbol>>,
},
Cancelled(CancellationError),
}
impl From<CancellationError> for AssertionError {
fn from(value: CancellationError) -> Self {
Self::Cancelled(value)
}
}
impl Assertion {
/// Run this assertion against the given graph, using the given paths object for path search.
pub fn run(
&self,
graph: &StackGraph,
partials: &mut PartialPaths,
db: &mut Database,
cancellation_flag: &dyn CancellationFlag,
) -> Result<(), AssertionError> {
match self {
Self::Defined { source, targets } => {
self.run_defined(graph, partials, db, source, targets, cancellation_flag)
}
Self::Defines { source, symbols } => self.run_defines(graph, source, symbols),
Self::Refers { source, symbols } => self.run_refers(graph, source, symbols),
}
}
fn run_defined(
&self,
graph: &StackGraph,
partials: &mut PartialPaths,
db: &mut Database,
source: &AssertionSource,
expected_targets: &Vec<AssertionTarget>,
cancellation_flag: &dyn CancellationFlag,
) -> Result<(), AssertionError> {
let references = source.references_iter(graph).collect::<Vec<_>>();
if references.is_empty() {
return Err(AssertionError::NoReferences {
source: source.clone(),
});
}
let mut actual_paths = Vec::new();
for reference in &references {
let mut reference_paths = Vec::new();
ForwardPartialPathStitcher::find_all_complete_partial_paths(
graph,
partials,
db,
vec![*reference],
cancellation_flag,
|_, _, p| {
reference_paths.push(p.clone());
},
)?;
for reference_path in &reference_paths {
if reference_paths
.iter()
.all(|other| !other.shadows(partials, reference_path))
{
actual_paths.push(reference_path.clone());
}
}
}
let missing_targets = expected_targets
.iter()
.filter(|t| {
!actual_paths
.iter()
.any(|p| t.matches_node(p.end_node, graph))
})
.cloned()
.unique()
.collect::<Vec<_>>();
let unexpected_paths = actual_paths
.iter()
.filter(|p| {
!expected_targets
.iter()
.any(|t| t.matches_node(p.end_node, graph))
})
.cloned()
.collect::<Vec<_>>();
if !missing_targets.is_empty() || !unexpected_paths.is_empty() {
return Err(AssertionError::IncorrectlyDefined {
source: source.clone(),
references,
missing_targets,
unexpected_paths,
});
}
Ok(())
}
fn run_defines(
&self,
graph: &StackGraph,
source: &AssertionSource,
expected_symbols: &Vec<Handle<Symbol>>,
) -> Result<(), AssertionError> {
let actual_symbols = source
.definitions_iter(graph)
.filter_map(|d| graph[d].symbol())
.collect::<Vec<_>>();
let missing_symbols = expected_symbols
.iter()
.filter(|x| !actual_symbols.contains(*x))
.cloned()
.unique()
.collect::<Vec<_>>();
let unexpected_symbols = actual_symbols
.iter()
.filter(|x| !expected_symbols.contains(*x))
.cloned()
.unique()
.collect::<Vec<_>>();
if !missing_symbols.is_empty() || !unexpected_symbols.is_empty() {
return Err(AssertionError::IncorrectDefinitions {
source: source.clone(),
missing_symbols,
unexpected_symbols,
});
}
Ok(())
}
fn run_refers(
&self,
graph: &StackGraph,
source: &AssertionSource,
expected_symbols: &Vec<Handle<Symbol>>,
) -> Result<(), AssertionError> {
let actual_symbols = source
.references_iter(graph)
.filter_map(|d| graph[d].symbol())
.collect::<Vec<_>>();
let missing_symbols = expected_symbols
.iter()
.filter(|x| !actual_symbols.contains(*x))
.cloned()
.unique()
.collect::<Vec<_>>();
let unexpected_symbols = actual_symbols
.iter()
.filter(|x| !expected_symbols.contains(*x))
.cloned()
.unique()
.collect::<Vec<_>>();
if !missing_symbols.is_empty() || !unexpected_symbols.is_empty() {
return Err(AssertionError::IncorrectReferences {
source: source.clone(),
missing_symbols,
unexpected_symbols,
});
}
Ok(())
}
}