rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator > Class Template Reference

Writer with indentation and spacing. More...

#include <prettywriter.h>

Inheritance diagram for rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >:

Public Types
typedef Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >	Base
typedef Base::Ch	Ch
Public Types inherited from rapidjson::Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >
typedef SourceEncoding::Ch	Ch

Public Member Functions
	PrettyWriter (OutputStream &os, StackAllocator *allocator=0, size_t levelDepth=Base::kDefaultLevelDepth)
	Constructor. More...
PrettyWriter &	SetIndent (Ch indentChar, unsigned indentCharCount)
	Set custom indentation. More...
Implementation of Handler
See also Handler
bool	Null ()
bool	Bool (bool b)
bool	Int (int i)
bool	Uint (unsigned u)
bool	Int64 (int64_t i64)
bool	Uint64 (uint64_t u64)
bool	Double (double d)
bool	String (const Ch *str, SizeType length, bool copy=false)
bool	StartObject ()
bool	Key (const Ch *str, SizeType length, bool copy=false)
bool	EndObject (SizeType memberCount=0)
bool	StartArray ()
bool	EndArray (SizeType memberCount=0)
Convenience extensions
bool	String (const Ch *str)
	Simpler but slower overload. More...
bool	Key (const Ch *str)
Public Member Functions inherited from rapidjson::Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >
	Writer (OutputStream &os, StackAllocator *stackAllocator=0, size_t levelDepth=kDefaultLevelDepth)
	Constructor. More...
	Writer (StackAllocator *allocator=0, size_t levelDepth=kDefaultLevelDepth)
void	Reset (OutputStream &os)
	Reset the writer with a new stream. More...
bool	IsComplete () const
	Checks whether the output is a complete JSON. More...
bool	Null ()
bool	Bool (bool b)
bool	Int (int i)
bool	Uint (unsigned u)
bool	Int64 (int64_t i64)
bool	Uint64 (uint64_t u64)
bool	Double (double d)
	Writes the given double value to the stream. More...
bool	String (const Ch *str, SizeType length, bool copy=false)
bool	StartObject ()
bool	Key (const Ch *str, SizeType length, bool copy=false)
bool	EndObject (SizeType memberCount=0)
bool	StartArray ()
bool	EndArray (SizeType elementCount=0)
bool	String (const Ch *str)
	Simpler but slower overload. More...
bool	Key (const Ch *str)

Protected Member Functions
void	PrettyPrefix (Type type)
void	WriteIndent ()
Protected Member Functions inherited from rapidjson::Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >
bool	WriteNull ()
bool	WriteBool (bool b)
bool	WriteInt (int i)
bool	WriteUint (unsigned u)
bool	WriteInt64 (int64_t i64)
bool	WriteUint64 (uint64_t u64)
bool	WriteDouble (double d)
bool	WriteString (const Ch *str, SizeType length)
bool	WriteStartObject ()
bool	WriteEndObject ()
bool	WriteStartArray ()
bool	WriteEndArray ()
void	Prefix (Type type)
template<>
bool	WriteInt (int i)
template<>
bool	WriteUint (unsigned u)
template<>
bool	WriteInt64 (int64_t i64)
template<>
bool	WriteUint64 (uint64_t u)
template<>
bool	WriteDouble (double d)

Protected Attributes
Ch	indentChar_
unsigned	indentCharCount_
Protected Attributes inherited from rapidjson::Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >
OutputStream *	os_
internal::Stack< StackAllocator >	level_stack_
bool	hasRoot_

Private Member Functions
	PrettyWriter (const PrettyWriter &)
PrettyWriter &	operator= (const PrettyWriter &)

Additional Inherited Members
Static Protected Attributes inherited from rapidjson::Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >
static const size_t	kDefaultLevelDepth = 32

Detailed Description

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>
class rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >

Writer with indentation and spacing.

Template Parameters

OutputStream	Type of ouptut os.
SourceEncoding	Encoding of source string.
TargetEncoding	Encoding of output stream.
StackAllocator	Type of allocator for allocating memory of stack.

Definition at line 41 of file prettywriter.h.

Member Typedef Documentation

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

typedef Writer<OutputStream, SourceEncoding, TargetEncoding, StackAllocator> rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Base

Definition at line 43 of file prettywriter.h.

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

typedef Base::Ch rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Ch

Definition at line 44 of file prettywriter.h.

Constructor & Destructor Documentation

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::PrettyWriter ( OutputStream &  os, StackAllocator *  allocator = 0, size_t  levelDepth = Base::kDefaultLevelDepth  )

inline

Constructor.

Parameters

os	Output stream.
allocator	User supplied allocator. If it is null, it will create a private one.
levelDepth	Initial capacity of stack.

Definition at line 51 of file prettywriter.h.

                                                                                                              : 
        Base(os, allocator, levelDepth), indentChar_(' '), indentCharCount_(4) {}

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::PrettyWriter ( const PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator > &  )

private

Member Function Documentation

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Bool ( bool  b )

inline

Definition at line 72 of file prettywriter.h.

{ PrettyPrefix(b ? kTrueType : kFalseType); return Base::WriteBool(b); }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Double ( double  d )

inline

Definition at line 77 of file prettywriter.h.

{ PrettyPrefix(kNumberType); return Base::WriteDouble(d); }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::EndArray ( SizeType  memberCount = 0 )

inline

Definition at line 116 of file prettywriter.h.

                                            {
        (void)memberCount;
        RAPIDJSON_ASSERT(Base::level_stack_.GetSize() >= sizeof(typename Base::Level));
        RAPIDJSON_ASSERT(Base::level_stack_.template Top<typename Base::Level>()->inArray);
        bool empty = Base::level_stack_.template Pop<typename Base::Level>(1)->valueCount == 0;

        if (!empty) {
            Base::os_->Put('\n');
            WriteIndent();
        }
        if (!Base::WriteEndArray())
            return false;
        if (Base::level_stack_.Empty()) // end of json text
            Base::os_->Flush();
        return true;
    }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::EndObject ( SizeType  memberCount = 0 )

inline

Definition at line 93 of file prettywriter.h.

                                             {
        (void)memberCount;
        RAPIDJSON_ASSERT(Base::level_stack_.GetSize() >= sizeof(typename Base::Level));
        RAPIDJSON_ASSERT(!Base::level_stack_.template Top<typename Base::Level>()->inArray);
        bool empty = Base::level_stack_.template Pop<typename Base::Level>(1)->valueCount == 0;

        if (!empty) {
            Base::os_->Put('\n');
            WriteIndent();
        }
        if (!Base::WriteEndObject())
            return false;
        if (Base::level_stack_.Empty()) // end of json text
            Base::os_->Flush();
        return true;
    }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Int ( int  i )

inline

Definition at line 73 of file prettywriter.h.

{ PrettyPrefix(kNumberType); return Base::WriteInt(i); }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Int64 ( int64_t  i64 )

inline

Definition at line 75 of file prettywriter.h.

{ PrettyPrefix(kNumberType); return Base::WriteInt64(i64); }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Key ( const Ch *  str, SizeType  length, bool  copy = false  )

inline

Definition at line 91 of file prettywriter.h.

{ return String(str, length, copy); }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Key ( const Ch *  str )

inline

Definition at line 140 of file prettywriter.h.

{ return Key(str, internal::StrLen(str)); }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Null ( )

inline

Definition at line 71 of file prettywriter.h.

{ PrettyPrefix(kNullType);   return Base::WriteNull(); }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

PrettyWriter& rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::operator= ( const PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator > &  )

private

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

void rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::PrettyPrefix ( Type  type )

inlineprotected

Definition at line 144 of file prettywriter.h.

                                 {
        (void)type;
        if (Base::level_stack_.GetSize() != 0) { // this value is not at root
            typename Base::Level* level = Base::level_stack_.template Top<typename Base::Level>();

            if (level->inArray) {
                if (level->valueCount > 0) {
                    Base::os_->Put(','); // add comma if it is not the first element in array
                    Base::os_->Put('\n');
                }
                else
                    Base::os_->Put('\n');
                WriteIndent();
            }
            else {  // in object
                if (level->valueCount > 0) {
                    if (level->valueCount % 2 == 0) {
                        Base::os_->Put(',');
                        Base::os_->Put('\n');
                    }
                    else {
                        Base::os_->Put(':');
                        Base::os_->Put(' ');
                    }
                }
                else
                    Base::os_->Put('\n');

                if (level->valueCount % 2 == 0)
                    WriteIndent();
            }
            if (!level->inArray && level->valueCount % 2 == 0)
                RAPIDJSON_ASSERT(type == kStringType);  // if it's in object, then even number should be a name
            level->valueCount++;
        }
        else {
            RAPIDJSON_ASSERT(!Base::hasRoot_);  // Should only has one and only one root.
            Base::hasRoot_ = true;
        }
    }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

PrettyWriter& rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::SetIndent ( Ch  indentChar, unsigned  indentCharCount  )

inline

Set custom indentation.

Parameters

indentChar	Character for indentation. Must be whitespace character (' ', '\t', '\n', '\r').
indentCharCount	Number of indent characters for each indentation level.

Note

The default indentation is 4 spaces.

Definition at line 59 of file prettywriter.h.

                                                                     {
        RAPIDJSON_ASSERT(indentChar == ' ' || indentChar == '\t' || indentChar == '\n' || indentChar == '\r');
        indentChar_ = indentChar;
        indentCharCount_ = indentCharCount;
        return *this;
    }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::StartArray ( )

inline

Definition at line 110 of file prettywriter.h.

                      {
        PrettyPrefix(kArrayType);
        new (Base::level_stack_.template Push<typename Base::Level>()) typename Base::Level(true);
        return Base::WriteStartArray();
    }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::StartObject ( )

inline

Definition at line 85 of file prettywriter.h.

                       {
        PrettyPrefix(kObjectType);
        new (Base::level_stack_.template Push<typename Base::Level>()) typename Base::Level(false);
        return Base::WriteStartObject();
    }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::String ( const Ch *  str, SizeType  length, bool  copy = false  )

inline

Definition at line 79 of file prettywriter.h.

                                                                   {
        (void)copy;
        PrettyPrefix(kStringType);
        return Base::WriteString(str, length);
    }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::String ( const Ch *  str )

inline

Simpler but slower overload.

Definition at line 139 of file prettywriter.h.

{ return String(str, internal::StrLen(str)); }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Uint ( unsigned  u )

inline

Definition at line 74 of file prettywriter.h.

{ PrettyPrefix(kNumberType); return Base::WriteUint(u); }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

bool rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::Uint64 ( uint64_t  u64 )

inline

Definition at line 76 of file prettywriter.h.

{ PrettyPrefix(kNumberType); return Base::WriteUint64(u64);  }

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

void rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::WriteIndent ( )

inlineprotected

Definition at line 185 of file prettywriter.h.

                        {
        size_t count = (Base::level_stack_.GetSize() / sizeof(typename Base::Level)) * indentCharCount_;
        PutN(*Base::os_, indentChar_, count);
    }

Member Data Documentation

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

Ch rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::indentChar_

protected

Definition at line 190 of file prettywriter.h.

template<typename OutputStream , typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator>

unsigned rapidjson::PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator >::indentCharCount_

protected

Definition at line 191 of file prettywriter.h.

---

The documentation for this class was generated from the following file:

• art/rapidjson/prettywriter.h