X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=21e24c471d6178610dacd5bdc3885d17221a9e99;hp=788d2e840c6650639407564f08949717fb01a64d;hb=c1f86f02a149f46609273e1bd5b42696d544727a;hpb=b231546d63396fd6cac381b12b99caf07687e7e3

diff --git a/decoder.c b/decoder.c
index 788d2e8..21e24c4 100644
--- a/decoder.c
+++ b/decoder.c
@@ -1,8 +1,8 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrokdecode 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
@@ -19,14 +19,33 @@
  */
 
 #include "config.h"
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
-#include <dirent.h>
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode-internal.h"
+#include <glib.h>
+
+/**
+ * @file
+ *
+ * Listing, loading, unloading, and handling protocol decoders.
+ */
+
+/**
+ * @defgroup grp_decoder Protocol decoders
+ *
+ * Handling protocol decoders.
+ *
+ * @{
+ */
+
+/** @cond PRIVATE */
 
 /* The list of protocol decoders. */
-GSList *pd_list = NULL;
-GSList *di_list = NULL;
+SRD_PRIV GSList *pd_list = NULL;
+
+/* module_sigrokdecode.c */
+extern SRD_PRIV PyObject *mod_sigrokdecode;
 
+/** @endcond */
 
 /**
  * Returns the list of supported/loaded protocol decoders.
@@ -34,26 +53,29 @@ GSList *di_list = NULL;
  * This is a GSList containing the names of the decoders as strings.
  *
  * @return List of decoders, NULL if none are supported or loaded.
+ *
+ * @since 0.1.0 (but the API changed in 0.2.0)
  */
-GSList *srd_list_decoders(void)
+SRD_API const 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.
+ *
+ * @since 0.1.0
  */
-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 = pd_list; l; l = l->next) {
 		dec = l->data;
 		if (!strcmp(dec->id, id))
 			return dec;
@@ -62,122 +84,413 @@ struct srd_decoder *srd_get_decoder_by_id(const char *id)
 	return NULL;
 }
 
+static int get_probes(const struct srd_decoder *d, const 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;
+}
+
+static int get_options(struct srd_decoder *d)
+{
+	PyObject *py_opts, *py_keys, *py_values, *py_val, *py_desc, *py_default;
+	Py_ssize_t i;
+	struct srd_decoder_option *o;
+	gint64 def_long;
+	int num_keys, overflow, ret;
+	char *key, *def_str;
+
+	ret = SRD_ERR_PYTHON;
+	key = NULL;
+
+	if (!PyObject_HasAttrString(d->py_dec, "options"))
+		/* That's fine. */
+		return SRD_OK;
+
+	/* If present, options must be a dictionary. */
+	py_opts = PyObject_GetAttrString(d->py_dec, "options");
+	if (!PyDict_Check(py_opts)) {
+		srd_err("Protocol decoder %s options attribute is not "
+			"a dictionary.", d->name);
+		goto err_out;
+	}
+
+	py_keys = PyDict_Keys(py_opts);
+	py_values = PyDict_Values(py_opts);
+	num_keys = PyList_Size(py_keys);
+	for (i = 0; i < num_keys; i++) {
+		py_str_as_str(PyList_GetItem(py_keys, i), &key);
+		srd_dbg("option '%s'", key);
+		py_val = PyList_GetItem(py_values, i);
+		if (!PyList_Check(py_val) || PyList_Size(py_val) != 2) {
+			srd_err("Protocol decoder %s option '%s' value must be "
+					"a list with two elements.", d->name, key);
+			goto err_out;
+		}
+		py_desc = PyList_GetItem(py_val, 0);
+		if (!PyUnicode_Check(py_desc)) {
+			srd_err("Protocol decoder %s option '%s' has no "
+					"description.", d->name, key);
+			goto err_out;
+		}
+		py_default = PyList_GetItem(py_val, 1);
+		if (!PyUnicode_Check(py_default) && !PyLong_Check(py_default)) {
+			srd_err("Protocol decoder %s option '%s' has default "
+					"of unsupported type '%s'.", d->name, key,
+					Py_TYPE(py_default)->tp_name);
+			goto err_out;
+		}
+		if (!(o = g_try_malloc(sizeof(struct srd_decoder_option)))) {
+			srd_err("option malloc failed");
+			goto err_out;
+		}
+		o->id = g_strdup(key);
+		py_str_as_str(py_desc, &o->desc);
+		if (PyUnicode_Check(py_default)) {
+			/* UTF-8 string */
+			py_str_as_str(py_default, &def_str);
+			o->def = g_variant_new_string(def_str);
+			g_free(def_str);
+		} else {
+			/* Long */
+			def_long = PyLong_AsLongAndOverflow(py_default, &overflow);
+			if (overflow) {
+				/* Value is < LONG_MIN or > LONG_MAX */
+				PyErr_Clear();
+				srd_err("Protocol decoder %s option '%s' has "
+						"invalid default value.", d->name, key);
+				goto err_out;
+			}
+			o->def = g_variant_new_int64(def_long);
+		}
+		g_variant_ref_sink(o->def);
+		d->options = g_slist_append(d->options, o);
+	}
+	Py_DecRef(py_keys);
+	Py_DecRef(py_values);
+
+	ret = SRD_OK;
+
+err_out:
+	Py_XDECREF(py_opts);
+	g_free(key);
+
+	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.
+ * @param module_name The module name to be loaded.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
  */
-int srd_load_decoder(const char *name, struct srd_decoder **dec)
+SRD_API int srd_decoder_load(const char *module_name)
 {
-	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;
+	struct srd_probe *p;
+	GSList *l;
+
+	srd_dbg("Loading protocol decoder '%s'.", module_name);
 
-	/* "Import" the Python module. */
-	if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
-		PyErr_Print(); /* Returns void. */
-		return SRD_ERR_PYTHON; /* TODO: More specific error? */
+	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;
 	}
 
-	/* 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? */
+	ret = SRD_ERR_PYTHON;
+
+	/* Import the Python module. */
+	if (!(d->py_mod = PyImport_ImportModule(module_name))) {
+		srd_exception_catch("Import of '%s' failed.", module_name);
+		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_Clear();
+		srd_err("Decoder class not found in protocol decoder %s.",
+			module_name);
+		goto err_out;
+	}
 
-	if ((r = h_str(py_res, "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, "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.", module_name);
+		goto err_out;
+	}
+	Py_CLEAR(py_basedec);
 
-	if ((r = h_str(py_res, "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.", 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.", module_name);
+		goto err_out;
+	}
+	Py_CLEAR(py_method);
 
-	if ((r = h_str(py_res, "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.", 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.", module_name);
+		goto err_out;
+	}
+	Py_CLEAR(py_method);
+
+	if (get_options(d) != SRD_OK)
+		goto err_out;
+
+	/* 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, "optional_probes", &d->opt_probes) != SRD_OK)
+		goto err_out;
+
+	/*
+	 * Fix order numbers for the optional probes.
+	 *
+	 * Example:
+	 * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
+	 * 'order' fields in the d->probes list = 0, 1, 2.
+	 * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
+	 */
+	for (l = d->opt_probes; l; l = l->next) {
+		p = l->data;
+		p->order += g_slist_length(d->probes);
+	}
 
-	if ((r = h_str(py_res, "longdesc", &(d->longdesc))) < 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, "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, "license", &(d->license))) < 0)
-		return r;
+	if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
+		goto err_out;
 
-	d->py_mod = py_mod;
-	d->py_decobj = py_res;
+	if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != 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;
-	d->inputformats = NULL;
-	d->outputformats = NULL;
+	if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
+		goto err_out;
 
-	/* Convert class annotation attribute to GSList of **char */
-	d->annotation = NULL;
-	if (PyObject_HasAttrString(py_res, "annotation")) {
-		py_annlist = PyObject_GetAttrString(py_res, "annotation");
+	/* 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 annotation should be a list", name);
-			return SRD_ERR_PYTHON;
+			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);
-				return SRD_ERR_PYTHON;
+				srd_err("Protocol decoder module %s "
+					"annotation %d should be a list with "
+					"two elements.", module_name, i + 1);
+				goto err_out;
 			}
 
-			if (py_strlist_to_char(py_ann, &ann) != SRD_OK)
-				return SRD_ERR_PYTHON;
-			d->annotation = g_slist_append(d->annotation, ann);
+			if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
+				goto err_out;
+			}
+			d->annotations = g_slist_append(d->annotations, ann);
 		}
 	}
 
-	*dec = d;
+	/* Append it to the list of supported/loaded decoders. */
+	pd_list = g_slist_append(pd_list, d);
 
-	return SRD_OK;
+	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 ret;
+}
+
+/**
+ * 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.
+ *
+ * @since 0.1.0
+ */
+SRD_API char *srd_decoder_doc_get(const 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__"))) {
+		srd_exception_catch("");
+		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.
+ *
+ * @since 0.1.0
  */
-int srd_unload_decoder(struct srd_decoder *dec)
+SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 {
+	struct srd_decoder_option *o;
+	GSList *l;
+
+	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);
+
+	for (l = dec->options; l; l = l->next) {
+		o = l->data;
+		g_free(o->id);
+		g_free(o->desc);
+		g_variant_unref(o->def);
+		g_free(o);
+	}
+	g_slist_free(dec->options);
+
+	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? */
@@ -185,63 +498,51 @@ int srd_unload_decoder(struct srd_decoder *dec)
 	return SRD_OK;
 }
 
-
-int srd_load_all_decoders(void)
+/**
+ * Load all installed protocol decoders.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
+ */
+SRD_API int srd_decoder_load_all(void)
 {
-	DIR *dir;
-	struct dirent *dp;
-	int ret;
-	char *decodername;
-	struct srd_decoder *dec;
+	GDir *dir;
+	GError *error;
+	const gchar *direntry;
 
-	if (!(dir = opendir(DECODERS_DIR))) {
-		Py_Finalize(); /* Returns void. */
+	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 ((dp = readdir(dir)) != NULL) {
-		/* Ignore filenames which don't end with ".py". */
-		if (!g_str_has_suffix(dp->d_name, ".py"))
-			continue;
-
-		/* 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);
-		}
+	while ((direntry = g_dir_read_name(dir)) != NULL) {
+		/* The directory name is the module name (e.g. "i2c"). */
+		srd_decoder_load(direntry);
 	}
-	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.
+ *
+ * @since 0.1.0
  */
-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 = pd_list; l; l = l->next) {
 		dec = l->data;
-		/* TODO: Error handling. */
-		srd_unload_decoder(dec);
+		srd_decoder_unload(dec);
 	}
 
 	return SRD_OK;
 }
 
-
-
+/** @} */