X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=sigrokdecode.h;h=b941c9f555f2ceb2fcd1c915f2d9a8cdaa640428;hp=be3ab98e05d9929bf2b2864c29f5508557c40f57;hb=7c3d8112204315d717b85bc4c71ecbf3ccf54f51;hpb=31b82285e5ca1fbd6a33eaaaa95bf83862b69eb1

diff --git a/sigrokdecode.h b/sigrokdecode.h
index be3ab98..b941c9f 100644
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -23,6 +23,11 @@
 
 #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.
@@ -41,25 +46,64 @@
  * 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 SRD_OK			 0 /**< No error */
+#define SRD_ERR			-1 /**< Generic/unspecified error */
+#define SRD_ERR_MALLOC		-2 /**< Malloc/calloc/realloc error */
+#define SRD_ERR_ARGS		-3 /**< Function argument error */
+#define SRD_ERR_PYTHON		-4 /**< Python C API error */
+#define SRD_ERR_DECODERS_DIR	-5 /**< Protocol decoder path invalid */
 
 /* TODO: Documentation. */
-struct sigrokdecode_decoder_info {
+struct srd_decoder {
+	/** The decoder ID. Must be non-NULL and unique for all decoders. */
 	char *id;
+
+	/** The (short) decoder name. */
 	char *name;
-	char *description;
-	char *function;
-	char *inputformats; /* FIXME: Should be a list. */
-	char *outputformats; /* FIXME: Should be a list. */
+
+	/** The (long) decoder name. May be NULL. */
+	char *longname;
+
+	/** A (short, one-line) description of the decoder. */
+	char *desc;
+
+	/** A (long, multi-line) description of the decoder. May be NULL. */
+	char *longdesc;
+
+	/** The author of the decoder. May be NULL. */
+	char *author;
+
+	/** An email address of the decoder's author. May be NULL. */
+	char *email;
+
+	/** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
+	char *license;
+
+	/** TODO */
+	char *func;
+
+	/** TODO */
+	GSList *inputformats;
+
+	/** TODO */
+	GSList *outputformats;
+
+	/** TODO */
+	PyObject *py_mod;
+
+	/** TODO */
+	PyObject *py_func;
 };
 
-int sigrokdecode_init(void);
-int sigrokdecode_load_decoder_file(const char *name);
-int sigrokdecode_run_decoder(const char *modulename, const char *decodername,
-			     uint8_t *inbuf, uint64_t inbuflen,
-			     uint8_t **outbuf, uint64_t *outbuflen);
-int sigrokdecode_shutdown(void);
+int srd_init(void);
+GSList *srd_list_decoders(void);
+struct srd_decoder *srd_get_decoder_by_id(const char *id);
+int srd_run_decoder(struct srd_decoder *dec, uint8_t *inbuf, uint64_t inbuflen,
+		    uint8_t **outbuf, uint64_t *outbuflen);
+int srd_exit(void);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif