include/errorHandle.h

Go to the documentation of this file.

/*==================================================================*\
|                EXIP - Embeddable EXI Processor in C                |
|--------------------------------------------------------------------|
|          This work is licensed under BSD 3-Clause License          |
|  The full license terms and conditions are located in LICENSE.txt  |
\===================================================================*/

#ifndef ERRORHANDLE_H_
#define ERRORHANDLE_H_

#include "exipConfig.h"

#define INFO 1
#define WARNING 2
#define ERROR 3

#if EXIP_DEBUG == ON

#  include <stdio.h>

/* Platform specific debugging character output */
# ifndef DEBUG_CHAR_OUTPUT
#  define DEBUG_CHAR_OUTPUT(character)  do {putchar (character);} while(0)
# endif

/* Platform specific debugging formatted output */
# ifndef DEBUG_OUTPUT
#  define DEBUG_OUTPUT(msg) do {printf msg;} while(0)
# endif

# ifndef EXIP_DEBUG_LEVEL
#  define EXIP_DEBUG_LEVEL INFO
# endif

# define DEBUG_MSG(level, module, msg) do { if (level >= EXIP_DEBUG_LEVEL && module == ON) { DEBUG_OUTPUT(msg); } } while(0)
#else
#  define DEBUG_MSG(level, module, msg)
#endif /* EXIP_DEBUG */

// IMPORTANT: remember to keep in sync with "errorCodeStrings[]" in procTypes.c!
/* Definitions for error constants. */
enum errorCode
{
     EXIP_OK                                     = 0,
     EXIP_NOT_IMPLEMENTED_YET                    = 1,
     EXIP_UNEXPECTED_ERROR                       = 2,
     EXIP_HASH_TABLE_ERROR                       = 3,
     EXIP_OUT_OF_BOUND_BUFFER                    = 4,
     EXIP_NULL_POINTER_REF                       = 5,
     EXIP_MEMORY_ALLOCATION_ERROR                = 6,
     EXIP_INVALID_EXI_HEADER                     = 7,
     EXIP_INCONSISTENT_PROC_STATE                = 8,
     EXIP_INVALID_EXI_INPUT                      = 9,
     EXIP_BUFFER_END_REACHED                     =10,
     EXIP_PARSING_COMPLETE                       =11,
     EXIP_INVALID_EXIP_CONFIGURATION             =12,
     EXIP_NO_PREFIXES_PRESERVED_XML_SCHEMA       =13,
     EXIP_INVALID_STRING_OPERATION               =14,
     EXIP_HEADER_OPTIONS_MISMATCH                =15,
     EXIP_HANDLER_STOP                           =16
};

typedef enum errorCode errorCode;

#if EXIP_DEBUG == ON
  extern const char* errorCodeStrings[];
# define GET_ERR_STRING(indx) errorCodeStrings[indx]
#else
# define GET_ERR_STRING(indx) ""
#endif

# define TRY(func) do { tmp_err_code = func;\
                        if (tmp_err_code != EXIP_OK) { \
                            DEBUG_MSG(ERROR, EXIP_DEBUG, ("\n>Error %s:%d at %s, line %d", GET_ERR_STRING(tmp_err_code), tmp_err_code, __FILE__, __LINE__)); \
                            return tmp_err_code; } } while(0)

# define TRY_CATCH(func, cblock) do { tmp_err_code = func;\
                                      if (tmp_err_code != EXIP_OK) { \
                                      DEBUG_MSG(ERROR, EXIP_DEBUG, ("\n>Error %s:%d at %s, line %d", GET_ERR_STRING(tmp_err_code), tmp_err_code, __FILE__, __LINE__)); \
                                      cblock;\
                                      return tmp_err_code; } } while(0)

#endif /* ERRORHANDLE_H_ */