prism 2.0.0.rc2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e07eb7cf91add89de3aa71e9707336a2a561c977b98f5a71ab31c9f0083623e4
-  data.tar.gz: 684ec87f807ac1e17a3b251746745751707cf300b4d2f6429cdc852102261204
+  metadata.gz: 4d4d17cd8ed8987149af4087c871958987c7a842377950efa042958a05101e53
+  data.tar.gz: 96b76a2642bb6743ff23d060304901cf4ece8b68a1d5ed9c43d04694fec7106d
 SHA512:
-  metadata.gz: 86a9128a3c56bffa1b9c6684f83e2e320fc58113f0a778ff1139d1393573ed5c42db80d7b9665b558aef9af9fbe72d84d929c997ce2ebdbfe07eafaa00864a86
-  data.tar.gz: 02c7498a1119b1106aa3a75bd07ca4d2aca13ba133e8c716693bbb33cca1d3e6004ccc6811155a4adff65a6758088066e817d7084727b80f7b6437cc280b6040
+  metadata.gz: 3ed8f2568284d69d6ed643e4f861e0479858e818e2cbe7c4ba7e95dc879bf31033c764bd440988d9a08ec6212147c01290089e3fc11c9a30b633568c590203e9
+  data.tar.gz: 64ede09015b98f79710fb93664575e34e43965f0a36301fba58196e23ebd24897b7673ab62b9300d9aae6f9809e37ea13c7faa48ab69a1bb3aa0298ec92273b2

data/CHANGELOG.md

@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [2.0.0] - 2026-10-21
+
 ### Highlights
 
 - Significant performance and memory usage improvements.
@@ -13,6 +15,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - Many documentation improvements, including a new playground.
 - Prism now ships accurate and complete RBS and RBI definitions.
 - The license is now owned by the Ruby developers.
+- Prism now ships an official C++ interface.
 
 ### Added
 
@@ -67,6 +70,9 @@ Note that for this major version, almost every change listed below is breaking.
 - Most allocations are now performed through an arena.
 - You may now build side tables of comment attachments through the `attach_comments` option.
 - `newline_list` was renamed to `list_offset_list`.
+- Visitor callbacks passed to `pm_visit_node` and `pm_visit_child_nodes` now return a `pm_visit_result_t` instead of a `bool`. Returning `PM_VISIT_DESCEND` or `PM_VISIT_SKIP` replaces returning `true` or `false`, and returning `PM_VISIT_STOP` ends the walk. Both functions now return `false` if the walk was stopped.
+- `pm_string_t` is now a view of bytes owned by someone else. It no longer has a `type` field, `pm_string_owned_init` was removed, and `pm_string_constant_init` was renamed to `pm_string_init`, which takes the bytes as `const uint8_t *`.
+- `pm_options_free` no longer frees the names of scope locals. The parser copies them when it is created, so they only need to remain valid until then.
 
 #### Rust
 
@@ -831,8 +837,9 @@ Note that for this major version, almost every change listed below is breaking.
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/ruby/prism/compare/v1.9.0...HEAD
-[1.9.0]: https://github.com/ruby/prism/compare/v1.8.0...v1.9.0
+[unreleased]: https://github.com/ruby/prism/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/ruby/prism/compare/v1.9.0...v2.0.0
+[1.9.0]: https://github.com/ruby/prism/compare/v1.8.1...v1.9.0
 [1.8.1]: https://github.com/ruby/prism/compare/v1.8.0...v1.8.1
 [1.8.0]: https://github.com/ruby/prism/compare/v1.7.0...v1.8.0
 [1.7.0]: https://github.com/ruby/prism/compare/v1.6.0...v1.7.0

data/docs/serialization.md

@@ -125,8 +125,14 @@ The header is structured like the following table:
 | varuint | content pool size |
 
 After the header comes the body of the serialized string.
-The body consists of a sequence of nodes that is built using a prefix traversal order of the syntax tree.
-Each node is structured like the following table:
+The body consists of a sequence of nodes that is built using a postfix traversal order of the syntax tree: the children of each node come before the node itself, so the root node comes last.
+The body ends at the content pool offset specified in the header.
+
+The children of a node are the values of its `node`, `node?`, and `node[]` fields, which are serialized in the order in which the fields are listed in `config.yml`.
+A `node` field is serialized as its node, a `node?` field is serialized as its node or as a single `0` byte if the node is not present, and a `node[]` field is serialized as each of its nodes in order.
+A loader can therefore keep a stack of loaded nodes: a `0` byte pushes an absent node, and each node pops its children off the top of the stack (they are in field order) and then pushes itself.
+
+After its children, each node is structured like the following table:
 
 | # bytes | field |
 | --- | --- |
@@ -135,12 +141,11 @@ Each node is structured like the following table:
 | location | node location |
 | varuint | node flags |
 
-Every field on the node is then appended to the serialized string. The fields can be determined by referencing `config.yml`. Depending on the type of field, it could take a couple of different forms, described below:
+Every other field on the node is then appended to the serialized string. The fields can be determined by referencing `config.yml`. Depending on the type of field, it could take a couple of different forms, described below:
 
 * `double` - A field that is a `double`. This is structured as a sequence of 8 bytes in native endian order.
-* `node` - A field that is a node. This is structured just as like parent node.
-* `node?` - A field that is a node that is optionally present. If the node is not present, then a single `0` byte will be written in its place. If it is present, then it will be structured just as like parent node.
-* `node[]` - A field that is an array of nodes. This is structured as a variable-length integer length, followed by the child nodes themselves.
+* `node`, `node?` - Nothing is appended here, since the node has already been serialized as a child.
+* `node[]` - A field that is an array of nodes. This is structured as a variable-length integer length, which is the number of children that belong to this field.
 * `string` - A field that is a string. For example, this is used as the name of the method in a call node, since it cannot directly reference the source string (as in `@-` or `foo=`). This is structured as a variable-length integer byte length, followed by the string bytes (_without_ a trailing null byte).
 * `constant` - A variable-length integer that represents an index in the constant pool.
 * `constant?` - An optional variable-length integer that represents an index in the constant pool. If it's not present, then a single `0` byte will be written in its place.
@@ -150,6 +155,14 @@ Every field on the node is then appended to the serialized string. The fields ca
 * `uint8` - A field that is an 8-bit unsigned integer. This is structured as a single byte.
 * `uint32` - A field that is a 32-bit unsigned integer. This is structured as a variable-length integer.
 
+The `body` field of a `DefNode` is lazy, which means that loaders can skip it and load it later. The children of a `DefNode` are preceded by the following, which loaders that do not skip lazy fields can ignore:
+
+| # bytes | field |
+| --- | --- |
+| `1` | `255` |
+| `4` | the byte length of the children that come before the `body` child |
+| `4` | the byte length of the `body` child |
+
 After the syntax tree, the content pool is serialized. This is a list of constants that were referenced from within the tree. The content pool begins at the offset specified in the header. Every constant is embedded in the serialization. Each constant is structured as follows:
 
 | # bytes | field |