/*

* logging.h - Centralised logging. Originated from the Linux-NTFS project.

*
* Copyright (c) 2005
Richard Russon
* Copyright (c) 2007-2008 Szabolcs Szakacsits
*
* This program/include file is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as published
* by the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program/include file is distributed in the hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program (in the main directory of the NTFS-3G
* distribution in the file COPYING); if not, write to the Free Software
* Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef _LOGGING_H_
#define _LOGGING_H_
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#ifdef HAVE_STDARG_H
#include <stdarg.h>
#endif
#include "types.h"
/* Function prototype for the logging handlers */
typedef int (ntfs_log_handler)(const char *function, const char *file, int line,
u32 level, void *data, const char *format, va_list args);
/* Set the logging handler from one of the functions, below. */
void ntfs_log_set_handler(ntfs_log_handler *handler
__attribute__((format(printf, 6, 0))));
/* Logging handlers */
ntfs_log_handler ntfs_log_handler_syslog
ntfs_log_handler ntfs_log_handler_fprintf
ntfs_log_handler ntfs_log_handler_null
ntfs_log_handler ntfs_log_handler_stdout
ntfs_log_handler ntfs_log_handler_outerr
ntfs_log_handler ntfs_log_handler_stderr
/* Enable/disable certain log levels */
u32 ntfs_log_set_levels(u32 levels);
u32 ntfs_log_clear_levels(u32 levels);
u32 ntfs_log_get_levels(void);
/* Enable/disable certain log flags */
u32 ntfs_log_set_flags(u32 flags);
u32 ntfs_log_clear_flags(u32 flags);
u32 ntfs_log_get_flags(void);

__attribute__((format(printf,
__attribute__((format(printf,
__attribute__((format(printf,
__attribute__((format(printf,
__attribute__((format(printf,
__attribute__((format(printf,

6,
6,
6,
6,
6,
6,

0)));
0)));
0)));
0)));
0)));
0)));

/* Turn command-line options into logging flags */

BOOL ntfs_log_parse_option(const char *option);
int ntfs_log_redirect(const char *function, const char *file, int line,
u32 level, void *data, const char *format, ...)
__attribute__((format(printf, 6, 7)));
/* Logging levels - Determine what
#define NTFS_LOG_LEVEL_DEBUG
(1
#define NTFS_LOG_LEVEL_TRACE
(1
#define NTFS_LOG_LEVEL_QUIET
(1
#define NTFS_LOG_LEVEL_INFO
(1
#define NTFS_LOG_LEVEL_VERBOSE (1
#define NTFS_LOG_LEVEL_PROGRESS (1
#define NTFS_LOG_LEVEL_WARNING (1
/
#define NTFS_LOG_LEVEL_ERROR
(1
#define NTFS_LOG_LEVEL_PERROR (1
n */
#define NTFS_LOG_LEVEL_CRITICAL (1
curred */
#define NTFS_LOG_LEVEL_ENTER
(1
#define NTFS_LOG_LEVEL_LEAVE
(1
/* Logging style flags - Manage
#define NTFS_LOG_FLAG_PREFIX
*/
#define NTFS_LOG_FLAG_FILENAME
*/
#define NTFS_LOG_FLAG_LINE
*/
#define NTFS_LOG_FLAG_FUNCTION
e message */
#define NTFS_LOG_FLAG_ONLYNAME
athname */

gets logged */
<< 0) /* x = 42 */
<< 1) /* Entering function x() */
<< 2) /* Quietable output */
<< 3) /* Volume needs defragmenting */
<< 4) /* Forced to continue */
<< 5) /* 54% complete */
<< 6) /* You should backup before starting *
<< 7) /* Operation failed, no damage done */
<< 8) /* Message : standard error descriptio
<< 9) /* Operation failed,damage may have oc
<< 10) /* Enter a function */
<< 11) /* Leave a function */

the style of the output */

(1 << 0) /* Prefix messages with "ERROR: ", etc
(1 << 1) /* Show the file origin of the message
(1 << 2) /* Show the line number of the message
(1 << 3) /* Show the function name containing th
(1 << 4) /* Only display the filename, not the p

/* Macros to simplify logging. One for each level defined above.

* Note, ntfs_log_debug/trace have effect only if DEBUG is defined.
*/
#define ntfs_log_critical(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE
__,__LINE__,NTFS_LOG_LEVEL_CRITICAL,NULL,FORMAT,##ARGS)
#define ntfs_log_error(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,
__LINE__,NTFS_LOG_LEVEL_ERROR,NULL,FORMAT,##ARGS)
#define ntfs_log_info(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,_
_LINE__,NTFS_LOG_LEVEL_INFO,NULL,FORMAT,##ARGS)
#define ntfs_log_perror(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__
,__LINE__,NTFS_LOG_LEVEL_PERROR,NULL,FORMAT,##ARGS)
#define ntfs_log_progress(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE
__,__LINE__,NTFS_LOG_LEVEL_PROGRESS,NULL,FORMAT,##ARGS)
#define ntfs_log_quiet(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,
__LINE__,NTFS_LOG_LEVEL_QUIET,NULL,FORMAT,##ARGS)
#define ntfs_log_verbose(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE_
_,__LINE__,NTFS_LOG_LEVEL_VERBOSE,NULL,FORMAT,##ARGS)
#define ntfs_log_warning(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE_
_,__LINE__,NTFS_LOG_LEVEL_WARNING,NULL,FORMAT,##ARGS)
/* By default debug and trace messages are compiled into the program,
* but not displayed.
*/

#ifdef DEBUG
#define ntfs_log_debug(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,
__LINE__,NTFS_LOG_LEVEL_DEBUG,NULL,FORMAT,##ARGS)
#define ntfs_log_trace(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,
__LINE__,NTFS_LOG_LEVEL_TRACE,NULL,FORMAT,##ARGS)
#define ntfs_log_enter(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,
__LINE__,NTFS_LOG_LEVEL_ENTER,NULL,FORMAT,##ARGS)
#define ntfs_log_leave(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,
__LINE__,NTFS_LOG_LEVEL_LEAVE,NULL,FORMAT,##ARGS)
#else
#define ntfs_log_debug(FORMAT, ARGS...)do {} while (0)
#define ntfs_log_trace(FORMAT, ARGS...)do {} while (0)
#define ntfs_log_enter(FORMAT, ARGS...)do {} while (0)
#define ntfs_log_leave(FORMAT, ARGS...)do {} while (0)
#endif /* DEBUG */
void ntfs_log_early_error(const char *format, ...)
__attribute__((format(printf, 1, 2)));
#endif /* _LOGGING_H_ */