mirror of
https://github.com/RGBCube/cstree
synced 2025-07-29 10:07:44 +00:00
RGBCube
fb8cc54104
* Implement traits for Arc<MultiThreadedTokenInterner> * implement Resolver for Arc<Resolver>, update docs
73 lines
4.7 KiB
Markdown
73 lines
4.7 KiB
Markdown
# Changelog
|
|
|
|
## Unreleased
|
|
|
|
* `&I` and `&mut I` will now implement `Resolver` if `I` implements `Resolver`.
|
|
* `&mut I` will now implement `Interner` if `I` implements `Interner`.
|
|
* Added an implementation for `Arc<MultiThreadedTokenInterner>` to implement `Resolver` and `Interner` so an `Arc` may be used alternatively to a reference to share access to the interner.
|
|
|
|
## `v0.12.2`
|
|
|
|
* `Checkpoint`s for the `GreenNodeBuilder` can now be used across node boundaries, meaning you can use them to wrap (finished) nodes in addition to just tokens.
|
|
* A new method `Checkpoint::revert_to` has been added which resets a `GreenNodeBuilder` to the state it was in when the checkpoint was taken, allowing a parser to backtrack to the checkpoint.
|
|
|
|
## `v0.12.1`
|
|
|
|
* Implement `Hash` and `Eq` for `ResolvedNode` and `ResolvedToken`
|
|
|
|
## `v0.12.0`
|
|
|
|
* Documentation has been improved in most areas, together with a switch to a more principled module structure that allows explicitly documenting submodules.
|
|
* The `Language` trait has been deprecated in favour of a new `Syntax` trait. `Syntax` provides the same methods that `Language` did before, but is implemented directly on the syntax kind enum instead of an additional type representing the language.
|
|
* The supertrait requirements on `PartialOrd`, `Ord`, and `Hash` have been dropped.
|
|
* This allows us to optionally provide a derive macro for `Syntax`. To enable the macro, add the `derive` feature flag in your `Cargo.toml` and `#[derive(Syntax)]` away!
|
|
* The `interning` module has been rewritten. It now provides fuctions for obtaining a default interner (`new_interner` and `new_threaded_interner`) and provides a small, dependency-free interner implementation.
|
|
* Compatibility with other interners can be enable via feature flags.
|
|
* **Note** that compatibilty with `lasso` is not enabled by default. Use the `lasso_compat` feature to match the previous default.
|
|
* If you are using `lasso` interners directly that you are also passing to `cstree`, note that while e.g. the `GreenNodeBuilder` can work with `lasso::Rodeo`s, you will not be able to convert between `lasso`'s `Spur` and `cstree`'s `TokenKey`. The `TokenKey` can, however, be used as the key type for `lasso` interners at no additional cost by working wiht a `Rodeo<TokenKey>` instead of the `lasso`-default `Rodeo<Spur>`.
|
|
* Introduced `Syntax::static_text` to optimize tokens that always appear with the same text (estimated 10-15% faster tree building when used, depending on the ratio of static to dynamic tokens).
|
|
* Since `cstree`s are lossless, `GreenNodeBuilder::token` must still be passed the source text even for static tokens.
|
|
* Internal performance improvements for up to 10% faster tree building by avoiding unnecessary duplication of elements.
|
|
* Use `NonNull` for the internal representation of `SyntaxNode`, meaning it now benefits from niche optimizations (`Option<SyntaxNode>` is now the same size as `SyntaxNode` itself: the size of a pointer).
|
|
* `SyntaxKind` has been renamed to `RawSyntaxKind` to no longer conflict with user-defined `SyntaxKind` enumerations.
|
|
* `RawSyntaxKind` has been changed to use a 32-bit index internally, which means existing `Language` implementations and syntax kind `enum`s need to be adjusted to `#[repr(u32)]` and the corresponding conversions.
|
|
* The crate's export module structure has been reorganized to give different groups of definitions their own submodules. A `cstree::prelude` module is available, containing the most commonly needed types that were previously accessible via `use cstree::*`. Otherwise, the module structure is now as follows:
|
|
* `cstree`
|
|
* `Syntax`
|
|
* `RawSyntaxKind`
|
|
* `build`
|
|
* `GreenNodeBuilder`
|
|
* `NodeCache`
|
|
* `Checkpoint`
|
|
* `green`
|
|
* `GreenNode`
|
|
* `GreenToken`
|
|
* `GreenNodeChildren`
|
|
* `syntax`
|
|
* `{Syntax,Resolved}Node`
|
|
* `{Syntax,Resolved}Token`
|
|
* `{Syntax,Resolved}Element`
|
|
* `{Syntax,Resolved}ElementRef`
|
|
* `SyntaxNodeChildren`
|
|
* `SyntaxElementChildren`
|
|
* `SyntaxText`
|
|
* `interning`
|
|
* `TokenKey` and the `InternKey` trait
|
|
* `Interner` and `Resolver` traits
|
|
* `new_interner` and `TokenInterner`
|
|
* `new_threaded_interner` and `MultiThreadedTokenInterner` (with the `multi_threaded_interning` feature enabled)
|
|
* compatibility implementations for interning crates depending on selected feature flags
|
|
* `text`
|
|
* `TextSize`
|
|
* `TextRange`
|
|
* `SyntaxText` (re-export)
|
|
* `traversal`
|
|
* `Direction`
|
|
* `WalkEvent`
|
|
* `util`
|
|
* `NodeOrToken`
|
|
* `TokenAtOffset`
|
|
* `sync`
|
|
* `Arc`
|
|
* `prelude`
|
|
* re-exports of the most-used items
|