ui/capture_ui_utils.h

   1 /** @file
   2  *
   3  * Declarations of utilities for capture user interfaces
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #ifndef __CAPTURE_UI_UTILS_H__
  13 #define __CAPTURE_UI_UTILS_H__
  14
  15 #include "ui/capture_opts.h"
  16
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif /* __cplusplus */
  20
  21 /** @file
  22  *  GList of available capture interfaces.
  23  */
  24
  25 /**
  26  * Find user-specified capture device description that matches interface
  27  * name, if any.
  28  *
  29  * @param if_name The name of the interface.
  30  *
  31  * @return The device description (must be g_free'd later) or NULL
  32  * if not found.
  33  */
  34 char *capture_dev_user_descr_find(const char *if_name);
  35
  36 /**
  37  * Find user-specified link-layer header type that matches interface
  38  * name, if any.
  39  *
  40  * @param if_name The name of the interface.
  41  *
  42  * @return The link-layer header type (a DLT_) or -1 if not found.
  43  */
  44 int capture_dev_user_linktype_find(const char *if_name);
  45
  46 /**
  47  * Find user-specified buffer size that matches interface
  48  * name, if any.
  49  *
  50  * @param if_name The name of the interface.
  51  *
  52  * @return The buffer size or -1 if not found.
  53  */
  54 int capture_dev_user_buffersize_find(const char *if_name);
  55
  56 /**
  57  * Find user-specified snap length that matches interface
  58  * name, if any.
  59  *
  60  * @param if_name The name of the interface.
  61  * @param hassnap Pointer to a variable to be set to true if the
  62  * interface should be given a snap length or false if it shouldn't
  63  * be given a snap length.
  64  * @param snaplen Pointer to a variable to be set to the snap length
  65  * if the interface should be given a snap length or the maximum
  66  * snap length if it shouldn't be given a snap length.
  67  *
  68  * @return true if found or false if not found.
  69  */
  70 bool capture_dev_user_snaplen_find(const char *if_name, bool *hassnap, int *snaplen);
  71
  72 /**
  73  * Find user-specified promiscuous mode that matches interface
  74  * name, if any.
  75  *
  76  * @param if_name The name of the interface.
  77  * @param pmode Pointer to a variable to be set to true if promiscuous
  78  * mode should be used and false if it shouldn't be used.
  79  *
  80  * @return true if found or false if not found.
  81  */
  82 bool capture_dev_user_pmode_find(const char *if_name, bool *pmode);
  83
  84 /**
  85  * Find user-specified capture filter that matches interface
  86  * name, if any.
  87  *
  88  * This is deprecated and should not be used in new code.
  89  *
  90  * @param if_name The name of the interface.
  91  *
  92  * @return The capture filter (must be g_free'd later) or NULL if not found.
  93  */
  94 char* capture_dev_user_cfilter_find(const char *if_name);
  95
  96 /** Return as descriptive a name for an interface as we can get.
  97  * If the user has specified a comment, use that.  Otherwise,
  98  * if the get_iface_list() method of capture_opts supplies a
  99  * description, use that, otherwise use the interface name.
 100  *
 101  * @param capture_opts The capture options to use to find the interface
 102  * @param if_name The name of the interface.
 103  *
 104  * @return The descriptive name (must be g_free'd later)
 105  */
 106 char *get_interface_descriptive_name(const capture_options *capture_opts, const char *if_name);
 107
 108 /** Build the GList of available capture interfaces.
 109  *
 110  * @param if_list An interface list from capture_interface_list().
 111  * @param do_hide Hide the "hidden" interfaces.
 112  *
 113  * @return A list of if_info_t structs (use free_capture_combo_list() later).
 114  */
 115 GList *build_capture_combo_list(GList *if_list, bool do_hide);
 116
 117 /** Free the GList from build_capture_combo_list().
 118  *
 119  * @param combo_list the interface list from build_capture_combo_list()
 120  */
 121 void free_capture_combo_list(GList *combo_list);
 122
 123
 124 /** Given text that contains an interface name possibly prefixed by an
 125  * interface description, extract the interface name.
 126  *
 127  * @param if_text A string containing the interface description + name.
 128  * This is usually the data from one of the list elements returned by
 129  * build_capture_combo_list().
 130  *
 131  * @return The raw interface name, without description (must NOT be g_free'd later)
 132  */
 133 const char *get_if_name(const char *if_text);
 134
 135 /** Set the active DLT for a device appropriately.
 136  *
 137  * @param device the device on which to set the active DLT
 138  * @param global_default_dlt the global default DLT
 139  */
 140 extern void set_active_dlt(interface_t *device, int global_default_dlt);
 141
 142 /** Get a descriptive string for a list of interfaces.
 143  *
 144  * @param capture_opts The capture_options structure that contains the interfaces
 145  * @param style flags to indicate the style of string to use:
 146  *
 147  *  IFLIST_QUOTE_IF_DESCRIPTION: put the interface descriptive string in
 148  *  single quotes
 149  *
 150  *  IFLIST_SHOW_FILTER: include the capture filters in the string
 151  *
 152  * @return A GString set to the descriptive string
 153  */
 154 #define IFLIST_QUOTE_IF_DESCRIPTION 0x00000001
 155 #define IFLIST_SHOW_FILTER          0x00000002
 156
 157 extern GString *get_iface_list_string(capture_options *capture_opts, uint32_t style);
 158
 159 #ifdef __cplusplus
 160 }
 161 #endif /* __cplusplus */
 162
 163 #endif /* __CAPTURE_UI_UTILS_H__ */