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 GSList *pd_list = NULL;
29 /* lives in module_sigrokdecode.c */
30 extern PyObject *mod_sigrokdecode;
34 * Returns the list of supported/loaded protocol decoders.
36 * This is a GSList containing the names of the decoders as strings.
38 * @return List of decoders, NULL if none are supported or loaded.
40 GSList *srd_list_decoders(void)
48 * Get the decoder with the specified ID.
50 * @param id The ID string of the decoder to return.
51 * @return The decoder with the specified ID, or NULL if not found.
53 struct srd_decoder *srd_get_decoder_by_id(const char *id)
56 struct srd_decoder *dec;
58 for (l = srd_list_decoders(); l; l = l->next) {
60 if (!strcmp(dec->id, id))
68 static int get_probes(struct srd_decoder *d, char *attr, GSList **pl)
70 PyObject *py_probelist, *py_entry;
72 int ret, num_probes, i;
74 if (!PyObject_HasAttrString(d->py_dec, attr))
75 /* No probes of this type specified. */
79 py_probelist = py_entry = NULL;
81 py_probelist = PyObject_GetAttrString(d->py_dec, attr);
82 if (!PyList_Check(py_probelist)) {
83 srd_err("Protocol decoder %s %s attribute is not "
84 "a list.", d->name, attr);
88 num_probes = PyList_Size(py_probelist);
90 /* Empty probelist. */
93 for (i = 0; i < num_probes; i++) {
94 py_entry = PyList_GetItem(py_probelist, i);
95 if (!PyDict_Check(py_entry)) {
96 srd_err("Protocol decoder %s %s attribute is not "
97 "a list with dict elements.", d->name, attr);
101 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
102 ret = SRD_ERR_MALLOC;
106 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
108 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
110 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
114 *pl = g_slist_append(*pl, p);
120 Py_DecRef(py_probelist);
126 * Load a protocol decoder module into the embedded Python interpreter.
128 * @param name The module name to be loaded.
129 * @param dec Pointer to the struct srd_decoder filled with the loaded module.
131 * @return SRD_OK upon success, a (negative) error code otherwise.
133 int srd_load_decoder(const char *name, struct srd_decoder **dec)
135 PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
136 struct srd_decoder *d;
140 srd_dbg("srd: loading module '%s'", name);
142 py_basedec = py_method = py_attr = NULL;
144 if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
145 srd_dbg("srd: Failed to malloc struct srd_decoder");
146 ret = SRD_ERR_MALLOC;
150 ret = SRD_ERR_PYTHON;
152 /* Import the Python module. */
153 if (!(d->py_mod = PyImport_ImportModule(name))) {
154 /* TODO: Report exception message/traceback to err/dbg. */
155 srd_warn("srd: import of '%s' failed.", name);
161 /* Get the 'Decoder' class as Python object. */
162 if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
163 /* This generated an AttributeError exception. */
166 srd_err("Decoder class not found in protocol decoder %s.", name);
170 if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
171 srd_dbg("srd: sigrokdecode module not loaded");
175 if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
176 srd_err("Decoder class in protocol decoder module %s is not "
177 "a subclass of sigrokdecode.Decoder.", name);
180 Py_DecRef(py_basedec);
182 /* Check for a proper start() method. */
183 if (!PyObject_HasAttrString(d->py_dec, "start")) {
184 srd_err("Protocol decoder %s has no start() method Decoder "
188 py_method = PyObject_GetAttrString(d->py_dec, "start");
189 if (!PyFunction_Check(py_method)) {
190 srd_err("Protocol decoder %s Decoder class attribute 'start' "
191 "is not a method.", name);
194 Py_DecRef(py_method);
196 /* Check for a proper decode() method. */
197 if (!PyObject_HasAttrString(d->py_dec, "decode")) {
198 srd_err("Protocol decoder %s has no decode() method Decoder "
202 py_method = PyObject_GetAttrString(d->py_dec, "decode");
203 if (!PyFunction_Check(py_method)) {
204 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
205 "is not a method.", name);
208 Py_DecRef(py_method);
210 /* If present, options must be a dictionary. */
211 if (PyObject_HasAttrString(d->py_dec, "options")) {
212 py_attr = PyObject_GetAttrString(d->py_dec, "options");
213 if (!PyDict_Check(py_attr)) {
214 srd_err("Protocol decoder %s options attribute is not "
215 "a dictionary.", d->name);
221 /* Check and import required probes. */
222 if (get_probes(d, "probes", &d->probes) != SRD_OK)
225 /* Check and import optional probes. */
226 if (get_probes(d, "extra_probes", &d->extra_probes) != SRD_OK)
229 /* Store required fields in newly allocated strings. */
230 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
233 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
236 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
239 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
242 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
245 /* TODO: Handle inputformats, outputformats. */
246 d->inputformats = NULL;
247 d->outputformats = NULL;
249 /* Convert class annotation attribute to GSList of **char */
250 d->annotations = NULL;
251 if (PyObject_HasAttrString(d->py_dec, "annotations")) {
252 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
253 if (!PyList_Check(py_annlist)) {
254 srd_err("Protocol decoder module %s annotations should be a list.", name);
257 alen = PyList_Size(py_annlist);
258 for (i = 0; i < alen; i++) {
259 py_ann = PyList_GetItem(py_annlist, i);
260 if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
261 srd_err("Protocol decoder module %s annotation %d should "
262 "be a list with two elements.", name, i+1);
266 if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
269 d->annotations = g_slist_append(d->annotations, ann);
278 Py_XDECREF(py_method);
279 Py_XDECREF(py_basedec);
280 Py_XDECREF(d->py_dec);
281 Py_XDECREF(d->py_mod);
288 char *srd_decoder_doc(struct srd_decoder *dec)
293 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
296 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
302 if (py_str != Py_None)
303 py_str_as_str(py_str, &doc);
311 * Unload decoder module.
313 * @param dec The decoder struct to be unloaded.
315 * @return SRD_OK upon success, a (negative) error code otherwise.
317 int srd_unload_decoder(struct srd_decoder *dec)
322 g_free(dec->longname);
324 g_free(dec->license);
326 /* TODO: Free everything in inputformats and outputformats. */
327 if (dec->inputformats != NULL)
328 g_slist_free(dec->inputformats);
329 if (dec->outputformats != NULL)
330 g_slist_free(dec->outputformats);
332 Py_XDECREF(dec->py_dec);
333 Py_XDECREF(dec->py_mod);
335 /* TODO: (g_)free dec itself? */
340 int srd_load_all_decoders(void)
344 struct srd_decoder *dec;
346 const gchar *direntry;
349 if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
350 return SRD_ERR_DECODERS_DIR;
353 while ((direntry = g_dir_read_name(dir)) != NULL) {
354 /* The decoder name is the PD directory name (e.g. "i2c"). */
355 decodername = g_strdup(direntry);
357 /* TODO: Error handling. Use g_try_malloc(). */
358 if (!(dec = malloc(sizeof(struct srd_decoder)))) {
359 Py_Finalize(); /* Returns void. */
360 return SRD_ERR_MALLOC;
363 /* Load the decoder. */
364 /* TODO: Warning if loading fails for a decoder. */
365 if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) {
366 /* Append it to the list of supported/loaded decoders. */
367 pd_list = g_slist_append(pd_list, dec);
378 int srd_unload_all_decoders(void)
381 struct srd_decoder *dec;
383 for (l = srd_list_decoders(); l; l = l->next) {
385 /* TODO: Error handling. */
386 srd_unload_decoder(dec);