log: Enable varargs format warnings
[libsigrokdecode.git] / libsigrokdecode-internal.h
1 /*
2  * This file is part of the libsigrokdecode project.
3  *
4  * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
20  */
21
22 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
23 #define LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
24
25 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
26 #include "libsigrokdecode.h"
27
28 /* Custom Python types: */
29
30 typedef struct {
31         PyObject_HEAD
32         struct srd_decoder_inst *di;
33         uint64_t start_samplenum;
34         unsigned int itercnt;
35         uint8_t *inbuf;
36         uint64_t inbuflen;
37         PyObject *sample;
38 } srd_logic;
39
40 struct srd_session {
41         int session_id;
42
43         /* List of decoder instances. */
44         GSList *di_list;
45
46         /* List of frontend callbacks to receive decoder output. */
47         GSList *callbacks;
48 };
49
50 /* srd.c */
51 SRD_PRIV int srd_decoder_searchpath_add(const char *path);
52
53 /* session.c */
54 SRD_PRIV int session_is_valid(struct srd_session *sess);
55 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(struct srd_session *sess,
56                 int output_type);
57
58 /* instance.c */
59 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj( const GSList *stack,
60                 const PyObject *obj);
61 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di);
62 SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
63                 uint64_t start_samplenum, uint64_t end_samplenum,
64                 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
65 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
66 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack);
67
68 /* log.c */
69 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
70 /*
71  * On MinGW, we need to specify the gnu_printf format flavor or GCC
72  * will assume non-standard Microsoft printf syntax.
73  */
74 SRD_PRIV int srd_log(int loglevel, const char *format, ...)
75                 __attribute__((__format__ (__gnu_printf__, 2, 3)));
76 #else
77 SRD_PRIV int srd_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
78 #endif
79
80 #define srd_spew(...)   srd_log(SRD_LOG_SPEW, __VA_ARGS__)
81 #define srd_dbg(...)    srd_log(SRD_LOG_DBG,  __VA_ARGS__)
82 #define srd_info(...)   srd_log(SRD_LOG_INFO, __VA_ARGS__)
83 #define srd_warn(...)   srd_log(SRD_LOG_WARN, __VA_ARGS__)
84 #define srd_err(...)    srd_log(SRD_LOG_ERR,  __VA_ARGS__)
85
86 /* module_sigrokdecode.c */
87 PyMODINIT_FUNC PyInit_sigrokdecode(void);
88
89 /* util.c */
90 SRD_PRIV int py_attr_as_str(const PyObject *py_obj, const char *attr,
91         char **outstr);
92 SRD_PRIV int py_dictitem_as_str(const PyObject *py_obj, const char *key,
93         char **outstr);
94 SRD_PRIV int py_str_as_str(const PyObject *py_str, char **outstr);
95 SRD_PRIV int py_strseq_to_char(const PyObject *py_strseq, char ***outstr);
96
97 /* exception.c */
98 SRD_PRIV void srd_exception_catch(const char *format, ...);
99
100 #endif