m2mb_xml.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef _M2MB_XML_H_
#define _M2MB_XML_H_

#ifdef __cplusplus
extern "C" {
#endif

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/


/* Global declarations ==========================================================================*/


/* Global typedefs ==============================================================================*/

typedef enum M2MB_XML_OBJ_TYPE
{
    M2MB_XML_COMPLEX_ELEMENT,   
    M2MB_XML_SIMPLE_ELEMENT,    
    M2MB_XML_ATTRIBUTE,         
    M2MB_XML_NONE               
} M2MB_XML_OBJ_TYPE_T;

typedef enum M2MB_XML_DATA_TYPE
{
    M2MB_XML_DT_NONE,       
    M2MB_XML_DT_UINT8,      
    M2MB_XML_DT_INT8,       
    M2MB_XML_DT_UINT16,     
    M2MB_XML_DT_INT16,      
    M2MB_XML_DT_UINT32,     
    M2MB_XML_DT_INT32,      
    M2MB_XML_DT_UINT64,     
    M2MB_XML_DT_INT64,      
    M2MB_XML_DT_FLOAT,      
    M2MB_XML_DT_DOUBLE,     
    M2MB_XML_DT_STR,        
    M2MB_XML_DT_TOKEN,      
    M2MB_XML_DT_BASE64BIN,  
    M2MB_XML_DT_HEXBIN,     
    M2MB_XML_DT_DATE,       
    M2MB_XML_DT_TIME,       
    M2MB_XML_DT_DATE_TIME,  
    M2MB_XML_DT_DURATION    
} M2MB_XML_DATA_TYPE_T;

typedef struct M2MB_XML_NODE
{
    UINT8 *pName;   
    UINT8 *pStart;  
    UINT8 *pEnd;    
} M2MB_XML_NODE_T;

typedef struct M2MB_XML_DATE
{
    UINT16 year;        
    UINT8  month;       
    UINT8  day;         
    UINT8  hrOffset;    
    UINT8  minOffset;   
} M2MB_XML_DATE_T;

typedef struct M2MB_XML_TIME
{
    UINT8  hr;          
    UINT8  min;         
    UINT8  sec;         
    UINT8  hrOffset;    
    UINT8  minOffset;   
} M2MB_XML_TIME_T;

typedef struct M2MB_XML_DATE_TIME
{
    UINT16 year;        
    UINT8  month;       
    UINT8  day;         
    UINT8  hr;          
    UINT8  min;         
    UINT8  sec;         
    UINT8  hrOffset;    
    UINT8  minOffset;   
} M2MB_XML_DATE_TIME_T;

typedef struct M2MB_XML_DURATION
{
    UINT16 year;    
    UINT8  month;   
    UINT8  day;     
    UINT8  hr;      
    UINT8  min;     
    UINT8  sec;     
} M2MB_XML_DURATION_T;


typedef struct M2MB_XML_STRING
{
    UINT8   type;   
    UINT16  len;    
    UINT8   *ptr;   
} M2MB_XML_STRING_T;

typedef struct M2MB_XML_OBJ
{
    UINT8         *pName;           
    M2MB_XML_OBJ_TYPE_T   objType;  
    M2MB_XML_DATA_TYPE_T dataType;  
    UINT8 maxObjOcc;                
    UINT16        offset;           
} M2MB_XML_OBJ_T;

typedef struct M2MB_XML_COMPLEX_INFO
{
    UINT8 maxNumOfObj;              
    UINT16     size;                
    const M2MB_XML_OBJ_T **pObj;    
} M2MB_XML_COMPLEX_INFO_T;

typedef struct M2MB_XML_COMPLEX_OBJ
{
    M2MB_XML_OBJ_T        obj;              
    M2MB_XML_COMPLEX_INFO_T  complexobj;    
} M2MB_XML_COMPLEX_OBJ_T;



/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_xml_encode( M2MB_XML_COMPLEX_OBJ_T *xml_schema,
    UINT8 *user_struct, UINT8 *xml_file_buffer, UINT32 xml_file_buffer_Size, 
    UINT32 *len_of_xml_written );
                           
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_xml_decode( UINT8 *parent_start, UINT8* parent_end,
    M2MB_XML_COMPLEX_OBJ_T *xml_schema, UINT8 *return_struct );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_xml_node_get( M2MB_XML_NODE_T *child_node, 
    UINT8 *parent_node_start, UINT8 *parent_node_end,UINT8 *tag_end );
                     
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
UINT8 m2mb_xml_node_occ_get( UINT8 *pTName, UINT8 *pPNStart, 
    UINT8 *pPNEnd );

/*-----------------------------------------------------------------------------------------------*/


#ifdef __cplusplus
}
#endif
#endif /* _M2MB_XML_H_ */