summaryrefslogtreecommitdiff
path: root/plugins/JSON/libJSON.h
blob: 83d37c46d7de77afefbd86a008dfbcbe0fc4c906 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
#ifndef LIBJSON_H
#define LIBJSON_H

#include "Source/JSONDefs.h"  //for typedefs of functions, strings, and nodes

#ifdef LIBJSON_EXPORTS
#define LIBJSON_DLL _declspec(dllexport)
#else
#define LIBJSON_DLL _declspec(dllimport)
#endif

/*
    This is the C interface to libJSON.
 
    This file also declares various things that are needed for
    C++ programming
*/

#ifdef JSON_LIBRARY  //compiling the library, hide the interface
    #ifdef __cplusplus
	   #ifdef JSON_UNIT_TEST
		  #include "Source/JSONNode.h"
	   #endif
	   extern "C" {
    #endif
		  
		  /*
			 stuff that's in namespace libJSON
		  */
		  LIBJSON_DLL void json_free(void * str);
		  LIBJSON_DLL void json_delete(JSONNODE * node);
		  #ifdef JSON_MEMORY_MANAGE
			 LIBJSON_DLL void json_free_all(void);
			 LIBJSON_DLL void json_delete_all(void);
		  #endif
		  LIBJSON_DLL JSONNODE * json_parse(const json_char * json);
		  LIBJSON_DLL json_char * json_strip_white_space(const json_char * json);
		  #ifdef JSON_VALIDATE
			 LIBJSON_DLL JSONNODE * json_validate(const json_char * json);
		  #endif
		  #if defined JSON_DEBUG && !defined JSON_STDERROR
			 //When libjson errors, a callback allows the user to know what went wrong
			 LIBJSON_DLL void json_register_debug_callback(json_error_callback_t callback);
		  #endif
		  #ifdef JSON_MUTEX_CALLBACKS
			 #ifdef JSON_MUTEX_MANAGE
				LIBJSON_DLL void json_register_mutex_callbacks(json_mutex_callback_t lock, json_mutex_callback_t unlock, json_mutex_callback_t destroy, void * manager_lock);
			 #else
				LIBJSON_DLL void json_register_mutex_callbacks(json_mutex_callback_t lock, json_mutex_callback_t unlock, void * manager_lock);
			 #endif
			 LIBJSON_DLL void json_set_global_mutex(void * mutex);
			 LIBJSON_DLL void json_set_mutex(JSONNODE * node, void * mutex);
			 LIBJSON_DLL void json_lock(JSONNODE * node, int threadid);
			 LIBJSON_DLL void json_unlock(JSONNODE * node, int threadid);
		  #endif
		  #ifdef JSON_MEMORY_CALLBACKS
			 LIBJSON_DLL void json_register_memory_callbacks(json_malloc_t mal, json_realloc_t real, json_free_t fre);
		  #endif

		  
		  /*
			 stuff that's in class JSONNode
		   */
		  //ctors
		  LIBJSON_DLL JSONNODE * json_new_a(const json_char * name, const json_char * value);
		  LIBJSON_DLL JSONNODE * json_new_i(const json_char * name, long value);
		  LIBJSON_DLL JSONNODE * json_new_f(const json_char * name, json_number value);
		  LIBJSON_DLL JSONNODE * json_new_b(const json_char * name, int value);  //because C bools are ints and C++ will implicitly cast it
		  LIBJSON_DLL JSONNODE * json_new(char type);
		  LIBJSON_DLL JSONNODE * json_copy(const JSONNODE * orig);
		  LIBJSON_DLL JSONNODE * json_duplicate(const JSONNODE * orig);

		  //assignment
		  LIBJSON_DLL void json_set_a(JSONNODE * node, const json_char * value);
		  LIBJSON_DLL void json_set_i(JSONNODE * node, long value);
		  LIBJSON_DLL void json_set_f(JSONNODE * node, json_number value);
		  LIBJSON_DLL void json_set_b(JSONNODE * node, int value);  //because C bools are ints ane C++ will implicit
		  LIBJSON_DLL void json_set_n(JSONNODE * node, const JSONNODE * orig);

		  //inspectors
		  LIBJSON_DLL char json_type(const JSONNODE * node);
		  LIBJSON_DLL json_index_t json_size(const JSONNODE * node);
		  LIBJSON_DLL int json_empty(const JSONNODE * node);
		  LIBJSON_DLL json_char * json_name(const JSONNODE * node);
		  #ifdef JSON_COMMENTS
			 LIBJSON_DLL json_char * json_get_comment(const JSONNODE * node);
		  #endif
		  LIBJSON_DLL json_char * json_as_string(const JSONNODE * node);
		  LIBJSON_DLL long json_as_int(const JSONNODE * node);
		  LIBJSON_DLL json_number json_as_float(const JSONNODE * node);
		  LIBJSON_DLL int json_as_bool(const JSONNODE * node);
		  LIBJSON_DLL JSONNODE * json_as_node(const JSONNODE * node);
		  LIBJSON_DLL JSONNODE * json_as_array(const JSONNODE * node);
		  #ifdef JSON_BINARY
			 LIBJSON_DLL void * json_as_binary(const JSONNODE * node, unsigned long * size);
		  #endif
		  #ifdef JSON_WRITER
			 LIBJSON_DLL json_char * json_write(const JSONNODE * node);
			 LIBJSON_DLL json_char * json_write_formatted(const JSONNODE * node);
		  #endif

		  //modifiers
		  LIBJSON_DLL void json_set_name(JSONNODE * node, const json_char * name);
		  #ifdef JSON_COMMENTS
			 LIBJSON_DLL void json_set_comment(JSONNODE * node, const json_char * comment);
		  #endif
		  LIBJSON_DLL void json_clear(JSONNODE * node);
		  LIBJSON_DLL void json_nullify(JSONNODE * node);
		  LIBJSON_DLL void json_swap(JSONNODE * node, JSONNODE * node2);
		  LIBJSON_DLL void json_merge(JSONNODE * node, JSONNODE * node2);
		  #ifndef JSON_PREPARSE
			 LIBJSON_DLL void json_preparse(JSONNODE * node);
		  #endif
		  #ifdef JSON_BINARY
			 LIBJSON_DLL void json_set_binary(JSONNODE * node, const void * data, unsigned long length);
		  #endif
		  LIBJSON_DLL void json_cast(JSONNODE * node, char type);

		  //children access
		  LIBJSON_DLL void json_reserve(JSONNODE * node, json_index_t siz);
		  LIBJSON_DLL JSONNODE * json_at(JSONNODE * node, json_index_t pos);
		  LIBJSON_DLL JSONNODE * json_get(JSONNODE * node, const json_char * name);
		  #ifdef JSON_CASE_INSENSITIVE_FUNCTIONS
			 LIBJSON_DLL JSONNODE * json_get_nocase(JSONNODE * node, const json_char * name);
			 LIBJSON_DLL JSONNODE * json_pop_back_nocase(JSONNODE * node, const json_char * name);
		  #endif
		  LIBJSON_DLL void json_push_back(JSONNODE * node, JSONNODE * node2);
		  LIBJSON_DLL JSONNODE * json_pop_back_at(JSONNODE * node, json_index_t pos);
		  LIBJSON_DLL JSONNODE * json_pop_back(JSONNODE * node, const json_char * name);
		  #ifdef JSON_ITERATORS
			 LIBJSON_DLL JSONNODE_ITERATOR json_find(JSONNODE * node, const json_char * name);
			 #ifdef JSON_CASE_INSENSITIVE_FUNCTIONS
				LIBJSON_DLL JSONNODE_ITERATOR json_find_nocase(JSONNODE * node, const json_char * name);
			 #endif
			 LIBJSON_DLL JSONNODE_ITERATOR json_erase(JSONNODE * node, JSONNODE_ITERATOR it);
			 LIBJSON_DLL JSONNODE_ITERATOR json_erase_multi(JSONNODE * node, JSONNODE_ITERATOR start, JSONNODE_ITERATOR end);
			 LIBJSON_DLL JSONNODE_ITERATOR json_insert(JSONNODE * node, JSONNODE_ITERATOR it, JSONNODE * node2);
			 LIBJSON_DLL JSONNODE_ITERATOR json_insert_multi(JSONNODE * node, JSONNODE_ITERATOR it, JSONNODE_ITERATOR start, JSONNODE_ITERATOR end);
	 
			 //iterator functions
			 LIBJSON_DLL JSONNODE_ITERATOR json_begin(JSONNODE * node);
			 LIBJSON_DLL JSONNODE_ITERATOR json_end(JSONNODE * node);
		  #endif

		  //comparison
		  LIBJSON_DLL int json_equal(JSONNODE * node, JSONNODE * node2);

    #ifdef __cplusplus
	   }
    #endif
#else
    #ifndef __cplusplus
	   #error Using the non-library requires C++
    #endif
    #include "Source/JSONNode.h"  //not used in this file, but libJSON.h should be the only file required to use it embedded
    #include "Source/JSONWorker.h"
    #include <stdexcept>  //some methods throw exceptions

    namespace libJSON {
	   //if json is invalid, it throws a std::invalid_argument exception
	   inline static JSONNode parse(const json_string & json){
		  return JSONWorker::parse(json);
	   }
	   
	   //useful if you have json that you don't want to parse, just want to strip to cut down on space
	   inline static json_string strip_white_space(const json_string & json){
		  return JSONWorker::RemoveWhiteSpaceAndComments(json);
	   }
	   
	   //if json is invalid, it throws a std::invalid_argument exception (differs from parse because this checks the entire tree)
	   #ifdef JSON_VALIDATE
		  inline static JSONNode validate(const json_string & json){
			 return JSONWorker::validate(json);
		  }
	   #endif
	   
	   //When libjson errors, a callback allows the user to know what went wrong
	   #if defined JSON_DEBUG && !defined JSON_STDERROR
		  inline static void register_debug_callback(json_error_callback_t callback){
			 JSONDebug::register_callback(callback);
		  }
	   #endif
	   
	   #ifdef JSON_MUTEX_CALLBACKS
		  #ifdef JSON_MUTEX_MANAGE
			 inline static void register_mutex_callbacks(json_mutex_callback_t lock, json_mutex_callback_t unlock, json_mutex_callback_t destroy, void * manager_lock){
				JSONNode::register_mutex_callbacks(lock, unlock, manager_lock);
				JSONNode::register_mutex_destructor(destroy);
			 }
		  #else
			 inline static void register_mutex_callbacks(json_mutex_callback_t lock, json_mutex_callback_t unlock, void * manager_lock){
				JSONNode::register_mutex_callbacks(lock, unlock, manager_lock);
			 }
		  #endif
		  
		  inline static void set_global_mutex(void * mutex){
			 JSONNode::set_global_mutex(mutex);
		  }
	   #endif
	   
	   #ifdef JSON_MEMORY_CALLBACKS
		  inline static void register_memory_callbacks(json_malloc_t mal, json_realloc_t real, json_free_t fre){
			 JSONMemory::registerMemoryCallbacks(mal, real, fre);
		  }
	   #endif

    }
#endif  //JSON_LIBRARY

#endif  //LIBJSON_H