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 fn request_autoindent(&mut self, cx: &mut Context<Self>) {
1561 if let Some(indent_sizes) = self.compute_autoindents() {
1562 let indent_sizes = cx.background_spawn(indent_sizes);
1563 match cx
1564 .background_executor()
1565 .block_with_timeout(Duration::from_micros(500), indent_sizes)
1566 {
1567 Ok(indent_sizes) => self.apply_autoindents(indent_sizes, cx),
1568 Err(indent_sizes) => {
1569 self.pending_autoindent = Some(cx.spawn(async move |this, cx| {
1570 let indent_sizes = indent_sizes.await;
1571 this.update(cx, |this, cx| {
1572 this.apply_autoindents(indent_sizes, cx);
1573 })
1574 .ok();
1575 }));
1576 }
1577 }
1578 } else {
1579 self.autoindent_requests.clear();
1580 }
1581 }
1582
1583 fn compute_autoindents(&self) -> Option<impl Future<Output = BTreeMap<u32, IndentSize>>> {
1584 let max_rows_between_yields = 100;
1585 let snapshot = self.snapshot();
1586 if snapshot.syntax.is_empty() || self.autoindent_requests.is_empty() {
1587 return None;
1588 }
1589
1590 let autoindent_requests = self.autoindent_requests.clone();
1591 Some(async move {
1592 let mut indent_sizes = BTreeMap::<u32, (IndentSize, bool)>::new();
1593 for request in autoindent_requests {
1594 // Resolve each edited range to its row in the current buffer and in the
1595 // buffer before this batch of edits.
1596 let mut row_ranges = Vec::new();
1597 let mut old_to_new_rows = BTreeMap::new();
1598 let mut language_indent_sizes_by_new_row = Vec::new();
1599 for entry in &request.entries {
1600 let position = entry.range.start;
1601 let new_row = position.to_point(&snapshot).row;
1602 let new_end_row = entry.range.end.to_point(&snapshot).row + 1;
1603 language_indent_sizes_by_new_row.push((new_row, entry.indent_size));
1604
1605 if !entry.first_line_is_new {
1606 let old_row = position.to_point(&request.before_edit).row;
1607 old_to_new_rows.insert(old_row, new_row);
1608 }
1609 row_ranges.push((new_row..new_end_row, entry.original_indent_column));
1610 }
1611
1612 // Build a map containing the suggested indentation for each of the edited lines
1613 // with respect to the state of the buffer before these edits. This map is keyed
1614 // by the rows for these lines in the current state of the buffer.
1615 let mut old_suggestions = BTreeMap::<u32, (IndentSize, bool)>::default();
1616 let old_edited_ranges =
1617 contiguous_ranges(old_to_new_rows.keys().copied(), max_rows_between_yields);
1618 let mut language_indent_sizes = language_indent_sizes_by_new_row.iter().peekable();
1619 let mut language_indent_size = IndentSize::default();
1620 for old_edited_range in old_edited_ranges {
1621 let suggestions = request
1622 .before_edit
1623 .suggest_autoindents(old_edited_range.clone())
1624 .into_iter()
1625 .flatten();
1626 for (old_row, suggestion) in old_edited_range.zip(suggestions) {
1627 if let Some(suggestion) = suggestion {
1628 let new_row = *old_to_new_rows.get(&old_row).unwrap();
1629
1630 // Find the indent size based on the language for this row.
1631 while let Some((row, size)) = language_indent_sizes.peek() {
1632 if *row > new_row {
1633 break;
1634 }
1635 language_indent_size = *size;
1636 language_indent_sizes.next();
1637 }
1638
1639 let suggested_indent = old_to_new_rows
1640 .get(&suggestion.basis_row)
1641 .and_then(|from_row| {
1642 Some(old_suggestions.get(from_row).copied()?.0)
1643 })
1644 .unwrap_or_else(|| {
1645 request
1646 .before_edit
1647 .indent_size_for_line(suggestion.basis_row)
1648 })
1649 .with_delta(suggestion.delta, language_indent_size);
1650 old_suggestions
1651 .insert(new_row, (suggested_indent, suggestion.within_error));
1652 }
1653 }
1654 yield_now().await;
1655 }
1656
1657 // Compute new suggestions for each line, but only include them in the result
1658 // if they differ from the old suggestion for that line.
1659 let mut language_indent_sizes = language_indent_sizes_by_new_row.iter().peekable();
1660 let mut language_indent_size = IndentSize::default();
1661 for (row_range, original_indent_column) in row_ranges {
1662 let new_edited_row_range = if request.is_block_mode {
1663 row_range.start..row_range.start + 1
1664 } else {
1665 row_range.clone()
1666 };
1667
1668 let suggestions = snapshot
1669 .suggest_autoindents(new_edited_row_range.clone())
1670 .into_iter()
1671 .flatten();
1672 for (new_row, suggestion) in new_edited_row_range.zip(suggestions) {
1673 if let Some(suggestion) = suggestion {
1674 // Find the indent size based on the language for this row.
1675 while let Some((row, size)) = language_indent_sizes.peek() {
1676 if *row > new_row {
1677 break;
1678 }
1679 language_indent_size = *size;
1680 language_indent_sizes.next();
1681 }
1682
1683 let suggested_indent = indent_sizes
1684 .get(&suggestion.basis_row)
1685 .copied()
1686 .map(|e| e.0)
1687 .unwrap_or_else(|| {
1688 snapshot.indent_size_for_line(suggestion.basis_row)
1689 })
1690 .with_delta(suggestion.delta, language_indent_size);
1691
1692 if old_suggestions.get(&new_row).map_or(
1693 true,
1694 |(old_indentation, was_within_error)| {
1695 suggested_indent != *old_indentation
1696 && (!suggestion.within_error || *was_within_error)
1697 },
1698 ) {
1699 indent_sizes.insert(
1700 new_row,
1701 (suggested_indent, request.ignore_empty_lines),
1702 );
1703 }
1704 }
1705 }
1706
1707 if let (true, Some(original_indent_column)) =
1708 (request.is_block_mode, original_indent_column)
1709 {
1710 let new_indent =
1711 if let Some((indent, _)) = indent_sizes.get(&row_range.start) {
1712 *indent
1713 } else {
1714 snapshot.indent_size_for_line(row_range.start)
1715 };
1716 let delta = new_indent.len as i64 - original_indent_column as i64;
1717 if delta != 0 {
1718 for row in row_range.skip(1) {
1719 indent_sizes.entry(row).or_insert_with(|| {
1720 let mut size = snapshot.indent_size_for_line(row);
1721 if size.kind == new_indent.kind {
1722 match delta.cmp(&0) {
1723 Ordering::Greater => size.len += delta as u32,
1724 Ordering::Less => {
1725 size.len = size.len.saturating_sub(-delta as u32)
1726 }
1727 Ordering::Equal => {}
1728 }
1729 }
1730 (size, request.ignore_empty_lines)
1731 });
1732 }
1733 }
1734 }
1735
1736 yield_now().await;
1737 }
1738 }
1739
1740 indent_sizes
1741 .into_iter()
1742 .filter_map(|(row, (indent, ignore_empty_lines))| {
1743 if ignore_empty_lines && snapshot.line_len(row) == 0 {
1744 None
1745 } else {
1746 Some((row, indent))
1747 }
1748 })
1749 .collect()
1750 })
1751 }
1752
1753 fn apply_autoindents(
1754 &mut self,
1755 indent_sizes: BTreeMap<u32, IndentSize>,
1756 cx: &mut Context<Self>,
1757 ) {
1758 self.autoindent_requests.clear();
1759
1760 let edits: Vec<_> = indent_sizes
1761 .into_iter()
1762 .filter_map(|(row, indent_size)| {
1763 let current_size = indent_size_for_line(self, row);
1764 Self::edit_for_indent_size_adjustment(row, current_size, indent_size)
1765 })
1766 .collect();
1767
1768 let preserve_preview = self.preserve_preview();
1769 self.edit(edits, None, cx);
1770 if preserve_preview {
1771 self.refresh_preview();
1772 }
1773 }
1774
1775 /// Create a minimal edit that will cause the given row to be indented
1776 /// with the given size. After applying this edit, the length of the line
1777 /// will always be at least `new_size.len`.
1778 pub fn edit_for_indent_size_adjustment(
1779 row: u32,
1780 current_size: IndentSize,
1781 new_size: IndentSize,
1782 ) -> Option<(Range<Point>, String)> {
1783 if new_size.kind == current_size.kind {
1784 match new_size.len.cmp(¤t_size.len) {
1785 Ordering::Greater => {
1786 let point = Point::new(row, 0);
1787 Some((
1788 point..point,
1789 iter::repeat(new_size.char())
1790 .take((new_size.len - current_size.len) as usize)
1791 .collect::<String>(),
1792 ))
1793 }
1794
1795 Ordering::Less => Some((
1796 Point::new(row, 0)..Point::new(row, current_size.len - new_size.len),
1797 String::new(),
1798 )),
1799
1800 Ordering::Equal => None,
1801 }
1802 } else {
1803 Some((
1804 Point::new(row, 0)..Point::new(row, current_size.len),
1805 iter::repeat(new_size.char())
1806 .take(new_size.len as usize)
1807 .collect::<String>(),
1808 ))
1809 }
1810 }
1811
1812 /// Spawns a background task that asynchronously computes a `Diff` between the buffer's text
1813 /// and the given new text.
1814 pub fn diff(&self, mut new_text: String, cx: &App) -> Task<Diff> {
1815 let old_text = self.as_rope().clone();
1816 let base_version = self.version();
1817 cx.background_executor()
1818 .spawn_labeled(*BUFFER_DIFF_TASK, async move {
1819 let old_text = old_text.to_string();
1820 let line_ending = LineEnding::detect(&new_text);
1821 LineEnding::normalize(&mut new_text);
1822 let edits = text_diff(&old_text, &new_text);
1823 Diff {
1824 base_version,
1825 line_ending,
1826 edits,
1827 }
1828 })
1829 }
1830
1831 /// Spawns a background task that searches the buffer for any whitespace
1832 /// at the ends of a lines, and returns a `Diff` that removes that whitespace.
1833 pub fn remove_trailing_whitespace(&self, cx: &App) -> Task<Diff> {
1834 let old_text = self.as_rope().clone();
1835 let line_ending = self.line_ending();
1836 let base_version = self.version();
1837 cx.background_spawn(async move {
1838 let ranges = trailing_whitespace_ranges(&old_text);
1839 let empty = Arc::<str>::from("");
1840 Diff {
1841 base_version,
1842 line_ending,
1843 edits: ranges
1844 .into_iter()
1845 .map(|range| (range, empty.clone()))
1846 .collect(),
1847 }
1848 })
1849 }
1850
1851 /// Ensures that the buffer ends with a single newline character, and
1852 /// no other whitespace.
1853 pub fn ensure_final_newline(&mut self, cx: &mut Context<Self>) {
1854 let len = self.len();
1855 let mut offset = len;
1856 for chunk in self.as_rope().reversed_chunks_in_range(0..len) {
1857 let non_whitespace_len = chunk
1858 .trim_end_matches(|c: char| c.is_ascii_whitespace())
1859 .len();
1860 offset -= chunk.len();
1861 offset += non_whitespace_len;
1862 if non_whitespace_len != 0 {
1863 if offset == len - 1 && chunk.get(non_whitespace_len..) == Some("\n") {
1864 return;
1865 }
1866 break;
1867 }
1868 }
1869 self.edit([(offset..len, "\n")], None, cx);
1870 }
1871
1872 /// Applies a diff to the buffer. If the buffer has changed since the given diff was
1873 /// calculated, then adjust the diff to account for those changes, and discard any
1874 /// parts of the diff that conflict with those changes.
1875 pub fn apply_diff(&mut self, diff: Diff, cx: &mut Context<Self>) -> Option<TransactionId> {
1876 // Check for any edits to the buffer that have occurred since this diff
1877 // was computed.
1878 let snapshot = self.snapshot();
1879 let mut edits_since = snapshot.edits_since::<usize>(&diff.base_version).peekable();
1880 let mut delta = 0;
1881 let adjusted_edits = diff.edits.into_iter().filter_map(|(range, new_text)| {
1882 while let Some(edit_since) = edits_since.peek() {
1883 // If the edit occurs after a diff hunk, then it does not
1884 // affect that hunk.
1885 if edit_since.old.start > range.end {
1886 break;
1887 }
1888 // If the edit precedes the diff hunk, then adjust the hunk
1889 // to reflect the edit.
1890 else if edit_since.old.end < range.start {
1891 delta += edit_since.new_len() as i64 - edit_since.old_len() as i64;
1892 edits_since.next();
1893 }
1894 // If the edit intersects a diff hunk, then discard that hunk.
1895 else {
1896 return None;
1897 }
1898 }
1899
1900 let start = (range.start as i64 + delta) as usize;
1901 let end = (range.end as i64 + delta) as usize;
1902 Some((start..end, new_text))
1903 });
1904
1905 self.start_transaction();
1906 self.text.set_line_ending(diff.line_ending);
1907 self.edit(adjusted_edits, None, cx);
1908 self.end_transaction(cx)
1909 }
1910
1911 fn has_unsaved_edits(&self) -> bool {
1912 let (last_version, has_unsaved_edits) = self.has_unsaved_edits.take();
1913
1914 if last_version == self.version {
1915 self.has_unsaved_edits
1916 .set((last_version, has_unsaved_edits));
1917 return has_unsaved_edits;
1918 }
1919
1920 let has_edits = self.has_edits_since(&self.saved_version);
1921 self.has_unsaved_edits
1922 .set((self.version.clone(), has_edits));
1923 has_edits
1924 }
1925
1926 /// Checks if the buffer has unsaved changes.
1927 pub fn is_dirty(&self) -> bool {
1928 if self.capability == Capability::ReadOnly {
1929 return false;
1930 }
1931 if self.has_conflict || self.has_unsaved_edits() {
1932 return true;
1933 }
1934 match self.file.as_ref().map(|f| f.disk_state()) {
1935 Some(DiskState::New) => !self.is_empty(),
1936 Some(DiskState::Deleted) => true,
1937 _ => false,
1938 }
1939 }
1940
1941 /// Checks if the buffer and its file have both changed since the buffer
1942 /// was last saved or reloaded.
1943 pub fn has_conflict(&self) -> bool {
1944 if self.has_conflict {
1945 return true;
1946 }
1947 let Some(file) = self.file.as_ref() else {
1948 return false;
1949 };
1950 match file.disk_state() {
1951 DiskState::New => false,
1952 DiskState::Present { mtime } => match self.saved_mtime {
1953 Some(saved_mtime) => {
1954 mtime.bad_is_greater_than(saved_mtime) && self.has_unsaved_edits()
1955 }
1956 None => true,
1957 },
1958 DiskState::Deleted => true,
1959 }
1960 }
1961
1962 /// Gets a [`Subscription`] that tracks all of the changes to the buffer's text.
1963 pub fn subscribe(&mut self) -> Subscription {
1964 self.text.subscribe()
1965 }
1966
1967 /// Adds a bit to the list of bits that are set when the buffer's text changes.
1968 ///
1969 /// This allows downstream code to check if the buffer's text has changed without
1970 /// waiting for an effect cycle, which would be required if using eents.
1971 pub fn record_changes(&mut self, bit: rc::Weak<Cell<bool>>) {
1972 if let Err(ix) = self
1973 .change_bits
1974 .binary_search_by_key(&rc::Weak::as_ptr(&bit), rc::Weak::as_ptr)
1975 {
1976 self.change_bits.insert(ix, bit);
1977 }
1978 }
1979
1980 fn was_changed(&mut self) {
1981 self.change_bits.retain(|change_bit| {
1982 change_bit.upgrade().map_or(false, |bit| {
1983 bit.replace(true);
1984 true
1985 })
1986 });
1987 }
1988
1989 /// Starts a transaction, if one is not already in-progress. When undoing or
1990 /// redoing edits, all of the edits performed within a transaction are undone
1991 /// or redone together.
1992 pub fn start_transaction(&mut self) -> Option<TransactionId> {
1993 self.start_transaction_at(Instant::now())
1994 }
1995
1996 /// Starts a transaction, providing the current time. Subsequent transactions
1997 /// that occur within a short period of time will be grouped together. This
1998 /// is controlled by the buffer's undo grouping duration.
1999 pub fn start_transaction_at(&mut self, now: Instant) -> Option<TransactionId> {
2000 self.transaction_depth += 1;
2001 if self.was_dirty_before_starting_transaction.is_none() {
2002 self.was_dirty_before_starting_transaction = Some(self.is_dirty());
2003 }
2004 self.text.start_transaction_at(now)
2005 }
2006
2007 /// Terminates the current transaction, if this is the outermost transaction.
2008 pub fn end_transaction(&mut self, cx: &mut Context<Self>) -> Option<TransactionId> {
2009 self.end_transaction_at(Instant::now(), cx)
2010 }
2011
2012 /// Terminates the current transaction, providing the current time. Subsequent transactions
2013 /// that occur within a short period of time will be grouped together. This
2014 /// is controlled by the buffer's undo grouping duration.
2015 pub fn end_transaction_at(
2016 &mut self,
2017 now: Instant,
2018 cx: &mut Context<Self>,
2019 ) -> Option<TransactionId> {
2020 assert!(self.transaction_depth > 0);
2021 self.transaction_depth -= 1;
2022 let was_dirty = if self.transaction_depth == 0 {
2023 self.was_dirty_before_starting_transaction.take().unwrap()
2024 } else {
2025 false
2026 };
2027 if let Some((transaction_id, start_version)) = self.text.end_transaction_at(now) {
2028 self.did_edit(&start_version, was_dirty, cx);
2029 Some(transaction_id)
2030 } else {
2031 None
2032 }
2033 }
2034
2035 /// Manually add a transaction to the buffer's undo history.
2036 pub fn push_transaction(&mut self, transaction: Transaction, now: Instant) {
2037 self.text.push_transaction(transaction, now);
2038 }
2039
2040 /// Prevent the last transaction from being grouped with any subsequent transactions,
2041 /// even if they occur with the buffer's undo grouping duration.
2042 pub fn finalize_last_transaction(&mut self) -> Option<&Transaction> {
2043 self.text.finalize_last_transaction()
2044 }
2045
2046 /// Manually group all changes since a given transaction.
2047 pub fn group_until_transaction(&mut self, transaction_id: TransactionId) {
2048 self.text.group_until_transaction(transaction_id);
2049 }
2050
2051 /// Manually remove a transaction from the buffer's undo history
2052 pub fn forget_transaction(&mut self, transaction_id: TransactionId) {
2053 self.text.forget_transaction(transaction_id);
2054 }
2055
2056 /// Manually merge two adjacent transactions in the buffer's undo history.
2057 pub fn merge_transactions(&mut self, transaction: TransactionId, destination: TransactionId) {
2058 self.text.merge_transactions(transaction, destination);
2059 }
2060
2061 /// Waits for the buffer to receive operations with the given timestamps.
2062 pub fn wait_for_edits(
2063 &mut self,
2064 edit_ids: impl IntoIterator<Item = clock::Lamport>,
2065 ) -> impl Future<Output = Result<()>> {
2066 self.text.wait_for_edits(edit_ids)
2067 }
2068
2069 /// Waits for the buffer to receive the operations necessary for resolving the given anchors.
2070 pub fn wait_for_anchors(
2071 &mut self,
2072 anchors: impl IntoIterator<Item = Anchor>,
2073 ) -> impl 'static + Future<Output = Result<()>> {
2074 self.text.wait_for_anchors(anchors)
2075 }
2076
2077 /// Waits for the buffer to receive operations up to the given version.
2078 pub fn wait_for_version(&mut self, version: clock::Global) -> impl Future<Output = Result<()>> {
2079 self.text.wait_for_version(version)
2080 }
2081
2082 /// Forces all futures returned by [`Buffer::wait_for_version`], [`Buffer::wait_for_edits`], or
2083 /// [`Buffer::wait_for_version`] to resolve with an error.
2084 pub fn give_up_waiting(&mut self) {
2085 self.text.give_up_waiting();
2086 }
2087
2088 /// Stores a set of selections that should be broadcasted to all of the buffer's replicas.
2089 pub fn set_active_selections(
2090 &mut self,
2091 selections: Arc<[Selection<Anchor>]>,
2092 line_mode: bool,
2093 cursor_shape: CursorShape,
2094 cx: &mut Context<Self>,
2095 ) {
2096 let lamport_timestamp = self.text.lamport_clock.tick();
2097 self.remote_selections.insert(
2098 self.text.replica_id(),
2099 SelectionSet {
2100 selections: selections.clone(),
2101 lamport_timestamp,
2102 line_mode,
2103 cursor_shape,
2104 },
2105 );
2106 self.send_operation(
2107 Operation::UpdateSelections {
2108 selections,
2109 line_mode,
2110 lamport_timestamp,
2111 cursor_shape,
2112 },
2113 true,
2114 cx,
2115 );
2116 self.non_text_state_update_count += 1;
2117 cx.notify();
2118 }
2119
2120 /// Clears the selections, so that other replicas of the buffer do not see any selections for
2121 /// this replica.
2122 pub fn remove_active_selections(&mut self, cx: &mut Context<Self>) {
2123 if self
2124 .remote_selections
2125 .get(&self.text.replica_id())
2126 .map_or(true, |set| !set.selections.is_empty())
2127 {
2128 self.set_active_selections(Arc::default(), false, Default::default(), cx);
2129 }
2130 }
2131
2132 /// Replaces the buffer's entire text.
2133 pub fn set_text<T>(&mut self, text: T, cx: &mut Context<Self>) -> Option<clock::Lamport>
2134 where
2135 T: Into<Arc<str>>,
2136 {
2137 self.autoindent_requests.clear();
2138 self.edit([(0..self.len(), text)], None, cx)
2139 }
2140
2141 /// Applies the given edits to the buffer. Each edit is specified as a range of text to
2142 /// delete, and a string of text to insert at that location.
2143 ///
2144 /// If an [`AutoindentMode`] is provided, then the buffer will enqueue an auto-indent
2145 /// request for the edited ranges, which will be processed when the buffer finishes
2146 /// parsing.
2147 ///
2148 /// Parsing takes place at the end of a transaction, and may compute synchronously
2149 /// or asynchronously, depending on the changes.
2150 pub fn edit<I, S, T>(
2151 &mut self,
2152 edits_iter: I,
2153 autoindent_mode: Option<AutoindentMode>,
2154 cx: &mut Context<Self>,
2155 ) -> Option<clock::Lamport>
2156 where
2157 I: IntoIterator<Item = (Range<S>, T)>,
2158 S: ToOffset,
2159 T: Into<Arc<str>>,
2160 {
2161 // Skip invalid edits and coalesce contiguous ones.
2162 let mut edits: Vec<(Range<usize>, Arc<str>)> = Vec::new();
2163 for (range, new_text) in edits_iter {
2164 let mut range = range.start.to_offset(self)..range.end.to_offset(self);
2165 if range.start > range.end {
2166 mem::swap(&mut range.start, &mut range.end);
2167 }
2168 let new_text = new_text.into();
2169 if !new_text.is_empty() || !range.is_empty() {
2170 if let Some((prev_range, prev_text)) = edits.last_mut() {
2171 if prev_range.end >= range.start {
2172 prev_range.end = cmp::max(prev_range.end, range.end);
2173 *prev_text = format!("{prev_text}{new_text}").into();
2174 } else {
2175 edits.push((range, new_text));
2176 }
2177 } else {
2178 edits.push((range, new_text));
2179 }
2180 }
2181 }
2182 if edits.is_empty() {
2183 return None;
2184 }
2185
2186 self.start_transaction();
2187 self.pending_autoindent.take();
2188 let autoindent_request = autoindent_mode
2189 .and_then(|mode| self.language.as_ref().map(|_| (self.snapshot(), mode)));
2190
2191 let edit_operation = self.text.edit(edits.iter().cloned());
2192 let edit_id = edit_operation.timestamp();
2193
2194 if let Some((before_edit, mode)) = autoindent_request {
2195 let mut delta = 0isize;
2196 let entries = edits
2197 .into_iter()
2198 .enumerate()
2199 .zip(&edit_operation.as_edit().unwrap().new_text)
2200 .map(|((ix, (range, _)), new_text)| {
2201 let new_text_length = new_text.len();
2202 let old_start = range.start.to_point(&before_edit);
2203 let new_start = (delta + range.start as isize) as usize;
2204 let range_len = range.end - range.start;
2205 delta += new_text_length as isize - range_len as isize;
2206
2207 // Decide what range of the insertion to auto-indent, and whether
2208 // the first line of the insertion should be considered a newly-inserted line
2209 // or an edit to an existing line.
2210 let mut range_of_insertion_to_indent = 0..new_text_length;
2211 let mut first_line_is_new = true;
2212
2213 let old_line_start = before_edit.indent_size_for_line(old_start.row).len;
2214 let old_line_end = before_edit.line_len(old_start.row);
2215
2216 if old_start.column > old_line_start {
2217 first_line_is_new = false;
2218 }
2219
2220 if !new_text.contains('\n')
2221 && (old_start.column + (range_len as u32) < old_line_end
2222 || old_line_end == old_line_start)
2223 {
2224 first_line_is_new = false;
2225 }
2226
2227 // When inserting text starting with a newline, avoid auto-indenting the
2228 // previous line.
2229 if new_text.starts_with('\n') {
2230 range_of_insertion_to_indent.start += 1;
2231 first_line_is_new = true;
2232 }
2233
2234 let mut original_indent_column = None;
2235 if let AutoindentMode::Block {
2236 original_indent_columns,
2237 } = &mode
2238 {
2239 original_indent_column = Some(
2240 original_indent_columns
2241 .get(ix)
2242 .copied()
2243 .flatten()
2244 .unwrap_or_else(|| {
2245 indent_size_for_text(
2246 new_text[range_of_insertion_to_indent.clone()].chars(),
2247 )
2248 .len
2249 }),
2250 );
2251
2252 // Avoid auto-indenting the line after the edit.
2253 if new_text[range_of_insertion_to_indent.clone()].ends_with('\n') {
2254 range_of_insertion_to_indent.end -= 1;
2255 }
2256 }
2257
2258 AutoindentRequestEntry {
2259 first_line_is_new,
2260 original_indent_column,
2261 indent_size: before_edit.language_indent_size_at(range.start, cx),
2262 range: self.anchor_before(new_start + range_of_insertion_to_indent.start)
2263 ..self.anchor_after(new_start + range_of_insertion_to_indent.end),
2264 }
2265 })
2266 .collect();
2267
2268 self.autoindent_requests.push(Arc::new(AutoindentRequest {
2269 before_edit,
2270 entries,
2271 is_block_mode: matches!(mode, AutoindentMode::Block { .. }),
2272 ignore_empty_lines: false,
2273 }));
2274 }
2275
2276 self.end_transaction(cx);
2277 self.send_operation(Operation::Buffer(edit_operation), true, cx);
2278 Some(edit_id)
2279 }
2280
2281 fn did_edit(&mut self, old_version: &clock::Global, was_dirty: bool, cx: &mut Context<Self>) {
2282 self.was_changed();
2283
2284 if self.edits_since::<usize>(old_version).next().is_none() {
2285 return;
2286 }
2287
2288 self.reparse(cx);
2289 cx.emit(BufferEvent::Edited);
2290 if was_dirty != self.is_dirty() {
2291 cx.emit(BufferEvent::DirtyChanged);
2292 }
2293 cx.notify();
2294 }
2295
2296 pub fn autoindent_ranges<I, T>(&mut self, ranges: I, cx: &mut Context<Self>)
2297 where
2298 I: IntoIterator<Item = Range<T>>,
2299 T: ToOffset + Copy,
2300 {
2301 let before_edit = self.snapshot();
2302 let entries = ranges
2303 .into_iter()
2304 .map(|range| AutoindentRequestEntry {
2305 range: before_edit.anchor_before(range.start)..before_edit.anchor_after(range.end),
2306 first_line_is_new: true,
2307 indent_size: before_edit.language_indent_size_at(range.start, cx),
2308 original_indent_column: None,
2309 })
2310 .collect();
2311 self.autoindent_requests.push(Arc::new(AutoindentRequest {
2312 before_edit,
2313 entries,
2314 is_block_mode: false,
2315 ignore_empty_lines: true,
2316 }));
2317 self.request_autoindent(cx);
2318 }
2319
2320 // Inserts newlines at the given position to create an empty line, returning the start of the new line.
2321 // You can also request the insertion of empty lines above and below the line starting at the returned point.
2322 pub fn insert_empty_line(
2323 &mut self,
2324 position: impl ToPoint,
2325 space_above: bool,
2326 space_below: bool,
2327 cx: &mut Context<Self>,
2328 ) -> Point {
2329 let mut position = position.to_point(self);
2330
2331 self.start_transaction();
2332
2333 self.edit(
2334 [(position..position, "\n")],
2335 Some(AutoindentMode::EachLine),
2336 cx,
2337 );
2338
2339 if position.column > 0 {
2340 position += Point::new(1, 0);
2341 }
2342
2343 if !self.is_line_blank(position.row) {
2344 self.edit(
2345 [(position..position, "\n")],
2346 Some(AutoindentMode::EachLine),
2347 cx,
2348 );
2349 }
2350
2351 if space_above && position.row > 0 && !self.is_line_blank(position.row - 1) {
2352 self.edit(
2353 [(position..position, "\n")],
2354 Some(AutoindentMode::EachLine),
2355 cx,
2356 );
2357 position.row += 1;
2358 }
2359
2360 if space_below
2361 && (position.row == self.max_point().row || !self.is_line_blank(position.row + 1))
2362 {
2363 self.edit(
2364 [(position..position, "\n")],
2365 Some(AutoindentMode::EachLine),
2366 cx,
2367 );
2368 }
2369
2370 self.end_transaction(cx);
2371
2372 position
2373 }
2374
2375 /// Applies the given remote operations to the buffer.
2376 pub fn apply_ops<I: IntoIterator<Item = Operation>>(&mut self, ops: I, cx: &mut Context<Self>) {
2377 self.pending_autoindent.take();
2378 let was_dirty = self.is_dirty();
2379 let old_version = self.version.clone();
2380 let mut deferred_ops = Vec::new();
2381 let buffer_ops = ops
2382 .into_iter()
2383 .filter_map(|op| match op {
2384 Operation::Buffer(op) => Some(op),
2385 _ => {
2386 if self.can_apply_op(&op) {
2387 self.apply_op(op, cx);
2388 } else {
2389 deferred_ops.push(op);
2390 }
2391 None
2392 }
2393 })
2394 .collect::<Vec<_>>();
2395 for operation in buffer_ops.iter() {
2396 self.send_operation(Operation::Buffer(operation.clone()), false, cx);
2397 }
2398 self.text.apply_ops(buffer_ops);
2399 self.deferred_ops.insert(deferred_ops);
2400 self.flush_deferred_ops(cx);
2401 self.did_edit(&old_version, was_dirty, cx);
2402 // Notify independently of whether the buffer was edited as the operations could include a
2403 // selection update.
2404 cx.notify();
2405 }
2406
2407 fn flush_deferred_ops(&mut self, cx: &mut Context<Self>) {
2408 let mut deferred_ops = Vec::new();
2409 for op in self.deferred_ops.drain().iter().cloned() {
2410 if self.can_apply_op(&op) {
2411 self.apply_op(op, cx);
2412 } else {
2413 deferred_ops.push(op);
2414 }
2415 }
2416 self.deferred_ops.insert(deferred_ops);
2417 }
2418
2419 pub fn has_deferred_ops(&self) -> bool {
2420 !self.deferred_ops.is_empty() || self.text.has_deferred_ops()
2421 }
2422
2423 fn can_apply_op(&self, operation: &Operation) -> bool {
2424 match operation {
2425 Operation::Buffer(_) => {
2426 unreachable!("buffer operations should never be applied at this layer")
2427 }
2428 Operation::UpdateDiagnostics {
2429 diagnostics: diagnostic_set,
2430 ..
2431 } => diagnostic_set.iter().all(|diagnostic| {
2432 self.text.can_resolve(&diagnostic.range.start)
2433 && self.text.can_resolve(&diagnostic.range.end)
2434 }),
2435 Operation::UpdateSelections { selections, .. } => selections
2436 .iter()
2437 .all(|s| self.can_resolve(&s.start) && self.can_resolve(&s.end)),
2438 Operation::UpdateCompletionTriggers { .. } => true,
2439 }
2440 }
2441
2442 fn apply_op(&mut self, operation: Operation, cx: &mut Context<Self>) {
2443 match operation {
2444 Operation::Buffer(_) => {
2445 unreachable!("buffer operations should never be applied at this layer")
2446 }
2447 Operation::UpdateDiagnostics {
2448 server_id,
2449 diagnostics: diagnostic_set,
2450 lamport_timestamp,
2451 } => {
2452 let snapshot = self.snapshot();
2453 self.apply_diagnostic_update(
2454 server_id,
2455 DiagnosticSet::from_sorted_entries(diagnostic_set.iter().cloned(), &snapshot),
2456 lamport_timestamp,
2457 cx,
2458 );
2459 }
2460 Operation::UpdateSelections {
2461 selections,
2462 lamport_timestamp,
2463 line_mode,
2464 cursor_shape,
2465 } => {
2466 if let Some(set) = self.remote_selections.get(&lamport_timestamp.replica_id) {
2467 if set.lamport_timestamp > lamport_timestamp {
2468 return;
2469 }
2470 }
2471
2472 self.remote_selections.insert(
2473 lamport_timestamp.replica_id,
2474 SelectionSet {
2475 selections,
2476 lamport_timestamp,
2477 line_mode,
2478 cursor_shape,
2479 },
2480 );
2481 self.text.lamport_clock.observe(lamport_timestamp);
2482 self.non_text_state_update_count += 1;
2483 }
2484 Operation::UpdateCompletionTriggers {
2485 triggers,
2486 lamport_timestamp,
2487 server_id,
2488 } => {
2489 if triggers.is_empty() {
2490 self.completion_triggers_per_language_server
2491 .remove(&server_id);
2492 self.completion_triggers = self
2493 .completion_triggers_per_language_server
2494 .values()
2495 .flat_map(|triggers| triggers.into_iter().cloned())
2496 .collect();
2497 } else {
2498 self.completion_triggers_per_language_server
2499 .insert(server_id, triggers.iter().cloned().collect());
2500 self.completion_triggers.extend(triggers);
2501 }
2502 self.text.lamport_clock.observe(lamport_timestamp);
2503 }
2504 }
2505 }
2506
2507 fn apply_diagnostic_update(
2508 &mut self,
2509 server_id: LanguageServerId,
2510 diagnostics: DiagnosticSet,
2511 lamport_timestamp: clock::Lamport,
2512 cx: &mut Context<Self>,
2513 ) {
2514 if lamport_timestamp > self.diagnostics_timestamp {
2515 let ix = self.diagnostics.binary_search_by_key(&server_id, |e| e.0);
2516 if diagnostics.is_empty() {
2517 if let Ok(ix) = ix {
2518 self.diagnostics.remove(ix);
2519 }
2520 } else {
2521 match ix {
2522 Err(ix) => self.diagnostics.insert(ix, (server_id, diagnostics)),
2523 Ok(ix) => self.diagnostics[ix].1 = diagnostics,
2524 };
2525 }
2526 self.diagnostics_timestamp = lamport_timestamp;
2527 self.non_text_state_update_count += 1;
2528 self.text.lamport_clock.observe(lamport_timestamp);
2529 cx.notify();
2530 cx.emit(BufferEvent::DiagnosticsUpdated);
2531 }
2532 }
2533
2534 fn send_operation(&mut self, operation: Operation, is_local: bool, cx: &mut Context<Self>) {
2535 self.was_changed();
2536 cx.emit(BufferEvent::Operation {
2537 operation,
2538 is_local,
2539 });
2540 }
2541
2542 /// Removes the selections for a given peer.
2543 pub fn remove_peer(&mut self, replica_id: ReplicaId, cx: &mut Context<Self>) {
2544 self.remote_selections.remove(&replica_id);
2545 cx.notify();
2546 }
2547
2548 /// Undoes the most recent transaction.
2549 pub fn undo(&mut self, cx: &mut Context<Self>) -> Option<TransactionId> {
2550 let was_dirty = self.is_dirty();
2551 let old_version = self.version.clone();
2552
2553 if let Some((transaction_id, operation)) = self.text.undo() {
2554 self.send_operation(Operation::Buffer(operation), true, cx);
2555 self.did_edit(&old_version, was_dirty, cx);
2556 Some(transaction_id)
2557 } else {
2558 None
2559 }
2560 }
2561
2562 /// Manually undoes a specific transaction in the buffer's undo history.
2563 pub fn undo_transaction(
2564 &mut self,
2565 transaction_id: TransactionId,
2566 cx: &mut Context<Self>,
2567 ) -> bool {
2568 let was_dirty = self.is_dirty();
2569 let old_version = self.version.clone();
2570 if let Some(operation) = self.text.undo_transaction(transaction_id) {
2571 self.send_operation(Operation::Buffer(operation), true, cx);
2572 self.did_edit(&old_version, was_dirty, cx);
2573 true
2574 } else {
2575 false
2576 }
2577 }
2578
2579 /// Manually undoes all changes after a given transaction in the buffer's undo history.
2580 pub fn undo_to_transaction(
2581 &mut self,
2582 transaction_id: TransactionId,
2583 cx: &mut Context<Self>,
2584 ) -> bool {
2585 let was_dirty = self.is_dirty();
2586 let old_version = self.version.clone();
2587
2588 let operations = self.text.undo_to_transaction(transaction_id);
2589 let undone = !operations.is_empty();
2590 for operation in operations {
2591 self.send_operation(Operation::Buffer(operation), true, cx);
2592 }
2593 if undone {
2594 self.did_edit(&old_version, was_dirty, cx)
2595 }
2596 undone
2597 }
2598
2599 pub fn undo_operations(&mut self, counts: HashMap<Lamport, u32>, cx: &mut Context<Buffer>) {
2600 let was_dirty = self.is_dirty();
2601 let operation = self.text.undo_operations(counts);
2602 let old_version = self.version.clone();
2603 self.send_operation(Operation::Buffer(operation), true, cx);
2604 self.did_edit(&old_version, was_dirty, cx);
2605 }
2606
2607 /// Manually redoes a specific transaction in the buffer's redo history.
2608 pub fn redo(&mut self, cx: &mut Context<Self>) -> Option<TransactionId> {
2609 let was_dirty = self.is_dirty();
2610 let old_version = self.version.clone();
2611
2612 if let Some((transaction_id, operation)) = self.text.redo() {
2613 self.send_operation(Operation::Buffer(operation), true, cx);
2614 self.did_edit(&old_version, was_dirty, cx);
2615 Some(transaction_id)
2616 } else {
2617 None
2618 }
2619 }
2620
2621 /// Manually undoes all changes until a given transaction in the buffer's redo history.
2622 pub fn redo_to_transaction(
2623 &mut self,
2624 transaction_id: TransactionId,
2625 cx: &mut Context<Self>,
2626 ) -> bool {
2627 let was_dirty = self.is_dirty();
2628 let old_version = self.version.clone();
2629
2630 let operations = self.text.redo_to_transaction(transaction_id);
2631 let redone = !operations.is_empty();
2632 for operation in operations {
2633 self.send_operation(Operation::Buffer(operation), true, cx);
2634 }
2635 if redone {
2636 self.did_edit(&old_version, was_dirty, cx)
2637 }
2638 redone
2639 }
2640
2641 /// Override current completion triggers with the user-provided completion triggers.
2642 pub fn set_completion_triggers(
2643 &mut self,
2644 server_id: LanguageServerId,
2645 triggers: BTreeSet<String>,
2646 cx: &mut Context<Self>,
2647 ) {
2648 self.completion_triggers_timestamp = self.text.lamport_clock.tick();
2649 if triggers.is_empty() {
2650 self.completion_triggers_per_language_server
2651 .remove(&server_id);
2652 self.completion_triggers = self
2653 .completion_triggers_per_language_server
2654 .values()
2655 .flat_map(|triggers| triggers.into_iter().cloned())
2656 .collect();
2657 } else {
2658 self.completion_triggers_per_language_server
2659 .insert(server_id, triggers.clone());
2660 self.completion_triggers.extend(triggers.iter().cloned());
2661 }
2662 self.send_operation(
2663 Operation::UpdateCompletionTriggers {
2664 triggers: triggers.iter().cloned().collect(),
2665 lamport_timestamp: self.completion_triggers_timestamp,
2666 server_id,
2667 },
2668 true,
2669 cx,
2670 );
2671 cx.notify();
2672 }
2673
2674 /// Returns a list of strings which trigger a completion menu for this language.
2675 /// Usually this is driven by LSP server which returns a list of trigger characters for completions.
2676 pub fn completion_triggers(&self) -> &BTreeSet<String> {
2677 &self.completion_triggers
2678 }
2679
2680 /// Call this directly after performing edits to prevent the preview tab
2681 /// from being dismissed by those edits. It causes `should_dismiss_preview`
2682 /// to return false until there are additional edits.
2683 pub fn refresh_preview(&mut self) {
2684 self.preview_version = self.version.clone();
2685 }
2686
2687 /// Whether we should preserve the preview status of a tab containing this buffer.
2688 pub fn preserve_preview(&self) -> bool {
2689 !self.has_edits_since(&self.preview_version)
2690 }
2691}
2692
2693#[doc(hidden)]
2694#[cfg(any(test, feature = "test-support"))]
2695impl Buffer {
2696 pub fn edit_via_marked_text(
2697 &mut self,
2698 marked_string: &str,
2699 autoindent_mode: Option<AutoindentMode>,
2700 cx: &mut Context<Self>,
2701 ) {
2702 let edits = self.edits_for_marked_text(marked_string);
2703 self.edit(edits, autoindent_mode, cx);
2704 }
2705
2706 pub fn set_group_interval(&mut self, group_interval: Duration) {
2707 self.text.set_group_interval(group_interval);
2708 }
2709
2710 pub fn randomly_edit<T>(&mut self, rng: &mut T, old_range_count: usize, cx: &mut Context<Self>)
2711 where
2712 T: rand::Rng,
2713 {
2714 let mut edits: Vec<(Range<usize>, String)> = Vec::new();
2715 let mut last_end = None;
2716 for _ in 0..old_range_count {
2717 if last_end.map_or(false, |last_end| last_end >= self.len()) {
2718 break;
2719 }
2720
2721 let new_start = last_end.map_or(0, |last_end| last_end + 1);
2722 let mut range = self.random_byte_range(new_start, rng);
2723 if rng.gen_bool(0.2) {
2724 mem::swap(&mut range.start, &mut range.end);
2725 }
2726 last_end = Some(range.end);
2727
2728 let new_text_len = rng.gen_range(0..10);
2729 let mut new_text: String = RandomCharIter::new(&mut *rng).take(new_text_len).collect();
2730 new_text = new_text.to_uppercase();
2731
2732 edits.push((range, new_text));
2733 }
2734 log::info!("mutating buffer {} with {:?}", self.replica_id(), edits);
2735 self.edit(edits, None, cx);
2736 }
2737
2738 pub fn randomly_undo_redo(&mut self, rng: &mut impl rand::Rng, cx: &mut Context<Self>) {
2739 let was_dirty = self.is_dirty();
2740 let old_version = self.version.clone();
2741
2742 let ops = self.text.randomly_undo_redo(rng);
2743 if !ops.is_empty() {
2744 for op in ops {
2745 self.send_operation(Operation::Buffer(op), true, cx);
2746 self.did_edit(&old_version, was_dirty, cx);
2747 }
2748 }
2749 }
2750}
2751
2752impl EventEmitter<BufferEvent> for Buffer {}
2753
2754impl Deref for Buffer {
2755 type Target = TextBuffer;
2756
2757 fn deref(&self) -> &Self::Target {
2758 &self.text
2759 }
2760}
2761
2762impl BufferSnapshot {
2763 /// Returns [`IndentSize`] for a given line that respects user settings and
2764 /// language preferences.
2765 pub fn indent_size_for_line(&self, row: u32) -> IndentSize {
2766 indent_size_for_line(self, row)
2767 }
2768
2769 /// Returns [`IndentSize`] for a given position that respects user settings
2770 /// and language preferences.
2771 pub fn language_indent_size_at<T: ToOffset>(&self, position: T, cx: &App) -> IndentSize {
2772 let settings = language_settings(
2773 self.language_at(position).map(|l| l.name()),
2774 self.file(),
2775 cx,
2776 );
2777 if settings.hard_tabs {
2778 IndentSize::tab()
2779 } else {
2780 IndentSize::spaces(settings.tab_size.get())
2781 }
2782 }
2783
2784 /// Retrieve the suggested indent size for all of the given rows. The unit of indentation
2785 /// is passed in as `single_indent_size`.
2786 pub fn suggested_indents(
2787 &self,
2788 rows: impl Iterator<Item = u32>,
2789 single_indent_size: IndentSize,
2790 ) -> BTreeMap<u32, IndentSize> {
2791 let mut result = BTreeMap::new();
2792
2793 for row_range in contiguous_ranges(rows, 10) {
2794 let suggestions = match self.suggest_autoindents(row_range.clone()) {
2795 Some(suggestions) => suggestions,
2796 _ => break,
2797 };
2798
2799 for (row, suggestion) in row_range.zip(suggestions) {
2800 let indent_size = if let Some(suggestion) = suggestion {
2801 result
2802 .get(&suggestion.basis_row)
2803 .copied()
2804 .unwrap_or_else(|| self.indent_size_for_line(suggestion.basis_row))
2805 .with_delta(suggestion.delta, single_indent_size)
2806 } else {
2807 self.indent_size_for_line(row)
2808 };
2809
2810 result.insert(row, indent_size);
2811 }
2812 }
2813
2814 result
2815 }
2816
2817 fn suggest_autoindents(
2818 &self,
2819 row_range: Range<u32>,
2820 ) -> Option<impl Iterator<Item = Option<IndentSuggestion>> + '_> {
2821 let config = &self.language.as_ref()?.config;
2822 let prev_non_blank_row = self.prev_non_blank_row(row_range.start);
2823
2824 // Find the suggested indentation ranges based on the syntax tree.
2825 let start = Point::new(prev_non_blank_row.unwrap_or(row_range.start), 0);
2826 let end = Point::new(row_range.end, 0);
2827 let range = (start..end).to_offset(&self.text);
2828 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
2829 Some(&grammar.indents_config.as_ref()?.query)
2830 });
2831 let indent_configs = matches
2832 .grammars()
2833 .iter()
2834 .map(|grammar| grammar.indents_config.as_ref().unwrap())
2835 .collect::<Vec<_>>();
2836
2837 let mut indent_ranges = Vec::<Range<Point>>::new();
2838 let mut outdent_positions = Vec::<Point>::new();
2839 while let Some(mat) = matches.peek() {
2840 let mut start: Option<Point> = None;
2841 let mut end: Option<Point> = None;
2842
2843 let config = &indent_configs[mat.grammar_index];
2844 for capture in mat.captures {
2845 if capture.index == config.indent_capture_ix {
2846 start.get_or_insert(Point::from_ts_point(capture.node.start_position()));
2847 end.get_or_insert(Point::from_ts_point(capture.node.end_position()));
2848 } else if Some(capture.index) == config.start_capture_ix {
2849 start = Some(Point::from_ts_point(capture.node.end_position()));
2850 } else if Some(capture.index) == config.end_capture_ix {
2851 end = Some(Point::from_ts_point(capture.node.start_position()));
2852 } else if Some(capture.index) == config.outdent_capture_ix {
2853 outdent_positions.push(Point::from_ts_point(capture.node.start_position()));
2854 }
2855 }
2856
2857 matches.advance();
2858 if let Some((start, end)) = start.zip(end) {
2859 if start.row == end.row {
2860 continue;
2861 }
2862
2863 let range = start..end;
2864 match indent_ranges.binary_search_by_key(&range.start, |r| r.start) {
2865 Err(ix) => indent_ranges.insert(ix, range),
2866 Ok(ix) => {
2867 let prev_range = &mut indent_ranges[ix];
2868 prev_range.end = prev_range.end.max(range.end);
2869 }
2870 }
2871 }
2872 }
2873
2874 let mut error_ranges = Vec::<Range<Point>>::new();
2875 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
2876 grammar.error_query.as_ref()
2877 });
2878 while let Some(mat) = matches.peek() {
2879 let node = mat.captures[0].node;
2880 let start = Point::from_ts_point(node.start_position());
2881 let end = Point::from_ts_point(node.end_position());
2882 let range = start..end;
2883 let ix = match error_ranges.binary_search_by_key(&range.start, |r| r.start) {
2884 Ok(ix) | Err(ix) => ix,
2885 };
2886 let mut end_ix = ix;
2887 while let Some(existing_range) = error_ranges.get(end_ix) {
2888 if existing_range.end < end {
2889 end_ix += 1;
2890 } else {
2891 break;
2892 }
2893 }
2894 error_ranges.splice(ix..end_ix, [range]);
2895 matches.advance();
2896 }
2897
2898 outdent_positions.sort();
2899 for outdent_position in outdent_positions {
2900 // find the innermost indent range containing this outdent_position
2901 // set its end to the outdent position
2902 if let Some(range_to_truncate) = indent_ranges
2903 .iter_mut()
2904 .filter(|indent_range| indent_range.contains(&outdent_position))
2905 .last()
2906 {
2907 range_to_truncate.end = outdent_position;
2908 }
2909 }
2910
2911 // Find the suggested indentation increases and decreased based on regexes.
2912 let mut indent_change_rows = Vec::<(u32, Ordering)>::new();
2913 self.for_each_line(
2914 Point::new(prev_non_blank_row.unwrap_or(row_range.start), 0)
2915 ..Point::new(row_range.end, 0),
2916 |row, line| {
2917 if config
2918 .decrease_indent_pattern
2919 .as_ref()
2920 .map_or(false, |regex| regex.is_match(line))
2921 {
2922 indent_change_rows.push((row, Ordering::Less));
2923 }
2924 if config
2925 .increase_indent_pattern
2926 .as_ref()
2927 .map_or(false, |regex| regex.is_match(line))
2928 {
2929 indent_change_rows.push((row + 1, Ordering::Greater));
2930 }
2931 },
2932 );
2933
2934 let mut indent_changes = indent_change_rows.into_iter().peekable();
2935 let mut prev_row = if config.auto_indent_using_last_non_empty_line {
2936 prev_non_blank_row.unwrap_or(0)
2937 } else {
2938 row_range.start.saturating_sub(1)
2939 };
2940 let mut prev_row_start = Point::new(prev_row, self.indent_size_for_line(prev_row).len);
2941 Some(row_range.map(move |row| {
2942 let row_start = Point::new(row, self.indent_size_for_line(row).len);
2943
2944 let mut indent_from_prev_row = false;
2945 let mut outdent_from_prev_row = false;
2946 let mut outdent_to_row = u32::MAX;
2947 let mut from_regex = false;
2948
2949 while let Some((indent_row, delta)) = indent_changes.peek() {
2950 match indent_row.cmp(&row) {
2951 Ordering::Equal => match delta {
2952 Ordering::Less => {
2953 from_regex = true;
2954 outdent_from_prev_row = true
2955 }
2956 Ordering::Greater => {
2957 indent_from_prev_row = true;
2958 from_regex = true
2959 }
2960 _ => {}
2961 },
2962
2963 Ordering::Greater => break,
2964 Ordering::Less => {}
2965 }
2966
2967 indent_changes.next();
2968 }
2969
2970 for range in &indent_ranges {
2971 if range.start.row >= row {
2972 break;
2973 }
2974 if range.start.row == prev_row && range.end > row_start {
2975 indent_from_prev_row = true;
2976 }
2977 if range.end > prev_row_start && range.end <= row_start {
2978 outdent_to_row = outdent_to_row.min(range.start.row);
2979 }
2980 }
2981
2982 let within_error = error_ranges
2983 .iter()
2984 .any(|e| e.start.row < row && e.end > row_start);
2985
2986 let suggestion = if outdent_to_row == prev_row
2987 || (outdent_from_prev_row && indent_from_prev_row)
2988 {
2989 Some(IndentSuggestion {
2990 basis_row: prev_row,
2991 delta: Ordering::Equal,
2992 within_error: within_error && !from_regex,
2993 })
2994 } else if indent_from_prev_row {
2995 Some(IndentSuggestion {
2996 basis_row: prev_row,
2997 delta: Ordering::Greater,
2998 within_error: within_error && !from_regex,
2999 })
3000 } else if outdent_to_row < prev_row {
3001 Some(IndentSuggestion {
3002 basis_row: outdent_to_row,
3003 delta: Ordering::Equal,
3004 within_error: within_error && !from_regex,
3005 })
3006 } else if outdent_from_prev_row {
3007 Some(IndentSuggestion {
3008 basis_row: prev_row,
3009 delta: Ordering::Less,
3010 within_error: within_error && !from_regex,
3011 })
3012 } else if config.auto_indent_using_last_non_empty_line || !self.is_line_blank(prev_row)
3013 {
3014 Some(IndentSuggestion {
3015 basis_row: prev_row,
3016 delta: Ordering::Equal,
3017 within_error: within_error && !from_regex,
3018 })
3019 } else {
3020 None
3021 };
3022
3023 prev_row = row;
3024 prev_row_start = row_start;
3025 suggestion
3026 }))
3027 }
3028
3029 fn prev_non_blank_row(&self, mut row: u32) -> Option<u32> {
3030 while row > 0 {
3031 row -= 1;
3032 if !self.is_line_blank(row) {
3033 return Some(row);
3034 }
3035 }
3036 None
3037 }
3038
3039 fn get_highlights(&self, range: Range<usize>) -> (SyntaxMapCaptures, Vec<HighlightMap>) {
3040 let captures = self.syntax.captures(range, &self.text, |grammar| {
3041 grammar.highlights_query.as_ref()
3042 });
3043 let highlight_maps = captures
3044 .grammars()
3045 .iter()
3046 .map(|grammar| grammar.highlight_map())
3047 .collect();
3048 (captures, highlight_maps)
3049 }
3050
3051 /// Iterates over chunks of text in the given range of the buffer. Text is chunked
3052 /// in an arbitrary way due to being stored in a [`Rope`](text::Rope). The text is also
3053 /// returned in chunks where each chunk has a single syntax highlighting style and
3054 /// diagnostic status.
3055 pub fn chunks<T: ToOffset>(&self, range: Range<T>, language_aware: bool) -> BufferChunks {
3056 let range = range.start.to_offset(self)..range.end.to_offset(self);
3057
3058 let mut syntax = None;
3059 if language_aware {
3060 syntax = Some(self.get_highlights(range.clone()));
3061 }
3062 // We want to look at diagnostic spans only when iterating over language-annotated chunks.
3063 let diagnostics = language_aware;
3064 BufferChunks::new(self.text.as_rope(), range, syntax, diagnostics, Some(self))
3065 }
3066
3067 pub fn highlighted_text_for_range<T: ToOffset>(
3068 &self,
3069 range: Range<T>,
3070 override_style: Option<HighlightStyle>,
3071 syntax_theme: &SyntaxTheme,
3072 ) -> HighlightedText {
3073 HighlightedText::from_buffer_range(
3074 range,
3075 &self.text,
3076 &self.syntax,
3077 override_style,
3078 syntax_theme,
3079 )
3080 }
3081
3082 /// Invokes the given callback for each line of text in the given range of the buffer.
3083 /// Uses callback to avoid allocating a string for each line.
3084 fn for_each_line(&self, range: Range<Point>, mut callback: impl FnMut(u32, &str)) {
3085 let mut line = String::new();
3086 let mut row = range.start.row;
3087 for chunk in self
3088 .as_rope()
3089 .chunks_in_range(range.to_offset(self))
3090 .chain(["\n"])
3091 {
3092 for (newline_ix, text) in chunk.split('\n').enumerate() {
3093 if newline_ix > 0 {
3094 callback(row, &line);
3095 row += 1;
3096 line.clear();
3097 }
3098 line.push_str(text);
3099 }
3100 }
3101 }
3102
3103 /// Iterates over every [`SyntaxLayer`] in the buffer.
3104 pub fn syntax_layers(&self) -> impl Iterator<Item = SyntaxLayer> + '_ {
3105 self.syntax
3106 .layers_for_range(0..self.len(), &self.text, true)
3107 }
3108
3109 pub fn syntax_layer_at<D: ToOffset>(&self, position: D) -> Option<SyntaxLayer> {
3110 let offset = position.to_offset(self);
3111 self.syntax
3112 .layers_for_range(offset..offset, &self.text, false)
3113 .filter(|l| l.node().end_byte() > offset)
3114 .last()
3115 }
3116
3117 pub fn smallest_syntax_layer_containing<D: ToOffset>(
3118 &self,
3119 range: Range<D>,
3120 ) -> Option<SyntaxLayer> {
3121 let range = range.to_offset(self);
3122 return self
3123 .syntax
3124 .layers_for_range(range, &self.text, false)
3125 .max_by(|a, b| {
3126 if a.depth != b.depth {
3127 a.depth.cmp(&b.depth)
3128 } else if a.offset.0 != b.offset.0 {
3129 a.offset.0.cmp(&b.offset.0)
3130 } else {
3131 a.node().end_byte().cmp(&b.node().end_byte()).reverse()
3132 }
3133 });
3134 }
3135
3136 /// Returns the main [`Language`].
3137 pub fn language(&self) -> Option<&Arc<Language>> {
3138 self.language.as_ref()
3139 }
3140
3141 /// Returns the [`Language`] at the given location.
3142 pub fn language_at<D: ToOffset>(&self, position: D) -> Option<&Arc<Language>> {
3143 self.syntax_layer_at(position)
3144 .map(|info| info.language)
3145 .or(self.language.as_ref())
3146 }
3147
3148 /// Returns the settings for the language at the given location.
3149 pub fn settings_at<'a, D: ToOffset>(
3150 &'a self,
3151 position: D,
3152 cx: &'a App,
3153 ) -> Cow<'a, LanguageSettings> {
3154 language_settings(
3155 self.language_at(position).map(|l| l.name()),
3156 self.file.as_ref(),
3157 cx,
3158 )
3159 }
3160
3161 pub fn char_classifier_at<T: ToOffset>(&self, point: T) -> CharClassifier {
3162 CharClassifier::new(self.language_scope_at(point))
3163 }
3164
3165 /// Returns the [`LanguageScope`] at the given location.
3166 pub fn language_scope_at<D: ToOffset>(&self, position: D) -> Option<LanguageScope> {
3167 let offset = position.to_offset(self);
3168 let mut scope = None;
3169 let mut smallest_range: Option<Range<usize>> = None;
3170
3171 // Use the layer that has the smallest node intersecting the given point.
3172 for layer in self
3173 .syntax
3174 .layers_for_range(offset..offset, &self.text, false)
3175 {
3176 let mut cursor = layer.node().walk();
3177
3178 let mut range = None;
3179 loop {
3180 let child_range = cursor.node().byte_range();
3181 if !child_range.to_inclusive().contains(&offset) {
3182 break;
3183 }
3184
3185 range = Some(child_range);
3186 if cursor.goto_first_child_for_byte(offset).is_none() {
3187 break;
3188 }
3189 }
3190
3191 if let Some(range) = range {
3192 if smallest_range
3193 .as_ref()
3194 .map_or(true, |smallest_range| range.len() < smallest_range.len())
3195 {
3196 smallest_range = Some(range);
3197 scope = Some(LanguageScope {
3198 language: layer.language.clone(),
3199 override_id: layer.override_id(offset, &self.text),
3200 });
3201 }
3202 }
3203 }
3204
3205 scope.or_else(|| {
3206 self.language.clone().map(|language| LanguageScope {
3207 language,
3208 override_id: None,
3209 })
3210 })
3211 }
3212
3213 /// Returns a tuple of the range and character kind of the word
3214 /// surrounding the given position.
3215 pub fn surrounding_word<T: ToOffset>(&self, start: T) -> (Range<usize>, Option<CharKind>) {
3216 let mut start = start.to_offset(self);
3217 let mut end = start;
3218 let mut next_chars = self.chars_at(start).peekable();
3219 let mut prev_chars = self.reversed_chars_at(start).peekable();
3220
3221 let classifier = self.char_classifier_at(start);
3222 let word_kind = cmp::max(
3223 prev_chars.peek().copied().map(|c| classifier.kind(c)),
3224 next_chars.peek().copied().map(|c| classifier.kind(c)),
3225 );
3226
3227 for ch in prev_chars {
3228 if Some(classifier.kind(ch)) == word_kind && ch != '\n' {
3229 start -= ch.len_utf8();
3230 } else {
3231 break;
3232 }
3233 }
3234
3235 for ch in next_chars {
3236 if Some(classifier.kind(ch)) == word_kind && ch != '\n' {
3237 end += ch.len_utf8();
3238 } else {
3239 break;
3240 }
3241 }
3242
3243 (start..end, word_kind)
3244 }
3245
3246 /// Returns the closest syntax node enclosing the given range.
3247 pub fn syntax_ancestor<'a, T: ToOffset>(
3248 &'a self,
3249 range: Range<T>,
3250 ) -> Option<tree_sitter::Node<'a>> {
3251 let range = range.start.to_offset(self)..range.end.to_offset(self);
3252 let mut result: Option<tree_sitter::Node<'a>> = None;
3253 'outer: for layer in self
3254 .syntax
3255 .layers_for_range(range.clone(), &self.text, true)
3256 {
3257 let mut cursor = layer.node().walk();
3258
3259 // Descend to the first leaf that touches the start of the range,
3260 // and if the range is non-empty, extends beyond the start.
3261 while cursor.goto_first_child_for_byte(range.start).is_some() {
3262 if !range.is_empty() && cursor.node().end_byte() == range.start {
3263 cursor.goto_next_sibling();
3264 }
3265 }
3266
3267 // Ascend to the smallest ancestor that strictly contains the range.
3268 loop {
3269 let node_range = cursor.node().byte_range();
3270 if node_range.start <= range.start
3271 && node_range.end >= range.end
3272 && node_range.len() > range.len()
3273 {
3274 break;
3275 }
3276 if !cursor.goto_parent() {
3277 continue 'outer;
3278 }
3279 }
3280
3281 let left_node = cursor.node();
3282 let mut layer_result = left_node;
3283
3284 // For an empty range, try to find another node immediately to the right of the range.
3285 if left_node.end_byte() == range.start {
3286 let mut right_node = None;
3287 while !cursor.goto_next_sibling() {
3288 if !cursor.goto_parent() {
3289 break;
3290 }
3291 }
3292
3293 while cursor.node().start_byte() == range.start {
3294 right_node = Some(cursor.node());
3295 if !cursor.goto_first_child() {
3296 break;
3297 }
3298 }
3299
3300 // If there is a candidate node on both sides of the (empty) range, then
3301 // decide between the two by favoring a named node over an anonymous token.
3302 // If both nodes are the same in that regard, favor the right one.
3303 if let Some(right_node) = right_node {
3304 if right_node.is_named() || !left_node.is_named() {
3305 layer_result = right_node;
3306 }
3307 }
3308 }
3309
3310 if let Some(previous_result) = &result {
3311 if previous_result.byte_range().len() < layer_result.byte_range().len() {
3312 continue;
3313 }
3314 }
3315 result = Some(layer_result);
3316 }
3317
3318 result
3319 }
3320
3321 /// Returns the outline for the buffer.
3322 ///
3323 /// This method allows passing an optional [`SyntaxTheme`] to
3324 /// syntax-highlight the returned symbols.
3325 pub fn outline(&self, theme: Option<&SyntaxTheme>) -> Option<Outline<Anchor>> {
3326 self.outline_items_containing(0..self.len(), true, theme)
3327 .map(Outline::new)
3328 }
3329
3330 /// Returns all the symbols that contain the given position.
3331 ///
3332 /// This method allows passing an optional [`SyntaxTheme`] to
3333 /// syntax-highlight the returned symbols.
3334 pub fn symbols_containing<T: ToOffset>(
3335 &self,
3336 position: T,
3337 theme: Option<&SyntaxTheme>,
3338 ) -> Option<Vec<OutlineItem<Anchor>>> {
3339 let position = position.to_offset(self);
3340 let mut items = self.outline_items_containing(
3341 position.saturating_sub(1)..self.len().min(position + 1),
3342 false,
3343 theme,
3344 )?;
3345 let mut prev_depth = None;
3346 items.retain(|item| {
3347 let result = prev_depth.map_or(true, |prev_depth| item.depth > prev_depth);
3348 prev_depth = Some(item.depth);
3349 result
3350 });
3351 Some(items)
3352 }
3353
3354 pub fn outline_range_containing<T: ToOffset>(&self, range: Range<T>) -> Option<Range<Point>> {
3355 let range = range.to_offset(self);
3356 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
3357 grammar.outline_config.as_ref().map(|c| &c.query)
3358 });
3359 let configs = matches
3360 .grammars()
3361 .iter()
3362 .map(|g| g.outline_config.as_ref().unwrap())
3363 .collect::<Vec<_>>();
3364
3365 while let Some(mat) = matches.peek() {
3366 let config = &configs[mat.grammar_index];
3367 let containing_item_node = maybe!({
3368 let item_node = mat.captures.iter().find_map(|cap| {
3369 if cap.index == config.item_capture_ix {
3370 Some(cap.node)
3371 } else {
3372 None
3373 }
3374 })?;
3375
3376 let item_byte_range = item_node.byte_range();
3377 if item_byte_range.end < range.start || item_byte_range.start > range.end {
3378 None
3379 } else {
3380 Some(item_node)
3381 }
3382 });
3383
3384 if let Some(item_node) = containing_item_node {
3385 return Some(
3386 Point::from_ts_point(item_node.start_position())
3387 ..Point::from_ts_point(item_node.end_position()),
3388 );
3389 }
3390
3391 matches.advance();
3392 }
3393 None
3394 }
3395
3396 pub fn outline_items_containing<T: ToOffset>(
3397 &self,
3398 range: Range<T>,
3399 include_extra_context: bool,
3400 theme: Option<&SyntaxTheme>,
3401 ) -> Option<Vec<OutlineItem<Anchor>>> {
3402 let range = range.to_offset(self);
3403 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
3404 grammar.outline_config.as_ref().map(|c| &c.query)
3405 });
3406 let configs = matches
3407 .grammars()
3408 .iter()
3409 .map(|g| g.outline_config.as_ref().unwrap())
3410 .collect::<Vec<_>>();
3411
3412 let mut items = Vec::new();
3413 let mut annotation_row_ranges: Vec<Range<u32>> = Vec::new();
3414 while let Some(mat) = matches.peek() {
3415 let config = &configs[mat.grammar_index];
3416 if let Some(item) =
3417 self.next_outline_item(config, &mat, &range, include_extra_context, theme)
3418 {
3419 items.push(item);
3420 } else if let Some(capture) = mat
3421 .captures
3422 .iter()
3423 .find(|capture| Some(capture.index) == config.annotation_capture_ix)
3424 {
3425 let capture_range = capture.node.start_position()..capture.node.end_position();
3426 let mut capture_row_range =
3427 capture_range.start.row as u32..capture_range.end.row as u32;
3428 if capture_range.end.row > capture_range.start.row && capture_range.end.column == 0
3429 {
3430 capture_row_range.end -= 1;
3431 }
3432 if let Some(last_row_range) = annotation_row_ranges.last_mut() {
3433 if last_row_range.end >= capture_row_range.start.saturating_sub(1) {
3434 last_row_range.end = capture_row_range.end;
3435 } else {
3436 annotation_row_ranges.push(capture_row_range);
3437 }
3438 } else {
3439 annotation_row_ranges.push(capture_row_range);
3440 }
3441 }
3442 matches.advance();
3443 }
3444
3445 items.sort_by_key(|item| (item.range.start, Reverse(item.range.end)));
3446
3447 // Assign depths based on containment relationships and convert to anchors.
3448 let mut item_ends_stack = Vec::<Point>::new();
3449 let mut anchor_items = Vec::new();
3450 let mut annotation_row_ranges = annotation_row_ranges.into_iter().peekable();
3451 for item in items {
3452 while let Some(last_end) = item_ends_stack.last().copied() {
3453 if last_end < item.range.end {
3454 item_ends_stack.pop();
3455 } else {
3456 break;
3457 }
3458 }
3459
3460 let mut annotation_row_range = None;
3461 while let Some(next_annotation_row_range) = annotation_row_ranges.peek() {
3462 let row_preceding_item = item.range.start.row.saturating_sub(1);
3463 if next_annotation_row_range.end < row_preceding_item {
3464 annotation_row_ranges.next();
3465 } else {
3466 if next_annotation_row_range.end == row_preceding_item {
3467 annotation_row_range = Some(next_annotation_row_range.clone());
3468 annotation_row_ranges.next();
3469 }
3470 break;
3471 }
3472 }
3473
3474 anchor_items.push(OutlineItem {
3475 depth: item_ends_stack.len(),
3476 range: self.anchor_after(item.range.start)..self.anchor_before(item.range.end),
3477 text: item.text,
3478 highlight_ranges: item.highlight_ranges,
3479 name_ranges: item.name_ranges,
3480 body_range: item.body_range.map(|body_range| {
3481 self.anchor_after(body_range.start)..self.anchor_before(body_range.end)
3482 }),
3483 annotation_range: annotation_row_range.map(|annotation_range| {
3484 self.anchor_after(Point::new(annotation_range.start, 0))
3485 ..self.anchor_before(Point::new(
3486 annotation_range.end,
3487 self.line_len(annotation_range.end),
3488 ))
3489 }),
3490 });
3491 item_ends_stack.push(item.range.end);
3492 }
3493
3494 Some(anchor_items)
3495 }
3496
3497 fn next_outline_item(
3498 &self,
3499 config: &OutlineConfig,
3500 mat: &SyntaxMapMatch,
3501 range: &Range<usize>,
3502 include_extra_context: bool,
3503 theme: Option<&SyntaxTheme>,
3504 ) -> Option<OutlineItem<Point>> {
3505 let item_node = mat.captures.iter().find_map(|cap| {
3506 if cap.index == config.item_capture_ix {
3507 Some(cap.node)
3508 } else {
3509 None
3510 }
3511 })?;
3512
3513 let item_byte_range = item_node.byte_range();
3514 if item_byte_range.end < range.start || item_byte_range.start > range.end {
3515 return None;
3516 }
3517 let item_point_range = Point::from_ts_point(item_node.start_position())
3518 ..Point::from_ts_point(item_node.end_position());
3519
3520 let mut open_point = None;
3521 let mut close_point = None;
3522 let mut buffer_ranges = Vec::new();
3523 for capture in mat.captures {
3524 let node_is_name;
3525 if capture.index == config.name_capture_ix {
3526 node_is_name = true;
3527 } else if Some(capture.index) == config.context_capture_ix
3528 || (Some(capture.index) == config.extra_context_capture_ix && include_extra_context)
3529 {
3530 node_is_name = false;
3531 } else {
3532 if Some(capture.index) == config.open_capture_ix {
3533 open_point = Some(Point::from_ts_point(capture.node.end_position()));
3534 } else if Some(capture.index) == config.close_capture_ix {
3535 close_point = Some(Point::from_ts_point(capture.node.start_position()));
3536 }
3537
3538 continue;
3539 }
3540
3541 let mut range = capture.node.start_byte()..capture.node.end_byte();
3542 let start = capture.node.start_position();
3543 if capture.node.end_position().row > start.row {
3544 range.end = range.start + self.line_len(start.row as u32) as usize - start.column;
3545 }
3546
3547 if !range.is_empty() {
3548 buffer_ranges.push((range, node_is_name));
3549 }
3550 }
3551 if buffer_ranges.is_empty() {
3552 return None;
3553 }
3554 let mut text = String::new();
3555 let mut highlight_ranges = Vec::new();
3556 let mut name_ranges = Vec::new();
3557 let mut chunks = self.chunks(
3558 buffer_ranges.first().unwrap().0.start..buffer_ranges.last().unwrap().0.end,
3559 true,
3560 );
3561 let mut last_buffer_range_end = 0;
3562
3563 for (buffer_range, is_name) in buffer_ranges {
3564 let space_added = !text.is_empty() && buffer_range.start > last_buffer_range_end;
3565 if space_added {
3566 text.push(' ');
3567 }
3568 let before_append_len = text.len();
3569 let mut offset = buffer_range.start;
3570 chunks.seek(buffer_range.clone());
3571 for mut chunk in chunks.by_ref() {
3572 if chunk.text.len() > buffer_range.end - offset {
3573 chunk.text = &chunk.text[0..(buffer_range.end - offset)];
3574 offset = buffer_range.end;
3575 } else {
3576 offset += chunk.text.len();
3577 }
3578 let style = chunk
3579 .syntax_highlight_id
3580 .zip(theme)
3581 .and_then(|(highlight, theme)| highlight.style(theme));
3582 if let Some(style) = style {
3583 let start = text.len();
3584 let end = start + chunk.text.len();
3585 highlight_ranges.push((start..end, style));
3586 }
3587 text.push_str(chunk.text);
3588 if offset >= buffer_range.end {
3589 break;
3590 }
3591 }
3592 if is_name {
3593 let after_append_len = text.len();
3594 let start = if space_added && !name_ranges.is_empty() {
3595 before_append_len - 1
3596 } else {
3597 before_append_len
3598 };
3599 name_ranges.push(start..after_append_len);
3600 }
3601 last_buffer_range_end = buffer_range.end;
3602 }
3603
3604 Some(OutlineItem {
3605 depth: 0, // We'll calculate the depth later
3606 range: item_point_range,
3607 text,
3608 highlight_ranges,
3609 name_ranges,
3610 body_range: open_point.zip(close_point).map(|(start, end)| start..end),
3611 annotation_range: None,
3612 })
3613 }
3614
3615 pub fn function_body_fold_ranges<T: ToOffset>(
3616 &self,
3617 within: Range<T>,
3618 ) -> impl Iterator<Item = Range<usize>> + '_ {
3619 self.text_object_ranges(within, TreeSitterOptions::default())
3620 .filter_map(|(range, obj)| (obj == TextObject::InsideFunction).then_some(range))
3621 }
3622
3623 /// For each grammar in the language, runs the provided
3624 /// [`tree_sitter::Query`] against the given range.
3625 pub fn matches(
3626 &self,
3627 range: Range<usize>,
3628 query: fn(&Grammar) -> Option<&tree_sitter::Query>,
3629 ) -> SyntaxMapMatches {
3630 self.syntax.matches(range, self, query)
3631 }
3632
3633 pub fn all_bracket_ranges(
3634 &self,
3635 range: Range<usize>,
3636 ) -> impl Iterator<Item = BracketMatch> + '_ {
3637 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
3638 grammar.brackets_config.as_ref().map(|c| &c.query)
3639 });
3640 let configs = matches
3641 .grammars()
3642 .iter()
3643 .map(|grammar| grammar.brackets_config.as_ref().unwrap())
3644 .collect::<Vec<_>>();
3645
3646 iter::from_fn(move || {
3647 while let Some(mat) = matches.peek() {
3648 let mut open = None;
3649 let mut close = None;
3650 let config = &configs[mat.grammar_index];
3651 let pattern = &config.patterns[mat.pattern_index];
3652 for capture in mat.captures {
3653 if capture.index == config.open_capture_ix {
3654 open = Some(capture.node.byte_range());
3655 } else if capture.index == config.close_capture_ix {
3656 close = Some(capture.node.byte_range());
3657 }
3658 }
3659
3660 matches.advance();
3661
3662 let Some((open_range, close_range)) = open.zip(close) else {
3663 continue;
3664 };
3665
3666 let bracket_range = open_range.start..=close_range.end;
3667 if !bracket_range.overlaps(&range) {
3668 continue;
3669 }
3670
3671 return Some(BracketMatch {
3672 open_range,
3673 close_range,
3674 newline_only: pattern.newline_only,
3675 });
3676 }
3677 None
3678 })
3679 }
3680
3681 /// Returns bracket range pairs overlapping or adjacent to `range`
3682 pub fn bracket_ranges<T: ToOffset>(
3683 &self,
3684 range: Range<T>,
3685 ) -> impl Iterator<Item = BracketMatch> + '_ {
3686 // Find bracket pairs that *inclusively* contain the given range.
3687 let range = range.start.to_offset(self).saturating_sub(1)
3688 ..self.len().min(range.end.to_offset(self) + 1);
3689 self.all_bracket_ranges(range)
3690 .filter(|pair| !pair.newline_only)
3691 }
3692
3693 pub fn text_object_ranges<T: ToOffset>(
3694 &self,
3695 range: Range<T>,
3696 options: TreeSitterOptions,
3697 ) -> impl Iterator<Item = (Range<usize>, TextObject)> + '_ {
3698 let range = range.start.to_offset(self).saturating_sub(1)
3699 ..self.len().min(range.end.to_offset(self) + 1);
3700
3701 let mut matches =
3702 self.syntax
3703 .matches_with_options(range.clone(), &self.text, options, |grammar| {
3704 grammar.text_object_config.as_ref().map(|c| &c.query)
3705 });
3706
3707 let configs = matches
3708 .grammars()
3709 .iter()
3710 .map(|grammar| grammar.text_object_config.as_ref())
3711 .collect::<Vec<_>>();
3712
3713 let mut captures = Vec::<(Range<usize>, TextObject)>::new();
3714
3715 iter::from_fn(move || loop {
3716 while let Some(capture) = captures.pop() {
3717 if capture.0.overlaps(&range) {
3718 return Some(capture);
3719 }
3720 }
3721
3722 let mat = matches.peek()?;
3723
3724 let Some(config) = configs[mat.grammar_index].as_ref() else {
3725 matches.advance();
3726 continue;
3727 };
3728
3729 for capture in mat.captures {
3730 let Some(ix) = config
3731 .text_objects_by_capture_ix
3732 .binary_search_by_key(&capture.index, |e| e.0)
3733 .ok()
3734 else {
3735 continue;
3736 };
3737 let text_object = config.text_objects_by_capture_ix[ix].1;
3738 let byte_range = capture.node.byte_range();
3739
3740 let mut found = false;
3741 for (range, existing) in captures.iter_mut() {
3742 if existing == &text_object {
3743 range.start = range.start.min(byte_range.start);
3744 range.end = range.end.max(byte_range.end);
3745 found = true;
3746 break;
3747 }
3748 }
3749
3750 if !found {
3751 captures.push((byte_range, text_object));
3752 }
3753 }
3754
3755 matches.advance();
3756 })
3757 }
3758
3759 /// Returns enclosing bracket ranges containing the given range
3760 pub fn enclosing_bracket_ranges<T: ToOffset>(
3761 &self,
3762 range: Range<T>,
3763 ) -> impl Iterator<Item = BracketMatch> + '_ {
3764 let range = range.start.to_offset(self)..range.end.to_offset(self);
3765
3766 self.bracket_ranges(range.clone()).filter(move |pair| {
3767 pair.open_range.start <= range.start && pair.close_range.end >= range.end
3768 })
3769 }
3770
3771 /// Returns the smallest enclosing bracket ranges containing the given range or None if no brackets contain range
3772 ///
3773 /// Can optionally pass a range_filter to filter the ranges of brackets to consider
3774 pub fn innermost_enclosing_bracket_ranges<T: ToOffset>(
3775 &self,
3776 range: Range<T>,
3777 range_filter: Option<&dyn Fn(Range<usize>, Range<usize>) -> bool>,
3778 ) -> Option<(Range<usize>, Range<usize>)> {
3779 let range = range.start.to_offset(self)..range.end.to_offset(self);
3780
3781 // Get the ranges of the innermost pair of brackets.
3782 let mut result: Option<(Range<usize>, Range<usize>)> = None;
3783
3784 for pair in self.enclosing_bracket_ranges(range.clone()) {
3785 if let Some(range_filter) = range_filter {
3786 if !range_filter(pair.open_range.clone(), pair.close_range.clone()) {
3787 continue;
3788 }
3789 }
3790
3791 let len = pair.close_range.end - pair.open_range.start;
3792
3793 if let Some((existing_open, existing_close)) = &result {
3794 let existing_len = existing_close.end - existing_open.start;
3795 if len > existing_len {
3796 continue;
3797 }
3798 }
3799
3800 result = Some((pair.open_range, pair.close_range));
3801 }
3802
3803 result
3804 }
3805
3806 /// Returns anchor ranges for any matches of the redaction query.
3807 /// The buffer can be associated with multiple languages, and the redaction query associated with each
3808 /// will be run on the relevant section of the buffer.
3809 pub fn redacted_ranges<T: ToOffset>(
3810 &self,
3811 range: Range<T>,
3812 ) -> impl Iterator<Item = Range<usize>> + '_ {
3813 let offset_range = range.start.to_offset(self)..range.end.to_offset(self);
3814 let mut syntax_matches = self.syntax.matches(offset_range, self, |grammar| {
3815 grammar
3816 .redactions_config
3817 .as_ref()
3818 .map(|config| &config.query)
3819 });
3820
3821 let configs = syntax_matches
3822 .grammars()
3823 .iter()
3824 .map(|grammar| grammar.redactions_config.as_ref())
3825 .collect::<Vec<_>>();
3826
3827 iter::from_fn(move || {
3828 let redacted_range = syntax_matches
3829 .peek()
3830 .and_then(|mat| {
3831 configs[mat.grammar_index].and_then(|config| {
3832 mat.captures
3833 .iter()
3834 .find(|capture| capture.index == config.redaction_capture_ix)
3835 })
3836 })
3837 .map(|mat| mat.node.byte_range());
3838 syntax_matches.advance();
3839 redacted_range
3840 })
3841 }
3842
3843 pub fn injections_intersecting_range<T: ToOffset>(
3844 &self,
3845 range: Range<T>,
3846 ) -> impl Iterator<Item = (Range<usize>, &Arc<Language>)> + '_ {
3847 let offset_range = range.start.to_offset(self)..range.end.to_offset(self);
3848
3849 let mut syntax_matches = self.syntax.matches(offset_range, self, |grammar| {
3850 grammar
3851 .injection_config
3852 .as_ref()
3853 .map(|config| &config.query)
3854 });
3855
3856 let configs = syntax_matches
3857 .grammars()
3858 .iter()
3859 .map(|grammar| grammar.injection_config.as_ref())
3860 .collect::<Vec<_>>();
3861
3862 iter::from_fn(move || {
3863 let ranges = syntax_matches.peek().and_then(|mat| {
3864 let config = &configs[mat.grammar_index]?;
3865 let content_capture_range = mat.captures.iter().find_map(|capture| {
3866 if capture.index == config.content_capture_ix {
3867 Some(capture.node.byte_range())
3868 } else {
3869 None
3870 }
3871 })?;
3872 let language = self.language_at(content_capture_range.start)?;
3873 Some((content_capture_range, language))
3874 });
3875 syntax_matches.advance();
3876 ranges
3877 })
3878 }
3879
3880 pub fn runnable_ranges(
3881 &self,
3882 offset_range: Range<usize>,
3883 ) -> impl Iterator<Item = RunnableRange> + '_ {
3884 let mut syntax_matches = self.syntax.matches(offset_range, self, |grammar| {
3885 grammar.runnable_config.as_ref().map(|config| &config.query)
3886 });
3887
3888 let test_configs = syntax_matches
3889 .grammars()
3890 .iter()
3891 .map(|grammar| grammar.runnable_config.as_ref())
3892 .collect::<Vec<_>>();
3893
3894 iter::from_fn(move || loop {
3895 let mat = syntax_matches.peek()?;
3896
3897 let test_range = test_configs[mat.grammar_index].and_then(|test_configs| {
3898 let mut run_range = None;
3899 let full_range = mat.captures.iter().fold(
3900 Range {
3901 start: usize::MAX,
3902 end: 0,
3903 },
3904 |mut acc, next| {
3905 let byte_range = next.node.byte_range();
3906 if acc.start > byte_range.start {
3907 acc.start = byte_range.start;
3908 }
3909 if acc.end < byte_range.end {
3910 acc.end = byte_range.end;
3911 }
3912 acc
3913 },
3914 );
3915 if full_range.start > full_range.end {
3916 // We did not find a full spanning range of this match.
3917 return None;
3918 }
3919 let extra_captures: SmallVec<[_; 1]> =
3920 SmallVec::from_iter(mat.captures.iter().filter_map(|capture| {
3921 test_configs
3922 .extra_captures
3923 .get(capture.index as usize)
3924 .cloned()
3925 .and_then(|tag_name| match tag_name {
3926 RunnableCapture::Named(name) => {
3927 Some((capture.node.byte_range(), name))
3928 }
3929 RunnableCapture::Run => {
3930 let _ = run_range.insert(capture.node.byte_range());
3931 None
3932 }
3933 })
3934 }));
3935 let run_range = run_range?;
3936 let tags = test_configs
3937 .query
3938 .property_settings(mat.pattern_index)
3939 .iter()
3940 .filter_map(|property| {
3941 if *property.key == *"tag" {
3942 property
3943 .value
3944 .as_ref()
3945 .map(|value| RunnableTag(value.to_string().into()))
3946 } else {
3947 None
3948 }
3949 })
3950 .collect();
3951 let extra_captures = extra_captures
3952 .into_iter()
3953 .map(|(range, name)| {
3954 (
3955 name.to_string(),
3956 self.text_for_range(range.clone()).collect::<String>(),
3957 )
3958 })
3959 .collect();
3960 // All tags should have the same range.
3961 Some(RunnableRange {
3962 run_range,
3963 full_range,
3964 runnable: Runnable {
3965 tags,
3966 language: mat.language,
3967 buffer: self.remote_id(),
3968 },
3969 extra_captures,
3970 buffer_id: self.remote_id(),
3971 })
3972 });
3973
3974 syntax_matches.advance();
3975 if test_range.is_some() {
3976 // It's fine for us to short-circuit on .peek()? returning None. We don't want to return None from this iter if we
3977 // had a capture that did not contain a run marker, hence we'll just loop around for the next capture.
3978 return test_range;
3979 }
3980 })
3981 }
3982
3983 /// Returns selections for remote peers intersecting the given range.
3984 #[allow(clippy::type_complexity)]
3985 pub fn selections_in_range(
3986 &self,
3987 range: Range<Anchor>,
3988 include_local: bool,
3989 ) -> impl Iterator<
3990 Item = (
3991 ReplicaId,
3992 bool,
3993 CursorShape,
3994 impl Iterator<Item = &Selection<Anchor>> + '_,
3995 ),
3996 > + '_ {
3997 self.remote_selections
3998 .iter()
3999 .filter(move |(replica_id, set)| {
4000 (include_local || **replica_id != self.text.replica_id())
4001 && !set.selections.is_empty()
4002 })
4003 .map(move |(replica_id, set)| {
4004 let start_ix = match set.selections.binary_search_by(|probe| {
4005 probe.end.cmp(&range.start, self).then(Ordering::Greater)
4006 }) {
4007 Ok(ix) | Err(ix) => ix,
4008 };
4009 let end_ix = match set.selections.binary_search_by(|probe| {
4010 probe.start.cmp(&range.end, self).then(Ordering::Less)
4011 }) {
4012 Ok(ix) | Err(ix) => ix,
4013 };
4014
4015 (
4016 *replica_id,
4017 set.line_mode,
4018 set.cursor_shape,
4019 set.selections[start_ix..end_ix].iter(),
4020 )
4021 })
4022 }
4023
4024 /// Returns if the buffer contains any diagnostics.
4025 pub fn has_diagnostics(&self) -> bool {
4026 !self.diagnostics.is_empty()
4027 }
4028
4029 /// Returns all the diagnostics intersecting the given range.
4030 pub fn diagnostics_in_range<'a, T, O>(
4031 &'a self,
4032 search_range: Range<T>,
4033 reversed: bool,
4034 ) -> impl 'a + Iterator<Item = DiagnosticEntry<O>>
4035 where
4036 T: 'a + Clone + ToOffset,
4037 O: 'a + FromAnchor,
4038 {
4039 let mut iterators: Vec<_> = self
4040 .diagnostics
4041 .iter()
4042 .map(|(_, collection)| {
4043 collection
4044 .range::<T, text::Anchor>(search_range.clone(), self, true, reversed)
4045 .peekable()
4046 })
4047 .collect();
4048
4049 std::iter::from_fn(move || {
4050 let (next_ix, _) = iterators
4051 .iter_mut()
4052 .enumerate()
4053 .flat_map(|(ix, iter)| Some((ix, iter.peek()?)))
4054 .min_by(|(_, a), (_, b)| {
4055 let cmp = a
4056 .range
4057 .start
4058 .cmp(&b.range.start, self)
4059 // when range is equal, sort by diagnostic severity
4060 .then(a.diagnostic.severity.cmp(&b.diagnostic.severity))
4061 // and stabilize order with group_id
4062 .then(a.diagnostic.group_id.cmp(&b.diagnostic.group_id));
4063 if reversed {
4064 cmp.reverse()
4065 } else {
4066 cmp
4067 }
4068 })?;
4069 iterators[next_ix]
4070 .next()
4071 .map(|DiagnosticEntry { range, diagnostic }| DiagnosticEntry {
4072 diagnostic,
4073 range: FromAnchor::from_anchor(&range.start, self)
4074 ..FromAnchor::from_anchor(&range.end, self),
4075 })
4076 })
4077 }
4078
4079 /// Returns all the diagnostic groups associated with the given
4080 /// language server ID. If no language server ID is provided,
4081 /// all diagnostics groups are returned.
4082 pub fn diagnostic_groups(
4083 &self,
4084 language_server_id: Option<LanguageServerId>,
4085 ) -> Vec<(LanguageServerId, DiagnosticGroup<Anchor>)> {
4086 let mut groups = Vec::new();
4087
4088 if let Some(language_server_id) = language_server_id {
4089 if let Ok(ix) = self
4090 .diagnostics
4091 .binary_search_by_key(&language_server_id, |e| e.0)
4092 {
4093 self.diagnostics[ix]
4094 .1
4095 .groups(language_server_id, &mut groups, self);
4096 }
4097 } else {
4098 for (language_server_id, diagnostics) in self.diagnostics.iter() {
4099 diagnostics.groups(*language_server_id, &mut groups, self);
4100 }
4101 }
4102
4103 groups.sort_by(|(id_a, group_a), (id_b, group_b)| {
4104 let a_start = &group_a.entries[group_a.primary_ix].range.start;
4105 let b_start = &group_b.entries[group_b.primary_ix].range.start;
4106 a_start.cmp(b_start, self).then_with(|| id_a.cmp(id_b))
4107 });
4108
4109 groups
4110 }
4111
4112 /// Returns an iterator over the diagnostics for the given group.
4113 pub fn diagnostic_group<O>(
4114 &self,
4115 group_id: usize,
4116 ) -> impl Iterator<Item = DiagnosticEntry<O>> + '_
4117 where
4118 O: FromAnchor + 'static,
4119 {
4120 self.diagnostics
4121 .iter()
4122 .flat_map(move |(_, set)| set.group(group_id, self))
4123 }
4124
4125 /// An integer version number that accounts for all updates besides
4126 /// the buffer's text itself (which is versioned via a version vector).
4127 pub fn non_text_state_update_count(&self) -> usize {
4128 self.non_text_state_update_count
4129 }
4130
4131 /// Returns a snapshot of underlying file.
4132 pub fn file(&self) -> Option<&Arc<dyn File>> {
4133 self.file.as_ref()
4134 }
4135
4136 /// Resolves the file path (relative to the worktree root) associated with the underlying file.
4137 pub fn resolve_file_path(&self, cx: &App, include_root: bool) -> Option<PathBuf> {
4138 if let Some(file) = self.file() {
4139 if file.path().file_name().is_none() || include_root {
4140 Some(file.full_path(cx))
4141 } else {
4142 Some(file.path().to_path_buf())
4143 }
4144 } else {
4145 None
4146 }
4147 }
4148
4149 pub fn words_in_range(&self, query: WordsQuery) -> HashMap<String, Range<Anchor>> {
4150 let query_str = query.fuzzy_contents;
4151 if query_str.map_or(false, |query| query.is_empty()) {
4152 return HashMap::default();
4153 }
4154
4155 let classifier = CharClassifier::new(self.language.clone().map(|language| LanguageScope {
4156 language,
4157 override_id: None,
4158 }));
4159
4160 let mut query_ix = 0;
4161 let query_chars = query_str.map(|query| query.chars().collect::<Vec<_>>());
4162 let query_len = query_chars.as_ref().map_or(0, |query| query.len());
4163
4164 let mut words = HashMap::default();
4165 let mut current_word_start_ix = None;
4166 let mut chunk_ix = query.range.start;
4167 for chunk in self.chunks(query.range, false) {
4168 for (i, c) in chunk.text.char_indices() {
4169 let ix = chunk_ix + i;
4170 if classifier.is_word(c) {
4171 if current_word_start_ix.is_none() {
4172 current_word_start_ix = Some(ix);
4173 }
4174
4175 if let Some(query_chars) = &query_chars {
4176 if query_ix < query_len {
4177 if c.to_lowercase().eq(query_chars[query_ix].to_lowercase()) {
4178 query_ix += 1;
4179 }
4180 }
4181 }
4182 continue;
4183 } else if let Some(word_start) = current_word_start_ix.take() {
4184 if query_ix == query_len {
4185 let word_range = self.anchor_before(word_start)..self.anchor_after(ix);
4186 let mut word_text = self.text_for_range(word_start..ix).peekable();
4187 let first_char = word_text
4188 .peek()
4189 .and_then(|first_chunk| first_chunk.chars().next());
4190 // Skip empty and "words" starting with digits as a heuristic to reduce useless completions
4191 if !query.skip_digits
4192 || first_char.map_or(true, |first_char| !first_char.is_digit(10))
4193 {
4194 words.insert(word_text.collect(), word_range);
4195 }
4196 }
4197 }
4198 query_ix = 0;
4199 }
4200 chunk_ix += chunk.text.len();
4201 }
4202
4203 words
4204 }
4205}
4206
4207pub struct WordsQuery<'a> {
4208 /// Only returns words with all chars from the fuzzy string in them.
4209 pub fuzzy_contents: Option<&'a str>,
4210 /// Skips words that start with a digit.
4211 pub skip_digits: bool,
4212 /// Buffer offset range, to look for words.
4213 pub range: Range<usize>,
4214}
4215
4216fn indent_size_for_line(text: &text::BufferSnapshot, row: u32) -> IndentSize {
4217 indent_size_for_text(text.chars_at(Point::new(row, 0)))
4218}
4219
4220fn indent_size_for_text(text: impl Iterator<Item = char>) -> IndentSize {
4221 let mut result = IndentSize::spaces(0);
4222 for c in text {
4223 let kind = match c {
4224 ' ' => IndentKind::Space,
4225 '\t' => IndentKind::Tab,
4226 _ => break,
4227 };
4228 if result.len == 0 {
4229 result.kind = kind;
4230 }
4231 result.len += 1;
4232 }
4233 result
4234}
4235
4236impl Clone for BufferSnapshot {
4237 fn clone(&self) -> Self {
4238 Self {
4239 text: self.text.clone(),
4240 syntax: self.syntax.clone(),
4241 file: self.file.clone(),
4242 remote_selections: self.remote_selections.clone(),
4243 diagnostics: self.diagnostics.clone(),
4244 language: self.language.clone(),
4245 non_text_state_update_count: self.non_text_state_update_count,
4246 }
4247 }
4248}
4249
4250impl Deref for BufferSnapshot {
4251 type Target = text::BufferSnapshot;
4252
4253 fn deref(&self) -> &Self::Target {
4254 &self.text
4255 }
4256}
4257
4258unsafe impl Send for BufferChunks<'_> {}
4259
4260impl<'a> BufferChunks<'a> {
4261 pub(crate) fn new(
4262 text: &'a Rope,
4263 range: Range<usize>,
4264 syntax: Option<(SyntaxMapCaptures<'a>, Vec<HighlightMap>)>,
4265 diagnostics: bool,
4266 buffer_snapshot: Option<&'a BufferSnapshot>,
4267 ) -> Self {
4268 let mut highlights = None;
4269 if let Some((captures, highlight_maps)) = syntax {
4270 highlights = Some(BufferChunkHighlights {
4271 captures,
4272 next_capture: None,
4273 stack: Default::default(),
4274 highlight_maps,
4275 })
4276 }
4277
4278 let diagnostic_endpoints = diagnostics.then(|| Vec::new().into_iter().peekable());
4279 let chunks = text.chunks_in_range(range.clone());
4280
4281 let mut this = BufferChunks {
4282 range,
4283 buffer_snapshot,
4284 chunks,
4285 diagnostic_endpoints,
4286 error_depth: 0,
4287 warning_depth: 0,
4288 information_depth: 0,
4289 hint_depth: 0,
4290 unnecessary_depth: 0,
4291 highlights,
4292 };
4293 this.initialize_diagnostic_endpoints();
4294 this
4295 }
4296
4297 /// Seeks to the given byte offset in the buffer.
4298 pub fn seek(&mut self, range: Range<usize>) {
4299 let old_range = std::mem::replace(&mut self.range, range.clone());
4300 self.chunks.set_range(self.range.clone());
4301 if let Some(highlights) = self.highlights.as_mut() {
4302 if old_range.start <= self.range.start && old_range.end >= self.range.end {
4303 // Reuse existing highlights stack, as the new range is a subrange of the old one.
4304 highlights
4305 .stack
4306 .retain(|(end_offset, _)| *end_offset > range.start);
4307 if let Some(capture) = &highlights.next_capture {
4308 if range.start >= capture.node.start_byte() {
4309 let next_capture_end = capture.node.end_byte();
4310 if range.start < next_capture_end {
4311 highlights.stack.push((
4312 next_capture_end,
4313 highlights.highlight_maps[capture.grammar_index].get(capture.index),
4314 ));
4315 }
4316 highlights.next_capture.take();
4317 }
4318 }
4319 } else if let Some(snapshot) = self.buffer_snapshot {
4320 let (captures, highlight_maps) = snapshot.get_highlights(self.range.clone());
4321 *highlights = BufferChunkHighlights {
4322 captures,
4323 next_capture: None,
4324 stack: Default::default(),
4325 highlight_maps,
4326 };
4327 } else {
4328 // We cannot obtain new highlights for a language-aware buffer iterator, as we don't have a buffer snapshot.
4329 // Seeking such BufferChunks is not supported.
4330 debug_assert!(false, "Attempted to seek on a language-aware buffer iterator without associated buffer snapshot");
4331 }
4332
4333 highlights.captures.set_byte_range(self.range.clone());
4334 self.initialize_diagnostic_endpoints();
4335 }
4336 }
4337
4338 fn initialize_diagnostic_endpoints(&mut self) {
4339 if let Some(diagnostics) = self.diagnostic_endpoints.as_mut() {
4340 if let Some(buffer) = self.buffer_snapshot {
4341 let mut diagnostic_endpoints = Vec::new();
4342 for entry in buffer.diagnostics_in_range::<_, usize>(self.range.clone(), false) {
4343 diagnostic_endpoints.push(DiagnosticEndpoint {
4344 offset: entry.range.start,
4345 is_start: true,
4346 severity: entry.diagnostic.severity,
4347 is_unnecessary: entry.diagnostic.is_unnecessary,
4348 });
4349 diagnostic_endpoints.push(DiagnosticEndpoint {
4350 offset: entry.range.end,
4351 is_start: false,
4352 severity: entry.diagnostic.severity,
4353 is_unnecessary: entry.diagnostic.is_unnecessary,
4354 });
4355 }
4356 diagnostic_endpoints
4357 .sort_unstable_by_key(|endpoint| (endpoint.offset, !endpoint.is_start));
4358 *diagnostics = diagnostic_endpoints.into_iter().peekable();
4359 self.hint_depth = 0;
4360 self.error_depth = 0;
4361 self.warning_depth = 0;
4362 self.information_depth = 0;
4363 }
4364 }
4365 }
4366
4367 /// The current byte offset in the buffer.
4368 pub fn offset(&self) -> usize {
4369 self.range.start
4370 }
4371
4372 pub fn range(&self) -> Range<usize> {
4373 self.range.clone()
4374 }
4375
4376 fn update_diagnostic_depths(&mut self, endpoint: DiagnosticEndpoint) {
4377 let depth = match endpoint.severity {
4378 DiagnosticSeverity::ERROR => &mut self.error_depth,
4379 DiagnosticSeverity::WARNING => &mut self.warning_depth,
4380 DiagnosticSeverity::INFORMATION => &mut self.information_depth,
4381 DiagnosticSeverity::HINT => &mut self.hint_depth,
4382 _ => return,
4383 };
4384 if endpoint.is_start {
4385 *depth += 1;
4386 } else {
4387 *depth -= 1;
4388 }
4389
4390 if endpoint.is_unnecessary {
4391 if endpoint.is_start {
4392 self.unnecessary_depth += 1;
4393 } else {
4394 self.unnecessary_depth -= 1;
4395 }
4396 }
4397 }
4398
4399 fn current_diagnostic_severity(&self) -> Option<DiagnosticSeverity> {
4400 if self.error_depth > 0 {
4401 Some(DiagnosticSeverity::ERROR)
4402 } else if self.warning_depth > 0 {
4403 Some(DiagnosticSeverity::WARNING)
4404 } else if self.information_depth > 0 {
4405 Some(DiagnosticSeverity::INFORMATION)
4406 } else if self.hint_depth > 0 {
4407 Some(DiagnosticSeverity::HINT)
4408 } else {
4409 None
4410 }
4411 }
4412
4413 fn current_code_is_unnecessary(&self) -> bool {
4414 self.unnecessary_depth > 0
4415 }
4416}
4417
4418impl<'a> Iterator for BufferChunks<'a> {
4419 type Item = Chunk<'a>;
4420
4421 fn next(&mut self) -> Option<Self::Item> {
4422 let mut next_capture_start = usize::MAX;
4423 let mut next_diagnostic_endpoint = usize::MAX;
4424
4425 if let Some(highlights) = self.highlights.as_mut() {
4426 while let Some((parent_capture_end, _)) = highlights.stack.last() {
4427 if *parent_capture_end <= self.range.start {
4428 highlights.stack.pop();
4429 } else {
4430 break;
4431 }
4432 }
4433
4434 if highlights.next_capture.is_none() {
4435 highlights.next_capture = highlights.captures.next();
4436 }
4437
4438 while let Some(capture) = highlights.next_capture.as_ref() {
4439 if self.range.start < capture.node.start_byte() {
4440 next_capture_start = capture.node.start_byte();
4441 break;
4442 } else {
4443 let highlight_id =
4444 highlights.highlight_maps[capture.grammar_index].get(capture.index);
4445 highlights
4446 .stack
4447 .push((capture.node.end_byte(), highlight_id));
4448 highlights.next_capture = highlights.captures.next();
4449 }
4450 }
4451 }
4452
4453 let mut diagnostic_endpoints = std::mem::take(&mut self.diagnostic_endpoints);
4454 if let Some(diagnostic_endpoints) = diagnostic_endpoints.as_mut() {
4455 while let Some(endpoint) = diagnostic_endpoints.peek().copied() {
4456 if endpoint.offset <= self.range.start {
4457 self.update_diagnostic_depths(endpoint);
4458 diagnostic_endpoints.next();
4459 } else {
4460 next_diagnostic_endpoint = endpoint.offset;
4461 break;
4462 }
4463 }
4464 }
4465 self.diagnostic_endpoints = diagnostic_endpoints;
4466
4467 if let Some(chunk) = self.chunks.peek() {
4468 let chunk_start = self.range.start;
4469 let mut chunk_end = (self.chunks.offset() + chunk.len())
4470 .min(next_capture_start)
4471 .min(next_diagnostic_endpoint);
4472 let mut highlight_id = None;
4473 if let Some(highlights) = self.highlights.as_ref() {
4474 if let Some((parent_capture_end, parent_highlight_id)) = highlights.stack.last() {
4475 chunk_end = chunk_end.min(*parent_capture_end);
4476 highlight_id = Some(*parent_highlight_id);
4477 }
4478 }
4479
4480 let slice =
4481 &chunk[chunk_start - self.chunks.offset()..chunk_end - self.chunks.offset()];
4482 self.range.start = chunk_end;
4483 if self.range.start == self.chunks.offset() + chunk.len() {
4484 self.chunks.next().unwrap();
4485 }
4486
4487 Some(Chunk {
4488 text: slice,
4489 syntax_highlight_id: highlight_id,
4490 diagnostic_severity: self.current_diagnostic_severity(),
4491 is_unnecessary: self.current_code_is_unnecessary(),
4492 ..Default::default()
4493 })
4494 } else {
4495 None
4496 }
4497 }
4498}
4499
4500impl operation_queue::Operation for Operation {
4501 fn lamport_timestamp(&self) -> clock::Lamport {
4502 match self {
4503 Operation::Buffer(_) => {
4504 unreachable!("buffer operations should never be deferred at this layer")
4505 }
4506 Operation::UpdateDiagnostics {
4507 lamport_timestamp, ..
4508 }
4509 | Operation::UpdateSelections {
4510 lamport_timestamp, ..
4511 }
4512 | Operation::UpdateCompletionTriggers {
4513 lamport_timestamp, ..
4514 } => *lamport_timestamp,
4515 }
4516 }
4517}
4518
4519impl Default for Diagnostic {
4520 fn default() -> Self {
4521 Self {
4522 source: Default::default(),
4523 code: None,
4524 severity: DiagnosticSeverity::ERROR,
4525 message: Default::default(),
4526 group_id: 0,
4527 is_primary: false,
4528 is_disk_based: false,
4529 is_unnecessary: false,
4530 data: None,
4531 }
4532 }
4533}
4534
4535impl IndentSize {
4536 /// Returns an [`IndentSize`] representing the given spaces.
4537 pub fn spaces(len: u32) -> Self {
4538 Self {
4539 len,
4540 kind: IndentKind::Space,
4541 }
4542 }
4543
4544 /// Returns an [`IndentSize`] representing a tab.
4545 pub fn tab() -> Self {
4546 Self {
4547 len: 1,
4548 kind: IndentKind::Tab,
4549 }
4550 }
4551
4552 /// An iterator over the characters represented by this [`IndentSize`].
4553 pub fn chars(&self) -> impl Iterator<Item = char> {
4554 iter::repeat(self.char()).take(self.len as usize)
4555 }
4556
4557 /// The character representation of this [`IndentSize`].
4558 pub fn char(&self) -> char {
4559 match self.kind {
4560 IndentKind::Space => ' ',
4561 IndentKind::Tab => '\t',
4562 }
4563 }
4564
4565 /// Consumes the current [`IndentSize`] and returns a new one that has
4566 /// been shrunk or enlarged by the given size along the given direction.
4567 pub fn with_delta(mut self, direction: Ordering, size: IndentSize) -> Self {
4568 match direction {
4569 Ordering::Less => {
4570 if self.kind == size.kind && self.len >= size.len {
4571 self.len -= size.len;
4572 }
4573 }
4574 Ordering::Equal => {}
4575 Ordering::Greater => {
4576 if self.len == 0 {
4577 self = size;
4578 } else if self.kind == size.kind {
4579 self.len += size.len;
4580 }
4581 }
4582 }
4583 self
4584 }
4585
4586 pub fn len_with_expanded_tabs(&self, tab_size: NonZeroU32) -> usize {
4587 match self.kind {
4588 IndentKind::Space => self.len as usize,
4589 IndentKind::Tab => self.len as usize * tab_size.get() as usize,
4590 }
4591 }
4592}
4593
4594#[cfg(any(test, feature = "test-support"))]
4595pub struct TestFile {
4596 pub path: Arc<Path>,
4597 pub root_name: String,
4598 pub local_root: Option<PathBuf>,
4599}
4600
4601#[cfg(any(test, feature = "test-support"))]
4602impl File for TestFile {
4603 fn path(&self) -> &Arc<Path> {
4604 &self.path
4605 }
4606
4607 fn full_path(&self, _: &gpui::App) -> PathBuf {
4608 PathBuf::from(&self.root_name).join(self.path.as_ref())
4609 }
4610
4611 fn as_local(&self) -> Option<&dyn LocalFile> {
4612 if self.local_root.is_some() {
4613 Some(self)
4614 } else {
4615 None
4616 }
4617 }
4618
4619 fn disk_state(&self) -> DiskState {
4620 unimplemented!()
4621 }
4622
4623 fn file_name<'a>(&'a self, _: &'a gpui::App) -> &'a std::ffi::OsStr {
4624 self.path().file_name().unwrap_or(self.root_name.as_ref())
4625 }
4626
4627 fn worktree_id(&self, _: &App) -> WorktreeId {
4628 WorktreeId::from_usize(0)
4629 }
4630
4631 fn as_any(&self) -> &dyn std::any::Any {
4632 unimplemented!()
4633 }
4634
4635 fn to_proto(&self, _: &App) -> rpc::proto::File {
4636 unimplemented!()
4637 }
4638
4639 fn is_private(&self) -> bool {
4640 false
4641 }
4642}
4643
4644#[cfg(any(test, feature = "test-support"))]
4645impl LocalFile for TestFile {
4646 fn abs_path(&self, _cx: &App) -> PathBuf {
4647 PathBuf::from(self.local_root.as_ref().unwrap())
4648 .join(&self.root_name)
4649 .join(self.path.as_ref())
4650 }
4651
4652 fn load(&self, _cx: &App) -> Task<Result<String>> {
4653 unimplemented!()
4654 }
4655
4656 fn load_bytes(&self, _cx: &App) -> Task<Result<Vec<u8>>> {
4657 unimplemented!()
4658 }
4659}
4660
4661pub(crate) fn contiguous_ranges(
4662 values: impl Iterator<Item = u32>,
4663 max_len: usize,
4664) -> impl Iterator<Item = Range<u32>> {
4665 let mut values = values;
4666 let mut current_range: Option<Range<u32>> = None;
4667 std::iter::from_fn(move || loop {
4668 if let Some(value) = values.next() {
4669 if let Some(range) = &mut current_range {
4670 if value == range.end && range.len() < max_len {
4671 range.end += 1;
4672 continue;
4673 }
4674 }
4675
4676 let prev_range = current_range.clone();
4677 current_range = Some(value..(value + 1));
4678 if prev_range.is_some() {
4679 return prev_range;
4680 }
4681 } else {
4682 return current_range.take();
4683 }
4684 })
4685}
4686
4687#[derive(Default, Debug)]
4688pub struct CharClassifier {
4689 scope: Option<LanguageScope>,
4690 for_completion: bool,
4691 ignore_punctuation: bool,
4692}
4693
4694impl CharClassifier {
4695 pub fn new(scope: Option<LanguageScope>) -> Self {
4696 Self {
4697 scope,
4698 for_completion: false,
4699 ignore_punctuation: false,
4700 }
4701 }
4702
4703 pub fn for_completion(self, for_completion: bool) -> Self {
4704 Self {
4705 for_completion,
4706 ..self
4707 }
4708 }
4709
4710 pub fn ignore_punctuation(self, ignore_punctuation: bool) -> Self {
4711 Self {
4712 ignore_punctuation,
4713 ..self
4714 }
4715 }
4716
4717 pub fn is_whitespace(&self, c: char) -> bool {
4718 self.kind(c) == CharKind::Whitespace
4719 }
4720
4721 pub fn is_word(&self, c: char) -> bool {
4722 self.kind(c) == CharKind::Word
4723 }
4724
4725 pub fn is_punctuation(&self, c: char) -> bool {
4726 self.kind(c) == CharKind::Punctuation
4727 }
4728
4729 pub fn kind_with(&self, c: char, ignore_punctuation: bool) -> CharKind {
4730 if c.is_alphanumeric() || c == '_' {
4731 return CharKind::Word;
4732 }
4733
4734 if let Some(scope) = &self.scope {
4735 let characters = if self.for_completion {
4736 scope.completion_query_characters()
4737 } else {
4738 scope.word_characters()
4739 };
4740 if let Some(characters) = characters {
4741 if characters.contains(&c) {
4742 return CharKind::Word;
4743 }
4744 }
4745 }
4746
4747 if c.is_whitespace() {
4748 return CharKind::Whitespace;
4749 }
4750
4751 if ignore_punctuation {
4752 CharKind::Word
4753 } else {
4754 CharKind::Punctuation
4755 }
4756 }
4757
4758 pub fn kind(&self, c: char) -> CharKind {
4759 self.kind_with(c, self.ignore_punctuation)
4760 }
4761}
4762
4763/// Find all of the ranges of whitespace that occur at the ends of lines
4764/// in the given rope.
4765///
4766/// This could also be done with a regex search, but this implementation
4767/// avoids copying text.
4768pub fn trailing_whitespace_ranges(rope: &Rope) -> Vec<Range<usize>> {
4769 let mut ranges = Vec::new();
4770
4771 let mut offset = 0;
4772 let mut prev_chunk_trailing_whitespace_range = 0..0;
4773 for chunk in rope.chunks() {
4774 let mut prev_line_trailing_whitespace_range = 0..0;
4775 for (i, line) in chunk.split('\n').enumerate() {
4776 let line_end_offset = offset + line.len();
4777 let trimmed_line_len = line.trim_end_matches([' ', '\t']).len();
4778 let mut trailing_whitespace_range = (offset + trimmed_line_len)..line_end_offset;
4779
4780 if i == 0 && trimmed_line_len == 0 {
4781 trailing_whitespace_range.start = prev_chunk_trailing_whitespace_range.start;
4782 }
4783 if !prev_line_trailing_whitespace_range.is_empty() {
4784 ranges.push(prev_line_trailing_whitespace_range);
4785 }
4786
4787 offset = line_end_offset + 1;
4788 prev_line_trailing_whitespace_range = trailing_whitespace_range;
4789 }
4790
4791 offset -= 1;
4792 prev_chunk_trailing_whitespace_range = prev_line_trailing_whitespace_range;
4793 }
4794
4795 if !prev_chunk_trailing_whitespace_range.is_empty() {
4796 ranges.push(prev_chunk_trailing_whitespace_range);
4797 }
4798
4799 ranges
4800}