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. */
34 GSList *list_pds = NULL;
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 * Returns the list of supported/loaded protocol decoders.
76 * This is a GSList containing the names of the decoders as strings.
78 * @return List of decoders, NULL if none are supported or loaded.
80 GSList *sigrokdecode_list_decoders(void)
86 * Helper function to handle Python strings.
88 * TODO: @param entries.
90 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
91 * The 'outstr' argument points to a malloc()ed string upon success.
93 static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod,
94 const char *key, char **outstr)
99 py_str = PyMapping_GetItemString(py_res, (char *)key);
100 if (!py_str || !PyString_Check(py_str)) {
101 if (PyErr_Occurred())
105 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
108 if (!(str = PyString_AsString(py_str))) {
109 if (PyErr_Occurred())
114 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
117 if (!(*outstr = strdup(str))) {
118 if (PyErr_Occurred())
123 return SIGROKDECODE_ERR_MALLOC;
128 return SIGROKDECODE_OK;
136 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
138 int sigrokdecode_load_decoder(const char *name,
139 struct sigrokdecode_decoder **dec)
141 struct sigrokdecode_decoder *d;
142 PyObject *py_name, *py_mod, *py_func, *py_res /* , *py_tuple */;
145 /* Get the name of the decoder module as Python string. */
146 if (!(py_name = PyString_FromString(name))) {
148 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
151 /* "Import" the Python module. */
152 if (!(py_mod = PyImport_Import(py_name))) {
155 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
159 /* Get the 'register' function name as Python callable object. */
160 py_func = PyObject_GetAttrString(py_mod, "register");
161 if (!py_func || !PyCallable_Check(py_func)) {
162 if (PyErr_Occurred())
165 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
168 /* Call the 'register' function without arguments, get the result. */
169 if (!(py_res = PyObject_CallFunction(py_func, NULL))) {
173 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
176 if (!(d = malloc(sizeof(struct sigrokdecode_decoder))))
177 return SIGROKDECODE_ERR_MALLOC;
179 if ((r = h_str(py_res, py_func, py_mod, "id", &(d->id))) < 0)
182 if ((r = h_str(py_res, py_func, py_mod, "name", &(d->name))) < 0)
185 if ((r = h_str(py_res, py_func, py_mod, "desc", &(d->desc))) < 0)
193 /* Get the 'decode' function name as Python callable object. */
194 py_func = PyObject_GetAttrString(py_mod, "decode");
195 if (!py_func || !PyCallable_Check(py_func)) {
196 if (PyErr_Occurred())
199 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
202 d->py_func = py_func;
204 /* TODO: Handle inputformats, outputformats. */
208 return SIGROKDECODE_OK;
212 * Run the specified decoder function.
216 * @param inbuflen TODO
218 * @param outbuflen TODO
220 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
222 int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
223 uint8_t *inbuf, uint64_t inbuflen,
224 uint8_t **outbuf, uint64_t *outbuflen)
226 PyObject *py_mod, *py_func, *py_args, *py_value, *py_res;
229 /* TODO: Use #defines for the return codes. */
231 /* Return an error upon unusable input. */
233 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
235 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
236 if (inbuflen == 0) /* No point in working on empty buffers. */
237 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
239 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
240 if (outbuflen == NULL)
241 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
243 /* TODO: Error handling. */
244 py_mod = dec->py_mod;
245 py_func = dec->py_func;
247 /* TODO: Really run Py_DECREF on py_mod/py_func? */
249 /* Create a Python tuple of size 1. */
250 if (!(py_args = PyTuple_New(1))) {
254 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
257 /* Get the input buffer as Python "string" (byte array). */
258 /* TODO: int vs. uint64_t for 'inbuflen'? */
259 if (!(py_value = Py_BuildValue("s#", inbuf, inbuflen))) {
264 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
267 if (PyTuple_SetItem(py_args, 0, py_value) != 0) {
273 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
276 if (!(py_res = PyObject_CallObject(py_func, py_args))) {
282 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
285 if ((ret = PyObject_AsCharBuffer(py_res, (const char **)outbuf,
286 (Py_ssize_t *)outbuflen))) {
293 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
297 // Py_DECREF(py_value);
302 return SIGROKDECODE_OK;
306 * Shutdown libsigrokdecode.
308 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
310 int sigrokdecode_shutdown(void)
312 /* Py_Finalize() returns void, any finalization errors are ignored. */
315 return SIGROKDECODE_OK;