Put the structure of a capture_file back in cfile.h.
[metze/wireshark/wip.git] / cfile.h
1 /* cfile.h
2  * capture_file definition & GUI-independent manipulation
3  *
4  * Wireshark - Network traffic analyzer
5  * By Gerald Combs <gerald@wireshark.org>
6  * Copyright 1998 Gerald Combs
7  *
8  * SPDX-License-Identifier: GPL-2.0+
9  */
10
11 #ifndef __CFILE_H__
12 #define __CFILE_H__
13
14 #include <epan/epan.h>
15 #include <epan/column-info.h>
16 #include <epan/dfilter/dfilter.h>
17 #include <epan/frame_data.h>
18 #include <epan/frame_data_sequence.h>
19 #include <epan/frame_set.h>
20 #include <wiretap/wtap.h>
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif /* __cplusplus */
25
26 /* Current state of file. */
27 typedef enum {
28   FILE_CLOSED,                  /* No file open */
29   FILE_READ_IN_PROGRESS,        /* Reading a file we've opened */
30   FILE_READ_ABORTED,            /* Read aborted by user */
31   FILE_READ_DONE                /* Read completed */
32 } file_state;
33
34 /* Character set for text search. */
35 typedef enum {
36   SCS_NARROW_AND_WIDE,
37   SCS_NARROW,
38   SCS_WIDE
39   /* add EBCDIC when it's implemented */
40 } search_charset_t;
41
42 typedef enum {
43   SD_FORWARD,
44   SD_BACKWARD
45 } search_direction;
46
47 typedef struct _capture_file {
48   epan_t      *epan;
49   file_state   state;                /* Current state of capture file */
50   gchar       *filename;             /* Name of capture file */
51   gchar       *source;               /* Temp file source, e.g. "Pipe from elsewhere" */
52   gboolean     is_tempfile;          /* Is capture file a temporary file? */
53   gboolean     unsaved_changes;      /* Does the capture file have changes that have not been saved? */
54   gboolean     stop_flag;            /* Stop current processing (loading, searching, etc.) */
55
56   gint64       f_datalen;            /* Size of capture file data (uncompressed) */
57   guint16      cd_t;                 /* File type of capture file */
58   unsigned int open_type;            /* open_routine index+1 used, if selected, or WTAP_TYPE_AUTO */
59   gboolean     iscompressed;         /* TRUE if the file is compressed */
60   int          lnk_t;                /* File link-layer type; could be WTAP_ENCAP_PER_PACKET */
61   GArray      *linktypes;            /* Array of packet link-layer types */
62   guint32      count;                /* Total number of frames */
63   guint64      packet_comment_count; /* Number of comments in frames (could be >1 per frame... */
64   guint32      displayed_count;      /* Number of displayed frames */
65   guint32      marked_count;         /* Number of marked frames */
66   guint32      ignored_count;        /* Number of ignored frames */
67   guint32      ref_time_count;       /* Number of time referenced frames */
68   gboolean     drops_known;          /* TRUE if we know how many packets were dropped */
69   guint32      drops;                /* Dropped packets */
70   nstime_t     elapsed_time;         /* Elapsed time */
71   int          snap;                 /* Maximum captured packet length; 0 if unknown */
72   dfilter_t   *rfcode;               /* Compiled read filter program */
73   dfilter_t   *dfcode;               /* Compiled display filter program */
74   gchar       *dfilter;              /* Display filter string */
75   gboolean     redissecting;         /* TRUE if currently redissecting (cf_redissect_packets) */
76   /* search */
77   gchar       *sfilter;              /* Filter, hex value, or string being searched */
78   gboolean     hex;                  /* TRUE if "Hex value" search was last selected */
79   gboolean     string;               /* TRUE if "String" search was last selected */
80   gboolean     summary_data;         /* TRUE if "String" search in "Packet list" (Info column) was last selected */
81   gboolean     decode_data;          /* TRUE if "String" search in "Packet details" was last selected */
82   gboolean     packet_data;          /* TRUE if "String" search in "Packet data" was last selected */
83   guint32      search_pos;           /* Byte position of last byte found in a hex search */
84   guint32      search_len;           /* Length of bytes matching the search */
85   gboolean     case_type;            /* TRUE if case-insensitive text search */
86   GRegex      *regex;                /* Set if regular expression search */
87   search_charset_t scs_type;         /* Character set for text search */
88   search_direction dir;              /* Direction in which to do searches */
89   gboolean     search_in_progress;   /* TRUE if user just clicked OK in the Find dialog or hit <control>N/B */
90   /* packet data */
91   struct wtap_pkthdr phdr;           /* Packet header */
92   Buffer       buf;                  /* Packet data */
93   /* frames */
94   frame_set    frame_set_info;       /* fjfff */
95   guint32      first_displayed;      /* Frame number of first frame displayed */
96   guint32      last_displayed;       /* Frame number of last frame displayed */
97   column_info  cinfo;                /* Column formatting information */
98   gboolean     columns_changed;      /**< Have the columns been changed in the prefs? (GTK+ only) */
99   frame_data  *current_frame;        /* Frame data for current frame */
100   gint         current_row;          /* Row number for current frame */
101   epan_dissect_t *edt;               /* Protocol dissection for currently selected packet */
102   field_info  *finfo_selected;       /* Field info for currently selected field */
103   gpointer     window;               /* Top-level window associated with file */
104   gulong       computed_elapsed;     /* Elapsed time to load the file (in msec). */
105
106   guint32      cum_bytes;
107 } capture_file;
108
109 extern void cap_file_init(capture_file *cf);
110
111 #ifdef __cplusplus
112 }
113 #endif /* __cplusplus */
114
115 #endif /* cfile.h */
116
117 /*
118  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
119  *
120  * Local Variables:
121  * c-basic-offset: 2
122  * tab-width: 8
123  * indent-tabs-mode: nil
124  * End:
125  *
126  * vi: set shiftwidth=2 tabstop=8 expandtab:
127  * :indentSize=2:tabSize=8:noTabs=true:
128  */