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