1. Create a new osrfListExtract function, which removes an item
[OpenSRF.git] / include / opensrf / osrf_json.h
1 /*
2 Copyright (C) 2006  Georgia Public Library Service 
3 Bill Erickson <billserickson@gmail.com>
4
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 GNU General Public License for more details.
14 */
15
16 #ifndef JSON_H
17 #define JSON_H
18
19 #include <opensrf/utils.h>
20 #include <opensrf/osrf_list.h>
21 #include <opensrf/osrf_hash.h>
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 /* parser states */
28 #define JSON_STATE_IN_OBJECT    0x1
29 #define JSON_STATE_IN_ARRAY             0x2
30 #define JSON_STATE_IN_STRING    0x4
31 #define JSON_STATE_IN_UTF               0x8
32 #define JSON_STATE_IN_ESCAPE    0x10
33 #define JSON_STATE_IN_KEY               0x20
34 #define JSON_STATE_IN_NULL              0x40
35 #define JSON_STATE_IN_TRUE              0x80
36 #define JSON_STATE_IN_FALSE             0x100
37 #define JSON_STATE_IN_NUMBER    0x200
38 #define JSON_STATE_IS_INVALID   0x400
39 #define JSON_STATE_IS_DONE              0x800
40 #define JSON_STATE_START_COMMEN 0x1000
41 #define JSON_STATE_IN_COMMENT   0x2000
42 #define JSON_STATE_END_COMMENT  0x4000
43
44
45 /* object and array (container) states are pushed onto a stack so we
46  * can keep track of the object nest.  All other states are
47  * simply stored in the state field of the parser */
48 #define JSON_STATE_SET(ctx,s) ctx->state |= s; /* set a state */
49 #define JSON_STATE_REMOVE(ctx,s) ctx->state &= ~s; /* unset a state */
50 #define JSON_STATE_CHECK(ctx,s) (ctx->state & s) ? 1 : 0 /* check if a state is set */
51 #define JSON_STATE_POP(ctx) osrfListPop( ctx->stateStack ); /* remove a state from the stack */
52 #define JSON_STATE_PUSH(ctx, state) osrfListPush( ctx->stateStack,(void*) state );/* push a state on the stack */
53 #define JSON_STATE_PEEK(ctx) osrfListGetIndex(ctx->stateStack, ctx->stateStack->size -1) /* check which container type we're currently in */
54 #define JSON_STATE_CHECK_STACK(ctx, s) (JSON_STATE_PEEK(ctx) == (void*) s ) ? 1 : 0  /* compare stack values */
55
56 /* JSON types */
57 #define JSON_HASH       0
58 #define JSON_ARRAY      1
59 #define JSON_STRING     2
60 #define JSON_NUMBER     3
61 #define JSON_NULL       4       
62 #define JSON_BOOL       5
63
64 #define JSON_PARSE_LAST_CHUNK 0x1 /* this is the last part of the string we're parsing */
65
66 #define JSON_PARSE_FLAG_CHECK(ctx, f) (ctx->flags & f) ? 1 : 0 /* check if a parser state is set */
67
68 #ifndef JSON_CLASS_KEY
69 #define JSON_CLASS_KEY "__c"
70 #endif
71 #ifndef JSON_DATA_KEY
72 #define JSON_DATA_KEY "__p"
73 #endif
74
75
76 struct jsonParserContextStruct {
77         int state;                                              /* what are we currently parsing */
78         const char* chunk;                              /* the chunk we're currently parsing */
79         int index;                                              /* where we are in parsing the current chunk */
80         int chunksize;                                  /* the size of the current chunk */
81         int flags;                                              /* parser flags */
82         osrfList* stateStack;           /* represents the nest of object/array states */
83         growing_buffer* buffer;         /* used to hold JSON strings, number, true, false, and null sequences */
84         growing_buffer* utfbuf;         /* holds the current unicode characters */
85         void* userData;                         /* opaque user pointer.  we ignore this */
86         const struct jsonParserHandlerStruct* handler; /* the event handler struct */
87 };
88 typedef struct jsonParserContextStruct jsonParserContext;
89
90 struct jsonParserHandlerStruct {
91         void (*handleStartObject)       (void* userData);
92         void (*handleObjectKey)         (void* userData, char* key);
93         void (*handleEndObject)         (void* userData);
94         void (*handleStartArray)        (void* userData);
95         void (*handleEndArray)          (void* userData);
96         void (*handleNull)                      (void* userData);
97         void (*handleString)                    (void* userData, char* string);
98         void (*handleBool)                      (void* userData, int boolval);
99         void (*handleNumber)            (void* userData, const char* numstr);
100         void (*handleError)                     (void* userData, char* err, ...);
101 };
102 typedef struct jsonParserHandlerStruct jsonParserHandler;
103
104 struct _jsonObjectStruct {
105         unsigned long size;     /* number of sub-items */
106         char* classname;                /* optional class hint (not part of the JSON spec) */
107         int type;                               /* JSON type */
108         struct _jsonObjectStruct* parent;       /* who we're attached to */
109         union __jsonValue {     /* cargo */
110                 osrfHash*       h;              /* object container */
111                 osrfList*       l;              /* array container */
112                 char*           s;              /* string */
113                 int                     b;              /* bool */
114 //              double  n;              /* number */
115                 double  n;              /* number */
116         } value;
117 };
118 typedef struct _jsonObjectStruct jsonObject;
119
120 struct _jsonIteratorStruct {
121         jsonObject* obj; /* the object we're traversing */
122         osrfHashIterator* hashItr; /* the iterator for this hash */
123         char* key; /* if this object is an object, the current key */
124         unsigned long index; /* if this object is an array, the index */
125 };
126 typedef struct _jsonIteratorStruct jsonIterator;
127
128
129
130 /** 
131  * Allocates a new parser context object
132  * @param handler The event handler struct
133  * @param userData Opaque user pointer which is available in callbacks
134  * and ignored by the parser
135  * @return An allocated parser context, NULL on error
136  */
137 jsonParserContext* jsonNewParser( const jsonParserHandler* handler, void* userData);
138
139 /**
140  * Deallocates a parser context
141  * @param ctx The context object
142  */
143 void jsonParserFree( jsonParserContext* ctx );
144
145 /**
146  * Parse a chunk of data.
147  * @param ctx The parser context
148  * @param data The data to parse
149  * @param datalen The size of the chunk to parser
150  * @param flags Reserved
151  */
152 int jsonParseChunk( jsonParserContext* ctx, const char* data, int datalen, int flags );
153
154
155 /**
156  * Parses a JSON string;
157  * @param str The string to parser
158  * @return The resulting JSON object or NULL on error
159  */
160 jsonObject* jsonParseString( const char* str );
161 jsonObject* jsonParseStringRaw( const char* str );
162
163 jsonObject* jsonParseStringFmt( const char* str, ... );
164
165 /**
166  * Parses a JSON string;
167  * @param str The string to parser
168  * @return The resulting JSON object or NULL on error
169  */
170 jsonObject* jsonParseStringHandleError( void (*errorHandler) (const char*), char* str, ... );
171
172
173
174 /**
175  * Creates a new json object
176  * @param data The string data this object will hold if 
177  * this object happens to be a JSON_STRING, NULL otherwise
178  * @return The allocated json object.  Must be freed with 
179  * jsonObjectFree()
180  */
181 jsonObject* jsonNewObject(const char* data);
182 jsonObject* jsonNewObjectFmt(const char* data, ...);
183
184 /**
185  * Creates a new object of the given type
186  */
187 jsonObject* jsonNewObjectType(int type);
188
189 /**
190  * Creates a new number object from a double
191  */
192 jsonObject* jsonNewNumberObject( double num );
193
194 /**
195  * Creates a new number object from a numeric string
196  */
197 jsonObject* jsonNewNumberStringObject( const char* numstr );
198
199 /**
200  * Creates a new json bool
201  */
202 jsonObject* jsonNewBoolObject(int val);
203
204 /**
205  * Deallocates an object
206  */
207 void jsonObjectFree( jsonObject* o );
208
209 /**
210  * Returns all unused jsonObjects to the heap
211  */
212 void jsonObjectFreeUnused( void );
213
214 /**
215  * Forces the given object to become an array (if it isn't already one) 
216  * and pushes the new object into the array
217  */
218 unsigned long jsonObjectPush(jsonObject* o, jsonObject* newo);
219
220 /**
221  * Forces the given object to become a hash (if it isn't already one)
222  * and assigns the new object to the key of the hash
223  */
224 unsigned long jsonObjectSetKey(
225                 jsonObject* o, const char* key, jsonObject* newo);
226
227
228 /**
229  * Turns the object into a JSON string.  The string must be freed by the caller */
230 char* jsonObjectToJSON( const jsonObject* obj );
231 char* jsonObjectToJSONRaw( const jsonObject* obj );
232
233
234 /**
235  * Retrieves the object at the given key
236  */
237 jsonObject* jsonObjectGetKey( jsonObject* obj, const char* key );
238 const jsonObject* jsonObjectGetKeyConst( const jsonObject* obj, const char* key );
239
240
241
242
243
244 /** Allocates a new iterator 
245         @param obj The object over which to iterate.
246 */
247 jsonIterator* jsonNewIterator(const jsonObject* obj);
248
249
250 /** 
251         De-allocates an iterator 
252         @param iter The iterator object to free
253 */
254 void jsonIteratorFree(jsonIterator* iter);
255
256 /** 
257         Returns the object_node currently pointed to by the iterator
258         and increments the pointer to the next node
259         @param iter The iterator in question.
260  */
261 jsonObject* jsonIteratorNext(jsonIterator* iter);
262
263
264 /** 
265         @param iter The iterator.
266         @return True if there is another node after the current node.
267  */
268 int jsonIteratorHasNext(const jsonIterator* iter);
269
270
271 /** 
272         Returns a pointer to the object at the given index.  This call is
273         only valid if the object has a type of JSON_ARRAY.
274         @param obj The object
275         @param index The position within the object
276         @return The object at the given index.
277 */
278 jsonObject* jsonObjectGetIndex( const jsonObject* obj, unsigned long index );
279
280
281 /* removes (and deallocates) the object at the given index (if one exists) and inserts 
282  * the new one.  returns the size on success, -1 on error 
283  * If obj is NULL, inserts a new object into the list with is_null set to true
284  */
285 unsigned long jsonObjectSetIndex(jsonObject* dest, unsigned long index, jsonObject* newObj);
286
287 /* removes and deallocates the object at the given index, replacing
288    it with a NULL pointer
289  */
290 unsigned long jsonObjectRemoveIndex(jsonObject* dest, unsigned long index);
291
292 /* removes (but does not deallocate) the object at the given index,
293  * replacing it with a NULL pointer; returns a pointer to the object removed
294  */
295 jsonObject* jsonObjectExtractIndex(jsonObject* dest, unsigned long index);
296
297 /* removes (and deallocates) the object with key 'key' if it exists */
298 unsigned long jsonObjectRemoveKey( jsonObject* dest, const char* key);
299
300 /* returns a pointer to the string data held by this object if this object
301         is a string.  Otherwise returns NULL*/
302 char* jsonObjectGetString(const jsonObject*);
303
304 double jsonObjectGetNumber( const jsonObject* obj );
305
306 /* sets the string data */
307 void jsonObjectSetString(jsonObject* dest, const char* string);
308
309 /* sets the number value for the object */
310 void jsonObjectSetNumber(jsonObject* dest, double num);
311 int jsonObjectSetNumberString(jsonObject* dest, const char* string);
312
313 /* sets the class hint for this object */
314 void jsonObjectSetClass(jsonObject* dest, const char* classname );
315 const char* jsonObjectGetClass(const jsonObject* dest);
316
317 int jsonBoolIsTrue( const jsonObject* boolObj );
318
319 void jsonSetBool(jsonObject* bl, int val);
320
321 jsonObject* jsonObjectClone( const jsonObject* o );
322
323
324 /* tries to extract the string data from an object.
325         if object       -> NULL (the C NULL)
326         if array                ->      NULL  
327         if null         -> NULL 
328         if bool         -> NULL
329         if string/number the string version of either of those
330         The caller is responsible for freeing the returned string
331         */
332 char* jsonObjectToSimpleString( const jsonObject* o );
333
334 /**
335  Allocate a buffer and format a specified numeric value into it,
336  with up to 30 decimal digits of precision.   Caller is responsible
337  for freeing the buffer.
338  **/
339 char* doubleToString( double num );
340
341 /**
342  Return 1 if the string is numeric, otherwise return 0.
343  This validation follows the rules defined by the grammar at:
344  http://www.json.org/
345  **/
346 int jsonIsNumeric( const char* s );
347
348 /**
349  Allocate and reformat a numeric string into one that is valid
350  by JSON rules.  If the string is not numeric, return NULL.
351  Caller is responsible for freeing the buffer.
352  **/
353 char* jsonScrubNumber( const char* s );
354
355 /* provides an XPATH style search interface (e.g. /some/node/here) and 
356         return the object at that location if one exists.  Naturally,  
357         every element in the path must be a proper object ("hash" / {}).
358         Returns NULL if the specified node is not found 
359         Note also that the object returned is a clone and
360         must be freed by the caller
361 */
362 jsonObject* jsonObjectFindPath( const jsonObject* obj, const char* path, ... );
363
364
365 /* formats a JSON string from printing.  User must free returned string */
366 char* jsonFormatString( const char* jsonString );
367
368 /* sets the error handler for all parsers */
369 void jsonSetGlobalErrorHandler(void (*errorHandler) (const char*));
370
371 /* ------------------------------------------------------------------------- */
372 /**
373  * The following methods provide a facility for serializing and
374  * deserializing "classed" JSON objects.  To give a JSON object a 
375  * class, simply call jsonObjectSetClass().  
376  * Then, calling jsonObjectEncodeClass() will convert the JSON
377  * object (and any sub-objects) to a JSON object with class 
378  * wrapper objects like so:
379  * { _c : "classname", _d : <json_thing> }
380  * In this example _c is the class key and _d is the data (object)
381  * key.  The keys are defined by the constants 
382  * OSRF_JSON_CLASS_KEY and OSRF_JSON_DATA_KEY
383  * To revive a serialized object, simply call
384  * jsonObjectDecodeClass()
385  */
386
387
388 /** Converts a class-wrapped object into an object with the
389  * classname set
390  * Caller must free the returned object 
391  */ 
392 jsonObject* jsonObjectDecodeClass( const jsonObject* obj );
393
394
395 /** Converts an object with a classname into a
396  * class-wrapped (serialized) object
397  * Caller must free the returned object 
398  */ 
399 jsonObject* jsonObjectEncodeClass( const jsonObject* obj );
400
401 /* ------------------------------------------------------------------------- */
402
403
404 /**
405  *      Generates an XML representation of a JSON object */
406 char* jsonObjectToXML(const jsonObject*);
407
408
409 /*
410  * Builds a JSON object from the provided XML 
411  */
412 jsonObject* jsonXMLToJSONObject(const char* xml);
413
414 #ifdef __cplusplus
415 }
416 #endif
417
418 #endif