Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the CST Visitor API #665

Merged
merged 9 commits into from
Nov 20, 2023
Merged

Conversation

Xanewok
Copy link
Contributor

@Xanewok Xanewok commented Nov 20, 2023

We discussed internally that the Visitor API for (dynamically typed) CST is a lot less useful now that we have the Iterator interface implemented in Rust (and hopefully Iterator protocol in TS in the future), so let's remove the CST Visitor API altogether.

The Visitor pattern will be a lot useful once we have typed, heterogenous data such as the new AST (#634), so let's wait until then with designing and exposing such interface.

...and use the borrowing variant for the NAPI `pathRuleNodes`
function to not double-allocate.

The borrowing variant is more general in the Rust API; not all use cases
want or should rely on previously collecting the path into a Vec of
owned `Rc`s.
In preparation to remove the CST `Visitor` trait altogether.
@Xanewok Xanewok requested a review from a team as a code owner November 20, 2023 14:52
Copy link

changeset-bot bot commented Nov 20, 2023

🦋 Changeset detected

Latest commit: f705de9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@nomicfoundation/slang Minor

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

@@ -60,5 +60,5 @@ Tree:
- PathImport (Rule): # 30..40 ' "foo.sol"'
- AsciiStringLiteral (Token): '"foo.sol"' # 31..40
- Semicolon (Token): ";" # 40..41
- EndOfFileTrivia (Rule): "\n" # 42..43
- EndOfFileTrivia (Rule): # 42..43 "\n"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previously, the TestNodeBuilder would not construct the whitespace children tokens and the printer logic would recognize this as an childless node, whereas the new printer does not, as we only skipped the leading/trailing trivia nodes before.

This should probably be fixed to also not include the EndOfFileTrivia much like the Leading/Trailing variants, however this is not as important as we will change the trivia model soon (DSL v2).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See 47663c9 for the fix

Copy link
Collaborator

@OmarTawfik OmarTawfik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a few suggestions.

crates/codegen/parser/runtime/src/cst.rs Show resolved Hide resolved
crates/codegen/parser/runtime/src/cursor.rs Show resolved Hide resolved
crates/codegen/parser/runtime/src/visitor.rs Show resolved Hide resolved
crates/codegen/parser/runtime/src/cst.rs Show resolved Hide resolved
@Xanewok Xanewok added this pull request to the merge queue Nov 20, 2023
Merged via the queue into NomicFoundation:main with commit 4b5f8b4 Nov 20, 2023
1 check passed
@Xanewok Xanewok deleted the remove-visitor-api branch November 20, 2023 23:02
@github-actions github-actions bot mentioned this pull request Nov 20, 2023
github-merge-queue bot pushed a commit that referenced this pull request Dec 14, 2023
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.12.0

### Minor Changes

- [#699](#699)
[`ddfebfe9`](ddfebfe)
Thanks [@Xanewok](https://github.com/Xanewok)! - Remove `ProductionKind`
in favor of `RuleKind`

- [#699](#699)
[`ddfebfe9`](ddfebfe)
Thanks [@Xanewok](https://github.com/Xanewok)! - Allow parsing
individual precedence expressions, like `ShiftExpression`

- [#665](#665)
[`4b5f8b46`](4b5f8b4)
Thanks [@Xanewok](https://github.com/Xanewok)! - Remove the CST Visitor
API in favor of the Cursor API

- [#666](#666)
[`0434b68c`](0434b68)
Thanks [@Xanewok](https://github.com/Xanewok)! - Add `Node::unparse()`
that allows to reconstruct the source code from the CST node

- [#675](#675)
[`daea4b7f`](daea4b7)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename `Cursor`'s
`pathRuleNodes()` to `ancestors()` in the NodeJS API.

- [#676](#676)
[`b496d361`](b496d36)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Fix NAPI `cursor`
types and expose `cursor.depth`.

### Patch Changes

- [#685](#685)
[`b5fca94a`](b5fca94)
Thanks [@Xanewok](https://github.com/Xanewok)! - `bytes` is now properly
recognized as a reserved word

- [#660](#660)
[`97028991`](9702899)
Thanks [@Xanewok](https://github.com/Xanewok)! - Drop List suffix from
collection grammar rule names

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants