A Value is an JSON value of unknown type. More...

#include "llvm/Support/JSON.h"

Public Types
enum	Kind { Null, Boolean, Number, String, Array, Object }

Public Member Functions
	Value (const Value &M)

	Value (Value &&M)

	Value (std::initializer_list< Value > Elements)

	Value (json::Array &&Elements)

template<typename Elt >
	Value (const std::vector< Elt > &C)

	Value (json::Object &&Properties)

template<typename Elt >
	Value (const std::map< std::string, Elt > &C)

	Value (std::string V)

	Value (const llvm::SmallVectorImpl< char > &V)

	Value (const llvm::formatv_object_base &V)

	Value (StringRef V)

	Value (const char *V)

	Value (std::nullptr_t)

template<typename T , typename = typename std::enable_if<std::is_same<T, bool>::value>::type, bool = false>
	Value (T B)

template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type, typename = typename std::enable_if<!std::is_same<T, bool>::value>::type>
	Value (T I)

template<typename T , typename = typename std::enable_if<std::is_floating_point<T>::value>::type, double * = nullptr>
	Value (T D)

template<typename T , typename = typename std::enable_if<std::is_same< Value, decltype(toJSON((const T )nullptr))>::value>, Value * = nullptr>
	Value (const T &V)

Value &	operator= (const Value &M)

Value &	operator= (Value &&M)

	~Value ()

Kind	kind () const

llvm::Optional< std::nullptr_t >	getAsNull () const

llvm::Optional< bool >	getAsBoolean () const

llvm::Optional< double >	getAsNumber () const

llvm::Optional< int64_t >	getAsInteger () const

llvm::Optional< llvm::StringRef >	getAsString () const

const json::Object *	getAsObject () const

json::Object *	getAsObject ()

const json::Array *	getAsArray () const

json::Array *	getAsArray ()

Friends
class	Array

class	Object

struct	llvm::format_provider< llvm::json::Value >

llvm::raw_ostream &	operator<< (llvm::raw_ostream &, const Value &)
	Serializes this Value to JSON, writing it to the provided stream. More...

bool	operator== (const Value &, const Value &)

Detailed Description

A Value is an JSON value of unknown type.

They can be copied, but should generally be moved.

=== Composing values ===

You can implicitly construct Values from:

strings: std::string, SmallString, formatv, StringRef, char* (char*, and StringRef are references, not copies!)
numbers
booleans
null: nullptr
arrays: {"foo", 42.0, false}
serializable things: types with toJSON(const T&)->Value, found by ADL

They can also be constructed from object/array helpers:

json::Object is a type like map<ObjectKey, Value>
json::Array is a type like vector<Value> These can be list-initialized, or used to build up collections in a loop. json::ary(Collection) converts all items in a collection to Values.

=== Inspecting values ===

Each Value is one of the JSON kinds: null (nullptr_t) boolean (bool) number (double or int64) string (StringRef) array (json::Array) object (json::Object)

The kind can be queried directly, or implicitly via the typed accessors: if (Optional<StringRef> S = E.getAsString() assert(E.kind() == Value::String);

Array and Object also have typed indexing accessors for easy traversal: Expected<Value> E = parse(R"( {"options": {"font": "sans-serif"}} )"); if (Object* O = E->getAsObject()) if (Object* Opts = O->getObject("options")) if (Optional<StringRef> Font = Opts->getString("font")) assert(Opts->at("font").kind() == Value::String);

=== Converting JSON values to C++ types ===

The convention is to have a deserializer function findable via ADL: fromJSON(const json::Value&, T&)->bool Deserializers are provided for:

bool
int and int64_t
double
std::string
vector<T>, where T is deserializable
map<string, T>, where T is deserializable
Optional<T>, where T is deserializable ObjectMapper can help writing fromJSON() functions for object types.

For conversion in the other direction, the serializer function is: toJSON(const T&) -> json::Value If this exists, then it also allows constructing Value from T, and can be used to serialize vector<T>, map<string, T>, and Optional<T>.

=== Serialization ===

Values can be serialized to JSON: 1) raw_ostream << Value // Basic formatting. 2) raw_ostream << formatv("{0}", Value) // Basic formatting. 3) raw_ostream << formatv("{0:2}", Value) // Pretty-print with indent 2.

And parsed: Expected<Value> E = json::parse("[1, 2, null]"); assert(E && E->kind() == Value::Array);

Definition at line 277 of file JSON.h.

Member Enumeration Documentation

◆ Kind

enum llvm::json::Value::Kind

Enumerator
Null
Boolean
Number	Number values can store both int64s and doubles at full precision, depending on what they were constructed/parsed from.
String
Array
Object

Definition at line 279 of file JSON.h.

Constructor & Destructor Documentation

◆ Value() [1/17]

llvm::json::Value::Value ( const Value & M )

inline

Definition at line 291 of file JSON.h.

◆ Value() [2/17]

llvm::json::Value::Value ( Value && M )

inline

Definition at line 292 of file JSON.h.

◆ Value() [3/17]

llvm::json::Value::Value ( std::initializer_list< Value > Elements )

Definition at line 100 of file JSON.cpp.

References Array, llvm::Intrinsic::memcpy, and Object.

◆ Value() [4/17]

llvm::json::Value::Value ( json::Array && Elements )

inline

Definition at line 294 of file JSON.h.

◆ Value() [5/17]

template<typename Elt >

llvm::json::Value::Value ( const std::vector< Elt > & C )

inline

Definition at line 298 of file JSON.h.

◆ Value() [6/17]

llvm::json::Value::Value ( json::Object && Properties )

inline

Definition at line 299 of file JSON.h.

◆ Value() [7/17]

template<typename Elt >

llvm::json::Value::Value ( const std::map< std::string, Elt > & C )

inline

Definition at line 303 of file JSON.h.

◆ Value() [8/17]

llvm::json::Value::Value ( std::string V )

inline

Definition at line 305 of file JSON.h.

References assert(), llvm::json::fixUTF8(), llvm::json::isUTF8(), and LLVM_UNLIKELY.

◆ Value() [9/17]

llvm::json::Value::Value ( const llvm::SmallVectorImpl< char > & V )

inline

Definition at line 312 of file JSON.h.

◆ Value() [10/17]

llvm::json::Value::Value ( const llvm::formatv_object_base & V )

inline

Definition at line 314 of file JSON.h.

◆ Value() [11/17]

llvm::json::Value::Value ( StringRef V )

inline

Definition at line 316 of file JSON.h.

References assert(), llvm::json::fixUTF8(), llvm::json::isUTF8(), and LLVM_UNLIKELY.

◆ Value() [12/17]

llvm::json::Value::Value ( const char * V )

inline

Definition at line 323 of file JSON.h.

◆ Value() [13/17]

llvm::json::Value::Value ( std::nullptr_t )

inline

Definition at line 324 of file JSON.h.

References T.

◆ Value() [14/17]

template<typename T , typename = typename std::enable_if<std::is_same<T, bool>::value>::type, bool = false>

llvm::json::Value::Value ( T B )

inline

Definition at line 331 of file JSON.h.

References B, and T.

◆ Value() [15/17]

template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type, typename = typename std::enable_if<!std::is_same<T, bool>::value>::type>

llvm::json::Value::Value ( T I )

inline

Definition at line 339 of file JSON.h.

References T.

◆ Value() [16/17]

template<typename T , typename = typename std::enable_if<std::is_floating_point<T>::value>::type, double * = nullptr>

llvm::json::Value::Value ( T D )

inline

Definition at line 347 of file JSON.h.

References T, and llvm::json::toJSON().

◆ Value() [17/17]

template<typename T , typename = typename std::enable_if<std::is_same< Value, decltype(toJSON(*(const T *)nullptr))>::value>, Value * = nullptr>

llvm::json::Value::Value ( const T & V )

inline

Definition at line 355 of file JSON.h.

◆ ~Value()

llvm::json::Value::~Value ( )

inline

Definition at line 367 of file JSON.h.

Member Function Documentation

◆ getAsArray() [1/2]

const json::Array* llvm::json::Value::getAsArray ( ) const

inline

Definition at line 433 of file JSON.h.

References LLVM_LIKELY.

Referenced by llvm::json::fromJSON(), and llvm::json::operator==().

◆ getAsArray() [2/2]

json::Array* llvm::json::Value::getAsArray ( )

inline

Definition at line 436 of file JSON.h.

References LLVM_LIKELY, and llvm::json::operator<<().

◆ getAsBoolean()

llvm::Optional<bool> llvm::json::Value::getAsBoolean ( ) const

inline

Definition at line 395 of file JSON.h.

References LLVM_LIKELY, and llvm::None.

Referenced by llvm::json::fromJSON(), and llvm::json::operator==().

◆ getAsInteger()

llvm::Optional<int64_t> llvm::json::Value::getAsInteger ( ) const

inline

Definition at line 408 of file JSON.h.

References D, LLVM_LIKELY, llvm::max(), and llvm::None.

Referenced by llvm::json::fromJSON(), and llvm::json::operator==().

◆ getAsNull()

llvm::Optional<std::nullptr_t> llvm::json::Value::getAsNull ( ) const

inline

Definition at line 390 of file JSON.h.

References LLVM_LIKELY, and llvm::None.

Referenced by llvm::json::fromJSON(), and llvm::json::operator==().

◆ getAsNumber()

llvm::Optional<double> llvm::json::Value::getAsNumber ( ) const

inline

Definition at line 400 of file JSON.h.

References LLVM_LIKELY, and llvm::None.

Referenced by llvm::json::fromJSON(), and llvm::json::operator==().

◆ getAsObject() [1/2]

const json::Object* llvm::json::Value::getAsObject ( ) const

inline

Definition at line 427 of file JSON.h.

References LLVM_LIKELY.

Referenced by llvm::json::fromJSON(), and llvm::json::operator==().

◆ getAsObject() [2/2]

json::Object* llvm::json::Value::getAsObject ( )

inline

Definition at line 430 of file JSON.h.

References LLVM_LIKELY.

◆ getAsString()

llvm::Optional<llvm::StringRef> llvm::json::Value::getAsString ( ) const

inline

Definition at line 420 of file JSON.h.

References LLVM_LIKELY, and llvm::None.

Referenced by llvm::json::fromJSON(), and llvm::json::operator==().

◆ kind()

Kind llvm::json::Value::kind ( ) const

inline

Definition at line 369 of file JSON.h.

References llvm_unreachable, Number, and llvm::json::Object::Object().

Referenced by llvm::json::operator==().

◆ operator=() [1/2]

Value& llvm::json::Value::operator= ( const Value & M )

inline

Definition at line 357 of file JSON.h.

◆ operator=() [2/2]

Value& llvm::json::Value::operator= ( Value && M )

inline

Definition at line 362 of file JSON.h.

Friends And Related Function Documentation

◆ Array

friend class Array

friend

Definition at line 452 of file JSON.h.

Referenced by llvm::json::operator==(), and Value().

◆ llvm::format_provider< llvm::json::Value >

friend struct llvm::format_provider< llvm::json::Value >

friend

Definition at line 467 of file JSON.h.

◆ Object

friend class Object

friend

Definition at line 453 of file JSON.h.

Referenced by llvm::json::operator==(), and Value().

◆ operator<<

llvm::raw_ostream& operator<<	(	llvm::raw_ostream &	,
		const Value &
	)

friend

Serializes this Value to JSON, writing it to the provided stream.

The formatting is compact (no extra whitespace) and deterministic. For pretty-printing, use the formatv() format_provider below.

◆ operator==

bool operator==	(	const Value &	L,
		const Value &	R
	)

friend

Definition at line 176 of file JSON.cpp.

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

include/llvm/Support/JSON.h
lib/Support/JSON.cpp

Public Types

Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ Kind

Constructor & Destructor Documentation

◆ Value() [1/17]

◆ Value() [2/17]

◆ Value() [3/17]

◆ Value() [4/17]

◆ Value() [5/17]

◆ Value() [6/17]

◆ Value() [7/17]

◆ Value() [8/17]

◆ Value() [9/17]

◆ Value() [10/17]

◆ Value() [11/17]

◆ Value() [12/17]

◆ Value() [13/17]

◆ Value() [14/17]

◆ Value() [15/17]

◆ Value() [16/17]

◆ Value() [17/17]

◆ ~Value()

Member Function Documentation

◆ getAsArray() [1/2]

◆ getAsArray() [2/2]

◆ getAsBoolean()

◆ getAsInteger()

◆ getAsNull()

◆ getAsNumber()

◆ getAsObject() [1/2]

◆ getAsObject() [2/2]

◆ getAsString()

◆ kind()

◆ operator=() [1/2]

◆ operator=() [2/2]

Friends And Related Function Documentation

◆ Array

◆ llvm::format_provider< llvm::json::Value >

◆ Object

◆ operator<<

◆ operator==