Annotation of libelwix/inc/elwix/ajson.h, revision 1.1.2.8
1.1.2.1 misho 1: /*************************************************************************
2: * (C) 2017 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
4: *
5: * $Author: misho $
1.1.2.8 ! misho 6: * $Id: ajson.h,v 1.1.2.7 2017/11/28 11:14:00 misho Exp $
1.1.2.1 misho 7: *
8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
15: Copyright 2004 - 2017
16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
46: #ifndef __AJSON_H
47: #define __AJSON_H
48:
1.1.2.2 misho 49:
50: /* JSON type identifiers */
51: typedef enum {
52: J_UNDEF = 0,
53: J_OBJECT = 1,
54: J_ARRAY = 2,
55: J_STRING = 3,
1.1.2.4 misho 56: J_VALUE = 4
1.1.2.2 misho 57: } jtype_t;
58:
59: /* JSON error numbers */
60: typedef enum {
61: J_ERR_OK = 0,
62: J_ERR_NOMEM = 1,
63: J_ERR_INVAL = 2,
1.1.2.3 misho 64: J_ERR_PART = 3,
65: J_ERR_PARAM = 4
1.1.2.2 misho 66: } jerr_t;
67:
1.1.2.3 misho 68: typedef struct _tagHandler {
69: unsigned long h_pos;
70: unsigned long h_next;
71: long h_parent;
72: void *h_alloc;
73: int h_strict;
1.1.2.2 misho 74: } json_t;
1.1.2.6 misho 75: #define json_toksnum(x) (x)->h_next
1.1.2.2 misho 76:
77: typedef struct _tagToken {
1.1.2.7 misho 78: long tok_idx;
1.1.2.2 misho 79: jtype_t tok_type;
80: long tok_start;
81: long tok_end;
82: long tok_size;
83: long tok_parent;
84: } jtok_t;
1.1.2.6 misho 85: #define json_toktype(x) (x)->tok_type
86: #define json_toksize(x) (x)->tok_size
87: #define json_toklen(x) ((x)->tok_end - (x)->tok_start)
88: #define json_tokstr(j, x) ((j) + (x)->tok_start)
1.1.2.7 misho 89: #define json_tokstrcpy(d, j, x) { strncpy((d), json_tokstr((j), (x)), json_toklen(x)); \
1.1.2.6 misho 90: (d)[json_toklen(x)] = 0; }
1.1.2.2 misho 91:
92:
93: /*
94: * json_init() - Initialize JSON handler
95: *
96: * @json = JSON handler, if there is NULL then dynamically will be allocated
1.1.2.3 misho 97: * @jstrict = JSON strict mode, when we select strict mode every unquoted value is error
98: * return: =NULL error or !=NULL ready for use JSON handler and should be free with json_free()
1.1.2.2 misho 99: */
1.1.2.3 misho 100: json_t *json_init(json_t * __restrict json, int jstrict);
1.1.2.2 misho 101:
102: /*
103: * json_free() - Free JSON handler
104: *
105: * @json = JSON handler
106: * return: none
107: */
1.1.2.3 misho 108: void json_free(json_t * __restrict json);
1.1.2.2 misho 109:
110: /*
111: * json_parse() - Parse JSON string
112: *
113: * @json = JSON handler
114: * @jstr = JSON string
115: * @jlen = JSON string length
116: * @jtoks = Token array
117: * @toksnum = Token array size, return number of allocated tokens in array
118: * return: -1 error or number of found tokens
119: */
120: unsigned int json_parse(json_t * __restrict json, const char *jstr, size_t jlen,
121: jtok_t * __restrict jtoks, unsigned int toksnum);
1.1.2.5 misho 122:
123: /*
124: * json_token2val() - Return token to AIT variable
125: *
126: * @jstr = JSON string
127: * @tok = Token for convert
128: * @return =NULL error or !=NULL variable, after use should be ait_freeVar()
129: */
130: ait_val_t *json_token2val(const char *jstr, jtok_t * __restrict tok);
131: /*
132: * json_token2str() - Return token to string
133: *
134: * @jstr = JSON string
135: * @tok = Token for convert
136: * @return =NULL error or !=NULL allocated str, after use should be e_free()
137: */
138: char *json_token2str(const char *jstr, jtok_t * __restrict tok);
139: /*
140: * json_token2num() - Return token to numeric
141: *
142: * @jstr = JSON string
143: * @tok = Token for convert
144: * @return number
145: */
146: long json_token2num(const char *jstr, jtok_t * __restrict tok);
147: /*
1.1.2.7 misho 148: * json_token2array() - Convert token to string array
1.1.2.5 misho 149: *
150: * @jstr = JSON string
151: * @tok = Token for convert
1.1.2.7 misho 152: * return: =NULL error or !=NULL allocated array with string variables,
1.1.2.5 misho 153: * after use should be ait_freeVars()
154: */
155: array_t *json_token2array(const char *jstr, jtok_t * __restrict tok);
156:
157: /*
158: * json_findbykey() - Find data by key
159: *
160: * @jstr = JSON string
161: * @key = Search key
162: * @toks = Parsed tokens
163: * @toksnum = Number of parsed tokens
164: * return: =NULL error or !=NULL data token found
165: */
166: jtok_t *json_findbykey(const char *jstr, const char *key,
167: jtok_t * __restrict toks, int toksnum);
1.1.2.8 ! misho 168:
! 169:
! 170: /*
! 171: * json_add_begin_object() - Adds begin of object {
! 172: *
! 173: * @jstr = JSON string
! 174: * @jlen = JSON string length
! 175: * @wspace = whitespace include
! 176: * return: -1 error or !=-1 actual JSON string length
! 177: */
! 178: int json_add_begin_object(char * __restrict jstr, int jlen, int wspace);
! 179: /*
! 180: * json_add_end_object() - Adds end of object }
! 181: *
! 182: * @jstr = JSON string
! 183: * @jlen = JSON string length
! 184: * @wspace = whitespace include
! 185: * return: -1 error or !=-1 actual JSON string length
! 186: */
! 187: int json_add_end_object(char * __restrict jstr, int jlen, int wspace);
! 188: /*
! 189: * json_add_begin_array() - Adds begin of array [
! 190: *
! 191: * @jstr = JSON string
! 192: * @jlen = JSON string length
! 193: * @wspace = whitespace include
! 194: * return: -1 error or !=-1 actual JSON string length
! 195: */
! 196: int json_add_begin_array(char * __restrict jstr, int jlen, int wspace);
! 197: /*
! 198: * json_add_end_array() - Adds end of array ]
! 199: *
! 200: * @jstr = JSON string
! 201: * @jlen = JSON string length
! 202: * @wspace = whitespace include
! 203: * return: -1 error or !=-1 actual JSON string length
! 204: */
! 205: int json_add_end_array(char * __restrict jstr, int jlen, int wspace);
! 206: /*
! 207: * json_add_char() - Adds character
! 208: *
! 209: * @jstr = JSON string
! 210: * @jlen = JSON string length
! 211: * @ch = Character
! 212: * return: -1 error or !=-1 actual JSON string length
! 213: */
! 214: int json_add_char(char * __restrict jstr, int jlen, unsigned char ch);
! 215: /*
! 216: * json_add_colon() - Adds key/value pair delimiter colon :
! 217: *
! 218: * @jstr = JSON string
! 219: * @jlen = JSON string length
! 220: * @wspace = whitespace include
! 221: * return: -1 error or !=-1 actual JSON string length
! 222: */
! 223: int json_add_colon(char * __restrict jstr, int jlen, int wspace);
! 224: /*
! 225: * json_add_comma() - Adds value delimiter comma ,
! 226: *
! 227: * @jstr = JSON string
! 228: * @jlen = JSON string length
! 229: * @wspace = whitespace include
! 230: * return: -1 error or !=-1 actual JSON string length
! 231: */
! 232: int json_add_comma(char * __restrict jstr, int jlen, int wspace);
! 233: /*
! 234: * json_add_string() - Adds string
! 235: *
! 236: * @jstr = JSON string
! 237: * @jlen = JSON string length
! 238: * @unquot = Unquoted string
! 239: * @str = String, it can't be NULL
! 240: * return: -1 error or !=-1 actual JSON string length
! 241: */
! 242: int json_add_string(char * __restrict jstr, int jlen, int unquot, const char *str);
! 243: /*
! 244: * json_add_value() - Adds value
! 245: *
! 246: * @jstr = JSON string
! 247: * @jlen = JSON string length
! 248: * @unquot = Unquoted number
! 249: * @num = Number
! 250: * return: -1 error or !=-1 actual JSON string length
! 251: */
! 252: int json_add_value(char * __restrict jstr, int jlen, int unquot, long num);
! 253: /*
! 254: * json_add_pair() - Adds key/value pair
! 255: *
! 256: * @jstr = JSON string
! 257: * @jlen = JSON string length
! 258: * @wspace = whitespace include
! 259: * @key = Key string
! 260: * @val = Value string
! 261: * return: -1 error or !=-1 actual JSON string length
! 262: */
! 263: int json_add_pair(char * __restrict jstr, int jlen, int wspace,
! 264: const char *key, const char *val);
! 265: /*
! 266: * json_add_array() - Adds array
! 267: *
! 268: * @jstr = JSON string
! 269: * @jlen = JSON string length
! 270: * @wspace = whitespace include
! 271: * @arr = Array with variables
! 272: * return: -1 error or !=-1 actual JSON string length
! 273: */
! 274: int json_add_array(char * __restrict jstr, int jlen, int wspace,
! 275: array_t * __restrict arr);
1.1.2.1 misho 276:
277:
278: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>