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. */
25 /* The list of protocol decoders. */
26 GSList *pd_list = NULL;
27 GSList *di_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))
70 * @return SRD_OK upon success, a (negative) error code otherwise.
72 int srd_load_decoder(const char *name, struct srd_decoder **dec)
74 struct srd_decoder *d;
75 PyObject *py_mod, *py_res;
78 fprintf(stdout, "%s: %s\n", __func__, name);
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 fprintf(stderr, "Decoder class not found in PD module %s\n", 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",
106 &(d->longname))) < 0)
109 if ((r = h_str(py_res, "desc", &(d->desc))) < 0)
112 if ((r = h_str(py_res, "longdesc",
113 &(d->longdesc))) < 0)
116 if ((r = h_str(py_res, "author", &(d->author))) < 0)
119 if ((r = h_str(py_res, "email", &(d->email))) < 0)
122 if ((r = h_str(py_res, "license", &(d->license))) < 0)
126 d->py_decobj = py_res;
128 /* TODO: Handle func, inputformats, outputformats. */
129 /* Note: They must at least be set to NULL, will segfault otherwise. */
131 d->inputformats = NULL;
132 d->outputformats = NULL;
143 int srd_unload_decoder(struct srd_decoder *dec)
150 /* TODO: Free everything in inputformats and outputformats. */
152 if (dec->inputformats != NULL)
153 g_slist_free(dec->inputformats);
154 if (dec->outputformats != NULL)
155 g_slist_free(dec->outputformats);
157 Py_XDECREF(dec->py_decobj);
158 Py_XDECREF(dec->py_mod);
160 /* TODO: (g_)free dec itself? */
166 int srd_load_all_decoders(void)
172 struct srd_decoder *dec;
174 if (!(dir = opendir(DECODERS_DIR))) {
175 Py_Finalize(); /* Returns void. */
176 return SRD_ERR_DECODERS_DIR;
179 while ((dp = readdir(dir)) != NULL) {
180 /* Ignore filenames which don't end with ".py". */
181 if (!g_str_has_suffix(dp->d_name, ".py"))
184 /* Decoder name == filename (without .py suffix). */
185 decodername = g_strndup(dp->d_name, strlen(dp->d_name) - 3);
187 /* TODO: Error handling. Use g_try_malloc(). */
188 if (!(dec = malloc(sizeof(struct srd_decoder)))) {
189 Py_Finalize(); /* Returns void. */
190 return SRD_ERR_MALLOC;
193 /* Load the decoder. */
194 /* TODO: Warning if loading fails for a decoder. */
195 if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) {
196 /* Append it to the list of supported/loaded decoders. */
197 pd_list = g_slist_append(pd_list, dec);
209 int srd_unload_all_decoders(void)
212 struct srd_decoder *dec;
214 for (l = srd_list_decoders(); l; l = l->next) {
216 /* TODO: Error handling. */
217 srd_unload_decoder(dec);