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 #ifdef __cplusplus
  31 extern "C" {
  32 #endif /* __cplusplus */
  33
  34 /** @file
  35  *  GList of available capture interfaces.
  36  */
  37
  38 /**
  39  * Find user-specified capture device description that matches interface
  40  * name, if any.
  41  */
  42 char *capture_dev_user_descr_find(const gchar *if_name);
  43
  44 /**
  45  * Find user-specified link-layer header type that matches interface
  46  * name, if any.
  47  */
  48 gint capture_dev_user_linktype_find(const gchar *if_name);
  49
  50 /** Return as descriptive a name for an interface as we can get.
  51  * If the user has specified a comment, use that.  Otherwise,
  52  * if capture_interface_list() supplies a description, use that,
  53  * otherwise use the interface name.
  54  *
  55  * @param if_name The name of the interface.
  56  *
  57  * @return The descriptive name (must be g_free'd later)
  58  */
  59 char *get_interface_descriptive_name(const char *if_name);
  60
  61 /** Build the GList of available capture interfaces.
  62  *
  63  * @param if_list An interface list from capture_interface_list().
  64  * @param do_hide Hide the "hidden" interfaces.
  65  *
  66  * @return A list of if_info_t structs (use free_capture_combo_list() later).
  67  */
  68 GList *build_capture_combo_list(GList *if_list, gboolean do_hide);
  69
  70 /** Free the GList from build_capture_combo_list().
  71  *
  72  * @param combo_list the interface list from build_capture_combo_list()
  73  */
  74 void free_capture_combo_list(GList *combo_list);
  75
  76
  77 /** Given text that contains an interface name possibly prefixed by an
  78  * interface description, extract the interface name.
  79  *
  80  * @param if_text A string containing the interface description + name.
  81  * This is usually the data from one of the list elements returned by
  82  * build_capture_combo_list().
  83  *
  84  * @return The raw interface name, without description (must NOT be g_free'd later)
  85  */
  86 const char *get_if_name(const char *if_text);
  87
  88 /** Convert plain interface name to the displayed name in the combo box.
  89  *
  90  * @param if_list The list of interfaces returned by build_capture_combo_list()
  91  * @param if_name The name of the interface.
  92  *
  93  * @return The descriptive name (must be g_free'd later)
  94  */
  95 char *build_capture_combo_name(GList *if_list, gchar *if_name);
  96
  97 /** Return the interface description (after setting it if not already set)
  98  *
  99  * @param capture_opts The capture_options structure that contains the used interface
 100  * @param i The index of the interface
 101  *
 102  * @return A pointer to interface_opts->descr
 103  */
 104 const char *get_iface_description_for_interface(capture_options *capture_opts, guint i);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif /* __cplusplus */
 109
 110 #endif /* __CAPTURE_UI_UTILS_H__ */