Set the svn:eol-style property on all text files to "native", so that
[obnox/wireshark/wip.git] / file.h
1 /* file.h
2  * Definitions for file structures and routines
3  *
4  * $Id$
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@ethereal.com>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 #ifndef __FILE_H__
26 #define __FILE_H__
27
28 #include "range.h"
29 #include "wiretap/wtap.h"
30 #include <epan/dfilter/dfilter.h>
31 #include "print.h"
32 #include <errno.h>
33 #include <epan/epan.h>
34
35 #include "cfile.h"
36
37 /* Return values from "cf_read()", "cf_continue_tail()", and
38    "cf_finish_tail()". */
39 typedef enum {
40         READ_SUCCESS,   /* read succeeded */
41         READ_ERROR,     /* read got an error */
42         READ_ABORTED    /* read aborted by user */
43 } read_status_t;
44
45 int  cf_open(char *, gboolean, capture_file *);
46 void cf_close(capture_file *);
47 read_status_t cf_read(capture_file *);
48 int  cf_start_tail(char *, gboolean, capture_file *);
49 read_status_t cf_continue_tail(capture_file *, int, int *);
50 read_status_t cf_finish_tail(capture_file *, int *);
51 /* size_t read_frame_header(capture_file *); */
52 gboolean cf_save(char *fname, capture_file * cf, packet_range_t *range, guint save_format);
53 gchar *cf_get_display_name(capture_file *);
54
55 gboolean filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
56 void reftime_packets(capture_file *);
57 void colorize_packets(capture_file *);
58 void redissect_packets(capture_file *cf);
59 int retap_packets(capture_file *cf);
60 typedef enum {
61         PP_OK,
62         PP_OPEN_ERROR,
63         PP_WRITE_ERROR
64 } pp_return_t;
65 pp_return_t print_packets(capture_file *cf, print_args_t *print_args);
66 pp_return_t write_pdml_packets(capture_file *cf, print_args_t *print_args);
67 pp_return_t write_psml_packets(capture_file *cf, print_args_t *print_args);
68
69 void change_time_formats(capture_file *);
70
71 gboolean find_packet_protocol_tree(capture_file *cf, const char *string);
72 gboolean find_packet_summary_line(capture_file *cf, const char *string);
73 gboolean find_packet_data(capture_file *cf, const guint8 *string,
74                           size_t string_size);
75 gboolean find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
76
77 guint8 get_int_value(char char_val);
78 gboolean find_ascii(capture_file *cf, char *ascii_text, gboolean ascii_search, char *ftype, gboolean case_type);
79 gboolean find_in_gtk_data(capture_file *cf, gpointer *data, char *ascii_text, gboolean case_type, gboolean search_type);
80 gboolean goto_frame(capture_file *cf, guint fnumber);
81 gboolean goto_bottom_frame(capture_file *cf);
82 gboolean goto_top_frame(capture_file *cf);
83
84
85 void select_packet(capture_file *, int);
86 void unselect_packet(capture_file *);
87
88 void unselect_field(capture_file *);
89
90 /*
91  * Mark a particular frame in a particular capture.
92  */
93 void mark_frame(capture_file *, frame_data *);
94
95 /*
96  * Unmark a particular frame in a particular capture.
97  */
98 void unmark_frame(capture_file *, frame_data *);
99
100 /* Moves or copies a file. Returns 0 on failure, 1 on success */
101 int file_mv(char *from, char *to);
102
103 /* Copies a file. Returns 0 on failure, 1 on success */
104 int file_cp(char *from, char *to);
105
106 char *cf_read_error_message(int, gchar *);
107
108 #endif /* file.h */