gdbsupport/pathstuff.h

   1 /* Path manipulation routines for GDB and gdbserver.
   2
   3    Copyright (C) 1986-2020 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef COMMON_PATHSTUFF_H
  21 #define COMMON_PATHSTUFF_H
  22
  23 #include "gdbsupport/byte-vector.h"
  24
  25 /* Path utilities.  */
  26
  27 /* Return the real path of FILENAME, expanding all the symbolic links.
  28
  29    Contrary to "gdb_abspath", this function does not use
  30    CURRENT_DIRECTORY for path expansion.  Instead, it relies on the
  31    current working directory (CWD) of GDB or gdbserver.  */
  32
  33 extern gdb::unique_xmalloc_ptr<char> gdb_realpath (const char *filename);
  34
  35 /* Return a copy of FILENAME, with its directory prefix canonicalized
  36    by gdb_realpath.  */
  37
  38 extern gdb::unique_xmalloc_ptr<char>
  39   gdb_realpath_keepfile (const char *filename);
  40
  41 /* Return PATH in absolute form, performing tilde-expansion if necessary.
  42    PATH cannot be NULL or the empty string.
  43    This does not resolve symlinks however, use gdb_realpath for that.
  44
  45    Contrary to "gdb_realpath", this function uses CURRENT_DIRECTORY
  46    for the path expansion.  This may lead to scenarios the current
  47    working directory (CWD) is different than CURRENT_DIRECTORY.
  48
  49    If CURRENT_DIRECTORY is NULL, this function returns a copy of
  50    PATH.  */
  51
  52 extern gdb::unique_xmalloc_ptr<char> gdb_abspath (const char *path);
  53
  54 /* If the path in CHILD is a child of the path in PARENT, return a
  55    pointer to the first component in the CHILD's pathname below the
  56    PARENT.  Otherwise, return NULL.  */
  57
  58 extern const char *child_path (const char *parent, const char *child);
  59
  60 /* Return whether PATH contains a directory separator character.  */
  61
  62 extern bool contains_dir_separator (const char *path);
  63
  64 /* Get the usual user cache directory for the current platform.
  65
  66    On Linux, it follows the XDG Base Directory specification: use
  67    $XDG_CACHE_HOME/gdb if the XDG_CACHE_HOME environment variable is
  68    defined, otherwise $HOME/.cache.
  69
  70    On macOS, it follows the local convention and uses
  71    ~/Library/Caches/gdb.
  72
  73   The return value is absolute and tilde-expanded.  Return an empty
  74   string if neither XDG_CACHE_HOME (on Linux) or HOME are defined.  */
  75
  76 extern std::string get_standard_cache_dir ();
  77
  78 /* Get the usual temporary directory for the current platform.
  79
  80    On Windows, this is the TMP or TEMP environment variable.
  81
  82    On the rest, this is the TMPDIR environment variable, if defined, else /tmp.
  83
  84    Throw an exception on error.  */
  85
  86 extern std::string get_standard_temp_dir ();
  87
  88 /* Get the usual user config directory for the current platform.
  89
  90    On Linux, it follows the XDG Base Directory specification: use
  91    $XDG_CONFIG_HOME/gdb if the XDG_CONFIG_HOME environment variable is
  92    defined, otherwise $HOME/.config.
  93
  94    On macOS, it follows the local convention and uses
  95    ~/Library/Preferences/gdb.
  96
  97   The return value is absolute and tilde-expanded.  Return an empty
  98   string if neither XDG_CONFIG_HOME (on Linux) or HOME are defined.  */
  99
 100 extern std::string get_standard_config_dir ();
 101
 102 /* Look for FILENAME in the standard configuration directory as returned by
 103    GET_STANDARD_CONFIG_DIR and return the path to the file.  No check is
 104    performed that the file actually exists or not.
 105
 106    If FILENAME begins with a '.' then the path returned will remove the
 107    leading '.' character, for example passing '.gdbinit' could return the
 108    path '/home/username/.config/gdb/gdbinit'.  */
 109
 110 extern std::string get_standard_config_filename (const char *filename);
 111
 112 /* Look for a file called NAME in either the standard config directory or
 113    in the users home directory.  If a suitable file is found then *BUF will
 114    be filled with the contents of a call to 'stat' on the found file,
 115    otherwise *BUF is undefined after this call.
 116
 117    If NAME starts with a '.' character then, when looking in the standard
 118    config directory the file searched for has the '.' removed.  For
 119    example, if NAME is '.gdbinit' then on a Linux target GDB might look for
 120    '~/.config/gdb/gdbinit' and then '~/.gdbinit'.  */
 121
 122 extern std::string find_gdb_home_config_file (const char *name,
 123                                               struct stat *buf);
 124
 125 /* Return the file name of the user's shell.  Normally this comes from
 126    the SHELL environment variable.  */
 127
 128 extern const char *get_shell ();
 129
 130 /* Make a filename suitable to pass to mkstemp based on F (e.g.
 131    /tmp/foo -> /tmp/foo-XXXXXX).  */
 132
 133 extern gdb::char_vector make_temp_filename (const std::string &f);
 134
 135 #endif /* COMMON_PATHSTUFF_H */