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 /* Custom Python types: */
  32
  33 typedef struct {
  34         PyObject_HEAD
  35         struct srd_decoder_inst *di;
  36         uint64_t start_samplenum;
  37         unsigned int itercnt;
  38         uint8_t *inbuf;
  39         uint64_t inbuflen;
  40         PyObject *sample;
  41 } srd_logic;
  42
  43 struct srd_session {
  44         int session_id;
  45
  46         /* List of decoder instances. */
  47         GSList *di_list;
  48
  49         /* List of frontend callbacks to receive decoder output. */
  50         GSList *callbacks;
  51 };
  52
  53 /* srd.c */
  54 SRD_PRIV int srd_decoder_searchpath_add(const char *path);
  55
  56 /* session.c */
  57 SRD_PRIV int session_is_valid(struct srd_session *sess);
  58 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(struct srd_session *sess,
  59                 int output_type);
  60
  61 /* instance.c */
  62 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj( const GSList *stack,
  63                 const PyObject *obj);
  64 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di);
  65 SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
  66                 uint64_t start_samplenum, uint64_t end_samplenum,
  67                 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
  68 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
  69 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack);
  70
  71 /* log.c */
  72 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
  73 /*
  74  * On MinGW, we need to specify the gnu_printf format flavor or GCC
  75  * will assume non-standard Microsoft printf syntax.
  76  */
  77 SRD_PRIV int srd_log(int loglevel, const char *format, ...)
  78                 __attribute__((__format__ (__gnu_printf__, 2, 3)));
  79 #else
  80 SRD_PRIV int srd_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
  81 #endif
  82
  83 #define srd_spew(...)   srd_log(SRD_LOG_SPEW, __VA_ARGS__)
  84 #define srd_dbg(...)    srd_log(SRD_LOG_DBG,  __VA_ARGS__)
  85 #define srd_info(...)   srd_log(SRD_LOG_INFO, __VA_ARGS__)
  86 #define srd_warn(...)   srd_log(SRD_LOG_WARN, __VA_ARGS__)
  87 #define srd_err(...)    srd_log(SRD_LOG_ERR,  __VA_ARGS__)
  88
  89 /* type_decoder.c */
  90 SRD_PRIV PyObject *srd_Decoder_type_new(void);
  91
  92 /* type_logic.c */
  93 SRD_PRIV PyObject *srd_logic_type_new(void);
  94
  95 /* module_sigrokdecode.c */
  96 PyMODINIT_FUNC PyInit_sigrokdecode(void);
  97
  98 /* util.c */
  99 SRD_PRIV PyObject *py_import_by_name(const char *name);
 100 SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
 101 SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr);
 102 SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr);
 103 SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv);
 104 SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj);
 105
 106 /* exception.c */
 107 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
 108 /*
 109  * On MinGW, we need to specify the gnu_printf format flavor or GCC
 110  * will assume non-standard Microsoft printf syntax.
 111  */
 112 SRD_PRIV void srd_exception_catch(const char *format, ...)
 113                 __attribute__((__format__ (__gnu_printf__, 1, 2)));
 114 #else
 115 SRD_PRIV void srd_exception_catch(const char *format, ...) G_GNUC_PRINTF(1, 2);
 116 #endif
 117
 118 #endif