constify srd_decoder_list() output

[libsigrokdecode.git] / decoder.c

diff --git a/decoder.c b/decoder.c
index f620c1efb03b114accc7893352c6e37604edd31a..cbca0b840376c60de504dcc1bd91cdd449c6bef4 100644 (file)
--- 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_decoders_list(void)
+SRD_API const GSList *srd_decoder_list(void)
 {
        return pd_list;
 }
@@ -53,7 +53,7 @@ SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
        GSList *l;
        struct srd_decoder *dec;
 
-       for (l = srd_decoders_list(); l; l = l->next) {
+       for (l = pd_list; l; l = l->next) {
                dec = l->data;
                if (!strcmp(dec->id, id))
                        return dec;
@@ -62,7 +62,8 @@ SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
        return NULL;
 }
 
-static int get_probes(struct srd_decoder *d, char *attr, GSList **pl)
+static int get_probes(const struct srd_decoder *d, const char *attr,
+                     GSList **pl)
 {
        PyObject *py_probelist, *py_entry;
        struct srd_probe *p;
@@ -123,7 +124,7 @@ err_out:
 /**
  * Load a protocol decoder module into the embedded Python interpreter.
  *
- * @param name The module name to be loaded.
+ * @param module_name The module name to be loaded.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
@@ -133,8 +134,10 @@ SRD_API int srd_decoder_load(const char *module_name)
        struct srd_decoder *d;
        int alen, ret, i;
        char **ann;
+       struct srd_probe *p;
+       GSList *l;
 
-       srd_dbg("Loading module '%s'.", module_name);
+       srd_dbg("Loading protocol decoder '%s'.", module_name);
 
        py_basedec = py_method = py_attr = NULL;
 
@@ -148,7 +151,7 @@ SRD_API int srd_decoder_load(const char *module_name)
 
        /* Import the Python module. */
        if (!(d->py_mod = PyImport_ImportModule(module_name))) {
-               catch_exception("Import of '%s' failed.", module_name);
+               srd_exception_catch("Import of '%s' failed.", module_name);
                goto err_out;
        }
 
@@ -221,6 +224,19 @@ SRD_API int srd_decoder_load(const char *module_name)
        if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
                goto err_out;
 
+       /*
+        * Fix order numbers for the optional probes.
+        *
+        * Example:
+        * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
+        * 'order' fields in the d->probes list = 0, 1, 2.
+        * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
+        */
+       for (l = d->opt_probes; l; l = l->next) {
+               p = l->data;
+               p->order += g_slist_length(d->probes);
+       }
+
        /* Store required fields in newly allocated strings. */
        if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
                goto err_out;
@@ -237,10 +253,6 @@ SRD_API int srd_decoder_load(const char *module_name)
        if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
                goto err_out;
 
-       /* TODO: Handle inputformats, outputformats. */
-       d->inputformats = NULL;
-       d->outputformats = NULL;
-
        /* Convert class annotation attribute to GSList of **char. */
        d->annotations = NULL;
        if (PyObject_HasAttrString(d->py_dec, "annotations")) {
@@ -292,7 +304,7 @@ err_out:
  * @return A newly allocated buffer containing the protocol decoder's
  *         documentation. The caller is responsible for free'ing the buffer.
  */
-SRD_API char *srd_decoder_doc(const struct srd_decoder *dec)
+SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
 {
        PyObject *py_str;
        char *doc;
@@ -301,7 +313,7 @@ SRD_API char *srd_decoder_doc(const struct srd_decoder *dec)
                return NULL;
 
        if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
-               catch_exception("");
+               srd_exception_catch("");
                return NULL;
        }
 
@@ -340,7 +352,7 @@ static void free_probes(GSList *probelist)
  */
 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 {
-       srd_dbg("Unloading decoder '%s'.", dec->name);
+       srd_dbg("Unloading protocol decoder '%s'.", dec->name);
 
        /*
         * Since any instances of this decoder need to be released as well,
@@ -358,12 +370,6 @@ SRD_API int srd_decoder_unload(struct srd_decoder *dec)
        g_free(dec->desc);
        g_free(dec->license);
 
-       /* TODO: Free everything in inputformats and outputformats. */
-       if (dec->inputformats != NULL)
-               g_slist_free(dec->inputformats);
-       if (dec->outputformats != NULL)
-               g_slist_free(dec->outputformats);
-
        /* The module's Decoder class. */
        Py_XDECREF(dec->py_dec);
        /* The module itself. */
@@ -379,7 +385,7 @@ SRD_API int srd_decoder_unload(struct srd_decoder *dec)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_decoders_load_all(void)
+SRD_API int srd_decoder_load_all(void)
 {
        GDir *dir;
        GError *error;
@@ -404,12 +410,12 @@ SRD_API int srd_decoders_load_all(void)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_decoders_unload_all(void)
+SRD_API int srd_decoder_unload_all(void)
 {
        GSList *l;
        struct srd_decoder *dec;
 
-       for (l = srd_decoders_list(); l; l = l->next) {
+       for (l = pd_list; l; l = l->next) {
                dec = l->data;
                srd_decoder_unload(dec);
        }