Drizzled Public API Documentation

Json Namespace Reference

JSON (JavaScript Object Notation). More...

Classes

class  BatchAllocator
 
class  DefaultValueAllocator
 
struct  DummyValueAllocatorInitializer
 
class  FastWriter
 Outputs a Value in JSON format without formatting (not human friendly). More...
 
class  Features
 Configuration passed to reader and writer. This configuration object can be used to force the Reader or Writer to behave in a standard conforming way. More...
 
class  Path
 Experimental and untested: represents a "path" to access a node. More...
 
class  PathArgument
 Experimental and untested: represents an element of the "path" to access a node. More...
 
class  Reader
 Unserialize a JSON document into a Value. More...
 
class  StaticString
 Lightweight wrapper to tag static string. More...
 
class  StyledStreamWriter
 Writes a Value in JSON format in a human friendly way, to a stream rather than to a string. More...
 
class  StyledWriter
 Writes a Value in JSON format in a human friendly way. More...
 
class  Value
 Represents a JSON value. More...
 
class  ValueAllocator
 Experimental do not use: Allocator to customize member name and string value memory management done by Value. More...
 
class  ValueConstIterator
 const iterator for object and array value. More...
 
class  ValueIterator
 Iterator for object and array value. More...
 
class  ValueIteratorBase
 base class for Value iterators. More...
 
class  Writer
 Abstract class for writers. More...
 

Typedefs

typedef int Int
 
typedef unsigned int UInt
 

Enumerations

enum  ValueType {
  nullValue = 0, intValue, uintValue, realValue,
  stringValue, booleanValue, arrayValue, objectValue
}
 Type of the value held by a Value object. More...
 
enum  CommentPlacement { commentBefore = 0, commentAfterOnSameLine, commentAfter, numberOfCommentPlacement }
 

Functions

static bool in (Reader::Char c, Reader::Char c1, Reader::Char c2, Reader::Char c3, Reader::Char c4)
 
static bool in (Reader::Char c, Reader::Char c1, Reader::Char c2, Reader::Char c3, Reader::Char c4, Reader::Char c5)
 
static bool containsNewLine (Reader::Location begin, Reader::Location end)
 
static std::string codePointToUTF8 (unsigned int cp)
 
std::istream & operator>> (std::istream &, Value &)
 Read from 'sin' into 'root'. More...
 
static ValueAllocator *& valueAllocator ()
 
static bool isControlCharacter (char ch)
 
static bool containsControlCharacter (const char *str)
 
static void uintToString (unsigned int value, char *&current)
 
std::string valueToString (Int value)
 
std::string valueToString (UInt value)
 
std::string valueToString (double value)
 
std::string valueToString (bool value)
 
std::string valueToQuotedString (const char *value)
 
std::ostream & operator<< (std::ostream &, const Value &root)
 Output using the StyledStreamWriter. More...
 

Variables

static struct Json::DummyValueAllocatorInitializer dummyValueAllocatorInitializer
 

Detailed Description

JSON (JavaScript Object Notation).

Enumeration Type Documentation

Enumerator
commentBefore 

a comment placed on the line before a value

commentAfterOnSameLine 

a comment just after a value on the same line

commentAfter 

a comment on the line after a value (only make sense for root value)

Definition at line 73 of file value.h.

Type of the value held by a Value object.

Enumerator
nullValue 

'null' value

intValue 

signed integer value

uintValue 

unsigned integer value

realValue 

double value

stringValue 

UTF-8 string value.

booleanValue 

bool value

arrayValue 

array value (ordered list)

objectValue 

object value (collection of name/value pairs).

Definition at line 61 of file value.h.

Function Documentation

std::ostream & Json::operator<< ( std::ostream &  ,
const Value root 
)

Output using the StyledStreamWriter.

See also
Json::operator>>()

Definition at line 854 of file json_writer.cpp.

References Json::StyledStreamWriter::write().

std::istream & Json::operator>> ( std::istream &  ,
Value  
)

Read from 'sin' into 'root'.

Always keep comments from the input JSON.

This can be used to read a file into a particular sub-object. For example:

cin >> root["dir"]["file"];
cout << root;

Result:

  {
"dir": {
    "file": {
  // The input stream JSON would be nested here.
    }
}
  }
Exceptions
std::exceptionon parse error.
See also
Json::operator<<()

Definition at line 911 of file json_reader.cpp.

References Json::Reader::getFormatedErrorMessages(), and Json::Reader::parse().