Error Handling API

Collaboration diagram for Error Handling API:

Topics
	Return Values

Files
file	merror.h

Macros
#define	merror_sz_to_retval(sz)
#define	merror_retval_to_sz(retval)
#define	maug_cleanup_if_null_msg(type, ptr, err, msg)
#define	maug_cleanup_if_not_null(type, ptr, err)
#define	maug_cleanup_if_null(type, ptr, err)
#define	maug_cleanup_if_null_alloc(type, ptr)
#define	maug_cleanup_if_null_lock(type, ptr)
#define	maug_cleanup_if_null_file(ptr)
#define	maug_cleanup_if_not_ok()
#define	maug_cleanup_if_not_ok_msg(msg)
#define	maug_cleanup_if_lt(a, b, fmt, err)
#define	maug_cleanup_if_lt_overflow(a, b)
#define	maug_cleanup_if_ge(a, b, fmt, err)
#define	maug_cleanup_if_ge_overflow(a, b)
#define	maug_cleanup_if_eq(a, b, fmt, err)
#define	maug_cleanup_if_ne(a, b, fmt, err)

Functions
void	maug_critical_error (const char *msg)
	Display an error dialog. This is a minimal function that can be called early on (e.g. in the logging API).

Detailed Description

Macro Definition Documentation

maug_cleanup_if_eq

#define maug_cleanup_if_eq	(		a,
			b,
			fmt,
			err )

Value:

   if( (a) == (b) ) { \
      error_printf( #a " " fmt " is equal to " #b " " fmt "!", a, b ); \
      retval = err; \
      goto cleanup; \
   }

maug_cleanup_if_ge

#define maug_cleanup_if_ge	(		a,
			b,
			fmt,
			err )

Value:

   if( (a) >= (b) ) { \
      error_printf( fmt " is greater or equal to " fmt "!", a, b ); \
      retval = err; \
      goto cleanup; \
   }

maug_cleanup_if_ge_overflow

#define maug_cleanup_if_ge_overflow	(		a,
			b )

Value:

   maug_cleanup_if_ge( a, (size_t)(b), SIZE_T_FMT, MERROR_OVERFLOW )

maug_cleanup_if_lt

#define maug_cleanup_if_lt	(		a,
			b,
			fmt,
			err )

Value:

   if( (a) < (b) ) { \
      error_printf( fmt " is less than " fmt "!", a, b ); \
      retval = err; \
      goto cleanup; \
   }

maug_cleanup_if_lt_overflow

#define maug_cleanup_if_lt_overflow	(		a,
			b )

Value:

   maug_cleanup_if_lt( a, b, SIZE_T_FMT, MERROR_OVERFLOW )

maug_cleanup_if_ne

#define maug_cleanup_if_ne	(		a,
			b,
			fmt,
			err )

Value:

   if( (a) != (b) ) { \
      error_printf( #a " " fmt " is NOT equal to " #b " " fmt "!", a, b ); \
      retval = err; \
      goto cleanup; \
   }

maug_cleanup_if_not_null

#define maug_cleanup_if_not_null	(		type,
			ptr,
			err )

Value:

   if( (type)NULL == ptr ) { \
      error_printf( #ptr " is not NULL!" ); \
      retval = err; \
      goto cleanup; \
   }

maug_cleanup_if_not_ok

#define maug_cleanup_if_not_ok

(

)

Value:

   if( MERROR_OK != retval ) { \
      goto cleanup; \
   }

maug_cleanup_if_not_ok_msg

#define maug_cleanup_if_not_ok_msg

(

msg

)

Value:

   if( MERROR_OK != retval ) { \
      error_printf( msg ); \
      goto cleanup; \
   }

maug_cleanup_if_null

#define maug_cleanup_if_null	(		type,
			ptr,
			err )

Value:

   maug_cleanup_if_null_msg( type, ptr, err, "failed to allocate " #ptr "!" )

maug_cleanup_if_null_alloc

#define maug_cleanup_if_null_alloc	(		type,
			ptr )

Value:

   maug_cleanup_if_null_msg( type, ptr, MERROR_ALLOC, "failed to allocate " #ptr "!" )

maug_cleanup_if_null_file

#define maug_cleanup_if_null_file

(

ptr

)

Value:

   maug_cleanup_if_null_msg( FILE*, ptr, MERROR_FILE, "failed to open FILE!" )

maug_cleanup_if_null_lock

#define maug_cleanup_if_null_lock	(		type,
			ptr )

Value:

   maug_cleanup_if_null_msg( type, ptr, MERROR_ALLOC, "failed to lock " #ptr "!" )

maug_cleanup_if_null_msg

#define maug_cleanup_if_null_msg	(		type,
			ptr,
			err,
			msg )

Value:

   if( (type)NULL == ptr ) { \
      error_printf( msg ); \
      retval = err; \
      goto cleanup; \
   }

merror_retval_to_sz

#define merror_retval_to_sz

(

retval

)

Value:

((retval) * -1)

merror_sz_to_retval

#define merror_sz_to_retval

(

sz

)

Value:

((sz) * -1)

Function Documentation

maug_critical_error()

void maug_critical_error

(

const char *

msg

)

Display an error dialog. This is a minimal function that can be called early on (e.g. in the logging API).

This is a rare example of an exception to layering, so that critical early components can display an urgent dialog using higher-level later components.