source: lib/parson.h @ 5726a0d

Last change on this file since 5726a0d was ee170a1, checked in by Wilmer van der Gaast <wilmer@…>, at 2015-02-22T17:01:53Z

Added json_object_get_tuple() which helps with implementing a JSON Object
foreach.

  • Property mode set to 100644
File size: 9.7 KB
Line 
1/*
2 Parson ( http://kgabis.github.com/parson/ )
3 Copyright (c) 2012 - 2014 Krzysztof Gabis
4 
5 Permission is hereby granted, free of charge, to any person obtaining a copy
6 of this software and associated documentation files (the "Software"), to deal
7 in the Software without restriction, including without limitation the rights
8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 copies of the Software, and to permit persons to whom the Software is
10 furnished to do so, subject to the following conditions:
11 
12 The above copyright notice and this permission notice shall be included in
13 all copies or substantial portions of the Software.
14 
15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 THE SOFTWARE.
22*/
23
24#ifndef parson_parson_h
25#define parson_parson_h
26
27#ifdef __cplusplus
28extern "C"
29{
30#endif   
31   
32#include <stddef.h>   /* size_t */   
33   
34/* Types and enums */
35typedef struct json_object_t JSON_Object;
36typedef struct json_array_t  JSON_Array;
37typedef struct json_value_t  JSON_Value;
38
39enum json_value_type {
40    JSONError   = -1,
41    JSONNull    = 1,
42    JSONString  = 2,
43    JSONNumber  = 3,
44    JSONObject  = 4,
45    JSONArray   = 5,
46    JSONBoolean = 6
47};
48typedef int JSON_Value_Type;
49   
50enum json_result_t {
51    JSONSuccess = 0,
52    JSONFailure = -1
53};
54typedef int JSON_Status;
55   
56/* Parses first JSON value in a file, returns NULL in case of error */
57JSON_Value * json_parse_file(const char *filename);
58
59/* Parses first JSON value in a file and ignores comments (/ * * / and //),
60   returns NULL in case of error */
61JSON_Value * json_parse_file_with_comments(const char *filename);
62   
63/*  Like json_parse_string, but *end is set to wherever it stopped parsing. */
64JSON_Value * json_parse_first(const char *string, const char **end);
65 
66/*  Parses first JSON value in a string, returns NULL in case of error */
67JSON_Value * json_parse_string(const char *string);
68
69/*  Parses first JSON value in a string and ignores comments (/ * * / and //),
70    returns NULL in case of error */
71JSON_Value * json_parse_string_with_comments(const char *string);
72   
73/* Serialization */
74size_t      json_serialization_size(const JSON_Value *value);
75JSON_Status json_serialize_to_buffer(const JSON_Value *value, char *buf, size_t buf_size_in_bytes);
76JSON_Status json_serialize_to_file(const JSON_Value *value, const char *filename);
77char *      json_serialize_to_string(const JSON_Value *value);
78void        json_free_serialized_string(char *string); /* frees string from json_serialize_to_string */
79
80/* Comparing */
81int  json_value_equals(const JSON_Value *a, const JSON_Value *b);
82   
83/* Validation
84   This is *NOT* JSON Schema. It validates json by checking if object have identically
85   named fields with matching types.
86   For example schema {"name":"", "age":0} will validate
87   {"name":"Joe", "age":25} and {"name":"Joe", "age":25, "gender":"m"},
88   but not {"name":"Joe"} or {"name":"Joe", "age":"Cucumber"}.
89   In case of arrays, only first value in schema is checked against all values in tested array.
90   Empty objects ({}) validate all objects, empty arrays ([]) validate all arrays,
91   null validates values of every type.
92 */
93JSON_Status json_validate(const JSON_Value *schema, const JSON_Value *value);
94   
95/*
96 * JSON Object
97 */
98JSON_Value  * json_object_get_value  (const JSON_Object *object, const char *name);
99const char  * json_object_get_string (const JSON_Object *object, const char *name);
100JSON_Object * json_object_get_object (const JSON_Object *object, const char *name);
101JSON_Array  * json_object_get_array  (const JSON_Object *object, const char *name);
102double        json_object_get_number (const JSON_Object *object, const char *name); /* returns 0 on fail */
103int           json_object_get_boolean(const JSON_Object *object, const char *name); /* returns -1 on fail */
104
105/* dotget functions enable addressing values with dot notation in nested objects,
106 just like in structs or c++/java/c# objects (e.g. objectA.objectB.value).
107 Because valid names in JSON can contain dots, some values may be inaccessible
108 this way. */
109JSON_Value  * json_object_dotget_value  (const JSON_Object *object, const char *name);
110const char  * json_object_dotget_string (const JSON_Object *object, const char *name);
111JSON_Object * json_object_dotget_object (const JSON_Object *object, const char *name);
112JSON_Array  * json_object_dotget_array  (const JSON_Object *object, const char *name);
113double        json_object_dotget_number (const JSON_Object *object, const char *name); /* returns 0 on fail */
114int           json_object_dotget_boolean(const JSON_Object *object, const char *name); /* returns -1 on fail */
115
116/* Functions to get available names */
117size_t        json_object_get_count(const JSON_Object *object);
118const char  * json_object_get_name (const JSON_Object *object, size_t index);
119int           json_object_get_tuple(const JSON_Object *object, size_t index,
120                                    const char **key, const JSON_Value **value); /* 0 == fail */
121
122/* Creates new name-value pair or frees and replaces old value with new one. */
123JSON_Status json_object_set_value(JSON_Object *object, const char *name, JSON_Value *value);
124JSON_Status json_object_set_string(JSON_Object *object, const char *name, const char *string);
125JSON_Status json_object_set_number(JSON_Object *object, const char *name, double number);
126JSON_Status json_object_set_boolean(JSON_Object *object, const char *name, int boolean);
127JSON_Status json_object_set_null(JSON_Object *object, const char *name);
128
129/* Works like dotget functions, but creates whole hierarchy if necessary. */
130JSON_Status json_object_dotset_value(JSON_Object *object, const char *name, JSON_Value *value);
131JSON_Status json_object_dotset_string(JSON_Object *object, const char *name, const char *string);
132JSON_Status json_object_dotset_number(JSON_Object *object, const char *name, double number);
133JSON_Status json_object_dotset_boolean(JSON_Object *object, const char *name, int boolean);
134JSON_Status json_object_dotset_null(JSON_Object *object, const char *name);
135
136/* Frees and removes name-value pair */
137JSON_Status json_object_remove(JSON_Object *object, const char *name);
138
139/* Works like dotget function, but removes name-value pair only on exact match. */
140JSON_Status json_object_dotremove(JSON_Object *object, const char *key);
141
142/* Removes all name-value pairs in object */
143JSON_Status json_object_clear(JSON_Object *object);
144   
145/*
146 *JSON Array
147 */
148JSON_Value  * json_array_get_value  (const JSON_Array *array, size_t index);
149const char  * json_array_get_string (const JSON_Array *array, size_t index);
150JSON_Object * json_array_get_object (const JSON_Array *array, size_t index);
151JSON_Array  * json_array_get_array  (const JSON_Array *array, size_t index);
152double        json_array_get_number (const JSON_Array *array, size_t index); /* returns 0 on fail */
153int           json_array_get_boolean(const JSON_Array *array, size_t index); /* returns -1 on fail */
154size_t        json_array_get_count  (const JSON_Array *array);
155   
156/* Frees and removes value at given index, does nothing and returns JSONFailure if index doesn't exist.
157 * Order of values in array may change during execution.  */
158JSON_Status json_array_remove(JSON_Array *array, size_t i);
159
160/* Frees and removes from array value at given index and replaces it with given one.
161 * Does nothing and returns JSONFailure if index doesn't exist. */
162JSON_Status json_array_replace_value(JSON_Array *array, size_t i, JSON_Value *value);
163JSON_Status json_array_replace_string(JSON_Array *array, size_t i, const char* string);
164JSON_Status json_array_replace_number(JSON_Array *array, size_t i, double number);
165JSON_Status json_array_replace_boolean(JSON_Array *array, size_t i, int boolean);
166JSON_Status json_array_replace_null(JSON_Array *array, size_t i);
167
168/* Frees and removes all values from array */
169JSON_Status json_array_clear(JSON_Array *array);
170
171/* Appends new value at the end of array. */
172JSON_Status json_array_append_value(JSON_Array *array, JSON_Value *value);
173JSON_Status json_array_append_string(JSON_Array *array, const char *string);
174JSON_Status json_array_append_number(JSON_Array *array, double number);
175JSON_Status json_array_append_boolean(JSON_Array *array, int boolean);
176JSON_Status json_array_append_null(JSON_Array *array);
177   
178/*
179 *JSON Value
180 */
181JSON_Value * json_value_init_object (void);
182JSON_Value * json_value_init_array  (void);
183JSON_Value * json_value_init_string (const char *string); /* copies passed string */
184JSON_Value * json_value_init_number (double number);
185JSON_Value * json_value_init_boolean(int boolean);
186JSON_Value * json_value_init_null   (void);
187JSON_Value * json_value_deep_copy   (const JSON_Value *value);
188void         json_value_free        (JSON_Value *value);
189
190JSON_Value_Type json_value_get_type   (const JSON_Value *value);
191JSON_Object *   json_value_get_object (const JSON_Value *value);
192JSON_Array  *   json_value_get_array  (const JSON_Value *value);
193const char  *   json_value_get_string (const JSON_Value *value);
194double          json_value_get_number (const JSON_Value *value);
195int             json_value_get_boolean(const JSON_Value *value);
196
197/* Same as above, but shorter */
198JSON_Value_Type json_type   (const JSON_Value *value);
199JSON_Object *   json_object (const JSON_Value *value);
200JSON_Array  *   json_array  (const JSON_Value *value);
201const char  *   json_string (const JSON_Value *value);
202double          json_number (const JSON_Value *value);
203int             json_boolean(const JSON_Value *value);
204   
205#ifdef __cplusplus
206}
207#endif
208
209#endif
Note: See TracBrowser for help on using the repository browser.