Revert "sq h2"
[metze/wireshark/wip.git] / cfile.h
diff --git a/cfile.h b/cfile.h
index 98949a088fd66b8e0a23f6bf573cd9c7c08cc9c3..3c9296ba43788dc4a0d498b5be9c53231057122f 100644 (file)
--- a/cfile.h
+++ b/cfile.h
@@ -5,19 +5,7 @@
  * By Gerald Combs <gerald@wireshark.org>
  * Copyright 1998 Gerald Combs
  *
- * 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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ * SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef __CFILE_H__
@@ -42,6 +30,13 @@ typedef enum {
   FILE_READ_DONE                /* Read completed */
 } file_state;
 
+/* Requested packets rescan action. */
+typedef enum {
+  RESCAN_NONE = 0,              /* No rescan requested */
+  RESCAN_SCAN,                  /* Request rescan without full redissection. */
+  RESCAN_REDISSECT              /* Request full redissection. */
+} rescan_type;
+
 /* Character set for text search. */
 typedef enum {
   SCS_NARROW_AND_WIDE,
@@ -55,88 +50,88 @@ typedef enum {
   SD_BACKWARD
 } search_direction;
 
-#ifdef WANT_PACKET_EDITOR
-/* XXX, where this struct should go? */
-typedef struct {
-  struct wtap_pkthdr phdr; /**< Modified packet header */
-  char *pd;                /**< Modified packet data */
-} modified_frame_data;
-#endif
+/*
+ * Packet provider for programs using a capture file.
+ */
+struct packet_provider_data {
+  wtap        *wth;                  /* Wiretap session */
+  const frame_data *ref;
+  frame_data  *prev_dis;
+  frame_data  *prev_cap;
+  frame_data_sequence *frames;       /* Sequence of frames, if we're keeping that information */
+  GTree       *frames_user_comments; /* BST with user comments for frames (key = frame_data) */
+};
 
 typedef struct _capture_file {
-  epan_t      *epan;
-  file_state   state;           /* Current state of capture file */
-  gchar       *filename;        /* Name of capture file */
-  gchar       *source;          /* Temp file source, e.g. "Pipe from elsewhere" */
-  gboolean     is_tempfile;     /* Is capture file a temporary file? */
-  gboolean     unsaved_changes; /* Does the capture file have changes that have not been saved? */
-  gboolean     stop_flag;       /* Stop current processing (loading, searching, etc.) */
-
-  gint64       f_datalen;       /* Size of capture file data (uncompressed) */
-  guint16      cd_t;            /* File type of capture file */
-  unsigned int open_type;       /* open_routine index+1 used, if selected, or WTAP_TYPE_AUTO */
-  gboolean     iscompressed;    /* TRUE if the file is compressed */
-  int          lnk_t;           /* File link-layer type; could be WTAP_ENCAP_PER_PACKET */
-  GArray      *linktypes;       /* Array of packet link-layer types */
-  guint32      count;           /* Total number of frames */
-  guint64      packet_comment_count; /* Number of comments in frames (could be >1 per frame... */
-  guint32      displayed_count; /* Number of displayed frames */
-  guint32      marked_count;    /* Number of marked frames */
-  guint32      ignored_count;   /* Number of ignored frames */
-  guint32      ref_time_count;  /* Number of time referenced frames */
-  gboolean     drops_known;     /* TRUE if we know how many packets were dropped */
-  guint32      drops;           /* Dropped packets */
-  nstime_t     elapsed_time;    /* Elapsed time */
-  gboolean     has_snap;        /* TRUE if maximum capture packet length is known */
-  int          snap;            /* Maximum captured packet length */
-  wtap        *wth;             /* Wiretap session */
-  dfilter_t   *rfcode;          /* Compiled read filter program */
-  dfilter_t   *dfcode;          /* Compiled display filter program */
-  gchar       *dfilter;         /* Display filter string */
-  gboolean     redissecting;    /* TRUE if currently redissecting (cf_redissect_packets) */
+  epan_t                     *epan;
+  file_state                  state;                /* Current state of capture file */
+  gchar                      *filename;             /* Name of capture file */
+  gchar                      *source;               /* Temp file source, e.g. "Pipe from elsewhere" */
+  gboolean                    is_tempfile;          /* Is capture file a temporary file? */
+  gboolean                    unsaved_changes;      /* Does the capture file have changes that have not been saved? */
+  gboolean                    stop_flag;            /* Stop current processing (loading, searching, etc.) */
+
+  gint64                      f_datalen;            /* Size of capture file data (uncompressed) */
+  guint16                     cd_t;                 /* File type of capture file */
+  unsigned int                open_type;            /* open_routine index+1 used, if selected, or WTAP_TYPE_AUTO */
+  wtap_compression_type       compression_type;     /* Compression type of the file, or uncompressed */
+  int                         lnk_t;                /* File link-layer type; could be WTAP_ENCAP_PER_PACKET */
+  GArray                     *linktypes;            /* Array of packet link-layer types */
+  guint32                     count;                /* Total number of frames */
+  guint64                     packet_comment_count; /* Number of comments in frames (could be >1 per frame... */
+  guint32                     displayed_count;      /* Number of displayed frames */
+  guint32                     marked_count;         /* Number of marked frames */
+  guint32                     ignored_count;        /* Number of ignored frames */
+  guint32                     ref_time_count;       /* Number of time referenced frames */
+  gboolean                    drops_known;          /* TRUE if we know how many packets were dropped */
+  guint32                     drops;                /* Dropped packets */
+  nstime_t                    elapsed_time;         /* Elapsed time */
+  int                         snap;                 /* Maximum captured packet length; 0 if unknown */
+  dfilter_t                  *rfcode;               /* Compiled read filter program */
+  dfilter_t                  *dfcode;               /* Compiled display filter program */
+  gchar                      *dfilter;              /* Display filter string */
+  gboolean                    redissecting;         /* TRUE if currently redissecting (cf_redissect_packets) */
+  gboolean                    read_lock;            /* TRUE if currently processing a file (cf_read) */
+  rescan_type                 redissection_queued;  /* Queued redissection type. */
   /* search */
-  gchar       *sfilter;         /* Filter, hex value, or string being searched */
-  gboolean     hex;             /* TRUE if "Hex value" search was last selected */
-  gboolean     string;          /* TRUE if "String" search was last selected */
-  gboolean     summary_data;    /* TRUE if "String" search in "Packet list" (Info column) was last selected */
-  gboolean     decode_data;     /* TRUE if "String" search in "Packet details" was last selected */
-  gboolean     packet_data;     /* TRUE if "String" search in "Packet data" was last selected */
-  guint32      search_pos;      /* Byte position of last byte found in a hex search */
-  guint32      search_len;      /* Length of bytes matching the search */
-  gboolean     case_type;       /* TRUE if case-insensitive text search */
-  GRegex      *regex;           /* Set if regular expression search */
-  search_charset_t scs_type;    /* Character set for text search */
-  search_direction dir;         /* Direction in which to do searches */
-  gboolean     search_in_progress; /* TRUE if user just clicked OK in the Find dialog or hit <control>N/B */
+  gchar                      *sfilter;              /* Filter, hex value, or string being searched */
+  gboolean                    hex;                  /* TRUE if "Hex value" search was last selected */
+  gboolean                    string;               /* TRUE if "String" search was last selected */
+  gboolean                    summary_data;         /* TRUE if "String" search in "Packet list" (Info column) was last selected */
+  gboolean                    decode_data;          /* TRUE if "String" search in "Packet details" was last selected */
+  gboolean                    packet_data;          /* TRUE if "String" search in "Packet data" was last selected */
+  guint32                     search_pos;           /* Byte position of last byte found in a hex search */
+  guint32                     search_len;           /* Length of bytes matching the search */
+  gboolean                    case_type;            /* TRUE if case-insensitive text search */
+  GRegex                     *regex;                /* Set if regular expression search */
+  search_charset_t            scs_type;             /* Character set for text search */
+  search_direction            dir;                  /* Direction in which to do searches */
+  gboolean                    search_in_progress;   /* TRUE if user just clicked OK in the Find dialog or hit <control>N/B */
   /* packet data */
-  struct wtap_pkthdr phdr;                /* Packet header */
-  Buffer       buf;             /* Packet data */
+  wtap_rec                    rec;                  /* Record header */
+  Buffer                      buf;                  /* Record data */
+  /* packet provider */
+  struct packet_provider_data provider;
   /* frames */
-  frame_data_sequence *frames;  /* Sequence of frames, if we're keeping that information */
-  guint32      first_displayed; /* Frame number of first frame displayed */
-  guint32      last_displayed;  /* Frame number of last frame displayed */
-  column_info  cinfo;           /* Column formatting information */
-  gboolean     columns_changed; /**< Have the columns been changed in the prefs? (GTK+ only) */
-  frame_data  *current_frame;   /* Frame data for current frame */
-  gint         current_row;     /* Row number for current frame */
-  epan_dissect_t *edt;          /* Protocol dissection for currently selected packet */
-  field_info  *finfo_selected;  /* Field info for currently selected field */
-#ifdef WANT_PACKET_EDITOR
-  GTree       *edited_frames;   /* BST with modified frames */
-#endif
-  gpointer     window;          /* Top-level window associated with file */
-  GTree       *frames_user_comments;   /* BST with user comments for frames (key = frame_data) */
-  gulong       computed_elapsed;
-
-  guint32      cum_bytes;
-  const frame_data *ref;
-  frame_data  *prev_dis;
-  frame_data  *prev_cap;
+  guint32                     first_displayed;      /* Frame number of first frame displayed */
+  guint32                     last_displayed;       /* Frame number of last frame displayed */
+  column_info                 cinfo;                /* Column formatting information */
+  frame_data                 *current_frame;        /* Frame data for current frame */
+  gint                        current_row;          /* Row number for current frame */
+  epan_dissect_t             *edt;                  /* Protocol dissection for currently selected packet */
+  field_info                 *finfo_selected;       /* Field info for currently selected field */
+  gpointer                    window;               /* Top-level window associated with file */
+  gulong                      computed_elapsed;     /* Elapsed time to load the file (in msec). */
+
+  guint32                     cum_bytes;
 } capture_file;
 
 extern void cap_file_init(capture_file *cf);
 
-extern const char *cap_file_get_interface_name(void *data, guint32 interface_id);
+const char *cap_file_provider_get_interface_name(struct packet_provider_data *prov, guint32 interface_id);
+const char *cap_file_provider_get_interface_description(struct packet_provider_data *prov, guint32 interface_id);
+const char *cap_file_provider_get_user_comment(struct packet_provider_data *prov, const frame_data *fd);
+void cap_file_provider_set_user_comment(struct packet_provider_data *prov, frame_data *fd, const char *new_comment);
 
 #ifdef __cplusplus
 }