session: add "terminate and reset" support for protocol stacks
[libsigrokdecode.git] / libsigrokdecode-internal.h
index 926036374c1a9511c4086be544c7a0bdbd730687..6fb590cff7ce8d4c5d1139aee9ca8b7eee44214e 100644 (file)
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
 #define LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
 
  */
 
 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
 #define LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
 
+/* Use the stable ABI subset as per PEP 384. */
+#define Py_LIMITED_API 0x03020000
+
 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
 #include "libsigrokdecode.h"
 
 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
 #include "libsigrokdecode.h"
 
+enum {
+       SRD_TERM_HIGH,
+       SRD_TERM_LOW,
+       SRD_TERM_RISING_EDGE,
+       SRD_TERM_FALLING_EDGE,
+       SRD_TERM_EITHER_EDGE,
+       SRD_TERM_NO_EDGE,
+       SRD_TERM_SKIP,
+};
+
+struct srd_term {
+       int type;
+       int channel;
+       uint64_t num_samples_to_skip;
+       uint64_t num_samples_already_skipped;
+};
+
 /* Custom Python types: */
 
 typedef struct {
        PyObject_HEAD
        struct srd_decoder_inst *di;
 /* Custom Python types: */
 
 typedef struct {
        PyObject_HEAD
        struct srd_decoder_inst *di;
-       uint64_t start_samplenum;
+       uint64_t abs_start_samplenum;
        unsigned int itercnt;
        uint8_t *inbuf;
        uint64_t inbuflen;
        unsigned int itercnt;
        uint8_t *inbuf;
        uint64_t inbuflen;
@@ -59,32 +78,68 @@ SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(struct srd_session
 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj( const GSList *stack,
                const PyObject *obj);
 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di);
 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj( const GSList *stack,
                const PyObject *obj);
 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di);
-SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
-               uint64_t start_samplenum, uint64_t end_samplenum,
+SRD_PRIV void match_array_free(struct srd_decoder_inst *di);
+SRD_PRIV void condition_list_free(struct srd_decoder_inst *di);
+SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di,
+               uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
                const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
                const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
+SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match);
+SRD_PRIV int srd_inst_terminate_reset(struct srd_decoder_inst *di);
 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
-SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack);
+SRD_PRIV void srd_inst_free_all(struct srd_session *sess);
 
 /* log.c */
 
 /* log.c */
-SRD_PRIV int srd_log(int loglevel, const char *format, ...);
-SRD_PRIV int srd_spew(const char *format, ...);
-SRD_PRIV int srd_dbg(const char *format, ...);
-SRD_PRIV int srd_info(const char *format, ...);
-SRD_PRIV int srd_warn(const char *format, ...);
-SRD_PRIV int srd_err(const char *format, ...);
+#if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
+/*
+ * On MinGW, we need to specify the gnu_printf format flavor or GCC
+ * will assume non-standard Microsoft printf syntax.
+ */
+SRD_PRIV int srd_log(int loglevel, const char *format, ...)
+               __attribute__((__format__ (__gnu_printf__, 2, 3)));
+#else
+SRD_PRIV int srd_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
+#endif
+
+#define srd_spew(...)  srd_log(SRD_LOG_SPEW, __VA_ARGS__)
+#define srd_dbg(...)   srd_log(SRD_LOG_DBG,  __VA_ARGS__)
+#define srd_info(...)  srd_log(SRD_LOG_INFO, __VA_ARGS__)
+#define srd_warn(...)  srd_log(SRD_LOG_WARN, __VA_ARGS__)
+#define srd_err(...)   srd_log(SRD_LOG_ERR,  __VA_ARGS__)
+
+/* decoder.c */
+SRD_PRIV long srd_decoder_apiver(const struct srd_decoder *d);
+
+/* type_decoder.c */
+SRD_PRIV PyObject *srd_Decoder_type_new(void);
+
+/* type_logic.c */
+SRD_PRIV PyObject *srd_logic_type_new(void);
 
 /* module_sigrokdecode.c */
 PyMODINIT_FUNC PyInit_sigrokdecode(void);
 
 /* util.c */
 
 /* module_sigrokdecode.c */
 PyMODINIT_FUNC PyInit_sigrokdecode(void);
 
 /* util.c */
-SRD_PRIV int py_attr_as_str(const PyObject *py_obj, const char *attr,
-        char **outstr);
-SRD_PRIV int py_dictitem_as_str(const PyObject *py_obj, const char *key,
-        char **outstr);
-SRD_PRIV int py_str_as_str(const PyObject *py_str, char **outstr);
-SRD_PRIV int py_strseq_to_char(const PyObject *py_strseq, char ***outstr);
+SRD_PRIV PyObject *py_import_by_name(const char *name);
+SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
+SRD_PRIV int py_attr_as_strlist(PyObject *py_obj, const char *attr, GSList **outstrlist);
+SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr);
+SRD_PRIV int py_listitem_as_str(PyObject *py_obj, Py_ssize_t idx, char **outstr);
+SRD_PRIV int py_pydictitem_as_str(PyObject *py_obj, PyObject *py_key, char **outstr);
+SRD_PRIV int py_pydictitem_as_long(PyObject *py_obj, PyObject *py_key, uint64_t *out);
+SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr);
+SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv);
+SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj);
 
 /* exception.c */
 
 /* exception.c */
-SRD_PRIV void srd_exception_catch(const char *format, ...);
+#if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
+/*
+ * On MinGW, we need to specify the gnu_printf format flavor or GCC
+ * will assume non-standard Microsoft printf syntax.
+ */
+SRD_PRIV void srd_exception_catch(const char *format, ...)
+               __attribute__((__format__ (__gnu_printf__, 1, 2)));
+#else
+SRD_PRIV void srd_exception_catch(const char *format, ...) G_GNUC_PRINTF(1, 2);
+#endif
 
 #endif
 
 #endif