Json::StyledStreamWriter Class Reference

Writes a Value in JSON format in a human friendly way, to a stream rather than to a string. More...

#include <json.h>

Public Member Functions
	StyledStreamWriter (std::string indentation="\t")
void	write (std::ostream &out, const Value &root)
	Serialize a Value in JSON format. More...
	~StyledStreamWriter ()

Private Types
typedef std::vector< std::string >	ChildValues

Private Member Functions
bool	hasCommentForValue (const Value &value)
void	indent ()
bool	isMultineArray (const Value &value)
void	pushValue (const std::string &value)
void	unindent ()
void	writeArrayValue (const Value &value)
void	writeCommentAfterValueOnSameLine (const Value &root)
void	writeCommentBeforeValue (const Value &root)
void	writeIndent ()
void	writeValue (const Value &value)
void	writeWithIndent (const std::string &value)

Static Private Member Functions
static std::string	normalizeEOL (const std::string &text)

Private Attributes
bool	addChildValues_
ChildValues	childValues_
std::ostream *	document_
std::string	indentation_
std::string	indentString_
int	rightMargin_

Detailed Description

Writes a Value in JSON format in a human friendly way, to a stream rather than to a string.

The rules for line break and indent are as follow:

• Object value:
  • if empty then print {} without indent and line break
  • if not empty the print '{', line break & indent, print one value per line and then unindent and line break and print '}'.
• Array value:
  • if empty then print [] without indent and line break
  • if the array contains no object value, empty array or some other value types, and all the values fit on one lines, then print the array on a single line.
  • otherwise, it the values do not fit on one line, or the array contains object or non empty array, then print one value per line.

If the Value have comments then they are outputed according to their CommentPlacement.

Parameters

indentation

Each level will be indented by this amount extra.

See also

Reader, Value, Value::setComment()

Definition at line 1789 of file json.h.

Member Typedef Documentation

typedef std::vector<std::string> Json::StyledStreamWriter::ChildValues

private

Definition at line 1817 of file json.h.

Constructor & Destructor Documentation

Json::StyledStreamWriter::StyledStreamWriter

(

std::string

indentation = "\t"

)

Definition at line 3936 of file jsoncpp.cpp.

Json::StyledStreamWriter::~StyledStreamWriter ( )

inline

Definition at line 1793 of file json.h.

Member Function Documentation

bool Json::StyledStreamWriter::hasCommentForValue ( const Value &  value )

private

Definition at line 4181 of file jsoncpp.cpp.

void Json::StyledStreamWriter::indent ( )

private

Definition at line 4141 of file jsoncpp.cpp.

bool Json::StyledStreamWriter::isMultineArray ( const Value &  value )

private

Definition at line 4073 of file jsoncpp.cpp.

std::string Json::StyledStreamWriter::normalizeEOL ( const std::string &  text )

staticprivate

Definition at line 4190 of file jsoncpp.cpp.

void Json::StyledStreamWriter::pushValue ( const std::string &  value )

private

Definition at line 4104 of file jsoncpp.cpp.

void Json::StyledStreamWriter::unindent ( )

private

Definition at line 4148 of file jsoncpp.cpp.

void Json::StyledStreamWriter::write	(	std::ostream &	out,
		const Value &	root
	)

Serialize a Value in JSON format.

Parameters

out	Stream to write to. (Can be ostringstream, e.g.)
root	Value to serialize.

Note

There is no point in deriving from Writer, since write() should not return a value.

Definition at line 3945 of file jsoncpp.cpp.

void Json::StyledStreamWriter::writeArrayValue ( const Value &  value )

private

Definition at line 4020 of file jsoncpp.cpp.

void Json::StyledStreamWriter::writeCommentAfterValueOnSameLine ( const Value &  root )

private

Definition at line 4166 of file jsoncpp.cpp.

void Json::StyledStreamWriter::writeCommentBeforeValue ( const Value &  root )

private

Definition at line 4156 of file jsoncpp.cpp.

void Json::StyledStreamWriter::writeIndent ( )

private

Definition at line 4114 of file jsoncpp.cpp.

void Json::StyledStreamWriter::writeValue ( const Value &  value )

private

Definition at line 3959 of file jsoncpp.cpp.

void Json::StyledStreamWriter::writeWithIndent ( const std::string &  value )

private

Definition at line 4133 of file jsoncpp.cpp.

Member Data Documentation

bool Json::StyledStreamWriter::addChildValues_

private

Definition at line 1824 of file json.h.

ChildValues Json::StyledStreamWriter::childValues_

private

Definition at line 1819 of file json.h.

std::ostream* Json::StyledStreamWriter::document_

private

Definition at line 1820 of file json.h.

std::string Json::StyledStreamWriter::indentation_

private

Definition at line 1823 of file json.h.

std::string Json::StyledStreamWriter::indentString_

private

Definition at line 1821 of file json.h.

int Json::StyledStreamWriter::rightMargin_

private

Definition at line 1822 of file json.h.

---

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

• json.h
• jsoncpp.cpp