FreeRDP
Loading...
Searching...
No Matches
json.h
1
21#ifndef WINPR_UTILS_JSON
22#define WINPR_UTILS_JSON
23
24#include <winpr/winpr.h>
25#include <winpr/string.h>
26#include <winpr/wtypes.h>
27
34#ifdef __cplusplus
35extern "C"
36{
37#endif
38
39 typedef void WINPR_JSON;
40
49 WINPR_ATTR_NODISCARD
50 WINPR_API int WINPR_JSON_version(char* buffer, size_t len);
51
58 WINPR_API void WINPR_JSON_Delete(WINPR_JSON* item);
59
67 WINPR_ATTR_MALLOC(WINPR_JSON_Delete, 1)
68 WINPR_API WINPR_JSON* WINPR_JSON_Parse(const char* value);
69
78 WINPR_ATTR_MALLOC(WINPR_JSON_Delete, 1)
79 WINPR_API WINPR_JSON* WINPR_JSON_ParseWithLength(const char* value, size_t buffer_length);
80
88 WINPR_ATTR_MALLOC(WINPR_JSON_Delete, 1)
89 WINPR_API WINPR_JSON* WINPR_JSON_ParseFromFile(const char* filename);
90
98 WINPR_ATTR_MALLOC(WINPR_JSON_Delete, 1)
99 WINPR_API WINPR_JSON* WINPR_JSON_ParseFromFileFP(FILE* fp);
100
108 WINPR_ATTR_NODISCARD
109 WINPR_API size_t WINPR_JSON_GetArraySize(const WINPR_JSON* array);
110
119 WINPR_ATTR_NODISCARD
120 WINPR_API WINPR_JSON* WINPR_JSON_GetArrayItem(const WINPR_JSON* array, size_t index);
121
130 WINPR_ATTR_NODISCARD
131 WINPR_API WINPR_JSON* WINPR_JSON_GetObjectItem(const WINPR_JSON* object, const char* string);
132
141 WINPR_ATTR_NODISCARD
142 WINPR_API WINPR_JSON* WINPR_JSON_GetObjectItemCaseSensitive(const WINPR_JSON* object,
143 const char* string);
144
152 WINPR_ATTR_NODISCARD
153 WINPR_API BOOL WINPR_JSON_HasObjectItem(const WINPR_JSON* object, const char* string);
154
160 WINPR_ATTR_NODISCARD
161 WINPR_API const char* WINPR_JSON_GetErrorPtr(void);
162
169 WINPR_ATTR_NODISCARD
170 WINPR_API const char* WINPR_JSON_GetStringValue(WINPR_JSON* item);
171
178 WINPR_ATTR_NODISCARD
179 WINPR_API double WINPR_JSON_GetNumberValue(const WINPR_JSON* item);
180
187 WINPR_ATTR_NODISCARD
188 WINPR_API BOOL WINPR_JSON_IsInvalid(const WINPR_JSON* item);
189
196 WINPR_ATTR_NODISCARD
197 WINPR_API BOOL WINPR_JSON_IsFalse(const WINPR_JSON* item);
198
205 WINPR_ATTR_NODISCARD
206 WINPR_API BOOL WINPR_JSON_IsTrue(const WINPR_JSON* item);
207
214 WINPR_ATTR_NODISCARD
215 WINPR_API BOOL WINPR_JSON_IsBool(const WINPR_JSON* item);
216
223 WINPR_ATTR_NODISCARD
224 WINPR_API BOOL WINPR_JSON_IsNull(const WINPR_JSON* item);
225
232 WINPR_ATTR_NODISCARD
233 WINPR_API BOOL WINPR_JSON_IsNumber(const WINPR_JSON* item);
234
241 WINPR_ATTR_NODISCARD
242 WINPR_API BOOL WINPR_JSON_IsString(const WINPR_JSON* item);
243
250 WINPR_ATTR_NODISCARD
251 WINPR_API BOOL WINPR_JSON_IsArray(const WINPR_JSON* item);
252
259 WINPR_ATTR_NODISCARD
260 WINPR_API BOOL WINPR_JSON_IsObject(const WINPR_JSON* item);
261
267 WINPR_ATTR_NODISCARD
268 WINPR_API WINPR_JSON* WINPR_JSON_CreateNull(void);
269
275 WINPR_ATTR_NODISCARD
276 WINPR_API WINPR_JSON* WINPR_JSON_CreateTrue(void);
277
283 WINPR_ATTR_NODISCARD
284 WINPR_API WINPR_JSON* WINPR_JSON_CreateFalse(void);
285
292 WINPR_ATTR_NODISCARD
293 WINPR_API WINPR_JSON* WINPR_JSON_CreateBool(BOOL boolean);
294
301 WINPR_ATTR_NODISCARD
302 WINPR_API WINPR_JSON* WINPR_JSON_CreateNumber(double num);
303
310 WINPR_ATTR_NODISCARD
311 WINPR_API WINPR_JSON* WINPR_JSON_CreateString(const char* string);
312
318 WINPR_ATTR_NODISCARD
319 WINPR_API WINPR_JSON* WINPR_JSON_CreateArray(void);
320
326 WINPR_ATTR_NODISCARD
327 WINPR_API WINPR_JSON* WINPR_JSON_CreateObject(void);
328
336 WINPR_ATTR_NODISCARD
337 WINPR_API WINPR_JSON* WINPR_JSON_AddNullToObject(WINPR_JSON* object, const char* name);
338
346 WINPR_ATTR_NODISCARD
347 WINPR_API WINPR_JSON* WINPR_JSON_AddTrueToObject(WINPR_JSON* object, const char* name);
348
356 WINPR_ATTR_NODISCARD
357 WINPR_API WINPR_JSON* WINPR_JSON_AddFalseToObject(WINPR_JSON* object, const char* name);
358
366 WINPR_ATTR_NODISCARD
367 WINPR_API WINPR_JSON* WINPR_JSON_AddBoolToObject(WINPR_JSON* object, const char* name,
368 BOOL boolean);
369
377 WINPR_ATTR_NODISCARD
378 WINPR_API WINPR_JSON* WINPR_JSON_AddNumberToObject(WINPR_JSON* object, const char* name,
379 double number);
380
388 WINPR_ATTR_NODISCARD
389 WINPR_API WINPR_JSON* WINPR_JSON_AddIntegerToObject(WINPR_JSON* object, const char* name,
390 int64_t number);
391
399 WINPR_ATTR_NODISCARD
400 WINPR_API WINPR_JSON* WINPR_JSON_AddStringToObject(WINPR_JSON* object, const char* name,
401 const char* string);
402
410 WINPR_ATTR_NODISCARD
411 WINPR_API WINPR_JSON* WINPR_JSON_AddObjectToObject(WINPR_JSON* object, const char* name);
412
420 WINPR_ATTR_NODISCARD
421 WINPR_API WINPR_JSON* WINPR_JSON_AddArrayToObject(WINPR_JSON* object, const char* name);
422
430 WINPR_ATTR_NODISCARD
431 WINPR_API BOOL WINPR_JSON_AddItemToArray(WINPR_JSON* array, WINPR_JSON* item);
432
441 WINPR_ATTR_MALLOC(free, 1)
442 WINPR_API char* WINPR_JSON_Print(WINPR_JSON* item);
443
452 WINPR_ATTR_MALLOC(free, 1)
453 WINPR_API char* WINPR_JSON_PrintUnformatted(WINPR_JSON* item);
454
455#ifdef __cplusplus
456}
457#endif
458
461#endif
WINPR_JSON_CreateString
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_CreateString(const char *string)
WINPR_JSON_CreateString.
Definition c-json.c:222
WINPR_JSON_CreateNull
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_CreateNull(void)
WINPR_JSON_CreateNull.
Definition c-json.c:197
WINPR_JSON_IsNull
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsNull(const WINPR_JSON *item)
Check if JSON item is Null.
Definition c-json.c:172
WINPR_JSON_CreateTrue
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_CreateTrue(void)
WINPR_JSON_CreateTrue.
Definition c-json.c:202
WINPR_JSON_CreateNumber
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_CreateNumber(double num)
WINPR_JSON_CreateNumber.
Definition c-json.c:217
WINPR_JSON_AddObjectToObject
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_AddObjectToObject(WINPR_JSON *object, const char *name)
WINPR_JSON_AddObjectToObject.
Definition c-json.c:274
WINPR_JSON_CreateObject
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_CreateObject(void)
WINPR_JSON_CreateObject.
Definition c-json.c:232
WINPR_JSON_HasObjectItem
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_HasObjectItem(const WINPR_JSON *object, const char *string)
Check if JSON has an object matching the name.
Definition c-json.c:132
WINPR_JSON_ParseFromFileFP
WINPR_API WINPR_JSON * WINPR_JSON_ParseFromFileFP(FILE *fp)
Parse a JSON string read from a FILE.
Definition json.c:37
WINPR_JSON_IsBool
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsBool(const WINPR_JSON *item)
Check if JSON item is of type BOOL.
Definition c-json.c:167
WINPR_JSON_AddItemToArray
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_AddItemToArray(WINPR_JSON *array, WINPR_JSON *item)
Add an item to an existing array.
Definition c-json.c:279
WINPR_JSON_IsInvalid
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsInvalid(const WINPR_JSON *item)
Check if JSON item is valid.
Definition c-json.c:152
WINPR_JSON_IsNumber
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsNumber(const WINPR_JSON *item)
Check if JSON item is of type Number.
Definition c-json.c:177
WINPR_JSON_version
WINPR_ATTR_NODISCARD WINPR_API int WINPR_JSON_version(char *buffer, size_t len)
Get the library version string.
Definition c-json.c:88
WINPR_JSON_GetArraySize
WINPR_ATTR_NODISCARD WINPR_API size_t WINPR_JSON_GetArraySize(const WINPR_JSON *array)
Get the number of arrayitems from an array.
Definition c-json.c:114
WINPR_JSON_CreateFalse
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_CreateFalse(void)
WINPR_JSON_CreateFalse.
Definition c-json.c:207
WINPR_JSON_AddIntegerToObject
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_AddIntegerToObject(WINPR_JSON *object, const char *name, int64_t number)
WINPR_JSON_AddIntegerToObject.
Definition c-json.c:262
WINPR_JSON_AddFalseToObject
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_AddFalseToObject(WINPR_JSON *object, const char *name)
WINPR_JSON_AddFalseToObject.
Definition c-json.c:247
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_PrintUnformatt...
Definition c-json.c:296
WINPR_JSON_IsTrue
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsTrue(const WINPR_JSON *item)
Check if JSON item is BOOL value True.
Definition c-json.c:162
WINPR_JSON_ParseFromFile
WINPR_API WINPR_JSON * WINPR_JSON_ParseFromFile(const char *filename)
Parse a JSON string read from a file filename.
Definition json.c:27
WINPR_JSON_AddTrueToObject
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_AddTrueToObject(WINPR_JSON *object, const char *name)
WINPR_JSON_AddTrueToObject.
Definition c-json.c:242
WINPR_JSON_GetObjectItemCaseSensitive
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_GetObjectItemCaseSensitive(const WINPR_JSON *object, const char *string)
Same as WINPR_JSON_GetObjectItem but with case sensitive matching.
Definition c-json.c:127
WINPR_JSON_AddNumberToObject
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_AddNumberToObject(WINPR_JSON *object, const char *name, double number)
WINPR_JSON_AddNumberToObject.
Definition c-json.c:257
WINPR_JSON_GetObjectItem
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_GetObjectItem(const WINPR_JSON *object, const char *string)
Return a pointer to an JSON object item.
Definition c-json.c:122
WINPR_JSON_IsFalse
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsFalse(const WINPR_JSON *item)
Check if JSON item is BOOL value False.
Definition c-json.c:157
WINPR_JSON_ParseWithLength
WINPR_API WINPR_JSON * WINPR_JSON_ParseWithLength(const char *value, size_t buffer_length)
Parse a JSON string.
Definition c-json.c:98
WINPR_JSON_GetErrorPtr
WINPR_ATTR_NODISCARD WINPR_API const char * WINPR_JSON_GetErrorPtr(void)
Return an error string.
Definition c-json.c:137
WINPR_JSON_AddArrayToObject
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_AddArrayToObject(WINPR_JSON *object, const char *name)
WINPR_JSON_AddArrayToObject.
Definition c-json.c:291
WINPR_JSON_IsString
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsString(const WINPR_JSON *item)
Check if JSON item is of type String.
Definition c-json.c:182
WINPR_JSON_GetArrayItem
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_GetArrayItem(const WINPR_JSON *array, size_t index)
Return a pointer to an item in the array.
Definition c-json.c:108
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_...
Definition c-json.c:301
WINPR_JSON_GetNumberValue
WINPR_ATTR_NODISCARD WINPR_API double WINPR_JSON_GetNumberValue(const WINPR_JSON *item)
Return the Number value of a JSON item.
Definition c-json.c:147
WINPR_JSON_CreateBool
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_CreateBool(BOOL boolean)
WINPR_JSON_CreateBool.
Definition c-json.c:212
WINPR_JSON_IsArray
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsArray(const WINPR_JSON *item)
Check if JSON item is of type Array.
Definition c-json.c:187
WINPR_JSON_IsObject
WINPR_ATTR_NODISCARD WINPR_API BOOL WINPR_JSON_IsObject(const WINPR_JSON *item)
Check if JSON item is of type Object.
Definition c-json.c:192
WINPR_JSON_AddNullToObject
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_AddNullToObject(WINPR_JSON *object, const char *name)
WINPR_JSON_AddNullToObject.
Definition c-json.c:237
WINPR_JSON_AddStringToObject
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_AddStringToObject(WINPR_JSON *object, const char *name, const char *string)
WINPR_JSON_AddStringToObject.
Definition c-json.c:269
WINPR_JSON_Delete
WINPR_API void WINPR_JSON_Delete(WINPR_JSON *item)
Delete a WinPR JSON wrapper object.
Definition c-json.c:103
WINPR_JSON_CreateArray
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_CreateArray(void)
WINPR_JSON_CreateArray.
Definition c-json.c:227
WINPR_JSON_GetStringValue
WINPR_ATTR_NODISCARD WINPR_API const char * WINPR_JSON_GetStringValue(WINPR_JSON *item)
Return the String value of a JSON item.
Definition c-json.c:142
WINPR_JSON_AddBoolToObject
WINPR_ATTR_NODISCARD WINPR_API WINPR_JSON * WINPR_JSON_AddBoolToObject(WINPR_JSON *object, const char *name, BOOL boolean)
WINPR_JSON_AddBoolToObject.
Definition c-json.c:252
WINPR_JSON_Parse
WINPR_API WINPR_JSON * WINPR_JSON_Parse(const char *value)
Parse a '\0' terminated JSON string.
Definition c-json.c:93