[deliverable/binutils-gdb.git] / gdb / common / pathstuff.h

/* Path manipulation routines for GDB and gdbserver.

   Copyright (C) 1986-2018 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef PATHSTUFF_H
#define PATHSTUFF_H

#include "common/byte-vector.h"

/* Path utilities.  */

/* Return the real path of FILENAME, expanding all the symbolic links.

   Contrary to "gdb_abspath", this function does not use
   CURRENT_DIRECTORY for path expansion.  Instead, it relies on the
   current working directory (CWD) of GDB or gdbserver.  */

extern gdb::unique_xmalloc_ptr<char> gdb_realpath (const char *filename);

/* Return a copy of FILENAME, with its directory prefix canonicalized
   by gdb_realpath.  */

extern gdb::unique_xmalloc_ptr<char>
  gdb_realpath_keepfile (const char *filename);

/* Return PATH in absolute form, performing tilde-expansion if necessary.
   PATH cannot be NULL or the empty string.
   This does not resolve symlinks however, use gdb_realpath for that.

   Contrary to "gdb_realpath", this function uses CURRENT_DIRECTORY
   for the path expansion.  This may lead to scenarios the current
   working directory (CWD) is different than CURRENT_DIRECTORY.  */

extern gdb::unique_xmalloc_ptr<char> gdb_abspath (const char *path);

/* Return whether PATH contains a directory separator character.  */

extern bool contains_dir_separator (const char *path);

/* Get the usual user cache directory for the current platform.

   On Linux, it follows the XDG Base Directory specification: use
   $XDG_CACHE_HOME/gdb if the XDG_CACHE_HOME environment variable is
   defined, otherwise $HOME/.cache.

   On macOS, it follows the local convention and uses
   ~/Library/Caches/gdb.

  The return value is absolute and tilde-expanded.  Return an empty
  string if neither XDG_CACHE_HOME (on Linux) or HOME are defined.  */

extern std::string get_standard_cache_dir ();

/* Return the file name of the user's shell.  Normally this comes from
   the SHELL environment variable.  */

extern const char *get_shell ();

/* Make a filename suitable to pass to mkstemp based on F (e.g.
   /tmp/foo -> /tmp/foo-XXXXXX).  */

extern gdb::char_vector make_temp_filename (const std::string &f);

#endif /* PATHSTUFF_H */
Commit	Line	Data
b4987c95 SDJ	1	/* Path manipulation routines for GDB and gdbserver.
	2
	3	Copyright (C) 1986-2018 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 PATHSTUFF_H
	21	#define PATHSTUFF_H
	22
29be4d9d TT	23	#include "common/byte-vector.h"
29be4d9d TT	24
b4987c95 SDJ	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	extern gdb::unique_xmalloc_ptr<char> gdb_abspath (const char *path);
	50
25e3c82c SDJ	51	/* Return whether PATH contains a directory separator character. */
	52
	53	extern bool contains_dir_separator (const char *path);
	54
87d6a7aa SM	55	/* Get the usual user cache directory for the current platform.
	56
	57	On Linux, it follows the XDG Base Directory specification: use
e6cd1dc1 TT	58	$XDG_CACHE_HOME/gdb if the XDG_CACHE_HOME environment variable is
e6cd1dc1 TT	59	defined, otherwise $HOME/.cache.
87d6a7aa	60
e6cd1dc1 TT	61	On macOS, it follows the local convention and uses
	62	~/Library/Caches/gdb.
	63
	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. */
87d6a7aa SM	66
	67	extern std::string get_standard_cache_dir ();
	68
974e6844 TT	69	/* Return the file name of the user's shell. Normally this comes from
	70	the SHELL environment variable. */
	71
	72	extern const char *get_shell ();
	73
29be4d9d TT	74	/* Make a filename suitable to pass to mkstemp based on F (e.g.
	75	/tmp/foo -> /tmp/foo-XXXXXX). */
	76
	77	extern gdb::char_vector make_temp_filename (const std::string &f);
	78
b4987c95	79	#endif /* PATHSTUFF_H */