lib headers: Add 'extern "C"' for C++ usage.

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index 7805d8545de86cdf60bd99c28a9391592f1b14ee..4876b5bd7f8c1480ccc344f0cb3fe01319240e26 100644 (file)
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -18,17 +18,64 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#ifndef LIBSIGROKDECODE_SIGROKDECODE_H
-#define LIBSIGROKDECODE_SIGROKDECODE_H
+#ifndef SIGROKDECODE_SIGROKDECODE_H
+#define SIGROKDECODE_SIGROKDECODE_H
 
 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
 #include <stdint.h>
+#include <glib.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * Status/error codes returned by libsigrokdecode functions.
+ *
+ * All possible return codes of libsigrokdecode functions must be listed here.
+ * Functions should never return hardcoded numbers as status, but rather
+ * use these #defines instead. All error codes are negative numbers.
+ *
+ * The error codes are globally unique in libsigrokdecode, i.e. if one of the
+ * libsigrokdecode functions returns a "malloc error" it must be exactly the
+ * same return value as used by all other functions to indicate "malloc error".
+ * There must be no functions which indicate two different errors via the
+ * same return code.
+ *
+ * Also, for compatibility reasons, no defined return codes are ever removed
+ * or reused for different #defines later. You can only add new #defines and
+ * return codes, but never remove or redefine existing ones.
+ */
+#define SIGROKDECODE_OK                         0 /* No error */
+#define SIGROKDECODE_ERR               -1 /* Generic/unspecified error */
+#define SIGROKDECODE_ERR_MALLOC                -2 /* Malloc/calloc/realloc error */
+#define SIGROKDECODE_ERR_ARGS          -3 /* Function argument error */
+#define SIGROKDECODE_ERR_PYTHON                -4 /* Python C API error */
+#define SIGROKDECODE_ERR_DECODERS_DIR  -5 /* Protocol decoder path invalid */
+
+/* TODO: Documentation. */
+struct sigrokdecode_decoder {
+       char *id;
+       char *name;
+       char *desc;
+       char *func;
+       GSList *inputformats;
+       GSList *outputformats;
+
+       PyObject *py_mod;
+       PyObject *py_func;
+};
 
 int sigrokdecode_init(void);
-int sigrokdecode_load_decoder_file(const char *name);
-int sigrokdecode_run_decoder(const char *decodername, uint8_t *inbuf,
-                            uint64_t inbuflen, uint8_t **outbuf,
-                            uint64_t *outbuflen);
+GSList *sigrokdecode_list_decoders(void);
+int sigrokdecode_load_decoder(const char *name, struct sigrokdecode_decoder **dec);
+int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
+                            uint8_t *inbuf, uint64_t inbuflen,
+                            uint8_t **outbuf, uint64_t *outbuflen);
 int sigrokdecode_shutdown(void);
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif