Constify a lot more items.

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

diff --git a/src/libsigrok-internal.h b/src/libsigrok-internal.h
index 8fb9006aaeedad61f8f33b6bda211a690321d54c..84ad295ef61de0ee1204e83c54299668cf6fe1b6 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. */
@@ -216,8 +223,6 @@ enum sr_input_meta_keys {
        SR_INPUT_META_FILESIZE = 0x02,
        /** The first 128 bytes of the file, provided as a GString. */
        SR_INPUT_META_HEADER = 0x04,
-       /** The file's MIME type. */
-       SR_INPUT_META_MIMETYPE = 0x08,
 
        /** The module cannot identify a file without this metadata. */
        SR_INPUT_META_REQUIRED = 0x80,
@@ -273,7 +278,6 @@ struct sr_input_module {
         *   SR_INPUT_META_FILENAME
         *   SR_INPUT_META_FILESIZE
         *   SR_INPUT_META_HEADER
-        *   SR_INPUT_META_MIMETYPE
         *
         * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
         * identify a stream without the given metadata.
@@ -284,7 +288,7 @@ struct sr_input_module {
         * Returns a NULL-terminated list of options this module can take.
         * Can be NULL, if the module has no options.
         */
-       struct sr_option *(*options) (void);
+       const struct sr_option *(*options) (void);
 
        /**
         * Check if this input module can load and parse the specified stream.
@@ -379,7 +383,7 @@ struct sr_output_module {
         * A unique ID for this output module, suitable for use in command-line
         * clients, [a-z0-9-]. Must not be NULL.
         */
-       char *id;
+       const char *id;
 
        /**
         * A unique name for this output module, suitable for use in GUI
@@ -393,7 +397,7 @@ struct sr_output_module {
         * This can be displayed by frontends, e.g. when selecting the output
         * module for saving a file.
         */
-       char *desc;
+       const char *desc;
 
        /**
         * A NULL terminated array of strings containing a list of file name
@@ -487,7 +491,7 @@ struct sr_transform_module {
         * A unique ID for this transform module, suitable for use in
         * command-line clients, [a-z0-9-]. Must not be NULL.
         */
-       char *id;
+       const char *id;
 
        /**
         * A unique name for this transform module, suitable for use in GUI
@@ -501,7 +505,7 @@ struct sr_transform_module {
         * This can be displayed by frontends, e.g. when selecting
         * which transform module(s) to add.
         */
-       char *desc;
+       const char *desc;
 
        /**
         * Returns a NULL-terminated list of options this transform module
@@ -564,9 +568,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;
@@ -682,15 +683,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 -------------------------------------------------------------*/
 
@@ -706,20 +698,24 @@ struct sr_session {
        GSList *transforms;
        struct sr_trigger *trigger;
 
-       /** Mutex protecting the main context pointer and ownership flag. */
+       /** Callback to invoke on session stop. */
+       sr_session_stopped_callback stopped_callback;
+       /** User data to be passed to the session stop callback. */
+       void *stopped_cb_data;
+
+       /** Mutex protecting the main context pointer. */
        GMutex main_mutex;
        /** Context of the session main loop. */
        GMainContext *main_context;
-       /** Whether we are using the thread's default context. */
-       gboolean main_context_is_default;
-
-       /** Whether the session has been started. */
-       gboolean running;
 
        /** Registered event sources for this session. */
        GHashTable *event_sources;
        /** Session main loop. */
        GMainLoop *main_loop;
+       /** ID of idle source for dispatching the session stop notification. */
+       unsigned int stop_check_id;
+       /** Whether the session has been started. */
+       gboolean running;
 };
 
 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
@@ -731,6 +727,21 @@ SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
 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_source_add(struct sr_session *session, int fd,
+               int events, int timeout, sr_receive_data_callback cb, void *cb_data);
+SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
+               GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
+               void *cb_data);
+SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
+               GIOChannel *channel, int events, int timeout,
+               sr_receive_data_callback cb, void *cb_data);
+SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
+SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
+               GPollFD *pollfd);
+SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
+               GIOChannel *channel);
+
 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,9 +749,20 @@ 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 --------------------------------------------------------*/
+
+#if !HAVE_ZIP_DISCARD
+/* Replace zip_discard() if not available. */
+#define zip_discard(zip) sr_zip_discard(zip)
+SR_PRIV void sr_zip_discard(struct zip *archive);
+#endif
+
+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,
+SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
                            struct sr_analog_encoding *encoding,
                            struct sr_analog_meaning *meaning,
                            struct sr_analog_spec *spec,
@@ -765,6 +787,22 @@ 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 int64_t sr_file_get_size(FILE *file);
+
+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);
@@ -843,10 +881,10 @@ SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
 
 #ifdef HAVE_LIBUSB_1_0
 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
-SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
-                                  const char *filename);
-SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
-                                 const char *filename);
+SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
+                                  const char *name);
+SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
+                                 int configuration, const char *name);
 #endif
 
 /*--- hardware/usb.c --------------------------------------------------------*/
@@ -940,25 +978,25 @@ struct es519xx_info {
 
 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
-               struct sr_datafeed_analog *analog, void *info);
+               struct sr_datafeed_analog_old *analog, void *info);
 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
-               float *floatval, struct sr_datafeed_analog *analog, void *info);
+               float *floatval, struct sr_datafeed_analog_old *analog, void *info);
 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
-               float *floatval, struct sr_datafeed_analog *analog, void *info);
+               float *floatval, struct sr_datafeed_analog_old *analog, void *info);
 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
-               float *floatval, struct sr_datafeed_analog *analog, void *info);
+               float *floatval, struct sr_datafeed_analog_old *analog, void *info);
 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
-               struct sr_datafeed_analog *analog, void *info);
+               struct sr_datafeed_analog_old *analog, void *info);
 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
-               struct sr_datafeed_analog *analog, void *info);
+               struct sr_datafeed_analog_old *analog, void *info);
 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
-               float *floatval, struct sr_datafeed_analog *analog, void *info);
+               float *floatval, struct sr_datafeed_analog_old *analog, void *info);
 
 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
 
@@ -975,8 +1013,8 @@ struct fs9922_info {
 
 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
-                           struct sr_datafeed_analog *analog, void *info);
-SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
+                           struct sr_datafeed_analog_old *analog, void *info);
+SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog_old *analog, void *info);
 
 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
 
@@ -991,12 +1029,12 @@ struct fs9721_info {
 
 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
-                           struct sr_datafeed_analog *analog, void *info);
-SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
-SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
-SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
-SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
-SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
+                           struct sr_datafeed_analog_old *analog, void *info);
+SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog_old *analog, void *info);
+SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog_old *analog, void *info);
+SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog_old *analog, void *info);
+SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog_old *analog, void *info);
+SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog_old *analog, void *info);
 
 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
 
@@ -1004,7 +1042,7 @@ SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
 
 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
-                            struct sr_datafeed_analog *analog, void *info);
+                            struct sr_datafeed_analog_old *analog, void *info);
 
 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
 
@@ -1023,7 +1061,7 @@ SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 #endif
 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
-                            struct sr_datafeed_analog *analog, void *info);
+                            struct sr_datafeed_analog_old *analog, void *info);
 
 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
 
@@ -1034,7 +1072,7 @@ struct rs9lcd_info { int dummy; };
 
 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
-                           struct sr_datafeed_analog *analog, void *info);
+                           struct sr_datafeed_analog_old *analog, void *info);
 
 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
 
@@ -1045,7 +1083,7 @@ struct bm25x_info { int dummy; };
 
 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
-                            struct sr_datafeed_analog *analog, void *info);
+                            struct sr_datafeed_analog_old *analog, void *info);
 
 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
 
@@ -1060,7 +1098,7 @@ struct ut71x_info {
 
 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
-               struct sr_datafeed_analog *analog, void *info);
+               struct sr_datafeed_analog_old *analog, void *info);
 
 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
 
@@ -1081,7 +1119,7 @@ struct vc870_info {
 
 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
-               struct sr_datafeed_analog *analog, void *info);
+               struct sr_datafeed_analog_old *analog, void *info);
 
 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
 
@@ -1113,7 +1151,7 @@ struct ut372_info {
 
 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
-               struct sr_datafeed_analog *analog, void *info);
+               struct sr_datafeed_analog_old *analog, void *info);
 
 /*--- hardware/scale/kern.c -------------------------------------------------*/
 
@@ -1126,6 +1164,6 @@ struct kern_info {
 
 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
-               struct sr_datafeed_analog *analog, void *info);
+               struct sr_datafeed_analog_old *analog, void *info);
 
 #endif