mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-14 23:38:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update comments for expand_wildcards functions.

Browse Source 
Be more specific in the description of mch_expand_wildcards():
This function will never free memory pointed to by its arguments.
If OK is returned, *file will always point to allocated memory.
*num_file is set to the number of pointers in *file.
If FAIL is returned *file is set to NULL and *num_file to 0.

If gen_expand_wildcards() returns FAIL, no memory allocation in this
function needs to be undone.

If expand_wildcards() returns FAIL, no memory allocation in this
function needs to be undone.

Helped-by: Eliseo Martínez <eliseomarmol@gmail.com>
Helped-by: Michael Reed <m.reed@mykolab.com>
This commit is contained in:
oni-link
2015-03-24 16:54:00 +01:00
committed by Justin M. Keyes
parent d3bb177f1e
commit adb3ec2026
3 changed files with 68 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
src/nvim/path.c
View File

@@ -1029,25 +1029,26 @@ static int has_special_wildchar(char_u *p)
}
#endif
/*
* 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*"
*
* Return FAIL when no single file was found. In this case "num_file" is not
* set, and "file" may contain an error message.
* Return OK when some files found. "num_file" is set to the number of
* matches, "file" to the array of matches. Call FreeWild() later.
*/
int
gen_expand_wildcards (
int num_pat, /* number of input patterns */
char_u **pat, /* array of input patterns */
int *num_file, /* resulting number of files */
char_u ***file, /* array of resulting files */
int flags /* EW_* 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*".
///
/// @param num_pat is number of input patterns.
/// @param pat is an array of pointers to input patterns.
/// @param[out] num_file is pointer to number of matched file names.
/// @param[out] file is pointer to array of pointers to matched file names.
/// @param 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 "".
int gen_expand_wildcards(int num_pat, char_u **pat, int *num_file,
char_u ***file, int flags)
{
int i;
garray_T ga;
@@ -1863,19 +1864,23 @@ int expand_wildcards_eval(char_u **pat, int *num_file, char_u ***file,
return ret;
}
/*
* Expand wildcards. Calls gen_expand_wildcards() and removes files matching
* 'wildignore'.
* Returns OK or FAIL. When FAIL then "num_file" won't be set.
*/
int
expand_wildcards (
int num_pat, /* number of input patterns */
char_u **pat, /* array of input patterns */
int *num_file, /* resulting number of files */
char_u ***file, /* array of resulting files */
int flags /* EW_DIR, etc. */
)
/// Expand wildcards. Calls gen_expand_wildcards() and removes files matching
/// 'wildignore'.
///
/// @param num_pat is number of input patterns.
/// @param pat is an array of pointers to input patterns.
/// @param[out] num_file is pointer to number of matched file names.
/// @param[out] file is pointer to array of pointers to matched file names.
/// @param flags is a combination of EW_* flags.
///
/// @returns OK when some files were found. *num_file is set to the
/// number of matches, *file to the allocated array 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 "".
int expand_wildcards(int num_pat, char_u **pat, int *num_file, char_u ***file,
int flags)
{
int retval;
int i, j;