X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=log.c;h=d8e98ba2b692f99f6e272a45b4546f552076194c;hp=a5e590beae3e3cd0698b6a22f2993d961566e11b;hb=4c1d067068fdb9e5f723b3548bddb64e0b06fc36;hpb=41106a07486f46de5dac2fd55233691172d4fe59

diff --git a/log.c b/log.c
index a5e590b..d8e98ba 100644
--- a/log.c
+++ b/log.c
@@ -27,7 +27,8 @@
 static int srd_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */
 
 /* Function prototype. */
-static int srd_logv(void *data, int loglevel, const char *format, va_list args);
+static int srd_logv(void *user_data, int loglevel, const char *format,
+		    va_list args);
 
 /* Pointer to the currently selected log handler. Default: srd_logv(). */
 static srd_log_handler_t srd_log_handler = srd_logv;
@@ -56,9 +57,10 @@ static char srd_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT;
  *
  * @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.
  */
-int srd_log_loglevel_set(int loglevel)
+SRD_API int srd_log_loglevel_set(int loglevel)
 {
 	if (loglevel < SRD_LOG_NONE || loglevel > SRD_LOG_SPEW) {
 		srd_err("Invalid loglevel %d.", loglevel);
@@ -77,7 +79,7 @@ int srd_log_loglevel_set(int loglevel)
  *
  * @return The currently configured libsigrokdecode loglevel.
  */
-int srd_log_loglevel_get(void)
+SRD_API int srd_log_loglevel_get(void)
 {
 	return srd_loglevel;
 }
@@ -93,9 +95,10 @@ int srd_log_loglevel_get(void)
  *                  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.
+ *
  * @return SRD_OK upon success, SRD_ERR_ARG upon invalid logdomain.
  */
-int srd_log_logdomain_set(const char *logdomain)
+SRD_API int srd_log_logdomain_set(const char *logdomain)
 {
 	if (!logdomain) {
 		srd_err("log: %s: logdomain was NULL", __func__);
@@ -117,7 +120,7 @@ int srd_log_logdomain_set(const char *logdomain)
  *         string. The caller is responsible for g_free()ing the string when
  *         it is no longer needed.
  */
-char *srd_log_logdomain_get(void)
+SRD_API char *srd_log_logdomain_get(void)
 {
 	return g_strdup((const char *)&srd_log_domain);
 }
@@ -127,24 +130,26 @@ char *srd_log_logdomain_get(void)
  *
  * @param handler Function pointer to the log handler function to use.
  *                Must not be NULL.
- * @param 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.
+ * @param user_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.
  */
-int srd_log_handler_set(srd_log_handler_t handler, void *data)
+SRD_API int srd_log_handler_set(srd_log_handler_t handler, void *user_data)
 {
 	if (!handler) {
 		srd_err("log: %s: handler was NULL", __func__);
 		return SRD_ERR_ARG;
 	}
 
-	/* Note: 'data' is allowed to be NULL. */
+	/* Note: 'user_data' is allowed to be NULL. */
 
 	srd_log_handler = handler;
-	srd_log_handler_data = data;
+	srd_log_handler_data = user_data;
 
 	return SRD_OK;
 }
@@ -154,9 +159,9 @@ int srd_log_handler_set(srd_log_handler_t handler, void *data)
  *
  * Additionally, the internal 'srd_log_handler_data' pointer is set to NULL.
  *
- * @return SRD_OK upon success, a negative error code otherwise.
+ * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-int srd_log_handler_set_default(void)
+SRD_API int srd_log_handler_set_default(void)
 {
 	/*
 	 * Note: No log output in this function, as it should safely work
@@ -168,12 +173,13 @@ int srd_log_handler_set_default(void)
 	return SRD_OK;
 }
 
-static int srd_logv(void *data, int loglevel, const char *format, va_list args)
+static int srd_logv(void *user_data, int loglevel, const char *format,
+		    va_list args)
 {
 	int ret;
 
 	/* This specific log handler doesn't need the void pointer data. */
-	(void)data;
+	(void)user_data;
 
 	/* Only output messages of at least the selected loglevel(s). */
 	if (loglevel > srd_loglevel)
@@ -187,7 +193,7 @@ static int srd_logv(void *data, int loglevel, const char *format, va_list args)
 	return ret;
 }
 
-int srd_log(int loglevel, const char *format, ...)
+SRD_PRIV int srd_log(int loglevel, const char *format, ...)
 {
 	int ret;
 	va_list args;
@@ -199,7 +205,7 @@ int srd_log(int loglevel, const char *format, ...)
 	return ret;
 }
 
-int srd_spew(const char *format, ...)
+SRD_PRIV int srd_spew(const char *format, ...)
 {
 	int ret;
 	va_list args;
@@ -211,7 +217,7 @@ int srd_spew(const char *format, ...)
 	return ret;
 }
 
-int srd_dbg(const char *format, ...)
+SRD_PRIV int srd_dbg(const char *format, ...)
 {
 	int ret;
 	va_list args;
@@ -223,7 +229,7 @@ int srd_dbg(const char *format, ...)
 	return ret;
 }
 
-int srd_info(const char *format, ...)
+SRD_PRIV int srd_info(const char *format, ...)
 {
 	int ret;
 	va_list args;
@@ -235,7 +241,7 @@ int srd_info(const char *format, ...)
 	return ret;
 }
 
-int srd_warn(const char *format, ...)
+SRD_PRIV int srd_warn(const char *format, ...)
 {
 	int ret;
 	va_list args;
@@ -247,7 +253,7 @@ int srd_warn(const char *format, ...)
 	return ret;
 }
 
-int srd_err(const char *format, ...)
+SRD_PRIV int srd_err(const char *format, ...)
 {
 	int ret;
 	va_list args;