X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=e3f847d205ea7db534ad9e93b2372fb7bf057774;hp=e25e4e01599556e1db3e9b42d64969d47eece5d4;hb=582c8473ffd456dfb0796974ef2c0b1b78de38a8;hpb=e97b6ef569f73e387b2597dfa144c01838c0e27c

diff --git a/decoder.c b/decoder.c
index e25e4e0..e3f847d 100644
--- 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,11 +21,13 @@
 #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;
+SRD_PRIV GSList *pd_list = NULL;
 
+/* module_sigrokdecode.c */
+extern SRD_PRIV PyObject *mod_sigrokdecode;
 
 /**
  * Returns the list of supported/loaded protocol decoders.
@@ -34,20 +36,19 @@ GSList *pd_list = NULL;
  *
  * @return List of decoders, NULL if none are supported or loaded.
  */
-GSList *srd_list_decoders(void)
+SRD_API GSList *srd_list_decoders(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_get_decoder_by_id(const char *id)
 {
 	GSList *l;
 	struct srd_decoder *dec;
@@ -61,122 +62,308 @@ struct srd_decoder *srd_get_decoder_by_id(const char *id)
 	return NULL;
 }
 
+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)))) {
+			srd_err("Failed to g_malloc() 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.
+ * 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_load_decoder(const char *name, struct srd_decoder **dec)
 {
-	PyObject *py_mod, *py_res, *py_annlist, *py_ann;
+	PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
 	struct srd_decoder *d;
-	int alen, r, i;
+	int alen, ret, i;
 	char **ann;
 
-	/* "Import" the Python module. */
-	if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
-		PyErr_Print(); /* Returns void. */
-		return SRD_ERR_PYTHON; /* TODO: More specific error? */
+	srd_dbg("Loading module '%s'.", name);
+
+	py_basedec = py_method = py_attr = NULL;
+
+	if (!(d = g_try_malloc0(sizeof(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);
+		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);
-		srd_err("Decoder class not found in PD module %s", name);
-		return SRD_ERR_PYTHON; /* TODO: More specific error? */
+	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);
+		goto err_out;
 	}
 
-	if (!(d = malloc(sizeof(struct srd_decoder))))
-		return SRD_ERR_MALLOC;
+	if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
+		srd_dbg("sigrokdecode module not loaded.");
+		goto err_out;
+	}
 
-	if ((r = h_str(py_res, "id", &(d->id))) < 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_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);
+		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_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);
+		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_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);
+	}
 
-	if ((r = h_str(py_res, "name", &(d->name))) < 0)
-		return r;
+	/* Check and import required probes. */
+	if (get_probes(d, "probes", &d->probes) != SRD_OK)
+		goto err_out;
 
-	if ((r = h_str(py_res, "longname", &(d->longname))) < 0)
-		return r;
+	/* Check and import optional probes. */
+	if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
+		goto err_out;
 
-	if ((r = h_str(py_res, "desc", &(d->desc))) < 0)
-		return r;
+	/* Store required fields in newly allocated strings. */
+	if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
+		goto err_out;
 
-	if ((r = h_str(py_res, "longdesc", &(d->longdesc))) < 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, "author", &(d->author))) < 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, "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(py_res, "annotations")) {
-		py_annlist = PyObject_GetAttrString(py_res, "annotations");
+	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);
-			return SRD_ERR_PYTHON;
+			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);
-				return SRD_ERR_PYTHON;
+				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)
-				return SRD_ERR_PYTHON;
+			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;
+}
+
+/**
+ * Return a protocol decoder's docstring.
+ *
+ * @param dec The loaded protocol decoder.
+ *
+ * @return A newly allocated buffer containing the docstring. The caller should
+ * free this after use.
+ */
+SRD_API 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__"))) {
+		catch_exception("");
+		return NULL;
+	}
+
+	doc = NULL;
+	if (py_str != Py_None)
+		py_str_as_str(py_str, &doc);
+	Py_DecRef(py_str);
+
+	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);
+
+}
 
 /**
- * TODO
+ * Unload decoder module.
+ *
+ * @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_unload_decoder(struct srd_decoder *dec)
 {
+	srd_dbg("unloading 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->longdesc);
-	g_free(dec->author);
 	g_free(dec->license);
-	g_free(dec->func);
 
 	/* 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);
+	/* The module's Decoder class. */
+	Py_XDECREF(dec->py_dec);
+	/* The module itself. */
 	Py_XDECREF(dec->py_mod);
 
 	/* TODO: (g_)free dec itself? */
@@ -184,63 +371,52 @@ int srd_unload_decoder(struct srd_decoder *dec)
 	return SRD_OK;
 }
 
-
-int srd_load_all_decoders(void)
+/**
+ * Load all protocol decoders libsigrokdecode knows about.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
+SRD_API 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_strdup(direntry);
 
-		/* Decoder name == filename (without .py suffix). */
-		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;
-		}
-
-		/* 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;
 }
 
-
 /**
- * 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_unload_all_decoders(void)
 {
 	GSList *l;
 	struct srd_decoder *dec;
 
 	for (l = srd_list_decoders(); l; l = l->next) {
 		dec = l->data;
-		/* TODO: Error handling. */
 		srd_unload_decoder(dec);
 	}
 
 	return SRD_OK;
 }
-
-
-