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

JSON (JavaScript Object Notation). More...

Classes

struct  BuiltStyledStreamWriter
 
class  CharReader
 
class  CharReaderBuilder
 Build a CharReader implementation. More...
 
struct  CommentStyle
 Scoped enums are not available until C++11. More...
 
class  Exception
 
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  LogicError
 
class  OurCharReader
 
class  OurFeatures
 
class  OurReader
 
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  RuntimeError
 
class  StaticString
 Lightweight wrapper to tag static string. More...
 
class  StreamWriter
 
class  StreamWriterBuilder
 Build a StreamWriter implementation. 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  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 unsigned int ArrayIndex
 
typedef std::auto_ptr< CharReaderCharReaderPtr
 
typedef int Int
 
typedef long long int Int64
 
typedef Int64 LargestInt
 
typedef UInt64 LargestUInt
 
typedef std::auto_ptr
< StreamWriter
StreamWriterPtr
 
typedef unsigned int UInt
 
typedef unsigned long long int UInt64
 
typedef char UIntToStringBuffer [uintToStringBufferSize]
 

Enumerations

enum  { uintToStringBufferSize = 3 * sizeof(LargestUInt) + 1 }
 
enum  CommentPlacement { commentBefore = 0, commentAfterOnSameLine, commentAfter, numberOfCommentPlacement }
 
enum  ValueType {
  nullValue = 0, intValue, uintValue, realValue,
  stringValue, booleanValue, arrayValue, objectValue
}
 Type of the value held by a Value object. More...
 

Functions

static const unsigned char ALIGNAS (8) kNull[sizeof(Value)]
 
static std::string codePointToUTF8 (unsigned int cp)
 Converts a unicode code-point to UTF-8. More...
 
static bool containsControlCharacter (const char *str)
 
static bool containsControlCharacter0 (const char *str, unsigned len)
 
static bool containsNewLine (Reader::Location begin, Reader::Location end)
 
static void decodePrefixedString (bool isPrefixed, char const *prefixed, unsigned *length, char const **value)
 
static char * duplicateAndPrefixStringValue (const char *value, unsigned int length)
 
static char * duplicateStringValue (const char *value, size_t length)
 
static void fixNumericLocale (char *begin, char *end)
 
static void getValidReaderKeys (std::set< std::string > *valid_keys)
 
static void getValidWriterKeys (std::set< std::string > *valid_keys)
 
template<typename T , typename U >
static bool InRange (double d, T min, U max)
 
static bool isControlCharacter (char ch)
 Returns true if ch is a control character (in range [0,32[). More...
 
static bool IsIntegral (double d)
 
static std::string normalizeEOL (Reader::Location begin, Reader::Location end)
 
JSON_API std::ostream & operator<< (std::ostream &, const Value &root)
 Output using the StyledStreamWriter. More...
 
JSON_API std::istream & operator>> (std::istream &, Value &)
 Read from 'sin' into 'root'. More...
 
bool JSON_API parseFromStream (CharReader::Factory const &, std::istream &, Value *root, std::string *errs)
 
static void releaseStringValue (char *value)
 
static char const * strnpbrk (char const *s, char const *accept, size_t n)
 
void throwLogicError (std::string const &msg)
 used internally More...
 
void throwRuntimeError (std::string const &msg)
 used internally More...
 
static void uintToString (LargestUInt value, char *&current)
 
std::string JSON_API valueToQuotedString (const char *value)
 
static std::string valueToQuotedStringN (const char *value, unsigned length)
 
std::string JSON_API valueToString (Int value)
 
std::string JSON_API valueToString (UInt value)
 
std::string JSON_API valueToString (LargestInt value)
 
std::string JSON_API valueToString (LargestUInt value)
 
std::string JSON_API valueToString (double value)
 
std::string JSON_API valueToString (bool value)
 
std::string JSON_API writeString (StreamWriter::Factory const &factory, Value const &root)
 Write into stringstream, then return string, for convenience. A StreamWriter will be created from the factory, used, and then deleted. More...
 

Variables

class JSON_API Exception
 
const unsigned char & kNullRef = kNull[0]
 
class JSON_API LogicError
 
static const double maxUInt64AsDouble = 18446744073709551615.0
 
class JSON_API RuntimeError
 

Detailed Description

JSON (JavaScript Object Notation).

Typedef Documentation

typedef unsigned int Json::ArrayIndex

Definition at line 231 of file json-forwards.h.

typedef std::auto_ptr<CharReader> Json::CharReaderPtr

Definition at line 225 of file jsoncpp.cpp.

typedef int Json::Int

Definition at line 173 of file json-forwards.h.

typedef long long int Json::Int64

Definition at line 185 of file json-forwards.h.

Definition at line 188 of file json-forwards.h.

Definition at line 189 of file json-forwards.h.

typedef std::auto_ptr<StreamWriter> Json::StreamWriterPtr

Definition at line 3988 of file jsoncpp.cpp.

typedef unsigned int Json::UInt

Definition at line 174 of file json-forwards.h.

typedef unsigned long long int Json::UInt64

Definition at line 186 of file json-forwards.h.

typedef char Json::UIntToStringBuffer[uintToStringBufferSize]

Definition at line 142 of file jsoncpp.cpp.

Enumeration Type Documentation

anonymous enum
Enumerator
uintToStringBufferSize 

Constant that specify the size of the buffer that must be passed to uintToString.

Definition at line 135 of file jsoncpp.cpp.

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

numberOfCommentPlacement 

root value)

Definition at line 431 of file json.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 420 of file json.h.

Function Documentation

static const unsigned char Json::ALIGNAS ( )
static
static std::string Json::codePointToUTF8 ( unsigned int  cp)
inlinestatic

Converts a unicode code-point to UTF-8.

Definition at line 104 of file jsoncpp.cpp.

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

Definition at line 3991 of file jsoncpp.cpp.

static bool Json::containsControlCharacter0 ( const char *  str,
unsigned  len 
)
static

Definition at line 3999 of file jsoncpp.cpp.

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

Definition at line 249 of file jsoncpp.cpp.

static void Json::decodePrefixedString ( bool  isPrefixed,
char const *  prefixed,
unsigned *  length,
char const **  value 
)
inlinestatic

Definition at line 2501 of file jsoncpp.cpp.

static char* Json::duplicateAndPrefixStringValue ( const char *  value,
unsigned int  length 
)
inlinestatic

Definition at line 2480 of file jsoncpp.cpp.

static char* Json::duplicateStringValue ( const char *  value,
size_t  length 
)
inlinestatic

Duplicates the specified string value.

Parameters
valuePointer to the string to duplicate. Must be zero-terminated if length is "unknown".
lengthLength of the value. if equals to unknown, then it will be computed using strlen(value).
Returns
Pointer on the duplicate instance of string.

Definition at line 2460 of file jsoncpp.cpp.

static void Json::fixNumericLocale ( char *  begin,
char *  end 
)
inlinestatic

Change ',' to '.' everywhere in buffer.

We had a sophisticated way, but it did not work in WinCE.

See Also
https://github.com/open-source-parsers/jsoncpp/pull/9

Definition at line 162 of file jsoncpp.cpp.

static void Json::getValidReaderKeys ( std::set< std::string > *  valid_keys)
static

Definition at line 2094 of file jsoncpp.cpp.

static void Json::getValidWriterKeys ( std::set< std::string > *  valid_keys)
static

Definition at line 5059 of file jsoncpp.cpp.

template<typename T , typename U >
static bool Json::InRange ( double  d,
min,
max 
)
inlinestatic

Definition at line 2435 of file jsoncpp.cpp.

static bool Json::isControlCharacter ( char  ch)
inlinestatic

Returns true if ch is a control character (in range [0,32[).

Definition at line 133 of file jsoncpp.cpp.

static bool Json::IsIntegral ( double  d)
static

Definition at line 3591 of file jsoncpp.cpp.

static std::string Json::normalizeEOL ( Reader::Location  begin,
Reader::Location  end 
)
static

Definition at line 541 of file jsoncpp.cpp.

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

Output using the StyledStreamWriter.

See Also
Json::operator>>()

Definition at line 5106 of file jsoncpp.cpp.

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 2174 of file jsoncpp.cpp.

bool Json::parseFromStream ( CharReader::Factory const &  fact,
std::istream &  sin,
Value *  root,
std::string *  errs 
)

Consume entire stream and use its begin/end. Someday we might have a real StreamReader, but for now this is convenient.

Definition at line 2160 of file jsoncpp.cpp.

static void Json::releaseStringValue ( char *  value)
inlinestatic

Free the string duplicated by duplicateStringValue()/duplicateAndPrefixStringValue().

Definition at line 2515 of file jsoncpp.cpp.

static char const* Json::strnpbrk ( char const *  s,
char const *  accept,
size_t  n 
)
static

Definition at line 4144 of file jsoncpp.cpp.

void Json::throwLogicError ( std::string const &  msg)

used internally

Definition at line 2569 of file jsoncpp.cpp.

void Json::throwRuntimeError ( std::string const &  msg)

used internally

Definition at line 2565 of file jsoncpp.cpp.

static void Json::uintToString ( LargestUInt  value,
char *&  current 
)
inlinestatic

Converts an unsigned integer to string.

Parameters
valueUnsigned interger to convert to string
currentInput/Output string buffer. Must have at least uintToStringBufferSize chars free.

Definition at line 149 of file jsoncpp.cpp.

std::string Json::valueToQuotedString ( const char *  value)

Definition at line 4081 of file jsoncpp.cpp.

static std::string Json::valueToQuotedStringN ( const char *  value,
unsigned  length 
)
static

Definition at line 4158 of file jsoncpp.cpp.

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

Definition at line 4032 of file jsoncpp.cpp.

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

Definition at line 4036 of file jsoncpp.cpp.

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

Definition at line 4009 of file jsoncpp.cpp.

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

Definition at line 4022 of file jsoncpp.cpp.

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

Definition at line 4042 of file jsoncpp.cpp.

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

Definition at line 4079 of file jsoncpp.cpp.

std::string Json::writeString ( StreamWriter::Factory const &  factory,
Value const &  root 
)

Write into stringstream, then return string, for convenience. A StreamWriter will be created from the factory, used, and then deleted.

Definition at line 5099 of file jsoncpp.cpp.

Variable Documentation

Base class for all exceptions we throw.

We use nothing but these internally. Of course, STL can throw others.

Definition at line 397 of file json.h.

const unsigned char& Json::kNullRef = kNull[0]

Definition at line 2413 of file jsoncpp.cpp.

Exceptions thrown by JSON_ASSERT/JSON_FAIL macros.

These are precondition-violations (user bugs) and internal errors (our bugs).

Remarks
derived from Json::Exception

Definition at line 411 of file json.h.

const double Json::maxUInt64AsDouble = 18446744073709551615.0
static

Definition at line 2427 of file jsoncpp.cpp.

Exceptions which the user cannot easily avoid.

E.g. out-of-memory (when we use malloc), stack-overflow, malicious input

Remarks
derived from Json::Exception

Definition at line 404 of file json.h.



mission_planning
Author(s): ivan
autogenerated on Thu Nov 12 2015 19:08:20