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