Annotation of libelwix/inc/elwix/ajson.h, revision 1.1.2.6

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.6 ! misho       6: * $Id: ajson.h,v 1.1.2.5 2017/11/28 00:46:53 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 {
                     78:        jtype_t         tok_type;
                     79:        long            tok_start;
                     80:        long            tok_end;
                     81:        long            tok_size;
                     82:        long            tok_parent;
                     83: } jtok_t;
1.1.2.6 ! misho      84: #define json_toktype(x)                (x)->tok_type
        !            85: #define json_toksize(x)                (x)->tok_size
        !            86: #define json_toklen(x)         ((x)->tok_end - (x)->tok_start)
        !            87: #define json_tokstr(j, x)      ((j) + (x)->tok_start)
        !            88: #define json_tokstrcpy(d, j, x)        { strncpy((d), json_tokstr((j), (x)), json_toklen(x) - 1); \
        !            89:                                        (d)[json_toklen(x)] = 0; } 
1.1.2.2   misho      90: 
                     91: 
                     92: /*
                     93:  * json_init() - Initialize JSON handler
                     94:  *
                     95:  * @json = JSON handler, if there is NULL then dynamically will be allocated
1.1.2.3   misho      96:  * @jstrict = JSON strict mode, when we select strict mode every unquoted value is error
                     97:  * return: =NULL error or !=NULL ready for use JSON handler and should be free with json_free()
1.1.2.2   misho      98:  */
1.1.2.3   misho      99: json_t *json_init(json_t * __restrict json, int jstrict);
1.1.2.2   misho     100: 
                    101: /*
                    102:  * json_free() - Free JSON handler
                    103:  *
                    104:  * @json = JSON handler
                    105:  * return: none
                    106:  */
1.1.2.3   misho     107: void json_free(json_t * __restrict json);
1.1.2.2   misho     108: 
                    109: /*
                    110:  * json_parse() - Parse JSON string
                    111:  *
                    112:  * @json = JSON handler
                    113:  * @jstr = JSON string
                    114:  * @jlen = JSON string length
                    115:  * @jtoks = Token array
                    116:  * @toksnum = Token array size, return number of allocated tokens in array
                    117:  * return: -1 error or number of found tokens 
                    118:  */
                    119: unsigned int json_parse(json_t * __restrict json, const char *jstr, size_t jlen, 
                    120:                jtok_t * __restrict jtoks, unsigned int toksnum);
1.1.2.5   misho     121: 
                    122: /*
                    123:  * json_token2val() - Return token to AIT variable
                    124:  *
                    125:  * @jstr = JSON string
                    126:  * @tok = Token for convert
                    127:  * @return =NULL error or !=NULL variable, after use should be ait_freeVar()
                    128:  */
                    129: ait_val_t *json_token2val(const char *jstr, jtok_t * __restrict tok);
                    130: /*
                    131:  * json_token2str() - Return token to string
                    132:  *
                    133:  * @jstr = JSON string
                    134:  * @tok = Token for convert
                    135:  * @return =NULL error or !=NULL allocated str, after use should be e_free()
                    136:  */
                    137: char *json_token2str(const char *jstr, jtok_t * __restrict tok);
                    138: /*
                    139:  * json_token2num() - Return token to numeric
                    140:  *
                    141:  * @jstr = JSON string
                    142:  * @tok = Token for convert
                    143:  * @return number
                    144:  */
                    145: long json_token2num(const char *jstr, jtok_t * __restrict tok);
                    146: /*
                    147:  * json_token2array() - Convert token to array
                    148:  *
                    149:  * @jstr = JSON string
                    150:  * @tok = Token for convert
                    151:  * return: =NULL error or !=NULL allocated array with variables, 
                    152:  *             after use should be ait_freeVars()
                    153:  */
                    154: array_t *json_token2array(const char *jstr, jtok_t * __restrict tok);
                    155: 
                    156: /*
                    157:  * json_findbykey() - Find data by key
                    158:  *
                    159:  * @jstr = JSON string
                    160:  * @key = Search key
                    161:  * @toks = Parsed tokens
                    162:  * @toksnum = Number of parsed tokens
                    163:  * return: =NULL error or !=NULL data token found 
                    164:  */
                    165: jtok_t *json_findbykey(const char *jstr, const char *key, 
                    166:                jtok_t * __restrict toks, int toksnum);
1.1.2.1   misho     167: 
                    168: 
                    169: #endif

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>