CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes
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 <writer.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:

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

Parameters
indentationEach level will be indented by this amount extra.
See Also
Reader, Value, Value::setComment()

Definition at line 122 of file writer.h.

Member Typedef Documentation

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

Definition at line 150 of file writer.h.

Constructor & Destructor Documentation

Json::StyledStreamWriter::StyledStreamWriter ( std::string  indentation = "\t")
Json::StyledStreamWriter::~StyledStreamWriter ( )
inline

Definition at line 126 of file writer.h.

126 {}

Member Function Documentation

bool Json::StyledStreamWriter::hasCommentForValue ( const Value value)
private
void Json::StyledStreamWriter::indent ( )
private
bool Json::StyledStreamWriter::isMultineArray ( const Value value)
private
static std::string Json::StyledStreamWriter::normalizeEOL ( const std::string &  text)
staticprivate
void Json::StyledStreamWriter::pushValue ( const std::string &  value)
private
void Json::StyledStreamWriter::unindent ( )
private
void Json::StyledStreamWriter::write ( std::ostream &  out,
const Value root 
)

Serialize a Value in JSON format.

Parameters
outStream to write to. (Can be ostringstream, e.g.)
rootValue to serialize.
Note
There is no point in deriving from Writer, since write() should not return a value.

Referenced by pkg.AbstractPkg::generate().

void Json::StyledStreamWriter::writeArrayValue ( const Value value)
private
void Json::StyledStreamWriter::writeCommentAfterValueOnSameLine ( const Value root)
private
void Json::StyledStreamWriter::writeCommentBeforeValue ( const Value root)
private
void Json::StyledStreamWriter::writeIndent ( )
private
void Json::StyledStreamWriter::writeValue ( const Value value)
private
void Json::StyledStreamWriter::writeWithIndent ( const std::string &  value)
private

Member Data Documentation

bool Json::StyledStreamWriter::addChildValues_
private

Definition at line 157 of file writer.h.

ChildValues Json::StyledStreamWriter::childValues_
private

Definition at line 152 of file writer.h.

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

Definition at line 153 of file writer.h.

std::string Json::StyledStreamWriter::indentation_
private

Definition at line 156 of file writer.h.

std::string Json::StyledStreamWriter::indentString_
private

Definition at line 154 of file writer.h.

int Json::StyledStreamWriter::rightMargin_
private

Definition at line 155 of file writer.h.