JsonCpp project page JsonCpp home page

Classes | Typedefs | Enumerations | Functions | Variables
Json Namespace Reference

JSON (JavaScript Object Notation). More...

Classes

class  Features
 Configuration passed to reader and writer. More...
 
class  Reader
 Unserialize a JSON document into a Value. More...
 
class  StaticString
 Lightweight wrapper to tag static string. More...
 
class  Value
 Represents a JSON value. More...
 
class  PathArgument
 Experimental and untested: represents an element of the "path" to access a node. More...
 
class  Path
 Experimental and untested: represents a "path" to access a node. More...
 
class  ValueAllocator
 Experimental do not use: Allocator to customize member name and string value memory management done by Value. More...
 
class  ValueMapAllocator
 Allocator to customize Value internal map. More...
 
class  ValueInternalLink
 ValueInternalMap hash-map bucket chain link (for internal use only). More...
 
class  ValueInternalMap
 A linked page based hash-table implementation used internally by Value. More...
 
class  ValueInternalArray
 A simplified deque implementation used internally by Value. More...
 
class  ValueArrayAllocator
 Experimental: do not use. More...
 
class  ValueIteratorBase
 base class for Value iterators. More...
 
class  ValueConstIterator
 const iterator for object and array value. More...
 
class  ValueIterator
 Iterator for object and array value. More...
 
class  Writer
 Abstract class for writers. More...
 
class  FastWriter
 Outputs a Value in JSON format without formatting (not human friendly). More...
 
class  StyledWriter
 Writes a Value in JSON format in a human friendly way. More...
 
class  StyledStreamWriter
 Writes a Value in JSON format in a human friendly way, to a stream rather than to a string. 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

std::istream & operator>> (std::istream &, Value &)
 Read from 'sin' into 'root'.
 
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.
 
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)
 
static ValueAllocator *& valueAllocator ()
 
static ValueArrayAllocator *& arrayAllocator ()
 
static ValueMapAllocator *& mapAllocator ()
 
static bool isControlCharacter (char ch)
 
static bool containsControlCharacter (const char *str)
 
static void uintToString (unsigned int value, char *&current)
 

Variables

static struct
Json::DummyValueAllocatorInitializer 
dummyValueAllocatorInitializer
 
static struct
Json::DummyArrayAllocatorInitializer 
dummyArrayAllocatorInitializer
 
static struct
Json::DummyMapAllocatorInitializer 
dummyMapAllocatorInitializer
 

Detailed Description

JSON (JavaScript Object Notation).

Typedef Documentation

typedef int Json::Int

Definition at line 16 of file forwards.h.

typedef unsigned int Json::UInt

Definition at line 20 of file forwards.h.

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)

numberOfCommentPlacement 

Definition at line 35 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 23 of file value.h.

Function Documentation

static ValueArrayAllocator*& Json::arrayAllocator ( )
static
static std::string Json::codePointToUTF8 ( unsigned int  cp)
static

Definition at line 69 of file json_reader.cpp.

static bool Json::containsControlCharacter ( const char *  str)
static

Definition at line 21 of file json_writer.cpp.

References isControlCharacter().

Referenced by valueToQuotedString().

+ Here is the caller graph for this function:

static bool Json::containsNewLine ( Reader::Location  begin,
Reader::Location  end 
)
static

Definition at line 60 of file json_reader.cpp.

static bool Json::in ( Reader::Char  c,
Reader::Char  c1,
Reader::Char  c2,
Reader::Char  c3,
Reader::Char  c4 
)
inlinestatic

Definition at line 47 of file json_reader.cpp.

Referenced by Json::Path::Path().

+ Here is the caller graph for this function:

static bool Json::in ( Reader::Char  c,
Reader::Char  c1,
Reader::Char  c2,
Reader::Char  c3,
Reader::Char  c4,
Reader::Char  c5 
)
inlinestatic

Definition at line 53 of file json_reader.cpp.

static bool Json::isControlCharacter ( char  ch)
static

Definition at line 16 of file json_writer.cpp.

Referenced by containsControlCharacter(), and valueToQuotedString().

+ Here is the caller graph for this function:

static ValueMapAllocator*& Json::mapAllocator ( )
static
std::ostream & Json::operator<< ( std::ostream &  sout,
const Value &  root 
)

Output using the StyledStreamWriter.

See Also
Json::operator>>()

Definition at line 821 of file json_writer.cpp.

References Json::StyledStreamWriter::write().

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

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 875 of file json_reader.cpp.

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

static void Json::uintToString ( unsigned int  value,
char *&  current 
)
static

Definition at line 30 of file json_writer.cpp.

Referenced by valueToString().

+ Here is the caller graph for this function:

static ValueAllocator*& Json::valueAllocator ( )
static
std::string Json::valueToQuotedString ( const char *  value)

Definition at line 111 of file json_writer.cpp.

References containsControlCharacter(), and isControlCharacter().

std::string Json::valueToString ( Int  value)

Definition at line 42 of file json_writer.cpp.

References uintToString().

std::string Json::valueToString ( UInt  value)

Definition at line 57 of file json_writer.cpp.

References uintToString().

std::string Json::valueToString ( double  value)

Definition at line 66 of file json_writer.cpp.

std::string Json::valueToString ( bool  value)

Definition at line 106 of file json_writer.cpp.

Variable Documentation

struct Json::DummyArrayAllocatorInitializer Json::dummyArrayAllocatorInitializer
static
struct Json::DummyMapAllocatorInitializer Json::dummyMapAllocatorInitializer
static
struct Json::DummyValueAllocatorInitializer Json::dummyValueAllocatorInitializer
static

SourceForge Logo hosts this site. Send comments to:
Json-cpp Developers