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