/* file.h
* Definitions for file structures and routines
*
- * $Id$
- *
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
#define __FILE_H__
#include "wiretap/wtap.h"
-#include "print.h"
#include <errno.h>
#include <epan/epan.h>
-#include "packet-range.h"
+#include <epan/print.h>
+#include <epan/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_fast_save_finished,
- cf_cb_packet_selected,
- cf_cb_packet_unselected,
- cf_cb_field_unselected,
+ cf_cb_file_retap_started,
+ cf_cb_file_retap_finished,
+ cf_cb_file_fast_save_finished, /* GTK+ only? */
+ cf_cb_packet_selected, /* GTK+ only. */
+ cf_cb_packet_unselected, /* GTK+ only. */
+ cf_cb_field_unselected, /* GTK+ only. */
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_export_specified_packets_started, /* GTK+ only. */
+ cf_cb_file_export_specified_packets_finished, /* GTK+ only. */
+ cf_cb_file_export_specified_packets_failed, /* GTK+ only. */
+ cf_cb_file_export_specified_packets_stopped /* GTK+ only. */
} 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 pseudo_header pointer to a wtap_pseudo_header union into
- * which to read the packet's pseudo-header
- * @param pd a guin8 array 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 phdr pointer to a wtap_pkthdr 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, guint8 *pd);
+gboolean cf_read_record_r(capture_file *cf, const frame_data *fdata,
+ struct wtap_pkthdr *phdr, Buffer *buf);
/**
- * Read the pseudo-header and raw data for a packet into a
- * capture_file structure's pseudo_header and pd 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 occured
- * @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.
*
* @param cf the capture file to be read from
* @param to_read the number of packets to read
- * @param err the error code, if an error had occured
+ * @param err the error code, if an error had occurred
* @return one of cf_read_status_t
*/
cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err);
* Finish reading from "end" of a capture file.
*
* @param cf the capture file to be read from
- * @param err the error code, if an error had occured
+ * @param err the error code, if an error had occurred
* @return one of cf_read_status_t
*/
cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
/**
- * Determine whether this capture file (or a range of it) can be saved
+ * Determine whether this capture file (or a range of it) can be written
* in any format using Wiretap rather than by copying the raw data.
*
* @param cf the capture file to check
- * @return TRUE if it can be saved, FALSE if it can't
+ * @return TRUE if it can be written, FALSE if it can't
*/
gboolean cf_can_write_with_wiretap(capture_file *cf);
+/**
+ * Determine whether this capture file can be saved with a "save" operation;
+ * if there's nothing unsaved, it can't.
+ *
+ * @param cf the capture file to check
+ * @return TRUE if it can be saved, FALSE if it can't
+ */
+gboolean cf_can_save(capture_file *cf);
+
+/**
+ * Determine whether this capture file can be saved with a "save as" operation.
+ *
+ * @param cf the capture file to check
+ * @return TRUE if it can be saved, FALSE if it can't
+ */
+gboolean cf_can_save_as(capture_file *cf);
+
+/**
+ * Determine whether this capture file has unsaved data.
+ *
+ * @param cf the capture file to check
+ * @return TRUE if it has unsaved data, FALSE if it doesn't
+ */
+gboolean cf_has_unsaved_data(capture_file *cf);
+
/**
* Save all packets in a capture file to a new file, and, if that succeeds,
* make that file the current capture file. If there's already a file with
* @param fname the filename to save to
* @param save_format the format of the file to save (libpcap, ...)
* @param compressed whether to gzip compress the file
- * @discard_comments TRUE if we should discard comments if the save
+ * @param discard_comments TRUE if we should discard comments if the save
* succeeds (because we saved in a format that doesn't support
* comments)
* @param dont_reopen TRUE if it shouldn't reopen and make that file the
* 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);
*/
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?
*
* Set the number of packet drops while capturing.
*
* @param cf the capture file
- * @param drops the number of packet drops occured while capturing
+ * @param drops the number of packet drops occurred while capturing
*/
void cf_set_drops(capture_file *cf, guint32 drops);
* Get the number of packet drops while capturing.
*
* @param cf the capture file
- * @return the number of packet drops occured while capturing
+ * @return the number of packet drops occurred while capturing
*/
guint32 cf_get_drops(capture_file *cf);
/**
* Return the time it took to load the file
*/
-gulong cf_get_computed_elapsed(void);
+gulong cf_get_computed_elapsed(capture_file *cf);
/**
* "Something" has changed, rescan all packets.
*
* @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.
*
*/
void cf_update_capture_comment(capture_file *cf, gchar *comment);
+char *cf_get_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
+ */
+gboolean cf_set_user_packet_comment(capture_file *cf, frame_data *fd, const gchar *new_comment);
+
+/**
+ * What types of comments does this file have?
+ *
+ * @param cf the capture file
+ * @return bitset of WTAP_COMMENT_ values
*/
-void cf_update_packet_comment(capture_file *cf, frame_data *fdata, gchar *comment);
+guint32 cf_comment_types(capture_file *cf);
/**
- * Does this capture file have any comments?
+ * Add a resolved address to this file's list of resolved addresses.
*
* @param cf the capture file
- * @return TRUE if it does, FALSE if it doesn't
+ * @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_has_comments(capture_file *cf);
+gboolean cf_add_ip_name_from_string(capture_file *cf, const char *addr, const char *name);
-#if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
-void read_keytab_file(const char *);
+#ifdef WANT_PACKET_EDITOR
+/**
+ * Give a frame new, edited data.
+ *
+ * @param cf the capture file
+ * @param fd frame_data structure for the frame
+ * @param phdr the struct wtap_pkthdr for the frame
+ * @param pd the raw packet data for the frame
+ */
+void cf_set_frame_edited(capture_file *cf, frame_data *fd, struct wtap_pkthdr *phdr, guint8 *pd);
#endif
#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