]>
Commit | Line | Data |
---|---|---|
b2c19614 BV |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * Copyright (C) 2011 Bert Vermeulen <bert@biot.com> | |
6 | * | |
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. | |
11 | * | |
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. | |
16 | * | |
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/>. | |
19 | */ | |
20 | ||
21 | #include "config.h" | |
73191416 | 22 | #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
15969949 | 23 | #include "sigrokdecode-internal.h" |
b2c19614 BV |
24 | #include <dirent.h> |
25 | ||
26 | /* The list of protocol decoders. */ | |
e5080882 | 27 | GSList *pd_list = NULL; |
b2c19614 | 28 | |
451680f1 BV |
29 | /* lives in module_sigrokdecode.c */ |
30 | extern PyObject *mod_sigrokdecode; | |
31 | ||
b2c19614 BV |
32 | |
33 | /** | |
34 | * Returns the list of supported/loaded protocol decoders. | |
35 | * | |
36 | * This is a GSList containing the names of the decoders as strings. | |
37 | * | |
38 | * @return List of decoders, NULL if none are supported or loaded. | |
39 | */ | |
40 | GSList *srd_list_decoders(void) | |
41 | { | |
42 | ||
e5080882 | 43 | return pd_list; |
b2c19614 BV |
44 | } |
45 | ||
46 | ||
47 | /** | |
48 | * Get the decoder with the specified ID. | |
49 | * | |
50 | * @param id The ID string of the decoder to return. | |
51 | * @return The decoder with the specified ID, or NULL if not found. | |
52 | */ | |
53 | struct srd_decoder *srd_get_decoder_by_id(const char *id) | |
54 | { | |
55 | GSList *l; | |
56 | struct srd_decoder *dec; | |
57 | ||
58 | for (l = srd_list_decoders(); l; l = l->next) { | |
59 | dec = l->data; | |
60 | if (!strcmp(dec->id, id)) | |
61 | return dec; | |
62 | } | |
63 | ||
64 | return NULL; | |
65 | } | |
66 | ||
67 | ||
68 | /** | |
15969949 | 69 | * Load a protocol decoder module into the embedded python interpreter. |
b2c19614 | 70 | * |
15969949 BV |
71 | * @param name The module name to be loaded. |
72 | * @param dec Pointer to the struct srd_decoder filled with the loaded module. | |
b2c19614 BV |
73 | * |
74 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
75 | */ | |
76 | int srd_load_decoder(const char *name, struct srd_decoder **dec) | |
77 | { | |
451680f1 | 78 | PyObject *py_basedec, *py_annlist, *py_ann; |
b2c19614 | 79 | struct srd_decoder *d; |
451680f1 | 80 | int alen, ret, i; |
15969949 | 81 | char **ann; |
b2c19614 | 82 | |
451680f1 BV |
83 | py_basedec = NULL; |
84 | ret = SRD_ERR; | |
85 | srd_dbg("loading module %s", name); | |
b2c19614 | 86 | |
451680f1 BV |
87 | if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) { |
88 | ret = SRD_ERR_MALLOC; | |
89 | goto err_out; | |
b2c19614 BV |
90 | } |
91 | ||
451680f1 BV |
92 | /* Import the Python module. */ |
93 | if (!(d->py_mod = PyImport_ImportModule(name))) { | |
94 | /* TODO: report exception message/traceback to err/dbg */ | |
95 | srd_dbg("import failed"); | |
96 | PyErr_Clear(); | |
97 | ret = SRD_ERR_PYTHON; | |
98 | goto err_out; | |
99 | } | |
b2c19614 | 100 | |
451680f1 BV |
101 | /* Get the 'Decoder' class as Python object. */ |
102 | if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) { | |
103 | /* This generated an AttributeError exception. */ | |
104 | PyErr_Clear(); | |
105 | srd_err("Decoder class not found in protocol decoder module %s", name); | |
106 | ret = SRD_ERR_PYTHON; | |
107 | goto err_out; | |
108 | } | |
b2c19614 | 109 | |
451680f1 BV |
110 | if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) { |
111 | srd_dbg("sigrokdecode module not loaded"); | |
112 | ret = SRD_ERR_PYTHON; | |
113 | goto err_out; | |
114 | } | |
b2c19614 | 115 | |
451680f1 BV |
116 | if (!PyObject_IsSubclass(d->py_dec, py_basedec)) { |
117 | srd_err("Decoder class in protocol decoder module %s is not " | |
118 | "a subclass of sigrokdecode.Decoder", name); | |
119 | ret = SRD_ERR_PYTHON; | |
120 | goto err_out; | |
121 | } | |
122 | Py_DecRef(py_basedec); | |
b2c19614 | 123 | |
451680f1 BV |
124 | if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) { |
125 | return SRD_ERR_PYTHON; | |
126 | goto err_out; | |
127 | } | |
b2c19614 | 128 | |
451680f1 BV |
129 | if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK) { |
130 | return SRD_ERR_PYTHON; | |
131 | goto err_out; | |
132 | } | |
b2c19614 | 133 | |
451680f1 BV |
134 | if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK) { |
135 | return SRD_ERR_PYTHON; | |
136 | goto err_out; | |
137 | } | |
b2c19614 | 138 | |
451680f1 BV |
139 | if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK) { |
140 | return SRD_ERR_PYTHON; | |
141 | goto err_out; | |
142 | } | |
b2c19614 | 143 | |
451680f1 BV |
144 | if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) { |
145 | return SRD_ERR_PYTHON; | |
146 | goto err_out; | |
147 | } | |
b2c19614 | 148 | |
451680f1 | 149 | /* TODO: Handle inputformats, outputformats. */ |
b2c19614 BV |
150 | d->inputformats = NULL; |
151 | d->outputformats = NULL; | |
152 | ||
15969949 | 153 | /* Convert class annotation attribute to GSList of **char */ |
e97b6ef5 | 154 | d->annotations = NULL; |
451680f1 BV |
155 | if (PyObject_HasAttrString(d->py_dec, "annotations")) { |
156 | py_annlist = PyObject_GetAttrString(d->py_dec, "annotations"); | |
15969949 | 157 | if (!PyList_Check(py_annlist)) { |
e97b6ef5 | 158 | srd_err("Protocol decoder module %s annotations should be a list", name); |
451680f1 BV |
159 | ret = SRD_ERR_PYTHON; |
160 | goto err_out; | |
15969949 BV |
161 | } |
162 | alen = PyList_Size(py_annlist); | |
163 | for (i = 0; i < alen; i++) { | |
164 | py_ann = PyList_GetItem(py_annlist, i); | |
165 | if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) { | |
166 | srd_err("Protocol decoder module %s annotation %d should be a list with two elements", | |
167 | name, i+1); | |
451680f1 BV |
168 | ret = SRD_ERR_PYTHON; |
169 | goto err_out; | |
15969949 BV |
170 | } |
171 | ||
451680f1 BV |
172 | if (py_strlist_to_char(py_ann, &ann) != SRD_OK) { |
173 | ret = SRD_ERR_PYTHON; | |
174 | goto err_out; | |
175 | } | |
e97b6ef5 | 176 | d->annotations = g_slist_append(d->annotations, ann); |
15969949 BV |
177 | } |
178 | } | |
179 | ||
b2c19614 | 180 | *dec = d; |
451680f1 BV |
181 | ret = SRD_OK; |
182 | ||
183 | err_out: | |
184 | if (ret != SRD_OK) { | |
185 | Py_XDECREF(py_basedec); | |
186 | Py_XDECREF(d->py_dec); | |
187 | Py_XDECREF(d->py_mod); | |
188 | g_free(d); | |
189 | } | |
b2c19614 | 190 | |
451680f1 BV |
191 | return ret; |
192 | } | |
193 | ||
194 | char *srd_decoder_doc(struct srd_decoder *dec) | |
195 | { | |
e7edca07 | 196 | PyObject *py_str; |
451680f1 BV |
197 | char *doc; |
198 | ||
e7edca07 BV |
199 | if (!PyObject_HasAttrString(dec->py_mod, "__doc__")) |
200 | return NULL; | |
201 | ||
202 | if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) { | |
203 | PyErr_Clear(); | |
204 | return NULL; | |
205 | } | |
206 | ||
451680f1 | 207 | doc = NULL; |
e7edca07 BV |
208 | if (py_str != Py_None) |
209 | py_str_as_str(py_str, &doc); | |
210 | Py_DecRef(py_str); | |
451680f1 BV |
211 | |
212 | return doc; | |
b2c19614 BV |
213 | } |
214 | ||
215 | ||
216 | /** | |
451680f1 BV |
217 | * Unload decoder module. |
218 | * | |
219 | * @param dec The decoder struct to be unloaded. | |
220 | * | |
221 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
b2c19614 BV |
222 | */ |
223 | int srd_unload_decoder(struct srd_decoder *dec) | |
224 | { | |
451680f1 | 225 | |
b2c19614 BV |
226 | g_free(dec->id); |
227 | g_free(dec->name); | |
b231546d | 228 | g_free(dec->longname); |
b2c19614 | 229 | g_free(dec->desc); |
b231546d | 230 | g_free(dec->license); |
b2c19614 BV |
231 | |
232 | /* TODO: Free everything in inputformats and outputformats. */ | |
b2c19614 BV |
233 | if (dec->inputformats != NULL) |
234 | g_slist_free(dec->inputformats); | |
235 | if (dec->outputformats != NULL) | |
236 | g_slist_free(dec->outputformats); | |
237 | ||
451680f1 | 238 | Py_XDECREF(dec->py_dec); |
b2c19614 BV |
239 | Py_XDECREF(dec->py_mod); |
240 | ||
241 | /* TODO: (g_)free dec itself? */ | |
242 | ||
243 | return SRD_OK; | |
244 | } | |
245 | ||
246 | ||
247 | int srd_load_all_decoders(void) | |
248 | { | |
249 | DIR *dir; | |
250 | struct dirent *dp; | |
251 | int ret; | |
252 | char *decodername; | |
253 | struct srd_decoder *dec; | |
254 | ||
255 | if (!(dir = opendir(DECODERS_DIR))) { | |
256 | Py_Finalize(); /* Returns void. */ | |
257 | return SRD_ERR_DECODERS_DIR; | |
258 | } | |
259 | ||
260 | while ((dp = readdir(dir)) != NULL) { | |
261 | /* Ignore filenames which don't end with ".py". */ | |
262 | if (!g_str_has_suffix(dp->d_name, ".py")) | |
263 | continue; | |
264 | ||
265 | /* Decoder name == filename (without .py suffix). */ | |
266 | decodername = g_strndup(dp->d_name, strlen(dp->d_name) - 3); | |
267 | ||
268 | /* TODO: Error handling. Use g_try_malloc(). */ | |
269 | if (!(dec = malloc(sizeof(struct srd_decoder)))) { | |
270 | Py_Finalize(); /* Returns void. */ | |
271 | return SRD_ERR_MALLOC; | |
272 | } | |
273 | ||
274 | /* Load the decoder. */ | |
275 | /* TODO: Warning if loading fails for a decoder. */ | |
276 | if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) { | |
277 | /* Append it to the list of supported/loaded decoders. */ | |
e5080882 | 278 | pd_list = g_slist_append(pd_list, dec); |
b2c19614 BV |
279 | } |
280 | } | |
281 | closedir(dir); | |
282 | ||
283 | return SRD_OK; | |
284 | } | |
285 | ||
286 | ||
287 | /** | |
288 | * TODO | |
289 | */ | |
290 | int srd_unload_all_decoders(void) | |
291 | { | |
292 | GSList *l; | |
293 | struct srd_decoder *dec; | |
294 | ||
295 | for (l = srd_list_decoders(); l; l = l->next) { | |
296 | dec = l->data; | |
297 | /* TODO: Error handling. */ | |
298 | srd_unload_decoder(dec); | |
299 | } | |
300 | ||
301 | return SRD_OK; | |
302 | } | |
303 | ||
304 | ||
305 |