From: Bert Vermeulen <redacted>
Date: Tue, 14 Feb 2012 02:43:28 +0000 (+0100)
Subject: srd: rename public API functions to srd_thing_action format
X-Git-Tag: libsigrokdecode-0.1.0~46
X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=commitdiff_plain;h=9d122fd5d66aa178547ec4222ab5f526f8a14cf7

srd: rename public API functions to srd_thing_action format
---

diff --git a/controller.c b/controller.c
index 64d4416..e169a51 100644
--- a/controller.c
+++ b/controller.c
@@ -49,7 +49,7 @@ extern SRD_PRIV PyTypeObject srd_logic_type;
  * Then, it searches for sigrok protocol decoder files (*.py) in the
  * "decoders" subdirectory of the the sigrok installation directory.
  * All decoders that are found are loaded into memory and added to an
- * internal list of decoders, which can be queried via srd_list_decoders().
+ * internal list of decoders, which can be queried via srd_decoders_list().
  *
  * The caller is responsible for calling the clean-up function srd_exit(),
  * which will properly shut down libsigrokdecode and free its allocated memory.
@@ -119,7 +119,7 @@ SRD_API int srd_exit(void)
 {
 	srd_dbg("Exiting libsigrokdecode.");
 
-	srd_unload_all_decoders();
+	srd_decoders_unload_all();
 	g_slist_free(pd_list);
 
 	/* Py_Finalize() returns void, any finalization errors are ignored. */
@@ -206,7 +206,7 @@ SRD_PRIV int add_modulepath(const char *path)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_inst_set_options(struct srd_decoder_inst *di,
+SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
 				     GHashTable *options)
 {
 	PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
@@ -314,7 +314,7 @@ err_out:
 	return ret;
 }
 
-/* Helper GComparefunc for g_slist_find_custom() in srd_inst_set_probes() */
+/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probes_set() */
 static gint compare_probe_id(struct srd_probe *a, char *probe_id)
 {
 	return strcmp(a->id, probe_id);
@@ -330,7 +330,7 @@ static gint compare_probe_id(struct srd_probe *a, char *probe_id)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
+SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
 				    GHashTable *new_probes)
 {
 	GList *l;
@@ -413,7 +413,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
 
 	srd_dbg("Creating new %s instance.", decoder_id);
 
-	if (!(dec = srd_get_decoder_by_id(decoder_id))) {
+	if (!(dec = srd_decoder_get_by_id(decoder_id))) {
 		srd_err("Protocol decoder %s not found.", decoder_id);
 		return NULL;
 	}
@@ -454,7 +454,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
 		return NULL;
 	}
 
-	if (srd_inst_set_options(di, options) != SRD_OK) {
+	if (srd_inst_options_set(di, options) != SRD_OK) {
 		g_free(di->dec_probemap);
 		g_free(di);
 		return NULL;
diff --git a/decoder.c b/decoder.c
index 33521c4..365e906 100644
--- a/decoder.c
+++ b/decoder.c
@@ -36,7 +36,7 @@ extern SRD_PRIV PyObject *mod_sigrokdecode;
  *
  * @return List of decoders, NULL if none are supported or loaded.
  */
-SRD_API GSList *srd_list_decoders(void)
+SRD_API GSList *srd_decoders_list(void)
 {
 	return pd_list;
 }
@@ -48,12 +48,12 @@ SRD_API GSList *srd_list_decoders(void)
  *
  * @return The decoder with the specified ID, or NULL if not found.
  */
-SRD_API struct srd_decoder *srd_get_decoder_by_id(const char *id)
+SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
 {
 	GSList *l;
 	struct srd_decoder *dec;
 
-	for (l = srd_list_decoders(); l; l = l->next) {
+	for (l = srd_decoders_list(); l; l = l->next) {
 		dec = l->data;
 		if (!strcmp(dec->id, id))
 			return dec;
@@ -127,7 +127,7 @@ err_out:
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_load_decoder(const char *module_name)
+SRD_API int srd_decoder_load(const char *module_name)
 {
 	PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
 	struct srd_decoder *d;
@@ -338,7 +338,7 @@ static void free_probes(GSList *probelist)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_unload_decoder(struct srd_decoder *dec)
+SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 {
 	srd_dbg("unloading decoder %s", dec->name);
 
@@ -377,7 +377,7 @@ SRD_API int srd_unload_decoder(struct srd_decoder *dec)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_load_all_decoders(void)
+SRD_API int srd_decoders_load_all(void)
 {
 	GDir *dir;
 	GError *error;
@@ -390,7 +390,7 @@ SRD_API int srd_load_all_decoders(void)
 
 	while ((direntry = g_dir_read_name(dir)) != NULL) {
 		/* The directory name is the module name (e.g. "i2c"). */
-		srd_load_decoder(direntry);
+		srd_decoder_load(direntry);
 	}
 	g_dir_close(dir);
 
@@ -402,14 +402,14 @@ SRD_API int srd_load_all_decoders(void)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_unload_all_decoders(void)
+SRD_API int srd_decoders_unload_all(void)
 {
 	GSList *l;
 	struct srd_decoder *dec;
 
-	for (l = srd_list_decoders(); l; l = l->next) {
+	for (l = srd_decoders_list(); l; l = l->next) {
 		dec = l->data;
-		srd_unload_decoder(dec);
+		srd_decoder_unload(dec);
 	}
 
 	return SRD_OK;
diff --git a/sigrokdecode.h b/sigrokdecode.h
index 4e65ed2..649cdc6 100644
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -201,9 +201,9 @@ typedef struct {
 
 SRD_API int srd_init(char *path);
 SRD_API int srd_exit(void);
-SRD_API int srd_inst_set_options(struct srd_decoder_inst *di,
+SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
 				     GHashTable *options);
-SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
+SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
 				    GHashTable *probes);
 SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
 						      GHashTable *options);
@@ -214,18 +214,17 @@ SRD_API int srd_session_start(int num_probes, int unitsize,
 			      uint64_t samplerate);
 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 *user_data);
 
 /*--- decoder.c -------------------------------------------------------------*/
 
-SRD_API GSList *srd_list_decoders(void);
-SRD_API struct srd_decoder *srd_get_decoder_by_id(const char *id);
-SRD_API int srd_load_decoder(const char *name);
-SRD_API int srd_unload_decoder(struct srd_decoder *dec);
-SRD_API int srd_load_all_decoders(void);
-SRD_API int srd_unload_all_decoders(void);
+SRD_API GSList *srd_decoders_list(void);
+SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
+SRD_API int srd_decoder_load(const char *name);
+SRD_API int srd_decoder_unload(struct srd_decoder *dec);
+SRD_API int srd_decoders_load_all(void);
+SRD_API int srd_decoders_unload_all(void);
 SRD_API char *srd_decoder_doc(struct srd_decoder *dec);
 
 /*--- log.c -----------------------------------------------------------------*/