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