util.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  */
  20
  21 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  22 #include "sigrokdecode-internal.h"
  23 #include "config.h"
  24
  25
  26 /**
  27  * Get the value of a python object's attribute, returned as a newly
  28  * allocated char *.
  29  *
  30  * @param py_obj The object to probe.
  31  * @param attr Name of the attribute to retrieve.
  32  * @param outstr ptr to char * storage to be filled in.
  33  *
  34  * @return SRD_OK upon success, a (negative) error code otherwise.
  35  *         The 'outstr' argument points to a malloc()ed string upon success.
  36  */
  37 int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr)
  38 {
  39         PyObject *py_str;
  40         int ret;
  41
  42         if (!PyObject_HasAttrString(py_obj, attr)) {
  43                 srd_dbg("object has no attribute '%s'", attr);
  44                 return SRD_ERR_PYTHON;
  45         }
  46
  47         if (!(py_str = PyObject_GetAttrString(py_obj, attr))) {
  48                 /* TODO: report exception message/traceback to err/dbg */
  49                 PyErr_Clear();
  50                 return SRD_ERR_PYTHON;
  51         }
  52
  53         ret = py_str_as_str(py_str, outstr);
  54         Py_XDECREF(py_str);
  55
  56         return ret;
  57 }
  58
  59
  60 /**
  61  * Get the value of a python unicode string object, returned as a newly
  62  * allocated char *.
  63  *
  64  * @param py_str The unicode string object.
  65  * @param outstr ptr to char * storage to be filled in.
  66  *
  67  * @return SRD_OK upon success, a (negative) error code otherwise.
  68  *         The 'outstr' argument points to a malloc()ed string upon success.
  69  */
  70 int py_str_as_str(PyObject *py_str, char **outstr)
  71 {
  72         PyObject *py_encstr;
  73         int ret;
  74         char *str;
  75
  76         py_encstr = NULL;
  77         str = NULL;
  78         ret = SRD_OK;
  79
  80         if (!PyUnicode_Check(py_str)) {
  81                 srd_dbg("not a string object");
  82                 ret = SRD_ERR_PYTHON;
  83                 goto err_out;
  84         }
  85
  86         if (!(py_encstr = PyUnicode_AsEncodedString(py_str, "utf-8", NULL))) {
  87                 ret = SRD_ERR_PYTHON;
  88                 goto err_out;
  89         }
  90         if (!(str = PyBytes_AS_STRING(py_encstr))) {
  91                 ret = SRD_ERR_PYTHON;
  92                 goto err_out;
  93         }
  94
  95         if (!(*outstr = g_strdup(str))) {
  96                 srd_dbg("malloc failed");
  97                 ret = SRD_ERR_MALLOC;
  98                 goto err_out;
  99         }
 100
 101 err_out:
 102         if (py_str)
 103                 Py_XDECREF(py_str);
 104         if (py_encstr)
 105                 Py_XDECREF(py_encstr);
 106
 107         if (PyErr_Occurred()) {
 108                 srd_dbg("string conversion failed");
 109                 /* TODO: dump exception to srd_dbg */
 110                 PyErr_Clear();
 111         }
 112
 113         return ret;
 114 }
 115
 116
 117 /**
 118  * Convert a python list of unicode strings to a NULL-terminated UTF8-encoded
 119  * char * array. The caller must free each string when finished.
 120  *
 121  * @param py_strlist The list object.
 122  * @param outstr ptr to char ** storage to be filled in.
 123  *
 124  * @return SRD_OK upon success, a (negative) error code otherwise.
 125  *         The 'outstr' argument points to a malloc()ed char ** upon success.
 126  */
 127 int py_strlist_to_char(PyObject *py_strlist, char ***outstr)
 128 {
 129         PyObject *py_str;
 130         int list_len, i;
 131         char **out, *str;
 132
 133         list_len = PyList_Size(py_strlist);
 134         if (!(out = g_try_malloc(sizeof(char *) * (list_len + 1))))
 135                 return SRD_ERR_MALLOC;
 136         for (i = 0; i < list_len; i++) {
 137                 if (!(py_str = PyUnicode_AsEncodedString(
 138                                 PyList_GetItem(py_strlist, i), "utf-8", NULL)))
 139                         return SRD_ERR_PYTHON;
 140                 if (!(str = PyBytes_AS_STRING(py_str)))
 141                         return SRD_ERR_PYTHON;
 142                 out[i] = g_strdup(str);
 143         }
 144         out[i] = NULL;
 145         *outstr = out;
 146
 147         return SRD_OK;
 148 }
 149