Various Python decoder infrastructure improvements.
[libsigrokdecode.git] / sigrokdecode.h
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #ifndef SIGROKDECODE_SIGROKDECODE_H
22 #define SIGROKDECODE_SIGROKDECODE_H
23
24 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
25 #include <stdint.h>
26 #include <glib.h>
27
28 /*
29  * Status/error codes returned by libsigrokdecode functions.
30  *
31  * All possible return codes of libsigrokdecode functions must be listed here.
32  * Functions should never return hardcoded numbers as status, but rather
33  * use these #defines instead. All error codes are negative numbers.
34  *
35  * The error codes are globally unique in libsigrokdecode, i.e. if one of the
36  * libsigrokdecode functions returns a "malloc error" it must be exactly the
37  * same return value as used by all other functions to indicate "malloc error".
38  * There must be no functions which indicate two different errors via the
39  * same return code.
40  *
41  * Also, for compatibility reasons, no defined return codes are ever removed
42  * or reused for different #defines later. You can only add new #defines and
43  * return codes, but never remove or redefine existing ones.
44  */
45 #define SIGROKDECODE_OK                  0 /* No error */
46 #define SIGROKDECODE_ERR                -1 /* Generic/unspecified error */
47 #define SIGROKDECODE_ERR_MALLOC         -2 /* Malloc/calloc/realloc error */
48 #define SIGROKDECODE_ERR_ARGS           -3 /* Function argument error */
49 #define SIGROKDECODE_ERR_PYTHON         -4 /* Python C API error */
50
51 /* TODO: Documentation. */
52 struct sigrokdecode_decoder {
53         char *id;
54         char *name;
55         char *desc;
56         char *func;
57         GSList *inputformats;
58         GSList *outputformats;
59
60         PyObject *py_mod;
61         PyObject *py_func;
62 };
63
64 int sigrokdecode_init(void);
65 int sigrokdecode_load_decoder(const char *name, struct sigrokdecode_decoder **dec);
66 int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
67                              uint8_t *inbuf, uint64_t inbuflen,
68                              uint8_t **outbuf, uint64_t *outbuflen);
69 int sigrokdecode_shutdown(void);
70
71 #endif