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

diff --git a/decoder.c b/decoder.c
index f242ffe..21e24c4 100644
--- a/decoder.c
+++ b/decoder.c
@@ -1,5 +1,5 @@
 /*
- * 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) 2012 Bert Vermeulen <bert@biot.com>
@@ -19,16 +19,33 @@
  */
 
 #include "config.h"
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.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;
+SRD_PRIV GSList *pd_list = NULL;
 
-/* lives in module_sigrokdecode.c */
-extern PyObject *mod_sigrokdecode;
+/* module_sigrokdecode.c */
+extern SRD_PRIV PyObject *mod_sigrokdecode;
 
+/** @endcond */
 
 /**
  * Returns the list of supported/loaded protocol decoders.
@@ -36,26 +53,29 @@ extern PyObject *mod_sigrokdecode;
  * 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;
@@ -64,8 +84,8 @@ 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)
+static int get_probes(const struct srd_decoder *d, const char *attr,
+		      GSList **pl)
 {
 	PyObject *py_probelist, *py_entry;
 	struct srd_probe *p;
@@ -81,7 +101,7 @@ static int get_probes(struct srd_decoder *d, char *attr, GSList **pl)
 	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;
 	}
 
@@ -94,11 +114,12 @@ static int get_probes(struct srd_decoder *d, char *attr, GSList **pl)
 		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;
 		}
@@ -122,27 +143,117 @@ err_out:
 	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.
  *
- * @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_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
 	struct srd_decoder *d;
 	int alen, ret, i;
 	char **ann;
+	struct srd_probe *p;
+	GSList *l;
 
-	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;
 	}
@@ -150,8 +261,8 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
 	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))) {
+		srd_exception_catch("Import of '%s' failed.", module_name);
 		goto err_out;
 	}
 
@@ -159,69 +270,75 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
 	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);
-			goto err_out;
-		}
-		Py_DecRef(py_attr);
-	}
+	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, "extra_probes", &d->extra_probes) != SRD_OK)
+	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);
+	}
+
 	/* Store required fields in newly allocated strings. */
 	if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
 		goto err_out;
@@ -238,24 +355,22 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
 	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;
 			}
 
@@ -266,7 +381,9 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
 		}
 	}
 
-	*dec = d;
+	/* Append it to the list of supported/loaded decoders. */
+	pd_list = g_slist_append(pd_list, d);
+
 	ret = SRD_OK;
 
 err_out:
@@ -281,7 +398,17 @@ 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.
+ *
+ * @since 0.1.0
+ */
+SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
 {
 	PyObject *py_str;
 	char *doc;
@@ -290,7 +417,7 @@ char *srd_decoder_doc(struct srd_decoder *dec)
 		return NULL;
 
 	if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
-		catch_exception("");
+		srd_exception_catch("");
 		return NULL;
 	}
 
@@ -302,30 +429,68 @@ char *srd_decoder_doc(struct srd_decoder *dec)
 	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.
+ *
+ * @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->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? */
@@ -333,30 +498,27 @@ 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)
 {
 	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);
 
@@ -364,20 +526,23 @@ int srd_load_all_decoders(void)
 }
 
 /**
- * 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;
-		srd_unload_decoder(dec);
+		srd_decoder_unload(dec);
 	}
 
 	return SRD_OK;
 }
 
-
-
+/** @} */