X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=util.c;h=442d0a6e1433c47abd035cc0f42839b8df9b4e73;hp=fcadf47edcdfd5658b6ccdd5257e016524c74722;hb=3a67b032235e719dc4e74f735d1c95ef2d481a33;hpb=201a85a8ea071d37f4fda2668c0a1c488d852f4e

diff --git a/util.c b/util.c
index fcadf47..442d0a6 100644
--- a/util.c
+++ b/util.c
@@ -21,6 +21,39 @@
 #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
  * allocated char *.
@@ -38,21 +71,93 @@ SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr)
 {
 	PyObject *py_str;
 	int ret;
+	PyGILState_STATE gstate;
+
+	gstate = PyGILState_Ensure();
 
 	if (!PyObject_HasAttrString(py_obj, attr)) {
 		srd_dbg("Object has no attribute '%s'.", attr);
-		return SRD_ERR_PYTHON;
+		goto err;
 	}
 
 	if (!(py_str = PyObject_GetAttrString(py_obj, attr))) {
 		srd_exception_catch("Failed to get attribute '%s'", attr);
-		return SRD_ERR_PYTHON;
+		goto err;
 	}
 
 	ret = py_str_as_str(py_str, outstr);
 	Py_DECREF(py_str);
 
+	PyGILState_Release(gstate);
+
 	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;
 }
 
 /**
@@ -72,18 +177,167 @@ 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.");
-		return SRD_ERR_PYTHON;
+		goto err;
 	}
 
 	if (!(py_value = PyDict_GetItemString(py_obj, key))) {
 		srd_dbg("Dictionary has no attribute '%s'.", key);
-		return SRD_ERR_PYTHON;
+		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
+ * allocated char *.
+ *
+ * @param py_obj The dictionary to probe.
+ * @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.
+ *
+ * @private
+ */
+SRD_PRIV int py_pydictitem_as_str(PyObject *py_obj, PyObject *py_key,
+				char **outstr)
+{
+	PyObject *py_value;
+	PyGILState_STATE gstate;
+
+	if (!py_obj || !py_key || !outstr)
+		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 (!PyUnicode_Check(py_value)) {
+		srd_dbg("Dictionary value should be a string.");
+		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
+ * 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;
 }
 
 /**
@@ -102,9 +356,13 @@ SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr)
 {
 	PyObject *py_bytes;
 	char *str;
+	PyGILState_STATE gstate;
+
+	gstate = PyGILState_Ensure();
 
 	if (!PyUnicode_Check(py_str)) {
 		srd_dbg("Object is not a string object.");
+		PyGILState_Release(gstate);
 		return SRD_ERR_PYTHON;
 	}
 
@@ -114,11 +372,14 @@ SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr)
 		Py_DECREF(py_bytes);
 		if (str) {
 			*outstr = str;
+			PyGILState_Release(gstate);
 			return SRD_OK;
 		}
 	}
 	srd_exception_catch("Failed to extract string");
 
+	PyGILState_Release(gstate);
+
 	return SRD_ERR_PYTHON;
 }
 
@@ -140,22 +401,27 @@ 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.");
-		return SRD_ERR_PYTHON;
+		goto err;
 	}
 
 	seq_len = PySequence_Size(py_strseq);
 	if (seq_len < 0) {
 		srd_exception_catch("Failed to obtain sequence size");
-		return SRD_ERR_PYTHON;
+		goto err;
 	}
 
 	strv = g_try_new0(char *, seq_len + 1);
 	if (!strv) {
 		srd_err("Failed to allocate result string vector.");
-		return SRD_ERR_MALLOC;
+		ret = SRD_ERR_MALLOC;
+		goto err;
 	}
 
 	for (i = 0; i < seq_len; i++) {
@@ -181,11 +447,70 @@ SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv)
 	}
 	*out_strv = strv;
 
+	PyGILState_Release(gstate);
+
 	return SRD_OK;
 
 err_out:
 	g_strfreev(strv);
 	srd_exception_catch("Failed to obtain string item");
 
-	return SRD_ERR_PYTHON;
+err:
+	PyGILState_Release(gstate);
+
+	return ret;
+}
+
+/**
+ * Convert a Python scalar object to a GLib variant.
+ * Supported variant types are string, int64 and double.
+ *
+ * @param[in] py_obj The Python object. Must not be NULL.
+ * @return A floating reference to a new variant, or NULL on failure.
+ *
+ * @private
+ */
+SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj)
+{
+	GVariant *var = NULL;
+	PyGILState_STATE gstate;
+
+	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;
 }