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 /* Use the stable ABI subset as per PEP 384. */
  26 #define Py_LIMITED_API 0x03020000
  27
  28 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
  29 #include "libsigrokdecode.h"
  30
  31 enum {
  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 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 int session_is_valid(struct srd_session *sess);
  75 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(struct srd_session *sess,
  76                 int output_type);
  77
  78 /* instance.c */
  79 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj( const GSList *stack,
  80                 const PyObject *obj);
  81 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di);
  82 SRD_PRIV void match_array_free(struct srd_decoder_inst *di);
  83 SRD_PRIV void condition_list_free(struct srd_decoder_inst *di);
  84 SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di,
  85                 uint64_t start_samplenum, uint64_t end_samplenum,
  86                 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
  87 SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match);
  88 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
  89 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack);
  90
  91 /* log.c */
  92 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
  93 /*
  94  * On MinGW, we need to specify the gnu_printf format flavor or GCC
  95  * will assume non-standard Microsoft printf syntax.
  96  */
  97 SRD_PRIV int srd_log(int loglevel, const char *format, ...)
  98                 __attribute__((__format__ (__gnu_printf__, 2, 3)));
  99 #else
 100 SRD_PRIV int srd_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
 101 #endif
 102
 103 #define srd_spew(...)   srd_log(SRD_LOG_SPEW, __VA_ARGS__)
 104 #define srd_dbg(...)    srd_log(SRD_LOG_DBG,  __VA_ARGS__)
 105 #define srd_info(...)   srd_log(SRD_LOG_INFO, __VA_ARGS__)
 106 #define srd_warn(...)   srd_log(SRD_LOG_WARN, __VA_ARGS__)
 107 #define srd_err(...)    srd_log(SRD_LOG_ERR,  __VA_ARGS__)
 108
 109 /* decoder.c */
 110 SRD_PRIV long srd_decoder_apiver(const struct srd_decoder *d);
 111
 112 /* type_decoder.c */
 113 SRD_PRIV PyObject *srd_Decoder_type_new(void);
 114
 115 /* type_logic.c */
 116 SRD_PRIV PyObject *srd_logic_type_new(void);
 117
 118 /* module_sigrokdecode.c */
 119 PyMODINIT_FUNC PyInit_sigrokdecode(void);
 120
 121 /* util.c */
 122 SRD_PRIV PyObject *py_import_by_name(const char *name);
 123 SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
 124 SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr);
 125 SRD_PRIV int py_pydictitem_as_str(PyObject *py_obj, PyObject *py_key, char **outstr);
 126 SRD_PRIV int py_pydictitem_as_long(PyObject *py_obj, PyObject *py_key, uint64_t *out);
 127 SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr);
 128 SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv);
 129 SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj);
 130
 131 /* exception.c */
 132 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
 133 /*
 134  * On MinGW, we need to specify the gnu_printf format flavor or GCC
 135  * will assume non-standard Microsoft printf syntax.
 136  */
 137 SRD_PRIV void srd_exception_catch(const char *format, ...)
 138                 __attribute__((__format__ (__gnu_printf__, 1, 2)));
 139 #else
 140 SRD_PRIV void srd_exception_catch(const char *format, ...) G_GNUC_PRINTF(1, 2);
 141 #endif
 142
 143 #endif