resource: New internal API for accessing resource files

[libsigrok.git] / src / libsigrok-internal.h

diff --git a/src/libsigrok-internal.h b/src/libsigrok-internal.h
index fc436014fb6f13a3807773387c0b5f0a70c16950..32f49197c128bd038539686dcdd76d6e46d078e7 100644 (file)
--- a/src/libsigrok-internal.h
+++ b/src/libsigrok-internal.h
@@ -25,8 +25,8 @@
 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
 
 #include <stdarg.h>
+#include <stdio.h>
 #include <glib.h>
-#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
 #ifdef HAVE_LIBUSB_1_0
 #include <libusb.h>
 #endif
@@ -34,6 +34,9 @@
 #include <libserialport.h>
 #endif
 
+struct zip;
+struct zip_stat;
+
 /**
  * @file
  *
@@ -206,6 +209,10 @@ struct sr_context {
 #ifdef HAVE_LIBUSB_1_0
        libusb_context *libusb_ctx;
 #endif
+       sr_resource_open_callback resource_open_cb;
+       sr_resource_close_callback resource_close_cb;
+       sr_resource_read_callback resource_read_cb;
+       void *resource_cb_data;
 };
 
 /** Input module metadata keys. */
@@ -564,9 +571,6 @@ struct sr_usb_dev_inst {
 #endif
 
 #ifdef HAVE_LIBSERIALPORT
-#define SERIAL_PARITY_NONE SP_PARITY_NONE
-#define SERIAL_PARITY_EVEN SP_PARITY_EVEN
-#define SERIAL_PARITY_ODD  SP_PARITY_ODD
 struct sr_serial_dev_inst {
        /** Port name, e.g. '/dev/tty42'. */
        char *port;
@@ -574,10 +578,6 @@ struct sr_serial_dev_inst {
        char *serialcomm;
        /** libserialport port handle */
        struct sp_port *data;
-       /** libserialport event set */
-       struct sp_event_set *event_set;
-       /** GPollFDs for event polling */
-       GPollFD *pollfds;
 };
 #endif
 
@@ -593,24 +593,29 @@ struct drv_context {
        GSList *instances;
 };
 
+/*--- input/input.c ---------------------------------------------------------*/
+
+SR_PRIV int64_t sr_file_get_size(FILE *file);
+
 /*--- log.c -----------------------------------------------------------------*/
 
-SR_PRIV int sr_log(int loglevel, const char *format, ...);
-SR_PRIV int sr_spew(const char *format, ...);
-SR_PRIV int sr_dbg(const char *format, ...);
-SR_PRIV int sr_info(const char *format, ...);
-SR_PRIV int sr_warn(const char *format, ...);
-SR_PRIV int sr_err(const char *format, ...);
+#if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
+/*
+ * On MinGW, we need to specify the gnu_printf format flavor or GCC
+ * will assume non-standard Microsoft printf syntax.
+ */
+SR_PRIV int sr_log(int loglevel, const char *format, ...)
+               __attribute__((__format__ (__gnu_printf__, 2, 3)));
+#else
+SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
+#endif
 
 /* Message logging helpers with subsystem-specific prefix string. */
-#ifndef NO_LOG_WRAPPERS
-#define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
-#define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
-#define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
-#define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
-#define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
-#define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
-#endif
+#define sr_spew(...)   sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
+#define sr_dbg(...)    sr_log(SR_LOG_DBG,  LOG_PREFIX ": " __VA_ARGS__)
+#define sr_info(...)   sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
+#define sr_warn(...)   sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
+#define sr_err(...)    sr_log(SR_LOG_ERR,  LOG_PREFIX ": " __VA_ARGS__)
 
 /*--- device.c --------------------------------------------------------------*/
 
@@ -685,15 +690,6 @@ SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
 SR_PRIV void sr_config_free(struct sr_config *src);
-SR_PRIV int sr_source_remove(int fd);
-SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
-SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
-SR_PRIV int sr_source_add(int fd, int events, int timeout,
-               sr_receive_data_callback cb, void *cb_data);
-SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
-               sr_receive_data_callback cb, void *cb_data);
-SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
-               sr_receive_data_callback cb, void *cb_data);
 
 /*--- session.c -------------------------------------------------------------*/
 
@@ -731,6 +727,9 @@ SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
                void *key);
 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
                void *key, GSource *source);
+SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
+               void *key, gintptr fd, int events, int timeout,
+               sr_receive_data_callback cb, void *cb_data);
 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
                const struct sr_datafeed_packet *packet);
 SR_PRIV int sr_sessionfile_check(const char *filename);
@@ -738,6 +737,11 @@ SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
                struct sr_datafeed_packet **copy);
 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
 
+/*--- session_file.c --------------------------------------------------------*/
+
+SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
+                       const struct zip_stat *entry);
+
 /*--- analog.c --------------------------------------------------------------*/
 
 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
@@ -765,6 +769,20 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
                std_dev_clear_callback clear_private);
 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
 
+/*--- resource.c ------------------------------------------------------------*/
+
+SR_PRIV int sr_resource_open(struct sr_context *ctx,
+               struct sr_resource *res, int type, const char *name)
+               G_GNUC_WARN_UNUSED_RESULT;
+SR_PRIV int sr_resource_close(struct sr_context *ctx,
+               struct sr_resource *res);
+SR_PRIV ssize_t sr_resource_read(struct sr_context *ctx,
+               const struct sr_resource *res, void *buf, size_t count)
+               G_GNUC_WARN_UNUSED_RESULT;
+SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
+               const char *name, size_t *size, size_t max_size)
+               G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
+
 /*--- strutil.c -------------------------------------------------------------*/
 
 SR_PRIV int sr_atol(const char *str, long *ret);