common: New function log_logv_with_prefix.
[gnupg.git] / common / logging.h
1 /* logging.h
2  * Copyright (C) 1999, 2000, 2001, 2004, 2006,
3  *               2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify it
8  * under the terms of either
9  *
10  *   - the GNU Lesser General Public License as published by the Free
11  *     Software Foundation; either version 3 of the License, or (at
12  *     your option) any later version.
13  *
14  * or
15  *
16  *   - the GNU General Public License as published by the Free
17  *     Software Foundation; either version 2 of the License, or (at
18  *     your option) any later version.
19  *
20  * or both in parallel, as here.
21  *
22  * GnuPG is distributed in the hope that it will be useful, but
23  * WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * General Public License for more details.
26  *
27  * You should have received a copies of the GNU General Public License
28  * and the GNU Lesser General Public License along with this program;
29  * if not, see <https://www.gnu.org/licenses/>.
30  */
31
32 #ifndef GNUPG_COMMON_LOGGING_H
33 #define GNUPG_COMMON_LOGGING_H
34
35 #include <stdio.h>
36 #include <stdarg.h>
37 #include <gpg-error.h>
38 #include "mischelp.h"
39 #include "w32help.h"
40
41 int  log_get_errorcount (int clear);
42 void log_inc_errorcount (void);
43 void log_set_file( const char *name );
44 void log_set_fd (int fd);
45 void log_set_socket_dir_cb (const char *(*fnc)(void));
46 void log_set_pid_suffix_cb (int (*cb)(unsigned long *r_value));
47 void log_set_prefix (const char *text, unsigned int flags);
48 const char *log_get_prefix (unsigned int *flags);
49 int log_test_fd (int fd);
50 int  log_get_fd(void);
51 estream_t log_get_stream (void);
52
53 #ifdef GPGRT_HAVE_MACRO_FUNCTION
54   void bug_at (const char *file, int line, const char *func)
55                GPGRT_ATTR_NORETURN;
56   void _log_assert (const char *expr, const char *file, int line,
57                     const char *func) GPGRT_ATTR_NORETURN;
58 # define BUG() bug_at( __FILE__ , __LINE__, __FUNCTION__)
59 # define log_assert(expr)                                       \
60   ((expr)                                                       \
61    ? (void) 0                                                   \
62    : _log_assert (#expr, __FILE__, __LINE__, __FUNCTION__))
63 #else /*!GPGRT_HAVE_MACRO_FUNCTION*/
64   void bug_at (const char *file, int line);
65   void _log_assert (const char *expr, const char *file, int line);
66 # define BUG() bug_at( __FILE__ , __LINE__ )
67 # define log_assert(expr)                                       \
68   ((expr)                                                       \
69    ? (void) 0                                                   \
70    : _log_assert (#expr, __FILE__, __LINE__))
71 #endif /*!GPGRT_HAVE_MACRO_FUNCTION*/
72
73 /* Flag values for log_set_prefix. */
74 #define GPGRT_LOG_WITH_PREFIX  1
75 #define GPGRT_LOG_WITH_TIME    2
76 #define GPGRT_LOG_WITH_PID     4
77 #define GPGRT_LOG_RUN_DETACHED 256
78 #define GPGRT_LOG_NO_REGISTRY  512
79
80 /* Log levels as used by log_log.  */
81 enum jnlib_log_levels {
82     GPGRT_LOG_BEGIN,
83     GPGRT_LOG_CONT,
84     GPGRT_LOG_INFO,
85     GPGRT_LOG_WARN,
86     GPGRT_LOG_ERROR,
87     GPGRT_LOG_FATAL,
88     GPGRT_LOG_BUG,
89     GPGRT_LOG_DEBUG
90 };
91 void log_log (int level, const char *fmt, ...) GPGRT_ATTR_PRINTF(2,3);
92 void log_logv (int level, const char *fmt, va_list arg_ptr);
93 void log_logv_with_prefix (int level, const char *prefix,
94                            const char *fmt, va_list arg_ptr);
95 void log_string (int level, const char *string);
96 void log_bug (const char *fmt, ...)    GPGRT_ATTR_NR_PRINTF(1,2);
97 void log_fatal (const char *fmt, ...)  GPGRT_ATTR_NR_PRINTF(1,2);
98 void log_error (const char *fmt, ...)  GPGRT_ATTR_PRINTF(1,2);
99 void log_info (const char *fmt, ...)   GPGRT_ATTR_PRINTF(1,2);
100 void log_debug (const char *fmt, ...)  GPGRT_ATTR_PRINTF(1,2);
101 void log_debug_with_string (const char *string, const char *fmt,
102                             ...) GPGRT_ATTR_PRINTF(2,3);
103 void log_printf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
104 void log_flush (void);
105
106 /* Print a hexdump of BUFFER.  With TEXT passes as NULL print just the
107    raw dump, with TEXT being an empty string, print a trailing
108    linefeed, otherwise print an entire debug line with TEXT followed
109    by the hexdump and a final LF.  */
110 void log_printhex (const char *text, const void *buffer, size_t length);
111
112 void log_clock (const char *string);
113
114
115 #endif /*GNUPG_COMMON_LOGGING_H*/