consolidate .children() APIs and iterators
#1156
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: ae456f9 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
.children() APIs into iterators.children() APIs and iterators
9a24218 to
e90c3d4
Compare
ggiraldez
approved these changes
Nov 25, 2024
| .cloned() | ||
| }) | ||
| .map(|identifier| identifier.text.clone()) | ||
| .filter(|node| node.is_terminal_with_kind(TerminalKind::Identifier)) |
There was a problem hiding this comment.
It's weird that node here is actually an Edge, which in turn consists of a label and a node. I think that's the most confusing part of this change in general: the items of both children() and CursorIterator (through descendants()) are now edges instead of nodes. Previously it was explicit with the added .with_edges() call to the cursor. It'll maybe catch users by surprise.
There was a problem hiding this comment.
We only had .nodes() and .edges() because edges came later, but I'm not sure it makes sense to add a specific iterator for it, given that it doesn't cost anything to do both, and they already have a Deref between them..
I updated the variable names to make this clearer. Please let me know if you have any other suggestions.
crates/metaslang/cst/src/cursor.rs
Outdated
| } | ||
| let current = Edge { | ||
| label: self.cursor.label(), | ||
| node: self.cursor.node().clone(), |
There was a problem hiding this comment.
The clone() here is redundant as the cursor's node is already cloned inside node().
| /// Returns an iterator over all descendants of the current node in pre-order traversal. | ||
| descendants: func() -> cursor-iterator; | ||
| /// Returns an iterator over all the remaining nodes in the current tree, moving in pre-order traversal, until the cursor is completed. | ||
| consume: func() -> cursor-iterator; |
There was a problem hiding this comment.
IIUC, the semantics of the generated function are different from the Rust's native function since this implementation will clone before calling to consume. Does it make sense to still call it consume in the WIT interface?
There was a problem hiding this comment.
Good point. To keep things consistent, I renamed it to remainingNodes() and modified the comment.
e90c3d4 to
a2aa67d
Compare
Consolidate redundant `Node` and `Cursor` utilities like `.children()` vs `edges()`, or `Cursor` vs `CursorWithEdges`, and expose them to WASM: - add `node.descendants()` and `cursor.descendants()` APIs to allow iterating over all descendants of the current node in pre-order traversal. - add `cursor.ancestors()` API to allow iterating over all ancestors of the current node, starting with the immediate parent, and moving upwards, ending with the root node. - add `cursor.consume()` API to allow iterating over all the remaining nodes. in the current tree, moving in pre-order traversal, until the cursor is completed. - fix `node.children()` and `parseOutput.errors()` return types.
a2aa67d to
ae456f9
Compare
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 24, 2025
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @nomicfoundation/slang@0.19.0 ### Minor Changes - [#1156](#1156) [`3a82f06`](3a82f06) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add `node.descendants()` and `cursor.descendants()` APIs to allow iterating over all descendants of the current node in pre-order traversal. - [#1156](#1156) [`3a82f06`](3a82f06) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - fix `node.children()` and `parseOutput.errors()` return types - [#1194](#1194) [`7a25d63`](7a25d63) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - split `parser/Parser.supportedVersions()` into a new `utils/LanguageFacts` API, with `allVersions()`, `earliestVersion()`, and `latestVersion()` methods. - [#1194](#1194) [`7a25d63`](7a25d63) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - expose the `BingingGraph` API to allow querying definitions/references between source files. - [#1156](#1156) [`3a82f06`](3a82f06) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add `cursor.ancestors()` API to allow iterating over all ancestors of the current node, starting with the immediate parent, and moving upwards, ending with the root node. - [#1156](#1156) [`3a82f06`](3a82f06) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add `cursor.remainingNodes()` API to allow iterating over all the remaining nodes in the current tree, moving in pre-order traversal, until the tree is completed. - [#1223](#1223) [`3e85a14`](3e85a14) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - split `Parser.parse()` API into `parse_file_contents()` and `parse_nonterminal()`. - [#1194](#1194) [`7a25d63`](7a25d63) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add a `CompilationBuilder` API to incrementally load and resolve source files and their imports. - [#1223](#1223) [`3e85a14`](3e85a14) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename `Query.parse()` to `Query.create()`, and provide exact `TextRange` for any errors it returns. - [#1172](#1172) [`6102886`](6102886) Thanks [@beta-ziliani](https://github.com/beta-ziliani)! - Improved error recovery, where leading trivia are always parsed and included before an erroneous terminal. - [#1223](#1223) [`3e85a14`](3e85a14) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add `TerminalKindExtensions.is_identifier()` API to distinguish terminals like Solidity's `Identifier` and Yul's `YulIdentifier`. ### Patch Changes - [#1134](#1134) [`cfc62f2`](cfc62f2) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - remove `YulPathComponent` and just use `YulIdentifier` instead. - [#1138](#1138) [`44a706f`](44a706f) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add `ThisKeyword` and `SuperKeyword` to the grammar, instead of parsing them as identifiers. - [#1134](#1134) [`cfc62f2`](cfc62f2) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - unreserve `AddressKeyword`, and let it be used for `MemberAccessExpression`, `StructMember`, etc... - [#1154](#1154) [`7b9b478`](7b9b478) Thanks [@beta-ziliani](https://github.com/beta-ziliani)! - Adding support for deprecated keywords `jump` and `jumpi` Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Consolidate redundant
NodeandCursorutilities like.children()vsedges(), orCursorvsCursorWithEdges, and expose them to WASM:node.descendants()andcursor.descendants()APIs to allow iterating over all descendants of the current node in pre-order traversal.cursor.ancestors()API to allow iterating over all ancestors of the current node, starting with the immediate parent, and moving upwards, ending with the root node.cursor.remainingNodes()API to allow iterating over all the remaining nodes. in the current tree, moving in pre-order traversal, until the tree is completed.node.children()andparseOutput.errors()return types.