*/
#include "config.h"
-#include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "sigrokdecode-internal.h"
#include <dirent.h>
/* The list of protocol decoders. */
GSList *pd_list = NULL;
-GSList *di_list = NULL;
+
+/* lives in module_sigrokdecode.c */
+extern PyObject *mod_sigrokdecode;
/**
/**
- * TODO
+ * Load a protocol decoder module into the embedded Python interpreter.
*
- * @param name TODO
+ * @param name The module name to be loaded.
+ * @param dec Pointer to the struct srd_decoder filled with the loaded module.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
int srd_load_decoder(const char *name, struct srd_decoder **dec)
{
+ PyObject *py_basedec, *py_method, *py_annlist, *py_ann;
struct srd_decoder *d;
- PyObject *py_mod, *py_res;
- int r;
+ int alen, ret, i;
+ char **ann;
+
+ py_basedec = py_method = NULL;
- fprintf(stdout, "%s: %s\n", __func__, name);
+ srd_dbg("decoder: %s: loading module '%s'", __func__, name);
- /* "Import" the Python module. */
- if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
- PyErr_Print(); /* Returns void. */
- return SRD_ERR_PYTHON; /* TODO: More specific error? */
+ if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
+ srd_err("decoder: %s: d malloc failed", __func__);
+ ret = SRD_ERR_MALLOC;
+ goto err_out;
}
- /* Get the 'Decoder' class as Python object. */
- py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */
- if (!py_res) {
- if (PyErr_Occurred())
- PyErr_Print(); /* Returns void. */
- Py_XDECREF(py_mod);
- fprintf(stderr, "Decoder class not found in PD module %s\n", name);
- return SRD_ERR_PYTHON; /* TODO: More specific error? */
+ ret = SRD_ERR_PYTHON;
+
+ /* 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();
+ goto err_out;
}
- if (!(d = malloc(sizeof(struct srd_decoder))))
- return SRD_ERR_MALLOC;
+ /* 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);
+ goto err_out;
+ }
- if ((r = h_str(py_res, py_mod, "id", &(d->id))) < 0)
- return r;
+ if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
+ srd_dbg("sigrokdecode module not loaded");
+ goto err_out;
+ }
- if ((r = h_str(py_res, py_mod, "name", &(d->name))) < 0)
- return r;
+ 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);
+ goto err_out;
+ }
+ Py_DecRef(py_basedec);
- if ((r = h_str(py_res, py_mod, "longname",
- &(d->longname))) < 0)
- return r;
+ /* Check for a proper start() method. */
+ if (!PyObject_HasAttrString(d->py_dec, "start")) {
+ srd_err("Protocol decoder %s has no start() method Decoder "
+ "class.", name);
+ goto err_out;
+ }
+ py_method = PyObject_GetAttrString(d->py_dec, "start");
+ if (!PyFunction_Check(py_method)) {
+ srd_err("Protocol decoder %s Decoder class attribute 'start'"
+ "is not a method.", name);
+ goto err_out;
+ }
+ Py_DecRef(py_method);
- if ((r = h_str(py_res, py_mod, "desc", &(d->desc))) < 0)
- return r;
+ /* Check for a proper decode() method. */
+ if (!PyObject_HasAttrString(d->py_dec, "decode")) {
+ srd_err("Protocol decoder %s has no decode() method Decoder "
+ "class.", name);
+ goto err_out;
+ }
+ py_method = PyObject_GetAttrString(d->py_dec, "decode");
+ if (!PyFunction_Check(py_method)) {
+ srd_err("Protocol decoder %s Decoder class attribute 'decode' "
+ "is not a method.", name);
+ goto err_out;
+ }
+ Py_DecRef(py_method);
- if ((r = h_str(py_res, py_mod, "longdesc",
- &(d->longdesc))) < 0)
- return r;
+ if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
+ goto err_out;
- if ((r = h_str(py_res, py_mod, "author", &(d->author))) < 0)
- return r;
+ if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
+ goto err_out;
- if ((r = h_str(py_res, py_mod, "email", &(d->email))) < 0)
- return r;
+ if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
+ goto err_out;
- if ((r = h_str(py_res, py_mod, "license", &(d->license))) < 0)
- return r;
+ if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
+ goto err_out;
- d->py_mod = py_mod;
- d->py_decobj = py_res;
+ if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
+ goto err_out;
- /* TODO: Handle func, inputformats, outputformats. */
- /* Note: They must at least be set to NULL, will segfault otherwise. */
- d->func = NULL;
+ /* 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")) {
+ 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);
+ 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);
+ goto err_out;
+ }
+
+ if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
+ goto err_out;
+ }
+ d->annotations = g_slist_append(d->annotations, ann);
+ }
+ }
+
*dec = d;
+ ret = SRD_OK;
+
+err_out:
+ if (ret != SRD_OK) {
+ Py_XDECREF(py_method);
+ Py_XDECREF(py_basedec);
+ Py_XDECREF(d->py_dec);
+ Py_XDECREF(d->py_mod);
+ g_free(d);
+ }
- return SRD_OK;
+ return ret;
+}
+
+char *srd_decoder_doc(struct srd_decoder *dec)
+{
+ PyObject *py_str;
+ char *doc;
+
+ if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
+ return NULL;
+
+ if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
+ PyErr_Clear();
+ return NULL;
+ }
+
+ doc = NULL;
+ if (py_str != Py_None)
+ py_str_as_str(py_str, &doc);
+ Py_DecRef(py_str);
+
+ return doc;
}
/**
- * TODO
+ * Unload decoder module.
+ *
+ * @param dec The decoder struct to be unloaded.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
*/
int srd_unload_decoder(struct srd_decoder *dec)
{
+
g_free(dec->id);
g_free(dec->name);
+ g_free(dec->longname);
g_free(dec->desc);
- g_free(dec->func);
+ 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);
- Py_XDECREF(dec->py_decobj);
+ Py_XDECREF(dec->py_dec);
Py_XDECREF(dec->py_mod);
/* TODO: (g_)free dec itself? */
return SRD_OK;
}
-
int srd_load_all_decoders(void)
{
DIR *dir;
if (!g_str_has_suffix(dp->d_name, ".py"))
continue;
- /* Decoder name == filename (without .py suffix). */
+ /* 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(). */
return SRD_OK;
}
-
/**
* TODO
*/
projects / libsigrokdecode.git / blobdiff