1use crate::{Grammar, InjectionConfig, Language, LanguageRegistry};
   2use collections::HashMap;
   3use lazy_static::lazy_static;
   4use parking_lot::Mutex;
   5use std::{
   6    borrow::Cow,
   7    cell::RefCell,
   8    cmp::{Ordering, Reverse},
   9    collections::BinaryHeap,
  10    ops::{Deref, DerefMut, Range},
  11    sync::Arc,
  12};
  13use sum_tree::{Bias, SeekTarget, SumTree};
  14use text::{Anchor, BufferSnapshot, OffsetRangeExt, Point, Rope, ToOffset, ToPoint};
  15use tree_sitter::{
  16    Node, Parser, Query, QueryCapture, QueryCaptures, QueryCursor, QueryMatches, Tree,
  17};
  18
  19thread_local! {
  20    static PARSER: RefCell<Parser> = RefCell::new(Parser::new());
  21}
  22
  23lazy_static! {
  24    static ref QUERY_CURSORS: Mutex<Vec<QueryCursor>> = Default::default();
  25}
  26
  27#[derive(Default)]
  28pub struct SyntaxMap {
  29    parsed_version: clock::Global,
  30    interpolated_version: clock::Global,
  31    snapshot: SyntaxSnapshot,
  32    language_registry: Option<Arc<LanguageRegistry>>,
  33}
  34
  35#[derive(Clone, Default)]
  36pub struct SyntaxSnapshot {
  37    layers: SumTree<SyntaxLayer>,
  38}
  39
  40#[derive(Default)]
  41pub struct SyntaxMapCaptures<'a> {
  42    layers: Vec<SyntaxMapCapturesLayer<'a>>,
  43    active_layer_count: usize,
  44    grammars: Vec<&'a Grammar>,
  45}
  46
  47#[derive(Default)]
  48pub struct SyntaxMapMatches<'a> {
  49    layers: Vec<SyntaxMapMatchesLayer<'a>>,
  50    active_layer_count: usize,
  51    grammars: Vec<&'a Grammar>,
  52}
  53
  54#[derive(Debug)]
  55pub struct SyntaxMapCapture<'a> {
  56    pub depth: usize,
  57    pub node: Node<'a>,
  58    pub index: u32,
  59    pub grammar_index: usize,
  60}
  61
  62#[derive(Debug)]
  63pub struct SyntaxMapMatch<'a> {
  64    pub depth: usize,
  65    pub pattern_index: usize,
  66    pub captures: &'a [QueryCapture<'a>],
  67    pub grammar_index: usize,
  68}
  69
  70struct SyntaxMapCapturesLayer<'a> {
  71    depth: usize,
  72    captures: QueryCaptures<'a, 'a, TextProvider<'a>>,
  73    next_capture: Option<QueryCapture<'a>>,
  74    grammar_index: usize,
  75    _query_cursor: QueryCursorHandle,
  76}
  77
  78struct SyntaxMapMatchesLayer<'a> {
  79    depth: usize,
  80    next_pattern_index: usize,
  81    next_captures: Vec<QueryCapture<'a>>,
  82    has_next: bool,
  83    matches: QueryMatches<'a, 'a, TextProvider<'a>>,
  84    grammar_index: usize,
  85    _query_cursor: QueryCursorHandle,
  86}
  87
  88#[derive(Clone)]
  89struct SyntaxLayer {
  90    depth: usize,
  91    range: Range<Anchor>,
  92    tree: tree_sitter::Tree,
  93    language: Arc<Language>,
  94}
  95
  96#[derive(Debug)]
  97pub struct SyntaxLayerInfo<'a> {
  98    pub depth: usize,
  99    pub node: Node<'a>,
 100    pub language: &'a Arc<Language>,
 101}
 102
 103#[derive(Debug, Clone)]
 104struct SyntaxLayerSummary {
 105    min_depth: usize,
 106    max_depth: usize,
 107    range: Range<Anchor>,
 108    last_layer_range: Range<Anchor>,
 109    last_layer_language: Option<usize>,
 110}
 111
 112#[derive(Clone, Debug)]
 113struct SyntaxLayerPosition {
 114    depth: usize,
 115    range: Range<Anchor>,
 116    language: Option<usize>,
 117}
 118
 119#[derive(Clone, Debug)]
 120struct ChangeStartPosition {
 121    depth: usize,
 122    position: Anchor,
 123}
 124
 125#[derive(Clone, Debug)]
 126struct SyntaxLayerPositionBeforeChange {
 127    position: SyntaxLayerPosition,
 128    change: ChangeStartPosition,
 129}
 130
 131struct ParseStep {
 132    depth: usize,
 133    language: Arc<Language>,
 134    range: Range<Anchor>,
 135    included_ranges: Vec<tree_sitter::Range>,
 136    mode: ParseMode,
 137}
 138
 139enum ParseMode {
 140    Single,
 141    Combined {
 142        parent_layer_range: Range<usize>,
 143        parent_layer_changed_ranges: Vec<Range<usize>>,
 144    },
 145}
 146
 147#[derive(Debug, PartialEq, Eq)]
 148struct ChangedRegion {
 149    depth: usize,
 150    range: Range<Anchor>,
 151}
 152
 153#[derive(Default)]
 154struct ChangeRegionSet(Vec<ChangedRegion>);
 155
 156struct TextProvider<'a>(&'a Rope);
 157
 158struct ByteChunks<'a>(text::Chunks<'a>);
 159
 160struct QueryCursorHandle(Option<QueryCursor>);
 161
 162impl SyntaxMap {
 163    pub fn new() -> Self {
 164        Self::default()
 165    }
 166
 167    pub fn set_language_registry(&mut self, registry: Arc<LanguageRegistry>) {
 168        self.language_registry = Some(registry);
 169    }
 170
 171    pub fn snapshot(&self) -> SyntaxSnapshot {
 172        self.snapshot.clone()
 173    }
 174
 175    pub fn language_registry(&self) -> Option<Arc<LanguageRegistry>> {
 176        self.language_registry.clone()
 177    }
 178
 179    pub fn parsed_version(&self) -> clock::Global {
 180        self.parsed_version.clone()
 181    }
 182
 183    pub fn interpolate(&mut self, text: &BufferSnapshot) {
 184        self.snapshot.interpolate(&self.interpolated_version, text);
 185        self.interpolated_version = text.version.clone();
 186    }
 187
 188    #[cfg(test)]
 189    pub fn reparse(&mut self, language: Arc<Language>, text: &BufferSnapshot) {
 190        self.snapshot.reparse(
 191            &self.parsed_version,
 192            text,
 193            self.language_registry.clone(),
 194            language,
 195        );
 196        self.parsed_version = text.version.clone();
 197        self.interpolated_version = text.version.clone();
 198    }
 199
 200    pub fn did_parse(&mut self, snapshot: SyntaxSnapshot, version: clock::Global) {
 201        self.interpolated_version = version.clone();
 202        self.parsed_version = version;
 203        self.snapshot = snapshot;
 204    }
 205
 206    pub fn clear(&mut self) {
 207        self.snapshot = SyntaxSnapshot::default();
 208    }
 209}
 210
 211impl SyntaxSnapshot {
 212    pub fn is_empty(&self) -> bool {
 213        self.layers.is_empty()
 214    }
 215
 216    pub fn interpolate(&mut self, from_version: &clock::Global, text: &BufferSnapshot) {
 217        let edits = text
 218            .anchored_edits_since::<(usize, Point)>(&from_version)
 219            .collect::<Vec<_>>();
 220        if edits.is_empty() {
 221            return;
 222        }
 223
 224        let mut layers = SumTree::new();
 225        let mut first_edit_ix_for_depth = 0;
 226        let mut prev_depth = 0;
 227        let mut cursor = self.layers.cursor::<SyntaxLayerSummary>();
 228        cursor.next(text);
 229
 230        'outer: loop {
 231            let depth = cursor.end(text).max_depth;
 232            if depth > prev_depth {
 233                first_edit_ix_for_depth = 0;
 234                prev_depth = depth;
 235            }
 236
 237            // Preserve any layers at this depth that precede the first edit.
 238            if let Some((_, edit_range)) = edits.get(first_edit_ix_for_depth) {
 239                let target = ChangeStartPosition {
 240                    depth,
 241                    position: edit_range.start,
 242                };
 243                if target.cmp(&cursor.start(), text).is_gt() {
 244                    let slice = cursor.slice(&target, Bias::Left, text);
 245                    layers.push_tree(slice, text);
 246                }
 247            }
 248            // If this layer follows all of the edits, then preserve it and any
 249            // subsequent layers at this same depth.
 250            else if cursor.item().is_some() {
 251                let slice = cursor.slice(
 252                    &SyntaxLayerPosition {
 253                        depth: depth + 1,
 254                        range: Anchor::MIN..Anchor::MAX,
 255                        language: None,
 256                    },
 257                    Bias::Left,
 258                    text,
 259                );
 260                layers.push_tree(slice, text);
 261                continue;
 262            };
 263
 264            let Some(layer) = cursor.item() else { break };
 265            let (start_byte, start_point) = layer.range.start.summary::<(usize, Point)>(text);
 266
 267            // Ignore edits that end before the start of this layer, and don't consider them
 268            // for any subsequent layers at this same depth.
 269            loop {
 270                let Some((_, edit_range)) = edits.get(first_edit_ix_for_depth) else { continue 'outer };
 271                if edit_range.end.cmp(&layer.range.start, text).is_le() {
 272                    first_edit_ix_for_depth += 1;
 273                } else {
 274                    break;
 275                }
 276            }
 277
 278            let mut layer = layer.clone();
 279            for (edit, edit_range) in &edits[first_edit_ix_for_depth..] {
 280                // Ignore any edits that follow this layer.
 281                if edit_range.start.cmp(&layer.range.end, text).is_ge() {
 282                    break;
 283                }
 284
 285                // Apply any edits that intersect this layer to the layer's syntax tree.
 286                let tree_edit = if edit_range.start.cmp(&layer.range.start, text).is_ge() {
 287                    tree_sitter::InputEdit {
 288                        start_byte: edit.new.start.0 - start_byte,
 289                        old_end_byte: edit.new.start.0 - start_byte
 290                            + (edit.old.end.0 - edit.old.start.0),
 291                        new_end_byte: edit.new.end.0 - start_byte,
 292                        start_position: (edit.new.start.1 - start_point).to_ts_point(),
 293                        old_end_position: (edit.new.start.1 - start_point
 294                            + (edit.old.end.1 - edit.old.start.1))
 295                            .to_ts_point(),
 296                        new_end_position: (edit.new.end.1 - start_point).to_ts_point(),
 297                    }
 298                } else {
 299                    let node = layer.tree.root_node();
 300                    tree_sitter::InputEdit {
 301                        start_byte: 0,
 302                        old_end_byte: node.end_byte(),
 303                        new_end_byte: 0,
 304                        start_position: Default::default(),
 305                        old_end_position: node.end_position(),
 306                        new_end_position: Default::default(),
 307                    }
 308                };
 309
 310                layer.tree.edit(&tree_edit);
 311            }
 312
 313            debug_assert!(
 314                layer.tree.root_node().end_byte() <= text.len(),
 315                "tree's size {}, is larger than text size {}",
 316                layer.tree.root_node().end_byte(),
 317                text.len(),
 318            );
 319
 320            layers.push(layer, text);
 321            cursor.next(text);
 322        }
 323
 324        layers.push_tree(cursor.suffix(&text), &text);
 325        drop(cursor);
 326        self.layers = layers;
 327    }
 328
 329    pub fn reparse(
 330        &mut self,
 331        from_version: &clock::Global,
 332        text: &BufferSnapshot,
 333        registry: Option<Arc<LanguageRegistry>>,
 334        root_language: Arc<Language>,
 335    ) {
 336        let edits = text.edits_since::<usize>(from_version).collect::<Vec<_>>();
 337        let max_depth = self.layers.summary().max_depth;
 338        let mut cursor = self.layers.cursor::<SyntaxLayerSummary>();
 339        cursor.next(&text);
 340        let mut layers = SumTree::new();
 341
 342        let mut changed_regions = ChangeRegionSet::default();
 343        let mut queue = BinaryHeap::new();
 344        let mut combined_injection_ranges = HashMap::default();
 345        queue.push(ParseStep {
 346            depth: 0,
 347            language: root_language.clone(),
 348            included_ranges: vec![tree_sitter::Range {
 349                start_byte: 0,
 350                end_byte: text.len(),
 351                start_point: Point::zero().to_ts_point(),
 352                end_point: text.max_point().to_ts_point(),
 353            }],
 354            range: Anchor::MIN..Anchor::MAX,
 355            mode: ParseMode::Single,
 356        });
 357
 358        loop {
 359            let step = queue.pop();
 360            let position = if let Some(step) = &step {
 361                SyntaxLayerPosition {
 362                    depth: step.depth,
 363                    range: step.range.clone(),
 364                    language: step.language.id(),
 365                }
 366            } else {
 367                SyntaxLayerPosition {
 368                    depth: max_depth + 1,
 369                    range: Anchor::MAX..Anchor::MAX,
 370                    language: None,
 371                }
 372            };
 373
 374            let mut done = cursor.item().is_none();
 375            while !done && position.cmp(&cursor.end(text), &text).is_gt() {
 376                done = true;
 377
 378                let bounded_position = SyntaxLayerPositionBeforeChange {
 379                    position: position.clone(),
 380                    change: changed_regions.start_position(),
 381                };
 382                if bounded_position.cmp(&cursor.start(), &text).is_gt() {
 383                    let slice = cursor.slice(&bounded_position, Bias::Left, text);
 384                    if !slice.is_empty() {
 385                        layers.push_tree(slice, &text);
 386                        if changed_regions.prune(cursor.end(text), text) {
 387                            done = false;
 388                        }
 389                    }
 390                }
 391
 392                while position.cmp(&cursor.end(text), text).is_gt() {
 393                    let Some(layer) = cursor.item() else { break };
 394
 395                    if changed_regions.intersects(&layer, text) {
 396                        changed_regions.insert(
 397                            ChangedRegion {
 398                                depth: layer.depth + 1,
 399                                range: layer.range.clone(),
 400                            },
 401                            text,
 402                        );
 403                    } else {
 404                        layers.push(layer.clone(), text);
 405                    }
 406
 407                    cursor.next(text);
 408                    if changed_regions.prune(cursor.end(text), text) {
 409                        done = false;
 410                    }
 411                }
 412            }
 413
 414            let Some(step) = step else { break };
 415            let (step_start_byte, step_start_point) =
 416                step.range.start.summary::<(usize, Point)>(text);
 417            let step_end_byte = step.range.end.to_offset(text);
 418            let Some(grammar) = step.language.grammar.as_deref() else { continue };
 419
 420            let mut old_layer = cursor.item();
 421            if let Some(layer) = old_layer {
 422                if layer.range.to_offset(text) == (step_start_byte..step_end_byte)
 423                    && layer.language.id() == step.language.id()
 424                {
 425                    cursor.next(&text);
 426                } else {
 427                    old_layer = None;
 428                }
 429            }
 430
 431            let tree;
 432            let changed_ranges;
 433            let mut included_ranges = step.included_ranges;
 434            if let Some(old_layer) = old_layer {
 435                if let ParseMode::Combined {
 436                    parent_layer_changed_ranges,
 437                    ..
 438                } = step.mode
 439                {
 440                    included_ranges = splice_included_ranges(
 441                        old_layer.tree.included_ranges(),
 442                        &parent_layer_changed_ranges,
 443                        &included_ranges,
 444                    );
 445                }
 446
 447                tree = parse_text(
 448                    grammar,
 449                    text.as_rope(),
 450                    step_start_byte,
 451                    step_start_point,
 452                    included_ranges,
 453                    Some(old_layer.tree.clone()),
 454                );
 455                changed_ranges = join_ranges(
 456                    edits.iter().map(|e| e.new.clone()).filter(|range| {
 457                        range.start <= step_end_byte && range.end >= step_start_byte
 458                    }),
 459                    old_layer
 460                        .tree
 461                        .changed_ranges(&tree)
 462                        .map(|r| step_start_byte + r.start_byte..step_start_byte + r.end_byte),
 463                );
 464            } else {
 465                tree = parse_text(
 466                    grammar,
 467                    text.as_rope(),
 468                    step_start_byte,
 469                    step_start_point,
 470                    included_ranges,
 471                    None,
 472                );
 473                changed_ranges = vec![step_start_byte..step_end_byte];
 474            }
 475
 476            layers.push(
 477                SyntaxLayer {
 478                    depth: step.depth,
 479                    range: step.range,
 480                    tree: tree.clone(),
 481                    language: step.language.clone(),
 482                },
 483                &text,
 484            );
 485
 486            if let (Some((config, registry)), false) = (
 487                grammar.injection_config.as_ref().zip(registry.as_ref()),
 488                changed_ranges.is_empty(),
 489            ) {
 490                for range in &changed_ranges {
 491                    changed_regions.insert(
 492                        ChangedRegion {
 493                            depth: step.depth + 1,
 494                            range: text.anchor_before(range.start)..text.anchor_after(range.end),
 495                        },
 496                        text,
 497                    );
 498                }
 499                get_injections(
 500                    config,
 501                    text,
 502                    tree.root_node_with_offset(step_start_byte, step_start_point.to_ts_point()),
 503                    registry,
 504                    step.depth + 1,
 505                    &changed_ranges,
 506                    &mut combined_injection_ranges,
 507                    &mut queue,
 508                );
 509            }
 510        }
 511
 512        drop(cursor);
 513        self.layers = layers;
 514    }
 515
 516    pub fn single_tree_captures<'a>(
 517        range: Range<usize>,
 518        text: &'a Rope,
 519        tree: &'a Tree,
 520        language: &'a Arc<Language>,
 521        query: fn(&Grammar) -> Option<&Query>,
 522    ) -> SyntaxMapCaptures<'a> {
 523        SyntaxMapCaptures::new(
 524            range.clone(),
 525            text,
 526            [SyntaxLayerInfo {
 527                language,
 528                depth: 0,
 529                node: tree.root_node(),
 530            }]
 531            .into_iter(),
 532            query,
 533        )
 534    }
 535
 536    pub fn captures<'a>(
 537        &'a self,
 538        range: Range<usize>,
 539        buffer: &'a BufferSnapshot,
 540        query: fn(&Grammar) -> Option<&Query>,
 541    ) -> SyntaxMapCaptures {
 542        SyntaxMapCaptures::new(
 543            range.clone(),
 544            buffer.as_rope(),
 545            self.layers_for_range(range, buffer).into_iter(),
 546            query,
 547        )
 548    }
 549
 550    pub fn matches<'a>(
 551        &'a self,
 552        range: Range<usize>,
 553        buffer: &'a BufferSnapshot,
 554        query: fn(&Grammar) -> Option<&Query>,
 555    ) -> SyntaxMapMatches {
 556        SyntaxMapMatches::new(
 557            range.clone(),
 558            buffer.as_rope(),
 559            self.layers_for_range(range, buffer).into_iter(),
 560            query,
 561        )
 562    }
 563
 564    #[cfg(test)]
 565    pub fn layers<'a>(&'a self, buffer: &'a BufferSnapshot) -> Vec<SyntaxLayerInfo> {
 566        self.layers_for_range(0..buffer.len(), buffer).collect()
 567    }
 568
 569    pub fn layers_for_range<'a, T: ToOffset>(
 570        &'a self,
 571        range: Range<T>,
 572        buffer: &'a BufferSnapshot,
 573    ) -> impl 'a + Iterator<Item = SyntaxLayerInfo> {
 574        let start = buffer.anchor_before(range.start.to_offset(buffer));
 575        let end = buffer.anchor_after(range.end.to_offset(buffer));
 576
 577        let mut cursor = self.layers.filter::<_, ()>(move |summary| {
 578            if summary.max_depth > summary.min_depth {
 579                true
 580            } else {
 581                let is_before_start = summary.range.end.cmp(&start, buffer).is_lt();
 582                let is_after_end = summary.range.start.cmp(&end, buffer).is_gt();
 583                !is_before_start && !is_after_end
 584            }
 585        });
 586
 587        cursor.next(buffer);
 588        std::iter::from_fn(move || {
 589            if let Some(layer) = cursor.item() {
 590                let info = SyntaxLayerInfo {
 591                    language: &layer.language,
 592                    depth: layer.depth,
 593                    node: layer.tree.root_node_with_offset(
 594                        layer.range.start.to_offset(buffer),
 595                        layer.range.start.to_point(buffer).to_ts_point(),
 596                    ),
 597                };
 598                cursor.next(buffer);
 599                Some(info)
 600            } else {
 601                None
 602            }
 603        })
 604    }
 605}
 606
 607impl<'a> SyntaxMapCaptures<'a> {
 608    fn new(
 609        range: Range<usize>,
 610        text: &'a Rope,
 611        layers: impl Iterator<Item = SyntaxLayerInfo<'a>>,
 612        query: fn(&Grammar) -> Option<&Query>,
 613    ) -> Self {
 614        let mut result = Self {
 615            layers: Vec::new(),
 616            grammars: Vec::new(),
 617            active_layer_count: 0,
 618        };
 619        for SyntaxLayerInfo {
 620            language,
 621            depth,
 622            node,
 623        } in layers
 624        {
 625            let grammar = match &language.grammar {
 626                Some(grammer) => grammer,
 627                None => continue,
 628            };
 629            let query = match query(&grammar) {
 630                Some(query) => query,
 631                None => continue,
 632            };
 633
 634            let mut query_cursor = QueryCursorHandle::new();
 635
 636            // TODO - add a Tree-sitter API to remove the need for this.
 637            let cursor = unsafe {
 638                std::mem::transmute::<_, &'static mut QueryCursor>(query_cursor.deref_mut())
 639            };
 640
 641            cursor.set_byte_range(range.clone());
 642            let captures = cursor.captures(query, node, TextProvider(text));
 643            let grammar_index = result
 644                .grammars
 645                .iter()
 646                .position(|g| g.id == grammar.id())
 647                .unwrap_or_else(|| {
 648                    result.grammars.push(grammar);
 649                    result.grammars.len() - 1
 650                });
 651            let mut layer = SyntaxMapCapturesLayer {
 652                depth,
 653                grammar_index,
 654                next_capture: None,
 655                captures,
 656                _query_cursor: query_cursor,
 657            };
 658
 659            layer.advance();
 660            if layer.next_capture.is_some() {
 661                let key = layer.sort_key();
 662                let ix = match result.layers[..result.active_layer_count]
 663                    .binary_search_by_key(&key, |layer| layer.sort_key())
 664                {
 665                    Ok(ix) | Err(ix) => ix,
 666                };
 667                result.layers.insert(ix, layer);
 668                result.active_layer_count += 1;
 669            } else {
 670                result.layers.push(layer);
 671            }
 672        }
 673
 674        result
 675    }
 676
 677    pub fn grammars(&self) -> &[&'a Grammar] {
 678        &self.grammars
 679    }
 680
 681    pub fn peek(&self) -> Option<SyntaxMapCapture<'a>> {
 682        let layer = self.layers[..self.active_layer_count].first()?;
 683        let capture = layer.next_capture?;
 684        Some(SyntaxMapCapture {
 685            depth: layer.depth,
 686            grammar_index: layer.grammar_index,
 687            index: capture.index,
 688            node: capture.node,
 689        })
 690    }
 691
 692    pub fn advance(&mut self) -> bool {
 693        let layer = if let Some(layer) = self.layers[..self.active_layer_count].first_mut() {
 694            layer
 695        } else {
 696            return false;
 697        };
 698
 699        layer.advance();
 700        if layer.next_capture.is_some() {
 701            let key = layer.sort_key();
 702            let i = 1 + self.layers[1..self.active_layer_count]
 703                .iter()
 704                .position(|later_layer| key < later_layer.sort_key())
 705                .unwrap_or(self.active_layer_count - 1);
 706            self.layers[0..i].rotate_left(1);
 707        } else {
 708            self.layers[0..self.active_layer_count].rotate_left(1);
 709            self.active_layer_count -= 1;
 710        }
 711
 712        true
 713    }
 714
 715    pub fn set_byte_range(&mut self, range: Range<usize>) {
 716        for layer in &mut self.layers {
 717            layer.captures.set_byte_range(range.clone());
 718            if let Some(capture) = &layer.next_capture {
 719                if capture.node.end_byte() > range.start {
 720                    continue;
 721                }
 722            }
 723            layer.advance();
 724        }
 725        self.layers.sort_unstable_by_key(|layer| layer.sort_key());
 726        self.active_layer_count = self
 727            .layers
 728            .iter()
 729            .position(|layer| layer.next_capture.is_none())
 730            .unwrap_or(self.layers.len());
 731    }
 732}
 733
 734impl<'a> SyntaxMapMatches<'a> {
 735    fn new(
 736        range: Range<usize>,
 737        text: &'a Rope,
 738        layers: impl Iterator<Item = SyntaxLayerInfo<'a>>,
 739        query: fn(&Grammar) -> Option<&Query>,
 740    ) -> Self {
 741        let mut result = Self::default();
 742        for SyntaxLayerInfo {
 743            language,
 744            depth,
 745            node,
 746        } in layers
 747        {
 748            let grammar = match &language.grammar {
 749                Some(grammer) => grammer,
 750                None => continue,
 751            };
 752            let query = match query(&grammar) {
 753                Some(query) => query,
 754                None => continue,
 755            };
 756
 757            let mut query_cursor = QueryCursorHandle::new();
 758
 759            // TODO - add a Tree-sitter API to remove the need for this.
 760            let cursor = unsafe {
 761                std::mem::transmute::<_, &'static mut QueryCursor>(query_cursor.deref_mut())
 762            };
 763
 764            cursor.set_byte_range(range.clone());
 765            let matches = cursor.matches(query, node, TextProvider(text));
 766            let grammar_index = result
 767                .grammars
 768                .iter()
 769                .position(|g| g.id == grammar.id())
 770                .unwrap_or_else(|| {
 771                    result.grammars.push(grammar);
 772                    result.grammars.len() - 1
 773                });
 774            let mut layer = SyntaxMapMatchesLayer {
 775                depth,
 776                grammar_index,
 777                matches,
 778                next_pattern_index: 0,
 779                next_captures: Vec::new(),
 780                has_next: false,
 781                _query_cursor: query_cursor,
 782            };
 783
 784            layer.advance();
 785            if layer.has_next {
 786                let key = layer.sort_key();
 787                let ix = match result.layers[..result.active_layer_count]
 788                    .binary_search_by_key(&key, |layer| layer.sort_key())
 789                {
 790                    Ok(ix) | Err(ix) => ix,
 791                };
 792                result.layers.insert(ix, layer);
 793                result.active_layer_count += 1;
 794            } else {
 795                result.layers.push(layer);
 796            }
 797        }
 798        result
 799    }
 800
 801    pub fn grammars(&self) -> &[&'a Grammar] {
 802        &self.grammars
 803    }
 804
 805    pub fn peek(&self) -> Option<SyntaxMapMatch> {
 806        let layer = self.layers.first()?;
 807        if !layer.has_next {
 808            return None;
 809        }
 810        Some(SyntaxMapMatch {
 811            depth: layer.depth,
 812            grammar_index: layer.grammar_index,
 813            pattern_index: layer.next_pattern_index,
 814            captures: &layer.next_captures,
 815        })
 816    }
 817
 818    pub fn advance(&mut self) -> bool {
 819        let layer = if let Some(layer) = self.layers.first_mut() {
 820            layer
 821        } else {
 822            return false;
 823        };
 824
 825        layer.advance();
 826        if layer.has_next {
 827            let key = layer.sort_key();
 828            let i = 1 + self.layers[1..self.active_layer_count]
 829                .iter()
 830                .position(|later_layer| key < later_layer.sort_key())
 831                .unwrap_or(self.active_layer_count - 1);
 832            self.layers[0..i].rotate_left(1);
 833        } else {
 834            self.layers[0..self.active_layer_count].rotate_left(1);
 835            self.active_layer_count -= 1;
 836        }
 837
 838        true
 839    }
 840}
 841
 842impl<'a> SyntaxMapCapturesLayer<'a> {
 843    fn advance(&mut self) {
 844        self.next_capture = self.captures.next().map(|(mat, ix)| mat.captures[ix]);
 845    }
 846
 847    fn sort_key(&self) -> (usize, Reverse<usize>, usize) {
 848        if let Some(capture) = &self.next_capture {
 849            let range = capture.node.byte_range();
 850            (range.start, Reverse(range.end), self.depth)
 851        } else {
 852            (usize::MAX, Reverse(0), usize::MAX)
 853        }
 854    }
 855}
 856
 857impl<'a> SyntaxMapMatchesLayer<'a> {
 858    fn advance(&mut self) {
 859        if let Some(mat) = self.matches.next() {
 860            self.next_captures.clear();
 861            self.next_captures.extend_from_slice(&mat.captures);
 862            self.next_pattern_index = mat.pattern_index;
 863            self.has_next = true;
 864        } else {
 865            self.has_next = false;
 866        }
 867    }
 868
 869    fn sort_key(&self) -> (usize, Reverse<usize>, usize) {
 870        if self.has_next {
 871            let captures = &self.next_captures;
 872            if let Some((first, last)) = captures.first().zip(captures.last()) {
 873                return (
 874                    first.node.start_byte(),
 875                    Reverse(last.node.end_byte()),
 876                    self.depth,
 877                );
 878            }
 879        }
 880        (usize::MAX, Reverse(0), usize::MAX)
 881    }
 882}
 883
 884impl<'a> Iterator for SyntaxMapCaptures<'a> {
 885    type Item = SyntaxMapCapture<'a>;
 886
 887    fn next(&mut self) -> Option<Self::Item> {
 888        let result = self.peek();
 889        self.advance();
 890        result
 891    }
 892}
 893
 894fn join_ranges(
 895    a: impl Iterator<Item = Range<usize>>,
 896    b: impl Iterator<Item = Range<usize>>,
 897) -> Vec<Range<usize>> {
 898    let mut result = Vec::<Range<usize>>::new();
 899    let mut a = a.peekable();
 900    let mut b = b.peekable();
 901    loop {
 902        let range = match (a.peek(), b.peek()) {
 903            (Some(range_a), Some(range_b)) => {
 904                if range_a.start < range_b.start {
 905                    a.next().unwrap()
 906                } else {
 907                    b.next().unwrap()
 908                }
 909            }
 910            (None, Some(_)) => b.next().unwrap(),
 911            (Some(_), None) => a.next().unwrap(),
 912            (None, None) => break,
 913        };
 914
 915        if let Some(last) = result.last_mut() {
 916            if range.start <= last.end {
 917                last.end = last.end.max(range.end);
 918                continue;
 919            }
 920        }
 921        result.push(range);
 922    }
 923    result
 924}
 925
 926fn parse_text(
 927    grammar: &Grammar,
 928    text: &Rope,
 929    start_byte: usize,
 930    start_point: Point,
 931    mut ranges: Vec<tree_sitter::Range>,
 932    old_tree: Option<Tree>,
 933) -> Tree {
 934    for range in &mut ranges {
 935        range.start_byte -= start_byte;
 936        range.end_byte -= start_byte;
 937        range.start_point = (Point::from_ts_point(range.start_point) - start_point).to_ts_point();
 938        range.end_point = (Point::from_ts_point(range.end_point) - start_point).to_ts_point();
 939    }
 940
 941    PARSER.with(|parser| {
 942        let mut parser = parser.borrow_mut();
 943        let mut chunks = text.chunks_in_range(start_byte..text.len());
 944        parser
 945            .set_included_ranges(&ranges)
 946            .expect("overlapping ranges");
 947        parser
 948            .set_language(grammar.ts_language)
 949            .expect("incompatible grammar");
 950        parser
 951            .parse_with(
 952                &mut move |offset, _| {
 953                    chunks.seek(start_byte + offset);
 954                    chunks.next().unwrap_or("").as_bytes()
 955                },
 956                old_tree.as_ref(),
 957            )
 958            .expect("invalid language")
 959    })
 960}
 961
 962fn get_injections(
 963    config: &InjectionConfig,
 964    text: &BufferSnapshot,
 965    node: Node,
 966    language_registry: &LanguageRegistry,
 967    depth: usize,
 968    changed_ranges: &[Range<usize>],
 969    combined_injection_ranges: &mut HashMap<Arc<Language>, Vec<tree_sitter::Range>>,
 970    queue: &mut BinaryHeap<ParseStep>,
 971) -> bool {
 972    let mut result = false;
 973    let mut query_cursor = QueryCursorHandle::new();
 974    let mut prev_match = None;
 975
 976    combined_injection_ranges.clear();
 977    for pattern in &config.patterns {
 978        if let (Some(language_name), true) = (pattern.language.as_ref(), pattern.combined) {
 979            if let Some(language) = language_registry.get_language(language_name) {
 980                combined_injection_ranges.insert(language, Vec::new());
 981            }
 982        }
 983    }
 984
 985    for query_range in changed_ranges {
 986        query_cursor.set_byte_range(query_range.start.saturating_sub(1)..query_range.end + 1);
 987        for mat in query_cursor.matches(&config.query, node, TextProvider(text.as_rope())) {
 988            let content_ranges = mat
 989                .nodes_for_capture_index(config.content_capture_ix)
 990                .map(|node| node.range())
 991                .collect::<Vec<_>>();
 992            if content_ranges.is_empty() {
 993                continue;
 994            }
 995
 996            // Avoid duplicate matches if two changed ranges intersect the same injection.
 997            let content_range =
 998                content_ranges.first().unwrap().start_byte..content_ranges.last().unwrap().end_byte;
 999            if let Some((last_pattern_ix, last_range)) = &prev_match {
1000                if mat.pattern_index == *last_pattern_ix && content_range == *last_range {
1001                    continue;
1002                }
1003            }
1004            prev_match = Some((mat.pattern_index, content_range.clone()));
1005
1006            let combined = config.patterns[mat.pattern_index].combined;
1007            let language_name = config.patterns[mat.pattern_index]
1008                .language
1009                .as_ref()
1010                .map(|s| Cow::Borrowed(s.as_ref()))
1011                .or_else(|| {
1012                    let ix = config.language_capture_ix?;
1013                    let node = mat.nodes_for_capture_index(ix).next()?;
1014                    Some(Cow::Owned(text.text_for_range(node.byte_range()).collect()))
1015                });
1016
1017            if let Some(language_name) = language_name {
1018                if let Some(language) = language_registry.get_language(language_name.as_ref()) {
1019                    result = true;
1020                    let range = text.anchor_before(content_range.start)
1021                        ..text.anchor_after(content_range.end);
1022                    if combined {
1023                        combined_injection_ranges
1024                            .get_mut(&language.clone())
1025                            .unwrap()
1026                            .extend(content_ranges);
1027                    } else {
1028                        queue.push(ParseStep {
1029                            depth,
1030                            language,
1031                            included_ranges: content_ranges,
1032                            range,
1033                            mode: ParseMode::Single,
1034                        });
1035                    }
1036                }
1037            }
1038        }
1039    }
1040
1041    for (language, mut included_ranges) in combined_injection_ranges.drain() {
1042        included_ranges.sort_unstable();
1043        let range = text.anchor_before(node.start_byte())..text.anchor_after(node.end_byte());
1044        queue.push(ParseStep {
1045            depth,
1046            language,
1047            range,
1048            included_ranges,
1049            mode: ParseMode::Combined {
1050                parent_layer_range: node.start_byte()..node.end_byte(),
1051                parent_layer_changed_ranges: changed_ranges.to_vec(),
1052            },
1053        })
1054    }
1055
1056    result
1057}
1058
1059fn splice_included_ranges(
1060    mut ranges: Vec<tree_sitter::Range>,
1061    changed_ranges: &[Range<usize>],
1062    new_ranges: &[tree_sitter::Range],
1063) -> Vec<tree_sitter::Range> {
1064    let mut changed_ranges = changed_ranges.into_iter().peekable();
1065    let mut new_ranges = new_ranges.into_iter().peekable();
1066    let mut ranges_ix = 0;
1067    loop {
1068        let new_range = new_ranges.peek();
1069        let mut changed_range = changed_ranges.peek();
1070
1071        // Remove ranges that have changed before inserting any new ranges
1072        // into those ranges.
1073        if let Some((changed, new)) = changed_range.zip(new_range) {
1074            if new.end_byte < changed.start {
1075                changed_range = None;
1076            }
1077        }
1078
1079        if let Some(changed) = changed_range {
1080            let mut start_ix = ranges_ix
1081                + match ranges[ranges_ix..].binary_search_by_key(&changed.start, |r| r.end_byte) {
1082                    Ok(ix) | Err(ix) => ix,
1083                };
1084            let mut end_ix = ranges_ix
1085                + match ranges[ranges_ix..].binary_search_by_key(&changed.end, |r| r.start_byte) {
1086                    Ok(ix) => ix + 1,
1087                    Err(ix) => ix,
1088                };
1089
1090            // If there are empty ranges, then there may be multiple ranges with the same
1091            // start or end. Expand the splice to include any adjacent ranges that touch
1092            // the changed range.
1093            while start_ix > 0 {
1094                if ranges[start_ix - 1].end_byte == changed.start {
1095                    start_ix -= 1;
1096                } else {
1097                    break;
1098                }
1099            }
1100            while let Some(range) = ranges.get(end_ix) {
1101                if range.start_byte == changed.end {
1102                    end_ix += 1;
1103                } else {
1104                    break;
1105                }
1106            }
1107
1108            if end_ix > start_ix {
1109                ranges.splice(start_ix..end_ix, []);
1110            }
1111            changed_ranges.next();
1112            ranges_ix = start_ix;
1113        } else if let Some(new_range) = new_range {
1114            let ix = ranges_ix
1115                + match ranges[ranges_ix..]
1116                    .binary_search_by_key(&new_range.start_byte, |r| r.start_byte)
1117                {
1118                    Ok(ix) | Err(ix) => ix,
1119                };
1120            ranges.insert(ix, **new_range);
1121            new_ranges.next();
1122            ranges_ix = ix + 1;
1123        } else {
1124            break;
1125        }
1126    }
1127    ranges
1128}
1129
1130impl std::ops::Deref for SyntaxMap {
1131    type Target = SyntaxSnapshot;
1132
1133    fn deref(&self) -> &Self::Target {
1134        &self.snapshot
1135    }
1136}
1137
1138impl PartialEq for ParseStep {
1139    fn eq(&self, _: &Self) -> bool {
1140        false
1141    }
1142}
1143
1144impl Eq for ParseStep {}
1145
1146impl PartialOrd for ParseStep {
1147    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1148        Some(self.cmp(&other))
1149    }
1150}
1151
1152impl Ord for ParseStep {
1153    fn cmp(&self, other: &Self) -> Ordering {
1154        let range_a = self.range();
1155        let range_b = other.range();
1156        Ord::cmp(&other.depth, &self.depth)
1157            .then_with(|| Ord::cmp(&range_b.start, &range_a.start))
1158            .then_with(|| Ord::cmp(&range_a.end, &range_b.end))
1159            .then_with(|| self.language.id().cmp(&other.language.id()))
1160    }
1161}
1162
1163impl ParseStep {
1164    fn range(&self) -> Range<usize> {
1165        if let ParseMode::Combined {
1166            parent_layer_range, ..
1167        } = &self.mode
1168        {
1169            parent_layer_range.clone()
1170        } else {
1171            let start = self.included_ranges.first().map_or(0, |r| r.start_byte);
1172            let end = self.included_ranges.last().map_or(0, |r| r.end_byte);
1173            start..end
1174        }
1175    }
1176}
1177
1178impl ChangedRegion {
1179    fn cmp(&self, other: &Self, buffer: &BufferSnapshot) -> Ordering {
1180        let range_a = &self.range;
1181        let range_b = &other.range;
1182        Ord::cmp(&self.depth, &other.depth)
1183            .then_with(|| range_a.start.cmp(&range_b.start, buffer))
1184            .then_with(|| range_b.end.cmp(&range_a.end, buffer))
1185    }
1186}
1187
1188impl ChangeRegionSet {
1189    fn start_position(&self) -> ChangeStartPosition {
1190        self.0.first().map_or(
1191            ChangeStartPosition {
1192                depth: usize::MAX,
1193                position: Anchor::MAX,
1194            },
1195            |region| ChangeStartPosition {
1196                depth: region.depth,
1197                position: region.range.start,
1198            },
1199        )
1200    }
1201
1202    fn intersects(&self, layer: &SyntaxLayer, text: &BufferSnapshot) -> bool {
1203        for region in &self.0 {
1204            if region.depth < layer.depth {
1205                continue;
1206            }
1207            if region.depth > layer.depth {
1208                break;
1209            }
1210            if region.range.end.cmp(&layer.range.start, text).is_le() {
1211                continue;
1212            }
1213            if region.range.start.cmp(&layer.range.end, text).is_ge() {
1214                break;
1215            }
1216            return true;
1217        }
1218        false
1219    }
1220
1221    fn insert(&mut self, region: ChangedRegion, text: &BufferSnapshot) {
1222        if let Err(ix) = self.0.binary_search_by(|probe| probe.cmp(&region, text)) {
1223            self.0.insert(ix, region);
1224        }
1225    }
1226
1227    fn prune(&mut self, summary: SyntaxLayerSummary, text: &BufferSnapshot) -> bool {
1228        let prev_len = self.0.len();
1229        self.0.retain(|region| {
1230            region.depth > summary.max_depth
1231                || (region.depth == summary.max_depth
1232                    && region
1233                        .range
1234                        .end
1235                        .cmp(&summary.last_layer_range.start, text)
1236                        .is_gt())
1237        });
1238        self.0.len() < prev_len
1239    }
1240}
1241
1242impl Default for SyntaxLayerSummary {
1243    fn default() -> Self {
1244        Self {
1245            max_depth: 0,
1246            min_depth: 0,
1247            range: Anchor::MAX..Anchor::MIN,
1248            last_layer_range: Anchor::MIN..Anchor::MAX,
1249            last_layer_language: None,
1250        }
1251    }
1252}
1253
1254impl sum_tree::Summary for SyntaxLayerSummary {
1255    type Context = BufferSnapshot;
1256
1257    fn add_summary(&mut self, other: &Self, buffer: &Self::Context) {
1258        if other.max_depth > self.max_depth {
1259            self.max_depth = other.max_depth;
1260            self.range = other.range.clone();
1261        } else {
1262            if other.range.start.cmp(&self.range.start, buffer).is_lt() {
1263                self.range.start = other.range.start;
1264            }
1265            if other.range.end.cmp(&self.range.end, buffer).is_gt() {
1266                self.range.end = other.range.end;
1267            }
1268        }
1269        self.last_layer_range = other.last_layer_range.clone();
1270        self.last_layer_language = other.last_layer_language;
1271    }
1272}
1273
1274impl<'a> SeekTarget<'a, SyntaxLayerSummary, SyntaxLayerSummary> for SyntaxLayerPosition {
1275    fn cmp(&self, cursor_location: &SyntaxLayerSummary, buffer: &BufferSnapshot) -> Ordering {
1276        Ord::cmp(&self.depth, &cursor_location.max_depth)
1277            .then_with(|| {
1278                self.range
1279                    .start
1280                    .cmp(&cursor_location.last_layer_range.start, buffer)
1281            })
1282            .then_with(|| {
1283                cursor_location
1284                    .last_layer_range
1285                    .end
1286                    .cmp(&self.range.end, buffer)
1287            })
1288            .then_with(|| self.language.cmp(&cursor_location.last_layer_language))
1289    }
1290}
1291
1292impl<'a> SeekTarget<'a, SyntaxLayerSummary, SyntaxLayerSummary> for ChangeStartPosition {
1293    fn cmp(&self, cursor_location: &SyntaxLayerSummary, text: &BufferSnapshot) -> Ordering {
1294        Ord::cmp(&self.depth, &cursor_location.max_depth)
1295            .then_with(|| self.position.cmp(&cursor_location.range.end, text))
1296    }
1297}
1298
1299impl<'a> SeekTarget<'a, SyntaxLayerSummary, SyntaxLayerSummary>
1300    for SyntaxLayerPositionBeforeChange
1301{
1302    fn cmp(&self, cursor_location: &SyntaxLayerSummary, buffer: &BufferSnapshot) -> Ordering {
1303        if self.change.cmp(cursor_location, buffer).is_le() {
1304            return Ordering::Less;
1305        } else {
1306            self.position.cmp(cursor_location, buffer)
1307        }
1308    }
1309}
1310
1311impl sum_tree::Item for SyntaxLayer {
1312    type Summary = SyntaxLayerSummary;
1313
1314    fn summary(&self) -> Self::Summary {
1315        SyntaxLayerSummary {
1316            min_depth: self.depth,
1317            max_depth: self.depth,
1318            range: self.range.clone(),
1319            last_layer_range: self.range.clone(),
1320            last_layer_language: self.language.id(),
1321        }
1322    }
1323}
1324
1325impl std::fmt::Debug for SyntaxLayer {
1326    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1327        f.debug_struct("SyntaxLayer")
1328            .field("depth", &self.depth)
1329            .field("range", &self.range)
1330            .field("tree", &self.tree)
1331            .finish()
1332    }
1333}
1334
1335impl<'a> tree_sitter::TextProvider<'a> for TextProvider<'a> {
1336    type I = ByteChunks<'a>;
1337
1338    fn text(&mut self, node: tree_sitter::Node) -> Self::I {
1339        ByteChunks(self.0.chunks_in_range(node.byte_range()))
1340    }
1341}
1342
1343impl<'a> Iterator for ByteChunks<'a> {
1344    type Item = &'a [u8];
1345
1346    fn next(&mut self) -> Option<Self::Item> {
1347        self.0.next().map(str::as_bytes)
1348    }
1349}
1350
1351impl QueryCursorHandle {
1352    pub(crate) fn new() -> Self {
1353        let mut cursor = QUERY_CURSORS.lock().pop().unwrap_or_else(QueryCursor::new);
1354        cursor.set_match_limit(64);
1355        QueryCursorHandle(Some(cursor))
1356    }
1357}
1358
1359impl Deref for QueryCursorHandle {
1360    type Target = QueryCursor;
1361
1362    fn deref(&self) -> &Self::Target {
1363        self.0.as_ref().unwrap()
1364    }
1365}
1366
1367impl DerefMut for QueryCursorHandle {
1368    fn deref_mut(&mut self) -> &mut Self::Target {
1369        self.0.as_mut().unwrap()
1370    }
1371}
1372
1373impl Drop for QueryCursorHandle {
1374    fn drop(&mut self) {
1375        let mut cursor = self.0.take().unwrap();
1376        cursor.set_byte_range(0..usize::MAX);
1377        cursor.set_point_range(Point::zero().to_ts_point()..Point::MAX.to_ts_point());
1378        QUERY_CURSORS.lock().push(cursor)
1379    }
1380}
1381
1382pub(crate) trait ToTreeSitterPoint {
1383    fn to_ts_point(self) -> tree_sitter::Point;
1384    fn from_ts_point(point: tree_sitter::Point) -> Self;
1385}
1386
1387impl ToTreeSitterPoint for Point {
1388    fn to_ts_point(self) -> tree_sitter::Point {
1389        tree_sitter::Point::new(self.row as usize, self.column as usize)
1390    }
1391
1392    fn from_ts_point(point: tree_sitter::Point) -> Self {
1393        Point::new(point.row as u32, point.column as u32)
1394    }
1395}
1396
1397#[cfg(test)]
1398mod tests {
1399    use super::*;
1400    use crate::LanguageConfig;
1401    use rand::rngs::StdRng;
1402    use std::env;
1403    use text::Buffer;
1404    use unindent::Unindent as _;
1405    use util::test::marked_text_ranges;
1406
1407    #[test]
1408    fn test_splice_included_ranges() {
1409        let ranges = vec![ts_range(20..30), ts_range(50..60), ts_range(80..90)];
1410
1411        let new_ranges = splice_included_ranges(
1412            ranges.clone(),
1413            &[54..56, 58..68],
1414            &[ts_range(50..54), ts_range(59..67)],
1415        );
1416        assert_eq!(
1417            new_ranges,
1418            &[
1419                ts_range(20..30),
1420                ts_range(50..54),
1421                ts_range(59..67),
1422                ts_range(80..90),
1423            ]
1424        );
1425
1426        let new_ranges = splice_included_ranges(ranges.clone(), &[70..71, 91..100], &[]);
1427        assert_eq!(
1428            new_ranges,
1429            &[ts_range(20..30), ts_range(50..60), ts_range(80..90)]
1430        );
1431
1432        let new_ranges =
1433            splice_included_ranges(ranges.clone(), &[], &[ts_range(0..2), ts_range(70..75)]);
1434        assert_eq!(
1435            new_ranges,
1436            &[
1437                ts_range(0..2),
1438                ts_range(20..30),
1439                ts_range(50..60),
1440                ts_range(70..75),
1441                ts_range(80..90)
1442            ]
1443        );
1444
1445        let new_ranges = splice_included_ranges(ranges.clone(), &[30..50], &[ts_range(25..55)]);
1446        assert_eq!(new_ranges, &[ts_range(25..55), ts_range(80..90)]);
1447
1448        fn ts_range(range: Range<usize>) -> tree_sitter::Range {
1449            tree_sitter::Range {
1450                start_byte: range.start,
1451                start_point: tree_sitter::Point {
1452                    row: 0,
1453                    column: range.start,
1454                },
1455                end_byte: range.end,
1456                end_point: tree_sitter::Point {
1457                    row: 0,
1458                    column: range.end,
1459                },
1460            }
1461        }
1462    }
1463
1464    #[gpui::test]
1465    fn test_syntax_map_layers_for_range() {
1466        let registry = Arc::new(LanguageRegistry::test());
1467        let language = Arc::new(rust_lang());
1468        registry.add(language.clone());
1469
1470        let mut buffer = Buffer::new(
1471            0,
1472            0,
1473            r#"
1474                fn a() {
1475                    assert_eq!(
1476                        b(vec![C {}]),
1477                        vec![d.e],
1478                    );
1479                    println!("{}", f(|_| true));
1480                }
1481            "#
1482            .unindent(),
1483        );
1484
1485        let mut syntax_map = SyntaxMap::new();
1486        syntax_map.set_language_registry(registry.clone());
1487        syntax_map.reparse(language.clone(), &buffer);
1488
1489        assert_layers_for_range(
1490            &syntax_map,
1491            &buffer,
1492            Point::new(2, 0)..Point::new(2, 0),
1493            &[
1494                "...(function_item ... (block (expression_statement (macro_invocation...",
1495                "...(tuple_expression (call_expression ... arguments: (arguments (macro_invocation...",
1496            ],
1497        );
1498        assert_layers_for_range(
1499            &syntax_map,
1500            &buffer,
1501            Point::new(2, 14)..Point::new(2, 16),
1502            &[
1503                "...(function_item ...",
1504                "...(tuple_expression (call_expression ... arguments: (arguments (macro_invocation...",
1505                "...(array_expression (struct_expression ...",
1506            ],
1507        );
1508        assert_layers_for_range(
1509            &syntax_map,
1510            &buffer,
1511            Point::new(3, 14)..Point::new(3, 16),
1512            &[
1513                "...(function_item ...",
1514                "...(tuple_expression (call_expression ... arguments: (arguments (macro_invocation...",
1515                "...(array_expression (field_expression ...",
1516            ],
1517        );
1518        assert_layers_for_range(
1519            &syntax_map,
1520            &buffer,
1521            Point::new(5, 12)..Point::new(5, 16),
1522            &[
1523                "...(function_item ...",
1524                "...(call_expression ... (arguments (closure_expression ...",
1525            ],
1526        );
1527
1528        // Replace a vec! macro invocation with a plain slice, removing a syntactic layer.
1529        let macro_name_range = range_for_text(&buffer, "vec!");
1530        buffer.edit([(macro_name_range, "&")]);
1531        syntax_map.interpolate(&buffer);
1532        syntax_map.reparse(language.clone(), &buffer);
1533
1534        assert_layers_for_range(
1535            &syntax_map,
1536            &buffer,
1537            Point::new(2, 14)..Point::new(2, 16),
1538            &[
1539                "...(function_item ...",
1540                "...(tuple_expression (call_expression ... arguments: (arguments (reference_expression value: (array_expression...",
1541            ],
1542        );
1543
1544        // Put the vec! macro back, adding back the syntactic layer.
1545        buffer.undo();
1546        syntax_map.interpolate(&buffer);
1547        syntax_map.reparse(language.clone(), &buffer);
1548
1549        assert_layers_for_range(
1550            &syntax_map,
1551            &buffer,
1552            Point::new(2, 14)..Point::new(2, 16),
1553            &[
1554                "...(function_item ...",
1555                "...(tuple_expression (call_expression ... arguments: (arguments (macro_invocation...",
1556                "...(array_expression (struct_expression ...",
1557            ],
1558        );
1559    }
1560
1561    #[gpui::test]
1562    fn test_typing_multiple_new_injections() {
1563        let (buffer, syntax_map) = test_edit_sequence(
1564            "Rust",
1565            &[
1566                "fn a() { dbg }",
1567                "fn a() { dbg«!» }",
1568                "fn a() { dbg!«()» }",
1569                "fn a() { dbg!(«b») }",
1570                "fn a() { dbg!(b«.») }",
1571                "fn a() { dbg!(b.«c») }",
1572                "fn a() { dbg!(b.c«()») }",
1573                "fn a() { dbg!(b.c(«vec»)) }",
1574                "fn a() { dbg!(b.c(vec«!»)) }",
1575                "fn a() { dbg!(b.c(vec!«[]»)) }",
1576                "fn a() { dbg!(b.c(vec![«d»])) }",
1577                "fn a() { dbg!(b.c(vec![d«.»])) }",
1578                "fn a() { dbg!(b.c(vec![d.«e»])) }",
1579            ],
1580        );
1581
1582        assert_capture_ranges(
1583            &syntax_map,
1584            &buffer,
1585            &["field"],
1586            "fn a() { dbg!(b.«c»(vec![d.«e»])) }",
1587        );
1588    }
1589
1590    #[gpui::test]
1591    fn test_pasting_new_injection_line_between_others() {
1592        let (buffer, syntax_map) = test_edit_sequence(
1593            "Rust",
1594            &[
1595                "
1596                    fn a() {
1597                        b!(B {});
1598                        c!(C {});
1599                        d!(D {});
1600                        e!(E {});
1601                        f!(F {});
1602                        g!(G {});
1603                    }
1604                ",
1605                "
1606                    fn a() {
1607                        b!(B {});
1608                        c!(C {});
1609                        d!(D {});
1610                    «    h!(H {});
1611                    »    e!(E {});
1612                        f!(F {});
1613                        g!(G {});
1614                    }
1615                ",
1616            ],
1617        );
1618
1619        assert_capture_ranges(
1620            &syntax_map,
1621            &buffer,
1622            &["struct"],
1623            "
1624            fn a() {
1625                b!(«B {}»);
1626                c!(«C {}»);
1627                d!(«D {}»);
1628                h!(«H {}»);
1629                e!(«E {}»);
1630                f!(«F {}»);
1631                g!(«G {}»);
1632            }
1633            ",
1634        );
1635    }
1636
1637    #[gpui::test]
1638    fn test_joining_injections_with_child_injections() {
1639        let (buffer, syntax_map) = test_edit_sequence(
1640            "Rust",
1641            &[
1642                "
1643                    fn a() {
1644                        b!(
1645                            c![one.two.three],
1646                            d![four.five.six],
1647                        );
1648                        e!(
1649                            f![seven.eight],
1650                        );
1651                    }
1652                ",
1653                "
1654                    fn a() {
1655                        b!(
1656                            c![one.two.three],
1657                            d![four.five.six],
1658                        ˇ    f![seven.eight],
1659                        );
1660                    }
1661                ",
1662            ],
1663        );
1664
1665        assert_capture_ranges(
1666            &syntax_map,
1667            &buffer,
1668            &["field"],
1669            "
1670            fn a() {
1671                b!(
1672                    c![one.«two».«three»],
1673                    d![four.«five».«six»],
1674                    f![seven.«eight»],
1675                );
1676            }
1677            ",
1678        );
1679    }
1680
1681    #[gpui::test]
1682    fn test_editing_edges_of_injection() {
1683        test_edit_sequence(
1684            "Rust",
1685            &[
1686                "
1687                    fn a() {
1688                        b!(c!())
1689                    }
1690                ",
1691                "
1692                    fn a() {
1693                        «d»!(c!())
1694                    }
1695                ",
1696                "
1697                    fn a() {
1698                        «e»d!(c!())
1699                    }
1700                ",
1701                "
1702                    fn a() {
1703                        ed!«[»c!()«]»
1704                    }
1705            ",
1706            ],
1707        );
1708    }
1709
1710    #[gpui::test]
1711    fn test_edits_preceding_and_intersecting_injection() {
1712        test_edit_sequence(
1713            "Rust",
1714            &[
1715                //
1716                "const aaaaaaaaaaaa: B = c!(d(e.f));",
1717                "const aˇa: B = c!(d(eˇ));",
1718            ],
1719        );
1720    }
1721
1722    #[gpui::test]
1723    fn test_non_local_changes_create_injections() {
1724        test_edit_sequence(
1725            "Rust",
1726            &[
1727                "
1728                    // a! {
1729                        static B: C = d;
1730                    // }
1731                ",
1732                "
1733                    ˇa! {
1734                        static B: C = d;
1735                    ˇ}
1736                ",
1737            ],
1738        );
1739    }
1740
1741    #[gpui::test]
1742    fn test_creating_many_injections_in_one_edit() {
1743        test_edit_sequence(
1744            "Rust",
1745            &[
1746                "
1747                    fn a() {
1748                        one(Two::three(3));
1749                        four(Five::six(6));
1750                        seven(Eight::nine(9));
1751                    }
1752                ",
1753                "
1754                    fn a() {
1755                        one«!»(Two::three(3));
1756                        four«!»(Five::six(6));
1757                        seven«!»(Eight::nine(9));
1758                    }
1759                ",
1760                "
1761                    fn a() {
1762                        one!(Two::three«!»(3));
1763                        four!(Five::six«!»(6));
1764                        seven!(Eight::nine«!»(9));
1765                    }
1766                ",
1767            ],
1768        );
1769    }
1770
1771    #[gpui::test]
1772    fn test_editing_across_injection_boundary() {
1773        test_edit_sequence(
1774            "Rust",
1775            &[
1776                "
1777                    fn one() {
1778                        two();
1779                        three!(
1780                            three.four,
1781                            five.six,
1782                        );
1783                    }
1784                ",
1785                "
1786                    fn one() {
1787                        two();
1788                        th«irty_five![»
1789                            three.four,
1790                            five.six,
1791                        «   seven.eight,
1792                        ];»
1793                    }
1794                ",
1795            ],
1796        );
1797    }
1798
1799    #[gpui::test]
1800    fn test_removing_injection_by_replacing_across_boundary() {
1801        test_edit_sequence(
1802            "Rust",
1803            &[
1804                "
1805                    fn one() {
1806                        two!(
1807                            three.four,
1808                        );
1809                    }
1810                ",
1811                "
1812                    fn one() {
1813                        t«en
1814                            .eleven(
1815                            twelve,
1816                        »
1817                            three.four,
1818                        );
1819                    }
1820                ",
1821            ],
1822        );
1823    }
1824
1825    #[gpui::test]
1826    fn test_combined_injections() {
1827        let (buffer, syntax_map) = test_edit_sequence(
1828            "ERB",
1829            &[
1830                "
1831                    <body>
1832                        <% if @one %>
1833                            <div class=one>
1834                        <% else %>
1835                            <div class=two>
1836                        <% end %>
1837                        </div>
1838                    </body>
1839                ",
1840                "
1841                    <body>
1842                        <% if @one %>
1843                            <div class=one>
1844                        ˇ else ˇ
1845                            <div class=two>
1846                        <% end %>
1847                        </div>
1848                    </body>
1849                ",
1850                "
1851                    <body>
1852                        <% if @one «;» end %>
1853                        </div>
1854                    </body>
1855                ",
1856            ],
1857        );
1858
1859        assert_capture_ranges(
1860            &syntax_map,
1861            &buffer,
1862            &["tag", "ivar"],
1863            "
1864                <«body»>
1865                    <% if «@one» ; end %>
1866                    </«div»>
1867                </«body»>
1868            ",
1869        );
1870    }
1871
1872    #[gpui::test]
1873    fn test_combined_injections_empty_ranges() {
1874        test_edit_sequence(
1875            "ERB",
1876            &[
1877                "
1878                    <% if @one %>
1879                    <% else %>
1880                    <% end %>
1881                ",
1882                "
1883                    <% if @one %>
1884                    ˇ<% end %>
1885                ",
1886            ],
1887        );
1888    }
1889
1890    #[gpui::test]
1891    fn test_combined_injections_edit_edges_of_ranges() {
1892        let (buffer, syntax_map) = test_edit_sequence(
1893            "ERB",
1894            &[
1895                "
1896                    <%= one @two %>
1897                    <%= three @four %>
1898                ",
1899                "
1900                    <%= one @two %ˇ
1901                    <%= three @four %>
1902                ",
1903                "
1904                    <%= one @two %«>»
1905                    <%= three @four %>
1906                ",
1907            ],
1908        );
1909
1910        assert_capture_ranges(
1911            &syntax_map,
1912            &buffer,
1913            &["tag", "ivar"],
1914            "
1915                <%= one «@two» %>
1916                <%= three «@four» %>
1917            ",
1918        );
1919    }
1920
1921    #[gpui::test]
1922    fn test_combined_injections_splitting_some_injections() {
1923        let (_buffer, _syntax_map) = test_edit_sequence(
1924            "ERB",
1925            &[
1926                r#"
1927                      <%A if b(:c) %>
1928                        d
1929                      <% end %>
1930                      eee
1931                      <% f %>
1932                "#,
1933                r#"
1934                      <%« AAAAAAA %>
1935                        hhhhhhh
1936                      <%=» if b(:c) %>
1937                        d
1938                      <% end %>
1939                      eee
1940                      <% f %>
1941                "#,
1942            ],
1943        );
1944    }
1945
1946    #[gpui::test(iterations = 50)]
1947    fn test_random_syntax_map_edits(mut rng: StdRng) {
1948        let operations = env::var("OPERATIONS")
1949            .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
1950            .unwrap_or(10);
1951
1952        let text = r#"
1953            fn test_something() {
1954                let vec = vec![5, 1, 3, 8];
1955                assert_eq!(
1956                    vec
1957                        .into_iter()
1958                        .map(|i| i * 2)
1959                        .collect::<Vec<usize>>(),
1960                    vec![
1961                        5 * 2, 1 * 2, 3 * 2, 8 * 2
1962                    ],
1963                );
1964            }
1965        "#
1966        .unindent()
1967        .repeat(2);
1968
1969        let registry = Arc::new(LanguageRegistry::test());
1970        let language = Arc::new(rust_lang());
1971        registry.add(language.clone());
1972        let mut buffer = Buffer::new(0, 0, text);
1973
1974        let mut syntax_map = SyntaxMap::new();
1975        syntax_map.set_language_registry(registry.clone());
1976        syntax_map.reparse(language.clone(), &buffer);
1977
1978        let mut reference_syntax_map = SyntaxMap::new();
1979        reference_syntax_map.set_language_registry(registry.clone());
1980
1981        log::info!("initial text:\n{}", buffer.text());
1982
1983        for _ in 0..operations {
1984            let prev_buffer = buffer.snapshot();
1985            let prev_syntax_map = syntax_map.snapshot();
1986
1987            buffer.randomly_edit(&mut rng, 3);
1988            log::info!("text:\n{}", buffer.text());
1989
1990            syntax_map.interpolate(&buffer);
1991            check_interpolation(&prev_syntax_map, &syntax_map, &prev_buffer, &buffer);
1992
1993            syntax_map.reparse(language.clone(), &buffer);
1994
1995            reference_syntax_map.clear();
1996            reference_syntax_map.reparse(language.clone(), &buffer);
1997        }
1998
1999        for i in 0..operations {
2000            let i = operations - i - 1;
2001            buffer.undo();
2002            log::info!("undoing operation {}", i);
2003            log::info!("text:\n{}", buffer.text());
2004
2005            syntax_map.interpolate(&buffer);
2006            syntax_map.reparse(language.clone(), &buffer);
2007
2008            reference_syntax_map.clear();
2009            reference_syntax_map.reparse(language.clone(), &buffer);
2010            assert_eq!(
2011                syntax_map.layers(&buffer).len(),
2012                reference_syntax_map.layers(&buffer).len(),
2013                "wrong number of layers after undoing edit {i}"
2014            );
2015        }
2016
2017        let layers = syntax_map.layers(&buffer);
2018        let reference_layers = reference_syntax_map.layers(&buffer);
2019        for (edited_layer, reference_layer) in layers.into_iter().zip(reference_layers.into_iter())
2020        {
2021            assert_eq!(edited_layer.node.to_sexp(), reference_layer.node.to_sexp());
2022            assert_eq!(edited_layer.node.range(), reference_layer.node.range());
2023        }
2024    }
2025
2026    #[gpui::test(iterations = 50)]
2027    fn test_random_syntax_map_edits_with_combined_injections(mut rng: StdRng) {
2028        let operations = env::var("OPERATIONS")
2029            .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
2030            .unwrap_or(10);
2031
2032        let text = r#"
2033          <div id="main">
2034            <% if one?(:two) %>
2035              <p class="three" four>
2036                <%= yield :five %>
2037              </p>
2038            <% elsif Six.seven(8) %>
2039              <p id="three" four>
2040                <%= yield :five %>
2041              </p>
2042            <% else %>
2043              <span>Ok</span>
2044            <% end %>
2045          </div>
2046        "#
2047        .unindent()
2048        .repeat(8);
2049
2050        let registry = Arc::new(LanguageRegistry::test());
2051        let language = Arc::new(erb_lang());
2052        registry.add(language.clone());
2053        registry.add(Arc::new(ruby_lang()));
2054        registry.add(Arc::new(html_lang()));
2055        let mut buffer = Buffer::new(0, 0, text);
2056
2057        let mut syntax_map = SyntaxMap::new();
2058        syntax_map.set_language_registry(registry.clone());
2059        syntax_map.reparse(language.clone(), &buffer);
2060
2061        let mut reference_syntax_map = SyntaxMap::new();
2062        reference_syntax_map.set_language_registry(registry.clone());
2063
2064        log::info!("initial text:\n{}", buffer.text());
2065
2066        for _ in 0..operations {
2067            let prev_buffer = buffer.snapshot();
2068            let prev_syntax_map = syntax_map.snapshot();
2069
2070            buffer.randomly_edit(&mut rng, 3);
2071            log::info!("text:\n{}", buffer.text());
2072
2073            syntax_map.interpolate(&buffer);
2074            check_interpolation(&prev_syntax_map, &syntax_map, &prev_buffer, &buffer);
2075
2076            syntax_map.reparse(language.clone(), &buffer);
2077
2078            reference_syntax_map.clear();
2079            reference_syntax_map.reparse(language.clone(), &buffer);
2080        }
2081
2082        for i in 0..operations {
2083            let i = operations - i - 1;
2084            buffer.undo();
2085            log::info!("undoing operation {}", i);
2086            log::info!("text:\n{}", buffer.text());
2087
2088            syntax_map.interpolate(&buffer);
2089            syntax_map.reparse(language.clone(), &buffer);
2090
2091            reference_syntax_map.clear();
2092            reference_syntax_map.reparse(language.clone(), &buffer);
2093            assert_eq!(
2094                syntax_map.layers(&buffer).len(),
2095                reference_syntax_map.layers(&buffer).len(),
2096                "wrong number of layers after undoing edit {i}"
2097            );
2098        }
2099
2100        let layers = syntax_map.layers(&buffer);
2101        let reference_layers = reference_syntax_map.layers(&buffer);
2102        for (edited_layer, reference_layer) in layers.into_iter().zip(reference_layers.into_iter())
2103        {
2104            assert_eq!(edited_layer.node.to_sexp(), reference_layer.node.to_sexp());
2105            assert_eq!(edited_layer.node.range(), reference_layer.node.range());
2106        }
2107    }
2108
2109    fn check_interpolation(
2110        old_syntax_map: &SyntaxSnapshot,
2111        new_syntax_map: &SyntaxSnapshot,
2112        old_buffer: &BufferSnapshot,
2113        new_buffer: &BufferSnapshot,
2114    ) {
2115        let edits = new_buffer
2116            .edits_since::<usize>(&old_buffer.version())
2117            .collect::<Vec<_>>();
2118
2119        for (old_layer, new_layer) in old_syntax_map
2120            .layers
2121            .iter()
2122            .zip(new_syntax_map.layers.iter())
2123        {
2124            assert_eq!(old_layer.range, new_layer.range);
2125            let old_start_byte = old_layer.range.start.to_offset(old_buffer);
2126            let new_start_byte = new_layer.range.start.to_offset(new_buffer);
2127            let old_start_point = old_layer.range.start.to_point(old_buffer).to_ts_point();
2128            let new_start_point = new_layer.range.start.to_point(new_buffer).to_ts_point();
2129            let old_node = old_layer
2130                .tree
2131                .root_node_with_offset(old_start_byte, old_start_point);
2132            let new_node = new_layer
2133                .tree
2134                .root_node_with_offset(new_start_byte, new_start_point);
2135            check_node_edits(
2136                old_layer.depth,
2137                &old_layer.range,
2138                old_node,
2139                new_node,
2140                old_buffer,
2141                new_buffer,
2142                &edits,
2143            );
2144        }
2145
2146        fn check_node_edits(
2147            depth: usize,
2148            range: &Range<Anchor>,
2149            old_node: Node,
2150            new_node: Node,
2151            old_buffer: &BufferSnapshot,
2152            new_buffer: &BufferSnapshot,
2153            edits: &[text::Edit<usize>],
2154        ) {
2155            assert_eq!(old_node.kind(), new_node.kind());
2156
2157            let old_range = old_node.byte_range();
2158            let new_range = new_node.byte_range();
2159
2160            let is_edited = edits
2161                .iter()
2162                .any(|edit| edit.new.start < new_range.end && edit.new.end > new_range.start);
2163            if is_edited {
2164                assert!(
2165                    new_node.has_changes(),
2166                    concat!(
2167                        "failed to mark node as edited.\n",
2168                        "layer depth: {}, old layer range: {:?}, new layer range: {:?},\n",
2169                        "node kind: {}, old node range: {:?}, new node range: {:?}",
2170                    ),
2171                    depth,
2172                    range.to_offset(old_buffer),
2173                    range.to_offset(new_buffer),
2174                    new_node.kind(),
2175                    old_range,
2176                    new_range,
2177                );
2178            }
2179
2180            if !new_node.has_changes() {
2181                assert_eq!(
2182                    old_buffer
2183                        .text_for_range(old_range.clone())
2184                        .collect::<String>(),
2185                    new_buffer
2186                        .text_for_range(new_range.clone())
2187                        .collect::<String>(),
2188                    concat!(
2189                        "mismatched text for node\n",
2190                        "layer depth: {}, old layer range: {:?}, new layer range: {:?},\n",
2191                        "node kind: {}, old node range:{:?}, new node range:{:?}",
2192                    ),
2193                    depth,
2194                    range.to_offset(old_buffer),
2195                    range.to_offset(new_buffer),
2196                    new_node.kind(),
2197                    old_range,
2198                    new_range,
2199                );
2200            }
2201
2202            for i in 0..new_node.child_count() {
2203                check_node_edits(
2204                    depth,
2205                    range,
2206                    old_node.child(i).unwrap(),
2207                    new_node.child(i).unwrap(),
2208                    old_buffer,
2209                    new_buffer,
2210                    edits,
2211                )
2212            }
2213        }
2214    }
2215
2216    fn test_edit_sequence(language_name: &str, steps: &[&str]) -> (Buffer, SyntaxMap) {
2217        let registry = Arc::new(LanguageRegistry::test());
2218        registry.add(Arc::new(rust_lang()));
2219        registry.add(Arc::new(ruby_lang()));
2220        registry.add(Arc::new(html_lang()));
2221        registry.add(Arc::new(erb_lang()));
2222        let language = registry.get_language(language_name).unwrap();
2223        let mut buffer = Buffer::new(0, 0, Default::default());
2224
2225        let mut mutated_syntax_map = SyntaxMap::new();
2226        mutated_syntax_map.set_language_registry(registry.clone());
2227        mutated_syntax_map.reparse(language.clone(), &buffer);
2228
2229        for (i, marked_string) in steps.into_iter().enumerate() {
2230            edit_buffer(&mut buffer, &marked_string.unindent());
2231
2232            // Reparse the syntax map
2233            mutated_syntax_map.interpolate(&buffer);
2234            mutated_syntax_map.reparse(language.clone(), &buffer);
2235
2236            // Create a second syntax map from scratch
2237            let mut reference_syntax_map = SyntaxMap::new();
2238            reference_syntax_map.set_language_registry(registry.clone());
2239            reference_syntax_map.reparse(language.clone(), &buffer);
2240
2241            // Compare the mutated syntax map to the new syntax map
2242            let mutated_layers = mutated_syntax_map.layers(&buffer);
2243            let reference_layers = reference_syntax_map.layers(&buffer);
2244            assert_eq!(
2245                mutated_layers.len(),
2246                reference_layers.len(),
2247                "wrong number of layers at step {i}"
2248            );
2249            for (edited_layer, reference_layer) in
2250                mutated_layers.into_iter().zip(reference_layers.into_iter())
2251            {
2252                assert_eq!(
2253                    edited_layer.node.to_sexp(),
2254                    reference_layer.node.to_sexp(),
2255                    "different layer at step {i}"
2256                );
2257                assert_eq!(
2258                    edited_layer.node.range(),
2259                    reference_layer.node.range(),
2260                    "different layer at step {i}"
2261                );
2262            }
2263        }
2264
2265        (buffer, mutated_syntax_map)
2266    }
2267
2268    fn html_lang() -> Language {
2269        Language::new(
2270            LanguageConfig {
2271                name: "HTML".into(),
2272                path_suffixes: vec!["html".to_string()],
2273                ..Default::default()
2274            },
2275            Some(tree_sitter_html::language()),
2276        )
2277        .with_highlights_query(
2278            r#"
2279                (tag_name) @tag
2280                (erroneous_end_tag_name) @tag
2281                (attribute_name) @property
2282            "#,
2283        )
2284        .unwrap()
2285    }
2286
2287    fn ruby_lang() -> Language {
2288        Language::new(
2289            LanguageConfig {
2290                name: "Ruby".into(),
2291                path_suffixes: vec!["rb".to_string()],
2292                ..Default::default()
2293            },
2294            Some(tree_sitter_ruby::language()),
2295        )
2296        .with_highlights_query(
2297            r#"
2298                ["if" "do" "else" "end"] @keyword
2299                (instance_variable) @ivar
2300            "#,
2301        )
2302        .unwrap()
2303    }
2304
2305    fn erb_lang() -> Language {
2306        Language::new(
2307            LanguageConfig {
2308                name: "ERB".into(),
2309                path_suffixes: vec!["erb".to_string()],
2310                ..Default::default()
2311            },
2312            Some(tree_sitter_embedded_template::language()),
2313        )
2314        .with_highlights_query(
2315            r#"
2316                ["<%" "%>"] @keyword
2317            "#,
2318        )
2319        .unwrap()
2320        .with_injection_query(
2321            r#"
2322                ((code) @content
2323                 (#set! "language" "ruby")
2324                 (#set! "combined"))
2325
2326                 ((content) @content
2327                 (#set! "language" "html")
2328                 (#set! "combined"))
2329            "#,
2330        )
2331        .unwrap()
2332    }
2333
2334    fn rust_lang() -> Language {
2335        Language::new(
2336            LanguageConfig {
2337                name: "Rust".into(),
2338                path_suffixes: vec!["rs".to_string()],
2339                ..Default::default()
2340            },
2341            Some(tree_sitter_rust::language()),
2342        )
2343        .with_highlights_query(
2344            r#"
2345                (field_identifier) @field
2346                (struct_expression) @struct
2347            "#,
2348        )
2349        .unwrap()
2350        .with_injection_query(
2351            r#"
2352                (macro_invocation
2353                    (token_tree) @content
2354                    (#set! "language" "rust"))
2355            "#,
2356        )
2357        .unwrap()
2358    }
2359
2360    fn range_for_text(buffer: &Buffer, text: &str) -> Range<usize> {
2361        let start = buffer.as_rope().to_string().find(text).unwrap();
2362        start..start + text.len()
2363    }
2364
2365    fn assert_layers_for_range(
2366        syntax_map: &SyntaxMap,
2367        buffer: &BufferSnapshot,
2368        range: Range<Point>,
2369        expected_layers: &[&str],
2370    ) {
2371        let layers = syntax_map
2372            .layers_for_range(range, &buffer)
2373            .collect::<Vec<_>>();
2374        assert_eq!(
2375            layers.len(),
2376            expected_layers.len(),
2377            "wrong number of layers"
2378        );
2379        for (i, (SyntaxLayerInfo { node, .. }, expected_s_exp)) in
2380            layers.iter().zip(expected_layers.iter()).enumerate()
2381        {
2382            let actual_s_exp = node.to_sexp();
2383            assert!(
2384                string_contains_sequence(
2385                    &actual_s_exp,
2386                    &expected_s_exp.split("...").collect::<Vec<_>>()
2387                ),
2388                "layer {i}:\n\nexpected: {expected_s_exp}\nactual:   {actual_s_exp}",
2389            );
2390        }
2391    }
2392
2393    fn assert_capture_ranges(
2394        syntax_map: &SyntaxMap,
2395        buffer: &BufferSnapshot,
2396        highlight_query_capture_names: &[&str],
2397        marked_string: &str,
2398    ) {
2399        let mut actual_ranges = Vec::<Range<usize>>::new();
2400        let captures = syntax_map.captures(0..buffer.len(), buffer, |grammar| {
2401            grammar.highlights_query.as_ref()
2402        });
2403        let queries = captures
2404            .grammars()
2405            .iter()
2406            .map(|grammar| grammar.highlights_query.as_ref().unwrap())
2407            .collect::<Vec<_>>();
2408        for capture in captures {
2409            let name = &queries[capture.grammar_index].capture_names()[capture.index as usize];
2410            if highlight_query_capture_names.contains(&name.as_str()) {
2411                actual_ranges.push(capture.node.byte_range());
2412            }
2413        }
2414
2415        let (text, expected_ranges) = marked_text_ranges(&marked_string.unindent(), false);
2416        assert_eq!(text, buffer.text());
2417        assert_eq!(actual_ranges, expected_ranges);
2418    }
2419
2420    fn edit_buffer(buffer: &mut Buffer, marked_string: &str) {
2421        let old_text = buffer.text();
2422        let (new_text, mut ranges) = marked_text_ranges(marked_string, false);
2423        if ranges.is_empty() {
2424            ranges.push(0..new_text.len());
2425        }
2426
2427        assert_eq!(
2428            old_text[..ranges[0].start],
2429            new_text[..ranges[0].start],
2430            "invalid edit"
2431        );
2432
2433        let mut delta = 0;
2434        let mut edits = Vec::new();
2435        let mut ranges = ranges.into_iter().peekable();
2436
2437        while let Some(inserted_range) = ranges.next() {
2438            let new_start = inserted_range.start;
2439            let old_start = (new_start as isize - delta) as usize;
2440
2441            let following_text = if let Some(next_range) = ranges.peek() {
2442                &new_text[inserted_range.end..next_range.start]
2443            } else {
2444                &new_text[inserted_range.end..]
2445            };
2446
2447            let inserted_len = inserted_range.len();
2448            let deleted_len = old_text[old_start..]
2449                .find(following_text)
2450                .expect("invalid edit");
2451
2452            let old_range = old_start..old_start + deleted_len;
2453            edits.push((old_range, new_text[inserted_range].to_string()));
2454            delta += inserted_len as isize - deleted_len as isize;
2455        }
2456
2457        assert_eq!(
2458            old_text.len() as isize + delta,
2459            new_text.len() as isize,
2460            "invalid edit"
2461        );
2462
2463        buffer.edit(edits);
2464    }
2465
2466    pub fn string_contains_sequence(text: &str, parts: &[&str]) -> bool {
2467        let mut last_part_end = 0;
2468        for part in parts {
2469            if let Some(start_ix) = text[last_part_end..].find(part) {
2470                last_part_end = start_ix + part.len();
2471            } else {
2472                return false;
2473            }
2474        }
2475        true
2476    }
2477}