#include <glib.h>
/* The list of protocol decoders. */
-GSList *pd_list = NULL;
-
-/* lives in module_sigrokdecode.c */
-extern PyObject *mod_sigrokdecode;
+SRD_PRIV GSList *pd_list = NULL;
+/* module_sigrokdecode.c */
+extern SRD_PRIV PyObject *mod_sigrokdecode;
/**
* Returns the list of supported/loaded protocol decoders.
*
* @return List of decoders, NULL if none are supported or loaded.
*/
-GSList *srd_list_decoders(void)
+SRD_API GSList *srd_decoder_list(void)
{
-
return pd_list;
}
-
/**
* Get the decoder with the specified ID.
*
* @param id The ID string of the decoder to return.
+ *
* @return The decoder with the specified ID, or NULL if not found.
*/
-struct srd_decoder *srd_get_decoder_by_id(const char *id)
+SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
{
GSList *l;
struct srd_decoder *dec;
- for (l = srd_list_decoders(); l; l = l->next) {
+ for (l = srd_decoder_list(); l; l = l->next) {
dec = l->data;
if (!strcmp(dec->id, id))
return dec;
return NULL;
}
-
-static int get_probes(struct srd_decoder *d, char *attr, GSList **pl)
+static int get_probes(const struct srd_decoder *d, const char *attr,
+ GSList **pl)
{
PyObject *py_probelist, *py_entry;
struct srd_probe *p;
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);
+ "a list.", d->name, attr);
goto err_out;
}
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);
+ "a list with dict elements.", d->name, attr);
goto err_out;
}
if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
+ srd_err("Failed to g_malloc() struct srd_probe.");
ret = SRD_ERR_MALLOC;
goto err_out;
}
* 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.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
-int srd_load_decoder(const char *name, struct srd_decoder **dec)
+SRD_API int srd_decoder_load(const char *module_name)
{
PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
struct srd_decoder *d;
int alen, ret, i;
char **ann;
- srd_dbg("srd: loading module '%s'", name);
+ srd_dbg("Loading protocol decoder '%s'.", module_name);
py_basedec = py_method = py_attr = NULL;
if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
- srd_dbg("srd: Failed to malloc struct srd_decoder");
+ srd_dbg("Failed to g_malloc() struct srd_decoder.");
ret = SRD_ERR_MALLOC;
goto err_out;
}
ret = SRD_ERR_PYTHON;
/* Import the Python module. */
- if (!(d->py_mod = PyImport_ImportModule(name))) {
- catch_exception("import of '%s' failed.", name);
+ if (!(d->py_mod = PyImport_ImportModule(module_name))) {
+ catch_exception("Import of '%s' failed.", module_name);
goto err_out;
}
if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
/* This generated an AttributeError exception. */
PyErr_Clear();
- srd_err("Decoder class not found in protocol decoder %s.", name);
+ srd_err("Decoder class not found in protocol decoder %s.",
+ module_name);
goto err_out;
}
if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
- srd_dbg("srd: 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.", module_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")) {
srd_err("Protocol decoder %s has no start() method Decoder "
- "class.", name);
+ "class.", module_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);
+ "is not a method.", module_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")) {
srd_err("Protocol decoder %s has no decode() method Decoder "
- "class.", name);
+ "class.", module_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);
+ "is not a method.", module_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);
+ "a dictionary.", d->name);
+ Py_DecRef(py_attr);
goto err_out;
}
Py_DecRef(py_attr);
goto err_out;
/* Check and import optional probes. */
- if (get_probes(d, "extra_probes", &d->extra_probes) != SRD_OK)
+ if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
goto err_out;
/* Store required fields in newly allocated strings. */
if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
goto err_out;
- /* TODO: Handle inputformats, outputformats. */
- d->inputformats = NULL;
- d->outputformats = NULL;
-
- /* Convert class annotation attribute to GSList of **char */
+ /* 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);
+ srd_err("Protocol decoder module %s annotations "
+ "should be a list.", module_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.", module_name, i + 1);
goto err_out;
}
}
}
- *dec = d;
+ /* Append it to the list of supported/loaded decoders. */
+ pd_list = g_slist_append(pd_list, d);
+
ret = SRD_OK;
err_out:
return ret;
}
-char *srd_decoder_doc(struct srd_decoder *dec)
+/**
+ * Return a protocol decoder's docstring.
+ *
+ * @param dec The loaded protocol decoder.
+ *
+ * @return A newly allocated buffer containing the protocol decoder's
+ * documentation. The caller is responsible for free'ing the buffer.
+ */
+SRD_API char *srd_decoder_doc(const struct srd_decoder *dec)
{
PyObject *py_str;
char *doc;
return doc;
}
+static void free_probes(GSList *probelist)
+{
+ GSList *l;
+ struct srd_probe *p;
+
+ if (probelist == NULL)
+ return;
+
+ for (l = probelist; l; l = l->next) {
+ p = l->data;
+ g_free(p->id);
+ g_free(p->name);
+ g_free(p->desc);
+ g_free(p);
+ }
+ g_slist_free(probelist);
+}
/**
* Unload decoder module.
*
- * @param dec The decoder struct to be unloaded.
+ * @param dec The struct srd_decoder to be unloaded.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
-int srd_unload_decoder(struct srd_decoder *dec)
+SRD_API int srd_decoder_unload(struct srd_decoder *dec)
{
-
+ srd_dbg("Unloading protocol decoder '%s'.", dec->name);
+
+ /*
+ * Since any instances of this decoder need to be released as well,
+ * but they could be anywhere in the stack, just free the entire
+ * stack. A frontend reloading a decoder thus has to restart all
+ * instances, and rebuild the stack.
+ */
+ srd_inst_free_all(NULL);
+
+ free_probes(dec->probes);
+ free_probes(dec->opt_probes);
g_free(dec->id);
g_free(dec->name);
g_free(dec->longname);
g_free(dec->desc);
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);
-
+ /* The module's Decoder class. */
Py_XDECREF(dec->py_dec);
+ /* The module itself. */
Py_XDECREF(dec->py_mod);
/* TODO: (g_)free dec itself? */
return SRD_OK;
}
-int srd_load_all_decoders(void)
+/**
+ * Load all installed protocol decoders.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
+SRD_API int srd_decoder_load_all(void)
{
GDir *dir;
GError *error;
- struct srd_decoder *dec;
- int ret;
const gchar *direntry;
- char *decodername;
if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
+ srd_err("Unable to open %s for reading.", DECODERS_DIR);
return SRD_ERR_DECODERS_DIR;
}
while ((direntry = g_dir_read_name(dir)) != NULL) {
- /* The decoder name is the PD directory name (e.g. "i2c"). */
- decodername = g_strdup(direntry);
-
- if (!(dec = g_try_malloc(sizeof(struct srd_decoder))))
- return SRD_ERR_MALLOC;
-
- 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);
- }
+ /* The directory name is the module name (e.g. "i2c"). */
+ srd_decoder_load(direntry);
}
g_dir_close(dir);
}
/**
- * TODO
+ * Unload all loaded protocol decoders.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
*/
-int srd_unload_all_decoders(void)
+SRD_API int srd_decoder_unload_all(void)
{
GSList *l;
struct srd_decoder *dec;
- for (l = srd_list_decoders(); l; l = l->next) {
+ for (l = srd_decoder_list(); l; l = l->next) {
dec = l->data;
- srd_unload_decoder(dec);
+ srd_decoder_unload(dec);
}
return SRD_OK;
}
-
-
-
projects / libsigrokdecode.git / blobdiff