[libsigrokdecode.git] / decode.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include <stdio.h>
#include <string.h>
#include <dirent.h>
#include <config.h>

/* Re-define some string functions for Python >= 3.0. */
#if PY_VERSION_HEX >= 0x03000000
#define PyString_AsString PyBytes_AsString
#define PyString_FromString PyBytes_FromString
#define PyString_Check PyBytes_Check
#endif

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

/*
 * Here's a quick overview of Python/C API reference counting.
 *
 * Check the Python/C API docs for what type of reference a function returns.
 *
 *  - If it returns a "new reference", you're responsible to Py_DECREF() it.
 *
 *  - If it returns a "borrowed reference", you MUST NOT Py_DECREF() it.
 *
 *  - If a function "steals" a reference, you no longer are responsible for
 *    Py_DECREF()ing it (someone else will do it for you at some point).
 */

/**
 * Initialize libsigrokdecode.
 *
 * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
 */
int sigrokdecode_init(void)
{
	DIR *dir;
	struct dirent *dp;
	char *tmp;

	/* Py_Initialize() returns void and usually cannot fail. */
	Py_Initialize();

	/* Add search directory for the protocol decoders. */
	/* FIXME: Check error code. */
	/* FIXME: What happens if this function is called multiple times? */
	PyRun_SimpleString("import sys;"
			   "sys.path.append(r'" DECODERS_DIR "');");

	if (!(dir = opendir(DECODERS_DIR)))
		return SIGROKDECODE_ERR_DECODERS_DIR;

	while ((dp = readdir(dir)) != NULL) {
		if (!g_str_has_suffix(dp->d_name, ".py"))
			continue;
		/* For now use the filename (without .py) as decoder name. */
		if ((tmp = g_strndup(dp->d_name, strlen(dp->d_name) - 3)))
			list_pds = g_slist_append(list_pds, tmp);
	}
	closedir(dir);

	return SIGROKDECODE_OK;
}

/**
 * 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 *sigrokdecode_list_decoders(void)
{
	return list_pds;
}

/**
 * Helper function to handle Python strings.
 *
 * TODO: @param entries.
 *
 * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
 *         The 'outstr' argument points to a malloc()ed string upon success.
 */
static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod,
		 const char *key, char **outstr)
{
	PyObject *py_str;
	char *str;

	py_str = PyMapping_GetItemString(py_res, (char *)key);
	if (!py_str || !PyString_Check(py_str)) {
		if (PyErr_Occurred())
			PyErr_Print(); /* Returns void. */
		Py_DECREF(py_func);
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	/*
	 * PyString_AsString()'s returned string refers to an internal buffer
	 * (not a copy), i.e. the data must not be modified, and the memory
	 * must not be free()'d.
	 */
	if (!(str = PyString_AsString(py_str))) {
		if (PyErr_Occurred())
			PyErr_Print(); /* Returns void. */
		Py_DECREF(py_str);
		Py_DECREF(py_func);
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	if (!(*outstr = strdup(str))) {
		if (PyErr_Occurred())
			PyErr_Print(); /* Returns void. */
		Py_DECREF(py_str);
		Py_DECREF(py_func);
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_MALLOC;
	}

	Py_DECREF(py_str);

	return SIGROKDECODE_OK;
}

/**
 * TODO
 *
 * @param name TODO
 *
 * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
 */
int sigrokdecode_load_decoder(const char *name,
			      struct sigrokdecode_decoder **dec)
{
	struct sigrokdecode_decoder *d;
	PyObject *py_name, *py_mod, *py_func, *py_res /* , *py_tuple */;
	int r;

	/* Get the name of the decoder module as Python string. */
	if (!(py_name = PyString_FromString(name))) { /* NEWREF */
		PyErr_Print(); /* Returns void. */
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	/* "Import" the Python module. */
	if (!(py_mod = PyImport_Import(py_name))) { /* NEWREF */
		PyErr_Print(); /* Returns void. */
		Py_DECREF(py_name);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}
	Py_DECREF(py_name);

	/* Get the 'register' function name as Python callable object. */
	py_func = PyObject_GetAttrString(py_mod, "register"); /* NEWREF */
	if (!py_func || !PyCallable_Check(py_func)) {
		if (PyErr_Occurred())
			PyErr_Print(); /* Returns void. */
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	/* Call the 'register' function without arguments, get the result. */
	if (!(py_res = PyObject_CallFunction(py_func, NULL))) { /* NEWREF */
		PyErr_Print(); /* Returns void. */
		Py_DECREF(py_func);
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	if (!(d = malloc(sizeof(struct sigrokdecode_decoder))))
		return SIGROKDECODE_ERR_MALLOC;

	if ((r = h_str(py_res, py_func, py_mod, "id", &(d->id))) < 0)
		return r;

	if ((r = h_str(py_res, py_func, py_mod, "name", &(d->name))) < 0)
		return r;

	if ((r = h_str(py_res, py_func, py_mod, "desc", &(d->desc))) < 0)
		return r;

	d->py_mod = py_mod;

	Py_DECREF(py_res);
	Py_DECREF(py_func);

	/* Get the 'decode' function name as Python callable object. */
	py_func = PyObject_GetAttrString(py_mod, "decode"); /* NEWREF */
	if (!py_func || !PyCallable_Check(py_func)) {
		if (PyErr_Occurred())
			PyErr_Print(); /* Returns void. */
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	d->py_func = py_func;

	/* TODO: Handle inputformats, outputformats. */

	*dec = d;

	return SIGROKDECODE_OK;
}

/**
 * Run the specified decoder function.
 *
 * @param dec TODO
 * @param inbuf TODO
 * @param inbuflen TODO
 * @param outbuf TODO
 * @param outbuflen TODO
 *
 * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
 */
int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
			     uint8_t *inbuf, uint64_t inbuflen,
			     uint8_t **outbuf, uint64_t *outbuflen)
{
	PyObject *py_mod, *py_func, *py_args, *py_value, *py_res;
	int ret;

	/* TODO: Use #defines for the return codes. */

	/* Return an error upon unusable input. */
	if (dec == NULL)
		return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
	if (inbuf == NULL)
		return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
	if (inbuflen == 0) /* No point in working on empty buffers. */
		return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
	if (outbuf == NULL)
		return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
	if (outbuflen == NULL)
		return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */

	/* TODO: Error handling. */
	py_mod = dec->py_mod;
	Py_INCREF(py_mod);
	py_func = dec->py_func;
	Py_INCREF(py_func);

	/* Create a Python tuple of size 1. */
	if (!(py_args = PyTuple_New(1))) { /* NEWREF */
		PyErr_Print(); /* Returns void. */
		Py_DECREF(py_func);
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	/* Get the input buffer as Python "string" (byte array). */
	/* TODO: int vs. uint64_t for 'inbuflen'? */
	if (!(py_value = Py_BuildValue("s#", inbuf, inbuflen))) { /* NEWREF */
		PyErr_Print(); /* Returns void. */
		Py_DECREF(py_args);
		Py_DECREF(py_func);
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	/*
	 * IMPORTANT: PyTuple_SetItem() "steals" a reference to py_value!
	 * That means we are no longer responsible for Py_DECREF()'ing it.
	 * It will automatically be free'd when the 'py_args' tuple is free'd.
	 */
	if (PyTuple_SetItem(py_args, 0, py_value) != 0) { /* STEAL */
		PyErr_Print(); /* Returns void. */
		Py_DECREF(py_value); /* TODO: Ref. stolen upon error? */
		Py_DECREF(py_args);
		Py_DECREF(py_func);
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	if (!(py_res = PyObject_CallObject(py_func, py_args))) { /* NEWREF */
		PyErr_Print(); /* Returns void. */
		Py_DECREF(py_args);
		Py_DECREF(py_func);
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	if ((ret = PyObject_AsCharBuffer(py_res, (const char **)outbuf,
					 (Py_ssize_t *)outbuflen))) {
		PyErr_Print(); /* Returns void. */
		Py_DECREF(py_res);
		Py_DECREF(py_args);
		Py_DECREF(py_func);
		Py_DECREF(py_mod);
		return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	}

	Py_DECREF(py_res);
	Py_DECREF(py_args);
	Py_DECREF(py_func);
	Py_DECREF(py_mod);

	return SIGROKDECODE_OK;
}

/**
 * Shutdown libsigrokdecode.
 *
 * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
 */
int sigrokdecode_shutdown(void)
{
	/* Py_Finalize() returns void, any finalization errors are ignored. */
	Py_Finalize();

	return SIGROKDECODE_OK;
}
Commit	Line	Data
1c6fa20f UH	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
	22	#include <stdio.h>
5c55017c	23	#include <string.h>
7c24d086	24	#include <dirent.h>
d842aebe	25	#include <config.h>
1c6fa20f	26
e6c7a826 UH	27	/* Re-define some string functions for Python >= 3.0. */
	28	#if PY_VERSION_HEX >= 0x03000000
	29	#define PyString_AsString PyBytes_AsString
	30	#define PyString_FromString PyBytes_FromString
	31	#define PyString_Check PyBytes_Check
	32	#endif
	33
7c24d086	34	/* The list of protocol decoders. */
871d21e2	35	GSList *list_pds = NULL;
7c24d086	36
f800adc4 UH	37	/*
	38	* Here's a quick overview of Python/C API reference counting.
	39	*
	40	* Check the Python/C API docs for what type of reference a function returns.
	41	*
	42	* - If it returns a "new reference", you're responsible to Py_DECREF() it.
	43	*
	44	* - If it returns a "borrowed reference", you MUST NOT Py_DECREF() it.
	45	*
	46	* - If a function "steals" a reference, you no longer are responsible for
	47	* Py_DECREF()ing it (someone else will do it for you at some point).
	48	*/
	49
1c6fa20f UH	50	/**
	51	* Initialize libsigrokdecode.
	52	*
70e44845	53	* @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
1c6fa20f UH	54	*/
	55	int sigrokdecode_init(void)
	56	{
7c24d086 UH	57	DIR *dir;
	58	struct dirent *dp;
	59	char *tmp;
	60
1c6fa20f UH	61	/* Py_Initialize() returns void and usually cannot fail. */
	62	Py_Initialize();
	63
0895f56a	64	/* Add search directory for the protocol decoders. */
2454527d	65	/* FIXME: Check error code. */
70e44845	66	/* FIXME: What happens if this function is called multiple times? */
0895f56a	67	PyRun_SimpleString("import sys;"
10426068	68	"sys.path.append(r'" DECODERS_DIR "');");
1c6fa20f	69
7c24d086 UH	70	if (!(dir = opendir(DECODERS_DIR)))
	71	return SIGROKDECODE_ERR_DECODERS_DIR;
	72
	73	while ((dp = readdir(dir)) != NULL) {
276b55eb	74	if (!g_str_has_suffix(dp->d_name, ".py"))
7c24d086	75	continue;
5b05904d UH	76	/* For now use the filename (without .py) as decoder name. */
5b05904d UH	77	if ((tmp = g_strndup(dp->d_name, strlen(dp->d_name) - 3)))
7c24d086 UH	78	list_pds = g_slist_append(list_pds, tmp);
	79	}
	80	closedir(dir);
	81
70e44845	82	return SIGROKDECODE_OK;
1c6fa20f UH	83	}
1c6fa20f UH	84
871d21e2 UH	85	/**
	86	* Returns the list of supported/loaded protocol decoders.
	87	*
	88	* This is a GSList containing the names of the decoders as strings.
	89	*
	90	* @return List of decoders, NULL if none are supported or loaded.
	91	*/
	92	GSList *sigrokdecode_list_decoders(void)
	93	{
	94	return list_pds;
	95	}
	96
5c55017c UH	97	/**
	98	* Helper function to handle Python strings.
	99	*
	100	* TODO: @param entries.
	101	*
3a9a7e38	102	* @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
70e44845	103	* The 'outstr' argument points to a malloc()ed string upon success.
5c55017c UH	104	*/
	105	static int h_str(PyObject py_res, PyObject py_func, PyObject *py_mod,
	106	const char key, char *outstr)
	107	{
	108	PyObject *py_str;
	109	char *str;
	110
	111	py_str = PyMapping_GetItemString(py_res, (char *)key);
	112	if (!py_str \|\| !PyString_Check(py_str)) {
	113	if (PyErr_Occurred())
6b08da24	114	PyErr_Print(); /* Returns void. */
5c55017c UH	115	Py_DECREF(py_func);
	116	Py_DECREF(py_mod);
	117	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	118	}
	119
6b08da24 UH	120	/*
	121	* PyString_AsString()'s returned string refers to an internal buffer
	122	* (not a copy), i.e. the data must not be modified, and the memory
	123	* must not be free()'d.
	124	*/
5c55017c UH	125	if (!(str = PyString_AsString(py_str))) {
5c55017c UH	126	if (PyErr_Occurred())
6b08da24	127	PyErr_Print(); /* Returns void. */
5c55017c UH	128	Py_DECREF(py_str);
	129	Py_DECREF(py_func);
	130	Py_DECREF(py_mod);
	131	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	132	}
	133
	134	if (!(*outstr = strdup(str))) {
	135	if (PyErr_Occurred())
6b08da24	136	PyErr_Print(); /* Returns void. */
5c55017c UH	137	Py_DECREF(py_str);
	138	Py_DECREF(py_func);
	139	Py_DECREF(py_mod);
	140	return SIGROKDECODE_ERR_MALLOC;
	141	}
	142
	143	Py_DECREF(py_str);
	144
70e44845	145	return SIGROKDECODE_OK;
5c55017c UH	146	}
5c55017c UH	147
1c6fa20f UH	148	/**
	149	* TODO
	150	*
	151	* @param name TODO
70e44845	152	*
3a9a7e38	153	* @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
1c6fa20f	154	*/
5c55017c UH	155	int sigrokdecode_load_decoder(const char *name,
5c55017c UH	156	struct sigrokdecode_decoder **dec)
1c6fa20f	157	{
5c55017c UH	158	struct sigrokdecode_decoder *d;
	159	PyObject py_name, py_mod, py_func, py_res /* , py_tuple /;
	160	int r;
	161
	162	/* Get the name of the decoder module as Python string. */
6b08da24 UH	163	if (!(py_name = PyString_FromString(name))) { /* NEWREF */
6b08da24 UH	164	PyErr_Print(); /* Returns void. */
5c55017c UH	165	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	166	}
	167
	168	/* "Import" the Python module. */
6b08da24 UH	169	if (!(py_mod = PyImport_Import(py_name))) { /* NEWREF */
6b08da24 UH	170	PyErr_Print(); /* Returns void. */
5c55017c UH	171	Py_DECREF(py_name);
	172	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	173	}
	174	Py_DECREF(py_name);
	175
	176	/* Get the 'register' function name as Python callable object. */
6b08da24	177	py_func = PyObject_GetAttrString(py_mod, "register"); /* NEWREF */
5c55017c UH	178	if (!py_func \|\| !PyCallable_Check(py_func)) {
5c55017c UH	179	if (PyErr_Occurred())
6b08da24	180	PyErr_Print(); /* Returns void. */
5c55017c UH	181	Py_DECREF(py_mod);
	182	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	183	}
	184
	185	/* Call the 'register' function without arguments, get the result. */
6b08da24 UH	186	if (!(py_res = PyObject_CallFunction(py_func, NULL))) { /* NEWREF */
6b08da24 UH	187	PyErr_Print(); /* Returns void. */
5c55017c UH	188	Py_DECREF(py_func);
	189	Py_DECREF(py_mod);
	190	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	191	}
	192
	193	if (!(d = malloc(sizeof(struct sigrokdecode_decoder))))
	194	return SIGROKDECODE_ERR_MALLOC;
	195
	196	if ((r = h_str(py_res, py_func, py_mod, "id", &(d->id))) < 0)
	197	return r;
	198
	199	if ((r = h_str(py_res, py_func, py_mod, "name", &(d->name))) < 0)
	200	return r;
	201
	202	if ((r = h_str(py_res, py_func, py_mod, "desc", &(d->desc))) < 0)
	203	return r;
	204
	205	d->py_mod = py_mod;
	206
	207	Py_DECREF(py_res);
	208	Py_DECREF(py_func);
	209
	210	/* Get the 'decode' function name as Python callable object. */
6b08da24	211	py_func = PyObject_GetAttrString(py_mod, "decode"); /* NEWREF */
5c55017c UH	212	if (!py_func \|\| !PyCallable_Check(py_func)) {
5c55017c UH	213	if (PyErr_Occurred())
6b08da24	214	PyErr_Print(); /* Returns void. */
5c55017c UH	215	Py_DECREF(py_mod);
	216	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
	217	}
	218
	219	d->py_func = py_func;
	220
	221	/* TODO: Handle inputformats, outputformats. */
	222
	223	*dec = d;
910e5fd8	224
70e44845	225	return SIGROKDECODE_OK;
1c6fa20f UH	226	}
	227
	228	/**
	229	* Run the specified decoder function.
	230	*
5c55017c	231	* @param dec TODO
1c6fa20f UH	232	* @param inbuf TODO
	233	* @param inbuflen TODO
	234	* @param outbuf TODO
	235	* @param outbuflen TODO
70e44845	236	*
3a9a7e38	237	* @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
1c6fa20f	238	*/
5c55017c	239	int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
2b45dd71	240	uint8_t *inbuf, uint64_t inbuflen,
2b45dd71	241	uint8_t *outbuf, uint64_t outbuflen)
1c6fa20f	242	{
5c55017c	243	PyObject py_mod, py_func, py_args, py_value, *py_res;
1c6fa20f UH	244	int ret;
	245
	246	/* TODO: Use #defines for the return codes. */
	247
	248	/* Return an error upon unusable input. */
5c55017c UH	249	if (dec == NULL)
5c55017c UH	250	return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
1c6fa20f	251	if (inbuf == NULL)
5c55017c	252	return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
1c6fa20f	253	if (inbuflen == 0) /* No point in working on empty buffers. */
5c55017c	254	return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
1c6fa20f	255	if (outbuf == NULL)
5c55017c	256	return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
1c6fa20f	257	if (outbuflen == NULL)
5c55017c	258	return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
1c6fa20f	259
5c55017c UH	260	/* TODO: Error handling. */
5c55017c UH	261	py_mod = dec->py_mod;
4fa17efc	262	Py_INCREF(py_mod);
5c55017c	263	py_func = dec->py_func;
4fa17efc	264	Py_INCREF(py_func);
1c6fa20f UH	265
1c6fa20f UH	266	/* Create a Python tuple of size 1. */
6b08da24 UH	267	if (!(py_args = PyTuple_New(1))) { /* NEWREF */
6b08da24 UH	268	PyErr_Print(); /* Returns void. */
1c6fa20f	269	Py_DECREF(py_func);
5c55017c UH	270	Py_DECREF(py_mod);
5c55017c UH	271	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
1c6fa20f UH	272	}
	273
	274	/* Get the input buffer as Python "string" (byte array). */
	275	/* TODO: int vs. uint64_t for 'inbuflen'? */
6b08da24 UH	276	if (!(py_value = Py_BuildValue("s#", inbuf, inbuflen))) { /* NEWREF */
6b08da24 UH	277	PyErr_Print(); /* Returns void. */
1c6fa20f UH	278	Py_DECREF(py_args);
1c6fa20f UH	279	Py_DECREF(py_func);
5c55017c UH	280	Py_DECREF(py_mod);
5c55017c UH	281	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
1c6fa20f UH	282	}
1c6fa20f UH	283
f800adc4 UH	284	/*
	285	* IMPORTANT: PyTuple_SetItem() "steals" a reference to py_value!
	286	* That means we are no longer responsible for Py_DECREF()'ing it.
	287	* It will automatically be free'd when the 'py_args' tuple is free'd.
	288	*/
6b08da24 UH	289	if (PyTuple_SetItem(py_args, 0, py_value) != 0) { /* STEAL */
6b08da24 UH	290	PyErr_Print(); /* Returns void. */
f800adc4	291	Py_DECREF(py_value); /* TODO: Ref. stolen upon error? */
1c6fa20f UH	292	Py_DECREF(py_args);
1c6fa20f UH	293	Py_DECREF(py_func);
5c55017c UH	294	Py_DECREF(py_mod);
5c55017c UH	295	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
1c6fa20f UH	296	}
1c6fa20f UH	297
6b08da24 UH	298	if (!(py_res = PyObject_CallObject(py_func, py_args))) { /* NEWREF */
6b08da24 UH	299	PyErr_Print(); /* Returns void. */
1c6fa20f UH	300	Py_DECREF(py_args);
1c6fa20f UH	301	Py_DECREF(py_func);
5c55017c UH	302	Py_DECREF(py_mod);
5c55017c UH	303	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
1c6fa20f UH	304	}
1c6fa20f UH	305
5c55017c	306	if ((ret = PyObject_AsCharBuffer(py_res, (const char **)outbuf,
1c6fa20f	307	(Py_ssize_t *)outbuflen))) {
6b08da24	308	PyErr_Print(); /* Returns void. */
5c55017c	309	Py_DECREF(py_res);
1c6fa20f UH	310	Py_DECREF(py_args);
1c6fa20f UH	311	Py_DECREF(py_func);
5c55017c UH	312	Py_DECREF(py_mod);
5c55017c UH	313	return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
1c6fa20f UH	314	}
1c6fa20f UH	315
5c55017c	316	Py_DECREF(py_res);
1c6fa20f UH	317	Py_DECREF(py_args);
1c6fa20f UH	318	Py_DECREF(py_func);
5c55017c	319	Py_DECREF(py_mod);
1c6fa20f	320
70e44845	321	return SIGROKDECODE_OK;
1c6fa20f UH	322	}
	323
	324	/**
	325	* Shutdown libsigrokdecode.
	326	*
3a9a7e38	327	* @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
1c6fa20f UH	328	*/
	329	int sigrokdecode_shutdown(void)
	330	{
	331	/* Py_Finalize() returns void, any finalization errors are ignored. */
	332	Py_Finalize();
	333
70e44845	334	return SIGROKDECODE_OK;
1c6fa20f	335	}