2 * Definitions for file structures and routines
4 * $Id: file.h,v 1.73 2000/08/03 12:44:20 gram Exp $
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@zing.org>
8 * Copyright 1998 Gerald Combs
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 #ifdef HAVE_SYS_TYPES_H
30 #include <sys/types.h>
34 #include "wiretap/wtap.h"
48 #include "gtk/colors.h" /* XXX */
60 #define file_open gzopen
61 #define filed_open gzdopen
62 #define file_close gzclose
65 #define file_open fopen
66 #define filed_open fdopen
67 #define file_close fclose
68 #endif /* HAVE_LIBZ */
70 typedef struct bpf_program bpf_prog;
72 /* Current state of file. */
74 FILE_CLOSED, /* No file open */
75 FILE_READ_IN_PROGRESS, /* Reading a file we've opened */
76 FILE_READ_ABORTED, /* Read aborted by user */
77 FILE_READ_DONE /* Read completed */
80 typedef struct _capture_file {
81 file_state state; /* Current state of capture file */
82 int filed; /* File descriptor of capture file */
83 gchar *filename; /* Name of capture file */
84 gboolean is_tempfile; /* Is capture file a temporary file? */
85 gboolean user_saved;/* If capture file is temporary, has it been saved by user yet? */
86 long f_len; /* Length of capture file */
87 guint16 cd_t; /* File type of capture file */
88 int lnk_t; /* Link-layer type with which to save capture */
89 guint32 vers; /* Version. For tcpdump minor is appended to major */
90 guint32 count; /* Packet count */
91 guint32 drops; /* Dropped packets */
92 guint32 esec; /* Elapsed seconds */
93 guint32 eusec; /* Elapsed microseconds */
94 guint32 snap; /* Captured packet length */
95 long progbar_quantum; /* Number of bytes read per progress bar update */
96 long progbar_nextstep; /* Next point at which to update progress bar */
97 gchar *iface; /* Interface */
98 gchar *save_file; /* File that user saved capture to */
99 int save_file_fd; /* File descriptor for saved file */
100 wtap *wth; /* Wiretap session */
101 dfilter *rfcode; /* Compiled read filter program */
102 gchar *dfilter; /* Display filter string */
103 colfilter *colors; /* Colors for colorizing packet window */
104 dfilter *dfcode; /* Compiled display filter program */
106 gchar *cfilter; /* Capture filter string */
107 bpf_prog fcode; /* Compiled capture filter program */
109 gchar *sfilter; /* Search filter string */
110 gboolean sbackward; /* TRUE if search is backward, FALSE if forward */
111 union wtap_pseudo_header pseudo_header; /* Packet pseudo_header */
112 guint8 pd[WTAP_MAX_PACKET_SIZE]; /* Packet data */
113 GMemChunk *plist_chunk; /* Memory chunk for frame_data structures */
114 frame_data *plist; /* Packet list */
115 frame_data *plist_end; /* Last packet in list */
116 frame_data *first_displayed; /* First frame displayed */
117 frame_data *last_displayed; /* Last frame displayed */
118 column_info cinfo; /* Column formatting information */
119 frame_data *current_frame; /* Frame data for current frame */
120 proto_tree *protocol_tree; /* Protocol tree for currently selected packet */
121 FILE *print_fh; /* File we're printing to */
124 /* Return values from "read_cap_file()", "continue_tail_cap_file()",
125 and "finish_tail_cap_file()". */
127 READ_SUCCESS, /* read succeeded */
128 READ_ERROR, /* read got an error */
129 READ_ABORTED /* read aborted by user */
132 int open_cap_file(char *, gboolean, capture_file *);
133 void close_cap_file(capture_file *, void *);
134 read_status_t read_cap_file(capture_file *, int *);
135 int start_tail_cap_file(char *, gboolean, capture_file *);
136 read_status_t continue_tail_cap_file(capture_file *, int, int *);
137 read_status_t finish_tail_cap_file(capture_file *, int *);
138 /* size_t read_frame_header(capture_file *); */
139 int save_cap_file(char *, capture_file *, gboolean, guint);
141 int filter_packets(capture_file *cf, gchar *dfilter);
142 void colorize_packets(capture_file *);
143 void redissect_packets(capture_file *cf);
144 int print_packets(capture_file *cf, print_args_t *print_args);
145 void change_time_formats(capture_file *);
146 gboolean find_packet(capture_file *cf, dfilter *sfcode);
149 FOUND_FRAME, /* found the frame */
150 NO_SUCH_FRAME, /* no frame with that number */
151 FRAME_NOT_DISPLAYED /* frame with that number isn't displayed */
153 goto_result_t goto_frame(capture_file *cf, guint fnumber);
155 void select_packet(capture_file *, int);
156 void unselect_packet(capture_file *);
158 /* Moves or copies a file. Returns 0 on failure, 1 on success */
159 int file_mv(char *from, char *to);
161 /* Copies a file. Returns 0 on failure, 1 on success */
162 int file_cp(char *from, char *to);
164 char *file_open_error_message(int, gboolean);
165 char *file_read_error_message(int);
166 char *file_write_error_message(int);
168 gboolean copy_binary_file(char *from_filename, char *to_filename);