7b089ce316c274d3e460d62a4978e0118a895f75
[gpgol.git] / src / debug.h
1 #ifndef DEBUG_H
2 #define DEBUG_H
3 /* debug.h - Debugging / Log helpers for GpgOL
4  * Copyright (C) 2018 by by Intevation GmbH
5  *
6  * This file is part of GpgOL.
7  *
8  * GpgOL is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation; either version 2.1
11  * of the License, or (at your option) any later version.
12  *
13  * GpgOL is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25
26 #ifdef __cplusplus
27 extern "C" {
28 #if 0
29 }
30 #endif
31 #endif
32
33 /* Bit values used for extra log file verbosity.  Value 1 is reserved
34    to enable debug menu options.
35
36    Note that the high values here are used for compatibility with
37    old howtos of how to enable debug flags. Based on the old
38    very split up logging categories.
39
40    Categories are meant to be:
41
42    DBG -> Generally useful information.
43    DBG_MEMORY -> Very verbose tracing of Releases / Allocs / Refs.
44    DBG_OOM -> Outlook Object Model events tracing.
45    DBG_DATA -> Including potentially private data and mime parser logging.
46
47    Common values are:
48    32 -> Only memory debugging.
49    544 -> OOM and Memory.
50    800 -> Full debugging.
51    */
52 #define DBG_OOM            (1<<1) // 2
53 #define DBG_MEMORY         (1<<2) // 4
54 #define DBG_TRACE          (1<<3) // 8
55 #define DBG_DATA           (1<<4) // 16
56
57 void log_debug (const char *fmt, ...) __attribute__ ((format (printf,1,2)));
58 void log_error (const char *fmt, ...) __attribute__ ((format (printf,1,2)));
59 void log_vdebug (const char *fmt, va_list a);
60 void log_debug_w32 (int w32err, const char *fmt,
61                     ...) __attribute__ ((format (printf,2,3)));
62 void log_error_w32 (int w32err, const char *fmt,
63                     ...) __attribute__ ((format (printf,2,3)));
64 void log_hexdump (const void *buf, size_t buflen, const char *fmt,
65                   ...)  __attribute__ ((format (printf,3,4)));
66
67 const char *anonstr (const char *data);
68 #define log_oom(format, ...) if ((opt.enable_debug & DBG_OOM)) \
69   log_debug("DBG_OOM/" format, ##__VA_ARGS__)
70
71 #define log_data(format, ...) if ((opt.enable_debug & DBG_DATA)) \
72   log_debug("DBG_DATA/" format, ##__VA_ARGS__)
73
74 #define log_memory(format, ...) if ((opt.enable_debug & DBG_MEMORY)) \
75   log_debug("DBG_MEM/" format, ##__VA_ARGS__)
76
77 #define log_trace(format, ...) if ((opt.enable_debug & DBG_TRACE)) \
78   log_debug("TRACE/" format, ##__VA_ARGS__)
79
80 #define gpgol_release(X) \
81 { \
82   if (X && opt.enable_debug & DBG_MEMORY) \
83     { \
84       log_memory ("%s:%s:%i: Object: %p released ref: %lu \n", \
85                   SRCNAME, __func__, __LINE__, X, X->Release()); \
86       memdbg_released (X); \
87     } \
88   else if (X) \
89     { \
90       X->Release(); \
91     } \
92 }
93
94 const char *log_srcname (const char *s);
95 #define SRCNAME log_srcname (__FILE__)
96
97 #define STRANGEPOINT log_debug ("%s:%s:%d:_trace_", \
98                            SRCNAME, __func__, __LINE__);
99 #define TRACEPOINT log_trace ("%s:%s:%d", \
100                               SRCNAME, __func__, __LINE__);
101 #define TSTART log_trace ("%s:%s:%d enter", SRCNAME, __func__, __LINE__);
102 #define TRETURN log_trace ("%s:%s:%d: return", SRCNAME, __func__, \
103                            __LINE__); \
104                    return
105 #define TBREAK log_trace ("%s:%s:%d: break", SRCNAME, __func__, \
106                            __LINE__); \
107                    break
108
109
110 const char *get_log_file (void);
111 void set_log_file (const char *name);
112
113 #ifdef _WIN64
114 #define SIZE_T_FORMAT "%I64u"
115 #else
116 # ifdef HAVE_W32_SYSTEM
117 #  define SIZE_T_FORMAT "%u"
118 # else
119 #  define SIZE_T_FORMAT "%lu"
120 # endif
121 #endif
122
123 #ifdef __cplusplus
124 }
125 #endif
126
127 #endif // DEBUG_H