ui/util.h

   1 /** @file
   2  *
   3  * Utility definitions
   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 __UTIL_H__
  13 #define __UTIL_H__
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif /* __cplusplus */
  18
  19 /* Collect command-line arguments as a string consisting of the arguments,
  20  * separated by spaces.
  21  */
  22 char *get_args_as_string(int argc, char **argv, int optindex);
  23
  24 /* Compute the difference between two seconds/microseconds time stamps.
  25  * Beware: we're using nanosecond resolution now and function is currently unused
  26  */
  27 void compute_timestamp_diff(int *diffsec, int *diffusec,
  28                             uint32_t sec1, uint32_t usec1, uint32_t sec2, uint32_t usec2);
  29
  30 /* Try to figure out if we're remotely connected, e.g. via ssh or
  31     Terminal Server, and create a capture filter that matches aspects of the
  32     connection.  We match the following environment variables:
  33
  34     SSH_CONNECTION (ssh): <remote IP> <remote port> <local IP> <local port>
  35     SSH_CLIENT (ssh): <remote IP> <remote port> <local port>
  36     REMOTEHOST (tcsh, others?): <remote name>
  37     DISPLAY (x11): [remote name]:<display num>
  38     CLIENTNAME (terminal server): <remote name>
  39  */
  40 const char *get_conn_cfilter(void);
  41
  42 /** Check if we're running on a remote connection.
  43  * @return true if we're running remotely, false if local.
  44  */
  45 bool display_is_remote(void);
  46
  47 /** Get the latest directory in which a file has been opened.
  48  *
  49  * @return the dirname
  50  */
  51 extern const char *get_last_open_dir(void);
  52
  53 /** Set the latest directory in which a file has been opened.
  54  *
  55  * @param dirname the dirname
  56  */
  57 extern void set_last_open_dir(const char *dirname);
  58
  59 /** Get the initial directory to use in file open dialogs.
  60  *
  61  * @return the dirname
  62  */
  63 extern const char *get_open_dialog_initial_dir(void);
  64
  65 #ifdef __cplusplus
  66 }
  67 #endif /* __cplusplus */
  68
  69 #endif /* __UTIL_H__ */