[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(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)))) {
			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 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;

	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))) {
		catch_exception("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;

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

	/* TODO: Handle inputformats, outputformats. */
	d->inputformats = NULL;
	d->outputformats = NULL;

	/* 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(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__"))) {
		catch_exception("");
		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);

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

	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
f38ec285 BV	65	static int get_probes(struct srd_decoder d, char attr, GSList **pl)
	66	{
	67	PyObject py_probelist, py_entry;
	68	struct srd_probe *p;
	69	int ret, num_probes, i;
	70
	71	if (!PyObject_HasAttrString(d->py_dec, attr))
	72	/* No probes of this type specified. */
	73	return SRD_OK;
	74
	75	ret = SRD_ERR_PYTHON;
	76	py_probelist = py_entry = NULL;
	77
	78	py_probelist = PyObject_GetAttrString(d->py_dec, attr);
	79	if (!PyList_Check(py_probelist)) {
	80	srd_err("Protocol decoder %s %s attribute is not "
c9bfccc6	81	"a list.", d->name, attr);
f38ec285 BV	82	goto err_out;
	83	}
	84
	85	num_probes = PyList_Size(py_probelist);
	86	if (num_probes == 0)
	87	/* Empty probelist. */
	88	return SRD_OK;
	89
	90	for (i = 0; i < num_probes; i++) {
	91	py_entry = PyList_GetItem(py_probelist, i);
	92	if (!PyDict_Check(py_entry)) {
	93	srd_err("Protocol decoder %s %s attribute is not "
c9bfccc6	94	"a list with dict elements.", d->name, attr);
f38ec285 BV	95	goto err_out;
	96	}
	97
	98	if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
a61ece20	99	srd_err("Failed to g_malloc() struct srd_probe.");
f38ec285 BV	100	ret = SRD_ERR_MALLOC;
	101	goto err_out;
	102	}
	103
	104	if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
	105	goto err_out;
	106	if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
	107	goto err_out;
	108	if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
	109	goto err_out;
	110	p->order = i;
	111
	112	pl = g_slist_append(pl, p);
	113	}
	114	ret = SRD_OK;
	115
	116	err_out:
	117	Py_DecRef(py_entry);
	118	Py_DecRef(py_probelist);
	119
	120	return ret;
	121	}
	122
b2c19614	123	/**
64c29e28	124	* Load a protocol decoder module into the embedded Python interpreter.
b2c19614	125	*
15969949	126	* @param name The module name to be loaded.
b2c19614 BV	127	*
	128	* @return SRD_OK upon success, a (negative) error code otherwise.
	129	*/
9d122fd5	130	SRD_API int srd_decoder_load(const char *module_name)
b2c19614	131	{
11ea8ae1	132	PyObject py_basedec, py_method, py_attr, py_annlist, *py_ann;
b2c19614	133	struct srd_decoder *d;
451680f1	134	int alen, ret, i;
15969949	135	char **ann;
b2c19614	136
8ad6e500	137	srd_dbg("Loading protocol decoder '%s'.", module_name);
64c29e28	138
d906d3f9	139	py_basedec = py_method = py_attr = NULL;
b2c19614	140
451680f1	141	if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
a61ece20	142	srd_dbg("Failed to g_malloc() struct srd_decoder.");
451680f1 BV	143	ret = SRD_ERR_MALLOC;
451680f1 BV	144	goto err_out;
b2c19614 BV	145	}
b2c19614 BV	146
21481b66 BV	147	ret = SRD_ERR_PYTHON;
21481b66 BV	148
451680f1	149	/* Import the Python module. */
9b37109d	150	if (!(d->py_mod = PyImport_ImportModule(module_name))) {
361fdcaa	151	catch_exception("Import of '%s' failed.", module_name);
451680f1 BV	152	goto err_out;
451680f1 BV	153	}
b2c19614	154
451680f1 BV	155	/* Get the 'Decoder' class as Python object. */
	156	if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
	157	/* This generated an AttributeError exception. */
	158	PyErr_Clear();
361fdcaa UH	159	srd_err("Decoder class not found in protocol decoder %s.",
361fdcaa UH	160	module_name);
451680f1 BV	161	goto err_out;
451680f1 BV	162	}
b2c19614	163
451680f1	164	if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
7a1712c4	165	srd_dbg("sigrokdecode module not loaded.");
451680f1 BV	166	goto err_out;
451680f1 BV	167	}
b2c19614	168
451680f1 BV	169	if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
451680f1 BV	170	srd_err("Decoder class in protocol decoder module %s is not "
9b37109d	171	"a subclass of sigrokdecode.Decoder.", module_name);
451680f1 BV	172	goto err_out;
451680f1 BV	173	}
ad022d94	174	Py_CLEAR(py_basedec);
b2c19614	175
1d552cd3 BV	176	/* Check for a proper start() method. */
	177	if (!PyObject_HasAttrString(d->py_dec, "start")) {
	178	srd_err("Protocol decoder %s has no start() method Decoder "
9b37109d	179	"class.", module_name);
1d552cd3 BV	180	goto err_out;
	181	}
	182	py_method = PyObject_GetAttrString(d->py_dec, "start");
	183	if (!PyFunction_Check(py_method)) {
d906d3f9	184	srd_err("Protocol decoder %s Decoder class attribute 'start' "
9b37109d	185	"is not a method.", module_name);
1d552cd3 BV	186	goto err_out;
1d552cd3 BV	187	}
ad022d94	188	Py_CLEAR(py_method);
1d552cd3 BV	189
	190	/* Check for a proper decode() method. */
	191	if (!PyObject_HasAttrString(d->py_dec, "decode")) {
	192	srd_err("Protocol decoder %s has no decode() method Decoder "
9b37109d	193	"class.", module_name);
1d552cd3 BV	194	goto err_out;
	195	}
	196	py_method = PyObject_GetAttrString(d->py_dec, "decode");
	197	if (!PyFunction_Check(py_method)) {
	198	srd_err("Protocol decoder %s Decoder class attribute 'decode' "
9b37109d	199	"is not a method.", module_name);
1d552cd3 BV	200	goto err_out;
1d552cd3 BV	201	}
ad022d94	202	Py_CLEAR(py_method);
1d552cd3	203
11ea8ae1 BV	204	/* If present, options must be a dictionary. */
	205	if (PyObject_HasAttrString(d->py_dec, "options")) {
	206	py_attr = PyObject_GetAttrString(d->py_dec, "options");
	207	if (!PyDict_Check(py_attr)) {
	208	srd_err("Protocol decoder %s options attribute is not "
c9bfccc6	209	"a dictionary.", d->name);
ad022d94	210	Py_DecRef(py_attr);
11ea8ae1 BV	211	goto err_out;
	212	}
	213	Py_DecRef(py_attr);
	214	}
	215
f38ec285 BV	216	/* Check and import required probes. */
	217	if (get_probes(d, "probes", &d->probes) != SRD_OK)
	218	goto err_out;
	219
	220	/* Check and import optional probes. */
dcdf4883	221	if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
f38ec285 BV	222	goto err_out;
	223
	224	/* Store required fields in newly allocated strings. */
21481b66	225	if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
451680f1	226	goto err_out;
b2c19614	227
21481b66	228	if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
451680f1	229	goto err_out;
b2c19614	230
21481b66	231	if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
451680f1	232	goto err_out;
b2c19614	233
21481b66	234	if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
451680f1	235	goto err_out;
b2c19614	236
21481b66	237	if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
451680f1	238	goto err_out;
b2c19614	239
451680f1	240	/* TODO: Handle inputformats, outputformats. */
b2c19614 BV	241	d->inputformats = NULL;
	242	d->outputformats = NULL;
	243
361fdcaa	244	/* Convert class annotation attribute to GSList of *char. /
e97b6ef5	245	d->annotations = NULL;
451680f1 BV	246	if (PyObject_HasAttrString(d->py_dec, "annotations")) {
451680f1 BV	247	py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
15969949	248	if (!PyList_Check(py_annlist)) {
c9bfccc6	249	srd_err("Protocol decoder module %s annotations "
9b37109d	250	"should be a list.", module_name);
451680f1	251	goto err_out;
15969949 BV	252	}
	253	alen = PyList_Size(py_annlist);
	254	for (i = 0; i < alen; i++) {
	255	py_ann = PyList_GetItem(py_annlist, i);
	256	if (!PyList_Check(py_ann) \|\| PyList_Size(py_ann) != 2) {
c9bfccc6 UH	257	srd_err("Protocol decoder module %s "
c9bfccc6 UH	258	"annotation %d should be a list with "
9b37109d	259	"two elements.", module_name, i + 1);
451680f1	260	goto err_out;
15969949 BV	261	}
15969949 BV	262
451680f1	263	if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
451680f1 BV	264	goto err_out;
451680f1 BV	265	}
e97b6ef5	266	d->annotations = g_slist_append(d->annotations, ann);
15969949 BV	267	}
	268	}
	269
9b37109d BV	270	/* Append it to the list of supported/loaded decoders. */
	271	pd_list = g_slist_append(pd_list, d);
	272
451680f1 BV	273	ret = SRD_OK;
	274
	275	err_out:
	276	if (ret != SRD_OK) {
1d552cd3	277	Py_XDECREF(py_method);
451680f1 BV	278	Py_XDECREF(py_basedec);
	279	Py_XDECREF(d->py_dec);
	280	Py_XDECREF(d->py_mod);
	281	g_free(d);
	282	}
b2c19614	283
451680f1 BV	284	return ret;
	285	}
	286
582c8473 BV	287	/**
	288	* Return a protocol decoder's docstring.
	289	*
	290	* @param dec The loaded protocol decoder.
	291	*
361fdcaa	292	* @return A newly allocated buffer containing the protocol decoder's
abeeed8b	293	* documentation. The caller is responsible for free'ing the buffer.
582c8473	294	*/
abeeed8b	295	SRD_API char srd_decoder_doc(const struct srd_decoder dec)
451680f1	296	{
e7edca07	297	PyObject *py_str;
451680f1 BV	298	char *doc;
451680f1 BV	299
e7edca07 BV	300	if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
	301	return NULL;
	302
	303	if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
2086c684	304	catch_exception("");
e7edca07 BV	305	return NULL;
	306	}
	307
451680f1	308	doc = NULL;
e7edca07 BV	309	if (py_str != Py_None)
	310	py_str_as_str(py_str, &doc);
	311	Py_DecRef(py_str);
451680f1 BV	312
451680f1 BV	313	return doc;
b2c19614 BV	314	}
b2c19614 BV	315
fa12a21e BV	316	static void free_probes(GSList *probelist)
	317	{
	318	GSList *l;
	319	struct srd_probe *p;
	320
	321	if (probelist == NULL)
	322	return;
	323
	324	for (l = probelist; l; l = l->next) {
	325	p = l->data;
	326	g_free(p->id);
	327	g_free(p->name);
	328	g_free(p->desc);
	329	g_free(p);
	330	}
	331	g_slist_free(probelist);
fa12a21e BV	332	}
fa12a21e BV	333
b2c19614	334	/**
451680f1 BV	335	* Unload decoder module.
451680f1 BV	336	*
fa12a21e	337	* @param dec The struct srd_decoder to be unloaded.
451680f1 BV	338	*
451680f1 BV	339	* @return SRD_OK upon success, a (negative) error code otherwise.
b2c19614	340	*/
9d122fd5	341	SRD_API int srd_decoder_unload(struct srd_decoder *dec)
b2c19614	342	{
8ad6e500	343	srd_dbg("Unloading protocol decoder '%s'.", dec->name);
fa12a21e	344
361fdcaa UH	345	/*
361fdcaa UH	346	* Since any instances of this decoder need to be released as well,
fa12a21e BV	347	* but they could be anywhere in the stack, just free the entire
fa12a21e BV	348	* stack. A frontend reloading a decoder thus has to restart all
361fdcaa UH	349	* instances, and rebuild the stack.
361fdcaa UH	350	*/
a8b72b05	351	srd_inst_free_all(NULL);
fa12a21e BV	352
fa12a21e BV	353	free_probes(dec->probes);
dcdf4883	354	free_probes(dec->opt_probes);
b2c19614 BV	355	g_free(dec->id);
b2c19614 BV	356	g_free(dec->name);
b231546d	357	g_free(dec->longname);
b2c19614	358	g_free(dec->desc);
b231546d	359	g_free(dec->license);
b2c19614 BV	360
b2c19614 BV	361	/* TODO: Free everything in inputformats and outputformats. */
b2c19614 BV	362	if (dec->inputformats != NULL)
	363	g_slist_free(dec->inputformats);
	364	if (dec->outputformats != NULL)
	365	g_slist_free(dec->outputformats);
	366
fa12a21e	367	/* The module's Decoder class. */
451680f1	368	Py_XDECREF(dec->py_dec);
fa12a21e	369	/* The module itself. */
b2c19614 BV	370	Py_XDECREF(dec->py_mod);
	371
	372	/* TODO: (g_)free dec itself? */
	373
	374	return SRD_OK;
	375	}
	376
582c8473	377	/**
9b37109d	378	* Load all installed protocol decoders.
582c8473 BV	379	*
	380	* @return SRD_OK upon success, a (negative) error code otherwise.
	381	*/
8ad6e500	382	SRD_API int srd_decoder_load_all(void)
b2c19614	383	{
eb2bbd66 BV	384	GDir *dir;
eb2bbd66 BV	385	GError *error;
eb2bbd66	386	const gchar *direntry;
b2c19614	387
eb2bbd66	388	if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
9b37109d	389	srd_err("Unable to open %s for reading.", DECODERS_DIR);
b2c19614 BV	390	return SRD_ERR_DECODERS_DIR;
	391	}
	392
eb2bbd66	393	while ((direntry = g_dir_read_name(dir)) != NULL) {
9b37109d	394	/* The directory name is the module name (e.g. "i2c"). */
9d122fd5	395	srd_decoder_load(direntry);
b2c19614	396	}
eb2bbd66	397	g_dir_close(dir);
b2c19614 BV	398
	399	return SRD_OK;
	400	}
	401
b2c19614	402	/**
582c8473 BV	403	* Unload all loaded protocol decoders.
	404	*
	405	* @return SRD_OK upon success, a (negative) error code otherwise.
b2c19614	406	*/
8ad6e500	407	SRD_API int srd_decoder_unload_all(void)
b2c19614 BV	408	{
	409	GSList *l;
	410	struct srd_decoder *dec;
	411
8ad6e500	412	for (l = srd_decoder_list(); l; l = l->next) {
b2c19614	413	dec = l->data;
9d122fd5	414	srd_decoder_unload(dec);
b2c19614 BV	415	}
	416
	417	return SRD_OK;
	418	}