🐛 proper JSON Pointer escape in diagnostic messages

parent 7633a21e
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
#include <string> #include <string>
#include <vector> #include <vector>
#include <nlohmann/detail/value_t.hpp> #include <nlohmann/detail/value_t.hpp>
#include <nlohmann/detail/string_escape.hpp>
namespace nlohmann namespace nlohmann
{ {
...@@ -70,7 +71,7 @@ class diagnostics_t ...@@ -70,7 +71,7 @@ class diagnostics_t
return "(" + std::accumulate(tokens.rbegin(), tokens.rend(), std::string{}, return "(" + std::accumulate(tokens.rbegin(), tokens.rend(), std::string{},
[](const std::string & a, const std::string & b) [](const std::string & a, const std::string & b)
{ {
return a + "/" + b; return a + "/" + detail::escape(b);
}) + ") "; }) + ") ";
#else #else
return ""; return "";
......
...@@ -11,6 +11,7 @@ ...@@ -11,6 +11,7 @@
#include <nlohmann/detail/diagnostics_t.hpp> #include <nlohmann/detail/diagnostics_t.hpp>
#include <nlohmann/detail/exceptions.hpp> #include <nlohmann/detail/exceptions.hpp>
#include <nlohmann/detail/macro_scope.hpp> #include <nlohmann/detail/macro_scope.hpp>
#include <nlohmann/detail/string_escape.hpp>
#include <nlohmann/detail/value_t.hpp> #include <nlohmann/detail/value_t.hpp>
namespace nlohmann namespace nlohmann
...@@ -70,7 +71,7 @@ class json_pointer ...@@ -70,7 +71,7 @@ class json_pointer
std::string{}, std::string{},
[](const std::string & a, const std::string & b) [](const std::string & a, const std::string & b)
{ {
return a + "/" + escape(b); return a + "/" + detail::escape(b);
}); });
} }
...@@ -791,53 +792,13 @@ class json_pointer ...@@ -791,53 +792,13 @@ class json_pointer
} }
// finally, store the reference token // finally, store the reference token
unescape(reference_token); detail::unescape(reference_token);
result.push_back(reference_token); result.push_back(reference_token);
} }
return result; return result;
} }
/*!
@brief replace all occurrences of a substring by another string
@param[in,out] s the string to manipulate; changed so that all
occurrences of @a f are replaced with @a t
@param[in] f the substring to replace with @a t
@param[in] t the string to replace @a f
@pre The search string @a f must not be empty. **This precondition is
enforced with an assertion.**
@since version 2.0.0
*/
static void replace_substring(std::string& s, const std::string& f,
const std::string& t)
{
JSON_ASSERT(!f.empty());
for (auto pos = s.find(f); // find first occurrence of f
pos != std::string::npos; // make sure f was found
s.replace(pos, f.size(), t), // replace with t, and
pos = s.find(f, pos + t.size())) // find next occurrence of f
{}
}
JSON_PRIVATE_UNLESS_TESTED:
/// escape "~" to "~0" and "/" to "~1"
static std::string escape(std::string s)
{
replace_substring(s, "~", "~0");
replace_substring(s, "/", "~1");
return s;
}
/// unescape "~1" to tilde and "~0" to slash (order is important!)
static void unescape(std::string& s)
{
replace_substring(s, "~1", "/");
replace_substring(s, "~0", "~");
}
private: private:
/*! /*!
@param[in] reference_string the reference string to the current value @param[in] reference_string the reference string to the current value
...@@ -883,7 +844,7 @@ class json_pointer ...@@ -883,7 +844,7 @@ class json_pointer
// iterate object and use keys as reference string // iterate object and use keys as reference string
for (const auto& element : *value.m_value.object) for (const auto& element : *value.m_value.object)
{ {
flatten(reference_string + "/" + escape(element.first), element.second, result); flatten(reference_string + "/" + detail::escape(element.first), element.second, result);
} }
} }
break; break;
......
#pragma once
#include <string>
#include <nlohmann/detail/macro_scope.hpp>
namespace nlohmann
{
namespace detail
{
/*!
@brief replace all occurrences of a substring by another string
@param[in,out] s the string to manipulate; changed so that all
occurrences of @a f are replaced with @a t
@param[in] f the substring to replace with @a t
@param[in] t the string to replace @a f
@pre The search string @a f must not be empty. **This precondition is
enforced with an assertion.**
@since version 2.0.0
*/
inline void replace_substring(std::string& s, const std::string& f,
const std::string& t)
{
JSON_ASSERT(!f.empty());
for (auto pos = s.find(f); // find first occurrence of f
pos != std::string::npos; // make sure f was found
s.replace(pos, f.size(), t), // replace with t, and
pos = s.find(f, pos + t.size())) // find next occurrence of f
{}
}
/*!
* @brief string escaping as described in RFC 6901 (Sect. 4)
* @param[in] s string to escape
* @return escaped string
*
* Note the order of escaping "~" to "~0" and "/" to "~1" is important.
*/
inline std::string escape(std::string s)
{
replace_substring(s, "~", "~0");
replace_substring(s, "/", "~1");
return s;
}
/*!
* @brief string unescaping as described in RFC 6901 (Sect. 4)
* @param[in] s string to unescape
* @return unescaped string
*
* Note the order of escaping "~1" to "/" and "~0" to "~" is important.
*/
static void unescape(std::string& s)
{
replace_substring(s, "~1", "/");
replace_substring(s, "~0", "~");
}
} // namespace detail
} // namespace nlohmann
...@@ -8651,7 +8651,7 @@ class basic_json ...@@ -8651,7 +8651,7 @@ class basic_json
for (auto it = source.cbegin(); it != source.cend(); ++it) for (auto it = source.cbegin(); it != source.cend(); ++it)
{ {
// escape the key name to be used in a JSON patch // escape the key name to be used in a JSON patch
const auto key = json_pointer::escape(it.key()); const auto key = detail::escape(it.key());
if (target.find(it.key()) != target.end()) if (target.find(it.key()) != target.end())
{ {
...@@ -8675,7 +8675,7 @@ class basic_json ...@@ -8675,7 +8675,7 @@ class basic_json
if (source.find(it.key()) == source.end()) if (source.find(it.key()) == source.end())
{ {
// found a key that is not in this -> add it // found a key that is not in this -> add it
const auto key = json_pointer::escape(it.key()); const auto key = detail::escape(it.key());
result.push_back( result.push_back(
{ {
{"op", "add"}, {"path", path + "/" + key}, {"op", "add"}, {"path", path + "/" + key},
......
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment