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