err.h File Reference

Header file. More...

#include <stdarg.h>

Include dependency graph for err.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	vwarn (const char *, va_list)
	Prints a formatted warning message to stderr. More...
void	vewarn (const char *, va_list)
	Prints a formatted error message to stderr. More...
void	verr (const char *, va_list)
	Prints a formatted error message to stderr and exits. More...
void	verrc (const int, const char *, va_list)
	Prints a formatted error message to stderr and exits with the given exit code. More...
void	warn (const char *,...)
	Prints a formatted warning message to stderr. More...
void	ewarn (const char *,...)
	Prints a formatted error message to stderr. More...
void	err (const char *,...)
	Prints a formatted error message to stderr and exits. More...
void	errc (const int, const char *,...)
	Prints a formatted error message to stderr and exits with the given exit code. More...

Variables
char *	program_invocation_name
	Global value for the program's name. More...

Detailed Description

Header file.

Version

2.0.0

#include this to use err in your project.

Definition in file err.h.

Function Documentation

err()

void err	(	const char *	fmt,
			...
	)

Prints a formatted error message to stderr and exits.

Precondition

program_invocation_name is set

Parameters

fmt	format string
...	arguments for the format string

Variadic wrapper for verr().

Definition at line 123 of file err.c.

{
        va_list ap;
 
        va_start(ap, fmt);
        verr(fmt, ap);
        va_end(ap);
}

Here is the call graph for this function:

errc()

void errc	(	const int	code,
		const char *	fmt,
			...
	)

Prints a formatted error message to stderr and exits with the given exit code.

Precondition

program_invocation_name is set

Parameters

code	exit code
fmt	format string
...	arguments for the format string

Variadic wrapper for verrc().

Definition at line 110 of file err.c.

{
        va_list ap;
 
        va_start(ap, fmt);
        verrc(code, fmt, ap);
        va_end(ap);
}

Here is the call graph for this function:

ewarn()

void ewarn	(	const char *	fmt,
			...
	)

Prints a formatted error message to stderr.

Precondition

program_invocation_name is set

Parameters

fmt	format string
...	arguments for the format string

Variadic wrapper for vewarn().

Definition at line 97 of file err.c.

{
        va_list ap;
 
        va_start(ap, fmt);
        vewarn(fmt, ap);
        va_end(ap);
}

Here is the call graph for this function:

verr()

void verr	(	const char *	fmt,
		va_list	ap
	)

Prints a formatted error message to stderr and exits.

Precondition

program_invocation_name is set

Parameters

fmt	format string
ap	va_list of arguments for the format string

Calls verrc() with EXIT_FAILURE.

Definition at line 75 of file err.c.

{
        verrc(EXIT_FAILURE, fmt, ap);
}

Here is the call graph for this function:

Here is the caller graph for this function:

verrc()

void verrc	(	const int	code,
		const char *	fmt,
		va_list	ap
	)

Prints a formatted error message to stderr and exits with the given exit code.

Precondition

program_invocation_name is set

Parameters

code	exit code
fmt	format string
ap	va_list of arguments for the format string

Calls vewarn() and exits the program with the provided code.

Definition at line 64 of file err.c.

{
        vewarn(fmt, ap);
 
        exit(code);
}

Here is the call graph for this function:

Here is the caller graph for this function:

vewarn()

void vewarn	(	const char *	fmt,
		va_list	ap
	)

Prints a formatted error message to stderr.

Precondition

program_invocation_name is set

Parameters

fmt	format string
ap	va_list of arguments for the format string

Calls vwarn(), then prints ": ", strerror(errno), and a newline.

Definition at line 46 of file err.c.

{
        vwarn(fmt, ap);
        if (errno != 0) {
                /* To avoid two colons being printed, like
                 * "program_invocation_name: : No such file or directory" */
                if (fmt != NULL && fmt[0] != '\0') {
                        fputs(": ", stderr);
                }
                fprintf(stderr, "%s", strerror(errno));
        }
        fputc('\n', stderr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

vwarn()

void vwarn	(	const char *	fmt,
		va_list	ap
	)

Prints a formatted warning message to stderr.

Precondition

program_invocation_name is set

Parameters

fmt	format string
ap	va_list of arguments for the format string

Prints program_invocation_name, ": ", and the printf(3)-like-formatted error message.

Definition at line 36 of file err.c.

{
        fprintf(stderr, "%s: ", program_invocation_name);
        vfprintf(stderr, fmt, ap);
}

Here is the caller graph for this function:

warn()

void warn	(	const char *	fmt,
			...
	)

Prints a formatted warning message to stderr.

Precondition

program_invocation_name is set

Parameters

fmt	format string
...	arguments for the format string

Variadic wrapper for vwarn().

Definition at line 84 of file err.c.

{
        va_list ap;
 
        va_start(ap, fmt);
        vwarn(fmt, ap);
        va_end(ap);
}

Here is the call graph for this function:

Variable Documentation

program_invocation_name

char* program_invocation_name

extern

Global value for the program's name.

This must be set before any err functions are called.

Definition at line 29 of file err.c.