2 * Declarations of utilities for capture user interfaces
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #ifndef __CAPTURE_UI_UTILS_H__
26 #define __CAPTURE_UI_UTILS_H__
28 #include "capture_opts.h"
32 #endif /* __cplusplus */
35 * GList of available capture interfaces.
39 * Find user-specified capture device description that matches interface
42 char *capture_dev_user_descr_find(const gchar *if_name);
45 * Find user-specified link-layer header type that matches interface
48 gint capture_dev_user_linktype_find(const gchar *if_name);
50 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
52 * Find user-specified buffer size that matches interface
55 gint capture_dev_user_buffersize_find(const gchar *if_name);
59 * Find user-specified snap length that matches interface
62 gint capture_dev_user_snaplen_find(const gchar *if_name);
63 gboolean capture_dev_user_hassnap_find(const gchar *if_name);
65 /** Return as descriptive a name for an interface as we can get.
66 * If the user has specified a comment, use that. Otherwise,
67 * if capture_interface_list() supplies a description, use that,
68 * otherwise use the interface name.
70 * @param if_name The name of the interface.
72 * @return The descriptive name (must be g_free'd later)
74 char *get_interface_descriptive_name(const char *if_name);
76 /** Build the GList of available capture interfaces.
78 * @param if_list An interface list from capture_interface_list().
79 * @param do_hide Hide the "hidden" interfaces.
81 * @return A list of if_info_t structs (use free_capture_combo_list() later).
83 GList *build_capture_combo_list(GList *if_list, gboolean do_hide);
85 /** Free the GList from build_capture_combo_list().
87 * @param combo_list the interface list from build_capture_combo_list()
89 void free_capture_combo_list(GList *combo_list);
92 /** Given text that contains an interface name possibly prefixed by an
93 * interface description, extract the interface name.
95 * @param if_text A string containing the interface description + name.
96 * This is usually the data from one of the list elements returned by
97 * build_capture_combo_list().
99 * @return The raw interface name, without description (must NOT be g_free'd later)
101 const char *get_if_name(const char *if_text);
103 /** Convert plain interface name to the displayed name in the combo box.
105 * @param if_list The list of interfaces returned by build_capture_combo_list()
106 * @param if_name The name of the interface.
108 * @return The descriptive name (must be g_free'd later)
110 char *build_capture_combo_name(GList *if_list, gchar *if_name);
112 /** Return the interface description (after setting it if not already set)
114 * @param capture_opts The capture_options structure that contains the used interface
115 * @param i The index of the interface
117 * @return A pointer to interface_opts->descr
119 const char *get_iface_description_for_interface(capture_options *capture_opts, guint i);
123 #endif /* __cplusplus */
125 #endif /* __CAPTURE_UI_UTILS_H__ */