[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. */
GSList *pd_list = NULL;

/* module_sigrokdecode.c */
extern 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.
 */
GSList *srd_list_decoders(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.
 */
struct srd_decoder *srd_get_decoder_by_id(const char *id)
{
	GSList *l;
	struct srd_decoder *dec;

	for (l = srd_list_decoders(); 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)))) {
			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.
 * @param dec Pointer to the struct srd_decoder filled with the loaded module.
 *
 * @return SRD_OK upon success, a (negative) error code otherwise.
 */
int srd_load_decoder(const char *name, struct srd_decoder **dec)
{
	PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
	struct srd_decoder *d;
	int alen, ret, i;
	char **ann;

	srd_dbg("Loading module '%s'.", name);

	py_basedec = py_method = py_attr = NULL;

	if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
		srd_dbg("Failed to 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(name))) {
		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_Clear();
		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.");
		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);
		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.", 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.", 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.", 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.", 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.", 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);
				goto err_out;
			}

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

	*dec = 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;
}

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

int srd_load_all_decoders(void)
{
	GDir *dir;
	GError *error;
	struct srd_decoder *dec;
	int ret;
	const gchar *direntry;
	char *decodername;

	if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
		return SRD_ERR_DECODERS_DIR;
	}

	while ((direntry = g_dir_read_name(dir)) != NULL) {
		/* The decoder name is the PD directory name (e.g. "i2c"). */
		decodername = g_strdup(direntry);

		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);
		}
	}
	g_dir_close(dir);

	return SRD_OK;
}

/**
 * TODO
 */
int srd_unload_all_decoders(void)
{
	GSList *l;
	struct srd_decoder *dec;

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