]> sigrok.org Git - libsigrokdecode.git/blobdiff - decode.c
Bugfix: PyTuple_SetItem() "steals" a reference.
[libsigrokdecode.git] / decode.c
index e6399db72ce346bf6d2dfc4e378a11ac0a2bcb4e..c2beab29a6bc619fbb783aae3d2d14db2d3f8858 100644 (file)
--- a/decode.c
+++ b/decode.c
 #include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
 #include <stdio.h>
 #include <string.h>
+#include <dirent.h>
+#include <config.h>
+
+/* Re-define some string functions for Python >= 3.0. */
+#if PY_VERSION_HEX >= 0x03000000
+#define PyString_AsString PyBytes_AsString
+#define PyString_FromString PyBytes_FromString
+#define PyString_Check PyBytes_Check
+#endif
+
+/* The list of protocol decoders. */
+GSList *list_pds = NULL;
+
+/*
+ * Here's a quick overview of Python/C API reference counting.
+ *
+ * Check the Python/C API docs for what type of reference a function returns.
+ *
+ *  - If it returns a "new reference", you're responsible to Py_DECREF() it.
+ *
+ *  - If it returns a "borrowed reference", you MUST NOT Py_DECREF() it.
+ *
+ *  - If a function "steals" a reference, you no longer are responsible for
+ *    Py_DECREF()ing it (someone else will do it for you at some point).
+ */
 
 /**
  * Initialize libsigrokdecode.
  *
- * @return 0 upon success, non-zero otherwise.
+ * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
  */
 int sigrokdecode_init(void)
 {
+       DIR *dir;
+       struct dirent *dp;
+       char *tmp;
+
        /* Py_Initialize() returns void and usually cannot fail. */
        Py_Initialize();
 
-       /* Add some more search directories for convenience. */
+       /* Add search directory for the protocol decoders. */
        /* FIXME: Check error code. */
-       PyRun_SimpleString(
-               "import sys;"
-               "sys.path.append('libsigrokdecode/scripts');"
-               "sys.path.append('../libsigrokdecode/scripts');"
-               "sys.path.append('/usr/local/share/sigrok');"
-               );
-
-       return 0;
+       /* FIXME: What happens if this function is called multiple times? */
+       PyRun_SimpleString("import sys;"
+                          "sys.path.append(r'" DECODERS_DIR "');");
+
+       if (!(dir = opendir(DECODERS_DIR)))
+               return SIGROKDECODE_ERR_DECODERS_DIR;
+
+       while ((dp = readdir(dir)) != NULL) {
+               if (!g_str_has_suffix(dp->d_name, ".py"))
+                       continue;
+               /* For now use the filename (without .py) as decoder name. */
+               if ((tmp = g_strndup(dp->d_name, strlen(dp->d_name) - 3)))
+                       list_pds = g_slist_append(list_pds, tmp);
+       }
+       closedir(dir);
+
+       return SIGROKDECODE_OK;
+}
+
+/**
+ * Returns the list of supported/loaded protocol decoders.
+ *
+ * This is a GSList containing the names of the decoders as strings.
+ *
+ * @return List of decoders, NULL if none are supported or loaded.
+ */
+GSList *sigrokdecode_list_decoders(void)
+{
+       return list_pds;
 }
 
 /**
@@ -49,8 +99,8 @@ int sigrokdecode_init(void)
  *
  * TODO: @param entries.
  *
- * @return 0 upon success, non-zero otherwise. The 'outstr' argument will
- *         point to a malloc()ed string upon success.
+ * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
+ *         The 'outstr' argument points to a malloc()ed string upon success.
  */
 static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod,
                 const char *key, char **outstr)
@@ -87,14 +137,15 @@ static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod,
 
        Py_DECREF(py_str);
 
-       return 0;
+       return SIGROKDECODE_OK;
 }
 
 /**
  * TODO
  *
  * @param name TODO
- * @return 0 upon success, non-zero otherwise.
+ *
+ * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
  */
 int sigrokdecode_load_decoder(const char *name,
                              struct sigrokdecode_decoder **dec)
@@ -166,7 +217,7 @@ int sigrokdecode_load_decoder(const char *name,
 
        *dec = d;
 
-       return 0;
+       return SIGROKDECODE_OK;
 }
 
 /**
@@ -177,7 +228,8 @@ int sigrokdecode_load_decoder(const char *name,
  * @param inbuflen TODO
  * @param outbuf TODO
  * @param outbuflen TODO
- * @return 0 upon success, non-zero otherwise.
+ *
+ * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
  */
 int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
                             uint8_t *inbuf, uint64_t inbuflen,
@@ -224,9 +276,14 @@ int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
                return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
        }
 
+       /*
+        * IMPORTANT: PyTuple_SetItem() "steals" a reference to py_value!
+        * That means we are no longer responsible for Py_DECREF()'ing it.
+        * It will automatically be free'd when the 'py_args' tuple is free'd.
+        */
        if (PyTuple_SetItem(py_args, 0, py_value) != 0) {
                PyErr_Print();
-               Py_DECREF(py_value);
+               Py_DECREF(py_value); /* TODO: Ref. stolen upon error? */
                Py_DECREF(py_args);
                Py_DECREF(py_func);
                Py_DECREF(py_mod);
@@ -235,7 +292,6 @@ int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
 
        if (!(py_res = PyObject_CallObject(py_func, py_args))) {
                PyErr_Print();
-               Py_DECREF(py_value);
                Py_DECREF(py_args);
                Py_DECREF(py_func);
                Py_DECREF(py_mod);
@@ -246,7 +302,6 @@ int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
                                         (Py_ssize_t *)outbuflen))) {
                PyErr_Print();
                Py_DECREF(py_res);
-               Py_DECREF(py_value);
                Py_DECREF(py_args);
                Py_DECREF(py_func);
                Py_DECREF(py_mod);
@@ -254,23 +309,22 @@ int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
        }
 
        Py_DECREF(py_res);
-       // Py_DECREF(py_value);
        Py_DECREF(py_args);
        Py_DECREF(py_func);
        Py_DECREF(py_mod);
 
-       return 0;
+       return SIGROKDECODE_OK;
 }
 
 /**
  * Shutdown libsigrokdecode.
  *
- * @return 0 upon success, non-zero otherwise.
+ * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
  */
 int sigrokdecode_shutdown(void)
 {
        /* Py_Finalize() returns void, any finalization errors are ignored. */
        Py_Finalize();
 
-       return 0;
+       return SIGROKDECODE_OK;
 }