[libsigrokdecode.git] / decoder.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
 * Copyright (C) 2011 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;

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


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

	py_basedec = py_method = py_attr = NULL;

	srd_dbg("decoder: %s: loading module '%s'", __func__, name);

	if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
		srd_err("decoder: %s: d malloc failed", __func__);
		ret = SRD_ERR_MALLOC;
		goto err_out;
	}

	ret = SRD_ERR_PYTHON;

	/* Import the Python module. */
	if (!(d->py_mod = PyImport_ImportModule(name))) {
		/* TODO: Report exception message/traceback to err/dbg. */
		srd_warn("decoder: %s: import of '%s' failed", __func__, name);
		PyErr_Print();
		PyErr_Clear();
		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_Print();
		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_DecRef(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_DecRef(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_DecRef(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);
			goto err_out;
		}
		Py_DecRef(py_attr);
	}

	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__"))) {
		PyErr_Clear();
		return NULL;
	}

	doc = NULL;
	if (py_str != Py_None)
		py_str_as_str(py_str, &doc);
	Py_DecRef(py_str);

	return doc;
}


/**
 * Unload decoder module.
 *
 * @param dec The decoder struct to be unloaded.
 *
 * @return SRD_OK upon success, a (negative) error code otherwise.
 */
int srd_unload_decoder(struct srd_decoder *dec)
{

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

	Py_XDECREF(dec->py_dec);
	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);

		/* TODO: Error handling. Use g_try_malloc(). */
		if (!(dec = malloc(sizeof(struct srd_decoder)))) {
			Py_Finalize(); /* Returns void. */
			return SRD_ERR_MALLOC;
		}

		/* Load the decoder. */
		/* TODO: Warning if loading fails for a decoder. */
		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;
		/* TODO: Error handling. */
		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>
	5	* Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
	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
451680f1 BV	29	/* lives in module_sigrokdecode.c */
	30	extern PyObject *mod_sigrokdecode;
	31
b2c19614 BV	32
	33	/**
	34	* Returns the list of supported/loaded protocol decoders.
	35	*
	36	* This is a GSList containing the names of the decoders as strings.
	37	*
	38	* @return List of decoders, NULL if none are supported or loaded.
	39	*/
	40	GSList *srd_list_decoders(void)
	41	{
	42
e5080882	43	return pd_list;
b2c19614 BV	44	}
	45
	46
	47	/**
	48	* Get the decoder with the specified ID.
	49	*
	50	* @param id The ID string of the decoder to return.
	51	* @return The decoder with the specified ID, or NULL if not found.
	52	*/
	53	struct srd_decoder srd_get_decoder_by_id(const char id)
	54	{
	55	GSList *l;
	56	struct srd_decoder *dec;
	57
	58	for (l = srd_list_decoders(); l; l = l->next) {
	59	dec = l->data;
	60	if (!strcmp(dec->id, id))
	61	return dec;
	62	}
	63
	64	return NULL;
	65	}
	66
	67
	68	/**
64c29e28	69	* Load a protocol decoder module into the embedded Python interpreter.
b2c19614	70	*
15969949 BV	71	* @param name The module name to be loaded.
15969949 BV	72	* @param dec Pointer to the struct srd_decoder filled with the loaded module.
b2c19614 BV	73	*
	74	* @return SRD_OK upon success, a (negative) error code otherwise.
	75	*/
	76	int srd_load_decoder(const char name, struct srd_decoder *dec)
	77	{
11ea8ae1	78	PyObject py_basedec, py_method, py_attr, py_annlist, *py_ann;
b2c19614	79	struct srd_decoder *d;
451680f1	80	int alen, ret, i;
15969949	81	char **ann;
b2c19614	82
11ea8ae1	83	py_basedec = py_method = py_attr = NULL;
64c29e28 UH	84
64c29e28 UH	85	srd_dbg("decoder: %s: loading module '%s'", __func__, name);
b2c19614	86
451680f1	87	if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
64c29e28	88	srd_err("decoder: %s: d malloc failed", __func__);
451680f1 BV	89	ret = SRD_ERR_MALLOC;
451680f1 BV	90	goto err_out;
b2c19614 BV	91	}
b2c19614 BV	92
21481b66 BV	93	ret = SRD_ERR_PYTHON;
21481b66 BV	94
451680f1 BV	95	/* Import the Python module. */
451680f1 BV	96	if (!(d->py_mod = PyImport_ImportModule(name))) {
64c29e28 UH	97	/* TODO: Report exception message/traceback to err/dbg. */
	98	srd_warn("decoder: %s: import of '%s' failed", __func__, name);
	99	PyErr_Print();
451680f1	100	PyErr_Clear();
451680f1 BV	101	goto err_out;
451680f1 BV	102	}
b2c19614	103
451680f1 BV	104	/* Get the 'Decoder' class as Python object. */
	105	if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
	106	/* This generated an AttributeError exception. */
64c29e28	107	PyErr_Print();
451680f1	108	PyErr_Clear();
1d552cd3	109	srd_err("Decoder class not found in protocol decoder %s", name);
451680f1 BV	110	goto err_out;
451680f1 BV	111	}
b2c19614	112
451680f1 BV	113	if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
451680f1 BV	114	srd_dbg("sigrokdecode module not loaded");
451680f1 BV	115	goto err_out;
451680f1 BV	116	}
b2c19614	117
451680f1 BV	118	if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
	119	srd_err("Decoder class in protocol decoder module %s is not "
	120	"a subclass of sigrokdecode.Decoder", name);
451680f1 BV	121	goto err_out;
	122	}
	123	Py_DecRef(py_basedec);
b2c19614	124
1d552cd3 BV	125	/* Check for a proper start() method. */
	126	if (!PyObject_HasAttrString(d->py_dec, "start")) {
	127	srd_err("Protocol decoder %s has no start() method Decoder "
	128	"class.", name);
	129	goto err_out;
	130	}
	131	py_method = PyObject_GetAttrString(d->py_dec, "start");
	132	if (!PyFunction_Check(py_method)) {
	133	srd_err("Protocol decoder %s Decoder class attribute 'start'"
	134	"is not a method.", name);
	135	goto err_out;
	136	}
	137	Py_DecRef(py_method);
	138
	139	/* Check for a proper decode() method. */
	140	if (!PyObject_HasAttrString(d->py_dec, "decode")) {
	141	srd_err("Protocol decoder %s has no decode() method Decoder "
	142	"class.", name);
	143	goto err_out;
	144	}
	145	py_method = PyObject_GetAttrString(d->py_dec, "decode");
	146	if (!PyFunction_Check(py_method)) {
	147	srd_err("Protocol decoder %s Decoder class attribute 'decode' "
	148	"is not a method.", name);
	149	goto err_out;
	150	}
	151	Py_DecRef(py_method);
	152
11ea8ae1 BV	153	/* If present, options must be a dictionary. */
	154	if (PyObject_HasAttrString(d->py_dec, "options")) {
	155	py_attr = PyObject_GetAttrString(d->py_dec, "options");
	156	if (!PyDict_Check(py_attr)) {
	157	srd_err("Protocol decoder %s options attribute is not "
	158	"a dictionary.", d->name);
	159	goto err_out;
	160	}
	161	Py_DecRef(py_attr);
	162	}
	163
21481b66	164	if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
451680f1	165	goto err_out;
b2c19614	166
21481b66	167	if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
451680f1	168	goto err_out;
b2c19614	169
21481b66	170	if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
451680f1	171	goto err_out;
b2c19614	172
21481b66	173	if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
451680f1	174	goto err_out;
b2c19614	175
21481b66	176	if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
451680f1	177	goto err_out;
b2c19614	178
451680f1	179	/* TODO: Handle inputformats, outputformats. */
b2c19614 BV	180	d->inputformats = NULL;
	181	d->outputformats = NULL;
	182
15969949	183	/* Convert class annotation attribute to GSList of *char /
e97b6ef5	184	d->annotations = NULL;
451680f1 BV	185	if (PyObject_HasAttrString(d->py_dec, "annotations")) {
451680f1 BV	186	py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
15969949	187	if (!PyList_Check(py_annlist)) {
e97b6ef5	188	srd_err("Protocol decoder module %s annotations should be a list", name);
451680f1	189	goto err_out;
15969949 BV	190	}
	191	alen = PyList_Size(py_annlist);
	192	for (i = 0; i < alen; i++) {
	193	py_ann = PyList_GetItem(py_annlist, i);
	194	if (!PyList_Check(py_ann) \|\| PyList_Size(py_ann) != 2) {
	195	srd_err("Protocol decoder module %s annotation %d should be a list with two elements",
	196	name, i+1);
451680f1	197	goto err_out;
15969949 BV	198	}
15969949 BV	199
451680f1	200	if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
451680f1 BV	201	goto err_out;
451680f1 BV	202	}
e97b6ef5	203	d->annotations = g_slist_append(d->annotations, ann);
15969949 BV	204	}
	205	}
	206
b2c19614	207	*dec = d;
451680f1 BV	208	ret = SRD_OK;
	209
	210	err_out:
	211	if (ret != SRD_OK) {
1d552cd3	212	Py_XDECREF(py_method);
451680f1 BV	213	Py_XDECREF(py_basedec);
	214	Py_XDECREF(d->py_dec);
	215	Py_XDECREF(d->py_mod);
	216	g_free(d);
	217	}
b2c19614	218
451680f1 BV	219	return ret;
	220	}
	221
	222	char srd_decoder_doc(struct srd_decoder dec)
	223	{
e7edca07	224	PyObject *py_str;
451680f1 BV	225	char *doc;
451680f1 BV	226
e7edca07 BV	227	if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
	228	return NULL;
	229
	230	if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
	231	PyErr_Clear();
	232	return NULL;
	233	}
	234
451680f1	235	doc = NULL;
e7edca07 BV	236	if (py_str != Py_None)
	237	py_str_as_str(py_str, &doc);
	238	Py_DecRef(py_str);
451680f1 BV	239
451680f1 BV	240	return doc;
b2c19614 BV	241	}
	242
	243
	244	/**
451680f1 BV	245	* Unload decoder module.
	246	*
	247	* @param dec The decoder struct to be unloaded.
	248	*
	249	* @return SRD_OK upon success, a (negative) error code otherwise.
b2c19614 BV	250	*/
	251	int srd_unload_decoder(struct srd_decoder *dec)
	252	{
451680f1	253
b2c19614 BV	254	g_free(dec->id);
b2c19614 BV	255	g_free(dec->name);
b231546d	256	g_free(dec->longname);
b2c19614	257	g_free(dec->desc);
b231546d	258	g_free(dec->license);
b2c19614 BV	259
b2c19614 BV	260	/* TODO: Free everything in inputformats and outputformats. */
b2c19614 BV	261	if (dec->inputformats != NULL)
	262	g_slist_free(dec->inputformats);
	263	if (dec->outputformats != NULL)
	264	g_slist_free(dec->outputformats);
	265
451680f1	266	Py_XDECREF(dec->py_dec);
b2c19614 BV	267	Py_XDECREF(dec->py_mod);
	268
	269	/* TODO: (g_)free dec itself? */
	270
	271	return SRD_OK;
	272	}
	273
b2c19614 BV	274	int srd_load_all_decoders(void)
b2c19614 BV	275	{
eb2bbd66 BV	276	GDir *dir;
	277	GError *error;
	278	struct srd_decoder *dec;
b2c19614	279	int ret;
eb2bbd66	280	const gchar *direntry;
b2c19614	281	char *decodername;
b2c19614	282
eb2bbd66	283	if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
b2c19614 BV	284	return SRD_ERR_DECODERS_DIR;
	285	}
	286
eb2bbd66	287	while ((direntry = g_dir_read_name(dir)) != NULL) {
64c29e28	288	/* The decoder name is the PD directory name (e.g. "i2c"). */
eb2bbd66	289	decodername = g_strdup(direntry);
b2c19614 BV	290
	291	/* TODO: Error handling. Use g_try_malloc(). */
	292	if (!(dec = malloc(sizeof(struct srd_decoder)))) {
	293	Py_Finalize(); /* Returns void. */
	294	return SRD_ERR_MALLOC;
	295	}
	296
	297	/* Load the decoder. */
	298	/* TODO: Warning if loading fails for a decoder. */
	299	if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) {
	300	/* Append it to the list of supported/loaded decoders. */
e5080882	301	pd_list = g_slist_append(pd_list, dec);
b2c19614 BV	302	}
b2c19614 BV	303	}
eb2bbd66	304	g_dir_close(dir);
b2c19614 BV	305
	306	return SRD_OK;
	307	}
	308
b2c19614 BV	309	/**
	310	* TODO
	311	*/
	312	int srd_unload_all_decoders(void)
	313	{
	314	GSList *l;
	315	struct srd_decoder *dec;
	316
	317	for (l = srd_list_decoders(); l; l = l->next) {
	318	dec = l->data;
	319	/* TODO: Error handling. */
	320	srd_unload_decoder(dec);
	321	}
	322
	323	return SRD_OK;
	324	}
	325
	326
	327