Writer with indentation and spacing. Plus de détails...

#include <arcane/utils/internal/json/rapidjson/prettywriter.h>

Graphe d'héritage de PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator, writeFlags >:

Graphe de collaboration de PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator, writeFlags >:

Types publics
typedef Writer< OutputStream, SourceEncoding, TargetEncoding, StackAllocator, writeFlags >	Base

typedef Base::Ch	Ch

Types publics hérités de Writer< OutputStream, UTF8<>, UTF8<>, CrtAllocator, kWriteDefaultFlags >
typedef UTF8<>::Ch	Ch

Fonctions membres publiques
	PrettyWriter (OutputStream &os, StackAllocator *allocator=0, size_t levelDepth=Base::kDefaultLevelDepth)
	Constructor.

	PrettyWriter (StackAllocator *allocator=0, size_t levelDepth=Base::kDefaultLevelDepth)

PrettyWriter &	SetIndent (Ch indentChar, unsigned indentCharCount)
	Set custom indentation.

PrettyWriter &	SetFormatOptions (PrettyFormatOptions options)
	Set pretty writer formatting options.

Implementation of Handler
Voir également 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	RawNumber (const Ch *str, SizeType length, bool copy=false)

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)

Fonctions membres publiques hérités de Writer< OutputStream, UTF8<>, UTF8<>, CrtAllocator, kWriteDefaultFlags >
	Writer (OutputStream &os, CrtAllocator *stackAllocator=0, size_t levelDepth=kDefaultLevelDepth)
	Constructor.

	Writer (CrtAllocator *allocator=0, size_t levelDepth=kDefaultLevelDepth)

void	Reset (OutputStream &os)
	Reset the writer with a new stream.

bool	IsComplete () const
	Checks whether the output is a complete JSON.

int	GetMaxDecimalPlaces () const

void	SetMaxDecimalPlaces (int maxDecimalPlaces)
	Sets the maximum number of decimal places for double output.

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.

bool	RawNumber (const Ch *str, SizeType length, bool copy=false)

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 *const &str)
	Simpler but slower overload.

bool	Key (const Ch *const &str)

bool	RawValue (const Ch *json, size_t length, Type type)
	Write a raw JSON value.

void	Flush ()
	Flush the output stream.

Convenience extensions
Ch	indentChar_

unsigned	indentCharCount_

PrettyFormatOptions	formatOptions_

bool	String (const Ch *str)
	Simpler but slower overload.

bool	Key (const Ch *str)

bool	RawValue (const Ch *json, size_t length, Type type)
	Write a raw JSON value.

void	PrettyPrefix (Type type)

void	WriteIndent ()

	PrettyWriter (const PrettyWriter &)

PrettyWriter &	operator= (const PrettyWriter &)

Membres hérités additionnels
Attributs publics statiques hérités de Writer< OutputStream, UTF8<>, UTF8<>, CrtAllocator, kWriteDefaultFlags >
static const int	kDefaultMaxDecimalPlaces

static const size_t	kDefaultLevelDepth

Fonctions membres protégées hérités de Writer< OutputStream, UTF8<>, UTF8<>, CrtAllocator, kWriteDefaultFlags >
bool	WriteInt (int i)

bool	WriteUint (unsigned u)

bool	WriteInt64 (int64_t i64)

bool	WriteUint64 (uint64_t u)

bool	WriteDouble (double d)

bool	WriteInt (int i)

bool	WriteUint (unsigned u)

bool	WriteInt64 (int64_t i64)

bool	WriteUint64 (uint64_t u)

bool	WriteDouble (double d)

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	ScanWriteUnescapedString (GenericStringStream< UTF8<> > &is, size_t length)

bool	WriteStartObject ()

bool	WriteEndObject ()

bool	WriteStartArray ()

bool	WriteEndArray ()

bool	WriteRawValue (const Ch *json, size_t length)

void	Prefix (Type type)

bool	EndValue (bool ret)

OutputStream *	os_

internal::Stack< CrtAllocator >	level_stack_

int	maxDecimalPlaces_

bool	hasRoot_

Description détaillée

template<typename OutputStream, typename SourceEncoding = UTF8<>, typename TargetEncoding = UTF8<>, typename StackAllocator = CrtAllocator, unsigned writeFlags = kWriteDefaultFlags>
class PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator, writeFlags >

Writer with indentation and spacing.

Paramètres du template

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

Définition à la ligne 49 du fichier prettywriter.h.

Documentation des définitions de type membres

◆ Base

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

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

Définition à la ligne 51 du fichier prettywriter.h.

◆ Ch

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

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

Définition à la ligne 52 du fichier prettywriter.h.

Documentation des constructeurs et destructeur

◆ PrettyWriter() [1/2]

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

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

inlineexplicit

Constructor.

Paramètres

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

Définition à la ligne 59 du fichier prettywriter.h.

Référencé par SetFormatOptions(), et SetIndent().

Voici le graphe des appelants de cette fonction :

◆ PrettyWriter() [2/2]

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

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

inlineexplicit

Définition à la ligne 63 du fichier prettywriter.h.

Documentation des fonctions membres

◆ Bool()

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

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

inline

Définition à la ligne 97 du fichier prettywriter.h.

◆ Double()

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

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

inline

Définition à la ligne 102 du fichier prettywriter.h.

◆ EndArray()

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

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

inline

Définition à la ligne 164 du fichier prettywriter.h.

◆ EndObject()

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

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

inline

Définition à la ligne 138 du fichier prettywriter.h.

◆ Int()

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

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

inline

Définition à la ligne 98 du fichier prettywriter.h.

◆ Int64()

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

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

inline

Définition à la ligne 100 du fichier prettywriter.h.

◆ Key() [1/2]

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

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

inline

Définition à la ligne 189 du fichier prettywriter.h.

◆ Key() [2/2]

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

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

inline

Définition à la ligne 130 du fichier prettywriter.h.

◆ Null()

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

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

inline

Définition à la ligne 96 du fichier prettywriter.h.

◆ PrettyPrefix()

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

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

inlineprotected

Définition à la ligne 209 du fichier prettywriter.h.

◆ RawNumber()

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

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

inline

Définition à la ligne 104 du fichier prettywriter.h.

◆ RawValue()

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

bool PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator, writeFlags >::RawValue	(	const Ch *	json,
		size_t	length,
		Type	type )

inline

Write a raw JSON value.

For user to write a stringified JSON as a value.

Paramètres

json	A well-formed JSON value. It should not contain null character within [0, length - 1] range.
length	Length of the json.
type	Type of the root of json.

Note: When using PrettyWriter::RawValue(), the result json may not be indented correctly.

Définition à la ligne 202 du fichier prettywriter.h.

Références RAPIDJSON_ASSERT.

◆ SetFormatOptions()

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

PrettyWriter & PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator, writeFlags >::SetFormatOptions ( PrettyFormatOptions options )

inline

Set pretty writer formatting options.

Paramètres

options Formatting options.

Définition à la ligne 86 du fichier prettywriter.h.

Références PrettyWriter().

Voici le graphe d'appel pour cette fonction :

◆ SetIndent()

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

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

inline

Set custom indentation.

Paramètres

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.

Définition à la ligne 76 du fichier prettywriter.h.

Références PrettyWriter(), et RAPIDJSON_ASSERT.

Voici le graphe d'appel pour cette fonction :

◆ StartArray()

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

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

inline

Définition à la ligne 158 du fichier prettywriter.h.

◆ StartObject()

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

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

inline

Définition à la ligne 124 du fichier prettywriter.h.

◆ String() [1/2]

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

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

inline

Simpler but slower overload.

Définition à la ligne 188 du fichier prettywriter.h.

Références String().

Référencé par String().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ String() [2/2]

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

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

inline

Définition à la ligne 111 du fichier prettywriter.h.

◆ Uint()

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

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

inline

Définition à la ligne 99 du fichier prettywriter.h.

◆ Uint64()

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

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

inline

Définition à la ligne 101 du fichier prettywriter.h.

◆ WriteIndent()

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

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

inlineprotected

Définition à la ligne 253 du fichier prettywriter.h.

Documentation des données membres

◆ formatOptions_

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

PrettyFormatOptions PrettyWriter< OutputStream, SourceEncoding, TargetEncoding, StackAllocator, writeFlags >::formatOptions_

protected

Définition à la ligne 260 du fichier prettywriter.h.

◆ indentChar_

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

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

protected

Définition à la ligne 258 du fichier prettywriter.h.

◆ indentCharCount_

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

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

protected

Définition à la ligne 259 du fichier prettywriter.h.

La documentation de cette classe a été générée à partir des fichiers suivants :

Types publics

Fonctions membres publiques

Convenience extensions

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ Base

◆ Ch

Documentation des constructeurs et destructeur

◆ PrettyWriter() [1/2]

◆ PrettyWriter() [2/2]

Documentation des fonctions membres

◆ Bool()

◆ Double()

◆ EndArray()

◆ EndObject()

◆ Int()

◆ Int64()

◆ Key() [1/2]

◆ Key() [2/2]

◆ Null()

◆ PrettyPrefix()

◆ RawNumber()

◆ RawValue()

◆ SetFormatOptions()

◆ SetIndent()

◆ StartArray()

◆ StartObject()

◆ String() [1/2]

◆ String() [2/2]

◆ Uint()

◆ Uint64()

◆ WriteIndent()

Documentation des données membres

◆ formatOptions_

◆ indentChar_

◆ indentCharCount_