Compare commits

..
Author SHA1 Message Date
Niels Lohmann 13766fc435 Fix stale comments in include/
- json_view.hpp: find_key() returns the first member with a duplicate key,
  not the last one (as find_member() and the API documentation say).
- binary_writer.hpp: throw_size_marker_required() throws other_error.502,
  not other_error.407.
- serializer.hpp, number_parse.hpp, to_chars.hpp: doubles are no longer
  converted with Grisu2 but with the shortest digits of Zmij; Grisu2 is
  only used for binary32 and other formats.

Comments only; the amalgamation is regenerated.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>
2026-11-16 07:03:33 +01:00
10 changed files with 28 additions and 64 deletions

No files matched your search

@@ -48,10 +48,11 @@ namespace detail
{ {
/*! /*!
@brief implements the Grisu2 algorithm for binary to decimal floating-point @brief implements binary to decimal floating-point conversion: the shortest
conversion. digits of Zmij (see zmij.hpp) for IEEE 754 binary64 numbers, and the Grisu2
algorithm for all other formats.
This implementation is a slightly modified version of the reference The Grisu2 implementation is a slightly modified version of the reference
implementation which may be obtained from implementation which may be obtained from
http://florian.loitsch.com/publications (bench.tar.gz). http://florian.loitsch.com/publications (bench.tar.gz).
@@ -4096,10 +4096,6 @@ class binary_reader
auto number_lexer = detail::lexer<BasicJsonType, ia_type>(detail::input_adapter(number_vector), false); auto number_lexer = detail::lexer<BasicJsonType, ia_type>(detail::input_adapter(number_vector), false);
const auto result_number = number_lexer.scan(); const auto result_number = number_lexer.scan();
const auto number_string = number_lexer.get_token_string(); const auto number_string = number_lexer.get_token_string();
// the number as the lexer read it, for SAX number_float(): unlike
// get_token_string(), which is meant for error messages and shortens
// long tokens, it is complete; the next scan() replaces it
const string_t number_text = number_lexer.get_string();
const auto result_remainder = number_lexer.scan(); const auto result_remainder = number_lexer.scan();
using token_type = typename detail::lexer_base<BasicJsonType>::token_type; using token_type = typename detail::lexer_base<BasicJsonType>::token_type;
@@ -4126,7 +4122,10 @@ class binary_reader
number_string, number_string,
out_of_range::create(exception_id::number_overflow, concat("number overflow parsing '", number_string, '\''), nullptr)); out_of_range::create(exception_id::number_overflow, concat("number overflow parsing '", number_string, '\''), nullptr));
} }
return sax->number_float(parsed_float, number_text); // number_string is a std::string, while the SAX interface takes a
// string_t; convert explicitly, as the two are only implicitly
// convertible for some string types
return sax->number_float(parsed_float, string_t(number_string.data(), number_string.size()));
} }
case token_type::uninitialized: case token_type::uninitialized:
case token_type::literal_true: case token_type::literal_true:
@@ -257,7 +257,7 @@ struct ieee_binary_format<53> // binary64
These formats (float, double, and long double where it is binary64, e.g. These formats (float, double, and long double where it is binary64, e.g.
with MSVC or on Apple arm64) are converted by parse_float_native(). The with MSVC or on Apple arm64) are converted by parse_float_native(). The
predicate is the one the serializer uses to choose Grisu2. predicate is the one the serializer uses to choose to_chars() over snprintf.
*/ */
template<typename FloatType> template<typename FloatType>
struct has_native_float_format struct has_native_float_format
@@ -915,7 +915,7 @@ class binary_writer
JSON_THROW(out_of_range::create(exception_id::subtype_out_of_range, concat("subtype ", std::to_string(subtype), " is too large for ", what, " (max 255)"), &j)); JSON_THROW(out_of_range::create(exception_id::subtype_out_of_range, concat("subtype ", std::to_string(subtype), " is too large for ", what, " (max 255)"), &j));
} }
/// @throw other_error.407 always /// @throw other_error.502 always
JSON_HEDLEY_NO_RETURN JSON_HEDLEY_NEVER_INLINE JSON_HEDLEY_NO_RETURN JSON_HEDLEY_NEVER_INLINE
static void throw_size_marker_required(const BasicJsonType& j) static void throw_size_marker_required(const BasicJsonType& j)
{ {
@@ -2033,8 +2033,9 @@ class serializer
} }
// If number_float_t is an IEEE-754 single or double precision number, // If number_float_t is an IEEE-754 single or double precision number,
// use the Grisu2 algorithm to produce short numbers which are // use to_chars() to produce short numbers which are guaranteed to
// guaranteed to round-trip, using strtof and strtod, resp. // round-trip, using strtof and strtod, resp. (the shortest digits of
// Zmij for binary64, the Grisu2 algorithm for binary32).
// //
// NB: The test below works if <long double> == <double>. // NB: The test below works if <long double> == <double>.
static constexpr bool is_ieee_single_or_double static constexpr bool is_ieee_single_or_double
+1 -1
View File
@@ -849,7 +849,7 @@ class basic_json_view
return !navigation::editable() || m_doc->edits == nullptr; return !navigation::editable() || m_doc->edits == nullptr;
} }
/// the member of this object with @a key (the last one if the key occurs more than once), or nullptr /// the member of this object with @a key (the first one if the key occurs more than once), or nullptr
NLOHMANN_VIEW_ALWAYS_INLINE const node* find_key(string_view_t key) const NLOHMANN_VIEW_ALWAYS_INLINE const node* find_key(string_view_t key) const
{ {
return find_key(key, std::integral_constant<bool, is_editable> {}); return find_key(key, std::integral_constant<bool, is_editable> {});
+13 -12
View File
@@ -11642,7 +11642,7 @@ struct ieee_binary_format<53> // binary64
These formats (float, double, and long double where it is binary64, e.g. These formats (float, double, and long double where it is binary64, e.g.
with MSVC or on Apple arm64) are converted by parse_float_native(). The with MSVC or on Apple arm64) are converted by parse_float_native(). The
predicate is the one the serializer uses to choose Grisu2. predicate is the one the serializer uses to choose to_chars() over snprintf.
*/ */
template<typename FloatType> template<typename FloatType>
struct has_native_float_format struct has_native_float_format
@@ -22774,10 +22774,6 @@ class binary_reader
auto number_lexer = detail::lexer<BasicJsonType, ia_type>(detail::input_adapter(number_vector), false); auto number_lexer = detail::lexer<BasicJsonType, ia_type>(detail::input_adapter(number_vector), false);
const auto result_number = number_lexer.scan(); const auto result_number = number_lexer.scan();
const auto number_string = number_lexer.get_token_string(); const auto number_string = number_lexer.get_token_string();
// the number as the lexer read it, for SAX number_float(): unlike
// get_token_string(), which is meant for error messages and shortens
// long tokens, it is complete; the next scan() replaces it
const string_t number_text = number_lexer.get_string();
const auto result_remainder = number_lexer.scan(); const auto result_remainder = number_lexer.scan();
using token_type = typename detail::lexer_base<BasicJsonType>::token_type; using token_type = typename detail::lexer_base<BasicJsonType>::token_type;
@@ -22804,7 +22800,10 @@ class binary_reader
number_string, number_string,
out_of_range::create(exception_id::number_overflow, concat("number overflow parsing '", number_string, '\''), nullptr)); out_of_range::create(exception_id::number_overflow, concat("number overflow parsing '", number_string, '\''), nullptr));
} }
return sax->number_float(parsed_float, number_text); // number_string is a std::string, while the SAX interface takes a
// string_t; convert explicitly, as the two are only implicitly
// convertible for some string types
return sax->number_float(parsed_float, string_t(number_string.data(), number_string.size()));
} }
case token_type::uninitialized: case token_type::uninitialized:
case token_type::literal_true: case token_type::literal_true:
@@ -31148,7 +31147,7 @@ class binary_writer
JSON_THROW(out_of_range::create(exception_id::subtype_out_of_range, concat("subtype ", std::to_string(subtype), " is too large for ", what, " (max 255)"), &j)); JSON_THROW(out_of_range::create(exception_id::subtype_out_of_range, concat("subtype ", std::to_string(subtype), " is too large for ", what, " (max 255)"), &j));
} }
/// @throw other_error.407 always /// @throw other_error.502 always
JSON_HEDLEY_NO_RETURN JSON_HEDLEY_NEVER_INLINE JSON_HEDLEY_NO_RETURN JSON_HEDLEY_NEVER_INLINE
static void throw_size_marker_required(const BasicJsonType& j) static void throw_size_marker_required(const BasicJsonType& j)
{ {
@@ -36007,10 +36006,11 @@ namespace detail
{ {
/*! /*!
@brief implements the Grisu2 algorithm for binary to decimal floating-point @brief implements binary to decimal floating-point conversion: the shortest
conversion. digits of Zmij (see zmij.hpp) for IEEE 754 binary64 numbers, and the Grisu2
algorithm for all other formats.
This implementation is a slightly modified version of the reference The Grisu2 implementation is a slightly modified version of the reference
implementation which may be obtained from implementation which may be obtained from
http://florian.loitsch.com/publications (bench.tar.gz). http://florian.loitsch.com/publications (bench.tar.gz).
@@ -39520,8 +39520,9 @@ class serializer
} }
// If number_float_t is an IEEE-754 single or double precision number, // If number_float_t is an IEEE-754 single or double precision number,
// use the Grisu2 algorithm to produce short numbers which are // use to_chars() to produce short numbers which are guaranteed to
// guaranteed to round-trip, using strtof and strtod, resp. // round-trip, using strtof and strtod, resp. (the shortest digits of
// Zmij for binary64, the Grisu2 algorithm for binary32).
// //
// NB: The test below works if <long double> == <double>. // NB: The test below works if <long double> == <double>.
static constexpr bool is_ieee_single_or_double static constexpr bool is_ieee_single_or_double
+1 -1
View File
@@ -11016,7 +11016,7 @@ class basic_json_view
return !navigation::editable() || m_doc->edits == nullptr; return !navigation::editable() || m_doc->edits == nullptr;
} }
/// the member of this object with @a key (the last one if the key occurs more than once), or nullptr /// the member of this object with @a key (the first one if the key occurs more than once), or nullptr
NLOHMANN_VIEW_ALWAYS_INLINE const node* find_key(string_view_t key) const NLOHMANN_VIEW_ALWAYS_INLINE const node* find_key(string_view_t key) const
{ {
return find_key(key, std::integral_constant<bool, is_editable> {}); return find_key(key, std::integral_constant<bool, is_editable> {});
-19
View File
@@ -1278,25 +1278,6 @@ TEST_CASE("BJData")
CHECK(j.dump() == "3.141592653589793"); CHECK(j.dump() == "3.141592653589793");
} }
SECTION("long floating-point number")
{
// the SAX parser receives the number text as it is in the
// input, also when it is longer than the part of a token
// that error messages show
const std::vector<std::size_t> lengths = {8192, 8193, 10000};
for (const auto length : lengths)
{
CAPTURE(length)
const std::string number = "1." + std::string(length - 2, '3');
std::vector<std::uint8_t> vec = {'H', 'I', static_cast<std::uint8_t>(length & 0xFF), static_cast<std::uint8_t>(length >> 8)};
vec.insert(vec.end(), number.begin(), number.end());
SaxEventLogger logger;
CHECK(json::sax_parse(vec, &logger, json::input_format_t::bjdata));
CHECK(logger.events == std::vector<std::string>({"number_float(" + number + ")"}));
CHECK(json::from_bjdata(vec).is_number_float());
}
}
SECTION("errors") SECTION("errors")
{ {
// error while parsing length // error while parsing length
-19
View File
@@ -793,25 +793,6 @@ TEST_CASE("UBJSON")
CHECK(j.dump() == "3.141592653589793"); CHECK(j.dump() == "3.141592653589793");
} }
SECTION("long floating-point number")
{
// the SAX parser receives the number text as it is in the
// input, also when it is longer than the part of a token
// that error messages show
const std::vector<std::size_t> lengths = {8192, 8193, 10000};
for (const auto length : lengths)
{
CAPTURE(length)
const std::string number = "1." + std::string(length - 2, '3');
std::vector<std::uint8_t> vec = {'H', 'I', static_cast<std::uint8_t>(length >> 8), static_cast<std::uint8_t>(length & 0xFF)};
vec.insert(vec.end(), number.begin(), number.end());
SaxEventLogger logger;
CHECK(json::sax_parse(vec, &logger, json::input_format_t::ubjson));
CHECK(logger.events == std::vector<std::string>({"number_float(" + number + ")"}));
CHECK(json::from_ubjson(vec).is_number_float());
}
}
SECTION("errors") SECTION("errors")
{ {
// error while parsing length // error while parsing length