From: Uwe Hermann <redacted>
Date: Sat, 11 Feb 2012 21:09:18 +0000 (+0100)
Subject: Rename 'void *' callback parameters to 'user_data'.
X-Git-Tag: libsigrokdecode-0.1.0~52
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=e09023b9dc8f1d6783a3bf6b05402a88060a795f;p=libsigrokdecode.git

Rename 'void *' callback parameters to 'user_data'.

This is better, both for consistency reasons, and also because 'data' is
a bit too generic and might be confusing, especially since we have other
'data' fields in the code in various places.
---

diff --git a/controller.c b/controller.c
index 6e6e435..3c50d8a 100644
--- a/controller.c
+++ b/controller.c
@@ -693,7 +693,7 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf,
 }
 
 SRD_API int srd_register_callback(int output_type,
-				  srd_pd_output_callback_t cb, void *data)
+				  srd_pd_output_callback_t cb, void *user_data)
 {
 	struct srd_pd_callback *pd_cb;
 
@@ -706,7 +706,7 @@ SRD_API int srd_register_callback(int output_type,
 
 	pd_cb->output_type = output_type;
 	pd_cb->callback = cb;
-	pd_cb->data = data;
+	pd_cb->user_data = user_data;
 	callbacks = g_slist_append(callbacks, pd_cb);
 
 	return SRD_OK;
diff --git a/log.c b/log.c
index 97fde91..5693abf 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;
@@ -127,24 +128,25 @@ 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;
 }
@@ -168,12 +170,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)
diff --git a/sigrokdecode.h b/sigrokdecode.h
index 18ab513..2728d72 100644
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -174,12 +174,12 @@ struct srd_proto_data {
 };
 
 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
-					 void *data);
+					 void *user_data);
 
 struct srd_pd_callback {
 	int output_type;
 	srd_pd_output_callback_t callback;
-	void *data;
+	void *user_data;
 };
 
 /* custom python types */
@@ -225,7 +225,7 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
 			     uint64_t inbuflen);
 SRD_API struct srd_decoder_inst *get_di_by_decobject(void *decobject);
 SRD_API int srd_register_callback(int output_type,
-				  srd_pd_output_callback_t cb, void *data);
+				  srd_pd_output_callback_t cb, void *user_data);
 SRD_API void *srd_find_callback(int output_type);
 
 /*--- decoder.c -------------------------------------------------------------*/
@@ -240,12 +240,12 @@ SRD_API char *srd_decoder_doc(struct srd_decoder *dec);
 
 /*--- log.c -----------------------------------------------------------------*/
 
-typedef int (*srd_log_handler_t)(void *data, int loglevel, const char *format,
-				 va_list args);
+typedef int (*srd_log_handler_t)(void *user_data, int loglevel,
+				 const char *format, va_list args);
 
 SRD_API int srd_log_loglevel_set(int loglevel);
 SRD_API int srd_log_loglevel_get(void);
-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);
 SRD_API int srd_log_handler_set_default(void);
 SRD_API int srd_log_logdomain_set(const char *logdomain);
 SRD_API char *srd_log_logdomain_get(void);