Annotation of libelwix/inc/elwix/ajson.h, revision 1.10
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.10 ! misho 6: * $Id: ajson.h,v 1.9.2.3 2025/08/25 12:58:08 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.9 misho 15: Copyright 2004 - 2025
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:
1.9 misho 92: #ifdef __cplusplus
93: extern "C" {
94: #endif
1.2 misho 95:
96: /*
97: * json_init() - Initialize JSON handler
98: *
99: * @json = JSON handler, if there is NULL then dynamically will be allocated
100: * @jstrict = JSON strict mode, when we select strict mode every unquoted value is error
101: * return: =NULL error or !=NULL ready for use JSON handler and should be free with json_free()
102: */
103: json_t *json_init(json_t * __restrict json, int jstrict);
104:
105: /*
106: * json_free() - Free JSON handler
107: *
108: * @json = JSON handler
109: * return: none
110: */
111: void json_free(json_t * __restrict json);
112:
113: /*
114: * json_parse() - Parse JSON string
115: *
116: * @json = JSON handler
117: * @jstr = JSON string
118: * @jlen = JSON string length
119: * @jtoks = Token array
120: * @toksnum = Token array size, return number of allocated tokens in array
121: * return: -1 error or number of found tokens
122: */
123: unsigned int json_parse(json_t * __restrict json, const char *jstr, size_t jlen,
124: jtok_t * __restrict jtoks, unsigned int toksnum);
125:
126: /*
127: * json_token2val() - Return token to AIT variable
128: *
129: * @jstr = JSON string
130: * @tok = Token for convert
131: * @return =NULL error or !=NULL variable, after use should be ait_freeVar()
132: */
133: ait_val_t *json_token2val(const char *jstr, jtok_t * __restrict tok);
134: /*
135: * json_token2str() - Return token to string
136: *
137: * @jstr = JSON string
138: * @tok = Token for convert
1.5 misho 139: * @return =NULL error or !=NULL allocated str, after use should be json_freestr()|e_free()
1.2 misho 140: */
141: char *json_token2str(const char *jstr, jtok_t * __restrict tok);
1.8 misho 142: #define json_token2obj json_token2str
1.5 misho 143: #define json_freestr(x) e_free((x))
1.2 misho 144: /*
145: * json_token2num() - Return token to numeric
146: *
147: * @jstr = JSON string
148: * @tok = Token for convert
149: * @return number
150: */
151: long json_token2num(const char *jstr, jtok_t * __restrict tok);
152: /*
1.5 misho 153: * json_token2dbl() - Return token to double
154: *
155: * @jstr = JSON string
156: * @tok = Token for convert
157: * @return number
158: */
159: double json_token2dbl(const char *jstr, jtok_t * __restrict tok);
1.6 misho 160: /*
161: * json_token2bool() - Return token to bool int
162: *
163: * @jstr = JSON string
164: * @tok = Token for convert
165: * @return 0 for FALSE and !=0 for TRUE
166: */
167: int json_token2bool(const char *jstr, jtok_t * __restrict tok);
1.5 misho 168: /*
1.10 ! misho 169: * json_token2vars() - Convert token to string variable array
1.2 misho 170: *
171: * @jstr = JSON string
172: * @tok = Token for convert
173: * return: =NULL error or !=NULL allocated array with string variables,
174: * after use should be ait_freeVars()
175: */
1.10 ! misho 176: array_t *json_token2vars(const char *jstr, jtok_t * __restrict tok);
! 177: /*
! 178: * json_token2array() - Convert token to string array
! 179: *
! 180: * @jstr = JSON string
! 181: * @tok = Token for convert
! 182: * return: =NULL error or !=NULL allocated array with strings,
! 183: * after use should be json_freearray()
! 184: */
1.2 misho 185: array_t *json_token2array(const char *jstr, jtok_t * __restrict tok);
1.10 ! misho 186: /*
! 187: * json_freearray() - Free & destroy allocated array from json_token2array function
! 188: *
! 189: * @parr = Array
! 190: * return -1 error or 0 ok
! 191: */
! 192: int json_freearray(array_t **parr);
! 193:
1.2 misho 194:
195: /*
1.5 misho 196: * json_findbykey() - Find token data by key
1.2 misho 197: *
198: * @jstr = JSON string
199: * @key = Search key
1.4 misho 200: * @type = Search key for particular token type, if is J_UNDEF this mean any type
1.2 misho 201: * @toks = Parsed tokens
202: * @toksnum = Number of parsed tokens
203: * return: =NULL error or !=NULL data token found
204: */
205: jtok_t *json_findbykey(const char *jstr, const char *key,
1.4 misho 206: jtype_t type, jtok_t * __restrict toks, int toksnum);
1.5 misho 207: /*
1.8 misho 208: * json_findbykeyatscope() - Find token data by key at particular scope
209: *
210: * @scope = Search at object scope, =0 main object scope
211: * @jstr = JSON string
212: * @key = Search key
213: * @type = Search key for particular token type, if is J_UNDEF this mean any type
214: * @toks = Parsed tokens
215: * @toksnum = Number of parsed tokens
216: * return: =NULL error or !=NULL data token found
217: */
218: jtok_t *json_findbykeyatscope(long scope, const char *jstr, const char *key,
219: jtype_t type, jtok_t * __restrict toks, int toksnum);
220: /*
1.5 misho 221: * json_findbypos() - Find token by position on JSON string
222: *
223: * @pos = Offset from begin of JSON string
224: * @toks = Parsed tokens
225: * @toksnum = Number of parsed tokens
226: * return: =NULL error or !=NULL token found
227: */
228: jtok_t *json_findbypos(unsigned long pos, jtok_t * __restrict toks, int toksnum);
1.8 misho 229: /*
230: * json_objscope() - Find object scope of key
231: *
232: * @key = Key of object, if it is =NULL, then return 0 (default scope)
233: * @jstr = JSON string
234: * @toks = JSON tokens
235: * @toksnum = Number of tokens
236: * return: -1 on error or >=0 scope of object
237: */
238: long json_objscope(const char *key, const char *jstr, jtok_t * __restrict toks, int toksnum);
1.9 misho 239: /*
240: * json_validate() - Validate JSON
241: *
242: * @jstr = JSON string
1.10 ! misho 243: * @started = if started != NULL then here will return start position of found JSON
1.9 misho 244: * return: -1 error or >=0 where valid JSON ends
245: */
1.10 ! misho 246: int json_validate(const char *jstr, int *started);
! 247: /*
! 248: * json_marshaling() - Prepare JSON to one continues line
! 249: *
! 250: * @jstr = JSON string
! 251: * @space = if it is 0 then spaces will be removed
! 252: * return NULL error or !=NULL ready JSON for proceeding
! 253: */
! 254: char *json_marshaling(char * __restrict jstr, int space);
1.3 misho 255:
256:
257: /*
258: * json_dump_yaml() - Dump parsed JSON string to YAML format
259: *
260: * @f = Output handler
261: * @jstr = JSON string
262: * @toks = JSON tokens
263: * @toksnum = Number of tokens
264: * @indent = Start indent spaces
265: * return: 0 done and 1 added one more item
266: */
267: int json_dump_yaml(FILE *f, const char *jstr, jtok_t *toks, int toksnum, int indent);
1.5 misho 268: /*
269: * json_dump() - Dump parsed JSON string to structure format
270: *
271: * @f = Output handler
272: * @jstr = JSON string
273: * @toks = JSON tokens
274: * @toksnum = Number of tokens
275: * @indent = Start indent spaces
276: * return: 0 done and 1 added one more item
277: */
278: int json_dump(FILE *f, const char *jstr, jtok_t *toks, int toksnum, int indent);
1.2 misho 279:
280:
281: /*
282: * json_add_begin_object() - Adds begin of object {
283: *
284: * @jstr = JSON string
285: * @jlen = JSON string length
286: * @wspace = whitespace include
287: * return: -1 error or !=-1 actual JSON string length
288: */
289: int json_add_begin_object(char * __restrict jstr, int jlen, int wspace);
290: /*
291: * json_add_end_object() - Adds end of object }
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_end_object(char * __restrict jstr, int jlen, int wspace);
299: /*
300: * json_add_begin_array() - Adds begin of array [
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_begin_array(char * __restrict jstr, int jlen, int wspace);
308: /*
309: * json_add_end_array() - Adds end of array ]
310: *
311: * @jstr = JSON string
312: * @jlen = JSON string length
313: * @wspace = whitespace include
314: * return: -1 error or !=-1 actual JSON string length
315: */
316: int json_add_end_array(char * __restrict jstr, int jlen, int wspace);
317: /*
318: * json_add_char() - Adds character
319: *
320: * @jstr = JSON string
321: * @jlen = JSON string length
322: * @ch = Character
323: * return: -1 error or !=-1 actual JSON string length
324: */
325: int json_add_char(char * __restrict jstr, int jlen, unsigned char ch);
326: /*
327: * json_add_colon() - Adds key/value pair delimiter colon :
328: *
329: * @jstr = JSON string
330: * @jlen = JSON string length
331: * @wspace = whitespace include
332: * return: -1 error or !=-1 actual JSON string length
333: */
334: int json_add_colon(char * __restrict jstr, int jlen, int wspace);
335: /*
336: * json_add_comma() - Adds value delimiter comma ,
337: *
338: * @jstr = JSON string
339: * @jlen = JSON string length
340: * @wspace = whitespace include
341: * return: -1 error or !=-1 actual JSON string length
342: */
343: int json_add_comma(char * __restrict jstr, int jlen, int wspace);
344: /*
345: * json_add_string() - Adds string
346: *
347: * @jstr = JSON string
348: * @jlen = JSON string length
349: * @unquot = Unquoted string
350: * @str = String, it can't be NULL
351: * return: -1 error or !=-1 actual JSON string length
352: */
353: int json_add_string(char * __restrict jstr, int jlen, int unquot, const char *str);
354: /*
355: * json_add_value() - Adds value
356: *
357: * @jstr = JSON string
358: * @jlen = JSON string length
359: * @unquot = Unquoted number
360: * @num = Number
361: * return: -1 error or !=-1 actual JSON string length
362: */
363: int json_add_value(char * __restrict jstr, int jlen, int unquot, long num);
364: /*
365: * json_add_pair() - Adds key/value pair
366: *
367: * @jstr = JSON string
368: * @jlen = JSON string length
369: * @wspace = whitespace include
370: * @key = Key string
371: * @val = Value string
372: * return: -1 error or !=-1 actual JSON string length
373: */
374: int json_add_pair(char * __restrict jstr, int jlen, int wspace,
375: const char *key, const char *val);
1.7 misho 376: /*
377: * json_add_pair2() - Adds key/value pair with formated args
378: *
379: * @jstr = JSON string
380: * @jlen = JSON string length
381: * @wspace = whitespace include
382: * @key = Key string
383: * @fmt = Format string for values
384: * return: -1 error or !=-1 actual JSON string length
385: */
386: int json_add_pair2(char * __restrict jstr, int jlen, int wspace,
387: const char *key, const char *fmt, ...);
1.2 misho 388: /*
389: * json_add_array() - Adds array
390: *
391: * @jstr = JSON string
392: * @jlen = JSON string length
393: * @wspace = whitespace include
394: * @arr = Array with variables
395: * return: -1 error or !=-1 actual JSON string length
396: */
397: int json_add_array(char * __restrict jstr, int jlen, int wspace,
398: array_t * __restrict arr);
399:
1.9 misho 400: #ifdef __cplusplus
401: }
402: #endif
1.2 misho 403:
404: #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