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(rows.clone(), true, Some(style.theme.suggestion))
1396 .map(|chunk| {
1397 let mut highlight_style = chunk
1398 .syntax_highlight_id
1399 .and_then(|id| id.style(&style.syntax));
1400
1401 if let Some(chunk_highlight) = chunk.highlight_style {
1402 if let Some(highlight_style) = highlight_style.as_mut() {
1403 highlight_style.highlight(chunk_highlight);
1404 } else {
1405 highlight_style = Some(chunk_highlight);
1406 }
1407 }
1408
1409 let mut diagnostic_highlight = HighlightStyle::default();
1410
1411 if chunk.is_unnecessary {
1412 diagnostic_highlight.fade_out = Some(style.unnecessary_code_fade);
1413 }
1414
1415 if let Some(severity) = chunk.diagnostic_severity {
1416 // Omit underlines for HINT/INFO diagnostics on 'unnecessary' code.
1417 if severity <= DiagnosticSeverity::WARNING || !chunk.is_unnecessary {
1418 let diagnostic_style = super::diagnostic_style(severity, true, style);
1419 diagnostic_highlight.underline = Some(Underline {
1420 color: Some(diagnostic_style.message.text.color),
1421 thickness: 1.0.into(),
1422 squiggly: true,
1423 });
1424 }
1425 }
1426
1427 if let Some(highlight_style) = highlight_style.as_mut() {
1428 highlight_style.highlight(diagnostic_highlight);
1429 } else {
1430 highlight_style = Some(diagnostic_highlight);
1431 }
1432
1433 HighlightedChunk {
1434 chunk: chunk.text,
1435 style: highlight_style,
1436 is_tab: chunk.is_tab,
1437 }
1438 });
1439
1440 LineWithInvisibles::from_chunks(
1441 chunks,
1442 &style.text,
1443 cx.text_layout_cache(),
1444 cx.font_cache(),
1445 MAX_LINE_LEN,
1446 rows.len() as usize,
1447 line_number_layouts,
1448 snapshot.mode,
1449 )
1450 }
1451 }
1452
1453 #[allow(clippy::too_many_arguments)]
1454 fn layout_blocks(
1455 &mut self,
1456 rows: Range<u32>,
1457 snapshot: &EditorSnapshot,
1458 editor_width: f32,
1459 scroll_width: f32,
1460 gutter_padding: f32,
1461 gutter_width: f32,
1462 em_width: f32,
1463 text_x: f32,
1464 line_height: f32,
1465 style: &EditorStyle,
1466 line_layouts: &[LineWithInvisibles],
1467 editor: &mut Editor,
1468 cx: &mut LayoutContext<Editor>,
1469 ) -> (f32, Vec<BlockLayout>) {
1470 let scroll_x = snapshot.scroll_anchor.offset.x();
1471 let (fixed_blocks, non_fixed_blocks) = snapshot
1472 .blocks_in_range(rows.clone())
1473 .partition::<Vec<_>, _>(|(_, block)| match block {
1474 TransformBlock::ExcerptHeader { .. } => false,
1475 TransformBlock::Custom(block) => block.style() == BlockStyle::Fixed,
1476 });
1477 let mut render_block = |block: &TransformBlock, width: f32| {
1478 let mut element = match block {
1479 TransformBlock::Custom(block) => {
1480 let align_to = block
1481 .position()
1482 .to_point(&snapshot.buffer_snapshot)
1483 .to_display_point(snapshot);
1484 let anchor_x = text_x
1485 + if rows.contains(&align_to.row()) {
1486 line_layouts[(align_to.row() - rows.start) as usize]
1487 .line
1488 .x_for_index(align_to.column() as usize)
1489 } else {
1490 layout_line(align_to.row(), snapshot, style, cx.text_layout_cache())
1491 .x_for_index(align_to.column() as usize)
1492 };
1493
1494 block.render(&mut BlockContext {
1495 view_context: cx,
1496 anchor_x,
1497 gutter_padding,
1498 line_height,
1499 scroll_x,
1500 gutter_width,
1501 em_width,
1502 })
1503 }
1504 TransformBlock::ExcerptHeader {
1505 id,
1506 buffer,
1507 range,
1508 starts_new_buffer,
1509 ..
1510 } => {
1511 let tooltip_style = theme::current(cx).tooltip.clone();
1512 let include_root = editor
1513 .project
1514 .as_ref()
1515 .map(|project| project.read(cx).visible_worktrees(cx).count() > 1)
1516 .unwrap_or_default();
1517 let jump_icon = project::File::from_dyn(buffer.file()).map(|file| {
1518 let jump_path = ProjectPath {
1519 worktree_id: file.worktree_id(cx),
1520 path: file.path.clone(),
1521 };
1522 let jump_anchor = range
1523 .primary
1524 .as_ref()
1525 .map_or(range.context.start, |primary| primary.start);
1526 let jump_position = language::ToPoint::to_point(&jump_anchor, buffer);
1527
1528 enum JumpIcon {}
1529 MouseEventHandler::<JumpIcon, _>::new((*id).into(), cx, |state, _| {
1530 let style = style.jump_icon.style_for(state, false);
1531 Svg::new("icons/arrow_up_right_8.svg")
1532 .with_color(style.color)
1533 .constrained()
1534 .with_width(style.icon_width)
1535 .aligned()
1536 .contained()
1537 .with_style(style.container)
1538 .constrained()
1539 .with_width(style.button_width)
1540 .with_height(style.button_width)
1541 })
1542 .with_cursor_style(CursorStyle::PointingHand)
1543 .on_click(MouseButton::Left, move |_, editor, cx| {
1544 if let Some(workspace) = editor
1545 .workspace
1546 .as_ref()
1547 .and_then(|(workspace, _)| workspace.upgrade(cx))
1548 {
1549 workspace.update(cx, |workspace, cx| {
1550 Editor::jump(
1551 workspace,
1552 jump_path.clone(),
1553 jump_position,
1554 jump_anchor,
1555 cx,
1556 );
1557 });
1558 }
1559 })
1560 .with_tooltip::<JumpIcon>(
1561 (*id).into(),
1562 "Jump to Buffer".to_string(),
1563 Some(Box::new(crate::OpenExcerpts)),
1564 tooltip_style.clone(),
1565 cx,
1566 )
1567 .aligned()
1568 .flex_float()
1569 });
1570
1571 if *starts_new_buffer {
1572 let editor_font_size = style.text.font_size;
1573 let style = &style.diagnostic_path_header;
1574 let font_size = (style.text_scale_factor * editor_font_size).round();
1575
1576 let path = buffer.resolve_file_path(cx, include_root);
1577 let mut filename = None;
1578 let mut parent_path = None;
1579 // Can't use .and_then() because `.file_name()` and `.parent()` return references :(
1580 if let Some(path) = path {
1581 filename = path.file_name().map(|f| f.to_string_lossy().to_string());
1582 parent_path =
1583 path.parent().map(|p| p.to_string_lossy().to_string() + "/");
1584 }
1585
1586 Flex::row()
1587 .with_child(
1588 Label::new(
1589 filename.unwrap_or_else(|| "untitled".to_string()),
1590 style.filename.text.clone().with_font_size(font_size),
1591 )
1592 .contained()
1593 .with_style(style.filename.container)
1594 .aligned(),
1595 )
1596 .with_children(parent_path.map(|path| {
1597 Label::new(path, style.path.text.clone().with_font_size(font_size))
1598 .contained()
1599 .with_style(style.path.container)
1600 .aligned()
1601 }))
1602 .with_children(jump_icon)
1603 .contained()
1604 .with_style(style.container)
1605 .with_padding_left(gutter_padding)
1606 .with_padding_right(gutter_padding)
1607 .expanded()
1608 .into_any_named("path header block")
1609 } else {
1610 let text_style = style.text.clone();
1611 Flex::row()
1612 .with_child(Label::new("⋯", text_style))
1613 .with_children(jump_icon)
1614 .contained()
1615 .with_padding_left(gutter_padding)
1616 .with_padding_right(gutter_padding)
1617 .expanded()
1618 .into_any_named("collapsed context")
1619 }
1620 }
1621 };
1622
1623 element.layout(
1624 SizeConstraint {
1625 min: Vector2F::zero(),
1626 max: vec2f(width, block.height() as f32 * line_height),
1627 },
1628 editor,
1629 cx,
1630 );
1631 element
1632 };
1633
1634 let mut fixed_block_max_width = 0f32;
1635 let mut blocks = Vec::new();
1636 for (row, block) in fixed_blocks {
1637 let element = render_block(block, f32::INFINITY);
1638 fixed_block_max_width = fixed_block_max_width.max(element.size().x() + em_width);
1639 blocks.push(BlockLayout {
1640 row,
1641 element,
1642 style: BlockStyle::Fixed,
1643 });
1644 }
1645 for (row, block) in non_fixed_blocks {
1646 let style = match block {
1647 TransformBlock::Custom(block) => block.style(),
1648 TransformBlock::ExcerptHeader { .. } => BlockStyle::Sticky,
1649 };
1650 let width = match style {
1651 BlockStyle::Sticky => editor_width,
1652 BlockStyle::Flex => editor_width
1653 .max(fixed_block_max_width)
1654 .max(gutter_width + scroll_width),
1655 BlockStyle::Fixed => unreachable!(),
1656 };
1657 let element = render_block(block, width);
1658 blocks.push(BlockLayout {
1659 row,
1660 element,
1661 style,
1662 });
1663 }
1664 (
1665 scroll_width.max(fixed_block_max_width - gutter_width),
1666 blocks,
1667 )
1668 }
1669}
1670
1671struct HighlightedChunk<'a> {
1672 chunk: &'a str,
1673 style: Option<HighlightStyle>,
1674 is_tab: bool,
1675}
1676
1677#[derive(Debug)]
1678pub struct LineWithInvisibles {
1679 pub line: Line,
1680 invisibles: Vec<Invisible>,
1681}
1682
1683impl LineWithInvisibles {
1684 fn from_chunks<'a>(
1685 chunks: impl Iterator<Item = HighlightedChunk<'a>>,
1686 text_style: &TextStyle,
1687 text_layout_cache: &TextLayoutCache,
1688 font_cache: &Arc<FontCache>,
1689 max_line_len: usize,
1690 max_line_count: usize,
1691 line_number_layouts: &[Option<Line>],
1692 editor_mode: EditorMode,
1693 ) -> Vec<Self> {
1694 let mut layouts = Vec::with_capacity(max_line_count);
1695 let mut line = String::new();
1696 let mut invisibles = Vec::new();
1697 let mut styles = Vec::new();
1698 let mut non_whitespace_added = false;
1699 let mut row = 0;
1700 let mut line_exceeded_max_len = false;
1701 for highlighted_chunk in chunks.chain([HighlightedChunk {
1702 chunk: "\n",
1703 style: None,
1704 is_tab: false,
1705 }]) {
1706 for (ix, mut line_chunk) in highlighted_chunk.chunk.split('\n').enumerate() {
1707 if ix > 0 {
1708 layouts.push(Self {
1709 line: text_layout_cache.layout_str(&line, text_style.font_size, &styles),
1710 invisibles: invisibles.drain(..).collect(),
1711 });
1712
1713 line.clear();
1714 styles.clear();
1715 row += 1;
1716 line_exceeded_max_len = false;
1717 non_whitespace_added = false;
1718 if row == max_line_count {
1719 return layouts;
1720 }
1721 }
1722
1723 if !line_chunk.is_empty() && !line_exceeded_max_len {
1724 let text_style = if let Some(style) = highlighted_chunk.style {
1725 text_style
1726 .clone()
1727 .highlight(style, font_cache)
1728 .map(Cow::Owned)
1729 .unwrap_or_else(|_| Cow::Borrowed(text_style))
1730 } else {
1731 Cow::Borrowed(text_style)
1732 };
1733
1734 if line.len() + line_chunk.len() > max_line_len {
1735 let mut chunk_len = max_line_len - line.len();
1736 while !line_chunk.is_char_boundary(chunk_len) {
1737 chunk_len -= 1;
1738 }
1739 line_chunk = &line_chunk[..chunk_len];
1740 line_exceeded_max_len = true;
1741 }
1742
1743 styles.push((
1744 line_chunk.len(),
1745 RunStyle {
1746 font_id: text_style.font_id,
1747 color: text_style.color,
1748 underline: text_style.underline,
1749 },
1750 ));
1751
1752 if editor_mode == EditorMode::Full {
1753 // Line wrap pads its contents with fake whitespaces,
1754 // avoid printing them
1755 let inside_wrapped_string = line_number_layouts
1756 .get(row)
1757 .and_then(|layout| layout.as_ref())
1758 .is_none();
1759 if highlighted_chunk.is_tab {
1760 if non_whitespace_added || !inside_wrapped_string {
1761 invisibles.push(Invisible::Tab {
1762 line_start_offset: line.len(),
1763 });
1764 }
1765 } else {
1766 invisibles.extend(
1767 line_chunk
1768 .chars()
1769 .enumerate()
1770 .filter(|(_, line_char)| {
1771 let is_whitespace = line_char.is_whitespace();
1772 non_whitespace_added |= !is_whitespace;
1773 is_whitespace
1774 && (non_whitespace_added || !inside_wrapped_string)
1775 })
1776 .map(|(whitespace_index, _)| Invisible::Whitespace {
1777 line_offset: line.len() + whitespace_index,
1778 }),
1779 )
1780 }
1781 }
1782
1783 line.push_str(line_chunk);
1784 }
1785 }
1786 }
1787
1788 layouts
1789 }
1790
1791 fn draw(
1792 &self,
1793 layout: &LayoutState,
1794 row: u32,
1795 scroll_top: f32,
1796 scene: &mut SceneBuilder,
1797 content_origin: Vector2F,
1798 scroll_left: f32,
1799 visible_text_bounds: RectF,
1800 whitespace_setting: ShowWhitespaceSetting,
1801 selection_ranges: &[Range<DisplayPoint>],
1802 visible_bounds: RectF,
1803 cx: &mut ViewContext<Editor>,
1804 ) {
1805 let line_height = layout.position_map.line_height;
1806 let line_y = row as f32 * line_height - scroll_top;
1807
1808 self.line.paint(
1809 scene,
1810 content_origin + vec2f(-scroll_left, line_y),
1811 visible_text_bounds,
1812 line_height,
1813 cx,
1814 );
1815
1816 self.draw_invisibles(
1817 &selection_ranges,
1818 layout,
1819 content_origin,
1820 scroll_left,
1821 line_y,
1822 row,
1823 scene,
1824 visible_bounds,
1825 line_height,
1826 whitespace_setting,
1827 cx,
1828 );
1829 }
1830
1831 fn draw_invisibles(
1832 &self,
1833 selection_ranges: &[Range<DisplayPoint>],
1834 layout: &LayoutState,
1835 content_origin: Vector2F,
1836 scroll_left: f32,
1837 line_y: f32,
1838 row: u32,
1839 scene: &mut SceneBuilder,
1840 visible_bounds: RectF,
1841 line_height: f32,
1842 whitespace_setting: ShowWhitespaceSetting,
1843 cx: &mut ViewContext<Editor>,
1844 ) {
1845 let allowed_invisibles_regions = match whitespace_setting {
1846 ShowWhitespaceSetting::None => return,
1847 ShowWhitespaceSetting::Selection => Some(selection_ranges),
1848 ShowWhitespaceSetting::All => None,
1849 };
1850
1851 for invisible in &self.invisibles {
1852 let (&token_offset, invisible_symbol) = match invisible {
1853 Invisible::Tab { line_start_offset } => (line_start_offset, &layout.tab_invisible),
1854 Invisible::Whitespace { line_offset } => (line_offset, &layout.space_invisible),
1855 };
1856
1857 let x_offset = self.line.x_for_index(token_offset);
1858 let invisible_offset =
1859 (layout.position_map.em_width - invisible_symbol.width()).max(0.0) / 2.0;
1860 let origin = content_origin + vec2f(-scroll_left + x_offset + invisible_offset, line_y);
1861
1862 if let Some(allowed_regions) = allowed_invisibles_regions {
1863 let invisible_point = DisplayPoint::new(row, token_offset as u32);
1864 if !allowed_regions
1865 .iter()
1866 .any(|region| region.start <= invisible_point && invisible_point < region.end)
1867 {
1868 continue;
1869 }
1870 }
1871 invisible_symbol.paint(scene, origin, visible_bounds, line_height, cx);
1872 }
1873 }
1874}
1875
1876#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1877enum Invisible {
1878 Tab { line_start_offset: usize },
1879 Whitespace { line_offset: usize },
1880}
1881
1882impl Element<Editor> for EditorElement {
1883 type LayoutState = LayoutState;
1884 type PaintState = ();
1885
1886 fn layout(
1887 &mut self,
1888 constraint: SizeConstraint,
1889 editor: &mut Editor,
1890 cx: &mut LayoutContext<Editor>,
1891 ) -> (Vector2F, Self::LayoutState) {
1892 let mut size = constraint.max;
1893 if size.x().is_infinite() {
1894 unimplemented!("we don't yet handle an infinite width constraint on buffer elements");
1895 }
1896
1897 let snapshot = editor.snapshot(cx);
1898 let style = self.style.clone();
1899 let line_height = style.text.line_height(cx.font_cache());
1900
1901 let gutter_padding;
1902 let gutter_width;
1903 let gutter_margin;
1904 if snapshot.show_gutter {
1905 let em_width = style.text.em_width(cx.font_cache());
1906 gutter_padding = (em_width * style.gutter_padding_factor).round();
1907 gutter_width = self.max_line_number_width(&snapshot, cx) + gutter_padding * 2.0;
1908 gutter_margin = -style.text.descent(cx.font_cache());
1909 } else {
1910 gutter_padding = 0.0;
1911 gutter_width = 0.0;
1912 gutter_margin = 0.0;
1913 };
1914
1915 let text_width = size.x() - gutter_width;
1916 let em_width = style.text.em_width(cx.font_cache());
1917 let em_advance = style.text.em_advance(cx.font_cache());
1918 let overscroll = vec2f(em_width, 0.);
1919 let snapshot = {
1920 editor.set_visible_line_count(size.y() / line_height);
1921
1922 let editor_width = text_width - gutter_margin - overscroll.x() - em_width;
1923 let wrap_width = match editor.soft_wrap_mode(cx) {
1924 SoftWrap::None => (MAX_LINE_LEN / 2) as f32 * em_advance,
1925 SoftWrap::EditorWidth => editor_width,
1926 SoftWrap::Column(column) => editor_width.min(column as f32 * em_advance),
1927 };
1928
1929 if editor.set_wrap_width(Some(wrap_width), cx) {
1930 editor.snapshot(cx)
1931 } else {
1932 snapshot
1933 }
1934 };
1935
1936 let scroll_height = (snapshot.max_point().row() + 1) as f32 * line_height;
1937 if let EditorMode::AutoHeight { max_lines } = snapshot.mode {
1938 size.set_y(
1939 scroll_height
1940 .min(constraint.max_along(Axis::Vertical))
1941 .max(constraint.min_along(Axis::Vertical))
1942 .min(line_height * max_lines as f32),
1943 )
1944 } else if let EditorMode::SingleLine = snapshot.mode {
1945 size.set_y(
1946 line_height
1947 .min(constraint.max_along(Axis::Vertical))
1948 .max(constraint.min_along(Axis::Vertical)),
1949 )
1950 } else if size.y().is_infinite() {
1951 size.set_y(scroll_height);
1952 }
1953 let gutter_size = vec2f(gutter_width, size.y());
1954 let text_size = vec2f(text_width, size.y());
1955
1956 let autoscroll_horizontally = editor.autoscroll_vertically(size.y(), line_height, cx);
1957 let mut snapshot = editor.snapshot(cx);
1958
1959 let scroll_position = snapshot.scroll_position();
1960 // The scroll position is a fractional point, the whole number of which represents
1961 // the top of the window in terms of display rows.
1962 let start_row = scroll_position.y() as u32;
1963 let height_in_lines = size.y() / line_height;
1964 let max_row = snapshot.max_point().row();
1965
1966 // Add 1 to ensure selections bleed off screen
1967 let end_row = 1 + cmp::min(
1968 (scroll_position.y() + height_in_lines).ceil() as u32,
1969 max_row,
1970 );
1971
1972 let start_anchor = if start_row == 0 {
1973 Anchor::min()
1974 } else {
1975 snapshot
1976 .buffer_snapshot
1977 .anchor_before(DisplayPoint::new(start_row, 0).to_offset(&snapshot, Bias::Left))
1978 };
1979 let end_anchor = if end_row > max_row {
1980 Anchor::max()
1981 } else {
1982 snapshot
1983 .buffer_snapshot
1984 .anchor_before(DisplayPoint::new(end_row, 0).to_offset(&snapshot, Bias::Right))
1985 };
1986
1987 let mut selections: Vec<(ReplicaId, Vec<SelectionLayout>)> = Vec::new();
1988 let mut active_rows = BTreeMap::new();
1989 let mut fold_ranges = Vec::new();
1990 let is_singleton = editor.is_singleton(cx);
1991
1992 let highlighted_rows = editor.highlighted_rows();
1993 let theme = theme::current(cx);
1994 let highlighted_ranges = editor.background_highlights_in_range(
1995 start_anchor..end_anchor,
1996 &snapshot.display_snapshot,
1997 theme.as_ref(),
1998 );
1999
2000 fold_ranges.extend(
2001 snapshot
2002 .folds_in_range(start_anchor..end_anchor)
2003 .map(|anchor| {
2004 let start = anchor.start.to_point(&snapshot.buffer_snapshot);
2005 (
2006 start.row,
2007 start.to_display_point(&snapshot.display_snapshot)
2008 ..anchor.end.to_display_point(&snapshot),
2009 )
2010 }),
2011 );
2012
2013 let mut remote_selections = HashMap::default();
2014 for (replica_id, line_mode, cursor_shape, selection) in snapshot
2015 .buffer_snapshot
2016 .remote_selections_in_range(&(start_anchor..end_anchor))
2017 {
2018 // The local selections match the leader's selections.
2019 if Some(replica_id) == editor.leader_replica_id {
2020 continue;
2021 }
2022 remote_selections
2023 .entry(replica_id)
2024 .or_insert(Vec::new())
2025 .push(SelectionLayout::new(
2026 selection,
2027 line_mode,
2028 cursor_shape,
2029 &snapshot.display_snapshot,
2030 ));
2031 }
2032 selections.extend(remote_selections);
2033
2034 if editor.show_local_selections {
2035 let mut local_selections = editor
2036 .selections
2037 .disjoint_in_range(start_anchor..end_anchor, cx);
2038 local_selections.extend(editor.selections.pending(cx));
2039 for selection in &local_selections {
2040 let is_empty = selection.start == selection.end;
2041 let selection_start = snapshot.prev_line_boundary(selection.start).1;
2042 let selection_end = snapshot.next_line_boundary(selection.end).1;
2043 for row in cmp::max(selection_start.row(), start_row)
2044 ..=cmp::min(selection_end.row(), end_row)
2045 {
2046 let contains_non_empty_selection = active_rows.entry(row).or_insert(!is_empty);
2047 *contains_non_empty_selection |= !is_empty;
2048 }
2049 }
2050
2051 // Render the local selections in the leader's color when following.
2052 let local_replica_id = editor
2053 .leader_replica_id
2054 .unwrap_or_else(|| editor.replica_id(cx));
2055
2056 selections.push((
2057 local_replica_id,
2058 local_selections
2059 .into_iter()
2060 .map(|selection| {
2061 SelectionLayout::new(
2062 selection,
2063 editor.selections.line_mode,
2064 editor.cursor_shape,
2065 &snapshot.display_snapshot,
2066 )
2067 })
2068 .collect(),
2069 ));
2070 }
2071
2072 let scrollbar_settings = &settings::get::<EditorSettings>(cx).scrollbar;
2073 let show_scrollbars = match scrollbar_settings.show {
2074 ShowScrollbar::Auto => {
2075 // Git
2076 (is_singleton && scrollbar_settings.git_diff && snapshot.buffer_snapshot.has_git_diffs())
2077 // Scrollmanager
2078 || editor.scroll_manager.scrollbars_visible()
2079 }
2080 ShowScrollbar::System => editor.scroll_manager.scrollbars_visible(),
2081 ShowScrollbar::Always => true,
2082 ShowScrollbar::Never => false,
2083 };
2084
2085 let fold_ranges: Vec<(BufferRow, Range<DisplayPoint>, Color)> = fold_ranges
2086 .into_iter()
2087 .map(|(id, fold)| {
2088 let color = self
2089 .style
2090 .folds
2091 .ellipses
2092 .background
2093 .style_for(&mut cx.mouse_state::<FoldMarkers>(id as usize), false)
2094 .color;
2095
2096 (id, fold, color)
2097 })
2098 .collect();
2099
2100 let (line_number_layouts, fold_statuses) = self.layout_line_numbers(
2101 start_row..end_row,
2102 &active_rows,
2103 is_singleton,
2104 &snapshot,
2105 cx,
2106 );
2107
2108 let display_hunks = self.layout_git_gutters(start_row..end_row, &snapshot);
2109
2110 let scrollbar_row_range = scroll_position.y()..(scroll_position.y() + height_in_lines);
2111
2112 let mut max_visible_line_width = 0.0;
2113 let line_layouts =
2114 self.layout_lines(start_row..end_row, &line_number_layouts, &snapshot, cx);
2115 for line_with_invisibles in &line_layouts {
2116 if line_with_invisibles.line.width() > max_visible_line_width {
2117 max_visible_line_width = line_with_invisibles.line.width();
2118 }
2119 }
2120
2121 let style = self.style.clone();
2122 let longest_line_width = layout_line(
2123 snapshot.longest_row(),
2124 &snapshot,
2125 &style,
2126 cx.text_layout_cache(),
2127 )
2128 .width();
2129 let scroll_width = longest_line_width.max(max_visible_line_width) + overscroll.x();
2130 let em_width = style.text.em_width(cx.font_cache());
2131 let (scroll_width, blocks) = self.layout_blocks(
2132 start_row..end_row,
2133 &snapshot,
2134 size.x(),
2135 scroll_width,
2136 gutter_padding,
2137 gutter_width,
2138 em_width,
2139 gutter_width + gutter_margin,
2140 line_height,
2141 &style,
2142 &line_layouts,
2143 editor,
2144 cx,
2145 );
2146
2147 let scroll_max = vec2f(
2148 ((scroll_width - text_size.x()) / em_width).max(0.0),
2149 max_row as f32,
2150 );
2151
2152 let clamped = editor.scroll_manager.clamp_scroll_left(scroll_max.x());
2153
2154 let autoscrolled = if autoscroll_horizontally {
2155 editor.autoscroll_horizontally(
2156 start_row,
2157 text_size.x(),
2158 scroll_width,
2159 em_width,
2160 &line_layouts,
2161 cx,
2162 )
2163 } else {
2164 false
2165 };
2166
2167 if clamped || autoscrolled {
2168 snapshot = editor.snapshot(cx);
2169 }
2170
2171 let newest_selection_head = editor
2172 .selections
2173 .newest::<usize>(cx)
2174 .head()
2175 .to_display_point(&snapshot);
2176 let style = editor.style(cx);
2177
2178 let mut context_menu = None;
2179 let mut code_actions_indicator = None;
2180 if (start_row..end_row).contains(&newest_selection_head.row()) {
2181 if editor.context_menu_visible() {
2182 context_menu = editor.render_context_menu(newest_selection_head, style.clone(), cx);
2183 }
2184
2185 let active = matches!(
2186 editor.context_menu,
2187 Some(crate::ContextMenu::CodeActions(_))
2188 );
2189
2190 code_actions_indicator = editor
2191 .render_code_actions_indicator(&style, active, cx)
2192 .map(|indicator| (newest_selection_head.row(), indicator));
2193 }
2194
2195 let visible_rows = start_row..start_row + line_layouts.len() as u32;
2196 let mut hover = editor
2197 .hover_state
2198 .render(&snapshot, &style, visible_rows, cx);
2199 let mode = editor.mode;
2200
2201 let mut fold_indicators = editor.render_fold_indicators(
2202 fold_statuses,
2203 &style,
2204 editor.gutter_hovered,
2205 line_height,
2206 gutter_margin,
2207 cx,
2208 );
2209
2210 if let Some((_, context_menu)) = context_menu.as_mut() {
2211 context_menu.layout(
2212 SizeConstraint {
2213 min: Vector2F::zero(),
2214 max: vec2f(
2215 cx.window_size().x() * 0.7,
2216 (12. * line_height).min((size.y() - line_height) / 2.),
2217 ),
2218 },
2219 editor,
2220 cx,
2221 );
2222 }
2223
2224 if let Some((_, indicator)) = code_actions_indicator.as_mut() {
2225 indicator.layout(
2226 SizeConstraint::strict_along(
2227 Axis::Vertical,
2228 line_height * style.code_actions.vertical_scale,
2229 ),
2230 editor,
2231 cx,
2232 );
2233 }
2234
2235 for fold_indicator in fold_indicators.iter_mut() {
2236 if let Some(indicator) = fold_indicator.as_mut() {
2237 indicator.layout(
2238 SizeConstraint::strict_along(
2239 Axis::Vertical,
2240 line_height * style.code_actions.vertical_scale,
2241 ),
2242 editor,
2243 cx,
2244 );
2245 }
2246 }
2247
2248 if let Some((_, hover_popovers)) = hover.as_mut() {
2249 for hover_popover in hover_popovers.iter_mut() {
2250 hover_popover.layout(
2251 SizeConstraint {
2252 min: Vector2F::zero(),
2253 max: vec2f(
2254 (120. * em_width) // Default size
2255 .min(size.x() / 2.) // Shrink to half of the editor width
2256 .max(MIN_POPOVER_CHARACTER_WIDTH * em_width), // Apply minimum width of 20 characters
2257 (16. * line_height) // Default size
2258 .min(size.y() / 2.) // Shrink to half of the editor height
2259 .max(MIN_POPOVER_LINE_HEIGHT * line_height), // Apply minimum height of 4 lines
2260 ),
2261 },
2262 editor,
2263 cx,
2264 );
2265 }
2266 }
2267
2268 let invisible_symbol_font_size = self.style.text.font_size / 2.0;
2269 let invisible_symbol_style = RunStyle {
2270 color: self.style.whitespace,
2271 font_id: self.style.text.font_id,
2272 underline: Default::default(),
2273 };
2274
2275 (
2276 size,
2277 LayoutState {
2278 mode,
2279 position_map: Arc::new(PositionMap {
2280 size,
2281 scroll_max,
2282 line_layouts,
2283 line_height,
2284 em_width,
2285 em_advance,
2286 snapshot,
2287 }),
2288 visible_display_row_range: start_row..end_row,
2289 gutter_size,
2290 gutter_padding,
2291 text_size,
2292 scrollbar_row_range,
2293 show_scrollbars,
2294 is_singleton,
2295 max_row,
2296 gutter_margin,
2297 active_rows,
2298 highlighted_rows,
2299 highlighted_ranges,
2300 fold_ranges,
2301 line_number_layouts,
2302 display_hunks,
2303 blocks,
2304 selections,
2305 context_menu,
2306 code_actions_indicator,
2307 fold_indicators,
2308 tab_invisible: cx.text_layout_cache().layout_str(
2309 "→",
2310 invisible_symbol_font_size,
2311 &[("→".len(), invisible_symbol_style)],
2312 ),
2313 space_invisible: cx.text_layout_cache().layout_str(
2314 "•",
2315 invisible_symbol_font_size,
2316 &[("•".len(), invisible_symbol_style)],
2317 ),
2318 hover_popovers: hover,
2319 },
2320 )
2321 }
2322
2323 fn paint(
2324 &mut self,
2325 scene: &mut SceneBuilder,
2326 bounds: RectF,
2327 visible_bounds: RectF,
2328 layout: &mut Self::LayoutState,
2329 editor: &mut Editor,
2330 cx: &mut ViewContext<Editor>,
2331 ) -> Self::PaintState {
2332 let visible_bounds = bounds.intersection(visible_bounds).unwrap_or_default();
2333 scene.push_layer(Some(visible_bounds));
2334
2335 let gutter_bounds = RectF::new(bounds.origin(), layout.gutter_size);
2336 let text_bounds = RectF::new(
2337 bounds.origin() + vec2f(layout.gutter_size.x(), 0.0),
2338 layout.text_size,
2339 );
2340
2341 Self::attach_mouse_handlers(
2342 scene,
2343 &layout.position_map,
2344 layout.hover_popovers.is_some(),
2345 visible_bounds,
2346 text_bounds,
2347 gutter_bounds,
2348 bounds,
2349 cx,
2350 );
2351
2352 self.paint_background(scene, gutter_bounds, text_bounds, layout);
2353 if layout.gutter_size.x() > 0. {
2354 self.paint_gutter(scene, gutter_bounds, visible_bounds, layout, editor, cx);
2355 }
2356 self.paint_text(scene, text_bounds, visible_bounds, layout, editor, cx);
2357
2358 scene.push_layer(Some(bounds));
2359 if !layout.blocks.is_empty() {
2360 self.paint_blocks(scene, bounds, visible_bounds, layout, editor, cx);
2361 }
2362 self.paint_scrollbar(scene, bounds, layout, cx);
2363 scene.pop_layer();
2364
2365 scene.pop_layer();
2366 }
2367
2368 fn rect_for_text_range(
2369 &self,
2370 range_utf16: Range<usize>,
2371 bounds: RectF,
2372 _: RectF,
2373 layout: &Self::LayoutState,
2374 _: &Self::PaintState,
2375 _: &Editor,
2376 _: &ViewContext<Editor>,
2377 ) -> Option<RectF> {
2378 let text_bounds = RectF::new(
2379 bounds.origin() + vec2f(layout.gutter_size.x(), 0.0),
2380 layout.text_size,
2381 );
2382 let content_origin = text_bounds.origin() + vec2f(layout.gutter_margin, 0.);
2383 let scroll_position = layout.position_map.snapshot.scroll_position();
2384 let start_row = scroll_position.y() as u32;
2385 let scroll_top = scroll_position.y() * layout.position_map.line_height;
2386 let scroll_left = scroll_position.x() * layout.position_map.em_width;
2387
2388 let range_start = OffsetUtf16(range_utf16.start)
2389 .to_display_point(&layout.position_map.snapshot.display_snapshot);
2390 if range_start.row() < start_row {
2391 return None;
2392 }
2393
2394 let line = &layout
2395 .position_map
2396 .line_layouts
2397 .get((range_start.row() - start_row) as usize)?
2398 .line;
2399 let range_start_x = line.x_for_index(range_start.column() as usize);
2400 let range_start_y = range_start.row() as f32 * layout.position_map.line_height;
2401 Some(RectF::new(
2402 content_origin
2403 + vec2f(
2404 range_start_x,
2405 range_start_y + layout.position_map.line_height,
2406 )
2407 - vec2f(scroll_left, scroll_top),
2408 vec2f(
2409 layout.position_map.em_width,
2410 layout.position_map.line_height,
2411 ),
2412 ))
2413 }
2414
2415 fn debug(
2416 &self,
2417 bounds: RectF,
2418 _: &Self::LayoutState,
2419 _: &Self::PaintState,
2420 _: &Editor,
2421 _: &ViewContext<Editor>,
2422 ) -> json::Value {
2423 json!({
2424 "type": "BufferElement",
2425 "bounds": bounds.to_json()
2426 })
2427 }
2428}
2429
2430type BufferRow = u32;
2431
2432pub struct LayoutState {
2433 position_map: Arc<PositionMap>,
2434 gutter_size: Vector2F,
2435 gutter_padding: f32,
2436 gutter_margin: f32,
2437 text_size: Vector2F,
2438 mode: EditorMode,
2439 visible_display_row_range: Range<u32>,
2440 active_rows: BTreeMap<u32, bool>,
2441 highlighted_rows: Option<Range<u32>>,
2442 line_number_layouts: Vec<Option<text_layout::Line>>,
2443 display_hunks: Vec<DisplayDiffHunk>,
2444 blocks: Vec<BlockLayout>,
2445 highlighted_ranges: Vec<(Range<DisplayPoint>, Color)>,
2446 fold_ranges: Vec<(BufferRow, Range<DisplayPoint>, Color)>,
2447 selections: Vec<(ReplicaId, Vec<SelectionLayout>)>,
2448 scrollbar_row_range: Range<f32>,
2449 show_scrollbars: bool,
2450 is_singleton: bool,
2451 max_row: u32,
2452 context_menu: Option<(DisplayPoint, AnyElement<Editor>)>,
2453 code_actions_indicator: Option<(u32, AnyElement<Editor>)>,
2454 hover_popovers: Option<(DisplayPoint, Vec<AnyElement<Editor>>)>,
2455 fold_indicators: Vec<Option<AnyElement<Editor>>>,
2456 tab_invisible: Line,
2457 space_invisible: Line,
2458}
2459
2460struct PositionMap {
2461 size: Vector2F,
2462 line_height: f32,
2463 scroll_max: Vector2F,
2464 em_width: f32,
2465 em_advance: f32,
2466 line_layouts: Vec<LineWithInvisibles>,
2467 snapshot: EditorSnapshot,
2468}
2469
2470impl PositionMap {
2471 /// Returns two display points:
2472 /// 1. The nearest *valid* position in the editor
2473 /// 2. An unclipped, potentially *invalid* position that maps directly to
2474 /// the given pixel position.
2475 fn point_for_position(
2476 &self,
2477 text_bounds: RectF,
2478 position: Vector2F,
2479 ) -> (DisplayPoint, DisplayPoint) {
2480 let scroll_position = self.snapshot.scroll_position();
2481 let position = position - text_bounds.origin();
2482 let y = position.y().max(0.0).min(self.size.y());
2483 let x = position.x() + (scroll_position.x() * self.em_width);
2484 let row = (y / self.line_height + scroll_position.y()) as u32;
2485 let (column, x_overshoot) = if let Some(line) = self
2486 .line_layouts
2487 .get(row as usize - scroll_position.y() as usize)
2488 .map(|line_with_spaces| &line_with_spaces.line)
2489 {
2490 if let Some(ix) = line.index_for_x(x) {
2491 (ix as u32, 0.0)
2492 } else {
2493 (line.len() as u32, 0f32.max(x - line.width()))
2494 }
2495 } else {
2496 (0, x)
2497 };
2498
2499 let mut target_point = DisplayPoint::new(row, column);
2500 let point = self.snapshot.clip_point(target_point, Bias::Left);
2501 *target_point.column_mut() += (x_overshoot / self.em_advance) as u32;
2502
2503 (point, target_point)
2504 }
2505}
2506
2507struct BlockLayout {
2508 row: u32,
2509 element: AnyElement<Editor>,
2510 style: BlockStyle,
2511}
2512
2513fn layout_line(
2514 row: u32,
2515 snapshot: &EditorSnapshot,
2516 style: &EditorStyle,
2517 layout_cache: &TextLayoutCache,
2518) -> text_layout::Line {
2519 let mut line = snapshot.line(row);
2520
2521 if line.len() > MAX_LINE_LEN {
2522 let mut len = MAX_LINE_LEN;
2523 while !line.is_char_boundary(len) {
2524 len -= 1;
2525 }
2526
2527 line.truncate(len);
2528 }
2529
2530 layout_cache.layout_str(
2531 &line,
2532 style.text.font_size,
2533 &[(
2534 snapshot.line_len(row) as usize,
2535 RunStyle {
2536 font_id: style.text.font_id,
2537 color: Color::black(),
2538 underline: Default::default(),
2539 },
2540 )],
2541 )
2542}
2543
2544#[derive(Debug)]
2545pub struct Cursor {
2546 origin: Vector2F,
2547 block_width: f32,
2548 line_height: f32,
2549 color: Color,
2550 shape: CursorShape,
2551 block_text: Option<Line>,
2552}
2553
2554impl Cursor {
2555 pub fn new(
2556 origin: Vector2F,
2557 block_width: f32,
2558 line_height: f32,
2559 color: Color,
2560 shape: CursorShape,
2561 block_text: Option<Line>,
2562 ) -> Cursor {
2563 Cursor {
2564 origin,
2565 block_width,
2566 line_height,
2567 color,
2568 shape,
2569 block_text,
2570 }
2571 }
2572
2573 pub fn bounding_rect(&self, origin: Vector2F) -> RectF {
2574 RectF::new(
2575 self.origin + origin,
2576 vec2f(self.block_width, self.line_height),
2577 )
2578 }
2579
2580 pub fn paint(&self, scene: &mut SceneBuilder, origin: Vector2F, cx: &mut WindowContext) {
2581 let bounds = match self.shape {
2582 CursorShape::Bar => RectF::new(self.origin + origin, vec2f(2.0, self.line_height)),
2583 CursorShape::Block | CursorShape::Hollow => RectF::new(
2584 self.origin + origin,
2585 vec2f(self.block_width, self.line_height),
2586 ),
2587 CursorShape::Underscore => RectF::new(
2588 self.origin + origin + Vector2F::new(0.0, self.line_height - 2.0),
2589 vec2f(self.block_width, 2.0),
2590 ),
2591 };
2592
2593 //Draw background or border quad
2594 if matches!(self.shape, CursorShape::Hollow) {
2595 scene.push_quad(Quad {
2596 bounds,
2597 background: None,
2598 border: Border::all(1., self.color),
2599 corner_radius: 0.,
2600 });
2601 } else {
2602 scene.push_quad(Quad {
2603 bounds,
2604 background: Some(self.color),
2605 border: Default::default(),
2606 corner_radius: 0.,
2607 });
2608 }
2609
2610 if let Some(block_text) = &self.block_text {
2611 block_text.paint(scene, self.origin + origin, bounds, self.line_height, cx);
2612 }
2613 }
2614
2615 pub fn shape(&self) -> CursorShape {
2616 self.shape
2617 }
2618}
2619
2620#[derive(Debug)]
2621pub struct HighlightedRange {
2622 pub start_y: f32,
2623 pub line_height: f32,
2624 pub lines: Vec<HighlightedRangeLine>,
2625 pub color: Color,
2626 pub corner_radius: f32,
2627}
2628
2629#[derive(Debug)]
2630pub struct HighlightedRangeLine {
2631 pub start_x: f32,
2632 pub end_x: f32,
2633}
2634
2635impl HighlightedRange {
2636 pub fn paint(&self, bounds: RectF, scene: &mut SceneBuilder) {
2637 if self.lines.len() >= 2 && self.lines[0].start_x > self.lines[1].end_x {
2638 self.paint_lines(self.start_y, &self.lines[0..1], bounds, scene);
2639 self.paint_lines(
2640 self.start_y + self.line_height,
2641 &self.lines[1..],
2642 bounds,
2643 scene,
2644 );
2645 } else {
2646 self.paint_lines(self.start_y, &self.lines, bounds, scene);
2647 }
2648 }
2649
2650 fn paint_lines(
2651 &self,
2652 start_y: f32,
2653 lines: &[HighlightedRangeLine],
2654 bounds: RectF,
2655 scene: &mut SceneBuilder,
2656 ) {
2657 if lines.is_empty() {
2658 return;
2659 }
2660
2661 let mut path = PathBuilder::new();
2662 let first_line = lines.first().unwrap();
2663 let last_line = lines.last().unwrap();
2664
2665 let first_top_left = vec2f(first_line.start_x, start_y);
2666 let first_top_right = vec2f(first_line.end_x, start_y);
2667
2668 let curve_height = vec2f(0., self.corner_radius);
2669 let curve_width = |start_x: f32, end_x: f32| {
2670 let max = (end_x - start_x) / 2.;
2671 let width = if max < self.corner_radius {
2672 max
2673 } else {
2674 self.corner_radius
2675 };
2676
2677 vec2f(width, 0.)
2678 };
2679
2680 let top_curve_width = curve_width(first_line.start_x, first_line.end_x);
2681 path.reset(first_top_right - top_curve_width);
2682 path.curve_to(first_top_right + curve_height, first_top_right);
2683
2684 let mut iter = lines.iter().enumerate().peekable();
2685 while let Some((ix, line)) = iter.next() {
2686 let bottom_right = vec2f(line.end_x, start_y + (ix + 1) as f32 * self.line_height);
2687
2688 if let Some((_, next_line)) = iter.peek() {
2689 let next_top_right = vec2f(next_line.end_x, bottom_right.y());
2690
2691 match next_top_right.x().partial_cmp(&bottom_right.x()).unwrap() {
2692 Ordering::Equal => {
2693 path.line_to(bottom_right);
2694 }
2695 Ordering::Less => {
2696 let curve_width = curve_width(next_top_right.x(), bottom_right.x());
2697 path.line_to(bottom_right - curve_height);
2698 if self.corner_radius > 0. {
2699 path.curve_to(bottom_right - curve_width, bottom_right);
2700 }
2701 path.line_to(next_top_right + curve_width);
2702 if self.corner_radius > 0. {
2703 path.curve_to(next_top_right + curve_height, next_top_right);
2704 }
2705 }
2706 Ordering::Greater => {
2707 let curve_width = curve_width(bottom_right.x(), next_top_right.x());
2708 path.line_to(bottom_right - curve_height);
2709 if self.corner_radius > 0. {
2710 path.curve_to(bottom_right + curve_width, bottom_right);
2711 }
2712 path.line_to(next_top_right - curve_width);
2713 if self.corner_radius > 0. {
2714 path.curve_to(next_top_right + curve_height, next_top_right);
2715 }
2716 }
2717 }
2718 } else {
2719 let curve_width = curve_width(line.start_x, line.end_x);
2720 path.line_to(bottom_right - curve_height);
2721 if self.corner_radius > 0. {
2722 path.curve_to(bottom_right - curve_width, bottom_right);
2723 }
2724
2725 let bottom_left = vec2f(line.start_x, bottom_right.y());
2726 path.line_to(bottom_left + curve_width);
2727 if self.corner_radius > 0. {
2728 path.curve_to(bottom_left - curve_height, bottom_left);
2729 }
2730 }
2731 }
2732
2733 if first_line.start_x > last_line.start_x {
2734 let curve_width = curve_width(last_line.start_x, first_line.start_x);
2735 let second_top_left = vec2f(last_line.start_x, start_y + self.line_height);
2736 path.line_to(second_top_left + curve_height);
2737 if self.corner_radius > 0. {
2738 path.curve_to(second_top_left + curve_width, second_top_left);
2739 }
2740 let first_bottom_left = vec2f(first_line.start_x, second_top_left.y());
2741 path.line_to(first_bottom_left - curve_width);
2742 if self.corner_radius > 0. {
2743 path.curve_to(first_bottom_left - curve_height, first_bottom_left);
2744 }
2745 }
2746
2747 path.line_to(first_top_left + curve_height);
2748 if self.corner_radius > 0. {
2749 path.curve_to(first_top_left + top_curve_width, first_top_left);
2750 }
2751 path.line_to(first_top_right - top_curve_width);
2752
2753 scene.push_path(path.build(self.color, Some(bounds)));
2754 }
2755}
2756
2757fn position_to_display_point(
2758 position: Vector2F,
2759 text_bounds: RectF,
2760 position_map: &PositionMap,
2761) -> Option<DisplayPoint> {
2762 if text_bounds.contains_point(position) {
2763 let (point, target_point) = position_map.point_for_position(text_bounds, position);
2764 if point == target_point {
2765 Some(point)
2766 } else {
2767 None
2768 }
2769 } else {
2770 None
2771 }
2772}
2773
2774fn range_to_bounds(
2775 range: &Range<DisplayPoint>,
2776 content_origin: Vector2F,
2777 scroll_left: f32,
2778 scroll_top: f32,
2779 visible_row_range: &Range<u32>,
2780 line_end_overshoot: f32,
2781 position_map: &PositionMap,
2782) -> impl Iterator<Item = RectF> {
2783 let mut bounds: SmallVec<[RectF; 1]> = SmallVec::new();
2784
2785 if range.start == range.end {
2786 return bounds.into_iter();
2787 }
2788
2789 let start_row = visible_row_range.start;
2790 let end_row = visible_row_range.end;
2791
2792 let row_range = if range.end.column() == 0 {
2793 cmp::max(range.start.row(), start_row)..cmp::min(range.end.row(), end_row)
2794 } else {
2795 cmp::max(range.start.row(), start_row)..cmp::min(range.end.row() + 1, end_row)
2796 };
2797
2798 let first_y =
2799 content_origin.y() + row_range.start as f32 * position_map.line_height - scroll_top;
2800
2801 for (idx, row) in row_range.enumerate() {
2802 let line_layout = &position_map.line_layouts[(row - start_row) as usize].line;
2803
2804 let start_x = if row == range.start.row() {
2805 content_origin.x() + line_layout.x_for_index(range.start.column() as usize)
2806 - scroll_left
2807 } else {
2808 content_origin.x() - scroll_left
2809 };
2810
2811 let end_x = if row == range.end.row() {
2812 content_origin.x() + line_layout.x_for_index(range.end.column() as usize) - scroll_left
2813 } else {
2814 content_origin.x() + line_layout.width() + line_end_overshoot - scroll_left
2815 };
2816
2817 bounds.push(RectF::from_points(
2818 vec2f(start_x, first_y + position_map.line_height * idx as f32),
2819 vec2f(end_x, first_y + position_map.line_height * (idx + 1) as f32),
2820 ))
2821 }
2822
2823 bounds.into_iter()
2824}
2825
2826pub fn scale_vertical_mouse_autoscroll_delta(delta: f32) -> f32 {
2827 delta.powf(1.5) / 100.0
2828}
2829
2830fn scale_horizontal_mouse_autoscroll_delta(delta: f32) -> f32 {
2831 delta.powf(1.2) / 300.0
2832}
2833
2834#[cfg(test)]
2835mod tests {
2836 use super::*;
2837 use crate::{
2838 display_map::{BlockDisposition, BlockProperties},
2839 editor_tests::{init_test, update_test_settings},
2840 Editor, MultiBuffer,
2841 };
2842 use gpui::TestAppContext;
2843 use language::language_settings;
2844 use log::info;
2845 use std::{num::NonZeroU32, sync::Arc};
2846 use util::test::sample_text;
2847
2848 #[gpui::test]
2849 fn test_layout_line_numbers(cx: &mut TestAppContext) {
2850 init_test(cx, |_| {});
2851
2852 let (_, editor) = cx.add_window(|cx| {
2853 let buffer = MultiBuffer::build_simple(&sample_text(6, 6, 'a'), cx);
2854 Editor::new(EditorMode::Full, buffer, None, None, cx)
2855 });
2856 let element = EditorElement::new(editor.read_with(cx, |editor, cx| editor.style(cx)));
2857
2858 let layouts = editor.update(cx, |editor, cx| {
2859 let snapshot = editor.snapshot(cx);
2860 element
2861 .layout_line_numbers(0..6, &Default::default(), false, &snapshot, cx)
2862 .0
2863 });
2864 assert_eq!(layouts.len(), 6);
2865 }
2866
2867 #[gpui::test]
2868 fn test_layout_with_placeholder_text_and_blocks(cx: &mut TestAppContext) {
2869 init_test(cx, |_| {});
2870
2871 let (_, editor) = cx.add_window(|cx| {
2872 let buffer = MultiBuffer::build_simple("", cx);
2873 Editor::new(EditorMode::Full, buffer, None, None, cx)
2874 });
2875
2876 editor.update(cx, |editor, cx| {
2877 editor.set_placeholder_text("hello", cx);
2878 editor.insert_blocks(
2879 [BlockProperties {
2880 style: BlockStyle::Fixed,
2881 disposition: BlockDisposition::Above,
2882 height: 3,
2883 position: Anchor::min(),
2884 render: Arc::new(|_| Empty::new().into_any()),
2885 }],
2886 cx,
2887 );
2888
2889 // Blur the editor so that it displays placeholder text.
2890 cx.blur();
2891 });
2892
2893 let mut element = EditorElement::new(editor.read_with(cx, |editor, cx| editor.style(cx)));
2894 let (size, mut state) = editor.update(cx, |editor, cx| {
2895 let mut new_parents = Default::default();
2896 let mut notify_views_if_parents_change = Default::default();
2897 let mut layout_cx = LayoutContext::new(
2898 cx,
2899 &mut new_parents,
2900 &mut notify_views_if_parents_change,
2901 false,
2902 );
2903 element.layout(
2904 SizeConstraint::new(vec2f(500., 500.), vec2f(500., 500.)),
2905 editor,
2906 &mut layout_cx,
2907 )
2908 });
2909
2910 assert_eq!(state.position_map.line_layouts.len(), 4);
2911 assert_eq!(
2912 state
2913 .line_number_layouts
2914 .iter()
2915 .map(Option::is_some)
2916 .collect::<Vec<_>>(),
2917 &[false, false, false, true]
2918 );
2919
2920 // Don't panic.
2921 let mut scene = SceneBuilder::new(1.0);
2922 let bounds = RectF::new(Default::default(), size);
2923 editor.update(cx, |editor, cx| {
2924 element.paint(&mut scene, bounds, bounds, &mut state, editor, cx);
2925 });
2926 }
2927
2928 #[gpui::test]
2929 fn test_all_invisibles_drawing(cx: &mut TestAppContext) {
2930 const TAB_SIZE: u32 = 4;
2931
2932 let input_text = "\t \t|\t| a b";
2933 let expected_invisibles = vec![
2934 Invisible::Tab {
2935 line_start_offset: 0,
2936 },
2937 Invisible::Whitespace {
2938 line_offset: TAB_SIZE as usize,
2939 },
2940 Invisible::Tab {
2941 line_start_offset: TAB_SIZE as usize + 1,
2942 },
2943 Invisible::Tab {
2944 line_start_offset: TAB_SIZE as usize * 2 + 1,
2945 },
2946 Invisible::Whitespace {
2947 line_offset: TAB_SIZE as usize * 3 + 1,
2948 },
2949 Invisible::Whitespace {
2950 line_offset: TAB_SIZE as usize * 3 + 3,
2951 },
2952 ];
2953 assert_eq!(
2954 expected_invisibles.len(),
2955 input_text
2956 .chars()
2957 .filter(|initial_char| initial_char.is_whitespace())
2958 .count(),
2959 "Hardcoded expected invisibles differ from the actual ones in '{input_text}'"
2960 );
2961
2962 init_test(cx, |s| {
2963 s.defaults.show_whitespaces = Some(ShowWhitespaceSetting::All);
2964 s.defaults.tab_size = NonZeroU32::new(TAB_SIZE);
2965 });
2966
2967 let actual_invisibles =
2968 collect_invisibles_from_new_editor(cx, EditorMode::Full, &input_text, 500.0);
2969
2970 assert_eq!(expected_invisibles, actual_invisibles);
2971 }
2972
2973 #[gpui::test]
2974 fn test_invisibles_dont_appear_in_certain_editors(cx: &mut TestAppContext) {
2975 init_test(cx, |s| {
2976 s.defaults.show_whitespaces = Some(ShowWhitespaceSetting::All);
2977 s.defaults.tab_size = NonZeroU32::new(4);
2978 });
2979
2980 for editor_mode_without_invisibles in [
2981 EditorMode::SingleLine,
2982 EditorMode::AutoHeight { max_lines: 100 },
2983 ] {
2984 let invisibles = collect_invisibles_from_new_editor(
2985 cx,
2986 editor_mode_without_invisibles,
2987 "\t\t\t| | a b",
2988 500.0,
2989 );
2990 assert!(invisibles.is_empty(),
2991 "For editor mode {editor_mode_without_invisibles:?} no invisibles was expected but got {invisibles:?}");
2992 }
2993 }
2994
2995 #[gpui::test]
2996 fn test_wrapped_invisibles_drawing(cx: &mut TestAppContext) {
2997 let tab_size = 4;
2998 let input_text = "a\tbcd ".repeat(9);
2999 let repeated_invisibles = [
3000 Invisible::Tab {
3001 line_start_offset: 1,
3002 },
3003 Invisible::Whitespace {
3004 line_offset: tab_size as usize + 3,
3005 },
3006 Invisible::Whitespace {
3007 line_offset: tab_size as usize + 4,
3008 },
3009 Invisible::Whitespace {
3010 line_offset: tab_size as usize + 5,
3011 },
3012 ];
3013 let expected_invisibles = std::iter::once(repeated_invisibles)
3014 .cycle()
3015 .take(9)
3016 .flatten()
3017 .collect::<Vec<_>>();
3018 assert_eq!(
3019 expected_invisibles.len(),
3020 input_text
3021 .chars()
3022 .filter(|initial_char| initial_char.is_whitespace())
3023 .count(),
3024 "Hardcoded expected invisibles differ from the actual ones in '{input_text}'"
3025 );
3026 info!("Expected invisibles: {expected_invisibles:?}");
3027
3028 init_test(cx, |_| {});
3029
3030 // Put the same string with repeating whitespace pattern into editors of various size,
3031 // take deliberately small steps during resizing, to put all whitespace kinds near the wrap point.
3032 let resize_step = 10.0;
3033 let mut editor_width = 200.0;
3034 while editor_width <= 1000.0 {
3035 update_test_settings(cx, |s| {
3036 s.defaults.tab_size = NonZeroU32::new(tab_size);
3037 s.defaults.show_whitespaces = Some(ShowWhitespaceSetting::All);
3038 s.defaults.preferred_line_length = Some(editor_width as u32);
3039 s.defaults.soft_wrap = Some(language_settings::SoftWrap::PreferredLineLength);
3040 });
3041
3042 let actual_invisibles =
3043 collect_invisibles_from_new_editor(cx, EditorMode::Full, &input_text, editor_width);
3044
3045 // Whatever the editor size is, ensure it has the same invisible kinds in the same order
3046 // (no good guarantees about the offsets: wrapping could trigger padding and its tests should check the offsets).
3047 let mut i = 0;
3048 for (actual_index, actual_invisible) in actual_invisibles.iter().enumerate() {
3049 i = actual_index;
3050 match expected_invisibles.get(i) {
3051 Some(expected_invisible) => match (expected_invisible, actual_invisible) {
3052 (Invisible::Whitespace { .. }, Invisible::Whitespace { .. })
3053 | (Invisible::Tab { .. }, Invisible::Tab { .. }) => {}
3054 _ => {
3055 panic!("At index {i}, expected invisible {expected_invisible:?} does not match actual {actual_invisible:?} by kind. Actual invisibles: {actual_invisibles:?}")
3056 }
3057 },
3058 None => panic!("Unexpected extra invisible {actual_invisible:?} at index {i}"),
3059 }
3060 }
3061 let missing_expected_invisibles = &expected_invisibles[i + 1..];
3062 assert!(
3063 missing_expected_invisibles.is_empty(),
3064 "Missing expected invisibles after index {i}: {missing_expected_invisibles:?}"
3065 );
3066
3067 editor_width += resize_step;
3068 }
3069 }
3070
3071 fn collect_invisibles_from_new_editor(
3072 cx: &mut TestAppContext,
3073 editor_mode: EditorMode,
3074 input_text: &str,
3075 editor_width: f32,
3076 ) -> Vec<Invisible> {
3077 info!(
3078 "Creating editor with mode {editor_mode:?}, width {editor_width} and text '{input_text}'"
3079 );
3080 let (_, editor) = cx.add_window(|cx| {
3081 let buffer = MultiBuffer::build_simple(&input_text, cx);
3082 Editor::new(editor_mode, buffer, None, None, cx)
3083 });
3084
3085 let mut element = EditorElement::new(editor.read_with(cx, |editor, cx| editor.style(cx)));
3086 let (_, layout_state) = editor.update(cx, |editor, cx| {
3087 editor.set_soft_wrap_mode(language_settings::SoftWrap::EditorWidth, cx);
3088 editor.set_wrap_width(Some(editor_width), cx);
3089
3090 let mut new_parents = Default::default();
3091 let mut notify_views_if_parents_change = Default::default();
3092 let mut layout_cx = LayoutContext::new(
3093 cx,
3094 &mut new_parents,
3095 &mut notify_views_if_parents_change,
3096 false,
3097 );
3098 element.layout(
3099 SizeConstraint::new(vec2f(editor_width, 500.), vec2f(editor_width, 500.)),
3100 editor,
3101 &mut layout_cx,
3102 )
3103 });
3104
3105 layout_state
3106 .position_map
3107 .line_layouts
3108 .iter()
3109 .map(|line_with_invisibles| &line_with_invisibles.invisibles)
3110 .flatten()
3111 .cloned()
3112 .collect()
3113 }
3114}