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/>.
23 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
24 #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_annlist, *py_ann;
79 struct srd_decoder *d;
86 srd_dbg("decoder: %s: loading module '%s'", __func__, name);
88 if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
89 srd_err("decoder: %s: d malloc failed", __func__);
94 /* Import the Python module. */
95 if (!(d->py_mod = PyImport_ImportModule(name))) {
96 /* TODO: Report exception message/traceback to err/dbg. */
97 srd_warn("decoder: %s: import of '%s' failed", __func__, name);
100 ret = SRD_ERR_PYTHON;
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 module %s", name);
110 ret = SRD_ERR_PYTHON;
114 if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
115 srd_dbg("sigrokdecode module not loaded");
116 ret = SRD_ERR_PYTHON;
120 if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
121 srd_err("Decoder class in protocol decoder module %s is not "
122 "a subclass of sigrokdecode.Decoder", name);
123 ret = SRD_ERR_PYTHON;
126 Py_DecRef(py_basedec);
128 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) {
129 return SRD_ERR_PYTHON;
133 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK) {
134 return SRD_ERR_PYTHON;
138 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK) {
139 return SRD_ERR_PYTHON;
143 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK) {
144 return SRD_ERR_PYTHON;
148 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) {
149 return SRD_ERR_PYTHON;
153 /* TODO: Handle inputformats, outputformats. */
154 d->inputformats = NULL;
155 d->outputformats = NULL;
157 /* Convert class annotation attribute to GSList of **char */
158 d->annotations = NULL;
159 if (PyObject_HasAttrString(d->py_dec, "annotations")) {
160 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
161 if (!PyList_Check(py_annlist)) {
162 srd_err("Protocol decoder module %s annotations should be a list", name);
163 ret = SRD_ERR_PYTHON;
166 alen = PyList_Size(py_annlist);
167 for (i = 0; i < alen; i++) {
168 py_ann = PyList_GetItem(py_annlist, i);
169 if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
170 srd_err("Protocol decoder module %s annotation %d should be a list with two elements",
172 ret = SRD_ERR_PYTHON;
176 if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
177 ret = SRD_ERR_PYTHON;
180 d->annotations = g_slist_append(d->annotations, ann);
189 Py_XDECREF(py_basedec);
190 Py_XDECREF(d->py_dec);
191 Py_XDECREF(d->py_mod);
198 char *srd_decoder_doc(struct srd_decoder *dec)
203 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
206 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
212 if (py_str != Py_None)
213 py_str_as_str(py_str, &doc);
221 * Unload decoder module.
223 * @param dec The decoder struct to be unloaded.
225 * @return SRD_OK upon success, a (negative) error code otherwise.
227 int srd_unload_decoder(struct srd_decoder *dec)
232 g_free(dec->longname);
234 g_free(dec->license);
236 /* TODO: Free everything in inputformats and outputformats. */
237 if (dec->inputformats != NULL)
238 g_slist_free(dec->inputformats);
239 if (dec->outputformats != NULL)
240 g_slist_free(dec->outputformats);
242 Py_XDECREF(dec->py_dec);
243 Py_XDECREF(dec->py_mod);
245 /* TODO: (g_)free dec itself? */
251 * Check if the directory in the specified search path is a valid PD dir.
253 * A valid sigrok protocol decoder consists of a directory, which contains
254 * at least two .py files (the special __init__.py and at least one additional
255 * .py file which contains the actual PD code).
257 * TODO: We should also check that this is not a random other Python module,
258 * but really a sigrok PD module by some means.
260 * @param search_path A string containing the (absolute) path to the directory
261 * where 'entry' resides in.
262 * @param entry A string containing the (relative) directory name of the
263 * sigrok PD module. E.g. "i2c" for the I2C protocol decoder.
264 * @return SRD_OK, if the directory is a valid sigrok PD, a negative error
265 * code, such as SRD_ERR, otherwise.
267 int srd_is_valid_pd_dir(const gchar *search_path, const gchar *entry)
270 int py_files = 0, has_init_py = 0;
271 gchar *path1, *path2, *file;
274 /* TODO: Error handling. */
275 path1 = g_build_filename(search_path, entry, NULL);
277 /* Check that it is a directory (and exists). */
278 if (!g_file_test(path1, G_FILE_TEST_IS_DIR)) {
279 srd_dbg("decoder: %s: '%s' not a directory or doesn't exist",
284 if (!(dir = g_dir_open(path1, 0, &error))) { /* TODO: flags? */
285 srd_dbg("decoder: %s: '%s' failed to open directory",
290 /* Check the contents of the directory. */
291 while ((file = g_dir_read_name(dir)) != NULL) {
292 /* TODO: Error handling. */
293 path2 = g_build_filename(path1, file, NULL);
295 /* Ignore non-files. */
296 if (!g_file_test(path2, G_FILE_TEST_IS_REGULAR)) {
297 srd_spew("decoder: %s: '%s' not a file, ignoring",
302 /* Count number of .py files. */
303 if (g_str_has_suffix(path2, ".py")) {
304 srd_spew("decoder: %s: found .py file: '%s'",
309 /* Check if it's an __init__.py file. */
310 if (g_str_has_suffix(path2, "__init__.py")) {
311 srd_spew("decoder: %s: found __init__.py file: '%s'",
318 /* Check if the directory contains >= 2 *.py files. */
320 srd_dbg("decoder: %s: '%s' is not a valid PD dir, it doesn't "
321 "contain >= 2 .py files", __func__, entry);
325 /* Check if the directory contains an __init__.py file. */
327 srd_dbg("decoder: %s: '%s' is not a valid PD dir, it doesn't "
328 "contain an __init__.py file", __func__, entry);
332 /* TODO: Check if it's a PD, not a random other Python module. */
337 int srd_load_all_decoders(void)
343 struct srd_decoder *dec;
346 if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) { /* TODO: flags? */
347 Py_Finalize(); /* Returns void. */
348 return SRD_ERR_DECODERS_DIR;
351 while ((direntry = g_dir_read_name(dir)) != NULL) {
352 /* Ignore directory entries which are not valid PDs. */
353 if (srd_is_valid_pd_dir(DECODERS_DIR, direntry) != SRD_OK) {
354 srd_dbg("decoder: %s: '%s' not a valid PD dir, "
355 "ignoring it", __func__, direntry);
359 /* The decoder name is the PD directory name (e.g. "i2c"). */
360 decodername = g_strdup(direntry);
362 /* TODO: Error handling. Use g_try_malloc(). */
363 if (!(dec = malloc(sizeof(struct srd_decoder)))) {
364 Py_Finalize(); /* Returns void. */
365 return SRD_ERR_MALLOC;
368 /* Load the decoder. */
369 /* TODO: Warning if loading fails for a decoder. */
370 if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) {
371 /* Append it to the list of supported/loaded decoders. */
372 pd_list = g_slist_append(pd_list, dec);
383 int srd_unload_all_decoders(void)
386 struct srd_decoder *dec;
388 for (l = srd_list_decoders(); l; l = l->next) {
390 /* TODO: Error handling. */
391 srd_unload_decoder(dec);