2 * Declarations of utilities for capture user interfaces
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@ethereal.com>
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 #ifndef __CAPTURE_UI_UTILS_H__
26 #define __CAPTURE_UI_UTILS_H__
29 * GList of available capture interfaces.
32 /** Return as descriptive a name for an interface as we can get.
33 * If the user has specified a comment, use that. Otherwise,
34 * if get_interface_list() supplies a description, use that,
35 * otherwise use the interface name.
37 * @param if_name The name of the interface.
39 * @return The descriptive name (must be g_free'd later)
41 char *get_interface_descriptive_name(const char *if_name);
43 /** Build the GList of available capture interfaces.
45 * @param if_list An interface list from get_interface_list().
46 * @param do_hide Hide the "hidden" interfaces.
48 * @return A list of if_info_t structs (use free_capture_combo_list() later).
50 GList *build_capture_combo_list(GList *if_list, gboolean do_hide);
52 /** Free the GList from build_capture_combo_list().
54 * @param combo_list the interface list from build_capture_combo_list()
56 void free_capture_combo_list(GList *combo_list);
59 /** Given text that contains an interface name possibly prefixed by an
60 * interface description, extract the interface name.
62 * @param if_text A string containing the interface description + name.
63 * This is usually the data from one of the list elements returned by
64 * build_capture_combo_list().
66 * @return The raw interface name, without description (must NOT be g_free'd later)
68 const char *get_if_name(const char *if_text);
70 /** Convert plain interface name to the displayed name in the combo box.
72 * @param if_list The list of interfaces returned by build_capture_combo_list()
73 * @param if_name The name of the interface.
75 * @return The descriptive name (must be g_free'd later)
77 char * build_capture_combo_name(GList *if_list, gchar *if_name);