json/Writer.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012, 2013 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_JSON_WRITER_H_INCLUDED
#define RIPPLE_JSON_WRITER_H_INCLUDED
 
#include <xrpl/basics/ToString.h>
#include <xrpl/basics/contract.h>
#include <xrpl/json/Output.h>
#include <xrpl/json/json_value.h>
#include <memory>
 
namespace Json {
 
class Writer
{
public:
    enum CollectionType { array, object };
 
    explicit Writer(Output const& output);
    Writer(Writer&&) noexcept;
    Writer&
    operator=(Writer&&) noexcept;
 
    ~Writer();
 
    void startRoot(CollectionType);
 
    void startAppend(CollectionType);
 
    void
    startSet(CollectionType, std::string const& key);
 
    void
    finish();
 
    void
    finishAll();
 
    template <typename Scalar>
    void
    append(Scalar t)
    {
        rawAppend();
        output(t);
    }
 
    void
    rawAppend();
 
    template <typename Type>
    void
    set(std::string const& tag, Type t)
    {
        rawSet(tag);
        output(t);
    }
 
    void
    rawSet(std::string const& key);
 
    // You won't need to call anything below here until you are writing single
    // items (numbers, strings, bools, null) to a JSON stream.
 
    /*** Output a string. */
    void
    output(std::string const&);
 
    /*** Output a literal constant or C string. */
    void
    output(char const*);
 
    /*** Output a Json::Value. */
    void
    output(Json::Value const&);
 
    void output(std::nullptr_t);
 
    void
    output(float);
 
    void
    output(double);
 
    void
    output(bool);
 
    template <typename Type>
    void
    output(Type t)
    {
        implOutput(std::to_string(t));
    }
 
    void
    output(Json::StaticString const& t)
    {
        output(t.c_str());
    }
 
private:
    class Impl;
    std::unique_ptr<Impl> impl_;
 
    void
    implOutput(std::string const&);
};
 
inline void
check(bool condition, std::string const& message)
{
    if (!condition)
        ripple::Throw<std::logic_error>(message);
}
 
}  // namespace Json
 
#endif