Add support for OO based PDs.

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index 99594f1a1f2b776e74f8e34dd453090ab238c4bb..c455acfc56c7bd00d67760909963895ddf5b7a3a 100644 (file)
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -46,24 +46,53 @@ extern "C" {
  * or reused for different #defines later. You can only add new #defines and
  * return codes, but never remove or redefine existing ones.
  */
-#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 */
+#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 srd_decoder {
+       /** The decoder ID. Must be non-NULL and unique for all decoders. */
        char *id;
+
+       /** The (short) decoder name. */
        char *name;
+
+       /** 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;
-       PyObject *py_func;
+
+       /** Python function that performs the decoding */
+       PyObject *py_decodefunc;
 };
 
 int srd_init(void);
@@ -71,7 +100,7 @@ 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_shutdown(void);
+int srd_exit(void);
 
 #ifdef __cplusplus
 }