New functions to compute an ssh style fingerprint.
[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 JNLIB.
6  *
7  * JNLIB is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 3 of
10  * the License, or (at your option) any later version.
11  *
12  * JNLIB is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef LIBJNLIB_LOGGING_H
22 #define LIBJNLIB_LOGGING_H
23
24 #include <stdio.h>
25 #include "estream.h"
26 #include "mischelp.h"
27 #include "w32help.h"
28
29 /* Flag values for log_set_prefix. */
30 #define JNLIB_LOG_WITH_PREFIX  1
31 #define JNLIB_LOG_WITH_TIME    2
32 #define JNLIB_LOG_WITH_PID     4
33 #define JNLIB_LOG_RUN_DETACHED 256
34
35 int  log_get_errorcount (int clear);
36 void log_inc_errorcount (void);
37 void log_set_file( const char *name );
38 void log_set_fd (int fd);
39 void log_set_pid_suffix_cb (int (*cb)(unsigned long *r_value));
40 void log_set_prefix (const char *text, unsigned int flags);
41 const char *log_get_prefix (unsigned int *flags);
42 int log_test_fd (int fd);
43 int  log_get_fd(void);
44 estream_t log_get_stream (void);
45
46 #ifdef JNLIB_GCC_M_FUNCTION
47   void bug_at( const char *file, int line, const char *func ) JNLIB_GCC_A_NR;
48 # define BUG() bug_at( __FILE__ , __LINE__, __FUNCTION__ )
49 #else
50   void bug_at( const char *file, int line );
51 # define BUG() bug_at( __FILE__ , __LINE__ )
52 #endif
53
54 /* To avoid mandatory inclusion of stdarg and other stuff, do it only
55    if explicitly requested to do so. */
56 #ifdef JNLIB_NEED_LOG_LOGV
57 #include <stdarg.h>
58 enum jnlib_log_levels {
59     JNLIB_LOG_BEGIN,
60     JNLIB_LOG_CONT,
61     JNLIB_LOG_INFO,
62     JNLIB_LOG_WARN,
63     JNLIB_LOG_ERROR,
64     JNLIB_LOG_FATAL,
65     JNLIB_LOG_BUG,
66     JNLIB_LOG_DEBUG
67 };
68 void log_log (int level, const char *fmt, ...) JNLIB_GCC_A_PRINTF(2,3);
69 void log_logv (int level, const char *fmt, va_list arg_ptr);
70 void log_string (int level, const char *string);
71 #endif /*JNLIB_NEED_LOG_LOGV*/
72
73
74 void log_bug( const char *fmt, ... )    JNLIB_GCC_A_NR_PRINTF(1,2);
75 void log_fatal( const char *fmt, ... )  JNLIB_GCC_A_NR_PRINTF(1,2);
76 void log_error( const char *fmt, ... )  JNLIB_GCC_A_PRINTF(1,2);
77 void log_info( const char *fmt, ... )   JNLIB_GCC_A_PRINTF(1,2);
78 void log_debug( const char *fmt, ... )  JNLIB_GCC_A_PRINTF(1,2);
79 void log_printf( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
80 void log_flush (void);
81
82 /* Print a hexdump of BUFFER.  With TEXT passes as NULL print just the
83    raw dump, with TEXT being an empty string, print a trailing
84    linefeed, otherwise print an entire debug line with TEXT followed
85    by the hexdump and a final LF.  */
86 void log_printhex (const char *text, const void *buffer, size_t length);
87
88
89 #endif /*LIBJNLIB_LOGGING_H*/