1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
#ifndef ANY_LOG_INCLUDE
#define ANY_LOG_INCLUDE
// any_log
// These values represent the decreasing urgency of a log invocation.
//
// panic: indicates a fatal error and using it will result in
// the program termination (see any_log_exit)
//
// error: indicates a (non-fatal) error
//
// warn: indicates a warning
//
// info: indicates an information (potentially useful to the user)
//
// debug: indicates debugging information
//
// trace: indicates verbose debugging information and can be completely
// disabled by defining ANY_LOG_NO_TRACE before including
//
// NOTE: The value ANY_LOG_ALL is not an actual level and it is used as
// a sentinel to indicate the last value of any_log_level_t
//
typedef enum {
ANY_LOG_PANIC,
ANY_LOG_ERROR,
ANY_LOG_WARN,
ANY_LOG_INFO,
ANY_LOG_DEBUG,
ANY_LOG_TRACE,
ANY_LOG_ALL,
} any_log_level_t;
// The value of ANY_LOG_MODULE is used to indicate the current module.
// By default it is defined as __FILE__, so that it will coincide with the
// source file path (relative to the compiler cwd).
//
// You can customize ANY_LOG_MODULE before including the header by simply
// defining it. For example
//
// #define ANY_LOG_MODULE "my-library"
// #include "any_log.h"
//
#ifndef ANY_LOG_MODULE
#define ANY_LOG_MODULE __FILE__
#endif
// C99 and later define the __func__ variable
#ifndef ANY_LOG_FUNC
#define ANY_LOG_FUNC __func__
#endif
#define log_panic(...) \
do { \
any_log_format(ANY_LOG_PANIC, ANY_LOG_MODULE, ANY_LOG_FUNC, __VA_ARGS__); \
any_log_exit(ANY_LOG_MODULE, ANY_LOG_FUNC); \
} while (0)
#define log_error(...) \
any_log_format(ANY_LOG_ERROR, ANY_LOG_MODULE, ANY_LOG_FUNC, __VA_ARGS__)
#define log_warn(...) \
any_log_format(ANY_LOG_WARN, ANY_LOG_MODULE, ANY_LOG_FUNC, __VA_ARGS__)
#define log_info(...) \
any_log_format(ANY_LOG_INFO, ANY_LOG_MODULE, ANY_LOG_FUNC, __VA_ARGS__)
#define log_debug(...) \
any_log_format(ANY_LOG_DEBUG, ANY_LOG_MODULE, ANY_LOG_FUNC, __VA_ARGS__)
#ifdef ANY_LOG_NO_TRACE
#define log_trace(...)
#else
#define log_trace(...) \
any_log_format(ANY_LOG_TRACE, ANY_LOG_MODULE, ANY_LOG_FUNC, __VA_ARGS__)
#endif
#ifdef __GNUC__
#define ANY_LOG_ATTRIBUTE(...) __attribute__((__VA_ARGS__))
#else
#define ANY_LOG_ATTRIBUTE(...)
#endif
extern const char *any_log_level_strings[ANY_LOG_ALL];
ANY_LOG_ATTRIBUTE(const)
const char *any_log_level_to_string(any_log_level_t level);
ANY_LOG_ATTRIBUTE(const)
any_log_level_t any_log_level_from_string(const char *string);
ANY_LOG_ATTRIBUTE(noreturn)
void any_log_exit(const char *module, const char *func);
ANY_LOG_ATTRIBUTE(format(printf, 4, 5))
void any_log_format(any_log_level_t level, const char *module,
const char *func, const char *format, ...);
#endif
#ifdef ANY_LOG_IMPLEMENT
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#ifndef ANY_LOG_PANIC_STRING
#define ANY_LOG_PANIC_STRING "panic"
#endif
#ifndef ANY_LOG_ERROR_STRING
#define ANY_LOG_ERROR_STRING "error"
#endif
#ifndef ANY_LOG_WARN_STRING
#define ANY_LOG_WARN_STRING "warn"
#endif
#ifndef ANY_LOG_INFO_STRING
#define ANY_LOG_INFO_STRING "info"
#endif
#ifndef ANY_LOG_DEBUG_STRING
#define ANY_LOG_DEBUG_STRING "debug"
#endif
#ifndef ANY_LOG_TRACE_STRING
#define ANY_LOG_TRACE_STRING "trace"
#endif
static const char *log_level_strings[ANY_LOG_ALL] = {
ANY_LOG_PANIC_STRING,
ANY_LOG_ERROR_STRING,
ANY_LOG_WARN_STRING,
ANY_LOG_INFO_STRING ,
ANY_LOG_DEBUG_STRING,
ANY_LOG_TRACE_STRING,
};
// Using log_panic results in a call to any_log_exit, which should terminate
// the program. The value of ANY_LOG_PANIC is used to specify what action
// to take in any_log_exit.
// By default it is abort
//
// NOTE: That any_log_exit should never return!
//
#ifndef ANY_LOG_PANIC
#define ANY_LOG_PANIC(module, func) abort()
#endif
// NOTE: This function should be called solely by the macro log_panic
void any_log_exit(const char *module, const char *func)
{
ANY_LOG_PANIC(module, func);
}
#ifndef ANY_LOG_FORMAT_BEFORE
#define ANY_LOG_FORMAT_BEFORE(level, module, func, level_strings) \
"[%s %s] %s: ", module, func, level_strings[level]
#endif
#ifndef ANY_LOG_FORMAT_AFTER
#define ANY_LOG_FORMAT_AFTER(level, module, func, levels) "\n"
#endif
void any_log_format(any_log_level_t level, const char *module,
const char *func, const char *format, ...)
{
fprintf(stdout,
ANY_LOG_FORMAT_BEFORE(level, module, func, log_level_strings));
va_list args;
va_start(args, format);
vfprintf(stdout, format, args);
va_end(args);
fprintf(stdout,
ANY_LOG_FORMAT_AFTER(level, module, func, log_level_strings));
}
#endif
// vim: ts=4 sw=4 et
|
