Wrapper around cJSON, JSONC or jansson 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 sensitive 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_AddIntegerToObject (WINPR_JSON object, const char name, int64_t number)
	WINPR_JSON_AddIntegerToObject.

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, JSONC or jansson libraries.

FreeRDP: A Remote Desktop Protocol Implementation JSON parser wrapper

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 291 of file c-json.c.

{
  return cJSON_AddArrayToObject((cJSON*)object, name);
}

◆ 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 252 of file c-json.c.

{
  return cJSON_AddBoolToObject((cJSON*)object, name, boolean);
}

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 247 of file c-json.c.

{
  return cJSON_AddFalseToObject((cJSON*)object, name);
}

◆ WINPR_JSON_AddIntegerToObject()

WINPR_API WINPR_JSON * WINPR_JSON_AddIntegerToObject	(	WINPR_JSON *	object,
		const char *	name,
		int64_t	number
	)

WINPR_JSON_AddIntegerToObject.

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 262 of file c-json.c.

{
  char str[64] = { 0 };
  (void)_snprintf(str, sizeof(str), "%" PRId64, number);
  return cJSON_AddRawToObject((cJSON*)object, name, str);
}

◆ 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 279 of file c-json.c.

{
#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
}

◆ 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 237 of file c-json.c.

{
  return cJSON_AddNullToObject((cJSON*)object, name);
}

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 257 of file c-json.c.

{
  return cJSON_AddNumberToObject((cJSON*)object, name, number);
}

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 274 of file c-json.c.

{
  return cJSON_AddObjectToObject((cJSON*)object, name);
}

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 269 of file c-json.c.

{
  return cJSON_AddStringToObject((cJSON*)object, name, string);
}

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 242 of file c-json.c.

{
  return cJSON_AddTrueToObject((cJSON*)object, name);
}

◆ 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 227 of file c-json.c.

{
  return cJSON_CreateArray();
}

◆ 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 212 of file c-json.c.

{
  return cJSON_CreateBool(boolean);
}

◆ 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 207 of file c-json.c.

{
  return cJSON_CreateFalse();
}

◆ 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 197 of file c-json.c.

{
  return cJSON_CreateNull();
}

◆ 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 217 of file c-json.c.

{
  return cJSON_CreateNumber(num);
}

◆ 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 232 of file c-json.c.

{
  return cJSON_CreateObject();
}

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 222 of file c-json.c.

{
  return cJSON_CreateString(string);
}

◆ 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 202 of file c-json.c.

{
  return cJSON_CreateTrue();
}

◆ 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 103 of file c-json.c.

{
  cJSON_Delete((cJSON*)item);
}

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 108 of file c-json.c.

{
  WINPR_ASSERT(index <= INT_MAX);
  return cJSON_GetArrayItem((const cJSON*)array, (INT)index);
}

◆ 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 114 of file c-json.c.

{
  const int rc = cJSON_GetArraySize((const cJSON*)array);
  if (rc <= 0)
    return 0;
  return (size_t)rc;
}

◆ 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 137 of file c-json.c.

{
  return cJSON_GetErrorPtr();
}

◆ 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 147 of file c-json.c.

{
  return cJSON_GetNumberValue((const cJSON*)item);
}

◆ 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 (case is ignored)

Returns: A pointer to the object identified by string or NULL

Since: version 3.6.0

Definition at line 122 of file c-json.c.

{
  return cJSON_GetObjectItem((const cJSON*)object, string);
}

◆ 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 sensitive 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 127 of file c-json.c.

{
  return cJSON_GetObjectItemCaseSensitive((const cJSON*)object, string);
}

Referenced by freerdp_settings_deserialize().

Here is the caller graph for this function:

◆ 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 142 of file c-json.c.

{
  return cJSON_GetStringValue((cJSON*)item);
}

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 132 of file c-json.c.

{
  return cJSON_HasObjectItem((const cJSON*)object, string);
}

◆ 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 187 of file c-json.c.

{
  return cJSON_IsArray((const cJSON*)item);
}

Referenced by WINPR_JSON_IsInvalid(), and 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 167 of file c-json.c.

{
  return cJSON_IsBool((const cJSON*)item);
}

Referenced by freerdp_settings_deserialize(), WINPR_JSON_IsInvalid(), 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 157 of file c-json.c.

{
  return cJSON_IsFalse((const cJSON*)item);
}

◆ 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 152 of file c-json.c.

{
  return cJSON_IsInvalid((const cJSON*)item);
}

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 172 of file c-json.c.

{
  return cJSON_IsNull((const cJSON*)item);
}

Referenced by freerdp_settings_deserialize(), WINPR_JSON_IsInvalid(), 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 177 of file c-json.c.

{
  return cJSON_IsNumber((const cJSON*)item);
}

Referenced by WINPR_JSON_IsInvalid(), and 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 192 of file c-json.c.

{
  return cJSON_IsObject((const cJSON*)item);
}

Referenced by WINPR_JSON_IsInvalid(), and 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 182 of file c-json.c.

{
  return cJSON_IsString((const cJSON*)item);
}

Referenced by freerdp_settings_deserialize(), WINPR_JSON_IsInvalid(), 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 162 of file c-json.c.

{
  return cJSON_IsTrue((const cJSON*)item);
}

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 93 of file c-json.c.

{
  return cJSON_Parse(value);
}

◆ 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

FreeRDP: A Remote Desktop Protocol Implementation JSON parser wrapper

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 27 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 37 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 98 of file c-json.c.

{
  return cJSON_ParseWithLength(value, buffer_length);
}

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 296 of file c-json.c.

{
  return cJSON_Print((const cJSON*)item);
}

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 301 of file c-json.c.

{
  return cJSON_PrintUnformatted((const cJSON*)item);
}

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

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 88 of file c-json.c.

{
  return _snprintf(buffer, len, "cJSON %s", cJSON_Version());
}

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ WINPR_JSON

Function Documentation

◆ WINPR_JSON_AddArrayToObject()

◆ WINPR_JSON_AddBoolToObject()

◆ WINPR_JSON_AddFalseToObject()

◆ WINPR_JSON_AddIntegerToObject()

◆ WINPR_JSON_AddItemToArray()

◆ WINPR_JSON_AddNullToObject()

◆ WINPR_JSON_AddNumberToObject()

◆ WINPR_JSON_AddObjectToObject()

◆ WINPR_JSON_AddStringToObject()

◆ WINPR_JSON_AddTrueToObject()

◆ WINPR_JSON_CreateArray()

◆ WINPR_JSON_CreateBool()

◆ WINPR_JSON_CreateFalse()

◆ WINPR_JSON_CreateNull()

◆ WINPR_JSON_CreateNumber()

◆ WINPR_JSON_CreateObject()

◆ WINPR_JSON_CreateString()

◆ WINPR_JSON_CreateTrue()

◆ WINPR_JSON_Delete()

◆ WINPR_JSON_GetArrayItem()

◆ WINPR_JSON_GetArraySize()

◆ WINPR_JSON_GetErrorPtr()

◆ WINPR_JSON_GetNumberValue()

◆ WINPR_JSON_GetObjectItem()

◆ WINPR_JSON_GetObjectItemCaseSensitive()

◆ WINPR_JSON_GetStringValue()

◆ WINPR_JSON_HasObjectItem()

◆ WINPR_JSON_IsArray()

◆ WINPR_JSON_IsBool()

◆ WINPR_JSON_IsFalse()

◆ WINPR_JSON_IsInvalid()

◆ WINPR_JSON_IsNull()

◆ WINPR_JSON_IsNumber()

◆ WINPR_JSON_IsObject()

◆ WINPR_JSON_IsString()

◆ WINPR_JSON_IsTrue()

◆ WINPR_JSON_Parse()

◆ WINPR_JSON_ParseFromFile()

◆ WINPR_JSON_ParseFromFileFP()

◆ WINPR_JSON_ParseWithLength()

◆ WINPR_JSON_Print()

◆ WINPR_JSON_PrintUnformatted()

◆ WINPR_JSON_version()