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 #include "capture_opts.h"
  29
  30 /** @file
  31  *  GList of available capture interfaces.
  32  */
  33
  34 /** Return as descriptive a name for an interface as we can get.
  35  * If the user has specified a comment, use that.  Otherwise,
  36  * if get_interface_list() supplies a description, use that,
  37  * otherwise use the interface name.
  38  *
  39  * @param if_name The name of the interface.
  40  *
  41  * @return The descriptive name (must be g_free'd later)
  42  */
  43 char *get_interface_descriptive_name(const char *if_name);
  44
  45 /** Build the GList of available capture interfaces.
  46  *
  47  * @param if_list An interface list from get_interface_list().
  48  * @param do_hide Hide the "hidden" interfaces.
  49  *
  50  * @return A list of if_info_t structs (use free_capture_combo_list() later).
  51  */
  52 GList *build_capture_combo_list(GList *if_list, gboolean do_hide);
  53
  54 /** Free the GList from build_capture_combo_list().
  55  *
  56  * @param combo_list the interface list from build_capture_combo_list()
  57  */
  58 void free_capture_combo_list(GList *combo_list);
  59
  60
  61 /** Given text that contains an interface name possibly prefixed by an
  62  * interface description, extract the interface name.
  63  *
  64  * @param if_text A string containing the interface description + name.
  65  * This is usually the data from one of the list elements returned by
  66  * build_capture_combo_list().
  67  *
  68  * @return The raw interface name, without description (must NOT be g_free'd later)
  69  */
  70 const char *get_if_name(const char *if_text);
  71
  72 /** Convert plain interface name to the displayed name in the combo box.
  73  *
  74  * @param if_list The list of interfaces returned by build_capture_combo_list()
  75  * @param if_name The name of the interface.
  76  *
  77  * @return The descriptive name (must be g_free'd later)
  78  */
  79 char *build_capture_combo_name(GList *if_list, gchar *if_name);
  80
  81 /** Return the interface description (after setting it if not already set)
  82  *
  83  * @param capture_opts The capture_options structure that contains the used interface
  84  *
  85  * @return A pointer to capture_ops->iface_descr
  86  */
  87 const char *get_iface_description(capture_options *capture_opts);
  88
  89 #endif