#include <assert.h>
#include <inttypes.h>
#include <stdbool.h>
#include <stdlib.h>
#include "nvim/ascii.h"
#include "nvim/charset.h"
#include "nvim/eval.h"
#include "nvim/ex_docmd.h"
#include "nvim/ex_getln.h"
#include "nvim/file_search.h"
#include "nvim/fileio.h"
#include "nvim/garray.h"
#include "nvim/memfile.h"
#include "nvim/memline.h"
#include "nvim/memory.h"
#include "nvim/message.h"
#include "nvim/misc1.h"
#include "nvim/option.h"
#include "nvim/os/input.h"
#include "nvim/os/os.h"
#include "nvim/os/shell.h"
#include "nvim/os_unix.h"
#include "nvim/path.h"
#include "nvim/quickfix.h"
#include "nvim/regexp.h"
#include "nvim/screen.h"
#include "nvim/strings.h"
#include "nvim/tag.h"
#include "nvim/types.h"
#include "nvim/vim.h"
#include "nvim/window.h"

Macros
#define	URL_SLASH 1

#define	URL_BACKSLASH 2

#define	MAXSUFLEN 30

Functions
FileComparison	path_full_compare (char_u const s1, char_u const s2, const bool checkname, const bool expandenv)

char_u *	path_tail (const char_u *fname) FUNC_ATTR_NONNULL_RET

char_u *	path_tail_with_sep (char_u *fname)

const char_u *	invocation_path_tail (const char_u invocation, size_t len) FUNC_ATTR_NONNULL_RET FUNC_ATTR_NONNULL_ARG(1)

const char *	path_next_component (const char *fname)

int	path_head_length (void)

bool	is_path_head (const char_u *path)

char_u *	get_past_head (const char_u *path)

int	vim_ispathsep (int c)

int	vim_ispathsep_nocolon (int c)

int	vim_ispathlistsep (int c)

char_u *	shorten_dir (char_u *str)

bool	dir_of_file_exists (char_u *fname)

int	path_fnamecmp (const char fname1, const char fname2) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_PURE FUNC_ATTR_WARN_UNUSED_RESULT

int	path_fnamencmp (const char const fname1, const char const fname2, size_t len) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_PURE FUNC_ATTR_WARN_UNUSED_RESULT

char *	concat_fnames (const char fname1, const char fname2, bool sep) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_NONNULL_RET

char *	concat_fnames_realloc (char fname1, const char fname2, bool sep) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_NONNULL_RET

bool	add_pathsep (char *p) FUNC_ATTR_NONNULL_ALL

char *	FullName_save (const char *fname, bool force) FUNC_ATTR_MALLOC

char *	save_abs_path (const char *name) FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL

bool	path_has_wildcard (const char_u *p) FUNC_ATTR_NONNULL_ALL

bool	path_has_exp_wildcard (const char_u *p) FUNC_ATTR_NONNULL_ALL

const char *	gettail_dir (const char *const fname) FUNC_ATTR_PURE FUNC_ATTR_WARN_UNUSED_RESULT FUNC_ATTR_NONNULL_ALL

int	gen_expand_wildcards (int num_pat, char_u *pat, int num_file, char_u ***file, int flags)

void	addfile (garray_T gap, char_u f, int flags)

void	simplify_filename (char_u *filename)

char_u *	find_file_name_in_path (char_u ptr, size_t len, int options, long count, char_u rel_fname)

int	path_is_url (const char *p)

int	path_with_url (const char *fname)

bool	path_with_extension (const char path, const char extension)

bool	vim_isAbsName (char_u *name)

int	vim_FullName (const char fname, char buf, size_t len, bool force) FUNC_ATTR_NONNULL_ARG(2)

char *	fix_fname (const char *fname)

void	path_fix_case (char_u *name) FUNC_ATTR_NONNULL_ALL

int	after_pathsep (const char b, const char p)

bool	same_directory (char_u f1, char_u f2)

int	pathcmp (const char p, const char q, int maxlen)

char_u *	path_try_shorten_fname (char_u *full_path)

char_u *	path_shorten_fname (char_u full_path, char_u dir_name)

int	expand_wildcards_eval (char_u *pat, int num_file, char_u ***file, int flags)

int	expand_wildcards (int num_pat, char_u *pat, int num_files, char_u ***files, int flags)

int	match_suffix (char_u *fname)

int	path_full_dir_name (char directory, char buffer, size_t len)

int	append_path (char path, const char to_append, size_t max_len)

int	path_is_absolute (const char_u *fname)

void	path_guess_exepath (const char argv0, char buf, size_t bufsize) FUNC_ATTR_NONNULL_ALL

Macro Definition Documentation

◆ MAXSUFLEN

#define MAXSUFLEN 30

◆ URL_BACKSLASH

#define URL_BACKSLASH 2

◆ URL_SLASH

#define URL_SLASH 1

Function Documentation

◆ add_pathsep()

bool add_pathsep ( char * p )

Adds a path separator to a filename, unless it already ends in one.

Returns: true if the path separator was added or already existed. false if the filename is too long.

◆ addfile()

void addfile	(	garray_T *	gap,
		char_u *	f,
		int	flags
	)

Add a file to a file list. Accepted flags: EW_DIR add directories EW_FILE add files EW_EXEC add executable files EW_NOTFOUND add even when it doesn't exist EW_ADDSLASH add slash after directory name EW_ALLLINKS add symlink also when the referred file does not exist

Parameters

f filename

◆ after_pathsep()

int after_pathsep	(	const char *	b,
		const char *	p
	)

◆ append_path()

int append_path	(	char *	path,
		const char *	to_append,
		size_t	max_len
	)

◆ concat_fnames()

char* concat_fnames	(	const char *	fname1,
		const char *	fname2,
		bool	sep
	)

Concatenate file names fname1 and fname2 into allocated memory.

Only add a '/' or '\' when 'sep' is true and it is necessary.

Parameters

fname1	is the first part of the path or filename
fname2	is the second half of the path or filename
sep	is a flag to indicate a path separator should be added if necessary

Returns: [allocated] Concatenation of fname1 and fname2.

◆ concat_fnames_realloc()

char* concat_fnames_realloc	(	char *	fname1,
		const char *	fname2,
		bool	sep
	)

Concatenate file names fname1 and fname2

Like concat_fnames(), but in place of allocating new memory it reallocates fname1. For this reason fname1 must be allocated with xmalloc, and can no longer be used after running concat_fnames_realloc.

Parameters

fname1	is the first part of the path or filename
fname2	is the second half of the path or filename
sep	is a flag to indicate a path separator should be added if necessary

Returns: [allocated] Concatenation of fname1 and fname2.

◆ dir_of_file_exists()

bool dir_of_file_exists ( char_u * fname )

◆ expand_wildcards()

int expand_wildcards	(	int	num_pat,
		char_u **	pat,
		int *	num_files,
		char_u ***	files,
		int	flags
	)

Expand wildcards. Calls gen_expand_wildcards() and removes files matching 'wildignore'.

Parameters

	num_pat	is number of input patterns.
	pat	is an array of pointers to input patterns.
[out]	num_file	is pointer to number of matched file names.
[out]	file	is pointer to array of pointers to matched file names.
	flags	is a combination of EW_* flags.

Returns: OK when *file is set to allocated array of matches and *num_file (can be zero) to the number of matches. If FAIL is returned, *num_file and *file are either unchanged or *num_file is set to 0 and *file is set to NULL or points to "".

◆ expand_wildcards_eval()

int expand_wildcards_eval	(	char_u **	pat,
		int *	num_file,
		char_u ***	file,
		int	flags
	)

Invoke expand_wildcards() for one pattern

One should expand items like "%:h" before the expansion.

Parameters

[in]	pat	Pointer to the input pattern.
[out]	num_file	Resulting number of files.
[out]	file	Array of resulting files.
[in]	flags	Flags passed to expand_wildcards().

Returns: OK when *file is set to allocated array of matches and *num_file(can be zero) to the number of matches. If FAIL is returned, *num_file and *file are either unchanged or *num_file is set to 0 and *file is set to NULL or points to "".

◆ find_file_name_in_path()

char_u* find_file_name_in_path	(	char_u *	ptr,
		size_t	len,
		int	options,
		long	count,
		char_u *	rel_fname
	)

Return the name of the file ptr[len] in 'path'. Otherwise like file_name_at_cursor().

Parameters

rel_fname file we are searching relative to

◆ fix_fname()

char* fix_fname ( const char * fname )

Get the full resolved path for fname

Even filenames that appear to be absolute based on starting from the root may have relative paths (like dir/../subdir) or symlinks embedded, or even extra separators (//). This function addresses those possibilities, returning a resolved absolute path. For MS-Windows, this also expands names like "longna~1".

Parameters

fname is the filename to expand

Returns: [allocated] Full path (NULL for failure).

◆ FullName_save()

char* FullName_save	(	const char *	fname,
		bool	force
	)

Get an allocated copy of the full path to a file.

Parameters

fname	is the filename to save
force	is a flag to expand `fname` even if it looks absolute

Returns: [allocated] Copy of absolute path to fname or NULL when fname is NULL.

◆ gen_expand_wildcards()

int gen_expand_wildcards	(	int	num_pat,
		char_u **	pat,
		int *	num_file,
		char_u ***	file,
		int	flags
	)

Generic wildcard expansion code.

Characters in pat that should not be expanded must be preceded with a backslash. E.g., "/path\ with\ spaces/my\*star*".

Parameters

	num_pat	is number of input patterns.
	pat	is an array of pointers to input patterns.
[out]	num_file	is pointer to number of matched file names.
[out]	file	is pointer to array of pointers to matched file names.
	flags	is a combination of EW_* flags used in expand_wildcards().

Returns: OK when some files were found. *num_file is set to the number of matches, *file to the allocated array of matches. Call FreeWild() later. If FAIL is returned, *num_file and *file are either unchanged or *num_file is set to 0 and *file is set to NULL or points to "".

◆ get_past_head()

char_u* get_past_head ( const char_u * path )

Get a pointer to one character past the head of a path name. Unix: after "/"; Win: after "c:\" If there is no head, path is returned.

◆ gettail_dir()

const char* gettail_dir ( const char *const fname )

Find end of the directory name

Parameters

[in] fname File name to process.

Returns

end of the directory name, on the first path separator:

       "/path/file", "/path/dir/", "/path//dir", "/file"
             ^             ^             ^        ^

◆ invocation_path_tail()

const char_u* invocation_path_tail	(	const char_u *	invocation,
		size_t *	len
	)

Finds the path tail (or executable) in an invocation.

Parameters

[in]	invocation	A program invocation in the form: "path/to/exe [args]".
[out]	len	Stores the length of the executable name.

Postcondition: if len is not null, stores the length of the executable name.

Returns: The position of the last path separator + 1.

◆ is_path_head()

bool is_path_head ( const char_u * path )

Returns true if path begins with characters denoting the head of a path (e.g. '/' on linux and 'D:' on windows).

Parameters

path	The path to be checked.

Returns

True if path begins with a path head
False otherwise

◆ match_suffix()

int match_suffix ( char_u * fname )

◆ path_fix_case()

void path_fix_case ( char_u * name )

Set the case of the file name, if it already exists. This will cause the file name to remain exactly the same. Only required for file systems where case is ignored and preserved.

◆ path_fnamecmp()

int path_fnamecmp	(	const char *	fname1,
		const char *	fname2
	)

Compare two file names

Handles '/' and '\' correctly and deals with &fileignorecase option.

Parameters

[in]	fname1	First file name.
[in]	fname2	Second file name.

Returns: 0 if they are equal, non-zero otherwise.

◆ path_fnamencmp()

int path_fnamencmp	(	const char *const	fname1,
		const char *const	fname2,
		size_t	len
	)

Compare two file names

Handles '/' and '\' correctly and deals with &fileignorecase option.

Parameters

[in]	fname1	First file name.
[in]	fname2	Second file name.
[in]	len	Compare at most len bytes.

Returns: 0 if they are equal, non-zero otherwise.

◆ path_full_compare()

FileComparison path_full_compare	(	char_u *const	s1,
		char_u *const	s2,
		const bool	checkname,
		const bool	expandenv
	)

Compare two file names.

Parameters

s1	First file name. Environment variables in this name will be expanded.
s2	Second file name.
checkname	When both files don't exist, only compare their names.
expandenv	Whether to expand environment variables in file names.

Returns: Enum of type FileComparison.

See also: FileComparison.

◆ path_full_dir_name()

int path_full_dir_name	(	char *	directory,
		char *	buffer,
		size_t	len
	)

Get the absolute name of the given relative directory.

Parameters

directory Directory name, relative to current directory.

Returns: FAIL for failure, OK for success.

◆ path_guess_exepath()

void path_guess_exepath	(	const char *	argv0,
		char *	buf,
		size_t	bufsize
	)

Builds a full path from an invocation name argv0, based on heuristics.

Parameters

[in]	argv0	Name by which Nvim was invoked.
[out]	buf	Guessed full path to `argv0`.
[in]	bufsize	Size of `buf`.

See also: os_exepath

◆ path_has_exp_wildcard()

bool path_has_exp_wildcard ( const char_u * p )

Checks if a path has a character path_expand can expand.

Parameters

p	The path to expand.

Returns: Unix: True if it contains one of *?[{.; Windows: True if it contains one of *?[.

◆ path_has_wildcard()

bool path_has_wildcard ( const char_u * p )

Checks if a path has a wildcard character including '~', unless at the end.

Parameters

p	The path to expand.

Returns: Unix: True if it contains one of "?[{`'$".; Windows: True if it contains one of "*?$[".

◆ path_head_length()

int path_head_length ( void )

Returns the length of the path head on the current platform.

Returns

3 on windows
1 otherwise

◆ path_is_absolute()

int path_is_absolute ( const char_u * fname )

Check if file fname is a full (absolute) path.

Returns: TRUE if "fname" is absolute.

◆ path_is_url()

int path_is_url ( const char * p )

◆ path_next_component()

const char* path_next_component ( const char * fname )

Get the next path component of a path name.

Parameters

fname A file path. (Must be != NULL.)

Returns: Pointer to first found path separator + 1. An empty string, if fname doesn't contain a path separator,

◆ path_shorten_fname()

char_u* path_shorten_fname	(	char_u *	full_path,
		char_u *	dir_name
	)

Try to find a shortname by comparing the fullname with dir_name.

Parameters

full_path	The full path of the file.
dir_name	The directory to shorten relative to.

Returns

Pointer into full_path if shortened.
NULL if no shorter name is possible.

◆ path_tail()

char_u* path_tail ( const char_u * fname )

Gets the tail (i.e., the filename segment) of a path fname.

Returns: pointer just past the last path separator (empty string, if fname ends in a slash), or empty string if fname is NULL.

◆ path_tail_with_sep()

char_u* path_tail_with_sep ( char_u * fname )

Get pointer to tail of "fname", including path separators.

Takes care of "c:/" and "//". That means path_tail_with_sep("dir///file.txt") will return a pointer to "///file.txt".

Parameters

fname A file path. (Must be != NULL.)

Returns

Pointer to the last path separator of fname, if there is any.
fname if it contains no path separator.
Never NULL.

◆ path_try_shorten_fname()

char_u* path_try_shorten_fname ( char_u * full_path )

Try to find a shortname by comparing the fullname with the current directory.

Parameters

full_path The full path of the file.

Returns

Pointer into full_path if shortened.
full_path unchanged if no shorter name is possible.
NULL if full_path is NULL.

◆ path_with_extension()

bool path_with_extension	(	const char *	path,
		const char *	extension
	)

◆ path_with_url()

int path_with_url ( const char * fname )

Check if "fname" starts with "name://". Return URL_SLASH if it does.

Parameters

fname is the filename to test

Returns: URL_BACKSLASH for "name:\\", zero otherwise.

◆ pathcmp()

int pathcmp	(	const char *	p,
		const char *	q,
		int	maxlen
	)

◆ same_directory()

bool same_directory	(	char_u *	f1,
		char_u *	f2
	)

◆ save_abs_path()

char* save_abs_path ( const char * name )

Saves the absolute path.

Parameters

name	An absolute or relative path.

Returns: The absolute path of name.

◆ shorten_dir()

char_u* shorten_dir ( char_u * str )

◆ simplify_filename()

void simplify_filename ( char_u * filename )

◆ vim_FullName()

int vim_FullName	(	const char *	fname,
		char *	buf,
		size_t	len,
		bool	force
	)

Save absolute file name to "buf[len]".

Parameters

	fname	filename to evaluate
[out]	buf	contains `fname` absolute path, or: truncated `fname` if longer than `len` unmodified `fname` if absolute path fails or is a URL
	len	length of `buf`
	force	flag to force expanding even if the path is absolute

Returns: FAIL for failure, OK otherwise

◆ vim_isAbsName()

bool vim_isAbsName ( char_u * name )

◆ vim_ispathlistsep()

int vim_ispathlistsep ( int c )

◆ vim_ispathsep()

int vim_ispathsep ( int c )

◆ vim_ispathsep_nocolon()

int vim_ispathsep_nocolon ( int c )

Macros

Functions

Macro Definition Documentation

◆ MAXSUFLEN

◆ URL_BACKSLASH

◆ URL_SLASH

Function Documentation

◆ add_pathsep()

◆ addfile()

◆ after_pathsep()

◆ append_path()

◆ concat_fnames()

◆ concat_fnames_realloc()

◆ dir_of_file_exists()

◆ expand_wildcards()

◆ expand_wildcards_eval()

◆ find_file_name_in_path()

◆ fix_fname()

◆ FullName_save()

◆ gen_expand_wildcards()

◆ get_past_head()

◆ gettail_dir()

◆ invocation_path_tail()

◆ is_path_head()

◆ match_suffix()

◆ path_fix_case()

◆ path_fnamecmp()

◆ path_fnamencmp()

◆ path_full_compare()

◆ path_full_dir_name()

◆ path_guess_exepath()

◆ path_has_exp_wildcard()

◆ path_has_wildcard()

◆ path_head_length()

◆ path_is_absolute()

◆ path_is_url()

◆ path_next_component()

◆ path_shorten_fname()

◆ path_tail()

◆ path_tail_with_sep()

◆ path_try_shorten_fname()

◆ path_with_extension()

◆ path_with_url()

◆ pathcmp()

◆ same_directory()

◆ save_abs_path()

◆ shorten_dir()

◆ simplify_filename()

◆ vim_FullName()

◆ vim_isAbsName()

◆ vim_ispathlistsep()

◆ vim_ispathsep()

◆ vim_ispathsep_nocolon()