Builder.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2026 nfx
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

 
#pragma once
 
#include "Document.h"
 
#include <nfx/Containers.h>
#include <nfx/string/StringBuilder.h>
 
#include <charconv>
#include <cstdint>
#include <stdexcept>
#include <string>
#include <string_view>
#include <type_traits>
 
namespace nfx::json
{
    class Builder
    {
    public:
        struct Options
        {
            int indent = 0;

            size_t bufferSize = 4096;

            bool escapeNonAscii = false;
        };

        inline explicit Builder( Options options = { 0, 4096, false } );

        inline Builder& writeStartObject();

        inline Builder& writeEndObject();

        inline Builder& writeStartArray();

        inline Builder& writeEndArray();

        inline Builder& writeKey( std::string_view key );

        inline Builder& writeRawJson( std::string_view rawJson );

        inline Builder& write( std::string_view key, std::nullptr_t value );

        inline Builder& write( std::string_view key, bool value );

        inline Builder& write( std::string_view key, int value );

        inline Builder& write( std::string_view key, unsigned int value );

        inline Builder& write( std::string_view key, int64_t value );

        inline Builder& write( std::string_view key, uint64_t value );

        inline Builder& write( std::string_view key, float value );

        inline Builder& write( std::string_view key, double value );

        inline Builder& write( std::string_view key, std::string_view value );

        inline Builder& write( std::string_view key, const char* value );

        inline Builder& write( std::string_view key, const std::string& value );

        inline Builder& write( std::string_view key, const Document& value );

        inline Builder& write( std::nullptr_t value );

        inline Builder& write( bool value );

        inline Builder& write( int value );

        inline Builder& write( unsigned int value );

        inline Builder& write( int64_t value );

        inline Builder& write( uint64_t value );

        inline Builder& write( float value );

        inline Builder& write( double value );

        inline Builder& write( std::string_view value );

        inline Builder& write( const char* value );

        inline Builder& write( const std::string& value );

        inline Builder& write( const Document& value );

        template <typename T>
        inline std::enable_if_t<
            std::is_same_v<T, long> && !std::is_same_v<long, int> && !std::is_same_v<long, int64_t>,
            Builder&>
        write( std::string_view key, T value );

        template <typename T>
        inline std::enable_if_t<
            std::is_same_v<T, unsigned long> && !std::is_same_v<unsigned long, unsigned int> &&
                !std::is_same_v<unsigned long, uint64_t>,
            Builder&>
        write( std::string_view key, T value );

        template <typename T>
        inline std::enable_if_t<std::is_same_v<T, long long> && !std::is_same_v<long long, int64_t>, Builder&> write(
            std::string_view key, T value );

        template <typename T>
        inline std::enable_if_t<
            std::is_same_v<T, unsigned long long> && !std::is_same_v<unsigned long long, uint64_t>,
            Builder&>
        write( std::string_view key, T value );

        template <typename T>
        inline std::enable_if_t<
            std::is_same_v<T, long> && !std::is_same_v<long, int> && !std::is_same_v<long, int64_t>,
            Builder&>
        write( T value );

        template <typename T>
        inline std::enable_if_t<
            std::is_same_v<T, unsigned long> && !std::is_same_v<unsigned long, unsigned int> &&
                !std::is_same_v<unsigned long, uint64_t>,
            Builder&>
        write( T value );

        template <typename T>
        inline std::enable_if_t<std::is_same_v<T, long long> && !std::is_same_v<long long, int64_t>, Builder&> write(
            T value );

        template <typename T>
        inline std::enable_if_t<
            std::is_same_v<T, unsigned long long> && !std::is_same_v<unsigned long long, uint64_t>,
            Builder&>
        write( T value );

        inline std::string toString();

        inline Builder& reset();

        [[nodiscard]] inline size_t size() const noexcept;

        [[nodiscard]] inline bool isEmpty() const noexcept;

        inline Builder& reserve( size_t capacity );

        [[nodiscard]] inline std::string_view toStringView() const noexcept;

        [[nodiscard]] inline size_t capacity() const noexcept;

        [[nodiscard]] inline size_t depth() const noexcept;

        [[nodiscard]] inline bool isValid() const noexcept;

        template <typename Container>
        inline Builder& writeArray( std::string_view key, const Container& values );

        template <typename Container>
        inline Builder& writeArray( const Container& values );
 
    private:
        struct ContextFrame
        {
            bool isObject;       
            bool isEmpty;        
            bool expectingValue; 
        };

        inline void writeInt( int64_t value );

        inline void writeUInt( uint64_t value );

        inline void writeDouble( double value );

        inline void writeString( std::string_view str );

        inline void writeNewlineAndIndent();

        inline void writeCommaIfNeeded();

        inline void writeDocument( const Document& doc );

        inline void writeDocumentArray( const Array& array );

        inline void writeDocumentObject( const Object& object );
 
        string::StringBuilder m_buffer;                          
        int m_indent;                                            
        int m_currentIndent;                                     
        bool m_escapeNonAscii;                                   
        containers::StackVector<ContextFrame, 8> m_contextStack; 
    };
} // namespace nfx::json
 
#include "detail/Builder.inl"