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