srd: make all debugging and error reporting uniform

[libsigrokdecode.git] / decoder.c

diff --git a/decoder.c b/decoder.c
index 5b9223c630812599548e0dcebfeac1a5104161b0..a5c5e53fb00162809f490aaa4213926acea3c3f4 100644 (file)
--- a/decoder.c
+++ b/decoder.c
@@ -65,6 +65,63 @@ struct srd_decoder *srd_get_decoder_by_id(const char *id)
 }
 
 
+static int get_probes(struct srd_decoder *d, char *attr, GSList **pl)
+{
+       PyObject *py_probelist, *py_entry;
+       struct srd_probe *p;
+       int ret, num_probes, i;
+
+       if (!PyObject_HasAttrString(d->py_dec, attr))
+               /* No probes of this type specified. */
+               return SRD_OK;
+
+       ret = SRD_ERR_PYTHON;
+       py_probelist = py_entry = NULL;
+
+       py_probelist = PyObject_GetAttrString(d->py_dec, attr);
+       if (!PyList_Check(py_probelist)) {
+               srd_err("Protocol decoder %s %s attribute is not "
+                               "a list.", d->name, attr);
+               goto err_out;
+       }
+
+       num_probes = PyList_Size(py_probelist);
+       if (num_probes == 0)
+               /* Empty probelist. */
+               return SRD_OK;
+
+       for (i = 0; i < num_probes; i++) {
+               py_entry = PyList_GetItem(py_probelist, i);
+               if (!PyDict_Check(py_entry)) {
+                       srd_err("Protocol decoder %s %s attribute is not "
+                                       "a list with dict elements.", d->name, attr);
+                       goto err_out;
+               }
+
+               if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
+                       ret = SRD_ERR_MALLOC;
+                       goto err_out;
+               }
+
+               if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
+                       goto err_out;
+               if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
+                       goto err_out;
+               if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
+                       goto err_out;
+               p->order = i;
+
+               *pl = g_slist_append(*pl, p);
+       }
+       ret = SRD_OK;
+
+err_out:
+       Py_DecRef(py_entry);
+       Py_DecRef(py_probelist);
+
+       return ret;
+}
+
 /**
  * Load a protocol decoder module into the embedded Python interpreter.
  *
@@ -80,12 +137,12 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
        int alen, ret, i;
        char **ann;
 
-       py_basedec = py_method = py_attr = NULL;
+       srd_dbg("srd: loading module '%s'", name);
 
-       srd_dbg("decoder: %s: loading module '%s'", __func__, name);
+       py_basedec = py_method = py_attr = NULL;
 
        if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
-               srd_err("decoder: %s: d malloc failed", __func__);
+               srd_dbg("srd: Failed to malloc struct srd_decoder");
                ret = SRD_ERR_MALLOC;
                goto err_out;
        }
@@ -95,7 +152,7 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
        /* Import the Python module. */
        if (!(d->py_mod = PyImport_ImportModule(name))) {
                /* TODO: Report exception message/traceback to err/dbg. */
-               srd_warn("decoder: %s: import of '%s' failed", __func__, name);
+               srd_warn("srd: import of '%s' failed.", name);
                PyErr_Print();
                PyErr_Clear();
                goto err_out;
@@ -106,18 +163,18 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
                /* This generated an AttributeError exception. */
                PyErr_Print();
                PyErr_Clear();
-               srd_err("Decoder class not found in protocol decoder %s", name);
+               srd_err("Decoder class not found in protocol decoder %s.", name);
                goto err_out;
        }
 
        if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
-               srd_dbg("sigrokdecode module not loaded");
+               srd_dbg("srd: sigrokdecode module not loaded");
                goto err_out;
        }
 
        if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
                srd_err("Decoder class in protocol decoder module %s is not "
-                               "a subclass of sigrokdecode.Decoder", name);
+                               "a subclass of sigrokdecode.Decoder.", name);
                goto err_out;
        }
        Py_DecRef(py_basedec);
@@ -130,7 +187,7 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
        }
        py_method = PyObject_GetAttrString(d->py_dec, "start");
        if (!PyFunction_Check(py_method)) {
-               srd_err("Protocol decoder %s Decoder class attribute 'start'"
+               srd_err("Protocol decoder %s Decoder class attribute 'start' "
                                "is not a method.", name);
                goto err_out;
        }
@@ -161,6 +218,15 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
                Py_DecRef(py_attr);
        }
 
+       /* Check and import required probes. */
+       if (get_probes(d, "probes", &d->probes) != SRD_OK)
+               goto err_out;
+
+       /* Check and import optional probes. */
+       if (get_probes(d, "extra_probes", &d->extra_probes) != SRD_OK)
+               goto err_out;
+
+       /* Store required fields in newly allocated strings. */
        if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
                goto err_out;
 
@@ -185,15 +251,15 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
        if (PyObject_HasAttrString(d->py_dec, "annotations")) {
                py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
                if (!PyList_Check(py_annlist)) {
-                       srd_err("Protocol decoder module %s annotations should be a list", name);
+                       srd_err("Protocol decoder module %s annotations should be a list.", name);
                        goto err_out;
                }
                alen = PyList_Size(py_annlist);
                for (i = 0; i < alen; i++) {
                        py_ann = PyList_GetItem(py_annlist, i);
                        if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
-                               srd_err("Protocol decoder module %s annotation %d should be a list with two elements",
-                                               name, i+1);
+                               srd_err("Protocol decoder module %s annotation %d should "
+                                               "be a list with two elements.", name, i+1);
                                goto err_out;
                        }