X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=6f4a88dbeb740e05d99d6677c15d3c970fd7385a;hp=5b9223c630812599548e0dcebfeac1a5104161b0;hb=b9e44d1e0964f5c6c99ec52b68a5a6e0bc1ac633;hpb=11ea8ae1b2279566125978766735a26252dff412

diff --git a/decoder.c b/decoder.c
index 5b9223c..6f4a88d 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
@@ -65,6 +65,63 @@ struct srd_decoder *srd_get_decoder_by_id(const char *id)
 }
 
 
+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)))) {
+			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.
  *
@@ -80,12 +137,12 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
 	int alen, ret, i;
 	char **ann;
 
-	py_basedec = py_method = py_attr = NULL;
+	srd_dbg("Loading module '%s'.", name);
 
-	srd_dbg("decoder: %s: loading module '%s'", __func__, name);
+	py_basedec = py_method = py_attr = NULL;
 
 	if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
-		srd_err("decoder: %s: d malloc failed", __func__);
+		srd_dbg("Failed to malloc struct srd_decoder.");
 		ret = SRD_ERR_MALLOC;
 		goto err_out;
 	}
@@ -94,33 +151,29 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
 
 	/* Import the Python module. */
 	if (!(d->py_mod = PyImport_ImportModule(name))) {
-		/* TODO: Report exception message/traceback to err/dbg. */
-		srd_warn("decoder: %s: import of '%s' failed", __func__, name);
-		PyErr_Print();
-		PyErr_Clear();
+		catch_exception("import of '%s' failed.", name);
 		goto err_out;
 	}
 
 	/* Get the 'Decoder' class as Python object. */
 	if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
 		/* This generated an AttributeError exception. */
-		PyErr_Print();
 		PyErr_Clear();
-		srd_err("Decoder class not found in protocol decoder %s", name);
+		srd_err("Decoder class not found in protocol decoder %s.", name);
 		goto err_out;
 	}
 
 	if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
-		srd_dbg("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.", 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")) {
@@ -130,11 +183,11 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
 	}
 	py_method = PyObject_GetAttrString(d->py_dec, "start");
 	if (!PyFunction_Check(py_method)) {
-		srd_err("Protocol decoder %s Decoder class attribute 'start'"
+		srd_err("Protocol decoder %s Decoder class attribute 'start' "
 				"is not a method.", 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")) {
@@ -148,7 +201,7 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
 				"is not a method.", 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")) {
@@ -156,11 +209,21 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
 		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);
 	}
 
+	/* 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;
+
+	/* Store required fields in newly allocated strings. */
 	if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
 		goto err_out;
 
@@ -185,15 +248,15 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec)
 	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.", 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.", name, i+1);
 				goto err_out;
 			}
 
@@ -228,7 +291,7 @@ char *srd_decoder_doc(struct srd_decoder *dec)
 		return NULL;
 
 	if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
-		PyErr_Clear();
+		catch_exception("");
 		return NULL;
 	}
 
@@ -241,16 +304,45 @@ char *srd_decoder_doc(struct srd_decoder *dec)
 }
 
 
+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_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_instance_free_all(NULL);
+
+	free_probes(dec->probes);
+	free_probes(dec->opt_probes);
 	g_free(dec->id);
 	g_free(dec->name);
 	g_free(dec->longname);
@@ -263,7 +355,9 @@ int srd_unload_decoder(struct srd_decoder *dec)
 	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? */
@@ -288,14 +382,6 @@ int srd_load_all_decoders(void)
 		/* The decoder name is the PD directory name (e.g. "i2c"). */
 		decodername = g_strdup(direntry);
 
-		/* 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);
@@ -316,7 +402,6 @@ int srd_unload_all_decoders(void)
 
 	for (l = srd_list_decoders(); l; l = l->next) {
 		dec = l->data;
-		/* TODO: Error handling. */
 		srd_unload_decoder(dec);
 	}