svn_error.h File Reference

Common exception handling for Subversion. More...

#include <apr.h>
#include <apr_errno.h>
#include <apr_pools.h>
#include <apr_want.h>
#include "svn_types.h"
#include "svn_error_codes.h"

Go to the source code of this file.

Defines

#define SVN_NO_ERROR 0

the best kind of (svn_error_t *) !

Typedefs

typedef svn_error_t *(* svn_error_malfunction_handler_t )(const char *file, int line, const char *expr)

A type of function that handles an assertion failure or other internal malfunction detected within the Subversion libraries.

Functions

void svn_error__locate (const char *file, long line)

Set the error location for debug mode.

char * svn_strerror (apr_status_t statcode, char *buf, apr_size_t bufsize)

Put an English description of statcode into buf and return buf, NULL-terminated.

const char * svn_err_best_message (svn_error_t *err, char *buf, apr_size_t bufsize)

If err has a custom error message, return that, otherwise store the generic error string associated with err->apr_err into buf (terminating with NULL) and return buf.

svn_error_t * svn_error_create (apr_status_t apr_err, svn_error_t *child, const char *message)

Create a nested exception structure.

svn_error_t * svn_error_createf (apr_status_t apr_err, svn_error_t *child, const char *fmt,...) __attribute__((format(printf

Create an error structure with the given apr_err and child, with a printf-style error message produced by passing fmt, using apr_psprintf().

svn_error_t * svn_error_wrap_apr (apr_status_t status, const char *fmt,...) __attribute__((format(printf

Wrap a status from an APR function.

svn_error_t * svn_error_quick_wrap (svn_error_t *child, const char *new_msg)

A quick n' easy way to create a wrapped exception with your own message, before throwing it up the stack.

void svn_error_compose (svn_error_t *chain, svn_error_t *new_err)

Add new_err to the end of chain's chain of errors.

svn_error_t * svn_error_root_cause (svn_error_t *err)

Return the root cause of err by finding the last error in its chain (e.g.

svn_error_t * svn_error_dup (svn_error_t *err)

Create a new error that is a deep copy of err and return it.

void svn_error_clear (svn_error_t *error)

Free the memory used by error, as well as all ancestors and descendants of error.

void svn_handle_error2 (svn_error_t *error, FILE *stream, svn_boolean_t fatal, const char *prefix)

Very basic default error handler: print out error stack error to the stdio stream stream, with each error prefixed by prefix; quit and clear error iff the fatal flag is set.

SVN_DEPRECATED void svn_handle_error (svn_error_t *error, FILE *stream, svn_boolean_t fatal)

Like svn_handle_error2() but with prefix set to "svn: ".

void svn_handle_warning2 (FILE *stream, svn_error_t *error, const char *prefix)

Very basic default warning handler: print out the error error to the stdio stream stream, prefixed by prefix.

SVN_DEPRECATED void svn_handle_warning (FILE *stream, svn_error_t *error)

Like svn_handle_warning2() but with prefix set to "svn: ".

svn_error_t * svn_error__malfunction (const char *file, int line, const char *expr)

A helper function for the macros that report malfunctions.

svn_error_malfunction_handler_t svn_error_set_malfunction_handler (svn_error_malfunction_handler_t func)

Cause subsequent malfunctions to be handled by func.

svn_error_t * svn_error_raise_on_malfunction (const char *file, int line, const char *expr)

Handle a malfunction by returning an error object that describes it.

svn_error_t * svn_error_abort_on_malfunction (const char *file, int line, const char *expr)

Handle a malfunction by printing a message to stderr and aborting.

Detailed Description

Common exception handling for Subversion.

Definition in file svn_error.h.

Typedef Documentation

typedef svn_error_t*(* svn_error_malfunction_handler_t)(const char *file, int line, const char *expr)

A type of function that handles an assertion failure or other internal malfunction detected within the Subversion libraries.
The error occurred in the source file file at line line, and was an assertion failure of the expression expr, or, if expr is null, an unconditional error.
A function of this type must do one of:

Return an error object describing the error, using an error code in the category SVN_ERR_MALFUNC_CATEGORY_START.
Never return.

The function may alter its behaviour according to compile-time and run-time and even interactive conditions.

Since:
New in 1.6.

Definition at line 406 of file svn_error.h.

Function Documentation

const char* svn_err_best_message ( svn_error_t * err,

char * buf,

apr_size_t bufsize

)

If err has a custom error message, return that, otherwise store the generic error string associated with err->apr_err into buf (terminating with NULL) and return buf.

Since:
New in 1.4.

Note:
buf and bufsize are provided in the interface so that this function is thread-safe and yet does no allocation.

svn_error_t* svn_error__malfunction ( const char * file,

int line,

const char * expr

)

A helper function for the macros that report malfunctions.
Handle a malfunction by calling the current "malfunction handler" which may have been specified by a call to svn_error_set_malfunction_handler() or else is the default handler as specified in that function's documentation.
Pass all of the parameters to the handler. The error occurred in the source file file at line line, and was an assertion failure of the expression expr, or, if expr is null, an unconditional error.
If the malfunction handler returns, then return the error object that it generated.

Since:
New in 1.6.

svn_error_t* svn_error_abort_on_malfunction ( const char * file,

int line,

const char * expr

)

Handle a malfunction by printing a message to stderr and aborting.
This function implements svn_error_malfunction_handler_t.

Since:
New in 1.6.

svn_error_t* svn_error_raise_on_malfunction ( const char * file,

int line,

const char * expr

)

Handle a malfunction by returning an error object that describes it.
This function implements svn_error_malfunction_handler_t.

Since:
New in 1.6.

svn_error_malfunction_handler_t svn_error_set_malfunction_handler ( svn_error_malfunction_handler_t func )

Cause subsequent malfunctions to be handled by func.
Return the handler that was previously in effect.
func may not be null.

Note:
The default handler is svn_error_abort_on_malfunction().
This function must be called in a single-threaded context.

Since:
New in 1.6.

char* svn_strerror ( apr_status_t statcode,

char * buf,

apr_size_t bufsize

)

Put an English description of statcode into buf and return buf, NULL-terminated.
statcode is either an svn error or apr error.

Generated on Tue Oct 7 04:09:55 2008 for Subversion by

1.3.9.1


Defines
#define	SVN_NO_ERROR 0
	the best kind of (`svn_error_t` *) !
Typedefs
typedef svn_error_t (	svn_error_malfunction_handler_t )(const char file, int line, const char expr)
	A type of function that handles an assertion failure or other internal malfunction detected within the Subversion libraries.
Functions
void	svn_error__locate (const char *file, long line)
	Set the error location for debug mode.
char *	svn_strerror (apr_status_t statcode, char *buf, apr_size_t bufsize)
	Put an English description of statcode into buf and return buf, NULL-terminated.
const char *	svn_err_best_message (svn_error_t err, char buf, apr_size_t bufsize)
	If err has a custom error message, return that, otherwise store the generic error string associated with err->apr_err into buf (terminating with NULL) and return buf.
svn_error_t *	svn_error_create (apr_status_t apr_err, svn_error_t child, const char message)
	Create a nested exception structure.
svn_error_t *	svn_error_createf (apr_status_t apr_err, svn_error_t child, const char fmt,...) __attribute__((format(printf
	Create an error structure with the given apr_err and child, with a printf-style error message produced by passing fmt, using apr_psprintf().
svn_error_t *	svn_error_wrap_apr (apr_status_t status, const char *fmt,...) __attribute__((format(printf
	Wrap a status from an APR function.
svn_error_t *	svn_error_quick_wrap (svn_error_t child, const char new_msg)
	A quick n' easy way to create a wrapped exception with your own message, before throwing it up the stack.
void	svn_error_compose (svn_error_t chain, svn_error_t new_err)
	Add new_err to the end of chain's chain of errors.
svn_error_t *	svn_error_root_cause (svn_error_t *err)
	Return the root cause of err by finding the last error in its chain (e.g.
svn_error_t *	svn_error_dup (svn_error_t *err)
	Create a new error that is a deep copy of err and return it.
void	svn_error_clear (svn_error_t *error)
	Free the memory used by error, as well as all ancestors and descendants of error.
void	svn_handle_error2 (svn_error_t error, FILE stream, svn_boolean_t fatal, const char *prefix)
	Very basic default error handler: print out error stack error to the stdio stream stream, with each error prefixed by prefix; quit and clear error iff the fatal flag is set.
SVN_DEPRECATED void	svn_handle_error (svn_error_t error, FILE stream, svn_boolean_t fatal)
	Like svn_handle_error2() but with `prefix` set to "svn: ".
void	svn_handle_warning2 (FILE stream, svn_error_t error, const char *prefix)
	Very basic default warning handler: print out the error error to the stdio stream stream, prefixed by prefix.
SVN_DEPRECATED void	svn_handle_warning (FILE stream, svn_error_t error)
	Like svn_handle_warning2() but with `prefix` set to "svn: ".
svn_error_t *	svn_error__malfunction (const char file, int line, const char expr)
	A helper function for the macros that report malfunctions.
svn_error_malfunction_handler_t	svn_error_set_malfunction_handler (svn_error_malfunction_handler_t func)
	Cause subsequent malfunctions to be handled by func.
svn_error_t *	svn_error_raise_on_malfunction (const char file, int line, const char expr)
	Handle a malfunction by returning an error object that describes it.
svn_error_t *	svn_error_abort_on_malfunction (const char file, int line, const char expr)
	Handle a malfunction by printing a message to stderr and aborting.