1pub use crate::{
2 diagnostic_set::DiagnosticSet,
3 highlight_map::{HighlightId, HighlightMap},
4 proto, BracketPair, Grammar, Language, LanguageConfig, LanguageRegistry, PLAIN_TEXT,
5};
6use crate::{
7 diagnostic_set::{DiagnosticEntry, DiagnosticGroup},
8 outline::OutlineItem,
9 syntax_map::{
10 SyntaxMap, SyntaxMapCapture, SyntaxMapCaptures, SyntaxSnapshot, ToTreeSitterPoint,
11 },
12 CodeLabel, LanguageScope, Outline,
13};
14use anyhow::{anyhow, Result};
15use clock::ReplicaId;
16use fs::LineEnding;
17use futures::FutureExt as _;
18use gpui::{fonts::HighlightStyle, AppContext, Entity, ModelContext, MutableAppContext, Task};
19use parking_lot::Mutex;
20use settings::Settings;
21use similar::{ChangeTag, TextDiff};
22use smol::future::yield_now;
23use std::{
24 any::Any,
25 cmp::{self, Ordering},
26 collections::BTreeMap,
27 ffi::OsStr,
28 future::Future,
29 iter::{self, Iterator, Peekable},
30 mem,
31 ops::{Deref, Range},
32 path::{Path, PathBuf},
33 str,
34 sync::Arc,
35 time::{Duration, Instant, SystemTime, UNIX_EPOCH},
36 vec,
37};
38use sum_tree::TreeMap;
39use text::operation_queue::OperationQueue;
40pub use text::{Buffer as TextBuffer, BufferSnapshot as TextBufferSnapshot, Operation as _, *};
41use theme::SyntaxTheme;
42#[cfg(any(test, feature = "test-support"))]
43use util::RandomCharIter;
44use util::{RangeExt, TryFutureExt as _};
45
46#[cfg(any(test, feature = "test-support"))]
47pub use {tree_sitter_rust, tree_sitter_typescript};
48
49pub use lsp::DiagnosticSeverity;
50
51struct GitDiffStatus {
52 diff: git::diff::BufferDiff,
53 update_in_progress: bool,
54 update_requested: bool,
55}
56
57pub struct Buffer {
58 text: TextBuffer,
59 diff_base: Option<String>,
60 git_diff_status: GitDiffStatus,
61 file: Option<Arc<dyn File>>,
62 saved_version: clock::Global,
63 saved_version_fingerprint: RopeFingerprint,
64 saved_mtime: SystemTime,
65 transaction_depth: usize,
66 was_dirty_before_starting_transaction: Option<bool>,
67 language: Option<Arc<Language>>,
68 autoindent_requests: Vec<Arc<AutoindentRequest>>,
69 pending_autoindent: Option<Task<()>>,
70 sync_parse_timeout: Duration,
71 syntax_map: Mutex<SyntaxMap>,
72 parsing_in_background: bool,
73 parse_count: usize,
74 diagnostics: DiagnosticSet,
75 remote_selections: TreeMap<ReplicaId, SelectionSet>,
76 selections_update_count: usize,
77 diagnostics_update_count: usize,
78 diagnostics_timestamp: clock::Lamport,
79 file_update_count: usize,
80 git_diff_update_count: usize,
81 completion_triggers: Vec<String>,
82 completion_triggers_timestamp: clock::Lamport,
83 deferred_ops: OperationQueue<Operation>,
84}
85
86pub struct BufferSnapshot {
87 text: text::BufferSnapshot,
88 pub git_diff: git::diff::BufferDiff,
89 pub(crate) syntax: SyntaxSnapshot,
90 file: Option<Arc<dyn File>>,
91 diagnostics: DiagnosticSet,
92 diagnostics_update_count: usize,
93 file_update_count: usize,
94 git_diff_update_count: usize,
95 remote_selections: TreeMap<ReplicaId, SelectionSet>,
96 selections_update_count: usize,
97 language: Option<Arc<Language>>,
98 parse_count: usize,
99}
100
101#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
102pub struct IndentSize {
103 pub len: u32,
104 pub kind: IndentKind,
105}
106
107#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
108pub enum IndentKind {
109 #[default]
110 Space,
111 Tab,
112}
113
114#[derive(Copy, Clone, PartialEq, Eq, Debug, Default)]
115pub enum CursorShape {
116 #[default]
117 Bar,
118 Block,
119 Underscore,
120 Hollow,
121}
122
123#[derive(Clone, Debug)]
124struct SelectionSet {
125 line_mode: bool,
126 cursor_shape: CursorShape,
127 selections: Arc<[Selection<Anchor>]>,
128 lamport_timestamp: clock::Lamport,
129}
130
131#[derive(Clone, Debug, PartialEq, Eq)]
132pub struct GroupId {
133 source: Arc<str>,
134 id: usize,
135}
136
137#[derive(Clone, Debug, PartialEq, Eq)]
138pub struct Diagnostic {
139 pub code: Option<String>,
140 pub severity: DiagnosticSeverity,
141 pub message: String,
142 pub group_id: usize,
143 pub is_valid: bool,
144 pub is_primary: bool,
145 pub is_disk_based: bool,
146 pub is_unnecessary: bool,
147}
148
149#[derive(Clone, Debug)]
150pub struct Completion {
151 pub old_range: Range<Anchor>,
152 pub new_text: String,
153 pub label: CodeLabel,
154 pub lsp_completion: lsp::CompletionItem,
155}
156
157#[derive(Clone, Debug)]
158pub struct CodeAction {
159 pub range: Range<Anchor>,
160 pub lsp_action: lsp::CodeAction,
161}
162
163#[derive(Clone, Debug, PartialEq, Eq)]
164pub enum Operation {
165 Buffer(text::Operation),
166 UpdateDiagnostics {
167 diagnostics: Arc<[DiagnosticEntry<Anchor>]>,
168 lamport_timestamp: clock::Lamport,
169 },
170 UpdateSelections {
171 selections: Arc<[Selection<Anchor>]>,
172 lamport_timestamp: clock::Lamport,
173 line_mode: bool,
174 cursor_shape: CursorShape,
175 },
176 UpdateCompletionTriggers {
177 triggers: Vec<String>,
178 lamport_timestamp: clock::Lamport,
179 },
180}
181
182#[derive(Clone, Debug, PartialEq, Eq)]
183pub enum Event {
184 Operation(Operation),
185 Edited,
186 DirtyChanged,
187 Saved,
188 FileHandleChanged,
189 Reloaded,
190 Reparsed,
191 DiagnosticsUpdated,
192 Closed,
193}
194
195pub trait File: Send + Sync {
196 fn as_local(&self) -> Option<&dyn LocalFile>;
197
198 fn is_local(&self) -> bool {
199 self.as_local().is_some()
200 }
201
202 fn mtime(&self) -> SystemTime;
203
204 /// Returns the path of this file relative to the worktree's root directory.
205 fn path(&self) -> &Arc<Path>;
206
207 /// Returns the path of this file relative to the worktree's parent directory (this means it
208 /// includes the name of the worktree's root folder).
209 fn full_path(&self, cx: &AppContext) -> PathBuf;
210
211 /// Returns the last component of this handle's absolute path. If this handle refers to the root
212 /// of its worktree, then this method will return the name of the worktree itself.
213 fn file_name<'a>(&'a self, cx: &'a AppContext) -> &'a OsStr;
214
215 fn is_deleted(&self) -> bool;
216
217 fn as_any(&self) -> &dyn Any;
218
219 fn to_proto(&self) -> rpc::proto::File;
220}
221
222pub trait LocalFile: File {
223 /// Returns the absolute path of this file.
224 fn abs_path(&self, cx: &AppContext) -> PathBuf;
225
226 fn load(&self, cx: &AppContext) -> Task<Result<String>>;
227
228 fn buffer_reloaded(
229 &self,
230 buffer_id: u64,
231 version: &clock::Global,
232 fingerprint: RopeFingerprint,
233 line_ending: LineEnding,
234 mtime: SystemTime,
235 cx: &mut MutableAppContext,
236 );
237}
238
239#[derive(Clone, Debug)]
240pub enum AutoindentMode {
241 /// Indent each line of inserted text.
242 EachLine,
243 /// Apply the same indentation adjustment to all of the lines
244 /// in a given insertion.
245 Block {
246 /// The original indentation level of the first line of each
247 /// insertion, if it has been copied.
248 original_indent_columns: Vec<u32>,
249 },
250}
251
252#[derive(Clone)]
253struct AutoindentRequest {
254 before_edit: BufferSnapshot,
255 entries: Vec<AutoindentRequestEntry>,
256 is_block_mode: bool,
257}
258
259#[derive(Clone)]
260struct AutoindentRequestEntry {
261 /// A range of the buffer whose indentation should be adjusted.
262 range: Range<Anchor>,
263 /// Whether or not these lines should be considered brand new, for the
264 /// purpose of auto-indent. When text is not new, its indentation will
265 /// only be adjusted if the suggested indentation level has *changed*
266 /// since the edit was made.
267 first_line_is_new: bool,
268 indent_size: IndentSize,
269 original_indent_column: Option<u32>,
270}
271
272#[derive(Debug)]
273struct IndentSuggestion {
274 basis_row: u32,
275 delta: Ordering,
276 within_error: bool,
277}
278
279struct BufferChunkHighlights<'a> {
280 captures: SyntaxMapCaptures<'a>,
281 next_capture: Option<SyntaxMapCapture<'a>>,
282 stack: Vec<(usize, HighlightId)>,
283 highlight_maps: Vec<HighlightMap>,
284}
285
286pub struct BufferChunks<'a> {
287 range: Range<usize>,
288 chunks: text::Chunks<'a>,
289 diagnostic_endpoints: Peekable<vec::IntoIter<DiagnosticEndpoint>>,
290 error_depth: usize,
291 warning_depth: usize,
292 information_depth: usize,
293 hint_depth: usize,
294 unnecessary_depth: usize,
295 highlights: Option<BufferChunkHighlights<'a>>,
296}
297
298#[derive(Clone, Copy, Debug, Default)]
299pub struct Chunk<'a> {
300 pub text: &'a str,
301 pub syntax_highlight_id: Option<HighlightId>,
302 pub highlight_style: Option<HighlightStyle>,
303 pub diagnostic_severity: Option<DiagnosticSeverity>,
304 pub is_unnecessary: bool,
305}
306
307pub struct Diff {
308 pub(crate) base_version: clock::Global,
309 line_ending: LineEnding,
310 edits: Vec<(Range<usize>, Arc<str>)>,
311}
312
313#[derive(Clone, Copy)]
314pub(crate) struct DiagnosticEndpoint {
315 offset: usize,
316 is_start: bool,
317 severity: DiagnosticSeverity,
318 is_unnecessary: bool,
319}
320
321#[derive(Copy, Clone, Eq, PartialEq, PartialOrd, Ord, Debug)]
322pub enum CharKind {
323 Punctuation,
324 Whitespace,
325 Word,
326}
327
328impl CharKind {
329 pub fn coerce_punctuation(self, treat_punctuation_as_word: bool) -> Self {
330 if treat_punctuation_as_word && self == CharKind::Punctuation {
331 CharKind::Word
332 } else {
333 self
334 }
335 }
336}
337
338impl Buffer {
339 pub fn new<T: Into<String>>(
340 replica_id: ReplicaId,
341 base_text: T,
342 cx: &mut ModelContext<Self>,
343 ) -> Self {
344 Self::build(
345 TextBuffer::new(replica_id, cx.model_id() as u64, base_text.into()),
346 None,
347 None,
348 )
349 }
350
351 pub fn from_file<T: Into<String>>(
352 replica_id: ReplicaId,
353 base_text: T,
354 diff_base: Option<T>,
355 file: Arc<dyn File>,
356 cx: &mut ModelContext<Self>,
357 ) -> Self {
358 Self::build(
359 TextBuffer::new(replica_id, cx.model_id() as u64, base_text.into()),
360 diff_base.map(|h| h.into().into_boxed_str().into()),
361 Some(file),
362 )
363 }
364
365 pub fn from_proto(
366 replica_id: ReplicaId,
367 message: proto::BufferState,
368 file: Option<Arc<dyn File>>,
369 ) -> Result<Self> {
370 let buffer = TextBuffer::new(replica_id, message.id, message.base_text);
371 let mut this = Self::build(
372 buffer,
373 message.diff_base.map(|text| text.into_boxed_str().into()),
374 file,
375 );
376 this.text.set_line_ending(proto::deserialize_line_ending(
377 rpc::proto::LineEnding::from_i32(message.line_ending)
378 .ok_or_else(|| anyhow!("missing line_ending"))?,
379 ));
380 this.saved_version = proto::deserialize_version(message.saved_version);
381 this.saved_version_fingerprint =
382 proto::deserialize_fingerprint(&message.saved_version_fingerprint)?;
383 this.saved_mtime = message
384 .saved_mtime
385 .ok_or_else(|| anyhow!("invalid saved_mtime"))?
386 .into();
387 Ok(this)
388 }
389
390 pub fn to_proto(&self) -> proto::BufferState {
391 proto::BufferState {
392 id: self.remote_id(),
393 file: self.file.as_ref().map(|f| f.to_proto()),
394 base_text: self.base_text().to_string(),
395 diff_base: self.diff_base.as_ref().map(|h| h.to_string()),
396 line_ending: proto::serialize_line_ending(self.line_ending()) as i32,
397 saved_version: proto::serialize_version(&self.saved_version),
398 saved_version_fingerprint: proto::serialize_fingerprint(self.saved_version_fingerprint),
399 saved_mtime: Some(self.saved_mtime.into()),
400 }
401 }
402
403 pub fn serialize_ops(
404 &self,
405 since: Option<clock::Global>,
406 cx: &AppContext,
407 ) -> Task<Vec<proto::Operation>> {
408 let mut operations = Vec::new();
409 operations.extend(self.deferred_ops.iter().map(proto::serialize_operation));
410 operations.extend(self.remote_selections.iter().map(|(_, set)| {
411 proto::serialize_operation(&Operation::UpdateSelections {
412 selections: set.selections.clone(),
413 lamport_timestamp: set.lamport_timestamp,
414 line_mode: set.line_mode,
415 cursor_shape: set.cursor_shape,
416 })
417 }));
418 operations.push(proto::serialize_operation(&Operation::UpdateDiagnostics {
419 diagnostics: self.diagnostics.iter().cloned().collect(),
420 lamport_timestamp: self.diagnostics_timestamp,
421 }));
422 operations.push(proto::serialize_operation(
423 &Operation::UpdateCompletionTriggers {
424 triggers: self.completion_triggers.clone(),
425 lamport_timestamp: self.completion_triggers_timestamp,
426 },
427 ));
428
429 let text_operations = self.text.operations().clone();
430 cx.background().spawn(async move {
431 let since = since.unwrap_or_default();
432 operations.extend(
433 text_operations
434 .iter()
435 .filter(|(_, op)| !since.observed(op.local_timestamp()))
436 .map(|(_, op)| proto::serialize_operation(&Operation::Buffer(op.clone()))),
437 );
438 operations.sort_unstable_by_key(proto::lamport_timestamp_for_operation);
439 operations
440 })
441 }
442
443 pub fn with_language(mut self, language: Arc<Language>, cx: &mut ModelContext<Self>) -> Self {
444 self.set_language(Some(language), cx);
445 self
446 }
447
448 fn build(buffer: TextBuffer, diff_base: Option<String>, file: Option<Arc<dyn File>>) -> Self {
449 let saved_mtime = if let Some(file) = file.as_ref() {
450 file.mtime()
451 } else {
452 UNIX_EPOCH
453 };
454
455 Self {
456 saved_mtime,
457 saved_version: buffer.version(),
458 saved_version_fingerprint: buffer.as_rope().fingerprint(),
459 transaction_depth: 0,
460 was_dirty_before_starting_transaction: None,
461 text: buffer,
462 diff_base,
463 git_diff_status: GitDiffStatus {
464 diff: git::diff::BufferDiff::new(),
465 update_in_progress: false,
466 update_requested: false,
467 },
468 file,
469 syntax_map: Mutex::new(SyntaxMap::new()),
470 parsing_in_background: false,
471 parse_count: 0,
472 sync_parse_timeout: Duration::from_millis(1),
473 autoindent_requests: Default::default(),
474 pending_autoindent: Default::default(),
475 language: None,
476 remote_selections: Default::default(),
477 selections_update_count: 0,
478 diagnostics: Default::default(),
479 diagnostics_update_count: 0,
480 diagnostics_timestamp: Default::default(),
481 file_update_count: 0,
482 git_diff_update_count: 0,
483 completion_triggers: Default::default(),
484 completion_triggers_timestamp: Default::default(),
485 deferred_ops: OperationQueue::new(),
486 }
487 }
488
489 pub fn snapshot(&self) -> BufferSnapshot {
490 let text = self.text.snapshot();
491 let mut syntax_map = self.syntax_map.lock();
492 syntax_map.interpolate(&text);
493 let syntax = syntax_map.snapshot();
494
495 BufferSnapshot {
496 text,
497 syntax,
498 git_diff: self.git_diff_status.diff.clone(),
499 file: self.file.clone(),
500 remote_selections: self.remote_selections.clone(),
501 diagnostics: self.diagnostics.clone(),
502 diagnostics_update_count: self.diagnostics_update_count,
503 file_update_count: self.file_update_count,
504 git_diff_update_count: self.git_diff_update_count,
505 language: self.language.clone(),
506 parse_count: self.parse_count,
507 selections_update_count: self.selections_update_count,
508 }
509 }
510
511 pub fn as_text_snapshot(&self) -> &text::BufferSnapshot {
512 &self.text
513 }
514
515 pub fn text_snapshot(&self) -> text::BufferSnapshot {
516 self.text.snapshot()
517 }
518
519 pub fn file(&self) -> Option<&Arc<dyn File>> {
520 self.file.as_ref()
521 }
522
523 pub fn saved_version(&self) -> &clock::Global {
524 &self.saved_version
525 }
526
527 pub fn saved_version_fingerprint(&self) -> RopeFingerprint {
528 self.saved_version_fingerprint
529 }
530
531 pub fn saved_mtime(&self) -> SystemTime {
532 self.saved_mtime
533 }
534
535 pub fn set_language(&mut self, language: Option<Arc<Language>>, cx: &mut ModelContext<Self>) {
536 self.syntax_map.lock().clear();
537 self.language = language;
538 self.reparse(cx);
539 }
540
541 pub fn set_language_registry(&mut self, language_registry: Arc<LanguageRegistry>) {
542 self.syntax_map
543 .lock()
544 .set_language_registry(language_registry);
545 }
546
547 pub fn did_save(
548 &mut self,
549 version: clock::Global,
550 fingerprint: RopeFingerprint,
551 mtime: SystemTime,
552 cx: &mut ModelContext<Self>,
553 ) {
554 self.saved_version = version;
555 self.saved_version_fingerprint = fingerprint;
556 self.saved_mtime = mtime;
557 cx.emit(Event::Saved);
558 cx.notify();
559 }
560
561 pub fn reload(&mut self, cx: &mut ModelContext<Self>) -> Task<Result<Option<Transaction>>> {
562 cx.spawn(|this, mut cx| async move {
563 if let Some((new_mtime, new_text)) = this.read_with(&cx, |this, cx| {
564 let file = this.file.as_ref()?.as_local()?;
565 Some((file.mtime(), file.load(cx)))
566 }) {
567 let new_text = new_text.await?;
568 let diff = this
569 .read_with(&cx, |this, cx| this.diff(new_text, cx))
570 .await;
571 this.update(&mut cx, |this, cx| {
572 if this.version() == diff.base_version {
573 this.finalize_last_transaction();
574 this.apply_diff(diff, cx);
575 if let Some(transaction) = this.finalize_last_transaction().cloned() {
576 this.did_reload(
577 this.version(),
578 this.as_rope().fingerprint(),
579 this.line_ending(),
580 new_mtime,
581 cx,
582 );
583 return Ok(Some(transaction));
584 }
585 }
586 Ok(None)
587 })
588 } else {
589 Ok(None)
590 }
591 })
592 }
593
594 pub fn did_reload(
595 &mut self,
596 version: clock::Global,
597 fingerprint: RopeFingerprint,
598 line_ending: LineEnding,
599 mtime: SystemTime,
600 cx: &mut ModelContext<Self>,
601 ) {
602 self.saved_version = version;
603 self.saved_version_fingerprint = fingerprint;
604 self.text.set_line_ending(line_ending);
605 self.saved_mtime = mtime;
606 if let Some(file) = self.file.as_ref().and_then(|f| f.as_local()) {
607 file.buffer_reloaded(
608 self.remote_id(),
609 &self.saved_version,
610 self.saved_version_fingerprint,
611 self.line_ending(),
612 self.saved_mtime,
613 cx,
614 );
615 }
616 self.git_diff_recalc(cx);
617 cx.emit(Event::Reloaded);
618 cx.notify();
619 }
620
621 pub fn file_updated(
622 &mut self,
623 new_file: Arc<dyn File>,
624 cx: &mut ModelContext<Self>,
625 ) -> Task<()> {
626 let mut file_changed = false;
627 let mut task = Task::ready(());
628
629 if let Some(old_file) = self.file.as_ref() {
630 if new_file.path() != old_file.path() {
631 file_changed = true;
632 }
633
634 if new_file.is_deleted() {
635 if !old_file.is_deleted() {
636 file_changed = true;
637 if !self.is_dirty() {
638 cx.emit(Event::DirtyChanged);
639 }
640 }
641 } else {
642 let new_mtime = new_file.mtime();
643 if new_mtime != old_file.mtime() {
644 file_changed = true;
645
646 if !self.is_dirty() {
647 let reload = self.reload(cx).log_err().map(drop);
648 task = cx.foreground().spawn(reload);
649 }
650 }
651 }
652 } else {
653 file_changed = true;
654 };
655
656 if file_changed {
657 self.file_update_count += 1;
658 cx.emit(Event::FileHandleChanged);
659 cx.notify();
660 }
661 self.file = Some(new_file);
662 task
663 }
664
665 pub fn diff_base(&self) -> Option<&str> {
666 self.diff_base.as_deref()
667 }
668
669 pub fn set_diff_base(&mut self, diff_base: Option<String>, cx: &mut ModelContext<Self>) {
670 self.diff_base = diff_base;
671 self.git_diff_recalc(cx);
672 }
673
674 pub fn needs_git_diff_recalc(&self) -> bool {
675 self.git_diff_status.diff.needs_update(self)
676 }
677
678 pub fn git_diff_recalc(&mut self, cx: &mut ModelContext<Self>) {
679 if self.git_diff_status.update_in_progress {
680 self.git_diff_status.update_requested = true;
681 return;
682 }
683
684 if let Some(diff_base) = &self.diff_base {
685 let snapshot = self.snapshot();
686 let diff_base = diff_base.clone();
687
688 let mut diff = self.git_diff_status.diff.clone();
689 let diff = cx.background().spawn(async move {
690 diff.update(&diff_base, &snapshot).await;
691 diff
692 });
693
694 cx.spawn_weak(|this, mut cx| async move {
695 let buffer_diff = diff.await;
696 if let Some(this) = this.upgrade(&cx) {
697 this.update(&mut cx, |this, cx| {
698 this.git_diff_status.diff = buffer_diff;
699 this.git_diff_update_count += 1;
700 cx.notify();
701
702 this.git_diff_status.update_in_progress = false;
703 if this.git_diff_status.update_requested {
704 this.git_diff_recalc(cx);
705 }
706 })
707 }
708 })
709 .detach()
710 } else {
711 let snapshot = self.snapshot();
712 self.git_diff_status.diff.clear(&snapshot);
713 self.git_diff_update_count += 1;
714 cx.notify();
715 }
716 }
717
718 pub fn close(&mut self, cx: &mut ModelContext<Self>) {
719 cx.emit(Event::Closed);
720 }
721
722 pub fn language(&self) -> Option<&Arc<Language>> {
723 self.language.as_ref()
724 }
725
726 pub fn language_at<D: ToOffset>(&self, position: D) -> Option<Arc<Language>> {
727 let offset = position.to_offset(self);
728 self.syntax_map
729 .lock()
730 .layers_for_range(offset..offset, &self.text)
731 .last()
732 .map(|info| info.language.clone())
733 .or_else(|| self.language.clone())
734 }
735
736 pub fn parse_count(&self) -> usize {
737 self.parse_count
738 }
739
740 pub fn selections_update_count(&self) -> usize {
741 self.selections_update_count
742 }
743
744 pub fn diagnostics_update_count(&self) -> usize {
745 self.diagnostics_update_count
746 }
747
748 pub fn file_update_count(&self) -> usize {
749 self.file_update_count
750 }
751
752 pub fn git_diff_update_count(&self) -> usize {
753 self.git_diff_update_count
754 }
755
756 #[cfg(any(test, feature = "test-support"))]
757 pub fn is_parsing(&self) -> bool {
758 self.parsing_in_background
759 }
760
761 pub fn contains_unknown_injections(&self) -> bool {
762 self.syntax_map.lock().contains_unknown_injections()
763 }
764
765 #[cfg(test)]
766 pub fn set_sync_parse_timeout(&mut self, timeout: Duration) {
767 self.sync_parse_timeout = timeout;
768 }
769
770 /// Called after an edit to synchronize the buffer's main parse tree with
771 /// the buffer's new underlying state.
772 ///
773 /// Locks the syntax map and interpolates the edits since the last reparse
774 /// into the foreground syntax tree.
775 ///
776 /// Then takes a stable snapshot of the syntax map before unlocking it.
777 /// The snapshot with the interpolated edits is sent to a background thread,
778 /// where we ask Tree-sitter to perform an incremental parse.
779 ///
780 /// Meanwhile, in the foreground, we block the main thread for up to 1ms
781 /// waiting on the parse to complete. As soon as it completes, we proceed
782 /// synchronously, unless a 1ms timeout elapses.
783 ///
784 /// If we time out waiting on the parse, we spawn a second task waiting
785 /// until the parse does complete and return with the interpolated tree still
786 /// in the foreground. When the background parse completes, call back into
787 /// the main thread and assign the foreground parse state.
788 ///
789 /// If the buffer or grammar changed since the start of the background parse,
790 /// initiate an additional reparse recursively. To avoid concurrent parses
791 /// for the same buffer, we only initiate a new parse if we are not already
792 /// parsing in the background.
793 pub fn reparse(&mut self, cx: &mut ModelContext<Self>) {
794 if self.parsing_in_background {
795 return;
796 }
797 let language = if let Some(language) = self.language.clone() {
798 language
799 } else {
800 return;
801 };
802
803 let text = self.text_snapshot();
804 let parsed_version = self.version();
805
806 let mut syntax_map = self.syntax_map.lock();
807 syntax_map.interpolate(&text);
808 let language_registry = syntax_map.language_registry();
809 let mut syntax_snapshot = syntax_map.snapshot();
810 drop(syntax_map);
811
812 let parse_task = cx.background().spawn({
813 let language = language.clone();
814 let language_registry = language_registry.clone();
815 async move {
816 syntax_snapshot.reparse(&text, language_registry, language);
817 syntax_snapshot
818 }
819 });
820
821 match cx
822 .background()
823 .block_with_timeout(self.sync_parse_timeout, parse_task)
824 {
825 Ok(new_syntax_snapshot) => {
826 self.did_finish_parsing(new_syntax_snapshot, cx);
827 return;
828 }
829 Err(parse_task) => {
830 self.parsing_in_background = true;
831 cx.spawn(move |this, mut cx| async move {
832 let new_syntax_map = parse_task.await;
833 this.update(&mut cx, move |this, cx| {
834 let grammar_changed =
835 this.language.as_ref().map_or(true, |current_language| {
836 !Arc::ptr_eq(&language, current_language)
837 });
838 let language_registry_changed = new_syntax_map
839 .contains_unknown_injections()
840 && language_registry.map_or(false, |registry| {
841 registry.version() != new_syntax_map.language_registry_version()
842 });
843 let parse_again = language_registry_changed
844 || grammar_changed
845 || this.version.changed_since(&parsed_version);
846 this.did_finish_parsing(new_syntax_map, cx);
847 this.parsing_in_background = false;
848 if parse_again {
849 this.reparse(cx);
850 }
851 });
852 })
853 .detach();
854 }
855 }
856 }
857
858 fn did_finish_parsing(&mut self, syntax_snapshot: SyntaxSnapshot, cx: &mut ModelContext<Self>) {
859 self.parse_count += 1;
860 self.syntax_map.lock().did_parse(syntax_snapshot);
861 self.request_autoindent(cx);
862 cx.emit(Event::Reparsed);
863 cx.notify();
864 }
865
866 pub fn update_diagnostics(&mut self, diagnostics: DiagnosticSet, cx: &mut ModelContext<Self>) {
867 let lamport_timestamp = self.text.lamport_clock.tick();
868 let op = Operation::UpdateDiagnostics {
869 diagnostics: diagnostics.iter().cloned().collect(),
870 lamport_timestamp,
871 };
872 self.apply_diagnostic_update(diagnostics, lamport_timestamp, cx);
873 self.send_operation(op, cx);
874 }
875
876 fn request_autoindent(&mut self, cx: &mut ModelContext<Self>) {
877 if let Some(indent_sizes) = self.compute_autoindents() {
878 let indent_sizes = cx.background().spawn(indent_sizes);
879 match cx
880 .background()
881 .block_with_timeout(Duration::from_micros(500), indent_sizes)
882 {
883 Ok(indent_sizes) => self.apply_autoindents(indent_sizes, cx),
884 Err(indent_sizes) => {
885 self.pending_autoindent = Some(cx.spawn(|this, mut cx| async move {
886 let indent_sizes = indent_sizes.await;
887 this.update(&mut cx, |this, cx| {
888 this.apply_autoindents(indent_sizes, cx);
889 });
890 }));
891 }
892 }
893 } else {
894 self.autoindent_requests.clear();
895 }
896 }
897
898 fn compute_autoindents(&self) -> Option<impl Future<Output = BTreeMap<u32, IndentSize>>> {
899 let max_rows_between_yields = 100;
900 let snapshot = self.snapshot();
901 if snapshot.syntax.is_empty() || self.autoindent_requests.is_empty() {
902 return None;
903 }
904
905 let autoindent_requests = self.autoindent_requests.clone();
906 Some(async move {
907 let mut indent_sizes = BTreeMap::new();
908 for request in autoindent_requests {
909 // Resolve each edited range to its row in the current buffer and in the
910 // buffer before this batch of edits.
911 let mut row_ranges = Vec::new();
912 let mut old_to_new_rows = BTreeMap::new();
913 let mut language_indent_sizes_by_new_row = Vec::new();
914 for entry in &request.entries {
915 let position = entry.range.start;
916 let new_row = position.to_point(&snapshot).row;
917 let new_end_row = entry.range.end.to_point(&snapshot).row + 1;
918 language_indent_sizes_by_new_row.push((new_row, entry.indent_size));
919
920 if !entry.first_line_is_new {
921 let old_row = position.to_point(&request.before_edit).row;
922 old_to_new_rows.insert(old_row, new_row);
923 }
924 row_ranges.push((new_row..new_end_row, entry.original_indent_column));
925 }
926
927 // Build a map containing the suggested indentation for each of the edited lines
928 // with respect to the state of the buffer before these edits. This map is keyed
929 // by the rows for these lines in the current state of the buffer.
930 let mut old_suggestions = BTreeMap::<u32, (IndentSize, bool)>::default();
931 let old_edited_ranges =
932 contiguous_ranges(old_to_new_rows.keys().copied(), max_rows_between_yields);
933 let mut language_indent_sizes = language_indent_sizes_by_new_row.iter().peekable();
934 let mut language_indent_size = IndentSize::default();
935 for old_edited_range in old_edited_ranges {
936 let suggestions = request
937 .before_edit
938 .suggest_autoindents(old_edited_range.clone())
939 .into_iter()
940 .flatten();
941 for (old_row, suggestion) in old_edited_range.zip(suggestions) {
942 if let Some(suggestion) = suggestion {
943 let new_row = *old_to_new_rows.get(&old_row).unwrap();
944
945 // Find the indent size based on the language for this row.
946 while let Some((row, size)) = language_indent_sizes.peek() {
947 if *row > new_row {
948 break;
949 }
950 language_indent_size = *size;
951 language_indent_sizes.next();
952 }
953
954 let suggested_indent = old_to_new_rows
955 .get(&suggestion.basis_row)
956 .and_then(|from_row| {
957 Some(old_suggestions.get(from_row).copied()?.0)
958 })
959 .unwrap_or_else(|| {
960 request
961 .before_edit
962 .indent_size_for_line(suggestion.basis_row)
963 })
964 .with_delta(suggestion.delta, language_indent_size);
965 old_suggestions
966 .insert(new_row, (suggested_indent, suggestion.within_error));
967 }
968 }
969 yield_now().await;
970 }
971
972 // In block mode, only compute indentation suggestions for the first line
973 // of each insertion. Otherwise, compute suggestions for every inserted line.
974 let new_edited_row_ranges = contiguous_ranges(
975 row_ranges.iter().flat_map(|(range, _)| {
976 if request.is_block_mode {
977 range.start..range.start + 1
978 } else {
979 range.clone()
980 }
981 }),
982 max_rows_between_yields,
983 );
984
985 // Compute new suggestions for each line, but only include them in the result
986 // if they differ from the old suggestion for that line.
987 let mut language_indent_sizes = language_indent_sizes_by_new_row.iter().peekable();
988 let mut language_indent_size = IndentSize::default();
989 for new_edited_row_range in new_edited_row_ranges {
990 let suggestions = snapshot
991 .suggest_autoindents(new_edited_row_range.clone())
992 .into_iter()
993 .flatten();
994 for (new_row, suggestion) in new_edited_row_range.zip(suggestions) {
995 if let Some(suggestion) = suggestion {
996 // Find the indent size based on the language for this row.
997 while let Some((row, size)) = language_indent_sizes.peek() {
998 if *row > new_row {
999 break;
1000 }
1001 language_indent_size = *size;
1002 language_indent_sizes.next();
1003 }
1004
1005 let suggested_indent = indent_sizes
1006 .get(&suggestion.basis_row)
1007 .copied()
1008 .unwrap_or_else(|| {
1009 snapshot.indent_size_for_line(suggestion.basis_row)
1010 })
1011 .with_delta(suggestion.delta, language_indent_size);
1012 if old_suggestions.get(&new_row).map_or(
1013 true,
1014 |(old_indentation, was_within_error)| {
1015 suggested_indent != *old_indentation
1016 && (!suggestion.within_error || *was_within_error)
1017 },
1018 ) {
1019 indent_sizes.insert(new_row, suggested_indent);
1020 }
1021 }
1022 }
1023 yield_now().await;
1024 }
1025
1026 // For each block of inserted text, adjust the indentation of the remaining
1027 // lines of the block by the same amount as the first line was adjusted.
1028 if request.is_block_mode {
1029 for (row_range, original_indent_column) in
1030 row_ranges
1031 .into_iter()
1032 .filter_map(|(range, original_indent_column)| {
1033 if range.len() > 1 {
1034 Some((range, original_indent_column?))
1035 } else {
1036 None
1037 }
1038 })
1039 {
1040 let new_indent = indent_sizes
1041 .get(&row_range.start)
1042 .copied()
1043 .unwrap_or_else(|| snapshot.indent_size_for_line(row_range.start));
1044 let delta = new_indent.len as i64 - original_indent_column as i64;
1045 if delta != 0 {
1046 for row in row_range.skip(1) {
1047 indent_sizes.entry(row).or_insert_with(|| {
1048 let mut size = snapshot.indent_size_for_line(row);
1049 if size.kind == new_indent.kind {
1050 match delta.cmp(&0) {
1051 Ordering::Greater => size.len += delta as u32,
1052 Ordering::Less => {
1053 size.len = size.len.saturating_sub(-delta as u32)
1054 }
1055 Ordering::Equal => {}
1056 }
1057 }
1058 size
1059 });
1060 }
1061 }
1062 }
1063 }
1064 }
1065
1066 indent_sizes
1067 })
1068 }
1069
1070 fn apply_autoindents(
1071 &mut self,
1072 indent_sizes: BTreeMap<u32, IndentSize>,
1073 cx: &mut ModelContext<Self>,
1074 ) {
1075 self.autoindent_requests.clear();
1076
1077 let edits: Vec<_> = indent_sizes
1078 .into_iter()
1079 .filter_map(|(row, indent_size)| {
1080 let current_size = indent_size_for_line(self, row);
1081 Self::edit_for_indent_size_adjustment(row, current_size, indent_size)
1082 })
1083 .collect();
1084
1085 self.edit(edits, None, cx);
1086 }
1087
1088 // Create a minimal edit that will cause the the given row to be indented
1089 // with the given size. After applying this edit, the length of the line
1090 // will always be at least `new_size.len`.
1091 pub fn edit_for_indent_size_adjustment(
1092 row: u32,
1093 current_size: IndentSize,
1094 new_size: IndentSize,
1095 ) -> Option<(Range<Point>, String)> {
1096 if new_size.kind != current_size.kind {
1097 Some((
1098 Point::new(row, 0)..Point::new(row, current_size.len),
1099 iter::repeat(new_size.char())
1100 .take(new_size.len as usize)
1101 .collect::<String>(),
1102 ))
1103 } else {
1104 match new_size.len.cmp(¤t_size.len) {
1105 Ordering::Greater => {
1106 let point = Point::new(row, 0);
1107 Some((
1108 point..point,
1109 iter::repeat(new_size.char())
1110 .take((new_size.len - current_size.len) as usize)
1111 .collect::<String>(),
1112 ))
1113 }
1114
1115 Ordering::Less => Some((
1116 Point::new(row, 0)..Point::new(row, current_size.len - new_size.len),
1117 String::new(),
1118 )),
1119
1120 Ordering::Equal => None,
1121 }
1122 }
1123 }
1124
1125 pub fn diff(&self, mut new_text: String, cx: &AppContext) -> Task<Diff> {
1126 let old_text = self.as_rope().clone();
1127 let base_version = self.version();
1128 cx.background().spawn(async move {
1129 let old_text = old_text.to_string();
1130 let line_ending = LineEnding::detect(&new_text);
1131 LineEnding::normalize(&mut new_text);
1132 let diff = TextDiff::from_chars(old_text.as_str(), new_text.as_str());
1133 let mut edits = Vec::new();
1134 let mut offset = 0;
1135 let empty: Arc<str> = "".into();
1136 for change in diff.iter_all_changes() {
1137 let value = change.value();
1138 let end_offset = offset + value.len();
1139 match change.tag() {
1140 ChangeTag::Equal => {
1141 offset = end_offset;
1142 }
1143 ChangeTag::Delete => {
1144 edits.push((offset..end_offset, empty.clone()));
1145 offset = end_offset;
1146 }
1147 ChangeTag::Insert => {
1148 edits.push((offset..offset, value.into()));
1149 }
1150 }
1151 }
1152 Diff {
1153 base_version,
1154 line_ending,
1155 edits,
1156 }
1157 })
1158 }
1159
1160 /// Spawn a background task that searches the buffer for any whitespace
1161 /// at the ends of a lines, and returns a `Diff` that removes that whitespace.
1162 pub fn remove_trailing_whitespace(&self, cx: &AppContext) -> Task<Diff> {
1163 let old_text = self.as_rope().clone();
1164 let line_ending = self.line_ending();
1165 let base_version = self.version();
1166 cx.background().spawn(async move {
1167 let ranges = trailing_whitespace_ranges(&old_text);
1168 let empty = Arc::<str>::from("");
1169 Diff {
1170 base_version,
1171 line_ending,
1172 edits: ranges
1173 .into_iter()
1174 .map(|range| (range, empty.clone()))
1175 .collect(),
1176 }
1177 })
1178 }
1179
1180 /// Ensure that the buffer ends with a single newline character, and
1181 /// no other whitespace.
1182 pub fn ensure_final_newline(&mut self, cx: &mut ModelContext<Self>) {
1183 let len = self.len();
1184 let mut offset = len;
1185 for chunk in self.as_rope().reversed_chunks_in_range(0..len) {
1186 let non_whitespace_len = chunk
1187 .trim_end_matches(|c: char| c.is_ascii_whitespace())
1188 .len();
1189 offset -= chunk.len();
1190 offset += non_whitespace_len;
1191 if non_whitespace_len != 0 {
1192 if offset == len - 1 && chunk.get(non_whitespace_len..) == Some("\n") {
1193 return;
1194 }
1195 break;
1196 }
1197 }
1198 self.edit([(offset..len, "\n")], None, cx);
1199 }
1200
1201 /// Apply a diff to the buffer. If the buffer has changed since the given diff was
1202 /// calculated, then adjust the diff to account for those changes, and discard any
1203 /// parts of the diff that conflict with those changes.
1204 pub fn apply_diff(&mut self, diff: Diff, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
1205 // Check for any edits to the buffer that have occurred since this diff
1206 // was computed.
1207 let snapshot = self.snapshot();
1208 let mut edits_since = snapshot.edits_since::<usize>(&diff.base_version).peekable();
1209 let mut delta = 0;
1210 let adjusted_edits = diff.edits.into_iter().filter_map(|(range, new_text)| {
1211 while let Some(edit_since) = edits_since.peek() {
1212 // If the edit occurs after a diff hunk, then it does not
1213 // affect that hunk.
1214 if edit_since.old.start > range.end {
1215 break;
1216 }
1217 // If the edit precedes the diff hunk, then adjust the hunk
1218 // to reflect the edit.
1219 else if edit_since.old.end < range.start {
1220 delta += edit_since.new_len() as i64 - edit_since.old_len() as i64;
1221 edits_since.next();
1222 }
1223 // If the edit intersects a diff hunk, then discard that hunk.
1224 else {
1225 return None;
1226 }
1227 }
1228
1229 let start = (range.start as i64 + delta) as usize;
1230 let end = (range.end as i64 + delta) as usize;
1231 Some((start..end, new_text))
1232 });
1233
1234 self.start_transaction();
1235 self.text.set_line_ending(diff.line_ending);
1236 self.edit(adjusted_edits, None, cx);
1237 self.end_transaction(cx)
1238 }
1239
1240 pub fn is_dirty(&self) -> bool {
1241 self.saved_version_fingerprint != self.as_rope().fingerprint()
1242 || self.file.as_ref().map_or(false, |file| file.is_deleted())
1243 }
1244
1245 pub fn has_conflict(&self) -> bool {
1246 self.saved_version_fingerprint != self.as_rope().fingerprint()
1247 && self
1248 .file
1249 .as_ref()
1250 .map_or(false, |file| file.mtime() > self.saved_mtime)
1251 }
1252
1253 pub fn subscribe(&mut self) -> Subscription {
1254 self.text.subscribe()
1255 }
1256
1257 pub fn start_transaction(&mut self) -> Option<TransactionId> {
1258 self.start_transaction_at(Instant::now())
1259 }
1260
1261 pub fn start_transaction_at(&mut self, now: Instant) -> Option<TransactionId> {
1262 self.transaction_depth += 1;
1263 if self.was_dirty_before_starting_transaction.is_none() {
1264 self.was_dirty_before_starting_transaction = Some(self.is_dirty());
1265 }
1266 self.text.start_transaction_at(now)
1267 }
1268
1269 pub fn end_transaction(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
1270 self.end_transaction_at(Instant::now(), cx)
1271 }
1272
1273 pub fn end_transaction_at(
1274 &mut self,
1275 now: Instant,
1276 cx: &mut ModelContext<Self>,
1277 ) -> Option<TransactionId> {
1278 assert!(self.transaction_depth > 0);
1279 self.transaction_depth -= 1;
1280 let was_dirty = if self.transaction_depth == 0 {
1281 self.was_dirty_before_starting_transaction.take().unwrap()
1282 } else {
1283 false
1284 };
1285 if let Some((transaction_id, start_version)) = self.text.end_transaction_at(now) {
1286 self.did_edit(&start_version, was_dirty, cx);
1287 Some(transaction_id)
1288 } else {
1289 None
1290 }
1291 }
1292
1293 pub fn push_transaction(&mut self, transaction: Transaction, now: Instant) {
1294 self.text.push_transaction(transaction, now);
1295 }
1296
1297 pub fn finalize_last_transaction(&mut self) -> Option<&Transaction> {
1298 self.text.finalize_last_transaction()
1299 }
1300
1301 pub fn group_until_transaction(&mut self, transaction_id: TransactionId) {
1302 self.text.group_until_transaction(transaction_id);
1303 }
1304
1305 pub fn forget_transaction(&mut self, transaction_id: TransactionId) {
1306 self.text.forget_transaction(transaction_id);
1307 }
1308
1309 pub fn wait_for_edits(
1310 &mut self,
1311 edit_ids: impl IntoIterator<Item = clock::Local>,
1312 ) -> impl Future<Output = ()> {
1313 self.text.wait_for_edits(edit_ids)
1314 }
1315
1316 pub fn wait_for_anchors<'a>(
1317 &mut self,
1318 anchors: impl IntoIterator<Item = &'a Anchor>,
1319 ) -> impl Future<Output = ()> {
1320 self.text.wait_for_anchors(anchors)
1321 }
1322
1323 pub fn wait_for_version(&mut self, version: clock::Global) -> impl Future<Output = ()> {
1324 self.text.wait_for_version(version)
1325 }
1326
1327 pub fn set_active_selections(
1328 &mut self,
1329 selections: Arc<[Selection<Anchor>]>,
1330 line_mode: bool,
1331 cursor_shape: CursorShape,
1332 cx: &mut ModelContext<Self>,
1333 ) {
1334 let lamport_timestamp = self.text.lamport_clock.tick();
1335 self.remote_selections.insert(
1336 self.text.replica_id(),
1337 SelectionSet {
1338 selections: selections.clone(),
1339 lamport_timestamp,
1340 line_mode,
1341 cursor_shape,
1342 },
1343 );
1344 self.send_operation(
1345 Operation::UpdateSelections {
1346 selections,
1347 line_mode,
1348 lamport_timestamp,
1349 cursor_shape,
1350 },
1351 cx,
1352 );
1353 }
1354
1355 pub fn remove_active_selections(&mut self, cx: &mut ModelContext<Self>) {
1356 if self
1357 .remote_selections
1358 .get(&self.text.replica_id())
1359 .map_or(true, |set| !set.selections.is_empty())
1360 {
1361 self.set_active_selections(Arc::from([]), false, Default::default(), cx);
1362 }
1363 }
1364
1365 pub fn set_text<T>(&mut self, text: T, cx: &mut ModelContext<Self>) -> Option<clock::Local>
1366 where
1367 T: Into<Arc<str>>,
1368 {
1369 self.edit([(0..self.len(), text)], None, cx)
1370 }
1371
1372 pub fn edit<I, S, T>(
1373 &mut self,
1374 edits_iter: I,
1375 autoindent_mode: Option<AutoindentMode>,
1376 cx: &mut ModelContext<Self>,
1377 ) -> Option<clock::Local>
1378 where
1379 I: IntoIterator<Item = (Range<S>, T)>,
1380 S: ToOffset,
1381 T: Into<Arc<str>>,
1382 {
1383 // Skip invalid edits and coalesce contiguous ones.
1384 let mut edits: Vec<(Range<usize>, Arc<str>)> = Vec::new();
1385 for (range, new_text) in edits_iter {
1386 let mut range = range.start.to_offset(self)..range.end.to_offset(self);
1387 if range.start > range.end {
1388 mem::swap(&mut range.start, &mut range.end);
1389 }
1390 let new_text = new_text.into();
1391 if !new_text.is_empty() || !range.is_empty() {
1392 if let Some((prev_range, prev_text)) = edits.last_mut() {
1393 if prev_range.end >= range.start {
1394 prev_range.end = cmp::max(prev_range.end, range.end);
1395 *prev_text = format!("{prev_text}{new_text}").into();
1396 } else {
1397 edits.push((range, new_text));
1398 }
1399 } else {
1400 edits.push((range, new_text));
1401 }
1402 }
1403 }
1404 if edits.is_empty() {
1405 return None;
1406 }
1407
1408 self.start_transaction();
1409 self.pending_autoindent.take();
1410 let autoindent_request = autoindent_mode
1411 .and_then(|mode| self.language.as_ref().map(|_| (self.snapshot(), mode)));
1412
1413 let edit_operation = self.text.edit(edits.iter().cloned());
1414 let edit_id = edit_operation.local_timestamp();
1415
1416 if let Some((before_edit, mode)) = autoindent_request {
1417 let mut delta = 0isize;
1418 let entries = edits
1419 .into_iter()
1420 .enumerate()
1421 .zip(&edit_operation.as_edit().unwrap().new_text)
1422 .map(|((ix, (range, _)), new_text)| {
1423 let new_text_length = new_text.len();
1424 let old_start = range.start.to_point(&before_edit);
1425 let new_start = (delta + range.start as isize) as usize;
1426 delta += new_text_length as isize - (range.end as isize - range.start as isize);
1427
1428 let mut range_of_insertion_to_indent = 0..new_text_length;
1429 let mut first_line_is_new = false;
1430 let mut original_indent_column = None;
1431
1432 // When inserting an entire line at the beginning of an existing line,
1433 // treat the insertion as new.
1434 if new_text.contains('\n')
1435 && old_start.column <= before_edit.indent_size_for_line(old_start.row).len
1436 {
1437 first_line_is_new = true;
1438 }
1439
1440 // When inserting text starting with a newline, avoid auto-indenting the
1441 // previous line.
1442 if new_text.starts_with('\n') {
1443 range_of_insertion_to_indent.start += 1;
1444 first_line_is_new = true;
1445 }
1446
1447 // Avoid auto-indenting after the insertion.
1448 if let AutoindentMode::Block {
1449 original_indent_columns,
1450 } = &mode
1451 {
1452 original_indent_column =
1453 Some(original_indent_columns.get(ix).copied().unwrap_or_else(|| {
1454 indent_size_for_text(
1455 new_text[range_of_insertion_to_indent.clone()].chars(),
1456 )
1457 .len
1458 }));
1459 if new_text[range_of_insertion_to_indent.clone()].ends_with('\n') {
1460 range_of_insertion_to_indent.end -= 1;
1461 }
1462 }
1463
1464 AutoindentRequestEntry {
1465 first_line_is_new,
1466 original_indent_column,
1467 indent_size: before_edit.language_indent_size_at(range.start, cx),
1468 range: self.anchor_before(new_start + range_of_insertion_to_indent.start)
1469 ..self.anchor_after(new_start + range_of_insertion_to_indent.end),
1470 }
1471 })
1472 .collect();
1473
1474 self.autoindent_requests.push(Arc::new(AutoindentRequest {
1475 before_edit,
1476 entries,
1477 is_block_mode: matches!(mode, AutoindentMode::Block { .. }),
1478 }));
1479 }
1480
1481 self.end_transaction(cx);
1482 self.send_operation(Operation::Buffer(edit_operation), cx);
1483 Some(edit_id)
1484 }
1485
1486 fn did_edit(
1487 &mut self,
1488 old_version: &clock::Global,
1489 was_dirty: bool,
1490 cx: &mut ModelContext<Self>,
1491 ) {
1492 if self.edits_since::<usize>(old_version).next().is_none() {
1493 return;
1494 }
1495
1496 self.reparse(cx);
1497
1498 cx.emit(Event::Edited);
1499 if was_dirty != self.is_dirty() {
1500 cx.emit(Event::DirtyChanged);
1501 }
1502 cx.notify();
1503 }
1504
1505 pub fn apply_ops<I: IntoIterator<Item = Operation>>(
1506 &mut self,
1507 ops: I,
1508 cx: &mut ModelContext<Self>,
1509 ) -> Result<()> {
1510 self.pending_autoindent.take();
1511 let was_dirty = self.is_dirty();
1512 let old_version = self.version.clone();
1513 let mut deferred_ops = Vec::new();
1514 let buffer_ops = ops
1515 .into_iter()
1516 .filter_map(|op| match op {
1517 Operation::Buffer(op) => Some(op),
1518 _ => {
1519 if self.can_apply_op(&op) {
1520 self.apply_op(op, cx);
1521 } else {
1522 deferred_ops.push(op);
1523 }
1524 None
1525 }
1526 })
1527 .collect::<Vec<_>>();
1528 self.text.apply_ops(buffer_ops)?;
1529 self.deferred_ops.insert(deferred_ops);
1530 self.flush_deferred_ops(cx);
1531 self.did_edit(&old_version, was_dirty, cx);
1532 // Notify independently of whether the buffer was edited as the operations could include a
1533 // selection update.
1534 cx.notify();
1535 Ok(())
1536 }
1537
1538 fn flush_deferred_ops(&mut self, cx: &mut ModelContext<Self>) {
1539 let mut deferred_ops = Vec::new();
1540 for op in self.deferred_ops.drain().iter().cloned() {
1541 if self.can_apply_op(&op) {
1542 self.apply_op(op, cx);
1543 } else {
1544 deferred_ops.push(op);
1545 }
1546 }
1547 self.deferred_ops.insert(deferred_ops);
1548 }
1549
1550 fn can_apply_op(&self, operation: &Operation) -> bool {
1551 match operation {
1552 Operation::Buffer(_) => {
1553 unreachable!("buffer operations should never be applied at this layer")
1554 }
1555 Operation::UpdateDiagnostics {
1556 diagnostics: diagnostic_set,
1557 ..
1558 } => diagnostic_set.iter().all(|diagnostic| {
1559 self.text.can_resolve(&diagnostic.range.start)
1560 && self.text.can_resolve(&diagnostic.range.end)
1561 }),
1562 Operation::UpdateSelections { selections, .. } => selections
1563 .iter()
1564 .all(|s| self.can_resolve(&s.start) && self.can_resolve(&s.end)),
1565 Operation::UpdateCompletionTriggers { .. } => true,
1566 }
1567 }
1568
1569 fn apply_op(&mut self, operation: Operation, cx: &mut ModelContext<Self>) {
1570 match operation {
1571 Operation::Buffer(_) => {
1572 unreachable!("buffer operations should never be applied at this layer")
1573 }
1574 Operation::UpdateDiagnostics {
1575 diagnostics: diagnostic_set,
1576 lamport_timestamp,
1577 } => {
1578 let snapshot = self.snapshot();
1579 self.apply_diagnostic_update(
1580 DiagnosticSet::from_sorted_entries(diagnostic_set.iter().cloned(), &snapshot),
1581 lamport_timestamp,
1582 cx,
1583 );
1584 }
1585 Operation::UpdateSelections {
1586 selections,
1587 lamport_timestamp,
1588 line_mode,
1589 cursor_shape,
1590 } => {
1591 if let Some(set) = self.remote_selections.get(&lamport_timestamp.replica_id) {
1592 if set.lamport_timestamp > lamport_timestamp {
1593 return;
1594 }
1595 }
1596
1597 self.remote_selections.insert(
1598 lamport_timestamp.replica_id,
1599 SelectionSet {
1600 selections,
1601 lamport_timestamp,
1602 line_mode,
1603 cursor_shape,
1604 },
1605 );
1606 self.text.lamport_clock.observe(lamport_timestamp);
1607 self.selections_update_count += 1;
1608 }
1609 Operation::UpdateCompletionTriggers {
1610 triggers,
1611 lamport_timestamp,
1612 } => {
1613 self.completion_triggers = triggers;
1614 self.text.lamport_clock.observe(lamport_timestamp);
1615 }
1616 }
1617 }
1618
1619 fn apply_diagnostic_update(
1620 &mut self,
1621 diagnostics: DiagnosticSet,
1622 lamport_timestamp: clock::Lamport,
1623 cx: &mut ModelContext<Self>,
1624 ) {
1625 if lamport_timestamp > self.diagnostics_timestamp {
1626 self.diagnostics = diagnostics;
1627 self.diagnostics_timestamp = lamport_timestamp;
1628 self.diagnostics_update_count += 1;
1629 self.text.lamport_clock.observe(lamport_timestamp);
1630 cx.notify();
1631 cx.emit(Event::DiagnosticsUpdated);
1632 }
1633 }
1634
1635 fn send_operation(&mut self, operation: Operation, cx: &mut ModelContext<Self>) {
1636 cx.emit(Event::Operation(operation));
1637 }
1638
1639 pub fn remove_peer(&mut self, replica_id: ReplicaId, cx: &mut ModelContext<Self>) {
1640 self.remote_selections.remove(&replica_id);
1641 cx.notify();
1642 }
1643
1644 pub fn undo(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
1645 let was_dirty = self.is_dirty();
1646 let old_version = self.version.clone();
1647
1648 if let Some((transaction_id, operation)) = self.text.undo() {
1649 self.send_operation(Operation::Buffer(operation), cx);
1650 self.did_edit(&old_version, was_dirty, cx);
1651 Some(transaction_id)
1652 } else {
1653 None
1654 }
1655 }
1656
1657 pub fn undo_to_transaction(
1658 &mut self,
1659 transaction_id: TransactionId,
1660 cx: &mut ModelContext<Self>,
1661 ) -> bool {
1662 let was_dirty = self.is_dirty();
1663 let old_version = self.version.clone();
1664
1665 let operations = self.text.undo_to_transaction(transaction_id);
1666 let undone = !operations.is_empty();
1667 for operation in operations {
1668 self.send_operation(Operation::Buffer(operation), cx);
1669 }
1670 if undone {
1671 self.did_edit(&old_version, was_dirty, cx)
1672 }
1673 undone
1674 }
1675
1676 pub fn redo(&mut self, cx: &mut ModelContext<Self>) -> Option<TransactionId> {
1677 let was_dirty = self.is_dirty();
1678 let old_version = self.version.clone();
1679
1680 if let Some((transaction_id, operation)) = self.text.redo() {
1681 self.send_operation(Operation::Buffer(operation), cx);
1682 self.did_edit(&old_version, was_dirty, cx);
1683 Some(transaction_id)
1684 } else {
1685 None
1686 }
1687 }
1688
1689 pub fn redo_to_transaction(
1690 &mut self,
1691 transaction_id: TransactionId,
1692 cx: &mut ModelContext<Self>,
1693 ) -> bool {
1694 let was_dirty = self.is_dirty();
1695 let old_version = self.version.clone();
1696
1697 let operations = self.text.redo_to_transaction(transaction_id);
1698 let redone = !operations.is_empty();
1699 for operation in operations {
1700 self.send_operation(Operation::Buffer(operation), cx);
1701 }
1702 if redone {
1703 self.did_edit(&old_version, was_dirty, cx)
1704 }
1705 redone
1706 }
1707
1708 pub fn set_completion_triggers(&mut self, triggers: Vec<String>, cx: &mut ModelContext<Self>) {
1709 self.completion_triggers = triggers.clone();
1710 self.completion_triggers_timestamp = self.text.lamport_clock.tick();
1711 self.send_operation(
1712 Operation::UpdateCompletionTriggers {
1713 triggers,
1714 lamport_timestamp: self.completion_triggers_timestamp,
1715 },
1716 cx,
1717 );
1718 cx.notify();
1719 }
1720
1721 pub fn completion_triggers(&self) -> &[String] {
1722 &self.completion_triggers
1723 }
1724}
1725
1726#[cfg(any(test, feature = "test-support"))]
1727impl Buffer {
1728 pub fn edit_via_marked_text(
1729 &mut self,
1730 marked_string: &str,
1731 autoindent_mode: Option<AutoindentMode>,
1732 cx: &mut ModelContext<Self>,
1733 ) {
1734 let edits = self.edits_for_marked_text(marked_string);
1735 self.edit(edits, autoindent_mode, cx);
1736 }
1737
1738 pub fn set_group_interval(&mut self, group_interval: Duration) {
1739 self.text.set_group_interval(group_interval);
1740 }
1741
1742 pub fn randomly_edit<T>(
1743 &mut self,
1744 rng: &mut T,
1745 old_range_count: usize,
1746 cx: &mut ModelContext<Self>,
1747 ) where
1748 T: rand::Rng,
1749 {
1750 let mut edits: Vec<(Range<usize>, String)> = Vec::new();
1751 let mut last_end = None;
1752 for _ in 0..old_range_count {
1753 if last_end.map_or(false, |last_end| last_end >= self.len()) {
1754 break;
1755 }
1756
1757 let new_start = last_end.map_or(0, |last_end| last_end + 1);
1758 let mut range = self.random_byte_range(new_start, rng);
1759 if rng.gen_bool(0.2) {
1760 mem::swap(&mut range.start, &mut range.end);
1761 }
1762 last_end = Some(range.end);
1763
1764 let new_text_len = rng.gen_range(0..10);
1765 let new_text: String = RandomCharIter::new(&mut *rng).take(new_text_len).collect();
1766
1767 edits.push((range, new_text));
1768 }
1769 log::info!("mutating buffer {} with {:?}", self.replica_id(), edits);
1770 self.edit(edits, None, cx);
1771 }
1772
1773 pub fn randomly_undo_redo(&mut self, rng: &mut impl rand::Rng, cx: &mut ModelContext<Self>) {
1774 let was_dirty = self.is_dirty();
1775 let old_version = self.version.clone();
1776
1777 let ops = self.text.randomly_undo_redo(rng);
1778 if !ops.is_empty() {
1779 for op in ops {
1780 self.send_operation(Operation::Buffer(op), cx);
1781 self.did_edit(&old_version, was_dirty, cx);
1782 }
1783 }
1784 }
1785}
1786
1787impl Entity for Buffer {
1788 type Event = Event;
1789}
1790
1791impl Deref for Buffer {
1792 type Target = TextBuffer;
1793
1794 fn deref(&self) -> &Self::Target {
1795 &self.text
1796 }
1797}
1798
1799impl BufferSnapshot {
1800 pub fn indent_size_for_line(&self, row: u32) -> IndentSize {
1801 indent_size_for_line(self, row)
1802 }
1803
1804 pub fn language_indent_size_at<T: ToOffset>(&self, position: T, cx: &AppContext) -> IndentSize {
1805 let language_name = self.language_at(position).map(|language| language.name());
1806 let settings = cx.global::<Settings>();
1807 if settings.hard_tabs(language_name.as_deref()) {
1808 IndentSize::tab()
1809 } else {
1810 IndentSize::spaces(settings.tab_size(language_name.as_deref()).get())
1811 }
1812 }
1813
1814 pub fn suggested_indents(
1815 &self,
1816 rows: impl Iterator<Item = u32>,
1817 single_indent_size: IndentSize,
1818 ) -> BTreeMap<u32, IndentSize> {
1819 let mut result = BTreeMap::new();
1820
1821 for row_range in contiguous_ranges(rows, 10) {
1822 let suggestions = match self.suggest_autoindents(row_range.clone()) {
1823 Some(suggestions) => suggestions,
1824 _ => break,
1825 };
1826
1827 for (row, suggestion) in row_range.zip(suggestions) {
1828 let indent_size = if let Some(suggestion) = suggestion {
1829 result
1830 .get(&suggestion.basis_row)
1831 .copied()
1832 .unwrap_or_else(|| self.indent_size_for_line(suggestion.basis_row))
1833 .with_delta(suggestion.delta, single_indent_size)
1834 } else {
1835 self.indent_size_for_line(row)
1836 };
1837
1838 result.insert(row, indent_size);
1839 }
1840 }
1841
1842 result
1843 }
1844
1845 fn suggest_autoindents(
1846 &self,
1847 row_range: Range<u32>,
1848 ) -> Option<impl Iterator<Item = Option<IndentSuggestion>> + '_> {
1849 let config = &self.language.as_ref()?.config;
1850 let prev_non_blank_row = self.prev_non_blank_row(row_range.start);
1851
1852 // Find the suggested indentation ranges based on the syntax tree.
1853 let start = Point::new(prev_non_blank_row.unwrap_or(row_range.start), 0);
1854 let end = Point::new(row_range.end, 0);
1855 let range = (start..end).to_offset(&self.text);
1856 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
1857 Some(&grammar.indents_config.as_ref()?.query)
1858 });
1859 let indent_configs = matches
1860 .grammars()
1861 .iter()
1862 .map(|grammar| grammar.indents_config.as_ref().unwrap())
1863 .collect::<Vec<_>>();
1864
1865 let mut indent_ranges = Vec::<Range<Point>>::new();
1866 let mut outdent_positions = Vec::<Point>::new();
1867 while let Some(mat) = matches.peek() {
1868 let mut start: Option<Point> = None;
1869 let mut end: Option<Point> = None;
1870
1871 let config = &indent_configs[mat.grammar_index];
1872 for capture in mat.captures {
1873 if capture.index == config.indent_capture_ix {
1874 start.get_or_insert(Point::from_ts_point(capture.node.start_position()));
1875 end.get_or_insert(Point::from_ts_point(capture.node.end_position()));
1876 } else if Some(capture.index) == config.start_capture_ix {
1877 start = Some(Point::from_ts_point(capture.node.end_position()));
1878 } else if Some(capture.index) == config.end_capture_ix {
1879 end = Some(Point::from_ts_point(capture.node.start_position()));
1880 } else if Some(capture.index) == config.outdent_capture_ix {
1881 outdent_positions.push(Point::from_ts_point(capture.node.start_position()));
1882 }
1883 }
1884
1885 matches.advance();
1886 if let Some((start, end)) = start.zip(end) {
1887 if start.row == end.row {
1888 continue;
1889 }
1890
1891 let range = start..end;
1892 match indent_ranges.binary_search_by_key(&range.start, |r| r.start) {
1893 Err(ix) => indent_ranges.insert(ix, range),
1894 Ok(ix) => {
1895 let prev_range = &mut indent_ranges[ix];
1896 prev_range.end = prev_range.end.max(range.end);
1897 }
1898 }
1899 }
1900 }
1901
1902 let mut error_ranges = Vec::<Range<Point>>::new();
1903 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
1904 Some(&grammar.error_query)
1905 });
1906 while let Some(mat) = matches.peek() {
1907 let node = mat.captures[0].node;
1908 let start = Point::from_ts_point(node.start_position());
1909 let end = Point::from_ts_point(node.end_position());
1910 let range = start..end;
1911 let ix = match error_ranges.binary_search_by_key(&range.start, |r| r.start) {
1912 Ok(ix) | Err(ix) => ix,
1913 };
1914 let mut end_ix = ix;
1915 while let Some(existing_range) = error_ranges.get(end_ix) {
1916 if existing_range.end < end {
1917 end_ix += 1;
1918 } else {
1919 break;
1920 }
1921 }
1922 error_ranges.splice(ix..end_ix, [range]);
1923 matches.advance();
1924 }
1925
1926 outdent_positions.sort();
1927 for outdent_position in outdent_positions {
1928 // find the innermost indent range containing this outdent_position
1929 // set its end to the outdent position
1930 if let Some(range_to_truncate) = indent_ranges
1931 .iter_mut()
1932 .filter(|indent_range| indent_range.contains(&outdent_position))
1933 .last()
1934 {
1935 range_to_truncate.end = outdent_position;
1936 }
1937 }
1938
1939 // Find the suggested indentation increases and decreased based on regexes.
1940 let mut indent_change_rows = Vec::<(u32, Ordering)>::new();
1941 self.for_each_line(
1942 Point::new(prev_non_blank_row.unwrap_or(row_range.start), 0)
1943 ..Point::new(row_range.end, 0),
1944 |row, line| {
1945 if config
1946 .decrease_indent_pattern
1947 .as_ref()
1948 .map_or(false, |regex| regex.is_match(line))
1949 {
1950 indent_change_rows.push((row, Ordering::Less));
1951 }
1952 if config
1953 .increase_indent_pattern
1954 .as_ref()
1955 .map_or(false, |regex| regex.is_match(line))
1956 {
1957 indent_change_rows.push((row + 1, Ordering::Greater));
1958 }
1959 },
1960 );
1961
1962 let mut indent_changes = indent_change_rows.into_iter().peekable();
1963 let mut prev_row = if config.auto_indent_using_last_non_empty_line {
1964 prev_non_blank_row.unwrap_or(0)
1965 } else {
1966 row_range.start.saturating_sub(1)
1967 };
1968 let mut prev_row_start = Point::new(prev_row, self.indent_size_for_line(prev_row).len);
1969 Some(row_range.map(move |row| {
1970 let row_start = Point::new(row, self.indent_size_for_line(row).len);
1971
1972 let mut indent_from_prev_row = false;
1973 let mut outdent_from_prev_row = false;
1974 let mut outdent_to_row = u32::MAX;
1975
1976 while let Some((indent_row, delta)) = indent_changes.peek() {
1977 match indent_row.cmp(&row) {
1978 Ordering::Equal => match delta {
1979 Ordering::Less => outdent_from_prev_row = true,
1980 Ordering::Greater => indent_from_prev_row = true,
1981 _ => {}
1982 },
1983
1984 Ordering::Greater => break,
1985 Ordering::Less => {}
1986 }
1987
1988 indent_changes.next();
1989 }
1990
1991 for range in &indent_ranges {
1992 if range.start.row >= row {
1993 break;
1994 }
1995 if range.start.row == prev_row && range.end > row_start {
1996 indent_from_prev_row = true;
1997 }
1998 if range.end > prev_row_start && range.end <= row_start {
1999 outdent_to_row = outdent_to_row.min(range.start.row);
2000 }
2001 }
2002
2003 let within_error = error_ranges
2004 .iter()
2005 .any(|e| e.start.row < row && e.end > row_start);
2006
2007 let suggestion = if outdent_to_row == prev_row
2008 || (outdent_from_prev_row && indent_from_prev_row)
2009 {
2010 Some(IndentSuggestion {
2011 basis_row: prev_row,
2012 delta: Ordering::Equal,
2013 within_error,
2014 })
2015 } else if indent_from_prev_row {
2016 Some(IndentSuggestion {
2017 basis_row: prev_row,
2018 delta: Ordering::Greater,
2019 within_error,
2020 })
2021 } else if outdent_to_row < prev_row {
2022 Some(IndentSuggestion {
2023 basis_row: outdent_to_row,
2024 delta: Ordering::Equal,
2025 within_error,
2026 })
2027 } else if outdent_from_prev_row {
2028 Some(IndentSuggestion {
2029 basis_row: prev_row,
2030 delta: Ordering::Less,
2031 within_error,
2032 })
2033 } else if config.auto_indent_using_last_non_empty_line || !self.is_line_blank(prev_row)
2034 {
2035 Some(IndentSuggestion {
2036 basis_row: prev_row,
2037 delta: Ordering::Equal,
2038 within_error,
2039 })
2040 } else {
2041 None
2042 };
2043
2044 prev_row = row;
2045 prev_row_start = row_start;
2046 suggestion
2047 }))
2048 }
2049
2050 fn prev_non_blank_row(&self, mut row: u32) -> Option<u32> {
2051 while row > 0 {
2052 row -= 1;
2053 if !self.is_line_blank(row) {
2054 return Some(row);
2055 }
2056 }
2057 None
2058 }
2059
2060 pub fn chunks<T: ToOffset>(&self, range: Range<T>, language_aware: bool) -> BufferChunks {
2061 let range = range.start.to_offset(self)..range.end.to_offset(self);
2062
2063 let mut syntax = None;
2064 let mut diagnostic_endpoints = Vec::new();
2065 if language_aware {
2066 let captures = self.syntax.captures(range.clone(), &self.text, |grammar| {
2067 grammar.highlights_query.as_ref()
2068 });
2069 let highlight_maps = captures
2070 .grammars()
2071 .into_iter()
2072 .map(|grammar| grammar.highlight_map())
2073 .collect();
2074 syntax = Some((captures, highlight_maps));
2075 for entry in self.diagnostics_in_range::<_, usize>(range.clone(), false) {
2076 diagnostic_endpoints.push(DiagnosticEndpoint {
2077 offset: entry.range.start,
2078 is_start: true,
2079 severity: entry.diagnostic.severity,
2080 is_unnecessary: entry.diagnostic.is_unnecessary,
2081 });
2082 diagnostic_endpoints.push(DiagnosticEndpoint {
2083 offset: entry.range.end,
2084 is_start: false,
2085 severity: entry.diagnostic.severity,
2086 is_unnecessary: entry.diagnostic.is_unnecessary,
2087 });
2088 }
2089 diagnostic_endpoints
2090 .sort_unstable_by_key(|endpoint| (endpoint.offset, !endpoint.is_start));
2091 }
2092
2093 BufferChunks::new(self.text.as_rope(), range, syntax, diagnostic_endpoints)
2094 }
2095
2096 pub fn for_each_line(&self, range: Range<Point>, mut callback: impl FnMut(u32, &str)) {
2097 let mut line = String::new();
2098 let mut row = range.start.row;
2099 for chunk in self
2100 .as_rope()
2101 .chunks_in_range(range.to_offset(self))
2102 .chain(["\n"])
2103 {
2104 for (newline_ix, text) in chunk.split('\n').enumerate() {
2105 if newline_ix > 0 {
2106 callback(row, &line);
2107 row += 1;
2108 line.clear();
2109 }
2110 line.push_str(text);
2111 }
2112 }
2113 }
2114
2115 pub fn language_at<D: ToOffset>(&self, position: D) -> Option<&Arc<Language>> {
2116 let offset = position.to_offset(self);
2117 self.syntax
2118 .layers_for_range(offset..offset, &self.text)
2119 .filter(|l| l.node.end_byte() > offset)
2120 .last()
2121 .map(|info| info.language)
2122 .or(self.language.as_ref())
2123 }
2124
2125 pub fn language_scope_at<D: ToOffset>(&self, position: D) -> Option<LanguageScope> {
2126 let offset = position.to_offset(self);
2127
2128 if let Some(layer_info) = self
2129 .syntax
2130 .layers_for_range(offset..offset, &self.text)
2131 .filter(|l| l.node.end_byte() > offset)
2132 .last()
2133 {
2134 Some(LanguageScope {
2135 language: layer_info.language.clone(),
2136 override_id: layer_info.override_id(offset, &self.text),
2137 })
2138 } else {
2139 self.language.clone().map(|language| LanguageScope {
2140 language,
2141 override_id: None,
2142 })
2143 }
2144 }
2145
2146 pub fn surrounding_word<T: ToOffset>(&self, start: T) -> (Range<usize>, Option<CharKind>) {
2147 let mut start = start.to_offset(self);
2148 let mut end = start;
2149 let mut next_chars = self.chars_at(start).peekable();
2150 let mut prev_chars = self.reversed_chars_at(start).peekable();
2151 let word_kind = cmp::max(
2152 prev_chars.peek().copied().map(char_kind),
2153 next_chars.peek().copied().map(char_kind),
2154 );
2155
2156 for ch in prev_chars {
2157 if Some(char_kind(ch)) == word_kind && ch != '\n' {
2158 start -= ch.len_utf8();
2159 } else {
2160 break;
2161 }
2162 }
2163
2164 for ch in next_chars {
2165 if Some(char_kind(ch)) == word_kind && ch != '\n' {
2166 end += ch.len_utf8();
2167 } else {
2168 break;
2169 }
2170 }
2171
2172 (start..end, word_kind)
2173 }
2174
2175 pub fn range_for_syntax_ancestor<T: ToOffset>(&self, range: Range<T>) -> Option<Range<usize>> {
2176 let range = range.start.to_offset(self)..range.end.to_offset(self);
2177 let mut result: Option<Range<usize>> = None;
2178 'outer: for layer in self.syntax.layers_for_range(range.clone(), &self.text) {
2179 let mut cursor = layer.node.walk();
2180
2181 // Descend to the first leaf that touches the start of the range,
2182 // and if the range is non-empty, extends beyond the start.
2183 while cursor.goto_first_child_for_byte(range.start).is_some() {
2184 if !range.is_empty() && cursor.node().end_byte() == range.start {
2185 cursor.goto_next_sibling();
2186 }
2187 }
2188
2189 // Ascend to the smallest ancestor that strictly contains the range.
2190 loop {
2191 let node_range = cursor.node().byte_range();
2192 if node_range.start <= range.start
2193 && node_range.end >= range.end
2194 && node_range.len() > range.len()
2195 {
2196 break;
2197 }
2198 if !cursor.goto_parent() {
2199 continue 'outer;
2200 }
2201 }
2202
2203 let left_node = cursor.node();
2204 let mut layer_result = left_node.byte_range();
2205
2206 // For an empty range, try to find another node immediately to the right of the range.
2207 if left_node.end_byte() == range.start {
2208 let mut right_node = None;
2209 while !cursor.goto_next_sibling() {
2210 if !cursor.goto_parent() {
2211 break;
2212 }
2213 }
2214
2215 while cursor.node().start_byte() == range.start {
2216 right_node = Some(cursor.node());
2217 if !cursor.goto_first_child() {
2218 break;
2219 }
2220 }
2221
2222 // If there is a candidate node on both sides of the (empty) range, then
2223 // decide between the two by favoring a named node over an anonymous token.
2224 // If both nodes are the same in that regard, favor the right one.
2225 if let Some(right_node) = right_node {
2226 if right_node.is_named() || !left_node.is_named() {
2227 layer_result = right_node.byte_range();
2228 }
2229 }
2230 }
2231
2232 if let Some(previous_result) = &result {
2233 if previous_result.len() < layer_result.len() {
2234 continue;
2235 }
2236 }
2237 result = Some(layer_result);
2238 }
2239
2240 result
2241 }
2242
2243 pub fn outline(&self, theme: Option<&SyntaxTheme>) -> Option<Outline<Anchor>> {
2244 self.outline_items_containing(0..self.len(), theme)
2245 .map(Outline::new)
2246 }
2247
2248 pub fn symbols_containing<T: ToOffset>(
2249 &self,
2250 position: T,
2251 theme: Option<&SyntaxTheme>,
2252 ) -> Option<Vec<OutlineItem<Anchor>>> {
2253 let position = position.to_offset(self);
2254 let mut items = self.outline_items_containing(
2255 position.saturating_sub(1)..self.len().min(position + 1),
2256 theme,
2257 )?;
2258 let mut prev_depth = None;
2259 items.retain(|item| {
2260 let result = prev_depth.map_or(true, |prev_depth| item.depth > prev_depth);
2261 prev_depth = Some(item.depth);
2262 result
2263 });
2264 Some(items)
2265 }
2266
2267 fn outline_items_containing(
2268 &self,
2269 range: Range<usize>,
2270 theme: Option<&SyntaxTheme>,
2271 ) -> Option<Vec<OutlineItem<Anchor>>> {
2272 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
2273 grammar.outline_config.as_ref().map(|c| &c.query)
2274 });
2275 let configs = matches
2276 .grammars()
2277 .iter()
2278 .map(|g| g.outline_config.as_ref().unwrap())
2279 .collect::<Vec<_>>();
2280
2281 let mut stack = Vec::<Range<usize>>::new();
2282 let mut items = Vec::new();
2283 while let Some(mat) = matches.peek() {
2284 let config = &configs[mat.grammar_index];
2285 let item_node = mat.captures.iter().find_map(|cap| {
2286 if cap.index == config.item_capture_ix {
2287 Some(cap.node)
2288 } else {
2289 None
2290 }
2291 })?;
2292
2293 let item_range = item_node.byte_range();
2294 if item_range.end < range.start || item_range.start > range.end {
2295 matches.advance();
2296 continue;
2297 }
2298
2299 let mut buffer_ranges = Vec::new();
2300 for capture in mat.captures {
2301 let node_is_name;
2302 if capture.index == config.name_capture_ix {
2303 node_is_name = true;
2304 } else if Some(capture.index) == config.context_capture_ix {
2305 node_is_name = false;
2306 } else {
2307 continue;
2308 }
2309
2310 let mut range = capture.node.start_byte()..capture.node.end_byte();
2311 let start = capture.node.start_position();
2312 if capture.node.end_position().row > start.row {
2313 range.end =
2314 range.start + self.line_len(start.row as u32) as usize - start.column;
2315 }
2316
2317 buffer_ranges.push((range, node_is_name));
2318 }
2319
2320 if buffer_ranges.is_empty() {
2321 continue;
2322 }
2323
2324 let mut text = String::new();
2325 let mut highlight_ranges = Vec::new();
2326 let mut name_ranges = Vec::new();
2327 let mut chunks = self.chunks(
2328 buffer_ranges.first().unwrap().0.start..buffer_ranges.last().unwrap().0.end,
2329 true,
2330 );
2331 for (buffer_range, is_name) in buffer_ranges {
2332 if !text.is_empty() {
2333 text.push(' ');
2334 }
2335 if is_name {
2336 let mut start = text.len();
2337 let end = start + buffer_range.len();
2338
2339 // When multiple names are captured, then the matcheable text
2340 // includes the whitespace in between the names.
2341 if !name_ranges.is_empty() {
2342 start -= 1;
2343 }
2344
2345 name_ranges.push(start..end);
2346 }
2347
2348 let mut offset = buffer_range.start;
2349 chunks.seek(offset);
2350 for mut chunk in chunks.by_ref() {
2351 if chunk.text.len() > buffer_range.end - offset {
2352 chunk.text = &chunk.text[0..(buffer_range.end - offset)];
2353 offset = buffer_range.end;
2354 } else {
2355 offset += chunk.text.len();
2356 }
2357 let style = chunk
2358 .syntax_highlight_id
2359 .zip(theme)
2360 .and_then(|(highlight, theme)| highlight.style(theme));
2361 if let Some(style) = style {
2362 let start = text.len();
2363 let end = start + chunk.text.len();
2364 highlight_ranges.push((start..end, style));
2365 }
2366 text.push_str(chunk.text);
2367 if offset >= buffer_range.end {
2368 break;
2369 }
2370 }
2371 }
2372
2373 matches.advance();
2374 while stack.last().map_or(false, |prev_range| {
2375 prev_range.start > item_range.start || prev_range.end < item_range.end
2376 }) {
2377 stack.pop();
2378 }
2379 stack.push(item_range.clone());
2380
2381 items.push(OutlineItem {
2382 depth: stack.len() - 1,
2383 range: self.anchor_after(item_range.start)..self.anchor_before(item_range.end),
2384 text,
2385 highlight_ranges,
2386 name_ranges,
2387 })
2388 }
2389 Some(items)
2390 }
2391
2392 /// Returns bracket range pairs overlapping or adjacent to `range`
2393 pub fn bracket_ranges<'a, T: ToOffset>(
2394 &'a self,
2395 range: Range<T>,
2396 ) -> impl Iterator<Item = (Range<usize>, Range<usize>)> + 'a {
2397 // Find bracket pairs that *inclusively* contain the given range.
2398 let range = range.start.to_offset(self).saturating_sub(1)
2399 ..self.len().min(range.end.to_offset(self) + 1);
2400
2401 let mut matches = self.syntax.matches(range.clone(), &self.text, |grammar| {
2402 grammar.brackets_config.as_ref().map(|c| &c.query)
2403 });
2404 let configs = matches
2405 .grammars()
2406 .iter()
2407 .map(|grammar| grammar.brackets_config.as_ref().unwrap())
2408 .collect::<Vec<_>>();
2409
2410 iter::from_fn(move || {
2411 while let Some(mat) = matches.peek() {
2412 let mut open = None;
2413 let mut close = None;
2414 let config = &configs[mat.grammar_index];
2415 for capture in mat.captures {
2416 if capture.index == config.open_capture_ix {
2417 open = Some(capture.node.byte_range());
2418 } else if capture.index == config.close_capture_ix {
2419 close = Some(capture.node.byte_range());
2420 }
2421 }
2422
2423 matches.advance();
2424
2425 let Some((open, close)) = open.zip(close) else { continue };
2426
2427 let bracket_range = open.start..=close.end;
2428 if !bracket_range.overlaps(&range) {
2429 continue;
2430 }
2431
2432 return Some((open, close));
2433 }
2434 None
2435 })
2436 }
2437
2438 #[allow(clippy::type_complexity)]
2439 pub fn remote_selections_in_range(
2440 &self,
2441 range: Range<Anchor>,
2442 ) -> impl Iterator<
2443 Item = (
2444 ReplicaId,
2445 bool,
2446 CursorShape,
2447 impl Iterator<Item = &Selection<Anchor>> + '_,
2448 ),
2449 > + '_ {
2450 self.remote_selections
2451 .iter()
2452 .filter(|(replica_id, set)| {
2453 **replica_id != self.text.replica_id() && !set.selections.is_empty()
2454 })
2455 .map(move |(replica_id, set)| {
2456 let start_ix = match set.selections.binary_search_by(|probe| {
2457 probe.end.cmp(&range.start, self).then(Ordering::Greater)
2458 }) {
2459 Ok(ix) | Err(ix) => ix,
2460 };
2461 let end_ix = match set.selections.binary_search_by(|probe| {
2462 probe.start.cmp(&range.end, self).then(Ordering::Less)
2463 }) {
2464 Ok(ix) | Err(ix) => ix,
2465 };
2466
2467 (
2468 *replica_id,
2469 set.line_mode,
2470 set.cursor_shape,
2471 set.selections[start_ix..end_ix].iter(),
2472 )
2473 })
2474 }
2475
2476 pub fn git_diff_hunks_in_row_range<'a>(
2477 &'a self,
2478 range: Range<u32>,
2479 reversed: bool,
2480 ) -> impl 'a + Iterator<Item = git::diff::DiffHunk<u32>> {
2481 self.git_diff.hunks_in_row_range(range, self, reversed)
2482 }
2483
2484 pub fn git_diff_hunks_intersecting_range<'a>(
2485 &'a self,
2486 range: Range<Anchor>,
2487 reversed: bool,
2488 ) -> impl 'a + Iterator<Item = git::diff::DiffHunk<u32>> {
2489 self.git_diff
2490 .hunks_intersecting_range(range, self, reversed)
2491 }
2492
2493 pub fn diagnostics_in_range<'a, T, O>(
2494 &'a self,
2495 search_range: Range<T>,
2496 reversed: bool,
2497 ) -> impl 'a + Iterator<Item = DiagnosticEntry<O>>
2498 where
2499 T: 'a + Clone + ToOffset,
2500 O: 'a + FromAnchor,
2501 {
2502 self.diagnostics.range(search_range, self, true, reversed)
2503 }
2504
2505 pub fn diagnostic_groups(&self) -> Vec<DiagnosticGroup<Anchor>> {
2506 let mut groups = Vec::new();
2507 self.diagnostics.groups(&mut groups, self);
2508 groups
2509 }
2510
2511 pub fn diagnostic_group<'a, O>(
2512 &'a self,
2513 group_id: usize,
2514 ) -> impl 'a + Iterator<Item = DiagnosticEntry<O>>
2515 where
2516 O: 'a + FromAnchor,
2517 {
2518 self.diagnostics.group(group_id, self)
2519 }
2520
2521 pub fn diagnostics_update_count(&self) -> usize {
2522 self.diagnostics_update_count
2523 }
2524
2525 pub fn parse_count(&self) -> usize {
2526 self.parse_count
2527 }
2528
2529 pub fn selections_update_count(&self) -> usize {
2530 self.selections_update_count
2531 }
2532
2533 pub fn file(&self) -> Option<&Arc<dyn File>> {
2534 self.file.as_ref()
2535 }
2536
2537 pub fn resolve_file_path(&self, cx: &AppContext, include_root: bool) -> Option<PathBuf> {
2538 if let Some(file) = self.file() {
2539 if file.path().file_name().is_none() || include_root {
2540 Some(file.full_path(cx))
2541 } else {
2542 Some(file.path().to_path_buf())
2543 }
2544 } else {
2545 None
2546 }
2547 }
2548
2549 pub fn file_update_count(&self) -> usize {
2550 self.file_update_count
2551 }
2552
2553 pub fn git_diff_update_count(&self) -> usize {
2554 self.git_diff_update_count
2555 }
2556}
2557
2558fn indent_size_for_line(text: &text::BufferSnapshot, row: u32) -> IndentSize {
2559 indent_size_for_text(text.chars_at(Point::new(row, 0)))
2560}
2561
2562pub fn indent_size_for_text(text: impl Iterator<Item = char>) -> IndentSize {
2563 let mut result = IndentSize::spaces(0);
2564 for c in text {
2565 let kind = match c {
2566 ' ' => IndentKind::Space,
2567 '\t' => IndentKind::Tab,
2568 _ => break,
2569 };
2570 if result.len == 0 {
2571 result.kind = kind;
2572 }
2573 result.len += 1;
2574 }
2575 result
2576}
2577
2578impl Clone for BufferSnapshot {
2579 fn clone(&self) -> Self {
2580 Self {
2581 text: self.text.clone(),
2582 git_diff: self.git_diff.clone(),
2583 syntax: self.syntax.clone(),
2584 file: self.file.clone(),
2585 remote_selections: self.remote_selections.clone(),
2586 diagnostics: self.diagnostics.clone(),
2587 selections_update_count: self.selections_update_count,
2588 diagnostics_update_count: self.diagnostics_update_count,
2589 file_update_count: self.file_update_count,
2590 git_diff_update_count: self.git_diff_update_count,
2591 language: self.language.clone(),
2592 parse_count: self.parse_count,
2593 }
2594 }
2595}
2596
2597impl Deref for BufferSnapshot {
2598 type Target = text::BufferSnapshot;
2599
2600 fn deref(&self) -> &Self::Target {
2601 &self.text
2602 }
2603}
2604
2605unsafe impl<'a> Send for BufferChunks<'a> {}
2606
2607impl<'a> BufferChunks<'a> {
2608 pub(crate) fn new(
2609 text: &'a Rope,
2610 range: Range<usize>,
2611 syntax: Option<(SyntaxMapCaptures<'a>, Vec<HighlightMap>)>,
2612 diagnostic_endpoints: Vec<DiagnosticEndpoint>,
2613 ) -> Self {
2614 let mut highlights = None;
2615 if let Some((captures, highlight_maps)) = syntax {
2616 highlights = Some(BufferChunkHighlights {
2617 captures,
2618 next_capture: None,
2619 stack: Default::default(),
2620 highlight_maps,
2621 })
2622 }
2623
2624 let diagnostic_endpoints = diagnostic_endpoints.into_iter().peekable();
2625 let chunks = text.chunks_in_range(range.clone());
2626
2627 BufferChunks {
2628 range,
2629 chunks,
2630 diagnostic_endpoints,
2631 error_depth: 0,
2632 warning_depth: 0,
2633 information_depth: 0,
2634 hint_depth: 0,
2635 unnecessary_depth: 0,
2636 highlights,
2637 }
2638 }
2639
2640 pub fn seek(&mut self, offset: usize) {
2641 self.range.start = offset;
2642 self.chunks.seek(self.range.start);
2643 if let Some(highlights) = self.highlights.as_mut() {
2644 highlights
2645 .stack
2646 .retain(|(end_offset, _)| *end_offset > offset);
2647 if let Some(capture) = &highlights.next_capture {
2648 if offset >= capture.node.start_byte() {
2649 let next_capture_end = capture.node.end_byte();
2650 if offset < next_capture_end {
2651 highlights.stack.push((
2652 next_capture_end,
2653 highlights.highlight_maps[capture.grammar_index].get(capture.index),
2654 ));
2655 }
2656 highlights.next_capture.take();
2657 }
2658 }
2659 highlights.captures.set_byte_range(self.range.clone());
2660 }
2661 }
2662
2663 pub fn offset(&self) -> usize {
2664 self.range.start
2665 }
2666
2667 fn update_diagnostic_depths(&mut self, endpoint: DiagnosticEndpoint) {
2668 let depth = match endpoint.severity {
2669 DiagnosticSeverity::ERROR => &mut self.error_depth,
2670 DiagnosticSeverity::WARNING => &mut self.warning_depth,
2671 DiagnosticSeverity::INFORMATION => &mut self.information_depth,
2672 DiagnosticSeverity::HINT => &mut self.hint_depth,
2673 _ => return,
2674 };
2675 if endpoint.is_start {
2676 *depth += 1;
2677 } else {
2678 *depth -= 1;
2679 }
2680
2681 if endpoint.is_unnecessary {
2682 if endpoint.is_start {
2683 self.unnecessary_depth += 1;
2684 } else {
2685 self.unnecessary_depth -= 1;
2686 }
2687 }
2688 }
2689
2690 fn current_diagnostic_severity(&self) -> Option<DiagnosticSeverity> {
2691 if self.error_depth > 0 {
2692 Some(DiagnosticSeverity::ERROR)
2693 } else if self.warning_depth > 0 {
2694 Some(DiagnosticSeverity::WARNING)
2695 } else if self.information_depth > 0 {
2696 Some(DiagnosticSeverity::INFORMATION)
2697 } else if self.hint_depth > 0 {
2698 Some(DiagnosticSeverity::HINT)
2699 } else {
2700 None
2701 }
2702 }
2703
2704 fn current_code_is_unnecessary(&self) -> bool {
2705 self.unnecessary_depth > 0
2706 }
2707}
2708
2709impl<'a> Iterator for BufferChunks<'a> {
2710 type Item = Chunk<'a>;
2711
2712 fn next(&mut self) -> Option<Self::Item> {
2713 let mut next_capture_start = usize::MAX;
2714 let mut next_diagnostic_endpoint = usize::MAX;
2715
2716 if let Some(highlights) = self.highlights.as_mut() {
2717 while let Some((parent_capture_end, _)) = highlights.stack.last() {
2718 if *parent_capture_end <= self.range.start {
2719 highlights.stack.pop();
2720 } else {
2721 break;
2722 }
2723 }
2724
2725 if highlights.next_capture.is_none() {
2726 highlights.next_capture = highlights.captures.next();
2727 }
2728
2729 while let Some(capture) = highlights.next_capture.as_ref() {
2730 if self.range.start < capture.node.start_byte() {
2731 next_capture_start = capture.node.start_byte();
2732 break;
2733 } else {
2734 let highlight_id =
2735 highlights.highlight_maps[capture.grammar_index].get(capture.index);
2736 highlights
2737 .stack
2738 .push((capture.node.end_byte(), highlight_id));
2739 highlights.next_capture = highlights.captures.next();
2740 }
2741 }
2742 }
2743
2744 while let Some(endpoint) = self.diagnostic_endpoints.peek().copied() {
2745 if endpoint.offset <= self.range.start {
2746 self.update_diagnostic_depths(endpoint);
2747 self.diagnostic_endpoints.next();
2748 } else {
2749 next_diagnostic_endpoint = endpoint.offset;
2750 break;
2751 }
2752 }
2753
2754 if let Some(chunk) = self.chunks.peek() {
2755 let chunk_start = self.range.start;
2756 let mut chunk_end = (self.chunks.offset() + chunk.len())
2757 .min(next_capture_start)
2758 .min(next_diagnostic_endpoint);
2759 let mut highlight_id = None;
2760 if let Some(highlights) = self.highlights.as_ref() {
2761 if let Some((parent_capture_end, parent_highlight_id)) = highlights.stack.last() {
2762 chunk_end = chunk_end.min(*parent_capture_end);
2763 highlight_id = Some(*parent_highlight_id);
2764 }
2765 }
2766
2767 let slice =
2768 &chunk[chunk_start - self.chunks.offset()..chunk_end - self.chunks.offset()];
2769 self.range.start = chunk_end;
2770 if self.range.start == self.chunks.offset() + chunk.len() {
2771 self.chunks.next().unwrap();
2772 }
2773
2774 Some(Chunk {
2775 text: slice,
2776 syntax_highlight_id: highlight_id,
2777 highlight_style: None,
2778 diagnostic_severity: self.current_diagnostic_severity(),
2779 is_unnecessary: self.current_code_is_unnecessary(),
2780 })
2781 } else {
2782 None
2783 }
2784 }
2785}
2786
2787impl operation_queue::Operation for Operation {
2788 fn lamport_timestamp(&self) -> clock::Lamport {
2789 match self {
2790 Operation::Buffer(_) => {
2791 unreachable!("buffer operations should never be deferred at this layer")
2792 }
2793 Operation::UpdateDiagnostics {
2794 lamport_timestamp, ..
2795 }
2796 | Operation::UpdateSelections {
2797 lamport_timestamp, ..
2798 }
2799 | Operation::UpdateCompletionTriggers {
2800 lamport_timestamp, ..
2801 } => *lamport_timestamp,
2802 }
2803 }
2804}
2805
2806impl Default for Diagnostic {
2807 fn default() -> Self {
2808 Self {
2809 code: None,
2810 severity: DiagnosticSeverity::ERROR,
2811 message: Default::default(),
2812 group_id: 0,
2813 is_primary: false,
2814 is_valid: true,
2815 is_disk_based: false,
2816 is_unnecessary: false,
2817 }
2818 }
2819}
2820
2821impl IndentSize {
2822 pub fn spaces(len: u32) -> Self {
2823 Self {
2824 len,
2825 kind: IndentKind::Space,
2826 }
2827 }
2828
2829 pub fn tab() -> Self {
2830 Self {
2831 len: 1,
2832 kind: IndentKind::Tab,
2833 }
2834 }
2835
2836 pub fn chars(&self) -> impl Iterator<Item = char> {
2837 iter::repeat(self.char()).take(self.len as usize)
2838 }
2839
2840 pub fn char(&self) -> char {
2841 match self.kind {
2842 IndentKind::Space => ' ',
2843 IndentKind::Tab => '\t',
2844 }
2845 }
2846
2847 pub fn with_delta(mut self, direction: Ordering, size: IndentSize) -> Self {
2848 match direction {
2849 Ordering::Less => {
2850 if self.kind == size.kind && self.len >= size.len {
2851 self.len -= size.len;
2852 }
2853 }
2854 Ordering::Equal => {}
2855 Ordering::Greater => {
2856 if self.len == 0 {
2857 self = size;
2858 } else if self.kind == size.kind {
2859 self.len += size.len;
2860 }
2861 }
2862 }
2863 self
2864 }
2865}
2866
2867impl Completion {
2868 pub fn sort_key(&self) -> (usize, &str) {
2869 let kind_key = match self.lsp_completion.kind {
2870 Some(lsp::CompletionItemKind::VARIABLE) => 0,
2871 _ => 1,
2872 };
2873 (kind_key, &self.label.text[self.label.filter_range.clone()])
2874 }
2875
2876 pub fn is_snippet(&self) -> bool {
2877 self.lsp_completion.insert_text_format == Some(lsp::InsertTextFormat::SNIPPET)
2878 }
2879}
2880
2881pub fn contiguous_ranges(
2882 values: impl Iterator<Item = u32>,
2883 max_len: usize,
2884) -> impl Iterator<Item = Range<u32>> {
2885 let mut values = values;
2886 let mut current_range: Option<Range<u32>> = None;
2887 std::iter::from_fn(move || loop {
2888 if let Some(value) = values.next() {
2889 if let Some(range) = &mut current_range {
2890 if value == range.end && range.len() < max_len {
2891 range.end += 1;
2892 continue;
2893 }
2894 }
2895
2896 let prev_range = current_range.clone();
2897 current_range = Some(value..(value + 1));
2898 if prev_range.is_some() {
2899 return prev_range;
2900 }
2901 } else {
2902 return current_range.take();
2903 }
2904 })
2905}
2906
2907pub fn char_kind(c: char) -> CharKind {
2908 if c.is_whitespace() {
2909 CharKind::Whitespace
2910 } else if c.is_alphanumeric() || c == '_' {
2911 CharKind::Word
2912 } else {
2913 CharKind::Punctuation
2914 }
2915}
2916
2917/// Find all of the ranges of whitespace that occur at the ends of lines
2918/// in the given rope.
2919///
2920/// This could also be done with a regex search, but this implementation
2921/// avoids copying text.
2922pub fn trailing_whitespace_ranges(rope: &Rope) -> Vec<Range<usize>> {
2923 let mut ranges = Vec::new();
2924
2925 let mut offset = 0;
2926 let mut prev_chunk_trailing_whitespace_range = 0..0;
2927 for chunk in rope.chunks() {
2928 let mut prev_line_trailing_whitespace_range = 0..0;
2929 for (i, line) in chunk.split('\n').enumerate() {
2930 let line_end_offset = offset + line.len();
2931 let trimmed_line_len = line.trim_end_matches(|c| matches!(c, ' ' | '\t')).len();
2932 let mut trailing_whitespace_range = (offset + trimmed_line_len)..line_end_offset;
2933
2934 if i == 0 && trimmed_line_len == 0 {
2935 trailing_whitespace_range.start = prev_chunk_trailing_whitespace_range.start;
2936 }
2937 if !prev_line_trailing_whitespace_range.is_empty() {
2938 ranges.push(prev_line_trailing_whitespace_range);
2939 }
2940
2941 offset = line_end_offset + 1;
2942 prev_line_trailing_whitespace_range = trailing_whitespace_range;
2943 }
2944
2945 offset -= 1;
2946 prev_chunk_trailing_whitespace_range = prev_line_trailing_whitespace_range;
2947 }
2948
2949 if !prev_chunk_trailing_whitespace_range.is_empty() {
2950 ranges.push(prev_chunk_trailing_whitespace_range);
2951 }
2952
2953 ranges
2954}