XLALError.h File Reference

Prototypes
int	XLALPrintError (const char *fmt,...) _LAL_GCC_PRINTF_FORMAT_(1
	Prints an error message if error printing is enabled by lalDebugLevel. More...
int int	XLALPrintWarning (const char *fmt,...) _LAL_GCC_PRINTF_FORMAT_(1
	Prints a warning message if warning printing is enabled by lalDebugLevel. More...
int int int	XLALPrintInfo (const char *fmt,...) _LAL_GCC_PRINTF_FORMAT_(1
	Prints an info message if info printing is enabled by lalDebugLevel. More...
int int int int	XLALVPrintError (const char *fmt, va_list ap) _LAL_GCC_VPRINTF_FORMAT_(1)
	Prints an error message if error printing is enabled by lalDebugLevel. More...
int	XLALVPrintWarning (const char *fmt, va_list ap) _LAL_GCC_VPRINTF_FORMAT_(1)
	Prints a warning message if warning printing is enabled by lalDebugLevel. More...
int	XLALVPrintInfo (const char *fmt, va_list ap) _LAL_GCC_VPRINTF_FORMAT_(1)
	Prints an info message if info printing is enabled by lalDebugLevel. More...
void	XLALPrintErrorMessage (const char *func, const char *file, int line, const char *fmt,...) _LAL_GCC_PRINTF_FORMAT_(4
	Print an error message with standard XLAL formatting (if error messages are enabled by lalDebugLevel). More...
void void	XLALPrintWarningMessage (const char *func, const char *file, int line, const char *fmt,...) _LAL_GCC_PRINTF_FORMAT_(4
	Print an warning message with standard XLAL formatting (if warning messages are enabled by lalDebugLevel). More...
void void void	XLALPrintInfoMessage (const char *func, const char *file, int line, const char *fmt,...) _LAL_GCC_PRINTF_FORMAT_(4
	Print an info message with standard XLAL formatting (if info messages are enabled by lalDebugLevel). More...
void void void void	XLALVPrintErrorMessage (const char *func, const char *file, int line, const char *fmt, va_list ap) _LAL_GCC_VPRINTF_FORMAT_(4)
	Print an error message with standard XLAL formatting (if error messages are enabled by lalDebugLevel). More...
void	XLALVPrintWarningMessage (const char *func, const char *file, int line, const char *fmt, va_list ap) _LAL_GCC_VPRINTF_FORMAT_(4)
	Print an warning message with standard XLAL formatting (if warning messages are enabled by lalDebugLevel). More...
void	XLALVPrintInfoMessage (const char *func, const char *file, int line, const char *fmt, va_list ap) _LAL_GCC_VPRINTF_FORMAT_(4)
	Print an error message with standard XLAL formatting (if error messages are enabled by lalDebugLevel). More...
int	XLALPrintProgressBar (double)
	Prints a progress bar at the "info" verbosity level. More...
static _LAL_INLINE_ REAL4	XLALREAL4FailNaN (void)
	Returns the value of the XLAL REAL4 failure NaN. More...
static _LAL_INLINE_ REAL8	XLALREAL8FailNaN (void)
	Returns the value of the XLAL REAL8 failure NaN. More...
static _LAL_INLINE_ int	XLALIsREAL4FailNaN (REAL4 val)
	Tests if a value is an XLAL REAL4 failure NaN. More...
static _LAL_INLINE_ int	XLALIsREAL8FailNaN (REAL8 val)
	Tests if a value is an XLAL REAL8 failure NaN. More...
const char *	XLALErrorString (int errnum)
	Returns the error message associated with an error number. More...
void	XLALPerror (const char *func, const char *file, int line, int errnum)
	Prints an error message for a particular error code in a standard format. More...
void	XLALDefaultErrorHandler (const char *func, const char *file, int line, int errnum)
	The default XLAL error handler. More...
void	XLALSilentErrorHandler (const char *func, const char *file, int line, int errnum)
	A silent XLAL error handler. More...
void	XLALAbortErrorHandler (const char *func, const char *file, int line, int errnum)
	The XLAL error handler that raises SIGABRT. More...
void	XLALExitErrorHandler (const char *func, const char *file, int line, int errnum)
	The XLAL error handler that calls exit. More...
void	XLALBacktraceErrorHandler (const char *func, const char *file, int line, int errnum)
	The XLAL error handler that prints a function call backtrace then raises SIGABRT. More...
XLALErrorHandlerType **	XLALGetErrorHandlerPtr (void)
	Function to return pointer to the XLAL error handler function pointer. More...
XLALErrorHandlerType *	XLALSetErrorHandler (XLALErrorHandlerType *newHandler)
	Sets the error handler to a new handler and returns the old handler. More...
XLALErrorHandlerType *	XLALSetDefaultErrorHandler (void)
	Sets the error handler to the default handler and returns the old handler. More...
XLALErrorHandlerType *	XLALSetSilentErrorHandler (void)
	Sets the error handler to a silent handler and returns the old handler. More...
int	XLALSetErrno (int errnum)
	Sets the XLAL error number to errnum, returns the new value. More...
int	XLALGetBaseErrno (void)
	Gets the XLAL base error number ignoring the internal-function-failed flag. More...
int	XLALClearErrno (void)
	Clears the XLAL error number, returns the old value. More...
int *	XLALGetErrnoPtr (void)
	Function to return pointer to the XLAL error number. More...
void	XLALError (const char *func, const char *file, int line, int errnum)
	Routine to set the XLAL error number and invoke the XLAL error handler. More...

Go to the source code of this file.

Macros
#define	XLAL_PRINT_DEPRECATION_WARNING(replacement)
	Prints a deprecation warning at the "warning" verbosity level. More...
#define	XLAL_PRINT_ERROR(...)    XLALPrintErrorMessage(__func__, __FILE__, __LINE__, __VA_ARGS__)
	Macro that will print an error message with a standard format. More...
#define	XLAL_PRINT_WARNING(...)    XLALPrintWarningMessage(__func__, __FILE__, __LINE__, __VA_ARGS__)
	Macro that will print a warning message with a standard format. More...
#define	XLAL_PRINT_INFO(...)    XLALPrintInfoMessage(__func__, __FILE__, __LINE__, __VA_ARGS__)
	Macro that will print an info message with a standard format. More...
#define	XLAL_REAL4_FAIL_NAN_INT   0x7fc001a1
	Hexadecimal representation of REAL4 NaN failure bit pattern. More...
#define	XLAL_REAL8_FAIL_NAN_INT   LAL_INT8_C(0x7ff80000000001a1)
	Hexadecimal representation of REAL8 NaN failure bit pattern. More...
#define	XLAL_REAL4_FAIL_NAN   ( XLALREAL4FailNaN() )
	Floating-point value of the XLAL REAL4 failure NaN. More...
#define	XLAL_REAL8_FAIL_NAN   ( XLALREAL8FailNaN() )
	Floating-point value of the XLAL REAL8 failure NaN. More...
#define	XLAL_IS_REAL4_FAIL_NAN(val)   XLALIsREAL4FailNaN(val)
	Tests if val is a XLAL REAL4 failure NaN. More...
#define	XLAL_IS_REAL8_FAIL_NAN(val)   XLALIsREAL8FailNaN(val)
	Tests if val is a XLAL REAL8 failure NaN. More...
#define	XLAL_PERROR()   XLALPerror(__func__, __FILE__, __LINE__, xlalErrno)
	Prints an error message for the current value of xlalErrno. More...
#define	xlalErrno   ( * XLALGetErrnoPtr() )
	Modifiable lvalue containing the XLAL error number. More...
#define	XLALErrorHandler   ( * XLALGetErrorHandlerPtr() )
	Modifiable lvalue containing the XLAL error handler. More...
#define	XLAL_TRY(statement, errnum)
	A macro to (i) disable the XLAL error handling and preserve the current value of xlalErrno (ii) perform a statement that involves an XLAL function call and (iii) restore the XLAL error handler and value of xlalErrno while setting variable errnum to the xlalErrno set by the statement. More...
#define	XLAL_TRY_SILENT(statement, errnum)
	Performs the same actions as XLAL_TRY(), but additionally silences any error/warning/etc. More...
#define	XLAL_ERROR_VAL(val, ...)   _XLAL_ERROR_IMPL_(return val, __VA_ARGS__)
	Macro to invoke the XLALError() function and return with code val (it should not really be used itself, but forms the basis for other macros). More...
#define	XLAL_ERROR(...)   _XLAL_ERROR_IMPL_(return (int)XLAL_FAILURE, __VA_ARGS__)
	Macro to invoke a failure from a XLAL routine returning an integer. More...
#define	XLAL_ERROR_NULL(...)   _XLAL_ERROR_IMPL_(return NULL, __VA_ARGS__)
	Macro to invoke a failure from a XLAL routine returning a pointer. More...
#define	XLAL_ERROR_VOID(...)   _XLAL_ERROR_IMPL_(return, __VA_ARGS__)
	Macro to invoke a failure from a XLAL routine returning void. More...
#define	XLAL_ERROR_REAL4(...)   _XLAL_ERROR_IMPL_(return XLAL_REAL4_FAIL_NAN, __VA_ARGS__)
	Macro to invoke a failure from a XLAL routine returning a REAL4. More...
#define	XLAL_ERROR_REAL8(...)   _XLAL_ERROR_IMPL_(return XLAL_REAL8_FAIL_NAN, __VA_ARGS__)
	Macro to invoke a failure from a XLAL routine returning a REAL8. More...
#define	XLAL_ERROR_MAIN(...)   _XLAL_ERROR_IMPL_(return EXIT_FAILURE, __VA_ARGS__)
	Macro to invoke a failure from a C main() routine. More...
#define	XLAL_ERROR_FAIL(...)   _XLAL_ERROR_IMPL_(goto XLAL_FAIL, __VA_ARGS__)
	Macro to invoke a failure by jumping to a XLAL_FAIL label. More...
#define	XLAL_CHECK_VAL(val, assertion, ...)   _XLAL_CHECK_IMPL_(return val, assertion, __VA_ARGS__)
	Macro to test an assertion; if it is not true, invoke the XLALError() function and return with code val (it should not really be used itself, but forms the basis for other macros). More...
#define	XLAL_CHECK(assertion, ...)   _XLAL_CHECK_IMPL_(return (int)XLAL_FAILURE, assertion, __VA_ARGS__)
	Macro to test an assertion and invoke a failure if it is not true in a function that returns an integer. More...
#define	XLAL_CHECK_NULL(assertion, ...)   _XLAL_CHECK_IMPL_(return NULL, assertion, __VA_ARGS__)
	Macro to test an assertion and invoke a failure if it is not true in a function that returns a pointer. More...
#define	XLAL_CHECK_VOID(assertion, ...)   _XLAL_CHECK_IMPL_(return, assertion, __VA_ARGS__)
	Macro to test an assertion and invoke a failure if it is not true in a function that returns void. More...
#define	XLAL_CHECK_REAL4(assertion, ...)   _XLAL_CHECK_IMPL_(return XLAL_REAL4_FAIL_NAN, assertion, __VA_ARGS__)
	Macro to test an assertion and invoke a failure if it is not true in a function that returns a REAL4. More...
#define	XLAL_CHECK_REAL8(assertion, ...)   _XLAL_CHECK_IMPL_(return XLAL_REAL8_FAIL_NAN, assertion, __VA_ARGS__)
	Macro to test an assertion and invoke a failure if it is not true in a function that returns a REAL8. More...
#define	XLAL_CHECK_MAIN(assertion, ...)   _XLAL_CHECK_IMPL_(return EXIT_FAILURE, assertion, __VA_ARGS__)
	Macro to test an assertion and invoke a failure if it is not true in a C main() routine. More...
#define	XLAL_CHECK_FAIL(assertion, ...)   _XLAL_CHECK_IMPL_(goto XLAL_FAIL, assertion, __VA_ARGS__)
	Macro to test an assertion and invoke a failure if it is not true by jumping to a XLAL_FAIL label. More...
#define	XLAL_CHECK_ABORT(assertion)
	Macro to test an assertion and invoke a failure if it is not true by calling lalAbortHook(). More...
#define	XLAL_CHECK_EXIT(assertion)
	Macro to test an assertion and invoke a failure if it is not true by calling exit(1). More...

Typedefs
typedef void	XLALErrorHandlerType(const char *func, const char *file, int line, int errnum)
	The XLAL error handler type. More...

Enumerations
enum	XLALErrorValue {   XLAL_SUCCESS = 0 , XLAL_FAILURE = -1 , XLAL_ENOENT = 2 , XLAL_EIO = 5 ,   XLAL_ENOMEM = 12 , XLAL_EFAULT = 14 , XLAL_EINVAL = 22 , XLAL_EDOM = 33 ,   XLAL_ERANGE = 34 , XLAL_ENOSYS = 38 , XLAL_EFAILED = 128 , XLAL_EBADLEN = 129 ,   XLAL_ESIZE = 130 , XLAL_EDIMS = 131 , XLAL_ETYPE = 132 , XLAL_ETIME = 133 ,   XLAL_EFREQ = 134 , XLAL_EUNIT = 135 , XLAL_ENAME = 136 , XLAL_EDATA = 137 ,   XLAL_EUSR0 = 200 , XLAL_EUSR1 = 201 , XLAL_EUSR2 = 202 , XLAL_EUSR3 = 203 ,   XLAL_EUSR4 = 204 , XLAL_EUSR5 = 205 , XLAL_EUSR6 = 206 , XLAL_EUSR7 = 207 ,   XLAL_EUSR8 = 208 , XLAL_EUSR9 = 209 , XLAL_ESYS = 254 , XLAL_EERR = 255 ,   XLAL_EFPINVAL = 256 , XLAL_EFPDIV0 = 257 , XLAL_EFPOVRFLW = 258 , XLAL_EFPUNDFLW = 259 ,   XLAL_EFPINEXCT = 260 , XLAL_EMAXITER = 261 , XLAL_EDIVERGE = 262 , XLAL_ESING = 263 ,   XLAL_ETOL = 264 , XLAL_ELOSS = 265 , XLAL_EFUNC = 1024 }
	XLAL error numbers and return values. More...