ichthyo/LUMIERA.clone
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doxycomment errorhandling, small macro improvement

Browse source
This commit is contained in:
Christian Thaeter 2007-08-23 05:30:29 +02:00
parent 0aaaa1c368
commit e2ffd09f4b
1 changed files with 39 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
src/lib/error.h
View file

@ -24,21 +24,57 @@
#include <nobug.h>
#include <stdlib.h>
/**
* C Error handling in Cinelerra.
*/
/**
* Abort unconditionally with a 'Fatal Error!' message.
* This macro is used whenever the program end up in a invalid state from which no runtime recovery is possible
*/
#define CINELERRA_DIE do { NOBUG_ERROR(NOBUG_ON, "Fatal Error!"); abort(); } while(0)
/**
* Forward declare an error constant.
* This macro eases the error declaration in header files
* @param err name of the error without the 'CINELERRA_ERROR_' prefix (example: NO_MEMORY)
*/
#define CINELERRA_ERROR_DECLARE(err) \
extern const char* CINELERRA_ERROR_##err
/**
* Definition and initialization of an error constant.
* This macro eases the error definition in implementation files
* @param err name of the error without the 'CINELERRA_ERROR_' prefix (example: NO_MEMORY)
* @param msg message describing the error in plain english (example: "memory allocation failed")
*/
#define CINELERRA_ERROR_DEFINE(err, msg) \
const char* CINELERRA_ERROR_##err = "CINELERRA_ERROR_" #err ":" msg
#define CINELERRA_ERROR_SET(flag, err) \
ERROR (flag, "%s", strchr(CINELERRA_ERROR_##err, ':')+1); \
cinelerra_error_set(CINELERRA_ERROR_##err)
/** Helper macro to raise an error for the current thread.
* This macro eases setting an error. It adds NoBug logging support to the low level error handling.
* @param flag NoBug flag describing the subsystem where the error was raised
* @param err name of the error without the 'CINELERRA_ERROR_' prefix (example: NO_MEMORY)
*/
#define CINELERRA_ERROR_SET(flag, err) \
(({ERROR (flag, "%s", strchr(CINELERRA_ERROR_##err, ':')+1);}), \
cinelerra_error_set(CINELERRA_ERROR_##err))
/**
* Set error state for the current thread.
* If the error state of the current thread was cleared, then set it, else preserve the old state.
* @param err name of the error with 'CINELERRA_ERROR_' prefix (example: CINELERRA_ERROR_NO_MEMORY)
* @return old state, that is NULL for success, when the state was cleared and a pointer to a pending error when the error state was already set
*/
const char*
cinelerra_error_set (const char * err);
/**
* Get and clear current error state.
* This function clears the error state, if it needs to be reused, one has to store it in a temporary variable.
* @return pointer to any pending error of this thread, NULL if no error is pending
*/
const char*
cinelerra_error ();