log.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <stdarg.h>
  22 #include <stdio.h>
  23 #include "libsigrok.h"
  24 #include "libsigrok-internal.h"
  25
  26 /**
  27  * @file
  28  *
  29  * Logging support.
  30  */
  31
  32 /* Currently selected libsigrok loglevel. Default: SR_LOG_WARN. */
  33 static int sr_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
  34
  35 /* Function prototype. */
  36 static int sr_logv(void *cb_data, int loglevel, const char *format,
  37                    va_list args);
  38
  39 /* Pointer to the currently selected log callback. Default: sr_logv(). */
  40 static sr_log_callback_t sr_log_callback = sr_logv;
  41
  42 /*
  43  * Pointer to private data that can be passed to the log callback.
  44  * This can be used (for example) by C++ GUIs to pass a "this" pointer.
  45  */
  46 static void *sr_log_callback_data = NULL;
  47
  48 /* Log domain (a short string that is used as prefix for all messages). */
  49 /** @cond PRIVATE */
  50 #define LOGDOMAIN_MAXLEN 30
  51 #define LOGDOMAIN_DEFAULT "sr: "
  52 /** @endcond */
  53 static char sr_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT;
  54
  55 /**
  56  * Set the libsigrok loglevel.
  57  *
  58  * This influences the amount of log messages (debug messages, error messages,
  59  * and so on) libsigrok will output. Using SR_LOG_NONE disables all messages.
  60  *
  61  * Note that this function itself will also output log messages. After the
  62  * loglevel has changed, it will output a debug message with SR_LOG_DBG for
  63  * example. Whether this message is shown depends on the (new) loglevel.
  64  *
  65  * @param loglevel The loglevel to set (SR_LOG_NONE, SR_LOG_ERR, SR_LOG_WARN,
  66  *                 SR_LOG_INFO, SR_LOG_DBG, or SR_LOG_SPEW).
  67  *
  68  * @return SR_OK upon success, SR_ERR_ARG upon invalid loglevel.
  69  */
  70 SR_API int sr_log_loglevel_set(int loglevel)
  71 {
  72         if (loglevel < SR_LOG_NONE || loglevel > SR_LOG_SPEW) {
  73                 sr_err("Invalid loglevel %d.", loglevel);
  74                 return SR_ERR_ARG;
  75         }
  76
  77         sr_loglevel = loglevel;
  78
  79         sr_dbg("libsigrok loglevel set to %d.", loglevel);
  80
  81         return SR_OK;
  82 }
  83
  84 /**
  85  * Get the libsigrok loglevel.
  86  *
  87  * @return The currently configured libsigrok loglevel.
  88  */
  89 SR_API int sr_log_loglevel_get(void)
  90 {
  91         return sr_loglevel;
  92 }
  93
  94 /**
  95  * Set the libsigrok logdomain string.
  96  *
  97  * @param logdomain The string to use as logdomain for libsigrok log
  98  *                  messages from now on. Must not be NULL. The maximum
  99  *                  length of the string is 30 characters (this does not
 100  *                  include the trailing NUL-byte). Longer strings are
 101  *                  silently truncated.
 102  *                  In order to not use a logdomain, pass an empty string.
 103  *                  The function makes its own copy of the input string, i.e.
 104  *                  the caller does not need to keep it around.
 105  *
 106  * @return SR_OK upon success, SR_ERR_ARG upon invalid logdomain.
 107  */
 108 SR_API int sr_log_logdomain_set(const char *logdomain)
 109 {
 110         if (!logdomain) {
 111                 sr_err("log: %s: logdomain was NULL", __func__);
 112                 return SR_ERR_ARG;
 113         }
 114
 115         /* TODO: Error handling. */
 116         snprintf((char *)&sr_log_domain, LOGDOMAIN_MAXLEN, "%s", logdomain);
 117
 118         sr_dbg("Log domain set to '%s'.", (const char *)&sr_log_domain);
 119
 120         return SR_OK;
 121 }
 122
 123 /**
 124  * Get the currently configured libsigrok logdomain.
 125  *
 126  * @return A copy of the currently configured libsigrok logdomain
 127  *         string. The caller is responsible for g_free()ing the string when
 128  *         it is no longer needed.
 129  */
 130 SR_API char *sr_log_logdomain_get(void)
 131 {
 132         return g_strdup((const char *)&sr_log_domain);
 133 }
 134
 135 /**
 136  * Set the libsigrok log callback to the specified function.
 137  *
 138  * @param cb Function pointer to the log callback function to use.
 139  *           Must not be NULL.
 140  * @param cb_data Pointer to private data to be passed on. This can be used by
 141  *                the caller to pass arbitrary data to the log functions. This
 142  *                pointer is only stored or passed on by libsigrok, and is
 143  *                never used or interpreted in any way. The pointer is allowed
 144  *                to be NULL if the caller doesn't need/want to pass any data.
 145  *
 146  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
 147  */
 148 SR_API int sr_log_callback_set(sr_log_callback_t cb, void *cb_data)
 149 {
 150         if (!cb) {
 151                 sr_err("log: %s: cb was NULL", __func__);
 152                 return SR_ERR_ARG;
 153         }
 154
 155         /* Note: 'cb_data' is allowed to be NULL. */
 156
 157         sr_log_callback = cb;
 158         sr_log_callback_data = cb_data;
 159
 160         return SR_OK;
 161 }
 162
 163 /**
 164  * Set the libsigrok log callback to the default built-in one.
 165  *
 166  * Additionally, the internal 'sr_log_callback_data' pointer is set to NULL.
 167  *
 168  * @return SR_OK upon success, a negative error code otherwise.
 169  */
 170 SR_API int sr_log_callback_set_default(void)
 171 {
 172         /*
 173          * Note: No log output in this function, as it should safely work
 174          * even if the currently set log callback is buggy/broken.
 175          */
 176         sr_log_callback = sr_logv;
 177         sr_log_callback_data = NULL;
 178
 179         return SR_OK;
 180 }
 181
 182 static int sr_logv(void *cb_data, int loglevel, const char *format, va_list args)
 183 {
 184         int ret;
 185
 186         /* This specific log callback doesn't need the void pointer data. */
 187         (void)cb_data;
 188
 189         /* Only output messages of at least the selected loglevel(s). */
 190         if (loglevel > sr_loglevel)
 191                 return SR_OK; /* TODO? */
 192
 193         if (sr_log_domain[0] != '\0')
 194                 fprintf(stderr, "%s", sr_log_domain);
 195         ret = vfprintf(stderr, format, args);
 196         fprintf(stderr, "\n");
 197
 198         return ret;
 199 }
 200
 201 /** @private */
 202 SR_PRIV int sr_log(int loglevel, const char *format, ...)
 203 {
 204         int ret;
 205         va_list args;
 206
 207         va_start(args, format);
 208         ret = sr_log_callback(sr_log_callback_data, loglevel, format, args);
 209         va_end(args);
 210
 211         return ret;
 212 }
 213
 214 /** @private */
 215 SR_PRIV int sr_spew(const char *format, ...)
 216 {
 217         int ret;
 218         va_list args;
 219
 220         va_start(args, format);
 221         ret = sr_log_callback(sr_log_callback_data, SR_LOG_SPEW, format, args);
 222         va_end(args);
 223
 224         return ret;
 225 }
 226
 227 /** @private */
 228 SR_PRIV int sr_dbg(const char *format, ...)
 229 {
 230         int ret;
 231         va_list args;
 232
 233         va_start(args, format);
 234         ret = sr_log_callback(sr_log_callback_data, SR_LOG_DBG, format, args);
 235         va_end(args);
 236
 237         return ret;
 238 }
 239
 240 /** @private */
 241 SR_PRIV int sr_info(const char *format, ...)
 242 {
 243         int ret;
 244         va_list args;
 245
 246         va_start(args, format);
 247         ret = sr_log_callback(sr_log_callback_data, SR_LOG_INFO, format, args);
 248         va_end(args);
 249
 250         return ret;
 251 }
 252
 253 /** @private */
 254 SR_PRIV int sr_warn(const char *format, ...)
 255 {
 256         int ret;
 257         va_list args;
 258
 259         va_start(args, format);
 260         ret = sr_log_callback(sr_log_callback_data, SR_LOG_WARN, format, args);
 261         va_end(args);
 262
 263         return ret;
 264 }
 265
 266 /** @private */
 267 SR_PRIV int sr_err(const char *format, ...)
 268 {
 269         int ret;
 270         va_list args;
 271
 272         va_start(args, format);
 273         ret = sr_log_callback(sr_log_callback_data, SR_LOG_ERR, format, args);
 274         va_end(args);
 275
 276         return ret;
 277 }