Skip to main content

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