/* file.h
* Definitions for file structures and routines
*
- * $Id$
- *
* Wireshark - Network traffic analyzer
* 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 __FILE_H__
#define __FILE_H__
-#include "wiretap/wtap.h"
-#include "print.h"
#include <errno.h>
-#include <epan/epan.h>
-#include "packet-range.h"
+#include <wiretap/wtap.h>
+#include <epan/epan.h>
+#include <epan/print.h>
+#include <ui/packet_range.h>
#ifdef __cplusplus
extern "C" {
/** Return values from functions that read capture files. */
typedef enum {
- CF_READ_OK, /**< operation succeeded */
+ CF_READ_OK, /**< operation succeeded */
CF_READ_ERROR, /**< operation got an error (function may provide err with details) */
CF_READ_ABORTED /**< operation aborted by user */
} cf_read_status_t;
/** Return values from functions that print sets of packets. */
typedef enum {
- CF_PRINT_OK, /**< print operation succeeded */
- CF_PRINT_OPEN_ERROR, /**< print operation failed while opening printer */
- CF_PRINT_WRITE_ERROR /**< print operation failed while writing to the printer */
+ CF_PRINT_OK, /**< print operation succeeded */
+ CF_PRINT_OPEN_ERROR, /**< print operation failed while opening printer */
+ CF_PRINT_WRITE_ERROR /**< print operation failed while writing to the printer */
} cf_print_status_t;
typedef enum {
cf_cb_file_reload_finished,
cf_cb_file_rescan_started,
cf_cb_file_rescan_finished,
+ cf_cb_file_retap_started,
+ cf_cb_file_retap_finished,
+ cf_cb_file_merge_started, /* Qt only */
+ cf_cb_file_merge_finished, /* Qt only */
cf_cb_file_fast_save_finished,
- cf_cb_packet_selected,
- cf_cb_packet_unselected,
- cf_cb_field_unselected,
cf_cb_file_save_started,
cf_cb_file_save_finished,
cf_cb_file_save_failed,
- cf_cb_file_save_stopped,
- cf_cb_file_export_specified_packets_started,
- cf_cb_file_export_specified_packets_finished,
- cf_cb_file_export_specified_packets_failed,
- cf_cb_file_export_specified_packets_stopped
+ cf_cb_file_save_stopped
} cf_cbs;
typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
field_info *finfo;
} match_data;
+/**
+ * Add a capture file event callback.
+ *
+ * @param func The function to be called for each event.
+ * The function will be passed three parameters: The event type (event),
+ * event-dependent data (data), and user-supplied data (user_data).
+ * Event-dependent data may be a capture_file pointer, character pointer,
+ * or NULL.
+ * @param user_data User-supplied data to pass to the callback. May be NULL.
+ */
+
extern void
cf_callback_add(cf_callback_t func, gpointer user_data);
+/**
+ * Remove a capture file event callback.
+ *
+ * @param func The function to be removed.
+ * @param user_data User-supplied data. Must be the same value supplied to cf_callback_add.
+ */
+
extern void
-cf_callback_remove(cf_callback_t func);
+cf_callback_remove(cf_callback_t func, gpointer user_data);
/**
* Open a capture file.
*
* @param cf the capture file to be opened
* @param fname the filename to be opened
+ * @param type WTAP_TYPE_AUTO for automatic or index to direct open routine
* @param is_tempfile is this a temporary file?
* @param err error code
* @return one of cf_status_t
*/
-cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
+cf_status_t cf_open(capture_file *cf, const char *fname, unsigned int type, gboolean is_tempfile, int *err);
/**
* Close a capture file.
* Read all packets of a capture file into the internal structures.
*
* @param cf the capture file to be read
- * @param from_save reread asked from cf_save_packets
+ * @param from_save reread asked from cf_save_records
* @return one of cf_read_status_t
*/
cf_read_status_t cf_read(capture_file *cf, gboolean from_save);
/**
- * Read the pseudo-header and raw data for a packet. It will pop
+ * Read the metadata and raw data for a record. It will pop
* up an alert box if there's an error.
*
- * @param cf the capture file from which to read the packet
- * @param fdata the frame_data structure for the packet in question
- * @param phdr pointer to a wtap_pkthdr structure to contain the
- * packet's pseudo-header and other metadata
- * @param buf a Buffer into which to read the packet's raw data
+ * @param cf the capture file from which to read the record
+ * @param fdata the frame_data structure for the record in question
+ * @param rec pointer to a wtap_rec structure to contain the
+ * record's metadata
+ * @param buf a Buffer into which to read the record's raw data
* @return TRUE if the read succeeded, FALSE if there was an error
*/
-gboolean cf_read_frame_r(capture_file *cf, frame_data *fdata,
- struct wtap_pkthdr *phdr, Buffer *buf);
+gboolean cf_read_record_r(capture_file *cf, const frame_data *fdata,
+ wtap_rec *rec, Buffer *buf);
/**
- * Read the pseudo-header and raw data for a packet into a
- * capture_file structure's pseudo_header and buf members.
+ * Read the metadata and raw data for a record into a
+ * capture_file structure's phdr and buf members.
* It will pop up an alert box if there's an error.
*
- * @param cf the capture file from which to read the packet
- * @param fdata the frame_data structure for the packet in question
+ * @param cf the capture file from which to read the record
+ * @param fdata the frame_data structure for the record in question
* @return TRUE if the read succeeded, FALSE if there was an error
*/
-gboolean cf_read_frame(capture_file *cf, frame_data *fdata);
-
-/**
- * Start reading from the end of a capture file.
- * This is used in "Update list of packets in Real-Time".
- *
- * @param cf the capture file to be read from
- * @param fname the filename to be read from
- * @param is_tempfile is this a temporary file?
- * @param err the error code, if an error had occurred
- * @return one of cf_status_t
- */
-cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
+gboolean cf_read_record(capture_file *cf, frame_data *fdata);
/**
* Read packets from the "end" of a capture file.
* current capture file
* @return one of cf_write_status_t
*/
-cf_write_status_t cf_save_packets(capture_file * cf, const char *fname,
+cf_write_status_t cf_save_records(capture_file * cf, const char *fname,
guint save_format, gboolean compressed,
gboolean discard_comments,
gboolean dont_reopen);
*/
gchar *cf_get_display_name(capture_file *cf);
+/**
+ * Get a name that can be used to generate a file name from the
+ * capture file name. It's based on the displayable name, so it's
+ * UTF-8; if it ends with a suffix that's used by a file type libwiretap
+ * can read, we strip that suffix off.
+ *
+ * @param cf the capture file
+ * @return the base name (must be g_free'd)
+ */
+gchar *cf_get_basename(capture_file *cf);
+
/**
* Set the source of the capture data for temporary files, e.g.
* "Interface eth0" or "Pipe from Pong"
*/
int cf_get_packet_count(capture_file *cf);
-/**
- * Set the number of packets in the capture file.
- *
- * @param cf the capture file
- * @param packet_count the number of packets in the capture file
- */
-void cf_set_packet_count(capture_file *cf, int packet_count);
-
/**
* Is this capture file a temporary file?
*
void cf_reftime_packets(capture_file *cf);
/**
- * Return the time it took to load the file
+ * Return the time it took to load the file (in msec).
*/
-gulong cf_get_computed_elapsed(void);
+gulong cf_get_computed_elapsed(capture_file *cf);
/**
* "Something" has changed, rescan all packets.
*/
void cf_timestamp_auto_precision(capture_file *cf);
+/* print_range, enum which frames should be printed */
+typedef enum {
+ print_range_selected_only, /* selected frame(s) only (currently only one) */
+ print_range_marked_only, /* marked frames only */
+ print_range_all_displayed, /* all frames currently displayed */
+ print_range_all_captured /* all frames in capture */
+} print_range_e;
+
+typedef struct {
+ print_stream_t *stream; /* the stream to which we're printing */
+ print_format_e format; /* plain text or PostScript */
+ gboolean to_file; /* TRUE if we're printing to a file */
+ char *file; /* file output pathname */
+ char *cmd; /* print command string (not win32) */
+ packet_range_t range;
+
+ gboolean print_summary; /* TRUE if we should print summary line. */
+ gboolean print_col_headings; /* TRUE if we should print column headings */
+ print_dissections_e print_dissections;
+ gboolean print_hex; /* TRUE if we should print hex data;
+ * FALSE if we should print only if not dissected. */
+ gboolean print_formfeed; /* TRUE if a formfeed should be printed before
+ * each new packet */
+} print_args_t;
+
/**
* Print the capture file.
*
* @param cf the capture file
* @param print_args the arguments what and how to print
+ * @param show_progress_bar TRUE if a progress bar is to be shown
* @return one of cf_print_status_t
*/
-cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
+cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args,
+ gboolean show_progress_bar);
/**
* Print (export) the capture file into PDML format.
*/
cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args);
+/**
+ * Print (export) the capture file into JSON format.
+ *
+ * @param cf the capture file
+ * @param print_args the arguments what and how to export
+ * @return one of cf_print_status_t
+ */
+cf_print_status_t cf_write_json_packets(capture_file *cf, print_args_t *print_args);
+
/**
* Find packet with a protocol tree item that contains a specified text string.
*
*/
gboolean cf_find_packet_time_reference(capture_file *cf, search_direction dir);
-/**
- * GoTo Packet in first row.
- *
- * @return TRUE if the first row exists, FALSE otherwise
- */
-gboolean cf_goto_top_frame(void);
-
-/**
- * GoTo Packet in last row.
- *
- * @return TRUE if last row exists, FALSE otherwise
- */
-gboolean cf_goto_bottom_frame(void);
-
/**
* GoTo Packet with the given row.
*
*/
void cf_unselect_packet(capture_file *cf);
-/**
- * Unselect all protocol tree fields, if any.
- *
- * @param cf the capture file
- */
-void cf_unselect_field(capture_file *cf);
-
/**
* Mark a particular frame in a particular capture.
*
void cf_unignore_frame(capture_file *cf, frame_data *frame);
/**
- * Merge two (or more) capture files into one.
+ * Merge two or more capture files into a temporary file.
* @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
*
- * @param out_filename pointer to output filename; if output filename is
- * NULL, a temporary file name is generated and *out_filename is set
- * to point to the generated file name
+ * @param pd_window Window pointer suitable for use by delayed_create_progress_dlg.
+ * @param out_filenamep Points to a pointer that's set to point to the
+ * pathname of the temporary file; it's allocated with g_malloc()
* @param in_file_count the number of input files to merge
* @param in_filenames array of input filenames
* @param file_type the output filetype
* @return one of cf_status_t
*/
cf_status_t
-cf_merge_files(char **out_filename, int in_file_count,
- char *const *in_filenames, int file_type, gboolean do_append);
+cf_merge_files_to_tempfile(gpointer pd_window, char **out_filenamep,
+ int in_file_count, char *const *in_filenames,
+ int file_type, gboolean do_append);
/**
* Get the comment on a capture from the SHB data block
+ * XXX - should support multiple sections.
*
* @param cf the capture file
*/
-const gchar* cf_read_shb_comment(capture_file *cf);
+const gchar* cf_read_section_comment(capture_file *cf);
/**
* Update(replace) the comment on a capture from the SHB data block
+ * XXX - should support multiple sections.
*
* @param cf the capture file
* @param comment the string replacing the old comment
*/
-void cf_update_capture_comment(capture_file *cf, gchar *comment);
+void cf_update_section_comment(capture_file *cf, gchar *comment);
+
+/*
+ * Get the comment on a packet (record).
+ * If the comment has been edited, it returns the result of the edit,
+ * otherwise it returns the comment from the file.
+ *
+ * @param cf the capture file
+ * @param fd the frame_data structure for the frame
+ */
+char *cf_get_packet_comment(capture_file *cf, const frame_data *fd);
/**
* Update(replace) the comment on a capture from a frame
*
* @param cf the capture file
- * @param fdata the frame_data structure for the frame
- * @param comment the string replacing the old comment
+ * @param fd the frame_data structure for the frame
+ * @param new_comment the string replacing the old comment
*/
-void cf_update_packet_comment(capture_file *cf, frame_data *fdata, gchar *comment);
+gboolean cf_set_user_packet_comment(capture_file *cf, frame_data *fd, const gchar *new_comment);
/**
* What types of comments does this file have?
*/
guint32 cf_comment_types(capture_file *cf);
-#if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
-WS_DLL_PUBLIC
-void read_keytab_file(const char *);
-#endif
+/**
+ * Add a resolved address to this file's list of resolved addresses.
+ *
+ * @param cf the capture file
+ * @param addr a string representing an IPv4 or IPv6 address
+ * @param name a string containing a name corresponding to that address
+ * @return TRUE if it succeeds, FALSE if not
+ */
+gboolean cf_add_ip_name_from_string(capture_file *cf, const char *addr, const char *name);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* file.h */
+
+/*
+ * Editor modelines - http://www.wireshark.org/tools/modelines.html
+ *
+ * Local variables:
+ * c-basic-offset: 4
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * vi: set shiftwidth=4 tabstop=8 expandtab:
+ * :indentSize=4:tabSize=8:noTabs=true:
+ */
git.samba.org / metze / wireshark / wip.git / blobdiff