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

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.2 ! misho       6: * $Id: ajson.h,v 1.1.2.1 2017/11/24 09:54:01 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,
        !            56:        J_NUMBER = 4,
        !            57:        J_BOOL = 5,
        !            58:        J_NULL = 6
        !            59: } jtype_t;
        !            60: 
        !            61: /* JSON error numbers */
        !            62: typedef enum {
        !            63:        J_ERR_OK = 0,
        !            64:        J_ERR_NOMEM = 1,
        !            65:        J_ERR_INVAL = 2,
        !            66:        J_ERR_PART = 3
        !            67: } jerr_t;
        !            68: 
        !            69: /* JSON error strings */
        !            70: typedef const char jerrstr[] = {
        !            71:        "No error",
        !            72:        "Not enough tokens were provided",
        !            73:        "Invalid character",
        !            74:        "JSON string isn't full",
        !            75:        NULL
        !            76: };
        !            77: 
        !            78: typedef struct _tagParser {
        !            79:        unsigned long   pos;
        !            80:        unsigned long   next;
        !            81:        long            parent;
        !            82: } json_t;
        !            83: 
        !            84: typedef struct _tagToken {
        !            85:        jtype_t         tok_type;
        !            86:        long            tok_start;
        !            87:        long            tok_end;
        !            88:        long            tok_size;
        !            89:        long            tok_parent;
        !            90: } jtok_t;
        !            91: 
        !            92: 
        !            93: /*
        !            94:  * json_init() - Initialize JSON handler
        !            95:  *
        !            96:  * @json = JSON handler, if there is NULL then dynamically will be allocated
        !            97:  * return: =NULL error or !=NULL ready for use JSON handler.
        !            98:  */
        !            99: json_t *json_init(json_t * __restrict json);
        !           100: 
        !           101: /*
        !           102:  * json_free() - Free JSON handler
        !           103:  *
        !           104:  * @json = JSON handler
        !           105:  * return: none
        !           106:  */
        !           107: void json_free(json_t **json);
        !           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.1   misho     121: 
                    122: 
                    123: #endif

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