v0.10.0

Author: biojppm

CMakeLists.txt

@@ -6,7 +6,7 @@ project(ryml
     LANGUAGES CXX)
 include(./compat.cmake)
 
-c4_project(VERSION 0.9.0 STANDALONE
+c4_project(VERSION 0.10.0 STANDALONE
     AUTHOR "Joao Paulo Magalhaes <dev@jpmag.me>")
 
 

changelog/0.10.0.md

@@ -0,0 +1,35 @@
+### Extra event handlers
+
+[PR#536](https://github.com/biojppm/rapidyaml/pull/536) adds a new major extra feature: a parser event handler that creates a compact representation of the YAML tree in a buffer of integers containing masks (to represent events) and offset+length (to represent strings in the source buffer).
+
+This handler is meant for use by other programming languages, and it supports container keys (unlike the ryml tree). You can find this handler among the other headers in the [new `src_extra` folder](https://github.com/biojppm/rapidyaml/tree/master/src_extra).
+
+
+### Changes
+
+- In [PR#536](https://github.com/biojppm/rapidyaml/pull/536) the location functions were moved from `ParserEngine` to `Tree` and `ConstNodeRef`. The parser engine is now fully agnostic vis-a-vis the type of the event-handler. (The location functions in the parser engine were a legacy of the initial implementation of the parser which was meant to create only ryml trees).
+- The tool ryml-yaml-events was updated to also dump integer events (and its command line options were changed to enable the different choices).
+
+
+### Fixes
+
+- Fix [#524](https://github.com/biojppm/rapidyaml/issues/524) ([PR#525](https://github.com/biojppm/rapidyaml/pull/525)): problem parsing nested map value in complex map. Kudos to @MatthewSteel!
+- [PR#542](https://github.com/biojppm/rapidyaml/pull/542): `\x` Unicode sequences were not decoded. Thanks to @mutativesystems!
+- [PR#541](https://github.com/biojppm/rapidyaml/pull/541): `std::is_trivial` deprecated in c++26. Thanks to @P3RK4N!
+- Fix [#529](https://github.com/biojppm/rapidyaml/issues/529) ([PR#530](https://github.com/biojppm/rapidyaml/pull/530)): double-quoted `"<<"` was mistaken for an inheriting reference.
+- [PR#543](https://github.com/biojppm/rapidyaml/pull/543): improvements to experimental style API:
+  - Add getters to `NodeType`, `Tree`, `NodeRef`, and `ConstNodeRef`:
+    - `.key_style()`: get the style flags in a node's key
+    - `.val_style()`: get the style flags in a node's val
+    - `.container_style()`: get the style flags in a node's container
+  - Add style modifiers to `NodeType`, `Tree`, `NodeRef`, and `ConstNodeRef`:
+    - `.clear_style(bool recurse)`
+    - `.set_style_conditionally(bool recurse)`
+- Fix argument handling in ryml-parse-emit.
+
+
+### Thanks
+
+- @MatthewSteel
+- @mutativesystems
+- @P3RK4N

changelog/current.md

@@ -1,35 +0,0 @@
-### Extra event handlers
-
-[PR#536](https://github.com/biojppm/rapidyaml/pull/536) adds a new major extra feature: a parser event handler that creates a compact representation of the YAML tree in a buffer of integers containing masks (to represent events) and offset+length (to represent strings in the source buffer).
-
-This handler is meant for use by other programming languages, and it supports container keys (unlike the ryml tree). You can find this handler among the other headers in the [new `src_extra` folder](https://github.com/biojppm/rapidyaml/tree/master/src_extra).
-
-
-### Changes
-
-- In [PR#536](https://github.com/biojppm/rapidyaml/pull/536) the location functions were moved from `ParserEngine` to `Tree` and `ConstNodeRef`. The parser engine is now fully agnostic vis-a-vis the type of the event-handler. (The location functions in the parser engine were a legacy of the initial implementation of the parser which was meant to create only ryml trees).
-- The tool ryml-yaml-events was updated to also dump integer events (and its command line options were changed to enable the different choices).
-
-
-### Fixes
-
-- Fix [#524](https://github.com/biojppm/rapidyaml/issues/524) ([PR#525](https://github.com/biojppm/rapidyaml/pull/525)): problem parsing nested map value in complex map. Kudos to @MatthewSteel!
-- [PR#542](https://github.com/biojppm/rapidyaml/pull/542): `\x` Unicode sequences were not decoded. Thanks to @mutativesystems!
-- [PR#541](https://github.com/biojppm/rapidyaml/pull/541): `std::is_trivial` deprecated in c++26. Thanks to @P3RK4N!
-- Fix [#529](https://github.com/biojppm/rapidyaml/issues/529) ([PR#530](https://github.com/biojppm/rapidyaml/pull/530)): double-quoted `"<<"` was mistaken for an inheriting reference.
-- [PR#543](https://github.com/biojppm/rapidyaml/pull/543): improvements to experimental style API:
-  - Add getters to `NodeType`, `Tree`, `NodeRef`, and `ConstNodeRef`:
-    - `.key_style()`: get the style flags in a node's key
-    - `.val_style()`: get the style flags in a node's val
-    - `.container_style()`: get the style flags in a node's container
-  - Add style modifiers to `NodeType`, `Tree`, `NodeRef`, and `ConstNodeRef`:
-    - `.clear_style(bool recurse)`
-    - `.set_style_conditionally(bool recurse)`
-- Fix argument handling in ryml-parse-emit.
-
-
-### Thanks
-
-- @MatthewSteel
-- @mutativesystems
-- @P3RK4N

doc/Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = rapidyaml
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.9.0
+PROJECT_NUMBER         = 0.10.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

doc/conf.py

@@ -10,7 +10,7 @@
 project = 'rapidyaml'
 copyright = '2018-2024 Joao Paulo Magalhaes <dev@jpmag.me>'
 author = 'Joao Paulo Magalhaes <dev@jpmag.me>'
-release = '0.9.0'
+release = '0.10.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

doc/doxy_main.md

@@ -1,6 +1,6 @@
 # rapidyaml
 
-* Begin by looking at the [project's README](https://github.com/biojppm/rapidyaml/blob/v0.9.0/README.md)
+* Begin by looking at the [project's README](https://github.com/biojppm/rapidyaml/blob/v0.10.0/README.md)
 * [Documentation page](https://rapidyaml.readthedocs.org)
 * Next, skim the docs for the @ref doc_quickstart sample.
 * Good! Now the main ryml topics:

doc/index.rst

@@ -72,7 +72,7 @@ API teaser
 Here's a short teaser from the API quickstart overview (`see on
 doxygen <doxygen/group__doc__quickstart.html>`_ / `see full code on
 github
-<https://github.com/biojppm/rapidyaml/blob/v0.9.0/samples/quickstart.cpp>`_):
+<https://github.com/biojppm/rapidyaml/blob/v0.10.0/samples/quickstart.cpp>`_):
 
 .. code-block:: c++
 

doc/sphinx_is_it_rapid.rst

@@ -25,11 +25,11 @@ faster.
    nicely as claimed here, we would definitely like to see it! Please
    open an issue, or submit a pull request adding the file to
    `bm/cases
-   <https://github.com/biojppm/rapidyaml/blob/v0.9.0/bm/cases>`__, or
+   <https://github.com/biojppm/rapidyaml/blob/v0.10.0/bm/cases>`__, or
    just send us the files.
 
 `Here’s a parsing benchmark
-<https://github.com/biojppm/rapidyaml/blob/v0.9.0/bm/bm_parse.cpp>`__. Using
+<https://github.com/biojppm/rapidyaml/blob/v0.10.0/bm/bm_parse.cpp>`__. Using
 different approaches within ryml (in-situ/read-only vs. with/without
 reuse), a YAML / JSON buffer is repeatedly parsed, and compared
 against other libraries.
@@ -40,7 +40,7 @@ Comparison with yaml-cpp
 
 The first result set is for Windows, and is using a `appveyor.yml
 config file
-<https://github.com/biojppm/rapidyaml/blob/v0.9.0/bm/cases/appveyor.yml>`__. A
+<https://github.com/biojppm/rapidyaml/blob/v0.10.0/bm/cases/appveyor.yml>`__. A
 comparison of these results is summarized on the table below:
 
 =========================== ===== ======= ==========
@@ -52,11 +52,11 @@ appveyor / vs2017 / Debug   6.4   0.0844  76x / 1.3%
 
 The next set of results is taken in Linux, comparing g++ 8.2 and
 clang++ 7.0.1 in parsing a YAML buffer from a `travis.yml config file
-<https://github.com/biojppm/rapidyaml/blob/v0.9.0/bm/cases/travis.yml>`__
+<https://github.com/biojppm/rapidyaml/blob/v0.10.0/bm/cases/travis.yml>`__
 or a JSON buffer from a `compile_commands.json file
-<https://github.com/biojppm/rapidyaml/blob/v0.9.0/bm/cases/compile_commands.json>`__. You
+<https://github.com/biojppm/rapidyaml/blob/v0.10.0/bm/cases/compile_commands.json>`__. You
 can `see the full results here
-<https://github.com/biojppm/rapidyaml/blob/v0.9.0/bm/results/parse.linux.i7_6800K.md>`__. Summarizing:
+<https://github.com/biojppm/rapidyaml/blob/v0.10.0/bm/results/parse.linux.i7_6800K.md>`__. Summarizing:
 
 ========================== ===== ======= ========
 Read rates (MB/s)          ryml  yamlcpp compared
@@ -89,9 +89,9 @@ So how does ryml compare against other JSON readers? Well, it may not
 be the fastest, but it's definitely ahead of the pack!
 
 The benchmark is the `same as above
-<https://github.com/biojppm/rapidyaml/blob/v0.9.0/bm/bm_parse.cpp>`__,
+<https://github.com/biojppm/rapidyaml/blob/v0.10.0/bm/bm_parse.cpp>`__,
 and it is reading the `compile_commands.json
-<https://github.com/biojppm/rapidyaml/blob/v0.9.0/bm/cases/compile_commands.json>`__,
+<https://github.com/biojppm/rapidyaml/blob/v0.10.0/bm/cases/compile_commands.json>`__,
 The ``_arena`` suffix notes parsing a read-only buffer (so buffer
 copies are performed), while the ``_inplace`` suffix means that the
 source buffer can be parsed in place. The ``_reuse`` means the data
@@ -131,7 +131,7 @@ Performance emitting
 --------------------
 
 `Emitting benchmarks
-<https://github.com/biojppm/rapidyaml/blob/v0.9.0/bm/bm_emit.cpp>`__
+<https://github.com/biojppm/rapidyaml/blob/v0.10.0/bm/bm_emit.cpp>`__
 also show similar speedups from the existing libraries, also
 anecdotally reported by some users `(eg, here’s a user reporting 25x
 speedup from yaml-cpp)

doc/sphinx_other_languages.rst

@@ -70,11 +70,11 @@ are string views into the source buffer, and not typed. With that
 said, it is really fast, and once you have the tree, you can still walk
 over the tree to create the native python structure. Have a look at
 this `test file
-<https://github.com/biojppm/rapidyaml/tree/v0.9.0/api/python/tests/test_readme.py>`__
+<https://github.com/biojppm/rapidyaml/tree/v0.10.0/api/python/tests/test_readme.py>`__
 to see how the python API works, and to judge whether it may be useful to your
 case.
 
-As for performance, in a `timeit benchmark <https://github.com/biojppm/rapidyaml/tree/v0.9.0/api/python/bm/parse_bm.py>`__ comparing against
+As for performance, in a `timeit benchmark <https://github.com/biojppm/rapidyaml/tree/v0.10.0/api/python/bm/parse_bm.py>`__ comparing against
 `PyYaml <https://pyyaml.org/>`__ and
 `ruamel.yaml <https://yaml.readthedocs.io/en/latest/>`__, ryml parses
 quicker by generally 100x and up to 400x:

doc/sphinx_quicklinks.rst

@@ -15,11 +15,11 @@ Quick links
 
   * `Kanban board <https://github.com/users/biojppm/projects/1/views/1>`_
 
-* Latest release: `0.9.0 <https://github.com/biojppm/rapidyaml/releases/tag/v0.9.0>`_
+* Latest release: `0.10.0 <https://github.com/biojppm/rapidyaml/releases/tag/v0.10.0>`_
 
-  * `Release page [0.9.0] <https://github.com/biojppm/rapidyaml/releases/tag/v0.9.0>`_
+  * `Release page [0.10.0] <https://github.com/biojppm/rapidyaml/releases/tag/v0.10.0>`_
 
-  * `README [0.9.0] <https://github.com/biojppm/rapidyaml/blob/v0.9.0/README.md>`_
+  * `README [0.10.0] <https://github.com/biojppm/rapidyaml/blob/v0.10.0/README.md>`_
 
 * Since latest release (master branch):