editor/editor.rs
1//! The editing surface.
2//!
3//! The document is the single source of truth. There is no `TextField` per
4//! block: a selection is a pair of `Cursor`s into one `Doc`, which is what
5//! makes Enter split, Backspace merge and Tab indent into list operations
6//! rather than negotiations between separate widgets each owning a string.
7//!
8//! Everything about *what* an edit does lives in `markdown` — `edit` and
9//! `select` — and is tested there without a window. This crate owns only what
10//! needs one: a focus handle, key bindings, the platform input handler, and
11//! turning a click into a position.
12
13use gpui::{
14 App, Context, CursorStyle, ElementInputHandler, EventEmitter, FocusHandle, Focusable,
15 KeyContext, MouseButton, Render, Styled as _, Task, Window, canvas, div, prelude::*,
16};
17use markdown::{
18 Affinity, Annotation, AppExt as _, Block, BlockKind, BlockLayouts, Cursor, Doc, Form, Mark,
19 Part, Selection, Splice, Text, edit, edit::shortcut,
20};
21use std::{ops::Range, time::Duration};
22use theme::Theme;
23
24use crate::{
25 anchor::{Anchor, AnchorId, Delta},
26 history::{EditKind, History},
27 link::{self, Choice},
28 slash::{Slash, SlashAction, SlashAt},
29 text_size,
30};
31
32mod anchors;
33mod blocks;
34mod caret;
35mod clipboard;
36pub(crate) mod image;
37mod input;
38pub mod keys;
39pub(crate) mod menu;
40mod mode;
41mod pointer;
42mod render;
43mod sizing;
44mod table;
45mod typing;
46
47pub use keys::init;
48use keys::{
49 Backspace, Copy, Cut, DecreaseTextSize, Delete, DeleteToHome, DeleteWordLeft, DeleteWordRight,
50 Dismiss, DocumentEnd, DocumentStart, Down, DuplicateBlock, End, Home, IncreaseTextSize, Indent,
51 InsertParagraph, KillLine, Left, MoveBlockDown, MoveBlockUp, Outdent, Paste, Redo, RemoveBlock,
52 ResetTextSize, Right, SelectAll, SelectDocumentEnd, SelectDocumentStart, SelectDown, SelectEnd,
53 SelectHome, SelectLeft, SelectRight, SelectUp, SelectWordLeft, SelectWordRight, SoftBreak,
54 SplitBlock, ToggleBold, ToggleCode, ToggleHighlight, ToggleItalic, ToggleStrike, Undo, Up,
55 WordLeft, WordRight,
56};
57
58pub const CONTEXT: &str = "BezelEditor";
59
60/// The custom mark [`ToggleHighlight`] toggles. It does nothing until the app
61/// registers a mark under this name with [`markdown::AppExt::set_marks`].
62pub const HIGHLIGHT_MARK: &str = "highlight";
63
64/// [`CONTEXT`], which every binding in [`keys`] is scoped to, plus the mark
65/// that keeps `tab` for [`Editor::indent`].
66fn key_context() -> KeyContext {
67 let mut context = KeyContext::default();
68 context.add(CONTEXT);
69 context.add(ui::focus::CLAIMS_TAB);
70 context
71}
72
73/// What the editor tells its host about.
74///
75/// An app holding comment threads has to hear that the document moved, or its
76/// side of the pairing goes stale against anchors that did not. Split the way
77/// [`ui::input::FieldEvent`] is, so a listener takes only the half it needs.
78#[derive(Clone, Copy, Debug, PartialEq)]
79pub enum EditorEvent {
80 /// The document is different, and the anchors have been mapped through it.
81 Changed,
82 /// A click landed on an anchor's range.
83 AnchorActivated(AnchorId),
84 /// The editor switched between the document and its source, which a host
85 /// lighting its own toggle has no other way to hear about — the switch can
86 /// come from an undo as well as from the button.
87 ModeChanged(Mode),
88}
89
90/// Which form the document is being edited in.
91///
92/// The trigger is the app's: a button, a menu row, a chord of its own. What is
93/// here is the switch it calls, because the caret, the undo history and the
94/// focus have to survive it, and only the editor owns all three.
95#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
96pub enum Mode {
97 /// The document as it reads.
98 #[default]
99 Blocks,
100 /// The markdown a save would write, in one editable text.
101 Source,
102}
103
104/// Which of the editor's own affordances are on.
105///
106/// All of them unless an app says otherwise: a document with nothing
107/// discoverable on it is the wrong default for a library. Turning one off is
108/// for an app that puts its own in the same place — a bar with its own block
109/// menu does not want the gutter handle's as well — rather than for trimming.
110#[derive(Clone, Copy, Debug, PartialEq, Eq)]
111pub struct Chrome {
112 /// The gutter handle, the menu it opens, and dragging a block by it.
113 pub handle: bool,
114 /// The `/` menu at an empty block.
115 pub slash: bool,
116 /// A fence's language label, and the picker it opens.
117 pub language: bool,
118 /// The menu a pasted URL drops — leave it, or make a card, a chip or the
119 /// picture it points at.
120 pub paste: bool,
121 /// The mention menus over the app's [`crate::MentionSource`]s. Off by
122 /// default.
123 pub mention: bool,
124}
125
126impl Default for Chrome {
127 fn default() -> Self {
128 Self {
129 handle: true,
130 slash: true,
131 language: true,
132 paste: true,
133 mention: false,
134 }
135 }
136}
137
138/// What a toolbar reads to light itself, in one call.
139///
140/// Every field is a question a bar asks on every frame, and each was a separate
141/// reach into the document before: which marks are lit, what the block is
142/// called, whether cmd-E would fence, and whether any of it applies at all.
143/// Taken together so a bar cannot answer half of them from one frame and half
144/// from the next.
145#[derive(Clone, Debug, PartialEq, Eq)]
146pub struct Formatting {
147 /// Which form the document is in. In [`Mode::Source`] the markup is already
148 /// spelled out, so [`Self::marks`] is empty and a bar has nothing to light.
149 pub mode: Mode,
150 /// The marks the selection carries throughout — and at a collapsed caret,
151 /// the ones the next character typed would carry, cmd-B before typing
152 /// included.
153 pub marks: Vec<Mark>,
154 /// What the caret's block is called in [`turns`], or `None` for a block the
155 /// menu does not offer.
156 pub block: Option<gpui::SharedString>,
157 /// Whether [`Mark::Code`] here makes a fence out of the selection rather
158 /// than an inline span — the one chord whose meaning changes with what is
159 /// selected, and the one a bar cannot work out for itself.
160 pub fenceable: bool,
161}
162
163/// Every block a block can be turned into, and what each is called — the
164/// vocabulary the slash menu and the block menu both offer, for an app building
165/// a menu of its own. Pair with [`Editor::set_block`], which is what both of
166/// bezel's own menus call.
167pub fn turns() -> Vec<(gpui::SharedString, BlockKind)> {
168 crate::slash::items()
169}
170
171/// Shown on the focused block while it is empty — the only discoverable place
172/// to say that `/` does anything.
173const PLACEHOLDER: &str = "Type / for commands";
174
175/// What tab inserts in the source, where there are no blocks to indent. Two
176/// spaces, which is what markdown's own nesting is written in.
177const INDENT: &str = " ";
178
179/// Half the caret's blink period — `ui::TextField`'s, which is the 500ms on,
180/// 500ms off macOS itself uses.
181const BLINK: Duration = Duration::from_millis(500);
182
183/// The handle's box. Wide enough to be hit without crowding the margin; how
184/// far left of the text it sits is [`Layout::text_inset`](crate::Layout).
185const HANDLE_SIZE: f32 = 18.0;
186
187/// How far a drag on an image's edge handle can shrink it — matches
188/// `markdown::render`'s `TABLE_MIN_COLUMN_WIDTH`, the same floor for the
189/// other block content a drag can resize.
190const MIN_IMAGE_WIDTH: f32 = 96.0;
191
192/// Whether a selection is prose covering more than one line — two blocks, or
193/// one line break inside a single block.
194///
195/// What a chord means about a selection is the editor's to decide; a [`Doc`]
196/// has no opinion about it. A selection reaching into a table or a fence is not
197/// prose and keeps the inline behaviour, because half a table has no lines to
198/// make a fence out of.
199fn fenceable(doc: &Doc, selection: Selection) -> bool {
200 let spans = doc.spans(selection);
201 let covered = |at: &Cursor, range: &Range<usize>| {
202 doc.blocks[at.block]
203 .text_at(at.part)
204 .and_then(|text| text.text.get(range.clone()))
205 };
206 spans.iter().all(|(at, _)| at.part == Part::Body)
207 && (spans.len() > 1
208 || spans
209 .iter()
210 .any(|(at, range)| covered(at, range).is_some_and(|text| text.contains('\n'))))
211}
212
213/// Give an empty document a block to hold a caret, and say whether one was
214/// needed.
215///
216/// A [`Doc`] with no blocks is a legitimate document — it is what `parse("")`
217/// returns — but it is not something that can be edited: nothing paints, so
218/// there is no caret and no placeholder, and neither a click nor a hit test
219/// has a target to find. An empty file would sit inert until something typed
220/// a block into existence, which is the one thing you cannot do with no caret.
221fn ensure_block(doc: &mut Doc) -> bool {
222 if !doc.blocks.is_empty() {
223 return false;
224 }
225 doc.blocks
226 .push(Block::new(BlockKind::Paragraph(Text::default())));
227 true
228}
229
230fn line_home(at: Cursor, doc: &Doc) -> Cursor {
231 let Some(text) = doc
232 .blocks
233 .get(at.block)
234 .and_then(|block| block.text_at(at.part))
235 else {
236 return at.home();
237 };
238 Cursor {
239 offset: ui::input::line_start(&text.text, at.offset.min(text.text.len())),
240 ..at
241 }
242}
243
244fn line_end(at: Cursor, doc: &Doc) -> Cursor {
245 let Some(text) = doc
246 .blocks
247 .get(at.block)
248 .and_then(|block| block.text_at(at.part))
249 else {
250 return at.end(doc);
251 };
252 Cursor {
253 offset: ui::input::line_end(&text.text, at.offset.min(text.text.len())),
254 ..at
255 }
256}
257
258/// The document a source view is edited as: one fence holding the markdown.
259///
260/// A fence rather than a paragraph because a fence is the block whose caret
261/// already behaves like a plain text editor's — Enter is a newline, nothing
262/// typed into it is markup, and its lines are laid out one per source line.
263fn source_doc(source: &str) -> Doc {
264 Doc {
265 blocks: vec![Block::new(BlockKind::Code {
266 language: Some(markdown::source::LANGUAGES[0].to_string()),
267 code: Text::plain(source),
268 height: None,
269 })],
270 }
271}
272
273/// A floating menu a block drops. A `Popup` rather than an `Option` for the
274/// exit phase, and for the press note: the card's `on_mouse_down_out` fires on
275/// the *press*, so without one a trigger's click on the *release* reopens what
276/// it just shut.
277pub(crate) type MenuPopup<T> = ui::popover::Popup<Dropped<T>>;
278
279/// What a dropped menu belongs to, where it hangs, and its live row.
280pub(crate) struct Dropped<T> {
281 pub of: T,
282 pub at: gpui::Point<gpui::Pixels>,
283 pub cursor: ui::menu::Cursor,
284}
285
286impl<T> Dropped<T> {
287 pub fn new(of: T, at: gpui::Point<gpui::Pixels>) -> Self {
288 Self {
289 of,
290 at,
291 cursor: ui::menu::Cursor::default(),
292 }
293 }
294}
295
296/// The row, column, or cell whose table menu is open.
297#[derive(Clone, Copy, PartialEq, Eq)]
298pub(crate) enum TableTarget {
299 Row(usize),
300 Column(usize),
301 Cell { row: usize, column: usize },
302}
303
304/// A table's row or column, as [`markdown::Part::Cell`] numbers them.
305#[derive(Clone, Copy, Debug, PartialEq, Eq)]
306pub(crate) enum Line {
307 Row(usize),
308 Column(usize),
309}
310
311/// Where a reveal leaves the caret's row in the scroll box.
312#[derive(Clone, Copy, Debug, PartialEq, Eq)]
313pub(crate) enum Reveal {
314 /// The least scroll that brings the row inside the box.
315 Nearest,
316 /// The row at the box's top edge, or as near it as the document's end
317 /// allows.
318 Top,
319}
320
321pub struct Editor {
322 doc: Doc,
323 /// The dialect this document is read and written in — the app's own marks,
324 /// taken once at construction. One editor, one spelling: a document that
325 /// changed dialect between a read and a write would rewrite itself.
326 marks: markdown::Marks,
327 /// Which of the editor's own affordances paint. The app's, so one document
328 /// can carry the lot and another none of it.
329 chrome: Chrome,
330 /// Which form the document is in. In [`Mode::Source`] `doc` is one fenced
331 /// block holding the markdown, so every operation below that is about
332 /// *blocks* asks [`Editor::blocks`] first.
333 mode: Mode,
334 /// Collapsed for an ordinary caret, so there is one position here rather
335 /// than a caret and a range that can disagree.
336 selection: Selection,
337 focus_handle: FocusHandle,
338 /// The IME composition range within the caret's text, underlined while it
339 /// is being composed.
340 marked: Option<Range<usize>>,
341 /// Where each text landed last frame, so a click can be turned into a
342 /// caret. Only paint knows this, so the renderer fills it.
343 layouts: BlockLayouts,
344 history: History,
345 /// Which half of the blink the caret is in. Flipped by [`Self::start_blink`].
346 caret_on: bool,
347 /// The blink, alive only while the document holds focus.
348 blink: Option<Task<()>>,
349 /// Comment ranges, mapped through every edit and snapshotted with the
350 /// document. Here rather than in the app because an undo restores a whole
351 /// document and leaves no delta an app could map its own copy through.
352 anchors: Vec<Anchor>,
353 /// Marks the next typed character will carry — cmd-B at a collapsed caret,
354 /// which otherwise has no range to apply to and so would do nothing.
355 /// Cleared by any motion, because they belong to a spot and not to a mood.
356 stored: Vec<Mark>,
357 /// The open slash menu, if `/` started one.
358 slash: Option<Slash>,
359 mention: Option<crate::mention::MentionMenu>,
360 /// The open paste menu, if a URL landed in a block of its own.
361 pasted: Option<link::Paste>,
362 /// The open prompt, if an image is waiting to be told where to look.
363 url_prompt: Option<image::Prompt>,
364 /// The block a file being dragged over the document would land after.
365 dropping: Option<usize>,
366 /// The block the pointer is over, which is the only one showing a handle.
367 hovered: Option<usize>,
368 /// The table cell the pointer is over, whose row and column show handles.
369 hovered_cell: Option<(usize, Part)>,
370 /// A table row's or column's menu: the table, the line and where it hangs.
371 table_drag: Option<table::TableDrag>,
372 table_dragged: bool,
373 table_menu: MenuPopup<(usize, TableTarget)>,
374 /// The right-click menu on text, with its rows as they stood when it
375 /// opened.
376 text_menu: MenuPopup<Vec<ui::menu::Item>>,
377 /// The right-click menu on a picture.
378 image_menu: MenuPopup<image::ImageTarget>,
379 /// A block being dragged by its handle, and where it would land.
380 lifted: Option<(usize, usize)>,
381 /// An image being dragged wider or narrower by its edge handle, and the
382 /// width it holds now — `None` being the natural one, exactly as the
383 /// document spells it. The document only learns the final width on
384 /// release, the same reason `lifted` waits for the drop; carrying the
385 /// document's own value here is what makes a press that never moved
386 /// read back as no change at all.
387 resizing: Option<(usize, Option<u32>)>,
388 /// A painted block being dragged taller or shorter by its bottom handle.
389 sizing: Option<sizing::Sizing>,
390 /// The block menu the handle opened, over the block and its rows.
391 block_menu: MenuPopup<(usize, crate::slash::Rows)>,
392 /// The language menu a fence's header opened, over its block.
393 language_menu: MenuPopup<usize>,
394 /// Set by a floating layer's press — the gutter handle, the URL prompt —
395 /// so the editor's own press does not undo what that press just did.
396 press_claimed: bool,
397 /// Where the editor's own box starts, so a position recorded in window
398 /// coordinates can be placed inside it, and how far it reaches — which is
399 /// how wide a resized image is allowed to be. Its own box rather than the
400 /// picture's: a picture already narrowed would otherwise be its own
401 /// ceiling, and no drag could ever widen it again.
402 origin: gpui::Point<gpui::Pixels>,
403 width: gpui::Pixels,
404 /// The press being dragged out: what it selects by, and what it selected.
405 dragging: Option<(ui::input::Granularity, Range<Cursor>)>,
406 /// Whether the pointer is over painted text, which is the only place the
407 /// editor claims an I-beam.
408 over_text: bool,
409 /// The host's scroll box, when it gave one, and the reveal the caret still
410 /// owes it.
411 scroll: Option<gpui::ScrollHandle>,
412 reveal: Option<Reveal>,
413 /// Where a held drag last was, in window coordinates.
414 drag_at: Option<gpui::Point<gpui::Pixels>>,
415 /// Scrolls [`Self::scroll`] while a drag is held past its top or bottom.
416 edge_scroll: Option<Task<()>>,
417 /// Where the gutter handle was placed this frame, so the frame after can
418 /// tell whether the block moved out from under it.
419 handle_at: Option<gpui::Point<gpui::Pixels>>,
420 /// The column held across consecutive vertical moves.
421 goal: Option<gpui::Pixels>,
422 /// The size the app set this document in, in points, or `None` to follow
423 /// the app's own text size. Absolute rather than a factor over the ladder,
424 /// so moving the interface size leaves a document set to 16pt at 16pt.
425 ///
426 /// What the chords move is the shared adjustment on top of this; the base
427 /// itself is the app's alone.
428 text_size: Option<f32>,
429 /// The directory relative image paths resolve against.
430 base: Option<std::path::PathBuf>,
431 image_overlay: Option<markdown::ImageOverlay>,
432 image_overlay_corner: markdown::ImageOverlayCorner,
433}
434
435impl Editor {
436 pub fn new(source: &str, cx: &mut Context<Self>) -> Self {
437 let marks = cx.marks();
438 let mut doc = markdown::parse_with(source, &marks);
439 ensure_block(&mut doc);
440 Self {
441 marks,
442 // Clamped, not defaulted: a document opening on a fence or a table
443 // has no body at block zero, and a caret claiming one resolves
444 // against nothing until something moves it.
445 selection: Selection::at(Cursor::default().clamp(&doc)),
446 doc,
447 chrome: Chrome::default(),
448 mode: Mode::default(),
449 focus_handle: cx.focus_handle(),
450 marked: None,
451 layouts: BlockLayouts::default(),
452 history: History::default(),
453 caret_on: true,
454 blink: None,
455 anchors: Vec::new(),
456 stored: Vec::new(),
457 slash: None,
458 mention: None,
459 pasted: None,
460 url_prompt: None,
461 dropping: None,
462 hovered: None,
463 hovered_cell: None,
464 table_menu: Default::default(),
465 text_menu: Default::default(),
466 image_menu: Default::default(),
467 table_drag: None,
468 table_dragged: false,
469 lifted: None,
470 resizing: None,
471 sizing: None,
472 block_menu: MenuPopup::default(),
473 language_menu: MenuPopup::default(),
474 press_claimed: false,
475 origin: gpui::Point::default(),
476 width: gpui::Pixels::ZERO,
477 dragging: None,
478 over_text: false,
479 scroll: None,
480 reveal: None,
481 drag_at: None,
482 edge_scroll: None,
483 goal: None,
484 handle_at: None,
485 text_size: None,
486 base: None,
487 image_overlay: None,
488 image_overlay_corner: markdown::ImageOverlayCorner::default(),
489 }
490 }
491
492 /// How many undo steps to keep. App-wide configuration would be a gpui
493 /// global alongside [`init`], not a `Theme` field — the theme is rebuilt on
494 /// every light/dark switch, which would quietly reset anything behavioural
495 /// parked in it.
496 pub fn with_undo_limit(mut self, limit: usize) -> Self {
497 self.history = History::with_limit(limit);
498 self
499 }
500
501 /// Read and write this document with marks of its own, rather than the ones
502 /// [`markdown::AppExt::set_marks`] installed. For an app whose editors do not all
503 /// speak the same dialect.
504 pub fn with_marks(mut self, marks: markdown::Marks) -> Self {
505 let source = self.source();
506 self.marks = marks;
507 self.doc = markdown::parse_with(&source, &self.marks);
508 ensure_block(&mut self.doc);
509 self.selection = self.selection.clamp(&self.doc);
510 self
511 }
512
513 /// Which of the editor's own affordances to paint. See [`Chrome`].
514 pub fn with_chrome(mut self, chrome: Chrome) -> Self {
515 self.chrome = chrome;
516 self
517 }
518
519 /// Adds an app-provided hover control to pictures in rich mode.
520 pub fn with_image_overlay(mut self, overlay: markdown::ImageOverlay) -> Self {
521 self.image_overlay = Some(overlay);
522 self
523 }
524
525 /// Replaces or removes the picture hover control.
526 pub fn set_image_overlay(
527 &mut self,
528 overlay: Option<markdown::ImageOverlay>,
529 cx: &mut Context<Self>,
530 ) {
531 self.image_overlay = overlay;
532 cx.notify();
533 }
534
535 /// Positions picture hover controls; bottom-right by default.
536 pub fn with_image_overlay_corner(mut self, corner: markdown::ImageOverlayCorner) -> Self {
537 self.image_overlay_corner = corner;
538 self
539 }
540
541 /// Repositions the picture hover control.
542 pub fn set_image_overlay_corner(
543 &mut self,
544 corner: markdown::ImageOverlayCorner,
545 cx: &mut Context<Self>,
546 ) {
547 self.image_overlay_corner = corner;
548 cx.notify();
549 }
550
551 /// What is painting now, for an app whose own bar mirrors it.
552 pub fn chrome(&self) -> Chrome {
553 self.chrome
554 }
555
556 /// Open in [`Mode::Source`] rather than on the document — an app whose
557 /// editor is a markdown file first. Nothing is recorded: this is where the
558 /// document starts, not a switch to step back over.
559 pub fn with_mode(mut self, mode: Mode) -> Self {
560 if mode != self.mode {
561 self.switch(mode);
562 }
563 self
564 }
565
566 /// Open the document at a size of its own, in points — the app's settings
567 /// field for prose. Unset, it is set at the app's own text size.
568 ///
569 /// The base, not the current size: `cmd-+` moves a shared adjustment over
570 /// this, and `cmd-0` clears that adjustment to come back here.
571 pub fn with_text_size(mut self, points: f32) -> Self {
572 self.text_size = Some(points);
573 self
574 }
575
576 /// Update the configured base size without changing the temporary zoom.
577 pub fn set_text_size(&mut self, points: f32, cx: &mut Context<Self>) {
578 if self.text_size != Some(points) {
579 self.text_size = Some(points);
580 cx.notify();
581 }
582 }
583
584 /// The base the app set, if any. Add
585 /// [`crate::AppExt::editor_text_size_adjustment`](crate::AppExt::editor_text_size_adjustment) for what is on
586 /// screen.
587 pub fn text_size(&self) -> Option<f32> {
588 self.text_size
589 }
590
591 /// Resolve relative image paths against `dir` — the document's own folder,
592 /// for a document that keeps its pictures beside it. The stored URL stays
593 /// as written.
594 pub fn with_base(mut self, dir: impl Into<std::path::PathBuf>) -> Self {
595 self.base = Some(dir.into());
596 self
597 }
598
599 /// Change or clear the directory relative image paths resolve against.
600 pub fn set_base(&mut self, dir: Option<std::path::PathBuf>, cx: &mut Context<Self>) {
601 if self.base != dir {
602 self.base = dir;
603 cx.notify();
604 }
605 }
606
607 /// The directory relative image paths resolve against, if one is set.
608 pub fn base(&self) -> Option<&std::path::Path> {
609 self.base.as_deref()
610 }
611
612 /// The box the document scrolls in, so typing off the bottom follows the
613 /// caret down and a drag held past its top or bottom scrolls it.
614 ///
615 /// The host's rather than the editor's: a document goes in whatever pane
616 /// the app gives it, and the gutter handle, the drop indicator and the
617 /// menus are all placed absolutely against this editor's own origin — put
618 /// the scroll box here and every one of them would be offset twice.
619 pub fn with_scroll(mut self, handle: gpui::ScrollHandle) -> Self {
620 self.scroll = Some(handle);
621 self
622 }
623
624 pub fn doc(&self) -> &Doc {
625 &self.doc
626 }
627
628 pub fn selection(&self) -> Selection {
629 self.selection
630 }
631
632 /// Put the selection somewhere — what a thread in a sidebar does when it is
633 /// clicked, and what a caret restored with a document needs.
634 ///
635 /// Clamped, because the caller's range came from somewhere the document may
636 /// have moved on from.
637 pub fn select(&mut self, selection: Selection, cx: &mut Context<Self>) {
638 self.select_revealing(selection, Reveal::Nearest, cx);
639 }
640
641 /// [`Self::select`], scrolling the caret's row to the top of the scroll
642 /// box — what a jump to a heading wants, from either side of it.
643 pub fn select_to_top(&mut self, selection: Selection, cx: &mut Context<Self>) {
644 self.select_revealing(selection, Reveal::Top, cx);
645 }
646
647 fn select_revealing(&mut self, selection: Selection, reveal: Reveal, cx: &mut Context<Self>) {
648 self.selection = selection.clamp(&self.doc);
649 self.history.interrupt();
650 self.reveal = Some(reveal);
651 self.caret_moved();
652 cx.notify();
653 }
654
655 /// Where the selection sits on screen, in window coordinates, so a host can
656 /// float a toolbar at it.
657 ///
658 /// The head's row only — a selection spanning ten blocks wants its bubble
659 /// where the pointer left off, not centred over the whole span. `None` when
660 /// nothing is selected or the caret has not painted yet.
661 /// Where everything landed last frame — blocks, pictures, a fence's
662 /// language label, and the row rects of any range.
663 ///
664 /// Handed out whole rather than a method per question: an app placing
665 /// chrome of its own asks the geometry, and which question it needs is not
666 /// this crate's to guess. See [`markdown::BlockLayouts`].
667 pub fn layouts(&self) -> &BlockLayouts {
668 &self.layouts
669 }
670
671 pub fn selection_bounds(&self) -> Option<gpui::Bounds<gpui::Pixels>> {
672 // The head alone. A bar centred over the whole selection wants
673 // `layouts().rects(selection)`, which is every painted row of it.
674 if self.selection.is_collapsed() {
675 return None;
676 }
677 let (point, line_height) = self
678 .layouts
679 .position(self.selection.head, self.selection.affinity)?;
680 Some(gpui::Bounds::new(
681 point,
682 gpui::size(gpui::px(0.0), line_height),
683 ))
684 }
685}
686
687impl EventEmitter<EditorEvent> for Editor {}
688
689impl Focusable for Editor {
690 fn focus_handle(&self, _: &App) -> FocusHandle {
691 self.focus_handle.clone()
692 }
693}