capture_ui_utils.h

   1 /* capture_ui_utils.c
   2  * Declarations of utilities for capture user interfaces
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  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.
  14  *
  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.
  19  *
  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.
  23  */
  24
  25 #ifndef __CAPTURE_UI_UTILS_H__
  26 #define __CAPTURE_UI_UTILS_H__
  27
  28 /** @file
  29  *  GList of available capture interfaces.
  30  */
  31
  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.
  36  *
  37  * @param if_name The name of the interface.
  38  *
  39  * @return The descriptive name (must be g_free'd later)
  40  */
  41 char *get_interface_descriptive_name(const char *if_name);
  42
  43 /** Build the GList of available capture interfaces.
  44  *
  45  * @param if_list An interface list from get_interface_list().
  46  * @param do_hide Hide the "hidden" interfaces.
  47  *
  48  * @return A list of if_info_t structs (use free_capture_combo_list() later).
  49  */
  50 GList *build_capture_combo_list(GList *if_list, gboolean do_hide);
  51
  52 /** Free the GList from build_capture_combo_list().
  53  *
  54  * @param combo_list the interface list from build_capture_combo_list()
  55  */
  56 void free_capture_combo_list(GList *combo_list);
  57
  58
  59 /** Given text that contains an interface name possibly prefixed by an
  60  * interface description, extract the interface name.
  61  *
  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().
  65  *
  66  * @return The raw interface name, without description (must NOT be g_free'd later)
  67  */
  68 const char *get_if_name(const char *if_text);
  69
  70 /** Convert plain interface name to the displayed name in the combo box.
  71  *
  72  * @param if_list The list of interfaces returned by build_capture_combo_list()
  73  * @param if_name The name of the interface.
  74  *
  75  * @return The descriptive name (must be g_free'd later)
  76  */
  77 char * build_capture_combo_name(GList *if_list, gchar *if_name);
  78
  79 #endif