srd/cli/qt: Some more API consistency renames.

[libsigrokdecode.git] / controller.c

diff --git a/controller.c b/controller.c
index 4db4ee8543c174b4e09a85e5d577978fed599906..277897c546abecc7199c96972dffb1c54d30f214 100644 (file)
--- a/controller.c
+++ b/controller.c
@@ -119,8 +119,9 @@ SRD_API int srd_exit(void)
 {
        srd_dbg("Exiting libsigrokdecode.");
 
-       srd_decoders_unload_all();
+       srd_decoder_unload_all();
        g_slist_free(pd_list);
+       pd_list = NULL;
 
        /* Py_Finalize() returns void, any finalization errors are ignored. */
        Py_Finalize();
@@ -151,7 +152,7 @@ SRD_PRIV int add_modulepath(const char *path)
        wchar_t *wc_new_path;
        char *item;
 
-       srd_dbg("adding %s to module path", path);
+       srd_dbg("Adding '%s' to module path.", path);
 
        new_path = g_string_sized_new(256);
        g_string_assign(new_path, g_strdup(path));
@@ -197,7 +198,7 @@ SRD_PRIV int add_modulepath(const char *path)
 }
 
 /**
- * Set options in a decoder instance.
+ * Set one or more options in a decoder instance.
  *
  * Handled options are removed from the hash.
  *
@@ -206,8 +207,8 @@ SRD_PRIV int add_modulepath(const char *path)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
-                                GHashTable *options)
+SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
+                               GHashTable *options)
 {
        PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
        PyObject *py_optlist, *py_classval;
@@ -315,14 +316,17 @@ err_out:
        return ret;
 }
 
-/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probes_set() */
+/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */
 static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
 {
        return strcmp(a->id, probe_id);
 }
 
 /**
- * Set probes in a decoder instance.
+ * Set all probes in a decoder instance.
+ *
+ * This function sets _all_ probes for the specified decoder instance, i.e.,
+ * it overwrites any probes that were already defined (if any).
  *
  * @param di Decoder instance.
  * @param probes A GHashTable of probes to set. Key is probe name, value is
@@ -331,8 +335,8 @@ static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
-                               GHashTable *new_probes)
+SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
+                                  GHashTable *new_probes)
 {
        GList *l;
        GSList *sl;
@@ -456,7 +460,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
                return NULL;
        }
 
-       if (srd_inst_options_set(di, options) != SRD_OK) {
+       if (srd_inst_option_set(di, options) != SRD_OK) {
                g_free(di->dec_probemap);
                g_free(di);
                return NULL;
@@ -740,7 +744,7 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
 }
 
 /**
- * Feed a chunk of logic sample data to a running decoder session.
+ * Send a chunk of logic sample data to a running decoder session.
  *
  * @param start_samplenum The sample number of the first sample in this chunk.
  * @param inbuf Pointer to sample data.
@@ -748,7 +752,7 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_session_feed(uint64_t start_samplenum, const uint8_t *inbuf,
+SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
                             uint64_t inbuflen)
 {
        GSList *d;
@@ -768,7 +772,7 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, const uint8_t *inbuf,
 }
 
 /**
- * Register a decoder output callback function.
+ * Register/add a decoder output callback function.
  *
  * The function will be called when a protocol decoder sends output back
  * to the PD controller (except for Python objects, which only go up the
@@ -779,8 +783,8 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, const uint8_t *inbuf,
  * @param cb The function to call. Must not be NULL.
  * @param cb_data Private data for the callback function. Can be NULL.
  */
-SRD_API int srd_register_callback(int output_type,
-                                 srd_pd_output_callback_t cb, void *cb_data)
+SRD_API int srd_pd_output_callback_add(int output_type,
+                               srd_pd_output_callback_t cb, void *cb_data)
 {
        struct srd_pd_callback *pd_cb;
 
@@ -799,7 +803,7 @@ SRD_API int srd_register_callback(int output_type,
        return SRD_OK;
 }
 
-SRD_PRIV void *srd_find_callback(int output_type)
+SRD_PRIV void *srd_pd_output_callback_find(int output_type)
 {
        GSList *l;
        struct srd_pd_callback *pd_cb;