srd: rename public API functions to srd_thing_action format

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index de08ff69ce41af1f0acf678fe78959f5b3d33424..649cdc63e299ef76077c9e67418562fedbcad907 100644 (file)
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -94,7 +94,7 @@ enum {
        SRD_OUTPUT_BINARY,
 };
 
-#define SRD_MAX_NUM_PROBES   64
+#define SRD_MAX_NUM_PROBES 64
 
 /* TODO: Documentation. */
 struct srd_decoder {
@@ -145,10 +145,10 @@ struct srd_probe {
        int order;
 };
 
-struct srd_decoder_instance {
+struct srd_decoder_inst {
        struct srd_decoder *decoder;
-       PyObject *py_instance;
-       char *instance_id;
+       PyObject *py_inst;
+       char *inst_id;
        GSList *pd_output;
        int dec_num_probes;
        int *dec_probemap;
@@ -161,7 +161,7 @@ struct srd_decoder_instance {
 struct srd_pd_output {
        int pdo_id;
        int output_type;
-       struct srd_decoder_instance *di;
+       struct srd_decoder_inst *di;
        char *proto_id;
 };
 
@@ -173,9 +173,13 @@ struct srd_proto_data {
        void *data;
 };
 
+typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
+                                        void *user_data);
+
 struct srd_pd_callback {
        int output_type;
-       void (*callback)(struct srd_proto_data *);
+       srd_pd_output_callback_t callback;
+       void *user_data;
 };
 
 /* custom python types */
@@ -185,7 +189,7 @@ typedef struct {
 
 typedef struct {
        PyObject_HEAD
-       struct srd_decoder_instance *di;
+       struct srd_decoder_inst *di;
        uint64_t start_samplenum;
        unsigned int itercnt;
        uint8_t *inbuf;
@@ -195,53 +199,42 @@ typedef struct {
 
 /*--- controller.c ----------------------------------------------------------*/
 
-SRD_API int srd_init(void);
+SRD_API int srd_init(char *path);
 SRD_API int srd_exit(void);
-SRD_API int set_modulepath(void);
-SRD_API int srd_instance_set_options(struct srd_decoder_instance *di,
+SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
                                     GHashTable *options);
-SRD_API int srd_instance_set_probes(struct srd_decoder_instance *di,
+SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
                                    GHashTable *probes);
-SRD_API struct srd_decoder_instance *srd_instance_new(const char *id,
+SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
                                                      GHashTable *options);
-SRD_API int srd_instance_stack(struct srd_decoder_instance *di_from,
-                              struct srd_decoder_instance *di_to);
-SRD_API struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id);
-SRD_API struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack,
-                                                             PyObject *obj);
-SRD_API int srd_instance_start(struct srd_decoder_instance *di, PyObject *args);
-SRD_API int srd_instance_decode(uint64_t start_samplenum,
-                               struct srd_decoder_instance *dec,
-                               uint8_t *inbuf, uint64_t inbuflen);
-SRD_API void srd_instance_free(struct srd_decoder_instance *di);
-SRD_API void srd_instance_free_all(GSList *stack);
+SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
+                              struct srd_decoder_inst *di_to);
+SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id);
 SRD_API int srd_session_start(int num_probes, int unitsize,
                              uint64_t samplerate);
 SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
                             uint64_t inbuflen);
-SRD_API struct srd_decoder_instance *get_di_by_decobject(void *decobject);
-typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata);
-SRD_API int srd_register_callback(int output_type, srd_pd_output_callback_t cb);
-SRD_API void *srd_find_callback(int output_type);
+SRD_API int srd_register_callback(int output_type,
+                                 srd_pd_output_callback_t cb, void *user_data);
 
 /*--- decoder.c -------------------------------------------------------------*/
 
-SRD_API GSList *srd_list_decoders(void);
-SRD_API struct srd_decoder *srd_get_decoder_by_id(const char *id);
-SRD_API int srd_load_decoder(const char *name, struct srd_decoder **dec);
-SRD_API int srd_unload_decoder(struct srd_decoder *dec);
-SRD_API int srd_load_all_decoders(void);
-SRD_API int srd_unload_all_decoders(void);
+SRD_API GSList *srd_decoders_list(void);
+SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
+SRD_API int srd_decoder_load(const char *name);
+SRD_API int srd_decoder_unload(struct srd_decoder *dec);
+SRD_API int srd_decoders_load_all(void);
+SRD_API int srd_decoders_unload_all(void);
 SRD_API char *srd_decoder_doc(struct srd_decoder *dec);
 
 /*--- log.c -----------------------------------------------------------------*/
 
-typedef int (*srd_log_handler_t)(void *data, int loglevel, const char *format,
-                                va_list args);
+typedef int (*srd_log_handler_t)(void *user_data, int loglevel,
+                                const char *format, va_list args);
 
 SRD_API int srd_log_loglevel_set(int loglevel);
 SRD_API int srd_log_loglevel_get(void);
-SRD_API int srd_log_handler_set(srd_log_handler_t handler, void *data);
+SRD_API int srd_log_handler_set(srd_log_handler_t handler, void *user_data);
 SRD_API int srd_log_handler_set_default(void);
 SRD_API int srd_log_logdomain_set(const char *logdomain);
 SRD_API char *srd_log_logdomain_get(void);