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