X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=1e22d0dd5c297ffd622c1651cc3c99bb2dd28434;hp=5eac220a55c5b0a2942963700dce6700efa19f11;hb=65f6eb77a33e6e7185376b1d9b8f3f0c62273d27;hpb=ca3fc3c0c042ecf509f8218e417655c04c9b9831

diff --git a/decoder.c b/decoder.c
index 5eac220..1e22d0d 100644
--- a/decoder.c
+++ b/decoder.c
@@ -42,6 +42,12 @@
 /* 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;
 
@@ -85,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;
@@ -95,49 +101,50 @@ 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;
+	if (!PyTuple_Check(py_probelist)) {
+		srd_err("Protocol decoder %s %s attribute is not a tuple.",
+				d->name, attr);
+		return SRD_ERR_PYTHON;
 	}
 
-	num_probes = PyList_Size(py_probelist);
-	if (num_probes == 0)
+	if ((num_probes = PyTuple_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);
+		py_entry = PyTuple_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);
 	}
-	ret = SRD_OK;
 
-err_out:
-	Py_DecRef(py_entry);
 	Py_DecRef(py_probelist);
 
 	return ret;
@@ -145,91 +152,137 @@ err_out:
 
 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;
+	PyObject *py_opts, *py_opt, *py_val, *py_default, *py_item;
+	Py_ssize_t opt, i;
 	struct srd_decoder_option *o;
-	gint64 def_long;
-	int num_keys, overflow, ret;
-	char *key, *def_str;
-
-	ret = SRD_ERR_PYTHON;
-	key = NULL;
+	GVariant *gvar;
+	gint64 lval;
+	double dval;
+	int overflow;
+	char *sval;
 
 	if (!PyObject_HasAttrString(d->py_dec, "options"))
-		/* That's fine. */
+		/* No options, that's fine. */
 		return SRD_OK;
 
-	/* If present, options must be a dictionary. */
+	/* If present, options must be a tuple. */
 	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;
+	if (!PyTuple_Check(py_opts)) {
+		srd_err("Protocol decoder %s: options attribute is not "
+				"a tuple.", d->id);
+		return SRD_ERR_PYTHON;
 	}
 
-	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;
+	for (opt = 0; opt < PyTuple_Size(py_opts); opt++) {
+		py_opt = PyTuple_GetItem(py_opts, opt);
+		if (!PyDict_Check(py_opt)) {
+			srd_err("Protocol decoder %s options: each option "
+					"must consist of a dictionary.", d->name);
+			return SRD_ERR_PYTHON;
 		}
-		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 (!(py_val = PyDict_GetItemString(py_opt, "id"))) {
+			srd_err("Protocol decoder %s option %d has no "
+					"id.", d->name);
+			return SRD_ERR_PYTHON;
 		}
-		if (!(o = g_try_malloc(sizeof(struct srd_decoder_option)))) {
-			srd_err("option malloc failed");
-			goto err_out;
+		o = g_malloc0(sizeof(struct srd_decoder_option));
+		py_str_as_str(py_val, &o->id);
+
+		if ((py_val = PyDict_GetItemString(py_opt, "desc")))
+			py_str_as_str(py_val, &o->desc);
+
+		if ((py_default = PyDict_GetItemString(py_opt, "default"))) {
+			if (PyUnicode_Check(py_default)) {
+				/* UTF-8 string */
+				py_str_as_str(py_default, &sval);
+				o->def = g_variant_new_string(sval);
+				g_free(sval);
+			} else if (PyLong_Check(py_default)) {
+				/* Long */
+				lval = PyLong_AsLongAndOverflow(py_default, &overflow);
+				if (overflow) {
+					/* Value is < LONG_MIN or > LONG_MAX */
+					PyErr_Clear();
+					srd_err("Protocol decoder %s option 'default' has "
+							"invalid default value.", d->name);
+					return SRD_ERR_PYTHON;
+				}
+				o->def = g_variant_new_int64(lval);
+			} else if (PyFloat_Check(py_default)) {
+				/* Float */
+				if ((dval = PyFloat_AsDouble(py_default)) == -1.0) {
+					PyErr_Clear();
+					srd_err("Protocol decoder %s option 'default' has "
+							"invalid default value.", d->name);
+					return SRD_ERR_PYTHON;
+				}
+				o->def = g_variant_new_double(dval);
+			} else {
+				srd_err("Protocol decoder %s option 'default' has "
+						"value of unsupported type '%s'.", d->name,
+						Py_TYPE(py_default)->tp_name);
+				return SRD_ERR_PYTHON;
+			}
+			g_variant_ref_sink(o->def);
 		}
-		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;
+
+		if ((py_val = PyDict_GetItemString(py_opt, "values"))) {
+			/* A default is required if a list of values is
+			 * given, since it's used to verify their type. */
+			if (!o->def) {
+				srd_err("No default for option '%s'", o->id);
+				return SRD_ERR_PYTHON;
+			}
+			if (!PyTuple_Check(py_val)) {
+				srd_err("Option '%s' values should be a tuple.", o->id);
+				return SRD_ERR_PYTHON;
+			}
+			for (i = 0; i < PyTuple_Size(py_val); i++) {
+				py_item = PyTuple_GetItem(py_val, i);
+				if (Py_TYPE(py_default) != Py_TYPE(py_item)) {
+					srd_err("All values for option '%s' must be "
+							"of the same type as the default.",
+							o->id);
+					return SRD_ERR_PYTHON;
+				}
+				if (PyUnicode_Check(py_item)) {
+					/* UTF-8 string */
+					py_str_as_str(py_item, &sval);
+					gvar = g_variant_new_string(sval);
+					g_variant_ref_sink(gvar);
+					g_free(sval);
+					o->values = g_slist_append(o->values, gvar);
+				} else if (PyLong_Check(py_item)) {
+					/* Long */
+					lval = PyLong_AsLongAndOverflow(py_item, &overflow);
+					if (overflow) {
+						/* Value is < LONG_MIN or > LONG_MAX */
+						PyErr_Clear();
+						srd_err("Protocol decoder %s option 'values' "
+								"has invalid value.", d->name);
+						return SRD_ERR_PYTHON;
+					}
+					gvar = g_variant_new_int64(lval);
+					g_variant_ref_sink(gvar);
+					o->values = g_slist_append(o->values, gvar);
+				} else if (PyFloat_Check(py_item)) {
+					/* Float */
+					if ((dval = PyFloat_AsDouble(py_item)) == -1.0) {
+						PyErr_Clear();
+						srd_err("Protocol decoder %s option 'default' has "
+								"invalid default value.", d->name);
+						return SRD_ERR_PYTHON;
+					}
+					gvar = g_variant_new_double(dval);
+					g_variant_ref_sink(gvar);
+					o->values = g_slist_append(o->values, gvar);
+				}
 			}
-			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_XDECREF(py_opts);
-	g_free(key);
 
-	return ret;
+	return SRD_OK;
 }
 
 /**
@@ -244,11 +297,25 @@ err_out:
 SRD_API int srd_decoder_load(const char *module_name)
 {
 	PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
+	PyObject *py_bin_classes, *py_bin_class, *py_ann_rows, *py_ann_row;
+	PyObject *py_ann_classes, *py_long;
 	struct srd_decoder *d;
-	int alen, ret, i;
-	char **ann;
+	int ret, i, j;
+	char **ann, **bin, *ann_row_id, *ann_row_desc;
 	struct srd_probe *p;
-	GSList *l;
+	GSList *l, *ann_classes;
+	struct srd_decoder_annotation_row *ann_row;
+
+	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);
 
@@ -317,6 +384,23 @@ SRD_API int srd_decoder_load(const char *module_name)
 	}
 	Py_CLEAR(py_method);
 
+	/* Store required fields in newly allocated strings. */
+	if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
+		goto err_out;
+
+	if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
+		goto err_out;
+
+	if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
+		goto err_out;
+
+	if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
+		goto err_out;
+
+	if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
+		goto err_out;
+
+	/* All options and their default values. */
 	if (get_options(d) != SRD_OK)
 		goto err_out;
 
@@ -341,45 +425,111 @@ SRD_API int srd_decoder_load(const char *module_name)
 		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;
+	/* 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");
+		if (!PyTuple_Check(py_annlist)) {
+			srd_err("Protocol decoder %s annotations should "
+					"be a tuple.", module_name);
+			goto err_out;
+		}
+		for (i = 0; i < PyTuple_Size(py_annlist); i++) {
+			py_ann = PyTuple_GetItem(py_annlist, i);
+			if (!PyTuple_Check(py_ann) || PyTuple_Size(py_ann) != 2) {
+				srd_err("Protocol decoder %s annotation %d should "
+						"be a tuple with two elements.", module_name, i + 1);
+				goto err_out;
+			}
 
-	if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
-		goto err_out;
+			if (py_strseq_to_char(py_ann, &ann) != SRD_OK) {
+				goto err_out;
+			}
+			d->annotations = g_slist_append(d->annotations, ann);
+		}
+	}
 
-	if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
-		goto err_out;
+	/* Convert annotation_rows to GSList of 'struct srd_decoder_annotation_row'. */
+	d->annotation_rows = NULL;
+	if (PyObject_HasAttrString(d->py_dec, "annotation_rows")) {
+		py_ann_rows = PyObject_GetAttrString(d->py_dec, "annotation_rows");
+		if (!PyTuple_Check(py_ann_rows)) {
+			srd_err("Protocol decoder %s annotation row list "
+				"must be a tuple.", module_name);
+			goto err_out;
+		}
+		for (i = 0; i < PyTuple_Size(py_ann_rows); i++) {
+			py_ann_row = PyTuple_GetItem(py_ann_rows, i);
+			if (!PyTuple_Check(py_ann_row)) {
+				srd_err("Protocol decoder %s annotation rows "
+					"must be tuples.", module_name);
+				goto err_out;
+			}
+			if (PyTuple_Size(py_ann_row) != 3
+					|| !PyUnicode_Check(PyTuple_GetItem(py_ann_row, 0))
+					|| !PyUnicode_Check(PyTuple_GetItem(py_ann_row, 1))
+					|| !PyTuple_Check(PyTuple_GetItem(py_ann_row, 2))) {
+				srd_err("Protocol decoder %s annotation rows "
+					"must contain tuples containing two "
+					"strings and a tuple.", module_name);
+				goto err_out;
+			}
 
-	if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
-		goto err_out;
+			if (py_str_as_str(PyTuple_GetItem(py_ann_row, 0), &ann_row_id) != SRD_OK)
+				goto err_out;
 
-	if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
-		goto err_out;
+			if (py_str_as_str(PyTuple_GetItem(py_ann_row, 1), &ann_row_desc) != SRD_OK)
+				goto err_out;
 
-	/* 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.", module_name);
+			py_ann_classes = PyTuple_GetItem(py_ann_row, 2);
+			ann_classes = NULL;
+			for (j = 0; j < PyTuple_Size(py_ann_classes); j++) {
+				py_long = PyTuple_GetItem(py_ann_classes, j);
+				if (!PyLong_Check(py_long)) {
+					srd_err("Protocol decoder %s annotation row class "
+						"list must only contain numbers.", module_name);
+					goto err_out;
+				}
+				ann_classes = g_slist_append(ann_classes,
+					GINT_TO_POINTER(PyLong_AsLong(py_long)));
+			}
+
+			ann_row = g_malloc0(sizeof(struct srd_decoder_annotation_row));
+			ann_row->id = ann_row_id;
+			ann_row->desc = ann_row_desc;
+			ann_row->ann_classes = ann_classes;
+			d->annotation_rows = g_slist_append(d->annotation_rows, ann_row);
+		}
+	}
+
+	/* 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 %s binary classes should "
+					"be a tuple.", 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.", module_name, i + 1);
+		for (i = 0; i < PyTuple_Size(py_bin_classes); i++) {
+			py_bin_class = PyTuple_GetItem(py_bin_classes, i);
+			if (!PyTuple_Check(py_bin_class)) {
+				srd_err("Protocol decoder %s binary classes "
+						"should consist of tuples.", module_name);
+				goto err_out;
+			}
+			if (PyTuple_Size(py_bin_class) != 2
+					|| !PyUnicode_Check(PyTuple_GetItem(py_bin_class, 0))
+					|| !PyUnicode_Check(PyTuple_GetItem(py_bin_class, 1))) {
+				srd_err("Protocol decoder %s binary classes should "
+						"contain tuples with two strings.", module_name);
 				goto err_out;
 			}
 
-			if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
+			if (py_strseq_to_char(py_bin_class, &bin) != SRD_OK) {
 				goto err_out;
 			}
-			d->annotations = g_slist_append(d->annotations, ann);
+			d->binary = g_slist_append(d->binary, bin);
 		}
 	}
 
@@ -415,6 +565,12 @@ 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;
 
@@ -461,8 +617,15 @@ static void free_probes(GSList *probelist)
 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);
 
 	/*
@@ -471,7 +634,10 @@ 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;
@@ -500,6 +666,26 @@ SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 	return SRD_OK;
 }
 
+static void srd_decoder_load_all_path(char *path)
+{
+	GDir *dir;
+	const gchar *direntry;
+
+	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.
  *
@@ -509,20 +695,13 @@ SRD_API int srd_decoder_unload(struct srd_decoder *dec)
  */
 SRD_API int srd_decoder_load_all(void)
 {
-	GDir *dir;
-	GError *error;
-	const gchar *direntry;
+	GSList *l;
 
-	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 (!srd_check_init())
+		return SRD_ERR;
 
-	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);
+	for (l = searchpaths; l; l = l->next)
+		srd_decoder_load_all_path(l->data);
 
 	return SRD_OK;
 }
@@ -543,6 +722,8 @@ 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;
 }