all opensrf related headers are shoved into opensrf/*.h
[working/Evergreen.git] / OpenSRF / src / objson / json_parser.h
1 /*
2 Copyright (C) 2005  Georgia Public Library Service 
3 Bill Erickson <highfalutin@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
17
18
19 /* ---------------------------------------------------------------------------------------
20         JSON parser.
21  * --------------------------------------------------------------------------------------- */
22 #ifndef JSON_PARSER_H
23 #define JSON_PARSER_H
24
25 #include <stdio.h>
26 #include "object.h"
27 #include "opensrf/utils.h"
28
29
30
31 /* Parses the given JSON string and returns the built object. 
32  *      returns NULL (and prints parser error to stderr) on error.  
33  */
34
35 jsonObject* json_parse_string(char* string);
36
37 jsonObject* jsonParseString( char* string );
38
39 jsonObject* json_parse_file( const char* filename );
40
41 jsonObject* jsonParseFile( const char* string );
42
43
44
45 /* does the actual parsing work.  returns 0 on success.  -1 on error and
46  * -2 if there was no object to build (string was all comments) 
47  */
48 int _json_parse_string(char* string, unsigned long* index, jsonObject* obj);
49
50 /* returns 0 on success and turns obj into a string object */
51 int json_parse_json_string(char* string, unsigned long* index, jsonObject* obj);
52
53 /* returns 0 on success and turns obj into a number or double object */
54 int json_parse_json_number(char* string, unsigned long* index, jsonObject* obj);
55
56 /* returns 0 on success and turns obj into an 'object' object */
57 int json_parse_json_object(char* string, unsigned long* index, jsonObject* obj);
58
59 /* returns 0 on success and turns object into an array object */
60 int json_parse_json_array(char* string, unsigned long* index, jsonObject* obj);
61
62 /* churns through whitespace and increments index as it goes.
63  * eat_all == true means we should eat newlines, tabs
64  */
65 void json_eat_ws(char* string, unsigned long* index, int eat_all);
66
67 int json_parse_json_bool(char* string, unsigned long* index, jsonObject* obj);
68
69 /* removes comments from a json string.  if the comment contains a class hint
70  * and class_hint isn't NULL, an allocated char* with the class name will be
71  * shoved into *class_hint.  returns 0 on success, -1 on parse error.
72  * 'index' is assumed to be at the second character (*) of the comment
73  */
74 int json_eat_comment(char* string, unsigned long* index, char** class_hint, int parse_class);
75
76 /* prints a useful error message to stderr. always returns -1 */
77 int json_handle_error(char* string, unsigned long* index, char* err_msg);
78
79 /* returns true if c is 0-9 */
80 int is_number(char c);
81
82 int json_parse_json_null(char* string, unsigned long* index, jsonObject* obj);
83
84
85 #endif