2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2011 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))
69 * Load a protocol decoder module into the embedded Python interpreter.
71 * @param name The module name to be loaded.
72 * @param dec Pointer to the struct srd_decoder filled with the loaded module.
74 * @return SRD_OK upon success, a (negative) error code otherwise.
76 int srd_load_decoder(const char *name, struct srd_decoder **dec)
78 PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
79 struct srd_decoder *d;
83 py_basedec = py_method = py_attr = NULL;
85 srd_dbg("decoder: %s: loading module '%s'", __func__, name);
87 if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
88 srd_err("decoder: %s: d malloc failed", __func__);
95 /* Import the Python module. */
96 if (!(d->py_mod = PyImport_ImportModule(name))) {
97 /* TODO: Report exception message/traceback to err/dbg. */
98 srd_warn("decoder: %s: import of '%s' failed", __func__, name);
104 /* Get the 'Decoder' class as Python object. */
105 if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
106 /* This generated an AttributeError exception. */
109 srd_err("Decoder class not found in protocol decoder %s", name);
113 if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
114 srd_dbg("sigrokdecode module not loaded");
118 if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
119 srd_err("Decoder class in protocol decoder module %s is not "
120 "a subclass of sigrokdecode.Decoder", name);
123 Py_DecRef(py_basedec);
125 /* Check for a proper start() method. */
126 if (!PyObject_HasAttrString(d->py_dec, "start")) {
127 srd_err("Protocol decoder %s has no start() method Decoder "
131 py_method = PyObject_GetAttrString(d->py_dec, "start");
132 if (!PyFunction_Check(py_method)) {
133 srd_err("Protocol decoder %s Decoder class attribute 'start'"
134 "is not a method.", name);
137 Py_DecRef(py_method);
139 /* Check for a proper decode() method. */
140 if (!PyObject_HasAttrString(d->py_dec, "decode")) {
141 srd_err("Protocol decoder %s has no decode() method Decoder "
145 py_method = PyObject_GetAttrString(d->py_dec, "decode");
146 if (!PyFunction_Check(py_method)) {
147 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
148 "is not a method.", name);
151 Py_DecRef(py_method);
153 /* If present, options must be a dictionary. */
154 if (PyObject_HasAttrString(d->py_dec, "options")) {
155 py_attr = PyObject_GetAttrString(d->py_dec, "options");
156 if (!PyDict_Check(py_attr)) {
157 srd_err("Protocol decoder %s options attribute is not "
158 "a dictionary.", d->name);
164 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
167 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
170 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
173 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
176 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
179 /* TODO: Handle inputformats, outputformats. */
180 d->inputformats = NULL;
181 d->outputformats = NULL;
183 /* Convert class annotation attribute to GSList of **char */
184 d->annotations = NULL;
185 if (PyObject_HasAttrString(d->py_dec, "annotations")) {
186 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
187 if (!PyList_Check(py_annlist)) {
188 srd_err("Protocol decoder module %s annotations should be a list", name);
191 alen = PyList_Size(py_annlist);
192 for (i = 0; i < alen; i++) {
193 py_ann = PyList_GetItem(py_annlist, i);
194 if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
195 srd_err("Protocol decoder module %s annotation %d should be a list with two elements",
200 if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
203 d->annotations = g_slist_append(d->annotations, ann);
212 Py_XDECREF(py_method);
213 Py_XDECREF(py_basedec);
214 Py_XDECREF(d->py_dec);
215 Py_XDECREF(d->py_mod);
222 char *srd_decoder_doc(struct srd_decoder *dec)
227 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
230 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
236 if (py_str != Py_None)
237 py_str_as_str(py_str, &doc);
245 * Unload decoder module.
247 * @param dec The decoder struct to be unloaded.
249 * @return SRD_OK upon success, a (negative) error code otherwise.
251 int srd_unload_decoder(struct srd_decoder *dec)
256 g_free(dec->longname);
258 g_free(dec->license);
260 /* TODO: Free everything in inputformats and outputformats. */
261 if (dec->inputformats != NULL)
262 g_slist_free(dec->inputformats);
263 if (dec->outputformats != NULL)
264 g_slist_free(dec->outputformats);
266 Py_XDECREF(dec->py_dec);
267 Py_XDECREF(dec->py_mod);
269 /* TODO: (g_)free dec itself? */
274 int srd_load_all_decoders(void)
278 struct srd_decoder *dec;
280 const gchar *direntry;
283 if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
284 return SRD_ERR_DECODERS_DIR;
287 while ((direntry = g_dir_read_name(dir)) != NULL) {
288 /* The decoder name is the PD directory name (e.g. "i2c"). */
289 decodername = g_strdup(direntry);
291 /* TODO: Error handling. Use g_try_malloc(). */
292 if (!(dec = malloc(sizeof(struct srd_decoder)))) {
293 Py_Finalize(); /* Returns void. */
294 return SRD_ERR_MALLOC;
297 /* Load the decoder. */
298 /* TODO: Warning if loading fails for a decoder. */
299 if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) {
300 /* Append it to the list of supported/loaded decoders. */
301 pd_list = g_slist_append(pd_list, dec);
312 int srd_unload_all_decoders(void)
315 struct srd_decoder *dec;
317 for (l = srd_list_decoders(); l; l = l->next) {
319 /* TODO: Error handling. */
320 srd_unload_decoder(dec);