srd/cli/qt: Some more API consistency renames.
authorUwe Hermann <uwe@hermann-uwe.de>
Sun, 25 Mar 2012 12:49:11 +0000 (14:49 +0200)
committerUwe Hermann <uwe@hermann-uwe.de>
Tue, 27 Mar 2012 23:19:27 +0000 (01:19 +0200)
controller.c
decoder.c
sigrokdecode-internal.h
sigrokdecode.h.in
type_decoder.c

index 565bc0ae19afeb665895770c909cc23e654a47a2..277897c546abecc7199c96972dffb1c54d30f214 100644 (file)
@@ -198,7 +198,7 @@ SRD_PRIV int add_modulepath(const char *path)
 }
 
 /**
- * Set options in a decoder instance.
+ * Set one or more options in a decoder instance.
  *
  * Handled options are removed from the hash.
  *
@@ -207,8 +207,8 @@ SRD_PRIV int add_modulepath(const char *path)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
-                                GHashTable *options)
+SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
+                               GHashTable *options)
 {
        PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
        PyObject *py_optlist, *py_classval;
@@ -316,14 +316,17 @@ err_out:
        return ret;
 }
 
-/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probes_set() */
+/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */
 static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
 {
        return strcmp(a->id, probe_id);
 }
 
 /**
- * Set probes in a decoder instance.
+ * Set all probes in a decoder instance.
+ *
+ * This function sets _all_ probes for the specified decoder instance, i.e.,
+ * it overwrites any probes that were already defined (if any).
  *
  * @param di Decoder instance.
  * @param probes A GHashTable of probes to set. Key is probe name, value is
@@ -332,8 +335,8 @@ static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
-                               GHashTable *new_probes)
+SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
+                                  GHashTable *new_probes)
 {
        GList *l;
        GSList *sl;
@@ -457,7 +460,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
                return NULL;
        }
 
-       if (srd_inst_options_set(di, options) != SRD_OK) {
+       if (srd_inst_option_set(di, options) != SRD_OK) {
                g_free(di->dec_probemap);
                g_free(di);
                return NULL;
@@ -769,7 +772,7 @@ SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
 }
 
 /**
- * Register a decoder output callback function.
+ * Register/add a decoder output callback function.
  *
  * The function will be called when a protocol decoder sends output back
  * to the PD controller (except for Python objects, which only go up the
@@ -780,8 +783,8 @@ SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
  * @param cb The function to call. Must not be NULL.
  * @param cb_data Private data for the callback function. Can be NULL.
  */
-SRD_API int srd_register_callback(int output_type,
-                                 srd_pd_output_callback_t cb, void *cb_data)
+SRD_API int srd_pd_output_callback_add(int output_type,
+                               srd_pd_output_callback_t cb, void *cb_data)
 {
        struct srd_pd_callback *pd_cb;
 
@@ -800,7 +803,7 @@ SRD_API int srd_register_callback(int output_type,
        return SRD_OK;
 }
 
-SRD_PRIV void *srd_find_callback(int output_type)
+SRD_PRIV void *srd_pd_output_callback_find(int output_type)
 {
        GSList *l;
        struct srd_pd_callback *pd_cb;
index 02edee22b69aa674dc4039ea1a493dc898b962d2..ad16846775b02c163f937af290a7c0a3243bea87 100644 (file)
--- a/decoder.c
+++ b/decoder.c
@@ -289,7 +289,7 @@ err_out:
  * @return A newly allocated buffer containing the protocol decoder's
  *         documentation. The caller is responsible for free'ing the buffer.
  */
-SRD_API char *srd_decoder_doc(const struct srd_decoder *dec)
+SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
 {
        PyObject *py_str;
        char *doc;
index 5351b13cb6b9c49bd97cb07b7fb3bbb1cb017c56..42e9118e915052a08a11bdc727a9ae03cafc6add 100644 (file)
@@ -38,7 +38,7 @@ SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type,
 
 /*--- decoder.c -------------------------------------------------------------*/
 
-SRD_PRIV void *srd_find_callback(int output_type);
+SRD_PRIV void *srd_pd_output_callback_find(int output_type);
 
 /*--- exception.c -----------------------------------------------------------*/
 
index f73c58c3bb6cc5d37cbf1dcc544ec64251951429..37a225742367b9d9221385f09c5f529c07a7406e 100644 (file)
@@ -239,10 +239,10 @@ typedef struct {
 
 SRD_API int srd_init(const char *path);
 SRD_API int srd_exit(void);
-SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
-                                GHashTable *options);
-SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
-                               GHashTable *probes);
+SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
+                               GHashTable *options);
+SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
+                                  GHashTable *probes);
 SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
                                              GHashTable *options);
 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
@@ -252,8 +252,8 @@ SRD_API int srd_session_start(int num_probes, int unitsize,
                              uint64_t samplerate);
 SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
                             uint64_t inbuflen);
-SRD_API int srd_register_callback(int output_type,
-                                 srd_pd_output_callback_t cb, void *cb_data);
+SRD_API int srd_pd_output_callback_add(int output_type,
+                               srd_pd_output_callback_t cb, void *cb_data);
 
 /*--- decoder.c -------------------------------------------------------------*/
 
@@ -263,7 +263,7 @@ SRD_API int srd_decoder_load(const char *name);
 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
 SRD_API int srd_decoder_load_all(void);
 SRD_API int srd_decoder_unload_all(void);
-SRD_API char *srd_decoder_doc(const struct srd_decoder *dec);
+SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
 
 /*--- log.c -----------------------------------------------------------------*/
 
index e5426c166f28aa87a7495aa7676be42175dfda97..19fd3508bd723a3ed965f9c8a8b25ae165a23578 100644 (file)
@@ -135,7 +135,7 @@ static PyObject *Decoder_put(PyObject *self, PyObject *args)
        switch (pdo->output_type) {
        case SRD_OUTPUT_ANN:
                /* Annotations are only fed to callbacks. */
-               if ((cb = srd_find_callback(pdo->output_type))) {
+               if ((cb = srd_pd_output_callback_find(pdo->output_type))) {
                        /* Annotations need converting from PyObject. */
                        if (convert_pyobj(di, data, &pdata->ann_format,
                                          (char ***)&pdata->data) != SRD_OK) {