H:/Class/11756/HLab/sphinxbase-0.4/include/err.h File Reference

Implementation of logging routines. More...

#include <stdarg.h>
#include <stdio.h>
#include <errno.h>
#include <sphinxbase_export.h>

Go to the source code of this file.

Defines
#define	E_FATAL   _E__pr_header(__FILE__, __LINE__, "FATAL_ERROR"),_E__die_error
#define	E_FATAL_SYSTEM   _E__pr_header(__FILE__, __LINE__, "SYSTEM_ERROR"),_E__fatal_sys_error
#define	E_WARN_SYSTEM   _E__pr_header(__FILE__, __LINE__, "SYSTEM_ERROR"),_E__sys_error
#define	E_ERROR_SYSTEM   _E__pr_header(__FILE__, __LINE__, "SYSTEM_ERROR"),_E__sys_error
#define	E_INFO   _E__pr_info_header(__FILE__, __LINE__, "INFO"),_E__pr_info
#define	E_INFOCONT   _E__pr_info
#define	E_INFO_NOFN   _E__pr_info_header_wofn("INFO"),_E__pr_info
#define	E_WARN   _E__pr_header(__FILE__, __LINE__, "WARNING"),_E__pr_warn
#define	E_ERROR   _E__pr_header(__FILE__, __LINE__, "ERROR"),_E__pr_warn
Functions
SPHINXBASE_EXPORT void	_E__pr_header (char const *file, long line, char const *msg)
SPHINXBASE_EXPORT void	_E__pr_info_header (char const *file, long line, char const *tag)
SPHINXBASE_EXPORT void	_E__pr_info_header_wofn (char const *msg)
SPHINXBASE_EXPORT void	_E__pr_warn (char const *fmt,...)
SPHINXBASE_EXPORT void	_E__pr_info (char const *fmt,...)
SPHINXBASE_EXPORT void	_E__die_error (char const *fmt,...)
SPHINXBASE_EXPORT void	_E__abort_error (char const *fmt,...)
SPHINXBASE_EXPORT void	_E__sys_error (char const *fmt,...)
SPHINXBASE_EXPORT void	_E__fatal_sys_error (char const *fmt,...)
SPHINXBASE_EXPORT FILE *	err_set_logfp (FILE *logfp)
SPHINXBASE_EXPORT FILE *	err_get_logfp (void)
SPHINXBASE_EXPORT int	err_set_logfile (char const *file)

---

Detailed Description

Implementation of logging routines.

Logging, warning and error message output funtionality is provided in this file.

---

Define Documentation

#define E_ERROR   _E__pr_header(__FILE__, __LINE__, "ERROR"),_E__pr_warn

Print error message to standard error stream

#define E_ERROR_SYSTEM   _E__pr_header(__FILE__, __LINE__, "SYSTEM_ERROR"),_E__sys_error

Print error text; Call perror("");

#define E_FATAL   _E__pr_header(__FILE__, __LINE__, "FATAL_ERROR"),_E__die_error

Exit with non-zero status after error message

#define E_FATAL_SYSTEM   _E__pr_header(__FILE__, __LINE__, "SYSTEM_ERROR"),_E__fatal_sys_error

Print error text; Call perror(""); exit(errno);

#define E_INFO   _E__pr_info_header(__FILE__, __LINE__, "INFO"),_E__pr_info

Print logging information to standard error stream

#define E_INFO_NOFN   _E__pr_info_header_wofn("INFO"),_E__pr_info

Print logging information without filename.

#define E_INFOCONT   _E__pr_info

Print logging information without header, to standard error stream

#define E_WARN   _E__pr_header(__FILE__, __LINE__, "WARNING"),_E__pr_warn

Print warning information to standard error stream

#define E_WARN_SYSTEM   _E__pr_header(__FILE__, __LINE__, "SYSTEM_ERROR"),_E__sys_error

Print error text; Call perror("");

---

Function Documentation

SPHINXBASE_EXPORT void _E__abort_error	(	char const *	fmt,
			...
	)

SPHINXBASE_EXPORT void _E__die_error	(	char const *	fmt,
			...
	)

SPHINXBASE_EXPORT void _E__fatal_sys_error	(	char const *	fmt,
			...
	)

SPHINXBASE_EXPORT void _E__pr_header	(	char const *	file,
		long	line,
		char const *	msg
	)

SPHINXBASE_EXPORT void _E__pr_info	(	char const *	fmt,
			...
	)

SPHINXBASE_EXPORT void _E__pr_info_header	(	char const *	file,
		long	line,
		char const *	tag
	)

SPHINXBASE_EXPORT void _E__pr_info_header_wofn

(

char const *

msg

)

SPHINXBASE_EXPORT void _E__pr_warn	(	char const *	fmt,
			...
	)

SPHINXBASE_EXPORT void _E__sys_error	(	char const *	fmt,
			...
	)

SPHINXBASE_EXPORT FILE* err_get_logfp

(

void

)

Get the current logging filehandle.

Returns:

Current logging filehandle, NULL if disabled.

SPHINXBASE_EXPORT int err_set_logfile

(

char const *

file

)

Append all log messages to a given file.

Previous logging filehandle is closed (unless it was stdout or stderr).

Parameters:

logfp

File to send log messages to, or NULL to disable logging.

Returns:

0 for success, <0 for failure (e.g. if file does not exist)

SPHINXBASE_EXPORT FILE* err_set_logfp

(

FILE *

logfp

)

Direct all logging to a given filehandle.

Parameters:

logfp

Filehandle to send log messages to, or NULL to disable logging.

Returns:

Previous logging filehandle, if any.