X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=858b56ad2233c0fe76e0a40248873eee1d188e3d;hp=52c913aeea0ad6bec6e9f876c4ee93714a112818;hb=62a2b15ce3fe6af6867c30cfc9c14c01d201a898;hpb=57790bc8c558ccf2e57b3d973c043088232628c7

diff --git a/decoder.c b/decoder.c
index 52c913a..858b56a 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,15 +19,35 @@
  */
 
 #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. */
 SRD_PRIV GSList *pd_list = NULL;
 
+/* srd.c */
+extern GSList *searchpaths;
+
+/* session.c */
+extern GSList *sessions;
+
 /* module_sigrokdecode.c */
 extern SRD_PRIV PyObject *mod_sigrokdecode;
 
@@ -39,6 +59,8 @@ extern SRD_PRIV 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)
  */
 SRD_API const GSList *srd_decoder_list(void)
 {
@@ -51,6 +73,8 @@ SRD_API const GSList *srd_decoder_list(void)
  * @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
  */
 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
 {
@@ -67,7 +91,7 @@ SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
 }
 
 static int get_probes(const struct srd_decoder *d, const char *attr,
-		      GSList **pl)
+		GSList **pl)
 {
 	PyObject *py_probelist, *py_entry;
 	struct srd_probe *p;
@@ -77,50 +101,140 @@ static int get_probes(const struct srd_decoder *d, const char *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;
+		srd_err("Protocol decoder %s %s attribute is not a list.",
+				d->name, attr);
+		return SRD_ERR_PYTHON;
 	}
 
-	num_probes = PyList_Size(py_probelist);
-	if (num_probes == 0)
+	if ((num_probes = PyList_Size(py_probelist)) == 0)
 		/* Empty probelist. */
 		return SRD_OK;
 
+	ret = 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;
+			ret = SRD_ERR_PYTHON;
+			break;
 		}
 
 		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;
+			break;
 		}
 
-		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;
+		if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK) {
+			ret = SRD_ERR_PYTHON;
+			break;
+		}
+		if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK) {
+			ret = SRD_ERR_PYTHON;
+			break;
+		}
+		if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK) {
+			ret = SRD_ERR_PYTHON;
+			break;
+		}
 		p->order = i;
 
 		*pl = g_slist_append(*pl, p);
 	}
+
+	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);
+		g_free(key);
+		key = NULL;
+	}
+	Py_DecRef(py_keys);
+	Py_DecRef(py_values);
+
 	ret = SRD_OK;
 
 err_out:
-	Py_DecRef(py_entry);
-	Py_DecRef(py_probelist);
+	Py_XDECREF(py_opts);
+	g_free(key);
 
 	return ret;
 }
@@ -131,16 +245,30 @@ err_out:
  * @param module_name The module name to be loaded.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
  */
 SRD_API int srd_decoder_load(const char *module_name)
 {
-	PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
+	PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann, \
+		*py_bin_classes, *py_bin_class;
 	struct srd_decoder *d;
-	int alen, ret, i;
-	char **ann;
+	int len, ret, i;
+	char **ann, *bin;
 	struct srd_probe *p;
 	GSList *l;
 
+	if (!srd_check_init())
+		return SRD_ERR;
+
+	if (!module_name)
+		return SRD_ERR_ARG;
+
+	if (PyDict_GetItemString(PyImport_GetModuleDict(), module_name)) {
+		/* Module was already imported. */
+		return SRD_OK;
+	}
+
 	srd_dbg("Loading protocol decoder '%s'.", module_name);
 
 	py_basedec = py_method = py_attr = NULL;
@@ -208,17 +336,8 @@ SRD_API int srd_decoder_load(const char *module_name)
 	}
 	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 (get_options(d) != SRD_OK)
+		goto err_out;
 
 	/* Check and import required probes. */
 	if (get_probes(d, "probes", &d->probes) != SRD_OK)
@@ -257,7 +376,7 @@ SRD_API int srd_decoder_load(const char *module_name)
 	if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
 		goto err_out;
 
-	/* Convert class annotation attribute to GSList of **char. */
+	/* Convert annotation class attribute to GSList of char **. */
 	d->annotations = NULL;
 	if (PyObject_HasAttrString(d->py_dec, "annotations")) {
 		py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
@@ -266,8 +385,8 @@ SRD_API int srd_decoder_load(const char *module_name)
 				"should be a list.", module_name);
 			goto err_out;
 		}
-		alen = PyList_Size(py_annlist);
-		for (i = 0; i < alen; i++) {
+		len = PyList_Size(py_annlist);
+		for (i = 0; i < len; i++) {
 			py_ann = PyList_GetItem(py_annlist, i);
 			if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
 				srd_err("Protocol decoder module %s "
@@ -276,13 +395,38 @@ SRD_API int srd_decoder_load(const char *module_name)
 				goto err_out;
 			}
 
-			if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
+			if (py_strseq_to_char(py_ann, &ann) != SRD_OK) {
 				goto err_out;
 			}
 			d->annotations = g_slist_append(d->annotations, ann);
 		}
 	}
 
+	/* Convert binary class to GSList of char *. */
+	d->binary = NULL;
+	if (PyObject_HasAttrString(d->py_dec, "binary")) {
+		py_bin_classes = PyObject_GetAttrString(d->py_dec, "binary");
+		if (!PyTuple_Check(py_bin_classes)) {
+			srd_err("Protocol decoder module %s binary classes "
+				"should be a tuple.", module_name);
+			goto err_out;
+		}
+		len = PyTuple_Size(py_bin_classes);
+		for (i = 0; i < len; i++) {
+			py_bin_class = PyTuple_GetItem(py_bin_classes, i);
+			if (!PyUnicode_Check(py_bin_class)) {
+				srd_err("Protocol decoder module %s binary "
+						"class should be a string.", module_name);
+				goto err_out;
+			}
+
+			if (py_str_as_str(py_bin_class, &bin) != SRD_OK) {
+				goto err_out;
+			}
+			d->binary = g_slist_append(d->binary, bin);
+		}
+	}
+
 	/* Append it to the list of supported/loaded decoders. */
 	pd_list = g_slist_append(pd_list, d);
 
@@ -307,12 +451,20 @@ err_out:
  *
  * @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 (!srd_check_init())
+		return NULL;
+
+	if (!dec)
+		return NULL;
+
 	if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
 		return NULL;
 
@@ -348,14 +500,26 @@ static void free_probes(GSList *probelist)
 }
 
 /**
- * Unload decoder module.
+ * Unload the specified protocol decoder.
  *
  * @param dec The struct srd_decoder to be unloaded.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
  */
 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 {
+	struct srd_decoder_option *o;
+	struct srd_session *sess;
+	GSList *l;
+
+	if (!srd_check_init())
+		return SRD_ERR;
+
+	if (!dec)
+		return SRD_ERR_ARG;
+
 	srd_dbg("Unloading protocol decoder '%s'.", dec->name);
 
 	/*
@@ -364,7 +528,19 @@ SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 	 * stack. A frontend reloading a decoder thus has to restart all
 	 * instances, and rebuild the stack.
 	 */
-	srd_inst_free_all(NULL);
+	for (l = sessions; l; l = l->next) {
+		sess = l->data;
+		srd_inst_free_all(sess, 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);
@@ -379,33 +555,48 @@ SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 	/* The module itself. */
 	Py_XDECREF(dec->py_mod);
 
-	/* TODO: (g_)free dec itself? */
+	g_free(dec);
 
 	return SRD_OK;
 }
 
-/**
- * Load all installed protocol decoders.
- *
- * @return SRD_OK upon success, a (negative) error code otherwise.
- */
-SRD_API int srd_decoder_load_all(void)
+static void srd_decoder_load_all_path(char *path)
 {
 	GDir *dir;
-	GError *error;
 	const gchar *direntry;
 
-	if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
-		srd_err("Unable to open %s for reading.", DECODERS_DIR);
-		return SRD_ERR_DECODERS_DIR;
-	}
+	if (!(dir = g_dir_open(path, 0, NULL)))
+		/* Not really fatal */
+		return;
 
+	/* This ignores errors returned by srd_decoder_load(). That
+	 * function will have logged the cause, but in any case we
+	 * want to continue anyway. */
 	while ((direntry = g_dir_read_name(dir)) != NULL) {
 		/* The directory name is the module name (e.g. "i2c"). */
 		srd_decoder_load(direntry);
 	}
 	g_dir_close(dir);
 
+}
+
+/**
+ * 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)
+{
+	GSList *l;
+
+	if (!srd_check_init())
+		return SRD_ERR;
+
+	for (l = searchpaths; l; l = l->next)
+		srd_decoder_load_all_path(l->data);
+
 	return SRD_OK;
 }
 
@@ -413,6 +604,8 @@ SRD_API int srd_decoder_load_all(void)
  * Unload all loaded protocol decoders.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
  */
 SRD_API int srd_decoder_unload_all(void)
 {
@@ -423,6 +616,10 @@ SRD_API int srd_decoder_unload_all(void)
 		dec = l->data;
 		srd_decoder_unload(dec);
 	}
+	g_slist_free(pd_list);
+	pd_list = NULL;
 
 	return SRD_OK;
 }
+
+/** @} */