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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*
* This file is part of the libsigrokdecode project.
*
* Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <http://www.gnu.org/licenses/>.
*/
#include <config.h>
#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include "libsigrokdecode.h"
#include <stdarg.h>
#include <stdio.h>
#include <glib/gprintf.h>
/**
* @file
*
* Controlling the libsigrokdecode message logging functionality.
*/
/**
* @defgroup grp_logging Logging
*
* Controlling the libsigrokdecode message logging functionality.
*
* @{
*/
/* Currently selected libsigrokdecode loglevel. Default: SRD_LOG_WARN. */
static int cur_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */
/* Function prototype. */
static int srd_logv(void *cb_data, int loglevel, const char *format,
va_list args);
/* Pointer to the currently selected log callback. Default: srd_logv(). */
static srd_log_callback srd_log_cb = srd_logv;
/*
* Pointer to private data that can be passed to the log callback.
* This can be used (for example) by C++ GUIs to pass a "this" pointer.
*/
static void *srd_log_cb_data = NULL;
/**
* Set the libsigrokdecode loglevel.
*
* This influences the amount of log messages (debug messages, error messages,
* and so on) libsigrokdecode will output. Using SRD_LOG_NONE disables all
* messages.
*
* Note that this function itself will also output log messages. After the
* loglevel has changed, it will output a debug message with SRD_LOG_DBG for
* example. Whether this message is shown depends on the (new) loglevel.
*
* @param loglevel The loglevel to set (SRD_LOG_NONE, SRD_LOG_ERR,
* SRD_LOG_WARN, SRD_LOG_INFO, SRD_LOG_DBG, or SRD_LOG_SPEW).
*
* @return SRD_OK upon success, SRD_ERR_ARG upon invalid loglevel.
*
* @since 0.1.0
*/
SRD_API int srd_log_loglevel_set(int loglevel)
{
if (loglevel < SRD_LOG_NONE || loglevel > SRD_LOG_SPEW) {
srd_err("Invalid loglevel %d.", loglevel);
return SRD_ERR_ARG;
}
cur_loglevel = loglevel;
srd_dbg("libsigrokdecode loglevel set to %d.", loglevel);
return SRD_OK;
}
/**
* Get the libsigrokdecode loglevel.
*
* @return The currently configured libsigrokdecode loglevel.
*
* @since 0.1.0
*/
SRD_API int srd_log_loglevel_get(void)
{
return cur_loglevel;
}
/**
* Set the libsigrokdecode log callback to the specified function.
*
* @param cb Function pointer to the log callback function to use.
* Must not be NULL.
* @param cb_data Pointer to private data to be passed on. This can be used
* by the caller to pass arbitrary data to the log functions.
* This pointer is only stored or passed on by libsigrokdecode,
* and is never used or interpreted in any way. The pointer
* is allowed to be NULL if the caller doesn't need/want to
* pass any data.
*
* @return SRD_OK upon success, SRD_ERR_ARG upon invalid arguments.
*
* @since 0.3.0
*/
SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data)
{
if (!cb) {
srd_err("log: %s: cb was NULL", __func__);
return SRD_ERR_ARG;
}
/* Note: 'cb_data' is allowed to be NULL. */
srd_log_cb = cb;
srd_log_cb_data = cb_data;
return SRD_OK;
}
/**
* Get the libsigrokdecode log callback routine and callback data.
*
* @param[out] cb Pointer to a function pointer to receive the log callback
* function. Optional, can be NULL.
* @param[out] cb_data Pointer to a void pointer to receive the log callback's
* additional arguments. Optional, can be NULL.
*
* @return SRD_OK upon success.
*
* @since 0.5.2
*/
SRD_API int srd_log_callback_get(srd_log_callback *cb, void **cb_data)
{
if (cb)
*cb = srd_log_cb;
if (cb_data)
*cb_data = srd_log_cb_data;
return SRD_OK;
}
/**
* Set the libsigrokdecode log callback to the default built-in one.
*
* Additionally, the internal 'srd_log_cb_data' pointer is set to NULL.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*
* @since 0.1.0
*/
SRD_API int srd_log_callback_set_default(void)
{
/*
* Note: No log output in this function, as it should safely work
* even if the currently set log callback is buggy/broken.
*/
srd_log_cb = srd_logv;
srd_log_cb_data = NULL;
return SRD_OK;
}
static int srd_logv(void *cb_data, int loglevel, const char *format,
va_list args)
{
/* This specific log callback doesn't need the void pointer data. */
(void)cb_data;
(void)loglevel;
if (fputs("srd: ", stderr) < 0
|| g_vfprintf(stderr, format, args) < 0
|| putc('\n', stderr) < 0)
return SRD_ERR;
fflush(stderr);
return SRD_OK;
}
/** @private */
SRD_PRIV int srd_log(int loglevel, const char *format, ...)
{
int ret;
va_list args;
/* Only output messages of at least the selected loglevel(s). */
if (loglevel > cur_loglevel)
return SRD_OK;
va_start(args, format);
ret = srd_log_cb(srd_log_cb_data, loglevel, format, args);
va_end(args);
return ret;
}
/** @} */
|
