1use editor::{scroll::Autoscroll, Anchor, Editor, ExcerptId};
2use gpui::{
3 actions, div, rems, uniform_list, AppContext, Div, EventEmitter, FocusHandle, FocusableView,
4 Hsla, InteractiveElement, IntoElement, Model, MouseButton, MouseDownEvent, MouseMoveEvent,
5 ParentElement, Render, SharedString, Styled, UniformListScrollHandle, View, ViewContext,
6 VisualContext, WeakView, WindowContext,
7};
8use language::{Buffer, OwnedSyntaxLayer};
9use std::{mem, ops::Range};
10use theme::ActiveTheme;
11use tree_sitter::{Node, TreeCursor};
12use ui::{h_flex, ButtonLike, Color, ContextMenu, Label, LabelCommon, PopoverMenu};
13use workspace::{
14 item::{Item, ItemHandle},
15 SplitDirection, ToolbarItemEvent, ToolbarItemLocation, ToolbarItemView, Workspace,
16};
17
18actions!(debug, [OpenSyntaxTreeView]);
19
20pub fn init(cx: &mut AppContext) {
21 cx.observe_new_views(|workspace: &mut Workspace, _| {
22 workspace.register_action(|workspace, _: &OpenSyntaxTreeView, cx| {
23 let active_item = workspace.active_item(cx);
24 let workspace_handle = workspace.weak_handle();
25 let syntax_tree_view =
26 cx.new_view(|cx| SyntaxTreeView::new(workspace_handle, active_item, cx));
27 workspace.split_item(SplitDirection::Right, Box::new(syntax_tree_view), cx)
28 });
29 })
30 .detach();
31}
32
33pub struct SyntaxTreeView {
34 workspace_handle: WeakView<Workspace>,
35 editor: Option<EditorState>,
36 list_scroll_handle: UniformListScrollHandle,
37 selected_descendant_ix: Option<usize>,
38 hovered_descendant_ix: Option<usize>,
39 focus_handle: FocusHandle,
40}
41
42pub struct SyntaxTreeToolbarItemView {
43 tree_view: Option<View<SyntaxTreeView>>,
44 subscription: Option<gpui::Subscription>,
45}
46
47struct EditorState {
48 editor: View<Editor>,
49 active_buffer: Option<BufferState>,
50 _subscription: gpui::Subscription,
51}
52
53#[derive(Clone)]
54struct BufferState {
55 buffer: Model<Buffer>,
56 excerpt_id: ExcerptId,
57 active_layer: Option<OwnedSyntaxLayer>,
58}
59
60impl SyntaxTreeView {
61 pub fn new(
62 workspace_handle: WeakView<Workspace>,
63 active_item: Option<Box<dyn ItemHandle>>,
64 cx: &mut ViewContext<Self>,
65 ) -> Self {
66 let mut this = Self {
67 workspace_handle: workspace_handle.clone(),
68 list_scroll_handle: UniformListScrollHandle::new(),
69 editor: None,
70 hovered_descendant_ix: None,
71 selected_descendant_ix: None,
72 focus_handle: cx.focus_handle(),
73 };
74
75 this.workspace_updated(active_item, cx);
76 cx.observe(
77 &workspace_handle.upgrade().unwrap(),
78 |this, workspace, cx| {
79 this.workspace_updated(workspace.read(cx).active_item(cx), cx);
80 },
81 )
82 .detach();
83
84 this
85 }
86
87 fn workspace_updated(
88 &mut self,
89 active_item: Option<Box<dyn ItemHandle>>,
90 cx: &mut ViewContext<Self>,
91 ) {
92 if let Some(item) = active_item {
93 if item.item_id() != cx.entity_id() {
94 if let Some(editor) = item.act_as::<Editor>(cx) {
95 self.set_editor(editor, cx);
96 }
97 }
98 }
99 }
100
101 fn set_editor(&mut self, editor: View<Editor>, cx: &mut ViewContext<Self>) {
102 if let Some(state) = &self.editor {
103 if state.editor == editor {
104 return;
105 }
106 editor.update(cx, |editor, cx| {
107 editor.clear_background_highlights::<Self>(cx)
108 });
109 }
110
111 let subscription = cx.subscribe(&editor, |this, _, event, cx| {
112 let did_reparse = match event {
113 editor::EditorEvent::Reparsed(_) => true,
114 editor::EditorEvent::SelectionsChanged { .. } => false,
115 _ => return,
116 };
117 this.editor_updated(did_reparse, cx);
118 });
119
120 self.editor = Some(EditorState {
121 editor,
122 _subscription: subscription,
123 active_buffer: None,
124 });
125 self.editor_updated(true, cx);
126 }
127
128 fn editor_updated(&mut self, did_reparse: bool, cx: &mut ViewContext<Self>) -> Option<()> {
129 // Find which excerpt the cursor is in, and the position within that excerpted buffer.
130 let editor_state = self.editor.as_mut()?;
131 let editor = &editor_state.editor.read(cx);
132 let selection_range = editor.selections.last::<usize>(cx).range();
133 let multibuffer = editor.buffer().read(cx);
134 let (buffer, range, excerpt_id) = multibuffer
135 .range_to_buffer_ranges(selection_range, cx)
136 .pop()?;
137
138 // If the cursor has moved into a different excerpt, retrieve a new syntax layer
139 // from that buffer.
140 let buffer_state = editor_state
141 .active_buffer
142 .get_or_insert_with(|| BufferState {
143 buffer: buffer.clone(),
144 excerpt_id,
145 active_layer: None,
146 });
147 let mut prev_layer = None;
148 if did_reparse {
149 prev_layer = buffer_state.active_layer.take();
150 }
151 if buffer_state.buffer != buffer || buffer_state.excerpt_id != excerpt_id {
152 buffer_state.buffer = buffer.clone();
153 buffer_state.excerpt_id = excerpt_id;
154 buffer_state.active_layer = None;
155 }
156
157 let layer = match &mut buffer_state.active_layer {
158 Some(layer) => layer,
159 None => {
160 let snapshot = buffer.read(cx).snapshot();
161 let layer = if let Some(prev_layer) = prev_layer {
162 let prev_range = prev_layer.node().byte_range();
163 snapshot
164 .syntax_layers()
165 .filter(|layer| layer.language == &prev_layer.language)
166 .min_by_key(|layer| {
167 let range = layer.node().byte_range();
168 ((range.start as i64) - (prev_range.start as i64)).abs()
169 + ((range.end as i64) - (prev_range.end as i64)).abs()
170 })?
171 } else {
172 snapshot.syntax_layers().next()?
173 };
174 buffer_state.active_layer.insert(layer.to_owned())
175 }
176 };
177
178 // Within the active layer, find the syntax node under the cursor,
179 // and scroll to it.
180 let mut cursor = layer.node().walk();
181 while cursor.goto_first_child_for_byte(range.start).is_some() {
182 if !range.is_empty() && cursor.node().end_byte() == range.start {
183 cursor.goto_next_sibling();
184 }
185 }
186
187 // Ascend to the smallest ancestor that contains the range.
188 loop {
189 let node_range = cursor.node().byte_range();
190 if node_range.start <= range.start && node_range.end >= range.end {
191 break;
192 }
193 if !cursor.goto_parent() {
194 break;
195 }
196 }
197
198 let descendant_ix = cursor.descendant_index();
199 self.selected_descendant_ix = Some(descendant_ix);
200 self.list_scroll_handle.scroll_to_item(descendant_ix);
201
202 cx.notify();
203 Some(())
204 }
205
206 fn update_editor_with_range_for_descendant_ix(
207 &self,
208 descendant_ix: usize,
209 cx: &mut ViewContext<Self>,
210 mut f: impl FnMut(&mut Editor, Range<Anchor>, &mut ViewContext<Editor>),
211 ) -> Option<()> {
212 let editor_state = self.editor.as_ref()?;
213 let buffer_state = editor_state.active_buffer.as_ref()?;
214 let layer = buffer_state.active_layer.as_ref()?;
215
216 // Find the node.
217 let mut cursor = layer.node().walk();
218 cursor.goto_descendant(descendant_ix);
219 let node = cursor.node();
220 let range = node.byte_range();
221
222 // Build a text anchor range.
223 let buffer = buffer_state.buffer.read(cx);
224 let range = buffer.anchor_before(range.start)..buffer.anchor_after(range.end);
225
226 // Build a multibuffer anchor range.
227 let multibuffer = editor_state.editor.read(cx).buffer();
228 let multibuffer = multibuffer.read(cx).snapshot(cx);
229 let excerpt_id = buffer_state.excerpt_id;
230 let range = multibuffer
231 .anchor_in_excerpt(excerpt_id, range.start)
232 .unwrap()
233 ..multibuffer
234 .anchor_in_excerpt(excerpt_id, range.end)
235 .unwrap();
236
237 // Update the editor with the anchor range.
238 editor_state.editor.update(cx, |editor, cx| {
239 f(editor, range, cx);
240 });
241 Some(())
242 }
243
244 fn render_node(cursor: &TreeCursor, depth: u32, selected: bool, cx: &AppContext) -> Div {
245 let colors = cx.theme().colors();
246 let mut row = h_flex();
247 if let Some(field_name) = cursor.field_name() {
248 row = row.children([Label::new(field_name).color(Color::Info), Label::new(": ")]);
249 }
250
251 let node = cursor.node();
252 return row
253 .child(if node.is_named() {
254 Label::new(node.kind()).color(Color::Default)
255 } else {
256 Label::new(format!("\"{}\"", node.kind())).color(Color::Created)
257 })
258 .child(
259 div()
260 .child(Label::new(format_node_range(node)).color(Color::Muted))
261 .pl_1(),
262 )
263 .text_bg(if selected {
264 colors.element_selected
265 } else {
266 Hsla::default()
267 })
268 .pl(rems(depth as f32))
269 .hover(|style| style.bg(colors.element_hover));
270 }
271}
272
273impl Render for SyntaxTreeView {
274 fn render(&mut self, cx: &mut gpui::ViewContext<'_, Self>) -> impl IntoElement {
275 let mut rendered = div().flex_1();
276
277 if let Some(layer) = self
278 .editor
279 .as_ref()
280 .and_then(|editor| editor.active_buffer.as_ref())
281 .and_then(|buffer| buffer.active_layer.as_ref())
282 {
283 let layer = layer.clone();
284 rendered = rendered.child(uniform_list(
285 cx.view().clone(),
286 "SyntaxTreeView",
287 layer.node().descendant_count(),
288 move |this, range, cx| {
289 let mut items = Vec::new();
290 let mut cursor = layer.node().walk();
291 let mut descendant_ix = range.start;
292 cursor.goto_descendant(descendant_ix);
293 let mut depth = cursor.depth();
294 let mut visited_children = false;
295 while descendant_ix < range.end {
296 if visited_children {
297 if cursor.goto_next_sibling() {
298 visited_children = false;
299 } else if cursor.goto_parent() {
300 depth -= 1;
301 } else {
302 break;
303 }
304 } else {
305 items.push(
306 Self::render_node(
307 &cursor,
308 depth,
309 Some(descendant_ix) == this.selected_descendant_ix,
310 cx,
311 )
312 .on_mouse_down(
313 MouseButton::Left,
314 cx.listener(move |tree_view, _: &MouseDownEvent, cx| {
315 tree_view.update_editor_with_range_for_descendant_ix(
316 descendant_ix,
317 cx,
318 |editor, mut range, cx| {
319 // Put the cursor at the beginning of the node.
320 mem::swap(&mut range.start, &mut range.end);
321
322 editor.change_selections(
323 Some(Autoscroll::newest()),
324 cx,
325 |selections| {
326 selections.select_ranges(vec![range]);
327 },
328 );
329 },
330 );
331 }),
332 )
333 .on_mouse_move(cx.listener(
334 move |tree_view, _: &MouseMoveEvent, cx| {
335 if tree_view.hovered_descendant_ix != Some(descendant_ix) {
336 tree_view.hovered_descendant_ix = Some(descendant_ix);
337 tree_view.update_editor_with_range_for_descendant_ix(descendant_ix, cx, |editor, range, cx| {
338 editor.clear_background_highlights::<Self>(cx);
339 editor.highlight_background::<Self>(
340 &[range],
341 |theme| theme.editor_document_highlight_write_background,
342 cx,
343 );
344 });
345 cx.notify();
346 }
347 },
348 )),
349 );
350 descendant_ix += 1;
351 if cursor.goto_first_child() {
352 depth += 1;
353 } else {
354 visited_children = true;
355 }
356 }
357 }
358 items
359 },
360 )
361 .size_full()
362 .track_scroll(self.list_scroll_handle.clone())
363 .text_bg(cx.theme().colors().background).into_any_element());
364 }
365
366 rendered
367 }
368}
369
370impl EventEmitter<()> for SyntaxTreeView {}
371
372impl FocusableView for SyntaxTreeView {
373 fn focus_handle(&self, _: &AppContext) -> gpui::FocusHandle {
374 self.focus_handle.clone()
375 }
376}
377
378impl Item for SyntaxTreeView {
379 type Event = ();
380
381 fn to_item_events(_: &Self::Event, _: impl FnMut(workspace::item::ItemEvent)) {}
382
383 fn tab_content_text(&self, _cx: &WindowContext) -> Option<SharedString> {
384 Some("Syntax Tree".into())
385 }
386
387 fn telemetry_event_text(&self) -> Option<&'static str> {
388 None
389 }
390
391 fn clone_on_split(
392 &self,
393 _: Option<workspace::WorkspaceId>,
394 cx: &mut ViewContext<Self>,
395 ) -> Option<View<Self>>
396 where
397 Self: Sized,
398 {
399 Some(cx.new_view(|cx| {
400 let mut clone = Self::new(self.workspace_handle.clone(), None, cx);
401 if let Some(editor) = &self.editor {
402 clone.set_editor(editor.editor.clone(), cx)
403 }
404 clone
405 }))
406 }
407}
408
409impl SyntaxTreeToolbarItemView {
410 pub fn new() -> Self {
411 Self {
412 tree_view: None,
413 subscription: None,
414 }
415 }
416
417 fn render_menu(&mut self, cx: &mut ViewContext<'_, Self>) -> Option<PopoverMenu<ContextMenu>> {
418 let tree_view = self.tree_view.as_ref()?;
419 let tree_view = tree_view.read(cx);
420
421 let editor_state = tree_view.editor.as_ref()?;
422 let buffer_state = editor_state.active_buffer.as_ref()?;
423 let active_layer = buffer_state.active_layer.clone()?;
424 let active_buffer = buffer_state.buffer.read(cx).snapshot();
425
426 let view = cx.view().clone();
427 Some(
428 PopoverMenu::new("Syntax Tree")
429 .trigger(Self::render_header(&active_layer))
430 .menu(move |cx| {
431 ContextMenu::build(cx, |mut menu, cx| {
432 for (layer_ix, layer) in active_buffer.syntax_layers().enumerate() {
433 menu = menu.entry(
434 format!(
435 "{} {}",
436 layer.language.name(),
437 format_node_range(layer.node())
438 ),
439 None,
440 cx.handler_for(&view, move |view, cx| {
441 view.select_layer(layer_ix, cx);
442 }),
443 );
444 }
445 menu
446 })
447 .into()
448 }),
449 )
450 }
451
452 fn select_layer(&mut self, layer_ix: usize, cx: &mut ViewContext<Self>) -> Option<()> {
453 let tree_view = self.tree_view.as_ref()?;
454 tree_view.update(cx, |view, cx| {
455 let editor_state = view.editor.as_mut()?;
456 let buffer_state = editor_state.active_buffer.as_mut()?;
457 let snapshot = buffer_state.buffer.read(cx).snapshot();
458 let layer = snapshot.syntax_layers().nth(layer_ix)?;
459 buffer_state.active_layer = Some(layer.to_owned());
460 view.selected_descendant_ix = None;
461 cx.notify();
462 view.focus_handle.focus(cx);
463 Some(())
464 })
465 }
466
467 fn render_header(active_layer: &OwnedSyntaxLayer) -> ButtonLike {
468 ButtonLike::new("syntax tree header")
469 .child(Label::new(active_layer.language.name()))
470 .child(Label::new(format_node_range(active_layer.node())))
471 }
472}
473
474fn format_node_range(node: Node) -> String {
475 let start = node.start_position();
476 let end = node.end_position();
477 format!(
478 "[{}:{} - {}:{}]",
479 start.row + 1,
480 start.column + 1,
481 end.row + 1,
482 end.column + 1,
483 )
484}
485
486impl Render for SyntaxTreeToolbarItemView {
487 fn render(&mut self, cx: &mut ViewContext<'_, Self>) -> impl IntoElement {
488 self.render_menu(cx)
489 .unwrap_or_else(|| PopoverMenu::new("Empty Syntax Tree"))
490 }
491}
492
493impl EventEmitter<ToolbarItemEvent> for SyntaxTreeToolbarItemView {}
494
495impl ToolbarItemView for SyntaxTreeToolbarItemView {
496 fn set_active_pane_item(
497 &mut self,
498 active_pane_item: Option<&dyn ItemHandle>,
499 cx: &mut ViewContext<Self>,
500 ) -> ToolbarItemLocation {
501 if let Some(item) = active_pane_item {
502 if let Some(view) = item.downcast::<SyntaxTreeView>() {
503 self.tree_view = Some(view.clone());
504 self.subscription = Some(cx.observe(&view, |_, _, cx| cx.notify()));
505 return ToolbarItemLocation::PrimaryLeft;
506 }
507 }
508 self.tree_view = None;
509 self.subscription = None;
510 ToolbarItemLocation::Hidden
511 }
512}