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
//! Jumping from and to source and the rendered document.
use std::num::NonZeroUsize;
use tinymist_project::LspWorld;
use tinymist_std::typst::TypstDocument;
use tinymist_world::debug_loc::SourceSpanOffset;
use typst::{
World,
layout::{Frame, FrameItem, Point, Position, Size},
syntax::{LinkedNode, Source, Span, SyntaxKind},
visualize::Geometry,
};
use typst_shim::syntax::LinkedNodeExt;
/// Finds a span range from a clicked physical position in a rendered paged
/// document.
pub fn jump_from_click(
world: &LspWorld,
frame: &Frame,
click: Point,
) -> Option<(SourceSpanOffset, SourceSpanOffset)> {
// Try to find a link first.
for (pos, item) in frame.items() {
if let FrameItem::Link(_dest, size) = item
&& is_in_rect(*pos, *size, click)
{
// todo: url reaction
return None;
}
}
// If there's no link, search for a jump target.
for &(mut pos, ref item) in frame.items().rev() {
match item {
FrameItem::Group(group) => {
// TODO: Handle transformation.
if let Some(span) = jump_from_click(world, &group.frame, click - pos) {
return Some(span);
}
}
FrameItem::Text(text) => {
for glyph in &text.glyphs {
let width = glyph.x_advance.at(text.size);
if is_in_rect(
Point::new(pos.x, pos.y - text.size),
Size::new(width, text.size),
click,
) {
let (span, span_offset) = glyph.span;
let mut span_offset = span_offset as usize;
let Some(id) = span.id() else { continue };
let source = world.source(id).ok()?;
let node = source.find(span)?;
if matches!(node.kind(), SyntaxKind::Text | SyntaxKind::MathText)
&& (click.x - pos.x) > width / 2.0
{
span_offset += glyph.range().len();
}
let span_offset = SourceSpanOffset {
span,
offset: span_offset,
};
return Some((span_offset, span_offset));
}
pos.x += width;
}
}
FrameItem::Shape(shape, span) => {
let Geometry::Rect(size) = shape.geometry else {
continue;
};
if is_in_rect(pos, size, click) {
let span = (*span).into();
return Some((span, span));
}
}
FrameItem::Image(_, size, span) if is_in_rect(pos, *size, click) => {
let span = (*span).into();
return Some((span, span));
}
_ => {}
}
}
None
}
/// Finds the output location in the document for a cursor position.
pub fn jump_from_cursor(document: &TypstDocument, source: &Source, cursor: usize) -> Vec<Position> {
jump_from_cursor_(document, source, cursor).unwrap_or_default()
}
/// Finds the output location in the document for a cursor position.
fn jump_from_cursor_(
document: &TypstDocument,
source: &Source,
cursor: usize,
) -> Option<Vec<Position>> {
// todo: leaf_at_compat only matches the text before the cursor, but we could
// also match a text if it is after the cursor
// The case `leaf_at_compat` will match: `Hello|`
// FIXME: The case `leaf_at_compat` will not match: `|Hello`
let node = LinkedNode::new(source.root()).leaf_at_compat(cursor)?;
// todo: When we click on a label or some math operators, we seems likely also
// be able to jump to some place.
if !matches!(node.kind(), SyntaxKind::Text | SyntaxKind::MathText) {
return None;
};
let span = node.span();
let offset = cursor.saturating_sub(node.offset());
// todo: The cursor may not exact hit at the start of some AST node. For
// example, the cursor in the text element `Hell|o` is offset by 4 from the
// node. It seems not pretty if we ignore the offset completely.
let _ = offset;
match document {
TypstDocument::Paged(paged_doc) => {
// We checks whether there are any elements exactly matching the
// cursor position.
let mut positions = vec![];
// Unluckily, we might not be able to find the exact spans, so we
// need to find the closest one at the same time.
let mut min_page = 0;
let mut min_point = Point::default();
let mut min_dis = u64::MAX;
for (idx, page) in paged_doc.pages.iter().enumerate() {
// In a page, we try to find a closer span than the existing found one.
let mut p_dis = min_dis;
if let Some(point) = find_in_frame(&page.frame, span, &mut p_dis, &mut min_point)
&& let Some(page) = NonZeroUsize::new(idx + 1)
{
positions.push(Position { page, point });
}
// In this page, we found a closer span and update.
if p_dis != min_dis {
min_page = idx;
min_dis = p_dis;
}
}
// If we didn't find any exact span, we add the closest one in the same page.
if positions.is_empty() && min_dis != u64::MAX {
positions.push(Position {
page: NonZeroUsize::new(min_page + 1)?,
point: min_point,
});
}
Some(positions)
}
_ => None,
}
}
/// Finds the position of a span in a frame.
fn find_in_frame(frame: &Frame, span: Span, min_dis: &mut u64, res: &mut Point) -> Option<Point> {
for &(mut pos, ref item) in frame.items() {
if let FrameItem::Group(group) = item {
// TODO: Handle transformation.
if let Some(point) = find_in_frame(&group.frame, span, min_dis, res) {
return Some(point + pos);
}
}
if let FrameItem::Text(text) = item {
for glyph in &text.glyphs {
if glyph.span.0 == span {
return Some(pos);
}
// We at least require that the span is in the same file.
let is_same_file = glyph.span.0.id() == span.id();
if is_same_file {
// The numbers are not offsets but a unique id on the AST tree which are
// nicely divided.
// FIXME: since typst v0.13.0, the numbers are not only the ids, but also raw
// ranges, See [`Span::range`].
let glyph_num = glyph.span.0.into_raw();
let span_num = span.into_raw().get();
let dis = glyph_num.get().abs_diff(span_num);
if dis < *min_dis {
*min_dis = dis;
*res = pos;
}
}
pos.x += glyph.x_advance.at(text.size);
}
}
}
None
}
/// Whether a rectangle with the given size at the given position contains the
/// click position.
fn is_in_rect(pos: Point, size: Size, click: Point) -> bool {
pos.x <= click.x && pos.x + size.x >= click.x && pos.y <= click.y && pos.y + size.y >= click.y
}
#[cfg(test)]
mod tests {
use itertools::Itertools;
use super::*;
use crate::tests::*;
#[test]
fn test() {
snapshot_testing("jump_from_cursor", &|ctx, path| {
let source = ctx.source_by_path(&path).unwrap();
let document = ctx.success_doc().unwrap();
let cursors = find_test_range_(&source);
let results = cursors
.map(|cursor| {
let points = jump_from_cursor(document, &source, cursor);
if points.is_empty() {
return "nothing".to_string();
}
points
.iter()
.map(|pos| {
let page = pos.page.get();
let point = pos.point;
format!("{page},{:.3}pt,{:.3}pt", point.x.to_pt(), point.y.to_pt())
})
.join(";")
})
.join("\n");
with_settings!({
description => format!("Jump cursor on {})", make_range_annotation(&source)),
}, {
assert_snapshot!(results);
})
});
}
}