]> sigrok.org Git - libsigrokdecode.git/blobdiff - util.c
srd: minor code cleanup
[libsigrokdecode.git] / util.c
diff --git a/util.c b/util.c
index 0885626d86ce4640ee5e61524f68780437cf8be7..060c25387df580d3df6f32597132eacbbaaf5f77 100644 (file)
--- a/util.c
+++ b/util.c
@@ -2,7 +2,7 @@
  * This file is part of the sigrok project.
  *
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
- * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * 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 <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
 
 
 /**
- * Helper function to get the value of a python object's attribute,
- * returned as a newly allocated char *.
+ * Get the value of a python object's attribute, returned as a newly
+ * allocated char *.
  *
  * @param py_obj The object to probe.
- * @param key Name of the attribute to retrieve.
+ * @param attr Name of the attribute to retrieve.
  * @param outstr ptr 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.
  */
-int h_str(PyObject *py_obj, const char *key, char **outstr)
+int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr)
 {
-       PyObject *py_str, *py_encstr;
-       char *str;
+       PyObject *py_str;
+       int ret;
+
+       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;
+       }
+
+       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;
+       }
+
+       ret = py_str_as_str(py_str, outstr);
+       Py_DecRef(py_str);
+
+       return ret;
+}
+
+
+/**
+ * Get the value of a python dictionary item, returned as a newly
+ * 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.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ *         The 'outstr' argument points to a malloc()ed string upon success.
+ */
+int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr)
+{
+       PyObject *py_value;
+       int ret;
+
+       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;
+       }
+
+       if (!(py_value = PyDict_GetItemString(py_obj, key))) {
+               srd_dbg("srd: Dictionary has no attribute '%s'.", key);
+               return SRD_ERR_PYTHON;
+       }
+
+       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;
+       }
+
+       ret = py_str_as_str(py_value, outstr);
+
+       return SRD_OK;
+}
+
+
+/**
+ * Get the value of a python unicode string object, returned as a newly
+ * allocated char *.
+ *
+ * @param py_str The unicode string object.
+ * @param outstr ptr 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.
+ */
+int py_str_as_str(PyObject *py_str, char **outstr)
+{
+       PyObject *py_encstr;
        int ret;
+       char *str;
 
-       py_str = py_encstr = NULL;
+       py_encstr = NULL;
        str = NULL;
        ret = SRD_OK;
 
-       if (!(py_str = PyObject_GetAttrString(py_obj, (char *)key))) {
-               /* TODO: log level 4 debug message */
+       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;
        }
 
        if (!(py_encstr = PyUnicode_AsEncodedString(py_str, "utf-8", NULL))) {
-               /* TODO: log level 4 debug message */
                ret = SRD_ERR_PYTHON;
                goto err_out;
        }
        if (!(str = PyBytes_AS_STRING(py_encstr))) {
-               /* TODO: log level 4 debug message */
                ret = SRD_ERR_PYTHON;
                goto err_out;
        }
 
        if (!(*outstr = g_strdup(str))) {
-               /* TODO: log level 4 debug message */
+               srd_dbg("srd: malloc failed");
                ret = SRD_ERR_MALLOC;
                goto err_out;
        }
 
 err_out:
-       if (py_str)
-               Py_XDECREF(py_str);
        if (py_encstr)
                Py_XDECREF(py_encstr);
 
-       if (PyErr_Occurred())
-               PyErr_Print();
+       if (PyErr_Occurred()) {
+               srd_dbg("srd: string conversion failed");
+               /* TODO: dump exception to srd_dbg */
+               PyErr_Clear();
+       }
 
        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.
+ *
+ * @param py_strlist The list object.
+ * @param outstr ptr 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 char ** upon success.
+ */
+int py_strlist_to_char(PyObject *py_strlist, char ***outstr)
+{
+       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;
+
+       return SRD_OK;
+}
+