1mod highlight_map;
2mod language;
3#[cfg(test)]
4mod tests;
5
6pub use self::{
7 highlight_map::{HighlightId, HighlightMap},
8 language::{BracketPair, Language, LanguageConfig, LanguageRegistry},
9};
10use anyhow::{anyhow, Result};
11pub use buffer::{Buffer as TextBuffer, *};
12use clock::ReplicaId;
13use futures::FutureExt as _;
14use gpui::{AppContext, Entity, ModelContext, MutableAppContext, Task};
15use lazy_static::lazy_static;
16use lsp::LanguageServer;
17use parking_lot::Mutex;
18use postage::{prelude::Stream, sink::Sink, watch};
19use rpc::proto;
20use similar::{ChangeTag, TextDiff};
21use smol::future::yield_now;
22use std::{
23 any::Any,
24 cell::RefCell,
25 cmp,
26 collections::{BTreeMap, HashMap, HashSet},
27 ffi::OsString,
28 future::Future,
29 iter::{Iterator, Peekable},
30 ops::{Deref, DerefMut, Range},
31 path::{Path, PathBuf},
32 str,
33 sync::Arc,
34 time::{Duration, Instant, SystemTime, UNIX_EPOCH},
35 vec,
36};
37use tree_sitter::{InputEdit, Parser, QueryCursor, Tree};
38use util::{post_inc, TryFutureExt as _};
39
40pub use lsp::DiagnosticSeverity;
41
42thread_local! {
43 static PARSER: RefCell<Parser> = RefCell::new(Parser::new());
44}
45
46lazy_static! {
47 static ref QUERY_CURSORS: Mutex<Vec<QueryCursor>> = Default::default();
48}
49
50// TODO - Make this configurable
51const INDENT_SIZE: u32 = 4;
52
53pub struct Buffer {
54 text: TextBuffer,
55 file: Option<Box<dyn File>>,
56 saved_version: clock::Global,
57 saved_mtime: SystemTime,
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: AnchorRangeMultimap<(DiagnosticSeverity, String)>,
66 diagnostics_update_count: usize,
67 language_server: Option<LanguageServerState>,
68 #[cfg(test)]
69 operations: Vec<Operation>,
70}
71
72pub struct Snapshot {
73 text: buffer::Snapshot,
74 tree: Option<Tree>,
75 diagnostics: AnchorRangeMultimap<(DiagnosticSeverity, String)>,
76 is_parsing: bool,
77 language: Option<Arc<Language>>,
78 query_cursor: QueryCursorHandle,
79}
80
81#[derive(Debug, PartialEq, Eq)]
82pub struct Diagnostic {
83 pub range: Range<Point>,
84 pub severity: DiagnosticSeverity,
85 pub message: String,
86}
87
88struct LanguageServerState {
89 server: Arc<LanguageServer>,
90 latest_snapshot: watch::Sender<Option<LanguageServerSnapshot>>,
91 pending_snapshots: BTreeMap<usize, LanguageServerSnapshot>,
92 next_version: usize,
93 _maintain_server: Task<Option<()>>,
94}
95
96#[derive(Clone)]
97struct LanguageServerSnapshot {
98 buffer_snapshot: buffer::Snapshot,
99 version: usize,
100 path: Arc<Path>,
101}
102
103#[derive(Clone, Debug, Eq, PartialEq)]
104pub enum Event {
105 Edited,
106 Dirtied,
107 Saved,
108 FileHandleChanged,
109 Reloaded,
110 Reparsed,
111 Closed,
112}
113
114pub trait File {
115 fn worktree_id(&self) -> usize;
116
117 fn entry_id(&self) -> Option<usize>;
118
119 fn mtime(&self) -> SystemTime;
120
121 /// Returns the path of this file relative to the worktree's root directory.
122 fn path(&self) -> &Arc<Path>;
123
124 /// Returns the absolute path of this file.
125 fn abs_path(&self, cx: &AppContext) -> Option<PathBuf>;
126
127 /// Returns the path of this file relative to the worktree's parent directory (this means it
128 /// includes the name of the worktree's root folder).
129 fn full_path(&self, cx: &AppContext) -> PathBuf;
130
131 /// Returns the last component of this handle's absolute path. If this handle refers to the root
132 /// of its worktree, then this method will return the name of the worktree itself.
133 fn file_name<'a>(&'a self, cx: &'a AppContext) -> Option<OsString>;
134
135 fn is_deleted(&self) -> bool;
136
137 fn save(
138 &self,
139 buffer_id: u64,
140 text: Rope,
141 version: clock::Global,
142 cx: &mut MutableAppContext,
143 ) -> Task<Result<(clock::Global, SystemTime)>>;
144
145 fn load_local(&self, cx: &AppContext) -> Option<Task<Result<String>>>;
146
147 fn buffer_updated(&self, buffer_id: u64, operation: Operation, cx: &mut MutableAppContext);
148
149 fn buffer_removed(&self, buffer_id: u64, cx: &mut MutableAppContext);
150
151 fn boxed_clone(&self) -> Box<dyn File>;
152
153 fn as_any(&self) -> &dyn Any;
154}
155
156struct QueryCursorHandle(Option<QueryCursor>);
157
158#[derive(Clone)]
159struct SyntaxTree {
160 tree: Tree,
161 version: clock::Global,
162}
163
164#[derive(Clone)]
165struct AutoindentRequest {
166 selection_set_ids: HashSet<SelectionSetId>,
167 before_edit: Snapshot,
168 edited: AnchorSet,
169 inserted: Option<AnchorRangeSet>,
170}
171
172#[derive(Debug)]
173struct IndentSuggestion {
174 basis_row: u32,
175 indent: bool,
176}
177
178struct TextProvider<'a>(&'a Rope);
179
180struct Highlights<'a> {
181 captures: tree_sitter::QueryCaptures<'a, 'a, TextProvider<'a>>,
182 next_capture: Option<(tree_sitter::QueryMatch<'a, 'a>, usize)>,
183 stack: Vec<(usize, HighlightId)>,
184 highlight_map: HighlightMap,
185}
186
187pub struct HighlightedChunks<'a> {
188 range: Range<usize>,
189 chunks: Chunks<'a>,
190 diagnostic_endpoints: Peekable<vec::IntoIter<DiagnosticEndpoint>>,
191 error_depth: usize,
192 warning_depth: usize,
193 information_depth: usize,
194 hint_depth: usize,
195 highlights: Option<Highlights<'a>>,
196}
197
198#[derive(Clone, Copy, Debug, Default)]
199pub struct HighlightedChunk<'a> {
200 pub text: &'a str,
201 pub highlight_id: HighlightId,
202 pub diagnostic: Option<DiagnosticSeverity>,
203}
204
205struct Diff {
206 base_version: clock::Global,
207 new_text: Arc<str>,
208 changes: Vec<(ChangeTag, usize)>,
209}
210
211#[derive(Clone, Copy)]
212struct DiagnosticEndpoint {
213 offset: usize,
214 is_start: bool,
215 severity: DiagnosticSeverity,
216}
217
218impl Buffer {
219 pub fn new<T: Into<Arc<str>>>(
220 replica_id: ReplicaId,
221 base_text: T,
222 cx: &mut ModelContext<Self>,
223 ) -> Self {
224 Self::build(
225 TextBuffer::new(
226 replica_id,
227 cx.model_id() as u64,
228 History::new(base_text.into()),
229 ),
230 None,
231 )
232 }
233
234 pub fn from_file<T: Into<Arc<str>>>(
235 replica_id: ReplicaId,
236 base_text: T,
237 file: Box<dyn File>,
238 cx: &mut ModelContext<Self>,
239 ) -> Self {
240 Self::build(
241 TextBuffer::new(
242 replica_id,
243 cx.model_id() as u64,
244 History::new(base_text.into()),
245 ),
246 Some(file),
247 )
248 }
249
250 pub fn from_proto(
251 replica_id: ReplicaId,
252 message: proto::Buffer,
253 file: Option<Box<dyn File>>,
254 ) -> Result<Self> {
255 Ok(Self::build(
256 TextBuffer::from_proto(replica_id, message)?,
257 file,
258 ))
259 }
260
261 pub fn with_language(
262 mut self,
263 language: Option<Arc<Language>>,
264 language_server: Option<Arc<LanguageServer>>,
265 cx: &mut ModelContext<Self>,
266 ) -> Self {
267 self.set_language(language, language_server, cx);
268 self
269 }
270
271 fn build(buffer: TextBuffer, file: Option<Box<dyn File>>) -> Self {
272 let saved_mtime;
273 if let Some(file) = file.as_ref() {
274 saved_mtime = file.mtime();
275 } else {
276 saved_mtime = UNIX_EPOCH;
277 }
278
279 Self {
280 text: buffer,
281 saved_mtime,
282 saved_version: clock::Global::new(),
283 file,
284 syntax_tree: Mutex::new(None),
285 parsing_in_background: false,
286 parse_count: 0,
287 sync_parse_timeout: Duration::from_millis(1),
288 autoindent_requests: Default::default(),
289 pending_autoindent: Default::default(),
290 language: None,
291 diagnostics: Default::default(),
292 diagnostics_update_count: 0,
293 language_server: None,
294 #[cfg(test)]
295 operations: Default::default(),
296 }
297 }
298
299 pub fn snapshot(&self) -> Snapshot {
300 Snapshot {
301 text: self.text.snapshot(),
302 tree: self.syntax_tree(),
303 diagnostics: self.diagnostics.clone(),
304 is_parsing: self.parsing_in_background,
305 language: self.language.clone(),
306 query_cursor: QueryCursorHandle::new(),
307 }
308 }
309
310 pub fn file(&self) -> Option<&dyn File> {
311 self.file.as_deref()
312 }
313
314 pub fn save(
315 &mut self,
316 cx: &mut ModelContext<Self>,
317 ) -> Result<Task<Result<(clock::Global, SystemTime)>>> {
318 let file = self
319 .file
320 .as_ref()
321 .ok_or_else(|| anyhow!("buffer has no file"))?;
322 let text = self.as_rope().clone();
323 let version = self.version.clone();
324 let save = file.save(self.remote_id(), text, version, cx.as_mut());
325 Ok(cx.spawn(|this, mut cx| async move {
326 let (version, mtime) = save.await?;
327 this.update(&mut cx, |this, cx| {
328 this.did_save(version.clone(), mtime, None, cx);
329 });
330 Ok((version, mtime))
331 }))
332 }
333
334 pub fn set_language(
335 &mut self,
336 language: Option<Arc<Language>>,
337 language_server: Option<Arc<lsp::LanguageServer>>,
338 cx: &mut ModelContext<Self>,
339 ) {
340 self.language = language;
341 self.language_server = if let Some(server) = language_server {
342 let (latest_snapshot_tx, mut latest_snapshot_rx) = watch::channel();
343 Some(LanguageServerState {
344 latest_snapshot: latest_snapshot_tx,
345 pending_snapshots: Default::default(),
346 next_version: 0,
347 server: server.clone(),
348 _maintain_server: cx.background().spawn(
349 async move {
350 let mut prev_snapshot: Option<LanguageServerSnapshot> = None;
351 while let Some(snapshot) = latest_snapshot_rx.recv().await {
352 if let Some(snapshot) = snapshot {
353 let uri = lsp::Url::from_file_path(&snapshot.path).unwrap();
354 if let Some(prev_snapshot) = prev_snapshot {
355 let changes = lsp::DidChangeTextDocumentParams {
356 text_document: lsp::VersionedTextDocumentIdentifier::new(
357 uri,
358 snapshot.version as i32,
359 ),
360 content_changes: snapshot
361 .buffer_snapshot
362 .edits_since(
363 prev_snapshot.buffer_snapshot.version().clone(),
364 )
365 .map(|edit| {
366 lsp::TextDocumentContentChangeEvent {
367 // TODO: Use UTF-16 positions.
368 range: Some(lsp::Range::new(
369 lsp::Position::new(
370 edit.old_lines.start.row,
371 edit.old_lines.start.column,
372 ),
373 lsp::Position::new(
374 edit.old_lines.end.row,
375 edit.old_lines.end.column,
376 ),
377 )),
378 range_length: None,
379 text: snapshot
380 .buffer_snapshot
381 .text_for_range(edit.new_bytes)
382 .collect(),
383 }
384 })
385 .collect(),
386 };
387 server
388 .notify::<lsp::notification::DidChangeTextDocument>(changes)
389 .await?;
390 } else {
391 server
392 .notify::<lsp::notification::DidOpenTextDocument>(
393 lsp::DidOpenTextDocumentParams {
394 text_document: lsp::TextDocumentItem::new(
395 uri,
396 Default::default(),
397 snapshot.version as i32,
398 snapshot.buffer_snapshot.text().into(),
399 ),
400 },
401 )
402 .await?;
403 }
404
405 prev_snapshot = Some(snapshot);
406 }
407 }
408 Ok(())
409 }
410 .log_err(),
411 ),
412 })
413 } else {
414 None
415 };
416
417 self.reparse(cx);
418 self.update_language_server(cx);
419 }
420
421 pub fn did_save(
422 &mut self,
423 version: clock::Global,
424 mtime: SystemTime,
425 new_file: Option<Box<dyn File>>,
426 cx: &mut ModelContext<Self>,
427 ) {
428 self.saved_mtime = mtime;
429 self.saved_version = version;
430 if let Some(new_file) = new_file {
431 self.file = Some(new_file);
432 }
433 if let Some(state) = &self.language_server {
434 cx.background()
435 .spawn(
436 state
437 .server
438 .notify::<lsp::notification::DidSaveTextDocument>(
439 lsp::DidSaveTextDocumentParams {
440 text_document: lsp::TextDocumentIdentifier {
441 uri: lsp::Url::from_file_path(
442 self.file.as_ref().unwrap().abs_path(cx).unwrap(),
443 )
444 .unwrap(),
445 },
446 text: None,
447 },
448 ),
449 )
450 .detach()
451 }
452 cx.emit(Event::Saved);
453 }
454
455 pub fn file_updated(
456 &mut self,
457 new_file: Box<dyn File>,
458 cx: &mut ModelContext<Self>,
459 ) -> Option<Task<()>> {
460 let old_file = self.file.as_ref()?;
461 let mut file_changed = false;
462 let mut task = None;
463
464 if new_file.path() != old_file.path() {
465 file_changed = true;
466 }
467
468 if new_file.is_deleted() {
469 if !old_file.is_deleted() {
470 file_changed = true;
471 if !self.is_dirty() {
472 cx.emit(Event::Dirtied);
473 }
474 }
475 } else {
476 let new_mtime = new_file.mtime();
477 if new_mtime != old_file.mtime() {
478 file_changed = true;
479
480 if !self.is_dirty() {
481 task = Some(cx.spawn(|this, mut cx| {
482 async move {
483 let new_text = this.read_with(&cx, |this, cx| {
484 this.file.as_ref().and_then(|file| file.load_local(cx))
485 });
486 if let Some(new_text) = new_text {
487 let new_text = new_text.await?;
488 let diff = this
489 .read_with(&cx, |this, cx| this.diff(new_text.into(), cx))
490 .await;
491 this.update(&mut cx, |this, cx| {
492 if this.apply_diff(diff, cx) {
493 this.saved_version = this.version.clone();
494 this.saved_mtime = new_mtime;
495 cx.emit(Event::Reloaded);
496 }
497 });
498 }
499 Ok(())
500 }
501 .log_err()
502 .map(drop)
503 }));
504 }
505 }
506 }
507
508 if file_changed {
509 cx.emit(Event::FileHandleChanged);
510 }
511 self.file = Some(new_file);
512 task
513 }
514
515 pub fn close(&mut self, cx: &mut ModelContext<Self>) {
516 cx.emit(Event::Closed);
517 }
518
519 pub fn language(&self) -> Option<&Arc<Language>> {
520 self.language.as_ref()
521 }
522
523 pub fn parse_count(&self) -> usize {
524 self.parse_count
525 }
526
527 fn syntax_tree(&self) -> Option<Tree> {
528 if let Some(syntax_tree) = self.syntax_tree.lock().as_mut() {
529 self.interpolate_tree(syntax_tree);
530 Some(syntax_tree.tree.clone())
531 } else {
532 None
533 }
534 }
535
536 #[cfg(any(test, feature = "test-support"))]
537 pub fn is_parsing(&self) -> bool {
538 self.parsing_in_background
539 }
540
541 #[cfg(test)]
542 pub fn set_sync_parse_timeout(&mut self, timeout: Duration) {
543 self.sync_parse_timeout = timeout;
544 }
545
546 fn reparse(&mut self, cx: &mut ModelContext<Self>) -> bool {
547 if self.parsing_in_background {
548 return false;
549 }
550
551 if let Some(language) = self.language.clone() {
552 let old_tree = self.syntax_tree();
553 let text = self.as_rope().clone();
554 let parsed_version = self.version();
555 let parse_task = cx.background().spawn({
556 let language = language.clone();
557 async move { Self::parse_text(&text, old_tree, &language) }
558 });
559
560 match cx
561 .background()
562 .block_with_timeout(self.sync_parse_timeout, parse_task)
563 {
564 Ok(new_tree) => {
565 self.did_finish_parsing(new_tree, parsed_version, cx);
566 return true;
567 }
568 Err(parse_task) => {
569 self.parsing_in_background = true;
570 cx.spawn(move |this, mut cx| async move {
571 let new_tree = parse_task.await;
572 this.update(&mut cx, move |this, cx| {
573 let language_changed =
574 this.language.as_ref().map_or(true, |curr_language| {
575 !Arc::ptr_eq(curr_language, &language)
576 });
577 let parse_again = this.version > parsed_version || language_changed;
578 this.parsing_in_background = false;
579 this.did_finish_parsing(new_tree, parsed_version, cx);
580
581 if parse_again && this.reparse(cx) {
582 return;
583 }
584 });
585 })
586 .detach();
587 }
588 }
589 }
590 false
591 }
592
593 fn parse_text(text: &Rope, old_tree: Option<Tree>, language: &Language) -> Tree {
594 PARSER.with(|parser| {
595 let mut parser = parser.borrow_mut();
596 parser
597 .set_language(language.grammar)
598 .expect("incompatible grammar");
599 let mut chunks = text.chunks_in_range(0..text.len());
600 let tree = parser
601 .parse_with(
602 &mut move |offset, _| {
603 chunks.seek(offset);
604 chunks.next().unwrap_or("").as_bytes()
605 },
606 old_tree.as_ref(),
607 )
608 .unwrap();
609 tree
610 })
611 }
612
613 fn interpolate_tree(&self, tree: &mut SyntaxTree) {
614 let mut delta = 0_isize;
615 for edit in self.edits_since(tree.version.clone()) {
616 let start_offset = (edit.old_bytes.start as isize + delta) as usize;
617 let start_point = self.as_rope().to_point(start_offset);
618 tree.tree.edit(&InputEdit {
619 start_byte: start_offset,
620 old_end_byte: start_offset + edit.deleted_bytes(),
621 new_end_byte: start_offset + edit.inserted_bytes(),
622 start_position: start_point.to_ts_point(),
623 old_end_position: (start_point + edit.deleted_lines()).to_ts_point(),
624 new_end_position: self
625 .as_rope()
626 .to_point(start_offset + edit.inserted_bytes())
627 .to_ts_point(),
628 });
629 delta += edit.inserted_bytes() as isize - edit.deleted_bytes() as isize;
630 }
631 tree.version = self.version();
632 }
633
634 fn did_finish_parsing(
635 &mut self,
636 tree: Tree,
637 version: clock::Global,
638 cx: &mut ModelContext<Self>,
639 ) {
640 self.parse_count += 1;
641 *self.syntax_tree.lock() = Some(SyntaxTree { tree, version });
642 self.request_autoindent(cx);
643 cx.emit(Event::Reparsed);
644 cx.notify();
645 }
646
647 pub fn update_diagnostics(
648 &mut self,
649 version: Option<i32>,
650 diagnostics: Vec<lsp::Diagnostic>,
651 cx: &mut ModelContext<Self>,
652 ) -> Result<()> {
653 let version = version.map(|version| version as usize);
654 let content = if let Some(version) = version {
655 let language_server = self.language_server.as_mut().unwrap();
656 let snapshot = language_server
657 .pending_snapshots
658 .get(&version)
659 .ok_or_else(|| anyhow!("missing snapshot"))?;
660 snapshot.buffer_snapshot.content()
661 } else {
662 self.content()
663 };
664
665 let empty_set = HashSet::new();
666 let disk_based_sources = self
667 .language
668 .as_ref()
669 .and_then(|language| language.disk_based_diagnostic_sources())
670 .unwrap_or(&empty_set);
671
672 let mut edits_since_save = self.text.edits_since(self.saved_version.clone()).peekable();
673 let mut last_edit_old_end = Point::zero();
674 let mut last_edit_new_end = Point::zero();
675
676 self.diagnostics = content.anchor_range_multimap(
677 Bias::Left,
678 Bias::Right,
679 diagnostics.into_iter().filter_map(|diagnostic| {
680 // TODO: Use UTF-16 positions.
681 let mut start = Point::new(
682 diagnostic.range.start.line,
683 diagnostic.range.start.character,
684 );
685 let mut end = Point::new(diagnostic.range.end.line, diagnostic.range.end.character);
686 let severity = diagnostic.severity.unwrap_or(DiagnosticSeverity::ERROR);
687
688 if diagnostic
689 .source
690 .as_ref()
691 .map_or(false, |source| disk_based_sources.contains(source))
692 {
693 while let Some(edit) = edits_since_save.peek() {
694 if edit.old_lines.end <= start {
695 last_edit_old_end = edit.old_lines.end;
696 last_edit_new_end = edit.new_lines.end;
697 edits_since_save.next();
698 } else if edit.old_lines.start <= end && edit.old_lines.end >= start {
699 return None;
700 } else {
701 break;
702 }
703 }
704
705 start = last_edit_new_end + (start - last_edit_old_end);
706 end = last_edit_new_end + (end - last_edit_old_end);
707 }
708
709 Some((start..end, (severity, diagnostic.message)))
710 }),
711 );
712
713 if let Some(version) = version {
714 let language_server = self.language_server.as_mut().unwrap();
715 let versions_to_delete = language_server
716 .pending_snapshots
717 .range(..version)
718 .map(|(v, _)| *v)
719 .collect::<Vec<_>>();
720 for version in versions_to_delete {
721 language_server.pending_snapshots.remove(&version);
722 }
723 }
724
725 self.diagnostics_update_count += 1;
726 cx.notify();
727 Ok(())
728 }
729
730 pub fn diagnostics_in_range<'a, T: ToOffset>(
731 &'a self,
732 range: Range<T>,
733 ) -> impl Iterator<Item = Diagnostic> + 'a {
734 let content = self.content();
735 let range = range.start.to_offset(&content)..range.end.to_offset(&content);
736 self.diagnostics
737 .intersecting_ranges(range, content, true)
738 .map(move |(_, range, (severity, message))| Diagnostic {
739 range,
740 severity: *severity,
741 message: message.clone(),
742 })
743 }
744
745 pub fn diagnostics_update_count(&self) -> usize {
746 self.diagnostics_update_count
747 }
748
749 fn request_autoindent(&mut self, cx: &mut ModelContext<Self>) {
750 if let Some(indent_columns) = self.compute_autoindents() {
751 let indent_columns = cx.background().spawn(indent_columns);
752 match cx
753 .background()
754 .block_with_timeout(Duration::from_micros(500), indent_columns)
755 {
756 Ok(indent_columns) => self.apply_autoindents(indent_columns, cx),
757 Err(indent_columns) => {
758 self.pending_autoindent = Some(cx.spawn(|this, mut cx| async move {
759 let indent_columns = indent_columns.await;
760 this.update(&mut cx, |this, cx| {
761 this.apply_autoindents(indent_columns, cx);
762 });
763 }));
764 }
765 }
766 }
767 }
768
769 fn compute_autoindents(&self) -> Option<impl Future<Output = BTreeMap<u32, u32>>> {
770 let max_rows_between_yields = 100;
771 let snapshot = self.snapshot();
772 if snapshot.language.is_none()
773 || snapshot.tree.is_none()
774 || self.autoindent_requests.is_empty()
775 {
776 return None;
777 }
778
779 let autoindent_requests = self.autoindent_requests.clone();
780 Some(async move {
781 let mut indent_columns = BTreeMap::new();
782 for request in autoindent_requests {
783 let old_to_new_rows = request
784 .edited
785 .to_points(&request.before_edit)
786 .map(|point| point.row)
787 .zip(request.edited.to_points(&snapshot).map(|point| point.row))
788 .collect::<BTreeMap<u32, u32>>();
789
790 let mut old_suggestions = HashMap::<u32, u32>::default();
791 let old_edited_ranges =
792 contiguous_ranges(old_to_new_rows.keys().copied(), max_rows_between_yields);
793 for old_edited_range in old_edited_ranges {
794 let suggestions = request
795 .before_edit
796 .suggest_autoindents(old_edited_range.clone())
797 .into_iter()
798 .flatten();
799 for (old_row, suggestion) in old_edited_range.zip(suggestions) {
800 let indentation_basis = old_to_new_rows
801 .get(&suggestion.basis_row)
802 .and_then(|from_row| old_suggestions.get(from_row).copied())
803 .unwrap_or_else(|| {
804 request
805 .before_edit
806 .indent_column_for_line(suggestion.basis_row)
807 });
808 let delta = if suggestion.indent { INDENT_SIZE } else { 0 };
809 old_suggestions.insert(
810 *old_to_new_rows.get(&old_row).unwrap(),
811 indentation_basis + delta,
812 );
813 }
814 yield_now().await;
815 }
816
817 // At this point, old_suggestions contains the suggested indentation for all edited lines with respect to the state of the
818 // buffer before the edit, but keyed by the row for these lines after the edits were applied.
819 let new_edited_row_ranges =
820 contiguous_ranges(old_to_new_rows.values().copied(), max_rows_between_yields);
821 for new_edited_row_range in new_edited_row_ranges {
822 let suggestions = snapshot
823 .suggest_autoindents(new_edited_row_range.clone())
824 .into_iter()
825 .flatten();
826 for (new_row, suggestion) in new_edited_row_range.zip(suggestions) {
827 let delta = if suggestion.indent { INDENT_SIZE } else { 0 };
828 let new_indentation = indent_columns
829 .get(&suggestion.basis_row)
830 .copied()
831 .unwrap_or_else(|| {
832 snapshot.indent_column_for_line(suggestion.basis_row)
833 })
834 + delta;
835 if old_suggestions
836 .get(&new_row)
837 .map_or(true, |old_indentation| new_indentation != *old_indentation)
838 {
839 indent_columns.insert(new_row, new_indentation);
840 }
841 }
842 yield_now().await;
843 }
844
845 if let Some(inserted) = request.inserted.as_ref() {
846 let inserted_row_ranges = contiguous_ranges(
847 inserted
848 .to_point_ranges(&snapshot)
849 .flat_map(|range| range.start.row..range.end.row + 1),
850 max_rows_between_yields,
851 );
852 for inserted_row_range in inserted_row_ranges {
853 let suggestions = snapshot
854 .suggest_autoindents(inserted_row_range.clone())
855 .into_iter()
856 .flatten();
857 for (row, suggestion) in inserted_row_range.zip(suggestions) {
858 let delta = if suggestion.indent { INDENT_SIZE } else { 0 };
859 let new_indentation = indent_columns
860 .get(&suggestion.basis_row)
861 .copied()
862 .unwrap_or_else(|| {
863 snapshot.indent_column_for_line(suggestion.basis_row)
864 })
865 + delta;
866 indent_columns.insert(row, new_indentation);
867 }
868 yield_now().await;
869 }
870 }
871 }
872 indent_columns
873 })
874 }
875
876 fn apply_autoindents(
877 &mut self,
878 indent_columns: BTreeMap<u32, u32>,
879 cx: &mut ModelContext<Self>,
880 ) {
881 let selection_set_ids = self
882 .autoindent_requests
883 .drain(..)
884 .flat_map(|req| req.selection_set_ids.clone())
885 .collect::<HashSet<_>>();
886
887 self.start_transaction(selection_set_ids.iter().copied())
888 .unwrap();
889 for (row, indent_column) in &indent_columns {
890 self.set_indent_column_for_line(*row, *indent_column, cx);
891 }
892
893 for selection_set_id in &selection_set_ids {
894 if let Ok(set) = self.selection_set(*selection_set_id) {
895 let new_selections = set
896 .selections
897 .iter()
898 .map(|selection| {
899 let start_point = selection.start.to_point(&self.text);
900 if start_point.column == 0 {
901 let end_point = selection.end.to_point(&self.text);
902 let delta = Point::new(
903 0,
904 indent_columns.get(&start_point.row).copied().unwrap_or(0),
905 );
906 if delta.column > 0 {
907 return Selection {
908 id: selection.id,
909 goal: selection.goal,
910 reversed: selection.reversed,
911 start: self
912 .anchor_at(start_point + delta, selection.start.bias),
913 end: self.anchor_at(end_point + delta, selection.end.bias),
914 };
915 }
916 }
917 selection.clone()
918 })
919 .collect::<Arc<[_]>>();
920 self.update_selection_set(*selection_set_id, new_selections, cx)
921 .unwrap();
922 }
923 }
924
925 self.end_transaction(selection_set_ids.iter().copied(), cx)
926 .unwrap();
927 }
928
929 pub fn indent_column_for_line(&self, row: u32) -> u32 {
930 self.content().indent_column_for_line(row)
931 }
932
933 fn set_indent_column_for_line(&mut self, row: u32, column: u32, cx: &mut ModelContext<Self>) {
934 let current_column = self.indent_column_for_line(row);
935 if column > current_column {
936 let offset = Point::new(row, 0).to_offset(&*self);
937 self.edit(
938 [offset..offset],
939 " ".repeat((column - current_column) as usize),
940 cx,
941 );
942 } else if column < current_column {
943 self.edit(
944 [Point::new(row, 0)..Point::new(row, current_column - column)],
945 "",
946 cx,
947 );
948 }
949 }
950
951 pub fn range_for_syntax_ancestor<T: ToOffset>(&self, range: Range<T>) -> Option<Range<usize>> {
952 if let Some(tree) = self.syntax_tree() {
953 let root = tree.root_node();
954 let range = range.start.to_offset(self)..range.end.to_offset(self);
955 let mut node = root.descendant_for_byte_range(range.start, range.end);
956 while node.map_or(false, |n| n.byte_range() == range) {
957 node = node.unwrap().parent();
958 }
959 node.map(|n| n.byte_range())
960 } else {
961 None
962 }
963 }
964
965 pub fn enclosing_bracket_ranges<T: ToOffset>(
966 &self,
967 range: Range<T>,
968 ) -> Option<(Range<usize>, Range<usize>)> {
969 let (lang, tree) = self.language.as_ref().zip(self.syntax_tree())?;
970 let open_capture_ix = lang.brackets_query.capture_index_for_name("open")?;
971 let close_capture_ix = lang.brackets_query.capture_index_for_name("close")?;
972
973 // Find bracket pairs that *inclusively* contain the given range.
974 let range = range.start.to_offset(self).saturating_sub(1)..range.end.to_offset(self) + 1;
975 let mut cursor = QueryCursorHandle::new();
976 let matches = cursor.set_byte_range(range).matches(
977 &lang.brackets_query,
978 tree.root_node(),
979 TextProvider(self.as_rope()),
980 );
981
982 // Get the ranges of the innermost pair of brackets.
983 matches
984 .filter_map(|mat| {
985 let open = mat.nodes_for_capture_index(open_capture_ix).next()?;
986 let close = mat.nodes_for_capture_index(close_capture_ix).next()?;
987 Some((open.byte_range(), close.byte_range()))
988 })
989 .min_by_key(|(open_range, close_range)| close_range.end - open_range.start)
990 }
991
992 fn diff(&self, new_text: Arc<str>, cx: &AppContext) -> Task<Diff> {
993 // TODO: it would be nice to not allocate here.
994 let old_text = self.text();
995 let base_version = self.version();
996 cx.background().spawn(async move {
997 let changes = TextDiff::from_lines(old_text.as_str(), new_text.as_ref())
998 .iter_all_changes()
999 .map(|c| (c.tag(), c.value().len()))
1000 .collect::<Vec<_>>();
1001 Diff {
1002 base_version,
1003 new_text,
1004 changes,
1005 }
1006 })
1007 }
1008
1009 fn apply_diff(&mut self, diff: Diff, cx: &mut ModelContext<Self>) -> bool {
1010 if self.version == diff.base_version {
1011 self.start_transaction(None).unwrap();
1012 let mut offset = 0;
1013 for (tag, len) in diff.changes {
1014 let range = offset..(offset + len);
1015 match tag {
1016 ChangeTag::Equal => offset += len,
1017 ChangeTag::Delete => self.edit(Some(range), "", cx),
1018 ChangeTag::Insert => {
1019 self.edit(Some(offset..offset), &diff.new_text[range], cx);
1020 offset += len;
1021 }
1022 }
1023 }
1024 self.end_transaction(None, cx).unwrap();
1025 true
1026 } else {
1027 false
1028 }
1029 }
1030
1031 pub fn is_dirty(&self) -> bool {
1032 self.version > self.saved_version
1033 || self.file.as_ref().map_or(false, |file| file.is_deleted())
1034 }
1035
1036 pub fn has_conflict(&self) -> bool {
1037 self.version > self.saved_version
1038 && self
1039 .file
1040 .as_ref()
1041 .map_or(false, |file| file.mtime() > self.saved_mtime)
1042 }
1043
1044 pub fn start_transaction(
1045 &mut self,
1046 selection_set_ids: impl IntoIterator<Item = SelectionSetId>,
1047 ) -> Result<()> {
1048 self.start_transaction_at(selection_set_ids, Instant::now())
1049 }
1050
1051 fn start_transaction_at(
1052 &mut self,
1053 selection_set_ids: impl IntoIterator<Item = SelectionSetId>,
1054 now: Instant,
1055 ) -> Result<()> {
1056 self.text.start_transaction_at(selection_set_ids, now)
1057 }
1058
1059 pub fn end_transaction(
1060 &mut self,
1061 selection_set_ids: impl IntoIterator<Item = SelectionSetId>,
1062 cx: &mut ModelContext<Self>,
1063 ) -> Result<()> {
1064 self.end_transaction_at(selection_set_ids, Instant::now(), cx)
1065 }
1066
1067 fn end_transaction_at(
1068 &mut self,
1069 selection_set_ids: impl IntoIterator<Item = SelectionSetId>,
1070 now: Instant,
1071 cx: &mut ModelContext<Self>,
1072 ) -> Result<()> {
1073 if let Some(start_version) = self.text.end_transaction_at(selection_set_ids, now) {
1074 let was_dirty = start_version != self.saved_version;
1075 self.did_edit(start_version, was_dirty, cx);
1076 }
1077 Ok(())
1078 }
1079
1080 fn update_language_server(&mut self, cx: &AppContext) {
1081 let language_server = if let Some(language_server) = self.language_server.as_mut() {
1082 language_server
1083 } else {
1084 return;
1085 };
1086 let abs_path = self
1087 .file
1088 .as_ref()
1089 .map_or(Path::new("/").to_path_buf(), |file| {
1090 file.abs_path(cx).unwrap()
1091 });
1092
1093 let version = post_inc(&mut language_server.next_version);
1094 let snapshot = LanguageServerSnapshot {
1095 buffer_snapshot: self.text.snapshot(),
1096 version,
1097 path: Arc::from(abs_path),
1098 };
1099 language_server
1100 .pending_snapshots
1101 .insert(version, snapshot.clone());
1102 let _ = language_server
1103 .latest_snapshot
1104 .blocking_send(Some(snapshot));
1105 }
1106
1107 pub fn edit<I, S, T>(&mut self, ranges_iter: I, new_text: T, cx: &mut ModelContext<Self>)
1108 where
1109 I: IntoIterator<Item = Range<S>>,
1110 S: ToOffset,
1111 T: Into<String>,
1112 {
1113 self.edit_internal(ranges_iter, new_text, false, cx)
1114 }
1115
1116 pub fn edit_with_autoindent<I, S, T>(
1117 &mut self,
1118 ranges_iter: I,
1119 new_text: T,
1120 cx: &mut ModelContext<Self>,
1121 ) where
1122 I: IntoIterator<Item = Range<S>>,
1123 S: ToOffset,
1124 T: Into<String>,
1125 {
1126 self.edit_internal(ranges_iter, new_text, true, cx)
1127 }
1128
1129 pub fn edit_internal<I, S, T>(
1130 &mut self,
1131 ranges_iter: I,
1132 new_text: T,
1133 autoindent: bool,
1134 cx: &mut ModelContext<Self>,
1135 ) where
1136 I: IntoIterator<Item = Range<S>>,
1137 S: ToOffset,
1138 T: Into<String>,
1139 {
1140 let new_text = new_text.into();
1141
1142 // Skip invalid ranges and coalesce contiguous ones.
1143 let mut ranges: Vec<Range<usize>> = Vec::new();
1144 for range in ranges_iter {
1145 let range = range.start.to_offset(&*self)..range.end.to_offset(&*self);
1146 if !new_text.is_empty() || !range.is_empty() {
1147 if let Some(prev_range) = ranges.last_mut() {
1148 if prev_range.end >= range.start {
1149 prev_range.end = cmp::max(prev_range.end, range.end);
1150 } else {
1151 ranges.push(range);
1152 }
1153 } else {
1154 ranges.push(range);
1155 }
1156 }
1157 }
1158 if ranges.is_empty() {
1159 return;
1160 }
1161
1162 self.start_transaction(None).unwrap();
1163 self.pending_autoindent.take();
1164 let autoindent_request = if autoindent && self.language.is_some() {
1165 let before_edit = self.snapshot();
1166 let edited = self.content().anchor_set(ranges.iter().filter_map(|range| {
1167 let start = range.start.to_point(&*self);
1168 if new_text.starts_with('\n') && start.column == self.line_len(start.row) {
1169 None
1170 } else {
1171 Some((range.start, Bias::Left))
1172 }
1173 }));
1174 Some((before_edit, edited))
1175 } else {
1176 None
1177 };
1178
1179 let first_newline_ix = new_text.find('\n');
1180 let new_text_len = new_text.len();
1181
1182 let edit = self.text.edit(ranges.iter().cloned(), new_text);
1183
1184 if let Some((before_edit, edited)) = autoindent_request {
1185 let mut inserted = None;
1186 if let Some(first_newline_ix) = first_newline_ix {
1187 let mut delta = 0isize;
1188 inserted = Some(self.content().anchor_range_set(ranges.iter().map(|range| {
1189 let start = (delta + range.start as isize) as usize + first_newline_ix + 1;
1190 let end = (delta + range.start as isize) as usize + new_text_len;
1191 delta += (range.end as isize - range.start as isize) + new_text_len as isize;
1192 (start, Bias::Left)..(end, Bias::Right)
1193 })));
1194 }
1195
1196 let selection_set_ids = self
1197 .text
1198 .peek_undo_stack()
1199 .unwrap()
1200 .starting_selection_set_ids()
1201 .collect();
1202 self.autoindent_requests.push(Arc::new(AutoindentRequest {
1203 selection_set_ids,
1204 before_edit,
1205 edited,
1206 inserted,
1207 }));
1208 }
1209
1210 self.end_transaction(None, cx).unwrap();
1211 self.send_operation(Operation::Edit(edit), cx);
1212 }
1213
1214 fn did_edit(
1215 &mut self,
1216 old_version: clock::Global,
1217 was_dirty: bool,
1218 cx: &mut ModelContext<Self>,
1219 ) {
1220 if self.edits_since(old_version).next().is_none() {
1221 return;
1222 }
1223
1224 self.reparse(cx);
1225 self.update_language_server(cx);
1226
1227 cx.emit(Event::Edited);
1228 if !was_dirty {
1229 cx.emit(Event::Dirtied);
1230 }
1231 cx.notify();
1232 }
1233
1234 pub fn add_selection_set(
1235 &mut self,
1236 selections: impl Into<Arc<[Selection]>>,
1237 cx: &mut ModelContext<Self>,
1238 ) -> SelectionSetId {
1239 let operation = self.text.add_selection_set(selections);
1240 if let Operation::UpdateSelections { set_id, .. } = &operation {
1241 let set_id = *set_id;
1242 cx.notify();
1243 self.send_operation(operation, cx);
1244 set_id
1245 } else {
1246 unreachable!()
1247 }
1248 }
1249
1250 pub fn update_selection_set(
1251 &mut self,
1252 set_id: SelectionSetId,
1253 selections: impl Into<Arc<[Selection]>>,
1254 cx: &mut ModelContext<Self>,
1255 ) -> Result<()> {
1256 let operation = self.text.update_selection_set(set_id, selections)?;
1257 cx.notify();
1258 self.send_operation(operation, cx);
1259 Ok(())
1260 }
1261
1262 pub fn set_active_selection_set(
1263 &mut self,
1264 set_id: Option<SelectionSetId>,
1265 cx: &mut ModelContext<Self>,
1266 ) -> Result<()> {
1267 let operation = self.text.set_active_selection_set(set_id)?;
1268 self.send_operation(operation, cx);
1269 Ok(())
1270 }
1271
1272 pub fn remove_selection_set(
1273 &mut self,
1274 set_id: SelectionSetId,
1275 cx: &mut ModelContext<Self>,
1276 ) -> Result<()> {
1277 let operation = self.text.remove_selection_set(set_id)?;
1278 cx.notify();
1279 self.send_operation(operation, cx);
1280 Ok(())
1281 }
1282
1283 pub fn apply_ops<I: IntoIterator<Item = Operation>>(
1284 &mut self,
1285 ops: I,
1286 cx: &mut ModelContext<Self>,
1287 ) -> Result<()> {
1288 self.pending_autoindent.take();
1289 let was_dirty = self.is_dirty();
1290 let old_version = self.version.clone();
1291 self.text.apply_ops(ops)?;
1292 self.did_edit(old_version, was_dirty, cx);
1293 Ok(())
1294 }
1295
1296 #[cfg(not(test))]
1297 pub fn send_operation(&mut self, operation: Operation, cx: &mut ModelContext<Self>) {
1298 if let Some(file) = &self.file {
1299 file.buffer_updated(self.remote_id(), operation, cx.as_mut());
1300 }
1301 }
1302
1303 #[cfg(test)]
1304 pub fn send_operation(&mut self, operation: Operation, _: &mut ModelContext<Self>) {
1305 self.operations.push(operation);
1306 }
1307
1308 pub fn remove_peer(&mut self, replica_id: ReplicaId, cx: &mut ModelContext<Self>) {
1309 self.text.remove_peer(replica_id);
1310 cx.notify();
1311 }
1312
1313 pub fn undo(&mut self, cx: &mut ModelContext<Self>) {
1314 let was_dirty = self.is_dirty();
1315 let old_version = self.version.clone();
1316
1317 for operation in self.text.undo() {
1318 self.send_operation(operation, cx);
1319 }
1320
1321 self.did_edit(old_version, was_dirty, cx);
1322 }
1323
1324 pub fn redo(&mut self, cx: &mut ModelContext<Self>) {
1325 let was_dirty = self.is_dirty();
1326 let old_version = self.version.clone();
1327
1328 for operation in self.text.redo() {
1329 self.send_operation(operation, cx);
1330 }
1331
1332 self.did_edit(old_version, was_dirty, cx);
1333 }
1334}
1335
1336#[cfg(any(test, feature = "test-support"))]
1337impl Buffer {
1338 pub fn randomly_edit<T>(&mut self, rng: &mut T, old_range_count: usize)
1339 where
1340 T: rand::Rng,
1341 {
1342 self.text.randomly_edit(rng, old_range_count);
1343 }
1344
1345 pub fn randomly_mutate<T>(&mut self, rng: &mut T)
1346 where
1347 T: rand::Rng,
1348 {
1349 self.text.randomly_mutate(rng);
1350 }
1351}
1352
1353impl Entity for Buffer {
1354 type Event = Event;
1355
1356 fn release(&mut self, cx: &mut gpui::MutableAppContext) {
1357 if let Some(file) = self.file.as_ref() {
1358 file.buffer_removed(self.remote_id(), cx);
1359 }
1360 }
1361}
1362
1363// TODO: Do we need to clone a buffer?
1364impl Clone for Buffer {
1365 fn clone(&self) -> Self {
1366 Self {
1367 text: self.text.clone(),
1368 saved_version: self.saved_version.clone(),
1369 saved_mtime: self.saved_mtime,
1370 file: self.file.as_ref().map(|f| f.boxed_clone()),
1371 language: self.language.clone(),
1372 syntax_tree: Mutex::new(self.syntax_tree.lock().clone()),
1373 parsing_in_background: false,
1374 sync_parse_timeout: self.sync_parse_timeout,
1375 parse_count: self.parse_count,
1376 autoindent_requests: Default::default(),
1377 pending_autoindent: Default::default(),
1378 diagnostics: self.diagnostics.clone(),
1379 diagnostics_update_count: self.diagnostics_update_count,
1380 language_server: None,
1381 #[cfg(test)]
1382 operations: self.operations.clone(),
1383 }
1384 }
1385}
1386
1387impl Deref for Buffer {
1388 type Target = TextBuffer;
1389
1390 fn deref(&self) -> &Self::Target {
1391 &self.text
1392 }
1393}
1394
1395impl<'a> From<&'a Buffer> for Content<'a> {
1396 fn from(buffer: &'a Buffer) -> Self {
1397 Self::from(&buffer.text)
1398 }
1399}
1400
1401impl<'a> From<&'a mut Buffer> for Content<'a> {
1402 fn from(buffer: &'a mut Buffer) -> Self {
1403 Self::from(&buffer.text)
1404 }
1405}
1406
1407impl<'a> From<&'a Snapshot> for Content<'a> {
1408 fn from(snapshot: &'a Snapshot) -> Self {
1409 Self::from(&snapshot.text)
1410 }
1411}
1412
1413impl Snapshot {
1414 fn suggest_autoindents<'a>(
1415 &'a self,
1416 row_range: Range<u32>,
1417 ) -> Option<impl Iterator<Item = IndentSuggestion> + 'a> {
1418 let mut query_cursor = QueryCursorHandle::new();
1419 if let Some((language, tree)) = self.language.as_ref().zip(self.tree.as_ref()) {
1420 let prev_non_blank_row = self.prev_non_blank_row(row_range.start);
1421
1422 // Get the "indentation ranges" that intersect this row range.
1423 let indent_capture_ix = language.indents_query.capture_index_for_name("indent");
1424 let end_capture_ix = language.indents_query.capture_index_for_name("end");
1425 query_cursor.set_point_range(
1426 Point::new(prev_non_blank_row.unwrap_or(row_range.start), 0).to_ts_point()
1427 ..Point::new(row_range.end, 0).to_ts_point(),
1428 );
1429 let mut indentation_ranges = Vec::<(Range<Point>, &'static str)>::new();
1430 for mat in query_cursor.matches(
1431 &language.indents_query,
1432 tree.root_node(),
1433 TextProvider(self.as_rope()),
1434 ) {
1435 let mut node_kind = "";
1436 let mut start: Option<Point> = None;
1437 let mut end: Option<Point> = None;
1438 for capture in mat.captures {
1439 if Some(capture.index) == indent_capture_ix {
1440 node_kind = capture.node.kind();
1441 start.get_or_insert(Point::from_ts_point(capture.node.start_position()));
1442 end.get_or_insert(Point::from_ts_point(capture.node.end_position()));
1443 } else if Some(capture.index) == end_capture_ix {
1444 end = Some(Point::from_ts_point(capture.node.start_position().into()));
1445 }
1446 }
1447
1448 if let Some((start, end)) = start.zip(end) {
1449 if start.row == end.row {
1450 continue;
1451 }
1452
1453 let range = start..end;
1454 match indentation_ranges.binary_search_by_key(&range.start, |r| r.0.start) {
1455 Err(ix) => indentation_ranges.insert(ix, (range, node_kind)),
1456 Ok(ix) => {
1457 let prev_range = &mut indentation_ranges[ix];
1458 prev_range.0.end = prev_range.0.end.max(range.end);
1459 }
1460 }
1461 }
1462 }
1463
1464 let mut prev_row = prev_non_blank_row.unwrap_or(0);
1465 Some(row_range.map(move |row| {
1466 let row_start = Point::new(row, self.indent_column_for_line(row));
1467
1468 let mut indent_from_prev_row = false;
1469 let mut outdent_to_row = u32::MAX;
1470 for (range, _node_kind) in &indentation_ranges {
1471 if range.start.row >= row {
1472 break;
1473 }
1474
1475 if range.start.row == prev_row && range.end > row_start {
1476 indent_from_prev_row = true;
1477 }
1478 if range.end.row >= prev_row && range.end <= row_start {
1479 outdent_to_row = outdent_to_row.min(range.start.row);
1480 }
1481 }
1482
1483 let suggestion = if outdent_to_row == prev_row {
1484 IndentSuggestion {
1485 basis_row: prev_row,
1486 indent: false,
1487 }
1488 } else if indent_from_prev_row {
1489 IndentSuggestion {
1490 basis_row: prev_row,
1491 indent: true,
1492 }
1493 } else if outdent_to_row < prev_row {
1494 IndentSuggestion {
1495 basis_row: outdent_to_row,
1496 indent: false,
1497 }
1498 } else {
1499 IndentSuggestion {
1500 basis_row: prev_row,
1501 indent: false,
1502 }
1503 };
1504
1505 prev_row = row;
1506 suggestion
1507 }))
1508 } else {
1509 None
1510 }
1511 }
1512
1513 fn prev_non_blank_row(&self, mut row: u32) -> Option<u32> {
1514 while row > 0 {
1515 row -= 1;
1516 if !self.is_line_blank(row) {
1517 return Some(row);
1518 }
1519 }
1520 None
1521 }
1522
1523 fn is_line_blank(&self, row: u32) -> bool {
1524 self.text_for_range(Point::new(row, 0)..Point::new(row, self.line_len(row)))
1525 .all(|chunk| chunk.matches(|c: char| !c.is_whitespace()).next().is_none())
1526 }
1527
1528 pub fn highlighted_text_for_range<T: ToOffset>(
1529 &mut self,
1530 range: Range<T>,
1531 ) -> HighlightedChunks {
1532 let range = range.start.to_offset(&*self)..range.end.to_offset(&*self);
1533
1534 let mut diagnostic_endpoints = Vec::<DiagnosticEndpoint>::new();
1535 for (_, range, (severity, _)) in
1536 self.diagnostics
1537 .intersecting_ranges(range.clone(), self.content(), true)
1538 {
1539 diagnostic_endpoints.push(DiagnosticEndpoint {
1540 offset: range.start,
1541 is_start: true,
1542 severity: *severity,
1543 });
1544 diagnostic_endpoints.push(DiagnosticEndpoint {
1545 offset: range.end,
1546 is_start: false,
1547 severity: *severity,
1548 });
1549 }
1550 diagnostic_endpoints.sort_unstable_by_key(|endpoint| endpoint.offset);
1551 let diagnostic_endpoints = diagnostic_endpoints.into_iter().peekable();
1552
1553 let chunks = self.text.as_rope().chunks_in_range(range.clone());
1554 let highlights =
1555 if let Some((language, tree)) = self.language.as_ref().zip(self.tree.as_ref()) {
1556 let captures = self.query_cursor.set_byte_range(range.clone()).captures(
1557 &language.highlights_query,
1558 tree.root_node(),
1559 TextProvider(self.text.as_rope()),
1560 );
1561
1562 Some(Highlights {
1563 captures,
1564 next_capture: None,
1565 stack: Default::default(),
1566 highlight_map: language.highlight_map(),
1567 })
1568 } else {
1569 None
1570 };
1571
1572 HighlightedChunks {
1573 range,
1574 chunks,
1575 diagnostic_endpoints,
1576 error_depth: 0,
1577 warning_depth: 0,
1578 information_depth: 0,
1579 hint_depth: 0,
1580 highlights,
1581 }
1582 }
1583}
1584
1585impl Clone for Snapshot {
1586 fn clone(&self) -> Self {
1587 Self {
1588 text: self.text.clone(),
1589 tree: self.tree.clone(),
1590 diagnostics: self.diagnostics.clone(),
1591 is_parsing: self.is_parsing,
1592 language: self.language.clone(),
1593 query_cursor: QueryCursorHandle::new(),
1594 }
1595 }
1596}
1597
1598impl Deref for Snapshot {
1599 type Target = buffer::Snapshot;
1600
1601 fn deref(&self) -> &Self::Target {
1602 &self.text
1603 }
1604}
1605
1606impl<'a> tree_sitter::TextProvider<'a> for TextProvider<'a> {
1607 type I = ByteChunks<'a>;
1608
1609 fn text(&mut self, node: tree_sitter::Node) -> Self::I {
1610 ByteChunks(self.0.chunks_in_range(node.byte_range()))
1611 }
1612}
1613
1614struct ByteChunks<'a>(rope::Chunks<'a>);
1615
1616impl<'a> Iterator for ByteChunks<'a> {
1617 type Item = &'a [u8];
1618
1619 fn next(&mut self) -> Option<Self::Item> {
1620 self.0.next().map(str::as_bytes)
1621 }
1622}
1623
1624impl<'a> HighlightedChunks<'a> {
1625 pub fn seek(&mut self, offset: usize) {
1626 self.range.start = offset;
1627 self.chunks.seek(self.range.start);
1628 if let Some(highlights) = self.highlights.as_mut() {
1629 highlights
1630 .stack
1631 .retain(|(end_offset, _)| *end_offset > offset);
1632 if let Some((mat, capture_ix)) = &highlights.next_capture {
1633 let capture = mat.captures[*capture_ix as usize];
1634 if offset >= capture.node.start_byte() {
1635 let next_capture_end = capture.node.end_byte();
1636 if offset < next_capture_end {
1637 highlights.stack.push((
1638 next_capture_end,
1639 highlights.highlight_map.get(capture.index),
1640 ));
1641 }
1642 highlights.next_capture.take();
1643 }
1644 }
1645 highlights.captures.set_byte_range(self.range.clone());
1646 }
1647 }
1648
1649 pub fn offset(&self) -> usize {
1650 self.range.start
1651 }
1652
1653 fn update_diagnostic_depths(&mut self, endpoint: DiagnosticEndpoint) {
1654 let depth = match endpoint.severity {
1655 DiagnosticSeverity::ERROR => &mut self.error_depth,
1656 DiagnosticSeverity::WARNING => &mut self.warning_depth,
1657 DiagnosticSeverity::INFORMATION => &mut self.information_depth,
1658 DiagnosticSeverity::HINT => &mut self.hint_depth,
1659 _ => return,
1660 };
1661 if endpoint.is_start {
1662 *depth += 1;
1663 } else {
1664 *depth -= 1;
1665 }
1666 }
1667
1668 fn current_diagnostic_severity(&mut self) -> Option<DiagnosticSeverity> {
1669 if self.error_depth > 0 {
1670 Some(DiagnosticSeverity::ERROR)
1671 } else if self.warning_depth > 0 {
1672 Some(DiagnosticSeverity::WARNING)
1673 } else if self.information_depth > 0 {
1674 Some(DiagnosticSeverity::INFORMATION)
1675 } else if self.hint_depth > 0 {
1676 Some(DiagnosticSeverity::HINT)
1677 } else {
1678 None
1679 }
1680 }
1681}
1682
1683impl<'a> Iterator for HighlightedChunks<'a> {
1684 type Item = HighlightedChunk<'a>;
1685
1686 fn next(&mut self) -> Option<Self::Item> {
1687 let mut next_capture_start = usize::MAX;
1688 let mut next_diagnostic_endpoint = usize::MAX;
1689
1690 if let Some(highlights) = self.highlights.as_mut() {
1691 while let Some((parent_capture_end, _)) = highlights.stack.last() {
1692 if *parent_capture_end <= self.range.start {
1693 highlights.stack.pop();
1694 } else {
1695 break;
1696 }
1697 }
1698
1699 if highlights.next_capture.is_none() {
1700 highlights.next_capture = highlights.captures.next();
1701 }
1702
1703 while let Some((mat, capture_ix)) = highlights.next_capture.as_ref() {
1704 let capture = mat.captures[*capture_ix as usize];
1705 if self.range.start < capture.node.start_byte() {
1706 next_capture_start = capture.node.start_byte();
1707 break;
1708 } else {
1709 let highlight_id = highlights.highlight_map.get(capture.index);
1710 highlights
1711 .stack
1712 .push((capture.node.end_byte(), highlight_id));
1713 highlights.next_capture = highlights.captures.next();
1714 }
1715 }
1716 }
1717
1718 while let Some(endpoint) = self.diagnostic_endpoints.peek().copied() {
1719 if endpoint.offset <= self.range.start {
1720 self.update_diagnostic_depths(endpoint);
1721 self.diagnostic_endpoints.next();
1722 } else {
1723 next_diagnostic_endpoint = endpoint.offset;
1724 break;
1725 }
1726 }
1727
1728 if let Some(chunk) = self.chunks.peek() {
1729 let chunk_start = self.range.start;
1730 let mut chunk_end = (self.chunks.offset() + chunk.len())
1731 .min(next_capture_start)
1732 .min(next_diagnostic_endpoint);
1733 let mut highlight_id = HighlightId::default();
1734 if let Some((parent_capture_end, parent_highlight_id)) =
1735 self.highlights.as_ref().and_then(|h| h.stack.last())
1736 {
1737 chunk_end = chunk_end.min(*parent_capture_end);
1738 highlight_id = *parent_highlight_id;
1739 }
1740
1741 let slice =
1742 &chunk[chunk_start - self.chunks.offset()..chunk_end - self.chunks.offset()];
1743 self.range.start = chunk_end;
1744 if self.range.start == self.chunks.offset() + chunk.len() {
1745 self.chunks.next().unwrap();
1746 }
1747
1748 Some(HighlightedChunk {
1749 text: slice,
1750 highlight_id,
1751 diagnostic: self.current_diagnostic_severity(),
1752 })
1753 } else {
1754 None
1755 }
1756 }
1757}
1758
1759impl QueryCursorHandle {
1760 fn new() -> Self {
1761 QueryCursorHandle(Some(
1762 QUERY_CURSORS
1763 .lock()
1764 .pop()
1765 .unwrap_or_else(|| QueryCursor::new()),
1766 ))
1767 }
1768}
1769
1770impl Deref for QueryCursorHandle {
1771 type Target = QueryCursor;
1772
1773 fn deref(&self) -> &Self::Target {
1774 self.0.as_ref().unwrap()
1775 }
1776}
1777
1778impl DerefMut for QueryCursorHandle {
1779 fn deref_mut(&mut self) -> &mut Self::Target {
1780 self.0.as_mut().unwrap()
1781 }
1782}
1783
1784impl Drop for QueryCursorHandle {
1785 fn drop(&mut self) {
1786 let mut cursor = self.0.take().unwrap();
1787 cursor.set_byte_range(0..usize::MAX);
1788 cursor.set_point_range(Point::zero().to_ts_point()..Point::MAX.to_ts_point());
1789 QUERY_CURSORS.lock().push(cursor)
1790 }
1791}
1792
1793trait ToTreeSitterPoint {
1794 fn to_ts_point(self) -> tree_sitter::Point;
1795 fn from_ts_point(point: tree_sitter::Point) -> Self;
1796}
1797
1798impl ToTreeSitterPoint for Point {
1799 fn to_ts_point(self) -> tree_sitter::Point {
1800 tree_sitter::Point::new(self.row as usize, self.column as usize)
1801 }
1802
1803 fn from_ts_point(point: tree_sitter::Point) -> Self {
1804 Point::new(point.row as u32, point.column as u32)
1805 }
1806}
1807
1808fn contiguous_ranges(
1809 values: impl IntoIterator<Item = u32>,
1810 max_len: usize,
1811) -> impl Iterator<Item = Range<u32>> {
1812 let mut values = values.into_iter();
1813 let mut current_range: Option<Range<u32>> = None;
1814 std::iter::from_fn(move || loop {
1815 if let Some(value) = values.next() {
1816 if let Some(range) = &mut current_range {
1817 if value == range.end && range.len() < max_len {
1818 range.end += 1;
1819 continue;
1820 }
1821 }
1822
1823 let prev_range = current_range.clone();
1824 current_range = Some(value..(value + 1));
1825 if prev_range.is_some() {
1826 return prev_range;
1827 }
1828 } else {
1829 return current_range.take();
1830 }
1831 })
1832}