le_json.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------

#ifndef LEGATO_JSON_H_INCLUDE_GUARD
#define LEGATO_JSON_H_INCLUDE_GUARD


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_JSON_OBJECT_START,   
    LE_JSON_OBJECT_MEMBER,  
    LE_JSON_OBJECT_END,     
    LE_JSON_ARRAY_START,    
    LE_JSON_ARRAY_END,      
    LE_JSON_STRING,         
    LE_JSON_NUMBER,         
    LE_JSON_TRUE,           
    LE_JSON_FALSE,          
    LE_JSON_NULL,           
    LE_JSON_DOC_END,        
}
le_json_Event_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (* le_json_EventHandler_t)
(
    le_json_Event_t event
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_JSON_SYNTAX_ERROR,   
    LE_JSON_READ_ERROR,     
}
le_json_Error_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (* le_json_ErrorHandler_t)
(
    le_json_Error_t error,
    const char* msg
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_json_ParsingSession* le_json_ParsingSessionRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API le_json_ParsingSessionRef_t le_json_Parse
(
    int fd, 
    le_json_EventHandler_t  eventHandler,   
    le_json_ErrorHandler_t  errorHandler,   
    void* opaquePtr   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_json_ParsingSessionRef_t le_json_ParseString
(
    const char *jsonString, 
    le_json_EventHandler_t  eventHandler,   
    le_json_ErrorHandler_t  errorHandler,   
    void* opaquePtr   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_json_Cleanup
(
    le_json_ParsingSessionRef_t session 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_json_SetEventHandler
(
    le_json_EventHandler_t  callbackFunc  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_JSON_CONTEXT_DOC,    
    LE_JSON_CONTEXT_OBJECT, 
    LE_JSON_CONTEXT_MEMBER, 
    LE_JSON_CONTEXT_ARRAY,  
    LE_JSON_CONTEXT_STRING, 
    LE_JSON_CONTEXT_NUMBER, 
    LE_JSON_CONTEXT_TRUE,   
    LE_JSON_CONTEXT_FALSE,  
    LE_JSON_CONTEXT_NULL,   
}
le_json_ContextType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_json_ContextType_t le_json_GetContextType
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_json_SetOpaquePtr
(
    void* ptr    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void* le_json_GetOpaquePtr
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_json_SetErrorHandler
(
    le_json_ErrorHandler_t  callbackFunc    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
const char* le_json_GetString
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
double le_json_GetNumber
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
const char* le_json_GetEventName
(
    le_json_Event_t event
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
const char* le_json_GetContextName
(
    le_json_ContextType_t context
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
size_t le_json_GetBytesRead
(
    le_json_ParsingSessionRef_t session 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_json_ParsingSessionRef_t le_json_GetSession
(
    void
);


#endif // LEGATO_JSON_H_INCLUDE_GUARD