srd: last public/private fix, and docs for all publis functions.
[libsigrokdecode.git] / sigrokdecode-internal.h
1 /*
2  * This file is part of the sigrok 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_SIGROKDECODE_INTERNAL_H
23 #define LIBSIGROKDECODE_SIGROKDECODE_INTERNAL_H
24
25 #include "sigrokdecode.h"
26
27 /*--- Macros ----------------------------------------------------------------*/
28
29 #ifndef ARRAY_SIZE
30 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
31 #endif
32
33 #ifndef ARRAY_AND_SIZE
34 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
35 #endif
36
37 /*--- controller.c ----------------------------------------------------------*/
38
39 SRD_PRIV int add_modulepath(const char *path);
40 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args);
41 SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
42                                 struct srd_decoder_inst *dec,
43                                 uint8_t *inbuf, uint64_t inbuflen);
44 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
45 SRD_PRIV void srd_inst_free_all(GSList *stack);
46 SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type,
47                     char *output_id);
48
49 /*--- decoder.c -------------------------------------------------------------*/
50 SRD_PRIV void *srd_find_callback(int output_type);
51
52 /*--- exception.c -----------------------------------------------------------*/
53
54 SRD_PRIV void catch_exception(const char *format, ...);
55
56 /*--- log.c -----------------------------------------------------------------*/
57
58 SRD_PRIV int srd_log(int loglevel, const char *format, ...);
59 SRD_PRIV int srd_spew(const char *format, ...);
60 SRD_PRIV int srd_dbg(const char *format, ...);
61 SRD_PRIV int srd_info(const char *format, ...);
62 SRD_PRIV int srd_warn(const char *format, ...);
63 SRD_PRIV int srd_err(const char *format, ...);
64
65 /*--- util.c ----------------------------------------------------------------*/
66
67 SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
68 SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr);
69 SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr);
70 SRD_PRIV int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
71 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
72                                                               PyObject *obj);
73
74 #endif