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, true),
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, true),
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, true)
807 .collect()
808 }
809
810 pub fn layers_for_range<'a, T: ToOffset>(
811 &'a self,
812 range: Range<T>,
813 buffer: &'a BufferSnapshot,
814 include_hidden: bool,
815 ) -> impl 'a + Iterator<Item = SyntaxLayer> {
816 let start_offset = range.start.to_offset(buffer);
817 let end_offset = range.end.to_offset(buffer);
818 let start = buffer.anchor_before(start_offset);
819 let end = buffer.anchor_after(end_offset);
820
821 let mut cursor = self.layers.filter::<_, ()>(move |summary| {
822 if summary.max_depth > summary.min_depth {
823 true
824 } else {
825 let is_before_start = summary.range.end.cmp(&start, buffer).is_lt();
826 let is_after_end = summary.range.start.cmp(&end, buffer).is_gt();
827 !is_before_start && !is_after_end
828 }
829 });
830
831 cursor.next(buffer);
832 iter::from_fn(move || {
833 while let Some(layer) = cursor.item() {
834 let mut info = None;
835 if let SyntaxLayerContent::Parsed { tree, language } = &layer.content {
836 let layer_start_offset = layer.range.start.to_offset(buffer);
837 let layer_start_point = layer.range.start.to_point(buffer).to_ts_point();
838 if include_hidden || !language.config.hidden {
839 info = Some(SyntaxLayer {
840 tree,
841 language,
842 depth: layer.depth,
843 offset: (layer_start_offset, layer_start_point),
844 });
845 }
846 }
847 cursor.next(buffer);
848 if info.is_some() {
849 return info;
850 }
851 }
852 None
853 })
854 }
855
856 pub fn contains_unknown_injections(&self) -> bool {
857 self.layers.summary().contains_unknown_injections
858 }
859
860 pub fn language_registry_version(&self) -> usize {
861 self.language_registry_version
862 }
863}
864
865impl<'a> SyntaxMapCaptures<'a> {
866 fn new(
867 range: Range<usize>,
868 text: &'a Rope,
869 layers: impl Iterator<Item = SyntaxLayer<'a>>,
870 query: fn(&Grammar) -> Option<&Query>,
871 ) -> Self {
872 let mut result = Self {
873 layers: Vec::new(),
874 grammars: Vec::new(),
875 active_layer_count: 0,
876 };
877 for layer in layers {
878 let grammar = match &layer.language.grammar {
879 Some(grammar) => grammar,
880 None => continue,
881 };
882 let query = match query(grammar) {
883 Some(query) => query,
884 None => continue,
885 };
886
887 let mut query_cursor = QueryCursorHandle::new();
888
889 // TODO - add a Tree-sitter API to remove the need for this.
890 let cursor = unsafe {
891 std::mem::transmute::<&mut tree_sitter::QueryCursor, &'static mut QueryCursor>(
892 query_cursor.deref_mut(),
893 )
894 };
895
896 cursor.set_byte_range(range.clone());
897 let captures = cursor.captures(query, layer.node(), TextProvider(text));
898 let grammar_index = result
899 .grammars
900 .iter()
901 .position(|g| g.id == grammar.id())
902 .unwrap_or_else(|| {
903 result.grammars.push(grammar);
904 result.grammars.len() - 1
905 });
906 let mut layer = SyntaxMapCapturesLayer {
907 depth: layer.depth,
908 grammar_index,
909 next_capture: None,
910 captures,
911 _query_cursor: query_cursor,
912 };
913
914 layer.advance();
915 if layer.next_capture.is_some() {
916 let key = layer.sort_key();
917 let ix = match result.layers[..result.active_layer_count]
918 .binary_search_by_key(&key, |layer| layer.sort_key())
919 {
920 Ok(ix) | Err(ix) => ix,
921 };
922 result.layers.insert(ix, layer);
923 result.active_layer_count += 1;
924 } else {
925 result.layers.push(layer);
926 }
927 }
928
929 result
930 }
931
932 pub fn grammars(&self) -> &[&'a Grammar] {
933 &self.grammars
934 }
935
936 pub fn peek(&self) -> Option<SyntaxMapCapture<'a>> {
937 let layer = self.layers[..self.active_layer_count].first()?;
938 let capture = layer.next_capture?;
939 Some(SyntaxMapCapture {
940 grammar_index: layer.grammar_index,
941 index: capture.index,
942 node: capture.node,
943 })
944 }
945
946 pub fn advance(&mut self) -> bool {
947 let layer = if let Some(layer) = self.layers[..self.active_layer_count].first_mut() {
948 layer
949 } else {
950 return false;
951 };
952
953 layer.advance();
954 if layer.next_capture.is_some() {
955 let key = layer.sort_key();
956 let i = 1 + self.layers[1..self.active_layer_count]
957 .iter()
958 .position(|later_layer| key < later_layer.sort_key())
959 .unwrap_or(self.active_layer_count - 1);
960 self.layers[0..i].rotate_left(1);
961 } else {
962 self.layers[0..self.active_layer_count].rotate_left(1);
963 self.active_layer_count -= 1;
964 }
965
966 true
967 }
968
969 pub fn set_byte_range(&mut self, range: Range<usize>) {
970 for layer in &mut self.layers {
971 layer.captures.set_byte_range(range.clone());
972 if let Some(capture) = &layer.next_capture {
973 if capture.node.end_byte() > range.start {
974 continue;
975 }
976 }
977 layer.advance();
978 }
979 self.layers.sort_unstable_by_key(|layer| layer.sort_key());
980 self.active_layer_count = self
981 .layers
982 .iter()
983 .position(|layer| layer.next_capture.is_none())
984 .unwrap_or(self.layers.len());
985 }
986}
987
988impl<'a> SyntaxMapMatches<'a> {
989 fn new(
990 range: Range<usize>,
991 text: &'a Rope,
992 layers: impl Iterator<Item = SyntaxLayer<'a>>,
993 query: fn(&Grammar) -> Option<&Query>,
994 ) -> Self {
995 let mut result = Self::default();
996 for layer in layers {
997 let grammar = match &layer.language.grammar {
998 Some(grammar) => grammar,
999 None => continue,
1000 };
1001 let query = match query(grammar) {
1002 Some(query) => query,
1003 None => continue,
1004 };
1005
1006 let mut query_cursor = QueryCursorHandle::new();
1007
1008 // TODO - add a Tree-sitter API to remove the need for this.
1009 let cursor = unsafe {
1010 std::mem::transmute::<&mut tree_sitter::QueryCursor, &'static mut QueryCursor>(
1011 query_cursor.deref_mut(),
1012 )
1013 };
1014
1015 cursor.set_byte_range(range.clone());
1016 let matches = cursor.matches(query, layer.node(), TextProvider(text));
1017 let grammar_index = result
1018 .grammars
1019 .iter()
1020 .position(|g| g.id == grammar.id())
1021 .unwrap_or_else(|| {
1022 result.grammars.push(grammar);
1023 result.grammars.len() - 1
1024 });
1025 let mut layer = SyntaxMapMatchesLayer {
1026 language: layer.language.clone(),
1027 depth: layer.depth,
1028 grammar_index,
1029 matches,
1030 next_pattern_index: 0,
1031 next_captures: Vec::new(),
1032 has_next: false,
1033 _query_cursor: query_cursor,
1034 };
1035
1036 layer.advance();
1037 if layer.has_next {
1038 let key = layer.sort_key();
1039 let ix = match result.layers[..result.active_layer_count]
1040 .binary_search_by_key(&key, |layer| layer.sort_key())
1041 {
1042 Ok(ix) | Err(ix) => ix,
1043 };
1044 result.layers.insert(ix, layer);
1045 result.active_layer_count += 1;
1046 } else {
1047 result.layers.push(layer);
1048 }
1049 }
1050 result
1051 }
1052
1053 pub fn grammars(&self) -> &[&'a Grammar] {
1054 &self.grammars
1055 }
1056
1057 pub fn peek(&self) -> Option<SyntaxMapMatch> {
1058 let layer = self.layers.first()?;
1059
1060 if !layer.has_next {
1061 return None;
1062 }
1063
1064 Some(SyntaxMapMatch {
1065 language: layer.language.clone(),
1066 depth: layer.depth,
1067 grammar_index: layer.grammar_index,
1068 pattern_index: layer.next_pattern_index,
1069 captures: &layer.next_captures,
1070 })
1071 }
1072
1073 pub fn advance(&mut self) -> bool {
1074 let layer = if let Some(layer) = self.layers.first_mut() {
1075 layer
1076 } else {
1077 return false;
1078 };
1079
1080 layer.advance();
1081 if layer.has_next {
1082 let key = layer.sort_key();
1083 let i = 1 + self.layers[1..self.active_layer_count]
1084 .iter()
1085 .position(|later_layer| key < later_layer.sort_key())
1086 .unwrap_or(self.active_layer_count - 1);
1087 self.layers[0..i].rotate_left(1);
1088 } else if self.active_layer_count != 0 {
1089 self.layers[0..self.active_layer_count].rotate_left(1);
1090 self.active_layer_count -= 1;
1091 }
1092
1093 true
1094 }
1095}
1096
1097impl<'a> SyntaxMapCapturesLayer<'a> {
1098 fn advance(&mut self) {
1099 self.next_capture = self.captures.next().map(|(mat, ix)| mat.captures[ix]);
1100 }
1101
1102 fn sort_key(&self) -> (usize, Reverse<usize>, usize) {
1103 if let Some(capture) = &self.next_capture {
1104 let range = capture.node.byte_range();
1105 (range.start, Reverse(range.end), self.depth)
1106 } else {
1107 (usize::MAX, Reverse(0), usize::MAX)
1108 }
1109 }
1110}
1111
1112impl<'a> SyntaxMapMatchesLayer<'a> {
1113 fn advance(&mut self) {
1114 if let Some(mat) = self.matches.next() {
1115 self.next_captures.clear();
1116 self.next_captures.extend_from_slice(mat.captures);
1117 self.next_pattern_index = mat.pattern_index;
1118 self.has_next = true;
1119 } else {
1120 self.has_next = false;
1121 }
1122 }
1123
1124 fn sort_key(&self) -> (usize, Reverse<usize>, usize) {
1125 if self.has_next {
1126 let captures = &self.next_captures;
1127 if let Some((first, last)) = captures.first().zip(captures.last()) {
1128 return (
1129 first.node.start_byte(),
1130 Reverse(last.node.end_byte()),
1131 self.depth,
1132 );
1133 }
1134 }
1135 (usize::MAX, Reverse(0), usize::MAX)
1136 }
1137}
1138
1139impl<'a> Iterator for SyntaxMapCaptures<'a> {
1140 type Item = SyntaxMapCapture<'a>;
1141
1142 fn next(&mut self) -> Option<Self::Item> {
1143 let result = self.peek();
1144 self.advance();
1145 result
1146 }
1147}
1148
1149fn join_ranges(
1150 a: impl Iterator<Item = Range<usize>>,
1151 b: impl Iterator<Item = Range<usize>>,
1152) -> Vec<Range<usize>> {
1153 let mut result = Vec::<Range<usize>>::new();
1154 let mut a = a.peekable();
1155 let mut b = b.peekable();
1156 loop {
1157 let range = match (a.peek(), b.peek()) {
1158 (Some(range_a), Some(range_b)) => {
1159 if range_a.start < range_b.start {
1160 a.next().unwrap()
1161 } else {
1162 b.next().unwrap()
1163 }
1164 }
1165 (None, Some(_)) => b.next().unwrap(),
1166 (Some(_), None) => a.next().unwrap(),
1167 (None, None) => break,
1168 };
1169
1170 if let Some(last) = result.last_mut() {
1171 if range.start <= last.end {
1172 last.end = last.end.max(range.end);
1173 continue;
1174 }
1175 }
1176 result.push(range);
1177 }
1178 result
1179}
1180
1181fn parse_text(
1182 grammar: &Grammar,
1183 text: &Rope,
1184 start_byte: usize,
1185 ranges: Vec<tree_sitter::Range>,
1186 old_tree: Option<Tree>,
1187) -> anyhow::Result<Tree> {
1188 with_parser(|parser| {
1189 let mut chunks = text.chunks_in_range(start_byte..text.len());
1190 parser.set_included_ranges(&ranges)?;
1191 parser.set_language(&grammar.ts_language)?;
1192 parser
1193 .parse_with(
1194 &mut move |offset, _| {
1195 chunks.seek(start_byte + offset);
1196 chunks.next().unwrap_or("").as_bytes()
1197 },
1198 old_tree.as_ref(),
1199 )
1200 .ok_or_else(|| anyhow::anyhow!("failed to parse"))
1201 })
1202}
1203
1204#[allow(clippy::too_many_arguments)]
1205fn get_injections(
1206 config: &InjectionConfig,
1207 text: &BufferSnapshot,
1208 outer_range: Range<Anchor>,
1209 node: Node,
1210 language_registry: &Arc<LanguageRegistry>,
1211 depth: usize,
1212 changed_ranges: &[Range<usize>],
1213 combined_injection_ranges: &mut HashMap<LanguageId, (Arc<Language>, Vec<tree_sitter::Range>)>,
1214 queue: &mut BinaryHeap<ParseStep>,
1215) {
1216 let mut query_cursor = QueryCursorHandle::new();
1217 let mut prev_match = None;
1218
1219 // Ensure that a `ParseStep` is created for every combined injection language, even
1220 // if there currently no matches for that injection.
1221 combined_injection_ranges.clear();
1222 for pattern in &config.patterns {
1223 if let (Some(language_name), true) = (pattern.language.as_ref(), pattern.combined) {
1224 if let Some(language) = language_registry
1225 .language_for_name_or_extension(language_name)
1226 .now_or_never()
1227 .and_then(|language| language.ok())
1228 {
1229 combined_injection_ranges.insert(language.id, (language, Vec::new()));
1230 }
1231 }
1232 }
1233
1234 for query_range in changed_ranges {
1235 query_cursor.set_byte_range(query_range.start.saturating_sub(1)..query_range.end + 1);
1236 for mat in query_cursor.matches(&config.query, node, TextProvider(text.as_rope())) {
1237 let content_ranges = mat
1238 .nodes_for_capture_index(config.content_capture_ix)
1239 .map(|node| node.range())
1240 .collect::<Vec<_>>();
1241 if content_ranges.is_empty() {
1242 continue;
1243 }
1244
1245 let content_range =
1246 content_ranges.first().unwrap().start_byte..content_ranges.last().unwrap().end_byte;
1247
1248 // Avoid duplicate matches if two changed ranges intersect the same injection.
1249 if let Some((prev_pattern_ix, prev_range)) = &prev_match {
1250 if mat.pattern_index == *prev_pattern_ix && content_range == *prev_range {
1251 continue;
1252 }
1253 }
1254
1255 prev_match = Some((mat.pattern_index, content_range.clone()));
1256 let combined = config.patterns[mat.pattern_index].combined;
1257
1258 let mut step_range = content_range.clone();
1259 let language_name =
1260 if let Some(name) = config.patterns[mat.pattern_index].language.as_ref() {
1261 Some(Cow::Borrowed(name.as_ref()))
1262 } else if let Some(language_node) = config
1263 .language_capture_ix
1264 .and_then(|ix| mat.nodes_for_capture_index(ix).next())
1265 {
1266 step_range.start = cmp::min(content_range.start, language_node.start_byte());
1267 step_range.end = cmp::max(content_range.end, language_node.end_byte());
1268 let language_name: String =
1269 text.text_for_range(language_node.byte_range()).collect();
1270
1271 // Enable paths ending in a language extension to represent a language name: e.g. "foo/bar/baz.rs"
1272 if let Some(last_dot_pos) = language_name.rfind('.') {
1273 Some(Cow::Owned(language_name[last_dot_pos + 1..].to_string()))
1274 } else {
1275 Some(Cow::Owned(language_name))
1276 }
1277 } else {
1278 None
1279 };
1280
1281 if let Some(language_name) = language_name {
1282 let language = language_registry
1283 .language_for_name_or_extension(&language_name)
1284 .now_or_never()
1285 .and_then(|language| language.ok());
1286 let range = text.anchor_before(step_range.start)..text.anchor_after(step_range.end);
1287 if let Some(language) = language {
1288 if combined {
1289 combined_injection_ranges
1290 .entry(language.id)
1291 .or_insert_with(|| (language.clone(), vec![]))
1292 .1
1293 .extend(content_ranges);
1294 } else {
1295 queue.push(ParseStep {
1296 depth,
1297 language: ParseStepLanguage::Loaded { language },
1298 included_ranges: content_ranges,
1299 range,
1300 mode: ParseMode::Single,
1301 });
1302 }
1303 } else {
1304 queue.push(ParseStep {
1305 depth,
1306 language: ParseStepLanguage::Pending {
1307 name: language_name.into(),
1308 },
1309 included_ranges: content_ranges,
1310 range,
1311 mode: ParseMode::Single,
1312 });
1313 }
1314 }
1315 }
1316 }
1317
1318 for (_, (language, mut included_ranges)) in combined_injection_ranges.drain() {
1319 included_ranges.sort_unstable_by(|a, b| {
1320 Ord::cmp(&a.start_byte, &b.start_byte).then_with(|| Ord::cmp(&a.end_byte, &b.end_byte))
1321 });
1322 queue.push(ParseStep {
1323 depth,
1324 language: ParseStepLanguage::Loaded { language },
1325 range: outer_range.clone(),
1326 included_ranges,
1327 mode: ParseMode::Combined {
1328 parent_layer_range: node.start_byte()..node.end_byte(),
1329 parent_layer_changed_ranges: changed_ranges.to_vec(),
1330 },
1331 })
1332 }
1333}
1334
1335/// Updates the given list of included `ranges`, removing any ranges that intersect
1336/// `removed_ranges`, and inserting the given `new_ranges`.
1337///
1338/// Returns a new vector of ranges, and the range of the vector that was changed,
1339/// from the previous `ranges` vector.
1340pub(crate) fn splice_included_ranges(
1341 mut ranges: Vec<tree_sitter::Range>,
1342 removed_ranges: &[Range<usize>],
1343 new_ranges: &[tree_sitter::Range],
1344) -> (Vec<tree_sitter::Range>, Range<usize>) {
1345 let mut removed_ranges = removed_ranges.iter().cloned().peekable();
1346 let mut new_ranges = new_ranges.into_iter().cloned().peekable();
1347 let mut ranges_ix = 0;
1348 let mut changed_portion: Option<Range<usize>> = None;
1349 loop {
1350 let next_new_range = new_ranges.peek();
1351 let next_removed_range = removed_ranges.peek();
1352
1353 let (remove, insert) = match (next_removed_range, next_new_range) {
1354 (None, None) => break,
1355 (Some(_), None) => (removed_ranges.next().unwrap(), None),
1356 (Some(next_removed_range), Some(next_new_range)) => {
1357 if next_removed_range.end < next_new_range.start_byte {
1358 (removed_ranges.next().unwrap(), None)
1359 } else {
1360 let mut start = next_new_range.start_byte;
1361 let mut end = next_new_range.end_byte;
1362
1363 while let Some(next_removed_range) = removed_ranges.peek() {
1364 if next_removed_range.start > next_new_range.end_byte {
1365 break;
1366 }
1367 let next_removed_range = removed_ranges.next().unwrap();
1368 start = cmp::min(start, next_removed_range.start);
1369 end = cmp::max(end, next_removed_range.end);
1370 }
1371
1372 (start..end, Some(new_ranges.next().unwrap()))
1373 }
1374 }
1375 (None, Some(next_new_range)) => (
1376 next_new_range.start_byte..next_new_range.end_byte,
1377 Some(new_ranges.next().unwrap()),
1378 ),
1379 };
1380
1381 let mut start_ix = ranges_ix
1382 + match ranges[ranges_ix..].binary_search_by_key(&remove.start, |r| r.end_byte) {
1383 Ok(ix) => ix,
1384 Err(ix) => ix,
1385 };
1386 let mut end_ix = ranges_ix
1387 + match ranges[ranges_ix..].binary_search_by_key(&remove.end, |r| r.start_byte) {
1388 Ok(ix) => ix + 1,
1389 Err(ix) => ix,
1390 };
1391
1392 // If there are empty ranges, then there may be multiple ranges with the same
1393 // start or end. Expand the splice to include any adjacent ranges that touch
1394 // the changed range.
1395 while start_ix > 0 {
1396 if ranges[start_ix - 1].end_byte == remove.start {
1397 start_ix -= 1;
1398 } else {
1399 break;
1400 }
1401 }
1402 while let Some(range) = ranges.get(end_ix) {
1403 if range.start_byte == remove.end {
1404 end_ix += 1;
1405 } else {
1406 break;
1407 }
1408 }
1409 let changed_start = changed_portion
1410 .as_ref()
1411 .map_or(usize::MAX, |range| range.start)
1412 .min(start_ix);
1413 let changed_end =
1414 changed_portion
1415 .as_ref()
1416 .map_or(0, |range| range.end)
1417 .max(if insert.is_some() {
1418 start_ix + 1
1419 } else {
1420 start_ix
1421 });
1422 changed_portion = Some(changed_start..changed_end);
1423
1424 ranges.splice(start_ix..end_ix, insert);
1425 ranges_ix = start_ix;
1426 }
1427
1428 (ranges, changed_portion.unwrap_or(0..0))
1429}
1430
1431/// Ensure there are newline ranges in between content range that appear on
1432/// different lines. For performance, only iterate through the given range of
1433/// indices. All of the ranges in the array are relative to a given start byte
1434/// and point.
1435fn insert_newlines_between_ranges(
1436 indices: Range<usize>,
1437 ranges: &mut Vec<tree_sitter::Range>,
1438 text: &text::BufferSnapshot,
1439 start_byte: usize,
1440 start_point: Point,
1441) {
1442 let mut ix = indices.end + 1;
1443 while ix > indices.start {
1444 ix -= 1;
1445 if 0 == ix || ix == ranges.len() {
1446 continue;
1447 }
1448
1449 let range_b = ranges[ix];
1450 let range_a = &mut ranges[ix - 1];
1451 if range_a.end_point.column == 0 {
1452 continue;
1453 }
1454
1455 if range_a.end_point.row < range_b.start_point.row {
1456 let end_point = start_point + Point::from_ts_point(range_a.end_point);
1457 let line_end = Point::new(end_point.row, text.line_len(end_point.row));
1458 if end_point.column >= line_end.column {
1459 range_a.end_byte += 1;
1460 range_a.end_point.row += 1;
1461 range_a.end_point.column = 0;
1462 } else {
1463 let newline_offset = text.point_to_offset(line_end);
1464 ranges.insert(
1465 ix,
1466 tree_sitter::Range {
1467 start_byte: newline_offset - start_byte,
1468 end_byte: newline_offset - start_byte + 1,
1469 start_point: (line_end - start_point).to_ts_point(),
1470 end_point: ((line_end - start_point) + Point::new(1, 0)).to_ts_point(),
1471 },
1472 )
1473 }
1474 }
1475 }
1476}
1477
1478impl OwnedSyntaxLayer {
1479 /// Returns the root syntax node for this layer.
1480 pub fn node(&self) -> Node {
1481 self.tree
1482 .root_node_with_offset(self.offset.0, self.offset.1)
1483 }
1484}
1485
1486impl<'a> SyntaxLayer<'a> {
1487 /// Returns an owned version of this layer.
1488 pub fn to_owned(&self) -> OwnedSyntaxLayer {
1489 OwnedSyntaxLayer {
1490 tree: self.tree.clone(),
1491 offset: self.offset,
1492 language: self.language.clone(),
1493 }
1494 }
1495
1496 /// Returns the root node for this layer.
1497 pub fn node(&self) -> Node<'a> {
1498 self.tree
1499 .root_node_with_offset(self.offset.0, self.offset.1)
1500 }
1501
1502 pub(crate) fn override_id(&self, offset: usize, text: &text::BufferSnapshot) -> Option<u32> {
1503 let text = TextProvider(text.as_rope());
1504 let config = self.language.grammar.as_ref()?.override_config.as_ref()?;
1505
1506 let mut query_cursor = QueryCursorHandle::new();
1507 query_cursor.set_byte_range(offset..offset);
1508
1509 let mut smallest_match: Option<(u32, Range<usize>)> = None;
1510 for mat in query_cursor.matches(&config.query, self.node(), text) {
1511 for capture in mat.captures {
1512 if !config.values.contains_key(&capture.index) {
1513 continue;
1514 }
1515
1516 let range = capture.node.byte_range();
1517 if offset <= range.start || offset >= range.end {
1518 continue;
1519 }
1520
1521 if let Some((_, smallest_range)) = &smallest_match {
1522 if range.len() < smallest_range.len() {
1523 smallest_match = Some((capture.index, range))
1524 }
1525 continue;
1526 }
1527
1528 smallest_match = Some((capture.index, range));
1529 }
1530 }
1531
1532 smallest_match.map(|(index, _)| index)
1533 }
1534}
1535
1536impl std::ops::Deref for SyntaxMap {
1537 type Target = SyntaxSnapshot;
1538
1539 fn deref(&self) -> &Self::Target {
1540 &self.snapshot
1541 }
1542}
1543
1544impl PartialEq for ParseStep {
1545 fn eq(&self, _: &Self) -> bool {
1546 false
1547 }
1548}
1549
1550impl Eq for ParseStep {}
1551
1552impl PartialOrd for ParseStep {
1553 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1554 Some(self.cmp(other))
1555 }
1556}
1557
1558impl Ord for ParseStep {
1559 fn cmp(&self, other: &Self) -> Ordering {
1560 let range_a = self.range();
1561 let range_b = other.range();
1562 Ord::cmp(&other.depth, &self.depth)
1563 .then_with(|| Ord::cmp(&range_b.start, &range_a.start))
1564 .then_with(|| Ord::cmp(&range_a.end, &range_b.end))
1565 .then_with(|| self.language.id().cmp(&other.language.id()))
1566 }
1567}
1568
1569impl ParseStep {
1570 fn range(&self) -> Range<usize> {
1571 if let ParseMode::Combined {
1572 parent_layer_range, ..
1573 } = &self.mode
1574 {
1575 parent_layer_range.clone()
1576 } else {
1577 let start = self.included_ranges.first().map_or(0, |r| r.start_byte);
1578 let end = self.included_ranges.last().map_or(0, |r| r.end_byte);
1579 start..end
1580 }
1581 }
1582}
1583
1584impl ChangedRegion {
1585 fn cmp(&self, other: &Self, buffer: &BufferSnapshot) -> Ordering {
1586 let range_a = &self.range;
1587 let range_b = &other.range;
1588 Ord::cmp(&self.depth, &other.depth)
1589 .then_with(|| range_a.start.cmp(&range_b.start, buffer))
1590 .then_with(|| range_b.end.cmp(&range_a.end, buffer))
1591 }
1592}
1593
1594impl ChangeRegionSet {
1595 fn start_position(&self) -> ChangeStartPosition {
1596 self.0.first().map_or(
1597 ChangeStartPosition {
1598 depth: usize::MAX,
1599 position: Anchor::MAX,
1600 },
1601 |region| ChangeStartPosition {
1602 depth: region.depth,
1603 position: region.range.start,
1604 },
1605 )
1606 }
1607
1608 fn intersects(&self, layer: &SyntaxLayerEntry, text: &BufferSnapshot) -> bool {
1609 for region in &self.0 {
1610 if region.depth < layer.depth {
1611 continue;
1612 }
1613 if region.depth > layer.depth {
1614 break;
1615 }
1616 if region.range.end.cmp(&layer.range.start, text).is_le() {
1617 continue;
1618 }
1619 if region.range.start.cmp(&layer.range.end, text).is_ge() {
1620 break;
1621 }
1622 return true;
1623 }
1624 false
1625 }
1626
1627 fn insert(&mut self, region: ChangedRegion, text: &BufferSnapshot) {
1628 if let Err(ix) = self.0.binary_search_by(|probe| probe.cmp(®ion, text)) {
1629 self.0.insert(ix, region);
1630 }
1631 }
1632
1633 fn prune(&mut self, summary: SyntaxLayerSummary, text: &BufferSnapshot) -> bool {
1634 let prev_len = self.0.len();
1635 self.0.retain(|region| {
1636 region.depth > summary.max_depth
1637 || (region.depth == summary.max_depth
1638 && region
1639 .range
1640 .end
1641 .cmp(&summary.last_layer_range.start, text)
1642 .is_gt())
1643 });
1644 self.0.len() < prev_len
1645 }
1646}
1647
1648impl Default for SyntaxLayerSummary {
1649 fn default() -> Self {
1650 Self {
1651 max_depth: 0,
1652 min_depth: 0,
1653 range: Anchor::MAX..Anchor::MIN,
1654 last_layer_range: Anchor::MIN..Anchor::MAX,
1655 last_layer_language: None,
1656 contains_unknown_injections: false,
1657 }
1658 }
1659}
1660
1661impl sum_tree::Summary for SyntaxLayerSummary {
1662 type Context = BufferSnapshot;
1663
1664 fn add_summary(&mut self, other: &Self, buffer: &Self::Context) {
1665 if other.max_depth > self.max_depth {
1666 self.max_depth = other.max_depth;
1667 self.range = other.range.clone();
1668 } else {
1669 if self.range == (Anchor::MAX..Anchor::MAX) {
1670 self.range.start = other.range.start;
1671 }
1672 if other.range.end.cmp(&self.range.end, buffer).is_gt() {
1673 self.range.end = other.range.end;
1674 }
1675 }
1676 self.last_layer_range = other.last_layer_range.clone();
1677 self.last_layer_language = other.last_layer_language;
1678 self.contains_unknown_injections |= other.contains_unknown_injections;
1679 }
1680}
1681
1682impl<'a> SeekTarget<'a, SyntaxLayerSummary, SyntaxLayerSummary> for SyntaxLayerPosition {
1683 fn cmp(&self, cursor_location: &SyntaxLayerSummary, buffer: &BufferSnapshot) -> Ordering {
1684 Ord::cmp(&self.depth, &cursor_location.max_depth)
1685 .then_with(|| {
1686 self.range
1687 .start
1688 .cmp(&cursor_location.last_layer_range.start, buffer)
1689 })
1690 .then_with(|| {
1691 cursor_location
1692 .last_layer_range
1693 .end
1694 .cmp(&self.range.end, buffer)
1695 })
1696 .then_with(|| self.language.cmp(&cursor_location.last_layer_language))
1697 }
1698}
1699
1700impl<'a> SeekTarget<'a, SyntaxLayerSummary, SyntaxLayerSummary> for ChangeStartPosition {
1701 fn cmp(&self, cursor_location: &SyntaxLayerSummary, text: &BufferSnapshot) -> Ordering {
1702 Ord::cmp(&self.depth, &cursor_location.max_depth)
1703 .then_with(|| self.position.cmp(&cursor_location.range.end, text))
1704 }
1705}
1706
1707impl<'a> SeekTarget<'a, SyntaxLayerSummary, SyntaxLayerSummary>
1708 for SyntaxLayerPositionBeforeChange
1709{
1710 fn cmp(&self, cursor_location: &SyntaxLayerSummary, buffer: &BufferSnapshot) -> Ordering {
1711 if self.change.cmp(cursor_location, buffer).is_le() {
1712 return Ordering::Less;
1713 } else {
1714 self.position.cmp(cursor_location, buffer)
1715 }
1716 }
1717}
1718
1719impl sum_tree::Item for SyntaxLayerEntry {
1720 type Summary = SyntaxLayerSummary;
1721
1722 fn summary(&self) -> Self::Summary {
1723 SyntaxLayerSummary {
1724 min_depth: self.depth,
1725 max_depth: self.depth,
1726 range: self.range.clone(),
1727 last_layer_range: self.range.clone(),
1728 last_layer_language: self.content.language_id(),
1729 contains_unknown_injections: matches!(self.content, SyntaxLayerContent::Pending { .. }),
1730 }
1731 }
1732}
1733
1734impl std::fmt::Debug for SyntaxLayerEntry {
1735 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1736 f.debug_struct("SyntaxLayer")
1737 .field("depth", &self.depth)
1738 .field("range", &self.range)
1739 .field("tree", &self.content.tree())
1740 .finish()
1741 }
1742}
1743
1744impl<'a> tree_sitter::TextProvider<&'a [u8]> for TextProvider<'a> {
1745 type I = ByteChunks<'a>;
1746
1747 fn text(&mut self, node: tree_sitter::Node) -> Self::I {
1748 ByteChunks(self.0.chunks_in_range(node.byte_range()))
1749 }
1750}
1751
1752impl<'a> Iterator for ByteChunks<'a> {
1753 type Item = &'a [u8];
1754
1755 fn next(&mut self) -> Option<Self::Item> {
1756 self.0.next().map(str::as_bytes)
1757 }
1758}
1759
1760impl QueryCursorHandle {
1761 pub fn new() -> Self {
1762 let mut cursor = QUERY_CURSORS.lock().pop().unwrap_or_else(QueryCursor::new);
1763 cursor.set_match_limit(64);
1764 QueryCursorHandle(Some(cursor))
1765 }
1766}
1767
1768impl Deref for QueryCursorHandle {
1769 type Target = QueryCursor;
1770
1771 fn deref(&self) -> &Self::Target {
1772 self.0.as_ref().unwrap()
1773 }
1774}
1775
1776impl DerefMut for QueryCursorHandle {
1777 fn deref_mut(&mut self) -> &mut Self::Target {
1778 self.0.as_mut().unwrap()
1779 }
1780}
1781
1782impl Drop for QueryCursorHandle {
1783 fn drop(&mut self) {
1784 let mut cursor = self.0.take().unwrap();
1785 cursor.set_byte_range(0..usize::MAX);
1786 cursor.set_point_range(Point::zero().to_ts_point()..Point::MAX.to_ts_point());
1787 QUERY_CURSORS.lock().push(cursor)
1788 }
1789}
1790
1791pub(crate) trait ToTreeSitterPoint {
1792 fn to_ts_point(self) -> tree_sitter::Point;
1793 fn from_ts_point(point: tree_sitter::Point) -> Self;
1794}
1795
1796impl ToTreeSitterPoint for Point {
1797 fn to_ts_point(self) -> tree_sitter::Point {
1798 tree_sitter::Point::new(self.row as usize, self.column as usize)
1799 }
1800
1801 fn from_ts_point(point: tree_sitter::Point) -> Self {
1802 Point::new(point.row as u32, point.column as u32)
1803 }
1804}
1805
1806struct LogIncludedRanges<'a>(&'a [tree_sitter::Range]);
1807struct LogPoint(Point);
1808struct LogAnchorRange<'a>(&'a Range<Anchor>, &'a text::BufferSnapshot);
1809struct LogChangedRegions<'a>(&'a ChangeRegionSet, &'a text::BufferSnapshot);
1810
1811impl<'a> fmt::Debug for LogIncludedRanges<'a> {
1812 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1813 f.debug_list()
1814 .entries(self.0.iter().map(|range| {
1815 let start = range.start_point;
1816 let end = range.end_point;
1817 (start.row, start.column)..(end.row, end.column)
1818 }))
1819 .finish()
1820 }
1821}
1822
1823impl<'a> fmt::Debug for LogAnchorRange<'a> {
1824 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1825 let range = self.0.to_point(self.1);
1826 (LogPoint(range.start)..LogPoint(range.end)).fmt(f)
1827 }
1828}
1829
1830impl<'a> fmt::Debug for LogChangedRegions<'a> {
1831 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1832 f.debug_list()
1833 .entries(
1834 self.0
1835 .0
1836 .iter()
1837 .map(|region| LogAnchorRange(®ion.range, self.1)),
1838 )
1839 .finish()
1840 }
1841}
1842
1843impl fmt::Debug for LogPoint {
1844 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1845 (self.0.row, self.0.column).fmt(f)
1846 }
1847}