Defines | Typedefs | Enumerations | Functions

cpl_error.h File Reference

CPL error handling services. More...

#include "cpl_port.h"

Go to the source code of this file.

Defines

#define CPLAssert(expr)
#define VALIDATE_POINTER_ERR   CE_Failure
#define VALIDATE_POINTER0(ptr, func)
#define VALIDATE_POINTER1(ptr, func, rc)
#define CPLE_None   0
#define CPLE_AppDefined   1
#define CPLE_OutOfMemory   2
#define CPLE_FileIO   3
#define CPLE_OpenFailed   4
#define CPLE_IllegalArg   5
#define CPLE_NotSupported   6
#define CPLE_AssertionFailed   7
#define CPLE_NoWriteAccess   8
#define CPLE_UserInterrupt   9
#define CPLE_ObjectNull   10

Typedefs

typedef void(* CPLErrorHandler )(CPLErr, int, const char *)

Enumerations

enum  CPLErr {
  CE_None = 0, CE_Debug = 1, CE_Warning = 2, CE_Failure = 3,
  CE_Fatal = 4
}

Functions

void CPLError (CPLErr eErrClass, int err_no, const char *fmt,...)
 Report an error.
void CPLErrorV (CPLErr, int, const char *, va_list)
void CPLEmergencyError (const char *)
 Fatal error when things are bad.
void CPLErrorReset (void)
 Erase any traces of previous errors.
int CPLGetLastErrorNo (void)
 Fetch the last error number.
CPLErr CPLGetLastErrorType (void)
 Fetch the last error type.
const char * CPLGetLastErrorMsg (void)
 Get the last error message.
void * CPLGetErrorHandlerUserData (void)
 Fetch the user data for the error context.
void CPLErrorSetState (CPLErr eErrClass, int err_no, const char *pszMsg)
 Restore an error state, without emitting an error.
void CPLCleanupErrorMutex (void)
void CPLLoggingErrorHandler (CPLErr, int, const char *)
void CPLDefaultErrorHandler (CPLErr, int, const char *)
void CPLQuietErrorHandler (CPLErr, int, const char *)
void CPLTurnFailureIntoWarning (int bOn)
CPLErrorHandler CPLSetErrorHandler (CPLErrorHandler)
 Install custom error handler.
CPLErrorHandler CPLSetErrorHandlerEx (CPLErrorHandler, void *)
 Install custom error handle with user's data.
void CPLPushErrorHandler (CPLErrorHandler)
 Push a new CPLError handler.
void CPLPushErrorHandlerEx (CPLErrorHandler, void *)
 Push a new CPLError handler with user data on the error context.
void CPLPopErrorHandler (void)
 Pop error handler off stack.
void CPLDebug (const char *, const char *,...)
 Display a debugging message.
void _CPLAssert (const char *, const char *, int)
 Report failure of a logical assertion.

Detailed Description

CPL error handling services.


Define Documentation

#define VALIDATE_POINTER0 (   ptr,
  func 
)
Value:
do { if( NULL == ptr ) \
      { \
        CPLErr const ret = VALIDATE_POINTER_ERR; \
        CPLError( ret, CPLE_ObjectNull, \
           "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
         return; }} while(0)
#define VALIDATE_POINTER1 (   ptr,
  func,
  rc 
)
Value:
do { if( NULL == ptr ) \
      { \
          CPLErr const ret = VALIDATE_POINTER_ERR; \
          CPLError( ret, CPLE_ObjectNull, \
           "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
        return (rc); }} while(0)

Function Documentation

void _CPLAssert ( const char *  pszExpression,
const char *  pszFile,
int  iLine 
)

Report failure of a logical assertion.

Applications would normally use the CPLAssert() macro which expands into code calling _CPLAssert() only if the condition fails. _CPLAssert() will generate a CE_Fatal error call to CPLError(), indicating the file name, and line number of the failed assertion, as well as containing the assertion itself.

There is no reason for application code to call _CPLAssert() directly.

void CPLDebug ( const char *  pszCategory,
const char *  pszFormat,
  ... 
)

Display a debugging message.

The category argument is used in conjunction with the CPL_DEBUG environment variable to establish if the message should be displayed. If the CPL_DEBUG environment variable is not set, no debug messages are emitted (use CPLError(CE_Warning,...) to ensure messages are displayed). If CPL_DEBUG is set, but is an empty string or the word "ON" then all debug messages are shown. Otherwise only messages whose category appears somewhere within the CPL_DEBUG value are displayed (as determinted by strstr()).

Categories are usually an identifier for the subsystem producing the error. For instance "GDAL" might be used for the GDAL core, and "TIFF" for messages from the TIFF translator.

Parameters:
pszCategory name of the debugging message category.
pszFormat printf() style format string for message to display. Remaining arguments are assumed to be for format.
void CPLEmergencyError ( const char *  pszMessage  ) 

Fatal error when things are bad.

This function should be called in an emergency situation where it is unlikely that a regular error report would work. This would include in the case of heap exhaustion for even small allocations, or any failure in the process of reporting an error (such as TLS allocations).

This function should never return. After the error message has been reported as best possible, the application will abort() similarly to how CPLError() aborts on CE_Fatal class errors.

Parameters:
pszMessage the error message to report.
void CPLError ( CPLErr  eErrClass,
int  err_no,
const char *  fmt,
  ... 
)

Report an error.

This function reports an error in a manner that can be hooked and reported appropriate by different applications.

The effect of this function can be altered by applications by installing a custom error handling using CPLSetErrorHandler().

The eErrClass argument can have the value CE_Warning indicating that the message is an informational warning, CE_Failure indicating that the action failed, but that normal recover mechanisms will be used or CE_Fatal meaning that a fatal error has occured, and that CPLError() should not return.

The default behaviour of CPLError() is to report errors to stderr, and to abort() after reporting a CE_Fatal error. It is expected that some applications will want to supress error reporting, and will want to install a C++ exception, or longjmp() approach to no local fatal error recovery.

Regardless of how application error handlers or the default error handler choose to handle an error, the error number, and message will be stored for recovery with CPLGetLastErrorNo() and CPLGetLastErrorMsg().

Parameters:
eErrClass one of CE_Warning, CE_Failure or CE_Fatal.
err_no the error number (CPLE_*) from cpl_error.h.
fmt a printf() style format string. Any additional arguments will be treated as arguments to fill in this format in a manner similar to printf().
void CPLErrorReset ( void   ) 

Erase any traces of previous errors.

This is normally used to ensure that an error which has been recovered from does not appear to be still in play with high level functions.

void CPLErrorSetState ( CPLErr  eErrClass,
int  err_no,
const char *  pszMsg 
)

Restore an error state, without emitting an error.

Can be usefull if a routine might call CPLErrorReset() and one wants to preserve the previous error state.

Since:
GDAL 2.0
void* CPLGetErrorHandlerUserData ( void   ) 

Fetch the user data for the error context.

Fetches the user data for the current error context. You can set the user data for the error context when you add your handler by issuing CPLSetErrorHandlerEx() and CPLPushErrorHandlerEx(). Note that user data is primarily intended for providing context within error handlers themselves, but they could potentially be abused in other useful ways with the usual caveat emptor understanding.

Returns:
the user data pointer for the error context
const char* CPLGetLastErrorMsg ( void   ) 

Get the last error message.

Fetches the last error message posted with CPLError(), that hasn't been cleared by CPLErrorReset(). The returned pointer is to an internal string that should not be altered or freed.

Returns:
the last error message, or NULL if there is no posted error message.
int CPLGetLastErrorNo ( void   ) 

Fetch the last error number.

Fetches the last error number posted with CPLError(), that hasn't been cleared by CPLErrorReset(). This is the error number, not the error class.

Returns:
the error number of the last error to occur, or CPLE_None (0) if there are no posted errors.
CPLErr CPLGetLastErrorType ( void   ) 

Fetch the last error type.

Fetches the last error type posted with CPLError(), that hasn't been cleared by CPLErrorReset(). This is the error class, not the error number.

Returns:
the error type of the last error to occur, or CE_None (0) if there are no posted errors.
void CPLPopErrorHandler ( void   ) 

Pop error handler off stack.

Discards the current error handler on the error handler stack, and restores the one in use before the last CPLPushErrorHandler() call. This method has no effect if there are no error handlers on the current threads error handler stack.

void CPLPushErrorHandler ( CPLErrorHandler  pfnErrorHandlerNew  ) 

Push a new CPLError handler.

This pushes a new error handler on the thread-local error handler stack. This handler will be used until removed with CPLPopErrorHandler().

The CPLSetErrorHandler() docs have further information on how CPLError handlers work.

Parameters:
pfnErrorHandlerNew new error handler function.
void CPLPushErrorHandlerEx ( CPLErrorHandler  pfnErrorHandlerNew,
void *  pUserData 
)

Push a new CPLError handler with user data on the error context.

This pushes a new error handler on the thread-local error handler stack. This handler will be used until removed with CPLPopErrorHandler(). Obtain the user data back by using CPLGetErrorContext().

The CPLSetErrorHandler() docs have further information on how CPLError handlers work.

Parameters:
pfnErrorHandlerNew new error handler function.
pUserData User data to put on the error context.
CPLErrorHandler CPLSetErrorHandler ( CPLErrorHandler  pfnErrorHandlerNew  ) 

Install custom error handler.

Allow the library's user to specify his own error handler function. A valid error handler is a C function with the following prototype:

     void MyErrorHandler(CPLErr eErrClass, int err_no, const char *msg)
 

Pass NULL to come back to the default behavior. The default behaviour (CPLDefaultErrorHandler()) is to write the message to stderr.

The msg will be a partially formatted error message not containing the "ERROR %d:" portion emitted by the default handler. Message formatting is handled by CPLError() before calling the handler. If the error handler function is passed a CE_Fatal class error and returns, then CPLError() will call abort(). Applications wanting to interrupt this fatal behaviour will have to use longjmp(), or a C++ exception to indirectly exit the function.

Another standard error handler is CPLQuietErrorHandler() which doesn't make any attempt to report the passed error or warning messages but will process debug messages via CPLDefaultErrorHandler.

Note that error handlers set with CPLSetErrorHandler() apply to all threads in an application, while error handlers set with CPLPushErrorHandler are thread-local. However, any error handlers pushed with CPLPushErrorHandler (and not removed with CPLPopErrorHandler) take precidence over the global error handlers set with CPLSetErrorHandler(). Generally speaking CPLSetErrorHandler() would be used to set a desired global error handler, while CPLPushErrorHandler() would be used to install a temporary local error handler, such as CPLQuietErrorHandler() to suppress error reporting in a limited segment of code.

Parameters:
pfnErrorHandlerNew new error handler function.
Returns:
returns the previously installed error handler.
CPLErrorHandler CPLSetErrorHandlerEx ( CPLErrorHandler  pfnErrorHandlerNew,
void *  pUserData 
)

Install custom error handle with user's data.

This method is essentially CPLSetErrorHandler with an added pointer to pUserData. The pUserData is not returned in the CPLErrorHandler, however, and must be fetched via CPLGetLastErrorUserData

Parameters:
pfnErrorHandlerNew new error handler function.
pUserData User data to carry along with the error context.
Returns:
returns the previously installed error handler.

Generated for GDAL by doxygen 1.7.1.