From e9d8999408f33d91a9655ef9e3c06a197a8e4001 Mon Sep 17 00:00:00 2001
From: Axel Huebl <axel.huebl@plasma.ninja>
Date: Mon, 7 Oct 2024 16:30:51 -0700
Subject: [PATCH] ADIOS2 Access Mode: Fix Dangling Ref (#1674)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* ADIOS2 Access Mode: Fix Dangling Ref

Fix GCC 13.3 warning:
```
/home/runner/work/openPMD-api/openPMD-api/src/IO/ADIOS/ADIOS2IOHandler.cpp: In member function 'adios2::Mode openPMD::ADIOS2IOHandlerImpl::adios2AccessMode(const std::string&)':
/home/runner/work/openPMD-api/openPMD-api/src/IO/ADIOS/ADIOS2IOHandler.cpp:1531:21: warning: possibly dangling reference to a temporary [-Wdangling-reference]
 1531 |         auto const &access_mode_json = m_config["engine"]["access_mode"].json();
      |                     ^~~~~~~~~~~~~~~~
/home/runner/work/openPMD-api/openPMD-api/src/IO/ADIOS/ADIOS2IOHandler.cpp:1531:78: note: the temporary was destroyed at the end of the full expression 'openPMD::json::TracingJSON::operator[](Key&&) [with Key = const char (&)[12]]("access_mode").openPMD::json::TracingJSON::json()'
 1531 |         auto const &access_mode_json = m_config["engine"]["access_mode"].json();
      |                                        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^~
```

* Solve gcc13 false positive at an API level

Introduce an explicit API call for the pattern that gcc13 dislikes.

* Non-template alternative to the previous solution

* Simplify Doxygen

---------

Co-authored-by: Franz Pöschel <franz.poeschel@gmail.com>
---
 include/openPMD/auxiliary/JSON_internal.hpp | 16 ++++++++++----
 src/IO/ADIOS/ADIOS2IOHandler.cpp            |  2 +-
 src/IO/HDF5/ParallelHDF5IOHandler.cpp       |  4 ++--
 src/auxiliary/JSON.cpp                      | 23 +++++++++++++++++++++
 4 files changed, 38 insertions(+), 7 deletions(-)

diff --git a/include/openPMD/auxiliary/JSON_internal.hpp b/include/openPMD/auxiliary/JSON_internal.hpp
index dc72cffbdc..f419842b0b 100644
--- a/include/openPMD/auxiliary/JSON_internal.hpp
+++ b/include/openPMD/auxiliary/JSON_internal.hpp
@@ -76,10 +76,18 @@ namespace json
          *
          * @return nlohmann::json&
          */
-        inline nlohmann::json &json()
-        {
-            return *m_positionInOriginal;
-        }
+        nlohmann::json &json();
+
+        /**
+         * @brief Access the underlying JSON value
+         *
+         * See args, first arg, used to distinguish this overload.
+         *
+         * @param path Index to some sub-expression. Shortcut for
+         *        `tracingJSON[arg1][arg2][arg3].json()`.
+         * @return nlohmann::json&
+         */
+        nlohmann::json &json(std::vector<std::string> path);
 
         template <typename Key>
         TracingJSON operator[](Key &&key);
diff --git a/src/IO/ADIOS/ADIOS2IOHandler.cpp b/src/IO/ADIOS/ADIOS2IOHandler.cpp
index bdbd43325a..2946b047f0 100644
--- a/src/IO/ADIOS/ADIOS2IOHandler.cpp
+++ b/src/IO/ADIOS/ADIOS2IOHandler.cpp
@@ -1528,7 +1528,7 @@ adios2::Mode ADIOS2IOHandlerImpl::adios2AccessMode(std::string const &fullPath)
     if (m_config.json().contains("engine") &&
         m_config["engine"].json().contains("access_mode"))
     {
-        auto const &access_mode_json = m_config["engine"]["access_mode"].json();
+        auto const &access_mode_json = m_config.json({"engine", "access_mode"});
         auto maybe_access_mode_string =
             json::asLowerCaseStringDynamic(access_mode_json);
         if (!maybe_access_mode_string.has_value())
diff --git a/src/IO/HDF5/ParallelHDF5IOHandler.cpp b/src/IO/HDF5/ParallelHDF5IOHandler.cpp
index 00d5741457..e1192c8a9c 100644
--- a/src/IO/HDF5/ParallelHDF5IOHandler.cpp
+++ b/src/IO/HDF5/ParallelHDF5IOHandler.cpp
@@ -231,7 +231,7 @@ ParallelHDF5IOHandlerImpl::ParallelHDF5IOHandlerImpl(
                     {
                         return std::nullopt;
                     }
-                    auto const &val = vfd_json_config[key].json();
+                    auto const &val = vfd_json_config.json({key});
                     if (val.is_number_integer())
                     {
                         return val.get<long long>();
@@ -250,7 +250,7 @@ ParallelHDF5IOHandlerImpl::ParallelHDF5IOHandlerImpl(
                     {
                         return std::nullopt;
                     }
-                    auto const &val = vfd_json_config[key].json();
+                    auto const &val = vfd_json_config.json({key});
                     if (auto str_val = json::asLowerCaseStringDynamic(val);
                         str_val.has_value())
                     {
diff --git a/src/auxiliary/JSON.cpp b/src/auxiliary/JSON.cpp
index 7c96221026..8b758fe70e 100644
--- a/src/auxiliary/JSON.cpp
+++ b/src/auxiliary/JSON.cpp
@@ -60,6 +60,29 @@ TracingJSON::TracingJSON(ParsedConfig parsedConfig)
           std::move(parsedConfig.config), parsedConfig.originallySpecifiedAs}
 {}
 
+nlohmann::json &TracingJSON::json()
+{
+    return *m_positionInOriginal;
+}
+
+nlohmann::json &TracingJSON::json(std::vector<std::string> paths)
+{
+    if (paths.empty())
+    {
+        return json();
+    }
+    auto it = paths.begin();
+    auto end = paths.end();
+    nlohmann::json *res = &m_positionInOriginal->operator[](*it);
+    auto subhandle = this->operator[](*it);
+    for (++it; it != end; ++it)
+    {
+        subhandle = subhandle[*it];
+        res = &(*res)[*it];
+    }
+    return *res;
+}
+
 nlohmann::json const &TracingJSON::getShadow() const
 {
     return *m_positionInShadow;