WinPR JSON wrapper

Wrapper around cJSON or JSONC libraries. More...

Typedefs
typedef void	WINPR_JSON

Functions
WINPR_API int	WINPR_JSON_version (char *buffer, size_t len)
	Get the library version string.
WINPR_API void	WINPR_JSON_Delete (WINPR_JSON *item)
	Delete a WinPR JSON wrapper object.
WINPR_API WINPR_JSON *	WINPR_JSON_Parse (const char *value)
	Parse a '\0' terminated JSON string.
WINPR_API WINPR_JSON *	WINPR_JSON_ParseWithLength (const char *value, size_t buffer_length)
	Parse a JSON string.
WINPR_API WINPR_JSON *	WINPR_JSON_ParseFromFile (const char *filename)
	Parse a JSON string read from a file filename.
WINPR_API WINPR_JSON *	WINPR_JSON_ParseFromFileFP (FILE *fp)
	Parse a JSON string read from a FILE.
WINPR_API size_t	WINPR_JSON_GetArraySize (const WINPR_JSON *array)
	Get the number of arrayitems from an array.
WINPR_API WINPR_JSON *	WINPR_JSON_GetArrayItem (const WINPR_JSON *array, size_t index)
	Return a pointer to an item in the array.
WINPR_API WINPR_JSON *	WINPR_JSON_GetObjectItem (const WINPR_JSON *object, const char *string)
	Return a pointer to an JSON object item.
WINPR_API WINPR_JSON *	WINPR_JSON_GetObjectItemCaseSensitive (const WINPR_JSON *object, const char *string)
	Same as WINPR_JSON_GetObjectItem but with case insensitive matching.
WINPR_API BOOL	WINPR_JSON_HasObjectItem (const WINPR_JSON *object, const char *string)
	Check if JSON has an object matching the name.
WINPR_API const char *	WINPR_JSON_GetErrorPtr (void)
	Return an error string.
WINPR_API const char *	WINPR_JSON_GetStringValue (WINPR_JSON *item)
	Return the String value of a JSON item.
WINPR_API double	WINPR_JSON_GetNumberValue (const WINPR_JSON *item)
	Return the Number value of a JSON item.
WINPR_API BOOL	WINPR_JSON_IsInvalid (const WINPR_JSON *item)
	Check if JSON item is valid.
WINPR_API BOOL	WINPR_JSON_IsFalse (const WINPR_JSON *item)
	Check if JSON item is BOOL value False.
WINPR_API BOOL	WINPR_JSON_IsTrue (const WINPR_JSON *item)
	Check if JSON item is BOOL value True.
WINPR_API BOOL	WINPR_JSON_IsBool (const WINPR_JSON *item)
	Check if JSON item is of type BOOL.
WINPR_API BOOL	WINPR_JSON_IsNull (const WINPR_JSON *item)
	Check if JSON item is Null.
WINPR_API BOOL	WINPR_JSON_IsNumber (const WINPR_JSON *item)
	Check if JSON item is of type Number.
WINPR_API BOOL	WINPR_JSON_IsString (const WINPR_JSON *item)
	Check if JSON item is of type String.
WINPR_API BOOL	WINPR_JSON_IsArray (const WINPR_JSON *item)
	Check if JSON item is of type Array.
WINPR_API BOOL	WINPR_JSON_IsObject (const WINPR_JSON *item)
	Check if JSON item is of type Object.
WINPR_API WINPR_JSON *	WINPR_JSON_CreateNull (void)
	WINPR_JSON_CreateNull.
WINPR_API WINPR_JSON *	WINPR_JSON_CreateTrue (void)
	WINPR_JSON_CreateTrue.
WINPR_API WINPR_JSON *	WINPR_JSON_CreateFalse (void)
	WINPR_JSON_CreateFalse.
WINPR_API WINPR_JSON *	WINPR_JSON_CreateBool (BOOL boolean)
	WINPR_JSON_CreateBool.
WINPR_API WINPR_JSON *	WINPR_JSON_CreateNumber (double num)
	WINPR_JSON_CreateNumber.
WINPR_API WINPR_JSON *	WINPR_JSON_CreateString (const char *string)
	WINPR_JSON_CreateString.
WINPR_API WINPR_JSON *	WINPR_JSON_CreateArray (void)
	WINPR_JSON_CreateArray.
WINPR_API WINPR_JSON *	WINPR_JSON_CreateObject (void)
	WINPR_JSON_CreateObject.
WINPR_API WINPR_JSON *	WINPR_JSON_AddNullToObject (WINPR_JSON *object, const char *name)
	WINPR_JSON_AddNullToObject.
WINPR_API WINPR_JSON *	WINPR_JSON_AddTrueToObject (WINPR_JSON *object, const char *name)
	WINPR_JSON_AddTrueToObject.
WINPR_API WINPR_JSON *	WINPR_JSON_AddFalseToObject (WINPR_JSON *object, const char *name)
	WINPR_JSON_AddFalseToObject.
WINPR_API WINPR_JSON *	WINPR_JSON_AddBoolToObject (WINPR_JSON *object, const char *name, BOOL boolean)
	WINPR_JSON_AddBoolToObject.
WINPR_API WINPR_JSON *	WINPR_JSON_AddNumberToObject (WINPR_JSON *object, const char *name, double number)
	WINPR_JSON_AddNumberToObject.
WINPR_API WINPR_JSON *	WINPR_JSON_AddStringToObject (WINPR_JSON *object, const char *name, const char *string)
	WINPR_JSON_AddStringToObject.
WINPR_API WINPR_JSON *	WINPR_JSON_AddObjectToObject (WINPR_JSON *object, const char *name)
	WINPR_JSON_AddObjectToObject.
WINPR_API WINPR_JSON *	WINPR_JSON_AddArrayToObject (WINPR_JSON *object, const char *name)
	WINPR_JSON_AddArrayToObject.
WINPR_API BOOL	WINPR_JSON_AddItemToArray (WINPR_JSON *array, WINPR_JSON *item)
	Add an item to an existing array.
WINPR_API char *	WINPR_JSON_Print (WINPR_JSON *item)
	Serialize a JSON instance to string for minimal size without formatting see WINPR_JSON_PrintUnformatted.
WINPR_API char *	WINPR_JSON_PrintUnformatted (WINPR_JSON *item)
	Serialize a JSON instance to string without formatting for human readable formatted output see WINPR_JSON_Print.

Detailed Description

Wrapper around cJSON or JSONC libraries.

FreeRDP: A Remote Desktop Protocol Implementation JSON parser wrapper

Copyright 2024 Armin Novak anova.nosp@m.k@th.nosp@m.incas.nosp@m.t.co.nosp@m.m Copyright 2024 Thincast Technologies GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Since

version 3.6.0

Typedef Documentation

WINPR_JSON

typedef void WINPR_JSON

Definition at line 39 of file json.h.

Function Documentation

WINPR_JSON_AddArrayToObject()

WINPR_API WINPR_JSON * WINPR_JSON_AddArrayToObject	(	WINPR_JSON *	object,
		const char *	name
	)

WINPR_JSON_AddArrayToObject.

Parameters

object	The JSON object the new item is added to
name	The name of the object

Returns

the new JSON item added

Since

version 3.6.0

Definition at line 635 of file json.c.

{
#if defined(WITH_JSONC)
  struct json_object* obj = json_object_new_array();
  if (json_object_object_add((json_object*)object, name, obj) != 0)
  {
    json_object_put(obj);
    return NULL;
  }
  return obj;
#elif defined(WITH_CJSON)
  return cJSON_AddArrayToObject((cJSON*)object, name);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(name);
  return NULL;
#endif
}

WINPR_JSON_AddBoolToObject()

WINPR_API WINPR_JSON * WINPR_JSON_AddBoolToObject	(	WINPR_JSON *	object,
		const char *	name,
		BOOL	boolean
	)

WINPR_JSON_AddBoolToObject.

Parameters

object	The JSON object the new item is added to
name	The name of the object

Returns

the new JSON item added

Since

version 3.6.0

Definition at line 533 of file json.c.

{
#if defined(WITH_JSONC)
  struct json_object* obj = json_object_new_boolean(boolean);
  if (json_object_object_add((json_object*)object, name, obj) != 0)
  {
    json_object_put(obj);
    return NULL;
  }
  return obj;
#elif defined(WITH_CJSON)
  return cJSON_AddBoolToObject((cJSON*)object, name, boolean);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(name);
  WINPR_UNUSED(boolean);
  return NULL;
#endif
}

Referenced by freerdp_settings_serialize().

Here is the caller graph for this function:

WINPR_JSON_AddFalseToObject()

WINPR_API WINPR_JSON * WINPR_JSON_AddFalseToObject	(	WINPR_JSON *	object,
		const char *	name
	)

WINPR_JSON_AddFalseToObject.

Parameters

object	The JSON object the new item is added to
name	The name of the object

Returns

the new JSON item added

Since

version 3.6.0

Definition at line 514 of file json.c.

{
#if defined(WITH_JSONC)
  struct json_object* obj = json_object_new_boolean(FALSE);
  if (json_object_object_add((json_object*)object, name, obj) != 0)
  {
    json_object_put(obj);
    return NULL;
  }
  return obj;
#elif defined(WITH_CJSON)
  return cJSON_AddFalseToObject((cJSON*)object, name);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(name);
  return NULL;
#endif
}

WINPR_JSON_AddItemToArray()

WINPR_API BOOL WINPR_JSON_AddItemToArray	(	WINPR_JSON *	array,
		WINPR_JSON *	item
	)

Add an item to an existing array.

Parameters

array	An array to add to, must not be NULL
item	An item to add, must not be NULL

Returns

TRUE for success, FALSE for failure

Since

version 3.7.0

Definition at line 612 of file json.c.

{
#if defined(WITH_JSONC)
  const int rc = json_object_array_add((json_object*)array, (json_object*)item);
  if (rc != 0)
    return FALSE;
  return TRUE;
#elif defined(WITH_CJSON)
#if defined(USE_CJSON_COMPAT)
  if ((array == NULL) || (item == NULL))
    return FALSE;
  cJSON_AddItemToArray((cJSON*)array, (cJSON*)item);
  return TRUE;
#else
  return cJSON_AddItemToArray((cJSON*)array, (cJSON*)item);
#endif
#else
  WINPR_UNUSED(array);
  WINPR_UNUSED(item);
  return FALSE;
#endif
}

WINPR_JSON_AddNullToObject()

WINPR_API WINPR_JSON * WINPR_JSON_AddNullToObject	(	WINPR_JSON *	object,
		const char *	name
	)

WINPR_JSON_AddNullToObject.

Parameters

object	The JSON object the new item is added to
name	The name of the object

Returns

the new JSON item added

Since

version 3.6.0

Definition at line 476 of file json.c.

{
#if defined(WITH_JSONC)
  struct json_object* obj = json_object_new_null();
  if (json_object_object_add((json_object*)object, name, obj) != 0)
  {
    json_object_put(obj);
    return NULL;
  }
  return obj;
#elif defined(WITH_CJSON)
  return cJSON_AddNullToObject((cJSON*)object, name);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(name);
  return NULL;
#endif
}

Referenced by freerdp_settings_serialize().

Here is the caller graph for this function:

WINPR_JSON_AddNumberToObject()

WINPR_API WINPR_JSON * WINPR_JSON_AddNumberToObject	(	WINPR_JSON *	object,
		const char *	name,
		double	number
	)

WINPR_JSON_AddNumberToObject.

Parameters

object	The JSON object the new item is added to
name	The name of the object

Returns

the new JSON item added

Since

version 3.6.0

Definition at line 553 of file json.c.

{
#if defined(WITH_JSONC)
  struct json_object* obj = json_object_new_double(number);
  if (json_object_object_add((json_object*)object, name, obj) != 0)
  {
    json_object_put(obj);
    return NULL;
  }
  return obj;
#elif defined(WITH_CJSON)
  return cJSON_AddNumberToObject((cJSON*)object, name, number);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(name);
  WINPR_UNUSED(number);
  return NULL;
#endif
}

Referenced by freerdp_settings_serialize().

Here is the caller graph for this function:

WINPR_JSON_AddObjectToObject()

WINPR_API WINPR_JSON * WINPR_JSON_AddObjectToObject	(	WINPR_JSON *	object,
		const char *	name
	)

WINPR_JSON_AddObjectToObject.

Parameters

object	The JSON object the new item is added to
name	The name of the object

Returns

the new JSON item added

Since

version 3.6.0

Definition at line 593 of file json.c.

{
#if defined(WITH_JSONC)
  struct json_object* obj = json_object_new_object();
  if (json_object_object_add((json_object*)object, name, obj) != 0)
  {
    json_object_put(obj);
    return NULL;
  }
  return obj;
#elif defined(WITH_CJSON)
  return cJSON_AddObjectToObject((cJSON*)object, name);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(name);
  return NULL;
#endif
}

Referenced by freerdp_settings_serialize().

Here is the caller graph for this function:

WINPR_JSON_AddStringToObject()

WINPR_API WINPR_JSON * WINPR_JSON_AddStringToObject	(	WINPR_JSON *	object,
		const char *	name,
		const char *	string
	)

WINPR_JSON_AddStringToObject.

Parameters

object	The JSON object the new item is added to
name	The name of the object

Returns

the new JSON item added

Since

version 3.6.0

Definition at line 573 of file json.c.

{
#if defined(WITH_JSONC)
  struct json_object* obj = json_object_new_string(string);
  if (json_object_object_add((json_object*)object, name, obj) != 0)
  {
    json_object_put(obj);
    return NULL;
  }
  return obj;
#elif defined(WITH_CJSON)
  return cJSON_AddStringToObject((cJSON*)object, name, string);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(name);
  WINPR_UNUSED(string);
  return NULL;
#endif
}

Referenced by freerdp_settings_serialize().

Here is the caller graph for this function:

WINPR_JSON_AddTrueToObject()

WINPR_API WINPR_JSON * WINPR_JSON_AddTrueToObject	(	WINPR_JSON *	object,
		const char *	name
	)

WINPR_JSON_AddTrueToObject.

Parameters

object	The JSON object the new item is added to
name	The name of the object

Returns

the new JSON item added

Since

version 3.6.0

Definition at line 495 of file json.c.

{
#if defined(WITH_JSONC)
  struct json_object* obj = json_object_new_boolean(TRUE);
  if (json_object_object_add((json_object*)object, name, obj) != 0)
  {
    json_object_put(obj);
    return NULL;
  }
  return obj;
#elif defined(WITH_CJSON)
  return cJSON_AddTrueToObject((cJSON*)object, name);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(name);
  return NULL;
#endif
}

WINPR_JSON_CreateArray()

WINPR_API WINPR_JSON * WINPR_JSON_CreateArray

(

void

)

WINPR_JSON_CreateArray.

Returns

a new JSON item of type array, empty

Since

version 3.6.0

Definition at line 454 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_new_array();
#elif defined(WITH_CJSON)
  return cJSON_CreateArray();
#else
  return NULL;
#endif
}

WINPR_JSON_CreateBool()

WINPR_API WINPR_JSON * WINPR_JSON_CreateBool

(

BOOL

boolean

)

WINPR_JSON_CreateBool.

Parameters

boolean

the value the JSON item should have

Returns

a new JSON item of type Bool

Since

version 3.6.0

Definition at line 418 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_new_boolean(boolean);
#elif defined(WITH_CJSON)
  return cJSON_CreateBool(boolean);
#else
  WINPR_UNUSED(boolean);
  return NULL;
#endif
}

WINPR_JSON_CreateFalse()

WINPR_API WINPR_JSON * WINPR_JSON_CreateFalse

(

void

)

WINPR_JSON_CreateFalse.

Returns

a new JSON item of type Bool and value False

Since

version 3.6.0

Definition at line 407 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_new_boolean(FALSE);
#elif defined(WITH_CJSON)
  return cJSON_CreateFalse();
#else
  return NULL;
#endif
}

WINPR_JSON_CreateNull()

WINPR_API WINPR_JSON * WINPR_JSON_CreateNull

(

void

)

WINPR_JSON_CreateNull.

Returns

a new JSON item of type and value Null

Since

version 3.6.0

Definition at line 385 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_new_null();
#elif defined(WITH_CJSON)
  return cJSON_CreateNull();
#else
  return NULL;
#endif
}

WINPR_JSON_CreateNumber()

WINPR_API WINPR_JSON * WINPR_JSON_CreateNumber

(

double

num

)

WINPR_JSON_CreateNumber.

Parameters

num	the number value of the new item

Returns

a new JSON item of type Number

Since

version 3.6.0

Definition at line 430 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_new_double(num);
#elif defined(WITH_CJSON)
  return cJSON_CreateNumber(num);
#else
  WINPR_UNUSED(num);
  return NULL;
#endif
}

WINPR_JSON_CreateObject()

WINPR_API WINPR_JSON * WINPR_JSON_CreateObject

(

void

)

WINPR_JSON_CreateObject.

Returns

a new JSON item of type Object

Since

version 3.6.0

Definition at line 465 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_new_object();
#elif defined(WITH_CJSON)
  return cJSON_CreateObject();
#else
  return NULL;
#endif
}

Referenced by freerdp_settings_serialize().

Here is the caller graph for this function:

WINPR_JSON_CreateString()

WINPR_API WINPR_JSON * WINPR_JSON_CreateString

(

const char *

string

)

WINPR_JSON_CreateString.

Parameters

string

The string value of the new item

Returns

a new JSON item of type String

Since

version 3.6.0

Definition at line 442 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_new_string(string);
#elif defined(WITH_CJSON)
  return cJSON_CreateString(string);
#else
  WINPR_UNUSED(string);
  return NULL;
#endif
}

WINPR_JSON_CreateTrue()

WINPR_API WINPR_JSON * WINPR_JSON_CreateTrue

(

void

)

WINPR_JSON_CreateTrue.

Returns

a new JSON item of type Bool and value True

Since

version 3.6.0

Definition at line 396 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_new_boolean(TRUE);
#elif defined(WITH_CJSON)
  return cJSON_CreateTrue();
#else
  return NULL;
#endif
}

WINPR_JSON_Delete()

WINPR_API void WINPR_JSON_Delete

(

WINPR_JSON *

item

)

Delete a WinPR JSON wrapper object.

Parameters

item	The instance to delete

Since

version 3.6.0

Definition at line 144 of file json.c.

{
#if defined(WITH_JSONC)
  json_object_put((json_object*)item);
#elif defined(WITH_CJSON)
  cJSON_Delete((cJSON*)item);
#else
  WINPR_UNUSED(item);
#endif
}

Referenced by freerdp_settings_deserialize(), and freerdp_settings_serialize().

Here is the caller graph for this function:

WINPR_JSON_GetArrayItem()

WINPR_API WINPR_JSON * WINPR_JSON_GetArrayItem	(	const WINPR_JSON *	array,
		size_t	index
	)

Return a pointer to an item in the array.

Parameters

array	the JSON instance to query
index	The index of the array item

Returns

A pointer to the array item or NULL if failed

Since

version 3.6.0

Definition at line 155 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_array_get_idx((const json_object*)array, index);
#elif defined(WITH_CJSON)
  WINPR_ASSERT(index <= INT_MAX);
  return cJSON_GetArrayItem((const cJSON*)array, (INT)index);
#else
  WINPR_UNUSED(array);
  WINPR_UNUSED(index);
  return NULL;
#endif
}

WINPR_JSON_GetArraySize()

WINPR_API size_t WINPR_JSON_GetArraySize

(

const WINPR_JSON *

array

)

Get the number of arrayitems from an array.

Parameters

array

the JSON instance to query

Returns

number of array items

Since

version 3.6.0

Definition at line 169 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_array_length((const json_object*)array);
#elif defined(WITH_CJSON)
  const int rc = cJSON_GetArraySize((const cJSON*)array);
  if (rc <= 0)
    return 0;
  return (size_t)rc;
#else
  WINPR_UNUSED(array);
  return 0;
#endif
}

WINPR_JSON_GetErrorPtr()

WINPR_API const char * WINPR_JSON_GetErrorPtr

(

void

)

Return an error string.

Returns

A string describing the last error that occurred or NULL

Since

version 3.6.0

Definition at line 223 of file json.c.

{
#if defined(WITH_JSONC)
  return json_util_get_last_err();
#elif defined(WITH_CJSON)
  return cJSON_GetErrorPtr();
#else
  return NULL;
#endif
}

WINPR_JSON_GetNumberValue()

WINPR_API double WINPR_JSON_GetNumberValue

(

const WINPR_JSON *

item

)

Return the Number value of a JSON item.

Parameters

item	the JSON item to query

Returns

The Number value or NaN if failed

Since

version 3.6.0

Definition at line 246 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_get_double((const json_object*)item);
#elif defined(WITH_CJSON)
  return cJSON_GetNumberValue((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return nan("");
#endif
}

WINPR_JSON_GetObjectItem()

WINPR_API WINPR_JSON * WINPR_JSON_GetObjectItem	(	const WINPR_JSON *	object,
		const char *	string
	)

Return a pointer to an JSON object item.

Parameters

object	the JSON object
string	the name of the object

Returns

A pointer to the object identified by string or NULL

Since

version 3.6.0

Definition at line 184 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_object_get((const json_object*)object, string);
#elif defined(WITH_CJSON)
  return cJSON_GetObjectItem((const cJSON*)object, string);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(string);
  return NULL;
#endif
}

Referenced by freerdp_settings_deserialize().

Here is the caller graph for this function:

WINPR_JSON_GetObjectItemCaseSensitive()

WINPR_API WINPR_JSON * WINPR_JSON_GetObjectItemCaseSensitive	(	const WINPR_JSON *	object,
		const char *	string
	)

Same as WINPR_JSON_GetObjectItem but with case insensitive matching.

Parameters

object	the JSON instance to query
string	the name of the object

Returns

A pointer to the object identified by string or NULL

Since

version 3.6.0

Definition at line 197 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_object_get((const json_object*)object, string);
#elif defined(WITH_CJSON)
  return cJSON_GetObjectItemCaseSensitive((const cJSON*)object, string);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(string);
  return NULL;
#endif
}

WINPR_JSON_GetStringValue()

WINPR_API const char * WINPR_JSON_GetStringValue

(

WINPR_JSON *

item

)

Return the String value of a JSON item.

Parameters

item	the JSON item to query

Returns

The string value or NULL if failed

Since

version 3.6.0

Definition at line 234 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_get_string((json_object*)item);
#elif defined(WITH_CJSON)
  return cJSON_GetStringValue((cJSON*)item);
#else
  WINPR_UNUSED(item);
  return NULL;
#endif
}

Referenced by freerdp_settings_deserialize().

Here is the caller graph for this function:

WINPR_JSON_HasObjectItem()

WINPR_API BOOL WINPR_JSON_HasObjectItem	(	const WINPR_JSON *	object,
		const char *	string
	)

Check if JSON has an object matching the name.

Parameters

object	the JSON instance
string	the name of the object

Returns

TRUE if found, FALSE otherwise

Since

version 3.6.0

Definition at line 210 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_object_get_ex((const json_object*)object, string, NULL);
#elif defined(WITH_CJSON)
  return cJSON_HasObjectItem((const cJSON*)object, string);
#else
  WINPR_UNUSED(object);
  WINPR_UNUSED(string);
  return FALSE;
#endif
}

WINPR_JSON_IsArray()

WINPR_API BOOL WINPR_JSON_IsArray

(

const WINPR_JSON *

item

)

Check if JSON item is of type Array.

Parameters

item	the JSON item to query

Returns

TRUE if the type is Array, FALSE otherwise

Since

version 3.6.0

Definition at line 361 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_is_type((const json_object*)item, json_type_array);
#elif defined(WITH_CJSON)
  return cJSON_IsArray((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return FALSE;
#endif
}

Referenced by WINPR_JSON_IsInvalid().

Here is the caller graph for this function:

WINPR_JSON_IsBool()

WINPR_API BOOL WINPR_JSON_IsBool

(

const WINPR_JSON *

item

)

Check if JSON item is of type BOOL.

Parameters

item	the JSON item to query

Returns

TRUE if the type is BOOL, FALSE otherwise

Since

version 3.6.0

Definition at line 312 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_is_type((const json_object*)item, json_type_boolean);
#elif defined(WITH_CJSON)
  return cJSON_IsBool((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return FALSE;
#endif
}

Referenced by freerdp_settings_deserialize(), and WINPR_JSON_IsInvalid().

Here is the caller graph for this function:

WINPR_JSON_IsFalse()

WINPR_API BOOL WINPR_JSON_IsFalse

(

const WINPR_JSON *

item

)

Check if JSON item is BOOL value False.

Parameters

item	the JSON item to query

Returns

TRUE if False, FALSE otherwise

Since

version 3.6.0

Definition at line 282 of file json.c.

{
#if defined(WITH_JSONC)
  if (!json_object_is_type((const json_object*)item, json_type_boolean))
    return FALSE;
  json_bool val = json_object_get_boolean((const json_object*)item);
  return val == 0;
#elif defined(WITH_CJSON)
  return cJSON_IsFalse((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return FALSE;
#endif
}

WINPR_JSON_IsInvalid()

WINPR_API BOOL WINPR_JSON_IsInvalid

(

const WINPR_JSON *

item

)

Check if JSON item is valid.

Parameters

item	the JSON item to query

Returns

TRUE if valid, FALSE otherwise

Since

version 3.6.0

Definition at line 258 of file json.c.

{
#if defined(WITH_JSONC)
  if (WINPR_JSON_IsArray(item))
    return FALSE;
  if (WINPR_JSON_IsObject(item))
    return FALSE;
  if (WINPR_JSON_IsNull(item))
    return FALSE;
  if (WINPR_JSON_IsNumber(item))
    return FALSE;
  if (WINPR_JSON_IsBool(item))
    return FALSE;
  if (WINPR_JSON_IsString(item))
    return FALSE;
  return TRUE;
#elif defined(WITH_CJSON)
  return cJSON_IsInvalid((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return TRUE;
#endif
}

References WINPR_JSON_IsArray(), WINPR_JSON_IsBool(), WINPR_JSON_IsNull(), WINPR_JSON_IsNumber(), WINPR_JSON_IsObject(), and WINPR_JSON_IsString().

Here is the call graph for this function:

WINPR_JSON_IsNull()

WINPR_API BOOL WINPR_JSON_IsNull

(

const WINPR_JSON *

item

)

Check if JSON item is Null.

Parameters

item	the JSON item to query

Returns

TRUE if it is Null, FALSE otherwise

Since

version 3.6.0

Definition at line 324 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_is_type((const json_object*)item, json_type_null);
#elif defined(WITH_CJSON)
  return cJSON_IsNull((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return FALSE;
#endif
}

Referenced by freerdp_settings_deserialize(), and WINPR_JSON_IsInvalid().

Here is the caller graph for this function:

WINPR_JSON_IsNumber()

WINPR_API BOOL WINPR_JSON_IsNumber

(

const WINPR_JSON *

item

)

Check if JSON item is of type Number.

Parameters

item	the JSON item to query

Returns

TRUE if the type is Number, FALSE otherwise

Since

version 3.6.0

Definition at line 336 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_is_type((const json_object*)item, json_type_int) ||
         json_object_is_type((const json_object*)item, json_type_double);
#elif defined(WITH_CJSON)
  return cJSON_IsNumber((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return FALSE;
#endif
}

Referenced by WINPR_JSON_IsInvalid().

Here is the caller graph for this function:

WINPR_JSON_IsObject()

WINPR_API BOOL WINPR_JSON_IsObject

(

const WINPR_JSON *

item

)

Check if JSON item is of type Object.

Parameters

item	the JSON item to query

Returns

TRUE if the type is Object, FALSE otherwise

Since

version 3.6.0

Definition at line 373 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_is_type((const json_object*)item, json_type_object);
#elif defined(WITH_CJSON)
  return cJSON_IsObject((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return FALSE;
#endif
}

Referenced by WINPR_JSON_IsInvalid().

Here is the caller graph for this function:

WINPR_JSON_IsString()

WINPR_API BOOL WINPR_JSON_IsString

(

const WINPR_JSON *

item

)

Check if JSON item is of type String.

Parameters

item	the JSON item to query

Returns

TRUE if the type is String, FALSE otherwise

Since

version 3.6.0

Definition at line 349 of file json.c.

{
#if defined(WITH_JSONC)
  return json_object_is_type((const json_object*)item, json_type_string);
#elif defined(WITH_CJSON)
  return cJSON_IsString((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return FALSE;
#endif
}

Referenced by freerdp_settings_deserialize(), and WINPR_JSON_IsInvalid().

Here is the caller graph for this function:

WINPR_JSON_IsTrue()

WINPR_API BOOL WINPR_JSON_IsTrue

(

const WINPR_JSON *

item

)

Check if JSON item is BOOL value True.

Parameters

item	the JSON item to query

Returns

TRUE if True, FALSE otherwise

Since

version 3.6.0

Definition at line 297 of file json.c.

{
#if defined(WITH_JSONC)
  if (!json_object_is_type((const json_object*)item, json_type_boolean))
    return FALSE;
  json_bool val = json_object_get_boolean((const json_object*)item);
  return val != 0;
#elif defined(WITH_CJSON)
  return cJSON_IsTrue((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return FALSE;
#endif
}

Referenced by freerdp_settings_deserialize().

Here is the caller graph for this function:

WINPR_JSON_Parse()

WINPR_API WINPR_JSON * WINPR_JSON_Parse

(

const char *

value

)

Parse a '\0' terminated JSON string.

Parameters

value

A '\0' terminated JSON string

Returns

A WinPR JSON wrapper object holding the parsed string or NULL if failed

Since

version 3.6.0

Definition at line 113 of file json.c.

{
#if defined(WITH_JSONC)
  return json_tokener_parse(value);
#elif defined(WITH_CJSON)
  return cJSON_Parse(value);
#else
  WINPR_UNUSED(value);
  return NULL;
#endif
}

WINPR_JSON_ParseFromFile()

WINPR_API WINPR_JSON * WINPR_JSON_ParseFromFile

(

const char *

filename

)

Parse a JSON string read from a file filename.

Parameters

filename

the name of the file to read from

Returns

A WinPR JSON wrapper object holding the parsed string or NULL if failed

Since

version 3.16.0

Definition at line 684 of file json.c.

{
  FILE* fp = winpr_fopen(filename, "r");
  if (!fp)
    return NULL;
  WINPR_JSON* json = WINPR_JSON_ParseFromFileFP(fp);
  (void)fclose(fp);
  return json;
}

References WINPR_JSON_ParseFromFileFP().

Here is the call graph for this function:

WINPR_JSON_ParseFromFileFP()

WINPR_API WINPR_JSON * WINPR_JSON_ParseFromFileFP

(

FILE *

fp

)

Parse a JSON string read from a FILE.

Parameters

fp	a FILE pointer to read from.

Returns

A WinPR JSON wrapper object holding the parsed string or NULL if failed

Since

version 3.16.0

Definition at line 694 of file json.c.

{
  if (!fp)
    return NULL;
 
  if (fseek(fp, 0, SEEK_END) != 0)
    return NULL;
 
  const INT64 size = _ftelli64(fp);
  if (size < 0)
    return NULL;
 
  if (fseek(fp, 0, SEEK_SET) != 0)
    return NULL;
 
  const size_t usize = WINPR_ASSERTING_INT_CAST(size_t, size);
  char* str = calloc(usize + 1, sizeof(char));
  if (!str)
    return NULL;
 
  WINPR_JSON* json = NULL;
  const size_t s = fread(str, sizeof(char), usize, fp);
  if (s == usize)
    json = WINPR_JSON_ParseWithLength(str, usize);
  free(str);
  return json;
}

References WINPR_JSON_ParseWithLength().

Referenced by WINPR_JSON_ParseFromFile().

Here is the call graph for this function:

Here is the caller graph for this function:

WINPR_JSON_ParseWithLength()

WINPR_API WINPR_JSON * WINPR_JSON_ParseWithLength	(	const char *	value,
		size_t	buffer_length
	)

Parse a JSON string.

Parameters

value	A JSON string
buffer_length	The length in bytes of the JSON string

Returns

A WinPR JSON wrapper object holding the parsed string or NULL if failed

Since

version 3.6.0

Definition at line 125 of file json.c.

{
#if defined(WITH_JSONC)
  WINPR_ASSERT(buffer_length <= INT_MAX);
  json_tokener* tok = json_tokener_new();
  if (!tok)
    return NULL;
  json_object* obj = json_tokener_parse_ex(tok, value, (int)buffer_length);
  json_tokener_free(tok);
  return obj;
#elif defined(WITH_CJSON)
  return cJSON_ParseWithLength(value, buffer_length);
#else
  WINPR_UNUSED(value);
  WINPR_UNUSED(buffer_length);
  return NULL;
#endif
}

Referenced by freerdp_settings_deserialize(), and WINPR_JSON_ParseFromFileFP().

Here is the caller graph for this function:

WINPR_JSON_Print()

WINPR_API char * WINPR_JSON_Print

(

WINPR_JSON *

item

)

Serialize a JSON instance to string for minimal size without formatting see WINPR_JSON_PrintUnformatted.

Parameters

item	The JSON instance to serialize

Returns

A string representation of the JSON instance or NULL

Since

version 3.6.0

Definition at line 654 of file json.c.

{
#if defined(WITH_JSONC)
  const char* str = json_object_to_json_string_ext((json_object*)item, JSON_C_TO_STRING_PRETTY);
  if (!str)
    return NULL;
  return _strdup(str);
#elif defined(WITH_CJSON)
  return cJSON_Print((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return NULL;
#endif
}

Referenced by freerdp_settings_serialize().

Here is the caller graph for this function:

WINPR_JSON_PrintUnformatted()

WINPR_API char * WINPR_JSON_PrintUnformatted

(

WINPR_JSON *

item

)

Serialize a JSON instance to string without formatting for human readable formatted output see WINPR_JSON_Print.

Parameters

item	The JSON instance to serialize

Returns

A string representation of the JSON instance or NULL

Since

version 3.6.0

Definition at line 669 of file json.c.

{
#if defined(WITH_JSONC)
  const char* str = json_object_to_json_string_ext((json_object*)item, JSON_C_TO_STRING_PLAIN);
  if (!str)
    return NULL;
  return _strdup(str);
#elif defined(WITH_CJSON)
  return cJSON_PrintUnformatted((const cJSON*)item);
#else
  WINPR_UNUSED(item);
  return NULL;
#endif
}

Referenced by freerdp_settings_serialize().

Here is the caller graph for this function:

WINPR_JSON_version()

WINPR_API int WINPR_JSON_version	(	char *	buffer,
		size_t	len
	)

Get the library version string.

Parameters

buffer	a string buffer to hold the version string
len	the length of the buffer

Returns

length of the version string in bytes or negative for error

Since

version 3.6.0

FreeRDP: A Remote Desktop Protocol Implementation JSON parser wrapper

Copyright 2024 Armin Novak anova.nosp@m.k@th.nosp@m.incas.nosp@m.t.co.nosp@m.m Copyright 2024 Thincast Technologies GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition at line 101 of file json.c.

{
#if defined(WITH_JSONC)
  return _snprintf(buffer, len, "json-c %s", json_c_version());
#elif defined(WITH_CJSON)
  return _snprintf(buffer, len, "cJSON %s", cJSON_Version());
#else
  (void)_snprintf(buffer, len, "JSON support not available");
  return -1;
#endif
}