source/core/inc/mh5json.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2010 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MH5JSON_H
#define _MH5JSON_H

/*---includes for this file--------------------------------------------------*/
#include "techtype.h"
#include "dtvstring.h"

/*---Constant and macro definitions for public use---------------------------*/
/* values given to callback when JST_CBF_ARRAY_OBJ */
#define JSON_VALUE_FINISH  0x80000000
#define JSON_VALUE_ERROR   0xffffffff
#define NULL_TOKEN         ""

/* helpful macro's for creating const token elements of S_JSON_MEMBERS */
#define DECLARE_MEMBER( token_str, type, ptr, child_object ) \
   { sizeof(token_str) - 1, token_str, type, {ptr}, child_object  }
#define DECLARE_OBJECT( cb_func ) \
   { 0, NULL_TOKEN, JST_CBF_OBJECT, {cb_func}, NULL }
#define DECLARE_OBJEND() \
   { 0, NULL_TOKEN, JST_NOTHING, {NULL}, NULL }

/*---Enumerations for public use---------------------------------------------*/

/*---Global type defs for public use-----------------------------------------*/

typedef enum
{
   JST_NOTHING,
   JST_PTR_INTEGER,
   JST_PTR_STRING,
   JST_PTR_ASTRING,
   JST_CBF_OBJECT,
   JST_CBF_INTEGER,
   JST_CBF_STRING,
   JST_CBF_ASTRING,
   JST_CBF_ARRAY_OBJ,
   /*below are not yet supported*/
   JST_CBF_ARRAY_INT,
   JST_CBF_ARRAY_STR
} E_JSON_TYPE;

typedef enum
{
   JSON_ERROR,
   JSON_OKAY,
   JSON_MAIN,
   JSON_NEXT,
} E_JSON_STATE;


typedef void * (*JsonCallback)( unsigned int val, void *array, void *usr );


typedef struct s_json_members
{
   unsigned int tk_len;
   const char *tk_str;
   E_JSON_TYPE type;
   union
   {
      void *ptr;
      JsonCallback cb_func;
      U32BIT *p_uint;
      S_STRING *p_str;
   } u;
   const struct s_json_members *pChildren;
} S_JSON_MEMBERS;


/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/

E_JSON_STATE JSON_Parse( U8BIT *data, U32BIT size,
   const S_JSON_MEMBERS *members, void *usr );

void JSON_FreeAstring( S_STRING *p_str );

void JSON_FreeUintArray( U32BIT *p_uint );

void JSON_FreeStrArray( S_STRING **pp_str );

#endif /*_MH5JSON_H*/