2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 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 "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
25 * Import a Python module by name.
27 * This function is implemented in terms of PyImport_Import() rather than
28 * PyImport_ImportModule(), so that the import hooks are not bypassed.
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.
36 SRD_PRIV PyObject *py_import_by_name(const char *name)
38 PyObject *py_mod, *py_modname;
39 PyGILState_STATE gstate;
41 gstate = PyGILState_Ensure();
43 py_modname = PyUnicode_FromString(name);
45 PyGILState_Release(gstate);
49 py_mod = PyImport_Import(py_modname);
50 Py_DECREF(py_modname);
52 PyGILState_Release(gstate);
58 * Get the value of a Python object's attribute, returned as a newly
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.
65 * @return SRD_OK upon success, a (negative) error code otherwise.
66 * The 'outstr' argument points to a g_malloc()ed string upon success.
70 SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr)
74 PyGILState_STATE gstate;
76 gstate = PyGILState_Ensure();
78 if (!PyObject_HasAttrString(py_obj, attr)) {
79 srd_dbg("Object has no attribute '%s'.", attr);
83 if (!(py_str = PyObject_GetAttrString(py_obj, attr))) {
84 srd_exception_catch("Failed to get attribute '%s'", attr);
88 ret = py_str_as_str(py_str, outstr);
91 PyGILState_Release(gstate);
96 PyGILState_Release(gstate);
98 return SRD_ERR_PYTHON;
102 * Get the value of a Python object's attribute, returned as a newly
103 * allocated GSList of char *.
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.
109 * @return SRD_OK upon success, a (negative) error code otherwise.
110 * The 'outstrlist' argument points to a GSList of g_malloc()ed strings
115 SRD_PRIV int py_attr_as_strlist(PyObject *py_obj, const char *attr, GSList **outstrlist)
121 PyGILState_STATE gstate;
123 gstate = PyGILState_Ensure();
125 if (!PyObject_HasAttrString(py_obj, attr)) {
126 srd_dbg("Object has no attribute '%s'.", attr);
130 if (!(py_list = PyObject_GetAttrString(py_obj, attr))) {
131 srd_exception_catch("Failed to get attribute '%s'", attr);
135 if (!PyList_Check(py_list)) {
136 srd_dbg("Object is not a list.");
142 for (i = 0; i < PyList_Size(py_list); i++) {
143 ret = py_listitem_as_str(py_list, i, &outstr);
145 srd_dbg("Couldn't get item %" PY_FORMAT_SIZE_T "d.", i);
148 *outstrlist = g_slist_append(*outstrlist, outstr);
153 PyGILState_Release(gstate);
158 PyGILState_Release(gstate);
160 return SRD_ERR_PYTHON;
164 * Get the value of a Python dictionary item, returned as a newly
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.
171 * @return SRD_OK upon success, a (negative) error code otherwise.
172 * The 'outstr' argument points to a g_malloc()ed string upon success.
176 SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key,
180 PyGILState_STATE gstate;
182 gstate = PyGILState_Ensure();
184 if (!PyDict_Check(py_obj)) {
185 srd_dbg("Object is not a dictionary.");
189 if (!(py_value = PyDict_GetItemString(py_obj, key))) {
190 srd_dbg("Dictionary has no attribute '%s'.", key);
194 PyGILState_Release(gstate);
196 return py_str_as_str(py_value, outstr);
199 PyGILState_Release(gstate);
201 return SRD_ERR_PYTHON;
205 * Get the value of a Python list item, returned as a newly
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.
212 * @return SRD_OK upon success, a (negative) error code otherwise.
213 * The 'outstr' argument points to a g_malloc()ed string upon success.
217 SRD_PRIV int py_listitem_as_str(PyObject *py_obj, Py_ssize_t idx,
221 PyGILState_STATE gstate;
223 gstate = PyGILState_Ensure();
225 if (!PyList_Check(py_obj)) {
226 srd_dbg("Object is not a list.");
230 if (!(py_value = PyList_GetItem(py_obj, idx))) {
231 srd_dbg("Couldn't get list item %" PY_FORMAT_SIZE_T "d.", idx);
235 PyGILState_Release(gstate);
237 return py_str_as_str(py_value, outstr);
240 PyGILState_Release(gstate);
242 return SRD_ERR_PYTHON;
246 * Get the value of a Python dictionary item, returned as a newly
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.
253 * @return SRD_OK upon success, a (negative) error code otherwise.
254 * The 'outstr' argument points to a malloc()ed string upon success.
258 SRD_PRIV int py_pydictitem_as_str(PyObject *py_obj, PyObject *py_key,
262 PyGILState_STATE gstate;
264 if (!py_obj || !py_key || !outstr)
267 gstate = PyGILState_Ensure();
269 if (!PyDict_Check(py_obj)) {
270 srd_dbg("Object is not a dictionary.");
274 if (!(py_value = PyDict_GetItem(py_obj, py_key))) {
275 srd_dbg("Dictionary has no such key.");
279 if (!PyUnicode_Check(py_value)) {
280 srd_dbg("Dictionary value should be a string.");
284 return py_str_as_str(py_value, outstr);
287 PyGILState_Release(gstate);
289 return SRD_ERR_PYTHON;
293 * Get the value of a Python dictionary item, returned as a newly
296 * @param py_obj The dictionary to probe.
297 * @param py_key Key of the item to retrieve.
300 * @return SRD_OK upon success, a (negative) error code otherwise.
304 SRD_PRIV int py_pydictitem_as_long(PyObject *py_obj, PyObject *py_key, uint64_t *out)
307 PyGILState_STATE gstate;
309 if (!py_obj || !py_key || !out)
312 gstate = PyGILState_Ensure();
314 if (!PyDict_Check(py_obj)) {
315 srd_dbg("Object is not a dictionary.");
319 if (!(py_value = PyDict_GetItem(py_obj, py_key))) {
320 srd_dbg("Dictionary has no such key.");
324 if (!PyLong_Check(py_value)) {
325 srd_dbg("Dictionary value should be a long.");
329 *out = PyLong_AsUnsignedLongLong(py_value);
331 PyGILState_Release(gstate);
336 PyGILState_Release(gstate);
338 return SRD_ERR_PYTHON;
342 * Get the value of a Python unicode string object, returned as a newly
345 * @param[in] py_str The unicode string object.
346 * @param[out] outstr ptr to char * storage to be filled in.
348 * @return SRD_OK upon success, a (negative) error code otherwise.
349 * The 'outstr' argument points to a g_malloc()ed string upon success.
353 SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr)
357 PyGILState_STATE gstate;
359 gstate = PyGILState_Ensure();
361 if (!PyUnicode_Check(py_str)) {
362 srd_dbg("Object is not a string object.");
363 PyGILState_Release(gstate);
364 return SRD_ERR_PYTHON;
367 py_bytes = PyUnicode_AsUTF8String(py_str);
369 str = g_strdup(PyBytes_AsString(py_bytes));
373 PyGILState_Release(gstate);
377 srd_exception_catch("Failed to extract string");
379 PyGILState_Release(gstate);
381 return SRD_ERR_PYTHON;
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.
390 * @param[in] py_strseq The sequence object.
391 * @param[out] out_strv Address of string vector to be filled in.
393 * @return SRD_OK upon success, a (negative) error code otherwise.
397 SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv)
399 PyObject *py_item, *py_bytes;
402 PyGILState_STATE gstate;
403 int ret = SRD_ERR_PYTHON;
405 gstate = PyGILState_Ensure();
407 if (!PySequence_Check(py_strseq)) {
408 srd_err("Object does not provide sequence protocol.");
412 seq_len = PySequence_Size(py_strseq);
414 srd_exception_catch("Failed to obtain sequence size");
418 strv = g_try_new0(char *, seq_len + 1);
420 srd_err("Failed to allocate result string vector.");
421 ret = SRD_ERR_MALLOC;
425 for (i = 0; i < seq_len; i++) {
426 py_item = PySequence_GetItem(py_strseq, i);
430 if (!PyUnicode_Check(py_item)) {
434 py_bytes = PyUnicode_AsUTF8String(py_item);
439 str = g_strdup(PyBytes_AsString(py_bytes));
452 srd_exception_catch("Failed to obtain string item");
455 PyGILState_Release(gstate);
461 * Convert a Python scalar object to a GLib variant.
462 * Supported variant types are string, int64 and double.
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.
469 SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj)
471 GVariant *var = NULL;
472 PyGILState_STATE gstate;
474 gstate = PyGILState_Ensure();
476 if (PyUnicode_Check(py_obj)) { /* string */
480 py_bytes = PyUnicode_AsUTF8String(py_obj);
482 str = PyBytes_AsString(py_bytes);
484 var = g_variant_new_string(str);
488 srd_exception_catch("Failed to extract string value");
490 } else if (PyLong_Check(py_obj)) { /* integer */
493 val = PyLong_AsLongLong(py_obj);
494 if (!PyErr_Occurred())
495 var = g_variant_new_int64(val);
497 srd_exception_catch("Failed to extract integer value");
499 } else if (PyFloat_Check(py_obj)) { /* float */
502 val = PyFloat_AsDouble(py_obj);
503 if (!PyErr_Occurred())
504 var = g_variant_new_double(val);
506 srd_exception_catch("Failed to extract float value");
509 srd_err("Failed to extract value of unsupported type.");
512 PyGILState_Release(gstate);