edid: move PD docstring to __init__.py

[libsigrokdecode.git] / type_decoder.c

diff --git a/type_decoder.c b/type_decoder.c
index 34b414e6c3b31a96644529245ea504d9dd665227..bbf1f64c2a8dfd6ec369f44dea84aba44148aac9 100644 (file)
--- a/type_decoder.c
+++ b/type_decoder.c
@@ -22,6 +22,14 @@
 #include "config.h"
 
 
+/* This is only used for nicer srd_dbg() output. */
+char *OUTPUT_TYPES[] = {
+       "OUTPUT_ANN",
+       "OUTPUT_PROTO",
+       "OUTPUT_BINARY",
+};
+
+
 static int convert_pyobj(struct srd_decoder_instance *di, PyObject *obj,
                int *ann_format, char ***ann)
 {
@@ -31,15 +39,15 @@ static int convert_pyobj(struct srd_decoder_instance *di, PyObject *obj,
 
        /* 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",
+               srd_err("Protocol decoder %s submitted %s instead of list.",
                                di->decoder->name, obj->ob_type->tp_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, PyList_Size(obj));
+               srd_err("Protocol decoder %s submitted annotation list with %d elements "
+                               "instead of 2", di->decoder->name, PyList_Size(obj));
                return SRD_ERR_PYTHON;
        }
 
@@ -47,15 +55,15 @@ static int convert_pyobj(struct srd_decoder_instance *di, PyObject *obj,
         * registered annotation format. */
        py_tmp = PyList_GetItem(obj, 0);
        if (!PyLong_Check(py_tmp)) {
-               srd_err("Protocol decoder %s submitted annotation list, but first element was not an integer",
-                               di->decoder->name);
+               srd_err("Protocol decoder %s submitted annotation list, but first "
+                               "element was not an integer.", di->decoder->name);
                return SRD_ERR_PYTHON;
        }
 
        ann_id = PyLong_AsLong(py_tmp);
        if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_id))) {
-               srd_err("Protocol decoder %s submitted data to non-existent annotation format %d",
-                               di->decoder->name, ann_id);
+               srd_err("Protocol decoder %s submitted data to unregistered "
+                               "annotation format %d.", di->decoder->name, ann_id);
                return SRD_ERR_PYTHON;
        }
        *ann_format = ann_id;
@@ -63,13 +71,13 @@ static int convert_pyobj(struct srd_decoder_instance *di, PyObject *obj,
        /* Second element must be a list */
        py_tmp = PyList_GetItem(obj, 1);
        if (!PyList_Check(py_tmp)) {
-               srd_err("Protocol decoder %s submitted annotation list, but second element was not a list",
-                               di->decoder->name);
+               srd_err("Protocol decoder %s submitted annotation list, but "
+                               "second element was not a list.", di->decoder->name);
                return SRD_ERR_PYTHON;
        }
        if (py_strlist_to_char(py_tmp, ann) != SRD_OK) {
-               srd_err("Protocol decoder %s submitted annotation list, but second element was malformed",
-                               di->decoder->name);
+               srd_err("Protocol decoder %s submitted annotation list, but "
+                               "second element was malformed.", di->decoder->name);
                return SRD_ERR_PYTHON;
        }
 
@@ -87,19 +95,29 @@ static PyObject *Decoder_put(PyObject *self, PyObject *args)
        int output_id;
        void (*cb)();
 
-       if (!(di = get_di_by_decobject(self)))
+       if (!(di = srd_instance_find_by_obj(NULL, self))) {
+               /* Shouldn't happen. */
+               srd_dbg("put(): self instance not found.");
                return NULL;
+       }
 
        if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample, &output_id, &data))
+               /* This throws an exception, but by returning NULL here we let python
+                * raise it. This results in a much better trace in controller.c
+                * on the decode() method call. */
                return NULL;
 
        if (!(l = g_slist_nth(di->pd_output, output_id))) {
-               srd_err("Protocol decoder %s submitted invalid output ID %d",
+               srd_err("Protocol decoder %s submitted invalid output ID %d.",
                                di->decoder->name, output_id);
                return NULL;
        }
        pdo = l->data;
 
+       srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.",
+                di->instance_id, start_sample, end_sample,
+                OUTPUT_TYPES[pdo->output_type], output_id);
+
        if (!(pdata = g_try_malloc0(sizeof(struct srd_proto_data))))
                return NULL;
        pdata->start_sample = start_sample;
@@ -124,19 +142,20 @@ static PyObject *Decoder_put(PyObject *self, PyObject *args)
                        next_di = l->data;
                        /* TODO: is this needed? */
                        Py_XINCREF(next_di->py_instance);
+                       srd_spew("Sending %d-%d to instance %s",
+                                start_sample, end_sample, next_di->instance_id);
                        if (!(py_res = PyObject_CallMethod(next_di->py_instance, "decode",
                                        "KKO", start_sample, end_sample, data))) {
-                               if (PyErr_Occurred())
-                                       PyErr_Print();
+                               catch_exception("calling %s decode(): ", next_di->instance_id);
                        }
                        Py_XDECREF(py_res);
                }
                break;
        case SRD_OUTPUT_BINARY:
-               srd_err("SRD_OUTPUT_BINARY not yet supported");
+               srd_err("SRD_OUTPUT_BINARY not yet supported.");
                break;
        default:
-               srd_err("Protocol decoder %s submitted invalid output type %d",
+               srd_err("Protocol decoder %s submitted invalid output type %d.",
                                di->decoder->name, pdo->output_type);
                break;
        }
@@ -154,15 +173,13 @@ static PyObject *Decoder_add(PyObject *self, PyObject *args)
        char *proto_id;
        int output_type, pdo_id;
 
-       if (!(di = get_di_by_decobject(self))) {
-               srd_err("%s():%d decoder instance not found", __func__, __LINE__);
+       if (!(di = srd_instance_find_by_obj(NULL, self))) {
                PyErr_SetString(PyExc_Exception, "decoder instance not found");
                return NULL;
        }
 
        if (!PyArg_ParseTuple(args, "is", &output_type, &proto_id)) {
-               if (PyErr_Occurred())
-                       PyErr_Print();
+               /* Let python raise this exception. */
                return NULL;
        }
 
@@ -177,7 +194,7 @@ static PyObject *Decoder_add(PyObject *self, PyObject *args)
 
 static PyMethodDef Decoder_methods[] = {
        {"put", Decoder_put, METH_VARARGS,
-        "Accepts a dictionary with the following keys: time, duration, data"},
+        "Accepts a dictionary with the following keys: startsample, endsample, data"},
        {"add", Decoder_add, METH_VARARGS, "Create a new output stream"},
        {NULL, NULL, 0, NULL}
 };