1#[cfg(test)]
2mod syntax_map_tests;
3
4use crate::{Grammar, InjectionConfig, Language, LanguageId, LanguageRegistry};
5use collections::HashMap;
6use futures::FutureExt;
7use parking_lot::Mutex;
8use std::{
9 borrow::Cow,
10 cmp::{self, Ordering, Reverse},
11 collections::BinaryHeap,
12 fmt, iter,
13 ops::{Deref, DerefMut, Range},
14 sync::Arc,
15};
16use sum_tree::{Bias, SeekTarget, SumTree};
17use text::{Anchor, BufferSnapshot, OffsetRangeExt, Point, Rope, ToOffset, ToPoint};
18use tree_sitter::{Node, Query, QueryCapture, QueryCaptures, QueryCursor, QueryMatches, Tree};
19
20use super::PARSER;
21
22static QUERY_CURSORS: Mutex<Vec<QueryCursor>> = Mutex::new(vec![]);
23
24#[derive(Default)]
25pub struct SyntaxMap {
26 snapshot: SyntaxSnapshot,
27 language_registry: Option<Arc<LanguageRegistry>>,
28}
29
30#[derive(Clone, Default)]
31pub struct SyntaxSnapshot {
32 layers: SumTree<SyntaxLayerEntry>,
33 parsed_version: clock::Global,
34 interpolated_version: clock::Global,
35 language_registry_version: usize,
36}
37
38#[derive(Default)]
39pub struct SyntaxMapCaptures<'a> {
40 layers: Vec<SyntaxMapCapturesLayer<'a>>,
41 active_layer_count: usize,
42 grammars: Vec<&'a Grammar>,
43}
44
45#[derive(Default)]
46pub struct SyntaxMapMatches<'a> {
47 layers: Vec<SyntaxMapMatchesLayer<'a>>,
48 active_layer_count: usize,
49 grammars: Vec<&'a Grammar>,
50}
51
52#[derive(Debug)]
53pub struct SyntaxMapCapture<'a> {
54 pub depth: usize,
55 pub node: Node<'a>,
56 pub index: u32,
57 pub grammar_index: usize,
58}
59
60#[derive(Debug)]
61pub struct SyntaxMapMatch<'a> {
62 pub depth: usize,
63 pub pattern_index: usize,
64 pub captures: &'a [QueryCapture<'a>],
65 pub grammar_index: usize,
66}
67
68struct SyntaxMapCapturesLayer<'a> {
69 depth: usize,
70 captures: QueryCaptures<'a, 'a, TextProvider<'a>, &'a [u8]>,
71 next_capture: Option<QueryCapture<'a>>,
72 grammar_index: usize,
73 _query_cursor: QueryCursorHandle,
74}
75
76struct SyntaxMapMatchesLayer<'a> {
77 depth: usize,
78 next_pattern_index: usize,
79 next_captures: Vec<QueryCapture<'a>>,
80 has_next: bool,
81 matches: QueryMatches<'a, 'a, TextProvider<'a>, &'a [u8]>,
82 grammar_index: usize,
83 _query_cursor: QueryCursorHandle,
84}
85
86#[derive(Clone)]
87struct SyntaxLayerEntry {
88 depth: usize,
89 range: Range<Anchor>,
90 content: SyntaxLayerContent,
91}
92
93#[derive(Clone)]
94enum SyntaxLayerContent {
95 Parsed {
96 tree: tree_sitter::Tree,
97 language: Arc<Language>,
98 },
99 Pending {
100 language_name: Arc<str>,
101 },
102}
103
104impl SyntaxLayerContent {
105 fn language_id(&self) -> Option<LanguageId> {
106 match self {
107 SyntaxLayerContent::Parsed { language, .. } => Some(language.id),
108 SyntaxLayerContent::Pending { .. } => None,
109 }
110 }
111
112 fn tree(&self) -> Option<&Tree> {
113 match self {
114 SyntaxLayerContent::Parsed { tree, .. } => Some(tree),
115 SyntaxLayerContent::Pending { .. } => None,
116 }
117 }
118}
119
120/// A layer of syntax highlighting, corresponding to a single syntax
121/// tree in a particular language.
122#[derive(Debug)]
123pub struct SyntaxLayer<'a> {
124 /// The language for this layer.
125 pub language: &'a Arc<Language>,
126 depth: usize,
127 tree: &'a Tree,
128 offset: (usize, tree_sitter::Point),
129}
130
131/// A layer of syntax highlighting. Like [SyntaxLayer], but holding
132/// owned data instead of references.
133#[derive(Clone)]
134pub struct OwnedSyntaxLayer {
135 /// The language for this layer.
136 pub language: Arc<Language>,
137 tree: tree_sitter::Tree,
138 offset: (usize, tree_sitter::Point),
139}
140
141#[derive(Debug, Clone)]
142struct SyntaxLayerSummary {
143 min_depth: usize,
144 max_depth: usize,
145 range: Range<Anchor>,
146 last_layer_range: Range<Anchor>,
147 last_layer_language: Option<LanguageId>,
148 contains_unknown_injections: bool,
149}
150
151#[derive(Clone, Debug)]
152struct SyntaxLayerPosition {
153 depth: usize,
154 range: Range<Anchor>,
155 language: Option<LanguageId>,
156}
157
158#[derive(Clone, Debug)]
159struct ChangeStartPosition {
160 depth: usize,
161 position: Anchor,
162}
163
164#[derive(Clone, Debug)]
165struct SyntaxLayerPositionBeforeChange {
166 position: SyntaxLayerPosition,
167 change: ChangeStartPosition,
168}
169
170struct ParseStep {
171 depth: usize,
172 language: ParseStepLanguage,
173 range: Range<Anchor>,
174 included_ranges: Vec<tree_sitter::Range>,
175 mode: ParseMode,
176}
177
178#[derive(Debug)]
179enum ParseStepLanguage {
180 Loaded { language: Arc<Language> },
181 Pending { name: Arc<str> },
182}
183
184impl ParseStepLanguage {
185 fn id(&self) -> Option<LanguageId> {
186 match self {
187 ParseStepLanguage::Loaded { language } => Some(language.id),
188 ParseStepLanguage::Pending { .. } => None,
189 }
190 }
191}
192
193enum ParseMode {
194 Single,
195 Combined {
196 parent_layer_range: Range<usize>,
197 parent_layer_changed_ranges: Vec<Range<usize>>,
198 },
199}
200
201#[derive(Debug, PartialEq, Eq)]
202struct ChangedRegion {
203 depth: usize,
204 range: Range<Anchor>,
205}
206
207#[derive(Default)]
208struct ChangeRegionSet(Vec<ChangedRegion>);
209
210struct TextProvider<'a>(&'a Rope);
211
212struct ByteChunks<'a>(text::Chunks<'a>);
213
214struct QueryCursorHandle(Option<QueryCursor>);
215
216impl SyntaxMap {
217 pub fn new() -> Self {
218 Self::default()
219 }
220
221 pub fn set_language_registry(&mut self, registry: Arc<LanguageRegistry>) {
222 self.language_registry = Some(registry);
223 }
224
225 pub fn snapshot(&self) -> SyntaxSnapshot {
226 self.snapshot.clone()
227 }
228
229 pub fn language_registry(&self) -> Option<Arc<LanguageRegistry>> {
230 self.language_registry.clone()
231 }
232
233 pub fn interpolate(&mut self, text: &BufferSnapshot) {
234 self.snapshot.interpolate(text);
235 }
236
237 #[cfg(test)]
238 pub fn reparse(&mut self, language: Arc<Language>, text: &BufferSnapshot) {
239 self.snapshot
240 .reparse(text, self.language_registry.clone(), language);
241 }
242
243 pub fn did_parse(&mut self, snapshot: SyntaxSnapshot) {
244 self.snapshot = snapshot;
245 }
246
247 pub fn clear(&mut self) {
248 self.snapshot = SyntaxSnapshot::default();
249 }
250}
251
252impl SyntaxSnapshot {
253 pub fn is_empty(&self) -> bool {
254 self.layers.is_empty()
255 }
256
257 fn interpolate(&mut self, text: &BufferSnapshot) {
258 let edits = text
259 .anchored_edits_since::<(usize, Point)>(&self.interpolated_version)
260 .collect::<Vec<_>>();
261 self.interpolated_version = text.version().clone();
262
263 if edits.is_empty() {
264 return;
265 }
266
267 let mut layers = SumTree::new();
268 let mut first_edit_ix_for_depth = 0;
269 let mut prev_depth = 0;
270 let mut cursor = self.layers.cursor::<SyntaxLayerSummary>();
271 cursor.next(text);
272
273 'outer: loop {
274 let depth = cursor.end(text).max_depth;
275 if depth > prev_depth {
276 first_edit_ix_for_depth = 0;
277 prev_depth = depth;
278 }
279
280 // Preserve any layers at this depth that precede the first edit.
281 if let Some((_, edit_range)) = edits.get(first_edit_ix_for_depth) {
282 let target = ChangeStartPosition {
283 depth,
284 position: edit_range.start,
285 };
286 if target.cmp(cursor.start(), text).is_gt() {
287 let slice = cursor.slice(&target, Bias::Left, text);
288 layers.append(slice, text);
289 }
290 }
291 // If this layer follows all of the edits, then preserve it and any
292 // subsequent layers at this same depth.
293 else if cursor.item().is_some() {
294 let slice = cursor.slice(
295 &SyntaxLayerPosition {
296 depth: depth + 1,
297 range: Anchor::MIN..Anchor::MAX,
298 language: None,
299 },
300 Bias::Left,
301 text,
302 );
303 layers.append(slice, text);
304 continue;
305 };
306
307 let Some(layer) = cursor.item() else { break };
308 let (start_byte, start_point) = layer.range.start.summary::<(usize, Point)>(text);
309
310 // Ignore edits that end before the start of this layer, and don't consider them
311 // for any subsequent layers at this same depth.
312 loop {
313 let Some((_, edit_range)) = edits.get(first_edit_ix_for_depth) else {
314 continue 'outer;
315 };
316 if edit_range.end.cmp(&layer.range.start, text).is_le() {
317 first_edit_ix_for_depth += 1;
318 } else {
319 break;
320 }
321 }
322
323 let mut layer = layer.clone();
324 if let SyntaxLayerContent::Parsed { tree, .. } = &mut layer.content {
325 for (edit, edit_range) in &edits[first_edit_ix_for_depth..] {
326 // Ignore any edits that follow this layer.
327 if edit_range.start.cmp(&layer.range.end, text).is_ge() {
328 break;
329 }
330
331 // Apply any edits that intersect this layer to the layer's syntax tree.
332 let tree_edit = if edit_range.start.cmp(&layer.range.start, text).is_ge() {
333 tree_sitter::InputEdit {
334 start_byte: edit.new.start.0 - start_byte,
335 old_end_byte: edit.new.start.0 - start_byte
336 + (edit.old.end.0 - edit.old.start.0),
337 new_end_byte: edit.new.end.0 - start_byte,
338 start_position: (edit.new.start.1 - start_point).to_ts_point(),
339 old_end_position: (edit.new.start.1 - start_point
340 + (edit.old.end.1 - edit.old.start.1))
341 .to_ts_point(),
342 new_end_position: (edit.new.end.1 - start_point).to_ts_point(),
343 }
344 } else {
345 let node = tree.root_node();
346 tree_sitter::InputEdit {
347 start_byte: 0,
348 old_end_byte: node.end_byte(),
349 new_end_byte: 0,
350 start_position: Default::default(),
351 old_end_position: node.end_position(),
352 new_end_position: Default::default(),
353 }
354 };
355
356 tree.edit(&tree_edit);
357 }
358
359 debug_assert!(
360 tree.root_node().end_byte() <= text.len(),
361 "tree's size {}, is larger than text size {}",
362 tree.root_node().end_byte(),
363 text.len(),
364 );
365 }
366
367 layers.push(layer, text);
368 cursor.next(text);
369 }
370
371 layers.append(cursor.suffix(text), text);
372 drop(cursor);
373 self.layers = layers;
374 }
375
376 pub fn reparse(
377 &mut self,
378 text: &BufferSnapshot,
379 registry: Option<Arc<LanguageRegistry>>,
380 root_language: Arc<Language>,
381 ) {
382 let edit_ranges = text
383 .edits_since::<usize>(&self.parsed_version)
384 .map(|edit| edit.new)
385 .collect::<Vec<_>>();
386 self.reparse_with_ranges(text, root_language.clone(), edit_ranges, registry.as_ref());
387
388 if let Some(registry) = registry {
389 if registry.version() != self.language_registry_version {
390 let mut resolved_injection_ranges = Vec::new();
391 let mut cursor = self
392 .layers
393 .filter::<_, ()>(|summary| summary.contains_unknown_injections);
394 cursor.next(text);
395 while let Some(layer) = cursor.item() {
396 let SyntaxLayerContent::Pending { language_name } = &layer.content else {
397 unreachable!()
398 };
399 if registry
400 .language_for_name_or_extension(language_name)
401 .now_or_never()
402 .and_then(|language| language.ok())
403 .is_some()
404 {
405 resolved_injection_ranges.push(layer.range.to_offset(text));
406 }
407
408 cursor.next(text);
409 }
410 drop(cursor);
411
412 if !resolved_injection_ranges.is_empty() {
413 self.reparse_with_ranges(
414 text,
415 root_language,
416 resolved_injection_ranges,
417 Some(®istry),
418 );
419 }
420 self.language_registry_version = registry.version();
421 }
422 }
423 }
424
425 fn reparse_with_ranges(
426 &mut self,
427 text: &BufferSnapshot,
428 root_language: Arc<Language>,
429 invalidated_ranges: Vec<Range<usize>>,
430 registry: Option<&Arc<LanguageRegistry>>,
431 ) {
432 log::trace!("reparse. invalidated ranges:{:?}", invalidated_ranges);
433
434 let max_depth = self.layers.summary().max_depth;
435 let mut cursor = self.layers.cursor::<SyntaxLayerSummary>();
436 cursor.next(text);
437 let mut layers = SumTree::new();
438
439 let mut changed_regions = ChangeRegionSet::default();
440 let mut queue = BinaryHeap::new();
441 let mut combined_injection_ranges = HashMap::default();
442 queue.push(ParseStep {
443 depth: 0,
444 language: ParseStepLanguage::Loaded {
445 language: root_language,
446 },
447 included_ranges: vec![tree_sitter::Range {
448 start_byte: 0,
449 end_byte: text.len(),
450 start_point: Point::zero().to_ts_point(),
451 end_point: text.max_point().to_ts_point(),
452 }],
453 range: Anchor::MIN..Anchor::MAX,
454 mode: ParseMode::Single,
455 });
456
457 loop {
458 let step = queue.pop();
459 let position = if let Some(step) = &step {
460 SyntaxLayerPosition {
461 depth: step.depth,
462 range: step.range.clone(),
463 language: step.language.id(),
464 }
465 } else {
466 SyntaxLayerPosition {
467 depth: max_depth + 1,
468 range: Anchor::MAX..Anchor::MAX,
469 language: None,
470 }
471 };
472
473 let mut done = cursor.item().is_none();
474 while !done && position.cmp(&cursor.end(text), text).is_gt() {
475 done = true;
476
477 let bounded_position = SyntaxLayerPositionBeforeChange {
478 position: position.clone(),
479 change: changed_regions.start_position(),
480 };
481 if bounded_position.cmp(cursor.start(), text).is_gt() {
482 let slice = cursor.slice(&bounded_position, Bias::Left, text);
483 if !slice.is_empty() {
484 layers.append(slice, text);
485 if changed_regions.prune(cursor.end(text), text) {
486 done = false;
487 }
488 }
489 }
490
491 while position.cmp(&cursor.end(text), text).is_gt() {
492 let Some(layer) = cursor.item() else { break };
493
494 if changed_regions.intersects(layer, text) {
495 if let SyntaxLayerContent::Parsed { language, .. } = &layer.content {
496 log::trace!(
497 "discard layer. language:{}, range:{:?}. changed_regions:{:?}",
498 language.name(),
499 LogAnchorRange(&layer.range, text),
500 LogChangedRegions(&changed_regions, text),
501 );
502 }
503
504 changed_regions.insert(
505 ChangedRegion {
506 depth: layer.depth + 1,
507 range: layer.range.clone(),
508 },
509 text,
510 );
511 } else {
512 layers.push(layer.clone(), text);
513 }
514
515 cursor.next(text);
516 if changed_regions.prune(cursor.end(text), text) {
517 done = false;
518 }
519 }
520 }
521
522 let Some(step) = step else { break };
523 let (step_start_byte, step_start_point) =
524 step.range.start.summary::<(usize, Point)>(text);
525 let step_end_byte = step.range.end.to_offset(text);
526
527 let mut old_layer = cursor.item();
528 if let Some(layer) = old_layer {
529 if layer.range.to_offset(text) == (step_start_byte..step_end_byte)
530 && layer.content.language_id() == step.language.id()
531 {
532 cursor.next(text);
533 } else {
534 old_layer = None;
535 }
536 }
537
538 let content = match step.language {
539 ParseStepLanguage::Loaded { language } => {
540 let Some(grammar) = language.grammar() else {
541 continue;
542 };
543 let tree;
544 let changed_ranges;
545
546 let mut included_ranges = step.included_ranges;
547 for range in &mut included_ranges {
548 range.start_byte -= step_start_byte;
549 range.end_byte -= step_start_byte;
550 range.start_point = (Point::from_ts_point(range.start_point)
551 - step_start_point)
552 .to_ts_point();
553 range.end_point = (Point::from_ts_point(range.end_point)
554 - step_start_point)
555 .to_ts_point();
556 }
557
558 if let Some((SyntaxLayerContent::Parsed { tree: old_tree, .. }, layer_start)) =
559 old_layer.map(|layer| (&layer.content, layer.range.start))
560 {
561 log::trace!(
562 "existing layer. language:{}, start:{:?}, ranges:{:?}",
563 language.name(),
564 LogPoint(layer_start.to_point(text)),
565 LogIncludedRanges(&old_tree.included_ranges())
566 );
567
568 if let ParseMode::Combined {
569 mut parent_layer_changed_ranges,
570 ..
571 } = step.mode
572 {
573 for range in &mut parent_layer_changed_ranges {
574 range.start = range.start.saturating_sub(step_start_byte);
575 range.end = range.end.saturating_sub(step_start_byte);
576 }
577
578 let changed_indices;
579 (included_ranges, changed_indices) = splice_included_ranges(
580 old_tree.included_ranges(),
581 &parent_layer_changed_ranges,
582 &included_ranges,
583 );
584 insert_newlines_between_ranges(
585 changed_indices,
586 &mut included_ranges,
587 text,
588 step_start_byte,
589 step_start_point,
590 );
591 }
592
593 if included_ranges.is_empty() {
594 included_ranges.push(tree_sitter::Range {
595 start_byte: 0,
596 end_byte: 0,
597 start_point: Default::default(),
598 end_point: Default::default(),
599 });
600 }
601
602 log::trace!(
603 "update layer. language:{}, start:{:?}, included_ranges:{:?}",
604 language.name(),
605 LogAnchorRange(&step.range, text),
606 LogIncludedRanges(&included_ranges),
607 );
608
609 tree = parse_text(
610 grammar,
611 text.as_rope(),
612 step_start_byte,
613 included_ranges,
614 Some(old_tree.clone()),
615 );
616 changed_ranges = join_ranges(
617 invalidated_ranges
618 .iter()
619 .filter(|&range| {
620 range.start <= step_end_byte && range.end >= step_start_byte
621 })
622 .cloned(),
623 old_tree.changed_ranges(&tree).map(|r| {
624 step_start_byte + r.start_byte..step_start_byte + r.end_byte
625 }),
626 );
627 } else {
628 if matches!(step.mode, ParseMode::Combined { .. }) {
629 insert_newlines_between_ranges(
630 0..included_ranges.len(),
631 &mut included_ranges,
632 text,
633 step_start_byte,
634 step_start_point,
635 );
636 }
637
638 if included_ranges.is_empty() {
639 included_ranges.push(tree_sitter::Range {
640 start_byte: 0,
641 end_byte: 0,
642 start_point: Default::default(),
643 end_point: Default::default(),
644 });
645 }
646
647 log::trace!(
648 "create layer. language:{}, range:{:?}, included_ranges:{:?}",
649 language.name(),
650 LogAnchorRange(&step.range, text),
651 LogIncludedRanges(&included_ranges),
652 );
653
654 tree = parse_text(
655 grammar,
656 text.as_rope(),
657 step_start_byte,
658 included_ranges,
659 None,
660 );
661 changed_ranges = vec![step_start_byte..step_end_byte];
662 }
663
664 if let (Some((config, registry)), false) = (
665 grammar.injection_config.as_ref().zip(registry.as_ref()),
666 changed_ranges.is_empty(),
667 ) {
668 for range in &changed_ranges {
669 changed_regions.insert(
670 ChangedRegion {
671 depth: step.depth + 1,
672 range: text.anchor_before(range.start)
673 ..text.anchor_after(range.end),
674 },
675 text,
676 );
677 }
678 get_injections(
679 config,
680 text,
681 step.range.clone(),
682 tree.root_node_with_offset(
683 step_start_byte,
684 step_start_point.to_ts_point(),
685 ),
686 registry,
687 step.depth + 1,
688 &changed_ranges,
689 &mut combined_injection_ranges,
690 &mut queue,
691 );
692 }
693
694 SyntaxLayerContent::Parsed { tree, language }
695 }
696 ParseStepLanguage::Pending { name } => SyntaxLayerContent::Pending {
697 language_name: name,
698 },
699 };
700
701 layers.push(
702 SyntaxLayerEntry {
703 depth: step.depth,
704 range: step.range,
705 content,
706 },
707 text,
708 );
709 }
710
711 drop(cursor);
712 self.layers = layers;
713 self.interpolated_version = text.version.clone();
714 self.parsed_version = text.version.clone();
715 #[cfg(debug_assertions)]
716 self.check_invariants(text);
717 }
718
719 #[cfg(debug_assertions)]
720 fn check_invariants(&self, text: &BufferSnapshot) {
721 let mut max_depth = 0;
722 let mut prev_range: Option<Range<Anchor>> = None;
723 for layer in self.layers.iter() {
724 if layer.depth == max_depth {
725 if let Some(prev_range) = prev_range {
726 match layer.range.start.cmp(&prev_range.start, text) {
727 Ordering::Less => panic!("layers out of order"),
728 Ordering::Equal => {
729 assert!(layer.range.end.cmp(&prev_range.end, text).is_ge())
730 }
731 Ordering::Greater => {}
732 }
733 }
734 } else if layer.depth < max_depth {
735 panic!("layers out of order")
736 }
737 max_depth = layer.depth;
738 prev_range = Some(layer.range.clone());
739 }
740 }
741
742 pub fn single_tree_captures<'a>(
743 range: Range<usize>,
744 text: &'a Rope,
745 tree: &'a Tree,
746 language: &'a Arc<Language>,
747 query: fn(&Grammar) -> Option<&Query>,
748 ) -> SyntaxMapCaptures<'a> {
749 SyntaxMapCaptures::new(
750 range.clone(),
751 text,
752 [SyntaxLayer {
753 language,
754 tree,
755 depth: 0,
756 offset: (0, tree_sitter::Point::new(0, 0)),
757 }]
758 .into_iter(),
759 query,
760 )
761 }
762
763 pub fn captures<'a>(
764 &'a self,
765 range: Range<usize>,
766 buffer: &'a BufferSnapshot,
767 query: fn(&Grammar) -> Option<&Query>,
768 ) -> SyntaxMapCaptures {
769 SyntaxMapCaptures::new(
770 range.clone(),
771 buffer.as_rope(),
772 self.layers_for_range(range, buffer),
773 query,
774 )
775 }
776
777 pub fn matches<'a>(
778 &'a self,
779 range: Range<usize>,
780 buffer: &'a BufferSnapshot,
781 query: fn(&Grammar) -> Option<&Query>,
782 ) -> SyntaxMapMatches {
783 SyntaxMapMatches::new(
784 range.clone(),
785 buffer.as_rope(),
786 self.layers_for_range(range, buffer),
787 query,
788 )
789 }
790
791 #[cfg(test)]
792 pub fn layers<'a>(&'a self, buffer: &'a BufferSnapshot) -> Vec<SyntaxLayer> {
793 self.layers_for_range(0..buffer.len(), buffer).collect()
794 }
795
796 pub fn layers_for_range<'a, T: ToOffset>(
797 &'a self,
798 range: Range<T>,
799 buffer: &'a BufferSnapshot,
800 ) -> impl 'a + Iterator<Item = SyntaxLayer> {
801 let start_offset = range.start.to_offset(buffer);
802 let end_offset = range.end.to_offset(buffer);
803 let start = buffer.anchor_before(start_offset);
804 let end = buffer.anchor_after(end_offset);
805
806 let mut cursor = self.layers.filter::<_, ()>(move |summary| {
807 if summary.max_depth > summary.min_depth {
808 true
809 } else {
810 let is_before_start = summary.range.end.cmp(&start, buffer).is_lt();
811 let is_after_end = summary.range.start.cmp(&end, buffer).is_gt();
812 !is_before_start && !is_after_end
813 }
814 });
815
816 cursor.next(buffer);
817 iter::from_fn(move || {
818 while let Some(layer) = cursor.item() {
819 let mut info = None;
820 if let SyntaxLayerContent::Parsed { tree, language } = &layer.content {
821 let layer_start_offset = layer.range.start.to_offset(buffer);
822 let layer_start_point = layer.range.start.to_point(buffer).to_ts_point();
823
824 info = Some(SyntaxLayer {
825 tree,
826 language,
827 depth: layer.depth,
828 offset: (layer_start_offset, layer_start_point),
829 });
830 }
831 cursor.next(buffer);
832 if info.is_some() {
833 return info;
834 }
835 }
836 None
837 })
838 }
839
840 pub fn contains_unknown_injections(&self) -> bool {
841 self.layers.summary().contains_unknown_injections
842 }
843
844 pub fn language_registry_version(&self) -> usize {
845 self.language_registry_version
846 }
847}
848
849impl<'a> SyntaxMapCaptures<'a> {
850 fn new(
851 range: Range<usize>,
852 text: &'a Rope,
853 layers: impl Iterator<Item = SyntaxLayer<'a>>,
854 query: fn(&Grammar) -> Option<&Query>,
855 ) -> Self {
856 let mut result = Self {
857 layers: Vec::new(),
858 grammars: Vec::new(),
859 active_layer_count: 0,
860 };
861 for layer in layers {
862 let grammar = match &layer.language.grammar {
863 Some(grammar) => grammar,
864 None => continue,
865 };
866 let query = match query(grammar) {
867 Some(query) => query,
868 None => continue,
869 };
870
871 let mut query_cursor = QueryCursorHandle::new();
872
873 // TODO - add a Tree-sitter API to remove the need for this.
874 let cursor = unsafe {
875 std::mem::transmute::<_, &'static mut QueryCursor>(query_cursor.deref_mut())
876 };
877
878 cursor.set_byte_range(range.clone());
879 let captures = cursor.captures(query, layer.node(), TextProvider(text));
880 let grammar_index = result
881 .grammars
882 .iter()
883 .position(|g| g.id == grammar.id())
884 .unwrap_or_else(|| {
885 result.grammars.push(grammar);
886 result.grammars.len() - 1
887 });
888 let mut layer = SyntaxMapCapturesLayer {
889 depth: layer.depth,
890 grammar_index,
891 next_capture: None,
892 captures,
893 _query_cursor: query_cursor,
894 };
895
896 layer.advance();
897 if layer.next_capture.is_some() {
898 let key = layer.sort_key();
899 let ix = match result.layers[..result.active_layer_count]
900 .binary_search_by_key(&key, |layer| layer.sort_key())
901 {
902 Ok(ix) | Err(ix) => ix,
903 };
904 result.layers.insert(ix, layer);
905 result.active_layer_count += 1;
906 } else {
907 result.layers.push(layer);
908 }
909 }
910
911 result
912 }
913
914 pub fn grammars(&self) -> &[&'a Grammar] {
915 &self.grammars
916 }
917
918 pub fn peek(&self) -> Option<SyntaxMapCapture<'a>> {
919 let layer = self.layers[..self.active_layer_count].first()?;
920 let capture = layer.next_capture?;
921 Some(SyntaxMapCapture {
922 depth: layer.depth,
923 grammar_index: layer.grammar_index,
924 index: capture.index,
925 node: capture.node,
926 })
927 }
928
929 pub fn advance(&mut self) -> bool {
930 let layer = if let Some(layer) = self.layers[..self.active_layer_count].first_mut() {
931 layer
932 } else {
933 return false;
934 };
935
936 layer.advance();
937 if layer.next_capture.is_some() {
938 let key = layer.sort_key();
939 let i = 1 + self.layers[1..self.active_layer_count]
940 .iter()
941 .position(|later_layer| key < later_layer.sort_key())
942 .unwrap_or(self.active_layer_count - 1);
943 self.layers[0..i].rotate_left(1);
944 } else {
945 self.layers[0..self.active_layer_count].rotate_left(1);
946 self.active_layer_count -= 1;
947 }
948
949 true
950 }
951
952 pub fn set_byte_range(&mut self, range: Range<usize>) {
953 for layer in &mut self.layers {
954 layer.captures.set_byte_range(range.clone());
955 if let Some(capture) = &layer.next_capture {
956 if capture.node.end_byte() > range.start {
957 continue;
958 }
959 }
960 layer.advance();
961 }
962 self.layers.sort_unstable_by_key(|layer| layer.sort_key());
963 self.active_layer_count = self
964 .layers
965 .iter()
966 .position(|layer| layer.next_capture.is_none())
967 .unwrap_or(self.layers.len());
968 }
969}
970
971impl<'a> SyntaxMapMatches<'a> {
972 fn new(
973 range: Range<usize>,
974 text: &'a Rope,
975 layers: impl Iterator<Item = SyntaxLayer<'a>>,
976 query: fn(&Grammar) -> Option<&Query>,
977 ) -> Self {
978 let mut result = Self::default();
979 for layer in layers {
980 let grammar = match &layer.language.grammar {
981 Some(grammar) => grammar,
982 None => continue,
983 };
984 let query = match query(grammar) {
985 Some(query) => query,
986 None => continue,
987 };
988
989 let mut query_cursor = QueryCursorHandle::new();
990
991 // TODO - add a Tree-sitter API to remove the need for this.
992 let cursor = unsafe {
993 std::mem::transmute::<_, &'static mut QueryCursor>(query_cursor.deref_mut())
994 };
995
996 cursor.set_byte_range(range.clone());
997 let matches = cursor.matches(query, layer.node(), TextProvider(text));
998 let grammar_index = result
999 .grammars
1000 .iter()
1001 .position(|g| g.id == grammar.id())
1002 .unwrap_or_else(|| {
1003 result.grammars.push(grammar);
1004 result.grammars.len() - 1
1005 });
1006 let mut layer = SyntaxMapMatchesLayer {
1007 depth: layer.depth,
1008 grammar_index,
1009 matches,
1010 next_pattern_index: 0,
1011 next_captures: Vec::new(),
1012 has_next: false,
1013 _query_cursor: query_cursor,
1014 };
1015
1016 layer.advance();
1017 if layer.has_next {
1018 let key = layer.sort_key();
1019 let ix = match result.layers[..result.active_layer_count]
1020 .binary_search_by_key(&key, |layer| layer.sort_key())
1021 {
1022 Ok(ix) | Err(ix) => ix,
1023 };
1024 result.layers.insert(ix, layer);
1025 result.active_layer_count += 1;
1026 } else {
1027 result.layers.push(layer);
1028 }
1029 }
1030 result
1031 }
1032
1033 pub fn grammars(&self) -> &[&'a Grammar] {
1034 &self.grammars
1035 }
1036
1037 pub fn peek(&self) -> Option<SyntaxMapMatch> {
1038 let layer = self.layers.first()?;
1039 if !layer.has_next {
1040 return None;
1041 }
1042 Some(SyntaxMapMatch {
1043 depth: layer.depth,
1044 grammar_index: layer.grammar_index,
1045 pattern_index: layer.next_pattern_index,
1046 captures: &layer.next_captures,
1047 })
1048 }
1049
1050 pub fn advance(&mut self) -> bool {
1051 let layer = if let Some(layer) = self.layers.first_mut() {
1052 layer
1053 } else {
1054 return false;
1055 };
1056
1057 layer.advance();
1058 if layer.has_next {
1059 let key = layer.sort_key();
1060 let i = 1 + self.layers[1..self.active_layer_count]
1061 .iter()
1062 .position(|later_layer| key < later_layer.sort_key())
1063 .unwrap_or(self.active_layer_count - 1);
1064 self.layers[0..i].rotate_left(1);
1065 } else if self.active_layer_count != 0 {
1066 self.layers[0..self.active_layer_count].rotate_left(1);
1067 self.active_layer_count -= 1;
1068 }
1069
1070 true
1071 }
1072}
1073
1074impl<'a> SyntaxMapCapturesLayer<'a> {
1075 fn advance(&mut self) {
1076 self.next_capture = self.captures.next().map(|(mat, ix)| mat.captures[ix]);
1077 }
1078
1079 fn sort_key(&self) -> (usize, Reverse<usize>, usize) {
1080 if let Some(capture) = &self.next_capture {
1081 let range = capture.node.byte_range();
1082 (range.start, Reverse(range.end), self.depth)
1083 } else {
1084 (usize::MAX, Reverse(0), usize::MAX)
1085 }
1086 }
1087}
1088
1089impl<'a> SyntaxMapMatchesLayer<'a> {
1090 fn advance(&mut self) {
1091 if let Some(mat) = self.matches.next() {
1092 self.next_captures.clear();
1093 self.next_captures.extend_from_slice(mat.captures);
1094 self.next_pattern_index = mat.pattern_index;
1095 self.has_next = true;
1096 } else {
1097 self.has_next = false;
1098 }
1099 }
1100
1101 fn sort_key(&self) -> (usize, Reverse<usize>, usize) {
1102 if self.has_next {
1103 let captures = &self.next_captures;
1104 if let Some((first, last)) = captures.first().zip(captures.last()) {
1105 return (
1106 first.node.start_byte(),
1107 Reverse(last.node.end_byte()),
1108 self.depth,
1109 );
1110 }
1111 }
1112 (usize::MAX, Reverse(0), usize::MAX)
1113 }
1114}
1115
1116impl<'a> Iterator for SyntaxMapCaptures<'a> {
1117 type Item = SyntaxMapCapture<'a>;
1118
1119 fn next(&mut self) -> Option<Self::Item> {
1120 let result = self.peek();
1121 self.advance();
1122 result
1123 }
1124}
1125
1126fn join_ranges(
1127 a: impl Iterator<Item = Range<usize>>,
1128 b: impl Iterator<Item = Range<usize>>,
1129) -> Vec<Range<usize>> {
1130 let mut result = Vec::<Range<usize>>::new();
1131 let mut a = a.peekable();
1132 let mut b = b.peekable();
1133 loop {
1134 let range = match (a.peek(), b.peek()) {
1135 (Some(range_a), Some(range_b)) => {
1136 if range_a.start < range_b.start {
1137 a.next().unwrap()
1138 } else {
1139 b.next().unwrap()
1140 }
1141 }
1142 (None, Some(_)) => b.next().unwrap(),
1143 (Some(_), None) => a.next().unwrap(),
1144 (None, None) => break,
1145 };
1146
1147 if let Some(last) = result.last_mut() {
1148 if range.start <= last.end {
1149 last.end = last.end.max(range.end);
1150 continue;
1151 }
1152 }
1153 result.push(range);
1154 }
1155 result
1156}
1157
1158fn parse_text(
1159 grammar: &Grammar,
1160 text: &Rope,
1161 start_byte: usize,
1162 ranges: Vec<tree_sitter::Range>,
1163 old_tree: Option<Tree>,
1164) -> Tree {
1165 PARSER.with(|parser| {
1166 let mut parser = parser.borrow_mut();
1167 let mut chunks = text.chunks_in_range(start_byte..text.len());
1168 parser
1169 .set_included_ranges(&ranges)
1170 .expect("overlapping ranges");
1171 parser
1172 .set_language(&grammar.ts_language)
1173 .expect("incompatible grammar");
1174 parser
1175 .parse_with(
1176 &mut move |offset, _| {
1177 chunks.seek(start_byte + offset);
1178 chunks.next().unwrap_or("").as_bytes()
1179 },
1180 old_tree.as_ref(),
1181 )
1182 .expect("invalid language")
1183 })
1184}
1185
1186#[allow(clippy::too_many_arguments)]
1187fn get_injections(
1188 config: &InjectionConfig,
1189 text: &BufferSnapshot,
1190 outer_range: Range<Anchor>,
1191 node: Node,
1192 language_registry: &Arc<LanguageRegistry>,
1193 depth: usize,
1194 changed_ranges: &[Range<usize>],
1195 combined_injection_ranges: &mut HashMap<Arc<Language>, Vec<tree_sitter::Range>>,
1196 queue: &mut BinaryHeap<ParseStep>,
1197) {
1198 let mut query_cursor = QueryCursorHandle::new();
1199 let mut prev_match = None;
1200
1201 // Ensure that a `ParseStep` is created for every combined injection language, even
1202 // if there currently no matches for that injection.
1203 combined_injection_ranges.clear();
1204 for pattern in &config.patterns {
1205 if let (Some(language_name), true) = (pattern.language.as_ref(), pattern.combined) {
1206 if let Some(language) = language_registry
1207 .language_for_name_or_extension(language_name)
1208 .now_or_never()
1209 .and_then(|language| language.ok())
1210 {
1211 combined_injection_ranges.insert(language, Vec::new());
1212 }
1213 }
1214 }
1215
1216 for query_range in changed_ranges {
1217 query_cursor.set_byte_range(query_range.start.saturating_sub(1)..query_range.end + 1);
1218 for mat in query_cursor.matches(&config.query, node, TextProvider(text.as_rope())) {
1219 let content_ranges = mat
1220 .nodes_for_capture_index(config.content_capture_ix)
1221 .map(|node| node.range())
1222 .collect::<Vec<_>>();
1223 if content_ranges.is_empty() {
1224 continue;
1225 }
1226
1227 let content_range =
1228 content_ranges.first().unwrap().start_byte..content_ranges.last().unwrap().end_byte;
1229
1230 // Avoid duplicate matches if two changed ranges intersect the same injection.
1231 if let Some((prev_pattern_ix, prev_range)) = &prev_match {
1232 if mat.pattern_index == *prev_pattern_ix && content_range == *prev_range {
1233 continue;
1234 }
1235 }
1236
1237 prev_match = Some((mat.pattern_index, content_range.clone()));
1238 let combined = config.patterns[mat.pattern_index].combined;
1239
1240 let mut language_name = None;
1241 let mut step_range = content_range.clone();
1242 if let Some(name) = config.patterns[mat.pattern_index].language.as_ref() {
1243 language_name = Some(Cow::Borrowed(name.as_ref()))
1244 } else if let Some(language_node) = config
1245 .language_capture_ix
1246 .and_then(|ix| mat.nodes_for_capture_index(ix).next())
1247 {
1248 step_range.start = cmp::min(content_range.start, language_node.start_byte());
1249 step_range.end = cmp::max(content_range.end, language_node.end_byte());
1250 language_name = Some(Cow::Owned(
1251 text.text_for_range(language_node.byte_range()).collect(),
1252 ))
1253 };
1254
1255 if let Some(language_name) = language_name {
1256 let language = language_registry
1257 .language_for_name_or_extension(&language_name)
1258 .now_or_never()
1259 .and_then(|language| language.ok());
1260 let range = text.anchor_before(step_range.start)..text.anchor_after(step_range.end);
1261 if let Some(language) = language {
1262 if combined {
1263 combined_injection_ranges
1264 .entry(language.clone())
1265 .or_default()
1266 .extend(content_ranges);
1267 } else {
1268 queue.push(ParseStep {
1269 depth,
1270 language: ParseStepLanguage::Loaded { language },
1271 included_ranges: content_ranges,
1272 range,
1273 mode: ParseMode::Single,
1274 });
1275 }
1276 } else {
1277 queue.push(ParseStep {
1278 depth,
1279 language: ParseStepLanguage::Pending {
1280 name: language_name.into(),
1281 },
1282 included_ranges: content_ranges,
1283 range,
1284 mode: ParseMode::Single,
1285 });
1286 }
1287 }
1288 }
1289 }
1290
1291 for (language, mut included_ranges) in combined_injection_ranges.drain() {
1292 included_ranges.sort_unstable_by(|a, b| {
1293 Ord::cmp(&a.start_byte, &b.start_byte).then_with(|| Ord::cmp(&a.end_byte, &b.end_byte))
1294 });
1295 queue.push(ParseStep {
1296 depth,
1297 language: ParseStepLanguage::Loaded { language },
1298 range: outer_range.clone(),
1299 included_ranges,
1300 mode: ParseMode::Combined {
1301 parent_layer_range: node.start_byte()..node.end_byte(),
1302 parent_layer_changed_ranges: changed_ranges.to_vec(),
1303 },
1304 })
1305 }
1306}
1307
1308/// Updates the given list of included `ranges`, removing any ranges that intersect
1309/// `removed_ranges`, and inserting the given `new_ranges`.
1310///
1311/// Returns a new vector of ranges, and the range of the vector that was changed,
1312/// from the previous `ranges` vector.
1313pub(crate) fn splice_included_ranges(
1314 mut ranges: Vec<tree_sitter::Range>,
1315 removed_ranges: &[Range<usize>],
1316 new_ranges: &[tree_sitter::Range],
1317) -> (Vec<tree_sitter::Range>, Range<usize>) {
1318 let mut removed_ranges = removed_ranges.iter().cloned().peekable();
1319 let mut new_ranges = new_ranges.into_iter().cloned().peekable();
1320 let mut ranges_ix = 0;
1321 let mut changed_portion = usize::MAX..0;
1322 loop {
1323 let next_new_range = new_ranges.peek();
1324 let next_removed_range = removed_ranges.peek();
1325
1326 let (remove, insert) = match (next_removed_range, next_new_range) {
1327 (None, None) => break,
1328 (Some(_), None) => (removed_ranges.next().unwrap(), None),
1329 (Some(next_removed_range), Some(next_new_range)) => {
1330 if next_removed_range.end < next_new_range.start_byte {
1331 (removed_ranges.next().unwrap(), None)
1332 } else {
1333 let mut start = next_new_range.start_byte;
1334 let mut end = next_new_range.end_byte;
1335
1336 while let Some(next_removed_range) = removed_ranges.peek() {
1337 if next_removed_range.start > next_new_range.end_byte {
1338 break;
1339 }
1340 let next_removed_range = removed_ranges.next().unwrap();
1341 start = cmp::min(start, next_removed_range.start);
1342 end = cmp::max(end, next_removed_range.end);
1343 }
1344
1345 (start..end, Some(new_ranges.next().unwrap()))
1346 }
1347 }
1348 (None, Some(next_new_range)) => (
1349 next_new_range.start_byte..next_new_range.end_byte,
1350 Some(new_ranges.next().unwrap()),
1351 ),
1352 };
1353
1354 let mut start_ix = ranges_ix
1355 + match ranges[ranges_ix..].binary_search_by_key(&remove.start, |r| r.end_byte) {
1356 Ok(ix) => ix,
1357 Err(ix) => ix,
1358 };
1359 let mut end_ix = ranges_ix
1360 + match ranges[ranges_ix..].binary_search_by_key(&remove.end, |r| r.start_byte) {
1361 Ok(ix) => ix + 1,
1362 Err(ix) => ix,
1363 };
1364
1365 // If there are empty ranges, then there may be multiple ranges with the same
1366 // start or end. Expand the splice to include any adjacent ranges that touch
1367 // the changed range.
1368 while start_ix > 0 {
1369 if ranges[start_ix - 1].end_byte == remove.start {
1370 start_ix -= 1;
1371 } else {
1372 break;
1373 }
1374 }
1375 while let Some(range) = ranges.get(end_ix) {
1376 if range.start_byte == remove.end {
1377 end_ix += 1;
1378 } else {
1379 break;
1380 }
1381 }
1382
1383 changed_portion.start = changed_portion.start.min(start_ix);
1384 changed_portion.end = changed_portion.end.max(if insert.is_some() {
1385 start_ix + 1
1386 } else {
1387 start_ix
1388 });
1389
1390 ranges.splice(start_ix..end_ix, insert);
1391 ranges_ix = start_ix;
1392 }
1393
1394 if changed_portion.end < changed_portion.start {
1395 changed_portion = 0..0;
1396 }
1397
1398 (ranges, changed_portion)
1399}
1400
1401/// Ensure there are newline ranges in between content range that appear on
1402/// different lines. For performance, only iterate through the given range of
1403/// indices. All of the ranges in the array are relative to a given start byte
1404/// and point.
1405fn insert_newlines_between_ranges(
1406 indices: Range<usize>,
1407 ranges: &mut Vec<tree_sitter::Range>,
1408 text: &text::BufferSnapshot,
1409 start_byte: usize,
1410 start_point: Point,
1411) {
1412 let mut ix = indices.end + 1;
1413 while ix > indices.start {
1414 ix -= 1;
1415 if 0 == ix || ix == ranges.len() {
1416 continue;
1417 }
1418
1419 let range_b = ranges[ix];
1420 let range_a = &mut ranges[ix - 1];
1421 if range_a.end_point.column == 0 {
1422 continue;
1423 }
1424
1425 if range_a.end_point.row < range_b.start_point.row {
1426 let end_point = start_point + Point::from_ts_point(range_a.end_point);
1427 let line_end = Point::new(end_point.row, text.line_len(end_point.row));
1428 if end_point.column >= line_end.column {
1429 range_a.end_byte += 1;
1430 range_a.end_point.row += 1;
1431 range_a.end_point.column = 0;
1432 } else {
1433 let newline_offset = text.point_to_offset(line_end);
1434 ranges.insert(
1435 ix,
1436 tree_sitter::Range {
1437 start_byte: newline_offset - start_byte,
1438 end_byte: newline_offset - start_byte + 1,
1439 start_point: (line_end - start_point).to_ts_point(),
1440 end_point: ((line_end - start_point) + Point::new(1, 0)).to_ts_point(),
1441 },
1442 )
1443 }
1444 }
1445 }
1446}
1447
1448impl OwnedSyntaxLayer {
1449 /// Returns the root syntax node for this layer.
1450 pub fn node(&self) -> Node {
1451 self.tree
1452 .root_node_with_offset(self.offset.0, self.offset.1)
1453 }
1454}
1455
1456impl<'a> SyntaxLayer<'a> {
1457 /// Returns an owned version of this layer.
1458 pub fn to_owned(&self) -> OwnedSyntaxLayer {
1459 OwnedSyntaxLayer {
1460 tree: self.tree.clone(),
1461 offset: self.offset,
1462 language: self.language.clone(),
1463 }
1464 }
1465
1466 /// Returns the root node for this layer.
1467 pub fn node(&self) -> Node<'a> {
1468 self.tree
1469 .root_node_with_offset(self.offset.0, self.offset.1)
1470 }
1471
1472 pub(crate) fn override_id(&self, offset: usize, text: &text::BufferSnapshot) -> Option<u32> {
1473 let text = TextProvider(text.as_rope());
1474 let config = self.language.grammar.as_ref()?.override_config.as_ref()?;
1475
1476 let mut query_cursor = QueryCursorHandle::new();
1477 query_cursor.set_byte_range(offset..offset);
1478
1479 let mut smallest_match: Option<(u32, Range<usize>)> = None;
1480 for mat in query_cursor.matches(&config.query, self.node(), text) {
1481 for capture in mat.captures {
1482 if !config.values.contains_key(&capture.index) {
1483 continue;
1484 }
1485
1486 let range = capture.node.byte_range();
1487 if offset <= range.start || offset >= range.end {
1488 continue;
1489 }
1490
1491 if let Some((_, smallest_range)) = &smallest_match {
1492 if range.len() < smallest_range.len() {
1493 smallest_match = Some((capture.index, range))
1494 }
1495 continue;
1496 }
1497
1498 smallest_match = Some((capture.index, range));
1499 }
1500 }
1501
1502 smallest_match.map(|(index, _)| index)
1503 }
1504}
1505
1506impl std::ops::Deref for SyntaxMap {
1507 type Target = SyntaxSnapshot;
1508
1509 fn deref(&self) -> &Self::Target {
1510 &self.snapshot
1511 }
1512}
1513
1514impl PartialEq for ParseStep {
1515 fn eq(&self, _: &Self) -> bool {
1516 false
1517 }
1518}
1519
1520impl Eq for ParseStep {}
1521
1522impl PartialOrd for ParseStep {
1523 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1524 Some(self.cmp(other))
1525 }
1526}
1527
1528impl Ord for ParseStep {
1529 fn cmp(&self, other: &Self) -> Ordering {
1530 let range_a = self.range();
1531 let range_b = other.range();
1532 Ord::cmp(&other.depth, &self.depth)
1533 .then_with(|| Ord::cmp(&range_b.start, &range_a.start))
1534 .then_with(|| Ord::cmp(&range_a.end, &range_b.end))
1535 .then_with(|| self.language.id().cmp(&other.language.id()))
1536 }
1537}
1538
1539impl ParseStep {
1540 fn range(&self) -> Range<usize> {
1541 if let ParseMode::Combined {
1542 parent_layer_range, ..
1543 } = &self.mode
1544 {
1545 parent_layer_range.clone()
1546 } else {
1547 let start = self.included_ranges.first().map_or(0, |r| r.start_byte);
1548 let end = self.included_ranges.last().map_or(0, |r| r.end_byte);
1549 start..end
1550 }
1551 }
1552}
1553
1554impl ChangedRegion {
1555 fn cmp(&self, other: &Self, buffer: &BufferSnapshot) -> Ordering {
1556 let range_a = &self.range;
1557 let range_b = &other.range;
1558 Ord::cmp(&self.depth, &other.depth)
1559 .then_with(|| range_a.start.cmp(&range_b.start, buffer))
1560 .then_with(|| range_b.end.cmp(&range_a.end, buffer))
1561 }
1562}
1563
1564impl ChangeRegionSet {
1565 fn start_position(&self) -> ChangeStartPosition {
1566 self.0.first().map_or(
1567 ChangeStartPosition {
1568 depth: usize::MAX,
1569 position: Anchor::MAX,
1570 },
1571 |region| ChangeStartPosition {
1572 depth: region.depth,
1573 position: region.range.start,
1574 },
1575 )
1576 }
1577
1578 fn intersects(&self, layer: &SyntaxLayerEntry, text: &BufferSnapshot) -> bool {
1579 for region in &self.0 {
1580 if region.depth < layer.depth {
1581 continue;
1582 }
1583 if region.depth > layer.depth {
1584 break;
1585 }
1586 if region.range.end.cmp(&layer.range.start, text).is_le() {
1587 continue;
1588 }
1589 if region.range.start.cmp(&layer.range.end, text).is_ge() {
1590 break;
1591 }
1592 return true;
1593 }
1594 false
1595 }
1596
1597 fn insert(&mut self, region: ChangedRegion, text: &BufferSnapshot) {
1598 if let Err(ix) = self.0.binary_search_by(|probe| probe.cmp(®ion, text)) {
1599 self.0.insert(ix, region);
1600 }
1601 }
1602
1603 fn prune(&mut self, summary: SyntaxLayerSummary, text: &BufferSnapshot) -> bool {
1604 let prev_len = self.0.len();
1605 self.0.retain(|region| {
1606 region.depth > summary.max_depth
1607 || (region.depth == summary.max_depth
1608 && region
1609 .range
1610 .end
1611 .cmp(&summary.last_layer_range.start, text)
1612 .is_gt())
1613 });
1614 self.0.len() < prev_len
1615 }
1616}
1617
1618impl Default for SyntaxLayerSummary {
1619 fn default() -> Self {
1620 Self {
1621 max_depth: 0,
1622 min_depth: 0,
1623 range: Anchor::MAX..Anchor::MIN,
1624 last_layer_range: Anchor::MIN..Anchor::MAX,
1625 last_layer_language: None,
1626 contains_unknown_injections: false,
1627 }
1628 }
1629}
1630
1631impl sum_tree::Summary for SyntaxLayerSummary {
1632 type Context = BufferSnapshot;
1633
1634 fn add_summary(&mut self, other: &Self, buffer: &Self::Context) {
1635 if other.max_depth > self.max_depth {
1636 self.max_depth = other.max_depth;
1637 self.range = other.range.clone();
1638 } else {
1639 if self.range == (Anchor::MAX..Anchor::MAX) {
1640 self.range.start = other.range.start;
1641 }
1642 if other.range.end.cmp(&self.range.end, buffer).is_gt() {
1643 self.range.end = other.range.end;
1644 }
1645 }
1646 self.last_layer_range = other.last_layer_range.clone();
1647 self.last_layer_language = other.last_layer_language;
1648 self.contains_unknown_injections |= other.contains_unknown_injections;
1649 }
1650}
1651
1652impl<'a> SeekTarget<'a, SyntaxLayerSummary, SyntaxLayerSummary> for SyntaxLayerPosition {
1653 fn cmp(&self, cursor_location: &SyntaxLayerSummary, buffer: &BufferSnapshot) -> Ordering {
1654 Ord::cmp(&self.depth, &cursor_location.max_depth)
1655 .then_with(|| {
1656 self.range
1657 .start
1658 .cmp(&cursor_location.last_layer_range.start, buffer)
1659 })
1660 .then_with(|| {
1661 cursor_location
1662 .last_layer_range
1663 .end
1664 .cmp(&self.range.end, buffer)
1665 })
1666 .then_with(|| self.language.cmp(&cursor_location.last_layer_language))
1667 }
1668}
1669
1670impl<'a> SeekTarget<'a, SyntaxLayerSummary, SyntaxLayerSummary> for ChangeStartPosition {
1671 fn cmp(&self, cursor_location: &SyntaxLayerSummary, text: &BufferSnapshot) -> Ordering {
1672 Ord::cmp(&self.depth, &cursor_location.max_depth)
1673 .then_with(|| self.position.cmp(&cursor_location.range.end, text))
1674 }
1675}
1676
1677impl<'a> SeekTarget<'a, SyntaxLayerSummary, SyntaxLayerSummary>
1678 for SyntaxLayerPositionBeforeChange
1679{
1680 fn cmp(&self, cursor_location: &SyntaxLayerSummary, buffer: &BufferSnapshot) -> Ordering {
1681 if self.change.cmp(cursor_location, buffer).is_le() {
1682 return Ordering::Less;
1683 } else {
1684 self.position.cmp(cursor_location, buffer)
1685 }
1686 }
1687}
1688
1689impl sum_tree::Item for SyntaxLayerEntry {
1690 type Summary = SyntaxLayerSummary;
1691
1692 fn summary(&self) -> Self::Summary {
1693 SyntaxLayerSummary {
1694 min_depth: self.depth,
1695 max_depth: self.depth,
1696 range: self.range.clone(),
1697 last_layer_range: self.range.clone(),
1698 last_layer_language: self.content.language_id(),
1699 contains_unknown_injections: matches!(self.content, SyntaxLayerContent::Pending { .. }),
1700 }
1701 }
1702}
1703
1704impl std::fmt::Debug for SyntaxLayerEntry {
1705 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1706 f.debug_struct("SyntaxLayer")
1707 .field("depth", &self.depth)
1708 .field("range", &self.range)
1709 .field("tree", &self.content.tree())
1710 .finish()
1711 }
1712}
1713
1714impl<'a> tree_sitter::TextProvider<&'a [u8]> for TextProvider<'a> {
1715 type I = ByteChunks<'a>;
1716
1717 fn text(&mut self, node: tree_sitter::Node) -> Self::I {
1718 ByteChunks(self.0.chunks_in_range(node.byte_range()))
1719 }
1720}
1721
1722impl<'a> Iterator for ByteChunks<'a> {
1723 type Item = &'a [u8];
1724
1725 fn next(&mut self) -> Option<Self::Item> {
1726 self.0.next().map(str::as_bytes)
1727 }
1728}
1729
1730impl QueryCursorHandle {
1731 pub(crate) fn new() -> Self {
1732 let mut cursor = QUERY_CURSORS.lock().pop().unwrap_or_else(QueryCursor::new);
1733 cursor.set_match_limit(64);
1734 QueryCursorHandle(Some(cursor))
1735 }
1736}
1737
1738impl Deref for QueryCursorHandle {
1739 type Target = QueryCursor;
1740
1741 fn deref(&self) -> &Self::Target {
1742 self.0.as_ref().unwrap()
1743 }
1744}
1745
1746impl DerefMut for QueryCursorHandle {
1747 fn deref_mut(&mut self) -> &mut Self::Target {
1748 self.0.as_mut().unwrap()
1749 }
1750}
1751
1752impl Drop for QueryCursorHandle {
1753 fn drop(&mut self) {
1754 let mut cursor = self.0.take().unwrap();
1755 cursor.set_byte_range(0..usize::MAX);
1756 cursor.set_point_range(Point::zero().to_ts_point()..Point::MAX.to_ts_point());
1757 QUERY_CURSORS.lock().push(cursor)
1758 }
1759}
1760
1761pub(crate) trait ToTreeSitterPoint {
1762 fn to_ts_point(self) -> tree_sitter::Point;
1763 fn from_ts_point(point: tree_sitter::Point) -> Self;
1764}
1765
1766impl ToTreeSitterPoint for Point {
1767 fn to_ts_point(self) -> tree_sitter::Point {
1768 tree_sitter::Point::new(self.row as usize, self.column as usize)
1769 }
1770
1771 fn from_ts_point(point: tree_sitter::Point) -> Self {
1772 Point::new(point.row as u32, point.column as u32)
1773 }
1774}
1775
1776struct LogIncludedRanges<'a>(&'a [tree_sitter::Range]);
1777struct LogPoint(Point);
1778struct LogAnchorRange<'a>(&'a Range<Anchor>, &'a text::BufferSnapshot);
1779struct LogChangedRegions<'a>(&'a ChangeRegionSet, &'a text::BufferSnapshot);
1780
1781impl<'a> fmt::Debug for LogIncludedRanges<'a> {
1782 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1783 f.debug_list()
1784 .entries(self.0.iter().map(|range| {
1785 let start = range.start_point;
1786 let end = range.end_point;
1787 (start.row, start.column)..(end.row, end.column)
1788 }))
1789 .finish()
1790 }
1791}
1792
1793impl<'a> fmt::Debug for LogAnchorRange<'a> {
1794 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1795 let range = self.0.to_point(self.1);
1796 (LogPoint(range.start)..LogPoint(range.end)).fmt(f)
1797 }
1798}
1799
1800impl<'a> fmt::Debug for LogChangedRegions<'a> {
1801 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1802 f.debug_list()
1803 .entries(
1804 self.0
1805 .0
1806 .iter()
1807 .map(|region| LogAnchorRange(®ion.range, self.1)),
1808 )
1809 .finish()
1810 }
1811}
1812
1813impl fmt::Debug for LogPoint {
1814 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1815 (self.0.row, self.0.column).fmt(f)
1816 }
1817}