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 33extern 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 38extern 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 52extern 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 58extern const char *child_path (const char *parent, const char *child); 59 60/* Return whether PATH contains a directory separator character. */ 61 62extern 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 76extern 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 86extern std::string get_standard_temp_dir (); 87 88/* Return the file name of the user's shell. Normally this comes from 89 the SHELL environment variable. */ 90 91extern const char *get_shell (); 92 93/* Make a filename suitable to pass to mkstemp based on F (e.g. 94 /tmp/foo -> /tmp/foo-XXXXXX). */ 95 96extern gdb::char_vector make_temp_filename (const std::string &f); 97 98#endif /* COMMON_PATHSTUFF_H */ 99