Drizzled Public API Documentation

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...
 

Private Types

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

Private Member Functions

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

Static Private Member Functions

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

Private Attributes

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

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
indentationEach level will be indented by this amount extra.
See Also
Reader, Value, Value::setComment()

Definition at line 156 of file writer.h.

Member Function Documentation

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.

Definition at line 586 of file json_writer.cpp.

Referenced by Json::operator<<().


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