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