1use crate::{
2 DebuggerTextObject, LanguageScope, Outline, OutlineConfig, RunnableCapture, RunnableTag,
3 TextObject, TreeSitterOptions,
4 diagnostic_set::{DiagnosticEntry, DiagnosticGroup},
5 language_settings::{LanguageSettings, language_settings},
6 outline::OutlineItem,
7 syntax_map::{
8 SyntaxLayer, SyntaxMap, SyntaxMapCapture, SyntaxMapCaptures, SyntaxMapMatch,
9 SyntaxMapMatches, SyntaxSnapshot, ToTreeSitterPoint,
10 },
11 task_context::RunnableRange,
12 text_diff::text_diff,
13};
14pub use crate::{
15 Grammar, Language, LanguageRegistry,
16 diagnostic_set::DiagnosticSet,
17 highlight_map::{HighlightId, HighlightMap},
18 proto,
19};
20use anyhow::{Context as _, Result};
21pub use clock::ReplicaId;
22use clock::{AGENT_REPLICA_ID, Lamport};
23use collections::HashMap;
24use fs::MTime;
25use futures::channel::oneshot;
26use gpui::{
27 App, AppContext as _, Context, Entity, EventEmitter, HighlightStyle, SharedString, StyledText,
28 Task, TaskLabel, TextStyle,
29};
30use lsp::{LanguageServerId, NumberOrString};
31use parking_lot::Mutex;
32use schemars::JsonSchema;
33use serde::{Deserialize, Serialize};
34use serde_json::Value;
35use settings::WorktreeId;
36use smallvec::SmallVec;
37use smol::future::yield_now;
38use std::{
39 any::Any,
40 borrow::Cow,
41 cell::Cell,
42 cmp::{self, Ordering, Reverse},
43 collections::{BTreeMap, BTreeSet},
44 ffi::OsStr,
45 future::Future,
46 iter::{self, Iterator, Peekable},
47 mem,
48 num::NonZeroU32,
49 ops::{Deref, Range},
50 path::{Path, PathBuf},
51 rc,
52 sync::{Arc, LazyLock},
53 time::{Duration, Instant},
54 vec,
55};
56use sum_tree::TreeMap;
57use text::operation_queue::OperationQueue;
58use text::*;
59pub use text::{
60 Anchor, Bias, Buffer as TextBuffer, BufferId, BufferSnapshot as TextBufferSnapshot, Edit,
61 LineIndent, OffsetRangeExt, OffsetUtf16, Patch, Point, PointUtf16, Rope, Selection,
62 SelectionGoal, Subscription, TextDimension, TextSummary, ToOffset, ToOffsetUtf16, ToPoint,
63 ToPointUtf16, Transaction, TransactionId, Unclipped,
64};
65use theme::{ActiveTheme as _, SyntaxTheme};
66#[cfg(any(test, feature = "test-support"))]
67use util::RandomCharIter;
68use util::{RangeExt, debug_panic, maybe};
69
70#[cfg(any(test, feature = "test-support"))]
71pub use {tree_sitter_python, tree_sitter_rust, tree_sitter_typescript};
72
73pub use lsp::DiagnosticSeverity;
74
75/// A label for the background task spawned by the buffer to compute
76/// a diff against the contents of its file.
77pub static BUFFER_DIFF_TASK: LazyLock<TaskLabel> = LazyLock::new(TaskLabel::new);
78
79/// Indicate whether a [`Buffer`] has permissions to edit.
80#[derive(PartialEq, Clone, Copy, Debug)]
81pub enum Capability {
82 /// The buffer is a mutable replica.
83 ReadWrite,
84 /// The buffer is a read-only replica.
85 ReadOnly,
86}
87
88pub type BufferRow = u32;
89
90/// An in-memory representation of a source code file, including its text,
91/// syntax trees, git status, and diagnostics.
92pub struct Buffer {
93 text: TextBuffer,
94 branch_state: Option<BufferBranchState>,
95 /// Filesystem state, `None` when there is no path.
96 file: Option<Arc<dyn File>>,
97 /// The mtime of the file when this buffer was last loaded from
98 /// or saved to disk.
99 saved_mtime: Option<MTime>,
100 /// The version vector when this buffer was last loaded from
101 /// or saved to disk.
102 saved_version: clock::Global,
103 preview_version: clock::Global,
104 transaction_depth: usize,
105 was_dirty_before_starting_transaction: Option<bool>,
106 reload_task: Option<Task<Result<()>>>,
107 language: Option<Arc<Language>>,
108 autoindent_requests: Vec<Arc<AutoindentRequest>>,
109 wait_for_autoindent_txs: Vec<oneshot::Sender<()>>,
110 pending_autoindent: Option<Task<()>>,
111 sync_parse_timeout: Duration,
112 syntax_map: Mutex<SyntaxMap>,
113 reparse: Option<Task<()>>,
114 parse_status: (watch::Sender<ParseStatus>, watch::Receiver<ParseStatus>),
115 non_text_state_update_count: usize,
116 diagnostics: SmallVec<[(LanguageServerId, DiagnosticSet); 2]>,
117 remote_selections: TreeMap<ReplicaId, SelectionSet>,
118 diagnostics_timestamp: clock::Lamport,
119 completion_triggers: BTreeSet<String>,
120 completion_triggers_per_language_server: HashMap<LanguageServerId, BTreeSet<String>>,
121 completion_triggers_timestamp: clock::Lamport,
122 deferred_ops: OperationQueue<Operation>,
123 capability: Capability,
124 has_conflict: bool,
125 /// Memoize calls to has_changes_since(saved_version).
126 /// The contents of a cell are (self.version, has_changes) at the time of a last call.
127 has_unsaved_edits: Cell<(clock::Global, bool)>,
128 change_bits: Vec<rc::Weak<Cell<bool>>>,
129 _subscriptions: Vec<gpui::Subscription>,
130}
131
132#[derive(Copy, Clone, Debug, PartialEq, Eq)]
133pub enum ParseStatus {
134 Idle,
135 Parsing,
136}
137
138struct BufferBranchState {
139 base_buffer: Entity<Buffer>,
140 merged_operations: Vec<Lamport>,
141}
142
143/// An immutable, cheaply cloneable representation of a fixed
144/// state of a buffer.
145pub struct BufferSnapshot {
146 pub text: text::BufferSnapshot,
147 pub(crate) syntax: SyntaxSnapshot,
148 file: Option<Arc<dyn File>>,
149 diagnostics: SmallVec<[(LanguageServerId, DiagnosticSet); 2]>,
150 remote_selections: TreeMap<ReplicaId, SelectionSet>,
151 language: Option<Arc<Language>>,
152 non_text_state_update_count: usize,
153}
154
155/// The kind and amount of indentation in a particular line. For now,
156/// assumes that indentation is all the same character.
157#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)]
158pub struct IndentSize {
159 /// The number of bytes that comprise the indentation.
160 pub len: u32,
161 /// The kind of whitespace used for indentation.
162 pub kind: IndentKind,
163}
164
165/// A whitespace character that's used for indentation.
166#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)]
167pub enum IndentKind {
168 /// An ASCII space character.
169 #[default]
170 Space,
171 /// An ASCII tab character.
172 Tab,
173}
174
175/// The shape of a selection cursor.
176#[derive(Copy, Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
177#[serde(rename_all = "snake_case")]
178pub enum CursorShape {
179 /// A vertical bar
180 #[default]
181 Bar,
182 /// A block that surrounds the following character
183 Block,
184 /// An underline that runs along the following character
185 Underline,
186 /// A box drawn around the following character
187 Hollow,
188}
189
190#[derive(Clone, Debug)]
191struct SelectionSet {
192 line_mode: bool,
193 cursor_shape: CursorShape,
194 selections: Arc<[Selection<Anchor>]>,
195 lamport_timestamp: clock::Lamport,
196}
197
198/// A diagnostic associated with a certain range of a buffer.
199#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
200pub struct Diagnostic {
201 /// The name of the service that produced this diagnostic.
202 pub source: Option<String>,
203 /// A machine-readable code that identifies this diagnostic.
204 pub code: Option<NumberOrString>,
205 pub code_description: Option<lsp::Url>,
206 /// Whether this diagnostic is a hint, warning, or error.
207 pub severity: DiagnosticSeverity,
208 /// The human-readable message associated with this diagnostic.
209 pub message: String,
210 /// The human-readable message (in markdown format)
211 pub markdown: Option<String>,
212 /// An id that identifies the group to which this diagnostic belongs.
213 ///
214 /// When a language server produces a diagnostic with
215 /// one or more associated diagnostics, those diagnostics are all
216 /// assigned a single group ID.
217 pub group_id: usize,
218 /// Whether this diagnostic is the primary diagnostic for its group.
219 ///
220 /// In a given group, the primary diagnostic is the top-level diagnostic
221 /// returned by the language server. The non-primary diagnostics are the
222 /// associated diagnostics.
223 pub is_primary: bool,
224 /// Whether this diagnostic is considered to originate from an analysis of
225 /// files on disk, as opposed to any unsaved buffer contents. This is a
226 /// property of a given diagnostic source, and is configured for a given
227 /// language server via the [`LspAdapter::disk_based_diagnostic_sources`](crate::LspAdapter::disk_based_diagnostic_sources) method
228 /// for the language server.
229 pub is_disk_based: bool,
230 /// Whether this diagnostic marks unnecessary code.
231 pub is_unnecessary: bool,
232 /// Quick separation of diagnostics groups based by their source.
233 pub source_kind: DiagnosticSourceKind,
234 /// Data from language server that produced this diagnostic. Passed back to the LS when we request code actions for this diagnostic.
235 pub data: Option<Value>,
236 /// Whether to underline the corresponding text range in the editor.
237 pub underline: bool,
238}
239
240#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
241pub enum DiagnosticSourceKind {
242 Pulled,
243 Pushed,
244 Other,
245}
246
247/// An operation used to synchronize this buffer with its other replicas.
248#[derive(Clone, Debug, PartialEq)]
249pub enum Operation {
250 /// A text operation.
251 Buffer(text::Operation),
252
253 /// An update to the buffer's diagnostics.
254 UpdateDiagnostics {
255 /// The id of the language server that produced the new diagnostics.
256 server_id: LanguageServerId,
257 /// The diagnostics.
258 diagnostics: Arc<[DiagnosticEntry<Anchor>]>,
259 /// The buffer's lamport timestamp.
260 lamport_timestamp: clock::Lamport,
261 },
262
263 /// An update to the most recent selections in this buffer.
264 UpdateSelections {
265 /// The selections.
266 selections: Arc<[Selection<Anchor>]>,
267 /// The buffer's lamport timestamp.
268 lamport_timestamp: clock::Lamport,
269 /// Whether the selections are in 'line mode'.
270 line_mode: bool,
271 /// The [`CursorShape`] associated with these selections.
272 cursor_shape: CursorShape,
273 },
274
275 /// An update to the characters that should trigger autocompletion
276 /// for this buffer.
277 UpdateCompletionTriggers {
278 /// The characters that trigger autocompletion.
279 triggers: Vec<String>,
280 /// The buffer's lamport timestamp.
281 lamport_timestamp: clock::Lamport,
282 /// The language server ID.
283 server_id: LanguageServerId,
284 },
285}
286
287/// An event that occurs in a buffer.
288#[derive(Clone, Debug, PartialEq)]
289pub enum BufferEvent {
290 /// The buffer was changed in a way that must be
291 /// propagated to its other replicas.
292 Operation {
293 operation: Operation,
294 is_local: bool,
295 },
296 /// The buffer was edited.
297 Edited,
298 /// The buffer's `dirty` bit changed.
299 DirtyChanged,
300 /// The buffer was saved.
301 Saved,
302 /// The buffer's file was changed on disk.
303 FileHandleChanged,
304 /// The buffer was reloaded.
305 Reloaded,
306 /// The buffer is in need of a reload
307 ReloadNeeded,
308 /// The buffer's language was changed.
309 LanguageChanged,
310 /// The buffer's syntax trees were updated.
311 Reparsed,
312 /// The buffer's diagnostics were updated.
313 DiagnosticsUpdated,
314 /// The buffer gained or lost editing capabilities.
315 CapabilityChanged,
316 /// The buffer was explicitly requested to close.
317 Closed,
318 /// The buffer was discarded when closing.
319 Discarded,
320}
321
322/// The file associated with a buffer.
323pub trait File: Send + Sync + Any {
324 /// Returns the [`LocalFile`] associated with this file, if the
325 /// file is local.
326 fn as_local(&self) -> Option<&dyn LocalFile>;
327
328 /// Returns whether this file is local.
329 fn is_local(&self) -> bool {
330 self.as_local().is_some()
331 }
332
333 /// Returns whether the file is new, exists in storage, or has been deleted. Includes metadata
334 /// only available in some states, such as modification time.
335 fn disk_state(&self) -> DiskState;
336
337 /// Returns the path of this file relative to the worktree's root directory.
338 fn path(&self) -> &Arc<Path>;
339
340 /// Returns the path of this file relative to the worktree's parent directory (this means it
341 /// includes the name of the worktree's root folder).
342 fn full_path(&self, cx: &App) -> PathBuf;
343
344 /// Returns the last component of this handle's absolute path. If this handle refers to the root
345 /// of its worktree, then this method will return the name of the worktree itself.
346 fn file_name<'a>(&'a self, cx: &'a App) -> &'a OsStr;
347
348 /// Returns the id of the worktree to which this file belongs.
349 ///
350 /// This is needed for looking up project-specific settings.
351 fn worktree_id(&self, cx: &App) -> WorktreeId;
352
353 /// Converts this file into a protobuf message.
354 fn to_proto(&self, cx: &App) -> rpc::proto::File;
355
356 /// Return whether Zed considers this to be a private file.
357 fn is_private(&self) -> bool;
358}
359
360/// The file's storage status - whether it's stored (`Present`), and if so when it was last
361/// modified. In the case where the file is not stored, it can be either `New` or `Deleted`. In the
362/// UI these two states are distinguished. For example, the buffer tab does not display a deletion
363/// indicator for new files.
364#[derive(Copy, Clone, Debug, PartialEq)]
365pub enum DiskState {
366 /// File created in Zed that has not been saved.
367 New,
368 /// File present on the filesystem.
369 Present { mtime: MTime },
370 /// Deleted file that was previously present.
371 Deleted,
372}
373
374impl DiskState {
375 /// Returns the file's last known modification time on disk.
376 pub fn mtime(self) -> Option<MTime> {
377 match self {
378 DiskState::New => None,
379 DiskState::Present { mtime } => Some(mtime),
380 DiskState::Deleted => None,
381 }
382 }
383
384 pub fn exists(&self) -> bool {
385 match self {
386 DiskState::New => false,
387 DiskState::Present { .. } => true,
388 DiskState::Deleted => false,
389 }
390 }
391}
392
393/// The file associated with a buffer, in the case where the file is on the local disk.
394pub trait LocalFile: File {
395 /// Returns the absolute path of this file
396 fn abs_path(&self, cx: &App) -> PathBuf;
397
398 /// Loads the file contents from disk and returns them as a UTF-8 encoded string.
399 fn load(&self, cx: &App) -> Task<Result<String>>;
400
401 /// Loads the file's contents from disk.
402 fn load_bytes(&self, cx: &App) -> Task<Result<Vec<u8>>>;
403}
404
405/// The auto-indent behavior associated with an editing operation.
406/// For some editing operations, each affected line of text has its
407/// indentation recomputed. For other operations, the entire block
408/// of edited text is adjusted uniformly.
409#[derive(Clone, Debug)]
410pub enum AutoindentMode {
411 /// Indent each line of inserted text.
412 EachLine,
413 /// Apply the same indentation adjustment to all of the lines
414 /// in a given insertion.
415 Block {
416 /// The original indentation column of the first line of each
417 /// insertion, if it has been copied.
418 ///
419 /// Knowing this makes it possible to preserve the relative indentation
420 /// of every line in the insertion from when it was copied.
421 ///
422 /// If the original indent column is `a`, and the first line of insertion
423 /// is then auto-indented to column `b`, then every other line of
424 /// the insertion will be auto-indented to column `b - a`
425 original_indent_columns: Vec<Option<u32>>,
426 },
427}
428
429#[derive(Clone)]
430struct AutoindentRequest {
431 before_edit: BufferSnapshot,
432 entries: Vec<AutoindentRequestEntry>,
433 is_block_mode: bool,
434 ignore_empty_lines: bool,
435}
436
437#[derive(Debug, Clone)]
438struct AutoindentRequestEntry {
439 /// A range of the buffer whose indentation should be adjusted.
440 range: Range<Anchor>,
441 /// Whether or not these lines should be considered brand new, for the
442 /// purpose of auto-indent. When text is not new, its indentation will
443 /// only be adjusted if the suggested indentation level has *changed*
444 /// since the edit was made.
445 first_line_is_new: bool,
446 indent_size: IndentSize,
447 original_indent_column: Option<u32>,
448}
449
450#[derive(Debug)]
451struct IndentSuggestion {
452 basis_row: u32,
453 delta: Ordering,
454 within_error: bool,
455}
456
457struct BufferChunkHighlights<'a> {
458 captures: SyntaxMapCaptures<'a>,
459 next_capture: Option<SyntaxMapCapture<'a>>,
460 stack: Vec<(usize, HighlightId)>,
461 highlight_maps: Vec<HighlightMap>,
462}
463
464/// An iterator that yields chunks of a buffer's text, along with their
465/// syntax highlights and diagnostic status.
466pub struct BufferChunks<'a> {
467 buffer_snapshot: Option<&'a BufferSnapshot>,
468 range: Range<usize>,
469 chunks: text::Chunks<'a>,
470 diagnostic_endpoints: Option<Peekable<vec::IntoIter<DiagnosticEndpoint>>>,
471 error_depth: usize,
472 warning_depth: usize,
473 information_depth: usize,
474 hint_depth: usize,
475 unnecessary_depth: usize,
476 underline: bool,
477 highlights: Option<BufferChunkHighlights<'a>>,
478}
479
480/// A chunk of a buffer's text, along with its syntax highlight and
481/// diagnostic status.
482#[derive(Clone, Debug, Default)]
483pub struct Chunk<'a> {
484 /// The text of the chunk.
485 pub text: &'a str,
486 /// The syntax highlighting style of the chunk.
487 pub syntax_highlight_id: Option<HighlightId>,
488 /// The highlight style that has been applied to this chunk in
489 /// the editor.
490 pub highlight_style: Option<HighlightStyle>,
491 /// The severity of diagnostic associated with this chunk, if any.
492 pub diagnostic_severity: Option<DiagnosticSeverity>,
493 /// Whether this chunk of text is marked as unnecessary.
494 pub is_unnecessary: bool,
495 /// Whether this chunk of text was originally a tab character.
496 pub is_tab: bool,
497 /// Whether this chunk of text was originally a tab character.
498 pub is_inlay: bool,
499 /// Whether to underline the corresponding text range in the editor.
500 pub underline: bool,
501}
502
503/// A set of edits to a given version of a buffer, computed asynchronously.
504#[derive(Debug)]
505pub struct Diff {
506 pub base_version: clock::Global,
507 pub line_ending: LineEnding,
508 pub edits: Vec<(Range<usize>, Arc<str>)>,
509}
510
511#[derive(Debug, Clone, Copy)]
512pub(crate) struct DiagnosticEndpoint {
513 offset: usize,
514 is_start: bool,
515 underline: bool,
516 severity: DiagnosticSeverity,
517 is_unnecessary: bool,
518}
519
520/// A class of characters, used for characterizing a run of text.
521#[derive(Copy, Clone, Eq, PartialEq, PartialOrd, Ord, Debug)]
522pub enum CharKind {
523 /// Whitespace.
524 Whitespace,
525 /// Punctuation.
526 Punctuation,
527 /// Word.
528 Word,
529}
530
531/// A runnable is a set of data about a region that could be resolved into a task
532pub struct Runnable {
533 pub tags: SmallVec<[RunnableTag; 1]>,
534 pub language: Arc<Language>,
535 pub buffer: BufferId,
536}
537
538#[derive(Default, Clone, Debug)]
539pub struct HighlightedText {
540 pub text: SharedString,
541 pub highlights: Vec<(Range<usize>, HighlightStyle)>,
542}
543
544#[derive(Default, Debug)]
545struct HighlightedTextBuilder {
546 pub text: String,
547 pub highlights: Vec<(Range<usize>, HighlightStyle)>,
548}
549
550impl HighlightedText {
551 pub fn from_buffer_range<T: ToOffset>(
552 range: Range<T>,
553 snapshot: &text::BufferSnapshot,
554 syntax_snapshot: &SyntaxSnapshot,
555 override_style: Option<HighlightStyle>,
556 syntax_theme: &SyntaxTheme,
557 ) -> Self {
558 let mut highlighted_text = HighlightedTextBuilder::default();
559 highlighted_text.add_text_from_buffer_range(
560 range,
561 snapshot,
562 syntax_snapshot,
563 override_style,
564 syntax_theme,
565 );
566 highlighted_text.build()
567 }
568
569 pub fn to_styled_text(&self, default_style: &TextStyle) -> StyledText {
570 gpui::StyledText::new(self.text.clone())
571 .with_default_highlights(default_style, self.highlights.iter().cloned())
572 }
573
574 /// Returns the first line without leading whitespace unless highlighted
575 /// and a boolean indicating if there are more lines after
576 pub fn first_line_preview(self) -> (Self, bool) {
577 let newline_ix = self.text.find('\n').unwrap_or(self.text.len());
578 let first_line = &self.text[..newline_ix];
579
580 // Trim leading whitespace, unless an edit starts prior to it.
581 let mut preview_start_ix = first_line.len() - first_line.trim_start().len();
582 if let Some((first_highlight_range, _)) = self.highlights.first() {
583 preview_start_ix = preview_start_ix.min(first_highlight_range.start);
584 }
585
586 let preview_text = &first_line[preview_start_ix..];
587 let preview_highlights = self
588 .highlights
589 .into_iter()
590 .take_while(|(range, _)| range.start < newline_ix)
591 .filter_map(|(mut range, highlight)| {
592 range.start = range.start.saturating_sub(preview_start_ix);
593 range.end = range.end.saturating_sub(preview_start_ix).min(newline_ix);
594 if range.is_empty() {
595 None
596 } else {
597 Some((range, highlight))
598 }
599 });
600
601 let preview = Self {
602 text: SharedString::new(preview_text),
603 highlights: preview_highlights.collect(),
604 };
605
606 (preview, self.text.len() > newline_ix)
607 }
608}
609
610impl HighlightedTextBuilder {
611 pub fn build(self) -> HighlightedText {
612 HighlightedText {
613 text: self.text.into(),
614 highlights: self.highlights,
615 }
616 }
617
618 pub fn add_text_from_buffer_range<T: ToOffset>(
619 &mut self,
620 range: Range<T>,
621 snapshot: &text::BufferSnapshot,
622 syntax_snapshot: &SyntaxSnapshot,
623 override_style: Option<HighlightStyle>,
624 syntax_theme: &SyntaxTheme,
625 ) {
626 let range = range.to_offset(snapshot);
627 for chunk in Self::highlighted_chunks(range, snapshot, syntax_snapshot) {
628 let start = self.text.len();
629 self.text.push_str(chunk.text);
630 let end = self.text.len();
631
632 if let Some(mut highlight_style) = chunk
633 .syntax_highlight_id
634 .and_then(|id| id.style(syntax_theme))
635 {
636 if let Some(override_style) = override_style {
637 highlight_style.highlight(override_style);
638 }
639 self.highlights.push((start..end, highlight_style));
640 } else if let Some(override_style) = override_style {
641 self.highlights.push((start..end, override_style));
642 }
643 }
644 }
645
646 fn highlighted_chunks<'a>(
647 range: Range<usize>,
648 snapshot: &'a text::BufferSnapshot,
649 syntax_snapshot: &'a SyntaxSnapshot,
650 ) -> BufferChunks<'a> {
651 let captures = syntax_snapshot.captures(range.clone(), snapshot, |grammar| {
652 grammar.highlights_query.as_ref()
653 });
654
655 let highlight_maps = captures
656 .grammars()
657 .iter()
658 .map(|grammar| grammar.highlight_map())
659 .collect();
660
661 BufferChunks::new(
662 snapshot.as_rope(),
663 range,
664 Some((captures, highlight_maps)),
665 false,
666 None,
667 )
668 }
669}
670
671#[derive(Clone)]
672pub struct EditPreview {
673 old_snapshot: text::BufferSnapshot,
674 applied_edits_snapshot: text::BufferSnapshot,
675 syntax_snapshot: SyntaxSnapshot,
676}
677
678impl EditPreview {
679 pub fn highlight_edits(
680 &self,
681 current_snapshot: &BufferSnapshot,
682 edits: &[(Range<Anchor>, String)],
683 include_deletions: bool,
684 cx: &App,
685 ) -> HighlightedText {
686 let Some(visible_range_in_preview_snapshot) = self.compute_visible_range(edits) else {
687 return HighlightedText::default();
688 };
689
690 let mut highlighted_text = HighlightedTextBuilder::default();
691
692 let mut offset_in_preview_snapshot = visible_range_in_preview_snapshot.start;
693
694 let insertion_highlight_style = HighlightStyle {
695 background_color: Some(cx.theme().status().created_background),
696 ..Default::default()
697 };
698 let deletion_highlight_style = HighlightStyle {
699 background_color: Some(cx.theme().status().deleted_background),
700 ..Default::default()
701 };
702 let syntax_theme = cx.theme().syntax();
703
704 for (range, edit_text) in edits {
705 let edit_new_end_in_preview_snapshot = range
706 .end
707 .bias_right(&self.old_snapshot)
708 .to_offset(&self.applied_edits_snapshot);
709 let edit_start_in_preview_snapshot = edit_new_end_in_preview_snapshot - edit_text.len();
710
711 let unchanged_range_in_preview_snapshot =
712 offset_in_preview_snapshot..edit_start_in_preview_snapshot;
713 if !unchanged_range_in_preview_snapshot.is_empty() {
714 highlighted_text.add_text_from_buffer_range(
715 unchanged_range_in_preview_snapshot,
716 &self.applied_edits_snapshot,
717 &self.syntax_snapshot,
718 None,
719 &syntax_theme,
720 );
721 }
722
723 let range_in_current_snapshot = range.to_offset(current_snapshot);
724 if include_deletions && !range_in_current_snapshot.is_empty() {
725 highlighted_text.add_text_from_buffer_range(
726 range_in_current_snapshot,
727 ¤t_snapshot.text,
728 ¤t_snapshot.syntax,
729 Some(deletion_highlight_style),
730 &syntax_theme,
731 );
732 }
733
734 if !edit_text.is_empty() {
735 highlighted_text.add_text_from_buffer_range(
736 edit_start_in_preview_snapshot..edit_new_end_in_preview_snapshot,
737 &self.applied_edits_snapshot,
738 &self.syntax_snapshot,
739 Some(insertion_highlight_style),
740 &syntax_theme,
741 );
742 }
743
744 offset_in_preview_snapshot = edit_new_end_in_preview_snapshot;
745 }
746
747 highlighted_text.add_text_from_buffer_range(
748 offset_in_preview_snapshot..visible_range_in_preview_snapshot.end,
749 &self.applied_edits_snapshot,
750 &self.syntax_snapshot,
751 None,
752 &syntax_theme,
753 );
754
755 highlighted_text.build()
756 }
757
758 fn compute_visible_range(&self, edits: &[(Range<Anchor>, String)]) -> Option<Range<usize>> {
759 let (first, _) = edits.first()?;
760 let (last, _) = edits.last()?;
761
762 let start = first
763 .start
764 .bias_left(&self.old_snapshot)
765 .to_point(&self.applied_edits_snapshot);
766 let end = last
767 .end
768 .bias_right(&self.old_snapshot)
769 .to_point(&self.applied_edits_snapshot);
770
771 // Ensure that the first line of the first edit and the last line of the last edit are always fully visible
772 let range = Point::new(start.row, 0)
773 ..Point::new(end.row, self.applied_edits_snapshot.line_len(end.row));
774
775 Some(range.to_offset(&self.applied_edits_snapshot))
776 }
777}
778
779#[derive(Clone, Debug, PartialEq, Eq)]
780pub struct BracketMatch {
781 pub open_range: Range<usize>,
782 pub close_range: Range<usize>,
783 pub newline_only: bool,
784}
785
786impl Buffer {
787 /// Create a new buffer with the given base text.
788 pub fn local<T: Into<String>>(base_text: T, cx: &Context<Self>) -> Self {
789 Self::build(
790 TextBuffer::new(0, cx.entity_id().as_non_zero_u64().into(), base_text.into()),
791 None,
792 Capability::ReadWrite,
793 )
794 }
795
796 /// Create a new buffer with the given base text that has proper line endings and other normalization applied.
797 pub fn local_normalized(
798 base_text_normalized: Rope,
799 line_ending: LineEnding,
800 cx: &Context<Self>,
801 ) -> Self {
802 Self::build(
803 TextBuffer::new_normalized(
804 0,
805 cx.entity_id().as_non_zero_u64().into(),
806 line_ending,
807 base_text_normalized,
808 ),
809 None,
810 Capability::ReadWrite,
811 )
812 }
813
814 /// Create a new buffer that is a replica of a remote buffer.
815 pub fn remote(
816 remote_id: BufferId,
817 replica_id: ReplicaId,
818 capability: Capability,
819 base_text: impl Into<String>,
820 ) -> Self {
821 Self::build(
822 TextBuffer::new(replica_id, remote_id, base_text.into()),
823 None,
824 capability,
825 )
826 }
827
828 /// Create a new buffer that is a replica of a remote buffer, populating its
829 /// state from the given protobuf message.
830 pub fn from_proto(
831 replica_id: ReplicaId,
832 capability: Capability,
833 message: proto::BufferState,
834 file: Option<Arc<dyn File>>,
835 ) -> Result<Self> {
836 let buffer_id = BufferId::new(message.id).context("Could not deserialize buffer_id")?;
837 let buffer = TextBuffer::new(replica_id, buffer_id, message.base_text);
838 let mut this = Self::build(buffer, file, capability);
839 this.text.set_line_ending(proto::deserialize_line_ending(
840 rpc::proto::LineEnding::from_i32(message.line_ending).context("missing line_ending")?,
841 ));
842 this.saved_version = proto::deserialize_version(&message.saved_version);
843 this.saved_mtime = message.saved_mtime.map(|time| time.into());
844 Ok(this)
845 }
846
847 /// Serialize the buffer's state to a protobuf message.
848 pub fn to_proto(&self, cx: &App) -> proto::BufferState {
849 proto::BufferState {
850 id: self.remote_id().into(),
851 file: self.file.as_ref().map(|f| f.to_proto(cx)),
852 base_text: self.base_text().to_string(),
853 line_ending: proto::serialize_line_ending(self.line_ending()) as i32,
854 saved_version: proto::serialize_version(&self.saved_version),
855 saved_mtime: self.saved_mtime.map(|time| time.into()),
856 }
857 }
858
859 /// Serialize as protobufs all of the changes to the buffer since the given version.
860 pub fn serialize_ops(
861 &self,
862 since: Option<clock::Global>,
863 cx: &App,
864 ) -> Task<Vec<proto::Operation>> {
865 let mut operations = Vec::new();
866 operations.extend(self.deferred_ops.iter().map(proto::serialize_operation));
867
868 operations.extend(self.remote_selections.iter().map(|(_, set)| {
869 proto::serialize_operation(&Operation::UpdateSelections {
870 selections: set.selections.clone(),
871 lamport_timestamp: set.lamport_timestamp,
872 line_mode: set.line_mode,
873 cursor_shape: set.cursor_shape,
874 })
875 }));
876
877 for (server_id, diagnostics) in &self.diagnostics {
878 operations.push(proto::serialize_operation(&Operation::UpdateDiagnostics {
879 lamport_timestamp: self.diagnostics_timestamp,
880 server_id: *server_id,
881 diagnostics: diagnostics.iter().cloned().collect(),
882 }));
883 }
884
885 for (server_id, completions) in &self.completion_triggers_per_language_server {
886 operations.push(proto::serialize_operation(
887 &Operation::UpdateCompletionTriggers {
888 triggers: completions.iter().cloned().collect(),
889 lamport_timestamp: self.completion_triggers_timestamp,
890 server_id: *server_id,
891 },
892 ));
893 }
894
895 let text_operations = self.text.operations().clone();
896 cx.background_spawn(async move {
897 let since = since.unwrap_or_default();
898 operations.extend(
899 text_operations
900 .iter()
901 .filter(|(_, op)| !since.observed(op.timestamp()))
902 .map(|(_, op)| proto::serialize_operation(&Operation::Buffer(op.clone()))),
903 );
904 operations.sort_unstable_by_key(proto::lamport_timestamp_for_operation);
905 operations
906 })
907 }
908
909 /// Assign a language to the buffer, returning the buffer.
910 pub fn with_language(mut self, language: Arc<Language>, cx: &mut Context<Self>) -> Self {
911 self.set_language(Some(language), cx);
912 self
913 }
914
915 /// Returns the [`Capability`] of this buffer.
916 pub fn capability(&self) -> Capability {
917 self.capability
918 }
919
920 /// Whether this buffer can only be read.
921 pub fn read_only(&self) -> bool {
922 self.capability == Capability::ReadOnly
923 }
924
925 /// Builds a [`Buffer`] with the given underlying [`TextBuffer`], diff base, [`File`] and [`Capability`].
926 pub fn build(buffer: TextBuffer, file: Option<Arc<dyn File>>, capability: Capability) -> Self {
927 let saved_mtime = file.as_ref().and_then(|file| file.disk_state().mtime());
928 let snapshot = buffer.snapshot();
929 let syntax_map = Mutex::new(SyntaxMap::new(&snapshot));
930 Self {
931 saved_mtime,
932 saved_version: buffer.version(),
933 preview_version: buffer.version(),
934 reload_task: None,
935 transaction_depth: 0,
936 was_dirty_before_starting_transaction: None,
937 has_unsaved_edits: Cell::new((buffer.version(), false)),
938 text: buffer,
939 branch_state: None,
940 file,
941 capability,
942 syntax_map,
943 reparse: None,
944 non_text_state_update_count: 0,
945 sync_parse_timeout: Duration::from_millis(1),
946 parse_status: watch::channel(ParseStatus::Idle),
947 autoindent_requests: Default::default(),
948 wait_for_autoindent_txs: Default::default(),
949 pending_autoindent: Default::default(),
950 language: None,
951 remote_selections: Default::default(),
952 diagnostics: Default::default(),
953 diagnostics_timestamp: Default::default(),
954 completion_triggers: Default::default(),
955 completion_triggers_per_language_server: Default::default(),
956 completion_triggers_timestamp: Default::default(),
957 deferred_ops: OperationQueue::new(),
958 has_conflict: false,
959 change_bits: Default::default(),
960 _subscriptions: Vec::new(),
961 }
962 }
963
964 pub fn build_snapshot(
965 text: Rope,
966 language: Option<Arc<Language>>,
967 language_registry: Option<Arc<LanguageRegistry>>,
968 cx: &mut App,
969 ) -> impl Future<Output = BufferSnapshot> + use<> {
970 let entity_id = cx.reserve_entity::<Self>().entity_id();
971 let buffer_id = entity_id.as_non_zero_u64().into();
972 async move {
973 let text =
974 TextBuffer::new_normalized(0, buffer_id, Default::default(), text).snapshot();
975 let mut syntax = SyntaxMap::new(&text).snapshot();
976 if let Some(language) = language.clone() {
977 let text = text.clone();
978 let language = language.clone();
979 let language_registry = language_registry.clone();
980 syntax.reparse(&text, language_registry, language);
981 }
982 BufferSnapshot {
983 text,
984 syntax,
985 file: None,
986 diagnostics: Default::default(),
987 remote_selections: Default::default(),
988 language,
989 non_text_state_update_count: 0,
990 }
991 }
992 }
993
994 pub fn build_empty_snapshot(cx: &mut App) -> BufferSnapshot {
995 let entity_id = cx.reserve_entity::<Self>().entity_id();
996 let buffer_id = entity_id.as_non_zero_u64().into();
997 let text =
998 TextBuffer::new_normalized(0, buffer_id, Default::default(), Rope::new()).snapshot();
999 let syntax = SyntaxMap::new(&text).snapshot();
1000 BufferSnapshot {
1001 text,
1002 syntax,
1003 file: None,
1004 diagnostics: Default::default(),
1005 remote_selections: Default::default(),
1006 language: None,
1007 non_text_state_update_count: 0,
1008 }
1009 }
1010
1011 #[cfg(any(test, feature = "test-support"))]
1012 pub fn build_snapshot_sync(
1013 text: Rope,
1014 language: Option<Arc<Language>>,
1015 language_registry: Option<Arc<LanguageRegistry>>,
1016 cx: &mut App,
1017 ) -> BufferSnapshot {
1018 let entity_id = cx.reserve_entity::<Self>().entity_id();
1019 let buffer_id = entity_id.as_non_zero_u64().into();
1020 let text = TextBuffer::new_normalized(0, buffer_id, Default::default(), text).snapshot();
1021 let mut syntax = SyntaxMap::new(&text).snapshot();
1022 if let Some(language) = language.clone() {
1023 let text = text.clone();
1024 let language = language.clone();
1025 let language_registry = language_registry.clone();
1026 syntax.reparse(&text, language_registry, language);
1027 }
1028 BufferSnapshot {
1029 text,
1030 syntax,
1031 file: None,
1032 diagnostics: Default::default(),
1033 remote_selections: Default::default(),
1034 language,
1035 non_text_state_update_count: 0,
1036 }
1037 }
1038
1039 /// Retrieve a snapshot of the buffer's current state. This is computationally
1040 /// cheap, and allows reading from the buffer on a background thread.
1041 pub fn snapshot(&self) -> BufferSnapshot {
1042 let text = self.text.snapshot();
1043 let mut syntax_map = self.syntax_map.lock();
1044 syntax_map.interpolate(&text);
1045 let syntax = syntax_map.snapshot();
1046
1047 BufferSnapshot {
1048 text,
1049 syntax,
1050 file: self.file.clone(),
1051 remote_selections: self.remote_selections.clone(),
1052 diagnostics: self.diagnostics.clone(),
1053 language: self.language.clone(),
1054 non_text_state_update_count: self.non_text_state_update_count,
1055 }
1056 }
1057
1058 pub fn branch(&mut self, cx: &mut Context<Self>) -> Entity<Self> {
1059 let this = cx.entity();
1060 cx.new(|cx| {
1061 let mut branch = Self {
1062 branch_state: Some(BufferBranchState {
1063 base_buffer: this.clone(),
1064 merged_operations: Default::default(),
1065 }),
1066 language: self.language.clone(),
1067 has_conflict: self.has_conflict,
1068 has_unsaved_edits: Cell::new(self.has_unsaved_edits.get_mut().clone()),
1069 _subscriptions: vec![cx.subscribe(&this, Self::on_base_buffer_event)],
1070 ..Self::build(self.text.branch(), self.file.clone(), self.capability())
1071 };
1072 if let Some(language_registry) = self.language_registry() {
1073 branch.set_language_registry(language_registry);
1074 }
1075
1076 // Reparse the branch buffer so that we get syntax highlighting immediately.
1077 branch.reparse(cx);
1078
1079 branch
1080 })
1081 }
1082
1083 pub fn preview_edits(
1084 &self,
1085 edits: Arc<[(Range<Anchor>, String)]>,
1086 cx: &App,
1087 ) -> Task<EditPreview> {
1088 let registry = self.language_registry();
1089 let language = self.language().cloned();
1090 let old_snapshot = self.text.snapshot();
1091 let mut branch_buffer = self.text.branch();
1092 let mut syntax_snapshot = self.syntax_map.lock().snapshot();
1093 cx.background_spawn(async move {
1094 if !edits.is_empty() {
1095 if let Some(language) = language.clone() {
1096 syntax_snapshot.reparse(&old_snapshot, registry.clone(), language);
1097 }
1098
1099 branch_buffer.edit(edits.iter().cloned());
1100 let snapshot = branch_buffer.snapshot();
1101 syntax_snapshot.interpolate(&snapshot);
1102
1103 if let Some(language) = language {
1104 syntax_snapshot.reparse(&snapshot, registry, language);
1105 }
1106 }
1107 EditPreview {
1108 old_snapshot,
1109 applied_edits_snapshot: branch_buffer.snapshot(),
1110 syntax_snapshot,
1111 }
1112 })
1113 }
1114
1115 /// Applies all of the changes in this buffer that intersect any of the
1116 /// given `ranges` to its base buffer.
1117 ///
1118 /// If `ranges` is empty, then all changes will be applied. This buffer must
1119 /// be a branch buffer to call this method.
1120 pub fn merge_into_base(&mut self, ranges: Vec<Range<usize>>, cx: &mut Context<Self>) {
1121 let Some(base_buffer) = self.base_buffer() else {
1122 debug_panic!("not a branch buffer");
1123 return;
1124 };
1125
1126 let mut ranges = if ranges.is_empty() {
1127 &[0..usize::MAX]
1128 } else {
1129 ranges.as_slice()
1130 }
1131 .into_iter()
1132 .peekable();
1133
1134 let mut edits = Vec::new();
1135 for edit in self.edits_since::<usize>(&base_buffer.read(cx).version()) {
1136 let mut is_included = false;
1137 while let Some(range) = ranges.peek() {
1138 if range.end < edit.new.start {
1139 ranges.next().unwrap();
1140 } else {
1141 if range.start <= edit.new.end {
1142 is_included = true;
1143 }
1144 break;
1145 }
1146 }
1147
1148 if is_included {
1149 edits.push((
1150 edit.old.clone(),
1151 self.text_for_range(edit.new.clone()).collect::<String>(),
1152 ));
1153 }
1154 }
1155
1156 let operation = base_buffer.update(cx, |base_buffer, cx| {
1157 // cx.emit(BufferEvent::DiffBaseChanged);
1158 base_buffer.edit(edits, None, cx)
1159 });
1160
1161 if let Some(operation) = operation {
1162 if let Some(BufferBranchState {
1163 merged_operations, ..
1164 }) = &mut self.branch_state
1165 {
1166 merged_operations.push(operation);
1167 }
1168 }
1169 }
1170
1171 fn on_base_buffer_event(
1172 &mut self,
1173 _: Entity<Buffer>,
1174 event: &BufferEvent,
1175 cx: &mut Context<Self>,
1176 ) {
1177 let BufferEvent::Operation { operation, .. } = event else {
1178 return;
1179 };
1180 let Some(BufferBranchState {
1181 merged_operations, ..
1182 }) = &mut self.branch_state
1183 else {
1184 return;
1185 };
1186
1187 let mut operation_to_undo = None;
1188 if let Operation::Buffer(text::Operation::Edit(operation)) = &operation {
1189 if let Ok(ix) = merged_operations.binary_search(&operation.timestamp) {
1190 merged_operations.remove(ix);
1191 operation_to_undo = Some(operation.timestamp);
1192 }
1193 }
1194
1195 self.apply_ops([operation.clone()], cx);
1196
1197 if let Some(timestamp) = operation_to_undo {
1198 let counts = [(timestamp, u32::MAX)].into_iter().collect();
1199 self.undo_operations(counts, cx);
1200 }
1201 }
1202
1203 #[cfg(test)]
1204 pub(crate) fn as_text_snapshot(&self) -> &text::BufferSnapshot {
1205 &self.text
1206 }
1207
1208 /// Retrieve a snapshot of the buffer's raw text, without any
1209 /// language-related state like the syntax tree or diagnostics.
1210 pub fn text_snapshot(&self) -> text::BufferSnapshot {
1211 self.text.snapshot()
1212 }
1213
1214 /// The file associated with the buffer, if any.
1215 pub fn file(&self) -> Option<&Arc<dyn File>> {
1216 self.file.as_ref()
1217 }
1218
1219 /// The version of the buffer that was last saved or reloaded from disk.
1220 pub fn saved_version(&self) -> &clock::Global {
1221 &self.saved_version
1222 }
1223
1224 /// The mtime of the buffer's file when the buffer was last saved or reloaded from disk.
1225 pub fn saved_mtime(&self) -> Option<MTime> {
1226 self.saved_mtime
1227 }
1228
1229 /// Assign a language to the buffer.
1230 pub fn set_language(&mut self, language: Option<Arc<Language>>, cx: &mut Context<Self>) {
1231 self.non_text_state_update_count += 1;
1232 self.syntax_map.lock().clear(&self.text);
1233 self.language = language;
1234 self.was_changed();
1235 self.reparse(cx);
1236 cx.emit(BufferEvent::LanguageChanged);
1237 }
1238
1239 /// Assign a language registry to the buffer. This allows the buffer to retrieve
1240 /// other languages if parts of the buffer are written in different languages.
1241 pub fn set_language_registry(&self, language_registry: Arc<LanguageRegistry>) {
1242 self.syntax_map
1243 .lock()
1244 .set_language_registry(language_registry);
1245 }
1246
1247 pub fn language_registry(&self) -> Option<Arc<LanguageRegistry>> {
1248 self.syntax_map.lock().language_registry()
1249 }
1250
1251 /// Assign the buffer a new [`Capability`].
1252 pub fn set_capability(&mut self, capability: Capability, cx: &mut Context<Self>) {
1253 self.capability = capability;
1254 cx.emit(BufferEvent::CapabilityChanged)
1255 }
1256
1257 /// This method is called to signal that the buffer has been saved.
1258 pub fn did_save(
1259 &mut self,
1260 version: clock::Global,
1261 mtime: Option<MTime>,
1262 cx: &mut Context<Self>,
1263 ) {
1264 self.saved_version = version;
1265 self.has_unsaved_edits
1266 .set((self.saved_version().clone(), false));
1267 self.has_conflict = false;
1268 self.saved_mtime = mtime;
1269 self.was_changed();
1270 cx.emit(BufferEvent::Saved);
1271 cx.notify();
1272 }
1273
1274 /// This method is called to signal that the buffer has been discarded.
1275 pub fn discarded(&self, cx: &mut Context<Self>) {
1276 cx.emit(BufferEvent::Discarded);
1277 cx.notify();
1278 }
1279
1280 /// Reloads the contents of the buffer from disk.
1281 pub fn reload(&mut self, cx: &Context<Self>) -> oneshot::Receiver<Option<Transaction>> {
1282 let (tx, rx) = futures::channel::oneshot::channel();
1283 let prev_version = self.text.version();
1284 self.reload_task = Some(cx.spawn(async move |this, cx| {
1285 let Some((new_mtime, new_text)) = this.update(cx, |this, cx| {
1286 let file = this.file.as_ref()?.as_local()?;
1287
1288 Some((file.disk_state().mtime(), file.load(cx)))
1289 })?
1290 else {
1291 return Ok(());
1292 };
1293
1294 let new_text = new_text.await?;
1295 let diff = this
1296 .update(cx, |this, cx| this.diff(new_text.clone(), cx))?
1297 .await;
1298 this.update(cx, |this, cx| {
1299 if this.version() == diff.base_version {
1300 this.finalize_last_transaction();
1301 this.apply_diff(diff, cx);
1302 tx.send(this.finalize_last_transaction().cloned()).ok();
1303 this.has_conflict = false;
1304 this.did_reload(this.version(), this.line_ending(), new_mtime, cx);
1305 } else {
1306 if !diff.edits.is_empty()
1307 || this
1308 .edits_since::<usize>(&diff.base_version)
1309 .next()
1310 .is_some()
1311 {
1312 this.has_conflict = true;
1313 }
1314
1315 this.did_reload(prev_version, this.line_ending(), this.saved_mtime, cx);
1316 }
1317
1318 this.reload_task.take();
1319 })
1320 }));
1321 rx
1322 }
1323
1324 /// This method is called to signal that the buffer has been reloaded.
1325 pub fn did_reload(
1326 &mut self,
1327 version: clock::Global,
1328 line_ending: LineEnding,
1329 mtime: Option<MTime>,
1330 cx: &mut Context<Self>,
1331 ) {
1332 self.saved_version = version;
1333 self.has_unsaved_edits
1334 .set((self.saved_version.clone(), false));
1335 self.text.set_line_ending(line_ending);
1336 self.saved_mtime = mtime;
1337 cx.emit(BufferEvent::Reloaded);
1338 cx.notify();
1339 }
1340
1341 /// Updates the [`File`] backing this buffer. This should be called when
1342 /// the file has changed or has been deleted.
1343 pub fn file_updated(&mut self, new_file: Arc<dyn File>, cx: &mut Context<Self>) {
1344 let was_dirty = self.is_dirty();
1345 let mut file_changed = false;
1346
1347 if let Some(old_file) = self.file.as_ref() {
1348 if new_file.path() != old_file.path() {
1349 file_changed = true;
1350 }
1351
1352 let old_state = old_file.disk_state();
1353 let new_state = new_file.disk_state();
1354 if old_state != new_state {
1355 file_changed = true;
1356 if !was_dirty && matches!(new_state, DiskState::Present { .. }) {
1357 cx.emit(BufferEvent::ReloadNeeded)
1358 }
1359 }
1360 } else {
1361 file_changed = true;
1362 };
1363
1364 self.file = Some(new_file);
1365 if file_changed {
1366 self.was_changed();
1367 self.non_text_state_update_count += 1;
1368 if was_dirty != self.is_dirty() {
1369 cx.emit(BufferEvent::DirtyChanged);
1370 }
1371 cx.emit(BufferEvent::FileHandleChanged);
1372 cx.notify();
1373 }
1374 }
1375
1376 pub fn base_buffer(&self) -> Option<Entity<Self>> {
1377 Some(self.branch_state.as_ref()?.base_buffer.clone())
1378 }
1379
1380 /// Returns the primary [`Language`] assigned to this [`Buffer`].
1381 pub fn language(&self) -> Option<&Arc<Language>> {
1382 self.language.as_ref()
1383 }
1384
1385 /// Returns the [`Language`] at the given location.
1386 pub fn language_at<D: ToOffset>(&self, position: D) -> Option<Arc<Language>> {
1387 let offset = position.to_offset(self);
1388 let mut is_first = true;
1389 let start_anchor = self.anchor_before(offset);
1390 let end_anchor = self.anchor_after(offset);
1391 self.syntax_map
1392 .lock()
1393 .layers_for_range(offset..offset, &self.text, false)
1394 .filter(|layer| {
1395 if is_first {
1396 is_first = false;
1397 return true;
1398 }
1399 let any_sub_ranges_contain_range = layer
1400 .included_sub_ranges
1401 .map(|sub_ranges| {
1402 sub_ranges.iter().any(|sub_range| {
1403 let is_before_start = sub_range.end.cmp(&start_anchor, self).is_lt();
1404 let is_after_end = sub_range.start.cmp(&end_anchor, self).is_gt();
1405 !is_before_start && !is_after_end
1406 })
1407 })
1408 .unwrap_or(true);
1409 let result = any_sub_ranges_contain_range;
1410 return result;
1411 })
1412 .last()
1413 .map(|info| info.language.clone())
1414 .or_else(|| self.language.clone())
1415 }
1416
1417 /// Returns each [`Language`] for the active syntax layers at the given location.
1418 pub fn languages_at<D: ToOffset>(&self, position: D) -> Vec<Arc<Language>> {
1419 let offset = position.to_offset(self);
1420 let mut languages: Vec<Arc<Language>> = self
1421 .syntax_map
1422 .lock()
1423 .layers_for_range(offset..offset, &self.text, false)
1424 .map(|info| info.language.clone())
1425 .collect();
1426
1427 if languages.is_empty() {
1428 if let Some(buffer_language) = self.language() {
1429 languages.push(buffer_language.clone());
1430 }
1431 }
1432
1433 languages
1434 }
1435
1436 /// An integer version number that accounts for all updates besides
1437 /// the buffer's text itself (which is versioned via a version vector).
1438 pub fn non_text_state_update_count(&self) -> usize {
1439 self.non_text_state_update_count
1440 }
1441
1442 /// Whether the buffer is being parsed in the background.
1443 #[cfg(any(test, feature = "test-support"))]
1444 pub fn is_parsing(&self) -> bool {
1445 self.reparse.is_some()
1446 }
1447
1448 /// Indicates whether the buffer contains any regions that may be
1449 /// written in a language that hasn't been loaded yet.
1450 pub fn contains_unknown_injections(&self) -> bool {
1451 self.syntax_map.lock().contains_unknown_injections()
1452 }
1453
1454 #[cfg(any(test, feature = "test-support"))]
1455 pub fn set_sync_parse_timeout(&mut self, timeout: Duration) {
1456 self.sync_parse_timeout = timeout;
1457 }
1458
1459 /// Called after an edit to synchronize the buffer's main parse tree with
1460 /// the buffer's new underlying state.
1461 ///
1462 /// Locks the syntax map and interpolates the edits since the last reparse
1463 /// into the foreground syntax tree.
1464 ///
1465 /// Then takes a stable snapshot of the syntax map before unlocking it.
1466 /// The snapshot with the interpolated edits is sent to a background thread,
1467 /// where we ask Tree-sitter to perform an incremental parse.
1468 ///
1469 /// Meanwhile, in the foreground, we block the main thread for up to 1ms
1470 /// waiting on the parse to complete. As soon as it completes, we proceed
1471 /// synchronously, unless a 1ms timeout elapses.
1472 ///
1473 /// If we time out waiting on the parse, we spawn a second task waiting
1474 /// until the parse does complete and return with the interpolated tree still
1475 /// in the foreground. When the background parse completes, call back into
1476 /// the main thread and assign the foreground parse state.
1477 ///
1478 /// If the buffer or grammar changed since the start of the background parse,
1479 /// initiate an additional reparse recursively. To avoid concurrent parses
1480 /// for the same buffer, we only initiate a new parse if we are not already
1481 /// parsing in the background.
1482 pub fn reparse(&mut self, cx: &mut Context<Self>) {
1483 if self.reparse.is_some() {
1484 return;
1485 }
1486 let language = if let Some(language) = self.language.clone() {
1487 language
1488 } else {
1489 return;
1490 };
1491
1492 let text = self.text_snapshot();
1493 let parsed_version = self.version();
1494
1495 let mut syntax_map = self.syntax_map.lock();
1496 syntax_map.interpolate(&text);
1497 let language_registry = syntax_map.language_registry();
1498 let mut syntax_snapshot = syntax_map.snapshot();
1499 drop(syntax_map);
1500
1501 let parse_task = cx.background_spawn({
1502 let language = language.clone();
1503 let language_registry = language_registry.clone();
1504 async move {
1505 syntax_snapshot.reparse(&text, language_registry, language);
1506 syntax_snapshot
1507 }
1508 });
1509
1510 self.parse_status.0.send(ParseStatus::Parsing).unwrap();
1511 match cx
1512 .background_executor()
1513 .block_with_timeout(self.sync_parse_timeout, parse_task)
1514 {
1515 Ok(new_syntax_snapshot) => {
1516 self.did_finish_parsing(new_syntax_snapshot, cx);
1517 self.reparse = None;
1518 }
1519 Err(parse_task) => {
1520 self.reparse = Some(cx.spawn(async move |this, cx| {
1521 let new_syntax_map = parse_task.await;
1522 this.update(cx, move |this, cx| {
1523 let grammar_changed =
1524 this.language.as_ref().map_or(true, |current_language| {
1525 !Arc::ptr_eq(&language, current_language)
1526 });
1527 let language_registry_changed = new_syntax_map
1528 .contains_unknown_injections()
1529 && language_registry.map_or(false, |registry| {
1530 registry.version() != new_syntax_map.language_registry_version()
1531 });
1532 let parse_again = language_registry_changed
1533 || grammar_changed
1534 || this.version.changed_since(&parsed_version);
1535 this.did_finish_parsing(new_syntax_map, cx);
1536 this.reparse = None;
1537 if parse_again {
1538 this.reparse(cx);
1539 }
1540 })
1541 .ok();
1542 }));
1543 }
1544 }
1545 }
1546
1547 fn did_finish_parsing(&mut self, syntax_snapshot: SyntaxSnapshot, cx: &mut Context<Self>) {
1548 self.was_changed();
1549 self.non_text_state_update_count += 1;
1550 self.syntax_map.lock().did_parse(syntax_snapshot);
1551 self.request_autoindent(cx);
1552 self.parse_status.0.send(ParseStatus::Idle).unwrap();
1553 cx.emit(BufferEvent::Reparsed);
1554 cx.notify();
1555 }
1556
1557 pub fn parse_status(&self) -> watch::Receiver<ParseStatus> {
1558 self.parse_status.1.clone()
1559 }
1560
1561 /// Assign to the buffer a set of diagnostics created by a given language server.
1562 pub fn update_diagnostics(
1563 &mut self,
1564 server_id: LanguageServerId,
1565 diagnostics: DiagnosticSet,
1566 cx: &mut Context<Self>,
1567 ) {
1568 let lamport_timestamp = self.text.lamport_clock.tick();
1569 let op = Operation::UpdateDiagnostics {
1570 server_id,
1571 diagnostics: diagnostics.iter().cloned().collect(),
1572 lamport_timestamp,
1573 };
1574 self.apply_diagnostic_update(server_id, diagnostics, lamport_timestamp, cx);
1575 self.send_operation(op, true, cx);
1576 }
1577
1578 pub fn get_diagnostics(&self, server_id: LanguageServerId) -> Option<&DiagnosticSet> {
1579 let Ok(idx) = self.diagnostics.binary_search_by_key(&server_id, |v| v.0) else {
1580 return None;
1581 };
1582 Some(&self.diagnostics[idx].1)
1583 }
1584
1585 fn request_autoindent(&mut self, cx: &mut Context<Self>) {
1586 if let Some(indent_sizes) = self.compute_autoindents() {
1587 let indent_sizes = cx.background_spawn(indent_sizes);
1588 match cx
1589 .background_executor()
1590 .block_with_timeout(Duration::from_micros(500), indent_sizes)
1591 {
1592 Ok(indent_sizes) => self.apply_autoindents(indent_sizes, cx),
1593 Err(indent_sizes) => {
1594 self.pending_autoindent = Some(cx.spawn(async move |this, cx| {
1595 let indent_sizes = indent_sizes.await;
1596 this.update(cx, |this, cx| {
1597 this.apply_autoindents(indent_sizes, cx);
1598 })
1599 .ok();
1600 }));
1601 }
1602 }
1603 } else {
1604 self.autoindent_requests.clear();
1605 for tx in self.wait_for_autoindent_txs.drain(..) {
1606 tx.send(()).ok();
1607 }
1608 }
1609 }
1610
1611 fn compute_autoindents(
1612 &self,
1613 ) -> Option<impl Future<Output = BTreeMap<u32, IndentSize>> + use<>> {
1614 let max_rows_between_yields = 100;
1615 let snapshot = self.snapshot();
1616 if snapshot.syntax.is_empty() || self.autoindent_requests.is_empty() {
1617 return None;
1618 }
1619
1620 let autoindent_requests = self.autoindent_requests.clone();
1621 Some(async move {
1622 let mut indent_sizes = BTreeMap::<u32, (IndentSize, bool)>::new();
1623 for request in autoindent_requests {
1624 // Resolve each edited range to its row in the current buffer and in the
1625 // buffer before this batch of edits.
1626 let mut row_ranges = Vec::new();
1627 let mut old_to_new_rows = BTreeMap::new();
1628 let mut language_indent_sizes_by_new_row = Vec::new();
1629 for entry in &request.entries {
1630 let position = entry.range.start;
1631 let new_row = position.to_point(&snapshot).row;
1632 let new_end_row = entry.range.end.to_point(&snapshot).row + 1;
1633 language_indent_sizes_by_new_row.push((new_row, entry.indent_size));
1634
1635 if !entry.first_line_is_new {
1636 let old_row = position.to_point(&request.before_edit).row;
1637 old_to_new_rows.insert(old_row, new_row);
1638 }
1639 row_ranges.push((new_row..new_end_row, entry.original_indent_column));
1640 }
1641
1642 // Build a map containing the suggested indentation for each of the edited lines
1643 // with respect to the state of the buffer before these edits. This map is keyed
1644 // by the rows for these lines in the current state of the buffer.
1645 let mut old_suggestions = BTreeMap::<u32, (IndentSize, bool)>::default();
1646 let old_edited_ranges =
1647 contiguous_ranges(old_to_new_rows.keys().copied(), max_rows_between_yields);
1648 let mut language_indent_sizes = language_indent_sizes_by_new_row.iter().peekable();
1649 let mut language_indent_size = IndentSize::default();
1650 for old_edited_range in old_edited_ranges {
1651 let suggestions = request
1652 .before_edit
1653 .suggest_autoindents(old_edited_range.clone())
1654 .into_iter()
1655 .flatten();
1656 for (old_row, suggestion) in old_edited_range.zip(suggestions) {
1657 if let Some(suggestion) = suggestion {
1658 let new_row = *old_to_new_rows.get(&old_row).unwrap();
1659
1660 // Find the indent size based on the language for this row.
1661 while let Some((row, size)) = language_indent_sizes.peek() {
1662 if *row > new_row {
1663 break;
1664 }
1665 language_indent_size = *size;
1666 language_indent_sizes.next();
1667 }
1668
1669 let suggested_indent = old_to_new_rows
1670 .get(&suggestion.basis_row)
1671 .and_then(|from_row| {
1672 Some(old_suggestions.get(from_row).copied()?.0)
1673 })
1674 .unwrap_or_else(|| {
1675 request
1676 .before_edit
1677 .indent_size_for_line(suggestion.basis_row)
1678 })
1679 .with_delta(suggestion.delta, language_indent_size);
1680 old_suggestions
1681 .insert(new_row, (suggested_indent, suggestion.within_error));
1682 }
1683 }
1684 yield_now().await;
1685 }
1686
1687 // Compute new suggestions for each line, but only include them in the result
1688 // if they differ from the old suggestion for that line.
1689 let mut language_indent_sizes = language_indent_sizes_by_new_row.iter().peekable();
1690 let mut language_indent_size = IndentSize::default();
1691 for (row_range, original_indent_column) in row_ranges {
1692 let new_edited_row_range = if request.is_block_mode {
1693 row_range.start..row_range.start + 1
1694 } else {
1695 row_range.clone()
1696 };
1697
1698 let suggestions = snapshot
1699 .suggest_autoindents(new_edited_row_range.clone())
1700 .into_iter()
1701 .flatten();
1702 for (new_row, suggestion) in new_edited_row_range.zip(suggestions) {
1703 if let Some(suggestion) = suggestion {
1704 // Find the indent size based on the language for this row.
1705 while let Some((row, size)) = language_indent_sizes.peek() {
1706 if *row > new_row {
1707 break;
1708 }
1709 language_indent_size = *size;
1710 language_indent_sizes.next();
1711 }
1712
1713 let suggested_indent = indent_sizes
1714 .get(&suggestion.basis_row)
1715 .copied()
1716 .map(|e| e.0)
1717 .unwrap_or_else(|| {
1718 snapshot.indent_size_for_line(suggestion.basis_row)
1719 })
1720 .with_delta(suggestion.delta, language_indent_size);
1721
1722 if old_suggestions.get(&new_row).map_or(
1723 true,
1724 |(old_indentation, was_within_error)| {
1725 suggested_indent != *old_indentation
1726 && (!suggestion.within_error || *was_within_error)
1727 },
1728 ) {
1729 indent_sizes.insert(
1730 new_row,
1731 (suggested_indent, request.ignore_empty_lines),
1732 );
1733 }
1734 }
1735 }
1736
1737 if let (true, Some(original_indent_column)) =
1738 (request.is_block_mode, original_indent_column)
1739 {
1740 let new_indent =
1741 if let Some((indent, _)) = indent_sizes.get(&row_range.start) {
1742 *indent
1743 } else {
1744 snapshot.indent_size_for_line(row_range.start)
1745 };
1746 let delta = new_indent.len as i64 - original_indent_column as i64;
1747 if delta != 0 {
1748 for row in row_range.skip(1) {
1749 indent_sizes.entry(row).or_insert_with(|| {
1750 let mut size = snapshot.indent_size_for_line(row);
1751 if size.kind == new_indent.kind {
1752 match delta.cmp(&0) {
1753 Ordering::Greater => size.len += delta as u32,
1754 Ordering::Less => {
1755 size.len = size.len.saturating_sub(-delta as u32)
1756 }
1757 Ordering::Equal => {}
1758 }
1759 }
1760 (size, request.ignore_empty_lines)
1761 });
1762 }
1763 }
1764 }
1765
1766 yield_now().await;
1767 }
1768 }
1769
1770 indent_sizes
1771 .into_iter()
1772 .filter_map(|(row, (indent, ignore_empty_lines))| {
1773 if ignore_empty_lines && snapshot.line_len(row) == 0 {
1774 None
1775 } else {
1776 Some((row, indent))
1777 }
1778 })
1779 .collect()
1780 })
1781 }
1782
1783 fn apply_autoindents(
1784 &mut self,
1785 indent_sizes: BTreeMap<u32, IndentSize>,
1786 cx: &mut Context<Self>,
1787 ) {
1788 self.autoindent_requests.clear();
1789 for tx in self.wait_for_autoindent_txs.drain(..) {
1790 tx.send(()).ok();
1791 }
1792
1793 let edits: Vec<_> = indent_sizes
1794 .into_iter()
1795 .filter_map(|(row, indent_size)| {
1796 let current_size = indent_size_for_line(self, row);
1797 Self::edit_for_indent_size_adjustment(row, current_size, indent_size)
1798 })
1799 .collect();
1800
1801 let preserve_preview = self.preserve_preview();
1802 self.edit(edits, None, cx);
1803 if preserve_preview {
1804 self.refresh_preview();
1805 }
1806 }
1807
1808 /// Create a minimal edit that will cause the given row to be indented
1809 /// with the given size. After applying this edit, the length of the line
1810 /// will always be at least `new_size.len`.
1811 pub fn edit_for_indent_size_adjustment(
1812 row: u32,
1813 current_size: IndentSize,
1814 new_size: IndentSize,
1815 ) -> Option<(Range<Point>, String)> {
1816 if new_size.kind == current_size.kind {
1817 match new_size.len.cmp(¤t_size.len) {
1818 Ordering::Greater => {
1819 let point = Point::new(row, 0);
1820 Some((
1821 point..point,
1822 iter::repeat(new_size.char())
1823 .take((new_size.len - current_size.len) as usize)
1824 .collect::<String>(),
1825 ))
1826 }
1827
1828 Ordering::Less => Some((
1829 Point::new(row, 0)..Point::new(row, current_size.len - new_size.len),
1830 String::new(),
1831 )),
1832
1833 Ordering::Equal => None,
1834 }
1835 } else {
1836 Some((
1837 Point::new(row, 0)..Point::new(row, current_size.len),
1838 iter::repeat(new_size.char())
1839 .take(new_size.len as usize)
1840 .collect::<String>(),
1841 ))
1842 }
1843 }
1844
1845 /// Spawns a background task that asynchronously computes a `Diff` between the buffer's text
1846 /// and the given new text.
1847 pub fn diff(&self, mut new_text: String, cx: &App) -> Task<Diff> {
1848 let old_text = self.as_rope().clone();
1849 let base_version = self.version();
1850 cx.background_executor()
1851 .spawn_labeled(*BUFFER_DIFF_TASK, async move {
1852 let old_text = old_text.to_string();
1853 let line_ending = LineEnding::detect(&new_text);
1854 LineEnding::normalize(&mut new_text);
1855 let edits = text_diff(&old_text, &new_text);
1856 Diff {
1857 base_version,
1858 line_ending,
1859 edits,
1860 }
1861 })
1862 }
1863
1864 /// Spawns a background task that searches the buffer for any whitespace
1865 /// at the ends of a lines, and returns a `Diff` that removes that whitespace.
1866 pub fn remove_trailing_whitespace(&self, cx: &App) -> Task<Diff> {
1867 let old_text = self.as_rope().clone();
1868 let line_ending = self.line_ending();
1869 let base_version = self.version();
1870 cx.background_spawn(async move {
1871 let ranges = trailing_whitespace_ranges(&old_text);
1872 let empty = Arc::<str>::from("");
1873 Diff {
1874 base_version,
1875 line_ending,
1876 edits: ranges
1877 .into_iter()
1878 .map(|range| (range, empty.clone()))
1879 .collect(),
1880 }
1881 })
1882 }
1883
1884 /// Ensures that the buffer ends with a single newline character, and
1885 /// no other whitespace. Skips if the buffer is empty.
1886 pub fn ensure_final_newline(&mut self, cx: &mut Context<Self>) {
1887 let len = self.len();
1888 if len == 0 {
1889 return;
1890 }
1891 let mut offset = len;
1892 for chunk in self.as_rope().reversed_chunks_in_range(0..len) {
1893 let non_whitespace_len = chunk
1894 .trim_end_matches(|c: char| c.is_ascii_whitespace())
1895 .len();
1896 offset -= chunk.len();
1897 offset += non_whitespace_len;
1898 if non_whitespace_len != 0 {
1899 if offset == len - 1 && chunk.get(non_whitespace_len..) == Some("\n") {
1900 return;
1901 }
1902 break;
1903 }
1904 }
1905 self.edit([(offset..len, "\n")], None, cx);
1906 }
1907
1908 /// Applies a diff to the buffer. If the buffer has changed since the given diff was
1909 /// calculated, then adjust the diff to account for those changes, and discard any
1910 /// parts of the diff that conflict with those changes.
1911 pub fn apply_diff(&mut self, diff: Diff, cx: &mut Context<Self>) -> Option<TransactionId> {
1912 let snapshot = self.snapshot();
1913 let mut edits_since = snapshot.edits_since::<usize>(&diff.base_version).peekable();
1914 let mut delta = 0;
1915 let adjusted_edits = diff.edits.into_iter().filter_map(|(range, new_text)| {
1916 while let Some(edit_since) = edits_since.peek() {
1917 // If the edit occurs after a diff hunk, then it does not
1918 // affect that hunk.
1919 if edit_since.old.start > range.end {
1920 break;
1921 }
1922 // If the edit precedes the diff hunk, then adjust the hunk
1923 // to reflect the edit.
1924 else if edit_since.old.end < range.start {
1925 delta += edit_since.new_len() as i64 - edit_since.old_len() as i64;
1926 edits_since.next();
1927 }
1928 // If the edit intersects a diff hunk, then discard that hunk.
1929 else {
1930 return None;
1931 }
1932 }
1933
1934 let start = (range.start as i64 + delta) as usize;
1935 let end = (range.end as i64 + delta) as usize;
1936 Some((start..end, new_text))
1937 });
1938
1939 self.start_transaction();
1940 self.text.set_line_ending(diff.line_ending);
1941 self.edit(adjusted_edits, None, cx);
1942 self.end_transaction(cx)
1943 }
1944
1945 fn has_unsaved_edits(&self) -> bool {
1946 let (last_version, has_unsaved_edits) = self.has_unsaved_edits.take();
1947
1948 if last_version == self.version {
1949 self.has_unsaved_edits
1950 .set((last_version, has_unsaved_edits));
1951 return has_unsaved_edits;
1952 }
1953
1954 let has_edits = self.has_edits_since(&self.saved_version);
1955 self.has_unsaved_edits
1956 .set((self.version.clone(), has_edits));
1957 has_edits
1958 }
1959
1960 /// Checks if the buffer has unsaved changes.
1961 pub fn is_dirty(&self) -> bool {
1962 if self.capability == Capability::ReadOnly {
1963 return false;
1964 }
1965 if self.has_conflict {
1966 return true;
1967 }
1968 match self.file.as_ref().map(|f| f.disk_state()) {
1969 Some(DiskState::New) | Some(DiskState::Deleted) => {
1970 !self.is_empty() && self.has_unsaved_edits()
1971 }
1972 _ => self.has_unsaved_edits(),
1973 }
1974 }
1975
1976 /// Checks if the buffer and its file have both changed since the buffer
1977 /// was last saved or reloaded.
1978 pub fn has_conflict(&self) -> bool {
1979 if self.has_conflict {
1980 return true;
1981 }
1982 let Some(file) = self.file.as_ref() else {
1983 return false;
1984 };
1985 match file.disk_state() {
1986 DiskState::New => false,
1987 DiskState::Present { mtime } => match self.saved_mtime {
1988 Some(saved_mtime) => {
1989 mtime.bad_is_greater_than(saved_mtime) && self.has_unsaved_edits()
1990 }
1991 None => true,
1992 },
1993 DiskState::Deleted => false,
1994 }
1995 }
1996
1997 /// Gets a [`Subscription`] that tracks all of the changes to the buffer's text.
1998 pub fn subscribe(&mut self) -> Subscription {
1999 self.text.subscribe()
2000 }
2001
2002 /// Adds a bit to the list of bits that are set when the buffer's text changes.
2003 ///
2004 /// This allows downstream code to check if the buffer's text has changed without
2005 /// waiting for an effect cycle, which would be required if using eents.
2006 pub fn record_changes(&mut self, bit: rc::Weak<Cell<bool>>) {
2007 if let Err(ix) = self
2008 .change_bits
2009 .binary_search_by_key(&rc::Weak::as_ptr(&bit), rc::Weak::as_ptr)
2010 {
2011 self.change_bits.insert(ix, bit);
2012 }
2013 }
2014
2015 fn was_changed(&mut self) {
2016 self.change_bits.retain(|change_bit| {
2017 change_bit.upgrade().map_or(false, |bit| {
2018 bit.replace(true);
2019 true
2020 })
2021 });
2022 }
2023
2024 /// Starts a transaction, if one is not already in-progress. When undoing or
2025 /// redoing edits, all of the edits performed within a transaction are undone
2026 /// or redone together.
2027 pub fn start_transaction(&mut self) -> Option<TransactionId> {
2028 self.start_transaction_at(Instant::now())
2029 }
2030
2031 /// Starts a transaction, providing the current time. Subsequent transactions
2032 /// that occur within a short period of time will be grouped together. This
2033 /// is controlled by the buffer's undo grouping duration.
2034 pub fn start_transaction_at(&mut self, now: Instant) -> Option<TransactionId> {
2035 self.transaction_depth += 1;
2036 if self.was_dirty_before_starting_transaction.is_none() {
2037 self.was_dirty_before_starting_transaction = Some(self.is_dirty());
2038 }
2039 self.text.start_transaction_at(now)
2040 }
2041
2042 /// Terminates the current transaction, if this is the outermost transaction.
2043 pub fn end_transaction(&mut self, cx: &mut Context<Self>) -> Option<TransactionId> {
2044 self.end_transaction_at(Instant::now(), cx)
2045 }
2046
2047 /// Terminates the current transaction, providing the current time. Subsequent transactions
2048 /// that occur within a short period of time will be grouped together. This
2049 /// is controlled by the buffer's undo grouping duration.
2050 pub fn end_transaction_at(
2051 &mut self,
2052 now: Instant,
2053 cx: &mut Context<Self>,
2054 ) -> Option<TransactionId> {
2055 assert!(self.transaction_depth > 0);
2056 self.transaction_depth -= 1;
2057 let was_dirty = if self.transaction_depth == 0 {
2058 self.was_dirty_before_starting_transaction.take().unwrap()
2059 } else {
2060 false
2061 };
2062 if let Some((transaction_id, start_version)) = self.text.end_transaction_at(now) {
2063 self.did_edit(&start_version, was_dirty, cx);
2064 Some(transaction_id)
2065 } else {
2066 None
2067 }
2068 }
2069
2070 /// Manually add a transaction to the buffer's undo history.
2071 pub fn push_transaction(&mut self, transaction: Transaction, now: Instant) {
2072 self.text.push_transaction(transaction, now);
2073 }
2074
2075 /// Differs from `push_transaction` in that it does not clear the redo
2076 /// stack. Intended to be used to create a parent transaction to merge
2077 /// potential child transactions into.
2078 ///
2079 /// The caller is responsible for removing it from the undo history using
2080 /// `forget_transaction` if no edits are merged into it. Otherwise, if edits
2081 /// are merged into this transaction, the caller is responsible for ensuring
2082 /// the redo stack is cleared. The easiest way to ensure the redo stack is
2083 /// cleared is to create transactions with the usual `start_transaction` and
2084 /// `end_transaction` methods and merging the resulting transactions into
2085 /// the transaction created by this method
2086 pub fn push_empty_transaction(&mut self, now: Instant) -> TransactionId {
2087 self.text.push_empty_transaction(now)
2088 }
2089
2090 /// Prevent the last transaction from being grouped with any subsequent transactions,
2091 /// even if they occur with the buffer's undo grouping duration.
2092 pub fn finalize_last_transaction(&mut self) -> Option<&Transaction> {
2093 self.text.finalize_last_transaction()
2094 }
2095
2096 /// Manually group all changes since a given transaction.
2097 pub fn group_until_transaction(&mut self, transaction_id: TransactionId) {
2098 self.text.group_until_transaction(transaction_id);
2099 }
2100
2101 /// Manually remove a transaction from the buffer's undo history
2102 pub fn forget_transaction(&mut self, transaction_id: TransactionId) -> Option<Transaction> {
2103 self.text.forget_transaction(transaction_id)
2104 }
2105
2106 /// Retrieve a transaction from the buffer's undo history
2107 pub fn get_transaction(&self, transaction_id: TransactionId) -> Option<&Transaction> {
2108 self.text.get_transaction(transaction_id)
2109 }
2110
2111 /// Manually merge two transactions in the buffer's undo history.
2112 pub fn merge_transactions(&mut self, transaction: TransactionId, destination: TransactionId) {
2113 self.text.merge_transactions(transaction, destination);
2114 }
2115
2116 /// Waits for the buffer to receive operations with the given timestamps.
2117 pub fn wait_for_edits<It: IntoIterator<Item = clock::Lamport>>(
2118 &mut self,
2119 edit_ids: It,
2120 ) -> impl Future<Output = Result<()>> + use<It> {
2121 self.text.wait_for_edits(edit_ids)
2122 }
2123
2124 /// Waits for the buffer to receive the operations necessary for resolving the given anchors.
2125 pub fn wait_for_anchors<It: IntoIterator<Item = Anchor>>(
2126 &mut self,
2127 anchors: It,
2128 ) -> impl 'static + Future<Output = Result<()>> + use<It> {
2129 self.text.wait_for_anchors(anchors)
2130 }
2131
2132 /// Waits for the buffer to receive operations up to the given version.
2133 pub fn wait_for_version(
2134 &mut self,
2135 version: clock::Global,
2136 ) -> impl Future<Output = Result<()>> + use<> {
2137 self.text.wait_for_version(version)
2138 }
2139
2140 /// Forces all futures returned by [`Buffer::wait_for_version`], [`Buffer::wait_for_edits`], or
2141 /// [`Buffer::wait_for_version`] to resolve with an error.
2142 pub fn give_up_waiting(&mut self) {
2143 self.text.give_up_waiting();
2144 }
2145
2146 pub fn wait_for_autoindent_applied(&mut self) -> Option<oneshot::Receiver<()>> {
2147 let mut rx = None;
2148 if !self.autoindent_requests.is_empty() {
2149 let channel = oneshot::channel();
2150 self.wait_for_autoindent_txs.push(channel.0);
2151 rx = Some(channel.1);
2152 }
2153 rx
2154 }
2155
2156 /// Stores a set of selections that should be broadcasted to all of the buffer's replicas.
2157 pub fn set_active_selections(
2158 &mut self,
2159 selections: Arc<[Selection<Anchor>]>,
2160 line_mode: bool,
2161 cursor_shape: CursorShape,
2162 cx: &mut Context<Self>,
2163 ) {
2164 let lamport_timestamp = self.text.lamport_clock.tick();
2165 self.remote_selections.insert(
2166 self.text.replica_id(),
2167 SelectionSet {
2168 selections: selections.clone(),
2169 lamport_timestamp,
2170 line_mode,
2171 cursor_shape,
2172 },
2173 );
2174 self.send_operation(
2175 Operation::UpdateSelections {
2176 selections,
2177 line_mode,
2178 lamport_timestamp,
2179 cursor_shape,
2180 },
2181 true,
2182 cx,
2183 );
2184 self.non_text_state_update_count += 1;
2185 cx.notify();
2186 }
2187
2188 /// Clears the selections, so that other replicas of the buffer do not see any selections for
2189 /// this replica.
2190 pub fn remove_active_selections(&mut self, cx: &mut Context<Self>) {
2191 if self
2192 .remote_selections
2193 .get(&self.text.replica_id())
2194 .map_or(true, |set| !set.selections.is_empty())
2195 {
2196 self.set_active_selections(Arc::default(), false, Default::default(), cx);
2197 }
2198 }
2199
2200 pub fn set_agent_selections(
2201 &mut self,
2202 selections: Arc<[Selection<Anchor>]>,
2203 line_mode: bool,
2204 cursor_shape: CursorShape,
2205 cx: &mut Context<Self>,
2206 ) {
2207 let lamport_timestamp = self.text.lamport_clock.tick();
2208 self.remote_selections.insert(
2209 AGENT_REPLICA_ID,
2210 SelectionSet {
2211 selections: selections.clone(),
2212 lamport_timestamp,
2213 line_mode,
2214 cursor_shape,
2215 },
2216 );
2217 self.non_text_state_update_count += 1;
2218 cx.notify();
2219 }
2220
2221 pub fn remove_agent_selections(&mut self, cx: &mut Context<Self>) {
2222 self.set_agent_selections(Arc::default(), false, Default::default(), cx);
2223 }
2224
2225 /// Replaces the buffer's entire text.
2226 pub fn set_text<T>(&mut self, text: T, cx: &mut Context<Self>) -> Option<clock::Lamport>
2227 where
2228 T: Into<Arc<str>>,
2229 {
2230 self.autoindent_requests.clear();
2231 self.edit([(0..self.len(), text)], None, cx)
2232 }
2233
2234 /// Appends the given text to the end of the buffer.
2235 pub fn append<T>(&mut self, text: T, cx: &mut Context<Self>) -> Option<clock::Lamport>
2236 where
2237 T: Into<Arc<str>>,
2238 {
2239 self.edit([(self.len()..self.len(), text)], None, cx)
2240 }
2241
2242 /// Applies the given edits to the buffer. Each edit is specified as a range of text to
2243 /// delete, and a string of text to insert at that location.
2244 ///
2245 /// If an [`AutoindentMode`] is provided, then the buffer will enqueue an auto-indent
2246 /// request for the edited ranges, which will be processed when the buffer finishes
2247 /// parsing.
2248 ///
2249 /// Parsing takes place at the end of a transaction, and may compute synchronously
2250 /// or asynchronously, depending on the changes.
2251 pub fn edit<I, S, T>(
2252 &mut self,
2253 edits_iter: I,
2254 autoindent_mode: Option<AutoindentMode>,
2255 cx: &mut Context<Self>,
2256 ) -> Option<clock::Lamport>
2257 where
2258 I: IntoIterator<Item = (Range<S>, T)>,
2259 S: ToOffset,
2260 T: Into<Arc<str>>,
2261 {
2262 // Skip invalid edits and coalesce contiguous ones.
2263 let mut edits: Vec<(Range<usize>, Arc<str>)> = Vec::new();
2264
2265 for (range, new_text) in edits_iter {
2266 let mut range = range.start.to_offset(self)..range.end.to_offset(self);
2267
2268 if range.start > range.end {
2269 mem::swap(&mut range.start, &mut range.end);
2270 }
2271 let new_text = new_text.into();
2272 if !new_text.is_empty() || !range.is_empty() {
2273 if let Some((prev_range, prev_text)) = edits.last_mut() {
2274 if prev_range.end >= range.start {
2275 prev_range.end = cmp::max(prev_range.end, range.end);
2276 *prev_text = format!("{prev_text}{new_text}").into();
2277 } else {
2278 edits.push((range, new_text));
2279 }
2280 } else {
2281 edits.push((range, new_text));
2282 }
2283 }
2284 }
2285 if edits.is_empty() {
2286 return None;
2287 }
2288
2289 self.start_transaction();
2290 self.pending_autoindent.take();
2291 let autoindent_request = autoindent_mode
2292 .and_then(|mode| self.language.as_ref().map(|_| (self.snapshot(), mode)));
2293
2294 let edit_operation = self.text.edit(edits.iter().cloned());
2295 let edit_id = edit_operation.timestamp();
2296
2297 if let Some((before_edit, mode)) = autoindent_request {
2298 let mut delta = 0isize;
2299 let entries = edits
2300 .into_iter()
2301 .enumerate()
2302 .zip(&edit_operation.as_edit().unwrap().new_text)
2303 .map(|((ix, (range, _)), new_text)| {
2304 let new_text_length = new_text.len();
2305 let old_start = range.start.to_point(&before_edit);
2306 let new_start = (delta + range.start as isize) as usize;
2307 let range_len = range.end - range.start;
2308 delta += new_text_length as isize - range_len as isize;
2309
2310 // Decide what range of the insertion to auto-indent, and whether
2311 // the first line of the insertion should be considered a newly-inserted line
2312 // or an edit to an existing line.
2313 let mut range_of_insertion_to_indent = 0..new_text_length;
2314 let mut first_line_is_new = true;
2315
2316 let old_line_start = before_edit.indent_size_for_line(old_start.row).len;
2317 let old_line_end = before_edit.line_len(old_start.row);
2318
2319 if old_start.column > old_line_start {
2320 first_line_is_new = false;
2321 }
2322
2323 if !new_text.contains('\n')
2324 && (old_start.column + (range_len as u32) < old_line_end
2325 || old_line_end == old_line_start)
2326 {
2327 first_line_is_new = false;
2328 }
2329
2330 // When inserting text starting with a newline, avoid auto-indenting the
2331 // previous line.
2332 if new_text.starts_with('\n') {
2333 range_of_insertion_to_indent.start += 1;
2334 first_line_is_new = true;
2335 }
2336
2337 let mut original_indent_column = None;
2338 if let AutoindentMode::Block {
2339 original_indent_columns,
2340 } = &mode
2341 {
2342 original_indent_column = Some(if new_text.starts_with('\n') {
2343 indent_size_for_text(
2344 new_text[range_of_insertion_to_indent.clone()].chars(),
2345 )
2346 .len
2347 } else {
2348 original_indent_columns
2349 .get(ix)
2350 .copied()
2351 .flatten()
2352 .unwrap_or_else(|| {
2353 indent_size_for_text(
2354 new_text[range_of_insertion_to_indent.clone()].chars(),
2355 )
2356 .len
2357 })
2358 });
2359
2360 // Avoid auto-indenting the line after the edit.
2361 if new_text[range_of_insertion_to_indent.clone()].ends_with('\n') {
2362 range_of_insertion_to_indent.end -= 1;
2363 }
2364 }
2365
2366 AutoindentRequestEntry {
2367 first_line_is_new,
2368 original_indent_column,
2369 indent_size: before_edit.language_indent_size_at(range.start, cx),
2370 range: self.anchor_before(new_start + range_of_insertion_to_indent.start)
2371 ..self.anchor_after(new_start + range_of_insertion_to_indent.end),
2372 }
2373 })
2374 .collect();
2375
2376 self.autoindent_requests.push(Arc::new(AutoindentRequest {
2377 before_edit,
2378 entries,
2379 is_block_mode: matches!(mode, AutoindentMode::Block { .. }),
2380 ignore_empty_lines: false,
2381 }));
2382 }
2383
2384 self.end_transaction(cx);
2385 self.send_operation(Operation::Buffer(edit_operation), true, cx);
2386 Some(edit_id)
2387 }
2388
2389 fn did_edit(&mut self, old_version: &clock::Global, was_dirty: bool, cx: &mut Context<Self>) {
2390 self.was_changed();
2391
2392 if self.edits_since::<usize>(old_version).next().is_none() {
2393 return;
2394 }
2395
2396 self.reparse(cx);
2397 cx.emit(BufferEvent::Edited);
2398 if was_dirty != self.is_dirty() {
2399 cx.emit(BufferEvent::DirtyChanged);
2400 }
2401 cx.notify();
2402 }
2403
2404 pub fn autoindent_ranges<I, T>(&mut self, ranges: I, cx: &mut Context<Self>)
2405 where
2406 I: IntoIterator<Item = Range<T>>,
2407 T: ToOffset + Copy,
2408 {
2409 let before_edit = self.snapshot();
2410 let entries = ranges
2411 .into_iter()
2412 .map(|range| AutoindentRequestEntry {
2413 range: before_edit.anchor_before(range.start)..before_edit.anchor_after(range.end),
2414 first_line_is_new: true,
2415 indent_size: before_edit.language_indent_size_at(range.start, cx),
2416 original_indent_column: None,
2417 })
2418 .collect();
2419 self.autoindent_requests.push(Arc::new(AutoindentRequest {
2420 before_edit,
2421 entries,
2422 is_block_mode: false,
2423 ignore_empty_lines: true,
2424 }));
2425 self.request_autoindent(cx);
2426 }
2427
2428 // Inserts newlines at the given position to create an empty line, returning the start of the new line.
2429 // You can also request the insertion of empty lines above and below the line starting at the returned point.
2430 pub fn insert_empty_line(
2431 &mut self,
2432 position: impl ToPoint,
2433 space_above: bool,
2434 space_below: bool,
2435 cx: &mut Context<Self>,
2436 ) -> Point {
2437 let mut position = position.to_point(self);
2438
2439 self.start_transaction();
2440
2441 self.edit(
2442 [(position..position, "\n")],
2443 Some(AutoindentMode::EachLine),
2444 cx,
2445 );
2446
2447 if position.column > 0 {
2448 position += Point::new(1, 0);
2449 }
2450
2451 if !self.is_line_blank(position.row) {
2452 self.edit(
2453 [(position..position, "\n")],
2454 Some(AutoindentMode::EachLine),
2455 cx,
2456 );
2457 }
2458
2459 if space_above && position.row > 0 && !self.is_line_blank(position.row - 1) {
2460 self.edit(
2461 [(position..position, "\n")],
2462 Some(AutoindentMode::EachLine),
2463 cx,
2464 );
2465 position.row += 1;
2466 }
2467
2468 if space_below
2469 && (position.row == self.max_point().row || !self.is_line_blank(position.row + 1))
2470 {
2471 self.edit(
2472 [(position..position, "\n")],
2473 Some(AutoindentMode::EachLine),
2474 cx,
2475 );
2476 }
2477
2478 self.end_transaction(cx);
2479
2480 position
2481 }
2482
2483 /// Applies the given remote operations to the buffer.
2484 pub fn apply_ops<I: IntoIterator<Item = Operation>>(&mut self, ops: I, cx: &mut Context<Self>) {
2485 self.pending_autoindent.take();
2486 let was_dirty = self.is_dirty();
2487 let old_version = self.version.clone();
2488 let mut deferred_ops = Vec::new();
2489 let buffer_ops = ops
2490 .into_iter()
2491 .filter_map(|op| match op {
2492 Operation::Buffer(op) => Some(op),
2493 _ => {
2494 if self.can_apply_op(&op) {
2495 self.apply_op(op, cx);
2496 } else {
2497 deferred_ops.push(op);
2498 }
2499 None
2500 }
2501 })
2502 .collect::<Vec<_>>();
2503 for operation in buffer_ops.iter() {
2504 self.send_operation(Operation::Buffer(operation.clone()), false, cx);
2505 }
2506 self.text.apply_ops(buffer_ops);
2507 self.deferred_ops.insert(deferred_ops);
2508 self.flush_deferred_ops(cx);
2509 self.did_edit(&old_version, was_dirty, cx);
2510 // Notify independently of whether the buffer was edited as the operations could include a
2511 // selection update.
2512 cx.notify();
2513 }
2514
2515 fn flush_deferred_ops(&mut self, cx: &mut Context<Self>) {
2516 let mut deferred_ops = Vec::new();
2517 for op in self.deferred_ops.drain().iter().cloned() {
2518 if self.can_apply_op(&op) {
2519 self.apply_op(op, cx);
2520 } else {
2521 deferred_ops.push(op);
2522 }
2523 }
2524 self.deferred_ops.insert(deferred_ops);
2525 }
2526
2527 pub fn has_deferred_ops(&self) -> bool {
2528 !self.deferred_ops.is_empty() || self.text.has_deferred_ops()
2529 }
2530
2531 fn can_apply_op(&self, operation: &Operation) -> bool {
2532 match operation {
2533 Operation::Buffer(_) => {
2534 unreachable!("buffer operations should never be applied at this layer")
2535 }
2536 Operation::UpdateDiagnostics {
2537 diagnostics: diagnostic_set,
2538 ..
2539 } => diagnostic_set.iter().all(|diagnostic| {
2540 self.text.can_resolve(&diagnostic.range.start)
2541 && self.text.can_resolve(&diagnostic.range.end)
2542 }),
2543 Operation::UpdateSelections { selections, .. } => selections
2544 .iter()
2545 .all(|s| self.can_resolve(&s.start) && self.can_resolve(&s.end)),
2546 Operation::UpdateCompletionTriggers { .. } => true,
2547 }
2548 }
2549
2550 fn apply_op(&mut self, operation: Operation, cx: &mut Context<Self>) {
2551 match operation {
2552 Operation::Buffer(_) => {
2553 unreachable!("buffer operations should never be applied at this layer")
2554 }
2555 Operation::UpdateDiagnostics {
2556 server_id,
2557 diagnostics: diagnostic_set,
2558 lamport_timestamp,
2559 } => {
2560 let snapshot = self.snapshot();
2561 self.apply_diagnostic_update(
2562 server_id,
2563 DiagnosticSet::from_sorted_entries(diagnostic_set.iter().cloned(), &snapshot),
2564 lamport_timestamp,
2565 cx,
2566 );
2567 }
2568 Operation::UpdateSelections {
2569 selections,
2570 lamport_timestamp,
2571 line_mode,
2572 cursor_shape,
2573 } => {
2574 if let Some(set) = self.remote_selections.get(&lamport_timestamp.replica_id) {
2575 if set.lamport_timestamp > lamport_timestamp {
2576 return;
2577 }
2578 }
2579
2580 self.remote_selections.insert(
2581 lamport_timestamp.replica_id,
2582 SelectionSet {
2583 selections,
2584 lamport_timestamp,
2585 line_mode,
2586 cursor_shape,
2587 },
2588 );
2589 self.text.lamport_clock.observe(lamport_timestamp);
2590 self.non_text_state_update_count += 1;
2591 }
2592 Operation::UpdateCompletionTriggers {
2593 triggers,
2594 lamport_timestamp,
2595 server_id,
2596 } => {
2597 if triggers.is_empty() {
2598 self.completion_triggers_per_language_server
2599 .remove(&server_id);
2600 self.completion_triggers = self
2601 .completion_triggers_per_language_server
2602 .values()
2603 .flat_map(|triggers| triggers.into_iter().cloned())
2604 .collect();
2605 } else {
2606 self.completion_triggers_per_language_server
2607 .insert(server_id, triggers.iter().cloned().collect());
2608 self.completion_triggers.extend(triggers);
2609 }
2610 self.text.lamport_clock.observe(lamport_timestamp);
2611 }
2612 }
2613 }
2614
2615 fn apply_diagnostic_update(
2616 &mut self,
2617 server_id: LanguageServerId,
2618 diagnostics: DiagnosticSet,
2619 lamport_timestamp: clock::Lamport,
2620 cx: &mut Context<Self>,
2621 ) {
2622 if lamport_timestamp > self.diagnostics_timestamp {
2623 let ix = self.diagnostics.binary_search_by_key(&server_id, |e| e.0);
2624 if diagnostics.is_empty() {
2625 if let Ok(ix) = ix {
2626 self.diagnostics.remove(ix);
2627 }
2628 } else {
2629 match ix {
2630 Err(ix) => self.diagnostics.insert(ix, (server_id, diagnostics)),
2631 Ok(ix) => self.diagnostics[ix].1 = diagnostics,
2632 };
2633 }
2634 self.diagnostics_timestamp = lamport_timestamp;
2635 self.non_text_state_update_count += 1;
2636 self.text.lamport_clock.observe(lamport_timestamp);
2637 cx.notify();
2638 cx.emit(BufferEvent::DiagnosticsUpdated);
2639 }
2640 }
2641
2642 fn send_operation(&mut self, operation: Operation, is_local: bool, cx: &mut Context<Self>) {
2643 self.was_changed();
2644 cx.emit(BufferEvent::Operation {
2645 operation,
2646 is_local,
2647 });
2648 }
2649
2650 /// Removes the selections for a given peer.
2651 pub fn remove_peer(&mut self, replica_id: ReplicaId, cx: &mut Context<Self>) {
2652 self.remote_selections.remove(&replica_id);
2653 cx.notify();
2654 }
2655
2656 /// Undoes the most recent transaction.
2657 pub fn undo(&mut self, cx: &mut Context<Self>) -> Option<TransactionId> {
2658 let was_dirty = self.is_dirty();
2659 let old_version = self.version.clone();
2660
2661 if let Some((transaction_id, operation)) = self.text.undo() {
2662 self.send_operation(Operation::Buffer(operation), true, cx);
2663 self.did_edit(&old_version, was_dirty, cx);
2664 Some(transaction_id)
2665 } else {
2666 None
2667 }
2668 }
2669
2670 /// Manually undoes a specific transaction in the buffer's undo history.
2671 pub fn undo_transaction(
2672 &mut self,
2673 transaction_id: TransactionId,
2674 cx: &mut Context<Self>,
2675 ) -> bool {
2676 let was_dirty = self.is_dirty();
2677 let old_version = self.version.clone();
2678 if let Some(operation) = self.text.undo_transaction(transaction_id) {
2679 self.send_operation(Operation::Buffer(operation), true, cx);
2680 self.did_edit(&old_version, was_dirty, cx);
2681 true
2682 } else {
2683 false
2684 }
2685 }
2686
2687 /// Manually undoes all changes after a given transaction in the buffer's undo history.
2688 pub fn undo_to_transaction(
2689 &mut self,
2690 transaction_id: TransactionId,
2691 cx: &mut Context<Self>,
2692 ) -> bool {
2693 let was_dirty = self.is_dirty();
2694 let old_version = self.version.clone();
2695
2696 let operations = self.text.undo_to_transaction(transaction_id);
2697 let undone = !operations.is_empty();
2698 for operation in operations {
2699 self.send_operation(Operation::Buffer(operation), true, cx);
2700 }
2701 if undone {
2702 self.did_edit(&old_version, was_dirty, cx)
2703 }
2704 undone
2705 }
2706
2707 pub fn undo_operations(&mut self, counts: HashMap<Lamport, u32>, cx: &mut Context<Buffer>) {
2708 let was_dirty = self.is_dirty();
2709 let operation = self.text.undo_operations(counts);
2710 let old_version = self.version.clone();
2711 self.send_operation(Operation::Buffer(operation), true, cx);
2712 self.did_edit(&old_version, was_dirty, cx);
2713 }
2714
2715 /// Manually redoes a specific transaction in the buffer's redo history.
2716 pub fn redo(&mut self, cx: &mut Context<Self>) -> Option<TransactionId> {
2717 let was_dirty = self.is_dirty();
2718 let old_version = self.version.clone();
2719
2720 if let Some((transaction_id, operation)) = self.text.redo() {
2721 self.send_operation(Operation::Buffer(operation), true, cx);
2722 self.did_edit(&old_version, was_dirty, cx);
2723 Some(transaction_id)
2724 } else {
2725 None
2726 }
2727 }
2728
2729 /// Manually undoes all changes until a given transaction in the buffer's redo history.
2730 pub fn redo_to_transaction(
2731 &mut self,
2732 transaction_id: TransactionId,
2733 cx: &mut Context<Self>,
2734 ) -> bool {
2735 let was_dirty = self.is_dirty();
2736 let old_version = self.version.clone();
2737
2738 let operations = self.text.redo_to_transaction(transaction_id);
2739 let redone = !operations.is_empty();
2740 for operation in operations {
2741 self.send_operation(Operation::Buffer(operation), true, cx);
2742 }
2743 if redone {
2744 self.did_edit(&old_version, was_dirty, cx)
2745 }
2746 redone
2747 }
2748
2749 /// Override current completion triggers with the user-provided completion triggers.
2750 pub fn set_completion_triggers(
2751 &mut self,
2752 server_id: LanguageServerId,
2753 triggers: BTreeSet<String>,
2754 cx: &mut Context<Self>,
2755 ) {
2756 self.completion_triggers_timestamp = self.text.lamport_clock.tick();
2757 if triggers.is_empty() {
2758 self.completion_triggers_per_language_server
2759 .remove(&server_id);
2760 self.completion_triggers = self
2761 .completion_triggers_per_language_server
2762 .values()
2763 .flat_map(|triggers| triggers.into_iter().cloned())
2764 .collect();
2765 } else {
2766 self.completion_triggers_per_language_server
2767 .insert(server_id, triggers.clone());
2768 self.completion_triggers.extend(triggers.iter().cloned());
2769 }
2770 self.send_operation(
2771 Operation::UpdateCompletionTriggers {
2772 triggers: triggers.into_iter().collect(),
2773 lamport_timestamp: self.completion_triggers_timestamp,
2774 server_id,
2775 },
2776 true,
2777 cx,
2778 );
2779 cx.notify();
2780 }
2781
2782 /// Returns a list of strings which trigger a completion menu for this language.
2783 /// Usually this is driven by LSP server which returns a list of trigger characters for completions.
2784 pub fn completion_triggers(&self) -> &BTreeSet<String> {
2785 &self.completion_triggers
2786 }
2787
2788 /// Call this directly after performing edits to prevent the preview tab
2789 /// from being dismissed by those edits. It causes `should_dismiss_preview`
2790 /// to return false until there are additional edits.
2791 pub fn refresh_preview(&mut self) {
2792 self.preview_version = self.version.clone();
2793 }
2794
2795 /// Whether we should preserve the preview status of a tab containing this buffer.
2796 pub fn preserve_preview(&self) -> bool {
2797 !self.has_edits_since(&self.preview_version)
2798 }
2799}
2800
2801#[doc(hidden)]
2802#[cfg(any(test, feature = "test-support"))]
2803impl Buffer {
2804 pub fn edit_via_marked_text(
2805 &mut self,
2806 marked_string: &str,
2807 autoindent_mode: Option<AutoindentMode>,
2808 cx: &mut Context<Self>,
2809 ) {
2810 let edits = self.edits_for_marked_text(marked_string);
2811 self.edit(edits, autoindent_mode, cx);
2812 }
2813
2814 pub fn set_group_interval(&mut self, group_interval: Duration) {
2815 self.text.set_group_interval(group_interval);
2816 }
2817
2818 pub fn randomly_edit<T>(&mut self, rng: &mut T, old_range_count: usize, cx: &mut Context<Self>)
2819 where
2820 T: rand::Rng,
2821 {
2822 let mut edits: Vec<(Range<usize>, String)> = Vec::new();
2823 let mut last_end = None;
2824 for _ in 0..old_range_count {
2825 if last_end.map_or(false, |last_end| last_end >= self.len()) {
2826 break;
2827 }
2828
2829 let new_start = last_end.map_or(0, |last_end| last_end + 1);
2830 let mut range = self.random_byte_range(new_start, rng);
2831 if rng.gen_bool(0.2) {
2832 mem::swap(&mut range.start, &mut range.end);
2833 }
2834 last_end = Some(range.end);
2835
2836 let new_text_len = rng.gen_range(0..10);
2837 let mut new_text: String = RandomCharIter::new(&mut *rng).take(new_text_len).collect();
2838 new_text = new_text.to_uppercase();
2839
2840 edits.push((range, new_text));
2841 }
2842 log::info!("mutating buffer {} with {:?}", self.replica_id(), edits);
2843 self.edit(edits, None, cx);
2844 }
2845
2846 pub fn randomly_undo_redo(&mut self, rng: &mut impl rand::Rng, cx: &mut Context<Self>) {
2847 let was_dirty = self.is_dirty();
2848 let old_version = self.version.clone();
2849
2850 let ops = self.text.randomly_undo_redo(rng);
2851 if !ops.is_empty() {
2852 for op in ops {
2853 self.send_operation(Operation::Buffer(op), true, cx);
2854 self.did_edit(&old_version, was_dirty, cx);
2855 }
2856 }
2857 }
2858}
2859
2860impl EventEmitter<BufferEvent> for Buffer {}
2861
2862impl Deref for Buffer {
2863 type Target = TextBuffer;
2864
2865 fn deref(&self) -> &Self::Target {
2866 &self.text
2867 }
2868}
2869
2870impl BufferSnapshot {
2871 /// Returns [`IndentSize`] for a given line that respects user settings and
2872 /// language preferences.
2873 pub fn indent_size_for_line(&self, row: u32) -> IndentSize {
2874 indent_size_for_line(self, row)
2875 }
2876
2877 /// Returns [`IndentSize`] for a given position that respects user settings
2878 /// and language preferences.
2879 pub fn language_indent_size_at<T: ToOffset>(&self, position: T, cx: &App) -> IndentSize {
2880 let settings = language_settings(
2881 self.language_at(position).map(|l| l.name()),
2882 self.file(),
2883 cx,
2884 );
2885 if settings.hard_tabs {
2886 IndentSize::tab()
2887 } else {
2888 IndentSize::spaces(settings.tab_size.get())
2889 }
2890 }
2891
2892 /// Retrieve the suggested indent size for all of the given rows. The unit of indentation
2893 /// is passed in as `single_indent_size`.
2894 pub fn suggested_indents(
2895 &self,
2896 rows: impl Iterator<Item = u32>,
2897 single_indent_size: IndentSize,
2898 ) -> BTreeMap<u32, IndentSize> {
2899 let mut result = BTreeMap::new();
2900
2901 for row_range in contiguous_ranges(rows, 10) {
2902 let suggestions = match self.suggest_autoindents(row_range.clone()) {
2903 Some(suggestions) => suggestions,
2904 _ => break,
2905 };
2906
2907 for (row, suggestion) in row_range.zip(suggestions) {
2908 let indent_size = if let Some(suggestion) = suggestion {
2909 result
2910 .get(&suggestion.basis_row)
2911 .copied()
2912 .unwrap_or_else(|| self.indent_size_for_line(suggestion.basis_row))
2913 .with_delta(suggestion.delta, single_indent_size)
2914 } else {
2915 self.indent_size_for_line(row)
2916 };
2917
2918 result.insert(row, indent_size);
2919 }
2920 }
2921
2922 result
2923 }
2924
2925 fn suggest_autoindents(
2926 &self,
2927 row_range: Range<u32>,
2928 ) -> Option<impl Iterator<Item = Option<IndentSuggestion>> + '_> {
2929 let config = &self.language.as_ref()?.config;
2930 let prev_non_blank_row = self.prev_non_blank_row(row_range.start);
2931
2932 #[derive(Debug, Clone)]
2933 struct StartPosition {
2934 start: Point,
2935 suffix: SharedString,
2936 }
2937
2938 // Find the suggested indentation ranges based on the syntax tree.
2939 let start = Point::new(prev_non_blank_row.unwrap_or(row_range.start), 0);
2940 let end = Point::new(row_range.end, 0);
2941 let range = (start..end).to_offset(&self.text);
2942 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
2943 Some(&grammar.indents_config.as_ref()?.query)
2944 });
2945 let indent_configs = matches
2946 .grammars()
2947 .iter()
2948 .map(|grammar| grammar.indents_config.as_ref().unwrap())
2949 .collect::<Vec<_>>();
2950
2951 let mut indent_ranges = Vec::<Range<Point>>::new();
2952 let mut start_positions = Vec::<StartPosition>::new();
2953 let mut outdent_positions = Vec::<Point>::new();
2954 while let Some(mat) = matches.peek() {
2955 let mut start: Option<Point> = None;
2956 let mut end: Option<Point> = None;
2957
2958 let config = indent_configs[mat.grammar_index];
2959 for capture in mat.captures {
2960 if capture.index == config.indent_capture_ix {
2961 start.get_or_insert(Point::from_ts_point(capture.node.start_position()));
2962 end.get_or_insert(Point::from_ts_point(capture.node.end_position()));
2963 } else if Some(capture.index) == config.start_capture_ix {
2964 start = Some(Point::from_ts_point(capture.node.end_position()));
2965 } else if Some(capture.index) == config.end_capture_ix {
2966 end = Some(Point::from_ts_point(capture.node.start_position()));
2967 } else if Some(capture.index) == config.outdent_capture_ix {
2968 outdent_positions.push(Point::from_ts_point(capture.node.start_position()));
2969 } else if let Some(suffix) = config.suffixed_start_captures.get(&capture.index) {
2970 start_positions.push(StartPosition {
2971 start: Point::from_ts_point(capture.node.start_position()),
2972 suffix: suffix.clone(),
2973 });
2974 }
2975 }
2976
2977 matches.advance();
2978 if let Some((start, end)) = start.zip(end) {
2979 if start.row == end.row {
2980 continue;
2981 }
2982 let range = start..end;
2983 match indent_ranges.binary_search_by_key(&range.start, |r| r.start) {
2984 Err(ix) => indent_ranges.insert(ix, range),
2985 Ok(ix) => {
2986 let prev_range = &mut indent_ranges[ix];
2987 prev_range.end = prev_range.end.max(range.end);
2988 }
2989 }
2990 }
2991 }
2992
2993 let mut error_ranges = Vec::<Range<Point>>::new();
2994 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
2995 grammar.error_query.as_ref()
2996 });
2997 while let Some(mat) = matches.peek() {
2998 let node = mat.captures[0].node;
2999 let start = Point::from_ts_point(node.start_position());
3000 let end = Point::from_ts_point(node.end_position());
3001 let range = start..end;
3002 let ix = match error_ranges.binary_search_by_key(&range.start, |r| r.start) {
3003 Ok(ix) | Err(ix) => ix,
3004 };
3005 let mut end_ix = ix;
3006 while let Some(existing_range) = error_ranges.get(end_ix) {
3007 if existing_range.end < end {
3008 end_ix += 1;
3009 } else {
3010 break;
3011 }
3012 }
3013 error_ranges.splice(ix..end_ix, [range]);
3014 matches.advance();
3015 }
3016
3017 outdent_positions.sort();
3018 for outdent_position in outdent_positions {
3019 // find the innermost indent range containing this outdent_position
3020 // set its end to the outdent position
3021 if let Some(range_to_truncate) = indent_ranges
3022 .iter_mut()
3023 .filter(|indent_range| indent_range.contains(&outdent_position))
3024 .next_back()
3025 {
3026 range_to_truncate.end = outdent_position;
3027 }
3028 }
3029
3030 start_positions.sort_by_key(|b| b.start);
3031
3032 // Find the suggested indentation increases and decreased based on regexes.
3033 let mut regex_outdent_map = HashMap::default();
3034 let mut last_seen_suffix: HashMap<String, Vec<Point>> = HashMap::default();
3035 let mut start_positions_iter = start_positions.iter().peekable();
3036
3037 let mut indent_change_rows = Vec::<(u32, Ordering)>::new();
3038 self.for_each_line(
3039 Point::new(prev_non_blank_row.unwrap_or(row_range.start), 0)
3040 ..Point::new(row_range.end, 0),
3041 |row, line| {
3042 if config
3043 .decrease_indent_pattern
3044 .as_ref()
3045 .map_or(false, |regex| regex.is_match(line))
3046 {
3047 indent_change_rows.push((row, Ordering::Less));
3048 }
3049 if config
3050 .increase_indent_pattern
3051 .as_ref()
3052 .map_or(false, |regex| regex.is_match(line))
3053 {
3054 indent_change_rows.push((row + 1, Ordering::Greater));
3055 }
3056 while let Some(pos) = start_positions_iter.peek() {
3057 if pos.start.row < row {
3058 let pos = start_positions_iter.next().unwrap();
3059 last_seen_suffix
3060 .entry(pos.suffix.to_string())
3061 .or_default()
3062 .push(pos.start);
3063 } else {
3064 break;
3065 }
3066 }
3067 for rule in &config.decrease_indent_patterns {
3068 if rule.pattern.as_ref().map_or(false, |r| r.is_match(line)) {
3069 let row_start_column = self.indent_size_for_line(row).len;
3070 let basis_row = rule
3071 .valid_after
3072 .iter()
3073 .filter_map(|valid_suffix| last_seen_suffix.get(valid_suffix))
3074 .flatten()
3075 .filter(|start_point| start_point.column <= row_start_column)
3076 .max_by_key(|start_point| start_point.row);
3077 if let Some(outdent_to_row) = basis_row {
3078 regex_outdent_map.insert(row, outdent_to_row.row);
3079 }
3080 break;
3081 }
3082 }
3083 },
3084 );
3085
3086 let mut indent_changes = indent_change_rows.into_iter().peekable();
3087 let mut prev_row = if config.auto_indent_using_last_non_empty_line {
3088 prev_non_blank_row.unwrap_or(0)
3089 } else {
3090 row_range.start.saturating_sub(1)
3091 };
3092
3093 let mut prev_row_start = Point::new(prev_row, self.indent_size_for_line(prev_row).len);
3094 Some(row_range.map(move |row| {
3095 let row_start = Point::new(row, self.indent_size_for_line(row).len);
3096
3097 let mut indent_from_prev_row = false;
3098 let mut outdent_from_prev_row = false;
3099 let mut outdent_to_row = u32::MAX;
3100 let mut from_regex = false;
3101
3102 while let Some((indent_row, delta)) = indent_changes.peek() {
3103 match indent_row.cmp(&row) {
3104 Ordering::Equal => match delta {
3105 Ordering::Less => {
3106 from_regex = true;
3107 outdent_from_prev_row = true
3108 }
3109 Ordering::Greater => {
3110 indent_from_prev_row = true;
3111 from_regex = true
3112 }
3113 _ => {}
3114 },
3115
3116 Ordering::Greater => break,
3117 Ordering::Less => {}
3118 }
3119
3120 indent_changes.next();
3121 }
3122
3123 for range in &indent_ranges {
3124 if range.start.row >= row {
3125 break;
3126 }
3127 if range.start.row == prev_row && range.end > row_start {
3128 indent_from_prev_row = true;
3129 }
3130 if range.end > prev_row_start && range.end <= row_start {
3131 outdent_to_row = outdent_to_row.min(range.start.row);
3132 }
3133 }
3134
3135 if let Some(basis_row) = regex_outdent_map.get(&row) {
3136 indent_from_prev_row = false;
3137 outdent_to_row = *basis_row;
3138 from_regex = true;
3139 }
3140
3141 let within_error = error_ranges
3142 .iter()
3143 .any(|e| e.start.row < row && e.end > row_start);
3144
3145 let suggestion = if outdent_to_row == prev_row
3146 || (outdent_from_prev_row && indent_from_prev_row)
3147 {
3148 Some(IndentSuggestion {
3149 basis_row: prev_row,
3150 delta: Ordering::Equal,
3151 within_error: within_error && !from_regex,
3152 })
3153 } else if indent_from_prev_row {
3154 Some(IndentSuggestion {
3155 basis_row: prev_row,
3156 delta: Ordering::Greater,
3157 within_error: within_error && !from_regex,
3158 })
3159 } else if outdent_to_row < prev_row {
3160 Some(IndentSuggestion {
3161 basis_row: outdent_to_row,
3162 delta: Ordering::Equal,
3163 within_error: within_error && !from_regex,
3164 })
3165 } else if outdent_from_prev_row {
3166 Some(IndentSuggestion {
3167 basis_row: prev_row,
3168 delta: Ordering::Less,
3169 within_error: within_error && !from_regex,
3170 })
3171 } else if config.auto_indent_using_last_non_empty_line || !self.is_line_blank(prev_row)
3172 {
3173 Some(IndentSuggestion {
3174 basis_row: prev_row,
3175 delta: Ordering::Equal,
3176 within_error: within_error && !from_regex,
3177 })
3178 } else {
3179 None
3180 };
3181
3182 prev_row = row;
3183 prev_row_start = row_start;
3184 suggestion
3185 }))
3186 }
3187
3188 fn prev_non_blank_row(&self, mut row: u32) -> Option<u32> {
3189 while row > 0 {
3190 row -= 1;
3191 if !self.is_line_blank(row) {
3192 return Some(row);
3193 }
3194 }
3195 None
3196 }
3197
3198 fn get_highlights(&self, range: Range<usize>) -> (SyntaxMapCaptures<'_>, Vec<HighlightMap>) {
3199 let captures = self.syntax.captures(range, &self.text, |grammar| {
3200 grammar.highlights_query.as_ref()
3201 });
3202 let highlight_maps = captures
3203 .grammars()
3204 .iter()
3205 .map(|grammar| grammar.highlight_map())
3206 .collect();
3207 (captures, highlight_maps)
3208 }
3209
3210 /// Iterates over chunks of text in the given range of the buffer. Text is chunked
3211 /// in an arbitrary way due to being stored in a [`Rope`](text::Rope). The text is also
3212 /// returned in chunks where each chunk has a single syntax highlighting style and
3213 /// diagnostic status.
3214 pub fn chunks<T: ToOffset>(&self, range: Range<T>, language_aware: bool) -> BufferChunks<'_> {
3215 let range = range.start.to_offset(self)..range.end.to_offset(self);
3216
3217 let mut syntax = None;
3218 if language_aware {
3219 syntax = Some(self.get_highlights(range.clone()));
3220 }
3221 // We want to look at diagnostic spans only when iterating over language-annotated chunks.
3222 let diagnostics = language_aware;
3223 BufferChunks::new(self.text.as_rope(), range, syntax, diagnostics, Some(self))
3224 }
3225
3226 pub fn highlighted_text_for_range<T: ToOffset>(
3227 &self,
3228 range: Range<T>,
3229 override_style: Option<HighlightStyle>,
3230 syntax_theme: &SyntaxTheme,
3231 ) -> HighlightedText {
3232 HighlightedText::from_buffer_range(
3233 range,
3234 &self.text,
3235 &self.syntax,
3236 override_style,
3237 syntax_theme,
3238 )
3239 }
3240
3241 /// Invokes the given callback for each line of text in the given range of the buffer.
3242 /// Uses callback to avoid allocating a string for each line.
3243 fn for_each_line(&self, range: Range<Point>, mut callback: impl FnMut(u32, &str)) {
3244 let mut line = String::new();
3245 let mut row = range.start.row;
3246 for chunk in self
3247 .as_rope()
3248 .chunks_in_range(range.to_offset(self))
3249 .chain(["\n"])
3250 {
3251 for (newline_ix, text) in chunk.split('\n').enumerate() {
3252 if newline_ix > 0 {
3253 callback(row, &line);
3254 row += 1;
3255 line.clear();
3256 }
3257 line.push_str(text);
3258 }
3259 }
3260 }
3261
3262 /// Iterates over every [`SyntaxLayer`] in the buffer.
3263 pub fn syntax_layers(&self) -> impl Iterator<Item = SyntaxLayer<'_>> + '_ {
3264 self.syntax
3265 .layers_for_range(0..self.len(), &self.text, true)
3266 }
3267
3268 pub fn syntax_layer_at<D: ToOffset>(&self, position: D) -> Option<SyntaxLayer<'_>> {
3269 let offset = position.to_offset(self);
3270 self.syntax
3271 .layers_for_range(offset..offset, &self.text, false)
3272 .filter(|l| l.node().end_byte() > offset)
3273 .last()
3274 }
3275
3276 pub fn smallest_syntax_layer_containing<D: ToOffset>(
3277 &self,
3278 range: Range<D>,
3279 ) -> Option<SyntaxLayer<'_>> {
3280 let range = range.to_offset(self);
3281 return self
3282 .syntax
3283 .layers_for_range(range, &self.text, false)
3284 .max_by(|a, b| {
3285 if a.depth != b.depth {
3286 a.depth.cmp(&b.depth)
3287 } else if a.offset.0 != b.offset.0 {
3288 a.offset.0.cmp(&b.offset.0)
3289 } else {
3290 a.node().end_byte().cmp(&b.node().end_byte()).reverse()
3291 }
3292 });
3293 }
3294
3295 /// Returns the main [`Language`].
3296 pub fn language(&self) -> Option<&Arc<Language>> {
3297 self.language.as_ref()
3298 }
3299
3300 /// Returns the [`Language`] at the given location.
3301 pub fn language_at<D: ToOffset>(&self, position: D) -> Option<&Arc<Language>> {
3302 self.syntax_layer_at(position)
3303 .map(|info| info.language)
3304 .or(self.language.as_ref())
3305 }
3306
3307 /// Returns the settings for the language at the given location.
3308 pub fn settings_at<'a, D: ToOffset>(
3309 &'a self,
3310 position: D,
3311 cx: &'a App,
3312 ) -> Cow<'a, LanguageSettings> {
3313 language_settings(
3314 self.language_at(position).map(|l| l.name()),
3315 self.file.as_ref(),
3316 cx,
3317 )
3318 }
3319
3320 pub fn char_classifier_at<T: ToOffset>(&self, point: T) -> CharClassifier {
3321 CharClassifier::new(self.language_scope_at(point))
3322 }
3323
3324 /// Returns the [`LanguageScope`] at the given location.
3325 pub fn language_scope_at<D: ToOffset>(&self, position: D) -> Option<LanguageScope> {
3326 let offset = position.to_offset(self);
3327 let mut scope = None;
3328 let mut smallest_range_and_depth: Option<(Range<usize>, usize)> = None;
3329
3330 // Use the layer that has the smallest node intersecting the given point.
3331 for layer in self
3332 .syntax
3333 .layers_for_range(offset..offset, &self.text, false)
3334 {
3335 let mut cursor = layer.node().walk();
3336
3337 let mut range = None;
3338 loop {
3339 let child_range = cursor.node().byte_range();
3340 if !child_range.contains(&offset) {
3341 break;
3342 }
3343
3344 range = Some(child_range);
3345 if cursor.goto_first_child_for_byte(offset).is_none() {
3346 break;
3347 }
3348 }
3349
3350 if let Some(range) = range {
3351 if smallest_range_and_depth.as_ref().map_or(
3352 true,
3353 |(smallest_range, smallest_range_depth)| {
3354 if layer.depth > *smallest_range_depth {
3355 true
3356 } else if layer.depth == *smallest_range_depth {
3357 range.len() < smallest_range.len()
3358 } else {
3359 false
3360 }
3361 },
3362 ) {
3363 smallest_range_and_depth = Some((range, layer.depth));
3364 scope = Some(LanguageScope {
3365 language: layer.language.clone(),
3366 override_id: layer.override_id(offset, &self.text),
3367 });
3368 }
3369 }
3370 }
3371
3372 scope.or_else(|| {
3373 self.language.clone().map(|language| LanguageScope {
3374 language,
3375 override_id: None,
3376 })
3377 })
3378 }
3379
3380 /// Returns a tuple of the range and character kind of the word
3381 /// surrounding the given position.
3382 pub fn surrounding_word<T: ToOffset>(&self, start: T) -> (Range<usize>, Option<CharKind>) {
3383 let mut start = start.to_offset(self);
3384 let mut end = start;
3385 let mut next_chars = self.chars_at(start).take(128).peekable();
3386 let mut prev_chars = self.reversed_chars_at(start).take(128).peekable();
3387
3388 let classifier = self.char_classifier_at(start);
3389 let word_kind = cmp::max(
3390 prev_chars.peek().copied().map(|c| classifier.kind(c)),
3391 next_chars.peek().copied().map(|c| classifier.kind(c)),
3392 );
3393
3394 for ch in prev_chars {
3395 if Some(classifier.kind(ch)) == word_kind && ch != '\n' {
3396 start -= ch.len_utf8();
3397 } else {
3398 break;
3399 }
3400 }
3401
3402 for ch in next_chars {
3403 if Some(classifier.kind(ch)) == word_kind && ch != '\n' {
3404 end += ch.len_utf8();
3405 } else {
3406 break;
3407 }
3408 }
3409
3410 (start..end, word_kind)
3411 }
3412
3413 /// Returns the closest syntax node enclosing the given range.
3414 pub fn syntax_ancestor<'a, T: ToOffset>(
3415 &'a self,
3416 range: Range<T>,
3417 ) -> Option<tree_sitter::Node<'a>> {
3418 let range = range.start.to_offset(self)..range.end.to_offset(self);
3419 let mut result: Option<tree_sitter::Node<'a>> = None;
3420 'outer: for layer in self
3421 .syntax
3422 .layers_for_range(range.clone(), &self.text, true)
3423 {
3424 let mut cursor = layer.node().walk();
3425
3426 // Descend to the first leaf that touches the start of the range.
3427 //
3428 // If the range is non-empty and the current node ends exactly at the start,
3429 // move to the next sibling to find a node that extends beyond the start.
3430 //
3431 // If the range is empty and the current node starts after the range position,
3432 // move to the previous sibling to find the node that contains the position.
3433 while cursor.goto_first_child_for_byte(range.start).is_some() {
3434 if !range.is_empty() && cursor.node().end_byte() == range.start {
3435 cursor.goto_next_sibling();
3436 }
3437 if range.is_empty() && cursor.node().start_byte() > range.start {
3438 cursor.goto_previous_sibling();
3439 }
3440 }
3441
3442 // Ascend to the smallest ancestor that strictly contains the range.
3443 loop {
3444 let node_range = cursor.node().byte_range();
3445 if node_range.start <= range.start
3446 && node_range.end >= range.end
3447 && node_range.len() > range.len()
3448 {
3449 break;
3450 }
3451 if !cursor.goto_parent() {
3452 continue 'outer;
3453 }
3454 }
3455
3456 let left_node = cursor.node();
3457 let mut layer_result = left_node;
3458
3459 // For an empty range, try to find another node immediately to the right of the range.
3460 if left_node.end_byte() == range.start {
3461 let mut right_node = None;
3462 while !cursor.goto_next_sibling() {
3463 if !cursor.goto_parent() {
3464 break;
3465 }
3466 }
3467
3468 while cursor.node().start_byte() == range.start {
3469 right_node = Some(cursor.node());
3470 if !cursor.goto_first_child() {
3471 break;
3472 }
3473 }
3474
3475 // If there is a candidate node on both sides of the (empty) range, then
3476 // decide between the two by favoring a named node over an anonymous token.
3477 // If both nodes are the same in that regard, favor the right one.
3478 if let Some(right_node) = right_node {
3479 if right_node.is_named() || !left_node.is_named() {
3480 layer_result = right_node;
3481 }
3482 }
3483 }
3484
3485 if let Some(previous_result) = &result {
3486 if previous_result.byte_range().len() < layer_result.byte_range().len() {
3487 continue;
3488 }
3489 }
3490 result = Some(layer_result);
3491 }
3492
3493 result
3494 }
3495
3496 /// Returns the root syntax node within the given row
3497 pub fn syntax_root_ancestor(&self, position: Anchor) -> Option<tree_sitter::Node<'_>> {
3498 let start_offset = position.to_offset(self);
3499
3500 let row = self.summary_for_anchor::<text::PointUtf16>(&position).row as usize;
3501
3502 let layer = self
3503 .syntax
3504 .layers_for_range(start_offset..start_offset, &self.text, true)
3505 .next()?;
3506
3507 let mut cursor = layer.node().walk();
3508
3509 // Descend to the first leaf that touches the start of the range.
3510 while cursor.goto_first_child_for_byte(start_offset).is_some() {
3511 if cursor.node().end_byte() == start_offset {
3512 cursor.goto_next_sibling();
3513 }
3514 }
3515
3516 // Ascend to the root node within the same row.
3517 while cursor.goto_parent() {
3518 if cursor.node().start_position().row != row {
3519 break;
3520 }
3521 }
3522
3523 return Some(cursor.node());
3524 }
3525
3526 /// Returns the outline for the buffer.
3527 ///
3528 /// This method allows passing an optional [`SyntaxTheme`] to
3529 /// syntax-highlight the returned symbols.
3530 pub fn outline(&self, theme: Option<&SyntaxTheme>) -> Option<Outline<Anchor>> {
3531 self.outline_items_containing(0..self.len(), true, theme)
3532 .map(Outline::new)
3533 }
3534
3535 /// Returns all the symbols that contain the given position.
3536 ///
3537 /// This method allows passing an optional [`SyntaxTheme`] to
3538 /// syntax-highlight the returned symbols.
3539 pub fn symbols_containing<T: ToOffset>(
3540 &self,
3541 position: T,
3542 theme: Option<&SyntaxTheme>,
3543 ) -> Option<Vec<OutlineItem<Anchor>>> {
3544 let position = position.to_offset(self);
3545 let mut items = self.outline_items_containing(
3546 position.saturating_sub(1)..self.len().min(position + 1),
3547 false,
3548 theme,
3549 )?;
3550 let mut prev_depth = None;
3551 items.retain(|item| {
3552 let result = prev_depth.map_or(true, |prev_depth| item.depth > prev_depth);
3553 prev_depth = Some(item.depth);
3554 result
3555 });
3556 Some(items)
3557 }
3558
3559 pub fn outline_range_containing<T: ToOffset>(&self, range: Range<T>) -> Option<Range<Point>> {
3560 let range = range.to_offset(self);
3561 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
3562 grammar.outline_config.as_ref().map(|c| &c.query)
3563 });
3564 let configs = matches
3565 .grammars()
3566 .iter()
3567 .map(|g| g.outline_config.as_ref().unwrap())
3568 .collect::<Vec<_>>();
3569
3570 while let Some(mat) = matches.peek() {
3571 let config = &configs[mat.grammar_index];
3572 let containing_item_node = maybe!({
3573 let item_node = mat.captures.iter().find_map(|cap| {
3574 if cap.index == config.item_capture_ix {
3575 Some(cap.node)
3576 } else {
3577 None
3578 }
3579 })?;
3580
3581 let item_byte_range = item_node.byte_range();
3582 if item_byte_range.end < range.start || item_byte_range.start > range.end {
3583 None
3584 } else {
3585 Some(item_node)
3586 }
3587 });
3588
3589 if let Some(item_node) = containing_item_node {
3590 return Some(
3591 Point::from_ts_point(item_node.start_position())
3592 ..Point::from_ts_point(item_node.end_position()),
3593 );
3594 }
3595
3596 matches.advance();
3597 }
3598 None
3599 }
3600
3601 pub fn outline_items_containing<T: ToOffset>(
3602 &self,
3603 range: Range<T>,
3604 include_extra_context: bool,
3605 theme: Option<&SyntaxTheme>,
3606 ) -> Option<Vec<OutlineItem<Anchor>>> {
3607 let range = range.to_offset(self);
3608 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
3609 grammar.outline_config.as_ref().map(|c| &c.query)
3610 });
3611 let configs = matches
3612 .grammars()
3613 .iter()
3614 .map(|g| g.outline_config.as_ref().unwrap())
3615 .collect::<Vec<_>>();
3616
3617 let mut items = Vec::new();
3618 let mut annotation_row_ranges: Vec<Range<u32>> = Vec::new();
3619 while let Some(mat) = matches.peek() {
3620 let config = &configs[mat.grammar_index];
3621 if let Some(item) =
3622 self.next_outline_item(config, &mat, &range, include_extra_context, theme)
3623 {
3624 items.push(item);
3625 } else if let Some(capture) = mat
3626 .captures
3627 .iter()
3628 .find(|capture| Some(capture.index) == config.annotation_capture_ix)
3629 {
3630 let capture_range = capture.node.start_position()..capture.node.end_position();
3631 let mut capture_row_range =
3632 capture_range.start.row as u32..capture_range.end.row as u32;
3633 if capture_range.end.row > capture_range.start.row && capture_range.end.column == 0
3634 {
3635 capture_row_range.end -= 1;
3636 }
3637 if let Some(last_row_range) = annotation_row_ranges.last_mut() {
3638 if last_row_range.end >= capture_row_range.start.saturating_sub(1) {
3639 last_row_range.end = capture_row_range.end;
3640 } else {
3641 annotation_row_ranges.push(capture_row_range);
3642 }
3643 } else {
3644 annotation_row_ranges.push(capture_row_range);
3645 }
3646 }
3647 matches.advance();
3648 }
3649
3650 items.sort_by_key(|item| (item.range.start, Reverse(item.range.end)));
3651
3652 // Assign depths based on containment relationships and convert to anchors.
3653 let mut item_ends_stack = Vec::<Point>::new();
3654 let mut anchor_items = Vec::new();
3655 let mut annotation_row_ranges = annotation_row_ranges.into_iter().peekable();
3656 for item in items {
3657 while let Some(last_end) = item_ends_stack.last().copied() {
3658 if last_end < item.range.end {
3659 item_ends_stack.pop();
3660 } else {
3661 break;
3662 }
3663 }
3664
3665 let mut annotation_row_range = None;
3666 while let Some(next_annotation_row_range) = annotation_row_ranges.peek() {
3667 let row_preceding_item = item.range.start.row.saturating_sub(1);
3668 if next_annotation_row_range.end < row_preceding_item {
3669 annotation_row_ranges.next();
3670 } else {
3671 if next_annotation_row_range.end == row_preceding_item {
3672 annotation_row_range = Some(next_annotation_row_range.clone());
3673 annotation_row_ranges.next();
3674 }
3675 break;
3676 }
3677 }
3678
3679 anchor_items.push(OutlineItem {
3680 depth: item_ends_stack.len(),
3681 range: self.anchor_after(item.range.start)..self.anchor_before(item.range.end),
3682 text: item.text,
3683 highlight_ranges: item.highlight_ranges,
3684 name_ranges: item.name_ranges,
3685 body_range: item.body_range.map(|body_range| {
3686 self.anchor_after(body_range.start)..self.anchor_before(body_range.end)
3687 }),
3688 annotation_range: annotation_row_range.map(|annotation_range| {
3689 self.anchor_after(Point::new(annotation_range.start, 0))
3690 ..self.anchor_before(Point::new(
3691 annotation_range.end,
3692 self.line_len(annotation_range.end),
3693 ))
3694 }),
3695 });
3696 item_ends_stack.push(item.range.end);
3697 }
3698
3699 Some(anchor_items)
3700 }
3701
3702 fn next_outline_item(
3703 &self,
3704 config: &OutlineConfig,
3705 mat: &SyntaxMapMatch,
3706 range: &Range<usize>,
3707 include_extra_context: bool,
3708 theme: Option<&SyntaxTheme>,
3709 ) -> Option<OutlineItem<Point>> {
3710 let item_node = mat.captures.iter().find_map(|cap| {
3711 if cap.index == config.item_capture_ix {
3712 Some(cap.node)
3713 } else {
3714 None
3715 }
3716 })?;
3717
3718 let item_byte_range = item_node.byte_range();
3719 if item_byte_range.end < range.start || item_byte_range.start > range.end {
3720 return None;
3721 }
3722 let item_point_range = Point::from_ts_point(item_node.start_position())
3723 ..Point::from_ts_point(item_node.end_position());
3724
3725 let mut open_point = None;
3726 let mut close_point = None;
3727 let mut buffer_ranges = Vec::new();
3728 for capture in mat.captures {
3729 let node_is_name;
3730 if capture.index == config.name_capture_ix {
3731 node_is_name = true;
3732 } else if Some(capture.index) == config.context_capture_ix
3733 || (Some(capture.index) == config.extra_context_capture_ix && include_extra_context)
3734 {
3735 node_is_name = false;
3736 } else {
3737 if Some(capture.index) == config.open_capture_ix {
3738 open_point = Some(Point::from_ts_point(capture.node.end_position()));
3739 } else if Some(capture.index) == config.close_capture_ix {
3740 close_point = Some(Point::from_ts_point(capture.node.start_position()));
3741 }
3742
3743 continue;
3744 }
3745
3746 let mut range = capture.node.start_byte()..capture.node.end_byte();
3747 let start = capture.node.start_position();
3748 if capture.node.end_position().row > start.row {
3749 range.end = range.start + self.line_len(start.row as u32) as usize - start.column;
3750 }
3751
3752 if !range.is_empty() {
3753 buffer_ranges.push((range, node_is_name));
3754 }
3755 }
3756 if buffer_ranges.is_empty() {
3757 return None;
3758 }
3759 let mut text = String::new();
3760 let mut highlight_ranges = Vec::new();
3761 let mut name_ranges = Vec::new();
3762 let mut chunks = self.chunks(
3763 buffer_ranges.first().unwrap().0.start..buffer_ranges.last().unwrap().0.end,
3764 true,
3765 );
3766 let mut last_buffer_range_end = 0;
3767
3768 for (buffer_range, is_name) in buffer_ranges {
3769 let space_added = !text.is_empty() && buffer_range.start > last_buffer_range_end;
3770 if space_added {
3771 text.push(' ');
3772 }
3773 let before_append_len = text.len();
3774 let mut offset = buffer_range.start;
3775 chunks.seek(buffer_range.clone());
3776 for mut chunk in chunks.by_ref() {
3777 if chunk.text.len() > buffer_range.end - offset {
3778 chunk.text = &chunk.text[0..(buffer_range.end - offset)];
3779 offset = buffer_range.end;
3780 } else {
3781 offset += chunk.text.len();
3782 }
3783 let style = chunk
3784 .syntax_highlight_id
3785 .zip(theme)
3786 .and_then(|(highlight, theme)| highlight.style(theme));
3787 if let Some(style) = style {
3788 let start = text.len();
3789 let end = start + chunk.text.len();
3790 highlight_ranges.push((start..end, style));
3791 }
3792 text.push_str(chunk.text);
3793 if offset >= buffer_range.end {
3794 break;
3795 }
3796 }
3797 if is_name {
3798 let after_append_len = text.len();
3799 let start = if space_added && !name_ranges.is_empty() {
3800 before_append_len - 1
3801 } else {
3802 before_append_len
3803 };
3804 name_ranges.push(start..after_append_len);
3805 }
3806 last_buffer_range_end = buffer_range.end;
3807 }
3808
3809 Some(OutlineItem {
3810 depth: 0, // We'll calculate the depth later
3811 range: item_point_range,
3812 text,
3813 highlight_ranges,
3814 name_ranges,
3815 body_range: open_point.zip(close_point).map(|(start, end)| start..end),
3816 annotation_range: None,
3817 })
3818 }
3819
3820 pub fn function_body_fold_ranges<T: ToOffset>(
3821 &self,
3822 within: Range<T>,
3823 ) -> impl Iterator<Item = Range<usize>> + '_ {
3824 self.text_object_ranges(within, TreeSitterOptions::default())
3825 .filter_map(|(range, obj)| (obj == TextObject::InsideFunction).then_some(range))
3826 }
3827
3828 /// For each grammar in the language, runs the provided
3829 /// [`tree_sitter::Query`] against the given range.
3830 pub fn matches(
3831 &self,
3832 range: Range<usize>,
3833 query: fn(&Grammar) -> Option<&tree_sitter::Query>,
3834 ) -> SyntaxMapMatches<'_> {
3835 self.syntax.matches(range, self, query)
3836 }
3837
3838 pub fn all_bracket_ranges(
3839 &self,
3840 range: Range<usize>,
3841 ) -> impl Iterator<Item = BracketMatch> + '_ {
3842 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
3843 grammar.brackets_config.as_ref().map(|c| &c.query)
3844 });
3845 let configs = matches
3846 .grammars()
3847 .iter()
3848 .map(|grammar| grammar.brackets_config.as_ref().unwrap())
3849 .collect::<Vec<_>>();
3850
3851 iter::from_fn(move || {
3852 while let Some(mat) = matches.peek() {
3853 let mut open = None;
3854 let mut close = None;
3855 let config = &configs[mat.grammar_index];
3856 let pattern = &config.patterns[mat.pattern_index];
3857 for capture in mat.captures {
3858 if capture.index == config.open_capture_ix {
3859 open = Some(capture.node.byte_range());
3860 } else if capture.index == config.close_capture_ix {
3861 close = Some(capture.node.byte_range());
3862 }
3863 }
3864
3865 matches.advance();
3866
3867 let Some((open_range, close_range)) = open.zip(close) else {
3868 continue;
3869 };
3870
3871 let bracket_range = open_range.start..=close_range.end;
3872 if !bracket_range.overlaps(&range) {
3873 continue;
3874 }
3875
3876 return Some(BracketMatch {
3877 open_range,
3878 close_range,
3879 newline_only: pattern.newline_only,
3880 });
3881 }
3882 None
3883 })
3884 }
3885
3886 /// Returns bracket range pairs overlapping or adjacent to `range`
3887 pub fn bracket_ranges<T: ToOffset>(
3888 &self,
3889 range: Range<T>,
3890 ) -> impl Iterator<Item = BracketMatch> + '_ {
3891 // Find bracket pairs that *inclusively* contain the given range.
3892 let range = range.start.to_offset(self).saturating_sub(1)
3893 ..self.len().min(range.end.to_offset(self) + 1);
3894 self.all_bracket_ranges(range)
3895 .filter(|pair| !pair.newline_only)
3896 }
3897
3898 pub fn debug_variables_query<T: ToOffset>(
3899 &self,
3900 range: Range<T>,
3901 ) -> impl Iterator<Item = (Range<usize>, DebuggerTextObject)> + '_ {
3902 let range = range.start.to_offset(self).saturating_sub(1)
3903 ..self.len().min(range.end.to_offset(self) + 1);
3904
3905 let mut matches = self.syntax.matches_with_options(
3906 range.clone(),
3907 &self.text,
3908 TreeSitterOptions::default(),
3909 |grammar| grammar.debug_variables_config.as_ref().map(|c| &c.query),
3910 );
3911
3912 let configs = matches
3913 .grammars()
3914 .iter()
3915 .map(|grammar| grammar.debug_variables_config.as_ref())
3916 .collect::<Vec<_>>();
3917
3918 let mut captures = Vec::<(Range<usize>, DebuggerTextObject)>::new();
3919
3920 iter::from_fn(move || {
3921 loop {
3922 while let Some(capture) = captures.pop() {
3923 if capture.0.overlaps(&range) {
3924 return Some(capture);
3925 }
3926 }
3927
3928 let mat = matches.peek()?;
3929
3930 let Some(config) = configs[mat.grammar_index].as_ref() else {
3931 matches.advance();
3932 continue;
3933 };
3934
3935 for capture in mat.captures {
3936 let Some(ix) = config
3937 .objects_by_capture_ix
3938 .binary_search_by_key(&capture.index, |e| e.0)
3939 .ok()
3940 else {
3941 continue;
3942 };
3943 let text_object = config.objects_by_capture_ix[ix].1;
3944 let byte_range = capture.node.byte_range();
3945
3946 let mut found = false;
3947 for (range, existing) in captures.iter_mut() {
3948 if existing == &text_object {
3949 range.start = range.start.min(byte_range.start);
3950 range.end = range.end.max(byte_range.end);
3951 found = true;
3952 break;
3953 }
3954 }
3955
3956 if !found {
3957 captures.push((byte_range, text_object));
3958 }
3959 }
3960
3961 matches.advance();
3962 }
3963 })
3964 }
3965
3966 pub fn text_object_ranges<T: ToOffset>(
3967 &self,
3968 range: Range<T>,
3969 options: TreeSitterOptions,
3970 ) -> impl Iterator<Item = (Range<usize>, TextObject)> + '_ {
3971 let range = range.start.to_offset(self).saturating_sub(1)
3972 ..self.len().min(range.end.to_offset(self) + 1);
3973
3974 let mut matches =
3975 self.syntax
3976 .matches_with_options(range.clone(), &self.text, options, |grammar| {
3977 grammar.text_object_config.as_ref().map(|c| &c.query)
3978 });
3979
3980 let configs = matches
3981 .grammars()
3982 .iter()
3983 .map(|grammar| grammar.text_object_config.as_ref())
3984 .collect::<Vec<_>>();
3985
3986 let mut captures = Vec::<(Range<usize>, TextObject)>::new();
3987
3988 iter::from_fn(move || {
3989 loop {
3990 while let Some(capture) = captures.pop() {
3991 if capture.0.overlaps(&range) {
3992 return Some(capture);
3993 }
3994 }
3995
3996 let mat = matches.peek()?;
3997
3998 let Some(config) = configs[mat.grammar_index].as_ref() else {
3999 matches.advance();
4000 continue;
4001 };
4002
4003 for capture in mat.captures {
4004 let Some(ix) = config
4005 .text_objects_by_capture_ix
4006 .binary_search_by_key(&capture.index, |e| e.0)
4007 .ok()
4008 else {
4009 continue;
4010 };
4011 let text_object = config.text_objects_by_capture_ix[ix].1;
4012 let byte_range = capture.node.byte_range();
4013
4014 let mut found = false;
4015 for (range, existing) in captures.iter_mut() {
4016 if existing == &text_object {
4017 range.start = range.start.min(byte_range.start);
4018 range.end = range.end.max(byte_range.end);
4019 found = true;
4020 break;
4021 }
4022 }
4023
4024 if !found {
4025 captures.push((byte_range, text_object));
4026 }
4027 }
4028
4029 matches.advance();
4030 }
4031 })
4032 }
4033
4034 /// Returns enclosing bracket ranges containing the given range
4035 pub fn enclosing_bracket_ranges<T: ToOffset>(
4036 &self,
4037 range: Range<T>,
4038 ) -> impl Iterator<Item = BracketMatch> + '_ {
4039 let range = range.start.to_offset(self)..range.end.to_offset(self);
4040
4041 self.bracket_ranges(range.clone()).filter(move |pair| {
4042 pair.open_range.start <= range.start && pair.close_range.end >= range.end
4043 })
4044 }
4045
4046 /// Returns the smallest enclosing bracket ranges containing the given range or None if no brackets contain range
4047 ///
4048 /// Can optionally pass a range_filter to filter the ranges of brackets to consider
4049 pub fn innermost_enclosing_bracket_ranges<T: ToOffset>(
4050 &self,
4051 range: Range<T>,
4052 range_filter: Option<&dyn Fn(Range<usize>, Range<usize>) -> bool>,
4053 ) -> Option<(Range<usize>, Range<usize>)> {
4054 let range = range.start.to_offset(self)..range.end.to_offset(self);
4055
4056 // Get the ranges of the innermost pair of brackets.
4057 let mut result: Option<(Range<usize>, Range<usize>)> = None;
4058
4059 for pair in self.enclosing_bracket_ranges(range.clone()) {
4060 if let Some(range_filter) = range_filter {
4061 if !range_filter(pair.open_range.clone(), pair.close_range.clone()) {
4062 continue;
4063 }
4064 }
4065
4066 let len = pair.close_range.end - pair.open_range.start;
4067
4068 if let Some((existing_open, existing_close)) = &result {
4069 let existing_len = existing_close.end - existing_open.start;
4070 if len > existing_len {
4071 continue;
4072 }
4073 }
4074
4075 result = Some((pair.open_range, pair.close_range));
4076 }
4077
4078 result
4079 }
4080
4081 /// Returns anchor ranges for any matches of the redaction query.
4082 /// The buffer can be associated with multiple languages, and the redaction query associated with each
4083 /// will be run on the relevant section of the buffer.
4084 pub fn redacted_ranges<T: ToOffset>(
4085 &self,
4086 range: Range<T>,
4087 ) -> impl Iterator<Item = Range<usize>> + '_ {
4088 let offset_range = range.start.to_offset(self)..range.end.to_offset(self);
4089 let mut syntax_matches = self.syntax.matches(offset_range, self, |grammar| {
4090 grammar
4091 .redactions_config
4092 .as_ref()
4093 .map(|config| &config.query)
4094 });
4095
4096 let configs = syntax_matches
4097 .grammars()
4098 .iter()
4099 .map(|grammar| grammar.redactions_config.as_ref())
4100 .collect::<Vec<_>>();
4101
4102 iter::from_fn(move || {
4103 let redacted_range = syntax_matches
4104 .peek()
4105 .and_then(|mat| {
4106 configs[mat.grammar_index].and_then(|config| {
4107 mat.captures
4108 .iter()
4109 .find(|capture| capture.index == config.redaction_capture_ix)
4110 })
4111 })
4112 .map(|mat| mat.node.byte_range());
4113 syntax_matches.advance();
4114 redacted_range
4115 })
4116 }
4117
4118 pub fn injections_intersecting_range<T: ToOffset>(
4119 &self,
4120 range: Range<T>,
4121 ) -> impl Iterator<Item = (Range<usize>, &Arc<Language>)> + '_ {
4122 let offset_range = range.start.to_offset(self)..range.end.to_offset(self);
4123
4124 let mut syntax_matches = self.syntax.matches(offset_range, self, |grammar| {
4125 grammar
4126 .injection_config
4127 .as_ref()
4128 .map(|config| &config.query)
4129 });
4130
4131 let configs = syntax_matches
4132 .grammars()
4133 .iter()
4134 .map(|grammar| grammar.injection_config.as_ref())
4135 .collect::<Vec<_>>();
4136
4137 iter::from_fn(move || {
4138 let ranges = syntax_matches.peek().and_then(|mat| {
4139 let config = &configs[mat.grammar_index]?;
4140 let content_capture_range = mat.captures.iter().find_map(|capture| {
4141 if capture.index == config.content_capture_ix {
4142 Some(capture.node.byte_range())
4143 } else {
4144 None
4145 }
4146 })?;
4147 let language = self.language_at(content_capture_range.start)?;
4148 Some((content_capture_range, language))
4149 });
4150 syntax_matches.advance();
4151 ranges
4152 })
4153 }
4154
4155 pub fn runnable_ranges(
4156 &self,
4157 offset_range: Range<usize>,
4158 ) -> impl Iterator<Item = RunnableRange> + '_ {
4159 let mut syntax_matches = self.syntax.matches(offset_range, self, |grammar| {
4160 grammar.runnable_config.as_ref().map(|config| &config.query)
4161 });
4162
4163 let test_configs = syntax_matches
4164 .grammars()
4165 .iter()
4166 .map(|grammar| grammar.runnable_config.as_ref())
4167 .collect::<Vec<_>>();
4168
4169 iter::from_fn(move || {
4170 loop {
4171 let mat = syntax_matches.peek()?;
4172
4173 let test_range = test_configs[mat.grammar_index].and_then(|test_configs| {
4174 let mut run_range = None;
4175 let full_range = mat.captures.iter().fold(
4176 Range {
4177 start: usize::MAX,
4178 end: 0,
4179 },
4180 |mut acc, next| {
4181 let byte_range = next.node.byte_range();
4182 if acc.start > byte_range.start {
4183 acc.start = byte_range.start;
4184 }
4185 if acc.end < byte_range.end {
4186 acc.end = byte_range.end;
4187 }
4188 acc
4189 },
4190 );
4191 if full_range.start > full_range.end {
4192 // We did not find a full spanning range of this match.
4193 return None;
4194 }
4195 let extra_captures: SmallVec<[_; 1]> =
4196 SmallVec::from_iter(mat.captures.iter().filter_map(|capture| {
4197 test_configs
4198 .extra_captures
4199 .get(capture.index as usize)
4200 .cloned()
4201 .and_then(|tag_name| match tag_name {
4202 RunnableCapture::Named(name) => {
4203 Some((capture.node.byte_range(), name))
4204 }
4205 RunnableCapture::Run => {
4206 let _ = run_range.insert(capture.node.byte_range());
4207 None
4208 }
4209 })
4210 }));
4211 let run_range = run_range?;
4212 let tags = test_configs
4213 .query
4214 .property_settings(mat.pattern_index)
4215 .iter()
4216 .filter_map(|property| {
4217 if *property.key == *"tag" {
4218 property
4219 .value
4220 .as_ref()
4221 .map(|value| RunnableTag(value.to_string().into()))
4222 } else {
4223 None
4224 }
4225 })
4226 .collect();
4227 let extra_captures = extra_captures
4228 .into_iter()
4229 .map(|(range, name)| {
4230 (
4231 name.to_string(),
4232 self.text_for_range(range.clone()).collect::<String>(),
4233 )
4234 })
4235 .collect();
4236 // All tags should have the same range.
4237 Some(RunnableRange {
4238 run_range,
4239 full_range,
4240 runnable: Runnable {
4241 tags,
4242 language: mat.language,
4243 buffer: self.remote_id(),
4244 },
4245 extra_captures,
4246 buffer_id: self.remote_id(),
4247 })
4248 });
4249
4250 syntax_matches.advance();
4251 if test_range.is_some() {
4252 // It's fine for us to short-circuit on .peek()? returning None. We don't want to return None from this iter if we
4253 // had a capture that did not contain a run marker, hence we'll just loop around for the next capture.
4254 return test_range;
4255 }
4256 }
4257 })
4258 }
4259
4260 /// Returns selections for remote peers intersecting the given range.
4261 #[allow(clippy::type_complexity)]
4262 pub fn selections_in_range(
4263 &self,
4264 range: Range<Anchor>,
4265 include_local: bool,
4266 ) -> impl Iterator<
4267 Item = (
4268 ReplicaId,
4269 bool,
4270 CursorShape,
4271 impl Iterator<Item = &Selection<Anchor>> + '_,
4272 ),
4273 > + '_ {
4274 self.remote_selections
4275 .iter()
4276 .filter(move |(replica_id, set)| {
4277 (include_local || **replica_id != self.text.replica_id())
4278 && !set.selections.is_empty()
4279 })
4280 .map(move |(replica_id, set)| {
4281 let start_ix = match set.selections.binary_search_by(|probe| {
4282 probe.end.cmp(&range.start, self).then(Ordering::Greater)
4283 }) {
4284 Ok(ix) | Err(ix) => ix,
4285 };
4286 let end_ix = match set.selections.binary_search_by(|probe| {
4287 probe.start.cmp(&range.end, self).then(Ordering::Less)
4288 }) {
4289 Ok(ix) | Err(ix) => ix,
4290 };
4291
4292 (
4293 *replica_id,
4294 set.line_mode,
4295 set.cursor_shape,
4296 set.selections[start_ix..end_ix].iter(),
4297 )
4298 })
4299 }
4300
4301 /// Returns if the buffer contains any diagnostics.
4302 pub fn has_diagnostics(&self) -> bool {
4303 !self.diagnostics.is_empty()
4304 }
4305
4306 /// Returns all the diagnostics intersecting the given range.
4307 pub fn diagnostics_in_range<'a, T, O>(
4308 &'a self,
4309 search_range: Range<T>,
4310 reversed: bool,
4311 ) -> impl 'a + Iterator<Item = DiagnosticEntry<O>>
4312 where
4313 T: 'a + Clone + ToOffset,
4314 O: 'a + FromAnchor,
4315 {
4316 let mut iterators: Vec<_> = self
4317 .diagnostics
4318 .iter()
4319 .map(|(_, collection)| {
4320 collection
4321 .range::<T, text::Anchor>(search_range.clone(), self, true, reversed)
4322 .peekable()
4323 })
4324 .collect();
4325
4326 std::iter::from_fn(move || {
4327 let (next_ix, _) = iterators
4328 .iter_mut()
4329 .enumerate()
4330 .flat_map(|(ix, iter)| Some((ix, iter.peek()?)))
4331 .min_by(|(_, a), (_, b)| {
4332 let cmp = a
4333 .range
4334 .start
4335 .cmp(&b.range.start, self)
4336 // when range is equal, sort by diagnostic severity
4337 .then(a.diagnostic.severity.cmp(&b.diagnostic.severity))
4338 // and stabilize order with group_id
4339 .then(a.diagnostic.group_id.cmp(&b.diagnostic.group_id));
4340 if reversed { cmp.reverse() } else { cmp }
4341 })?;
4342 iterators[next_ix]
4343 .next()
4344 .map(|DiagnosticEntry { range, diagnostic }| DiagnosticEntry {
4345 diagnostic,
4346 range: FromAnchor::from_anchor(&range.start, self)
4347 ..FromAnchor::from_anchor(&range.end, self),
4348 })
4349 })
4350 }
4351
4352 /// Returns all the diagnostic groups associated with the given
4353 /// language server ID. If no language server ID is provided,
4354 /// all diagnostics groups are returned.
4355 pub fn diagnostic_groups(
4356 &self,
4357 language_server_id: Option<LanguageServerId>,
4358 ) -> Vec<(LanguageServerId, DiagnosticGroup<Anchor>)> {
4359 let mut groups = Vec::new();
4360
4361 if let Some(language_server_id) = language_server_id {
4362 if let Ok(ix) = self
4363 .diagnostics
4364 .binary_search_by_key(&language_server_id, |e| e.0)
4365 {
4366 self.diagnostics[ix]
4367 .1
4368 .groups(language_server_id, &mut groups, self);
4369 }
4370 } else {
4371 for (language_server_id, diagnostics) in self.diagnostics.iter() {
4372 diagnostics.groups(*language_server_id, &mut groups, self);
4373 }
4374 }
4375
4376 groups.sort_by(|(id_a, group_a), (id_b, group_b)| {
4377 let a_start = &group_a.entries[group_a.primary_ix].range.start;
4378 let b_start = &group_b.entries[group_b.primary_ix].range.start;
4379 a_start.cmp(b_start, self).then_with(|| id_a.cmp(id_b))
4380 });
4381
4382 groups
4383 }
4384
4385 /// Returns an iterator over the diagnostics for the given group.
4386 pub fn diagnostic_group<O>(
4387 &self,
4388 group_id: usize,
4389 ) -> impl Iterator<Item = DiagnosticEntry<O>> + '_
4390 where
4391 O: FromAnchor + 'static,
4392 {
4393 self.diagnostics
4394 .iter()
4395 .flat_map(move |(_, set)| set.group(group_id, self))
4396 }
4397
4398 /// An integer version number that accounts for all updates besides
4399 /// the buffer's text itself (which is versioned via a version vector).
4400 pub fn non_text_state_update_count(&self) -> usize {
4401 self.non_text_state_update_count
4402 }
4403
4404 /// An integer version that changes when the buffer's syntax changes.
4405 pub fn syntax_update_count(&self) -> usize {
4406 self.syntax.update_count()
4407 }
4408
4409 /// Returns a snapshot of underlying file.
4410 pub fn file(&self) -> Option<&Arc<dyn File>> {
4411 self.file.as_ref()
4412 }
4413
4414 /// Resolves the file path (relative to the worktree root) associated with the underlying file.
4415 pub fn resolve_file_path(&self, cx: &App, include_root: bool) -> Option<PathBuf> {
4416 if let Some(file) = self.file() {
4417 if file.path().file_name().is_none() || include_root {
4418 Some(file.full_path(cx))
4419 } else {
4420 Some(file.path().to_path_buf())
4421 }
4422 } else {
4423 None
4424 }
4425 }
4426
4427 pub fn words_in_range(&self, query: WordsQuery) -> BTreeMap<String, Range<Anchor>> {
4428 let query_str = query.fuzzy_contents;
4429 if query_str.map_or(false, |query| query.is_empty()) {
4430 return BTreeMap::default();
4431 }
4432
4433 let classifier = CharClassifier::new(self.language.clone().map(|language| LanguageScope {
4434 language,
4435 override_id: None,
4436 }));
4437
4438 let mut query_ix = 0;
4439 let query_chars = query_str.map(|query| query.chars().collect::<Vec<_>>());
4440 let query_len = query_chars.as_ref().map_or(0, |query| query.len());
4441
4442 let mut words = BTreeMap::default();
4443 let mut current_word_start_ix = None;
4444 let mut chunk_ix = query.range.start;
4445 for chunk in self.chunks(query.range, false) {
4446 for (i, c) in chunk.text.char_indices() {
4447 let ix = chunk_ix + i;
4448 if classifier.is_word(c) {
4449 if current_word_start_ix.is_none() {
4450 current_word_start_ix = Some(ix);
4451 }
4452
4453 if let Some(query_chars) = &query_chars {
4454 if query_ix < query_len {
4455 if c.to_lowercase().eq(query_chars[query_ix].to_lowercase()) {
4456 query_ix += 1;
4457 }
4458 }
4459 }
4460 continue;
4461 } else if let Some(word_start) = current_word_start_ix.take() {
4462 if query_ix == query_len {
4463 let word_range = self.anchor_before(word_start)..self.anchor_after(ix);
4464 let mut word_text = self.text_for_range(word_start..ix).peekable();
4465 let first_char = word_text
4466 .peek()
4467 .and_then(|first_chunk| first_chunk.chars().next());
4468 // Skip empty and "words" starting with digits as a heuristic to reduce useless completions
4469 if !query.skip_digits
4470 || first_char.map_or(true, |first_char| !first_char.is_digit(10))
4471 {
4472 words.insert(word_text.collect(), word_range);
4473 }
4474 }
4475 }
4476 query_ix = 0;
4477 }
4478 chunk_ix += chunk.text.len();
4479 }
4480
4481 words
4482 }
4483}
4484
4485pub struct WordsQuery<'a> {
4486 /// Only returns words with all chars from the fuzzy string in them.
4487 pub fuzzy_contents: Option<&'a str>,
4488 /// Skips words that start with a digit.
4489 pub skip_digits: bool,
4490 /// Buffer offset range, to look for words.
4491 pub range: Range<usize>,
4492}
4493
4494fn indent_size_for_line(text: &text::BufferSnapshot, row: u32) -> IndentSize {
4495 indent_size_for_text(text.chars_at(Point::new(row, 0)))
4496}
4497
4498fn indent_size_for_text(text: impl Iterator<Item = char>) -> IndentSize {
4499 let mut result = IndentSize::spaces(0);
4500 for c in text {
4501 let kind = match c {
4502 ' ' => IndentKind::Space,
4503 '\t' => IndentKind::Tab,
4504 _ => break,
4505 };
4506 if result.len == 0 {
4507 result.kind = kind;
4508 }
4509 result.len += 1;
4510 }
4511 result
4512}
4513
4514impl Clone for BufferSnapshot {
4515 fn clone(&self) -> Self {
4516 Self {
4517 text: self.text.clone(),
4518 syntax: self.syntax.clone(),
4519 file: self.file.clone(),
4520 remote_selections: self.remote_selections.clone(),
4521 diagnostics: self.diagnostics.clone(),
4522 language: self.language.clone(),
4523 non_text_state_update_count: self.non_text_state_update_count,
4524 }
4525 }
4526}
4527
4528impl Deref for BufferSnapshot {
4529 type Target = text::BufferSnapshot;
4530
4531 fn deref(&self) -> &Self::Target {
4532 &self.text
4533 }
4534}
4535
4536unsafe impl Send for BufferChunks<'_> {}
4537
4538impl<'a> BufferChunks<'a> {
4539 pub(crate) fn new(
4540 text: &'a Rope,
4541 range: Range<usize>,
4542 syntax: Option<(SyntaxMapCaptures<'a>, Vec<HighlightMap>)>,
4543 diagnostics: bool,
4544 buffer_snapshot: Option<&'a BufferSnapshot>,
4545 ) -> Self {
4546 let mut highlights = None;
4547 if let Some((captures, highlight_maps)) = syntax {
4548 highlights = Some(BufferChunkHighlights {
4549 captures,
4550 next_capture: None,
4551 stack: Default::default(),
4552 highlight_maps,
4553 })
4554 }
4555
4556 let diagnostic_endpoints = diagnostics.then(|| Vec::new().into_iter().peekable());
4557 let chunks = text.chunks_in_range(range.clone());
4558
4559 let mut this = BufferChunks {
4560 range,
4561 buffer_snapshot,
4562 chunks,
4563 diagnostic_endpoints,
4564 error_depth: 0,
4565 warning_depth: 0,
4566 information_depth: 0,
4567 hint_depth: 0,
4568 unnecessary_depth: 0,
4569 underline: true,
4570 highlights,
4571 };
4572 this.initialize_diagnostic_endpoints();
4573 this
4574 }
4575
4576 /// Seeks to the given byte offset in the buffer.
4577 pub fn seek(&mut self, range: Range<usize>) {
4578 let old_range = std::mem::replace(&mut self.range, range.clone());
4579 self.chunks.set_range(self.range.clone());
4580 if let Some(highlights) = self.highlights.as_mut() {
4581 if old_range.start <= self.range.start && old_range.end >= self.range.end {
4582 // Reuse existing highlights stack, as the new range is a subrange of the old one.
4583 highlights
4584 .stack
4585 .retain(|(end_offset, _)| *end_offset > range.start);
4586 if let Some(capture) = &highlights.next_capture {
4587 if range.start >= capture.node.start_byte() {
4588 let next_capture_end = capture.node.end_byte();
4589 if range.start < next_capture_end {
4590 highlights.stack.push((
4591 next_capture_end,
4592 highlights.highlight_maps[capture.grammar_index].get(capture.index),
4593 ));
4594 }
4595 highlights.next_capture.take();
4596 }
4597 }
4598 } else if let Some(snapshot) = self.buffer_snapshot {
4599 let (captures, highlight_maps) = snapshot.get_highlights(self.range.clone());
4600 *highlights = BufferChunkHighlights {
4601 captures,
4602 next_capture: None,
4603 stack: Default::default(),
4604 highlight_maps,
4605 };
4606 } else {
4607 // We cannot obtain new highlights for a language-aware buffer iterator, as we don't have a buffer snapshot.
4608 // Seeking such BufferChunks is not supported.
4609 debug_assert!(
4610 false,
4611 "Attempted to seek on a language-aware buffer iterator without associated buffer snapshot"
4612 );
4613 }
4614
4615 highlights.captures.set_byte_range(self.range.clone());
4616 self.initialize_diagnostic_endpoints();
4617 }
4618 }
4619
4620 fn initialize_diagnostic_endpoints(&mut self) {
4621 if let Some(diagnostics) = self.diagnostic_endpoints.as_mut() {
4622 if let Some(buffer) = self.buffer_snapshot {
4623 let mut diagnostic_endpoints = Vec::new();
4624 for entry in buffer.diagnostics_in_range::<_, usize>(self.range.clone(), false) {
4625 diagnostic_endpoints.push(DiagnosticEndpoint {
4626 offset: entry.range.start,
4627 is_start: true,
4628 severity: entry.diagnostic.severity,
4629 is_unnecessary: entry.diagnostic.is_unnecessary,
4630 underline: entry.diagnostic.underline,
4631 });
4632 diagnostic_endpoints.push(DiagnosticEndpoint {
4633 offset: entry.range.end,
4634 is_start: false,
4635 severity: entry.diagnostic.severity,
4636 is_unnecessary: entry.diagnostic.is_unnecessary,
4637 underline: entry.diagnostic.underline,
4638 });
4639 }
4640 diagnostic_endpoints
4641 .sort_unstable_by_key(|endpoint| (endpoint.offset, !endpoint.is_start));
4642 *diagnostics = diagnostic_endpoints.into_iter().peekable();
4643 self.hint_depth = 0;
4644 self.error_depth = 0;
4645 self.warning_depth = 0;
4646 self.information_depth = 0;
4647 }
4648 }
4649 }
4650
4651 /// The current byte offset in the buffer.
4652 pub fn offset(&self) -> usize {
4653 self.range.start
4654 }
4655
4656 pub fn range(&self) -> Range<usize> {
4657 self.range.clone()
4658 }
4659
4660 fn update_diagnostic_depths(&mut self, endpoint: DiagnosticEndpoint) {
4661 let depth = match endpoint.severity {
4662 DiagnosticSeverity::ERROR => &mut self.error_depth,
4663 DiagnosticSeverity::WARNING => &mut self.warning_depth,
4664 DiagnosticSeverity::INFORMATION => &mut self.information_depth,
4665 DiagnosticSeverity::HINT => &mut self.hint_depth,
4666 _ => return,
4667 };
4668 if endpoint.is_start {
4669 *depth += 1;
4670 } else {
4671 *depth -= 1;
4672 }
4673
4674 if endpoint.is_unnecessary {
4675 if endpoint.is_start {
4676 self.unnecessary_depth += 1;
4677 } else {
4678 self.unnecessary_depth -= 1;
4679 }
4680 }
4681 }
4682
4683 fn current_diagnostic_severity(&self) -> Option<DiagnosticSeverity> {
4684 if self.error_depth > 0 {
4685 Some(DiagnosticSeverity::ERROR)
4686 } else if self.warning_depth > 0 {
4687 Some(DiagnosticSeverity::WARNING)
4688 } else if self.information_depth > 0 {
4689 Some(DiagnosticSeverity::INFORMATION)
4690 } else if self.hint_depth > 0 {
4691 Some(DiagnosticSeverity::HINT)
4692 } else {
4693 None
4694 }
4695 }
4696
4697 fn current_code_is_unnecessary(&self) -> bool {
4698 self.unnecessary_depth > 0
4699 }
4700}
4701
4702impl<'a> Iterator for BufferChunks<'a> {
4703 type Item = Chunk<'a>;
4704
4705 fn next(&mut self) -> Option<Self::Item> {
4706 let mut next_capture_start = usize::MAX;
4707 let mut next_diagnostic_endpoint = usize::MAX;
4708
4709 if let Some(highlights) = self.highlights.as_mut() {
4710 while let Some((parent_capture_end, _)) = highlights.stack.last() {
4711 if *parent_capture_end <= self.range.start {
4712 highlights.stack.pop();
4713 } else {
4714 break;
4715 }
4716 }
4717
4718 if highlights.next_capture.is_none() {
4719 highlights.next_capture = highlights.captures.next();
4720 }
4721
4722 while let Some(capture) = highlights.next_capture.as_ref() {
4723 if self.range.start < capture.node.start_byte() {
4724 next_capture_start = capture.node.start_byte();
4725 break;
4726 } else {
4727 let highlight_id =
4728 highlights.highlight_maps[capture.grammar_index].get(capture.index);
4729 highlights
4730 .stack
4731 .push((capture.node.end_byte(), highlight_id));
4732 highlights.next_capture = highlights.captures.next();
4733 }
4734 }
4735 }
4736
4737 let mut diagnostic_endpoints = std::mem::take(&mut self.diagnostic_endpoints);
4738 if let Some(diagnostic_endpoints) = diagnostic_endpoints.as_mut() {
4739 while let Some(endpoint) = diagnostic_endpoints.peek().copied() {
4740 if endpoint.offset <= self.range.start {
4741 self.update_diagnostic_depths(endpoint);
4742 diagnostic_endpoints.next();
4743 self.underline = endpoint.underline;
4744 } else {
4745 next_diagnostic_endpoint = endpoint.offset;
4746 break;
4747 }
4748 }
4749 }
4750 self.diagnostic_endpoints = diagnostic_endpoints;
4751
4752 if let Some(chunk) = self.chunks.peek() {
4753 let chunk_start = self.range.start;
4754 let mut chunk_end = (self.chunks.offset() + chunk.len())
4755 .min(next_capture_start)
4756 .min(next_diagnostic_endpoint);
4757 let mut highlight_id = None;
4758 if let Some(highlights) = self.highlights.as_ref() {
4759 if let Some((parent_capture_end, parent_highlight_id)) = highlights.stack.last() {
4760 chunk_end = chunk_end.min(*parent_capture_end);
4761 highlight_id = Some(*parent_highlight_id);
4762 }
4763 }
4764
4765 let slice =
4766 &chunk[chunk_start - self.chunks.offset()..chunk_end - self.chunks.offset()];
4767 self.range.start = chunk_end;
4768 if self.range.start == self.chunks.offset() + chunk.len() {
4769 self.chunks.next().unwrap();
4770 }
4771
4772 Some(Chunk {
4773 text: slice,
4774 syntax_highlight_id: highlight_id,
4775 underline: self.underline,
4776 diagnostic_severity: self.current_diagnostic_severity(),
4777 is_unnecessary: self.current_code_is_unnecessary(),
4778 ..Chunk::default()
4779 })
4780 } else {
4781 None
4782 }
4783 }
4784}
4785
4786impl operation_queue::Operation for Operation {
4787 fn lamport_timestamp(&self) -> clock::Lamport {
4788 match self {
4789 Operation::Buffer(_) => {
4790 unreachable!("buffer operations should never be deferred at this layer")
4791 }
4792 Operation::UpdateDiagnostics {
4793 lamport_timestamp, ..
4794 }
4795 | Operation::UpdateSelections {
4796 lamport_timestamp, ..
4797 }
4798 | Operation::UpdateCompletionTriggers {
4799 lamport_timestamp, ..
4800 } => *lamport_timestamp,
4801 }
4802 }
4803}
4804
4805impl Default for Diagnostic {
4806 fn default() -> Self {
4807 Self {
4808 source: Default::default(),
4809 source_kind: DiagnosticSourceKind::Other,
4810 code: None,
4811 code_description: None,
4812 severity: DiagnosticSeverity::ERROR,
4813 message: Default::default(),
4814 markdown: None,
4815 group_id: 0,
4816 is_primary: false,
4817 is_disk_based: false,
4818 is_unnecessary: false,
4819 underline: true,
4820 data: None,
4821 }
4822 }
4823}
4824
4825impl IndentSize {
4826 /// Returns an [`IndentSize`] representing the given spaces.
4827 pub fn spaces(len: u32) -> Self {
4828 Self {
4829 len,
4830 kind: IndentKind::Space,
4831 }
4832 }
4833
4834 /// Returns an [`IndentSize`] representing a tab.
4835 pub fn tab() -> Self {
4836 Self {
4837 len: 1,
4838 kind: IndentKind::Tab,
4839 }
4840 }
4841
4842 /// An iterator over the characters represented by this [`IndentSize`].
4843 pub fn chars(&self) -> impl Iterator<Item = char> {
4844 iter::repeat(self.char()).take(self.len as usize)
4845 }
4846
4847 /// The character representation of this [`IndentSize`].
4848 pub fn char(&self) -> char {
4849 match self.kind {
4850 IndentKind::Space => ' ',
4851 IndentKind::Tab => '\t',
4852 }
4853 }
4854
4855 /// Consumes the current [`IndentSize`] and returns a new one that has
4856 /// been shrunk or enlarged by the given size along the given direction.
4857 pub fn with_delta(mut self, direction: Ordering, size: IndentSize) -> Self {
4858 match direction {
4859 Ordering::Less => {
4860 if self.kind == size.kind && self.len >= size.len {
4861 self.len -= size.len;
4862 }
4863 }
4864 Ordering::Equal => {}
4865 Ordering::Greater => {
4866 if self.len == 0 {
4867 self = size;
4868 } else if self.kind == size.kind {
4869 self.len += size.len;
4870 }
4871 }
4872 }
4873 self
4874 }
4875
4876 pub fn len_with_expanded_tabs(&self, tab_size: NonZeroU32) -> usize {
4877 match self.kind {
4878 IndentKind::Space => self.len as usize,
4879 IndentKind::Tab => self.len as usize * tab_size.get() as usize,
4880 }
4881 }
4882}
4883
4884#[cfg(any(test, feature = "test-support"))]
4885pub struct TestFile {
4886 pub path: Arc<Path>,
4887 pub root_name: String,
4888 pub local_root: Option<PathBuf>,
4889}
4890
4891#[cfg(any(test, feature = "test-support"))]
4892impl File for TestFile {
4893 fn path(&self) -> &Arc<Path> {
4894 &self.path
4895 }
4896
4897 fn full_path(&self, _: &gpui::App) -> PathBuf {
4898 PathBuf::from(&self.root_name).join(self.path.as_ref())
4899 }
4900
4901 fn as_local(&self) -> Option<&dyn LocalFile> {
4902 if self.local_root.is_some() {
4903 Some(self)
4904 } else {
4905 None
4906 }
4907 }
4908
4909 fn disk_state(&self) -> DiskState {
4910 unimplemented!()
4911 }
4912
4913 fn file_name<'a>(&'a self, _: &'a gpui::App) -> &'a std::ffi::OsStr {
4914 self.path().file_name().unwrap_or(self.root_name.as_ref())
4915 }
4916
4917 fn worktree_id(&self, _: &App) -> WorktreeId {
4918 WorktreeId::from_usize(0)
4919 }
4920
4921 fn to_proto(&self, _: &App) -> rpc::proto::File {
4922 unimplemented!()
4923 }
4924
4925 fn is_private(&self) -> bool {
4926 false
4927 }
4928}
4929
4930#[cfg(any(test, feature = "test-support"))]
4931impl LocalFile for TestFile {
4932 fn abs_path(&self, _cx: &App) -> PathBuf {
4933 PathBuf::from(self.local_root.as_ref().unwrap())
4934 .join(&self.root_name)
4935 .join(self.path.as_ref())
4936 }
4937
4938 fn load(&self, _cx: &App) -> Task<Result<String>> {
4939 unimplemented!()
4940 }
4941
4942 fn load_bytes(&self, _cx: &App) -> Task<Result<Vec<u8>>> {
4943 unimplemented!()
4944 }
4945}
4946
4947pub(crate) fn contiguous_ranges(
4948 values: impl Iterator<Item = u32>,
4949 max_len: usize,
4950) -> impl Iterator<Item = Range<u32>> {
4951 let mut values = values;
4952 let mut current_range: Option<Range<u32>> = None;
4953 std::iter::from_fn(move || {
4954 loop {
4955 if let Some(value) = values.next() {
4956 if let Some(range) = &mut current_range {
4957 if value == range.end && range.len() < max_len {
4958 range.end += 1;
4959 continue;
4960 }
4961 }
4962
4963 let prev_range = current_range.clone();
4964 current_range = Some(value..(value + 1));
4965 if prev_range.is_some() {
4966 return prev_range;
4967 }
4968 } else {
4969 return current_range.take();
4970 }
4971 }
4972 })
4973}
4974
4975#[derive(Default, Debug)]
4976pub struct CharClassifier {
4977 scope: Option<LanguageScope>,
4978 for_completion: bool,
4979 ignore_punctuation: bool,
4980}
4981
4982impl CharClassifier {
4983 pub fn new(scope: Option<LanguageScope>) -> Self {
4984 Self {
4985 scope,
4986 for_completion: false,
4987 ignore_punctuation: false,
4988 }
4989 }
4990
4991 pub fn for_completion(self, for_completion: bool) -> Self {
4992 Self {
4993 for_completion,
4994 ..self
4995 }
4996 }
4997
4998 pub fn ignore_punctuation(self, ignore_punctuation: bool) -> Self {
4999 Self {
5000 ignore_punctuation,
5001 ..self
5002 }
5003 }
5004
5005 pub fn is_whitespace(&self, c: char) -> bool {
5006 self.kind(c) == CharKind::Whitespace
5007 }
5008
5009 pub fn is_word(&self, c: char) -> bool {
5010 self.kind(c) == CharKind::Word
5011 }
5012
5013 pub fn is_punctuation(&self, c: char) -> bool {
5014 self.kind(c) == CharKind::Punctuation
5015 }
5016
5017 pub fn kind_with(&self, c: char, ignore_punctuation: bool) -> CharKind {
5018 if c.is_alphanumeric() || c == '_' {
5019 return CharKind::Word;
5020 }
5021
5022 if let Some(scope) = &self.scope {
5023 let characters = if self.for_completion {
5024 scope.completion_query_characters()
5025 } else {
5026 scope.word_characters()
5027 };
5028 if let Some(characters) = characters {
5029 if characters.contains(&c) {
5030 return CharKind::Word;
5031 }
5032 }
5033 }
5034
5035 if c.is_whitespace() {
5036 return CharKind::Whitespace;
5037 }
5038
5039 if ignore_punctuation {
5040 CharKind::Word
5041 } else {
5042 CharKind::Punctuation
5043 }
5044 }
5045
5046 pub fn kind(&self, c: char) -> CharKind {
5047 self.kind_with(c, self.ignore_punctuation)
5048 }
5049}
5050
5051/// Find all of the ranges of whitespace that occur at the ends of lines
5052/// in the given rope.
5053///
5054/// This could also be done with a regex search, but this implementation
5055/// avoids copying text.
5056pub fn trailing_whitespace_ranges(rope: &Rope) -> Vec<Range<usize>> {
5057 let mut ranges = Vec::new();
5058
5059 let mut offset = 0;
5060 let mut prev_chunk_trailing_whitespace_range = 0..0;
5061 for chunk in rope.chunks() {
5062 let mut prev_line_trailing_whitespace_range = 0..0;
5063 for (i, line) in chunk.split('\n').enumerate() {
5064 let line_end_offset = offset + line.len();
5065 let trimmed_line_len = line.trim_end_matches([' ', '\t']).len();
5066 let mut trailing_whitespace_range = (offset + trimmed_line_len)..line_end_offset;
5067
5068 if i == 0 && trimmed_line_len == 0 {
5069 trailing_whitespace_range.start = prev_chunk_trailing_whitespace_range.start;
5070 }
5071 if !prev_line_trailing_whitespace_range.is_empty() {
5072 ranges.push(prev_line_trailing_whitespace_range);
5073 }
5074
5075 offset = line_end_offset + 1;
5076 prev_line_trailing_whitespace_range = trailing_whitespace_range;
5077 }
5078
5079 offset -= 1;
5080 prev_chunk_trailing_whitespace_range = prev_line_trailing_whitespace_range;
5081 }
5082
5083 if !prev_chunk_trailing_whitespace_range.is_empty() {
5084 ranges.push(prev_chunk_trailing_whitespace_range);
5085 }
5086
5087 ranges
5088}