mirror of
https://github.com/simdjson/simdjson
synced 2026-06-08 17:27:07 +00:00
Daniel Lemire
9b67497ed0
* This PR does the following: 1. Upgrade cxxopts. 2. Allows field::unescape_key to take in a string parameter (syntaxic sugar). 3. Adds a dev. check to detect a string buffer overflow (indicating broken code). Note that this is unrecoverable and indicates bad code. * tweak
113 lines
4.7 KiB
C++
113 lines
4.7 KiB
C++
#ifndef SIMDJSON_GENERIC_ONDEMAND_FIELD_H
|
|
|
|
#ifndef SIMDJSON_CONDITIONAL_INCLUDE
|
|
#define SIMDJSON_GENERIC_ONDEMAND_FIELD_H
|
|
#include "simdjson/generic/ondemand/base.h"
|
|
#include "simdjson/generic/implementation_simdjson_result_base.h"
|
|
#include "simdjson/generic/ondemand/raw_json_string.h"
|
|
#include "simdjson/generic/ondemand/value.h"
|
|
#endif // SIMDJSON_CONDITIONAL_INCLUDE
|
|
|
|
namespace simdjson {
|
|
namespace SIMDJSON_IMPLEMENTATION {
|
|
namespace ondemand {
|
|
|
|
/**
|
|
* A JSON field (key/value pair) in an object.
|
|
*
|
|
* Returned from object iteration.
|
|
*
|
|
* Extends from std::pair<raw_json_string, value> so you can use C++ algorithms that rely on pairs.
|
|
*/
|
|
class field : public std::pair<raw_json_string, value> {
|
|
public:
|
|
/**
|
|
* Create a new invalid field.
|
|
*
|
|
* Exists so you can declare a variable and later assign to it before use.
|
|
*/
|
|
simdjson_inline field() noexcept;
|
|
|
|
/**
|
|
* Get the key as a string_view (for higher speed, consider raw_key).
|
|
* We deliberately use a more cumbersome name (unescaped_key) to force users
|
|
* to think twice about using it.
|
|
*
|
|
* This consumes the key: once you have called unescaped_key(), you cannot
|
|
* call it again nor can you call key().
|
|
*/
|
|
simdjson_inline simdjson_warn_unused simdjson_result<std::string_view> unescaped_key(bool allow_replacement = false) noexcept;
|
|
/**
|
|
* Get the key as a string_view (for higher speed, consider raw_key).
|
|
* We deliberately use a more cumbersome name (unescaped_key) to force users
|
|
* to think twice about using it. The content is stored in the receiver.
|
|
*
|
|
* This consumes the key: once you have called unescaped_key(), you cannot
|
|
* call it again nor can you call key().
|
|
*/
|
|
template <typename string_type>
|
|
simdjson_inline simdjson_warn_unused error_code unescaped_key(string_type& receiver, bool allow_replacement = false) noexcept;
|
|
/**
|
|
* Get the key as a raw_json_string. Can be used for direct comparison with
|
|
* an unescaped C string: e.g., key() == "test". This does not count as
|
|
* consumption of the content: you can safely call it repeatedly.
|
|
* See escaped_key() for a similar function which returns
|
|
* a more convenient std::string_view result.
|
|
*/
|
|
simdjson_inline raw_json_string key() const noexcept;
|
|
/**
|
|
* Get the unprocessed key as a string_view. This includes the quotes and may include
|
|
* some spaces after the last quote. This does not count as
|
|
* consumption of the content: you can safely call it repeatedly.
|
|
* See escaped_key().
|
|
*/
|
|
simdjson_inline std::string_view key_raw_json_token() const noexcept;
|
|
/**
|
|
* Get the key as a string_view. This does not include the quotes and
|
|
* the string is unprocessed key so it may contain escape characters
|
|
* (e.g., \uXXXX or \n). It does not count as a consumption of the content:
|
|
* you can safely call it repeatedly. Use unescaped_key() to get the unescaped key.
|
|
*/
|
|
simdjson_inline std::string_view escaped_key() const noexcept;
|
|
/**
|
|
* Get the field value.
|
|
*/
|
|
simdjson_inline ondemand::value &value() & noexcept;
|
|
/**
|
|
* @overload ondemand::value &ondemand::value() & noexcept
|
|
*/
|
|
simdjson_inline ondemand::value value() && noexcept;
|
|
|
|
protected:
|
|
simdjson_inline field(raw_json_string key, ondemand::value &&value) noexcept;
|
|
static simdjson_inline simdjson_result<field> start(value_iterator &parent_iter) noexcept;
|
|
static simdjson_inline simdjson_result<field> start(const value_iterator &parent_iter, raw_json_string key) noexcept;
|
|
friend struct simdjson_result<field>;
|
|
friend class object_iterator;
|
|
};
|
|
|
|
} // namespace ondemand
|
|
} // namespace SIMDJSON_IMPLEMENTATION
|
|
} // namespace simdjson
|
|
|
|
namespace simdjson {
|
|
|
|
template<>
|
|
struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::field> : public SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::field> {
|
|
public:
|
|
simdjson_inline simdjson_result(SIMDJSON_IMPLEMENTATION::ondemand::field &&value) noexcept; ///< @private
|
|
simdjson_inline simdjson_result(error_code error) noexcept; ///< @private
|
|
simdjson_inline simdjson_result() noexcept = default;
|
|
|
|
simdjson_inline simdjson_result<std::string_view> unescaped_key(bool allow_replacement = false) noexcept;
|
|
template<typename string_type>
|
|
simdjson_inline error_code unescaped_key(string_type &receiver, bool allow_replacement = false) noexcept;
|
|
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::raw_json_string> key() noexcept;
|
|
simdjson_inline simdjson_result<std::string_view> key_raw_json_token() noexcept;
|
|
simdjson_inline simdjson_result<std::string_view> escaped_key() noexcept;
|
|
simdjson_inline simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::value> value() noexcept;
|
|
};
|
|
|
|
} // namespace simdjson
|
|
|
|
#endif // SIMDJSON_GENERIC_ONDEMAND_FIELD_H
|