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