Main header is <libsigrokdecode/libsigrokdecode.h> now.
authorUwe Hermann <uwe@hermann-uwe.de>
Fri, 3 May 2013 12:49:21 +0000 (14:49 +0200)
committerUwe Hermann <uwe@hermann-uwe.de>
Fri, 3 May 2013 19:34:27 +0000 (21:34 +0200)
This matches the convention used in libsigrok. Potential other headers
might end up in libsigrokdecode/, but only libsigrokdecode.h is meant
to be #included by frontends directly.

16 files changed:
.gitignore
Makefile.am
configure.ac
controller.c
decoder.c
exception.c
libsigrokdecode-internal.h [new file with mode: 0644]
libsigrokdecode.h.in [new file with mode: 0644]
log.c
module_sigrokdecode.c
sigrokdecode-internal.h [deleted file]
sigrokdecode.h.in [deleted file]
type_decoder.c
type_logic.c
util.c
version.c

index da301384c05fc2cd6f4865487de5db74bf3cb07d..b812ba6873774988fe5d2c44c9a34f253691c562 100644 (file)
@@ -17,7 +17,7 @@ map
 missing
 stamp-h1
 autostuff/
-sigrokdecode.h
+libsigrokdecode.h
 ChangeLog
 INSTALL
 
index e6f2cede510879cb298e5ab324af271669486e89..d3f91b89feaea549d6027619064c60562f4c4194 100644 (file)
@@ -31,8 +31,9 @@ libsigrokdecode_la_CPPFLAGS = $(CPPFLAGS_PYTHON) \
                              -DDECODERS_DIR='"$(DECODERS_DIR)"'
 libsigrokdecode_la_LDFLAGS = $(SRD_LIB_LDFLAGS) $(LDFLAGS_PYTHON)
 
-include_HEADERS = sigrokdecode.h
-noinst_HEADERS = sigrokdecode-internal.h
+library_includedir = $(includedir)/libsigrokdecode
+library_include_HEADERS = libsigrokdecode.h
+noinst_HEADERS = libsigrokdecode-internal.h
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = libsigrokdecode.pc
index 5431835cefd3332016114539259267bc503d9bf9..3ed527fb87ba1509a10f5d07ea50542368922a43 100644 (file)
@@ -148,7 +148,7 @@ AC_SUBST(SRD_PACKAGE_VERSION_MICRO)
 AC_SUBST(SRD_PACKAGE_VERSION)
 
 AC_CONFIG_FILES([Makefile
-                sigrokdecode.h
+                libsigrokdecode.h
                 libsigrokdecode.pc
                 contrib/Makefile
                 decoders/Makefile
index e023b7151dddd07d15f29a42efd10abde0b72ffb..c9825b95cfc70c8fd6448f9001e851bd6957be3b 100644 (file)
@@ -18,8 +18,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode-internal.h"
 #include "config.h"
 #include <glib.h>
 #include <inttypes.h>
index c8eb98fb1b641103f0c7548eaf4f942956cd1e45..21e24c471d6178610dacd5bdc3885d17221a9e99 100644 (file)
--- a/decoder.c
+++ b/decoder.c
@@ -19,8 +19,8 @@
  */
 
 #include "config.h"
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode-internal.h"
 #include <glib.h>
 
 /**
index cd9d2b267efe49bac893eb380c5552cd94647e4d..1ce66a875db44b23f4024545defe5bf8f08ac054 100644 (file)
@@ -17,8 +17,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode-internal.h"
 #include "config.h"
 #include <stdarg.h>
 #include <glib.h>
diff --git a/libsigrokdecode-internal.h b/libsigrokdecode-internal.h
new file mode 100644 (file)
index 0000000..718f11e
--- /dev/null
@@ -0,0 +1,67 @@
+/*
+ * This file is part of the libsigrokdecode project.
+ *
+ * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * 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
+ */
+
+#ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
+#define LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
+
+#include "libsigrokdecode.h"
+
+/*--- controller.c ----------------------------------------------------------*/
+
+SRD_PRIV int srd_decoder_searchpath_add(const char *path);
+SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args);
+SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
+                            const struct srd_decoder_inst *dec,
+                            const uint8_t *inbuf, uint64_t inbuflen);
+SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
+SRD_PRIV void srd_inst_free_all(GSList *stack);
+SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
+                                   int output_type, const char *output_id);
+
+/*--- decoder.c -------------------------------------------------------------*/
+
+SRD_PRIV void *srd_pd_output_callback_find(int output_type);
+
+/*--- exception.c -----------------------------------------------------------*/
+
+SRD_PRIV void srd_exception_catch(const char *format, ...);
+
+/*--- 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, ...);
+
+/*--- 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_strlist_to_char(const PyObject *py_strlist, char ***outstr);
+SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
+                                                      const PyObject *obj);
+
+#endif
diff --git a/libsigrokdecode.h.in b/libsigrokdecode.h.in
new file mode 100644 (file)
index 0000000..877aeb1
--- /dev/null
@@ -0,0 +1,330 @@
+/*
+ * This file is part of the libsigrokdecode project.
+ *
+ * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * 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
+ */
+
+#ifndef LIBSIGROKDECODE_SIGROKDECODE_H
+#define LIBSIGROKDECODE_SIGROKDECODE_H
+
+#include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include <stdint.h>
+#include <glib.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @file
+ *
+ * The public libsigrokdecode header file to be used by frontends.
+ *
+ * This is the only file that libsigrokdecode users (frontends) are supposed
+ * to use and include. There are other header files which get installed with
+ * libsigrokdecode, but those are not meant to be used directly by frontends.
+ *
+ * The correct way to get/use the libsigrokdecode API functions is:
+ *
+ * @code{.c}
+ *   #include <libsigrokdecode/libsigrokdecode.h>
+ * @endcode
+ */
+
+/*
+ * Package version macros (can be used for conditional compilation).
+ */
+
+/** The libsigrokdecode package 'major' version number. */
+#define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@
+
+/** The libsigrokdecode package 'minor' version number. */
+#define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@
+
+/** The libsigrokdecode package 'micro' version number. */
+#define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@
+
+/** The libsigrokdecode package version ("major.minor.micro") as string. */
+#define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@"
+
+/*
+ * Library/libtool version macros (can be used for conditional compilation).
+ */
+
+/** The libsigrokdecode libtool 'current' version number. */
+#define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@
+
+/** The libsigrokdecode libtool 'revision' version number. */
+#define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@
+
+/** The libsigrokdecode libtool 'age' version number. */
+#define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@
+
+/** The libsigrokdecode libtool version ("current:revision:age") as string. */
+#define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@"
+
+/*
+ * Status/error codes returned by libsigrokdecode functions.
+ *
+ * All possible return codes of libsigrokdecode functions must be listed here.
+ * Functions should never return hardcoded numbers as status, but rather
+ * use these #defines instead. All error codes are negative numbers.
+ *
+ * The error codes are globally unique in libsigrokdecode, i.e. if one of the
+ * libsigrokdecode functions returns a "malloc error" it must be exactly the
+ * same return value as used by all other functions to indicate "malloc error".
+ * There must be no functions which indicate two different errors via the
+ * same return code.
+ *
+ * Also, for compatibility reasons, no defined return codes are ever removed
+ * or reused for different #defines later. You can only add new #defines and
+ * return codes, but never remove or redefine existing ones.
+ */
+#define SRD_OK                 0 /**< No error */
+#define SRD_ERR               -1 /**< Generic/unspecified error */
+#define SRD_ERR_MALLOC        -2 /**< Malloc/calloc/realloc error */
+#define SRD_ERR_ARG           -3 /**< Function argument error */
+#define SRD_ERR_BUG           -4 /**< Errors hinting at internal bugs */
+#define SRD_ERR_PYTHON        -5 /**< Python C API error */
+#define SRD_ERR_DECODERS_DIR  -6 /**< Protocol decoder path invalid */
+
+/* libsigrokdecode loglevels. */
+#define SRD_LOG_NONE   0 /**< Output no messages at all. */
+#define SRD_LOG_ERR    1 /**< Output error messages. */
+#define SRD_LOG_WARN   2 /**< Output warnings. */
+#define SRD_LOG_INFO   3 /**< Output informational messages. */
+#define SRD_LOG_DBG    4 /**< Output debug messages. */
+#define SRD_LOG_SPEW   5 /**< Output very noisy debug messages. */
+
+/*
+ * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
+ *
+ * Variables and functions marked 'static' are private already and don't
+ * need SRD_PRIV. However, functions which are not static (because they need
+ * to be used in other libsigrokdecode-internal files) but are also not
+ * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
+ *
+ * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
+ *
+ * This feature is not available on MinGW/Windows, as it is a feature of
+ * ELF files and MinGW/Windows uses PE files.
+ *
+ * Details: http://gcc.gnu.org/wiki/Visibility
+ */
+
+/* Marks public libsigrokdecode API symbols. */
+#ifndef _WIN32
+#define SRD_API __attribute__((visibility("default")))
+#else
+#define SRD_API
+#endif
+
+/* Marks private, non-public libsigrokdecode symbols (not part of the API). */
+#ifndef _WIN32
+#define SRD_PRIV __attribute__((visibility("hidden")))
+#else
+#define SRD_PRIV
+#endif
+
+/*
+ * When adding an output type, don't forget to...
+ *   - expose it to PDs in controller.c:PyInit_sigrokdecode()
+ *   - add a check in module_sigrokdecode.c:Decoder_put()
+ *   - add a debug string in type_decoder.c:OUTPUT_TYPES
+ */
+enum {
+       SRD_OUTPUT_ANN,
+       SRD_OUTPUT_PROTO,
+       SRD_OUTPUT_BINARY,
+};
+
+#define SRD_MAX_NUM_PROBES 64
+
+struct srd_decoder {
+       /** The decoder ID. Must be non-NULL and unique for all decoders. */
+       char *id;
+
+       /** The (short) decoder name. Must be non-NULL. */
+       char *name;
+
+       /** The (long) decoder name. Must be non-NULL. */
+       char *longname;
+
+       /** A (short, one-line) description of the decoder. Must be non-NULL. */
+       char *desc;
+
+       /**
+        * The license of the decoder. Valid values: "gplv2+", "gplv3+".
+        * Other values are currently not allowed. Must be non-NULL.
+        */
+       char *license;
+
+       /** List of probes required by this decoder. */
+       GSList *probes;
+
+       /** List of optional probes for this decoder. */
+       GSList *opt_probes;
+
+       /**
+        * List of NULL-terminated char[], containing descriptions of the
+        * supported annotation output.
+        */
+       GSList *annotations;
+
+       /** List of decoder options.  */
+       GSList *options;
+
+       /** Python module. */
+       PyObject *py_mod;
+
+       /** sigrokdecode.Decoder class. */
+       PyObject *py_dec;
+};
+
+/**
+ * Structure which contains information about one protocol decoder probe.
+ * For example, I2C has two probes, SDA and SCL.
+ */
+struct srd_probe {
+       /** The ID of the probe. Must be non-NULL. */
+       char *id;
+       /** The name of the probe. Must not be NULL. */
+       char *name;
+       /** The description of the probe. Must not be NULL. */
+       char *desc;
+       /** The index of the probe, i.e. its order in the list of probes. */
+       int order;
+};
+
+struct srd_decoder_option {
+       char *id;
+       char *desc;
+       GVariant *def;
+};
+
+struct srd_decoder_inst {
+       struct srd_decoder *decoder;
+       PyObject *py_inst;
+       char *inst_id;
+       GSList *pd_output;
+       int dec_num_probes;
+       int *dec_probemap;
+       int data_num_probes;
+       int data_unitsize;
+       uint64_t data_samplerate;
+       GSList *next_di;
+};
+
+struct srd_pd_output {
+       int pdo_id;
+       int output_type;
+       struct srd_decoder_inst *di;
+       char *proto_id;
+};
+
+struct srd_proto_data {
+       uint64_t start_sample;
+       uint64_t end_sample;
+       struct srd_pd_output *pdo;
+       int ann_format;
+       void *data;
+};
+
+typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
+                                        void *cb_data);
+
+struct srd_pd_callback {
+       int output_type;
+       srd_pd_output_callback_t cb;
+       void *cb_data;
+};
+
+/* Custom Python types: */
+
+typedef struct {
+       PyObject_HEAD
+} srd_Decoder;
+
+typedef struct {
+       PyObject_HEAD
+       struct srd_decoder_inst *di;
+       uint64_t start_samplenum;
+       unsigned int itercnt;
+       uint8_t *inbuf;
+       uint64_t inbuflen;
+       PyObject *sample;
+} srd_logic;
+
+/*--- controller.c ----------------------------------------------------------*/
+
+SRD_API int srd_init(const char *path);
+SRD_API int srd_exit(void);
+SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
+               GHashTable *options);
+SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
+               GHashTable *probes);
+SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
+               GHashTable *options);
+SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
+               struct srd_decoder_inst *di_to);
+SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id);
+SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
+SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
+               uint64_t inbuflen);
+SRD_API int srd_pd_output_callback_add(int output_type,
+               srd_pd_output_callback_t cb, void *cb_data);
+
+/*--- decoder.c -------------------------------------------------------------*/
+
+SRD_API const GSList *srd_decoder_list(void);
+SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
+SRD_API int srd_decoder_load(const char *name);
+SRD_API int srd_decoder_unload(struct srd_decoder *dec);
+SRD_API int srd_decoder_load_all(void);
+SRD_API int srd_decoder_unload_all(void);
+SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
+
+/*--- log.c -----------------------------------------------------------------*/
+
+typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
+                                 const char *format, va_list args);
+
+SRD_API int srd_log_loglevel_set(int loglevel);
+SRD_API int srd_log_loglevel_get(void);
+SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
+SRD_API int srd_log_callback_set_default(void);
+SRD_API int srd_log_logdomain_set(const char *logdomain);
+SRD_API char *srd_log_logdomain_get(void);
+
+/*--- version.c -------------------------------------------------------------*/
+
+SRD_API int srd_package_version_major_get(void);
+SRD_API int srd_package_version_minor_get(void);
+SRD_API int srd_package_version_micro_get(void);
+SRD_API const char *srd_package_version_string_get(void);
+
+SRD_API int srd_lib_version_current_get(void);
+SRD_API int srd_lib_version_revision_get(void);
+SRD_API int srd_lib_version_age_get(void);
+SRD_API const char *srd_lib_version_string_get(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/log.c b/log.c
index 49a18eb8eb925ec7f6b4b65a6b980ea860f8ff81..36dcd95958e83d98010b7197fee39e12247f3978 100644 (file)
--- a/log.c
+++ b/log.c
@@ -18,8 +18,8 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode-internal.h"
 #include <stdarg.h>
 #include <stdio.h>
 
index 557ad1ac8aa4d770d2e33164e08f744c7e91b158..f88a6e97de654ca9a3f3c9f08bca0c99d74af1be 100644 (file)
@@ -17,8 +17,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode-internal.h"
 #include "config.h"
 
 /** @cond PRIVATE */
diff --git a/sigrokdecode-internal.h b/sigrokdecode-internal.h
deleted file mode 100644 (file)
index b969356..0000000
+++ /dev/null
@@ -1,67 +0,0 @@
-/*
- * This file is part of the libsigrokdecode project.
- *
- * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
- * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * 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
- */
-
-#ifndef LIBSIGROKDECODE_SIGROKDECODE_INTERNAL_H
-#define LIBSIGROKDECODE_SIGROKDECODE_INTERNAL_H
-
-#include "sigrokdecode.h"
-
-/*--- controller.c ----------------------------------------------------------*/
-
-SRD_PRIV int srd_decoder_searchpath_add(const char *path);
-SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args);
-SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
-                            const struct srd_decoder_inst *dec,
-                            const uint8_t *inbuf, uint64_t inbuflen);
-SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
-SRD_PRIV void srd_inst_free_all(GSList *stack);
-SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
-                                   int output_type, const char *output_id);
-
-/*--- decoder.c -------------------------------------------------------------*/
-
-SRD_PRIV void *srd_pd_output_callback_find(int output_type);
-
-/*--- exception.c -----------------------------------------------------------*/
-
-SRD_PRIV void srd_exception_catch(const char *format, ...);
-
-/*--- 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, ...);
-
-/*--- 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_strlist_to_char(const PyObject *py_strlist, char ***outstr);
-SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
-                                                      const PyObject *obj);
-
-#endif
diff --git a/sigrokdecode.h.in b/sigrokdecode.h.in
deleted file mode 100644 (file)
index 7aac0ba..0000000
+++ /dev/null
@@ -1,330 +0,0 @@
-/*
- * This file is part of the libsigrokdecode project.
- *
- * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
- * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * 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
- */
-
-#ifndef LIBSIGROKDECODE_SIGROKDECODE_H
-#define LIBSIGROKDECODE_SIGROKDECODE_H
-
-#include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include <stdint.h>
-#include <glib.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * @file
- *
- * The public libsigrokdecode header file to be used by frontends.
- *
- * This is the only file that libsigrokdecode users (frontends) are supposed
- * to use and include. There are other header files which get installed with
- * libsigrokdecode, but those are not meant to be used directly by frontends.
- *
- * The correct way to get/use the libsigrokdecode API functions is:
- *
- * @code{.c}
- *   #include <sigrokdecode.h>
- * @endcode
- */
-
-/*
- * Package version macros (can be used for conditional compilation).
- */
-
-/** The libsigrokdecode package 'major' version number. */
-#define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@
-
-/** The libsigrokdecode package 'minor' version number. */
-#define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@
-
-/** The libsigrokdecode package 'micro' version number. */
-#define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@
-
-/** The libsigrokdecode package version ("major.minor.micro") as string. */
-#define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@"
-
-/*
- * Library/libtool version macros (can be used for conditional compilation).
- */
-
-/** The libsigrokdecode libtool 'current' version number. */
-#define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@
-
-/** The libsigrokdecode libtool 'revision' version number. */
-#define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@
-
-/** The libsigrokdecode libtool 'age' version number. */
-#define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@
-
-/** The libsigrokdecode libtool version ("current:revision:age") as string. */
-#define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@"
-
-/*
- * Status/error codes returned by libsigrokdecode functions.
- *
- * All possible return codes of libsigrokdecode functions must be listed here.
- * Functions should never return hardcoded numbers as status, but rather
- * use these #defines instead. All error codes are negative numbers.
- *
- * The error codes are globally unique in libsigrokdecode, i.e. if one of the
- * libsigrokdecode functions returns a "malloc error" it must be exactly the
- * same return value as used by all other functions to indicate "malloc error".
- * There must be no functions which indicate two different errors via the
- * same return code.
- *
- * Also, for compatibility reasons, no defined return codes are ever removed
- * or reused for different #defines later. You can only add new #defines and
- * return codes, but never remove or redefine existing ones.
- */
-#define SRD_OK                 0 /**< No error */
-#define SRD_ERR               -1 /**< Generic/unspecified error */
-#define SRD_ERR_MALLOC        -2 /**< Malloc/calloc/realloc error */
-#define SRD_ERR_ARG           -3 /**< Function argument error */
-#define SRD_ERR_BUG           -4 /**< Errors hinting at internal bugs */
-#define SRD_ERR_PYTHON        -5 /**< Python C API error */
-#define SRD_ERR_DECODERS_DIR  -6 /**< Protocol decoder path invalid */
-
-/* libsigrokdecode loglevels. */
-#define SRD_LOG_NONE   0 /**< Output no messages at all. */
-#define SRD_LOG_ERR    1 /**< Output error messages. */
-#define SRD_LOG_WARN   2 /**< Output warnings. */
-#define SRD_LOG_INFO   3 /**< Output informational messages. */
-#define SRD_LOG_DBG    4 /**< Output debug messages. */
-#define SRD_LOG_SPEW   5 /**< Output very noisy debug messages. */
-
-/*
- * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
- *
- * Variables and functions marked 'static' are private already and don't
- * need SRD_PRIV. However, functions which are not static (because they need
- * to be used in other libsigrokdecode-internal files) but are also not
- * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
- *
- * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
- *
- * This feature is not available on MinGW/Windows, as it is a feature of
- * ELF files and MinGW/Windows uses PE files.
- *
- * Details: http://gcc.gnu.org/wiki/Visibility
- */
-
-/* Marks public libsigrokdecode API symbols. */
-#ifndef _WIN32
-#define SRD_API __attribute__((visibility("default")))
-#else
-#define SRD_API
-#endif
-
-/* Marks private, non-public libsigrokdecode symbols (not part of the API). */
-#ifndef _WIN32
-#define SRD_PRIV __attribute__((visibility("hidden")))
-#else
-#define SRD_PRIV
-#endif
-
-/*
- * When adding an output type, don't forget to...
- *   - expose it to PDs in controller.c:PyInit_sigrokdecode()
- *   - add a check in module_sigrokdecode.c:Decoder_put()
- *   - add a debug string in type_decoder.c:OUTPUT_TYPES
- */
-enum {
-       SRD_OUTPUT_ANN,
-       SRD_OUTPUT_PROTO,
-       SRD_OUTPUT_BINARY,
-};
-
-#define SRD_MAX_NUM_PROBES 64
-
-struct srd_decoder {
-       /** The decoder ID. Must be non-NULL and unique for all decoders. */
-       char *id;
-
-       /** The (short) decoder name. Must be non-NULL. */
-       char *name;
-
-       /** The (long) decoder name. Must be non-NULL. */
-       char *longname;
-
-       /** A (short, one-line) description of the decoder. Must be non-NULL. */
-       char *desc;
-
-       /**
-        * The license of the decoder. Valid values: "gplv2+", "gplv3+".
-        * Other values are currently not allowed. Must be non-NULL.
-        */
-       char *license;
-
-       /** List of probes required by this decoder. */
-       GSList *probes;
-
-       /** List of optional probes for this decoder. */
-       GSList *opt_probes;
-
-       /**
-        * List of NULL-terminated char[], containing descriptions of the
-        * supported annotation output.
-        */
-       GSList *annotations;
-
-       /** List of decoder options.  */
-       GSList *options;
-
-       /** Python module. */
-       PyObject *py_mod;
-
-       /** sigrokdecode.Decoder class. */
-       PyObject *py_dec;
-};
-
-/**
- * Structure which contains information about one protocol decoder probe.
- * For example, I2C has two probes, SDA and SCL.
- */
-struct srd_probe {
-       /** The ID of the probe. Must be non-NULL. */
-       char *id;
-       /** The name of the probe. Must not be NULL. */
-       char *name;
-       /** The description of the probe. Must not be NULL. */
-       char *desc;
-       /** The index of the probe, i.e. its order in the list of probes. */
-       int order;
-};
-
-struct srd_decoder_option {
-       char *id;
-       char *desc;
-       GVariant *def;
-};
-
-struct srd_decoder_inst {
-       struct srd_decoder *decoder;
-       PyObject *py_inst;
-       char *inst_id;
-       GSList *pd_output;
-       int dec_num_probes;
-       int *dec_probemap;
-       int data_num_probes;
-       int data_unitsize;
-       uint64_t data_samplerate;
-       GSList *next_di;
-};
-
-struct srd_pd_output {
-       int pdo_id;
-       int output_type;
-       struct srd_decoder_inst *di;
-       char *proto_id;
-};
-
-struct srd_proto_data {
-       uint64_t start_sample;
-       uint64_t end_sample;
-       struct srd_pd_output *pdo;
-       int ann_format;
-       void *data;
-};
-
-typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
-                                        void *cb_data);
-
-struct srd_pd_callback {
-       int output_type;
-       srd_pd_output_callback_t cb;
-       void *cb_data;
-};
-
-/* Custom Python types: */
-
-typedef struct {
-       PyObject_HEAD
-} srd_Decoder;
-
-typedef struct {
-       PyObject_HEAD
-       struct srd_decoder_inst *di;
-       uint64_t start_samplenum;
-       unsigned int itercnt;
-       uint8_t *inbuf;
-       uint64_t inbuflen;
-       PyObject *sample;
-} srd_logic;
-
-/*--- controller.c ----------------------------------------------------------*/
-
-SRD_API int srd_init(const char *path);
-SRD_API int srd_exit(void);
-SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
-               GHashTable *options);
-SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
-               GHashTable *probes);
-SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
-               GHashTable *options);
-SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
-               struct srd_decoder_inst *di_to);
-SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id);
-SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
-SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
-               uint64_t inbuflen);
-SRD_API int srd_pd_output_callback_add(int output_type,
-               srd_pd_output_callback_t cb, void *cb_data);
-
-/*--- decoder.c -------------------------------------------------------------*/
-
-SRD_API const GSList *srd_decoder_list(void);
-SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
-SRD_API int srd_decoder_load(const char *name);
-SRD_API int srd_decoder_unload(struct srd_decoder *dec);
-SRD_API int srd_decoder_load_all(void);
-SRD_API int srd_decoder_unload_all(void);
-SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
-
-/*--- log.c -----------------------------------------------------------------*/
-
-typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
-                                 const char *format, va_list args);
-
-SRD_API int srd_log_loglevel_set(int loglevel);
-SRD_API int srd_log_loglevel_get(void);
-SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
-SRD_API int srd_log_callback_set_default(void);
-SRD_API int srd_log_logdomain_set(const char *logdomain);
-SRD_API char *srd_log_logdomain_get(void);
-
-/*--- version.c -------------------------------------------------------------*/
-
-SRD_API int srd_package_version_major_get(void);
-SRD_API int srd_package_version_minor_get(void);
-SRD_API int srd_package_version_micro_get(void);
-SRD_API const char *srd_package_version_string_get(void);
-
-SRD_API int srd_lib_version_current_get(void);
-SRD_API int srd_lib_version_revision_get(void);
-SRD_API int srd_lib_version_age_get(void);
-SRD_API const char *srd_lib_version_string_get(void);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif
index 1de3b0ed12de262c0d00446f13c2cd6c01293ba4..16675bcb9f0a136560d15c1cb70ddba91a5e3daf 100644 (file)
@@ -17,8 +17,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode-internal.h"
 #include "config.h"
 #include <inttypes.h>
 
index 6f266aa11110e0f39133f43c72c050530e0c6e53..9f2b39277570c7a920cb87b933b04888fefb5f0a 100644 (file)
@@ -17,7 +17,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
 #include "config.h"
 #include <inttypes.h>
 #include <string.h>
diff --git a/util.c b/util.c
index aec73facbf99f780be1704702d8de01fb59d21d3..74d56c39aff6bda94e9f2ca228586b97b055a5af 100644 (file)
--- a/util.c
+++ b/util.c
@@ -18,8 +18,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode-internal.h"
 #include "config.h"
 
 /**
index 9449c2d6b30d6531f504ca99bac62440635b3232..8fbbafae1592021f9a9d24838ac2718814a49a38 100644 (file)
--- a/version.c
+++ b/version.c
@@ -18,7 +18,7 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#include "sigrokdecode.h"
+#include "libsigrokdecode.h"
 
 /**
  * @file