Json::StyledWriter Class Reference

Writes a Value in JSON format in a human friendly way. More...

#include <json.h>

Inheritance diagram for Json::StyledWriter:

Public Member Functions
	StyledWriter ()
std::string	write (const Value &root) override
	Serialize a Value in JSON format. More...
	~StyledWriter () override
Public Member Functions inherited from Json::Writer
virtual	~Writer ()

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::string	document_
int	indentSize_
std::string	indentString_
int	rightMargin_

Detailed Description

Writes a Value in JSON format in a human friendly way.

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.

See also

Reader, Value, Value::setComment()

Deprecated:

Use StreamWriterBuilder.

Definition at line 1876 of file json.h.

Member Typedef Documentation

ChildValues

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

private

Definition at line 1902 of file json.h.

Constructor & Destructor Documentation

StyledWriter()

Json::StyledWriter::StyledWriter

(

)

Definition at line 4361 of file jsoncpp.cpp.

~StyledWriter()

Json::StyledWriter::~StyledWriter ( )

inlineoverride

Definition at line 1879 of file json.h.

Member Function Documentation

hasCommentForValue()

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

private

Definition at line 4565 of file jsoncpp.cpp.

indent()

void Json::StyledWriter::indent ( )

private

Definition at line 4527 of file jsoncpp.cpp.

isMultineArray()

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

private

Definition at line 4477 of file jsoncpp.cpp.

normalizeEOL()

static std::string Json::StyledWriter::normalizeEOL ( const std::string &  text )

staticprivate

pushValue()

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

private

Definition at line 4504 of file jsoncpp.cpp.

unindent()

void Json::StyledWriter::unindent ( )

private

Definition at line 4529 of file jsoncpp.cpp.

write()

std::string Json::StyledWriter::write ( const Value &  root )

overridevirtual

Serialize a Value in JSON format.

Parameters

root	Value to serialize.

Returns

String containing the JSON document that represents the root value.

Implements Json::Writer.

Definition at line 4364 of file jsoncpp.cpp.

writeArrayValue()

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

private

Definition at line 4434 of file jsoncpp.cpp.

writeCommentAfterValueOnSameLine()

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

private

Definition at line 4554 of file jsoncpp.cpp.

writeCommentBeforeValue()

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

private

Definition at line 4534 of file jsoncpp.cpp.

writeIndent()

void Json::StyledWriter::writeIndent ( )

private

Definition at line 4511 of file jsoncpp.cpp.

writeValue()

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

private

Definition at line 4375 of file jsoncpp.cpp.

writeWithIndent()

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

private

Definition at line 4522 of file jsoncpp.cpp.

Member Data Documentation

addChildValues_

bool Json::StyledWriter::addChildValues_

private

Definition at line 1909 of file json.h.

childValues_

ChildValues Json::StyledWriter::childValues_

private

Definition at line 1904 of file json.h.

document_

std::string Json::StyledWriter::document_

private

Definition at line 1905 of file json.h.

indentSize_

int Json::StyledWriter::indentSize_

private

Definition at line 1908 of file json.h.

indentString_

std::string Json::StyledWriter::indentString_

private

Definition at line 1906 of file json.h.

rightMargin_

int Json::StyledWriter::rightMargin_

private

Definition at line 1907 of file json.h.

---

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

• json.h
• jsoncpp.cpp