srd: Cosmetics, whitespace, coding-style fixes.

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index 17615216a09f2446d668a0c29b1700bb02faae4a..51efcc6ebf2b9a6b8b1148c7dd1635876974c30e 100644 (file)
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -63,15 +63,16 @@ extern "C" {
 #define SRD_LOG_DBG    4 /**< Output debug messages. */
 #define SRD_LOG_SPEW   5 /**< Output very noisy debug messages. */
 
+/*
+ * When adding an output type, don't forget to...
+ *   - expose it to PDs in controller.c:PyInit_sigrokdecode()
+ *   - add a check in module_sigrokdecode.c:Decoder_put()
+ *   - add a debug string in type_decoder.c:OUTPUT_TYPES
+ */
 enum {
        SRD_OUTPUT_ANN,
        SRD_OUTPUT_PROTO,
        SRD_OUTPUT_BINARY,
-       /* When adding an output type, don't forget to...
-        *        - expose it to PDs in controller.c:PyInit_sigrokdecode()
-        *        - add a check in module_sigrokdecode.c:Decoder_put()
-        *    - add a debug string in type_decoder.c:OUTPUT_TYPES
-        */
 };
 
 #define SRD_MAX_NUM_PROBES   64
@@ -105,7 +106,8 @@ struct srd_decoder {
        /** Optional probes */
        GSList *opt_probes;
 
-       /* List of NULL-terminated char[], containing descriptions of the
+       /*
+        * List of NULL-terminated char[], containing descriptions of the
         * supported annotation output.
         */
        GSList *annotations;
@@ -157,7 +159,6 @@ struct srd_pd_callback {
        void (*callback)(struct srd_proto_data *);
 };
 
-
 /* custom python types */
 typedef struct {
        PyObject_HEAD
@@ -173,29 +174,31 @@ typedef struct {
        PyObject *sample;
 } srd_logic;
 
-
 /*--- controller.c ----------------------------------------------------------*/
+
 int srd_init(void);
 int srd_exit(void);
 int set_modulepath(void);
 int srd_instance_set_options(struct srd_decoder_instance *di,
-               GHashTable *options);
+                            GHashTable *options);
 int srd_instance_set_probes(struct srd_decoder_instance *di,
-               GHashTable *probes);
+                           GHashTable *probes);
 struct srd_decoder_instance *srd_instance_new(const char *id,
-               GHashTable *options);
+                                             GHashTable *options);
 int srd_instance_stack(struct srd_decoder_instance *di_from,
-               struct srd_decoder_instance *di_to);
+                      struct srd_decoder_instance *di_to);
 struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id);
 struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack,
-               PyObject *obj);
+                                                     PyObject *obj);
 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args);
 int srd_instance_decode(uint64_t start_samplenum,
-               struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen);
+                       struct srd_decoder_instance *dec,
+                       uint8_t *inbuf, uint64_t inbuflen);
 void srd_instance_free(struct srd_decoder_instance *di);
 void srd_instance_free_all(GSList *stack);
 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
-int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen);
+int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
+                    uint64_t inbuflen);
 int pd_add(struct srd_decoder_instance *di, int output_type, char *output_id);
 struct srd_decoder_instance *get_di_by_decobject(void *decobject);
 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata);
@@ -203,6 +206,7 @@ int srd_register_callback(int output_type, srd_pd_output_callback_t cb);
 void *srd_find_callback(int output_type);
 
 /*--- decoder.c -------------------------------------------------------------*/
+
 GSList *srd_list_decoders(void);
 struct srd_decoder *srd_get_decoder_by_id(const char *id);
 int srd_load_decoder(const char *name, struct srd_decoder **dec);
@@ -212,23 +216,27 @@ int srd_unload_all_decoders(void);
 char *srd_decoder_doc(struct srd_decoder *dec);
 
 /*--- exception.c -----------------------------------------------------------*/
+
 void catch_exception(const char *format, ...);
 
 /*--- util.c ----------------------------------------------------------------*/
+
 int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
 int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr);
 int py_str_as_str(PyObject *py_str, char **outstr);
 int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
 
 /*--- log.c -----------------------------------------------------------------*/
+
 typedef int (*srd_log_handler_t)(void *data, int loglevel, const char *format,
                                 va_list args);
-int srd_set_loglevel(int loglevel);
-int srd_get_loglevel(void);
-int srd_log_set_handler(srd_log_handler_t handler, void *data);
-int srd_log_set_default_handler(void);
-int srd_log_set_logdomain(const char *logdomain);
-char *srd_log_get_logdomain(void);
+
+int srd_log_loglevel_set(int loglevel);
+int srd_log_loglevel_get(void);
+int srd_log_handler_set(srd_log_handler_t handler, void *data);
+int srd_log_handler_set_default(void);
+int srd_log_logdomain_set(const char *logdomain);
+char *srd_log_logdomain_get(void);
 
 #ifdef __cplusplus
 }