X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=log.c;h=d8e98ba2b692f99f6e272a45b4546f552076194c;hp=97fde915bfc3c412527a2541026be52dfdb41aa3;hb=4c1d067068fdb9e5f723b3548bddb64e0b06fc36;hpb=55c3c5f4b9d38b85fae2c39a8a6150b4c50b1bdb diff --git a/log.c b/log.c index 97fde91..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,6 +57,7 @@ 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. */ SRD_API int srd_log_loglevel_set(int loglevel) @@ -93,6 +95,7 @@ SRD_API 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. */ SRD_API int srd_log_logdomain_set(const char *logdomain) @@ -127,24 +130,26 @@ SRD_API 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. */ -SRD_API 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,7 +159,7 @@ SRD_API 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. */ SRD_API int srd_log_handler_set_default(void) { @@ -168,12 +173,13 @@ SRD_API 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)