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;
31 * Returns the list of supported/loaded protocol decoders.
33 * This is a GSList containing the names of the decoders as strings.
35 * @return List of decoders, NULL if none are supported or loaded.
37 GSList *srd_list_decoders(void)
45 * Get the decoder with the specified ID.
47 * @param id The ID string of the decoder to return.
48 * @return The decoder with the specified ID, or NULL if not found.
50 struct srd_decoder *srd_get_decoder_by_id(const char *id)
53 struct srd_decoder *dec;
55 for (l = srd_list_decoders(); l; l = l->next) {
57 if (!strcmp(dec->id, id))
66 * Load a protocol decoder module into the embedded python interpreter.
68 * @param name The module name to be loaded.
69 * @param dec Pointer to the struct srd_decoder filled with the loaded module.
71 * @return SRD_OK upon success, a (negative) error code otherwise.
73 int srd_load_decoder(const char *name, struct srd_decoder **dec)
75 PyObject *py_mod, *py_res, *py_annlist, *py_ann;
76 struct srd_decoder *d;
80 /* "Import" the Python module. */
81 if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
82 PyErr_Print(); /* Returns void. */
83 return SRD_ERR_PYTHON; /* TODO: More specific error? */
86 /* Get the 'Decoder' class as Python object. */
87 py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */
90 PyErr_Print(); /* Returns void. */
92 srd_err("Decoder class not found in PD module %s", name);
93 return SRD_ERR_PYTHON; /* TODO: More specific error? */
96 if (!(d = malloc(sizeof(struct srd_decoder))))
97 return SRD_ERR_MALLOC;
99 if ((r = h_str(py_res, "id", &(d->id))) < 0)
102 if ((r = h_str(py_res, "name", &(d->name))) < 0)
105 if ((r = h_str(py_res, "longname", &(d->longname))) < 0)
108 if ((r = h_str(py_res, "desc", &(d->desc))) < 0)
111 if ((r = h_str(py_res, "longdesc", &(d->longdesc))) < 0)
114 if ((r = h_str(py_res, "author", &(d->author))) < 0)
117 if ((r = h_str(py_res, "license", &(d->license))) < 0)
121 d->py_decobj = py_res;
123 /* TODO: Handle func, inputformats, outputformats. */
124 /* Note: They must at least be set to NULL, will segfault otherwise. */
126 d->inputformats = NULL;
127 d->outputformats = NULL;
129 /* Convert class annotation attribute to GSList of **char */
130 d->annotation = NULL;
131 if (PyObject_HasAttrString(py_res, "annotation")) {
132 py_annlist = PyObject_GetAttrString(py_res, "annotation");
133 if (!PyList_Check(py_annlist)) {
134 srd_err("Protocol decoder module %s annotation should be a list", name);
135 return SRD_ERR_PYTHON;
137 alen = PyList_Size(py_annlist);
138 for (i = 0; i < alen; i++) {
139 py_ann = PyList_GetItem(py_annlist, i);
140 if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
141 srd_err("Protocol decoder module %s annotation %d should be a list with two elements",
143 return SRD_ERR_PYTHON;
146 if (py_strlist_to_char(py_ann, &ann) != SRD_OK)
147 return SRD_ERR_PYTHON;
148 d->annotation = g_slist_append(d->annotation, ann);
161 int srd_unload_decoder(struct srd_decoder *dec)
165 g_free(dec->longname);
167 g_free(dec->longdesc);
169 g_free(dec->license);
172 /* TODO: Free everything in inputformats and outputformats. */
174 if (dec->inputformats != NULL)
175 g_slist_free(dec->inputformats);
176 if (dec->outputformats != NULL)
177 g_slist_free(dec->outputformats);
179 Py_XDECREF(dec->py_decobj);
180 Py_XDECREF(dec->py_mod);
182 /* TODO: (g_)free dec itself? */
188 int srd_load_all_decoders(void)
194 struct srd_decoder *dec;
196 if (!(dir = opendir(DECODERS_DIR))) {
197 Py_Finalize(); /* Returns void. */
198 return SRD_ERR_DECODERS_DIR;
201 while ((dp = readdir(dir)) != NULL) {
202 /* Ignore filenames which don't end with ".py". */
203 if (!g_str_has_suffix(dp->d_name, ".py"))
206 /* Decoder name == filename (without .py suffix). */
207 decodername = g_strndup(dp->d_name, strlen(dp->d_name) - 3);
209 /* TODO: Error handling. Use g_try_malloc(). */
210 if (!(dec = malloc(sizeof(struct srd_decoder)))) {
211 Py_Finalize(); /* Returns void. */
212 return SRD_ERR_MALLOC;
215 /* Load the decoder. */
216 /* TODO: Warning if loading fails for a decoder. */
217 if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) {
218 /* Append it to the list of supported/loaded decoders. */
219 pd_list = g_slist_append(pd_list, dec);
231 int srd_unload_all_decoders(void)
234 struct srd_decoder *dec;
236 for (l = srd_list_decoders(); l; l = l->next) {
238 /* TODO: Error handling. */
239 srd_unload_decoder(dec);