2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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
21 #include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
26 /* Re-define some string functions for Python >= 3.0. */
27 #if PY_VERSION_HEX >= 0x03000000
28 #define PyString_AsString PyBytes_AsString
29 #define PyString_FromString PyBytes_FromString
30 #define PyString_Check PyBytes_Check
33 /* The list of protocol decoders. */
37 * Initialize libsigrokdecode.
39 * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
41 int sigrokdecode_init(void)
47 /* Py_Initialize() returns void and usually cannot fail. */
50 /* Add some more search directories for convenience. */
51 /* FIXME: Check error code. */
52 /* FIXME: What happens if this function is called multiple times? */
55 "sys.path.append('libsigrokdecode/decoders');"
56 "sys.path.append('" DECODERS_DIR "');"
59 if (!(dir = opendir(DECODERS_DIR)))
60 return SIGROKDECODE_ERR_DECODERS_DIR;
62 while ((dp = readdir(dir)) != NULL) {
63 if (!strstr(dp->d_name, ".py"))
65 if ((tmp = strdup(dp->d_name)))
66 list_pds = g_slist_append(list_pds, tmp);
70 return SIGROKDECODE_OK;
74 * Helper function to handle Python strings.
76 * TODO: @param entries.
78 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
79 * The 'outstr' argument points to a malloc()ed string upon success.
81 static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod,
82 const char *key, char **outstr)
87 py_str = PyMapping_GetItemString(py_res, (char *)key);
88 if (!py_str || !PyString_Check(py_str)) {
93 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
96 if (!(str = PyString_AsString(py_str))) {
102 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
105 if (!(*outstr = strdup(str))) {
106 if (PyErr_Occurred())
111 return SIGROKDECODE_ERR_MALLOC;
116 return SIGROKDECODE_OK;
124 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
126 int sigrokdecode_load_decoder(const char *name,
127 struct sigrokdecode_decoder **dec)
129 struct sigrokdecode_decoder *d;
130 PyObject *py_name, *py_mod, *py_func, *py_res /* , *py_tuple */;
133 /* Get the name of the decoder module as Python string. */
134 if (!(py_name = PyString_FromString(name))) {
136 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
139 /* "Import" the Python module. */
140 if (!(py_mod = PyImport_Import(py_name))) {
143 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
147 /* Get the 'register' function name as Python callable object. */
148 py_func = PyObject_GetAttrString(py_mod, "register");
149 if (!py_func || !PyCallable_Check(py_func)) {
150 if (PyErr_Occurred())
153 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
156 /* Call the 'register' function without arguments, get the result. */
157 if (!(py_res = PyObject_CallFunction(py_func, NULL))) {
161 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
164 if (!(d = malloc(sizeof(struct sigrokdecode_decoder))))
165 return SIGROKDECODE_ERR_MALLOC;
167 if ((r = h_str(py_res, py_func, py_mod, "id", &(d->id))) < 0)
170 if ((r = h_str(py_res, py_func, py_mod, "name", &(d->name))) < 0)
173 if ((r = h_str(py_res, py_func, py_mod, "desc", &(d->desc))) < 0)
181 /* Get the 'decode' function name as Python callable object. */
182 py_func = PyObject_GetAttrString(py_mod, "decode");
183 if (!py_func || !PyCallable_Check(py_func)) {
184 if (PyErr_Occurred())
187 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
190 d->py_func = py_func;
192 /* TODO: Handle inputformats, outputformats. */
196 return SIGROKDECODE_OK;
200 * Run the specified decoder function.
204 * @param inbuflen TODO
206 * @param outbuflen TODO
208 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
210 int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
211 uint8_t *inbuf, uint64_t inbuflen,
212 uint8_t **outbuf, uint64_t *outbuflen)
214 PyObject *py_mod, *py_func, *py_args, *py_value, *py_res;
217 /* TODO: Use #defines for the return codes. */
219 /* Return an error upon unusable input. */
221 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
223 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
224 if (inbuflen == 0) /* No point in working on empty buffers. */
225 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
227 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
228 if (outbuflen == NULL)
229 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
231 /* TODO: Error handling. */
232 py_mod = dec->py_mod;
233 py_func = dec->py_func;
235 /* TODO: Really run Py_DECREF on py_mod/py_func? */
237 /* Create a Python tuple of size 1. */
238 if (!(py_args = PyTuple_New(1))) {
242 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
245 /* Get the input buffer as Python "string" (byte array). */
246 /* TODO: int vs. uint64_t for 'inbuflen'? */
247 if (!(py_value = Py_BuildValue("s#", inbuf, inbuflen))) {
252 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
255 if (PyTuple_SetItem(py_args, 0, py_value) != 0) {
261 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
264 if (!(py_res = PyObject_CallObject(py_func, py_args))) {
270 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
273 if ((ret = PyObject_AsCharBuffer(py_res, (const char **)outbuf,
274 (Py_ssize_t *)outbuflen))) {
281 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
285 // Py_DECREF(py_value);
290 return SIGROKDECODE_OK;
294 * Shutdown libsigrokdecode.
296 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
298 int sigrokdecode_shutdown(void)
300 /* Py_Finalize() returns void, any finalization errors are ignored. */
303 return SIGROKDECODE_OK;