2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
22 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "sigrokdecode-internal.h"
26 /* The list of protocol decoders. */
27 SRD_PRIV GSList *pd_list = NULL;
29 /* module_sigrokdecode.c */
30 extern SRD_PRIV PyObject *mod_sigrokdecode;
33 * Returns the list of supported/loaded protocol decoders.
35 * This is a GSList containing the names of the decoders as strings.
37 * @return List of decoders, NULL if none are supported or loaded.
39 SRD_API GSList *srd_decoder_list(void)
45 * Get the decoder with the specified ID.
47 * @param id The ID string of the decoder to return.
49 * @return The decoder with the specified ID, or NULL if not found.
51 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
54 struct srd_decoder *dec;
56 for (l = srd_decoder_list(); l; l = l->next) {
58 if (!strcmp(dec->id, id))
65 static int get_probes(const struct srd_decoder *d, const char *attr,
68 PyObject *py_probelist, *py_entry;
70 int ret, num_probes, i;
72 if (!PyObject_HasAttrString(d->py_dec, attr))
73 /* No probes of this type specified. */
77 py_probelist = py_entry = NULL;
79 py_probelist = PyObject_GetAttrString(d->py_dec, attr);
80 if (!PyList_Check(py_probelist)) {
81 srd_err("Protocol decoder %s %s attribute is not "
82 "a list.", d->name, attr);
86 num_probes = PyList_Size(py_probelist);
88 /* Empty probelist. */
91 for (i = 0; i < num_probes; i++) {
92 py_entry = PyList_GetItem(py_probelist, i);
93 if (!PyDict_Check(py_entry)) {
94 srd_err("Protocol decoder %s %s attribute is not "
95 "a list with dict elements.", d->name, attr);
99 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
100 srd_err("Failed to g_malloc() struct srd_probe.");
101 ret = SRD_ERR_MALLOC;
105 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
107 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
109 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
113 *pl = g_slist_append(*pl, p);
119 Py_DecRef(py_probelist);
125 * Load a protocol decoder module into the embedded Python interpreter.
127 * @param name The module name to be loaded.
129 * @return SRD_OK upon success, a (negative) error code otherwise.
131 SRD_API int srd_decoder_load(const char *module_name)
133 PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
134 struct srd_decoder *d;
138 srd_dbg("Loading protocol decoder '%s'.", module_name);
140 py_basedec = py_method = py_attr = NULL;
142 if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
143 srd_dbg("Failed to g_malloc() struct srd_decoder.");
144 ret = SRD_ERR_MALLOC;
148 ret = SRD_ERR_PYTHON;
150 /* Import the Python module. */
151 if (!(d->py_mod = PyImport_ImportModule(module_name))) {
152 catch_exception("Import of '%s' failed.", module_name);
156 /* Get the 'Decoder' class as Python object. */
157 if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
158 /* This generated an AttributeError exception. */
160 srd_err("Decoder class not found in protocol decoder %s.",
165 if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
166 srd_dbg("sigrokdecode module not loaded.");
170 if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
171 srd_err("Decoder class in protocol decoder module %s is not "
172 "a subclass of sigrokdecode.Decoder.", module_name);
175 Py_CLEAR(py_basedec);
177 /* Check for a proper start() method. */
178 if (!PyObject_HasAttrString(d->py_dec, "start")) {
179 srd_err("Protocol decoder %s has no start() method Decoder "
180 "class.", module_name);
183 py_method = PyObject_GetAttrString(d->py_dec, "start");
184 if (!PyFunction_Check(py_method)) {
185 srd_err("Protocol decoder %s Decoder class attribute 'start' "
186 "is not a method.", module_name);
191 /* Check for a proper decode() method. */
192 if (!PyObject_HasAttrString(d->py_dec, "decode")) {
193 srd_err("Protocol decoder %s has no decode() method Decoder "
194 "class.", module_name);
197 py_method = PyObject_GetAttrString(d->py_dec, "decode");
198 if (!PyFunction_Check(py_method)) {
199 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
200 "is not a method.", module_name);
205 /* If present, options must be a dictionary. */
206 if (PyObject_HasAttrString(d->py_dec, "options")) {
207 py_attr = PyObject_GetAttrString(d->py_dec, "options");
208 if (!PyDict_Check(py_attr)) {
209 srd_err("Protocol decoder %s options attribute is not "
210 "a dictionary.", d->name);
217 /* Check and import required probes. */
218 if (get_probes(d, "probes", &d->probes) != SRD_OK)
221 /* Check and import optional probes. */
222 if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
225 /* Store required fields in newly allocated strings. */
226 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
229 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
232 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
235 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
238 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
241 /* TODO: Handle inputformats, outputformats. */
242 d->inputformats = NULL;
243 d->outputformats = NULL;
245 /* Convert class annotation attribute to GSList of **char. */
246 d->annotations = NULL;
247 if (PyObject_HasAttrString(d->py_dec, "annotations")) {
248 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
249 if (!PyList_Check(py_annlist)) {
250 srd_err("Protocol decoder module %s annotations "
251 "should be a list.", module_name);
254 alen = PyList_Size(py_annlist);
255 for (i = 0; i < alen; i++) {
256 py_ann = PyList_GetItem(py_annlist, i);
257 if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
258 srd_err("Protocol decoder module %s "
259 "annotation %d should be a list with "
260 "two elements.", module_name, i + 1);
264 if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
267 d->annotations = g_slist_append(d->annotations, ann);
271 /* Append it to the list of supported/loaded decoders. */
272 pd_list = g_slist_append(pd_list, d);
278 Py_XDECREF(py_method);
279 Py_XDECREF(py_basedec);
280 Py_XDECREF(d->py_dec);
281 Py_XDECREF(d->py_mod);
289 * Return a protocol decoder's docstring.
291 * @param dec The loaded protocol decoder.
293 * @return A newly allocated buffer containing the protocol decoder's
294 * documentation. The caller is responsible for free'ing the buffer.
296 SRD_API char *srd_decoder_doc(const struct srd_decoder *dec)
301 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
304 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
310 if (py_str != Py_None)
311 py_str_as_str(py_str, &doc);
317 static void free_probes(GSList *probelist)
322 if (probelist == NULL)
325 for (l = probelist; l; l = l->next) {
332 g_slist_free(probelist);
336 * Unload decoder module.
338 * @param dec The struct srd_decoder to be unloaded.
340 * @return SRD_OK upon success, a (negative) error code otherwise.
342 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
344 srd_dbg("Unloading protocol decoder '%s'.", dec->name);
347 * Since any instances of this decoder need to be released as well,
348 * but they could be anywhere in the stack, just free the entire
349 * stack. A frontend reloading a decoder thus has to restart all
350 * instances, and rebuild the stack.
352 srd_inst_free_all(NULL);
354 free_probes(dec->probes);
355 free_probes(dec->opt_probes);
358 g_free(dec->longname);
360 g_free(dec->license);
362 /* TODO: Free everything in inputformats and outputformats. */
363 if (dec->inputformats != NULL)
364 g_slist_free(dec->inputformats);
365 if (dec->outputformats != NULL)
366 g_slist_free(dec->outputformats);
368 /* The module's Decoder class. */
369 Py_XDECREF(dec->py_dec);
370 /* The module itself. */
371 Py_XDECREF(dec->py_mod);
373 /* TODO: (g_)free dec itself? */
379 * Load all installed protocol decoders.
381 * @return SRD_OK upon success, a (negative) error code otherwise.
383 SRD_API int srd_decoder_load_all(void)
387 const gchar *direntry;
389 if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
390 srd_err("Unable to open %s for reading.", DECODERS_DIR);
391 return SRD_ERR_DECODERS_DIR;
394 while ((direntry = g_dir_read_name(dir)) != NULL) {
395 /* The directory name is the module name (e.g. "i2c"). */
396 srd_decoder_load(direntry);
404 * Unload all loaded protocol decoders.
406 * @return SRD_OK upon success, a (negative) error code otherwise.
408 SRD_API int srd_decoder_unload_all(void)
411 struct srd_decoder *dec;
413 for (l = srd_decoder_list(); l; l = l->next) {
415 srd_decoder_unload(dec);