refactored PD framework, now using new sigrok.Decoder object
[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 "config.h"
22 #include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
23
24
25 /**
26  * Helper function to handle Python strings.
27  *
28  * TODO: @param entries.
29  *
30  * @return SRD_OK upon success, a (negative) error code otherwise.
31  *         The 'outstr' argument points to a malloc()ed string upon success.
32  */
33 int h_str(PyObject *py_res, PyObject *py_mod, const char *key, char **outstr)
34 {
35         PyObject *py_str;
36         char *str;
37         int ret;
38
39         py_str = PyObject_GetAttrString(py_res, (char *)key); /* NEWREF */
40         if (!py_str || !PyString_Check(py_str)) {
41                 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
42                 goto err_h_decref_mod;
43         }
44
45         /*
46          * PyString_AsString()'s returned string refers to an internal buffer
47          * (not a copy), i.e. the data must not be modified, and the memory
48          * must not be free()'d.
49          */
50         if (!(str = PyString_AsString(py_str))) {
51                 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
52                 goto err_h_decref_str;
53         }
54
55         if (!(*outstr = g_strdup(str))) {
56                 ret = SRD_ERR_MALLOC;
57                 goto err_h_decref_str;
58         }
59
60         Py_XDECREF(py_str);
61
62         return SRD_OK;
63
64 err_h_decref_str:
65         Py_XDECREF(py_str);
66 err_h_decref_mod:
67         Py_XDECREF(py_mod);
68
69         if (PyErr_Occurred())
70                 PyErr_Print(); /* Returns void. */
71
72         return ret;
73 }
74