Variant/JSON/Writer.h

Go to the documentation of this file.

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2026.  All rights reserved
 */
#ifndef _Stroika_Foundation_DataExchange_Variant_JSON_Writer_h_
#define _Stroika_Foundation_DataExchange_Variant_JSON_Writer_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include "Stroika/Foundation/Characters/FloatConversion.h"
#include "Stroika/Foundation/Characters/LineEndings.h"
#include "Stroika/Foundation/Common/Common.h"
#include "Stroika/Foundation/DataExchange/Variant/Writer.h"
#include "Stroika/Foundation/DataExchange/VariantValue.h"
#include "Stroika/Foundation/Streams/OutputStream.h"
 
/**
 *  \file
 */
 
namespace Stroika::Foundation::DataExchange::Variant::JSON {
 
    /**
     *  \note   Our definition of the JSON format comes from:
     *          http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf
     *
     *          There are several variations. Please also note that http://jsonlint.com/ disallows
     *          json top level values other than array or object, but that doesn't appear to follow
     *          the standard as specified in ECMA.
     *
     *          This implementation allows any top-level value (as ECMA-404 calls for).
     *
     *  \note   Though ANY VariantValue can be mapped to a JSON object, the return trip
     *          will NOT necessarily be the same as the start object, because VariantValue supports more builtin types
     *          than JSON (e.g. Date). If you map a date to JSON, and back, you will get a String.
     *
     *  \note   Writing NAN/INF values (if fAllowNANInf set - default) - transforms those values to strings, but on roundtrip
     *          automatically transforms them back to the correct IEEE floating point type (if you coerce the VariantValue
     *          return from parsing to a floating point type).
     *
     *  \par Example Usage
     *      \code
     *          VariantValue v{3};
     *          JSON::Writer{}.Write (v, IO::FileSystem::FileOutputStream ("fred.json"));
     *      \endcode
     *
     *  \par Example Usage
     *      \code
     *          Mapping<String, VariantValue> m;
     *          m.Add ("max-files", 10);
     *          m.Add ("max-processes", 3);
     *          stringstream stringBuf;
     *          JSON::Writer{}.Write (VariantValue{m}, Streams::iostream::OutputStreamFromStdOStream (stringBuf));
     *      \endcode
     *
     *  \par Example Usage
     *      \code
     *          VariantValue v{3}; // or any other variant value - like a Mapping<String,VariantValue>
     *          String x = JSON::Writer {}.WriteAsString (v);
     *      \endcode
     *
     */
    class Writer : public Variant::Writer {
    private:
        using inherited = Variant::Writer;
 
    private:
        class Rep_;
 
    public:
        DISABLE_COMPILER_GCC_WARNING_START ("GCC diagnostic ignored \"-Wdeprecated-declarations\"");
        DISABLE_COMPILER_CLANG_WARNING_START ("clang diagnostic ignored \"-Wdeprecated-declarations\"");
        /**
         */
        struct Options {
            /**
             *  If false, more compact, and no leading/trailing spaces.
             */
            bool fPrettyPrint{true};
 
            /**
             *  Off by default, since it is costly, and rarely needed. Principally used for regression tests
             *  where we want to compare we get the same results as last time.
             */
            bool fCanonicalize{false};
 
            /**
             */
            Characters::FloatConversion::ToStringOptions fFloatOptions{};
 
            /**
             *  Ignored where fPrettyPrint is false.
             */
            unsigned int fSpacesPerIndent{4};
 
            /**
             *  \note   Note - NAN values (if floating point) - are also illegal, and generate a 'Require' failure.
             *          From http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf:
             *              Numeric values that cannot be represented as sequences of digits (such as Infinity and NaN) are not
             *              permitted.
             *
             *  And yet, there is a natural way to represent the numbers.
             *  We DEFAULT to allowing this. If not allowed, then presence of NANs and INF in input, is treated as an assertion error.
             *
             *  \note - because these would be ILLEGAL JSON, - they are written as strings. So when written, they REMAIN LEGAL JSON. And when you
             *          re-read the JSON, it will be read as a string. But when you coerce that string to a floating point type, the 'INF' or whatever,
             *          will be coerced to the proper IEEE floating point type.
             */
            bool fAllowNANInf{true};
 
            /**
             */
            String fLineTermination{Characters::kEOL<char>};
        };
        DISABLE_COMPILER_GCC_WARNING_END ("GCC diagnostic ignored \"-Wdeprecated-declarations\"");
        DISABLE_COMPILER_CLANG_WARNING_END ("clang diagnostic ignored \"-Wdeprecated-declarations\"");
 
    public:
#if qCompilerAndStdLib_default_member_initializer_needed_within_enclosing_class_Buggy
        Writer ();
        Writer (const Options& options); ///< \brief Writing as options says
#else
        Writer (const Options& options = {}); ///< \brief Writing as options says
#endif
    };
 
}
 
/*
 ********************************************************************************
 ***************************** Implementation Details ***************************
 ********************************************************************************
 */
 
#endif /*_Stroika_Foundation_DataExchange_Variant_JSON_Writer_h_*/