]> sigrok.org Git - libsigrok.git/blobdiff - src/log.c
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / log.c
index e12c8f4ccaa6a63186dfd6d4958047d676908a00..1b01afee3368df65c02e2c847e219c59d17c16b8 100644 (file)
--- a/src/log.c
+++ b/src/log.c
  * 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, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <stdarg.h>
 #include <stdio.h>
+#include <glib/gprintf.h>
 #include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
+/** @cond PRIVATE */
 #define LOG_PREFIX "log"
+/** @endcond */
 
 /**
  * @file
@@ -55,13 +58,6 @@ static sr_log_callback sr_log_cb = sr_logv;
  */
 static void *sr_log_cb_data = NULL;
 
-/* Log domain (a short string that is used as prefix for all messages). */
-/** @cond PRIVATE */
-#define LOGDOMAIN_MAXLEN 30
-#define LOGDOMAIN_DEFAULT "sr: "
-/** @endcond */
-static char sr_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT;
-
 /** @cond PRIVATE */
 #define LOGLEVEL_TIMESTAMP SR_LOG_DBG
 /** @endcond */
@@ -113,54 +109,6 @@ SR_API int sr_log_loglevel_get(void)
        return cur_loglevel;
 }
 
-/**
- * Set the libsigrok logdomain string.
- *
- * @param logdomain The string to use as logdomain for libsigrok log
- *                  messages from now on. Must not be NULL. The maximum
- *                  length of the string is 30 characters (this does not
- *                  include the trailing NUL-byte). Longer strings are
- *                  truncated.
- *                  In order to not use a logdomain, pass an empty string.
- *                  The function makes its own copy of the input string, i.e.
- *                  the caller does not need to keep it around.
- *
- * @retval SR_OK upon success.
- * @retval SR_ERR_ARG @a logdomain was NULL.
- * @retval SR_ERR @a logdomain was truncated.
- *
- * @since 0.1.0
- */
-SR_API int sr_log_logdomain_set(const char *logdomain)
-{
-       size_t len;
-
-       if (!logdomain) {
-               sr_err("%s: logdomain was NULL", __func__);
-               return SR_ERR_ARG;
-       }
-
-       len = g_strlcpy(sr_log_domain, logdomain, sizeof sr_log_domain);
-
-       sr_dbg("Log domain set to '%s'.", sr_log_domain);
-
-       return (len < sizeof sr_log_domain) ? SR_OK : SR_ERR;
-}
-
-/**
- * Get the currently configured libsigrok logdomain.
- *
- * @return A copy of the currently configured libsigrok logdomain
- *         string. The caller is responsible for g_free()ing the string when
- *         it is no longer needed.
- *
- * @since 0.1.0
- */
-SR_API char *sr_log_logdomain_get(void)
-{
-       return g_strdup(sr_log_domain);
-}
-
 /**
  * Set the libsigrok log callback to the specified function.
  *
@@ -212,18 +160,48 @@ SR_API int sr_log_callback_set_default(void)
        return SR_OK;
 }
 
+/**
+ * Get the libsigrok 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 SR_OK upon success.
+ *
+ * @since 0.6.0
+ */
+SR_API int sr_log_callback_get(sr_log_callback *cb, void **cb_data)
+{
+       if (cb)
+               *cb = sr_log_cb;
+       if (cb_data)
+               *cb_data = sr_log_cb_data;
+
+       return SR_OK;
+}
+
 static int sr_logv(void *cb_data, int loglevel, const char *format, va_list args)
 {
+       int ret;
        uint64_t elapsed_us, minutes;
        unsigned int rest_us, seconds, microseconds;
+       char *raw_output, *output, c;
+       ssize_t print_len;
+       size_t raw_len;
+       const char *raw_ptr;
+       char *out_ptr;
 
        /* This specific log callback doesn't need the void pointer data. */
        (void)cb_data;
 
-       /* Only output messages of at least the selected loglevel(s). */
-       if (loglevel > cur_loglevel)
-               return SR_OK;
+       (void)loglevel;
 
+       /* Prefix with 'sr:'. Optionally prefix with timestamp. */
+       ret = fputs("sr: ", stderr);
+       if (ret < 0)
+               return SR_ERR;
        if (cur_loglevel >= LOGLEVEL_TIMESTAMP) {
                elapsed_us = g_get_monotonic_time() - sr_log_start_time;
 
@@ -232,16 +210,42 @@ static int sr_logv(void *cb_data, int loglevel, const char *format, va_list args
                seconds = rest_us / G_TIME_SPAN_SECOND;
                microseconds = rest_us % G_TIME_SPAN_SECOND;
 
-               if (fprintf(stderr, "[%.2" PRIu64 ":%.2u.%.6u] ",
-                               minutes, seconds, microseconds) < 0)
+               ret = g_fprintf(stderr, "[%.2" PRIu64 ":%.2u.%.6u] ",
+                               minutes, seconds, microseconds);
+               if (ret < 0)
                        return SR_ERR;
        }
-       if (sr_log_domain[0] != '\0' && fputs(sr_log_domain, stderr) < 0)
-               return SR_ERR;
-       if (vfprintf(stderr, format, args) < 0)
+
+       /* Print the caller's message into a local buffer. */
+       raw_output = NULL;
+       print_len = g_vasprintf(&raw_output, format, args);
+       if (print_len < 0) {
+               g_free(raw_output);
                return SR_ERR;
-       if (putc('\n', stderr) < 0)
+       }
+       raw_len = (size_t)print_len;
+
+       /* Copy the string. Strip unwanted line breaks. */
+       output = g_malloc(raw_len + 1);
+       if (!output) {
+               g_free(raw_output);
                return SR_ERR;
+       }
+       out_ptr = output;
+       raw_ptr = raw_output;
+       while (*raw_ptr) {
+               c = *raw_ptr++;
+               if (c == '\r' || c == '\n')
+                       continue;
+               *out_ptr++ = c;
+       }
+       *out_ptr = '\0';
+       g_free(raw_output);
+
+       /* Print the trimmed output text. */
+       g_fprintf(stderr, "%s\n", output);
+       fflush(stderr);
+       g_free(output);
 
        return SR_OK;
 }
@@ -252,6 +256,14 @@ SR_PRIV int sr_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 SR_OK;
+
+       /* Silently succeed when no logging callback is registered. */
+       if (!sr_log_cb)
+               return SR_OK;
+
        va_start(args, format);
        ret = sr_log_cb(sr_log_cb_data, loglevel, format, args);
        va_end(args);