mirror of
https://github.com/helix-editor/tree-house.git
synced 2025-10-06 00:12:46 +02:00
c9fa54f2eb
This fixes a bug where a layer could be removed from `QueryIter`'s
`active_layers` because it had no more captures and then reinitialized
later, restarting the query cursor and producing duplicate captures.
The new test case exhibits this behavior. Consider this markdown.
```rust
/// `Something`
/// Anything
```
This consists of four layers:
* The root layer, the entire markdown document
* The Rust injection in the codefence
* Two markdown injections within the Rust doc comments. These injections
are tagged with `injection.combined` so they form one markdown layer.
* Two markdown.inline injections within those markdown injections. Again
these injections are combined so they form one layer.
Layers are removed from `QueryIter` when they have no more captures. In
this example code the "`Something`" was the only capture in the two
injections of the markdown.inline layer, so after the first injection
was finished, the layer would be removed. Once the `QueryIter` reached
the "Anything" region, though, it would create a new `ActiveLayer` for
the markdown.inline layer and recreate its query cursor. Then the query
cursor would emit the same highlights as it did previously for
"`Something`".
This breaks an invariant that the `Highlighter::next_event_offset` must
be monotonically increasing. The added test case failed with:
thread 'tests::codefence_rust_doc_comments' panicked at /.../ropey-1.6.1/src/slice.rs:703:23:
byte_slice(): Invalid byte range 27..12: start must be <= end
Also see helix-editor/helix#13569.
The solution is to "tombstone" any layers which are finished in a new
`HashSet<Layer>` and avoid recreating query cursors for any finished
layers. Outside of this bug, this also prevents us from needlessly
creating query cursors which we know will yield nothing. Query cursors
are reused in a thread-local cache, so by not creating a query cursor we
allow another caller to use the cached cursor.
tree-house
This repository contains a number of crates used by the Helix editor for integration with the tree-sitter C library.
bindings/contains thetree-house-bindingscrate which provides Rust bindings over the C library.highlighter/contains thetree-housecrate which exposes a robust highlighter and query iterator for working across [injections].skidder/contains theskiddercrate which exposes utilities for building a package repository for tree-sitter grammars.cli/contains theskidder-clicrate which wrapsskidderin a command line interface.