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_decoders_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_decoders_list(); l; l = l->next) {
58 if (!strcmp(dec->id, id))
65 static int get_probes(struct srd_decoder *d, char *attr, GSList **pl)
67 PyObject *py_probelist, *py_entry;
69 int ret, num_probes, i;
71 if (!PyObject_HasAttrString(d->py_dec, attr))
72 /* No probes of this type specified. */
76 py_probelist = py_entry = NULL;
78 py_probelist = PyObject_GetAttrString(d->py_dec, attr);
79 if (!PyList_Check(py_probelist)) {
80 srd_err("Protocol decoder %s %s attribute is not "
81 "a list.", d->name, attr);
85 num_probes = PyList_Size(py_probelist);
87 /* Empty probelist. */
90 for (i = 0; i < num_probes; i++) {
91 py_entry = PyList_GetItem(py_probelist, i);
92 if (!PyDict_Check(py_entry)) {
93 srd_err("Protocol decoder %s %s attribute is not "
94 "a list with dict elements.", d->name, attr);
98 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
99 srd_err("Failed to g_malloc() struct srd_probe.");
100 ret = SRD_ERR_MALLOC;
104 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
106 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
108 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
112 *pl = g_slist_append(*pl, p);
118 Py_DecRef(py_probelist);
124 * Load a protocol decoder module into the embedded Python interpreter.
126 * @param name The module name to be loaded.
128 * @return SRD_OK upon success, a (negative) error code otherwise.
130 SRD_API int srd_decoder_load(const char *module_name)
132 PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
133 struct srd_decoder *d;
137 srd_dbg("Loading module '%s'.", module_name);
139 py_basedec = py_method = py_attr = NULL;
141 if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
142 srd_dbg("Failed to g_malloc() struct srd_decoder.");
143 ret = SRD_ERR_MALLOC;
147 ret = SRD_ERR_PYTHON;
149 /* Import the Python module. */
150 if (!(d->py_mod = PyImport_ImportModule(module_name))) {
151 catch_exception("Import of '%s' failed.", module_name);
155 /* Get the 'Decoder' class as Python object. */
156 if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
157 /* This generated an AttributeError exception. */
159 srd_err("Decoder class not found in protocol decoder %s.",
164 if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
165 srd_dbg("sigrokdecode module not loaded.");
169 if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
170 srd_err("Decoder class in protocol decoder module %s is not "
171 "a subclass of sigrokdecode.Decoder.", module_name);
174 Py_CLEAR(py_basedec);
176 /* Check for a proper start() method. */
177 if (!PyObject_HasAttrString(d->py_dec, "start")) {
178 srd_err("Protocol decoder %s has no start() method Decoder "
179 "class.", module_name);
182 py_method = PyObject_GetAttrString(d->py_dec, "start");
183 if (!PyFunction_Check(py_method)) {
184 srd_err("Protocol decoder %s Decoder class attribute 'start' "
185 "is not a method.", module_name);
190 /* Check for a proper decode() method. */
191 if (!PyObject_HasAttrString(d->py_dec, "decode")) {
192 srd_err("Protocol decoder %s has no decode() method Decoder "
193 "class.", module_name);
196 py_method = PyObject_GetAttrString(d->py_dec, "decode");
197 if (!PyFunction_Check(py_method)) {
198 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
199 "is not a method.", module_name);
204 /* If present, options must be a dictionary. */
205 if (PyObject_HasAttrString(d->py_dec, "options")) {
206 py_attr = PyObject_GetAttrString(d->py_dec, "options");
207 if (!PyDict_Check(py_attr)) {
208 srd_err("Protocol decoder %s options attribute is not "
209 "a dictionary.", d->name);
216 /* Check and import required probes. */
217 if (get_probes(d, "probes", &d->probes) != SRD_OK)
220 /* Check and import optional probes. */
221 if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
224 /* Store required fields in newly allocated strings. */
225 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
228 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
231 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
234 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
237 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
240 /* TODO: Handle inputformats, outputformats. */
241 d->inputformats = NULL;
242 d->outputformats = NULL;
244 /* Convert class annotation attribute to GSList of **char. */
245 d->annotations = NULL;
246 if (PyObject_HasAttrString(d->py_dec, "annotations")) {
247 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
248 if (!PyList_Check(py_annlist)) {
249 srd_err("Protocol decoder module %s annotations "
250 "should be a list.", module_name);
253 alen = PyList_Size(py_annlist);
254 for (i = 0; i < alen; i++) {
255 py_ann = PyList_GetItem(py_annlist, i);
256 if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
257 srd_err("Protocol decoder module %s "
258 "annotation %d should be a list with "
259 "two elements.", module_name, i + 1);
263 if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
266 d->annotations = g_slist_append(d->annotations, ann);
270 /* Append it to the list of supported/loaded decoders. */
271 pd_list = g_slist_append(pd_list, d);
277 Py_XDECREF(py_method);
278 Py_XDECREF(py_basedec);
279 Py_XDECREF(d->py_dec);
280 Py_XDECREF(d->py_mod);
288 * Return a protocol decoder's docstring.
290 * @param dec The loaded protocol decoder.
292 * @return A newly allocated buffer containing the protocol decoder's
293 * documentation. The caller is responsible for free'ing the buffer.
295 SRD_API char *srd_decoder_doc(const struct srd_decoder *dec)
300 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
303 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
309 if (py_str != Py_None)
310 py_str_as_str(py_str, &doc);
316 static void free_probes(GSList *probelist)
321 if (probelist == NULL)
324 for (l = probelist; l; l = l->next) {
331 g_slist_free(probelist);
335 * Unload decoder module.
337 * @param dec The struct srd_decoder to be unloaded.
339 * @return SRD_OK upon success, a (negative) error code otherwise.
341 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
343 srd_dbg("Unloading decoder '%s'.", dec->name);
346 * Since any instances of this decoder need to be released as well,
347 * but they could be anywhere in the stack, just free the entire
348 * stack. A frontend reloading a decoder thus has to restart all
349 * instances, and rebuild the stack.
351 srd_inst_free_all(NULL);
353 free_probes(dec->probes);
354 free_probes(dec->opt_probes);
357 g_free(dec->longname);
359 g_free(dec->license);
361 /* TODO: Free everything in inputformats and outputformats. */
362 if (dec->inputformats != NULL)
363 g_slist_free(dec->inputformats);
364 if (dec->outputformats != NULL)
365 g_slist_free(dec->outputformats);
367 /* The module's Decoder class. */
368 Py_XDECREF(dec->py_dec);
369 /* The module itself. */
370 Py_XDECREF(dec->py_mod);
372 /* TODO: (g_)free dec itself? */
378 * Load all installed protocol decoders.
380 * @return SRD_OK upon success, a (negative) error code otherwise.
382 SRD_API int srd_decoders_load_all(void)
386 const gchar *direntry;
388 if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
389 srd_err("Unable to open %s for reading.", DECODERS_DIR);
390 return SRD_ERR_DECODERS_DIR;
393 while ((direntry = g_dir_read_name(dir)) != NULL) {
394 /* The directory name is the module name (e.g. "i2c"). */
395 srd_decoder_load(direntry);
403 * Unload all loaded protocol decoders.
405 * @return SRD_OK upon success, a (negative) error code otherwise.
407 SRD_API int srd_decoders_unload_all(void)
410 struct srd_decoder *dec;
412 for (l = srd_decoders_list(); l; l = l->next) {
414 srd_decoder_unload(dec);