json.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__include
#define ti_utils_json_Json__include


/*
 *  ======== json.h ========
 *  @brief Contains JSON library APIs
 */

/*
 * ==========================json scenario examples=========================
 *
 *  Create json from       | Parse the json and get | Parse the json, change
 *  scratch and build it   | its value              | its value and build it
 *  +--------------------+ | +--------------------+ | +--------------------+
 *  |Json_createTemplate | | |Json_createTemplate | | |Json_createTemplate |
 *  +--------------------+ | +--------------------+ | +--------------------+
 *             |           |            |           |            |
 *             v           |            v           |            v
 *  +--------------------+ | +--------------------+ | +--------------------+
 *  |Json_createObject   | | |Json_createObject   | | |Json_createObject   |
 *  +--------------------+ | +--------------------+ | +--------------------+
 *             |           |            |           |            |
 *             v           |            v           |            v
 *  +--------------------+ | +--------------------+ | +--------------------+
 *  |Json_setValue       | | |Json_parse          | | |Json_parse          |
 *  +--------------------+ | +--------------------+ | +--------------------+
 *             |           |            |           |            |
 *             v           |            v           |            v
 *  +--------------------+ | +--------------------+ | +--------------------+
 *  |Json_build          | | |Json_getValue       | | |Json_getValue       |
 *  +--------------------+ | +--------------------+ | +--------------------+
 *             |           |            |           |            |
 *             v           |            v           |            v
 *  +--------------------+ | +--------------------+ | +--------------------+
 *  |Json_destroyObject  | | |Json_destroyObject  | | |Json_setValue       |
 *  +--------------------+ | +--------------------+ | +--------------------+
 *             |           |            |           |            |
 *             v           |            v           |            v
 *  +--------------------+ | +--------------------+ | +--------------------+
 *  |Json_destroyTemplate| | |Json_destroyTemplate| | |Json_build          |
 *  +--------------------+ | +--------------------+ | +--------------------+
 *                         |                        |            |
 *                         |                        |            v
 *                         |                        | +--------------------+
 *                         |                        | |Json_destroyObject  |
 *                         |                        | +--------------------+
 *                         |                        |            |
 *                         |                        |            v
 *                         |                        | +--------------------+
 *                         |                        | |Json_destroyTemplate|
 *                         |                        | +--------------------+
 *
 * =========================================================================
 */

#include <stdlib.h>
#include <string.h>
#include "json_engine.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef size_t Json_Handle;

#define JSON_DEFAULT_SIZE                       (1024u)

int16_t Json_createTemplate(Json_Handle *templateHandle,
    const char *templateString, uint16_t templateStringLen);


int16_t Json_destroyTemplate(Json_Handle templateHandle);

int16_t Json_createObject(Json_Handle *objHandle, Json_Handle templateHandle,
        uint16_t maxObjectSize);


int16_t Json_destroyObject(Json_Handle objHandle);

int16_t Json_parse(Json_Handle objHandle, char *jsonText, uint16_t jsonTextLen);


int16_t Json_getArrayMembersCount(Json_Handle objHandle, const char *pKey);


int16_t Json_getValue(Json_Handle objHandle, const char *pKey, void *pValue,
        uint16_t *maxValueSize);


int16_t Json_setValue(Json_Handle objHandle, const char *pKey, void *pValue,
        uint16_t valueSize);


int16_t Json_build(Json_Handle objHandle, char *pJsonText, uint16_t *maxTxtLen);

#ifdef __cplusplus
}
#endif

#endif