Classes
class	Array
	An Array is a JSON array, which contains heterogeneous JSON values. More...

class	Object
	An Object is a JSON object, which maps strings to heterogenous JSON values. More...

class	ObjectKey
	ObjectKey is a used to capture keys in Object. More...

class	ObjectMapper
	Helper for mapping JSON objects onto protocol structs. More...

class	OStream
	json::OStream allows writing well-formed JSON without materializing all structures as json::Value ahead of time. More...

class	ParseError

class	Path
	A "cursor" marking a position within a Value. More...

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

Functions
bool	isUTF8 (llvm::StringRef S, size_t *ErrOffset=nullptr)
	Returns true if `S` is valid UTF-8, which is required for use as JSON.

std::string	fixUTF8 (llvm::StringRef S)
	Replaces invalid UTF-8 sequences in `S` with the replacement character (U+FFFD).

template<typename T >
Value	toJSON (const std::optional< T > &Opt)

bool	operator== (const Object &LHS, const Object &RHS)

bool	operator!= (const Object &LHS, const Object &RHS)

bool	operator!= (const Array &L, const Array &R)

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

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

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

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

bool	operator!= (const ObjectKey &L, const ObjectKey &R)

bool	operator< (const ObjectKey &L, const ObjectKey &R)

bool	fromJSON (const Value &E, std::string &Out, Path P)

bool	fromJSON (const Value &E, int &Out, Path P)

bool	fromJSON (const Value &E, int64_t &Out, Path P)

bool	fromJSON (const Value &E, double &Out, Path P)

bool	fromJSON (const Value &E, bool &Out, Path P)

bool	fromJSON (const Value &E, uint64_t &Out, Path P)

bool	fromJSON (const Value &E, std::nullptr_t &Out, Path P)

template<typename T >
bool	fromJSON (const Value &E, std::optional< T > &Out, Path P)

template<typename T >
bool	fromJSON (const Value &E, std::vector< T > &Out, Path P)

template<typename T >
bool	fromJSON (const Value &E, std::map< std::string, T > &Out, Path P)

llvm::Expected< Value >	parse (llvm::StringRef JSON)
	Parses the provided JSON source, or returns a ParseError.

template<typename T >
Expected< T >	parse (const llvm::StringRef &JSON, const char *RootName="")
	Version of parse() that converts the parsed value to the type T.

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

static void	quote (llvm::raw_ostream &OS, llvm::StringRef S)

Variables
template<typename T >
constexpr bool	is_uint_64_bit_v

Function Documentation

◆ fixUTF8()

std::string llvm::json::fixUTF8 ( llvm::StringRef S )

Replaces invalid UTF-8 sequences in S with the replacement character (U+FFFD).

The returned string is valid UTF-8. This is much slower than isUTF8, so test that first.

Definition at line 711 of file JSON.cpp.

References llvm::ConvertUTF32toUTF8(), llvm::ConvertUTF8toUTF32(), llvm::StringRef::data(), llvm::lenientConversion, llvm::StringRef::size(), and llvm::strictConversion.

Referenced by llvm::json::OStream::attributeBegin(), llvm::json::ObjectKey::ObjectKey(), and llvm::json::Value::Value().

◆ fromJSON() [1/10]

bool llvm::json::fromJSON	(	const Value &	E,
		bool &	Out,
		Path	P
	)

inline

Definition at line 748 of file JSON.h.

References E, and P.

◆ fromJSON() [2/10]

bool llvm::json::fromJSON	(	const Value &	E,
		double &	Out,
		Path	P
	)

inline

Definition at line 740 of file JSON.h.

References E, and P.

◆ fromJSON() [3/10]

bool llvm::json::fromJSON	(	const Value &	E,
		int &	Out,
		Path	P
	)

inline

Definition at line 724 of file JSON.h.

References E, and P.

◆ fromJSON() [4/10]

bool llvm::json::fromJSON	(	const Value &	E,
		int64_t &	Out,
		Path	P
	)

inline

Definition at line 732 of file JSON.h.

References E, and P.

◆ fromJSON() [5/10]

template<typename T >

bool llvm::json::fromJSON	(	const Value &	E,
		std::map< std::string, T > &	Out,
		Path	P
	)

Definition at line 798 of file JSON.h.

References E, fromJSON(), and P.

◆ fromJSON() [6/10]

bool llvm::json::fromJSON	(	const Value &	E,
		std::nullptr_t &	Out,
		Path	P
	)

inline

Definition at line 764 of file JSON.h.

References E, and P.

◆ fromJSON() [7/10]

template<typename T >

bool llvm::json::fromJSON	(	const Value &	E,
		std::optional< T > &	Out,
		Path	P
	)

Definition at line 773 of file JSON.h.

References E, fromJSON(), and P.

◆ fromJSON() [8/10]

bool llvm::json::fromJSON	(	const Value &	E,
		std::string &	Out,
		Path	P
	)

inline

Definition at line 716 of file JSON.h.

References E, and P.

Referenced by fromJSON(), llvm::json::ObjectMapper::map(), llvm::json::ObjectMapper::mapOptional(), and parse().

◆ fromJSON() [9/10]

template<typename T >

bool llvm::json::fromJSON	(	const Value &	E,
		std::vector< T > &	Out,
		Path	P
	)

Definition at line 785 of file JSON.h.

References A, E, fromJSON(), I, and P.

◆ fromJSON() [10/10]

bool llvm::json::fromJSON	(	const Value &	E,
		uint64_t &	Out,
		Path	P
	)

inline

Definition at line 756 of file JSON.h.

References E, and P.

◆ isUTF8()

bool llvm::json::isUTF8	(	llvm::StringRef	S,
		size_t *	ErrOffset = `nullptr`
	)

Returns true if S is valid UTF-8, which is required for use as JSON.

If it returns false, Offset is set to a byte offset near the first error.

Definition at line 697 of file JSON.cpp.

References llvm::StringRef::data(), llvm::Data, llvm::isLegalUTF8String(), LLVM_LIKELY, and llvm::StringRef::size().

Referenced by llvm::json::OStream::attributeBegin(), llvm::json::ObjectKey::ObjectKey(), and llvm::json::Value::Value().

◆ operator!=() [1/4]

bool llvm::json::operator!=	(	const Array &	L,
		const Array &	R
	)

inline

Definition at line 208 of file JSON.h.

◆ operator!=() [2/4]

bool llvm::json::operator!=	(	const Object &	LHS,
		const Object &	RHS
	)

inline

Definition at line 157 of file JSON.h.

References LHS, and RHS.

◆ operator!=() [3/4]

bool llvm::json::operator!=	(	const ObjectKey &	L,
		const ObjectKey &	R
	)

inline

Definition at line 611 of file JSON.h.

◆ operator!=() [4/4]

bool llvm::json::operator!=	(	const Value &	L,
		const Value &	R
	)

inline

Definition at line 517 of file JSON.h.

◆ operator<()

bool llvm::json::operator<	(	const ObjectKey &	L,
		const ObjectKey &	R
	)

inline

Definition at line 614 of file JSON.h.

◆ operator<<()

llvm::raw_ostream & llvm::json::operator<<	(	llvm::raw_ostream &	OS,
		const Value &	V
	)

inline

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.

Definition at line 1074 of file JSON.h.

References OS, and llvm::json::OStream::value().

◆ operator==() [1/4]

bool llvm::json::operator==	(	const Array &	L,
		const Array &	R
	)

inline

Definition at line 559 of file JSON.h.

◆ operator==() [2/4]

bool llvm::json::operator==	(	const Object &	LHS,
		const Object &	RHS
	)

Definition at line 87 of file JSON.cpp.

References LHS, and RHS.

◆ operator==() [3/4]

bool llvm::json::operator==	(	const ObjectKey &	L,
		const ObjectKey &	R
	)

inline

Definition at line 608 of file JSON.h.

◆ operator==() [4/4]

bool llvm::json::operator==	(	const Value &	L,
		const Value &	R
	)

Definition at line 185 of file JSON.cpp.

◆ parse() [1/2]

template<typename T >

Expected< T > llvm::json::parse	(	const llvm::StringRef &	JSON,
		const char *	RootName = `""`
	)

Version of parse() that converts the parsed value to the type T.

RootName describes the root object and is used in error messages.

Definition at line 899 of file JSON.h.

References fromJSON().

◆ parse() [2/2]

Expected< Value > llvm::json::parse ( llvm::StringRef JSON )

Parses the provided JSON source, or returns a ParseError.

The returned Value is self-contained and owns its strings (they do not refer to the original source).

Definition at line 686 of file JSON.cpp.

References E, and P.

◆ quote()

static void llvm::json::quote	(	llvm::raw_ostream &	OS,
		llvm::StringRef	S
	)

static

Definition at line 728 of file JSON.cpp.

References llvm::CallingConv::C, llvm::Lower, OS, and llvm::write_hex().

Referenced by llvm::json::OStream::attributeBegin(), and llvm::json::OStream::value().

◆ toJSON()

template<typename T >

Value llvm::json::toJSON ( const std::optional< T > & Opt )

Definition at line 812 of file JSON.h.

Variable Documentation

◆ is_uint_64_bit_v

template<typename T >

constexpr bool llvm::json::is_uint_64_bit_v

constexpr

Initial value:

=
    std::is_integral_v<T> && std::is_unsigned_v<T> &&
    sizeof(T) == sizeof(uint64_t)

Definition at line 78 of file JSON.h.

Classes

Functions

Variables

Function Documentation

◆ fixUTF8()

◆ fromJSON() [1/10]

◆ fromJSON() [2/10]

◆ fromJSON() [3/10]

◆ fromJSON() [4/10]

◆ fromJSON() [5/10]

◆ fromJSON() [6/10]

◆ fromJSON() [7/10]

◆ fromJSON() [8/10]

◆ fromJSON() [9/10]

◆ fromJSON() [10/10]

◆ isUTF8()

◆ operator!=() [1/4]

◆ operator!=() [2/4]

◆ operator!=() [3/4]

◆ operator!=() [4/4]

◆ operator<()

◆ operator<<()

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ parse() [1/2]

◆ parse() [2/2]

◆ quote()

◆ toJSON()

Variable Documentation

◆ is_uint_64_bit_v