1use super::{
2 display_map::{BlockContext, ToDisplayPoint},
3 Anchor, DisplayPoint, Editor, EditorMode, EditorSnapshot, SelectPhase, SoftWrap, ToPoint,
4 MAX_LINE_LEN,
5};
6use crate::{
7 display_map::{BlockStyle, DisplaySnapshot, FoldStatus, TransformBlock},
8 editor_settings::ShowScrollbar,
9 git::{diff_hunk_to_display, DisplayDiffHunk},
10 hover_popover::{
11 hide_hover, hover_at, HOVER_POPOVER_GAP, MIN_POPOVER_CHARACTER_WIDTH,
12 MIN_POPOVER_LINE_HEIGHT,
13 },
14 link_go_to_definition::{
15 go_to_fetched_definition, go_to_fetched_type_definition, update_go_to_definition_link,
16 },
17 mouse_context_menu, EditorSettings, EditorStyle, GutterHover, UnfoldAt,
18};
19use clock::ReplicaId;
20use collections::{BTreeMap, HashMap};
21use git::diff::DiffHunkStatus;
22use gpui::{
23 color::Color,
24 elements::*,
25 fonts::{HighlightStyle, TextStyle, Underline},
26 geometry::{
27 rect::RectF,
28 vector::{vec2f, Vector2F},
29 PathBuilder,
30 },
31 json::{self, ToJson},
32 platform::{CursorStyle, Modifiers, MouseButton, MouseButtonEvent, MouseMovedEvent},
33 text_layout::{self, Line, RunStyle, TextLayoutCache},
34 AnyElement, Axis, Border, CursorRegion, Element, EventContext, FontCache, LayoutContext,
35 MouseRegion, Quad, SceneBuilder, SizeConstraint, ViewContext, WindowContext,
36};
37use itertools::Itertools;
38use json::json;
39use language::{
40 language_settings::ShowWhitespaceSetting, Bias, CursorShape, DiagnosticSeverity, OffsetUtf16,
41 Selection,
42};
43use project::{
44 project_settings::{GitGutterSetting, ProjectSettings},
45 ProjectPath,
46};
47use smallvec::SmallVec;
48use std::{
49 borrow::Cow,
50 cmp::{self, Ordering},
51 fmt::Write,
52 iter,
53 ops::Range,
54 sync::Arc,
55};
56use text::Point;
57use workspace::item::Item;
58
59enum FoldMarkers {}
60
61struct SelectionLayout {
62 head: DisplayPoint,
63 cursor_shape: CursorShape,
64 range: Range<DisplayPoint>,
65}
66
67impl SelectionLayout {
68 fn new<T: ToPoint + ToDisplayPoint + Clone>(
69 selection: Selection<T>,
70 line_mode: bool,
71 cursor_shape: CursorShape,
72 map: &DisplaySnapshot,
73 ) -> Self {
74 if line_mode {
75 let selection = selection.map(|p| p.to_point(&map.buffer_snapshot));
76 let point_range = map.expand_to_line(selection.range());
77 Self {
78 head: selection.head().to_display_point(map),
79 cursor_shape,
80 range: point_range.start.to_display_point(map)
81 ..point_range.end.to_display_point(map),
82 }
83 } else {
84 let selection = selection.map(|p| p.to_display_point(map));
85 Self {
86 head: selection.head(),
87 cursor_shape,
88 range: selection.range(),
89 }
90 }
91 }
92}
93
94pub struct EditorElement {
95 style: Arc<EditorStyle>,
96}
97
98impl EditorElement {
99 pub fn new(style: EditorStyle) -> Self {
100 Self {
101 style: Arc::new(style),
102 }
103 }
104
105 fn attach_mouse_handlers(
106 scene: &mut SceneBuilder,
107 position_map: &Arc<PositionMap>,
108 has_popovers: bool,
109 visible_bounds: RectF,
110 text_bounds: RectF,
111 gutter_bounds: RectF,
112 bounds: RectF,
113 cx: &mut ViewContext<Editor>,
114 ) {
115 enum EditorElementMouseHandlers {}
116 scene.push_mouse_region(
117 MouseRegion::new::<EditorElementMouseHandlers>(
118 cx.view_id(),
119 cx.view_id(),
120 visible_bounds,
121 )
122 .on_down(MouseButton::Left, {
123 let position_map = position_map.clone();
124 move |event, editor, cx| {
125 if !Self::mouse_down(
126 editor,
127 event.platform_event,
128 position_map.as_ref(),
129 text_bounds,
130 gutter_bounds,
131 cx,
132 ) {
133 cx.propagate_event();
134 }
135 }
136 })
137 .on_down(MouseButton::Right, {
138 let position_map = position_map.clone();
139 move |event, editor, cx| {
140 if !Self::mouse_right_down(
141 editor,
142 event.position,
143 position_map.as_ref(),
144 text_bounds,
145 cx,
146 ) {
147 cx.propagate_event();
148 }
149 }
150 })
151 .on_up(MouseButton::Left, {
152 let position_map = position_map.clone();
153 move |event, editor, cx| {
154 if !Self::mouse_up(
155 editor,
156 event.position,
157 event.cmd,
158 event.shift,
159 position_map.as_ref(),
160 text_bounds,
161 cx,
162 ) {
163 cx.propagate_event()
164 }
165 }
166 })
167 .on_drag(MouseButton::Left, {
168 let position_map = position_map.clone();
169 move |event, editor, cx| {
170 if !Self::mouse_dragged(
171 editor,
172 event.platform_event,
173 position_map.as_ref(),
174 text_bounds,
175 cx,
176 ) {
177 cx.propagate_event()
178 }
179 }
180 })
181 .on_move({
182 let position_map = position_map.clone();
183 move |event, editor, cx| {
184 if !Self::mouse_moved(
185 editor,
186 event.platform_event,
187 &position_map,
188 text_bounds,
189 cx,
190 ) {
191 cx.propagate_event()
192 }
193 }
194 })
195 .on_move_out(move |_, editor: &mut Editor, cx| {
196 if has_popovers {
197 hide_hover(editor, cx);
198 }
199 })
200 .on_scroll({
201 let position_map = position_map.clone();
202 move |event, editor, cx| {
203 if !Self::scroll(
204 editor,
205 event.position,
206 *event.delta.raw(),
207 event.delta.precise(),
208 &position_map,
209 bounds,
210 cx,
211 ) {
212 cx.propagate_event()
213 }
214 }
215 }),
216 );
217
218 enum GutterHandlers {}
219 scene.push_mouse_region(
220 MouseRegion::new::<GutterHandlers>(cx.view_id(), cx.view_id() + 1, gutter_bounds)
221 .on_hover(|hover, editor: &mut Editor, cx| {
222 editor.gutter_hover(
223 &GutterHover {
224 hovered: hover.started,
225 },
226 cx,
227 );
228 }),
229 )
230 }
231
232 fn mouse_down(
233 editor: &mut Editor,
234 MouseButtonEvent {
235 position,
236 modifiers:
237 Modifiers {
238 shift,
239 ctrl,
240 alt,
241 cmd,
242 ..
243 },
244 mut click_count,
245 ..
246 }: MouseButtonEvent,
247 position_map: &PositionMap,
248 text_bounds: RectF,
249 gutter_bounds: RectF,
250 cx: &mut EventContext<Editor>,
251 ) -> bool {
252 if gutter_bounds.contains_point(position) {
253 click_count = 3; // Simulate triple-click when clicking the gutter to select lines
254 } else if !text_bounds.contains_point(position) {
255 return false;
256 }
257
258 let (position, target_position) = position_map.point_for_position(text_bounds, position);
259
260 if shift && alt {
261 editor.select(
262 SelectPhase::BeginColumnar {
263 position,
264 goal_column: target_position.column(),
265 },
266 cx,
267 );
268 } else if shift && !ctrl && !alt && !cmd {
269 editor.select(
270 SelectPhase::Extend {
271 position,
272 click_count,
273 },
274 cx,
275 );
276 } else {
277 editor.select(
278 SelectPhase::Begin {
279 position,
280 add: alt,
281 click_count,
282 },
283 cx,
284 );
285 }
286
287 true
288 }
289
290 fn mouse_right_down(
291 editor: &mut Editor,
292 position: Vector2F,
293 position_map: &PositionMap,
294 text_bounds: RectF,
295 cx: &mut EventContext<Editor>,
296 ) -> bool {
297 if !text_bounds.contains_point(position) {
298 return false;
299 }
300
301 let (point, _) = position_map.point_for_position(text_bounds, position);
302 mouse_context_menu::deploy_context_menu(editor, position, point, cx);
303 true
304 }
305
306 fn mouse_up(
307 editor: &mut Editor,
308 position: Vector2F,
309 cmd: bool,
310 shift: bool,
311 position_map: &PositionMap,
312 text_bounds: RectF,
313 cx: &mut EventContext<Editor>,
314 ) -> bool {
315 let end_selection = editor.has_pending_selection();
316 let pending_nonempty_selections = editor.has_pending_nonempty_selection();
317
318 if end_selection {
319 editor.select(SelectPhase::End, cx);
320 }
321
322 if !pending_nonempty_selections && cmd && text_bounds.contains_point(position) {
323 let (point, target_point) = position_map.point_for_position(text_bounds, position);
324
325 if point == target_point {
326 if shift {
327 go_to_fetched_type_definition(editor, point, cx);
328 } else {
329 go_to_fetched_definition(editor, point, cx);
330 }
331
332 return true;
333 }
334 }
335
336 end_selection
337 }
338
339 fn mouse_dragged(
340 editor: &mut Editor,
341 MouseMovedEvent {
342 modifiers: Modifiers { cmd, shift, .. },
343 position,
344 ..
345 }: MouseMovedEvent,
346 position_map: &PositionMap,
347 text_bounds: RectF,
348 cx: &mut EventContext<Editor>,
349 ) -> bool {
350 // This will be handled more correctly once https://github.com/zed-industries/zed/issues/1218 is completed
351 // Don't trigger hover popover if mouse is hovering over context menu
352 let point = if text_bounds.contains_point(position) {
353 let (point, target_point) = position_map.point_for_position(text_bounds, position);
354 if point == target_point {
355 Some(point)
356 } else {
357 None
358 }
359 } else {
360 None
361 };
362
363 update_go_to_definition_link(editor, point, cmd, shift, cx);
364
365 if editor.has_pending_selection() {
366 let mut scroll_delta = Vector2F::zero();
367
368 let vertical_margin = position_map.line_height.min(text_bounds.height() / 3.0);
369 let top = text_bounds.origin_y() + vertical_margin;
370 let bottom = text_bounds.lower_left().y() - vertical_margin;
371 if position.y() < top {
372 scroll_delta.set_y(-scale_vertical_mouse_autoscroll_delta(top - position.y()))
373 }
374 if position.y() > bottom {
375 scroll_delta.set_y(scale_vertical_mouse_autoscroll_delta(position.y() - bottom))
376 }
377
378 let horizontal_margin = position_map.line_height.min(text_bounds.width() / 3.0);
379 let left = text_bounds.origin_x() + horizontal_margin;
380 let right = text_bounds.upper_right().x() - horizontal_margin;
381 if position.x() < left {
382 scroll_delta.set_x(-scale_horizontal_mouse_autoscroll_delta(
383 left - position.x(),
384 ))
385 }
386 if position.x() > right {
387 scroll_delta.set_x(scale_horizontal_mouse_autoscroll_delta(
388 position.x() - right,
389 ))
390 }
391
392 let (position, target_position) =
393 position_map.point_for_position(text_bounds, position);
394
395 editor.select(
396 SelectPhase::Update {
397 position,
398 goal_column: target_position.column(),
399 scroll_position: (position_map.snapshot.scroll_position() + scroll_delta)
400 .clamp(Vector2F::zero(), position_map.scroll_max),
401 },
402 cx,
403 );
404 hover_at(editor, point, cx);
405 true
406 } else {
407 hover_at(editor, point, cx);
408 false
409 }
410 }
411
412 fn mouse_moved(
413 editor: &mut Editor,
414 MouseMovedEvent {
415 modifiers: Modifiers { shift, cmd, .. },
416 position,
417 ..
418 }: MouseMovedEvent,
419 position_map: &PositionMap,
420 text_bounds: RectF,
421 cx: &mut ViewContext<Editor>,
422 ) -> bool {
423 // This will be handled more correctly once https://github.com/zed-industries/zed/issues/1218 is completed
424 // Don't trigger hover popover if mouse is hovering over context menu
425 let point = position_to_display_point(position, text_bounds, position_map);
426
427 update_go_to_definition_link(editor, point, cmd, shift, cx);
428 hover_at(editor, point, cx);
429
430 true
431 }
432
433 fn scroll(
434 editor: &mut Editor,
435 position: Vector2F,
436 mut delta: Vector2F,
437 precise: bool,
438 position_map: &PositionMap,
439 bounds: RectF,
440 cx: &mut ViewContext<Editor>,
441 ) -> bool {
442 if !bounds.contains_point(position) {
443 return false;
444 }
445
446 let line_height = position_map.line_height;
447 let max_glyph_width = position_map.em_width;
448
449 let axis = if precise {
450 //Trackpad
451 position_map.snapshot.ongoing_scroll.filter(&mut delta)
452 } else {
453 //Not trackpad
454 delta *= vec2f(max_glyph_width, line_height);
455 None //Resets ongoing scroll
456 };
457
458 let scroll_position = position_map.snapshot.scroll_position();
459 let x = (scroll_position.x() * max_glyph_width - delta.x()) / max_glyph_width;
460 let y = (scroll_position.y() * line_height - delta.y()) / line_height;
461 let scroll_position = vec2f(x, y).clamp(Vector2F::zero(), position_map.scroll_max);
462 editor.scroll(scroll_position, axis, cx);
463
464 true
465 }
466
467 fn paint_background(
468 &self,
469 scene: &mut SceneBuilder,
470 gutter_bounds: RectF,
471 text_bounds: RectF,
472 layout: &LayoutState,
473 ) {
474 let bounds = gutter_bounds.union_rect(text_bounds);
475 let scroll_top =
476 layout.position_map.snapshot.scroll_position().y() * layout.position_map.line_height;
477 scene.push_quad(Quad {
478 bounds: gutter_bounds,
479 background: Some(self.style.gutter_background),
480 border: Border::new(0., Color::transparent_black()),
481 corner_radius: 0.,
482 });
483 scene.push_quad(Quad {
484 bounds: text_bounds,
485 background: Some(self.style.background),
486 border: Border::new(0., Color::transparent_black()),
487 corner_radius: 0.,
488 });
489
490 if let EditorMode::Full = layout.mode {
491 let mut active_rows = layout.active_rows.iter().peekable();
492 while let Some((start_row, contains_non_empty_selection)) = active_rows.next() {
493 let mut end_row = *start_row;
494 while active_rows.peek().map_or(false, |r| {
495 *r.0 == end_row + 1 && r.1 == contains_non_empty_selection
496 }) {
497 active_rows.next().unwrap();
498 end_row += 1;
499 }
500
501 if !contains_non_empty_selection {
502 let origin = vec2f(
503 bounds.origin_x(),
504 bounds.origin_y() + (layout.position_map.line_height * *start_row as f32)
505 - scroll_top,
506 );
507 let size = vec2f(
508 bounds.width(),
509 layout.position_map.line_height * (end_row - start_row + 1) as f32,
510 );
511 scene.push_quad(Quad {
512 bounds: RectF::new(origin, size),
513 background: Some(self.style.active_line_background),
514 border: Border::default(),
515 corner_radius: 0.,
516 });
517 }
518 }
519
520 if let Some(highlighted_rows) = &layout.highlighted_rows {
521 let origin = vec2f(
522 bounds.origin_x(),
523 bounds.origin_y()
524 + (layout.position_map.line_height * highlighted_rows.start as f32)
525 - scroll_top,
526 );
527 let size = vec2f(
528 bounds.width(),
529 layout.position_map.line_height * highlighted_rows.len() as f32,
530 );
531 scene.push_quad(Quad {
532 bounds: RectF::new(origin, size),
533 background: Some(self.style.highlighted_line_background),
534 border: Border::default(),
535 corner_radius: 0.,
536 });
537 }
538 }
539 }
540
541 fn paint_gutter(
542 &mut self,
543 scene: &mut SceneBuilder,
544 bounds: RectF,
545 visible_bounds: RectF,
546 layout: &mut LayoutState,
547 editor: &mut Editor,
548 cx: &mut ViewContext<Editor>,
549 ) {
550 let line_height = layout.position_map.line_height;
551
552 let scroll_position = layout.position_map.snapshot.scroll_position();
553 let scroll_top = scroll_position.y() * line_height;
554
555 let show_gutter = matches!(
556 settings::get::<ProjectSettings>(cx).git.git_gutter,
557 Some(GitGutterSetting::TrackedFiles)
558 );
559
560 if show_gutter {
561 Self::paint_diff_hunks(scene, bounds, layout, cx);
562 }
563
564 for (ix, line) in layout.line_number_layouts.iter().enumerate() {
565 if let Some(line) = line {
566 let line_origin = bounds.origin()
567 + vec2f(
568 bounds.width() - line.width() - layout.gutter_padding,
569 ix as f32 * line_height - (scroll_top % line_height),
570 );
571
572 line.paint(scene, line_origin, visible_bounds, line_height, cx);
573 }
574 }
575
576 for (ix, fold_indicator) in layout.fold_indicators.iter_mut().enumerate() {
577 if let Some(indicator) = fold_indicator.as_mut() {
578 let position = vec2f(
579 bounds.width() - layout.gutter_padding,
580 ix as f32 * line_height - (scroll_top % line_height),
581 );
582 let centering_offset = vec2f(
583 (layout.gutter_padding + layout.gutter_margin - indicator.size().x()) / 2.,
584 (line_height - indicator.size().y()) / 2.,
585 );
586
587 let indicator_origin = bounds.origin() + position + centering_offset;
588
589 indicator.paint(scene, indicator_origin, visible_bounds, editor, cx);
590 }
591 }
592
593 if let Some((row, indicator)) = layout.code_actions_indicator.as_mut() {
594 let mut x = 0.;
595 let mut y = *row as f32 * line_height - scroll_top;
596 x += ((layout.gutter_padding + layout.gutter_margin) - indicator.size().x()) / 2.;
597 y += (line_height - indicator.size().y()) / 2.;
598 indicator.paint(
599 scene,
600 bounds.origin() + vec2f(x, y),
601 visible_bounds,
602 editor,
603 cx,
604 );
605 }
606 }
607
608 fn paint_diff_hunks(
609 scene: &mut SceneBuilder,
610 bounds: RectF,
611 layout: &mut LayoutState,
612 cx: &mut ViewContext<Editor>,
613 ) {
614 let diff_style = &theme::current(cx).editor.diff.clone();
615 let line_height = layout.position_map.line_height;
616
617 let scroll_position = layout.position_map.snapshot.scroll_position();
618 let scroll_top = scroll_position.y() * line_height;
619
620 for hunk in &layout.display_hunks {
621 let (display_row_range, status) = match hunk {
622 //TODO: This rendering is entirely a horrible hack
623 &DisplayDiffHunk::Folded { display_row: row } => {
624 let start_y = row as f32 * line_height - scroll_top;
625 let end_y = start_y + line_height;
626
627 let width = diff_style.removed_width_em * line_height;
628 let highlight_origin = bounds.origin() + vec2f(-width, start_y);
629 let highlight_size = vec2f(width * 2., end_y - start_y);
630 let highlight_bounds = RectF::new(highlight_origin, highlight_size);
631
632 scene.push_quad(Quad {
633 bounds: highlight_bounds,
634 background: Some(diff_style.modified),
635 border: Border::new(0., Color::transparent_black()),
636 corner_radius: 1. * line_height,
637 });
638
639 continue;
640 }
641
642 DisplayDiffHunk::Unfolded {
643 display_row_range,
644 status,
645 } => (display_row_range, status),
646 };
647
648 let color = match status {
649 DiffHunkStatus::Added => diff_style.inserted,
650 DiffHunkStatus::Modified => diff_style.modified,
651
652 //TODO: This rendering is entirely a horrible hack
653 DiffHunkStatus::Removed => {
654 let row = display_row_range.start;
655
656 let offset = line_height / 2.;
657 let start_y = row as f32 * line_height - offset - scroll_top;
658 let end_y = start_y + line_height;
659
660 let width = diff_style.removed_width_em * line_height;
661 let highlight_origin = bounds.origin() + vec2f(-width, start_y);
662 let highlight_size = vec2f(width * 2., end_y - start_y);
663 let highlight_bounds = RectF::new(highlight_origin, highlight_size);
664
665 scene.push_quad(Quad {
666 bounds: highlight_bounds,
667 background: Some(diff_style.deleted),
668 border: Border::new(0., Color::transparent_black()),
669 corner_radius: 1. * line_height,
670 });
671
672 continue;
673 }
674 };
675
676 let start_row = display_row_range.start;
677 let end_row = display_row_range.end;
678
679 let start_y = start_row as f32 * line_height - scroll_top;
680 let end_y = end_row as f32 * line_height - scroll_top;
681
682 let width = diff_style.width_em * line_height;
683 let highlight_origin = bounds.origin() + vec2f(-width, start_y);
684 let highlight_size = vec2f(width * 2., end_y - start_y);
685 let highlight_bounds = RectF::new(highlight_origin, highlight_size);
686
687 scene.push_quad(Quad {
688 bounds: highlight_bounds,
689 background: Some(color),
690 border: Border::new(0., Color::transparent_black()),
691 corner_radius: diff_style.corner_radius * line_height,
692 });
693 }
694 }
695
696 fn paint_text(
697 &mut self,
698 scene: &mut SceneBuilder,
699 bounds: RectF,
700 visible_bounds: RectF,
701 layout: &mut LayoutState,
702 editor: &mut Editor,
703 cx: &mut ViewContext<Editor>,
704 ) {
705 let style = &self.style;
706 let local_replica_id = editor.replica_id(cx);
707 let scroll_position = layout.position_map.snapshot.scroll_position();
708 let start_row = layout.visible_display_row_range.start;
709 let scroll_top = scroll_position.y() * layout.position_map.line_height;
710 let max_glyph_width = layout.position_map.em_width;
711 let scroll_left = scroll_position.x() * max_glyph_width;
712 let content_origin = bounds.origin() + vec2f(layout.gutter_margin, 0.);
713 let line_end_overshoot = 0.15 * layout.position_map.line_height;
714 let whitespace_setting = editor.buffer.read(cx).settings_at(0, cx).show_whitespaces;
715
716 scene.push_layer(Some(bounds));
717
718 scene.push_cursor_region(CursorRegion {
719 bounds,
720 style: if !editor.link_go_to_definition_state.definitions.is_empty() {
721 CursorStyle::PointingHand
722 } else {
723 CursorStyle::IBeam
724 },
725 });
726
727 let fold_corner_radius =
728 self.style.folds.ellipses.corner_radius_factor * layout.position_map.line_height;
729 for (id, range, color) in layout.fold_ranges.iter() {
730 self.paint_highlighted_range(
731 scene,
732 range.clone(),
733 *color,
734 fold_corner_radius,
735 fold_corner_radius * 2.,
736 layout,
737 content_origin,
738 scroll_top,
739 scroll_left,
740 bounds,
741 );
742
743 for bound in range_to_bounds(
744 &range,
745 content_origin,
746 scroll_left,
747 scroll_top,
748 &layout.visible_display_row_range,
749 line_end_overshoot,
750 &layout.position_map,
751 ) {
752 scene.push_cursor_region(CursorRegion {
753 bounds: bound,
754 style: CursorStyle::PointingHand,
755 });
756
757 let display_row = range.start.row();
758
759 let buffer_row = DisplayPoint::new(display_row, 0)
760 .to_point(&layout.position_map.snapshot.display_snapshot)
761 .row;
762
763 scene.push_mouse_region(
764 MouseRegion::new::<FoldMarkers>(cx.view_id(), *id as usize, bound)
765 .on_click(MouseButton::Left, move |_, editor: &mut Editor, cx| {
766 editor.unfold_at(&UnfoldAt { buffer_row }, cx)
767 })
768 .with_notify_on_hover(true)
769 .with_notify_on_click(true),
770 )
771 }
772 }
773
774 for (range, color) in &layout.highlighted_ranges {
775 self.paint_highlighted_range(
776 scene,
777 range.clone(),
778 *color,
779 0.,
780 line_end_overshoot,
781 layout,
782 content_origin,
783 scroll_top,
784 scroll_left,
785 bounds,
786 );
787 }
788
789 let mut cursors = SmallVec::<[Cursor; 32]>::new();
790 let corner_radius = 0.15 * layout.position_map.line_height;
791 let mut invisible_display_ranges = SmallVec::<[Range<DisplayPoint>; 32]>::new();
792
793 for (replica_id, selections) in &layout.selections {
794 let replica_id = *replica_id;
795 let selection_style = style.replica_selection_style(replica_id);
796
797 for selection in selections {
798 if !selection.range.is_empty()
799 && (replica_id == local_replica_id
800 || Some(replica_id) == editor.leader_replica_id)
801 {
802 invisible_display_ranges.push(selection.range.clone());
803 }
804 self.paint_highlighted_range(
805 scene,
806 selection.range.clone(),
807 selection_style.selection,
808 corner_radius,
809 corner_radius * 2.,
810 layout,
811 content_origin,
812 scroll_top,
813 scroll_left,
814 bounds,
815 );
816
817 if editor.show_local_cursors(cx) || replica_id != local_replica_id {
818 let cursor_position = selection.head;
819 if layout
820 .visible_display_row_range
821 .contains(&cursor_position.row())
822 {
823 let cursor_row_layout = &layout.position_map.line_layouts
824 [(cursor_position.row() - start_row) as usize]
825 .line;
826 let cursor_column = cursor_position.column() as usize;
827
828 let cursor_character_x = cursor_row_layout.x_for_index(cursor_column);
829 let mut block_width =
830 cursor_row_layout.x_for_index(cursor_column + 1) - cursor_character_x;
831 if block_width == 0.0 {
832 block_width = layout.position_map.em_width;
833 }
834 let block_text = if let CursorShape::Block = selection.cursor_shape {
835 layout
836 .position_map
837 .snapshot
838 .chars_at(cursor_position)
839 .next()
840 .and_then(|(character, _)| {
841 let font_id =
842 cursor_row_layout.font_for_index(cursor_column)?;
843 let text = character.to_string();
844
845 Some(cx.text_layout_cache().layout_str(
846 &text,
847 cursor_row_layout.font_size(),
848 &[(
849 text.len(),
850 RunStyle {
851 font_id,
852 color: style.background,
853 underline: Default::default(),
854 },
855 )],
856 ))
857 })
858 } else {
859 None
860 };
861
862 let x = cursor_character_x - scroll_left;
863 let y = cursor_position.row() as f32 * layout.position_map.line_height
864 - scroll_top;
865 cursors.push(Cursor {
866 color: selection_style.cursor,
867 block_width,
868 origin: vec2f(x, y),
869 line_height: layout.position_map.line_height,
870 shape: selection.cursor_shape,
871 block_text,
872 });
873 }
874 }
875 }
876 }
877
878 if let Some(visible_text_bounds) = bounds.intersection(visible_bounds) {
879 for (ix, line_with_invisibles) in layout.position_map.line_layouts.iter().enumerate() {
880 let row = start_row + ix as u32;
881 line_with_invisibles.draw(
882 layout,
883 row,
884 scroll_top,
885 scene,
886 content_origin,
887 scroll_left,
888 visible_text_bounds,
889 whitespace_setting,
890 &invisible_display_ranges,
891 visible_bounds,
892 cx,
893 )
894 }
895 }
896
897 scene.paint_layer(Some(bounds), |scene| {
898 for cursor in cursors {
899 cursor.paint(scene, content_origin, cx);
900 }
901 });
902
903 if let Some((position, context_menu)) = layout.context_menu.as_mut() {
904 scene.push_stacking_context(None, None);
905 let cursor_row_layout =
906 &layout.position_map.line_layouts[(position.row() - start_row) as usize].line;
907 let x = cursor_row_layout.x_for_index(position.column() as usize) - scroll_left;
908 let y = (position.row() + 1) as f32 * layout.position_map.line_height - scroll_top;
909 let mut list_origin = content_origin + vec2f(x, y);
910 let list_width = context_menu.size().x();
911 let list_height = context_menu.size().y();
912
913 // Snap the right edge of the list to the right edge of the window if
914 // its horizontal bounds overflow.
915 if list_origin.x() + list_width > cx.window_size().x() {
916 list_origin.set_x((cx.window_size().x() - list_width).max(0.));
917 }
918
919 if list_origin.y() + list_height > bounds.max_y() {
920 list_origin.set_y(list_origin.y() - layout.position_map.line_height - list_height);
921 }
922
923 context_menu.paint(
924 scene,
925 list_origin,
926 RectF::from_points(Vector2F::zero(), vec2f(f32::MAX, f32::MAX)), // Let content bleed outside of editor
927 editor,
928 cx,
929 );
930
931 scene.pop_stacking_context();
932 }
933
934 if let Some((position, hover_popovers)) = layout.hover_popovers.as_mut() {
935 scene.push_stacking_context(None, None);
936
937 // This is safe because we check on layout whether the required row is available
938 let hovered_row_layout =
939 &layout.position_map.line_layouts[(position.row() - start_row) as usize].line;
940
941 // Minimum required size: Take the first popover, and add 1.5 times the minimum popover
942 // height. This is the size we will use to decide whether to render popovers above or below
943 // the hovered line.
944 let first_size = hover_popovers[0].size();
945 let height_to_reserve = first_size.y()
946 + 1.5 * MIN_POPOVER_LINE_HEIGHT as f32 * layout.position_map.line_height;
947
948 // Compute Hovered Point
949 let x = hovered_row_layout.x_for_index(position.column() as usize) - scroll_left;
950 let y = position.row() as f32 * layout.position_map.line_height - scroll_top;
951 let hovered_point = content_origin + vec2f(x, y);
952
953 if hovered_point.y() - height_to_reserve > 0.0 {
954 // There is enough space above. Render popovers above the hovered point
955 let mut current_y = hovered_point.y();
956 for hover_popover in hover_popovers {
957 let size = hover_popover.size();
958 let mut popover_origin = vec2f(hovered_point.x(), current_y - size.y());
959
960 let x_out_of_bounds = bounds.max_x() - (popover_origin.x() + size.x());
961 if x_out_of_bounds < 0.0 {
962 popover_origin.set_x(popover_origin.x() + x_out_of_bounds);
963 }
964
965 hover_popover.paint(
966 scene,
967 popover_origin,
968 RectF::from_points(Vector2F::zero(), vec2f(f32::MAX, f32::MAX)), // Let content bleed outside of editor
969 editor,
970 cx,
971 );
972
973 current_y = popover_origin.y() - HOVER_POPOVER_GAP;
974 }
975 } else {
976 // There is not enough space above. Render popovers below the hovered point
977 let mut current_y = hovered_point.y() + layout.position_map.line_height;
978 for hover_popover in hover_popovers {
979 let size = hover_popover.size();
980 let mut popover_origin = vec2f(hovered_point.x(), current_y);
981
982 let x_out_of_bounds = bounds.max_x() - (popover_origin.x() + size.x());
983 if x_out_of_bounds < 0.0 {
984 popover_origin.set_x(popover_origin.x() + x_out_of_bounds);
985 }
986
987 hover_popover.paint(
988 scene,
989 popover_origin,
990 RectF::from_points(Vector2F::zero(), vec2f(f32::MAX, f32::MAX)), // Let content bleed outside of editor
991 editor,
992 cx,
993 );
994
995 current_y = popover_origin.y() + size.y() + HOVER_POPOVER_GAP;
996 }
997 }
998
999 scene.pop_stacking_context();
1000 }
1001
1002 scene.pop_layer();
1003 }
1004
1005 fn paint_scrollbar(
1006 &mut self,
1007 scene: &mut SceneBuilder,
1008 bounds: RectF,
1009 layout: &mut LayoutState,
1010 cx: &mut ViewContext<Editor>,
1011 ) {
1012 enum ScrollbarMouseHandlers {}
1013 if layout.mode != EditorMode::Full {
1014 return;
1015 }
1016
1017 let style = &self.style.theme.scrollbar;
1018
1019 let top = bounds.min_y();
1020 let bottom = bounds.max_y();
1021 let right = bounds.max_x();
1022 let left = right - style.width;
1023 let row_range = &layout.scrollbar_row_range;
1024 let max_row = layout.max_row as f32 + (row_range.end - row_range.start);
1025
1026 let mut height = bounds.height();
1027 let mut first_row_y_offset = 0.0;
1028
1029 // Impose a minimum height on the scrollbar thumb
1030 let row_height = height / max_row;
1031 let min_thumb_height =
1032 style.min_height_factor * cx.font_cache.line_height(self.style.text.font_size);
1033 let thumb_height = (row_range.end - row_range.start) * row_height;
1034 if thumb_height < min_thumb_height {
1035 first_row_y_offset = (min_thumb_height - thumb_height) / 2.0;
1036 height -= min_thumb_height - thumb_height;
1037 }
1038
1039 let y_for_row = |row: f32| -> f32 { top + first_row_y_offset + row * row_height };
1040
1041 let thumb_top = y_for_row(row_range.start) - first_row_y_offset;
1042 let thumb_bottom = y_for_row(row_range.end) + first_row_y_offset;
1043 let track_bounds = RectF::from_points(vec2f(left, top), vec2f(right, bottom));
1044 let thumb_bounds = RectF::from_points(vec2f(left, thumb_top), vec2f(right, thumb_bottom));
1045
1046 if layout.show_scrollbars {
1047 scene.push_quad(Quad {
1048 bounds: track_bounds,
1049 border: style.track.border,
1050 background: style.track.background_color,
1051 ..Default::default()
1052 });
1053
1054 if layout.is_singleton && settings::get::<EditorSettings>(cx).scrollbar.git_diff {
1055 let diff_style = theme::current(cx).editor.scrollbar.git.clone();
1056 for hunk in layout
1057 .position_map
1058 .snapshot
1059 .buffer_snapshot
1060 .git_diff_hunks_in_range(0..(max_row.floor() as u32))
1061 {
1062 let start_display = Point::new(hunk.buffer_range.start, 0)
1063 .to_display_point(&layout.position_map.snapshot.display_snapshot);
1064 let end_display = Point::new(hunk.buffer_range.end, 0)
1065 .to_display_point(&layout.position_map.snapshot.display_snapshot);
1066 let start_y = y_for_row(start_display.row() as f32);
1067 let mut end_y = if hunk.buffer_range.start == hunk.buffer_range.end {
1068 y_for_row((end_display.row() + 1) as f32)
1069 } else {
1070 y_for_row((end_display.row()) as f32)
1071 };
1072
1073 if end_y - start_y < 1. {
1074 end_y = start_y + 1.;
1075 }
1076 let bounds = RectF::from_points(vec2f(left, start_y), vec2f(right, end_y));
1077
1078 let color = match hunk.status() {
1079 DiffHunkStatus::Added => diff_style.inserted,
1080 DiffHunkStatus::Modified => diff_style.modified,
1081 DiffHunkStatus::Removed => diff_style.deleted,
1082 };
1083
1084 let border = Border {
1085 width: 1.,
1086 color: style.thumb.border.color,
1087 overlay: false,
1088 top: false,
1089 right: true,
1090 bottom: false,
1091 left: true,
1092 };
1093
1094 scene.push_quad(Quad {
1095 bounds,
1096 background: Some(color),
1097 border,
1098 corner_radius: style.thumb.corner_radius,
1099 })
1100 }
1101 }
1102
1103 scene.push_quad(Quad {
1104 bounds: thumb_bounds,
1105 border: style.thumb.border,
1106 background: style.thumb.background_color,
1107 corner_radius: style.thumb.corner_radius,
1108 });
1109 }
1110
1111 scene.push_cursor_region(CursorRegion {
1112 bounds: track_bounds,
1113 style: CursorStyle::Arrow,
1114 });
1115 scene.push_mouse_region(
1116 MouseRegion::new::<ScrollbarMouseHandlers>(cx.view_id(), cx.view_id(), track_bounds)
1117 .on_move(move |_, editor: &mut Editor, cx| {
1118 editor.scroll_manager.show_scrollbar(cx);
1119 })
1120 .on_down(MouseButton::Left, {
1121 let row_range = row_range.clone();
1122 move |event, editor: &mut Editor, cx| {
1123 let y = event.position.y();
1124 if y < thumb_top || thumb_bottom < y {
1125 let center_row = ((y - top) * max_row as f32 / height).round() as u32;
1126 let top_row = center_row
1127 .saturating_sub((row_range.end - row_range.start) as u32 / 2);
1128 let mut position = editor.scroll_position(cx);
1129 position.set_y(top_row as f32);
1130 editor.set_scroll_position(position, cx);
1131 } else {
1132 editor.scroll_manager.show_scrollbar(cx);
1133 }
1134 }
1135 })
1136 .on_drag(MouseButton::Left, {
1137 move |event, editor: &mut Editor, cx| {
1138 let y = event.prev_mouse_position.y();
1139 let new_y = event.position.y();
1140 if thumb_top < y && y < thumb_bottom {
1141 let mut position = editor.scroll_position(cx);
1142 position.set_y(position.y() + (new_y - y) * (max_row as f32) / height);
1143 if position.y() < 0.0 {
1144 position.set_y(0.);
1145 }
1146 editor.set_scroll_position(position, cx);
1147 }
1148 }
1149 }),
1150 );
1151 }
1152
1153 #[allow(clippy::too_many_arguments)]
1154 fn paint_highlighted_range(
1155 &self,
1156 scene: &mut SceneBuilder,
1157 range: Range<DisplayPoint>,
1158 color: Color,
1159 corner_radius: f32,
1160 line_end_overshoot: f32,
1161 layout: &LayoutState,
1162 content_origin: Vector2F,
1163 scroll_top: f32,
1164 scroll_left: f32,
1165 bounds: RectF,
1166 ) {
1167 let start_row = layout.visible_display_row_range.start;
1168 let end_row = layout.visible_display_row_range.end;
1169 if range.start != range.end {
1170 let row_range = if range.end.column() == 0 {
1171 cmp::max(range.start.row(), start_row)..cmp::min(range.end.row(), end_row)
1172 } else {
1173 cmp::max(range.start.row(), start_row)..cmp::min(range.end.row() + 1, end_row)
1174 };
1175
1176 let highlighted_range = HighlightedRange {
1177 color,
1178 line_height: layout.position_map.line_height,
1179 corner_radius,
1180 start_y: content_origin.y()
1181 + row_range.start as f32 * layout.position_map.line_height
1182 - scroll_top,
1183 lines: row_range
1184 .into_iter()
1185 .map(|row| {
1186 let line_layout =
1187 &layout.position_map.line_layouts[(row - start_row) as usize].line;
1188 HighlightedRangeLine {
1189 start_x: if row == range.start.row() {
1190 content_origin.x()
1191 + line_layout.x_for_index(range.start.column() as usize)
1192 - scroll_left
1193 } else {
1194 content_origin.x() - scroll_left
1195 },
1196 end_x: if row == range.end.row() {
1197 content_origin.x()
1198 + line_layout.x_for_index(range.end.column() as usize)
1199 - scroll_left
1200 } else {
1201 content_origin.x() + line_layout.width() + line_end_overshoot
1202 - scroll_left
1203 },
1204 }
1205 })
1206 .collect(),
1207 };
1208
1209 highlighted_range.paint(bounds, scene);
1210 }
1211 }
1212
1213 fn paint_blocks(
1214 &mut self,
1215 scene: &mut SceneBuilder,
1216 bounds: RectF,
1217 visible_bounds: RectF,
1218 layout: &mut LayoutState,
1219 editor: &mut Editor,
1220 cx: &mut ViewContext<Editor>,
1221 ) {
1222 let scroll_position = layout.position_map.snapshot.scroll_position();
1223 let scroll_left = scroll_position.x() * layout.position_map.em_width;
1224 let scroll_top = scroll_position.y() * layout.position_map.line_height;
1225
1226 for block in &mut layout.blocks {
1227 let mut origin = bounds.origin()
1228 + vec2f(
1229 0.,
1230 block.row as f32 * layout.position_map.line_height - scroll_top,
1231 );
1232 if !matches!(block.style, BlockStyle::Sticky) {
1233 origin += vec2f(-scroll_left, 0.);
1234 }
1235 block
1236 .element
1237 .paint(scene, origin, visible_bounds, editor, cx);
1238 }
1239 }
1240
1241 fn max_line_number_width(&self, snapshot: &EditorSnapshot, cx: &ViewContext<Editor>) -> f32 {
1242 let digit_count = (snapshot.max_buffer_row() as f32).log10().floor() as usize + 1;
1243 let style = &self.style;
1244
1245 cx.text_layout_cache()
1246 .layout_str(
1247 "1".repeat(digit_count).as_str(),
1248 style.text.font_size,
1249 &[(
1250 digit_count,
1251 RunStyle {
1252 font_id: style.text.font_id,
1253 color: Color::black(),
1254 underline: Default::default(),
1255 },
1256 )],
1257 )
1258 .width()
1259 }
1260
1261 //Folds contained in a hunk are ignored apart from shrinking visual size
1262 //If a fold contains any hunks then that fold line is marked as modified
1263 fn layout_git_gutters(
1264 &self,
1265 display_rows: Range<u32>,
1266 snapshot: &EditorSnapshot,
1267 ) -> Vec<DisplayDiffHunk> {
1268 let buffer_snapshot = &snapshot.buffer_snapshot;
1269
1270 let buffer_start_row = DisplayPoint::new(display_rows.start, 0)
1271 .to_point(snapshot)
1272 .row;
1273 let buffer_end_row = DisplayPoint::new(display_rows.end, 0)
1274 .to_point(snapshot)
1275 .row;
1276
1277 buffer_snapshot
1278 .git_diff_hunks_in_range(buffer_start_row..buffer_end_row)
1279 .map(|hunk| diff_hunk_to_display(hunk, snapshot))
1280 .dedup()
1281 .collect()
1282 }
1283
1284 fn layout_line_numbers(
1285 &self,
1286 rows: Range<u32>,
1287 active_rows: &BTreeMap<u32, bool>,
1288 is_singleton: bool,
1289 snapshot: &EditorSnapshot,
1290 cx: &ViewContext<Editor>,
1291 ) -> (
1292 Vec<Option<text_layout::Line>>,
1293 Vec<Option<(FoldStatus, BufferRow, bool)>>,
1294 ) {
1295 let style = &self.style;
1296 let include_line_numbers = snapshot.mode == EditorMode::Full;
1297 let mut line_number_layouts = Vec::with_capacity(rows.len());
1298 let mut fold_statuses = Vec::with_capacity(rows.len());
1299 let mut line_number = String::new();
1300 for (ix, row) in snapshot
1301 .buffer_rows(rows.start)
1302 .take((rows.end - rows.start) as usize)
1303 .enumerate()
1304 {
1305 let display_row = rows.start + ix as u32;
1306 let (active, color) = if active_rows.contains_key(&display_row) {
1307 (true, style.line_number_active)
1308 } else {
1309 (false, style.line_number)
1310 };
1311 if let Some(buffer_row) = row {
1312 if include_line_numbers {
1313 line_number.clear();
1314 write!(&mut line_number, "{}", buffer_row + 1).unwrap();
1315 line_number_layouts.push(Some(cx.text_layout_cache().layout_str(
1316 &line_number,
1317 style.text.font_size,
1318 &[(
1319 line_number.len(),
1320 RunStyle {
1321 font_id: style.text.font_id,
1322 color,
1323 underline: Default::default(),
1324 },
1325 )],
1326 )));
1327 fold_statuses.push(
1328 is_singleton
1329 .then(|| {
1330 snapshot
1331 .fold_for_line(buffer_row)
1332 .map(|fold_status| (fold_status, buffer_row, active))
1333 })
1334 .flatten(),
1335 )
1336 }
1337 } else {
1338 fold_statuses.push(None);
1339 line_number_layouts.push(None);
1340 }
1341 }
1342
1343 (line_number_layouts, fold_statuses)
1344 }
1345
1346 fn layout_lines(
1347 &mut self,
1348 rows: Range<u32>,
1349 line_number_layouts: &[Option<Line>],
1350 snapshot: &EditorSnapshot,
1351 cx: &ViewContext<Editor>,
1352 ) -> Vec<LineWithInvisibles> {
1353 if rows.start >= rows.end {
1354 return Vec::new();
1355 }
1356
1357 // When the editor is empty and unfocused, then show the placeholder.
1358 if snapshot.is_empty() {
1359 let placeholder_style = self
1360 .style
1361 .placeholder_text
1362 .as_ref()
1363 .unwrap_or(&self.style.text);
1364 let placeholder_text = snapshot.placeholder_text();
1365 let placeholder_lines = placeholder_text
1366 .as_ref()
1367 .map_or("", AsRef::as_ref)
1368 .split('\n')
1369 .skip(rows.start as usize)
1370 .chain(iter::repeat(""))
1371 .take(rows.len());
1372 placeholder_lines
1373 .map(|line| {
1374 cx.text_layout_cache().layout_str(
1375 line,
1376 placeholder_style.font_size,
1377 &[(
1378 line.len(),
1379 RunStyle {
1380 font_id: placeholder_style.font_id,
1381 color: placeholder_style.color,
1382 underline: Default::default(),
1383 },
1384 )],
1385 )
1386 })
1387 .map(|line| LineWithInvisibles {
1388 line,
1389 invisibles: Vec::new(),
1390 })
1391 .collect()
1392 } else {
1393 let style = &self.style;
1394 let chunks = snapshot
1395 .chunks(
1396 rows.clone(),
1397 true,
1398 Some(style.theme.hint),
1399 Some(style.theme.suggestion),
1400 )
1401 .map(|chunk| {
1402 let mut highlight_style = chunk
1403 .syntax_highlight_id
1404 .and_then(|id| id.style(&style.syntax));
1405
1406 if let Some(chunk_highlight) = chunk.highlight_style {
1407 if let Some(highlight_style) = highlight_style.as_mut() {
1408 highlight_style.highlight(chunk_highlight);
1409 } else {
1410 highlight_style = Some(chunk_highlight);
1411 }
1412 }
1413
1414 let mut diagnostic_highlight = HighlightStyle::default();
1415
1416 if chunk.is_unnecessary {
1417 diagnostic_highlight.fade_out = Some(style.unnecessary_code_fade);
1418 }
1419
1420 if let Some(severity) = chunk.diagnostic_severity {
1421 // Omit underlines for HINT/INFO diagnostics on 'unnecessary' code.
1422 if severity <= DiagnosticSeverity::WARNING || !chunk.is_unnecessary {
1423 let diagnostic_style = super::diagnostic_style(severity, true, style);
1424 diagnostic_highlight.underline = Some(Underline {
1425 color: Some(diagnostic_style.message.text.color),
1426 thickness: 1.0.into(),
1427 squiggly: true,
1428 });
1429 }
1430 }
1431
1432 if let Some(highlight_style) = highlight_style.as_mut() {
1433 highlight_style.highlight(diagnostic_highlight);
1434 } else {
1435 highlight_style = Some(diagnostic_highlight);
1436 }
1437
1438 HighlightedChunk {
1439 chunk: chunk.text,
1440 style: highlight_style,
1441 is_tab: chunk.is_tab,
1442 }
1443 });
1444
1445 LineWithInvisibles::from_chunks(
1446 chunks,
1447 &style.text,
1448 cx.text_layout_cache(),
1449 cx.font_cache(),
1450 MAX_LINE_LEN,
1451 rows.len() as usize,
1452 line_number_layouts,
1453 snapshot.mode,
1454 )
1455 }
1456 }
1457
1458 #[allow(clippy::too_many_arguments)]
1459 fn layout_blocks(
1460 &mut self,
1461 rows: Range<u32>,
1462 snapshot: &EditorSnapshot,
1463 editor_width: f32,
1464 scroll_width: f32,
1465 gutter_padding: f32,
1466 gutter_width: f32,
1467 em_width: f32,
1468 text_x: f32,
1469 line_height: f32,
1470 style: &EditorStyle,
1471 line_layouts: &[LineWithInvisibles],
1472 editor: &mut Editor,
1473 cx: &mut LayoutContext<Editor>,
1474 ) -> (f32, Vec<BlockLayout>) {
1475 let mut block_id = 0;
1476 let scroll_x = snapshot.scroll_anchor.offset.x();
1477 let (fixed_blocks, non_fixed_blocks) = snapshot
1478 .blocks_in_range(rows.clone())
1479 .partition::<Vec<_>, _>(|(_, block)| match block {
1480 TransformBlock::ExcerptHeader { .. } => false,
1481 TransformBlock::Custom(block) => block.style() == BlockStyle::Fixed,
1482 });
1483 let mut render_block = |block: &TransformBlock, width: f32, block_id: usize| {
1484 let mut element = match block {
1485 TransformBlock::Custom(block) => {
1486 let align_to = block
1487 .position()
1488 .to_point(&snapshot.buffer_snapshot)
1489 .to_display_point(snapshot);
1490 let anchor_x = text_x
1491 + if rows.contains(&align_to.row()) {
1492 line_layouts[(align_to.row() - rows.start) as usize]
1493 .line
1494 .x_for_index(align_to.column() as usize)
1495 } else {
1496 layout_line(align_to.row(), snapshot, style, cx.text_layout_cache())
1497 .x_for_index(align_to.column() as usize)
1498 };
1499
1500 block.render(&mut BlockContext {
1501 view_context: cx,
1502 anchor_x,
1503 gutter_padding,
1504 line_height,
1505 scroll_x,
1506 gutter_width,
1507 em_width,
1508 block_id,
1509 })
1510 }
1511 TransformBlock::ExcerptHeader {
1512 id,
1513 buffer,
1514 range,
1515 starts_new_buffer,
1516 ..
1517 } => {
1518 let tooltip_style = theme::current(cx).tooltip.clone();
1519 let include_root = editor
1520 .project
1521 .as_ref()
1522 .map(|project| project.read(cx).visible_worktrees(cx).count() > 1)
1523 .unwrap_or_default();
1524 let jump_icon = project::File::from_dyn(buffer.file()).map(|file| {
1525 let jump_path = ProjectPath {
1526 worktree_id: file.worktree_id(cx),
1527 path: file.path.clone(),
1528 };
1529 let jump_anchor = range
1530 .primary
1531 .as_ref()
1532 .map_or(range.context.start, |primary| primary.start);
1533 let jump_position = language::ToPoint::to_point(&jump_anchor, buffer);
1534
1535 enum JumpIcon {}
1536 MouseEventHandler::<JumpIcon, _>::new((*id).into(), cx, |state, _| {
1537 let style = style.jump_icon.style_for(state);
1538 Svg::new("icons/arrow_up_right_8.svg")
1539 .with_color(style.color)
1540 .constrained()
1541 .with_width(style.icon_width)
1542 .aligned()
1543 .contained()
1544 .with_style(style.container)
1545 .constrained()
1546 .with_width(style.button_width)
1547 .with_height(style.button_width)
1548 })
1549 .with_cursor_style(CursorStyle::PointingHand)
1550 .on_click(MouseButton::Left, move |_, editor, cx| {
1551 if let Some(workspace) = editor
1552 .workspace
1553 .as_ref()
1554 .and_then(|(workspace, _)| workspace.upgrade(cx))
1555 {
1556 workspace.update(cx, |workspace, cx| {
1557 Editor::jump(
1558 workspace,
1559 jump_path.clone(),
1560 jump_position,
1561 jump_anchor,
1562 cx,
1563 );
1564 });
1565 }
1566 })
1567 .with_tooltip::<JumpIcon>(
1568 (*id).into(),
1569 "Jump to Buffer".to_string(),
1570 Some(Box::new(crate::OpenExcerpts)),
1571 tooltip_style.clone(),
1572 cx,
1573 )
1574 .aligned()
1575 .flex_float()
1576 });
1577
1578 if *starts_new_buffer {
1579 let editor_font_size = style.text.font_size;
1580 let style = &style.diagnostic_path_header;
1581 let font_size = (style.text_scale_factor * editor_font_size).round();
1582
1583 let path = buffer.resolve_file_path(cx, include_root);
1584 let mut filename = None;
1585 let mut parent_path = None;
1586 // Can't use .and_then() because `.file_name()` and `.parent()` return references :(
1587 if let Some(path) = path {
1588 filename = path.file_name().map(|f| f.to_string_lossy().to_string());
1589 parent_path =
1590 path.parent().map(|p| p.to_string_lossy().to_string() + "/");
1591 }
1592
1593 Flex::row()
1594 .with_child(
1595 Label::new(
1596 filename.unwrap_or_else(|| "untitled".to_string()),
1597 style.filename.text.clone().with_font_size(font_size),
1598 )
1599 .contained()
1600 .with_style(style.filename.container)
1601 .aligned(),
1602 )
1603 .with_children(parent_path.map(|path| {
1604 Label::new(path, style.path.text.clone().with_font_size(font_size))
1605 .contained()
1606 .with_style(style.path.container)
1607 .aligned()
1608 }))
1609 .with_children(jump_icon)
1610 .contained()
1611 .with_style(style.container)
1612 .with_padding_left(gutter_padding)
1613 .with_padding_right(gutter_padding)
1614 .expanded()
1615 .into_any_named("path header block")
1616 } else {
1617 let text_style = style.text.clone();
1618 Flex::row()
1619 .with_child(Label::new("⋯", text_style))
1620 .with_children(jump_icon)
1621 .contained()
1622 .with_padding_left(gutter_padding)
1623 .with_padding_right(gutter_padding)
1624 .expanded()
1625 .into_any_named("collapsed context")
1626 }
1627 }
1628 };
1629
1630 element.layout(
1631 SizeConstraint {
1632 min: Vector2F::zero(),
1633 max: vec2f(width, block.height() as f32 * line_height),
1634 },
1635 editor,
1636 cx,
1637 );
1638 element
1639 };
1640
1641 let mut fixed_block_max_width = 0f32;
1642 let mut blocks = Vec::new();
1643 for (row, block) in fixed_blocks {
1644 let element = render_block(block, f32::INFINITY, block_id);
1645 block_id += 1;
1646 fixed_block_max_width = fixed_block_max_width.max(element.size().x() + em_width);
1647 blocks.push(BlockLayout {
1648 row,
1649 element,
1650 style: BlockStyle::Fixed,
1651 });
1652 }
1653 for (row, block) in non_fixed_blocks {
1654 let style = match block {
1655 TransformBlock::Custom(block) => block.style(),
1656 TransformBlock::ExcerptHeader { .. } => BlockStyle::Sticky,
1657 };
1658 let width = match style {
1659 BlockStyle::Sticky => editor_width,
1660 BlockStyle::Flex => editor_width
1661 .max(fixed_block_max_width)
1662 .max(gutter_width + scroll_width),
1663 BlockStyle::Fixed => unreachable!(),
1664 };
1665 let element = render_block(block, width, block_id);
1666 block_id += 1;
1667 blocks.push(BlockLayout {
1668 row,
1669 element,
1670 style,
1671 });
1672 }
1673 (
1674 scroll_width.max(fixed_block_max_width - gutter_width),
1675 blocks,
1676 )
1677 }
1678}
1679
1680struct HighlightedChunk<'a> {
1681 chunk: &'a str,
1682 style: Option<HighlightStyle>,
1683 is_tab: bool,
1684}
1685
1686#[derive(Debug)]
1687pub struct LineWithInvisibles {
1688 pub line: Line,
1689 invisibles: Vec<Invisible>,
1690}
1691
1692impl LineWithInvisibles {
1693 fn from_chunks<'a>(
1694 chunks: impl Iterator<Item = HighlightedChunk<'a>>,
1695 text_style: &TextStyle,
1696 text_layout_cache: &TextLayoutCache,
1697 font_cache: &Arc<FontCache>,
1698 max_line_len: usize,
1699 max_line_count: usize,
1700 line_number_layouts: &[Option<Line>],
1701 editor_mode: EditorMode,
1702 ) -> Vec<Self> {
1703 let mut layouts = Vec::with_capacity(max_line_count);
1704 let mut line = String::new();
1705 let mut invisibles = Vec::new();
1706 let mut styles = Vec::new();
1707 let mut non_whitespace_added = false;
1708 let mut row = 0;
1709 let mut line_exceeded_max_len = false;
1710 for highlighted_chunk in chunks.chain([HighlightedChunk {
1711 chunk: "\n",
1712 style: None,
1713 is_tab: false,
1714 }]) {
1715 for (ix, mut line_chunk) in highlighted_chunk.chunk.split('\n').enumerate() {
1716 if ix > 0 {
1717 layouts.push(Self {
1718 line: text_layout_cache.layout_str(&line, text_style.font_size, &styles),
1719 invisibles: invisibles.drain(..).collect(),
1720 });
1721
1722 line.clear();
1723 styles.clear();
1724 row += 1;
1725 line_exceeded_max_len = false;
1726 non_whitespace_added = false;
1727 if row == max_line_count {
1728 return layouts;
1729 }
1730 }
1731
1732 if !line_chunk.is_empty() && !line_exceeded_max_len {
1733 let text_style = if let Some(style) = highlighted_chunk.style {
1734 text_style
1735 .clone()
1736 .highlight(style, font_cache)
1737 .map(Cow::Owned)
1738 .unwrap_or_else(|_| Cow::Borrowed(text_style))
1739 } else {
1740 Cow::Borrowed(text_style)
1741 };
1742
1743 if line.len() + line_chunk.len() > max_line_len {
1744 let mut chunk_len = max_line_len - line.len();
1745 while !line_chunk.is_char_boundary(chunk_len) {
1746 chunk_len -= 1;
1747 }
1748 line_chunk = &line_chunk[..chunk_len];
1749 line_exceeded_max_len = true;
1750 }
1751
1752 styles.push((
1753 line_chunk.len(),
1754 RunStyle {
1755 font_id: text_style.font_id,
1756 color: text_style.color,
1757 underline: text_style.underline,
1758 },
1759 ));
1760
1761 if editor_mode == EditorMode::Full {
1762 // Line wrap pads its contents with fake whitespaces,
1763 // avoid printing them
1764 let inside_wrapped_string = line_number_layouts
1765 .get(row)
1766 .and_then(|layout| layout.as_ref())
1767 .is_none();
1768 if highlighted_chunk.is_tab {
1769 if non_whitespace_added || !inside_wrapped_string {
1770 invisibles.push(Invisible::Tab {
1771 line_start_offset: line.len(),
1772 });
1773 }
1774 } else {
1775 invisibles.extend(
1776 line_chunk
1777 .chars()
1778 .enumerate()
1779 .filter(|(_, line_char)| {
1780 let is_whitespace = line_char.is_whitespace();
1781 non_whitespace_added |= !is_whitespace;
1782 is_whitespace
1783 && (non_whitespace_added || !inside_wrapped_string)
1784 })
1785 .map(|(whitespace_index, _)| Invisible::Whitespace {
1786 line_offset: line.len() + whitespace_index,
1787 }),
1788 )
1789 }
1790 }
1791
1792 line.push_str(line_chunk);
1793 }
1794 }
1795 }
1796
1797 layouts
1798 }
1799
1800 fn draw(
1801 &self,
1802 layout: &LayoutState,
1803 row: u32,
1804 scroll_top: f32,
1805 scene: &mut SceneBuilder,
1806 content_origin: Vector2F,
1807 scroll_left: f32,
1808 visible_text_bounds: RectF,
1809 whitespace_setting: ShowWhitespaceSetting,
1810 selection_ranges: &[Range<DisplayPoint>],
1811 visible_bounds: RectF,
1812 cx: &mut ViewContext<Editor>,
1813 ) {
1814 let line_height = layout.position_map.line_height;
1815 let line_y = row as f32 * line_height - scroll_top;
1816
1817 self.line.paint(
1818 scene,
1819 content_origin + vec2f(-scroll_left, line_y),
1820 visible_text_bounds,
1821 line_height,
1822 cx,
1823 );
1824
1825 self.draw_invisibles(
1826 &selection_ranges,
1827 layout,
1828 content_origin,
1829 scroll_left,
1830 line_y,
1831 row,
1832 scene,
1833 visible_bounds,
1834 line_height,
1835 whitespace_setting,
1836 cx,
1837 );
1838 }
1839
1840 fn draw_invisibles(
1841 &self,
1842 selection_ranges: &[Range<DisplayPoint>],
1843 layout: &LayoutState,
1844 content_origin: Vector2F,
1845 scroll_left: f32,
1846 line_y: f32,
1847 row: u32,
1848 scene: &mut SceneBuilder,
1849 visible_bounds: RectF,
1850 line_height: f32,
1851 whitespace_setting: ShowWhitespaceSetting,
1852 cx: &mut ViewContext<Editor>,
1853 ) {
1854 let allowed_invisibles_regions = match whitespace_setting {
1855 ShowWhitespaceSetting::None => return,
1856 ShowWhitespaceSetting::Selection => Some(selection_ranges),
1857 ShowWhitespaceSetting::All => None,
1858 };
1859
1860 for invisible in &self.invisibles {
1861 let (&token_offset, invisible_symbol) = match invisible {
1862 Invisible::Tab { line_start_offset } => (line_start_offset, &layout.tab_invisible),
1863 Invisible::Whitespace { line_offset } => (line_offset, &layout.space_invisible),
1864 };
1865
1866 let x_offset = self.line.x_for_index(token_offset);
1867 let invisible_offset =
1868 (layout.position_map.em_width - invisible_symbol.width()).max(0.0) / 2.0;
1869 let origin = content_origin + vec2f(-scroll_left + x_offset + invisible_offset, line_y);
1870
1871 if let Some(allowed_regions) = allowed_invisibles_regions {
1872 let invisible_point = DisplayPoint::new(row, token_offset as u32);
1873 if !allowed_regions
1874 .iter()
1875 .any(|region| region.start <= invisible_point && invisible_point < region.end)
1876 {
1877 continue;
1878 }
1879 }
1880 invisible_symbol.paint(scene, origin, visible_bounds, line_height, cx);
1881 }
1882 }
1883}
1884
1885#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1886enum Invisible {
1887 Tab { line_start_offset: usize },
1888 Whitespace { line_offset: usize },
1889}
1890
1891impl Element<Editor> for EditorElement {
1892 type LayoutState = LayoutState;
1893 type PaintState = ();
1894
1895 fn layout(
1896 &mut self,
1897 constraint: SizeConstraint,
1898 editor: &mut Editor,
1899 cx: &mut LayoutContext<Editor>,
1900 ) -> (Vector2F, Self::LayoutState) {
1901 let mut size = constraint.max;
1902 if size.x().is_infinite() {
1903 unimplemented!("we don't yet handle an infinite width constraint on buffer elements");
1904 }
1905
1906 let snapshot = editor.snapshot(cx);
1907 let style = self.style.clone();
1908 let line_height = style.text.line_height(cx.font_cache());
1909
1910 let gutter_padding;
1911 let gutter_width;
1912 let gutter_margin;
1913 if snapshot.show_gutter {
1914 let em_width = style.text.em_width(cx.font_cache());
1915 gutter_padding = (em_width * style.gutter_padding_factor).round();
1916 gutter_width = self.max_line_number_width(&snapshot, cx) + gutter_padding * 2.0;
1917 gutter_margin = -style.text.descent(cx.font_cache());
1918 } else {
1919 gutter_padding = 0.0;
1920 gutter_width = 0.0;
1921 gutter_margin = 0.0;
1922 };
1923
1924 let text_width = size.x() - gutter_width;
1925 let em_width = style.text.em_width(cx.font_cache());
1926 let em_advance = style.text.em_advance(cx.font_cache());
1927 let overscroll = vec2f(em_width, 0.);
1928 let snapshot = {
1929 editor.set_visible_line_count(size.y() / line_height, cx);
1930
1931 let editor_width = text_width - gutter_margin - overscroll.x() - em_width;
1932 let wrap_width = match editor.soft_wrap_mode(cx) {
1933 SoftWrap::None => (MAX_LINE_LEN / 2) as f32 * em_advance,
1934 SoftWrap::EditorWidth => editor_width,
1935 SoftWrap::Column(column) => editor_width.min(column as f32 * em_advance),
1936 };
1937
1938 if editor.set_wrap_width(Some(wrap_width), cx) {
1939 editor.snapshot(cx)
1940 } else {
1941 snapshot
1942 }
1943 };
1944
1945 let scroll_height = (snapshot.max_point().row() + 1) as f32 * line_height;
1946 if let EditorMode::AutoHeight { max_lines } = snapshot.mode {
1947 size.set_y(
1948 scroll_height
1949 .min(constraint.max_along(Axis::Vertical))
1950 .max(constraint.min_along(Axis::Vertical))
1951 .min(line_height * max_lines as f32),
1952 )
1953 } else if let EditorMode::SingleLine = snapshot.mode {
1954 size.set_y(
1955 line_height
1956 .min(constraint.max_along(Axis::Vertical))
1957 .max(constraint.min_along(Axis::Vertical)),
1958 )
1959 } else if size.y().is_infinite() {
1960 size.set_y(scroll_height);
1961 }
1962 let gutter_size = vec2f(gutter_width, size.y());
1963 let text_size = vec2f(text_width, size.y());
1964
1965 let autoscroll_horizontally = editor.autoscroll_vertically(size.y(), line_height, cx);
1966 let mut snapshot = editor.snapshot(cx);
1967
1968 let scroll_position = snapshot.scroll_position();
1969 // The scroll position is a fractional point, the whole number of which represents
1970 // the top of the window in terms of display rows.
1971 let start_row = scroll_position.y() as u32;
1972 let height_in_lines = size.y() / line_height;
1973 let max_row = snapshot.max_point().row();
1974
1975 // Add 1 to ensure selections bleed off screen
1976 let end_row = 1 + cmp::min(
1977 (scroll_position.y() + height_in_lines).ceil() as u32,
1978 max_row,
1979 );
1980
1981 let start_anchor = if start_row == 0 {
1982 Anchor::min()
1983 } else {
1984 snapshot
1985 .buffer_snapshot
1986 .anchor_before(DisplayPoint::new(start_row, 0).to_offset(&snapshot, Bias::Left))
1987 };
1988 let end_anchor = if end_row > max_row {
1989 Anchor::max()
1990 } else {
1991 snapshot
1992 .buffer_snapshot
1993 .anchor_before(DisplayPoint::new(end_row, 0).to_offset(&snapshot, Bias::Right))
1994 };
1995
1996 let mut selections: Vec<(ReplicaId, Vec<SelectionLayout>)> = Vec::new();
1997 let mut active_rows = BTreeMap::new();
1998 let mut fold_ranges = Vec::new();
1999 let is_singleton = editor.is_singleton(cx);
2000
2001 let highlighted_rows = editor.highlighted_rows();
2002 let theme = theme::current(cx);
2003 let highlighted_ranges = editor.background_highlights_in_range(
2004 start_anchor..end_anchor,
2005 &snapshot.display_snapshot,
2006 theme.as_ref(),
2007 );
2008
2009 fold_ranges.extend(
2010 snapshot
2011 .folds_in_range(start_anchor..end_anchor)
2012 .map(|anchor| {
2013 let start = anchor.start.to_point(&snapshot.buffer_snapshot);
2014 (
2015 start.row,
2016 start.to_display_point(&snapshot.display_snapshot)
2017 ..anchor.end.to_display_point(&snapshot),
2018 )
2019 }),
2020 );
2021
2022 let mut remote_selections = HashMap::default();
2023 for (replica_id, line_mode, cursor_shape, selection) in snapshot
2024 .buffer_snapshot
2025 .remote_selections_in_range(&(start_anchor..end_anchor))
2026 {
2027 // The local selections match the leader's selections.
2028 if Some(replica_id) == editor.leader_replica_id {
2029 continue;
2030 }
2031 remote_selections
2032 .entry(replica_id)
2033 .or_insert(Vec::new())
2034 .push(SelectionLayout::new(
2035 selection,
2036 line_mode,
2037 cursor_shape,
2038 &snapshot.display_snapshot,
2039 ));
2040 }
2041 selections.extend(remote_selections);
2042
2043 if editor.show_local_selections {
2044 let mut local_selections = editor
2045 .selections
2046 .disjoint_in_range(start_anchor..end_anchor, cx);
2047 local_selections.extend(editor.selections.pending(cx));
2048 for selection in &local_selections {
2049 let is_empty = selection.start == selection.end;
2050 let selection_start = snapshot.prev_line_boundary(selection.start).1;
2051 let selection_end = snapshot.next_line_boundary(selection.end).1;
2052 for row in cmp::max(selection_start.row(), start_row)
2053 ..=cmp::min(selection_end.row(), end_row)
2054 {
2055 let contains_non_empty_selection = active_rows.entry(row).or_insert(!is_empty);
2056 *contains_non_empty_selection |= !is_empty;
2057 }
2058 }
2059
2060 // Render the local selections in the leader's color when following.
2061 let local_replica_id = editor
2062 .leader_replica_id
2063 .unwrap_or_else(|| editor.replica_id(cx));
2064
2065 selections.push((
2066 local_replica_id,
2067 local_selections
2068 .into_iter()
2069 .map(|selection| {
2070 SelectionLayout::new(
2071 selection,
2072 editor.selections.line_mode,
2073 editor.cursor_shape,
2074 &snapshot.display_snapshot,
2075 )
2076 })
2077 .collect(),
2078 ));
2079 }
2080
2081 let scrollbar_settings = &settings::get::<EditorSettings>(cx).scrollbar;
2082 let show_scrollbars = match scrollbar_settings.show {
2083 ShowScrollbar::Auto => {
2084 // Git
2085 (is_singleton && scrollbar_settings.git_diff && snapshot.buffer_snapshot.has_git_diffs())
2086 // Scrollmanager
2087 || editor.scroll_manager.scrollbars_visible()
2088 }
2089 ShowScrollbar::System => editor.scroll_manager.scrollbars_visible(),
2090 ShowScrollbar::Always => true,
2091 ShowScrollbar::Never => false,
2092 };
2093
2094 let fold_ranges: Vec<(BufferRow, Range<DisplayPoint>, Color)> = fold_ranges
2095 .into_iter()
2096 .map(|(id, fold)| {
2097 let color = self
2098 .style
2099 .folds
2100 .ellipses
2101 .background
2102 .style_for(&mut cx.mouse_state::<FoldMarkers>(id as usize))
2103 .color;
2104
2105 (id, fold, color)
2106 })
2107 .collect();
2108
2109 let (line_number_layouts, fold_statuses) = self.layout_line_numbers(
2110 start_row..end_row,
2111 &active_rows,
2112 is_singleton,
2113 &snapshot,
2114 cx,
2115 );
2116
2117 let display_hunks = self.layout_git_gutters(start_row..end_row, &snapshot);
2118
2119 let scrollbar_row_range = scroll_position.y()..(scroll_position.y() + height_in_lines);
2120
2121 let mut max_visible_line_width = 0.0;
2122 let line_layouts =
2123 self.layout_lines(start_row..end_row, &line_number_layouts, &snapshot, cx);
2124 for line_with_invisibles in &line_layouts {
2125 if line_with_invisibles.line.width() > max_visible_line_width {
2126 max_visible_line_width = line_with_invisibles.line.width();
2127 }
2128 }
2129
2130 let style = self.style.clone();
2131 let longest_line_width = layout_line(
2132 snapshot.longest_row(),
2133 &snapshot,
2134 &style,
2135 cx.text_layout_cache(),
2136 )
2137 .width();
2138 let scroll_width = longest_line_width.max(max_visible_line_width) + overscroll.x();
2139 let em_width = style.text.em_width(cx.font_cache());
2140 let (scroll_width, blocks) = self.layout_blocks(
2141 start_row..end_row,
2142 &snapshot,
2143 size.x(),
2144 scroll_width,
2145 gutter_padding,
2146 gutter_width,
2147 em_width,
2148 gutter_width + gutter_margin,
2149 line_height,
2150 &style,
2151 &line_layouts,
2152 editor,
2153 cx,
2154 );
2155
2156 let scroll_max = vec2f(
2157 ((scroll_width - text_size.x()) / em_width).max(0.0),
2158 max_row as f32,
2159 );
2160
2161 let clamped = editor.scroll_manager.clamp_scroll_left(scroll_max.x());
2162
2163 let autoscrolled = if autoscroll_horizontally {
2164 editor.autoscroll_horizontally(
2165 start_row,
2166 text_size.x(),
2167 scroll_width,
2168 em_width,
2169 &line_layouts,
2170 cx,
2171 )
2172 } else {
2173 false
2174 };
2175
2176 if clamped || autoscrolled {
2177 snapshot = editor.snapshot(cx);
2178 }
2179
2180 let newest_selection_head = editor
2181 .selections
2182 .newest::<usize>(cx)
2183 .head()
2184 .to_display_point(&snapshot);
2185 let style = editor.style(cx);
2186
2187 let mut context_menu = None;
2188 let mut code_actions_indicator = None;
2189 if (start_row..end_row).contains(&newest_selection_head.row()) {
2190 if editor.context_menu_visible() {
2191 context_menu = editor.render_context_menu(newest_selection_head, style.clone(), cx);
2192 }
2193
2194 let active = matches!(
2195 editor.context_menu,
2196 Some(crate::ContextMenu::CodeActions(_))
2197 );
2198
2199 code_actions_indicator = editor
2200 .render_code_actions_indicator(&style, active, cx)
2201 .map(|indicator| (newest_selection_head.row(), indicator));
2202 }
2203
2204 let visible_rows = start_row..start_row + line_layouts.len() as u32;
2205 let mut hover = editor
2206 .hover_state
2207 .render(&snapshot, &style, visible_rows, cx);
2208 let mode = editor.mode;
2209
2210 let mut fold_indicators = editor.render_fold_indicators(
2211 fold_statuses,
2212 &style,
2213 editor.gutter_hovered,
2214 line_height,
2215 gutter_margin,
2216 cx,
2217 );
2218
2219 if let Some((_, context_menu)) = context_menu.as_mut() {
2220 context_menu.layout(
2221 SizeConstraint {
2222 min: Vector2F::zero(),
2223 max: vec2f(
2224 cx.window_size().x() * 0.7,
2225 (12. * line_height).min((size.y() - line_height) / 2.),
2226 ),
2227 },
2228 editor,
2229 cx,
2230 );
2231 }
2232
2233 if let Some((_, indicator)) = code_actions_indicator.as_mut() {
2234 indicator.layout(
2235 SizeConstraint::strict_along(
2236 Axis::Vertical,
2237 line_height * style.code_actions.vertical_scale,
2238 ),
2239 editor,
2240 cx,
2241 );
2242 }
2243
2244 for fold_indicator in fold_indicators.iter_mut() {
2245 if let Some(indicator) = fold_indicator.as_mut() {
2246 indicator.layout(
2247 SizeConstraint::strict_along(
2248 Axis::Vertical,
2249 line_height * style.code_actions.vertical_scale,
2250 ),
2251 editor,
2252 cx,
2253 );
2254 }
2255 }
2256
2257 if let Some((_, hover_popovers)) = hover.as_mut() {
2258 for hover_popover in hover_popovers.iter_mut() {
2259 hover_popover.layout(
2260 SizeConstraint {
2261 min: Vector2F::zero(),
2262 max: vec2f(
2263 (120. * em_width) // Default size
2264 .min(size.x() / 2.) // Shrink to half of the editor width
2265 .max(MIN_POPOVER_CHARACTER_WIDTH * em_width), // Apply minimum width of 20 characters
2266 (16. * line_height) // Default size
2267 .min(size.y() / 2.) // Shrink to half of the editor height
2268 .max(MIN_POPOVER_LINE_HEIGHT * line_height), // Apply minimum height of 4 lines
2269 ),
2270 },
2271 editor,
2272 cx,
2273 );
2274 }
2275 }
2276
2277 let invisible_symbol_font_size = self.style.text.font_size / 2.0;
2278 let invisible_symbol_style = RunStyle {
2279 color: self.style.whitespace,
2280 font_id: self.style.text.font_id,
2281 underline: Default::default(),
2282 };
2283
2284 (
2285 size,
2286 LayoutState {
2287 mode,
2288 position_map: Arc::new(PositionMap {
2289 size,
2290 scroll_max,
2291 line_layouts,
2292 line_height,
2293 em_width,
2294 em_advance,
2295 snapshot,
2296 }),
2297 visible_display_row_range: start_row..end_row,
2298 gutter_size,
2299 gutter_padding,
2300 text_size,
2301 scrollbar_row_range,
2302 show_scrollbars,
2303 is_singleton,
2304 max_row,
2305 gutter_margin,
2306 active_rows,
2307 highlighted_rows,
2308 highlighted_ranges,
2309 fold_ranges,
2310 line_number_layouts,
2311 display_hunks,
2312 blocks,
2313 selections,
2314 context_menu,
2315 code_actions_indicator,
2316 fold_indicators,
2317 tab_invisible: cx.text_layout_cache().layout_str(
2318 "→",
2319 invisible_symbol_font_size,
2320 &[("→".len(), invisible_symbol_style)],
2321 ),
2322 space_invisible: cx.text_layout_cache().layout_str(
2323 "•",
2324 invisible_symbol_font_size,
2325 &[("•".len(), invisible_symbol_style)],
2326 ),
2327 hover_popovers: hover,
2328 },
2329 )
2330 }
2331
2332 fn paint(
2333 &mut self,
2334 scene: &mut SceneBuilder,
2335 bounds: RectF,
2336 visible_bounds: RectF,
2337 layout: &mut Self::LayoutState,
2338 editor: &mut Editor,
2339 cx: &mut ViewContext<Editor>,
2340 ) -> Self::PaintState {
2341 let visible_bounds = bounds.intersection(visible_bounds).unwrap_or_default();
2342 scene.push_layer(Some(visible_bounds));
2343
2344 let gutter_bounds = RectF::new(bounds.origin(), layout.gutter_size);
2345 let text_bounds = RectF::new(
2346 bounds.origin() + vec2f(layout.gutter_size.x(), 0.0),
2347 layout.text_size,
2348 );
2349
2350 Self::attach_mouse_handlers(
2351 scene,
2352 &layout.position_map,
2353 layout.hover_popovers.is_some(),
2354 visible_bounds,
2355 text_bounds,
2356 gutter_bounds,
2357 bounds,
2358 cx,
2359 );
2360
2361 self.paint_background(scene, gutter_bounds, text_bounds, layout);
2362 if layout.gutter_size.x() > 0. {
2363 self.paint_gutter(scene, gutter_bounds, visible_bounds, layout, editor, cx);
2364 }
2365 self.paint_text(scene, text_bounds, visible_bounds, layout, editor, cx);
2366
2367 scene.push_layer(Some(bounds));
2368 if !layout.blocks.is_empty() {
2369 self.paint_blocks(scene, bounds, visible_bounds, layout, editor, cx);
2370 }
2371 self.paint_scrollbar(scene, bounds, layout, cx);
2372 scene.pop_layer();
2373
2374 scene.pop_layer();
2375 }
2376
2377 fn rect_for_text_range(
2378 &self,
2379 range_utf16: Range<usize>,
2380 bounds: RectF,
2381 _: RectF,
2382 layout: &Self::LayoutState,
2383 _: &Self::PaintState,
2384 _: &Editor,
2385 _: &ViewContext<Editor>,
2386 ) -> Option<RectF> {
2387 let text_bounds = RectF::new(
2388 bounds.origin() + vec2f(layout.gutter_size.x(), 0.0),
2389 layout.text_size,
2390 );
2391 let content_origin = text_bounds.origin() + vec2f(layout.gutter_margin, 0.);
2392 let scroll_position = layout.position_map.snapshot.scroll_position();
2393 let start_row = scroll_position.y() as u32;
2394 let scroll_top = scroll_position.y() * layout.position_map.line_height;
2395 let scroll_left = scroll_position.x() * layout.position_map.em_width;
2396
2397 let range_start = OffsetUtf16(range_utf16.start)
2398 .to_display_point(&layout.position_map.snapshot.display_snapshot);
2399 if range_start.row() < start_row {
2400 return None;
2401 }
2402
2403 let line = &layout
2404 .position_map
2405 .line_layouts
2406 .get((range_start.row() - start_row) as usize)?
2407 .line;
2408 let range_start_x = line.x_for_index(range_start.column() as usize);
2409 let range_start_y = range_start.row() as f32 * layout.position_map.line_height;
2410 Some(RectF::new(
2411 content_origin
2412 + vec2f(
2413 range_start_x,
2414 range_start_y + layout.position_map.line_height,
2415 )
2416 - vec2f(scroll_left, scroll_top),
2417 vec2f(
2418 layout.position_map.em_width,
2419 layout.position_map.line_height,
2420 ),
2421 ))
2422 }
2423
2424 fn debug(
2425 &self,
2426 bounds: RectF,
2427 _: &Self::LayoutState,
2428 _: &Self::PaintState,
2429 _: &Editor,
2430 _: &ViewContext<Editor>,
2431 ) -> json::Value {
2432 json!({
2433 "type": "BufferElement",
2434 "bounds": bounds.to_json()
2435 })
2436 }
2437}
2438
2439type BufferRow = u32;
2440
2441pub struct LayoutState {
2442 position_map: Arc<PositionMap>,
2443 gutter_size: Vector2F,
2444 gutter_padding: f32,
2445 gutter_margin: f32,
2446 text_size: Vector2F,
2447 mode: EditorMode,
2448 visible_display_row_range: Range<u32>,
2449 active_rows: BTreeMap<u32, bool>,
2450 highlighted_rows: Option<Range<u32>>,
2451 line_number_layouts: Vec<Option<text_layout::Line>>,
2452 display_hunks: Vec<DisplayDiffHunk>,
2453 blocks: Vec<BlockLayout>,
2454 highlighted_ranges: Vec<(Range<DisplayPoint>, Color)>,
2455 fold_ranges: Vec<(BufferRow, Range<DisplayPoint>, Color)>,
2456 selections: Vec<(ReplicaId, Vec<SelectionLayout>)>,
2457 scrollbar_row_range: Range<f32>,
2458 show_scrollbars: bool,
2459 is_singleton: bool,
2460 max_row: u32,
2461 context_menu: Option<(DisplayPoint, AnyElement<Editor>)>,
2462 code_actions_indicator: Option<(u32, AnyElement<Editor>)>,
2463 hover_popovers: Option<(DisplayPoint, Vec<AnyElement<Editor>>)>,
2464 fold_indicators: Vec<Option<AnyElement<Editor>>>,
2465 tab_invisible: Line,
2466 space_invisible: Line,
2467}
2468
2469struct PositionMap {
2470 size: Vector2F,
2471 line_height: f32,
2472 scroll_max: Vector2F,
2473 em_width: f32,
2474 em_advance: f32,
2475 line_layouts: Vec<LineWithInvisibles>,
2476 snapshot: EditorSnapshot,
2477}
2478
2479impl PositionMap {
2480 /// Returns two display points:
2481 /// 1. The nearest *valid* position in the editor
2482 /// 2. An unclipped, potentially *invalid* position that maps directly to
2483 /// the given pixel position.
2484 fn point_for_position(
2485 &self,
2486 text_bounds: RectF,
2487 position: Vector2F,
2488 ) -> (DisplayPoint, DisplayPoint) {
2489 let scroll_position = self.snapshot.scroll_position();
2490 let position = position - text_bounds.origin();
2491 let y = position.y().max(0.0).min(self.size.y());
2492 let x = position.x() + (scroll_position.x() * self.em_width);
2493 let row = (y / self.line_height + scroll_position.y()) as u32;
2494 let (column, x_overshoot) = if let Some(line) = self
2495 .line_layouts
2496 .get(row as usize - scroll_position.y() as usize)
2497 .map(|line_with_spaces| &line_with_spaces.line)
2498 {
2499 if let Some(ix) = line.index_for_x(x) {
2500 (ix as u32, 0.0)
2501 } else {
2502 (line.len() as u32, 0f32.max(x - line.width()))
2503 }
2504 } else {
2505 (0, x)
2506 };
2507
2508 let mut target_point = DisplayPoint::new(row, column);
2509 let point = self.snapshot.clip_point(target_point, Bias::Left);
2510 *target_point.column_mut() += (x_overshoot / self.em_advance) as u32;
2511
2512 (point, target_point)
2513 }
2514}
2515
2516struct BlockLayout {
2517 row: u32,
2518 element: AnyElement<Editor>,
2519 style: BlockStyle,
2520}
2521
2522fn layout_line(
2523 row: u32,
2524 snapshot: &EditorSnapshot,
2525 style: &EditorStyle,
2526 layout_cache: &TextLayoutCache,
2527) -> text_layout::Line {
2528 let mut line = snapshot.line(row);
2529
2530 if line.len() > MAX_LINE_LEN {
2531 let mut len = MAX_LINE_LEN;
2532 while !line.is_char_boundary(len) {
2533 len -= 1;
2534 }
2535
2536 line.truncate(len);
2537 }
2538
2539 layout_cache.layout_str(
2540 &line,
2541 style.text.font_size,
2542 &[(
2543 snapshot.line_len(row) as usize,
2544 RunStyle {
2545 font_id: style.text.font_id,
2546 color: Color::black(),
2547 underline: Default::default(),
2548 },
2549 )],
2550 )
2551}
2552
2553#[derive(Debug)]
2554pub struct Cursor {
2555 origin: Vector2F,
2556 block_width: f32,
2557 line_height: f32,
2558 color: Color,
2559 shape: CursorShape,
2560 block_text: Option<Line>,
2561}
2562
2563impl Cursor {
2564 pub fn new(
2565 origin: Vector2F,
2566 block_width: f32,
2567 line_height: f32,
2568 color: Color,
2569 shape: CursorShape,
2570 block_text: Option<Line>,
2571 ) -> Cursor {
2572 Cursor {
2573 origin,
2574 block_width,
2575 line_height,
2576 color,
2577 shape,
2578 block_text,
2579 }
2580 }
2581
2582 pub fn bounding_rect(&self, origin: Vector2F) -> RectF {
2583 RectF::new(
2584 self.origin + origin,
2585 vec2f(self.block_width, self.line_height),
2586 )
2587 }
2588
2589 pub fn paint(&self, scene: &mut SceneBuilder, origin: Vector2F, cx: &mut WindowContext) {
2590 let bounds = match self.shape {
2591 CursorShape::Bar => RectF::new(self.origin + origin, vec2f(2.0, self.line_height)),
2592 CursorShape::Block | CursorShape::Hollow => RectF::new(
2593 self.origin + origin,
2594 vec2f(self.block_width, self.line_height),
2595 ),
2596 CursorShape::Underscore => RectF::new(
2597 self.origin + origin + Vector2F::new(0.0, self.line_height - 2.0),
2598 vec2f(self.block_width, 2.0),
2599 ),
2600 };
2601
2602 //Draw background or border quad
2603 if matches!(self.shape, CursorShape::Hollow) {
2604 scene.push_quad(Quad {
2605 bounds,
2606 background: None,
2607 border: Border::all(1., self.color),
2608 corner_radius: 0.,
2609 });
2610 } else {
2611 scene.push_quad(Quad {
2612 bounds,
2613 background: Some(self.color),
2614 border: Default::default(),
2615 corner_radius: 0.,
2616 });
2617 }
2618
2619 if let Some(block_text) = &self.block_text {
2620 block_text.paint(scene, self.origin + origin, bounds, self.line_height, cx);
2621 }
2622 }
2623
2624 pub fn shape(&self) -> CursorShape {
2625 self.shape
2626 }
2627}
2628
2629#[derive(Debug)]
2630pub struct HighlightedRange {
2631 pub start_y: f32,
2632 pub line_height: f32,
2633 pub lines: Vec<HighlightedRangeLine>,
2634 pub color: Color,
2635 pub corner_radius: f32,
2636}
2637
2638#[derive(Debug)]
2639pub struct HighlightedRangeLine {
2640 pub start_x: f32,
2641 pub end_x: f32,
2642}
2643
2644impl HighlightedRange {
2645 pub fn paint(&self, bounds: RectF, scene: &mut SceneBuilder) {
2646 if self.lines.len() >= 2 && self.lines[0].start_x > self.lines[1].end_x {
2647 self.paint_lines(self.start_y, &self.lines[0..1], bounds, scene);
2648 self.paint_lines(
2649 self.start_y + self.line_height,
2650 &self.lines[1..],
2651 bounds,
2652 scene,
2653 );
2654 } else {
2655 self.paint_lines(self.start_y, &self.lines, bounds, scene);
2656 }
2657 }
2658
2659 fn paint_lines(
2660 &self,
2661 start_y: f32,
2662 lines: &[HighlightedRangeLine],
2663 bounds: RectF,
2664 scene: &mut SceneBuilder,
2665 ) {
2666 if lines.is_empty() {
2667 return;
2668 }
2669
2670 let mut path = PathBuilder::new();
2671 let first_line = lines.first().unwrap();
2672 let last_line = lines.last().unwrap();
2673
2674 let first_top_left = vec2f(first_line.start_x, start_y);
2675 let first_top_right = vec2f(first_line.end_x, start_y);
2676
2677 let curve_height = vec2f(0., self.corner_radius);
2678 let curve_width = |start_x: f32, end_x: f32| {
2679 let max = (end_x - start_x) / 2.;
2680 let width = if max < self.corner_radius {
2681 max
2682 } else {
2683 self.corner_radius
2684 };
2685
2686 vec2f(width, 0.)
2687 };
2688
2689 let top_curve_width = curve_width(first_line.start_x, first_line.end_x);
2690 path.reset(first_top_right - top_curve_width);
2691 path.curve_to(first_top_right + curve_height, first_top_right);
2692
2693 let mut iter = lines.iter().enumerate().peekable();
2694 while let Some((ix, line)) = iter.next() {
2695 let bottom_right = vec2f(line.end_x, start_y + (ix + 1) as f32 * self.line_height);
2696
2697 if let Some((_, next_line)) = iter.peek() {
2698 let next_top_right = vec2f(next_line.end_x, bottom_right.y());
2699
2700 match next_top_right.x().partial_cmp(&bottom_right.x()).unwrap() {
2701 Ordering::Equal => {
2702 path.line_to(bottom_right);
2703 }
2704 Ordering::Less => {
2705 let curve_width = curve_width(next_top_right.x(), bottom_right.x());
2706 path.line_to(bottom_right - curve_height);
2707 if self.corner_radius > 0. {
2708 path.curve_to(bottom_right - curve_width, bottom_right);
2709 }
2710 path.line_to(next_top_right + curve_width);
2711 if self.corner_radius > 0. {
2712 path.curve_to(next_top_right + curve_height, next_top_right);
2713 }
2714 }
2715 Ordering::Greater => {
2716 let curve_width = curve_width(bottom_right.x(), next_top_right.x());
2717 path.line_to(bottom_right - curve_height);
2718 if self.corner_radius > 0. {
2719 path.curve_to(bottom_right + curve_width, bottom_right);
2720 }
2721 path.line_to(next_top_right - curve_width);
2722 if self.corner_radius > 0. {
2723 path.curve_to(next_top_right + curve_height, next_top_right);
2724 }
2725 }
2726 }
2727 } else {
2728 let curve_width = curve_width(line.start_x, line.end_x);
2729 path.line_to(bottom_right - curve_height);
2730 if self.corner_radius > 0. {
2731 path.curve_to(bottom_right - curve_width, bottom_right);
2732 }
2733
2734 let bottom_left = vec2f(line.start_x, bottom_right.y());
2735 path.line_to(bottom_left + curve_width);
2736 if self.corner_radius > 0. {
2737 path.curve_to(bottom_left - curve_height, bottom_left);
2738 }
2739 }
2740 }
2741
2742 if first_line.start_x > last_line.start_x {
2743 let curve_width = curve_width(last_line.start_x, first_line.start_x);
2744 let second_top_left = vec2f(last_line.start_x, start_y + self.line_height);
2745 path.line_to(second_top_left + curve_height);
2746 if self.corner_radius > 0. {
2747 path.curve_to(second_top_left + curve_width, second_top_left);
2748 }
2749 let first_bottom_left = vec2f(first_line.start_x, second_top_left.y());
2750 path.line_to(first_bottom_left - curve_width);
2751 if self.corner_radius > 0. {
2752 path.curve_to(first_bottom_left - curve_height, first_bottom_left);
2753 }
2754 }
2755
2756 path.line_to(first_top_left + curve_height);
2757 if self.corner_radius > 0. {
2758 path.curve_to(first_top_left + top_curve_width, first_top_left);
2759 }
2760 path.line_to(first_top_right - top_curve_width);
2761
2762 scene.push_path(path.build(self.color, Some(bounds)));
2763 }
2764}
2765
2766fn position_to_display_point(
2767 position: Vector2F,
2768 text_bounds: RectF,
2769 position_map: &PositionMap,
2770) -> Option<DisplayPoint> {
2771 if text_bounds.contains_point(position) {
2772 let (point, target_point) = position_map.point_for_position(text_bounds, position);
2773 if point == target_point {
2774 Some(point)
2775 } else {
2776 None
2777 }
2778 } else {
2779 None
2780 }
2781}
2782
2783fn range_to_bounds(
2784 range: &Range<DisplayPoint>,
2785 content_origin: Vector2F,
2786 scroll_left: f32,
2787 scroll_top: f32,
2788 visible_row_range: &Range<u32>,
2789 line_end_overshoot: f32,
2790 position_map: &PositionMap,
2791) -> impl Iterator<Item = RectF> {
2792 let mut bounds: SmallVec<[RectF; 1]> = SmallVec::new();
2793
2794 if range.start == range.end {
2795 return bounds.into_iter();
2796 }
2797
2798 let start_row = visible_row_range.start;
2799 let end_row = visible_row_range.end;
2800
2801 let row_range = if range.end.column() == 0 {
2802 cmp::max(range.start.row(), start_row)..cmp::min(range.end.row(), end_row)
2803 } else {
2804 cmp::max(range.start.row(), start_row)..cmp::min(range.end.row() + 1, end_row)
2805 };
2806
2807 let first_y =
2808 content_origin.y() + row_range.start as f32 * position_map.line_height - scroll_top;
2809
2810 for (idx, row) in row_range.enumerate() {
2811 let line_layout = &position_map.line_layouts[(row - start_row) as usize].line;
2812
2813 let start_x = if row == range.start.row() {
2814 content_origin.x() + line_layout.x_for_index(range.start.column() as usize)
2815 - scroll_left
2816 } else {
2817 content_origin.x() - scroll_left
2818 };
2819
2820 let end_x = if row == range.end.row() {
2821 content_origin.x() + line_layout.x_for_index(range.end.column() as usize) - scroll_left
2822 } else {
2823 content_origin.x() + line_layout.width() + line_end_overshoot - scroll_left
2824 };
2825
2826 bounds.push(RectF::from_points(
2827 vec2f(start_x, first_y + position_map.line_height * idx as f32),
2828 vec2f(end_x, first_y + position_map.line_height * (idx + 1) as f32),
2829 ))
2830 }
2831
2832 bounds.into_iter()
2833}
2834
2835pub fn scale_vertical_mouse_autoscroll_delta(delta: f32) -> f32 {
2836 delta.powf(1.5) / 100.0
2837}
2838
2839fn scale_horizontal_mouse_autoscroll_delta(delta: f32) -> f32 {
2840 delta.powf(1.2) / 300.0
2841}
2842
2843#[cfg(test)]
2844mod tests {
2845 use super::*;
2846 use crate::{
2847 display_map::{BlockDisposition, BlockProperties},
2848 editor_tests::{init_test, update_test_settings},
2849 Editor, MultiBuffer,
2850 };
2851 use gpui::TestAppContext;
2852 use language::language_settings;
2853 use log::info;
2854 use std::{num::NonZeroU32, sync::Arc};
2855 use util::test::sample_text;
2856
2857 #[gpui::test]
2858 fn test_layout_line_numbers(cx: &mut TestAppContext) {
2859 init_test(cx, |_| {});
2860
2861 let (_, editor) = cx.add_window(|cx| {
2862 let buffer = MultiBuffer::build_simple(&sample_text(6, 6, 'a'), cx);
2863 Editor::new(EditorMode::Full, buffer, None, None, cx)
2864 });
2865 let element = EditorElement::new(editor.read_with(cx, |editor, cx| editor.style(cx)));
2866
2867 let layouts = editor.update(cx, |editor, cx| {
2868 let snapshot = editor.snapshot(cx);
2869 element
2870 .layout_line_numbers(0..6, &Default::default(), false, &snapshot, cx)
2871 .0
2872 });
2873 assert_eq!(layouts.len(), 6);
2874 }
2875
2876 #[gpui::test]
2877 fn test_layout_with_placeholder_text_and_blocks(cx: &mut TestAppContext) {
2878 init_test(cx, |_| {});
2879
2880 let (_, editor) = cx.add_window(|cx| {
2881 let buffer = MultiBuffer::build_simple("", cx);
2882 Editor::new(EditorMode::Full, buffer, None, None, cx)
2883 });
2884
2885 editor.update(cx, |editor, cx| {
2886 editor.set_placeholder_text("hello", cx);
2887 editor.insert_blocks(
2888 [BlockProperties {
2889 style: BlockStyle::Fixed,
2890 disposition: BlockDisposition::Above,
2891 height: 3,
2892 position: Anchor::min(),
2893 render: Arc::new(|_| Empty::new().into_any()),
2894 }],
2895 None,
2896 cx,
2897 );
2898
2899 // Blur the editor so that it displays placeholder text.
2900 cx.blur();
2901 });
2902
2903 let mut element = EditorElement::new(editor.read_with(cx, |editor, cx| editor.style(cx)));
2904 let (size, mut state) = editor.update(cx, |editor, cx| {
2905 let mut new_parents = Default::default();
2906 let mut notify_views_if_parents_change = Default::default();
2907 let mut layout_cx = LayoutContext::new(
2908 cx,
2909 &mut new_parents,
2910 &mut notify_views_if_parents_change,
2911 false,
2912 );
2913 element.layout(
2914 SizeConstraint::new(vec2f(500., 500.), vec2f(500., 500.)),
2915 editor,
2916 &mut layout_cx,
2917 )
2918 });
2919
2920 assert_eq!(state.position_map.line_layouts.len(), 4);
2921 assert_eq!(
2922 state
2923 .line_number_layouts
2924 .iter()
2925 .map(Option::is_some)
2926 .collect::<Vec<_>>(),
2927 &[false, false, false, true]
2928 );
2929
2930 // Don't panic.
2931 let mut scene = SceneBuilder::new(1.0);
2932 let bounds = RectF::new(Default::default(), size);
2933 editor.update(cx, |editor, cx| {
2934 element.paint(&mut scene, bounds, bounds, &mut state, editor, cx);
2935 });
2936 }
2937
2938 #[gpui::test]
2939 fn test_all_invisibles_drawing(cx: &mut TestAppContext) {
2940 const TAB_SIZE: u32 = 4;
2941
2942 let input_text = "\t \t|\t| a b";
2943 let expected_invisibles = vec![
2944 Invisible::Tab {
2945 line_start_offset: 0,
2946 },
2947 Invisible::Whitespace {
2948 line_offset: TAB_SIZE as usize,
2949 },
2950 Invisible::Tab {
2951 line_start_offset: TAB_SIZE as usize + 1,
2952 },
2953 Invisible::Tab {
2954 line_start_offset: TAB_SIZE as usize * 2 + 1,
2955 },
2956 Invisible::Whitespace {
2957 line_offset: TAB_SIZE as usize * 3 + 1,
2958 },
2959 Invisible::Whitespace {
2960 line_offset: TAB_SIZE as usize * 3 + 3,
2961 },
2962 ];
2963 assert_eq!(
2964 expected_invisibles.len(),
2965 input_text
2966 .chars()
2967 .filter(|initial_char| initial_char.is_whitespace())
2968 .count(),
2969 "Hardcoded expected invisibles differ from the actual ones in '{input_text}'"
2970 );
2971
2972 init_test(cx, |s| {
2973 s.defaults.show_whitespaces = Some(ShowWhitespaceSetting::All);
2974 s.defaults.tab_size = NonZeroU32::new(TAB_SIZE);
2975 });
2976
2977 let actual_invisibles =
2978 collect_invisibles_from_new_editor(cx, EditorMode::Full, &input_text, 500.0);
2979
2980 assert_eq!(expected_invisibles, actual_invisibles);
2981 }
2982
2983 #[gpui::test]
2984 fn test_invisibles_dont_appear_in_certain_editors(cx: &mut TestAppContext) {
2985 init_test(cx, |s| {
2986 s.defaults.show_whitespaces = Some(ShowWhitespaceSetting::All);
2987 s.defaults.tab_size = NonZeroU32::new(4);
2988 });
2989
2990 for editor_mode_without_invisibles in [
2991 EditorMode::SingleLine,
2992 EditorMode::AutoHeight { max_lines: 100 },
2993 ] {
2994 let invisibles = collect_invisibles_from_new_editor(
2995 cx,
2996 editor_mode_without_invisibles,
2997 "\t\t\t| | a b",
2998 500.0,
2999 );
3000 assert!(invisibles.is_empty(),
3001 "For editor mode {editor_mode_without_invisibles:?} no invisibles was expected but got {invisibles:?}");
3002 }
3003 }
3004
3005 #[gpui::test]
3006 fn test_wrapped_invisibles_drawing(cx: &mut TestAppContext) {
3007 let tab_size = 4;
3008 let input_text = "a\tbcd ".repeat(9);
3009 let repeated_invisibles = [
3010 Invisible::Tab {
3011 line_start_offset: 1,
3012 },
3013 Invisible::Whitespace {
3014 line_offset: tab_size as usize + 3,
3015 },
3016 Invisible::Whitespace {
3017 line_offset: tab_size as usize + 4,
3018 },
3019 Invisible::Whitespace {
3020 line_offset: tab_size as usize + 5,
3021 },
3022 ];
3023 let expected_invisibles = std::iter::once(repeated_invisibles)
3024 .cycle()
3025 .take(9)
3026 .flatten()
3027 .collect::<Vec<_>>();
3028 assert_eq!(
3029 expected_invisibles.len(),
3030 input_text
3031 .chars()
3032 .filter(|initial_char| initial_char.is_whitespace())
3033 .count(),
3034 "Hardcoded expected invisibles differ from the actual ones in '{input_text}'"
3035 );
3036 info!("Expected invisibles: {expected_invisibles:?}");
3037
3038 init_test(cx, |_| {});
3039
3040 // Put the same string with repeating whitespace pattern into editors of various size,
3041 // take deliberately small steps during resizing, to put all whitespace kinds near the wrap point.
3042 let resize_step = 10.0;
3043 let mut editor_width = 200.0;
3044 while editor_width <= 1000.0 {
3045 update_test_settings(cx, |s| {
3046 s.defaults.tab_size = NonZeroU32::new(tab_size);
3047 s.defaults.show_whitespaces = Some(ShowWhitespaceSetting::All);
3048 s.defaults.preferred_line_length = Some(editor_width as u32);
3049 s.defaults.soft_wrap = Some(language_settings::SoftWrap::PreferredLineLength);
3050 });
3051
3052 let actual_invisibles =
3053 collect_invisibles_from_new_editor(cx, EditorMode::Full, &input_text, editor_width);
3054
3055 // Whatever the editor size is, ensure it has the same invisible kinds in the same order
3056 // (no good guarantees about the offsets: wrapping could trigger padding and its tests should check the offsets).
3057 let mut i = 0;
3058 for (actual_index, actual_invisible) in actual_invisibles.iter().enumerate() {
3059 i = actual_index;
3060 match expected_invisibles.get(i) {
3061 Some(expected_invisible) => match (expected_invisible, actual_invisible) {
3062 (Invisible::Whitespace { .. }, Invisible::Whitespace { .. })
3063 | (Invisible::Tab { .. }, Invisible::Tab { .. }) => {}
3064 _ => {
3065 panic!("At index {i}, expected invisible {expected_invisible:?} does not match actual {actual_invisible:?} by kind. Actual invisibles: {actual_invisibles:?}")
3066 }
3067 },
3068 None => panic!("Unexpected extra invisible {actual_invisible:?} at index {i}"),
3069 }
3070 }
3071 let missing_expected_invisibles = &expected_invisibles[i + 1..];
3072 assert!(
3073 missing_expected_invisibles.is_empty(),
3074 "Missing expected invisibles after index {i}: {missing_expected_invisibles:?}"
3075 );
3076
3077 editor_width += resize_step;
3078 }
3079 }
3080
3081 fn collect_invisibles_from_new_editor(
3082 cx: &mut TestAppContext,
3083 editor_mode: EditorMode,
3084 input_text: &str,
3085 editor_width: f32,
3086 ) -> Vec<Invisible> {
3087 info!(
3088 "Creating editor with mode {editor_mode:?}, width {editor_width} and text '{input_text}'"
3089 );
3090 let (_, editor) = cx.add_window(|cx| {
3091 let buffer = MultiBuffer::build_simple(&input_text, cx);
3092 Editor::new(editor_mode, buffer, None, None, cx)
3093 });
3094
3095 let mut element = EditorElement::new(editor.read_with(cx, |editor, cx| editor.style(cx)));
3096 let (_, layout_state) = editor.update(cx, |editor, cx| {
3097 editor.set_soft_wrap_mode(language_settings::SoftWrap::EditorWidth, cx);
3098 editor.set_wrap_width(Some(editor_width), cx);
3099
3100 let mut new_parents = Default::default();
3101 let mut notify_views_if_parents_change = Default::default();
3102 let mut layout_cx = LayoutContext::new(
3103 cx,
3104 &mut new_parents,
3105 &mut notify_views_if_parents_change,
3106 false,
3107 );
3108 element.layout(
3109 SizeConstraint::new(vec2f(editor_width, 500.), vec2f(editor_width, 500.)),
3110 editor,
3111 &mut layout_cx,
3112 )
3113 });
3114
3115 layout_state
3116 .position_map
3117 .line_layouts
3118 .iter()
3119 .map(|line_with_invisibles| &line_with_invisibles.invisibles)
3120 .flatten()
3121 .cloned()
3122 .collect()
3123 }
3124}