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 let is_combined = matches!(step.mode, ParseMode::Combined { .. });
591
592 for range in &mut included_ranges {
593 range.start_byte -= step_start_byte;
594 range.end_byte -= step_start_byte;
595 range.start_point = (Point::from_ts_point(range.start_point)
596 - step_start_point)
597 .to_ts_point();
598 range.end_point = (Point::from_ts_point(range.end_point)
599 - step_start_point)
600 .to_ts_point();
601 }
602
603 if let Some((SyntaxLayerContent::Parsed { tree: old_tree, .. }, layer_range)) =
604 old_layer.map(|layer| (&layer.content, layer.range.clone()))
605 {
606 log::trace!(
607 "existing layer. language:{}, range:{:?}, included_ranges:{:?}",
608 language.name(),
609 LogAnchorRange(&layer_range, text),
610 LogIncludedRanges(&old_tree.included_ranges())
611 );
612
613 if let ParseMode::Combined {
614 mut parent_layer_changed_ranges,
615 ..
616 } = step.mode
617 {
618 for range in &mut parent_layer_changed_ranges {
619 range.start = range.start.saturating_sub(step_start_byte);
620 range.end = range.end.saturating_sub(step_start_byte);
621 }
622
623 let changed_indices;
624 (included_ranges, changed_indices) = splice_included_ranges(
625 old_tree.included_ranges(),
626 &parent_layer_changed_ranges,
627 &included_ranges,
628 );
629 insert_newlines_between_ranges(
630 changed_indices,
631 &mut included_ranges,
632 text,
633 step_start_byte,
634 step_start_point,
635 );
636 }
637
638 if included_ranges.is_empty() {
639 included_ranges.push(tree_sitter::Range {
640 start_byte: 0,
641 end_byte: 0,
642 start_point: Default::default(),
643 end_point: Default::default(),
644 });
645 }
646
647 log::trace!(
648 "update layer. language:{}, range:{:?}, included_ranges:{:?}",
649 language.name(),
650 LogAnchorRange(&step.range, text),
651 LogIncludedRanges(&included_ranges),
652 );
653
654 let result = parse_text(
655 grammar,
656 text.as_rope(),
657 step_start_byte,
658 &included_ranges,
659 Some(old_tree.clone()),
660 );
661 match result {
662 Ok(t) => tree = t,
663 Err(e) => {
664 log::error!("error parsing text: {:?}", e);
665 continue;
666 }
667 };
668
669 changed_ranges = join_ranges(
670 invalidated_ranges
671 .iter()
672 .filter(|&range| {
673 range.start <= step_end_byte && range.end >= step_start_byte
674 })
675 .cloned(),
676 old_tree.changed_ranges(&tree).map(|r| {
677 step_start_byte + r.start_byte..step_start_byte + r.end_byte
678 }),
679 );
680 } else {
681 if matches!(step.mode, ParseMode::Combined { .. }) {
682 insert_newlines_between_ranges(
683 0..included_ranges.len(),
684 &mut included_ranges,
685 text,
686 step_start_byte,
687 step_start_point,
688 );
689 }
690
691 if included_ranges.is_empty() {
692 included_ranges.push(tree_sitter::Range {
693 start_byte: 0,
694 end_byte: 0,
695 start_point: Default::default(),
696 end_point: Default::default(),
697 });
698 }
699
700 log::trace!(
701 "create layer. language:{}, range:{:?}, included_ranges:{:?}",
702 language.name(),
703 LogAnchorRange(&step.range, text),
704 LogIncludedRanges(&included_ranges),
705 );
706
707 let result = parse_text(
708 grammar,
709 text.as_rope(),
710 step_start_byte,
711 &included_ranges,
712 None,
713 );
714 match result {
715 Ok(t) => tree = t,
716 Err(e) => {
717 log::error!("error parsing text: {:?}", e);
718 continue;
719 }
720 };
721 changed_ranges = vec![step_start_byte..step_end_byte];
722 }
723
724 if let (Some((config, registry)), false) = (
725 grammar.injection_config.as_ref().zip(registry.as_ref()),
726 changed_ranges.is_empty(),
727 ) {
728 for range in &changed_ranges {
729 changed_regions.insert(
730 ChangedRegion {
731 depth: step.depth + 1,
732 range: text.anchor_before(range.start)
733 ..text.anchor_after(range.end),
734 },
735 text,
736 );
737 }
738 get_injections(
739 config,
740 text,
741 step.range.clone(),
742 tree.root_node_with_offset(
743 step_start_byte,
744 step_start_point.to_ts_point(),
745 ),
746 registry,
747 step.depth + 1,
748 &changed_ranges,
749 &mut combined_injection_ranges,
750 &mut queue,
751 );
752 }
753
754 let included_sub_ranges: Option<Vec<Range<Anchor>>> = if is_combined {
755 Some(
756 included_ranges
757 .into_iter()
758 .filter(|r| r.start_byte < r.end_byte)
759 .map(|r| {
760 text.anchor_before(r.start_byte + step_start_byte)
761 ..text.anchor_after(r.end_byte + step_start_byte)
762 })
763 .collect(),
764 )
765 } else {
766 None
767 };
768 SyntaxLayerContent::Parsed {
769 tree,
770 language,
771 included_sub_ranges,
772 }
773 }
774 ParseStepLanguage::Pending { name } => SyntaxLayerContent::Pending {
775 language_name: name,
776 },
777 };
778
779 layers.push(
780 SyntaxLayerEntry {
781 depth: step.depth,
782 range: step.range,
783 content,
784 },
785 text,
786 );
787 }
788
789 drop(cursor);
790 self.layers = layers;
791 self.interpolated_version = text.version.clone();
792 self.parsed_version = text.version.clone();
793 #[cfg(debug_assertions)]
794 self.check_invariants(text);
795 }
796
797 #[cfg(debug_assertions)]
798 fn check_invariants(&self, text: &BufferSnapshot) {
799 let mut max_depth = 0;
800 let mut prev_layer: Option<(Range<Anchor>, Option<LanguageId>)> = None;
801 for layer in self.layers.iter() {
802 match Ord::cmp(&layer.depth, &max_depth) {
803 Ordering::Less => {
804 panic!("layers out of order")
805 }
806 Ordering::Equal => {
807 if let Some((prev_range, prev_language_id)) = prev_layer {
808 match layer.range.start.cmp(&prev_range.start, text) {
809 Ordering::Less => panic!("layers out of order"),
810 Ordering::Equal => match layer.range.end.cmp(&prev_range.end, text) {
811 Ordering::Less => panic!("layers out of order"),
812 Ordering::Equal => {
813 if layer.content.language_id() < prev_language_id {
814 panic!("layers out of order")
815 }
816 }
817 Ordering::Greater => {}
818 },
819 Ordering::Greater => {}
820 }
821 }
822 prev_layer = Some((layer.range.clone(), layer.content.language_id()));
823 }
824 Ordering::Greater => {
825 prev_layer = None;
826 }
827 }
828
829 max_depth = layer.depth;
830 }
831 }
832
833 pub fn single_tree_captures<'a>(
834 range: Range<usize>,
835 text: &'a Rope,
836 tree: &'a Tree,
837 language: &'a Arc<Language>,
838 query: fn(&Grammar) -> Option<&Query>,
839 ) -> SyntaxMapCaptures<'a> {
840 SyntaxMapCaptures::new(
841 range,
842 text,
843 [SyntaxLayer {
844 language,
845 tree,
846 included_sub_ranges: None,
847 depth: 0,
848 offset: (0, tree_sitter::Point::new(0, 0)),
849 }]
850 .into_iter(),
851 query,
852 )
853 }
854
855 pub fn captures<'a>(
856 &'a self,
857 range: Range<usize>,
858 buffer: &'a BufferSnapshot,
859 query: fn(&Grammar) -> Option<&Query>,
860 ) -> SyntaxMapCaptures<'a> {
861 SyntaxMapCaptures::new(
862 range.clone(),
863 buffer.as_rope(),
864 self.layers_for_range(range, buffer, true),
865 query,
866 )
867 }
868
869 pub fn matches<'a>(
870 &'a self,
871 range: Range<usize>,
872 buffer: &'a BufferSnapshot,
873 query: fn(&Grammar) -> Option<&Query>,
874 ) -> SyntaxMapMatches<'a> {
875 SyntaxMapMatches::new(
876 range.clone(),
877 buffer.as_rope(),
878 self.layers_for_range(range, buffer, true),
879 query,
880 TreeSitterOptions::default(),
881 )
882 }
883
884 pub fn matches_with_options<'a>(
885 &'a self,
886 range: Range<usize>,
887 buffer: &'a BufferSnapshot,
888 options: TreeSitterOptions,
889 query: fn(&Grammar) -> Option<&Query>,
890 ) -> SyntaxMapMatches<'a> {
891 SyntaxMapMatches::new(
892 range.clone(),
893 buffer.as_rope(),
894 self.layers_for_range(range, buffer, true),
895 query,
896 options,
897 )
898 }
899
900 #[cfg(test)]
901 pub fn layers<'a>(&'a self, buffer: &'a BufferSnapshot) -> Vec<SyntaxLayer<'a>> {
902 self.layers_for_range(0..buffer.len(), buffer, true)
903 .collect()
904 }
905
906 pub fn layers_for_range<'a, T: ToOffset>(
907 &'a self,
908 range: Range<T>,
909 buffer: &'a BufferSnapshot,
910 include_hidden: bool,
911 ) -> impl 'a + Iterator<Item = SyntaxLayer<'a>> {
912 let start_offset = range.start.to_offset(buffer);
913 let end_offset = range.end.to_offset(buffer);
914 let start = buffer.anchor_before(start_offset);
915 let end = buffer.anchor_after(end_offset);
916
917 let mut cursor = self.layers.filter::<_, ()>(buffer, move |summary| {
918 if summary.max_depth > summary.min_depth {
919 true
920 } else {
921 let is_before_start = summary.range.end.cmp(&start, buffer).is_lt();
922 let is_after_end = summary.range.start.cmp(&end, buffer).is_gt();
923 !is_before_start && !is_after_end
924 }
925 });
926
927 cursor.next();
928 iter::from_fn(move || {
929 while let Some(layer) = cursor.item() {
930 let mut info = None;
931 if let SyntaxLayerContent::Parsed {
932 tree,
933 language,
934 included_sub_ranges,
935 } = &layer.content
936 {
937 let layer_start_offset = layer.range.start.to_offset(buffer);
938 let layer_start_point = layer.range.start.to_point(buffer).to_ts_point();
939 if include_hidden || !language.config.hidden {
940 info = Some(SyntaxLayer {
941 tree,
942 language,
943 included_sub_ranges: included_sub_ranges.as_deref(),
944 depth: layer.depth,
945 offset: (layer_start_offset, layer_start_point),
946 });
947 }
948 }
949 cursor.next();
950 if info.is_some() {
951 return info;
952 }
953 }
954 None
955 })
956 }
957
958 pub fn contains_unknown_injections(&self) -> bool {
959 self.layers.summary().contains_unknown_injections
960 }
961
962 pub fn language_registry_version(&self) -> usize {
963 self.language_registry_version
964 }
965}
966
967impl<'a> SyntaxMapCaptures<'a> {
968 fn new(
969 range: Range<usize>,
970 text: &'a Rope,
971 layers: impl Iterator<Item = SyntaxLayer<'a>>,
972 query: fn(&Grammar) -> Option<&Query>,
973 ) -> Self {
974 let mut result = Self {
975 layers: Vec::new(),
976 grammars: Vec::new(),
977 active_layer_count: 0,
978 };
979 for layer in layers {
980 let grammar = match &layer.language.grammar {
981 Some(grammar) => grammar,
982 None => continue,
983 };
984 let query = match query(grammar) {
985 Some(query) => query,
986 None => continue,
987 };
988
989 let mut query_cursor = QueryCursorHandle::new();
990
991 // TODO - add a Tree-sitter API to remove the need for this.
992 let cursor = unsafe {
993 std::mem::transmute::<&mut tree_sitter::QueryCursor, &'static mut QueryCursor>(
994 query_cursor.deref_mut(),
995 )
996 };
997
998 cursor.set_byte_range(range.clone());
999 let captures = cursor.captures(query, layer.node(), TextProvider(text));
1000 let grammar_index = result
1001 .grammars
1002 .iter()
1003 .position(|g| g.id == grammar.id())
1004 .unwrap_or_else(|| {
1005 result.grammars.push(grammar);
1006 result.grammars.len() - 1
1007 });
1008 let mut layer = SyntaxMapCapturesLayer {
1009 depth: layer.depth,
1010 grammar_index,
1011 next_capture: None,
1012 captures,
1013 _query_cursor: query_cursor,
1014 };
1015
1016 layer.advance();
1017 if layer.next_capture.is_some() {
1018 let key = layer.sort_key();
1019 let ix = match result.layers[..result.active_layer_count]
1020 .binary_search_by_key(&key, |layer| layer.sort_key())
1021 {
1022 Ok(ix) | Err(ix) => ix,
1023 };
1024 result.layers.insert(ix, layer);
1025 result.active_layer_count += 1;
1026 } else {
1027 result.layers.push(layer);
1028 }
1029 }
1030
1031 result
1032 }
1033
1034 pub fn grammars(&self) -> &[&'a Grammar] {
1035 &self.grammars
1036 }
1037
1038 pub fn peek(&self) -> Option<SyntaxMapCapture<'a>> {
1039 let layer = self.layers[..self.active_layer_count].first()?;
1040 let capture = layer.next_capture?;
1041 Some(SyntaxMapCapture {
1042 grammar_index: layer.grammar_index,
1043 index: capture.index,
1044 node: capture.node,
1045 })
1046 }
1047
1048 pub fn advance(&mut self) -> bool {
1049 let layer = if let Some(layer) = self.layers[..self.active_layer_count].first_mut() {
1050 layer
1051 } else {
1052 return false;
1053 };
1054
1055 layer.advance();
1056 if layer.next_capture.is_some() {
1057 let key = layer.sort_key();
1058 let i = 1 + self.layers[1..self.active_layer_count]
1059 .iter()
1060 .position(|later_layer| key < later_layer.sort_key())
1061 .unwrap_or(self.active_layer_count - 1);
1062 self.layers[0..i].rotate_left(1);
1063 } else {
1064 self.layers[0..self.active_layer_count].rotate_left(1);
1065 self.active_layer_count -= 1;
1066 }
1067
1068 true
1069 }
1070
1071 pub fn set_byte_range(&mut self, range: Range<usize>) {
1072 for layer in &mut self.layers {
1073 layer.captures.set_byte_range(range.clone());
1074 if let Some(capture) = &layer.next_capture
1075 && capture.node.end_byte() > range.start
1076 {
1077 continue;
1078 }
1079 layer.advance();
1080 }
1081 self.layers.sort_unstable_by_key(|layer| layer.sort_key());
1082 self.active_layer_count = self
1083 .layers
1084 .iter()
1085 .position(|layer| layer.next_capture.is_none())
1086 .unwrap_or(self.layers.len());
1087 }
1088}
1089
1090#[derive(Default)]
1091pub struct TreeSitterOptions {
1092 max_start_depth: Option<u32>,
1093}
1094impl TreeSitterOptions {
1095 pub fn max_start_depth(max_start_depth: u32) -> Self {
1096 Self {
1097 max_start_depth: Some(max_start_depth),
1098 }
1099 }
1100}
1101
1102impl<'a> SyntaxMapMatches<'a> {
1103 fn new(
1104 range: Range<usize>,
1105 text: &'a Rope,
1106 layers: impl Iterator<Item = SyntaxLayer<'a>>,
1107 query: fn(&Grammar) -> Option<&Query>,
1108 options: TreeSitterOptions,
1109 ) -> Self {
1110 let mut result = Self::default();
1111 for layer in layers {
1112 let grammar = match &layer.language.grammar {
1113 Some(grammar) => grammar,
1114 None => continue,
1115 };
1116 let query = match query(grammar) {
1117 Some(query) => query,
1118 None => continue,
1119 };
1120
1121 let mut query_cursor = QueryCursorHandle::new();
1122
1123 // TODO - add a Tree-sitter API to remove the need for this.
1124 let cursor = unsafe {
1125 std::mem::transmute::<&mut tree_sitter::QueryCursor, &'static mut QueryCursor>(
1126 query_cursor.deref_mut(),
1127 )
1128 };
1129 cursor.set_max_start_depth(options.max_start_depth);
1130
1131 cursor.set_byte_range(range.clone());
1132 let matches = cursor.matches(query, layer.node(), TextProvider(text));
1133 let grammar_index = result
1134 .grammars
1135 .iter()
1136 .position(|g| g.id == grammar.id())
1137 .unwrap_or_else(|| {
1138 result.grammars.push(grammar);
1139 result.grammars.len() - 1
1140 });
1141 let mut layer = SyntaxMapMatchesLayer {
1142 language: layer.language.clone(),
1143 depth: layer.depth,
1144 grammar_index,
1145 matches,
1146 next_pattern_index: 0,
1147 next_captures: Vec::new(),
1148 has_next: false,
1149 _query_cursor: query_cursor,
1150 };
1151
1152 layer.advance();
1153 if layer.has_next {
1154 let key = layer.sort_key();
1155 let ix = match result.layers[..result.active_layer_count]
1156 .binary_search_by_key(&key, |layer| layer.sort_key())
1157 {
1158 Ok(ix) | Err(ix) => ix,
1159 };
1160 result.layers.insert(ix, layer);
1161 result.active_layer_count += 1;
1162 } else {
1163 result.layers.push(layer);
1164 }
1165 }
1166 result
1167 }
1168
1169 pub fn grammars(&self) -> &[&'a Grammar] {
1170 &self.grammars
1171 }
1172
1173 pub fn peek(&self) -> Option<SyntaxMapMatch<'_>> {
1174 let layer = self.layers.first()?;
1175
1176 if !layer.has_next {
1177 return None;
1178 }
1179
1180 Some(SyntaxMapMatch {
1181 language: layer.language.clone(),
1182 depth: layer.depth,
1183 grammar_index: layer.grammar_index,
1184 pattern_index: layer.next_pattern_index,
1185 captures: &layer.next_captures,
1186 })
1187 }
1188
1189 pub fn advance(&mut self) -> bool {
1190 let layer = if let Some(layer) = self.layers.first_mut() {
1191 layer
1192 } else {
1193 return false;
1194 };
1195
1196 layer.advance();
1197 if layer.has_next {
1198 let key = layer.sort_key();
1199 let i = 1 + self.layers[1..self.active_layer_count]
1200 .iter()
1201 .position(|later_layer| key < later_layer.sort_key())
1202 .unwrap_or(self.active_layer_count - 1);
1203 self.layers[0..i].rotate_left(1);
1204 } else if self.active_layer_count != 0 {
1205 self.layers[0..self.active_layer_count].rotate_left(1);
1206 self.active_layer_count -= 1;
1207 }
1208
1209 true
1210 }
1211}
1212
1213impl SyntaxMapCapturesLayer<'_> {
1214 fn advance(&mut self) {
1215 self.next_capture = self.captures.next().map(|(mat, ix)| mat.captures[*ix]);
1216 }
1217
1218 fn sort_key(&self) -> (usize, Reverse<usize>, usize) {
1219 if let Some(capture) = &self.next_capture {
1220 let range = capture.node.byte_range();
1221 (range.start, Reverse(range.end), self.depth)
1222 } else {
1223 (usize::MAX, Reverse(0), usize::MAX)
1224 }
1225 }
1226}
1227
1228impl SyntaxMapMatchesLayer<'_> {
1229 fn advance(&mut self) {
1230 if let Some(mat) = self.matches.next() {
1231 self.next_captures.clear();
1232 self.next_captures.extend_from_slice(mat.captures);
1233 self.next_pattern_index = mat.pattern_index;
1234 self.has_next = true;
1235 } else {
1236 self.has_next = false;
1237 }
1238 }
1239
1240 fn sort_key(&self) -> (usize, Reverse<usize>, usize) {
1241 if self.has_next {
1242 let captures = &self.next_captures;
1243 if let Some((first, last)) = captures.first().zip(captures.last()) {
1244 return (
1245 first.node.start_byte(),
1246 Reverse(last.node.end_byte()),
1247 self.depth,
1248 );
1249 }
1250 }
1251 (usize::MAX, Reverse(0), usize::MAX)
1252 }
1253}
1254
1255impl<'a> Iterator for SyntaxMapCaptures<'a> {
1256 type Item = SyntaxMapCapture<'a>;
1257
1258 fn next(&mut self) -> Option<Self::Item> {
1259 let result = self.peek();
1260 self.advance();
1261 result
1262 }
1263}
1264
1265fn join_ranges(
1266 a: impl Iterator<Item = Range<usize>>,
1267 b: impl Iterator<Item = Range<usize>>,
1268) -> Vec<Range<usize>> {
1269 let mut result = Vec::<Range<usize>>::new();
1270 let mut a = a.peekable();
1271 let mut b = b.peekable();
1272 loop {
1273 let range = match (a.peek(), b.peek()) {
1274 (Some(range_a), Some(range_b)) => {
1275 if range_a.start < range_b.start {
1276 a.next().unwrap()
1277 } else {
1278 b.next().unwrap()
1279 }
1280 }
1281 (None, Some(_)) => b.next().unwrap(),
1282 (Some(_), None) => a.next().unwrap(),
1283 (None, None) => break,
1284 };
1285
1286 if let Some(last) = result.last_mut()
1287 && range.start <= last.end
1288 {
1289 last.end = last.end.max(range.end);
1290 continue;
1291 }
1292 result.push(range);
1293 }
1294 result
1295}
1296
1297fn parse_text(
1298 grammar: &Grammar,
1299 text: &Rope,
1300 start_byte: usize,
1301 ranges: &[tree_sitter::Range],
1302 old_tree: Option<Tree>,
1303) -> anyhow::Result<Tree> {
1304 with_parser(|parser| {
1305 let mut chunks = text.chunks_in_range(start_byte..text.len());
1306 parser.set_included_ranges(ranges)?;
1307 parser.set_language(&grammar.ts_language)?;
1308 parser
1309 .parse_with_options(
1310 &mut move |offset, _| {
1311 chunks.seek(start_byte + offset);
1312 chunks.next().unwrap_or("").as_bytes()
1313 },
1314 old_tree.as_ref(),
1315 None,
1316 )
1317 .context("failed to parse")
1318 })
1319}
1320
1321fn get_injections(
1322 config: &InjectionConfig,
1323 text: &BufferSnapshot,
1324 outer_range: Range<Anchor>,
1325 node: Node,
1326 language_registry: &Arc<LanguageRegistry>,
1327 depth: usize,
1328 changed_ranges: &[Range<usize>],
1329 combined_injection_ranges: &mut HashMap<LanguageId, (Arc<Language>, Vec<tree_sitter::Range>)>,
1330 queue: &mut BinaryHeap<ParseStep>,
1331) {
1332 let mut query_cursor = QueryCursorHandle::new();
1333 let mut prev_match = None;
1334
1335 // Ensure that a `ParseStep` is created for every combined injection language, even
1336 // if there currently no matches for that injection.
1337 combined_injection_ranges.clear();
1338 for pattern in &config.patterns {
1339 if let (Some(language_name), true) = (pattern.language.as_ref(), pattern.combined)
1340 && let Some(language) = language_registry
1341 .language_for_name_or_extension(language_name)
1342 .now_or_never()
1343 .and_then(|language| language.ok())
1344 {
1345 combined_injection_ranges.insert(language.id, (language, Vec::new()));
1346 }
1347 }
1348
1349 for query_range in changed_ranges {
1350 query_cursor.set_byte_range(query_range.start.saturating_sub(1)..query_range.end + 1);
1351 let mut matches = query_cursor.matches(&config.query, node, TextProvider(text.as_rope()));
1352 while let Some(mat) = matches.next() {
1353 let content_ranges = mat
1354 .nodes_for_capture_index(config.content_capture_ix)
1355 .map(|node| node.range())
1356 .collect::<Vec<_>>();
1357 if content_ranges.is_empty() {
1358 continue;
1359 }
1360
1361 let content_range =
1362 content_ranges.first().unwrap().start_byte..content_ranges.last().unwrap().end_byte;
1363
1364 // Avoid duplicate matches if two changed ranges intersect the same injection.
1365 if let Some((prev_pattern_ix, prev_range)) = &prev_match
1366 && mat.pattern_index == *prev_pattern_ix
1367 && content_range == *prev_range
1368 {
1369 continue;
1370 }
1371
1372 prev_match = Some((mat.pattern_index, content_range.clone()));
1373 let combined = config.patterns[mat.pattern_index].combined;
1374
1375 let mut step_range = content_range.clone();
1376 let language_name =
1377 if let Some(name) = config.patterns[mat.pattern_index].language.as_ref() {
1378 Some(Cow::Borrowed(name.as_ref()))
1379 } else if let Some(language_node) = config
1380 .language_capture_ix
1381 .and_then(|ix| mat.nodes_for_capture_index(ix).next())
1382 {
1383 step_range.start = cmp::min(content_range.start, language_node.start_byte());
1384 step_range.end = cmp::max(content_range.end, language_node.end_byte());
1385 let language_name: String =
1386 text.text_for_range(language_node.byte_range()).collect();
1387
1388 // Enable paths ending in a language extension to represent a language name: e.g. "foo/bar/baz.rs"
1389 if let Some(last_dot_pos) = language_name.rfind('.') {
1390 Some(Cow::Owned(language_name[last_dot_pos + 1..].to_string()))
1391 } else {
1392 Some(Cow::Owned(language_name))
1393 }
1394 } else {
1395 None
1396 };
1397
1398 if let Some(language_name) = language_name {
1399 let language = language_registry
1400 .language_for_name_or_extension(&language_name)
1401 .now_or_never()
1402 .and_then(|language| language.ok());
1403 let range = text.anchor_before(step_range.start)..text.anchor_after(step_range.end);
1404 if let Some(language) = language {
1405 if combined {
1406 combined_injection_ranges
1407 .entry(language.id)
1408 .or_insert_with(|| (language.clone(), vec![]))
1409 .1
1410 .extend(content_ranges);
1411 } else {
1412 queue.push(ParseStep {
1413 depth,
1414 language: ParseStepLanguage::Loaded { language },
1415 included_ranges: content_ranges,
1416 range,
1417 mode: ParseMode::Single,
1418 });
1419 }
1420 } else {
1421 queue.push(ParseStep {
1422 depth,
1423 language: ParseStepLanguage::Pending {
1424 name: language_name.into(),
1425 },
1426 included_ranges: content_ranges,
1427 range,
1428 mode: ParseMode::Single,
1429 });
1430 }
1431 }
1432 }
1433 }
1434
1435 for (_, (language, mut included_ranges)) in combined_injection_ranges.drain() {
1436 included_ranges.sort_unstable_by(|a, b| {
1437 Ord::cmp(&a.start_byte, &b.start_byte).then_with(|| Ord::cmp(&a.end_byte, &b.end_byte))
1438 });
1439 queue.push(ParseStep {
1440 depth,
1441 language: ParseStepLanguage::Loaded { language },
1442 range: outer_range.clone(),
1443 included_ranges,
1444 mode: ParseMode::Combined {
1445 parent_layer_range: node.start_byte()..node.end_byte(),
1446 parent_layer_changed_ranges: changed_ranges.to_vec(),
1447 },
1448 })
1449 }
1450}
1451
1452/// Updates the given list of included `ranges`, removing any ranges that intersect
1453/// `removed_ranges`, and inserting the given `new_ranges`.
1454///
1455/// Returns a new vector of ranges, and the range of the vector that was changed,
1456/// from the previous `ranges` vector.
1457pub(crate) fn splice_included_ranges(
1458 mut ranges: Vec<tree_sitter::Range>,
1459 removed_ranges: &[Range<usize>],
1460 new_ranges: &[tree_sitter::Range],
1461) -> (Vec<tree_sitter::Range>, Range<usize>) {
1462 let mut removed_ranges = removed_ranges.iter().cloned().peekable();
1463 let mut new_ranges = new_ranges.iter().cloned().peekable();
1464 let mut ranges_ix = 0;
1465 let mut changed_portion: Option<Range<usize>> = None;
1466 loop {
1467 let next_new_range = new_ranges.peek();
1468 let next_removed_range = removed_ranges.peek();
1469
1470 let (remove, insert) = match (next_removed_range, next_new_range) {
1471 (None, None) => break,
1472 (Some(_), None) => (removed_ranges.next().unwrap(), None),
1473 (Some(next_removed_range), Some(next_new_range)) => {
1474 if next_removed_range.end < next_new_range.start_byte {
1475 (removed_ranges.next().unwrap(), None)
1476 } else {
1477 let mut start = next_new_range.start_byte;
1478 let mut end = next_new_range.end_byte;
1479
1480 while let Some(next_removed_range) = removed_ranges.peek() {
1481 if next_removed_range.start > next_new_range.end_byte {
1482 break;
1483 }
1484 let next_removed_range = removed_ranges.next().unwrap();
1485 start = cmp::min(start, next_removed_range.start);
1486 end = cmp::max(end, next_removed_range.end);
1487 }
1488
1489 (start..end, Some(new_ranges.next().unwrap()))
1490 }
1491 }
1492 (None, Some(next_new_range)) => (
1493 next_new_range.start_byte..next_new_range.end_byte,
1494 Some(new_ranges.next().unwrap()),
1495 ),
1496 };
1497
1498 let mut start_ix = ranges_ix
1499 + match ranges[ranges_ix..].binary_search_by_key(&remove.start, |r| r.end_byte) {
1500 Ok(ix) => ix,
1501 Err(ix) => ix,
1502 };
1503 let mut end_ix = ranges_ix
1504 + match ranges[ranges_ix..].binary_search_by_key(&remove.end, |r| r.start_byte) {
1505 Ok(ix) => ix + 1,
1506 Err(ix) => ix,
1507 };
1508
1509 // If there are empty ranges, then there may be multiple ranges with the same
1510 // start or end. Expand the splice to include any adjacent ranges that touch
1511 // the changed range.
1512 while start_ix > 0 {
1513 if ranges[start_ix - 1].end_byte == remove.start {
1514 start_ix -= 1;
1515 } else {
1516 break;
1517 }
1518 }
1519 while let Some(range) = ranges.get(end_ix) {
1520 if range.start_byte == remove.end {
1521 end_ix += 1;
1522 } else {
1523 break;
1524 }
1525 }
1526 let changed_start = changed_portion
1527 .as_ref()
1528 .map_or(usize::MAX, |range| range.start)
1529 .min(start_ix);
1530 let changed_end =
1531 changed_portion
1532 .as_ref()
1533 .map_or(0, |range| range.end)
1534 .max(if insert.is_some() {
1535 start_ix + 1
1536 } else {
1537 start_ix
1538 });
1539 changed_portion = Some(changed_start..changed_end);
1540
1541 ranges.splice(start_ix..end_ix, insert);
1542 ranges_ix = start_ix;
1543 }
1544
1545 (ranges, changed_portion.unwrap_or(0..0))
1546}
1547
1548/// Ensure there are newline ranges in between content range that appear on
1549/// different lines. For performance, only iterate through the given range of
1550/// indices. All of the ranges in the array are relative to a given start byte
1551/// and point.
1552fn insert_newlines_between_ranges(
1553 indices: Range<usize>,
1554 ranges: &mut Vec<tree_sitter::Range>,
1555 text: &text::BufferSnapshot,
1556 start_byte: usize,
1557 start_point: Point,
1558) {
1559 let mut ix = indices.end + 1;
1560 while ix > indices.start {
1561 ix -= 1;
1562 if 0 == ix || ix == ranges.len() {
1563 continue;
1564 }
1565
1566 let range_b = ranges[ix];
1567 let range_a = &mut ranges[ix - 1];
1568 if range_a.end_point.column == 0 {
1569 continue;
1570 }
1571
1572 if range_a.end_point.row < range_b.start_point.row {
1573 let end_point = start_point + Point::from_ts_point(range_a.end_point);
1574 let line_end = Point::new(end_point.row, text.line_len(end_point.row));
1575 if end_point.column >= line_end.column {
1576 range_a.end_byte += 1;
1577 range_a.end_point.row += 1;
1578 range_a.end_point.column = 0;
1579 } else {
1580 let newline_offset = text.point_to_offset(line_end);
1581 ranges.insert(
1582 ix,
1583 tree_sitter::Range {
1584 start_byte: newline_offset - start_byte,
1585 end_byte: newline_offset - start_byte + 1,
1586 start_point: (line_end - start_point).to_ts_point(),
1587 end_point: ((line_end - start_point) + Point::new(1, 0)).to_ts_point(),
1588 },
1589 )
1590 }
1591 }
1592 }
1593}
1594
1595impl OwnedSyntaxLayer {
1596 /// Returns the root syntax node for this layer.
1597 pub fn node(&self) -> Node<'_> {
1598 self.tree
1599 .root_node_with_offset(self.offset.0, self.offset.1)
1600 }
1601}
1602
1603impl<'a> SyntaxLayer<'a> {
1604 /// Returns an owned version of this layer.
1605 pub fn to_owned(&self) -> OwnedSyntaxLayer {
1606 OwnedSyntaxLayer {
1607 tree: self.tree.clone(),
1608 offset: self.offset,
1609 language: self.language.clone(),
1610 }
1611 }
1612
1613 /// Returns the root node for this layer.
1614 pub fn node(&self) -> Node<'a> {
1615 self.tree
1616 .root_node_with_offset(self.offset.0, self.offset.1)
1617 }
1618
1619 pub(crate) fn override_id(&self, offset: usize, text: &text::BufferSnapshot) -> Option<u32> {
1620 let text = TextProvider(text.as_rope());
1621 let config = self.language.grammar.as_ref()?.override_config.as_ref()?;
1622
1623 let mut query_cursor = QueryCursorHandle::new();
1624 query_cursor.set_byte_range(offset.saturating_sub(1)..offset.saturating_add(1));
1625
1626 let mut smallest_match: Option<(u32, Range<usize>)> = None;
1627 let mut matches = query_cursor.matches(&config.query, self.node(), text);
1628 while let Some(mat) = matches.next() {
1629 for capture in mat.captures {
1630 let Some(override_entry) = config.values.get(&capture.index) else {
1631 continue;
1632 };
1633
1634 let range = capture.node.byte_range();
1635 if override_entry.range_is_inclusive {
1636 if offset < range.start || offset > range.end {
1637 continue;
1638 }
1639 } else if offset <= range.start || offset >= range.end {
1640 continue;
1641 }
1642
1643 if let Some((_, smallest_range)) = &smallest_match {
1644 if range.len() < smallest_range.len() {
1645 smallest_match = Some((capture.index, range))
1646 }
1647 continue;
1648 }
1649
1650 smallest_match = Some((capture.index, range));
1651 }
1652 }
1653
1654 smallest_match.map(|(index, _)| index)
1655 }
1656}
1657
1658impl std::ops::Deref for SyntaxMap {
1659 type Target = SyntaxSnapshot;
1660
1661 fn deref(&self) -> &Self::Target {
1662 &self.snapshot
1663 }
1664}
1665
1666impl PartialEq for ParseStep {
1667 fn eq(&self, _: &Self) -> bool {
1668 false
1669 }
1670}
1671
1672impl Eq for ParseStep {}
1673
1674impl PartialOrd for ParseStep {
1675 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1676 Some(self.cmp(other))
1677 }
1678}
1679
1680impl Ord for ParseStep {
1681 fn cmp(&self, other: &Self) -> Ordering {
1682 let range_a = self.range();
1683 let range_b = other.range();
1684 Ord::cmp(&other.depth, &self.depth)
1685 .then_with(|| Ord::cmp(&range_b.start, &range_a.start))
1686 .then_with(|| Ord::cmp(&range_a.end, &range_b.end))
1687 .then_with(|| other.language.id().cmp(&self.language.id()))
1688 }
1689}
1690
1691impl ParseStep {
1692 fn range(&self) -> Range<usize> {
1693 if let ParseMode::Combined {
1694 parent_layer_range, ..
1695 } = &self.mode
1696 {
1697 parent_layer_range.clone()
1698 } else {
1699 let start = self.included_ranges.first().map_or(0, |r| r.start_byte);
1700 let end = self.included_ranges.last().map_or(0, |r| r.end_byte);
1701 start..end
1702 }
1703 }
1704}
1705
1706impl ChangedRegion {
1707 fn cmp(&self, other: &Self, buffer: &BufferSnapshot) -> Ordering {
1708 let range_a = &self.range;
1709 let range_b = &other.range;
1710 Ord::cmp(&self.depth, &other.depth)
1711 .then_with(|| range_a.start.cmp(&range_b.start, buffer))
1712 .then_with(|| range_b.end.cmp(&range_a.end, buffer))
1713 }
1714}
1715
1716impl ChangeRegionSet {
1717 fn start_position(&self) -> ChangeStartPosition {
1718 self.0.first().map_or(
1719 ChangeStartPosition {
1720 depth: usize::MAX,
1721 position: Anchor::MAX,
1722 },
1723 |region| ChangeStartPosition {
1724 depth: region.depth,
1725 position: region.range.start,
1726 },
1727 )
1728 }
1729
1730 fn intersects(&self, layer: &SyntaxLayerEntry, text: &BufferSnapshot) -> bool {
1731 for region in &self.0 {
1732 if region.depth < layer.depth {
1733 continue;
1734 }
1735 if region.depth > layer.depth {
1736 break;
1737 }
1738 if region.range.end.cmp(&layer.range.start, text).is_le() {
1739 continue;
1740 }
1741 if region.range.start.cmp(&layer.range.end, text).is_ge() {
1742 break;
1743 }
1744 return true;
1745 }
1746 false
1747 }
1748
1749 fn insert(&mut self, region: ChangedRegion, text: &BufferSnapshot) {
1750 if let Err(ix) = self.0.binary_search_by(|probe| probe.cmp(®ion, text)) {
1751 self.0.insert(ix, region);
1752 }
1753 }
1754
1755 fn prune(&mut self, summary: SyntaxLayerSummary, text: &BufferSnapshot) -> bool {
1756 let prev_len = self.0.len();
1757 self.0.retain(|region| {
1758 region.depth > summary.max_depth
1759 || (region.depth == summary.max_depth
1760 && region
1761 .range
1762 .end
1763 .cmp(&summary.last_layer_range.start, text)
1764 .is_gt())
1765 });
1766 self.0.len() < prev_len
1767 }
1768}
1769
1770impl Default for SyntaxLayerSummary {
1771 fn default() -> Self {
1772 Self {
1773 max_depth: 0,
1774 min_depth: 0,
1775 range: Anchor::MAX..Anchor::MIN,
1776 last_layer_range: Anchor::MIN..Anchor::MAX,
1777 last_layer_language: None,
1778 contains_unknown_injections: false,
1779 }
1780 }
1781}
1782
1783impl sum_tree::Summary for SyntaxLayerSummary {
1784 type Context<'a> = &'a BufferSnapshot;
1785
1786 fn zero(_cx: &BufferSnapshot) -> Self {
1787 Default::default()
1788 }
1789
1790 fn add_summary(&mut self, other: &Self, buffer: Self::Context<'_>) {
1791 if other.max_depth > self.max_depth {
1792 self.max_depth = other.max_depth;
1793 self.range = other.range.clone();
1794 } else {
1795 if self.range == (Anchor::MAX..Anchor::MAX) {
1796 self.range.start = other.range.start;
1797 }
1798 if other.range.end.cmp(&self.range.end, buffer).is_gt() {
1799 self.range.end = other.range.end;
1800 }
1801 }
1802 self.last_layer_range = other.last_layer_range.clone();
1803 self.last_layer_language = other.last_layer_language;
1804 self.contains_unknown_injections |= other.contains_unknown_injections;
1805 }
1806}
1807
1808impl SeekTarget<'_, SyntaxLayerSummary, SyntaxLayerSummary> for SyntaxLayerPosition {
1809 fn cmp(&self, cursor_location: &SyntaxLayerSummary, buffer: &BufferSnapshot) -> Ordering {
1810 Ord::cmp(&self.depth, &cursor_location.max_depth)
1811 .then_with(|| {
1812 self.range
1813 .start
1814 .cmp(&cursor_location.last_layer_range.start, buffer)
1815 })
1816 .then_with(|| {
1817 cursor_location
1818 .last_layer_range
1819 .end
1820 .cmp(&self.range.end, buffer)
1821 })
1822 .then_with(|| self.language.cmp(&cursor_location.last_layer_language))
1823 }
1824}
1825
1826impl SeekTarget<'_, SyntaxLayerSummary, SyntaxLayerSummary> for ChangeStartPosition {
1827 fn cmp(&self, cursor_location: &SyntaxLayerSummary, text: &BufferSnapshot) -> Ordering {
1828 Ord::cmp(&self.depth, &cursor_location.max_depth)
1829 .then_with(|| self.position.cmp(&cursor_location.range.end, text))
1830 }
1831}
1832
1833impl SeekTarget<'_, SyntaxLayerSummary, SyntaxLayerSummary> for SyntaxLayerPositionBeforeChange {
1834 fn cmp(&self, cursor_location: &SyntaxLayerSummary, buffer: &BufferSnapshot) -> Ordering {
1835 if self.change.cmp(cursor_location, buffer).is_le() {
1836 Ordering::Less
1837 } else {
1838 self.position.cmp(cursor_location, buffer)
1839 }
1840 }
1841}
1842
1843impl sum_tree::Item for SyntaxLayerEntry {
1844 type Summary = SyntaxLayerSummary;
1845
1846 fn summary(&self, _cx: &BufferSnapshot) -> Self::Summary {
1847 SyntaxLayerSummary {
1848 min_depth: self.depth,
1849 max_depth: self.depth,
1850 range: self.range.clone(),
1851 last_layer_range: self.range.clone(),
1852 last_layer_language: self.content.language_id(),
1853 contains_unknown_injections: matches!(self.content, SyntaxLayerContent::Pending { .. }),
1854 }
1855 }
1856}
1857
1858impl std::fmt::Debug for SyntaxLayerEntry {
1859 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1860 f.debug_struct("SyntaxLayer")
1861 .field("depth", &self.depth)
1862 .field("range", &self.range)
1863 .field("tree", &self.content.tree())
1864 .finish()
1865 }
1866}
1867
1868impl<'a> tree_sitter::TextProvider<&'a [u8]> for TextProvider<'a> {
1869 type I = ByteChunks<'a>;
1870
1871 fn text(&mut self, node: tree_sitter::Node) -> Self::I {
1872 ByteChunks(self.0.chunks_in_range(node.byte_range()))
1873 }
1874}
1875
1876impl<'a> Iterator for ByteChunks<'a> {
1877 type Item = &'a [u8];
1878
1879 fn next(&mut self) -> Option<Self::Item> {
1880 self.0.next().map(str::as_bytes)
1881 }
1882}
1883
1884impl QueryCursorHandle {
1885 pub fn new() -> Self {
1886 let mut cursor = QUERY_CURSORS.lock().pop().unwrap_or_default();
1887 cursor.set_match_limit(64);
1888 QueryCursorHandle(Some(cursor))
1889 }
1890}
1891
1892impl Deref for QueryCursorHandle {
1893 type Target = QueryCursor;
1894
1895 fn deref(&self) -> &Self::Target {
1896 self.0.as_ref().unwrap()
1897 }
1898}
1899
1900impl DerefMut for QueryCursorHandle {
1901 fn deref_mut(&mut self) -> &mut Self::Target {
1902 self.0.as_mut().unwrap()
1903 }
1904}
1905
1906impl Drop for QueryCursorHandle {
1907 fn drop(&mut self) {
1908 let mut cursor = self.0.take().unwrap();
1909 cursor.set_byte_range(0..usize::MAX);
1910 cursor.set_point_range(Point::zero().to_ts_point()..Point::MAX.to_ts_point());
1911 QUERY_CURSORS.lock().push(cursor)
1912 }
1913}
1914
1915pub trait ToTreeSitterPoint {
1916 fn to_ts_point(self) -> tree_sitter::Point;
1917 fn from_ts_point(point: tree_sitter::Point) -> Self;
1918}
1919
1920impl ToTreeSitterPoint for Point {
1921 fn to_ts_point(self) -> tree_sitter::Point {
1922 tree_sitter::Point::new(self.row as usize, self.column as usize)
1923 }
1924
1925 fn from_ts_point(point: tree_sitter::Point) -> Self {
1926 Point::new(point.row as u32, point.column as u32)
1927 }
1928}
1929
1930struct LogIncludedRanges<'a>(&'a [tree_sitter::Range]);
1931struct LogPoint(Point);
1932struct LogAnchorRange<'a>(&'a Range<Anchor>, &'a text::BufferSnapshot);
1933struct LogOffsetRanges<'a>(&'a [Range<usize>], &'a text::BufferSnapshot);
1934struct LogChangedRegions<'a>(&'a ChangeRegionSet, &'a text::BufferSnapshot);
1935
1936impl fmt::Debug for LogIncludedRanges<'_> {
1937 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1938 f.debug_list()
1939 .entries(self.0.iter().map(|range| {
1940 let start = range.start_point;
1941 let end = range.end_point;
1942 (start.row, start.column)..(end.row, end.column)
1943 }))
1944 .finish()
1945 }
1946}
1947
1948impl fmt::Debug for LogAnchorRange<'_> {
1949 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1950 let range = self.0.to_point(self.1);
1951 (LogPoint(range.start)..LogPoint(range.end)).fmt(f)
1952 }
1953}
1954
1955impl fmt::Debug for LogOffsetRanges<'_> {
1956 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1957 f.debug_list()
1958 .entries(self.0.iter().map(|range| {
1959 LogPoint(range.start.to_point(self.1))..LogPoint(range.end.to_point(self.1))
1960 }))
1961 .finish()
1962 }
1963}
1964
1965impl fmt::Debug for LogChangedRegions<'_> {
1966 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1967 f.debug_list()
1968 .entries(
1969 self.0
1970 .0
1971 .iter()
1972 .map(|region| LogAnchorRange(®ion.range, self.1)),
1973 )
1974 .finish()
1975 }
1976}
1977
1978impl fmt::Debug for LogPoint {
1979 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1980 (self.0.row, self.0.column).fmt(f)
1981 }
1982}