chiark / gitweb /
plugins/tracklength-gstreamer.c: Rewrite to use `GstDiscoverer'.
[disorder] / lib / log.h
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder.
cca89d7c 3 * Copyright (C) 2004, 2005, 2007-9, 2013 Richard Kettlewell
460b9539 4 *
e7eb3a27 5 * This program is free software: you can redistribute it and/or modify
460b9539 6 * it under the terms of the GNU General Public License as published by
e7eb3a27 7 * the Free Software Foundation, either version 3 of the License, or
460b9539 8 * (at your option) any later version.
e7eb3a27
RK
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
460b9539 15 * You should have received a copy of the GNU General Public License
e7eb3a27 16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
460b9539 17 */
132a5a4a
RK
18/** @file lib/log.h
19 * @brief Errors and logging
20 */
460b9539 21
22#ifndef LOG_H
23#define LOG_H
24
460b9539 25#include <stdarg.h>
26
27struct log_output;
28
29void set_progname(char **argv);
460b9539 30
92db088e
RK
31/** @brief Possible error number spaces */
32enum error_class {
33 /** @brief Invalid number space */
34 ec_none,
35
36 /** @brief @c errno number space */
37 ec_errno,
38
9e42afcd
RK
39 /** @brief Windows GetLastError/WSAGetLastError return value */
40 ec_windows,
41
92db088e
RK
42 /** @brief getaddrinfo() return value */
43 ec_getaddrinfo,
44};
45
9e42afcd
RK
46#if _WIN32
47# define ec_native ec_windows
48# define ec_socket ec_windows
49#else
92db088e
RK
50# define ec_native ec_errno
51# define ec_socket ec_errno
9e42afcd 52#endif
92db088e
RK
53
54void elog(int pri, enum error_class, int errno_value, const char *fmt, va_list ap);
460b9539 55
9e42afcd 56declspec(noreturn)
093ec810 57void disorder_fatal(int errno_value, const char *msg, ...) attribute((noreturn))
460b9539 58 attribute((format (printf, 2, 3)));
9e42afcd 59declspec(noreturn)
92db088e
RK
60void disorder_fatal_ec(enum error_class ec, int errno_value, const char *msg, ...) attribute((noreturn))
61 attribute((format (printf, 3, 4)));
093ec810 62void disorder_error(int errno_value, const char *msg, ...)
460b9539 63 attribute((format (printf, 2, 3)));
92db088e
RK
64void disorder_error_ec(enum error_class ec, int errno_value, const char *msg, ...)
65 attribute((format (printf, 3, 4)));
093ec810 66void disorder_info(const char *msg, ...)
460b9539 67 attribute((format (printf, 1, 2)));
093ec810 68void disorder_debug(const char *msg, ...)
460b9539 69 attribute((format (printf, 1, 2)));
70/* report a message of the given class. @errno_value@ if present an
71 * non-zero is included. @fatal@ terminates the process. */
72
92db088e
RK
73const char *format_error(enum error_class ec, int err, char buffer[], size_t bufsize);
74
460b9539 75extern int debugging;
76/* set when debugging enabled */
77
78extern void (*exitfn)(int) attribute((noreturn));
79/* how to exit the program (for fatal) */
80
81extern const char *progname;
82/* program name */
83
cca89d7c
RK
84extern struct log_output log_stderr, *log_default;
85#if HAVE_SYSLOG_H
86extern struct log_output log_syslog;
87#endif
460b9539 88/* some typical outputs */
89
90extern const char *debug_filename;
91extern int debug_lineno;
9d7a6129 92extern int logdate;
460b9539 93
00682707
RK
94/** @brief Issue a debug message if debugging is turned on
95 * @param x Parenthesized debug arguments
96 *
97 * Use in the format: D(("format string", arg, arg, ...));
98 */
460b9539 99#define D(x) do { \
100 if(debugging) { \
101 debug_filename=__FILE__; \
102 debug_lineno=__LINE__; \
2e9ba080 103 disorder_debug x; \
460b9539 104 } \
105} while(0)
106
107#endif /* LOG_H */
108
109/*
110Local Variables:
111c-basic-offset:2
112comment-column:40
113fill-column:79
114End:
115*/