[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>

/**
 * @file
 *
 * Listing, loading, unloading, and handling protocol decoders.
 */

/** @cond PRIVATE */

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

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

/** @endcond */

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