atsha204a: Add missing full stop in description.
[libsigrokdecode.git] / util.c
diff --git a/util.c b/util.c
index 060c25387df580d3df6f32597132eacbbaaf5f77..442d0a6e1433c47abd035cc0f42839b8df9b4e73 100644 (file)
--- a/util.c
+++ b/util.c
@@ -1,5 +1,5 @@
 /*
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrokdecode project.
  *
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  *
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
-#include "config.h"
+#include <config.h>
+#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
 
 
+/**
+ * Import a Python module by name.
+ *
+ * This function is implemented in terms of PyImport_Import() rather than
+ * PyImport_ImportModule(), so that the import hooks are not bypassed.
+ *
+ * @param[in] name The name of the module to load as UTF-8 string.
+ * @return The Python module object, or NULL if an exception occurred. The
+ *  caller is responsible for evaluating and clearing the Python error state.
+ *
+ * @private
+ */
+SRD_PRIV PyObject *py_import_by_name(const char *name)
+{
+       PyObject *py_mod, *py_modname;
+       PyGILState_STATE gstate;
+
+       gstate = PyGILState_Ensure();
+
+       py_modname = PyUnicode_FromString(name);
+       if (!py_modname) {
+               PyGILState_Release(gstate);
+               return NULL;
+       }
+
+       py_mod = PyImport_Import(py_modname);
+       Py_DECREF(py_modname);
+
+       PyGILState_Release(gstate);
+
+       return py_mod;
+}
 
 /**
 
 /**
- * Get the value of a python object's attribute, returned as a newly
+ * Get the value of a Python object's attribute, returned as a newly
  * allocated char *.
  *
  * allocated char *.
  *
- * @param py_obj The object to probe.
- * @param attr Name of the attribute to retrieve.
- * @param outstr ptr to char * storage to be filled in.
+ * @param[in] py_obj The object to probe.
+ * @param[in] attr Name of the attribute to retrieve.
+ * @param[out] outstr ptr to char * storage to be filled in.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
- *         The 'outstr' argument points to a malloc()ed string upon success.
+ *         The 'outstr' argument points to a g_malloc()ed string upon success.
+ *
+ * @private
  */
  */
-int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr)
+SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr)
 {
        PyObject *py_str;
        int ret;
 {
        PyObject *py_str;
        int ret;
+       PyGILState_STATE gstate;
+
+       gstate = PyGILState_Ensure();
 
        if (!PyObject_HasAttrString(py_obj, attr)) {
 
        if (!PyObject_HasAttrString(py_obj, attr)) {
-               srd_dbg("srd: %s object has no attribute '%s'.",
-                               Py_TYPE(py_obj)->tp_name, attr);
-               return SRD_ERR_PYTHON;
+               srd_dbg("Object has no attribute '%s'.", attr);
+               goto err;
        }
 
        if (!(py_str = PyObject_GetAttrString(py_obj, attr))) {
        }
 
        if (!(py_str = PyObject_GetAttrString(py_obj, attr))) {
-               /* TODO: report exception message/traceback to err/dbg */
-               PyErr_Clear();
-               return SRD_ERR_PYTHON;
-       }
-
-       if (!PyUnicode_Check(py_str)) {
-               srd_dbg("srd: %s attribute should be a string, but is a %s.",
-                               attr, Py_TYPE(py_str)->tp_name);
-               Py_DecRef(py_str);
-               return SRD_ERR_PYTHON;
+               srd_exception_catch("Failed to get attribute '%s'", attr);
+               goto err;
        }
 
        ret = py_str_as_str(py_str, outstr);
        }
 
        ret = py_str_as_str(py_str, outstr);
-       Py_DecRef(py_str);
+       Py_DECREF(py_str);
+
+       PyGILState_Release(gstate);
 
        return ret;
 
        return ret;
+
+err:
+       PyGILState_Release(gstate);
+
+       return SRD_ERR_PYTHON;
 }
 
 }
 
+/**
+ * Get the value of a Python object's attribute, returned as a newly
+ * allocated GSList of char *.
+ *
+ * @param[in] py_obj The object to probe.
+ * @param[in] attr Name of the attribute to retrieve.
+ * @param[out] outstrlist ptr to GSList of char * storage to be filled in.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ *         The 'outstrlist' argument points to a GSList of g_malloc()ed strings
+ *         upon success.
+ *
+ * @private
+ */
+SRD_PRIV int py_attr_as_strlist(PyObject *py_obj, const char *attr, GSList **outstrlist)
+{
+       PyObject *py_list;
+       Py_ssize_t i;
+       int ret;
+       char *outstr;
+       PyGILState_STATE gstate;
+
+       gstate = PyGILState_Ensure();
+
+       if (!PyObject_HasAttrString(py_obj, attr)) {
+               srd_dbg("Object has no attribute '%s'.", attr);
+               goto err;
+       }
+
+       if (!(py_list = PyObject_GetAttrString(py_obj, attr))) {
+               srd_exception_catch("Failed to get attribute '%s'", attr);
+               goto err;
+       }
+
+       if (!PyList_Check(py_list)) {
+               srd_dbg("Object is not a list.");
+               goto err;
+       }
+
+       *outstrlist = NULL;
+
+       for (i = 0; i < PyList_Size(py_list); i++) {
+               ret = py_listitem_as_str(py_list, i, &outstr);
+               if (ret < 0) {
+                       srd_dbg("Couldn't get item %" PY_FORMAT_SIZE_T "d.", i);
+                       goto err;
+               }
+               *outstrlist = g_slist_append(*outstrlist, outstr);
+       }
+
+       Py_DECREF(py_list);
+
+       PyGILState_Release(gstate);
+
+       return SRD_OK;
+
+err:
+       PyGILState_Release(gstate);
+
+       return SRD_ERR_PYTHON;
+}
+
+/**
+ * Get the value of a Python dictionary item, returned as a newly
+ * allocated char *.
+ *
+ * @param[in] py_obj The dictionary to probe.
+ * @param[in] key Key of the item to retrieve.
+ * @param[out] outstr Pointer to char * storage to be filled in.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ *         The 'outstr' argument points to a g_malloc()ed string upon success.
+ *
+ * @private
+ */
+SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key,
+                               char **outstr)
+{
+       PyObject *py_value;
+       PyGILState_STATE gstate;
+
+       gstate = PyGILState_Ensure();
+
+       if (!PyDict_Check(py_obj)) {
+               srd_dbg("Object is not a dictionary.");
+               goto err;
+       }
+
+       if (!(py_value = PyDict_GetItemString(py_obj, key))) {
+               srd_dbg("Dictionary has no attribute '%s'.", key);
+               goto err;
+       }
+
+       PyGILState_Release(gstate);
+
+       return py_str_as_str(py_value, outstr);
+
+err:
+       PyGILState_Release(gstate);
+
+       return SRD_ERR_PYTHON;
+}
+
+/**
+ * Get the value of a Python list item, returned as a newly
+ * allocated char *.
+ *
+ * @param[in] py_obj The list to probe.
+ * @param[in] idx Index of the list item to retrieve.
+ * @param[out] outstr Pointer to char * storage to be filled in.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ *         The 'outstr' argument points to a g_malloc()ed string upon success.
+ *
+ * @private
+ */
+SRD_PRIV int py_listitem_as_str(PyObject *py_obj, Py_ssize_t idx,
+                               char **outstr)
+{
+       PyObject *py_value;
+       PyGILState_STATE gstate;
+
+       gstate = PyGILState_Ensure();
+
+       if (!PyList_Check(py_obj)) {
+               srd_dbg("Object is not a list.");
+               goto err;
+       }
+
+       if (!(py_value = PyList_GetItem(py_obj, idx))) {
+               srd_dbg("Couldn't get list item %" PY_FORMAT_SIZE_T "d.", idx);
+               goto err;
+       }
+
+       PyGILState_Release(gstate);
+
+       return py_str_as_str(py_value, outstr);
+
+err:
+       PyGILState_Release(gstate);
+
+       return SRD_ERR_PYTHON;
+}
 
 /**
 
 /**
- * Get the value of a python dictionary item, returned as a newly
+ * Get the value of a Python dictionary item, returned as a newly
  * allocated char *.
  *
  * @param py_obj The dictionary to probe.
  * allocated char *.
  *
  * @param py_obj The dictionary to probe.
- * @param attr Key of the item to retrieve.
- * @param outstr ptr to char * storage to be filled in.
+ * @param py_key Key of the item to retrieve.
+ * @param outstr Pointer to char * storage to be filled in.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *         The 'outstr' argument points to a malloc()ed string upon success.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *         The 'outstr' argument points to a malloc()ed string upon success.
+ *
+ * @private
  */
  */
-int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr)
+SRD_PRIV int py_pydictitem_as_str(PyObject *py_obj, PyObject *py_key,
+                               char **outstr)
 {
        PyObject *py_value;
 {
        PyObject *py_value;
-       int ret;
+       PyGILState_STATE gstate;
+
+       if (!py_obj || !py_key || !outstr)
+               return SRD_ERR_ARG;
+
+       gstate = PyGILState_Ensure();
 
        if (!PyDict_Check(py_obj)) {
 
        if (!PyDict_Check(py_obj)) {
-               srd_dbg("srd: Object is a %s, not a dictionary.", Py_TYPE(py_obj)->tp_name);
-               return SRD_ERR_PYTHON;
+               srd_dbg("Object is not a dictionary.");
+               goto err;
        }
 
        }
 
-       if (!(py_value = PyDict_GetItemString(py_obj, key))) {
-               srd_dbg("srd: Dictionary has no attribute '%s'.", key);
-               return SRD_ERR_PYTHON;
+       if (!(py_value = PyDict_GetItem(py_obj, py_key))) {
+               srd_dbg("Dictionary has no such key.");
+               goto err;
        }
 
        if (!PyUnicode_Check(py_value)) {
        }
 
        if (!PyUnicode_Check(py_value)) {
-               srd_dbg("srd: Dictionary value for %s should be a string, but is a %s.",
-                               key, Py_TYPE(py_value)->tp_name);
-               return SRD_ERR_PYTHON;
+               srd_dbg("Dictionary value should be a string.");
+               goto err;
        }
 
        }
 
-       ret = py_str_as_str(py_value, outstr);
+       PyGILState_Release(gstate);
 
 
-       return SRD_OK;
+       return py_str_as_str(py_value, outstr);
+
+err:
+       PyGILState_Release(gstate);
+
+       return SRD_ERR_PYTHON;
 }
 
 }
 
+/**
+ * Get the value of a Python dictionary item, returned as a newly
+ * allocated char *.
+ *
+ * @param py_obj The dictionary to probe.
+ * @param py_key Key of the item to retrieve.
+ * @param out TODO.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @private
+ */
+SRD_PRIV int py_pydictitem_as_long(PyObject *py_obj, PyObject *py_key, uint64_t *out)
+{
+       PyObject *py_value;
+       PyGILState_STATE gstate;
+
+       if (!py_obj || !py_key || !out)
+               return SRD_ERR_ARG;
+
+       gstate = PyGILState_Ensure();
+
+       if (!PyDict_Check(py_obj)) {
+               srd_dbg("Object is not a dictionary.");
+               goto err;
+       }
+
+       if (!(py_value = PyDict_GetItem(py_obj, py_key))) {
+               srd_dbg("Dictionary has no such key.");
+               goto err;
+       }
+
+       if (!PyLong_Check(py_value)) {
+               srd_dbg("Dictionary value should be a long.");
+               goto err;
+       }
+
+       *out = PyLong_AsUnsignedLongLong(py_value);
+
+       PyGILState_Release(gstate);
+
+       return SRD_OK;
+
+err:
+       PyGILState_Release(gstate);
+
+       return SRD_ERR_PYTHON;
+}
 
 /**
 
 /**
- * Get the value of a python unicode string object, returned as a newly
+ * Get the value of a Python unicode string object, returned as a newly
  * allocated char *.
  *
  * allocated char *.
  *
- * @param py_str The unicode string object.
- * @param outstr ptr to char * storage to be filled in.
+ * @param[in] py_str The unicode string object.
+ * @param[out] outstr ptr to char * storage to be filled in.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
- *         The 'outstr' argument points to a malloc()ed string upon success.
+ *         The 'outstr' argument points to a g_malloc()ed string upon success.
+ *
+ * @private
  */
  */
-int py_str_as_str(PyObject *py_str, char **outstr)
+SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr)
 {
 {
-       PyObject *py_encstr;
-       int ret;
+       PyObject *py_bytes;
        char *str;
        char *str;
+       PyGILState_STATE gstate;
 
 
-       py_encstr = NULL;
-       str = NULL;
-       ret = SRD_OK;
+       gstate = PyGILState_Ensure();
 
        if (!PyUnicode_Check(py_str)) {
 
        if (!PyUnicode_Check(py_str)) {
-               srd_dbg("srd: object is a %s, not a string object", Py_TYPE(py_str)->tp_name);
-               ret = SRD_ERR_PYTHON;
-               goto err_out;
+               srd_dbg("Object is not a string object.");
+               PyGILState_Release(gstate);
+               return SRD_ERR_PYTHON;
        }
 
        }
 
-       if (!(py_encstr = PyUnicode_AsEncodedString(py_str, "utf-8", NULL))) {
-               ret = SRD_ERR_PYTHON;
-               goto err_out;
+       py_bytes = PyUnicode_AsUTF8String(py_str);
+       if (py_bytes) {
+               str = g_strdup(PyBytes_AsString(py_bytes));
+               Py_DECREF(py_bytes);
+               if (str) {
+                       *outstr = str;
+                       PyGILState_Release(gstate);
+                       return SRD_OK;
+               }
        }
        }
-       if (!(str = PyBytes_AS_STRING(py_encstr))) {
-               ret = SRD_ERR_PYTHON;
-               goto err_out;
+       srd_exception_catch("Failed to extract string");
+
+       PyGILState_Release(gstate);
+
+       return SRD_ERR_PYTHON;
+}
+
+/**
+ * Convert a Python list of unicode strings to a C string vector.
+ * On success, a pointer to a newly allocated NULL-terminated array of
+ * allocated C strings is written to @a out_strv. The caller must g_free()
+ * each string and the array itself.
+ *
+ * @param[in] py_strseq The sequence object.
+ * @param[out] out_strv Address of string vector to be filled in.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @private
+ */
+SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv)
+{
+       PyObject *py_item, *py_bytes;
+       char **strv, *str;
+       ssize_t seq_len, i;
+       PyGILState_STATE gstate;
+       int ret = SRD_ERR_PYTHON;
+
+       gstate = PyGILState_Ensure();
+
+       if (!PySequence_Check(py_strseq)) {
+               srd_err("Object does not provide sequence protocol.");
+               goto err;
+       }
+
+       seq_len = PySequence_Size(py_strseq);
+       if (seq_len < 0) {
+               srd_exception_catch("Failed to obtain sequence size");
+               goto err;
        }
 
        }
 
-       if (!(*outstr = g_strdup(str))) {
-               srd_dbg("srd: malloc failed");
+       strv = g_try_new0(char *, seq_len + 1);
+       if (!strv) {
+               srd_err("Failed to allocate result string vector.");
                ret = SRD_ERR_MALLOC;
                ret = SRD_ERR_MALLOC;
-               goto err_out;
+               goto err;
        }
 
        }
 
-err_out:
-       if (py_encstr)
-               Py_XDECREF(py_encstr);
+       for (i = 0; i < seq_len; i++) {
+               py_item = PySequence_GetItem(py_strseq, i);
+               if (!py_item)
+                       goto err_out;
+
+               if (!PyUnicode_Check(py_item)) {
+                       Py_DECREF(py_item);
+                       goto err_out;
+               }
+               py_bytes = PyUnicode_AsUTF8String(py_item);
+               Py_DECREF(py_item);
+               if (!py_bytes)
+                       goto err_out;
+
+               str = g_strdup(PyBytes_AsString(py_bytes));
+               Py_DECREF(py_bytes);
+               if (!str)
+                       goto err_out;
 
 
-       if (PyErr_Occurred()) {
-               srd_dbg("srd: string conversion failed");
-               /* TODO: dump exception to srd_dbg */
-               PyErr_Clear();
+               strv[i] = str;
        }
        }
+       *out_strv = strv;
+
+       PyGILState_Release(gstate);
+
+       return SRD_OK;
+
+err_out:
+       g_strfreev(strv);
+       srd_exception_catch("Failed to obtain string item");
+
+err:
+       PyGILState_Release(gstate);
 
        return ret;
 }
 
 
        return ret;
 }
 
-
 /**
 /**
- * Convert a python list of unicode strings to a NULL-terminated UTF8-encoded
- * char * array. The caller must free each string when finished.
+ * Convert a Python scalar object to a GLib variant.
+ * Supported variant types are string, int64 and double.
  *
  *
- * @param py_strlist The list object.
- * @param outstr ptr to char ** storage to be filled in.
+ * @param[in] py_obj The Python object. Must not be NULL.
+ * @return A floating reference to a new variant, or NULL on failure.
  *
  *
- * @return SRD_OK upon success, a (negative) error code otherwise.
- *         The 'outstr' argument points to a malloc()ed char ** upon success.
+ * @private
  */
  */
-int py_strlist_to_char(PyObject *py_strlist, char ***outstr)
+SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj)
 {
 {
-       PyObject *py_str;
-       int list_len, i;
-       char **out, *str;
-
-       list_len = PyList_Size(py_strlist);
-       if (!(out = g_try_malloc(sizeof(char *) * (list_len + 1))))
-               return SRD_ERR_MALLOC;
-       for (i = 0; i < list_len; i++) {
-               if (!(py_str = PyUnicode_AsEncodedString(
-                               PyList_GetItem(py_strlist, i), "utf-8", NULL)))
-                       return SRD_ERR_PYTHON;
-               if (!(str = PyBytes_AS_STRING(py_str)))
-                       return SRD_ERR_PYTHON;
-               out[i] = g_strdup(str);
-       }
-       out[i] = NULL;
-       *outstr = out;
+       GVariant *var = NULL;
+       PyGILState_STATE gstate;
 
 
-       return SRD_OK;
-}
+       gstate = PyGILState_Ensure();
+
+       if (PyUnicode_Check(py_obj)) { /* string */
+               PyObject *py_bytes;
+               const char *str;
+
+               py_bytes = PyUnicode_AsUTF8String(py_obj);
+               if (py_bytes) {
+                       str = PyBytes_AsString(py_bytes);
+                       if (str)
+                               var = g_variant_new_string(str);
+                       Py_DECREF(py_bytes);
+               }
+               if (!var)
+                       srd_exception_catch("Failed to extract string value");
+       } else if (PyLong_Check(py_obj)) { /* integer */
+               int64_t val;
 
 
+               val = PyLong_AsLongLong(py_obj);
+               if (!PyErr_Occurred())
+                       var = g_variant_new_int64(val);
+               else
+                       srd_exception_catch("Failed to extract integer value");
+       } else if (PyFloat_Check(py_obj)) { /* float */
+               double val;
+
+               val = PyFloat_AsDouble(py_obj);
+               if (!PyErr_Occurred())
+                       var = g_variant_new_double(val);
+               else
+                       srd_exception_catch("Failed to extract float value");
+       } else {
+               srd_err("Failed to extract value of unsupported type.");
+       }
+
+       PyGILState_Release(gstate);
+
+       return var;
+}