df433d719f6bb08ad26262883ec5acd7434ed366
[libsigrokdecode.git] / 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 "config.h"
23
24
25 /**
26  * Helper function to get the value of a python object's attribute,
27  * returned as a newly allocated char *.
28  *
29  * @param py_obj The object to probe.
30  * @param key Name of the attribute to retrieve.
31  * @param outstr ptr to char * storage to be filled in.
32  *
33  * @return SRD_OK upon success, a (negative) error code otherwise.
34  *         The 'outstr' argument points to a malloc()ed string upon success.
35  */
36 int h_str(PyObject *py_obj, const char *key, char **outstr)
37 {
38         PyObject *py_str, *py_encstr;
39         char *str;
40         int ret;
41
42         py_str = py_encstr = NULL;
43         str = NULL;
44         ret = SRD_OK;
45
46         if (!(py_str = PyObject_GetAttrString(py_obj, (char *)key))) {
47                 /* TODO: log level 4 debug message */
48                 ret = SRD_ERR_PYTHON;
49                 goto err_out;
50         }
51
52         if (!(py_encstr = PyUnicode_AsEncodedString(py_str, "utf-8", NULL))) {
53                 /* TODO: log level 4 debug message */
54                 ret = SRD_ERR_PYTHON;
55                 goto err_out;
56         }
57         if (!(str = PyBytes_AS_STRING(py_encstr))) {
58                 /* TODO: log level 4 debug message */
59                 ret = SRD_ERR_PYTHON;
60                 goto err_out;
61         }
62
63         if (!(*outstr = g_strdup(str))) {
64                 /* TODO: log level 4 debug message */
65                 ret = SRD_ERR_MALLOC;
66                 goto err_out;
67         }
68
69 err_out:
70         if (py_str)
71                 Py_XDECREF(py_str);
72         if (py_encstr)
73                 Py_XDECREF(py_encstr);
74
75         if (PyErr_Occurred())
76                 /* TODO: log level 4 debug message */
77                 PyErr_Print();
78
79         return ret;
80 }
81
82 /**
83  * Convert a python list of unicode strings to a NULL-terminated UTF8-encoded
84  * char * array. The caller must free each string when finished.
85  */
86 int py_strlist_to_char(PyObject *py_strlist, char ***outstr)
87 {
88         PyObject *py_str;
89         int list_len, i;
90         char **out, *str;
91
92         list_len = PyList_Size(py_strlist);
93         if (!(out = g_try_malloc(sizeof(char *) * (list_len + 1))))
94                 return SRD_ERR_MALLOC;
95         for (i = 0; i < list_len; i++) {
96                 if (!(py_str = PyUnicode_AsEncodedString(PyList_GetItem(py_strlist, i), "utf-8", NULL)))
97                         return SRD_ERR_PYTHON;
98                 if (!(str = PyBytes_AS_STRING(py_str)))
99                         return SRD_ERR_PYTHON;
100                 out[i] = g_strdup(str);
101         }
102         out[i] = NULL;
103         *outstr = out;
104
105         return SRD_OK;
106 }
107