pjon: show "communication relations", and nits
[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, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
22 #define LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
23
24 /* Use the stable ABI subset as per PEP 384. */
25 #define Py_LIMITED_API 0x03020000
26
27 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
28 #include "libsigrokdecode.h"
29
30 enum {
31         SRD_TERM_ALWAYS_FALSE,
32         SRD_TERM_HIGH,
33         SRD_TERM_LOW,
34         SRD_TERM_RISING_EDGE,
35         SRD_TERM_FALLING_EDGE,
36         SRD_TERM_EITHER_EDGE,
37         SRD_TERM_NO_EDGE,
38         SRD_TERM_SKIP,
39 };
40
41 struct srd_term {
42         int type;
43         int channel;
44         uint64_t num_samples_to_skip;
45         uint64_t num_samples_already_skipped;
46 };
47
48 /* Custom Python types: */
49
50 typedef struct {
51         PyObject_HEAD
52         struct srd_decoder_inst *di;
53         uint64_t abs_start_samplenum;
54         unsigned int itercnt;
55         uint8_t *inbuf;
56         uint64_t inbuflen;
57         PyObject *sample;
58 } srd_logic;
59
60 struct srd_session {
61         int session_id;
62
63         /* List of decoder instances. */
64         GSList *di_list;
65
66         /* List of frontend callbacks to receive decoder output. */
67         GSList *callbacks;
68 };
69
70 /* srd.c */
71 SRD_PRIV int srd_decoder_searchpath_add(const char *path);
72
73 /* session.c */
74 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(struct srd_session *sess,
75                 int output_type);
76
77 /* instance.c */
78 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di);
79 SRD_PRIV void match_array_free(struct srd_decoder_inst *di);
80 SRD_PRIV void condition_list_free(struct srd_decoder_inst *di);
81 SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di,
82                 uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
83                 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
84 SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match);
85 SRD_PRIV int srd_inst_terminate_reset(struct srd_decoder_inst *di);
86 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
87 SRD_PRIV void srd_inst_free_all(struct srd_session *sess);
88
89 /* log.c */
90 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
91 /*
92  * On MinGW, we need to specify the gnu_printf format flavor or GCC
93  * will assume non-standard Microsoft printf syntax.
94  */
95 SRD_PRIV int srd_log(int loglevel, const char *format, ...)
96                 __attribute__((__format__ (__gnu_printf__, 2, 3)));
97 #else
98 SRD_PRIV int srd_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
99 #endif
100
101 #define srd_spew(...)   srd_log(SRD_LOG_SPEW, __VA_ARGS__)
102 #define srd_dbg(...)    srd_log(SRD_LOG_DBG,  __VA_ARGS__)
103 #define srd_info(...)   srd_log(SRD_LOG_INFO, __VA_ARGS__)
104 #define srd_warn(...)   srd_log(SRD_LOG_WARN, __VA_ARGS__)
105 #define srd_err(...)    srd_log(SRD_LOG_ERR,  __VA_ARGS__)
106
107 /* decoder.c */
108 SRD_PRIV long srd_decoder_apiver(const struct srd_decoder *d);
109
110 /* type_decoder.c */
111 SRD_PRIV PyObject *srd_Decoder_type_new(void);
112 SRD_PRIV const char *output_type_name(unsigned int idx);
113
114 /* type_logic.c */
115 SRD_PRIV PyObject *srd_logic_type_new(void);
116
117 /* module_sigrokdecode.c */
118 PyMODINIT_FUNC PyInit_sigrokdecode(void);
119
120 /* util.c */
121 SRD_PRIV PyObject *py_import_by_name(const char *name);
122 SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
123 SRD_PRIV int py_attr_as_strlist(PyObject *py_obj, const char *attr, GSList **outstrlist);
124 SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr);
125 SRD_PRIV int py_listitem_as_str(PyObject *py_obj, Py_ssize_t idx, char **outstr);
126 SRD_PRIV int py_pydictitem_as_str(PyObject *py_obj, PyObject *py_key, char **outstr);
127 SRD_PRIV int py_pydictitem_as_long(PyObject *py_obj, PyObject *py_key, int64_t *out);
128 SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr);
129 SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv);
130 SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj);
131
132 /* exception.c */
133 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
134 /*
135  * On MinGW, we need to specify the gnu_printf format flavor or GCC
136  * will assume non-standard Microsoft printf syntax.
137  */
138 SRD_PRIV void srd_exception_catch(const char *format, ...)
139                 __attribute__((__format__ (__gnu_printf__, 1, 2)));
140 #else
141 SRD_PRIV void srd_exception_catch(const char *format, ...) G_GNUC_PRINTF(1, 2);
142 #endif
143
144 #endif