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