JSONSerializers.h File Reference

Standard JSONSerializer and JSONDeserializer functions for C struct fields. More...

#include <stddef.h>
#include <stdint.h>
#include <Objectively/Array.h>
#include <Objectively/Date.h>
#include <Objectively/Dictionary.h>
#include <Objectively/Set.h>
#include <Objectively/Object.h>
#include <Objectively/URL.h>

Go to the source code of this file.

Data Structures
struct	JSONArrayProperties
	Describes the JSON binding for an inline array field of a C struct. More...
struct	JSONProperties
	Describes the JSON binding for all fields of a C struct. More...
struct	JSONProperty
	Describes the JSON binding strategy for a single field of a C struct. More...

Macros
#define	JSONArrayProperties_NoCount   ((ptrdiff_t) -1)
	Sentinel for JSONArrayProperties::count indicating no sibling count field.
#define	MakeJSONArrayProperties(properties, capacity, count)    &(JSONArrayProperties){ .properties = (properties), .capacity = (capacity), .count = (count) }
	Creates a pointer to a JSONArrayProperties compound literal.
#define	MakeJSONProperties(Struct, ...)
	Creates a JSONProperties descriptor for a C struct type.
#define	MakeJSONProperty(Struct, field, serializer_, deserializer_, data_)
	Creates a JSONProperty for a named field of a struct, deriving offset automatically.

Typedefs
typedef bool(*	JSONDeserializer) (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON value into a C struct field.
typedef ident(*	JSONSerializer) (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a C struct field to an Objectively Object.

Functions
OBJECTIVELY_EXPORT bool	JSONDeserializeArray (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON array into an inline array field.
OBJECTIVELY_EXPORT bool	JSONDeserializeBoole (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON boolean into a bool field.
OBJECTIVELY_EXPORT bool	JSONDeserializeCharacters (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON string into a fixed-size char[] field.
OBJECTIVELY_EXPORT bool	JSONDeserializeCString (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON string into a heap-allocated char * field.
OBJECTIVELY_EXPORT bool	JSONDeserializeDate (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON string into a Date * field (ISO 8601 by default).
OBJECTIVELY_EXPORT bool	JSONDeserializeDictionary (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON object into a Dictionary * field.
OBJECTIVELY_EXPORT bool	JSONDeserializeDouble (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON number into a double field.
OBJECTIVELY_EXPORT bool	JSONDeserializeFloat (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON number into a float field.
OBJECTIVELY_EXPORT bool	JSONDeserializeInt32 (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON number into an int32_t field.
OBJECTIVELY_EXPORT bool	JSONDeserializeInt64 (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON number into an int64_t field.
OBJECTIVELY_EXPORT bool	JSONDeserializeObjectArray (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON array into an Array * field.
OBJECTIVELY_EXPORT bool	JSONDeserializeSet (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON array into a Set * field.
OBJECTIVELY_EXPORT bool	JSONDeserializeString (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON string into a String * field.
OBJECTIVELY_EXPORT bool	JSONDeserializeStruct (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON object into a nested struct field.
OBJECTIVELY_EXPORT bool	JSONDeserializeUint32 (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON number into a uint32_t field.
OBJECTIVELY_EXPORT bool	JSONDeserializeUint64 (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON number into a uint64_t field.
OBJECTIVELY_EXPORT bool	JSONDeserializeURL (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)
	Deserializes a JSON string into a URL * field via initWithString.
OBJECTIVELY_EXPORT ident	JSONSerializeArray (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes an inline array field to a JSON array.
OBJECTIVELY_EXPORT ident	JSONSerializeBoole (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a bool field to a JSON boolean.
OBJECTIVELY_EXPORT ident	JSONSerializeCharacters (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a fixed-size char[] field to a JSON string.
OBJECTIVELY_EXPORT ident	JSONSerializeCString (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a char * heap string field to a JSON string.
OBJECTIVELY_EXPORT ident	JSONSerializeDate (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a Date * field to a JSON string (ISO 8601 by default).
OBJECTIVELY_EXPORT ident	JSONSerializeDictionary (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a Dictionary * field to a JSON object.
OBJECTIVELY_EXPORT ident	JSONSerializeDouble (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a double field to a JSON number.
OBJECTIVELY_EXPORT ident	JSONSerializeFloat (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a float field to a JSON number.
OBJECTIVELY_EXPORT ident	JSONSerializeInt32 (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes an int32_t field to a JSON number.
OBJECTIVELY_EXPORT ident	JSONSerializeInt64 (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes an int64_t field to a JSON number.
OBJECTIVELY_EXPORT ident	JSONSerializeObjectArray (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes an Array * field to a JSON array.
OBJECTIVELY_EXPORT ident	JSONSerializeSet (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a Set * field to a JSON array.
OBJECTIVELY_EXPORT ident	JSONSerializeString (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a String * field to a JSON string.
OBJECTIVELY_EXPORT ident	JSONSerializeStruct (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a nested struct field to a JSON object.
OBJECTIVELY_EXPORT ident	JSONSerializeUint32 (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a uint32_t field to a JSON number.
OBJECTIVELY_EXPORT ident	JSONSerializeUint64 (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a uint64_t field to a JSON number.
OBJECTIVELY_EXPORT ident	JSONSerializeURL (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)
	Serializes a URL * field to a JSON string (the URL's string form).

Detailed Description

Standard JSONSerializer and JSONDeserializer functions for C struct fields.

Definition in file JSONSerializers.h.

Macro Definition Documentation

JSONArrayProperties_NoCount

#define JSONArrayProperties_NoCount   ((ptrdiff_t) -1)

Sentinel for JSONArrayProperties::count indicating no sibling count field.

Definition at line 399 of file JSONSerializers.h.

MakeJSONArrayProperties

#define MakeJSONArrayProperties	(		properties,
			capacity,
			count
	)		&(JSONArrayProperties){ .properties = (properties), .capacity = (capacity), .count = (count) }

Creates a pointer to a JSONArrayProperties compound literal.

Use this macro (rather than a raw compound literal) as the data argument to MakeJSONProperty when binding a JSONDeserializeArray/JSONSerializeArray property inline. A raw (JSONArrayProperties){ ... } literal cannot be used directly as a macro argument because the preprocessor does not track brace depth; its commas would split macro arguments.

Definition at line 431 of file JSONSerializers.h.

                        { .properties = (properties), .capacity = (capacity), .count = (count) }

MakeJSONProperties

#define MakeJSONProperties	(		Struct,
			...
	)

Value:

  (JSONProperties) { \
    .name = #Struct, \
    .size = sizeof(Struct), \
    .properties = (const JSONProperty[]) { \
      __VA_ARGS__, \
      (JSONProperty) { .key = NULL } \
    } \
  }

Creates a JSONProperties descriptor for a C struct type.

Definition at line 155 of file JSONSerializers.h.

                   { \
    .name = #Struct, \
    .size = sizeof(Struct), \
    .properties = (const JSONProperty[]) { \
      __VA_ARGS__, \
      (JSONProperty) { .key = NULL } \
    } \
  }

MakeJSONProperty

#define MakeJSONProperty	(		Struct,
			field,
			serializer_,
			deserializer_,
			data_
	)

Value:

  (JSONProperty) { \
    .key = #field, \
    .offset = (ptrdiff_t) offsetof(Struct, field), \
    .size = sizeof(((Struct *) NULL)->field), \
    .serializer = (serializer_), \
    .deserializer = (deserializer_), \
    .data = (data_) \
  }

Creates a JSONProperty for a named field of a struct, deriving offset automatically.

The JSON key is the stringified field name.

Definition at line 142 of file JSONSerializers.h.

                 { \
    .key = #field, \
    .offset = (ptrdiff_t) offsetof(Struct, field), \
    .size = sizeof(((Struct *) NULL)->field), \
    .serializer = (serializer_), \
    .deserializer = (deserializer_), \
    .data = (data_) \
  }

Typedef Documentation

JSONDeserializer

typedef bool(* JSONDeserializer) (const JSONProperties *properties, const JSONProperty *property, const Object *value, ident field, JSONContext *context)

Deserializes a JSON value into a C struct field.

Parameters

properties	The JSONProperties of the containing struct.
property	The JSONProperty for this field.
value	The parsed JSON Object; guaranteed non-NULL at the call site.
field	Pointer to the destination field within the struct instance.
context	The active JSONContext, for nested deserialization and error reporting.

Returns

true on success; false on type mismatch.

Definition at line 74 of file JSONSerializers.h.

JSONSerializer

typedef ident(* JSONSerializer) (const JSONProperties *properties, const JSONProperty *property, ident value, ident data, JSONContext *context)

Serializes a C struct field to an Objectively Object.

Parameters

properties	The JSONProperties of the containing struct.
property	The JSONProperty for this field.
value	Pointer to the field within the struct instance.
data	Opaque user data from property->data.
context	The active JSONContext, for nested serialization and error reporting.

Returns

An Objectively Object (String, Number, Boole, etc.), or NULL to omit the key.

Definition at line 59 of file JSONSerializers.h.

Function Documentation

JSONDeserializeArray()

OBJECTIVELY_EXPORT bool JSONDeserializeArray	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON array into an inline array field.

property->data must point to a JSONArrayProperties.

Returns

false if the JSON value is not an Array.

Definition at line 501 of file JSONSerializers.c.

                                                  {
 
  (void) properties;
 
  const JSONArrayProperties *array = property->data;
  if (!array || !array->properties || !field) {
    return false;
  }
 
  uint8_t *instance = (uint8_t *) field - property->offset;
  if (array->count != JSONArrayProperties_NoCount) {
    *(size_t *) (instance + array->count) = 0;
  }
 
  memset(field, 0, array->properties->size * array->capacity);
 
  if (!$(value, isKindOfClass, _Array())) {
    return false;
  }
 
  const size_t n = $(context, structsFromArray, array->properties,
                                                    cast(Array, value), field, array->capacity);
 
  if (array->count != JSONArrayProperties_NoCount) {
    *(size_t *) (instance + array->count) = n;
  }
 
  return true;
}

JSONDeserializeBoole()

OBJECTIVELY_EXPORT bool JSONDeserializeBoole	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON boolean into a bool field.

Returns

false if the JSON value is not a Boole.

Definition at line 454 of file JSONSerializers.c.

                                                  {
 
  (void) properties;
  (void) property;
  (void) context;
 
  bool *dest = field;
  if (!dest) {
    return false;
  }
 
  *dest = false;
 
  if (!$(value, isKindOfClass, _Boole())) {
    return false;
  }
 
  *dest = cast(Boole, value)->value;
  return true;
}

JSONDeserializeCharacters()

OBJECTIVELY_EXPORT bool JSONDeserializeCharacters	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON string into a fixed-size char[] field.

property->data must carry the field size via JSONFieldSize.

Returns

false if the JSON value is not a String.

Definition at line 251 of file JSONSerializers.c.

                                                       {
 
  (void) properties;
  (void) context;
 
  char *dest = field;
  const size_t size = property->size;
 
  if (!dest || !size) {
    return false;
  }
 
  memset(dest, 0, size);
 
  if (!$(value, isKindOfClass, _String())) {
    return false;
  }
 
  strncpy(dest, cast(String, value)->chars, size - 1);
  dest[size - 1] = '\0';
  return true;
}

JSONDeserializeCString()

OBJECTIVELY_EXPORT bool JSONDeserializeCString	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON string into a heap-allocated char * field.

The existing pointer is freed before replacement.

Returns

false if the JSON value is not a String.

Definition at line 278 of file JSONSerializers.c.

                                                    {
 
  (void) properties;
  (void) property;
  (void) context;
 
  char **dest = field;
  if (!dest) {
    return false;
  }
 
  free(*dest);
  *dest = NULL;
 
  if (!$(value, isKindOfClass, _String())) {
    return false;
  }
 
  *dest = strdup(cast(String, value)->chars);
  return true;
}

JSONDeserializeDate()

OBJECTIVELY_EXPORT bool JSONDeserializeDate	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON string into a Date * field (ISO 8601 by default).

Pass a const char * format string as property->data to override the format.

Returns

false if the JSON value is not a String or cannot be parsed.

Definition at line 632 of file JSONSerializers.c.

                                                {
 
  (void) properties;
  (void) context;
 
  Date **dest = field;
  release(*dest);
  *dest = NULL;
 
  if (!$(value, isKindOfClass, _String())) {
    return false;
  }
 
  const char *fmt = property->data ? (const char *) property->data : DATEFORMAT_ISO8601;
  DateFormatter *formatter = $(alloc(DateFormatter), initWithFormat, fmt);
  *dest = $(formatter, dateFromString, cast(String, value));
  release(formatter);
  return *dest != NULL;
}

JSONDeserializeDictionary()

OBJECTIVELY_EXPORT bool JSONDeserializeDictionary	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON object into a Dictionary * field.

The existing Dictionary is released before replacement.

Returns

false if the JSON value is not a Dictionary.

Definition at line 753 of file JSONSerializers.c.

                                                             {
 
  (void) properties;
  (void) property;
  (void) context;
 
  Dictionary **dest = field;
  release(*dest);
  *dest = NULL;
 
  if (!$(value, isKindOfClass, _Dictionary())) {
    return false;
  }
 
  *dest = $(alloc(Dictionary), init);
  $(*(Dictionary **) dest, addEntriesFromDictionary, cast(Dictionary, value));
  return true;
}

JSONDeserializeDouble()

OBJECTIVELY_EXPORT bool JSONDeserializeDouble	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON number into a double field.

Returns

false if the JSON value is not a Number.

Definition at line 429 of file JSONSerializers.c.

                                                   {
 
  (void) properties;
  (void) property;
  (void) context;
 
  double *dest = field;
  if (!dest) {
    return false;
  }
 
  *dest = 0.0;
 
  if (!$(value, isKindOfClass, _Number())) {
    return false;
  }
 
  *dest = cast(Number, value)->value;
  return true;
}

JSONDeserializeFloat()

OBJECTIVELY_EXPORT bool JSONDeserializeFloat	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON number into a float field.

Returns

false if the JSON value is not a Number.

Definition at line 404 of file JSONSerializers.c.

                                                  {
 
  (void) properties;
  (void) property;
  (void) context;
 
  float *dest = field;
  if (!dest) {
    return false;
  }
 
  *dest = 0.f;
 
  if (!$(value, isKindOfClass, _Number())) {
    return false;
  }
 
  *dest = (float) cast(Number, value)->value;
  return true;
}

JSONDeserializeInt32()

OBJECTIVELY_EXPORT bool JSONDeserializeInt32	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON number into an int32_t field.

Returns

false if the JSON value is not a Number.

Definition at line 304 of file JSONSerializers.c.

                                                  {
 
  (void) properties;
  (void) property;
  (void) context;
 
  int32_t *dest = field;
  if (!dest) {
    return false;
  }
 
  *dest = 0;
 
  if (!$(value, isKindOfClass, _Number())) {
    return false;
  }
 
  *dest = (int32_t) cast(Number, value)->value;
  return true;
}

JSONDeserializeInt64()

OBJECTIVELY_EXPORT bool JSONDeserializeInt64	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON number into an int64_t field.

JSON numbers are IEEE 754 doubles (53-bit mantissa). Values beyond 2^53 will lose precision on round-trip.

Returns

false if the JSON value is not a Number.

Definition at line 354 of file JSONSerializers.c.

                                                  {
 
  (void) properties;
  (void) property;
  (void) context;
 
  int64_t *dest = field;
  if (!dest) {
    return false;
  }
 
  *dest = 0;
 
  if (!$(value, isKindOfClass, _Number())) {
    return false;
  }
 
  *dest = (int64_t) cast(Number, value)->value;
  return true;
}

JSONDeserializeObjectArray()

OBJECTIVELY_EXPORT bool JSONDeserializeObjectArray	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON array into an Array * field.

The existing Array is released before replacement. Elements are retained as their parsed Objectively types (String, Number, Boole, etc.).

Returns

false if the JSON value is not an Array.

Definition at line 671 of file JSONSerializers.c.

                                                        {
 
  (void) properties;
  (void) property;
  (void) context;
 
  Array **dest = field;
  release(*dest);
  *dest = NULL;
 
  if (!$(value, isKindOfClass, _Array())) {
    return false;
  }
 
  const Array *src = cast(Array, value);
  *dest = $(alloc(Array), initWithCapacity, src->count);
  $(*(Array **) dest, addObjectsFromArray, src);
  return true;
}

JSONDeserializeSet()

OBJECTIVELY_EXPORT bool JSONDeserializeSet	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON array into a Set * field.

The existing Set is released before replacement.

Returns

false if the JSON value is not an Array.

Definition at line 714 of file JSONSerializers.c.

                                                      {
 
  (void) properties;
  (void) property;
  (void) context;
 
  Set **dest = field;
  release(*dest);
  *dest = NULL;
 
  if (!$(value, isKindOfClass, _Array())) {
    return false;
  }
 
  const Array *src = cast(Array, value);
  *dest = $(alloc(Set), initWithCapacity, src->count);
  $(*(Set **) dest, addObjectsFromArray, src);
  return true;
}

JSONDeserializeString()

OBJECTIVELY_EXPORT bool JSONDeserializeString	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON string into a String * field.

The existing String is released before replacement.

Returns

false if the JSON value is not a String.

Definition at line 552 of file JSONSerializers.c.

                                                  {
 
  (void) properties;
  (void) property;
  (void) context;
 
  String **dest = field;
  release(*dest);
  *dest = NULL;
 
  if (!$(value, isKindOfClass, _String())) {
    return false;
  }
 
  *dest = retain((String *) value);
  return true;
}

JSONDeserializeStruct()

OBJECTIVELY_EXPORT bool JSONDeserializeStruct	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON object into a nested struct field.

property->data must point to a JSONProperties describing the nested type.

Returns

false if the JSON value is not a Dictionary.

Definition at line 479 of file JSONSerializers.c.

                                                   {
 
  (void) properties;
 
  const JSONProperties *child = property->data;
  if (!child || !child->properties || !field) {
    return false;
  }
 
  memset(field, 0, child->size);
 
  if (!$(value, isKindOfClass, _Dictionary())) {
    return false;
  }
 
  return $(context, structFromDictionary, child, cast(Dictionary, value), field);
}

JSONDeserializeUint32()

OBJECTIVELY_EXPORT bool JSONDeserializeUint32	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON number into a uint32_t field.

Returns

false if the JSON value is not a Number.

Definition at line 329 of file JSONSerializers.c.

                                                   {
 
  (void) properties;
  (void) property;
  (void) context;
 
  uint32_t *dest = field;
  if (!dest) {
    return false;
  }
 
  *dest = 0;
 
  if (!$(value, isKindOfClass, _Number())) {
    return false;
  }
 
  *dest = (uint32_t) cast(Number, value)->value;
  return true;
}

JSONDeserializeUint64()

OBJECTIVELY_EXPORT bool JSONDeserializeUint64	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON number into a uint64_t field.

JSON numbers are IEEE 754 doubles (53-bit mantissa). Values beyond 2^53 will lose precision on round-trip.

Returns

false if the JSON value is not a Number.

Definition at line 379 of file JSONSerializers.c.

                                                   {
 
  (void) properties;
  (void) property;
  (void) context;
 
  uint64_t *dest = field;
  if (!dest) {
    return false;
  }
 
  *dest = 0;
 
  if (!$(value, isKindOfClass, _Number())) {
    return false;
  }
 
  *dest = (uint64_t) cast(Number, value)->value;
  return true;
}

JSONDeserializeURL()

OBJECTIVELY_EXPORT bool JSONDeserializeURL	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		const Object *	value,
		ident	field,
		JSONContext *	context
	)

Deserializes a JSON string into a URL * field via initWithString.

The existing URL is released before replacement.

Returns

false if the JSON value is not a String.

Definition at line 589 of file JSONSerializers.c.

                                               {
 
  (void) properties;
  (void) property;
  (void) context;
 
  URL **dest = field;
  release(*dest);
  *dest = NULL;
 
  if (!$(value, isKindOfClass, _String())) {
    return false;
  }
 
  *dest = $(alloc(URL), initWithString, cast(String, value));
  return *dest != NULL;
}

JSONSerializeArray()

OBJECTIVELY_EXPORT ident JSONSerializeArray	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes an inline array field to a JSON array.

property->data must point to a JSONArrayProperties.

Definition at line 223 of file JSONSerializers.c.

                                                {
 
  (void) properties;
  (void) property;
 
  const JSONArrayProperties *array = data;
  if (!array || !array->properties || !value) {
    return NULL;
  }
 
  Array *out = $(alloc(Array), init);
 
  for (size_t i = 0; i < array->capacity; i++) {
    const ident instance = (uint8_t *) value + i * array->properties->size;
    Dictionary *dict = $(context, dictionaryFromStruct, array->properties, instance);
    $(out, addObject, dict);
    release(dict);
  }
 
  return (ident) out;
}

JSONSerializeBoole()

OBJECTIVELY_EXPORT ident JSONSerializeBoole	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a bool field to a JSON boolean.

Definition at line 188 of file JSONSerializers.c.

                                                {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  if (!value) {
    return NULL;
  }
 
  return retain(*(const bool *) value ? $$(Boole, True) : $$(Boole, False));
}

JSONSerializeCharacters()

OBJECTIVELY_EXPORT ident JSONSerializeCharacters	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a fixed-size char[] field to a JSON string.

Omits the key (returns NULL) when the field is empty.

Definition at line 42 of file JSONSerializers.c.

                                                     {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  const char *s = value;
  if (s && s[0]) {
    return (ident) $$(String, stringWithCharacters, s);
  }
 
  return NULL;
}

JSONSerializeCString()

OBJECTIVELY_EXPORT ident JSONSerializeCString	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a char * heap string field to a JSON string.

Omits the key (returns NULL) when the pointer is NULL.

Definition at line 61 of file JSONSerializers.c.

                                                  {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  const char *const *s = value;
  if (s && *s) {
    return (ident) $$(String, stringWithCharacters, *s);
  }
 
  return NULL;
}

JSONSerializeDate()

OBJECTIVELY_EXPORT ident JSONSerializeDate	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a Date * field to a JSON string (ISO 8601 by default).

Pass a const char * format string as property->data to override the format.

Definition at line 611 of file JSONSerializers.c.

                                               {
 
  (void) properties;
  (void) context;
 
  Date **date = value;
  if (!*date) {
    return NULL;
  }
 
  const char *fmt = data ? (const char *) data : DATEFORMAT_ISO8601;
  DateFormatter *formatter = $(alloc(DateFormatter), initWithFormat, fmt);
  String *string = $(formatter, stringFromDate, *date);
  release(formatter);
  return string;
}

JSONSerializeDictionary()

OBJECTIVELY_EXPORT ident JSONSerializeDictionary	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a Dictionary * field to a JSON object.

Values are written as-is; each must be a JSON-compatible Objectively type.

Definition at line 738 of file JSONSerializers.c.

                                                            {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  Dictionary **dict = value;
  return *dict ? retain(*dict) : NULL;
}

JSONSerializeDouble()

OBJECTIVELY_EXPORT ident JSONSerializeDouble	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a double field to a JSON number.

Definition at line 170 of file JSONSerializers.c.

                                                 {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  if (!value) {
    return NULL;
  }
 
  return (ident) $$(Number, numberWithValue, *(const double *) value);
}

JSONSerializeFloat()

OBJECTIVELY_EXPORT ident JSONSerializeFloat	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a float field to a JSON number.

Definition at line 152 of file JSONSerializers.c.

                                                {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  if (!value) {
    return NULL;
  }
 
  return (ident) $$(Number, numberWithValue, (double) *(const float *) value);
}

JSONSerializeInt32()

OBJECTIVELY_EXPORT ident JSONSerializeInt32	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes an int32_t field to a JSON number.

Definition at line 80 of file JSONSerializers.c.

                                                {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  if (!value) {
    return NULL;
  }
 
  return (ident) $$(Number, numberWithValue, (double) *(const int32_t *) value);
}

JSONSerializeInt64()

OBJECTIVELY_EXPORT ident JSONSerializeInt64	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes an int64_t field to a JSON number.

JSON numbers are IEEE 754 doubles (53-bit mantissa). Values beyond 2^53 will lose precision on round-trip.

Definition at line 116 of file JSONSerializers.c.

                                                {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  if (!value) {
    return NULL;
  }
 
  return (ident) $$(Number, numberWithValue, (double) *(const int64_t *) value);
}

JSONSerializeObjectArray()

OBJECTIVELY_EXPORT ident JSONSerializeObjectArray	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes an Array * field to a JSON array.

Elements are written as-is; each must be a JSON-compatible Objectively type.

Definition at line 656 of file JSONSerializers.c.

                                                       {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  Array **arr = value;
  return *arr ? retain(*arr) : NULL;
}

JSONSerializeSet()

OBJECTIVELY_EXPORT ident JSONSerializeSet	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a Set * field to a JSON array.

Elements are written as-is; each must be a JSON-compatible Objectively type.

Definition at line 695 of file JSONSerializers.c.

                                                     {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  Set **set = value;
  if (!*set) {
    return NULL;
  }
 
  return (ident) $(cast(Set, *set), allObjects);
}

JSONSerializeString()

OBJECTIVELY_EXPORT ident JSONSerializeString	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a String * field to a JSON string.

Definition at line 537 of file JSONSerializers.c.

                                                 {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  String **s = value;
  return *s ? retain(*s) : NULL;
}

JSONSerializeStruct()

OBJECTIVELY_EXPORT ident JSONSerializeStruct	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a nested struct field to a JSON object.

property->data must point to a JSONProperties describing the nested type.

Definition at line 206 of file JSONSerializers.c.

                                                 {
 
  (void) properties;
  (void) property;
 
  const JSONProperties *child = data;
  if (!child || !child->properties || !value) {
    return NULL;
  }
 
  return (ident) $(context, dictionaryFromStruct, child, value);
}

JSONSerializeUint32()

OBJECTIVELY_EXPORT ident JSONSerializeUint32	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a uint32_t field to a JSON number.

Definition at line 98 of file JSONSerializers.c.

                                                 {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  if (!value) {
    return NULL;
  }
 
  return (ident) $$(Number, numberWithValue, (double) *(const uint32_t *) value);
}

JSONSerializeUint64()

OBJECTIVELY_EXPORT ident JSONSerializeUint64	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a uint64_t field to a JSON number.

JSON numbers are IEEE 754 doubles (53-bit mantissa). Values beyond 2^53 will lose precision on round-trip.

Definition at line 134 of file JSONSerializers.c.

                                                 {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  if (!value) {
    return NULL;
  }
 
  return (ident) $$(Number, numberWithValue, (double) *(const uint64_t *) value);
}

JSONSerializeURL()

OBJECTIVELY_EXPORT ident JSONSerializeURL	(	const JSONProperties *	properties,
		const JSONProperty *	property,
		ident	value,
		ident	data,
		JSONContext *	context
	)

Serializes a URL * field to a JSON string (the URL's string form).

Definition at line 574 of file JSONSerializers.c.

                                              {
 
  (void) properties;
  (void) property;
  (void) data;
  (void) context;
 
  URL **url = value;
  return *url ? retain((*url)->urlString) : NULL;
}