Forgot to actually return a ParsedList for the HDF5 parsers.

Fixed the JSON docs to indicate that we're returning ParsedLists.

Author: LTLA

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.24)
 
 project(uzuki2
-    VERSION 1.1.2
+    VERSION 1.1.3
     DESCRIPTION "Storing simple R lists inside HDF5 or JSON"
     LANGUAGES CXX)
 

include/uzuki2/parse_hdf5.hpp

@@ -16,6 +16,7 @@
 #include "Dummy.hpp"
 #include "utils.hpp"
 #include "Version.hpp"
+#include "ParsedList.hpp"
 
 /**
  * @file parse_hdf5.hpp
@@ -565,7 +566,7 @@ std::shared_ptr<Base> parse_inner(const H5::Group& handle, Externals& ext, const
  * Only used for error messages.
  * @param ext Instance of an external reference resolver class.
  *
- * @return Pointer to the root `Base` object.
+ * @return A `ParsedList` containing a pointer to the root `Base` object.
  * Depending on `Provisioner`, this may contain references to all nested objects. 
  * 
  * Any invalid representations in `contents` will cause an error to be thrown.
@@ -603,7 +604,7 @@ std::shared_ptr<Base> parse_inner(const H5::Group& handle, Externals& ext, const
  * - `size_t size()`, which returns the number of available external references.
  */
 template<class Provisioner, class Externals>
-std::shared_ptr<Base> parse(const H5::Group& handle, const std::string& name, Externals ext) {
+ParsedList parse(const H5::Group& handle, const std::string& name, Externals ext) {
     Version version;
     if (handle.attrExists("uzuki_version")) {
         auto ver_str = load_string_attribute(handle.openAttribute("uzuki_version"), "uzuki_version", name);
@@ -613,7 +614,7 @@ std::shared_ptr<Base> parse(const H5::Group& handle, const std::string& name, Ex
     ExternalTracker etrack(std::move(ext));
     auto ptr = parse_inner<Provisioner>(handle, etrack, name, version);
     etrack.validate();
-    return ptr;
+    return ParsedList(std::move(ptr), std::move(version));
 }
 
 /**
@@ -626,13 +627,13 @@ std::shared_ptr<Base> parse(const H5::Group& handle, const std::string& name, Ex
  * @param name Name of the HDF5 group corresponding to `handle`. 
  * Only used for error messages.
  *
- * @return Pointer to the root `Base` object.
+ * @return A `ParsedList` containing a pointer to the root `Base` object.
  * Depending on `Provisioner`, this may contain references to all nested objects. 
  * 
  * Any invalid representations in `contents` will cause an error to be thrown.
  */
 template<class Provisioner>
-std::shared_ptr<Base> parse(const H5::Group& handle, const std::string& name) {
+ParsedList parse(const H5::Group& handle, const std::string& name) {
     return parse<Provisioner>(handle, name, uzuki2::DummyExternals(0));
 }
 
@@ -646,13 +647,13 @@ std::shared_ptr<Base> parse(const H5::Group& handle, const std::string& name) {
  * @param name Name of the HDF5 group containing the list in `file`.
  * @param ext Instance of an external reference resolver class.
  *
- * @return Pointer to the root `Base` object.
+ * @return A `ParsedList` containing a pointer to the root `Base` object.
  * Depending on `Provisioner`, this may contain references to all nested objects. 
  * 
  * Any invalid representations in `contents` will cause an error to be thrown.
  */
 template<class Provisioner, class Externals>
-std::shared_ptr<Base> parse(const std::string& file, const std::string& name, Externals ext) {
+ParsedList parse(const std::string& file, const std::string& name, Externals ext) {
     H5::H5File handle(file, H5F_ACC_RDONLY);
     return parse<Provisioner>(handle.openGroup(name), name, std::move(ext));
 }
@@ -666,13 +667,13 @@ std::shared_ptr<Base> parse(const std::string& file, const std::string& name, Ex
  * @param file Path to a HDF5 file.
  * @param name Name of the HDF5 group containing the list in `file`.
  *
- * @return Pointer to the root `Base` object.
+ * @return A `ParsedList` containing a pointer to the root `Base` object.
  * Depending on `Provisioner`, this may contain references to all nested objects. 
  * 
  * Any invalid representations in `contents` will cause an error to be thrown.
  */
 template<class Provisioner>
-std::shared_ptr<Base> parse(const std::string& file, const std::string& name) {
+ParsedList parse(const std::string& file, const std::string& name) {
     H5::H5File handle(file, H5F_ACC_RDONLY);
     return parse<Provisioner>(handle.openGroup(name), name, uzuki2::DummyExternals(0));
 }

include/uzuki2/parse_json.hpp

@@ -409,7 +409,7 @@ struct Options {
  * @param ext Instance of an external reference resolver class.
  * @param options Options for parsing.
  *
- * @return Pointer to the root `Base` object.
+ * @return A `ParsedList` containing a pointer to the root `Base` object.
  * Depending on `Provisioner`, this may contain references to all nested objects.
  *
  * Any invalid representations in `reader` will cause an error to be thrown.
@@ -454,7 +454,7 @@ ParsedList parse(byteme::Reader& reader, Externals ext, Options options = Option
  * @param reader Instance of a `byteme::Reader` providing the contents of the JSON file.
  * @param options Options for parsing.
  *
- * @return Pointer to the root `Base` object.
+ * @return A `ParsedList` containing a pointer to the root `Base` object.
  * Depending on `Provisioner`, this may contain references to all nested objects.
  *
  * Any invalid representations in `reader` will cause an error to be thrown.
@@ -477,7 +477,7 @@ ParsedList parse(byteme::Reader& reader, Options options = Options()) {
  * @param ext Instance of an external reference resolver class.
  * @param options Options for parsing.
  *
- * @return Pointer to the root `Base` object.
+ * @return A `ParsedList` containing a pointer to the root `Base` object.
  * Depending on `Provisioner`, this may contain references to all nested objects.
  *
  * Any invalid representations in `reader` will cause an error to be thrown.
@@ -497,7 +497,7 @@ ParsedList parse_file(const std::string& file, Externals ext, Options options =
  * @param file Path to a (possibly Gzip-compressed) JSON file.
  * @param options Options for parsing.
  *
- * @return Pointer to the root `Base` object.
+ * @return A `ParsedList` containing a pointer to the root `Base` object.
  * Depending on `Provisioner`, this may contain references to all nested objects.
  *
  * Any invalid representations in `reader` will cause an error to be thrown.
@@ -521,7 +521,7 @@ ParsedList parse_file(const std::string& file, Options options = Options()) {
  * @param ext Instance of an external reference resolver class.
  * @param options Options for parsing.
  *
- * @return Pointer to the root `Base` object.
+ * @return A `ParsedList` containing a pointer to the root `Base` object.
  * Depending on `Provisioner`, this may contain references to all nested objects.
  *
  * Any invalid representations in `reader` will cause an error to be thrown.
@@ -542,7 +542,7 @@ ParsedList parse_buffer(const unsigned char* buffer, size_t len, Externals ext,
  * @param len Length of the buffer in bytes.
  * @param options Options for parsing.
  *
- * @return Pointer to the root `Base` object.
+ * @return A `ParsedList` containing a pointer to the root `Base` object.
  * Depending on `Provisioner`, this may contain references to all nested objects.
  *
  * Any invalid representations in `reader` will cause an error to be thrown.