json_engine.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_utils_json_Json_engine__include
#define ti_utils_json_Json_engine__include


#include <stdint.h>
#include <stdbool.h>

#ifdef  __cplusplus
extern "C" {
#endif

/*****************************************************************************

    API Prototypes

*****************************************************************************/

#define __O
#define _IO_
#define _I_             const

typedef enum json_rc_TAG
{
    JSON_RC__OK                                      =      0  ,
    JSON_RC__RECOVERED__IGNORED_UNKNOWN_VALUE        =     -1  ,

    JSON_RC__RECOVERED__NESTING_EXCEEDED__IGNORING_LEAVES =-4  ,
    JSON_RC__RECOVERED__PARSING_FAILURE              =     -5  ,
    JSON_RC__RECOVERED__INVALID_VALUE                =    -22  ,
    JSON_RC__RECOVERED__NUMBER_ACCURACY_LOSS         =    -23  ,
    JSON_RC__RECOVERED__NUMBER_OVERFLOW              =    -24  ,
    JSON_RC__RECOVERED__ILLEGAL_Q_VALUES             =    -25  ,
    JSON_RC__RECOVERED__STRING_TRUNCATED             =    -28  ,

    JSON_RC__REWIND_REQUIRED                         =    -99  ,
    JSON_RC__RECOVERABLE_ERROR__MINIMUM_VALUE        =   -100  ,

    JSON_RC__PARSING_BUFFER_SIZE_EXCEEDED            =   -101  ,
    JSON_RC__PARSING_FAILURE                         =   -102  ,
    JSON_RC__PARSING_FAILURE__INCOMPLETE_STRING      =   -103  ,
    JSON_RC__NO_HASH_FOUND                           =   -104  ,
    JSON_RC__BUILDING_UNKNOWN_ATOM                   =   -105  ,
    JSON_RC__BUILDING_BUFFER_SIZE_EXCEEDED           =   -106  ,
    JSON_RC__BUILDING_PARSED_DATA_EXHAUSTED          =   -107  ,
    JSON_RC__WRONG_VALUE_SIZE_FOR_TYPE               =   -108  ,
    JSON_RC__VALUE_NOT_AN_ARRAY                      =   -109  ,
    JSON_RC__INDEX_FAR_BEYOND_ARRAY_END              =   -110  ,
    JSON_RC__PARSING_BUFFER_SIZE_WOULD_HAVE_EXCEEDED =   -111  ,
    JSON_RC__NOT_SUPPORTED                           =   -128  ,


    JSON_RC__NOT_FOUND                               =   -200  ,
    JSON_RC__VALUE_IS_NULL                           =   -201  ,
    JSON_RC__VALUE_NOT_VALID                         =   -202  ,
    JSON_RC__NESTING_EXCEEDED                        =   -204  ,

    JSON_RC__MEMORY_ALLOCATION_ERROR                 =   -300  ,
    JSON_RC__INVALID_TEMPLATE_HANDLE                 =   -301  ,
    JSON_RC__INVALID_OBJECT_HANDLE                   =   -302  ,

    JSON_RC__UNEXPECTED_ERROR                        = -16384

} json_rc_T;

#define JSON_PARSE_FLAGS__ESTIMATE_ONLY             0x80000000u

json_rc_T __JSON_Init(__O void *   json_internal,
                      _IO_ uint16_t * json_internal_size,
                      _I_ void *   json_template,
                      _I_ uint16_t json_template_size);

json_rc_T __JSON_Parse(__O void *   json_internal,
                       _IO_ uint16_t * json_internal_size,
                       _I_ char *   json_text,
                       _I_ uint16_t json_text_size,
                       _I_ void *   json_template,
                       _I_ uint16_t json_template_size,
                       _I_ uint32_t flags);

json_rc_T __JSON_Build(__O char *    json_text,
                       _IO_ uint16_t *  json_text_size,
                       _I_ void *    json_internal,
                       _I_ void *    json_template);

json_rc_T __JSON_GetValue(__O void *    value_buffer,
                          _IO_ uint16_t *  value_buffer_size,
                          _I_ void *    json_internal,
                          _I_ char *    property_path,
                          _I_ uint16_t property_path_size);

json_rc_T __JSON_SetValue(_IO_ void *    json_internal,
                          _IO_ uint16_t *  json_internal_size,
                          _I_ void *    value,
                          _I_ uint16_t value_size,
                          _I_ char *    property_path,
                          _I_ uint16_t property_path_size);

json_rc_T __JSON_GetArrayMembersCount(__O uint16_t *  members_count_var,
                                      _I_ void *    json_internal,
                                      _I_ char *    property_path,
                                      _I_ uint16_t property_path_size);
json_rc_T __JSON_Templetize(__O void *      output_template,
                            _IO_ uint16_t *    output_template_size,
                            __O uint16_t *    minimal_template_size,
                            _I_ char *      partly_templetized_json,
                            _I_ uint16_t partly_templetized_json_size);

#ifdef __cplusplus
}
#endif

#endif