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 dictionary item, returned as a newly
88 * @param[in] py_obj The dictionary to probe.
89 * @param[in] key Key of the item to retrieve.
90 * @param[out] outstr Pointer to char * storage to be filled in.
92 * @return SRD_OK upon success, a (negative) error code otherwise.
93 * The 'outstr' argument points to a g_malloc()ed string upon success.
97 SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key,
102 if (!PyDict_Check(py_obj)) {
103 srd_dbg("Object is not a dictionary.");
104 return SRD_ERR_PYTHON;
107 if (!(py_value = PyDict_GetItemString(py_obj, key))) {
108 srd_dbg("Dictionary has no attribute '%s'.", key);
109 return SRD_ERR_PYTHON;
112 return py_str_as_str(py_value, outstr);
116 * Get the value of a Python unicode string object, returned as a newly
119 * @param[in] py_str The unicode string object.
120 * @param[out] outstr ptr to char * storage to be filled in.
122 * @return SRD_OK upon success, a (negative) error code otherwise.
123 * The 'outstr' argument points to a g_malloc()ed string upon success.
127 SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr)
132 if (!PyUnicode_Check(py_str)) {
133 srd_dbg("Object is not a string object.");
134 return SRD_ERR_PYTHON;
137 py_bytes = PyUnicode_AsUTF8String(py_str);
139 str = g_strdup(PyBytes_AsString(py_bytes));
146 srd_exception_catch("Failed to extract string");
148 return SRD_ERR_PYTHON;
152 * Convert a Python list of unicode strings to a C string vector.
153 * On success, a pointer to a newly allocated NULL-terminated array of
154 * allocated C strings is written to @a out_strv. The caller must g_free()
155 * each string and the array itself.
157 * @param[in] py_strseq The sequence object.
158 * @param[out] out_strv Address of string vector to be filled in.
160 * @return SRD_OK upon success, a (negative) error code otherwise.
164 SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv)
166 PyObject *py_item, *py_bytes;
170 if (!PySequence_Check(py_strseq)) {
171 srd_err("Object does not provide sequence protocol.");
172 return SRD_ERR_PYTHON;
175 seq_len = PySequence_Size(py_strseq);
177 srd_exception_catch("Failed to obtain sequence size");
178 return SRD_ERR_PYTHON;
181 strv = g_try_new0(char *, seq_len + 1);
183 srd_err("Failed to allocate result string vector.");
184 return SRD_ERR_MALLOC;
187 for (i = 0; i < seq_len; i++) {
188 py_item = PySequence_GetItem(py_strseq, i);
192 if (!PyUnicode_Check(py_item)) {
196 py_bytes = PyUnicode_AsUTF8String(py_item);
201 str = g_strdup(PyBytes_AsString(py_bytes));
214 srd_exception_catch("Failed to obtain string item");
216 return SRD_ERR_PYTHON;
220 * Convert a Python scalar object to a GLib variant.
221 * Supported variant types are string, int64 and double.
223 * @param[in] py_obj The Python object. Must not be NULL.
224 * @return A floating reference to a new variant, or NULL on failure.
228 SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj)
230 GVariant *var = NULL;
232 if (PyUnicode_Check(py_obj)) { /* string */
236 py_bytes = PyUnicode_AsUTF8String(py_obj);
238 str = PyBytes_AsString(py_bytes);
240 var = g_variant_new_string(str);
244 srd_exception_catch("Failed to extract string value");
246 } else if (PyLong_Check(py_obj)) { /* integer */
249 val = PyLong_AsLongLong(py_obj);
250 if (!PyErr_Occurred())
251 var = g_variant_new_int64(val);
253 srd_exception_catch("Failed to extract integer value");
255 } else if (PyFloat_Check(py_obj)) { /* float */
258 val = PyFloat_AsDouble(py_obj);
259 if (!PyErr_Occurred())
260 var = g_variant_new_double(val);
262 srd_exception_catch("Failed to extract float value");
265 srd_err("Failed to extract value of unsupported type.");