Declarations of an Error and associated functions. More...

#include <jwsc/config.h>
#include <stdlib.h>
#include <inttypes.h>

Include dependency graph for error.h:

Data Structures
struct	Error
	Error structure used for error handling. More...
Defines
#define	JWSC_EARG(msg) create_error(ERROR_INV_ARG, __FILE__, __LINE__, msg)
	Creates a new error caused by invalid argument.
#define	JWSC_EIO(msg) create_error(ERROR_IO, __FILE__, __LINE__, msg)
	Creates a new error caused by invalid I/O.
#define	JWSC_ECALC(msg) create_error(ERROR_CALC, __FILE__, __LINE__, msg)
	Creates a new error caused by a calculation.
Enumerations
enum	Error_type { ERROR_NO_MEMORY, ERROR_IO, ERROR_INV_ARG, ERROR_CALC, ERROR_NOT_READY, ERROR_SOCKET, ERROR_CONNECT }
	Error types. More...
Functions
Error *	create_error (Error_type type, const char file, unsigned int line, const char msg)
	Creates a new Error.
void	free_error (Error *e)
	Frees an Error.
void	print_error (const char prefix, const Error e)
	Prints an Error on stderr.
void	print_error_exit (const char prefix, const Error e)
	Prints an Error on stderr and exits.
void	print_error_msg (const char prefix, const char msg)
	Prints an error message on stderr.
void	print_error_msg_exit (const char prefix, const char msg)
	Prints an error message on stderr and exits.
void	print_errno (const char *prefix)
	Prints the error message associated with the current value of errno on stderr.
void	print_errno_exit (const char *prefix)
	Prints the error message associated with the current value of errno on stderr and exits.
uint32_t	get_num_unhandled_errors ()
	Returns the number of errors created and never handled (freed).
Variables
Error *	error_no_memory
	Special Error for memory allocation errors.

Detailed Description

Declarations of an Error and associated functions.

Author:: Joseph Schlecht

License:: Creative Commons BY-NC-SA 3.0

Definition in file error.h.

Define Documentation

#define JWSC_EARG ( msg ) create_error(ERROR_INV_ARG, __FILE__, __LINE__, msg)

Creates a new error caused by invalid argument.

Macro shortcut to include file name and line number when creating an error.

Parameters:

msg	Error message.

Returns:: The error.

Definition at line 162 of file error.h.

#define JWSC_EIO ( msg ) create_error(ERROR_IO, __FILE__, __LINE__, msg)

Creates a new error caused by invalid I/O.

Macro shortcut to include file name and line number when creating an error.

Parameters:

msg	Error message.

Returns:: The error.

Definition at line 174 of file error.h.

#define JWSC_ECALC ( msg ) create_error(ERROR_CALC, __FILE__, __LINE__, msg)

Creates a new error caused by a calculation.

Macro shortcut to include file name and line number when creating an error.

Parameters:

msg	Error message.

Returns:: The error.

Definition at line 186 of file error.h.

Enumeration Type Documentation

enum Error_type

Error types.

Enumerator:

ERROR_NO_MEMORY	No memory available.
ERROR_IO	Input/output problem.
ERROR_INV_ARG	Argument is not in valid range.
ERROR_CALC	Calculated value outside error tolerance.
ERROR_NOT_READY	Non-blocking Result is not yet ready.
ERROR_SOCKET	Error creating a socket.
ERROR_CONNECT	Error connecting a socket.

Definition at line 63 of file error.h.

Function Documentation

Error* create_error	(	Error_type	type,
		const char *	file,
		unsigned int	line,
		const char *	msg
	)

Creates a new Error.

Any and all of the const char* parameters can be NULL. If non-NULL, a copy of the the const char* parameters is allocated. The Error::code is set to 0.

Parameters:

type	Error_type.
file	File where the Error occurred.
line	Line near the offending code.
msg	Message for the Error.

Returns:: An Error is always returned. If the Error could not be created because of memory exhaustion, error_no_memory is returned.

Definition at line 97 of file error.c.

void free_error ( Error * e )

Frees an Error.

Parameters:

e	Error to free.

Definition at line 151 of file error.c.

void print_error	(	const char *	prefix,
		const Error *	e
	)

Prints an Error on stderr.

Prints all the non-NULL fields of the Error in the format

 'prefix: file: line: msg\n'

If prefix == NULL, just the error message is printed. The Error e must not be NULL.

Parameters:

prefix	Prefix to print before the error message.
e	Error to print.

Definition at line 181 of file error.c.

void print_error_exit	(	const char *	prefix,
		const Error *	e
	)

Prints an Error on stderr and exits.

Definition at line 229 of file error.c.

void print_error_msg	(	const char *	prefix,
		const char *	msg
	)

Prints an error message on stderr.

Prints the Error in the format

 'prefix: msg\n'

If prefix == NULL, just the error message is printed. If msg is NULL, no new-line is printed. This is useful for printing multi-prefixed error messages.

Parameters:

prefix	Prefix to print before the error message.
msg	Error message to print.

Definition at line 248 of file error.c.

void print_error_msg_exit	(	const char *	prefix,
		const char *	msg
	)

Prints an error message on stderr and exits.

Prints the Error in the format

 'prefix: msg\n'

If prefix == NULL, just the error message is printed. If msg is NULL, no new-line is printed. This is useful for printing multi-prefixed error messages.

The exit status is EXIT_FAILURE.

Parameters:

prefix	Prefix to print before the error message.
msg	Error message to print.

Definition at line 276 of file error.c.

void print_errno ( const char * prefix )

Prints the error message associated with the current value of errno on stderr.

Prints the Error in the format

 'prefix: errno_msg\n'

The standard function strerror is used to get the message for errno.

If prefix == NULL, just the error message is printed.

Parameters:

prefix Prefix to print before the error message.

Definition at line 294 of file error.c.

void print_errno_exit ( const char * prefix )

Prints the error message associated with the current value of errno on stderr and exits.

Prints the Error in the format

 'prefix: errno_msg\n'

The standard function strerror is used to get the message for errno.

If prefix == NULL, just the error message is printed.

The exit status is EXIT_FAILURE.

Parameters:

prefix Prefix to print before the error message.

Definition at line 318 of file error.c.

uint32_t get_num_unhandled_errors ( )

Returns the number of errors created and never handled (freed).

Returns:: The number of errors created and never handled (freed).

Definition at line 326 of file error.c.

Variable Documentation

Error* error_no_memory

Special Error for memory allocation errors.

This is a very special Error: it is static and must never be freed.

Global pointer to the static Error no_memory.

Definition at line 81 of file error.c.

Data Structures

Defines

Enumerations

Functions

Variables

Detailed Description

Define Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation