]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrokdecode project. | |
3 | * | |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * Copyright (C) 2012 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> | |
22 | #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ | |
23 | ||
24 | /** | |
25 | * Import a Python module by name. | |
26 | * | |
27 | * This function is implemented in terms of PyImport_Import() rather than | |
28 | * PyImport_ImportModule(), so that the import hooks are not bypassed. | |
29 | * | |
30 | * @param[in] name The name of the module to load as UTF-8 string. | |
31 | * @return The Python module object, or NULL if an exception occurred. The | |
32 | * caller is responsible for evaluating and clearing the Python error state. | |
33 | * | |
34 | * @private | |
35 | */ | |
36 | SRD_PRIV PyObject *py_import_by_name(const char *name) | |
37 | { | |
38 | PyObject *py_mod, *py_modname; | |
39 | PyGILState_STATE gstate; | |
40 | ||
41 | gstate = PyGILState_Ensure(); | |
42 | ||
43 | py_modname = PyUnicode_FromString(name); | |
44 | if (!py_modname) { | |
45 | PyGILState_Release(gstate); | |
46 | return NULL; | |
47 | } | |
48 | ||
49 | py_mod = PyImport_Import(py_modname); | |
50 | Py_DECREF(py_modname); | |
51 | ||
52 | PyGILState_Release(gstate); | |
53 | ||
54 | return py_mod; | |
55 | } | |
56 | ||
57 | /** | |
58 | * Get the value of a Python object's attribute, returned as a newly | |
59 | * allocated char *. | |
60 | * | |
61 | * @param[in] py_obj The object to probe. | |
62 | * @param[in] attr Name of the attribute to retrieve. | |
63 | * @param[out] outstr ptr to char * storage to be filled in. | |
64 | * | |
65 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
66 | * The 'outstr' argument points to a g_malloc()ed string upon success. | |
67 | * | |
68 | * @private | |
69 | */ | |
70 | SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr) | |
71 | { | |
72 | PyObject *py_str; | |
73 | int ret; | |
74 | PyGILState_STATE gstate; | |
75 | ||
76 | gstate = PyGILState_Ensure(); | |
77 | ||
78 | if (!PyObject_HasAttrString(py_obj, attr)) { | |
79 | srd_dbg("Object has no attribute '%s'.", attr); | |
80 | goto err; | |
81 | } | |
82 | ||
83 | if (!(py_str = PyObject_GetAttrString(py_obj, attr))) { | |
84 | srd_exception_catch("Failed to get attribute '%s'", attr); | |
85 | goto err; | |
86 | } | |
87 | ||
88 | ret = py_str_as_str(py_str, outstr); | |
89 | Py_DECREF(py_str); | |
90 | ||
91 | PyGILState_Release(gstate); | |
92 | ||
93 | return ret; | |
94 | ||
95 | err: | |
96 | PyGILState_Release(gstate); | |
97 | ||
98 | return SRD_ERR_PYTHON; | |
99 | } | |
100 | ||
101 | /** | |
102 | * Get the value of a Python object's attribute, returned as a newly | |
103 | * allocated GSList of char *. | |
104 | * | |
105 | * @param[in] py_obj The object to probe. | |
106 | * @param[in] attr Name of the attribute to retrieve. | |
107 | * @param[out] outstrlist ptr to GSList of char * storage to be filled in. | |
108 | * | |
109 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
110 | * The 'outstrlist' argument points to a GSList of g_malloc()ed strings | |
111 | * upon success. | |
112 | * | |
113 | * @private | |
114 | */ | |
115 | SRD_PRIV int py_attr_as_strlist(PyObject *py_obj, const char *attr, GSList **outstrlist) | |
116 | { | |
117 | PyObject *py_list; | |
118 | Py_ssize_t i; | |
119 | int ret; | |
120 | char *outstr; | |
121 | PyGILState_STATE gstate; | |
122 | ||
123 | gstate = PyGILState_Ensure(); | |
124 | ||
125 | if (!PyObject_HasAttrString(py_obj, attr)) { | |
126 | srd_dbg("Object has no attribute '%s'.", attr); | |
127 | goto err; | |
128 | } | |
129 | ||
130 | if (!(py_list = PyObject_GetAttrString(py_obj, attr))) { | |
131 | srd_exception_catch("Failed to get attribute '%s'", attr); | |
132 | goto err; | |
133 | } | |
134 | ||
135 | if (!PyList_Check(py_list)) { | |
136 | srd_dbg("Object is not a list."); | |
137 | goto err; | |
138 | } | |
139 | ||
140 | *outstrlist = NULL; | |
141 | ||
142 | for (i = 0; i < PyList_Size(py_list); i++) { | |
143 | ret = py_listitem_as_str(py_list, i, &outstr); | |
144 | if (ret < 0) { | |
145 | srd_dbg("Couldn't get item %" PY_FORMAT_SIZE_T "d.", i); | |
146 | goto err; | |
147 | } | |
148 | *outstrlist = g_slist_append(*outstrlist, outstr); | |
149 | } | |
150 | ||
151 | Py_DECREF(py_list); | |
152 | ||
153 | PyGILState_Release(gstate); | |
154 | ||
155 | return SRD_OK; | |
156 | ||
157 | err: | |
158 | PyGILState_Release(gstate); | |
159 | ||
160 | return SRD_ERR_PYTHON; | |
161 | } | |
162 | ||
163 | /** | |
164 | * Get the value of a Python dictionary item, returned as a newly | |
165 | * allocated char *. | |
166 | * | |
167 | * @param[in] py_obj The dictionary to probe. | |
168 | * @param[in] key Key of the item to retrieve. | |
169 | * @param[out] outstr Pointer to char * storage to be filled in. | |
170 | * | |
171 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
172 | * The 'outstr' argument points to a g_malloc()ed string upon success. | |
173 | * | |
174 | * @private | |
175 | */ | |
176 | SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key, | |
177 | char **outstr) | |
178 | { | |
179 | PyObject *py_value; | |
180 | PyGILState_STATE gstate; | |
181 | ||
182 | gstate = PyGILState_Ensure(); | |
183 | ||
184 | if (!PyDict_Check(py_obj)) { | |
185 | srd_dbg("Object is not a dictionary."); | |
186 | goto err; | |
187 | } | |
188 | ||
189 | if (!(py_value = PyDict_GetItemString(py_obj, key))) { | |
190 | srd_dbg("Dictionary has no attribute '%s'.", key); | |
191 | goto err; | |
192 | } | |
193 | ||
194 | PyGILState_Release(gstate); | |
195 | ||
196 | return py_str_as_str(py_value, outstr); | |
197 | ||
198 | err: | |
199 | PyGILState_Release(gstate); | |
200 | ||
201 | return SRD_ERR_PYTHON; | |
202 | } | |
203 | ||
204 | /** | |
205 | * Get the value of a Python list item, returned as a newly | |
206 | * allocated char *. | |
207 | * | |
208 | * @param[in] py_obj The list to probe. | |
209 | * @param[in] idx Index of the list item to retrieve. | |
210 | * @param[out] outstr Pointer to char * storage to be filled in. | |
211 | * | |
212 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
213 | * The 'outstr' argument points to a g_malloc()ed string upon success. | |
214 | * | |
215 | * @private | |
216 | */ | |
217 | SRD_PRIV int py_listitem_as_str(PyObject *py_obj, Py_ssize_t idx, | |
218 | char **outstr) | |
219 | { | |
220 | PyObject *py_value; | |
221 | PyGILState_STATE gstate; | |
222 | ||
223 | gstate = PyGILState_Ensure(); | |
224 | ||
225 | if (!PyList_Check(py_obj)) { | |
226 | srd_dbg("Object is not a list."); | |
227 | goto err; | |
228 | } | |
229 | ||
230 | if (!(py_value = PyList_GetItem(py_obj, idx))) { | |
231 | srd_dbg("Couldn't get list item %" PY_FORMAT_SIZE_T "d.", idx); | |
232 | goto err; | |
233 | } | |
234 | ||
235 | PyGILState_Release(gstate); | |
236 | ||
237 | return py_str_as_str(py_value, outstr); | |
238 | ||
239 | err: | |
240 | PyGILState_Release(gstate); | |
241 | ||
242 | return SRD_ERR_PYTHON; | |
243 | } | |
244 | ||
245 | /** | |
246 | * Get the value of a Python dictionary item, returned as a newly | |
247 | * allocated char *. | |
248 | * | |
249 | * @param py_obj The dictionary to probe. | |
250 | * @param py_key Key of the item to retrieve. | |
251 | * @param outstr Pointer to char * storage to be filled in. | |
252 | * | |
253 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
254 | * The 'outstr' argument points to a malloc()ed string upon success. | |
255 | * | |
256 | * @private | |
257 | */ | |
258 | SRD_PRIV int py_pydictitem_as_str(PyObject *py_obj, PyObject *py_key, | |
259 | char **outstr) | |
260 | { | |
261 | PyObject *py_value; | |
262 | PyGILState_STATE gstate; | |
263 | ||
264 | if (!py_obj || !py_key || !outstr) | |
265 | return SRD_ERR_ARG; | |
266 | ||
267 | gstate = PyGILState_Ensure(); | |
268 | ||
269 | if (!PyDict_Check(py_obj)) { | |
270 | srd_dbg("Object is not a dictionary."); | |
271 | goto err; | |
272 | } | |
273 | ||
274 | if (!(py_value = PyDict_GetItem(py_obj, py_key))) { | |
275 | srd_dbg("Dictionary has no such key."); | |
276 | goto err; | |
277 | } | |
278 | ||
279 | if (!PyUnicode_Check(py_value)) { | |
280 | srd_dbg("Dictionary value should be a string."); | |
281 | goto err; | |
282 | } | |
283 | ||
284 | return py_str_as_str(py_value, outstr); | |
285 | ||
286 | err: | |
287 | PyGILState_Release(gstate); | |
288 | ||
289 | return SRD_ERR_PYTHON; | |
290 | } | |
291 | ||
292 | /** | |
293 | * Get the value of a Python dictionary item, returned as a newly | |
294 | * allocated char *. | |
295 | * | |
296 | * @param py_obj The dictionary to probe. | |
297 | * @param py_key Key of the item to retrieve. | |
298 | * @param out TODO. | |
299 | * | |
300 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
301 | * | |
302 | * @private | |
303 | */ | |
304 | SRD_PRIV int py_pydictitem_as_long(PyObject *py_obj, PyObject *py_key, uint64_t *out) | |
305 | { | |
306 | PyObject *py_value; | |
307 | PyGILState_STATE gstate; | |
308 | ||
309 | if (!py_obj || !py_key || !out) | |
310 | return SRD_ERR_ARG; | |
311 | ||
312 | gstate = PyGILState_Ensure(); | |
313 | ||
314 | if (!PyDict_Check(py_obj)) { | |
315 | srd_dbg("Object is not a dictionary."); | |
316 | goto err; | |
317 | } | |
318 | ||
319 | if (!(py_value = PyDict_GetItem(py_obj, py_key))) { | |
320 | srd_dbg("Dictionary has no such key."); | |
321 | goto err; | |
322 | } | |
323 | ||
324 | if (!PyLong_Check(py_value)) { | |
325 | srd_dbg("Dictionary value should be a long."); | |
326 | goto err; | |
327 | } | |
328 | ||
329 | *out = PyLong_AsUnsignedLongLong(py_value); | |
330 | ||
331 | PyGILState_Release(gstate); | |
332 | ||
333 | return SRD_OK; | |
334 | ||
335 | err: | |
336 | PyGILState_Release(gstate); | |
337 | ||
338 | return SRD_ERR_PYTHON; | |
339 | } | |
340 | ||
341 | /** | |
342 | * Get the value of a Python unicode string object, returned as a newly | |
343 | * allocated char *. | |
344 | * | |
345 | * @param[in] py_str The unicode string object. | |
346 | * @param[out] outstr ptr to char * storage to be filled in. | |
347 | * | |
348 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
349 | * The 'outstr' argument points to a g_malloc()ed string upon success. | |
350 | * | |
351 | * @private | |
352 | */ | |
353 | SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr) | |
354 | { | |
355 | PyObject *py_bytes; | |
356 | char *str; | |
357 | PyGILState_STATE gstate; | |
358 | ||
359 | gstate = PyGILState_Ensure(); | |
360 | ||
361 | if (!PyUnicode_Check(py_str)) { | |
362 | srd_dbg("Object is not a string object."); | |
363 | PyGILState_Release(gstate); | |
364 | return SRD_ERR_PYTHON; | |
365 | } | |
366 | ||
367 | py_bytes = PyUnicode_AsUTF8String(py_str); | |
368 | if (py_bytes) { | |
369 | str = g_strdup(PyBytes_AsString(py_bytes)); | |
370 | Py_DECREF(py_bytes); | |
371 | if (str) { | |
372 | *outstr = str; | |
373 | PyGILState_Release(gstate); | |
374 | return SRD_OK; | |
375 | } | |
376 | } | |
377 | srd_exception_catch("Failed to extract string"); | |
378 | ||
379 | PyGILState_Release(gstate); | |
380 | ||
381 | return SRD_ERR_PYTHON; | |
382 | } | |
383 | ||
384 | /** | |
385 | * Convert a Python list of unicode strings to a C string vector. | |
386 | * On success, a pointer to a newly allocated NULL-terminated array of | |
387 | * allocated C strings is written to @a out_strv. The caller must g_free() | |
388 | * each string and the array itself. | |
389 | * | |
390 | * @param[in] py_strseq The sequence object. | |
391 | * @param[out] out_strv Address of string vector to be filled in. | |
392 | * | |
393 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
394 | * | |
395 | * @private | |
396 | */ | |
397 | SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv) | |
398 | { | |
399 | PyObject *py_item, *py_bytes; | |
400 | char **strv, *str; | |
401 | ssize_t seq_len, i; | |
402 | PyGILState_STATE gstate; | |
403 | int ret = SRD_ERR_PYTHON; | |
404 | ||
405 | gstate = PyGILState_Ensure(); | |
406 | ||
407 | if (!PySequence_Check(py_strseq)) { | |
408 | srd_err("Object does not provide sequence protocol."); | |
409 | goto err; | |
410 | } | |
411 | ||
412 | seq_len = PySequence_Size(py_strseq); | |
413 | if (seq_len < 0) { | |
414 | srd_exception_catch("Failed to obtain sequence size"); | |
415 | goto err; | |
416 | } | |
417 | ||
418 | strv = g_try_new0(char *, seq_len + 1); | |
419 | if (!strv) { | |
420 | srd_err("Failed to allocate result string vector."); | |
421 | ret = SRD_ERR_MALLOC; | |
422 | goto err; | |
423 | } | |
424 | ||
425 | for (i = 0; i < seq_len; i++) { | |
426 | py_item = PySequence_GetItem(py_strseq, i); | |
427 | if (!py_item) | |
428 | goto err_out; | |
429 | ||
430 | if (!PyUnicode_Check(py_item)) { | |
431 | Py_DECREF(py_item); | |
432 | goto err_out; | |
433 | } | |
434 | py_bytes = PyUnicode_AsUTF8String(py_item); | |
435 | Py_DECREF(py_item); | |
436 | if (!py_bytes) | |
437 | goto err_out; | |
438 | ||
439 | str = g_strdup(PyBytes_AsString(py_bytes)); | |
440 | Py_DECREF(py_bytes); | |
441 | if (!str) | |
442 | goto err_out; | |
443 | ||
444 | strv[i] = str; | |
445 | } | |
446 | *out_strv = strv; | |
447 | ||
448 | return SRD_OK; | |
449 | ||
450 | err_out: | |
451 | g_strfreev(strv); | |
452 | srd_exception_catch("Failed to obtain string item"); | |
453 | ||
454 | err: | |
455 | PyGILState_Release(gstate); | |
456 | ||
457 | return ret; | |
458 | } | |
459 | ||
460 | /** | |
461 | * Convert a Python scalar object to a GLib variant. | |
462 | * Supported variant types are string, int64 and double. | |
463 | * | |
464 | * @param[in] py_obj The Python object. Must not be NULL. | |
465 | * @return A floating reference to a new variant, or NULL on failure. | |
466 | * | |
467 | * @private | |
468 | */ | |
469 | SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj) | |
470 | { | |
471 | GVariant *var = NULL; | |
472 | PyGILState_STATE gstate; | |
473 | ||
474 | gstate = PyGILState_Ensure(); | |
475 | ||
476 | if (PyUnicode_Check(py_obj)) { /* string */ | |
477 | PyObject *py_bytes; | |
478 | const char *str; | |
479 | ||
480 | py_bytes = PyUnicode_AsUTF8String(py_obj); | |
481 | if (py_bytes) { | |
482 | str = PyBytes_AsString(py_bytes); | |
483 | if (str) | |
484 | var = g_variant_new_string(str); | |
485 | Py_DECREF(py_bytes); | |
486 | } | |
487 | if (!var) | |
488 | srd_exception_catch("Failed to extract string value"); | |
489 | ||
490 | } else if (PyLong_Check(py_obj)) { /* integer */ | |
491 | int64_t val; | |
492 | ||
493 | val = PyLong_AsLongLong(py_obj); | |
494 | if (!PyErr_Occurred()) | |
495 | var = g_variant_new_int64(val); | |
496 | else | |
497 | srd_exception_catch("Failed to extract integer value"); | |
498 | ||
499 | } else if (PyFloat_Check(py_obj)) { /* float */ | |
500 | double val; | |
501 | ||
502 | val = PyFloat_AsDouble(py_obj); | |
503 | if (!PyErr_Occurred()) | |
504 | var = g_variant_new_double(val); | |
505 | else | |
506 | srd_exception_catch("Failed to extract float value"); | |
507 | ||
508 | } else { | |
509 | srd_err("Failed to extract value of unsupported type."); | |
510 | } | |
511 | ||
512 | PyGILState_Release(gstate); | |
513 | ||
514 | return var; | |
515 | } |