]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoder.c
srd: removed stray malloc()
[libsigrokdecode.git] / decoder.c
index 7dd1e968da23c88e0d936f4f31217d13b24635c1..efb1f9ae4bdd8b2ac827a2aec123455178cf53aa 100644 (file)
--- a/decoder.c
+++ b/decoder.c
@@ -2,7 +2,7 @@
  * This file is part of the sigrok project.
  *
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
- * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -21,7 +21,7 @@
 #include "config.h"
 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
 #include "sigrokdecode-internal.h"
-#include <dirent.h>
+#include <glib.h>
 
 /* The list of protocol decoders. */
 GSList *pd_list = NULL;
@@ -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.
  *
@@ -75,17 +132,17 @@ struct srd_decoder *srd_get_decoder_by_id(const char *id)
  */
 int srd_load_decoder(const char *name, struct srd_decoder **dec)
 {
-       PyObject *py_basedec, *py_method, *py_annlist, *py_ann;
+       PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
        struct srd_decoder *d;
        int alen, ret, i;
        char **ann;
 
-       py_basedec = py_method = NULL;
+       srd_dbg("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("Failed to malloc struct srd_decoder.");
                ret = SRD_ERR_MALLOC;
                goto err_out;
        }
@@ -94,33 +151,29 @@ 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);
-               PyErr_Print();
-               PyErr_Clear();
+               catch_exception("import of '%s' failed.", name);
                goto err_out;
        }
 
        /* Get the 'Decoder' class as Python object. */
        if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
                /* 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("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);
+       Py_CLEAR(py_basedec);
 
        /* Check for a proper start() method. */
        if (!PyObject_HasAttrString(d->py_dec, "start")) {
@@ -130,11 +183,11 @@ 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;
        }
-       Py_DecRef(py_method);
+       Py_CLEAR(py_method);
 
        /* Check for a proper decode() method. */
        if (!PyObject_HasAttrString(d->py_dec, "decode")) {
@@ -148,8 +201,29 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
                                "is not a method.", name);
                goto err_out;
        }
-       Py_DecRef(py_method);
+       Py_CLEAR(py_method);
+
+       /* If present, options must be a dictionary. */
+       if (PyObject_HasAttrString(d->py_dec, "options")) {
+               py_attr = PyObject_GetAttrString(d->py_dec, "options");
+               if (!PyDict_Check(py_attr)) {
+                       srd_err("Protocol decoder %s options attribute is not "
+                                       "a dictionary.", d->name);
+                       Py_DecRef(py_attr);
+                       goto err_out;
+               }
+               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;
 
@@ -174,15 +248,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;
                        }
 
@@ -217,7 +291,7 @@ char *srd_decoder_doc(struct srd_decoder *dec)
                return NULL;
 
        if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
-               PyErr_Clear();
+               catch_exception("");
                return NULL;
        }
 
@@ -262,39 +336,27 @@ int srd_unload_decoder(struct srd_decoder *dec)
 
 int srd_load_all_decoders(void)
 {
-       DIR *dir;
-       struct dirent *dp;
+       GDir *dir;
+       GError *error;
+       struct srd_decoder *dec;
        int ret;
+       const gchar *direntry;
        char *decodername;
-       struct srd_decoder *dec;
 
-       if (!(dir = opendir(DECODERS_DIR))) {
-               Py_Finalize(); /* Returns void. */
+       if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
                return SRD_ERR_DECODERS_DIR;
        }
 
-       while ((dp = readdir(dir)) != NULL) {
-               /* Ignore filenames which don't end with ".py". */
-               if (!g_str_has_suffix(dp->d_name, ".py"))
-                       continue;
-
+       while ((direntry = g_dir_read_name(dir)) != NULL) {
                /* The decoder name is the PD directory name (e.g. "i2c"). */
-               decodername = g_strndup(dp->d_name, strlen(dp->d_name) - 3);
-
-               /* TODO: Error handling. Use g_try_malloc(). */
-               if (!(dec = malloc(sizeof(struct srd_decoder)))) {
-                       Py_Finalize(); /* Returns void. */
-                       return SRD_ERR_MALLOC;
-               }
+               decodername = g_strdup(direntry);
 
-               /* Load the decoder. */
-               /* TODO: Warning if loading fails for a decoder. */
                if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) {
                        /* Append it to the list of supported/loaded decoders. */
                        pd_list = g_slist_append(pd_list, dec);
                }
        }
-       closedir(dir);
+       g_dir_close(dir);
 
        return SRD_OK;
 }
@@ -309,7 +371,6 @@ int srd_unload_all_decoders(void)
 
        for (l = srd_list_decoders(); l; l = l->next) {
                dec = l->data;
-               /* TODO: Error handling. */
                srd_unload_decoder(dec);
        }