srd: SRD_PACKAGE_VERSION_* for consistency.

[libsigrokdecode.git] / controller.c

diff --git a/controller.c b/controller.c
index 565bc0ae19afeb665895770c909cc23e654a47a2..8a01d32e6d570968fff5177c012a3ab481830c0f 100644 (file)
--- a/controller.c
+++ b/controller.c
@@ -79,14 +79,14 @@ SRD_API int srd_init(const char *path)
        Py_Initialize();
 
        /* Installed decoders. */
-       if ((ret = add_modulepath(DECODERS_DIR)) != SRD_OK) {
+       if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
                Py_Finalize();
                return ret;
        }
 
        /* Path specified by the user. */
        if (path) {
-               if ((ret = add_modulepath(path)) != SRD_OK) {
+               if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) {
                        Py_Finalize();
                        return ret;
                }
@@ -94,7 +94,7 @@ SRD_API int srd_init(const char *path)
 
        /* Environment variable overrides everything, for debugging. */
        if ((env_path = getenv("SIGROKDECODE_DIR"))) {
-               if ((ret = add_modulepath(env_path)) != SRD_OK) {
+               if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
                        Py_Finalize();
                        return ret;
                }
@@ -144,7 +144,7 @@ SRD_API int srd_exit(void)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_PRIV int add_modulepath(const char *path)
+SRD_PRIV int srd_decoder_searchpath_add(const char *path)
 {
        PyObject *py_cur_path, *py_item;
        GString *new_path;
@@ -198,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.
  *
@@ -207,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;
@@ -311,19 +311,22 @@ err_out:
        Py_XDECREF(py_dec_options);
        g_free(key);
        if (PyErr_Occurred())
-               catch_exception("Stray exception in srd_inst_set_options().");
+               srd_exception_catch("Stray exception in srd_inst_option_set().");
 
        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
@@ -332,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;
@@ -450,14 +453,14 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
        /* Create a new instance of this decoder class. */
        if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
                if (PyErr_Occurred())
-                       catch_exception("failed to create %s instance: ",
-                                       decoder_id);
+                       srd_exception_catch("failed to create %s instance: ",
+                                           decoder_id);
                g_free(di->dec_probemap);
                g_free(di);
                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;
@@ -566,15 +569,15 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
 
        if (!(py_name = PyUnicode_FromString("start"))) {
                srd_err("Unable to build Python object for 'start'.");
-               catch_exception("Protocol decoder instance %s: ",
-                               di->inst_id);
+               srd_exception_catch("Protocol decoder instance %s: ",
+                                   di->inst_id);
                return SRD_ERR_PYTHON;
        }
 
        if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
                                                  py_name, args, NULL))) {
-               catch_exception("Protocol decoder instance %s: ",
-                               di->inst_id);
+               srd_exception_catch("Protocol decoder instance %s: ",
+                                   di->inst_id);
                return SRD_ERR_PYTHON;
        }
 
@@ -649,8 +652,8 @@ SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
        if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
                                           "KKO", logic->start_samplenum,
                                           end_samplenum, logic))) {
-               catch_exception("Protocol decoder instance %s: ",
-                               di->inst_id);
+               srd_exception_catch("Protocol decoder instance %s: ",
+                                   di->inst_id);
                return SRD_ERR_PYTHON; /* TODO: More specific error? */
        }
        Py_DecRef(py_res);
@@ -769,7 +772,7 @@ SRD_API int srd_session_send(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
@@ -780,8 +783,8 @@ SRD_API int srd_session_send(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;
 
@@ -800,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;
@@ -819,8 +822,8 @@ SRD_PRIV void *srd_find_callback(int output_type)
 }
 
 /* This is the backend function to Python sigrokdecode.add() call. */
-SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type,
-                   const char *proto_id)
+SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
+                                   int output_type, const char *proto_id)
 {
        struct srd_pd_output *pdo;