1 /* 2 Parson ( http://kgabis.github.com/parson/ ) 3 Copyright (c) 2012 - 2016 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 28 extern "C" 29 { 30 #endif 31 32 #include <stddef.h> /* size_t */ 33 34 /* Types and enums */ 35 typedef struct x_json_object_t x_JSON_Object; 36 typedef struct x_json_array_t x_JSON_Array; 37 typedef struct x_json_value_t x_JSON_Value; 38 39 enum x_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 }; 48 typedef int x_JSON_Value_Type; 49 50 enum x_json_result_t { 51 JSONSuccess = 0, 52 JSONFailure = -1 53 }; 54 typedef int x_JSON_Status; 55 56 typedef void * (*x_JSON_Malloc_Function)(size_t); 57 typedef void(*x_JSON_Free_Function)(void *); 58 59 /* Call only once, before calling any other function from parson API. If not called, malloc and free 60 from stdlib will be used for all allocations */ 61 void x_json_set_allocation_functions(x_JSON_Malloc_Function malloc_fun, x_JSON_Free_Function free_fun); 62 63 /* Parses first JSON value in a file, returns NULL in case of error */ 64 x_JSON_Value * x_json_parse_file(const char *filename); 65 66 /* Parses first JSON value in a file and ignores comments (/ * * / and //), 67 returns NULL in case of error */ 68 x_JSON_Value * x_json_parse_file_with_comments(const char *filename); 69 70 /* Parses first JSON value in a string, returns NULL in case of error */ 71 x_JSON_Value * x_json_parse_string(const char *string); 72 73 /* Parses first JSON value in a string and ignores comments (/ * * / and //), 74 returns NULL in case of error */ 75 x_JSON_Value * x_json_parse_string_with_comments(const char *string); 76 77 /* Serialization */ 78 size_t x_json_serialization_size(const x_JSON_Value *value); /* returns 0 on fail */ 79 x_JSON_Status x_json_serialize_to_buffer(const x_JSON_Value *value, char *buf, size_t buf_size_in_bytes); 80 x_JSON_Status x_json_serialize_to_file(const x_JSON_Value *value, const char *filename); 81 char * x_json_serialize_to_string(const x_JSON_Value *value); 82 83 /* Pretty serialization */ 84 size_t x_json_serialization_size_pretty(const x_JSON_Value *value); /* returns 0 on fail */ 85 x_JSON_Status x_json_serialize_to_buffer_pretty(const x_JSON_Value *value, char *buf, size_t buf_size_in_bytes); 86 x_JSON_Status x_json_serialize_to_file_pretty(const x_JSON_Value *value, const char *filename); 87 char * x_json_serialize_to_string_pretty(const x_JSON_Value *value); 88 89 void x_json_free_serialized_string(char *string); /* frees string from x_json_serialize_to_string and x_json_serialize_to_string_pretty */ 90 91 /* Comparing */ 92 int x_json_value_equals(const x_JSON_Value *a, const x_JSON_Value *b); 93 94 /* Validation 95 This is *NOT* JSON Schema. It validates json by checking if object have identically 96 named fields with matching types. 97 For example schema {"name":"", "age":0} will validate 98 {"name":"Joe", "age":25} and {"name":"Joe", "age":25, "gender":"m"}, 99 but not {"name":"Joe"} or {"name":"Joe", "age":"Cucumber"}. 100 In case of arrays, only first value in schema is checked against all values in tested array. 101 Empty objects ({}) validate all objects, empty arrays ([]) validate all arrays, 102 null validates values of every type. 103 */ 104 x_JSON_Status x_json_validate(const x_JSON_Value *schema, const x_JSON_Value *value); 105 106 /* 107 * JSON Object 108 */ 109 x_JSON_Value * x_json_object_get_value(const x_JSON_Object *object, const char *name); 110 const char * x_json_object_get_string(const x_JSON_Object *object, const char *name); 111 x_JSON_Object * x_json_object_get_object(const x_JSON_Object *object, const char *name); 112 x_JSON_Array * x_json_object_get_array(const x_JSON_Object *object, const char *name); 113 double x_json_object_get_number(const x_JSON_Object *object, const char *name); /* returns 0 on fail */ 114 int x_json_object_get_boolean(const x_JSON_Object *object, const char *name); /* returns -1 on fail */ 115 116 /* dotget functions enable addressing values with dot notation in nested objects, 117 just like in structs or c++/java/c# objects (e.g. objectA.objectB.value). 118 Because valid names in JSON can contain dots, some values may be inaccessible 119 this way. */ 120 x_JSON_Value * x_json_object_dotget_value(const x_JSON_Object *object, const char *name); 121 const char * x_json_object_dotget_string(const x_JSON_Object *object, const char *name); 122 x_JSON_Object * x_json_object_dotget_object(const x_JSON_Object *object, const char *name); 123 x_JSON_Array * x_json_object_dotget_array(const x_JSON_Object *object, const char *name); 124 double x_json_object_dotget_number(const x_JSON_Object *object, const char *name); /* returns 0 on fail */ 125 int x_json_object_dotget_boolean(const x_JSON_Object *object, const char *name); /* returns -1 on fail */ 126 127 /* Functions to get available names */ 128 size_t x_json_object_get_count(const x_JSON_Object *object); 129 const char * x_json_object_get_name(const x_JSON_Object *object, size_t index); 130 x_JSON_Value * x_json_object_get_value_at(const x_JSON_Object *object, size_t index); 131 132 /* Functions to check if object has a value with a specific name. Returned value is 1 if object has 133 * a value and 0 if it doesn't. dothas functions behave exactly like dotget functions. */ 134 int x_json_object_has_value(const x_JSON_Object *object, const char *name); 135 int x_json_object_has_value_of_type(const x_JSON_Object *object, const char *name, x_JSON_Value_Type type); 136 137 int x_json_object_dothas_value(const x_JSON_Object *object, const char *name); 138 int x_json_object_dothas_value_of_type(const x_JSON_Object *object, const char *name, x_JSON_Value_Type type); 139 140 /* Creates new name-value pair or frees and replaces old value with a new one. 141 * x_json_object_set_value does not copy passed value so it shouldn't be freed afterwards. */ 142 x_JSON_Status x_json_object_set_value(x_JSON_Object *object, const char *name, x_JSON_Value *value); 143 x_JSON_Status x_json_object_set_string(x_JSON_Object *object, const char *name, const char *string); 144 x_JSON_Status x_json_object_set_number(x_JSON_Object *object, const char *name, double number); 145 x_JSON_Status x_json_object_set_boolean(x_JSON_Object *object, const char *name, int boolean); 146 x_JSON_Status x_json_object_set_null(x_JSON_Object *object, const char *name); 147 148 /* Works like dotget functions, but creates whole hierarchy if necessary. 149 * x_json_object_dotset_value does not copy passed value so it shouldn't be freed afterwards. */ 150 x_JSON_Status x_json_object_dotset_value(x_JSON_Object *object, const char *name, x_JSON_Value *value); 151 x_JSON_Status x_json_object_dotset_string(x_JSON_Object *object, const char *name, const char *string); 152 x_JSON_Status x_json_object_dotset_number(x_JSON_Object *object, const char *name, double number); 153 x_JSON_Status x_json_object_dotset_boolean(x_JSON_Object *object, const char *name, int boolean); 154 x_JSON_Status x_json_object_dotset_null(x_JSON_Object *object, const char *name); 155 156 /* Frees and removes name-value pair */ 157 x_JSON_Status x_json_object_remove(x_JSON_Object *object, const char *name); 158 159 /* Works like dotget function, but removes name-value pair only on exact match. */ 160 x_JSON_Status x_json_object_dotremove(x_JSON_Object *object, const char *key); 161 162 /* Removes all name-value pairs in object */ 163 x_JSON_Status x_json_object_clear(x_JSON_Object *object); 164 165 /* 166 *JSON Array 167 */ 168 x_JSON_Value * x_json_array_get_value(const x_JSON_Array *array, size_t index); 169 const char * x_json_array_get_string(const x_JSON_Array *array, size_t index); 170 x_JSON_Object * x_json_array_get_object(const x_JSON_Array *array, size_t index); 171 x_JSON_Array * x_json_array_get_array(const x_JSON_Array *array, size_t index); 172 double x_json_array_get_number(const x_JSON_Array *array, size_t index); /* returns 0 on fail */ 173 int x_json_array_get_boolean(const x_JSON_Array *array, size_t index); /* returns -1 on fail */ 174 size_t x_json_array_get_count(const x_JSON_Array *array); 175 176 /* Frees and removes value at given index, does nothing and returns JSONFailure if index doesn't exist. 177 * Order of values in array may change during execution. */ 178 x_JSON_Status x_json_array_remove(x_JSON_Array *array, size_t i); 179 180 /* Frees and removes from array value at given index and replaces it with given one. 181 * Does nothing and returns JSONFailure if index doesn't exist. 182 * x_json_array_replace_value does not copy passed value so it shouldn't be freed afterwards. */ 183 x_JSON_Status x_json_array_replace_value(x_JSON_Array *array, size_t i, x_JSON_Value *value); 184 x_JSON_Status x_json_array_replace_string(x_JSON_Array *array, size_t i, const char* string); 185 x_JSON_Status x_json_array_replace_number(x_JSON_Array *array, size_t i, double number); 186 x_JSON_Status x_json_array_replace_boolean(x_JSON_Array *array, size_t i, int boolean); 187 x_JSON_Status x_json_array_replace_null(x_JSON_Array *array, size_t i); 188 189 /* Frees and removes all values from array */ 190 x_JSON_Status x_json_array_clear(x_JSON_Array *array); 191 192 /* Appends new value at the end of array. 193 * x_json_array_append_value does not copy passed value so it shouldn't be freed afterwards. */ 194 x_JSON_Status x_json_array_append_value(x_JSON_Array *array, x_JSON_Value *value); 195 x_JSON_Status x_json_array_append_string(x_JSON_Array *array, const char *string); 196 x_JSON_Status x_json_array_append_number(x_JSON_Array *array, double number); 197 x_JSON_Status x_json_array_append_boolean(x_JSON_Array *array, int boolean); 198 x_JSON_Status x_json_array_append_null(x_JSON_Array *array); 199 200 /* 201 *JSON Value 202 */ 203 x_JSON_Value * x_json_value_init_object(void); 204 x_JSON_Value * x_json_value_init_array(void); 205 x_JSON_Value * x_json_value_init_string(const char *string); /* copies passed string */ 206 x_JSON_Value * x_json_value_init_number(double number); 207 x_JSON_Value * x_json_value_init_boolean(int boolean); 208 x_JSON_Value * x_json_value_init_null(void); 209 x_JSON_Value * x_json_value_deep_copy(const x_JSON_Value *value); 210 void x_json_value_free(x_JSON_Value *value); 211 212 x_JSON_Value_Type x_json_value_get_type(const x_JSON_Value *value); 213 x_JSON_Object * x_json_value_get_object(const x_JSON_Value *value); 214 x_JSON_Array * x_json_value_get_array(const x_JSON_Value *value); 215 const char * x_json_value_get_string(const x_JSON_Value *value); 216 double x_json_value_get_number(const x_JSON_Value *value); 217 int x_json_value_get_boolean(const x_JSON_Value *value); 218 219 /* Same as above, but shorter */ 220 x_JSON_Value_Type x_json_type(const x_JSON_Value *value); 221 x_JSON_Object * x_json_object(const x_JSON_Value *value); 222 x_JSON_Array * x_json_array(const x_JSON_Value *value); 223 const char * x_json_string(const x_JSON_Value *value); 224 double x_json_number(const x_JSON_Value *value); 225 int x_json_boolean(const x_JSON_Value *value); 226 227 #ifdef __cplusplus 228 } 229 #endif 230 231 #endif