/**
- * Load a protocol decoder module into the embedded python interpreter.
+ * Load a protocol decoder module into the embedded Python interpreter.
*
* @param name The module name to be loaded.
* @param dec Pointer to the struct srd_decoder filled with the loaded module.
*/
int srd_load_decoder(const char *name, struct srd_decoder **dec)
{
- PyObject *py_basedec, *py_annlist, *py_ann;
+ PyObject *py_basedec, *py_method, *py_annlist, *py_ann;
struct srd_decoder *d;
int alen, ret, i;
char **ann;
- py_basedec = NULL;
- ret = SRD_ERR;
- srd_dbg("loading module %s", name);
+ py_basedec = py_method = NULL;
+
+ srd_dbg("decoder: %s: loading module '%s'", __func__, name);
if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
+ srd_err("decoder: %s: d malloc failed", __func__);
ret = SRD_ERR_MALLOC;
goto err_out;
}
+ ret = SRD_ERR_PYTHON;
+
/* Import the Python module. */
if (!(d->py_mod = PyImport_ImportModule(name))) {
- /* TODO: report exception message/traceback to err/dbg */
- srd_dbg("import failed");
+ /* TODO: Report exception message/traceback to err/dbg. */
+ srd_warn("decoder: %s: import of '%s' failed", __func__, name);
+ PyErr_Print();
PyErr_Clear();
- ret = SRD_ERR_PYTHON;
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 module %s", name);
- ret = SRD_ERR_PYTHON;
+ 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");
- ret = SRD_ERR_PYTHON;
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);
- ret = SRD_ERR_PYTHON;
goto err_out;
}
Py_DecRef(py_basedec);
- if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) {
- return SRD_ERR_PYTHON;
+ /* 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;
}
-
- if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK) {
- return SRD_ERR_PYTHON;
+ 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 (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK) {
- return SRD_ERR_PYTHON;
+ /* 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;
}
-
- if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK) {
- return SRD_ERR_PYTHON;
+ 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 (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) {
- return SRD_ERR_PYTHON;
+ if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
+ goto err_out;
+
+ if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
+ goto err_out;
+
+ if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
+ goto err_out;
+
+ if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
+ goto err_out;
+
+ if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
goto err_out;
- }
/* TODO: Handle inputformats, outputformats. */
d->inputformats = NULL;
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);
- ret = SRD_ERR_PYTHON;
goto err_out;
}
alen = PyList_Size(py_annlist);
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);
- ret = SRD_ERR_PYTHON;
goto err_out;
}
if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
- ret = SRD_ERR_PYTHON;
goto err_out;
}
d->annotations = g_slist_append(d->annotations, ann);
err_out:
if (ret != SRD_OK) {
+ Py_XDECREF(py_method);
Py_XDECREF(py_basedec);
Py_XDECREF(d->py_dec);
Py_XDECREF(d->py_mod);
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;
- py_attr_as_str(dec->py_mod, "__doc__", &doc);
+ if (py_str != Py_None)
+ py_str_as_str(py_str, &doc);
+ Py_DecRef(py_str);
return doc;
}
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
*/