/src/jsoncons/include/jsoncons_ext/msgpack/msgpack_parser.hpp

Source
// Copyright 2013-2026 Daniel Parker
// Distributed under the Boost license, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

// See https://github.com/danielaparker/jsoncons for latest version

#ifndef JSONCONS_EXT_MSGPACK_MSGPACK_PARSER_HPP
#define JSONCONS_EXT_MSGPACK_MSGPACK_PARSER_HPP

#include <cstddef>
#include <cstdint>
#include <memory>
#include <string>
#include <system_error>
#include <utility> // std::move
#include <vector>

#include <jsoncons/config/compiler_support.hpp>
#include <jsoncons/config/jsoncons_config.hpp>
#include <jsoncons/generic_visitor.hpp>
#include <jsoncons/json_type.hpp>
#include <jsoncons/semantic_tag.hpp>
#include <jsoncons/ser_utils.hpp>
#include <jsoncons/source.hpp>
#include <jsoncons/utility/bigint.hpp>
#include <jsoncons/utility/binary.hpp>
#include <jsoncons/utility/byte_string.hpp>
#include <jsoncons/utility/unicode_traits.hpp>

#include <jsoncons_ext/msgpack/msgpack_error.hpp>
#include <jsoncons_ext/msgpack/msgpack_options.hpp>
#include <jsoncons_ext/msgpack/msgpack_type.hpp>

namespace jsoncons { 
namespace msgpack {

enum class parse_mode {root,accept,array,map_key,map_value};

struct parse_state 
{
    parse_mode mode; 
    std::size_t length{0};
    std::size_t index{0};

    parse_state(parse_mode mode, std::size_t length) noexcept
        : mode(mode), length(length)
    {
    }

    parse_state(const parse_state&) = default;
    parse_state(parse_state&&) = default;
    
    ~parse_state() = default;
};

template <typename Source,typename Allocator=std::allocator<char>>
class basic_msgpack_parser : public ser_context
{
    using char_type = char;
    using char_traits_type = std::char_traits<char>;
    using temp_allocator_type = Allocator;
    using char_allocator_type = typename std::allocator_traits<temp_allocator_type>:: template rebind_alloc<char_type>;                  
    using byte_allocator_type = typename std::allocator_traits<temp_allocator_type>:: template rebind_alloc<uint8_t>;                  
    using int64_allocator_type = typename std::allocator_traits<temp_allocator_type>:: template rebind_alloc<int64_t>;                  
    using parse_state_allocator_type = typename std::allocator_traits<temp_allocator_type>:: template rebind_alloc<parse_state>;                         

    static constexpr int64_t nanos_in_second = 1000000000;

    bool more_{true};
    bool done_{false};
    int nesting_depth_{0};
    bool cursor_mode_{false};
    int mark_level_{0};

    Source source_;
    int max_nesting_depth_;
    std::basic_string<char,std::char_traits<char>,char_allocator_type> text_buffer_;
    std::vector<uint8_t,byte_allocator_type> bytes_buffer_;
    std::vector<parse_state,parse_state_allocator_type> state_stack_;

public:
    template <typename Sourceable>
    basic_msgpack_parser(Sourceable&& source,
                         const msgpack_decode_options& options = msgpack_decode_options(),
                         const Allocator& alloc = Allocator())
       : source_(std::forward<Sourceable>(source)),
         max_nesting_depth_(options.max_nesting_depth()),
         text_buffer_(alloc),
         bytes_buffer_(alloc),
         state_stack_(alloc)
    {
        state_stack_.emplace_back(parse_mode::root,0);
    }

    void restart()
    {
        more_ = true;
    }

    void reset()
    {
        more_ = true;
        done_ = false;
        text_buffer_.clear();
        bytes_buffer_.clear();
        state_stack_.clear();
        state_stack_.emplace_back(parse_mode::root,0);
        nesting_depth_ = 0;
    }

    template <typename Sourceable>
    void reset(Sourceable&& source)
    {
        source_ = std::forward<Sourceable>(source);
        reset();
    }

    void cursor_mode(bool value)
    {
        cursor_mode_ = value;
    }

    int level() const
    {
        return static_cast<int>(state_stack_.size());
    }

    int mark_level() const 
    {
        return mark_level_;
    }

    void mark_level(int value)
    {
        mark_level_ = value;
    }

    bool done() const
    {
        return done_;
    }

    bool stopped() const
    {
        return !more_;
    }

    std::size_t line() const final
    {
        return 0;
    }

    std::size_t column() const final
    {
        return source_.position();
    }

    void parse(generic_visitor& visitor, std::error_code& ec)
    {
        while (!done_ && more_)
        {
            switch (state_stack_.back().mode)
            {
                case parse_mode::array:
                {
                    if (state_stack_.back().index < state_stack_.back().length)
                    {
                        ++state_stack_.back().index;
                        read_item(visitor, ec);
                        if (JSONCONS_UNLIKELY(ec))
                        {
                            return;
                        }
                    }
                    else
                    {
                        end_array(visitor, ec);
                    }
                    break;
                }
                case parse_mode::map_key:
                {
                    if (state_stack_.back().index < state_stack_.back().length)
                    {
                        ++state_stack_.back().index;
                        state_stack_.back().mode = parse_mode::map_value;
                        read_item(visitor, ec);
                        if (JSONCONS_UNLIKELY(ec))
                        {
                            return;
                        }
                    }
                    else
                    {
                        end_object(visitor, ec);
                    }
                    break;
                }
                case parse_mode::map_value:
                {
                    state_stack_.back().mode = parse_mode::map_key;
                    read_item(visitor, ec);
                    if (JSONCONS_UNLIKELY(ec))
                    {
                        return;
                    }
                    break;
                }
                case parse_mode::root:
                {
                    state_stack_.back().mode = parse_mode::accept;
                    read_item(visitor, ec);
                    if (JSONCONS_UNLIKELY(ec))
                    {
                        return;
                    }
                    break;
                }
                case parse_mode::accept:
                {
                    JSONCONS_ASSERT(state_stack_.size() == 1);
                    state_stack_.clear();
                    more_ = false;
                    done_ = true;
                    visitor.flush();
                    break;
                }
            }
        }
    }
private:

    void read_item(generic_visitor& visitor, std::error_code& ec)
    {
        if (source_.is_error())
        {
            ec = msgpack_errc::source_error;
            more_ = false;
            return;
        }   

        uint8_t type;
        if (source_.read(&type, 1) == 0)
        {
            ec = msgpack_errc::unexpected_eof;
            more_ = false;
            return;
        }

        if (type <= 0xbf)
        {
            if (type <= 0x7f) 
            {
                // positive fixint
                visitor.uint64_value(type, semantic_tag::none, *this, ec);
                more_ = !cursor_mode_;
            }
            else if (type <= 0x8f) 
            {
                begin_object(visitor,type,ec); // fixmap
            }
            else if (type <= 0x9f) 
            {
                begin_array(visitor,type,ec); // fixarray
            }
            else 
            {
                // fixstr
                const size_t len = type & 0x1f;

                auto data = source_.read_span(len, bytes_buffer_);
                if (data.size() != static_cast<std::size_t>(len))
                {
                    ec = msgpack_errc::unexpected_eof;
                    more_ = false;
                    return;
                }

                auto result = unicode_traits::validate(data.data(), data.size());
                if (result.ec != unicode_traits::unicode_errc())
                {
                    ec = msgpack_errc::invalid_utf8_text_string;
                    more_ = false;
                    return;
                }
                visitor.string_value(jsoncons::string_view(reinterpret_cast<const char*>(data.data()),data.size()), 
                    semantic_tag::none, *this, ec);
                more_ = !cursor_mode_;
            }
        }
        else if (type >= 0xe0) 
        {
            // negative fixint
            visitor.int64_value(static_cast<int8_t>(type), semantic_tag::none, *this, ec);
            more_ = !cursor_mode_;
        }
        else
        {
            switch (type)
            {
                case jsoncons::msgpack::msgpack_type::nil_type: 
                {
                    visitor.null_value(semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }
                case jsoncons::msgpack::msgpack_type::true_type:
                {
                    visitor.bool_value(true, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }
                case jsoncons::msgpack::msgpack_type::false_type:
                {
                    visitor.bool_value(false, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }
                case jsoncons::msgpack::msgpack_type::float32_type: 
                {
                    uint8_t buf[sizeof(float)];
                    if (source_.read(buf, sizeof(float)) != sizeof(float))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }
                    float val = binary::big_to_native<float>(buf, sizeof(buf));
                    visitor.double_value(val, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::float64_type: 
                {
                    uint8_t buf[sizeof(double)];
                    if (source_.read(buf, sizeof(double)) != sizeof(double))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }
                    double val = binary::big_to_native<double>(buf, sizeof(buf));
                    visitor.double_value(val, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::uint8_type: 
                {
                    uint8_t b;
                    if (source_.read(&b, 1) == 0)
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }
                    visitor.uint64_value(b, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::uint16_type: 
                {
                    uint8_t buf[sizeof(uint16_t)];
                    if (source_.read(buf, sizeof(uint16_t)) !=sizeof(uint16_t)) 
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }
                    uint16_t val = binary::big_to_native<uint16_t>(buf, sizeof(buf));
                    visitor.uint64_value(val, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::uint32_type: 
                {
                    uint8_t buf[sizeof(uint32_t)];
                    if (source_.read(buf, sizeof(uint32_t)) != sizeof(uint32_t))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }
                    uint32_t val = binary::big_to_native<uint32_t>(buf, sizeof(buf));
                    visitor.uint64_value(val, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::uint64_type: 
                {
                    uint8_t buf[sizeof(uint64_t)];
                    if (source_.read(buf, sizeof(uint64_t)) != sizeof(uint64_t))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }
                    uint64_t val = binary::big_to_native<uint64_t>(buf, sizeof(buf));
                    visitor.uint64_value(val, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::int8_type: 
                {
                    uint8_t buf[sizeof(int8_t)];
                    if (source_.read(buf, sizeof(int8_t)) != sizeof(int8_t))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }
                    int8_t val = binary::big_to_native<int8_t>(buf, sizeof(buf));
                    visitor.int64_value(val, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::int16_type: 
                {
                    uint8_t buf[sizeof(int16_t)];
                    if (source_.read(buf, sizeof(int16_t)) != sizeof(int16_t))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }
                    int16_t val = binary::big_to_native<int16_t>(buf, sizeof(buf));
                    visitor.int64_value(val, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::int32_type: 
                {
                    uint8_t buf[sizeof(int32_t)];
                    if (source_.read(buf, sizeof(int32_t)) != sizeof(int32_t))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }
                    int32_t val = binary::big_to_native<int32_t>(buf, sizeof(buf));
                    visitor.int64_value(val, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::int64_type: 
                {
                    uint8_t buf[sizeof(int64_t)];
                    if (source_.read(buf, sizeof(int64_t)) != sizeof(int64_t))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }
                    int64_t val = binary::big_to_native<int64_t>(buf, sizeof(buf));
                    visitor.int64_value(val, semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::str8_type: 
                case jsoncons::msgpack::msgpack_type::str16_type: 
                case jsoncons::msgpack::msgpack_type::str32_type: 
                {
                    std::size_t len = get_size(type, ec);
                    if (!more_)
                    {
                        return;
                    }

                    auto data = source_.read_span(len, bytes_buffer_);
                    if (data.size() != static_cast<std::size_t>(len))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }

                    auto result = unicode_traits::validate(data.data(), data.size());
                    if (result.ec != unicode_traits::unicode_errc())
                    {
                        ec = msgpack_errc::invalid_utf8_text_string;
                        more_ = false;
                        return;
                    }
                    visitor.string_value(jsoncons::string_view(reinterpret_cast<const char*>(data.data()),data.size()), 
                        semantic_tag::none, *this, ec);
                    more_ = !cursor_mode_;
                    break;
                }

                case jsoncons::msgpack::msgpack_type::bin8_type: 
                case jsoncons::msgpack::msgpack_type::bin16_type: 
                case jsoncons::msgpack::msgpack_type::bin32_type: 
                {
                    std::size_t len = get_size(type,ec);
                    if (!more_)
                    {
                        return;
                    }
                    auto data = source_.read_span(len, bytes_buffer_);
                    if (JSONCONS_UNLIKELY(data.size() != static_cast<std::size_t>(len)))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }

                    visitor.byte_string_value(byte_string_view(data.data(),data.size()), 
                        semantic_tag::none, 
                        *this,
                        ec);
                    more_ = !cursor_mode_;
                    break;
                }
                case jsoncons::msgpack::msgpack_type::fixext1_type: 
                case jsoncons::msgpack::msgpack_type::fixext2_type: 
                case jsoncons::msgpack::msgpack_type::fixext4_type: 
                case jsoncons::msgpack::msgpack_type::fixext8_type: 
                case jsoncons::msgpack::msgpack_type::fixext16_type: 
                case jsoncons::msgpack::msgpack_type::ext8_type: 
                case jsoncons::msgpack::msgpack_type::ext16_type: 
                case jsoncons::msgpack::msgpack_type::ext32_type: 
                {
                    std::size_t len = get_size(type,ec);
                    if (!more_)
                    {
                        return;
                    }

                    // type
                    uint8_t buf[sizeof(int8_t)];
                    if (source_.read(buf, sizeof(int8_t)) != sizeof(int8_t))
                    {
                        ec = msgpack_errc::unexpected_eof;
                        more_ = false;
                        return;
                    }

                    int8_t ext_type = binary::big_to_native<int8_t>(buf, sizeof(buf));

                    bool is_timestamp = false; 
                    if (ext_type == -1)
                    {
                        is_timestamp = true;;
                    }

                    // payload
                    if (is_timestamp && len == 4)
                    {
                        uint8_t buf32[sizeof(uint32_t)];
                        if (source_.read(buf32, sizeof(uint32_t)) != sizeof(uint32_t))
                        {
                            ec = msgpack_errc::unexpected_eof;
                            more_ = false;
                            return;
                        }
                        uint32_t val = binary::big_to_native<uint32_t>(buf32, sizeof(buf32));
                        visitor.uint64_value(val, semantic_tag::epoch_second, *this, ec);
                        more_ = !cursor_mode_;
                    }
                    else if (is_timestamp && len == 8)
                    {
                        uint8_t buf64[sizeof(uint64_t)];
                        if (source_.read(buf64, sizeof(uint64_t)) != sizeof(uint64_t))
                        {
                            ec = msgpack_errc::unexpected_eof;
                            more_ = false;
                            return;
                        }
                        uint64_t data64 = binary::big_to_native<uint64_t>(buf64, sizeof(buf64));
                        uint64_t sec = data64 & 0x00000003ffffffffL;
                        uint64_t nsec = data64 >> 34;

                        bigint nano(sec);
                        nano *= uint64_t(nanos_in_second);
                        nano += nsec;
                        text_buffer_.clear();
                        nano.write_string(text_buffer_);
                        visitor.string_value(text_buffer_, semantic_tag::epoch_nano, *this, ec);
                        more_ = !cursor_mode_;
                        if (!more_) return;
                    }
                    else if (is_timestamp && len == 12)
                    {
                        uint8_t buf1[sizeof(uint32_t)];
                        if (source_.read(buf1, sizeof(uint32_t)) != sizeof(uint32_t))
                        {
                            ec = msgpack_errc::unexpected_eof;
                            more_ = false;
                            return;
                        }
                        uint32_t nsec = binary::big_to_native<uint32_t>(buf1, sizeof(buf1));

                        uint8_t buf2[sizeof(int64_t)];
                        if (source_.read(buf2, sizeof(int64_t)) != sizeof(int64_t))
                        {
                            ec = msgpack_errc::unexpected_eof;
                            more_ = false;
                            return;
                        }
                        int64_t sec = binary::big_to_native<int64_t>(buf2, sizeof(buf2));

                        bigint nano(sec);

                        nano *= uint64_t(nanos_in_second);

                        if (nano < 0)
                        {
                            nano -= nsec;
                        }
                        else
                        {
                            nano += nsec;
                        }

                        text_buffer_.clear();
                        nano.write_string(text_buffer_);
                        visitor.string_value(text_buffer_, semantic_tag::epoch_nano, *this, ec);
                        more_ = !cursor_mode_;
                        if (!more_) return;
                    }
                    else
                    {
                        auto data = source_.read_span(len, bytes_buffer_);
                        if (JSONCONS_UNLIKELY(data.size() != static_cast<std::size_t>(len)))
                        {
                            ec = msgpack_errc::unexpected_eof;
                            more_ = false;
                            return;
                        }

                        visitor.byte_string_value(byte_string_view(data.data(),data.size()), 
                                                          static_cast<uint8_t>(ext_type), 
                                                          *this,
                                                          ec);
                        more_ = !cursor_mode_;
                    }
                    break;
                }

                case jsoncons::msgpack::msgpack_type::array16_type: 
                case jsoncons::msgpack::msgpack_type::array32_type: 
                {
                    begin_array(visitor,type,ec);
                    break;
                }

                case jsoncons::msgpack::msgpack_type::map16_type : 
                case jsoncons::msgpack::msgpack_type::map32_type : 
                {
                    begin_object(visitor, type, ec);
                    break;
                }

                default:
                {
                    ec = msgpack_errc::unknown_type;
                    more_ = false;
                    return;
                }
            }
        }
    }

    void begin_array(generic_visitor& visitor, uint8_t type, std::error_code& ec)
    {
        if (JSONCONS_UNLIKELY(++nesting_depth_ > max_nesting_depth_))
        {
            ec = msgpack_errc::max_nesting_depth_exceeded;
            more_ = false;
            return;
        } 
        std::size_t length = get_size(type, ec);
        if (!more_)
        {
            return;
        }
        state_stack_.emplace_back(parse_mode::array,length);
        visitor.begin_array(length, semantic_tag::none, *this, ec);
        more_ = !cursor_mode_;
    }

    void end_array(generic_visitor& visitor, std::error_code& ec)
    {
        --nesting_depth_;

        visitor.end_array(*this, ec);
        more_ = !cursor_mode_;
        state_stack_.pop_back();
    }

    void begin_object(generic_visitor& visitor, uint8_t type, std::error_code& ec)
    {
        if (JSONCONS_UNLIKELY(++nesting_depth_ > max_nesting_depth_))
        {
            ec = msgpack_errc::max_nesting_depth_exceeded;
            more_ = false;
            return;
        } 
        std::size_t length = get_size(type, ec);
        if (!more_)
        {
            return;
        }
        state_stack_.emplace_back(parse_mode::map_key,length);
        visitor.begin_object(length, semantic_tag::none, *this, ec);
        more_ = !cursor_mode_;
    }

    void end_object(generic_visitor& visitor, std::error_code& ec)
    {
        --nesting_depth_;
        visitor.end_object(*this, ec);
        more_ = !cursor_mode_;
        state_stack_.pop_back();
    }

    std::size_t get_size(uint8_t type, std::error_code& ec)
    {
        switch (type)
        {
            case jsoncons::msgpack::msgpack_type::str8_type: 
            case jsoncons::msgpack::msgpack_type::bin8_type: 
            case jsoncons::msgpack::msgpack_type::ext8_type: 
            {
                uint8_t buf[sizeof(int8_t)];
                if (source_.read(buf, sizeof(int8_t)) != sizeof(int8_t))
                {
                    ec = msgpack_errc::unexpected_eof;
                    more_ = false;
                    return 0;
                }
                uint8_t len = binary::big_to_native<uint8_t>(buf, sizeof(buf));
                return static_cast<std::size_t>(len);
            }

            case jsoncons::msgpack::msgpack_type::str16_type: 
            case jsoncons::msgpack::msgpack_type::bin16_type: 
            case jsoncons::msgpack::msgpack_type::ext16_type: 
            case jsoncons::msgpack::msgpack_type::array16_type: 
            case jsoncons::msgpack::msgpack_type::map16_type:
            {
                uint8_t buf[sizeof(int16_t)];
                if (source_.read(buf, sizeof(int16_t)) != sizeof(int16_t))
                {
                    ec = msgpack_errc::unexpected_eof;
                    more_ = false;
                    return 0;
                }
                uint16_t len = binary::big_to_native<uint16_t>(buf, sizeof(buf));
                return static_cast<std::size_t>(len);
            }

            case jsoncons::msgpack::msgpack_type::str32_type: 
            case jsoncons::msgpack::msgpack_type::bin32_type: 
            case jsoncons::msgpack::msgpack_type::ext32_type: 
            case jsoncons::msgpack::msgpack_type::array32_type: 
            case jsoncons::msgpack::msgpack_type::map32_type : 
            {
                uint8_t buf[sizeof(int32_t)];
                if (source_.read(buf, sizeof(int32_t)) != sizeof(int32_t))
                {
                    ec = msgpack_errc::unexpected_eof;
                    more_ = false;
                    return 0;
                }
                uint32_t len = binary::big_to_native<uint32_t>(buf, sizeof(buf));
                return static_cast<std::size_t>(len);
            }
            case jsoncons::msgpack::msgpack_type::fixext1_type: 
                return 1;
            case jsoncons::msgpack::msgpack_type::fixext2_type: 
                return 2;
            case jsoncons::msgpack::msgpack_type::fixext4_type: 
                return 4;
            case jsoncons::msgpack::msgpack_type::fixext8_type: 
                return 8;
            case jsoncons::msgpack::msgpack_type::fixext16_type: 
                return 16;
            default:
                if ((type > 0x8f && type <= 0x9f) // fixarray
                    || (type > 0x7f && type <= 0x8f) // fixmap
        )
                {
                    return type & 0x0f;
                }
                else
                {
                    ec = msgpack_errc::unknown_type;
                    more_ = false;
                    return 0;
                }
                break;
        }
    }
};

} // namespace msgpack
} // namespace jsoncons

#endif // JSONCONS_EXT_MSGPACK_MSGPACK_PARSER_HPP

Coverage Report

Created: 2026-08-13 06:30