X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=d29a6d6a9472208673ca0ec27ed03428638d8239;hp=65d05d01ef9b4b3babeb943a1cbbe254fe2a82e5;hb=4fadb1282f5e9aa41abcb67e7d90cdc4a9b2628d;hpb=21481b6609641fb3076290dad915a3a6259ce05a diff --git a/decoder.c b/decoder.c index 65d05d0..d29a6d6 100644 --- a/decoder.c +++ b/decoder.c @@ -2,7 +2,7 @@ * This file is part of the sigrok project. * * Copyright (C) 2010 Uwe Hermann - * Copyright (C) 2011 Bert Vermeulen + * Copyright (C) 2012 Bert Vermeulen * * 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 @@ -18,10 +18,10 @@ * along with this program. If not, see . */ -#include #include "config.h" #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ #include "sigrokdecode-internal.h" +#include /* 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_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 = 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,22 +163,70 @@ 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 module %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); + /* 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); + + /* 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 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); + 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; @@ -146,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; } @@ -170,6 +275,7 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) err_out: if (ret != SRD_OK) { + Py_XDECREF(py_method); Py_XDECREF(py_basedec); Py_XDECREF(d->py_dec); Py_XDECREF(d->py_mod); @@ -231,115 +337,20 @@ int srd_unload_decoder(struct srd_decoder *dec) return SRD_OK; } -/** - * Check if the directory in the specified search path is a valid PD dir. - * - * A valid sigrok protocol decoder consists of a directory, which contains - * at least two .py files (the special __init__.py and at least one additional - * .py file which contains the actual PD code). - * - * TODO: We should also check that this is not a random other Python module, - * but really a sigrok PD module by some means. - * - * @param search_path A string containing the (absolute) path to the directory - * where 'entry' resides in. - * @param entry A string containing the (relative) directory name of the - * sigrok PD module. E.g. "i2c" for the I2C protocol decoder. - * @return SRD_OK, if the directory is a valid sigrok PD, a negative error - * code, such as SRD_ERR, otherwise. - */ -int srd_is_valid_pd_dir(const gchar *search_path, const gchar *entry) -{ - GDir *dir; - int py_files = 0, has_init_py = 0; - gchar *path1, *path2, *file; - GError *error; - - /* TODO: Error handling. */ - path1 = g_build_filename(search_path, entry, NULL); - - /* Check that it is a directory (and exists). */ - if (!g_file_test(path1, G_FILE_TEST_IS_DIR)) { - srd_dbg("decoder: %s: '%s' not a directory or doesn't exist", - __func__, entry); - return SRD_ERR; - } - - if (!(dir = g_dir_open(path1, 0, &error))) { /* TODO: flags? */ - srd_dbg("decoder: %s: '%s' failed to open directory", - __func__, entry); - return SRD_ERR; - } - - /* Check the contents of the directory. */ - while ((file = g_dir_read_name(dir)) != NULL) { - /* TODO: Error handling. */ - path2 = g_build_filename(path1, file, NULL); - - /* Ignore non-files. */ - if (!g_file_test(path2, G_FILE_TEST_IS_REGULAR)) { - srd_spew("decoder: %s: '%s' not a file, ignoring", - __func__, file); - continue; - } - - /* Count number of .py files. */ - if (g_str_has_suffix(path2, ".py")) { - srd_spew("decoder: %s: found .py file: '%s'", - __func__, file); - py_files++; - } - - /* Check if it's an __init__.py file. */ - if (g_str_has_suffix(path2, "__init__.py")) { - srd_spew("decoder: %s: found __init__.py file: '%s'", - __func__, path2); - has_init_py = 1; - } - } - g_dir_close(dir); - - /* Check if the directory contains >= 2 *.py files. */ - if (py_files < 2) { - srd_dbg("decoder: %s: '%s' is not a valid PD dir, it doesn't " - "contain >= 2 .py files", __func__, entry); - return SRD_ERR; - } - - /* Check if the directory contains an __init__.py file. */ - if (!has_init_py) { - srd_dbg("decoder: %s: '%s' is not a valid PD dir, it doesn't " - "contain an __init__.py file", __func__, entry); - return SRD_ERR; - } - - /* TODO: Check if it's a PD, not a random other Python module. */ - - return SRD_OK; -} - int srd_load_all_decoders(void) { GDir *dir; - gchar *direntry; + GError *error; + struct srd_decoder *dec; int ret; + const gchar *direntry; char *decodername; - struct srd_decoder *dec; - GError *error; - if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) { /* TODO: flags? */ - Py_Finalize(); /* Returns void. */ + if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) { return SRD_ERR_DECODERS_DIR; } while ((direntry = g_dir_read_name(dir)) != NULL) { - /* Ignore directory entries which are not valid PDs. */ - if (srd_is_valid_pd_dir(DECODERS_DIR, direntry) != SRD_OK) { - srd_dbg("decoder: %s: '%s' not a valid PD dir, " - "ignoring it", __func__, direntry); - continue; - } - /* The decoder name is the PD directory name (e.g. "i2c"). */ decodername = g_strdup(direntry);