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;
40 py_modname = PyUnicode_FromString(name);
44 py_mod = PyImport_Import(py_modname);
45 Py_DECREF(py_modname);
51 * Get the value of a Python object's attribute, returned as a newly
54 * @param[in] py_obj The object to probe.
55 * @param[in] attr Name of the attribute to retrieve.
56 * @param[out] outstr ptr to char * storage to be filled in.
58 * @return SRD_OK upon success, a (negative) error code otherwise.
59 * The 'outstr' argument points to a g_malloc()ed string upon success.
63 SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr)
68 if (!PyObject_HasAttrString(py_obj, attr)) {
69 srd_dbg("Object has no attribute '%s'.", attr);
70 return SRD_ERR_PYTHON;
73 if (!(py_str = PyObject_GetAttrString(py_obj, attr))) {
74 srd_exception_catch("Failed to get attribute '%s'", attr);
75 return SRD_ERR_PYTHON;
78 ret = py_str_as_str(py_str, outstr);
85 * Get the value of a Python object's attribute, returned as a newly
86 * allocated GSList of char *.
88 * @param[in] py_obj The object to probe.
89 * @param[in] attr Name of the attribute to retrieve.
90 * @param[out] outstrlist ptr to GSList of char * storage to be filled in.
92 * @return SRD_OK upon success, a (negative) error code otherwise.
93 * The 'outstrlist' argument points to a GSList of g_malloc()ed strings
98 SRD_PRIV int py_attr_as_strlist(PyObject *py_obj, const char *attr, GSList **outstrlist)
105 if (!PyObject_HasAttrString(py_obj, attr)) {
106 srd_dbg("Object has no attribute '%s'.", attr);
107 return SRD_ERR_PYTHON;
110 if (!(py_list = PyObject_GetAttrString(py_obj, attr))) {
111 srd_exception_catch("Failed to get attribute '%s'", attr);
112 return SRD_ERR_PYTHON;
115 if (!PyList_Check(py_list)) {
116 srd_dbg("Object is not a list.");
117 return SRD_ERR_PYTHON;
122 for (i = 0; i < PyList_Size(py_list); i++) {
123 ret = py_listitem_as_str(py_list, i, &outstr);
125 srd_dbg("Couldn't get item %" PY_FORMAT_SIZE_T "d.", i);
126 return SRD_ERR_PYTHON;
128 *outstrlist = g_slist_append(*outstrlist, outstr);
137 * Get the value of a Python dictionary item, returned as a newly
140 * @param[in] py_obj The dictionary to probe.
141 * @param[in] key Key of the item to retrieve.
142 * @param[out] outstr Pointer to char * storage to be filled in.
144 * @return SRD_OK upon success, a (negative) error code otherwise.
145 * The 'outstr' argument points to a g_malloc()ed string upon success.
149 SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key,
154 if (!PyDict_Check(py_obj)) {
155 srd_dbg("Object is not a dictionary.");
156 return SRD_ERR_PYTHON;
159 if (!(py_value = PyDict_GetItemString(py_obj, key))) {
160 srd_dbg("Dictionary has no attribute '%s'.", key);
161 return SRD_ERR_PYTHON;
164 return py_str_as_str(py_value, outstr);
168 * Get the value of a Python list item, returned as a newly
171 * @param[in] py_obj The list to probe.
172 * @param[in] idx Index of the list item to retrieve.
173 * @param[out] outstr Pointer to char * storage to be filled in.
175 * @return SRD_OK upon success, a (negative) error code otherwise.
176 * The 'outstr' argument points to a g_malloc()ed string upon success.
180 SRD_PRIV int py_listitem_as_str(PyObject *py_obj, Py_ssize_t idx,
185 if (!PyList_Check(py_obj)) {
186 srd_dbg("Object is not a list.");
187 return SRD_ERR_PYTHON;
190 if (!(py_value = PyList_GetItem(py_obj, idx))) {
191 srd_dbg("Couldn't get list item %" PY_FORMAT_SIZE_T "d.", idx);
192 return SRD_ERR_PYTHON;
195 return py_str_as_str(py_value, outstr);
199 * Get the value of a Python dictionary item, returned as a newly
202 * @param py_obj The dictionary to probe.
203 * @param py_key Key of the item to retrieve.
204 * @param outstr Pointer to char * storage to be filled in.
206 * @return SRD_OK upon success, a (negative) error code otherwise.
207 * The 'outstr' argument points to a malloc()ed string upon success.
211 SRD_PRIV int py_pydictitem_as_str(PyObject *py_obj, PyObject *py_key,
216 if (!py_obj || !py_key || !outstr)
219 if (!PyDict_Check(py_obj)) {
220 srd_dbg("Object is not a dictionary.");
221 return SRD_ERR_PYTHON;
224 if (!(py_value = PyDict_GetItem(py_obj, py_key))) {
225 srd_dbg("Dictionary has no such key.");
226 return SRD_ERR_PYTHON;
229 if (!PyUnicode_Check(py_value)) {
230 srd_dbg("Dictionary value should be a string.");
231 return SRD_ERR_PYTHON;
234 return py_str_as_str(py_value, outstr);
238 * Get the value of a Python dictionary item, returned as a newly
241 * @param py_obj The dictionary to probe.
242 * @param py_key Key of the item to retrieve.
245 * @return SRD_OK upon success, a (negative) error code otherwise.
249 SRD_PRIV int py_pydictitem_as_long(PyObject *py_obj, PyObject *py_key, uint64_t *out)
253 if (!py_obj || !py_key || !out)
256 if (!PyDict_Check(py_obj)) {
257 srd_dbg("Object is not a dictionary.");
258 return SRD_ERR_PYTHON;
261 if (!(py_value = PyDict_GetItem(py_obj, py_key))) {
262 srd_dbg("Dictionary has no such key.");
263 return SRD_ERR_PYTHON;
266 if (!PyLong_Check(py_value)) {
267 srd_dbg("Dictionary value should be a long.");
268 return SRD_ERR_PYTHON;
271 *out = PyLong_AsUnsignedLongLong(py_value);
277 * Get the value of a Python unicode string object, returned as a newly
280 * @param[in] py_str The unicode string object.
281 * @param[out] outstr ptr to char * storage to be filled in.
283 * @return SRD_OK upon success, a (negative) error code otherwise.
284 * The 'outstr' argument points to a g_malloc()ed string upon success.
288 SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr)
293 if (!PyUnicode_Check(py_str)) {
294 srd_dbg("Object is not a string object.");
295 return SRD_ERR_PYTHON;
298 py_bytes = PyUnicode_AsUTF8String(py_str);
300 str = g_strdup(PyBytes_AsString(py_bytes));
307 srd_exception_catch("Failed to extract string");
309 return SRD_ERR_PYTHON;
313 * Convert a Python list of unicode strings to a C string vector.
314 * On success, a pointer to a newly allocated NULL-terminated array of
315 * allocated C strings is written to @a out_strv. The caller must g_free()
316 * each string and the array itself.
318 * @param[in] py_strseq The sequence object.
319 * @param[out] out_strv Address of string vector to be filled in.
321 * @return SRD_OK upon success, a (negative) error code otherwise.
325 SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv)
327 PyObject *py_item, *py_bytes;
331 if (!PySequence_Check(py_strseq)) {
332 srd_err("Object does not provide sequence protocol.");
333 return SRD_ERR_PYTHON;
336 seq_len = PySequence_Size(py_strseq);
338 srd_exception_catch("Failed to obtain sequence size");
339 return SRD_ERR_PYTHON;
342 strv = g_try_new0(char *, seq_len + 1);
344 srd_err("Failed to allocate result string vector.");
345 return SRD_ERR_MALLOC;
348 for (i = 0; i < seq_len; i++) {
349 py_item = PySequence_GetItem(py_strseq, i);
353 if (!PyUnicode_Check(py_item)) {
357 py_bytes = PyUnicode_AsUTF8String(py_item);
362 str = g_strdup(PyBytes_AsString(py_bytes));
375 srd_exception_catch("Failed to obtain string item");
377 return SRD_ERR_PYTHON;
381 * Convert a Python scalar object to a GLib variant.
382 * Supported variant types are string, int64 and double.
384 * @param[in] py_obj The Python object. Must not be NULL.
385 * @return A floating reference to a new variant, or NULL on failure.
389 SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj)
391 GVariant *var = NULL;
393 if (PyUnicode_Check(py_obj)) { /* string */
397 py_bytes = PyUnicode_AsUTF8String(py_obj);
399 str = PyBytes_AsString(py_bytes);
401 var = g_variant_new_string(str);
405 srd_exception_catch("Failed to extract string value");
407 } else if (PyLong_Check(py_obj)) { /* integer */
410 val = PyLong_AsLongLong(py_obj);
411 if (!PyErr_Occurred())
412 var = g_variant_new_int64(val);
414 srd_exception_catch("Failed to extract integer value");
416 } else if (PyFloat_Check(py_obj)) { /* float */
419 val = PyFloat_AsDouble(py_obj);
420 if (!PyErr_Occurred())
421 var = g_variant_new_double(val);
423 srd_exception_catch("Failed to extract float value");
426 srd_err("Failed to extract value of unsupported type.");