2 Copyright (C) 2005 Georgia Public Library Service
3 Bill Erickson <highfalutin@gmail.com>
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.
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.
19 /* ---------------------------------------------------------------------------------------
21 * --------------------------------------------------------------------------------------- */
25 #include <opensrf/osrf_json.h>
30 /* Parses the given JSON string and returns the built object.
31 * returns NULL (and prints parser error to stderr) on error.
34 jsonObject* json_parse_string(char* string);
36 jsonObject* legacy_jsonParseString(const char* string);
37 jsonObject* legacy_jsonParseStringFmt( const char* string, ... );
39 /* does the actual parsing work. returns 0 on success. -1 on error and
40 * -2 if there was no object to build (string was all comments)
42 int _json_parse_string(char* string, unsigned long* index, jsonObject* obj, int current_strlen);
44 /* returns 0 on success and turns obj into a string object */
45 int json_parse_json_string(char* string, unsigned long* index, jsonObject* obj, int current_strlen);
47 /* returns 0 on success and turns obj into a number or double object */
48 int json_parse_json_number(char* string, unsigned long* index, jsonObject* obj, int current_strlen);
50 /* returns 0 on success and turns obj into an 'object' object */
51 int json_parse_json_object(char* string, unsigned long* index, jsonObject* obj, int current_strlen);
53 /* returns 0 on success and turns object into an array object */
54 int json_parse_json_array(char* string, unsigned long* index, jsonObject* obj, int current_strlen);
56 /* churns through whitespace and increments index as it goes.
57 * eat_all == true means we should eat newlines, tabs
59 void json_eat_ws(char* string, unsigned long* index, int eat_all, int current_strlen);
61 int json_parse_json_bool(char* string, unsigned long* index, jsonObject* obj, int current_strlen);
63 /* removes comments from a json string. if the comment contains a class hint
64 * and class_hint isn't NULL, an allocated char* with the class name will be
65 * shoved into *class_hint. returns 0 on success, -1 on parse error.
66 * 'index' is assumed to be at the second character (*) of the comment
68 int json_eat_comment(char* string, unsigned long* index, char** class_hint, int parse_class, int current_strlen);
70 /* prints a useful error message to stderr. always returns -1 */
71 int json_handle_error(char* string, unsigned long* index, char* err_msg);
73 int json_parse_json_null(char* string, unsigned long* index, jsonObject* obj, int current_strlen);
76 char* legacy_jsonObjectToJSON( const jsonObject* obj );
80 /* LEGACY ITERATOR CODE ---------------------------------------------------
81 ------------------------------------------------------------------------ */
83 struct _jsonObjectNodeStruct {
84 unsigned long index; /* our array position */
85 char* key; /* our hash key */
86 jsonObject* item; /* our object */
88 typedef struct _jsonObjectNodeStruct jsonObjectNode;
92 /* utility object for iterating over hash objects */
93 struct _jsonObjectIteratorStruct {
94 jsonIterator* iterator;
95 const jsonObject* obj; /* the topic object */
96 jsonObjectNode* current; /* the current node within the object */
99 typedef struct _jsonObjectIteratorStruct jsonObjectIterator;
102 /** Allocates a new iterator
103 @param obj The object over which to iterate.
105 jsonObjectIterator* jsonNewObjectIterator(const jsonObject* obj);
108 De-allocates an iterator
109 @param iter The iterator object to free
111 void jsonObjectIteratorFree(jsonObjectIterator* iter);
114 Returns the object_node currently pointed to by the iterator
115 and increments the pointer to the next node
116 @param iter The iterator in question.
118 jsonObjectNode* jsonObjectIteratorNext(jsonObjectIterator* iter);
121 @param iter The iterator.
122 @return True if there is another node after the current node.
124 int jsonObjectIteratorHasNext(const jsonObjectIterator* iter);