1 /* Path manipulation routines for GDB and gdbserver.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
23 #include "common/byte-vector.h"
27 /* Return the real path of FILENAME, expanding all the symbolic links.
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. */
33 extern gdb::unique_xmalloc_ptr
<char> gdb_realpath (const char *filename
);
35 /* Return a copy of FILENAME, with its directory prefix canonicalized
38 extern gdb::unique_xmalloc_ptr
<char>
39 gdb_realpath_keepfile (const char *filename
);
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.
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. */
49 extern gdb::unique_xmalloc_ptr
<char> gdb_abspath (const char *path
);
51 /* Return whether PATH contains a directory separator character. */
53 extern bool contains_dir_separator (const char *path
);
55 /* Get the usual user cache directory for the current platform.
57 On Linux, it follows the XDG Base Directory specification: use
58 $XDG_CACHE_HOME/gdb if the XDG_CACHE_HOME environment variable is
59 defined, otherwise $HOME/.cache.
61 On macOS, it follows the local convention and uses
64 The return value is absolute and tilde-expanded. Return an empty
65 string if neither XDG_CACHE_HOME (on Linux) or HOME are defined. */
67 extern std::string
get_standard_cache_dir ();
69 /* Get the usual temporary directory for the current platform.
71 On Windows, this is the TMP or TEMP environment variable.
73 On the rest, this is the TMPDIR environment variable, if defined, else /tmp.
75 Throw an exception on error. */
77 extern std::string
get_standard_temp_dir ();
79 /* Return the file name of the user's shell. Normally this comes from
80 the SHELL environment variable. */
82 extern const char *get_shell ();
84 /* Make a filename suitable to pass to mkstemp based on F (e.g.
85 /tmp/foo -> /tmp/foo-XXXXXX). */
87 extern gdb::char_vector
make_temp_filename (const std::string
&f
);
89 #endif /* PATHSTUFF_H */
This page took 0.03062 seconds and 4 git commands to generate.