#![allow(rustdoc::private_intra_doc_links)]//! This is the place where everything editor-related is stored (data-wise) and displayed (ui-wise).//! The main point of interest in this crate is [`Editor`] type, which is used in every other Zed part as a user input element.//! It comes in different flavors: single line, multiline and a fixed height one.//!//! Editor contains of multiple large submodules://! * [`element`] — the place where all rendering happens//! * [`display_map`] - chunks up text in the editor into the logical blocks, establishes coordinates and mapping between each of them.//! Contains all metadata related to text transformations (folds, fake inlay text insertions, soft wraps, tab markup, etc.).//! * [`inlay_hint_cache`] - is a storage of inlay hints out of LSP requests, responsible for querying LSP and updating `display_map`'s state accordingly.//!//! All other submodules and structs are mostly concerned with holding editor data about the way it displays current buffer region(s).//!//! If you're looking to improve Vim mode, you should check out Vim crate that wraps Editor and overrides its behavior.pub mod actions;mod blame_entry_tooltip;mod blink_manager;mod debounced_delay;pub mod display_map;mod editor_settings;mod editor_settings_controls;mod element;mod git;mod highlight_matching_bracket;mod hover_links;mod hover_popover;mod hunk_diff;mod indent_guides;mod inlay_hint_cache;mod inline_completion_provider;pub mod items;mod linked_editing_ranges;mod mouse_context_menu;pub mod movement;mod persistence;mod rust_analyzer_ext;pub mod scroll;mod selections_collection;pub mod tasks; #[cfg(test)]mod editor_tests;mod signature_help;#[cfg(any(test, feature = "test-support"))]pub mod test; use ::git::diff::{DiffHunk, DiffHunkStatus};use ::git::{parse_git_remote_url, BuildPermalinkParams, GitHostingProviderRegistry};pub(crate) use actions::*;use aho_corasick::AhoCorasick;use anyhow::{anyhow, Context as _, Result};use blink_manager::BlinkManager;use client::{Collaborator, ParticipantIndex};use clock::ReplicaId;use collections::{BTreeMap, Bound, HashMap, HashSet, VecDeque};use convert_case::{Case, Casing};use debounced_delay::DebouncedDelay;use display_map::*;pub use display_map::{DisplayPoint, FoldPlaceholder};pub use editor_settings::{CurrentLineHighlight, EditorSettings};pub use editor_settings_controls::*;use element::LineWithInvisibles;pub use element::{ CursorLayout, EditorElement, HighlightedRange, HighlightedRangeLine, PointForPosition,};use futures::FutureExt;use fuzzy::{StringMatch, StringMatchCandidate};use git::blame::GitBlame;use git::diff_hunk_to_display;use gpui::{ div, impl_actions, point, prelude::*, px, relative, size, uniform_list, Action, AnyElement, AppContext, AsyncWindowContext, AvailableSpace, BackgroundExecutor, Bounds, ClipboardItem, Context, DispatchPhase, ElementId, EntityId, EventEmitter, FocusHandle, FocusOutEvent, FocusableView, FontId, FontWeight, HighlightStyle, Hsla, InteractiveText, KeyContext, ListSizingBehavior, Model, MouseButton, PaintQuad, ParentElement, Pixels, Render, SharedString, Size, StrikethroughStyle, Styled, StyledText, Subscription, Task, TextStyle, UnderlineStyle, UniformListScrollHandle, View, ViewContext, ViewInputHandler, VisualContext, WeakFocusHandle, WeakView, WindowContext,};use highlight_matching_bracket::refresh_matching_bracket_highlights;use hover_popover::{hide_hover, HoverState};use hunk_diff::ExpandedHunks;pub(crate) use hunk_diff::HoveredHunk;use indent_guides::ActiveIndentGuidesState;use inlay_hint_cache::{InlayHintCache, InlaySplice, InvalidationStrategy};pub use inline_completion_provider::*;pub use items::MAX_TAB_TITLE_LEN;use itertools::Itertools;use language::{ char_kind, language_settings::{self, all_language_settings, InlayHintSettings}, markdown, point_from_lsp, AutoindentMode, BracketPair, Buffer, Capability, CharKind, CodeLabel, CursorShape, Diagnostic, Documentation, IndentKind, IndentSize, Language, OffsetRangeExt, Point, Selection, SelectionGoal, TransactionId,};use language::{point_to_lsp, BufferRow, Runnable, RunnableRange};use linked_editing_ranges::refresh_linked_ranges;use task::{ResolvedTask, TaskTemplate, TaskVariables}; use hover_links::{HoverLink, HoveredLinkState, InlayHighlight};pub use lsp::CompletionContext;use lsp::{ CompletionItemKind, CompletionTriggerKind, DiagnosticSeverity, InsertTextFormat, LanguageServerId,};use mouse_context_menu::MouseContextMenu;use movement::TextLayoutDetails;pub use multi_buffer::{ Anchor, AnchorRangeExt, ExcerptId, ExcerptRange, MultiBuffer, MultiBufferSnapshot, ToOffset, ToPoint,};use multi_buffer::{ExpandExcerptDirection, MultiBufferPoint, MultiBufferRow, ToOffsetUtf16};use ordered_float::OrderedFloat;use parking_lot::{Mutex, RwLock};use project::project_settings::{GitGutterSetting, ProjectSettings};use project::{ CodeAction, Completion, FormatTrigger, Item, Location, Project, ProjectPath, ProjectTransaction, TaskSourceKind, WorktreeId,};use rand::prelude::*;use rpc::{proto::*, ErrorExt};use scroll::{Autoscroll, OngoingScroll, ScrollAnchor, ScrollManager, ScrollbarAutoHide};use selections_collection::{resolve_multiple, MutableSelectionsCollection, SelectionsCollection};use serde::{Deserialize, Serialize};use settings::{update_settings_file, Settings, SettingsStore};use smallvec::SmallVec;use snippet::Snippet;use std::{ any::TypeId, borrow::Cow, cell::RefCell, cmp::{self, Ordering, Reverse}, mem, num::NonZeroU32, ops::{ControlFlow, Deref, DerefMut, Not as _, Range, RangeInclusive}, path::{Path, PathBuf}, rc::Rc, sync::Arc, time::{Duration, Instant},};pub use sum_tree::Bias;use sum_tree::TreeMap;use text::{BufferId, OffsetUtf16, Rope};use theme::{ observe_buffer_font_size_adjustment, ActiveTheme, PlayerColor, StatusColors, SyntaxTheme, ThemeColors, ThemeSettings,};use ui::{ h_flex, prelude::*, ButtonSize, ButtonStyle, Disclosure, IconButton, IconName, IconSize, ListItem, Popover, Tooltip,};use util::{defer, maybe, post_inc, RangeExt, ResultExt, TryFutureExt};use workspace::item::{ItemHandle, PreviewTabsSettings};use workspace::notifications::{DetachAndPromptErr, NotificationId};use workspace::{ searchable::SearchEvent, ItemNavHistory, SplitDirection, ViewId, Workspace, WorkspaceId,};use workspace::{OpenInTerminal, OpenTerminal, TabBarSettings, Toast}; use crate::hover_links::find_url;use crate::signature_help::{SignatureHelpHiddenBy, SignatureHelpState}; pub const FILE_HEADER_HEIGHT: u32 = 1;pub const MULTI_BUFFER_EXCERPT_HEADER_HEIGHT: u32 = 1;pub const MULTI_BUFFER_EXCERPT_FOOTER_HEIGHT: u32 = 1;pub const DEFAULT_MULTIBUFFER_CONTEXT: u32 = 2;const CURSOR_BLINK_INTERVAL: Duration = Duration::from_millis(500);const MAX_LINE_LEN: usize = 1024;const MIN_NAVIGATION_HISTORY_ROW_DELTA: i64 = 10;const MAX_SELECTION_HISTORY_LEN: usize = 1024;pub(crate) const CURSORS_VISIBLE_FOR: Duration = Duration::from_millis(2000);#[doc(hidden)]pub const CODE_ACTIONS_DEBOUNCE_TIMEOUT: Duration = Duration::from_millis(250);#[doc(hidden)]pub const DOCUMENT_HIGHLIGHTS_DEBOUNCE_TIMEOUT: Duration = Duration::from_millis(75); pub(crate) const FORMAT_TIMEOUT: Duration = Duration::from_secs(2); pub fn render_parsed_markdown( element_id: impl Into<ElementId>, parsed: &language::ParsedMarkdown, editor_style: &EditorStyle, workspace: Option<WeakView<Workspace>>, cx: &mut WindowContext,) -> InteractiveText { let code_span_background_color = cx .theme() .colors() .editor_document_highlight_read_background; let highlights = gpui::combine_highlights( parsed.highlights.iter().filter_map(|(range, highlight)| { let highlight = highlight.to_highlight_style(&editor_style.syntax)?; Some((range.clone(), highlight)) }), parsed .regions .iter() .zip(&parsed.region_ranges) .filter_map(|(region, range)| { if region.code { Some(( range.clone(), HighlightStyle { background_color: Some(code_span_background_color), ..Default::default() }, )) } else { None } }), ); let mut links = Vec::new(); let mut link_ranges = Vec::new(); for (range, region) in parsed.region_ranges.iter().zip(&parsed.regions) { if let Some(link) = region.link.clone() { links.push(link); link_ranges.push(range.clone()); } } InteractiveText::new( element_id, StyledText::new(parsed.text.clone()).with_highlights(&editor_style.text, highlights), ) .on_click(link_ranges, move |clicked_range_ix, cx| { match &links[clicked_range_ix] { markdown::Link::Web { url } => cx.open_url(url), markdown::Link::Path { path } => { if let Some(workspace) = &workspace { _ = workspace.update(cx, |workspace, cx| { workspace.open_abs_path(path.clone(), false, cx).detach(); }); } } } })} #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]pub(crate) enum InlayId { Suggestion(usize), Hint(usize),} impl InlayId { fn id(&self) -> usize { match self { Self::Suggestion(id) => *id, Self::Hint(id) => *id, } }} enum DiffRowHighlight {}enum DocumentHighlightRead {}enum DocumentHighlightWrite {}enum InputComposition {} #[derive(Copy, Clone, PartialEq, Eq)]pub enum Direction { Prev, Next,} pub fn init_settings(cx: &mut AppContext) { EditorSettings::register(cx);} pub fn init(cx: &mut AppContext) { init_settings(cx); workspace::register_project_item::<Editor>(cx); workspace::FollowableViewRegistry::register::<Editor>(cx); workspace::register_serializable_item::<Editor>(cx); cx.observe_new_views( |workspace: &mut Workspace, _cx: &mut ViewContext<Workspace>| { workspace.register_action(Editor::new_file); workspace.register_action(Editor::new_file_in_direction); }, ) .detach(); cx.on_action(move |_: &workspace::NewFile, cx| { let app_state = workspace::AppState::global(cx); if let Some(app_state) = app_state.upgrade() { workspace::open_new(app_state, cx, |workspace, cx| { Editor::new_file(workspace, &Default::default(), cx) }) .detach(); } }); cx.on_action(move |_: &workspace::NewWindow, cx| { let app_state = workspace::AppState::global(cx); if let Some(app_state) = app_state.upgrade() { workspace::open_new(app_state, cx, |workspace, cx| { Editor::new_file(workspace, &Default::default(), cx) }) .detach(); } });} pub struct SearchWithinRange; trait InvalidationRegion { fn ranges(&self) -> &[Range<Anchor>];} #[derive(Clone, Debug, PartialEq)]pub enum SelectPhase { Begin { position: DisplayPoint, add: bool, click_count: usize, }, BeginColumnar { position: DisplayPoint, reset: bool, goal_column: u32, }, Extend { position: DisplayPoint, click_count: usize, }, Update { position: DisplayPoint, goal_column: u32, scroll_delta: gpui::Point<f32>, }, End,} #[derive(Clone, Debug)]pub enum SelectMode { Character, Word(Range<Anchor>), Line(Range<Anchor>), All,} #[derive(Copy, Clone, PartialEq, Eq, Debug)]pub enum EditorMode { SingleLine { auto_width: bool }, AutoHeight { max_lines: usize }, Full,} #[derive(Clone, Debug)]pub enum SoftWrap { None, PreferLine, EditorWidth, Column(u32),} #[derive(Clone)]pub struct EditorStyle { pub background: Hsla, pub local_player: PlayerColor, pub text: TextStyle, pub scrollbar_width: Pixels, pub syntax: Arc<SyntaxTheme>, pub status: StatusColors, pub inlay_hints_style: HighlightStyle, pub suggestions_style: HighlightStyle,} impl Default for EditorStyle { fn default() -> Self { Self { background: Hsla::default(), local_player: PlayerColor::default(), text: TextStyle::default(), scrollbar_width: Pixels::default(), syntax: Default::default(), // HACK: Status colors don't have a real default. // We should look into removing the status colors from the editor // style and retrieve them directly from the theme. status: StatusColors::dark(), inlay_hints_style: HighlightStyle::default(), suggestions_style: HighlightStyle::default(), } }} type CompletionId = usize; #[derive(Copy, Clone, Eq, PartialEq, PartialOrd, Ord, Debug, Default)]struct EditorActionId(usize); impl EditorActionId { pub fn post_inc(&mut self) -> Self { let answer = self.0; *self = Self(answer + 1); Self(answer) }} // type GetFieldEditorTheme = dyn Fn(&theme::Theme) -> theme::FieldEditor;// type OverrideTextStyle = dyn Fn(&EditorStyle) -> Option<HighlightStyle>; type BackgroundHighlight = (fn(&ThemeColors) -> Hsla, Arc<[Range<Anchor>]>);type GutterHighlight = (fn(&AppContext) -> Hsla, Arc<[Range<Anchor>]>); #[derive(Default)]struct ScrollbarMarkerState { scrollbar_size: Size<Pixels>, dirty: bool, markers: Arc<[PaintQuad]>, pending_refresh: Option<Task<Result<()>>>,} impl ScrollbarMarkerState { fn should_refresh(&self, scrollbar_size: Size<Pixels>) -> bool { self.pending_refresh.is_none() && (self.scrollbar_size != scrollbar_size || self.dirty) }} #[derive(Clone, Debug)]struct RunnableTasks { templates: Vec<(TaskSourceKind, TaskTemplate)>, offset: MultiBufferOffset, // We need the column at which the task context evaluation should take place (when we're spawning it via gutter). column: u32, // Values of all named captures, including those starting with '_' extra_variables: HashMap<String, String>, // Full range of the tagged region. We use it to determine which `extra_variables` to grab for context resolution in e.g. a modal. context_range: Range<BufferOffset>,} #[derive(Clone)]struct ResolvedTasks { templates: SmallVec<[(TaskSourceKind, ResolvedTask); 1]>, position: Anchor,}#[derive(Copy, Clone, Debug)]struct MultiBufferOffset(usize);#[derive(Copy, Clone, Debug, PartialEq, PartialOrd)]struct BufferOffset(usize);/// Zed's primary text input `View`, allowing users to edit a [`MultiBuffer`]////// See the [module level documentation](self) for more information.pub struct Editor { focus_handle: FocusHandle, last_focused_descendant: Option<WeakFocusHandle>, /// The text buffer being edited buffer: Model<MultiBuffer>, /// Map of how text in the buffer should be displayed. /// Handles soft wraps, folds, fake inlay text insertions, etc. pub display_map: Model<DisplayMap>, pub selections: SelectionsCollection, pub scroll_manager: ScrollManager, /// When inline assist editors are linked, they all render cursors because /// typing enters text into each of them, even the ones that aren't focused. pub(crate) show_cursor_when_unfocused: bool, columnar_selection_tail: Option<Anchor>, add_selections_state: Option<AddSelectionsState>, select_next_state: Option<SelectNextState>, select_prev_state: Option<SelectNextState>, selection_history: SelectionHistory, autoclose_regions: Vec<AutocloseRegion>, snippet_stack: InvalidationStack<SnippetState>, select_larger_syntax_node_stack: Vec<Box<[Selection<usize>]>>, ime_transaction: Option<TransactionId>, active_diagnostics: Option<ActiveDiagnosticGroup>, soft_wrap_mode_override: Option<language_settings::SoftWrap>, project: Option<Model<Project>>, completion_provider: Option<Box<dyn CompletionProvider>>, collaboration_hub: Option<Box<dyn CollaborationHub>>, blink_manager: Model<BlinkManager>, show_cursor_names: bool, hovered_cursors: HashMap<HoveredCursor, Task<()>>, pub show_local_selections: bool, mode: EditorMode, show_breadcrumbs: bool, show_gutter: bool, show_line_numbers: Option<bool>, show_git_diff_gutter: Option<bool>, show_code_actions: Option<bool>, show_runnables: Option<bool>, show_wrap_guides: Option<bool>, show_indent_guides: Option<bool>, placeholder_text: Option<Arc<str>>, highlight_order: usize, highlighted_rows: HashMap<TypeId, Vec<RowHighlight>>, background_highlights: TreeMap<TypeId, BackgroundHighlight>, gutter_highlights: TreeMap<TypeId, GutterHighlight>, scrollbar_marker_state: ScrollbarMarkerState, active_indent_guides_state: ActiveIndentGuidesState, nav_history: Option<ItemNavHistory>, context_menu: RwLock<Option<ContextMenu>>, mouse_context_menu: Option<MouseContextMenu>, completion_tasks: Vec<(CompletionId, Task<Option<()>>)>, signature_help_state: SignatureHelpState,Lines 1–500 of 13193. Load more
#![allow(rustdoc::private_intra_doc_links)] //! This is the place where everything editor-related is stored (data-wise) and displayed (ui-wise). //! The main point of interest in this crate is [`Editor`] type, which is used in every other Zed part as a user input element. //! It comes in different flavors: single line, multiline and a fixed height one. //! //! Editor contains of multiple large submodules: //! * [`element`] — the place where all rendering happens //! * [`display_map`] - chunks up text in the editor into the logical blocks, establishes coordinates and mapping between each of them. //! Contains all metadata related to text transformations (folds, fake inlay text insertions, soft wraps, tab markup, etc.). //! * [`inlay_hint_cache`] - is a storage of inlay hints out of LSP requests, responsible for querying LSP and updating `display_map`'s state accordingly. //! //! All other submodules and structs are mostly concerned with holding editor data about the way it displays current buffer region(s). //! //! If you're looking to improve Vim mode, you should check out Vim crate that wraps Editor and overrides its behavior. pub mod actions; mod blame_entry_tooltip; mod blink_manager; mod debounced_delay; pub mod display_map; mod editor_settings; mod editor_settings_controls; mod element; mod git; mod highlight_matching_bracket; mod hover_links; mod hover_popover; mod hunk_diff; mod indent_guides; mod inlay_hint_cache; mod inline_completion_provider; pub mod items; mod linked_editing_ranges; mod mouse_context_menu; pub mod movement; mod persistence; mod rust_analyzer_ext; pub mod scroll; mod selections_collection; pub mod tasks; #[cfg(test)] mod editor_tests; mod signature_help; #[cfg(any(test, feature = "test-support"))] pub mod test; use ::git::diff::{DiffHunk, DiffHunkStatus}; use ::git::{parse_git_remote_url, BuildPermalinkParams, GitHostingProviderRegistry}; pub(crate) use actions::*; use aho_corasick::AhoCorasick; use anyhow::{anyhow, Context as _, Result}; use blink_manager::BlinkManager; use client::{Collaborator, ParticipantIndex}; use clock::ReplicaId; use collections::{BTreeMap, Bound, HashMap, HashSet, VecDeque}; use convert_case::{Case, Casing}; use debounced_delay::DebouncedDelay; use display_map::*; pub use display_map::{DisplayPoint, FoldPlaceholder}; pub use editor_settings::{CurrentLineHighlight, EditorSettings}; pub use editor_settings_controls::*; use element::LineWithInvisibles; pub use element::{ CursorLayout, EditorElement, HighlightedRange, HighlightedRangeLine, PointForPosition, }; use futures::FutureExt; use fuzzy::{StringMatch, StringMatchCandidate}; use git::blame::GitBlame; use git::diff_hunk_to_display; use gpui::{ div, impl_actions, point, prelude::*, px, relative, size, uniform_list, Action, AnyElement, AppContext, AsyncWindowContext, AvailableSpace, BackgroundExecutor, Bounds, ClipboardItem, Context, DispatchPhase, ElementId, EntityId, EventEmitter, FocusHandle, FocusOutEvent, FocusableView, FontId, FontWeight, HighlightStyle, Hsla, InteractiveText, KeyContext, ListSizingBehavior, Model, MouseButton, PaintQuad, ParentElement, Pixels, Render, SharedString, Size, StrikethroughStyle, Styled, StyledText, Subscription, Task, TextStyle, UnderlineStyle, UniformListScrollHandle, View, ViewContext, ViewInputHandler, VisualContext, WeakFocusHandle, WeakView, WindowContext, }; use highlight_matching_bracket::refresh_matching_bracket_highlights; use hover_popover::{hide_hover, HoverState}; use hunk_diff::ExpandedHunks; pub(crate) use hunk_diff::HoveredHunk; use indent_guides::ActiveIndentGuidesState; use inlay_hint_cache::{InlayHintCache, InlaySplice, InvalidationStrategy}; pub use inline_completion_provider::*; pub use items::MAX_TAB_TITLE_LEN; use itertools::Itertools; use language::{ char_kind, language_settings::{self, all_language_settings, InlayHintSettings}, markdown, point_from_lsp, AutoindentMode, BracketPair, Buffer, Capability, CharKind, CodeLabel, CursorShape, Diagnostic, Documentation, IndentKind, IndentSize, Language, OffsetRangeExt, Point, Selection, SelectionGoal, TransactionId, }; use language::{point_to_lsp, BufferRow, Runnable, RunnableRange}; use linked_editing_ranges::refresh_linked_ranges; use task::{ResolvedTask, TaskTemplate, TaskVariables}; use hover_links::{HoverLink, HoveredLinkState, InlayHighlight}; pub use lsp::CompletionContext; use lsp::{ CompletionItemKind, CompletionTriggerKind, DiagnosticSeverity, InsertTextFormat, LanguageServerId, }; use mouse_context_menu::MouseContextMenu; use movement::TextLayoutDetails; pub use multi_buffer::{ Anchor, AnchorRangeExt, ExcerptId, ExcerptRange, MultiBuffer, MultiBufferSnapshot, ToOffset, ToPoint, }; use multi_buffer::{ExpandExcerptDirection, MultiBufferPoint, MultiBufferRow, ToOffsetUtf16}; use ordered_float::OrderedFloat; use parking_lot::{Mutex, RwLock}; use project::project_settings::{GitGutterSetting, ProjectSettings}; use project::{ CodeAction, Completion, FormatTrigger, Item, Location, Project, ProjectPath, ProjectTransaction, TaskSourceKind, WorktreeId, }; use rand::prelude::*; use rpc::{proto::*, ErrorExt}; use scroll::{Autoscroll, OngoingScroll, ScrollAnchor, ScrollManager, ScrollbarAutoHide}; use selections_collection::{resolve_multiple, MutableSelectionsCollection, SelectionsCollection}; use serde::{Deserialize, Serialize}; use settings::{update_settings_file, Settings, SettingsStore}; use smallvec::SmallVec; use snippet::Snippet; use std::{ any::TypeId, borrow::Cow, cell::RefCell, cmp::{self, Ordering, Reverse}, mem, num::NonZeroU32, ops::{ControlFlow, Deref, DerefMut, Not as _, Range, RangeInclusive}, path::{Path, PathBuf}, rc::Rc, sync::Arc, time::{Duration, Instant}, }; pub use sum_tree::Bias; use sum_tree::TreeMap; use text::{BufferId, OffsetUtf16, Rope}; use theme::{ observe_buffer_font_size_adjustment, ActiveTheme, PlayerColor, StatusColors, SyntaxTheme, ThemeColors, ThemeSettings, }; use ui::{ h_flex, prelude::*, ButtonSize, ButtonStyle, Disclosure, IconButton, IconName, IconSize, ListItem, Popover, Tooltip, }; use util::{defer, maybe, post_inc, RangeExt, ResultExt, TryFutureExt}; use workspace::item::{ItemHandle, PreviewTabsSettings}; use workspace::notifications::{DetachAndPromptErr, NotificationId}; use workspace::{ searchable::SearchEvent, ItemNavHistory, SplitDirection, ViewId, Workspace, WorkspaceId, }; use workspace::{OpenInTerminal, OpenTerminal, TabBarSettings, Toast}; use crate::hover_links::find_url; use crate::signature_help::{SignatureHelpHiddenBy, SignatureHelpState}; pub const FILE_HEADER_HEIGHT: u32 = 1; pub const MULTI_BUFFER_EXCERPT_HEADER_HEIGHT: u32 = 1; pub const MULTI_BUFFER_EXCERPT_FOOTER_HEIGHT: u32 = 1; pub const DEFAULT_MULTIBUFFER_CONTEXT: u32 = 2; const CURSOR_BLINK_INTERVAL: Duration = Duration::from_millis(500); const MAX_LINE_LEN: usize = 1024; const MIN_NAVIGATION_HISTORY_ROW_DELTA: i64 = 10; const MAX_SELECTION_HISTORY_LEN: usize = 1024; pub(crate) const CURSORS_VISIBLE_FOR: Duration = Duration::from_millis(2000); #[doc(hidden)] pub const CODE_ACTIONS_DEBOUNCE_TIMEOUT: Duration = Duration::from_millis(250); #[doc(hidden)] pub const DOCUMENT_HIGHLIGHTS_DEBOUNCE_TIMEOUT: Duration = Duration::from_millis(75); pub(crate) const FORMAT_TIMEOUT: Duration = Duration::from_secs(2); pub fn render_parsed_markdown( element_id: impl Into<ElementId>, parsed: &language::ParsedMarkdown, editor_style: &EditorStyle, workspace: Option<WeakView<Workspace>>, cx: &mut WindowContext, ) -> InteractiveText { let code_span_background_color = cx .theme() .colors() .editor_document_highlight_read_background; let highlights = gpui::combine_highlights( parsed.highlights.iter().filter_map(|(range, highlight)| { let highlight = highlight.to_highlight_style(&editor_style.syntax)?; Some((range.clone(), highlight)) }), parsed .regions .iter() .zip(&parsed.region_ranges) .filter_map(|(region, range)| { if region.code { Some(( range.clone(), HighlightStyle { background_color: Some(code_span_background_color), ..Default::default() }, )) } else { None } }), ); let mut links = Vec::new(); let mut link_ranges = Vec::new(); for (range, region) in parsed.region_ranges.iter().zip(&parsed.regions) { if let Some(link) = region.link.clone() { links.push(link); link_ranges.push(range.clone()); } } InteractiveText::new( element_id, StyledText::new(parsed.text.clone()).with_highlights(&editor_style.text, highlights), ) .on_click(link_ranges, move |clicked_range_ix, cx| { match &links[clicked_range_ix] { markdown::Link::Web { url } => cx.open_url(url), markdown::Link::Path { path } => { if let Some(workspace) = &workspace { _ = workspace.update(cx, |workspace, cx| { workspace.open_abs_path(path.clone(), false, cx).detach(); }); } } } }) } #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] pub(crate) enum InlayId { Suggestion(usize), Hint(usize), } impl InlayId { fn id(&self) -> usize { match self { Self::Suggestion(id) => *id, Self::Hint(id) => *id, } } } enum DiffRowHighlight {} enum DocumentHighlightRead {} enum DocumentHighlightWrite {} enum InputComposition {} #[derive(Copy, Clone, PartialEq, Eq)] pub enum Direction { Prev, Next, } pub fn init_settings(cx: &mut AppContext) { EditorSettings::register(cx); } pub fn init(cx: &mut AppContext) { init_settings(cx); workspace::register_project_item::<Editor>(cx); workspace::FollowableViewRegistry::register::<Editor>(cx); workspace::register_serializable_item::<Editor>(cx); cx.observe_new_views( |workspace: &mut Workspace, _cx: &mut ViewContext<Workspace>| { workspace.register_action(Editor::new_file); workspace.register_action(Editor::new_file_in_direction); }, ) .detach(); cx.on_action(move |_: &workspace::NewFile, cx| { let app_state = workspace::AppState::global(cx); if let Some(app_state) = app_state.upgrade() { workspace::open_new(app_state, cx, |workspace, cx| { Editor::new_file(workspace, &Default::default(), cx) }) .detach(); } }); cx.on_action(move |_: &workspace::NewWindow, cx| { let app_state = workspace::AppState::global(cx); if let Some(app_state) = app_state.upgrade() { workspace::open_new(app_state, cx, |workspace, cx| { Editor::new_file(workspace, &Default::default(), cx) }) .detach(); } }); } pub struct SearchWithinRange; trait InvalidationRegion { fn ranges(&self) -> &[Range<Anchor>]; } #[derive(Clone, Debug, PartialEq)] pub enum SelectPhase { Begin { position: DisplayPoint, add: bool, click_count: usize, }, BeginColumnar { position: DisplayPoint, reset: bool, goal_column: u32, }, Extend { position: DisplayPoint, click_count: usize, }, Update { position: DisplayPoint, goal_column: u32, scroll_delta: gpui::Point<f32>, }, End, } #[derive(Clone, Debug)] pub enum SelectMode { Character, Word(Range<Anchor>), Line(Range<Anchor>), All, } #[derive(Copy, Clone, PartialEq, Eq, Debug)] pub enum EditorMode { SingleLine { auto_width: bool }, AutoHeight { max_lines: usize }, Full, } #[derive(Clone, Debug)] pub enum SoftWrap { None, PreferLine, EditorWidth, Column(u32), } #[derive(Clone)] pub struct EditorStyle { pub background: Hsla, pub local_player: PlayerColor, pub text: TextStyle, pub scrollbar_width: Pixels, pub syntax: Arc<SyntaxTheme>, pub status: StatusColors, pub inlay_hints_style: HighlightStyle, pub suggestions_style: HighlightStyle, } impl Default for EditorStyle { fn default() -> Self { Self { background: Hsla::default(), local_player: PlayerColor::default(), text: TextStyle::default(), scrollbar_width: Pixels::default(), syntax: Default::default(), // HACK: Status colors don't have a real default. // We should look into removing the status colors from the editor // style and retrieve them directly from the theme. status: StatusColors::dark(), inlay_hints_style: HighlightStyle::default(), suggestions_style: HighlightStyle::default(), } } } type CompletionId = usize; #[derive(Copy, Clone, Eq, PartialEq, PartialOrd, Ord, Debug, Default)] struct EditorActionId(usize); impl EditorActionId { pub fn post_inc(&mut self) -> Self { let answer = self.0; *self = Self(answer + 1); Self(answer) } } // type GetFieldEditorTheme = dyn Fn(&theme::Theme) -> theme::FieldEditor; // type OverrideTextStyle = dyn Fn(&EditorStyle) -> Option<HighlightStyle>; type BackgroundHighlight = (fn(&ThemeColors) -> Hsla, Arc<[Range<Anchor>]>); type GutterHighlight = (fn(&AppContext) -> Hsla, Arc<[Range<Anchor>]>); #[derive(Default)] struct ScrollbarMarkerState { scrollbar_size: Size<Pixels>, dirty: bool, markers: Arc<[PaintQuad]>, pending_refresh: Option<Task<Result<()>>>, } impl ScrollbarMarkerState { fn should_refresh(&self, scrollbar_size: Size<Pixels>) -> bool { self.pending_refresh.is_none() && (self.scrollbar_size != scrollbar_size || self.dirty) } } #[derive(Clone, Debug)] struct RunnableTasks { templates: Vec<(TaskSourceKind, TaskTemplate)>, offset: MultiBufferOffset, // We need the column at which the task context evaluation should take place (when we're spawning it via gutter). column: u32, // Values of all named captures, including those starting with '_' extra_variables: HashMap<String, String>, // Full range of the tagged region. We use it to determine which `extra_variables` to grab for context resolution in e.g. a modal. context_range: Range<BufferOffset>, } #[derive(Clone)] struct ResolvedTasks { templates: SmallVec<[(TaskSourceKind, ResolvedTask); 1]>, position: Anchor, } #[derive(Copy, Clone, Debug)] struct MultiBufferOffset(usize); #[derive(Copy, Clone, Debug, PartialEq, PartialOrd)] struct BufferOffset(usize); /// Zed's primary text input `View`, allowing users to edit a [`MultiBuffer`] /// /// See the [module level documentation](self) for more information. pub struct Editor { focus_handle: FocusHandle, last_focused_descendant: Option<WeakFocusHandle>, /// The text buffer being edited buffer: Model<MultiBuffer>, /// Map of how text in the buffer should be displayed. /// Handles soft wraps, folds, fake inlay text insertions, etc. pub display_map: Model<DisplayMap>, pub selections: SelectionsCollection, pub scroll_manager: ScrollManager, /// When inline assist editors are linked, they all render cursors because /// typing enters text into each of them, even the ones that aren't focused. pub(crate) show_cursor_when_unfocused: bool, columnar_selection_tail: Option<Anchor>, add_selections_state: Option<AddSelectionsState>, select_next_state: Option<SelectNextState>, select_prev_state: Option<SelectNextState>, selection_history: SelectionHistory, autoclose_regions: Vec<AutocloseRegion>, snippet_stack: InvalidationStack<SnippetState>, select_larger_syntax_node_stack: Vec<Box<[Selection<usize>]>>, ime_transaction: Option<TransactionId>, active_diagnostics: Option<ActiveDiagnosticGroup>, soft_wrap_mode_override: Option<language_settings::SoftWrap>, project: Option<Model<Project>>, completion_provider: Option<Box<dyn CompletionProvider>>, collaboration_hub: Option<Box<dyn CollaborationHub>>, blink_manager: Model<BlinkManager>, show_cursor_names: bool, hovered_cursors: HashMap<HoveredCursor, Task<()>>, pub show_local_selections: bool, mode: EditorMode, show_breadcrumbs: bool, show_gutter: bool, show_line_numbers: Option<bool>, show_git_diff_gutter: Option<bool>, show_code_actions: Option<bool>, show_runnables: Option<bool>, show_wrap_guides: Option<bool>, show_indent_guides: Option<bool>, placeholder_text: Option<Arc<str>>, highlight_order: usize, highlighted_rows: HashMap<TypeId, Vec<RowHighlight>>, background_highlights: TreeMap<TypeId, BackgroundHighlight>, gutter_highlights: TreeMap<TypeId, GutterHighlight>, scrollbar_marker_state: ScrollbarMarkerState, active_indent_guides_state: ActiveIndentGuidesState, nav_history: Option<ItemNavHistory>, context_menu: RwLock<Option<ContextMenu>>, mouse_context_menu: Option<MouseContextMenu>, completion_tasks: Vec<(CompletionId, Task<Option<()>>)>, signature_help_state: SignatureHelpState,