log.c

   1 /*
   2  * This file is part of the libsigrokdecode 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 <config.h>
  22 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  23 #include "libsigrokdecode.h"
  24 #include <stdarg.h>
  25 #include <stdio.h>
  26 #include <glib/gprintf.h>
  27
  28 /**
  29  * @file
  30  *
  31  * Controlling the libsigrokdecode message logging functionality.
  32  */
  33
  34 /**
  35  * @defgroup grp_logging Logging
  36  *
  37  * Controlling the libsigrokdecode message logging functionality.
  38  *
  39  * @{
  40  */
  41
  42 /* Currently selected libsigrokdecode loglevel. Default: SRD_LOG_WARN. */
  43 static int cur_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */
  44
  45 /* Function prototype. */
  46 static int srd_logv(void *cb_data, int loglevel, const char *format,
  47                     va_list args);
  48
  49 /* Pointer to the currently selected log callback. Default: srd_logv(). */
  50 static srd_log_callback srd_log_cb = srd_logv;
  51
  52 /*
  53  * Pointer to private data that can be passed to the log callback.
  54  * This can be used (for example) by C++ GUIs to pass a "this" pointer.
  55  */
  56 static void *srd_log_cb_data = NULL;
  57
  58 /**
  59  * Set the libsigrokdecode loglevel.
  60  *
  61  * This influences the amount of log messages (debug messages, error messages,
  62  * and so on) libsigrokdecode will output. Using SRD_LOG_NONE disables all
  63  * messages.
  64  *
  65  * Note that this function itself will also output log messages. After the
  66  * loglevel has changed, it will output a debug message with SRD_LOG_DBG for
  67  * example. Whether this message is shown depends on the (new) loglevel.
  68  *
  69  * @param loglevel The loglevel to set (SRD_LOG_NONE, SRD_LOG_ERR,
  70  *                 SRD_LOG_WARN, SRD_LOG_INFO, SRD_LOG_DBG, or SRD_LOG_SPEW).
  71  *
  72  * @return SRD_OK upon success, SRD_ERR_ARG upon invalid loglevel.
  73  *
  74  * @since 0.1.0
  75  */
  76 SRD_API int srd_log_loglevel_set(int loglevel)
  77 {
  78         if (loglevel < SRD_LOG_NONE || loglevel > SRD_LOG_SPEW) {
  79                 srd_err("Invalid loglevel %d.", loglevel);
  80                 return SRD_ERR_ARG;
  81         }
  82
  83         cur_loglevel = loglevel;
  84
  85         srd_dbg("libsigrokdecode loglevel set to %d.", loglevel);
  86
  87         return SRD_OK;
  88 }
  89
  90 /**
  91  * Get the libsigrokdecode loglevel.
  92  *
  93  * @return The currently configured libsigrokdecode loglevel.
  94  *
  95  * @since 0.1.0
  96  */
  97 SRD_API int srd_log_loglevel_get(void)
  98 {
  99         return cur_loglevel;
 100 }
 101
 102 /**
 103  * Set the libsigrokdecode log callback to the specified function.
 104  *
 105  * @param cb Function pointer to the log callback function to use.
 106  *           Must not be NULL.
 107  * @param cb_data Pointer to private data to be passed on. This can be used
 108  *                by the caller to pass arbitrary data to the log functions.
 109  *                This pointer is only stored or passed on by libsigrokdecode,
 110  *                and is never used or interpreted in any way. The pointer
 111  *                is allowed to be NULL if the caller doesn't need/want to
 112  *                pass any data.
 113  *
 114  * @return SRD_OK upon success, SRD_ERR_ARG upon invalid arguments.
 115  *
 116  * @since 0.3.0
 117  */
 118 SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data)
 119 {
 120         if (!cb) {
 121                 srd_err("log: %s: cb was NULL", __func__);
 122                 return SRD_ERR_ARG;
 123         }
 124
 125         /* Note: 'cb_data' is allowed to be NULL. */
 126
 127         srd_log_cb = cb;
 128         srd_log_cb_data = cb_data;
 129
 130         return SRD_OK;
 131 }
 132
 133 /**
 134  * Set the libsigrokdecode log callback to the default built-in one.
 135  *
 136  * Additionally, the internal 'srd_log_cb_data' pointer is set to NULL.
 137  *
 138  * @return SRD_OK upon success, a (negative) error code otherwise.
 139  *
 140  * @since 0.1.0
 141  */
 142 SRD_API int srd_log_callback_set_default(void)
 143 {
 144         /*
 145          * Note: No log output in this function, as it should safely work
 146          * even if the currently set log callback is buggy/broken.
 147          */
 148         srd_log_cb = srd_logv;
 149         srd_log_cb_data = NULL;
 150
 151         return SRD_OK;
 152 }
 153
 154 static int srd_logv(void *cb_data, int loglevel, const char *format,
 155                     va_list args)
 156 {
 157         /* This specific log callback doesn't need the void pointer data. */
 158         (void)cb_data;
 159
 160         /* Only output messages of at least the selected loglevel(s). */
 161         if (loglevel > cur_loglevel)
 162                 return SRD_OK;
 163
 164         if (fputs("srd: ", stderr) < 0
 165                         || g_vfprintf(stderr, format, args) < 0
 166                         || putc('\n', stderr) < 0)
 167                 return SRD_ERR;
 168
 169         return SRD_OK;
 170 }
 171
 172 /** @private */
 173 SRD_PRIV int srd_log(int loglevel, const char *format, ...)
 174 {
 175         int ret;
 176         va_list args;
 177
 178         va_start(args, format);
 179         ret = srd_log_cb(srd_log_cb_data, loglevel, format, args);
 180         va_end(args);
 181
 182         return ret;
 183 }
 184
 185 /** @} */