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