code cleanup
[libsigrokdecode.git] / module_sigrokdecode.c
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
21 #include "sigrokdecode-internal.h"
22 #include "config.h"
23
24 /* lives in type_logic.c */
25 extern PyTypeObject srd_logic_type;
26
27
28 static int convert_pyobj(struct srd_decoder_instance *di, PyObject *obj,
29                 int *annotation_format, char ***annotation)
30 {
31         PyObject *py_tmp;
32         struct srd_pd_output *pdo;
33         int ann_id;
34
35         /* Should be a list of [annotation format, [string, ...]] */
36         if (!PyList_Check(obj) && !PyTuple_Check(obj)) {
37                 srd_err("Protocol decoder %s submitted %s instead of list",
38                                 di->decoder->name, obj->ob_type->tp_name);
39                 return SRD_ERR_PYTHON;
40         }
41
42         /* Should have 2 elements... */
43         if (PyList_Size(obj) != 2) {
44                 srd_err("Protocol decoder %s submitted annotation list with %d elements instead of 2",
45                                 di->decoder->name, PyList_Size(obj));
46                 return SRD_ERR_PYTHON;
47         }
48
49         /* First element should be an integer matching a previously
50          * registered annotation format. */
51         py_tmp = PyList_GetItem(obj, 0);
52         if (!PyLong_Check(py_tmp)) {
53                 srd_err("Protocol decoder %s submitted annotation list, but first element was not an integer",
54                                 di->decoder->name);
55                 return SRD_ERR_PYTHON;
56         }
57
58         ann_id = PyLong_AsLong(py_tmp);
59         if (!(pdo = g_slist_nth_data(di->decoder->annotation, ann_id))) {
60                 srd_err("Protocol decoder %s submitted data to non-existent annotation format %d",
61                                 di->decoder->name, ann_id);
62                 return SRD_ERR_PYTHON;
63         }
64         *annotation_format = ann_id;
65
66         /* Second element must be a list */
67         py_tmp = PyList_GetItem(obj, 1);
68         if (!PyList_Check(py_tmp)) {
69                 srd_err("Protocol decoder %s submitted annotation list, but second element was not a list",
70                                 di->decoder->name);
71                 return SRD_ERR_PYTHON;
72         }
73         if (py_strlist_to_char(py_tmp, annotation) != SRD_OK) {
74                 srd_err("Protocol decoder %s submitted annotation list, but second element was malformed",
75                                 di->decoder->name);
76                 return SRD_ERR_PYTHON;
77         }
78
79         return SRD_OK;
80 }
81
82 static PyObject *Decoder_put(PyObject *self, PyObject *args)
83 {
84         GSList *l;
85         PyObject *data;
86         struct srd_decoder_instance *di;
87         struct srd_pd_output *pdo;
88         struct srd_protocol_data *pdata;
89         uint64_t start_sample, end_sample;
90         int output_id;
91         void (*cb)();
92
93         if (!(di = get_di_by_decobject(self)))
94                 return NULL;
95
96         if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample, &output_id, &data))
97                 return NULL;
98
99         if (!(l = g_slist_nth(di->pd_output, output_id))) {
100                 srd_err("Protocol decoder %s submitted invalid output ID %d",
101                                 di->decoder->name, output_id);
102                 return NULL;
103         }
104         pdo = l->data;
105
106         switch (pdo->output_type) {
107         case SRD_OUTPUT_ANNOTATION:
108         case SRD_OUTPUT_PROTOCOL:
109         case SRD_OUTPUT_BINARY:
110                 break;
111         default:
112                 srd_err("Protocol decoder %s submitted invalid output type %d",
113                                 di->decoder->name, pdo->output_type);
114                 return NULL;
115                 break;
116         }
117
118         if ((cb = srd_find_callback(pdo->output_type))) {
119                 /* Something registered an interest in this output type. */
120                 if (!(pdata = g_try_malloc0(sizeof(struct srd_protocol_data))))
121                         return NULL;
122                 pdata->start_sample = start_sample;
123                 pdata->end_sample = end_sample;
124                 pdata->pdo = pdo;
125                 if (pdo->output_type == SRD_OUTPUT_ANNOTATION) {
126                         /* annotations need converting from PyObject */
127                         if (convert_pyobj(di, data, &pdata->annotation_format,
128                                         (char ***)&pdata->data) != SRD_OK)
129                                 return NULL;
130                 } else {
131                         /* annotation_format is unused, data is an opaque blob. */
132                         pdata->data = data;
133                 }
134                 cb(pdata);
135         }
136
137         Py_RETURN_NONE;
138 }
139
140
141 static PyObject *Decoder_add(PyObject *self, PyObject *args)
142 {
143         PyObject *ret;
144         struct srd_decoder_instance *di;
145         char *protocol_id;
146         int output_type, pdo_id;
147
148         if (!(di = get_di_by_decobject(self)))
149                 return NULL;
150
151         if (!PyArg_ParseTuple(args, "is", &output_type, &protocol_id))
152                 return NULL;
153
154         pdo_id = pd_add(di, output_type, protocol_id);
155         if (pdo_id < 0)
156                 Py_RETURN_NONE;
157         else
158                 ret = Py_BuildValue("i", pdo_id);
159
160         return ret;
161 }
162
163 static PyMethodDef no_methods[] = { {NULL, NULL, 0, NULL} };
164 static PyMethodDef Decoder_methods[] = {
165         {"put", Decoder_put, METH_VARARGS,
166          "Accepts a dictionary with the following keys: time, duration, data"},
167         {"add", Decoder_add, METH_VARARGS, "Create a new output stream"},
168         {NULL, NULL, 0, NULL}
169 };
170
171
172 typedef struct {
173         PyObject_HEAD
174 } sigrok_Decoder_object;
175
176 static PyTypeObject srd_Decoder_type = {
177         PyVarObject_HEAD_INIT(NULL, 0)
178         .tp_name = "sigrokdecode.Decoder",
179         .tp_basicsize = sizeof(sigrok_Decoder_object),
180         .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
181         .tp_doc = "Sigrok Decoder object",
182         .tp_methods = Decoder_methods,
183 };
184
185 static struct PyModuleDef sigrokdecode_module = {
186         PyModuleDef_HEAD_INIT,
187         .m_name = "sigrokdecode",
188         .m_doc = "sigrokdecode base class",
189         .m_size = -1,
190         .m_methods = no_methods,
191 };
192
193 PyMODINIT_FUNC PyInit_sigrokdecode(void)
194 {
195         PyObject *mod;
196
197         /* tp_new needs to be assigned here for compiler portability */
198         srd_Decoder_type.tp_new = PyType_GenericNew;
199         if (PyType_Ready(&srd_Decoder_type) < 0)
200                 return NULL;
201
202         srd_logic_type.tp_new = PyType_GenericNew;
203         if (PyType_Ready(&srd_logic_type) < 0)
204                 return NULL;
205
206         mod = PyModule_Create(&sigrokdecode_module);
207         Py_INCREF(&srd_Decoder_type);
208         if (PyModule_AddObject(mod, "Decoder", (PyObject *)&srd_Decoder_type) == -1)
209                 return NULL;
210         Py_INCREF(&srd_logic_type);
211         if (PyModule_AddObject(mod, "srd_logic", (PyObject *)&srd_logic_type) == -1)
212                 return NULL;
213
214         /* expose output types as symbols in the sigrokdecode module */
215         if(PyModule_AddObject(mod, "SRD_OUTPUT_ANNOTATION",
216                         PyLong_FromLong(SRD_OUTPUT_ANNOTATION)) == -1)
217                 return NULL;
218         if(PyModule_AddObject(mod, "SRD_OUTPUT_PROTOCOL",
219                         PyLong_FromLong(SRD_OUTPUT_PROTOCOL)) == -1)
220                 return NULL;
221         if(PyModule_AddObject(mod, "SRD_OUTPUT_BINARY",
222                         PyLong_FromLong(SRD_OUTPUT_BINARY)) == -1)
223                 return NULL;
224
225         return mod;
226 }
227