X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=type_decoder.c;h=228cd444c42fc208279472a34c678ddc83739484;hb=711d0602317e28ddc123ab540036b37979df70c4;hp=52f7ca0640b31a3f53f7403ee39c4dd935415ab7;hpb=7ee0c40b4ac605c68a8ec2008ef4ab61a1872475;p=libsigrokdecode.git
diff --git a/type_decoder.c b/type_decoder.c
index 52f7ca0..228cd44 100644
--- a/type_decoder.c
+++ b/type_decoder.c
@@ -17,18 +17,28 @@
* along with this program. If not, see .
*/
-#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "libsigrokdecode-internal.h"
-#include "config.h"
+#include
+#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode.h"
#include
-/* This is only used for nicer srd_dbg() output. */
-static const char *OUTPUT_TYPES[] = {
- "OUTPUT_ANN",
- "OUTPUT_PYTHON",
- "OUTPUT_BINARY",
- "OUTPUT_META",
-};
+typedef struct {
+ PyObject_HEAD
+} srd_Decoder;
+
+/* This is only used for nicer srd_dbg() output.
+ */
+static const char *output_type_name(unsigned int idx)
+{
+ static const char names[][16] = {
+ "OUTPUT_ANN",
+ "OUTPUT_PYTHON",
+ "OUTPUT_BINARY",
+ "OUTPUT_META",
+ "(invalid)"
+ };
+ return names[MIN(idx, G_N_ELEMENTS(names) - 1)];
+}
static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
struct srd_proto_data *pdata)
@@ -36,27 +46,27 @@ static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
PyObject *py_tmp;
struct srd_pd_output *pdo;
struct srd_proto_data_annotation *pda;
- int ann_format;
+ int ann_class;
char **ann_text;
- /* Should be a list of [annotation format, [string, ...]]. */
- if (!PyList_Check(obj) && !PyTuple_Check(obj)) {
- srd_err("Protocol decoder %s submitted %s instead of list.",
- di->decoder->name, obj->ob_type->tp_name);
+ /* Should be a list of [annotation class, [string, ...]]. */
+ if (!PyList_Check(obj)) {
+ srd_err("Protocol decoder %s submitted an annotation that"
+ " is not a list", di->decoder->name);
return SRD_ERR_PYTHON;
}
/* Should have 2 elements. */
if (PyList_Size(obj) != 2) {
srd_err("Protocol decoder %s submitted annotation list with "
- "%d elements instead of 2", di->decoder->name,
+ "%zd elements instead of 2", di->decoder->name,
PyList_Size(obj));
return SRD_ERR_PYTHON;
}
/*
* The first element should be an integer matching a previously
- * registered annotation format.
+ * registered annotation class.
*/
py_tmp = PyList_GetItem(obj, 0);
if (!PyLong_Check(py_tmp)) {
@@ -64,10 +74,10 @@ static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
"first element was not an integer.", di->decoder->name);
return SRD_ERR_PYTHON;
}
- ann_format = PyLong_AsLong(py_tmp);
- if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_format))) {
+ ann_class = PyLong_AsLong(py_tmp);
+ if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_class))) {
srd_err("Protocol decoder %s submitted data to unregistered "
- "annotation format %d.", di->decoder->name, ann_format);
+ "annotation class %d.", di->decoder->name, ann_class);
return SRD_ERR_PYTHON;
}
@@ -78,21 +88,86 @@ static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
"second element was not a list.", di->decoder->name);
return SRD_ERR_PYTHON;
}
- if (py_strlist_to_char(py_tmp, &ann_text) != SRD_OK) {
+ if (py_strseq_to_char(py_tmp, &ann_text) != SRD_OK) {
srd_err("Protocol decoder %s submitted annotation list, but "
"second element was malformed.", di->decoder->name);
return SRD_ERR_PYTHON;
}
- if (!(pda = g_try_malloc(sizeof(struct srd_proto_data_annotation))))
- return SRD_ERR_MALLOC;
- pda->ann_format = ann_format;
+ pda = g_malloc(sizeof(struct srd_proto_data_annotation));
+ pda->ann_class = ann_class;
pda->ann_text = ann_text;
pdata->data = pda;
return SRD_OK;
}
+static int convert_binary(struct srd_decoder_inst *di, PyObject *obj,
+ struct srd_proto_data *pdata)
+{
+ struct srd_proto_data_binary *pdb;
+ PyObject *py_tmp;
+ Py_ssize_t size;
+ int bin_class;
+ char *class_name, *buf;
+
+ /* Should be a list of [binary class, bytes]. */
+ if (!PyList_Check(obj)) {
+ srd_err("Protocol decoder %s submitted non-list for SRD_OUTPUT_BINARY.",
+ di->decoder->name);
+ return SRD_ERR_PYTHON;
+ }
+
+ /* Should have 2 elements. */
+ if (PyList_Size(obj) != 2) {
+ srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list "
+ "with %zd elements instead of 2", di->decoder->name,
+ PyList_Size(obj));
+ return SRD_ERR_PYTHON;
+ }
+
+ /* The first element should be an integer. */
+ py_tmp = PyList_GetItem(obj, 0);
+ if (!PyLong_Check(py_tmp)) {
+ srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
+ "but first element was not an integer.", di->decoder->name);
+ return SRD_ERR_PYTHON;
+ }
+ bin_class = PyLong_AsLong(py_tmp);
+ if (!(class_name = g_slist_nth_data(di->decoder->binary, bin_class))) {
+ srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
+ "unregistered binary class %d.", di->decoder->name, bin_class);
+ return SRD_ERR_PYTHON;
+ }
+
+ /* Second element should be bytes. */
+ py_tmp = PyList_GetItem(obj, 1);
+ if (!PyBytes_Check(py_tmp)) {
+ srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
+ "but second element was not bytes.", di->decoder->name);
+ return SRD_ERR_PYTHON;
+ }
+
+ /* Consider an empty set of bytes a bug. */
+ if (PyBytes_Size(py_tmp) == 0) {
+ srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY "
+ "with empty data set.", di->decoder->name);
+ return SRD_ERR_PYTHON;
+ }
+
+ pdb = g_malloc(sizeof(struct srd_proto_data_binary));
+ if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1)
+ return SRD_ERR_PYTHON;
+ pdb->bin_class = bin_class;
+ pdb->size = size;
+ if (!(pdb->data = g_try_malloc(pdb->size)))
+ return SRD_ERR_MALLOC;
+ memcpy((void *)pdb->data, (const void *)buf, pdb->size);
+ pdata->data = pdb;
+
+ return SRD_OK;
+}
+
static int convert_meta(struct srd_proto_data *pdata, PyObject *obj)
{
long long intvalue;
@@ -101,7 +176,7 @@ static int convert_meta(struct srd_proto_data *pdata, PyObject *obj)
if (pdata->pdo->meta_type == G_VARIANT_TYPE_INT64) {
if (!PyLong_Check(obj)) {
PyErr_Format(PyExc_TypeError, "This output was registered "
- "as 'int', but '%s' was passed.", obj->ob_type->tp_name);
+ "as 'int', but something else was passed.");
return SRD_ERR_PYTHON;
}
intvalue = PyLong_AsLongLong(obj);
@@ -111,7 +186,7 @@ static int convert_meta(struct srd_proto_data *pdata, PyObject *obj)
} else if (pdata->pdo->meta_type == G_VARIANT_TYPE_DOUBLE) {
if (!PyFloat_Check(obj)) {
PyErr_Format(PyExc_TypeError, "This output was registered "
- "as 'float', but '%s' was passed.", obj->ob_type->tp_name);
+ "as 'float', but something else was passed.");
return SRD_ERR_PYTHON;
}
dvalue = PyFloat_AsDouble(obj);
@@ -141,7 +216,7 @@ static PyObject *Decoder_put(PyObject *self, PyObject *args)
}
if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample,
- &output_id, &py_data)) {
+ &output_id, &py_data)) {
/*
* This throws an exception, but by returning NULL here we let
* Python raise it. This results in a much better trace in
@@ -159,12 +234,9 @@ static PyObject *Decoder_put(PyObject *self, PyObject *args)
srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.",
di->inst_id, start_sample, end_sample,
- OUTPUT_TYPES[pdo->output_type], output_id);
+ output_type_name(pdo->output_type), output_id);
- if (!(pdata = g_try_malloc0(sizeof(struct srd_proto_data)))) {
- srd_err("Failed to g_malloc() struct srd_proto_data.");
- return NULL;
- }
+ pdata = g_malloc0(sizeof(struct srd_proto_data));
pdata->start_sample = start_sample;
pdata->end_sample = end_sample;
pdata->pdo = pdo;
@@ -173,7 +245,7 @@ static PyObject *Decoder_put(PyObject *self, PyObject *args)
case SRD_OUTPUT_ANN:
/* Annotations are only fed to callbacks. */
if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
- /* Annotations need converting from PyObject. */
+ /* Convert from PyDict to srd_proto_data_annotation. */
if (convert_annotation(di, py_data, pdata) != SRD_OK) {
/* An error was already logged. */
break;
@@ -184,22 +256,32 @@ static PyObject *Decoder_put(PyObject *self, PyObject *args)
case SRD_OUTPUT_PYTHON:
for (l = di->next_di; l; l = l->next) {
next_di = l->data;
- /* TODO: Is this needed? */
- Py_XINCREF(next_di->py_inst);
- srd_spew("Sending %d-%d to instance %s",
- start_sample, end_sample,
- next_di->inst_id);
+ srd_spew("Sending %" PRIu64 "-%" PRIu64 " to instance %s",
+ start_sample, end_sample, next_di->inst_id);
if (!(py_res = PyObject_CallMethod(
- next_di->py_inst, "decode", "KKO", start_sample,
- end_sample, py_data))) {
- srd_exception_catch("Calling %s decode(): ",
- next_di->inst_id);
+ next_di->py_inst, "decode", "KKO", start_sample,
+ end_sample, py_data))) {
+ srd_exception_catch("Calling %s decode() failed",
+ next_di->inst_id);
}
Py_XDECREF(py_res);
}
+ if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
+ /* Frontends aren't really supposed to get Python
+ * callbacks, but it's useful for testing. */
+ pdata->data = py_data;
+ cb->cb(pdata, cb->cb_data);
+ }
break;
case SRD_OUTPUT_BINARY:
- srd_err("SRD_OUTPUT_BINARY not yet supported.");
+ if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
+ /* Convert from PyDict to srd_proto_data_binary. */
+ if (convert_binary(di, py_data, pdata) != SRD_OK) {
+ /* An error was already logged. */
+ break;
+ }
+ cb->cb(pdata, cb->cb_data);
+ }
break;
case SRD_OUTPUT_META:
if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
@@ -259,8 +341,7 @@ static PyObject *Decoder_register(PyObject *self, PyObject *args,
else if (meta_type_py == &PyFloat_Type)
meta_type_gv = G_VARIANT_TYPE_DOUBLE;
else {
- PyErr_Format(PyExc_TypeError, "Unsupported type '%s'.",
- meta_type_py->tp_name);
+ PyErr_Format(PyExc_TypeError, "Unsupported type.");
return NULL;
}
}
@@ -268,10 +349,7 @@ static PyObject *Decoder_register(PyObject *self, PyObject *args,
srd_dbg("Instance %s creating new output type %d for %s.",
di->inst_id, output_type, proto_id);
- if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
- PyErr_SetString(PyExc_MemoryError, "struct srd_pd_output");
- return NULL;
- }
+ pdo = g_malloc(sizeof(struct srd_pd_output));
/* pdo_id is just a simple index, nothing is deleted from this list anyway. */
pdo->pdo_id = g_slist_length(di->pd_output);
@@ -291,35 +369,32 @@ static PyObject *Decoder_register(PyObject *self, PyObject *args,
return py_new_output_id;
}
-/* TODO: this is just a stub that calls _register() until all PDs
- * are changed to use the new register API. */
-static PyObject *Decoder_add(PyObject *self, PyObject *args)
-{
- PyObject *py_keywords, *py_new_output_id;
-
- py_keywords = PyDict_New();
- py_new_output_id = Decoder_register(self, args, py_keywords);
- Py_DecRef(py_keywords);
-
- return py_new_output_id;
-}
-
static PyMethodDef Decoder_methods[] = {
{"put", Decoder_put, METH_VARARGS,
"Accepts a dictionary with the following keys: startsample, endsample, data"},
- {"add", Decoder_add, METH_VARARGS, "Create a new output stream"},
{"register", (PyCFunction)Decoder_register, METH_VARARGS|METH_KEYWORDS,
"Register a new output stream"},
{NULL, NULL, 0, NULL}
};
-/** @cond PRIVATE */
-SRD_PRIV PyTypeObject srd_Decoder_type = {
- PyVarObject_HEAD_INIT(NULL, 0)
- .tp_name = "sigrokdecode.Decoder",
- .tp_basicsize = sizeof(srd_Decoder),
- .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
- .tp_doc = "sigrok Decoder base class",
- .tp_methods = Decoder_methods,
-};
-/** @endcond */
+/** Create the sigrokdecode.Decoder type.
+ * @return The new type object.
+ * @private
+ */
+SRD_PRIV PyObject *srd_Decoder_type_new(void)
+{
+ PyType_Spec spec;
+ PyType_Slot slots[] = {
+ { Py_tp_doc, "sigrok Decoder base class" },
+ { Py_tp_methods, Decoder_methods },
+ { Py_tp_new, (void *)&PyType_GenericNew },
+ { 0, NULL }
+ };
+ spec.name = "sigrokdecode.Decoder";
+ spec.basicsize = sizeof(srd_Decoder);
+ spec.itemsize = 0;
+ spec.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE;
+ spec.slots = slots;
+
+ return PyType_FromSpec(&spec);
+}