Annotation of libelwix/inc/elwix/ajson.h, revision 1.8
1.2 misho 1: /*************************************************************************
2: * (C) 2017 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
4: *
5: * $Author: misho $
1.8 ! misho 6: * $Id: ajson.h,v 1.7.60.1 2024/12/04 17:46:50 misho Exp $
1.2 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:
1.8 ! misho 15: Copyright 2004 - 2024
1.2 misho 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:
49:
50: /* JSON type identifiers */
51: typedef enum {
52: J_UNDEF = 0,
53: J_OBJECT = 1,
54: J_ARRAY = 2,
55: J_STRING = 3,
56: J_VALUE = 4
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,
64: J_ERR_PART = 3,
65: J_ERR_PARAM = 4
66: } jerr_t;
67:
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;
74: } json_t;
75: #define json_toksnum(x) (x)->h_next
76:
77: typedef struct _tagToken {
78: long tok_idx;
79: jtype_t tok_type;
80: long tok_start;
81: long tok_end;
82: long tok_size;
83: long tok_parent;
84: } jtok_t;
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)
89: #define json_tokstrcpy(d, j, x) { strncpy((d), json_tokstr((j), (x)), json_toklen(x)); \
90: (d)[json_toklen(x)] = 0; }
91:
92:
93: /*
94: * json_init() - Initialize JSON handler
95: *
96: * @json = JSON handler, if there is NULL then dynamically will be allocated
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()
99: */
100: json_t *json_init(json_t * __restrict json, int jstrict);
101:
102: /*
103: * json_free() - Free JSON handler
104: *
105: * @json = JSON handler
106: * return: none
107: */
108: void json_free(json_t * __restrict json);
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);
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
1.5 misho 136: * @return =NULL error or !=NULL allocated str, after use should be json_freestr()|e_free()
1.2 misho 137: */
138: char *json_token2str(const char *jstr, jtok_t * __restrict tok);
1.8 ! misho 139: #define json_token2obj json_token2str
1.5 misho 140: #define json_freestr(x) e_free((x))
1.2 misho 141: /*
142: * json_token2num() - Return token to numeric
143: *
144: * @jstr = JSON string
145: * @tok = Token for convert
146: * @return number
147: */
148: long json_token2num(const char *jstr, jtok_t * __restrict tok);
149: /*
1.5 misho 150: * json_token2dbl() - Return token to double
151: *
152: * @jstr = JSON string
153: * @tok = Token for convert
154: * @return number
155: */
156: double json_token2dbl(const char *jstr, jtok_t * __restrict tok);
1.6 misho 157: /*
158: * json_token2bool() - Return token to bool int
159: *
160: * @jstr = JSON string
161: * @tok = Token for convert
162: * @return 0 for FALSE and !=0 for TRUE
163: */
164: int json_token2bool(const char *jstr, jtok_t * __restrict tok);
1.5 misho 165: /*
1.2 misho 166: * json_token2array() - Convert token to string array
167: *
168: * @jstr = JSON string
169: * @tok = Token for convert
170: * return: =NULL error or !=NULL allocated array with string variables,
171: * after use should be ait_freeVars()
172: */
173: array_t *json_token2array(const char *jstr, jtok_t * __restrict tok);
174:
175: /*
1.5 misho 176: * json_findbykey() - Find token data by key
1.2 misho 177: *
178: * @jstr = JSON string
179: * @key = Search key
1.4 misho 180: * @type = Search key for particular token type, if is J_UNDEF this mean any type
1.2 misho 181: * @toks = Parsed tokens
182: * @toksnum = Number of parsed tokens
183: * return: =NULL error or !=NULL data token found
184: */
185: jtok_t *json_findbykey(const char *jstr, const char *key,
1.4 misho 186: jtype_t type, jtok_t * __restrict toks, int toksnum);
1.5 misho 187: /*
1.8 ! misho 188: * json_findbykeyatscope() - Find token data by key at particular scope
! 189: *
! 190: * @scope = Search at object scope, =0 main object scope
! 191: * @jstr = JSON string
! 192: * @key = Search key
! 193: * @type = Search key for particular token type, if is J_UNDEF this mean any type
! 194: * @toks = Parsed tokens
! 195: * @toksnum = Number of parsed tokens
! 196: * return: =NULL error or !=NULL data token found
! 197: */
! 198: jtok_t *json_findbykeyatscope(long scope, const char *jstr, const char *key,
! 199: jtype_t type, jtok_t * __restrict toks, int toksnum);
! 200: /*
1.5 misho 201: * json_findbypos() - Find token by position on JSON string
202: *
203: * @pos = Offset from begin of JSON string
204: * @toks = Parsed tokens
205: * @toksnum = Number of parsed tokens
206: * return: =NULL error or !=NULL token found
207: */
208: jtok_t *json_findbypos(unsigned long pos, jtok_t * __restrict toks, int toksnum);
1.8 ! misho 209: /*
! 210: * json_objscope() - Find object scope of key
! 211: *
! 212: * @key = Key of object, if it is =NULL, then return 0 (default scope)
! 213: * @jstr = JSON string
! 214: * @toks = JSON tokens
! 215: * @toksnum = Number of tokens
! 216: * return: -1 on error or >=0 scope of object
! 217: */
! 218: long json_objscope(const char *key, const char *jstr, jtok_t * __restrict toks, int toksnum);
1.3 misho 219:
220:
221: /*
222: * json_dump_yaml() - Dump parsed JSON string to YAML format
223: *
224: * @f = Output handler
225: * @jstr = JSON string
226: * @toks = JSON tokens
227: * @toksnum = Number of tokens
228: * @indent = Start indent spaces
229: * return: 0 done and 1 added one more item
230: */
231: int json_dump_yaml(FILE *f, const char *jstr, jtok_t *toks, int toksnum, int indent);
1.5 misho 232: /*
233: * json_dump() - Dump parsed JSON string to structure format
234: *
235: * @f = Output handler
236: * @jstr = JSON string
237: * @toks = JSON tokens
238: * @toksnum = Number of tokens
239: * @indent = Start indent spaces
240: * return: 0 done and 1 added one more item
241: */
242: int json_dump(FILE *f, const char *jstr, jtok_t *toks, int toksnum, int indent);
1.2 misho 243:
244:
245: /*
246: * json_add_begin_object() - Adds begin of object {
247: *
248: * @jstr = JSON string
249: * @jlen = JSON string length
250: * @wspace = whitespace include
251: * return: -1 error or !=-1 actual JSON string length
252: */
253: int json_add_begin_object(char * __restrict jstr, int jlen, int wspace);
254: /*
255: * json_add_end_object() - Adds end of object }
256: *
257: * @jstr = JSON string
258: * @jlen = JSON string length
259: * @wspace = whitespace include
260: * return: -1 error or !=-1 actual JSON string length
261: */
262: int json_add_end_object(char * __restrict jstr, int jlen, int wspace);
263: /*
264: * json_add_begin_array() - Adds begin of array [
265: *
266: * @jstr = JSON string
267: * @jlen = JSON string length
268: * @wspace = whitespace include
269: * return: -1 error or !=-1 actual JSON string length
270: */
271: int json_add_begin_array(char * __restrict jstr, int jlen, int wspace);
272: /*
273: * json_add_end_array() - Adds end of array ]
274: *
275: * @jstr = JSON string
276: * @jlen = JSON string length
277: * @wspace = whitespace include
278: * return: -1 error or !=-1 actual JSON string length
279: */
280: int json_add_end_array(char * __restrict jstr, int jlen, int wspace);
281: /*
282: * json_add_char() - Adds character
283: *
284: * @jstr = JSON string
285: * @jlen = JSON string length
286: * @ch = Character
287: * return: -1 error or !=-1 actual JSON string length
288: */
289: int json_add_char(char * __restrict jstr, int jlen, unsigned char ch);
290: /*
291: * json_add_colon() - Adds key/value pair delimiter colon :
292: *
293: * @jstr = JSON string
294: * @jlen = JSON string length
295: * @wspace = whitespace include
296: * return: -1 error or !=-1 actual JSON string length
297: */
298: int json_add_colon(char * __restrict jstr, int jlen, int wspace);
299: /*
300: * json_add_comma() - Adds value delimiter comma ,
301: *
302: * @jstr = JSON string
303: * @jlen = JSON string length
304: * @wspace = whitespace include
305: * return: -1 error or !=-1 actual JSON string length
306: */
307: int json_add_comma(char * __restrict jstr, int jlen, int wspace);
308: /*
309: * json_add_string() - Adds string
310: *
311: * @jstr = JSON string
312: * @jlen = JSON string length
313: * @unquot = Unquoted string
314: * @str = String, it can't be NULL
315: * return: -1 error or !=-1 actual JSON string length
316: */
317: int json_add_string(char * __restrict jstr, int jlen, int unquot, const char *str);
318: /*
319: * json_add_value() - Adds value
320: *
321: * @jstr = JSON string
322: * @jlen = JSON string length
323: * @unquot = Unquoted number
324: * @num = Number
325: * return: -1 error or !=-1 actual JSON string length
326: */
327: int json_add_value(char * __restrict jstr, int jlen, int unquot, long num);
328: /*
329: * json_add_pair() - Adds key/value pair
330: *
331: * @jstr = JSON string
332: * @jlen = JSON string length
333: * @wspace = whitespace include
334: * @key = Key string
335: * @val = Value string
336: * return: -1 error or !=-1 actual JSON string length
337: */
338: int json_add_pair(char * __restrict jstr, int jlen, int wspace,
339: const char *key, const char *val);
1.7 misho 340: /*
341: * json_add_pair2() - Adds key/value pair with formated args
342: *
343: * @jstr = JSON string
344: * @jlen = JSON string length
345: * @wspace = whitespace include
346: * @key = Key string
347: * @fmt = Format string for values
348: * return: -1 error or !=-1 actual JSON string length
349: */
350: int json_add_pair2(char * __restrict jstr, int jlen, int wspace,
351: const char *key, const char *fmt, ...);
1.2 misho 352: /*
353: * json_add_array() - Adds array
354: *
355: * @jstr = JSON string
356: * @jlen = JSON string length
357: * @wspace = whitespace include
358: * @arr = Array with variables
359: * return: -1 error or !=-1 actual JSON string length
360: */
361: int json_add_array(char * __restrict jstr, int jlen, int wspace,
362: array_t * __restrict arr);
363:
364:
365: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to ajson.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libelwix / inc / elwix