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