1 /*
2   Copyright (c) 2009 Dave Gamble
3   Copyright (c) 2015-2021 The Khronos Group Inc.
4   Copyright (c) 2015-2021 Valve Corporation
5   Copyright (c) 2015-2021 LunarG, Inc.
6 
7   Permission is hereby granted, free of charge, to any person obtaining a copy
8   of this software and associated documentation files (the "Software"), to deal
9   in the Software without restriction, including without limitation the rights
10   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11   copies of the Software, and to permit persons to whom the Software is
12   furnished to do so, subject to the following conditions:
13 
14   The above copyright notice and this permission notice shall be included in
15   all copies or substantial portions of the Software.
16 
17   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23   THE SOFTWARE.
24 */
25 
26 #pragma once
27 
28 #include <stdint.h>
29 
30 #include <vulkan/vulkan_core.h>
31 
32 /* cJSON Types: */
33 #define cJSON_False 0
34 #define cJSON_True 1
35 #define cJSON_NULL 2
36 #define cJSON_Number 3
37 #define cJSON_String 4
38 #define cJSON_Array 5
39 #define cJSON_Object 6
40 
41 #define cJSON_IsReference 256
42 #define cJSON_StringIsConst 512
43 
44 /* The cJSON structure: */
45 typedef struct cJSON {
46     struct cJSON *next, *prev; /* next/prev allow you to walk array/object
47                                   chains. Alternatively, use
48                                   GetArraySize/GetArrayItem/GetObjectItem */
49     struct cJSON *child;       /* An array or object item will have a child pointer
50                                   pointing to a chain of the items in the
51                                   array/object. */
52 
53     int type; /* The type of the item, as above. */
54 
55     char *valuestring;  /* The item's string, if type==cJSON_String */
56     int valueint;       /* The item's number, if type==cJSON_Number */
57     double valuedouble; /* The item's number, if type==cJSON_Number */
58 
59     char *string; /* The item's name string, if this item is the child of, or is
60                      in the list of subitems of an object. */
61     /* pointer to the allocation callbacks to use */
62     VkAllocationCallbacks *pAllocator;
63 } cJSON;
64 
65 /* Render a cJSON entity to text for transfer/storage. Free the char* when
66  * finished. */
67 char *loader_cJSON_Print(cJSON *item);
68 /* Render a cJSON entity to text for transfer/storage without any formatting.
69  * Free the char* when finished. */
70 char *loader_cJSON_PrintUnformatted(cJSON *item);
71 /* Delete a cJSON entity and all subentities. */
72 void loader_cJSON_Delete(cJSON *c);
73 
74 /* Returns the number of items in an array (or object). */
75 int loader_cJSON_GetArraySize(cJSON *array);
76 /* Retrieve item number "item" from array "array". Returns NULL if unsuccessful.
77  */
78 cJSON *loader_cJSON_GetArrayItem(cJSON *array, int item);
79 /* Get item "string" from object. Case insensitive. */
80 cJSON *loader_cJSON_GetObjectItem(cJSON *object, const char *string);
81 
82 /* When assigning an integer value, it needs to be propagated to valuedouble
83  * too. */
84 #define cJSON_SetIntValue(object, val) ((object) ? (object)->valueint = (object)->valuedouble = (val) : (val))
85 #define cJSON_SetNumberValue(object, val) ((object) ? (object)->valueint = (object)->valuedouble = (val) : (val))
86 
87 // Helper functions to using JSON
88 
89 struct loader_instance;
90 struct loader_string_list;
91 
92 // Read a JSON file into a buffer.
93 //
94 // @return -  A pointer to a cJSON object representing the JSON parse tree.
95 //            This returned buffer should be freed by caller.
96 VkResult loader_get_json(const struct loader_instance *inst, const char *filename, cJSON **json);
97 
98 // Given a cJSON object, find the string associated with the key and puts an pre-allocated string into out_string.
99 // Length is given by out_str_len, and this function truncates the string with a null terminator if it the provided space isn't
100 // large enough.
101 VkResult loader_parse_json_string_to_existing_str(const struct loader_instance *inst, cJSON *object, const char *key,
102                                                   size_t out_str_len, char *out_string);
103 
104 // Given a cJSON object, find the string associated with the key and puts an allocated string into out_string.
105 // It is the callers responsibility to free out_string.
106 VkResult loader_parse_json_string(cJSON *object, const char *key, char **out_string);
107 
108 // Given a cJSON object, find the array of strings associated with they key and writes the count into out_count and data into
109 // out_array_of_strings. It is the callers responsibility to free out_array_of_strings.
110 VkResult loader_parse_json_array_of_strings(const struct loader_instance *inst, cJSON *object, const char *key,
111                                             struct loader_string_list *string_list);
112