mirror of
https://github.com/msgpack/msgpack-c.git
synced 2025-05-29 15:34:08 +02:00
0f66e144ab
MSVC CLI defined their own nullptr and provides for __nullptr for standard C++11. https://msdn.microsoft.com/en-us/library/4ex65770.aspx msgpack-c introduce MSGPACK_NULLPTR for internal use, it is defined as __nullptr only if compiled on C++ CLI otherwise defined as nullptr.
349 lines
12 KiB
C++
349 lines
12 KiB
C++
//
|
|
// MessagePack for C++ deserializing routine
|
|
//
|
|
// Copyright (C) 2016 KONDO Takatoshi
|
|
//
|
|
// Distributed under the Boost Software License, Version 1.0.
|
|
// (See accompanying file LICENSE_1_0.txt or copy at
|
|
// http://www.boost.org/LICENSE_1_0.txt)
|
|
//
|
|
#ifndef MSGPACK_V2_UNPACK_DECL_HPP
|
|
#define MSGPACK_V2_UNPACK_DECL_HPP
|
|
|
|
#include "msgpack/v1/unpack_decl.hpp"
|
|
|
|
namespace msgpack {
|
|
|
|
/// @cond
|
|
MSGPACK_API_VERSION_NAMESPACE(v2) {
|
|
/// @endcond
|
|
|
|
using v1::unpack_reference_func;
|
|
|
|
using v1::unpack_error;
|
|
using v1::parse_error;
|
|
using v1::insufficient_bytes;
|
|
using v1::size_overflow;
|
|
using v1::array_size_overflow;
|
|
using v1::map_size_overflow;
|
|
using v1::str_size_overflow;
|
|
using v1::bin_size_overflow;
|
|
using v1::ext_size_overflow;
|
|
using v1::depth_size_overflow;
|
|
using v1::unpack_limit;
|
|
|
|
namespace detail {
|
|
|
|
using v1::detail::unpack_user;
|
|
|
|
using v1::detail::unpack_uint8;
|
|
using v1::detail::unpack_uint16;
|
|
using v1::detail::unpack_uint32;
|
|
using v1::detail::unpack_uint64;
|
|
|
|
using v1::detail::unpack_int8;
|
|
using v1::detail::unpack_int16;
|
|
using v1::detail::unpack_int32;
|
|
using v1::detail::unpack_int64;
|
|
|
|
using v1::detail::unpack_float;
|
|
using v1::detail::unpack_double;
|
|
|
|
using v1::detail::unpack_nil;
|
|
|
|
using v1::detail::unpack_true;
|
|
using v1::detail::unpack_false;
|
|
|
|
using v1::detail::unpack_array;
|
|
using v1::detail::unpack_array_item;
|
|
using v1::detail::unpack_map;
|
|
using v1::detail::unpack_map_item;
|
|
using v1::detail::unpack_str;
|
|
using v1::detail::unpack_bin;
|
|
using v1::detail::unpack_ext;
|
|
|
|
using v1::detail::unpack_stack;
|
|
|
|
using v1::detail::init_count;
|
|
using v1::detail::decr_count;
|
|
using v1::detail::incr_count;
|
|
|
|
using v1::detail::get_count;
|
|
|
|
using v1::detail::fix_tag;
|
|
|
|
using v1::detail::value;
|
|
|
|
using v1::detail::load;
|
|
|
|
} // detail
|
|
|
|
|
|
using v1::unpacked;
|
|
|
|
/// Unpacking class for a stream deserialization.
|
|
class unpacker;
|
|
|
|
template <typename unpack_visitor, typename referenced_buffer_hook>
|
|
class basic_unpacker;
|
|
|
|
typedef enum unpack_return {
|
|
UNPACK_SUCCESS = v1::UNPACK_SUCCESS,
|
|
UNPACK_EXTRA_BYTES = v1::UNPACK_EXTRA_BYTES,
|
|
UNPACK_CONTINUE = v1::UNPACK_CONTINUE,
|
|
UNPACK_PARSE_ERROR = v1::UNPACK_PARSE_ERROR,
|
|
UNPACK_STOP_VISITOR = -2
|
|
} unpack_return;
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param off The offset position of the buffer. It is read and overwritten.
|
|
* @param referenced If the unpacked object contains reference of the buffer, then set as true, otherwise false.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
* @return object_handle that contains unpacked data.
|
|
*
|
|
*/
|
|
object_handle unpack(
|
|
const char* data, std::size_t len, std::size_t& off, bool& referenced,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param off The offset position of the buffer. It is read and overwritten.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
* @return object_handle that contains unpacked data.
|
|
*
|
|
*/
|
|
object_handle unpack(
|
|
const char* data, std::size_t len, std::size_t& off,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param referenced If the unpacked object contains reference of the buffer, then set as true, otherwise false.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
* @return object_handle that contains unpacked data.
|
|
*
|
|
*/
|
|
object_handle unpack(
|
|
const char* data, std::size_t len, bool& referenced,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
* @return object_handle that contains unpacked data.
|
|
*
|
|
*/
|
|
object_handle unpack(
|
|
const char* data, std::size_t len,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param result The object_handle that contains unpacked data.
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param off The offset position of the buffer. It is read and overwritten.
|
|
* @param referenced If the unpacked object contains reference of the buffer, then set as true, otherwise false.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
*
|
|
*/
|
|
void unpack(
|
|
object_handle& result,
|
|
const char* data, std::size_t len, std::size_t& off, bool& referenced,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param result The object_handle that contains unpacked data.
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param off The offset position of the buffer. It is read and overwritten.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
*
|
|
*/
|
|
void unpack(
|
|
object_handle& result,
|
|
const char* data, std::size_t len, std::size_t& off,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param result The object_handle that contains unpacked data.
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param referenced If the unpacked object contains reference of the buffer, then set as true, otherwise false.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
*
|
|
*/
|
|
void unpack(
|
|
object_handle& result,
|
|
const char* data, std::size_t len, bool& referenced,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param result The object_handle that contains unpacked data.
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
*
|
|
*/
|
|
void unpack(
|
|
object_handle& result,
|
|
const char* data, std::size_t len,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param z The msgpack::zone that is used as a memory of unpacked msgpack objects.
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param off The offset position of the buffer. It is read and overwritten.
|
|
* @param referenced If the unpacked object contains reference of the buffer, then set as true, otherwise false.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
* @return msgpack::object that contains unpacked data.
|
|
*
|
|
*/
|
|
msgpack::object unpack(
|
|
msgpack::zone& z,
|
|
const char* data, std::size_t len, std::size_t& off, bool& referenced,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param z The msgpack::zone that is used as a memory of unpacked msgpack objects.
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param off The offset position of the buffer. It is read and overwritten.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
* @return msgpack::object that contains unpacked data.
|
|
*
|
|
*/
|
|
msgpack::object unpack(
|
|
msgpack::zone& z,
|
|
const char* data, std::size_t len, std::size_t& off,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param z The msgpack::zone that is used as a memory of unpacked msgpack objects.
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param referenced If the unpacked object contains reference of the buffer, then set as true, otherwise false.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
* @return msgpack::object that contains unpacked data.
|
|
*
|
|
*/
|
|
msgpack::object unpack(
|
|
msgpack::zone& z,
|
|
const char* data, std::size_t len, bool& referenced,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack::object from a buffer.
|
|
/**
|
|
* @param z The msgpack::zone that is used as a memory of unpacked msgpack objects.
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param f A judging function that msgpack::object refer to the buffer.
|
|
* @param user_data This parameter is passed to f.
|
|
* @param limit The size limit information of msgpack::object.
|
|
*
|
|
* @return msgpack::object that contains unpacked data.
|
|
*
|
|
*/
|
|
msgpack::object unpack(
|
|
msgpack::zone& z,
|
|
const char* data, std::size_t len,
|
|
unpack_reference_func f = MSGPACK_NULLPTR, void* user_data = MSGPACK_NULLPTR, unpack_limit const& limit = unpack_limit());
|
|
|
|
/// Unpack msgpack formatted data via a visitor
|
|
/**
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param off The offset position of the buffer. It is read and overwritten.
|
|
* @param v The visitor that satisfies visitor concept. https://github.com/msgpack/msgpack-c/wiki/v2_0_cpp_visitor#visitor-concept
|
|
*
|
|
* @return if unpacking process finishs without error then return true, otherwise return false.
|
|
*
|
|
*/
|
|
template <typename Visitor>
|
|
bool parse(const char* data, size_t len, size_t& off, Visitor& v);
|
|
|
|
/// Unpack msgpack formatted data via a visitor
|
|
/**
|
|
* @param data The pointer to the buffer.
|
|
* @param len The length of the buffer.
|
|
* @param v The visitor that satisfies visitor concept. https://github.com/msgpack/msgpack-c/wiki/v2_0_cpp_visitor#visitor-concept
|
|
*
|
|
* @return if unpacking process finishs without error then return true, otherwise return false.
|
|
*
|
|
*/
|
|
template <typename Visitor>
|
|
bool parse(const char* data, size_t len, Visitor& v);
|
|
|
|
namespace detail {
|
|
|
|
unpack_return
|
|
unpack_imp(const char* data, std::size_t len, std::size_t& off,
|
|
msgpack::zone& result_zone, msgpack::object& result, bool& referenced,
|
|
unpack_reference_func f, void* user_data,
|
|
unpack_limit const& limit);
|
|
|
|
template <typename UnpackVisitor>
|
|
unpack_return
|
|
parse_imp(const char* data, size_t len, size_t& off, UnpackVisitor& v);
|
|
|
|
} // detail
|
|
|
|
/// @cond
|
|
} // MSGPACK_API_VERSION_NAMESPACE(v2)
|
|
/// @endcond
|
|
|
|
} // namespace msgpack
|
|
|
|
#endif // MSGPACK_V2_UNPACK_DECL_HPP
|