FIXUP: add parameter dcerpc_info to functions defined in cnf file
[metze/wireshark/wip.git] / capture_opts.h
index 8eda37b2b26782cd01298417b16362ba997ce595..06e81698992967e0d3b67801390f8bf2ca87d9dd 100644 (file)
@@ -19,7 +19,7 @@
  *
  * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 
 
 #include "capture_ifinfo.h"
 
-/* Current state of capture engine. XXX - differentiate states */
-typedef enum {
-    CAPTURE_STOPPED,        /**< stopped */
-    CAPTURE_PREPARING,      /**< preparing, but still no response from capture child */
-    CAPTURE_RUNNING         /**< capture child signalled ok, capture is running now */
-} capture_state;
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/* Attention:
+   for tshark, we're using a leading - in the optstring to prevent getopt()
+   from permuting the argv[] entries, in this case, unknown argv[] entries
+   will be returned as parameters to a dummy-option 1
+   in short: we must not use 1 here */
+
+/* this does not clash with tshark's -2 option which returns '2' */
+#define LONGOPT_NUM_CAP_COMMENT 2
+
 
 #ifdef HAVE_PCAP_REMOTE
 /* Type of capture source */
@@ -73,10 +80,70 @@ typedef enum {
 } capture_sampling;
 #endif
 
-typedef struct interface_options_tag {
+#ifdef HAVE_PCAP_REMOTE
+struct remote_host_info {
+    gchar *remote_host;          /**< Host name or network address for remote capturing */
+    gchar *remote_port;          /**< TCP port of remote RPCAP server */
+    gint auth_type;              /**< Authentication type */
+    gchar *auth_username;        /**< Remote authentication parameters */
+    gchar *auth_password;        /**< Remote authentication parameters */
+    gboolean datatx_udp;
+    gboolean nocap_rpcap;
+    gboolean nocap_local;
+};
+
+typedef struct remote_options_tag {
+    capture_source src_type;
+    struct remote_host_info remote_host_opts;
+#ifdef HAVE_PCAP_SETSAMPLING
+    capture_sampling sampling_method;
+    int sampling_param;
+#endif
+} remote_options;
+#endif /* HAVE_PCAP_REMOTE */
+
+typedef struct interface_tag {
     gchar *name;
+    gchar *display_name;
+    gchar *friendly_name;
+    guint type;
+    gchar *addresses;
+    gint no_addresses;
+    gchar *cfilter;
+    GList *links;
+    gint active_dlt;
+    gboolean pmode;
+    gboolean has_snaplen;
+    guint snaplen;
+    gboolean local;
+#if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
+    gint buffer;
+#endif
+#ifdef HAVE_PCAP_CREATE
+    gboolean monitor_mode_enabled;
+    gboolean monitor_mode_supported;
+#endif
+#ifdef HAVE_PCAP_REMOTE
+    remote_options remote_opts;
+#endif
+    guint32     last_packets;
+    if_info_t   if_info;
+    gboolean    selected;
+    gboolean    hidden;
+    gboolean    locked;
+} interface_t;
+
+typedef struct link_row_tag {
+    gchar *name;
+    gint dlt;
+} link_row;
+
+typedef struct interface_options_tag {
+    gchar *name; /* the name of the interface provided to winpcap/libpcap to specify the interface */
     gchar *descr;
+    gchar *console_display_name; /* the name displayed in the console, also the basis for autonamed pcap filenames */
     gchar *cfilter;
+    gboolean has_snaplen;
     int snaplen;
     int linktype;
     gboolean promisc_mode;
@@ -104,70 +171,30 @@ typedef struct interface_options_tag {
 /** Capture options coming from user interface */
 typedef struct capture_options_tag {
     /* general */
-    void     *cf;                   /**< handle to cfile (note: untyped handle) */
-    gboolean has_cfilter;           /**< TRUE if capture filter specified on command line */
-    gchar    *cfilter;              /**< Capture filter string
-                                      *< XXX: Can finally be be removed.
-                                      *<      Replaced by interface_options.cfilter */
-    gchar    *iface;                /**< the network interface to capture from
-                                      *< XXX: Can finally be be removed.
-                                      *<      Replaced by interface_options.name */
-    gchar    *iface_descr;          /**< A human readable description of iface.
-                                      *< NOTE: capture_opts.c is not able to
-                                      *< set this field because doing so
-                                      *< requires too many dependencies.
-                                      *< Readers of this field should use
-                                      *< get_iface_description() from
-                                      *< "capture_ui_utils.h" to access it.
-                                      *< XXX: Can finally be be removed.
-                                      *<      Replaced by interface_options.descr */
     GArray   *ifaces;               /**< array of interfaces.
                                          Currently only used by dumpcap. */
+    GArray   *all_ifaces;
+    guint    num_selected;
+
+    /*
+     * Options to be applied to all interfaces.
+     *
+     * Some of these can be set from the GUI, others can't; setting
+     * the link-layer header type, for example, doesn't necessarily
+     * make sense, as different interfaces may support different sets
+     * of link-layer header types.
+     *
+     * Some that can't be set from the GUI can be set from the command
+     * line, by specifying them before any interface is specified.
+     * This includes the link-layer header type, so if somebody asks
+     * for a link-layer header type that an interface on which they're
+     * capturing doesn't support, we should report an error and fail
+     * to capture.
+     *
+     * These can be overridden per-interface.
+     */
     interface_options default_options;
-#ifdef HAVE_PCAP_REMOTE
-                                    /**< XXX: Should this whole block moved to
-                                      *< interface_options ? Yes!*/
-    capture_source src_type;        /**< Capturing on remote interface */
-    gchar    *remote_host;          /**< Host name or network address
-                                      *< for remote capturing */
-    gchar    *remote_port;          /**< TCP port of remote RPCAP server */
-
-    capture_auth  auth_type;
-    gchar    *auth_username;
-    gchar    *auth_password;        /**< Remote authentication parameters */
-
-    gboolean datatx_udp;            /**< Whether to use UDP for data transfer */
-    gboolean nocap_rpcap;           /**< Whether to capture RPCAP own traffic */
-    gboolean nocap_local;           /**< TODO: Whether to capture local traffic */
-#endif
-#ifdef HAVE_PCAP_SETSAMPLING
-    capture_sampling sampling_method; /**< PCAP packet sampling method
-                                        *< XXX: Can finally be be removed.
-                                        *<      Replaced by interface_options.sampling_method */
-    int sampling_param;             /**< PCAP packet sampling parameter
-                                      *< XXX: Can finally be be removed.
-                                      *<      Replaced by interface_options.sampling_param */
-#endif
-#if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
-    int      buffer_size;           /**< the capture buffer size (MB)
-                                      *< XXX: Can finally be be removed.
-                                      *<      Replaced by interface_options.buffer_size */
-#endif
-    gboolean has_snaplen;           /**< TRUE if maximum capture packet length
-                                         is specified */
-    int      snaplen;               /**< Maximum captured packet length
-                                      *< XXX: Can finally be be removed.
-                                      *<      Replaced by interface_options.snaplen */
-    gboolean promisc_mode;          /**< Capture in promiscuous mode
-                                      *< XXX: Can finally be be removed.
-                                      *<      Replaced by interface_options.promisc_mode */
-    int      linktype;              /**< Data link type to use, or -1 for
-                                         "use default"
-                                      *< XXX: Can finally be be removed.
-                                      *<      Replaced by interface_options.linktype */
-    gboolean monitor_mode;          /**< Capture in monitor mode, if available
-                                      *< XXX: Can finally be be removed.
-                                      *<      Replaced by interface_options.monitor_mode */
+
     gboolean saving_to_file;        /**< TRUE if capture is writing to a file */
     gchar    *save_file;            /**< the capture file name */
     gboolean group_read_access;     /**< TRUE is group read permission needs to be set */
@@ -178,6 +205,7 @@ typedef struct capture_options_tag {
     gboolean show_info;             /**< show the info dialog */
     gboolean quit_after_cap;        /**< Makes a "capture only mode". Implies -k */
     gboolean restart;               /**< restart after closing is done */
+    gchar    *orig_save_file;       /**< the original capture file name (saved for a restart) */
 
     /* multiple files (and ringbuffer) */
     gboolean multi_files_on;        /**< TRUE if ring buffer in use */
@@ -197,28 +225,22 @@ typedef struct capture_options_tag {
     int autostop_packets;           /**< Maximum packet count */
     gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
                                          is specified */
-    gint32 autostop_filesize;       /**< Maximum capture file size */
+    guint32 autostop_filesize;      /**< Maximum capture file size */
     gboolean has_autostop_duration; /**< TRUE if maximum capture duration
                                          is specified */
     gint32 autostop_duration;       /**< Maximum capture duration */
 
+    gchar *capture_comment;         /** capture comment to write to the
+                                        output file */
+
     /* internally used (don't touch from outside) */
-    int fork_child;                 /**< If not -1, in parent, process ID of child */
-    int fork_child_status;          /**< Child exit status */
-#ifdef _WIN32
-    int signal_pipe_write_fd;       /**< the pipe to signal the child */
-#endif
-    capture_state state;            /**< current state of the capture engine */
     gboolean output_to_pipe;        /**< save_file is a pipe (named or stdout) */
-#ifndef _WIN32
-    uid_t owner;                    /**< owner of the cfile */
-    gid_t group;                    /**< group of the cfile */
-#endif
+    gboolean capture_child;         /**< hidden option: Wireshark child mode */
 } capture_options;
 
 /* initialize the capture_options with some reasonable values */
 extern void
-capture_opts_init(capture_options *capture_opts, void *cf);
+capture_opts_init(capture_options *capture_opts);
 
 /* set a command line option value */
 extern int
@@ -245,8 +267,19 @@ capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
 extern void
 capture_opts_trim_ring_num_files(capture_options *capture_opts);
 
-/* trim the interface entry */
-extern gboolean
-capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device);
+/* pick default interface if none was specified */
+extern int
+capture_opts_default_iface_if_necessary(capture_options *capture_opts,
+                                        const char *capture_device);
+
+extern void
+collect_ifaces(capture_options *capture_opts);
+
+/* Default capture buffer size in Mbytes. */
+#define DEFAULT_CAPTURE_BUFFER_SIZE 2
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
 
 #endif /* capture_opts.h */