[libsigrokdecode.git] / decoder.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
 * 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
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "config.h"
#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include "sigrokdecode-internal.h"
#include <glib.h>

/* The list of protocol decoders. */
SRD_PRIV GSList *pd_list = NULL;

/* module_sigrokdecode.c */
extern SRD_PRIV PyObject *mod_sigrokdecode;

/**
 * Returns the list of supported/loaded protocol decoders.
 *
 * This is a GSList containing the names of the decoders as strings.
 *
 * @return List of decoders, NULL if none are supported or loaded.
 */
SRD_API 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.
 */
SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
{
	GSList *l;
	struct srd_decoder *dec;

	for (l = srd_decoder_list(); l; l = l->next) {
		dec = l->data;
		if (!strcmp(dec->id, id))
			return dec;
	}

	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;
}

/**
 * Load a protocol decoder module into the embedded Python interpreter.
 *
 * @param module_name The module name to be loaded.
 *
 * @return SRD_OK upon success, a (negative) error code otherwise.
 */
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("Loading protocol decoder '%s'.", module_name);

	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;
	}

	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;
	}

	/* 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 (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
		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.", module_name);
		goto err_out;
	}
	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.", 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);

	/* 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 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);
	}

	/* 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);
	}

	/* 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;

	/* 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);
			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);
				goto err_out;
			}

			if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
				goto err_out;
			}
			d->annotations = g_slist_append(d->annotations, ann);
		}
	}

	/* Append it to the list of supported/loaded decoders. */
	pd_list = g_slist_append(pd_list, d);

	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.
 */
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);
}

/**
 * Unload decoder module.
 *
 * @param dec The struct srd_decoder to be unloaded.
 *
 * @return SRD_OK upon success, a (negative) error code otherwise.
 */
SRD_API int srd_decoder_unload(struct srd_decoder *dec)
{
	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);

	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);

	/* The module's Decoder class. */
	Py_XDECREF(dec->py_dec);
	/* The module itself. */
	Py_XDECREF(dec->py_mod);

	/* TODO: (g_)free dec itself? */

	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)
{
	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;
	}

	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);

	return SRD_OK;
}

/**
 * Unload all loaded protocol decoders.
 *
 * @return SRD_OK upon success, a (negative) error code otherwise.
 */
SRD_API int srd_decoder_unload_all(void)
{
	GSList *l;
	struct srd_decoder *dec;

	for (l = srd_decoder_list(); l; l = l->next) {
		dec = l->data;
		srd_decoder_unload(dec);
	}

	return SRD_OK;
}
Commit	Line	Data
b2c19614 BV	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
4fadb128	5	* Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
b2c19614 BV	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation, either version 3 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
	21	#include "config.h"
73191416	22	#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
15969949	23	#include "sigrokdecode-internal.h"
eb2bbd66	24	#include <glib.h>
b2c19614 BV	25
b2c19614 BV	26	/* The list of protocol decoders. */
55c3c5f4	27	SRD_PRIV GSList *pd_list = NULL;
b2c19614	28
c9bfccc6	29	/* module_sigrokdecode.c */
55c3c5f4	30	extern SRD_PRIV PyObject *mod_sigrokdecode;
451680f1	31
b2c19614 BV	32	/**
	33	* Returns the list of supported/loaded protocol decoders.
	34	*
	35	* This is a GSList containing the names of the decoders as strings.
	36	*
	37	* @return List of decoders, NULL if none are supported or loaded.
	38	*/
8ad6e500	39	SRD_API GSList *srd_decoder_list(void)
b2c19614	40	{
e5080882	41	return pd_list;
b2c19614 BV	42	}
b2c19614 BV	43
b2c19614 BV	44	/**
	45	* Get the decoder with the specified ID.
	46	*
	47	* @param id The ID string of the decoder to return.
582c8473	48	*
b2c19614 BV	49	* @return The decoder with the specified ID, or NULL if not found.
b2c19614 BV	50	*/
9d122fd5	51	SRD_API struct srd_decoder srd_decoder_get_by_id(const char id)
b2c19614 BV	52	{
	53	GSList *l;
	54	struct srd_decoder *dec;
	55
8ad6e500	56	for (l = srd_decoder_list(); l; l = l->next) {
b2c19614 BV	57	dec = l->data;
	58	if (!strcmp(dec->id, id))
	59	return dec;
	60	}
	61
	62	return NULL;
	63	}
	64
5a2c4dc4 UH	65	static int get_probes(const struct srd_decoder d, const char attr,
5a2c4dc4 UH	66	GSList **pl)
f38ec285 BV	67	{
	68	PyObject py_probelist, py_entry;
	69	struct srd_probe *p;
	70	int ret, num_probes, i;
	71
	72	if (!PyObject_HasAttrString(d->py_dec, attr))
	73	/* No probes of this type specified. */
	74	return SRD_OK;
	75
	76	ret = SRD_ERR_PYTHON;
	77	py_probelist = py_entry = NULL;
	78
	79	py_probelist = PyObject_GetAttrString(d->py_dec, attr);
	80	if (!PyList_Check(py_probelist)) {
	81	srd_err("Protocol decoder %s %s attribute is not "
c9bfccc6	82	"a list.", d->name, attr);
f38ec285 BV	83	goto err_out;
	84	}
	85
	86	num_probes = PyList_Size(py_probelist);
	87	if (num_probes == 0)
	88	/* Empty probelist. */
	89	return SRD_OK;
	90
	91	for (i = 0; i < num_probes; i++) {
	92	py_entry = PyList_GetItem(py_probelist, i);
	93	if (!PyDict_Check(py_entry)) {
	94	srd_err("Protocol decoder %s %s attribute is not "
c9bfccc6	95	"a list with dict elements.", d->name, attr);
f38ec285 BV	96	goto err_out;
	97	}
	98
	99	if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
a61ece20	100	srd_err("Failed to g_malloc() struct srd_probe.");
f38ec285 BV	101	ret = SRD_ERR_MALLOC;
	102	goto err_out;
	103	}
	104
	105	if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
	106	goto err_out;
	107	if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
	108	goto err_out;
	109	if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
	110	goto err_out;
	111	p->order = i;
	112
	113	pl = g_slist_append(pl, p);
	114	}
	115	ret = SRD_OK;
	116
	117	err_out:
	118	Py_DecRef(py_entry);
	119	Py_DecRef(py_probelist);
	120
	121	return ret;
	122	}
	123
b2c19614	124	/**
64c29e28	125	* Load a protocol decoder module into the embedded Python interpreter.
b2c19614	126	*
29590b14	127	* @param module_name The module name to be loaded.
b2c19614 BV	128	*
	129	* @return SRD_OK upon success, a (negative) error code otherwise.
	130	*/
9d122fd5	131	SRD_API int srd_decoder_load(const char *module_name)
b2c19614	132	{
11ea8ae1	133	PyObject py_basedec, py_method, py_attr, py_annlist, *py_ann;
b2c19614	134	struct srd_decoder *d;
451680f1	135	int alen, ret, i;
15969949	136	char **ann;
dd93276b UH	137	struct srd_probe *p;
dd93276b UH	138	GSList *l;
b2c19614	139
8ad6e500	140	srd_dbg("Loading protocol decoder '%s'.", module_name);
64c29e28	141
d906d3f9	142	py_basedec = py_method = py_attr = NULL;
b2c19614	143
451680f1	144	if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
a61ece20	145	srd_dbg("Failed to g_malloc() struct srd_decoder.");
451680f1 BV	146	ret = SRD_ERR_MALLOC;
451680f1 BV	147	goto err_out;
b2c19614 BV	148	}
b2c19614 BV	149
21481b66 BV	150	ret = SRD_ERR_PYTHON;
21481b66 BV	151
451680f1	152	/* Import the Python module. */
9b37109d	153	if (!(d->py_mod = PyImport_ImportModule(module_name))) {
aafeeaea	154	srd_exception_catch("Import of '%s' failed.", module_name);
451680f1 BV	155	goto err_out;
451680f1 BV	156	}
b2c19614	157
451680f1 BV	158	/* Get the 'Decoder' class as Python object. */
	159	if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
	160	/* This generated an AttributeError exception. */
	161	PyErr_Clear();
361fdcaa UH	162	srd_err("Decoder class not found in protocol decoder %s.",
361fdcaa UH	163	module_name);
451680f1 BV	164	goto err_out;
451680f1 BV	165	}
b2c19614	166
451680f1	167	if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
7a1712c4	168	srd_dbg("sigrokdecode module not loaded.");
451680f1 BV	169	goto err_out;
451680f1 BV	170	}
b2c19614	171
451680f1 BV	172	if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
451680f1 BV	173	srd_err("Decoder class in protocol decoder module %s is not "
9b37109d	174	"a subclass of sigrokdecode.Decoder.", module_name);
451680f1 BV	175	goto err_out;
451680f1 BV	176	}
ad022d94	177	Py_CLEAR(py_basedec);
b2c19614	178
1d552cd3 BV	179	/* Check for a proper start() method. */
	180	if (!PyObject_HasAttrString(d->py_dec, "start")) {
	181	srd_err("Protocol decoder %s has no start() method Decoder "
9b37109d	182	"class.", module_name);
1d552cd3 BV	183	goto err_out;
	184	}
	185	py_method = PyObject_GetAttrString(d->py_dec, "start");
	186	if (!PyFunction_Check(py_method)) {
d906d3f9	187	srd_err("Protocol decoder %s Decoder class attribute 'start' "
9b37109d	188	"is not a method.", module_name);
1d552cd3 BV	189	goto err_out;
1d552cd3 BV	190	}
ad022d94	191	Py_CLEAR(py_method);
1d552cd3 BV	192
	193	/* Check for a proper decode() method. */
	194	if (!PyObject_HasAttrString(d->py_dec, "decode")) {
	195	srd_err("Protocol decoder %s has no decode() method Decoder "
9b37109d	196	"class.", module_name);
1d552cd3 BV	197	goto err_out;
	198	}
	199	py_method = PyObject_GetAttrString(d->py_dec, "decode");
	200	if (!PyFunction_Check(py_method)) {
	201	srd_err("Protocol decoder %s Decoder class attribute 'decode' "
9b37109d	202	"is not a method.", module_name);
1d552cd3 BV	203	goto err_out;
1d552cd3 BV	204	}
ad022d94	205	Py_CLEAR(py_method);
1d552cd3	206
11ea8ae1 BV	207	/* If present, options must be a dictionary. */
	208	if (PyObject_HasAttrString(d->py_dec, "options")) {
	209	py_attr = PyObject_GetAttrString(d->py_dec, "options");
	210	if (!PyDict_Check(py_attr)) {
	211	srd_err("Protocol decoder %s options attribute is not "
c9bfccc6	212	"a dictionary.", d->name);
ad022d94	213	Py_DecRef(py_attr);
11ea8ae1 BV	214	goto err_out;
	215	}
	216	Py_DecRef(py_attr);
	217	}
	218
f38ec285 BV	219	/* Check and import required probes. */
	220	if (get_probes(d, "probes", &d->probes) != SRD_OK)
	221	goto err_out;
	222
	223	/* Check and import optional probes. */
dcdf4883	224	if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
f38ec285 BV	225	goto err_out;
f38ec285 BV	226
dd93276b UH	227	/*
	228	* Fix order numbers for the optional probes.
	229	*
	230	* Example:
	231	* Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
	232	* 'order' fields in the d->probes list = 0, 1, 2.
	233	* 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
	234	*/
	235	for (l = d->opt_probes; l; l = l->next) {
	236	p = l->data;
	237	p->order += g_slist_length(d->probes);
	238	}
	239
f38ec285	240	/* Store required fields in newly allocated strings. */
21481b66	241	if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
451680f1	242	goto err_out;
b2c19614	243
21481b66	244	if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
451680f1	245	goto err_out;
b2c19614	246
21481b66	247	if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
451680f1	248	goto err_out;
b2c19614	249
21481b66	250	if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
451680f1	251	goto err_out;
b2c19614	252
21481b66	253	if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
451680f1	254	goto err_out;
b2c19614	255
361fdcaa	256	/* Convert class annotation attribute to GSList of *char. /
e97b6ef5	257	d->annotations = NULL;
451680f1 BV	258	if (PyObject_HasAttrString(d->py_dec, "annotations")) {
451680f1 BV	259	py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
15969949	260	if (!PyList_Check(py_annlist)) {
c9bfccc6	261	srd_err("Protocol decoder module %s annotations "
9b37109d	262	"should be a list.", module_name);
451680f1	263	goto err_out;
15969949 BV	264	}
	265	alen = PyList_Size(py_annlist);
	266	for (i = 0; i < alen; i++) {
	267	py_ann = PyList_GetItem(py_annlist, i);
	268	if (!PyList_Check(py_ann) \|\| PyList_Size(py_ann) != 2) {
c9bfccc6 UH	269	srd_err("Protocol decoder module %s "
c9bfccc6 UH	270	"annotation %d should be a list with "
9b37109d	271	"two elements.", module_name, i + 1);
451680f1	272	goto err_out;
15969949 BV	273	}
15969949 BV	274
451680f1	275	if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
451680f1 BV	276	goto err_out;
451680f1 BV	277	}
e97b6ef5	278	d->annotations = g_slist_append(d->annotations, ann);
15969949 BV	279	}
	280	}
	281
9b37109d BV	282	/* Append it to the list of supported/loaded decoders. */
	283	pd_list = g_slist_append(pd_list, d);
	284
451680f1 BV	285	ret = SRD_OK;
	286
	287	err_out:
	288	if (ret != SRD_OK) {
1d552cd3	289	Py_XDECREF(py_method);
451680f1 BV	290	Py_XDECREF(py_basedec);
	291	Py_XDECREF(d->py_dec);
	292	Py_XDECREF(d->py_mod);
	293	g_free(d);
	294	}
b2c19614	295
451680f1 BV	296	return ret;
	297	}
	298
582c8473 BV	299	/**
	300	* Return a protocol decoder's docstring.
	301	*
	302	* @param dec The loaded protocol decoder.
	303	*
361fdcaa	304	* @return A newly allocated buffer containing the protocol decoder's
abeeed8b	305	* documentation. The caller is responsible for free'ing the buffer.
582c8473	306	*/
b33b8aa5	307	SRD_API char srd_decoder_doc_get(const struct srd_decoder dec)
451680f1	308	{
e7edca07	309	PyObject *py_str;
451680f1 BV	310	char *doc;
451680f1 BV	311
e7edca07 BV	312	if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
	313	return NULL;
	314
	315	if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
aafeeaea	316	srd_exception_catch("");
e7edca07 BV	317	return NULL;
	318	}
	319
451680f1	320	doc = NULL;
e7edca07 BV	321	if (py_str != Py_None)
	322	py_str_as_str(py_str, &doc);
	323	Py_DecRef(py_str);
451680f1 BV	324
451680f1 BV	325	return doc;
b2c19614 BV	326	}
b2c19614 BV	327
fa12a21e BV	328	static void free_probes(GSList *probelist)
	329	{
	330	GSList *l;
	331	struct srd_probe *p;
	332
	333	if (probelist == NULL)
	334	return;
	335
	336	for (l = probelist; l; l = l->next) {
	337	p = l->data;
	338	g_free(p->id);
	339	g_free(p->name);
	340	g_free(p->desc);
	341	g_free(p);
	342	}
	343	g_slist_free(probelist);
fa12a21e BV	344	}
fa12a21e BV	345
b2c19614	346	/**
451680f1 BV	347	* Unload decoder module.
451680f1 BV	348	*
fa12a21e	349	* @param dec The struct srd_decoder to be unloaded.
451680f1 BV	350	*
451680f1 BV	351	* @return SRD_OK upon success, a (negative) error code otherwise.
b2c19614	352	*/
9d122fd5	353	SRD_API int srd_decoder_unload(struct srd_decoder *dec)
b2c19614	354	{
8ad6e500	355	srd_dbg("Unloading protocol decoder '%s'.", dec->name);
fa12a21e	356
361fdcaa UH	357	/*
361fdcaa UH	358	* Since any instances of this decoder need to be released as well,
fa12a21e BV	359	* but they could be anywhere in the stack, just free the entire
fa12a21e BV	360	* stack. A frontend reloading a decoder thus has to restart all
361fdcaa UH	361	* instances, and rebuild the stack.
361fdcaa UH	362	*/
a8b72b05	363	srd_inst_free_all(NULL);
fa12a21e BV	364
fa12a21e BV	365	free_probes(dec->probes);
dcdf4883	366	free_probes(dec->opt_probes);
b2c19614 BV	367	g_free(dec->id);
b2c19614 BV	368	g_free(dec->name);
b231546d	369	g_free(dec->longname);
b2c19614	370	g_free(dec->desc);
b231546d	371	g_free(dec->license);
b2c19614	372
fa12a21e	373	/* The module's Decoder class. */
451680f1	374	Py_XDECREF(dec->py_dec);
fa12a21e	375	/* The module itself. */
b2c19614 BV	376	Py_XDECREF(dec->py_mod);
	377
	378	/* TODO: (g_)free dec itself? */
	379
	380	return SRD_OK;
	381	}
	382
582c8473	383	/**
9b37109d	384	* Load all installed protocol decoders.
582c8473 BV	385	*
	386	* @return SRD_OK upon success, a (negative) error code otherwise.
	387	*/
8ad6e500	388	SRD_API int srd_decoder_load_all(void)
b2c19614	389	{
eb2bbd66 BV	390	GDir *dir;
eb2bbd66 BV	391	GError *error;
eb2bbd66	392	const gchar *direntry;
b2c19614	393
eb2bbd66	394	if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
9b37109d	395	srd_err("Unable to open %s for reading.", DECODERS_DIR);
b2c19614 BV	396	return SRD_ERR_DECODERS_DIR;
	397	}
	398
eb2bbd66	399	while ((direntry = g_dir_read_name(dir)) != NULL) {
9b37109d	400	/* The directory name is the module name (e.g. "i2c"). */
9d122fd5	401	srd_decoder_load(direntry);
b2c19614	402	}
eb2bbd66	403	g_dir_close(dir);
b2c19614 BV	404
	405	return SRD_OK;
	406	}
	407
b2c19614	408	/**
582c8473 BV	409	* Unload all loaded protocol decoders.
	410	*
	411	* @return SRD_OK upon success, a (negative) error code otherwise.
b2c19614	412	*/
8ad6e500	413	SRD_API int srd_decoder_unload_all(void)
b2c19614 BV	414	{
	415	GSList *l;
	416	struct srd_decoder *dec;
	417
8ad6e500	418	for (l = srd_decoder_list(); l; l = l->next) {
b2c19614	419	dec = l->data;
9d122fd5	420	srd_decoder_unload(dec);
b2c19614 BV	421	}
	422
	423	return SRD_OK;
	424	}