Add readdir()

[mattn]

glob() is bit difficult to use to get file list in Vim script since it depend on suffixes or wildignore. So this change add new API readdir().

readdir() take 1 or 2 arguments. first one is a path to the directory to be listed files. sencond one is expr to add or ignore for the result. 1 to add the filename. 0 to ignore. If you set -1 to expr, readdir() stop to read. Below is test code.

func Test_readdir()
  call mkdir('Xdir')
  call writefile([], 'Xdir/foo.txt')
  call writefile([], 'Xdir/bar.txt')
  call mkdir('Xdir/dir')

  let files = readdir('Xdir')
  call assert_equal(['bar.txt', 'dir', 'foo.txt'], files)

  let files = readdir('Xdir', {x->stridx(x,'f')!=-1})
  call assert_equal(['foo.txt'], files)

  let l = []
  let files = readdir('Xdir', {x->len(add(l, x)) == 2 ? -1 : 1})
  call assert_equal(1, len(files))

  call delete('Xdir', 'rf')
endfunc

[codecov-io]

Codecov Report

Merging #2439 into master will increase coverage by 0.02%.
The diff coverage is 90.9%.

@@            Coverage Diff             @@
##           master    #2439      +/-   ##
==========================================
+ Coverage   74.48%    74.5%   +0.02%     
==========================================
  Files          92       92              
  Lines      132744   132798      +54     
  Branches    29123    29136      +13     
==========================================
+ Hits        98878    98947      +69     
+ Misses      33835    33820      -15     
  Partials       31       31

Impacted Files	Coverage Δ
src/eval.c	81.01% <ø> (ø)	⬆️
src/evalfunc.c	83.84% <90.9%> (+0.07%)	⬆️
src/channel.c	82.68% <0%> (-0.13%)	⬇️
src/if_py_both.h	76.59% <0%> (-0.01%)	⬇️
src/window.c	81.28% <0%> (+0.06%)	⬆️
src/gui.c	47.5% <0%> (+0.2%)	⬆️
src/term.c	50.75% <0%> (+0.21%)	⬆️
src/message.c	68.72% <0%> (+0.24%)	⬆️
src/gui_gtk_x11.c	47.8% <0%> (+0.24%)	⬆️
src/if_xcmdsrv.c	84.71% <0%> (+0.53%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a6d4849...efbb6d8. Read the comment docs.

[k-takata]

{max} -> {expr}

[chrisbra]

it might be silly, but would it make sense to have an indication on the returned list, whether the resulting entry is a directory?
E.g. instead of this:

let files = readdir('Xdir')
call assert_equal(['bar.txt', 'dir', 'foo.txt'], files)

let files = readdir('Xdir')
call assert_equal(['bar.txt', 'dir/', 'foo.txt'], files)

one more thing to think about it, would it make sense to return a recursive list of matches?

[mattn]

I'm thinking that return recursive list is over work. But it can be done with:

function! s:tree(dir)
  return {a:dir : map(readdir(a:dir), {_,x -> isdirectory(x) ? {x : s:tree(a:dir . '/' . x)} : x})}
endfunction

echo s:tree(".")

Appending suffix '/' may be useful to know the item is directory easily.

[chrisbra]

that example should be added to the documentation :)

[k-takata]

< is needed in the top of this line.

[Shougo]

#696
#1099

It may fix the delete('rf')problems.
delete('rf') uses glob() internally.
But it should use readdir() instead.

[brammool]

Yasuhiro Matsumoto wrote:

glob() is bit difficult to use to get file list in Vim script since it depend on suffixes or wildignore. So this change add new API `readdir()`. readdir() take 1 or 2 arguments. first one is a path to the directory to be listed files. sencond one is expr to add or ignore for the result. 1 to add the filename. 0 to ignore. If you set -1 to expr, readdir() stop to read. Below is test code.

Hmm, this results in a large overlap of functionality between glob() and readdir(). Each covers a part of the functionality, a lot can be done with either, and there will still be things that neither can do and will have to be added later. Using readdir() for recursive stuff is a bit complicated, while with glob() that's easy. The use of a filter function is nice for readdir() and lacking from glob(). Also, glob() has gained several optional arguments over the year, which now make it clumsy to use. How about this instead: glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) glob({expr}, {dict}) The first form is what we already have, we keep supporting it. The second form passes arguments in a dictionary. Members are: nosuf as the {nosuf} argument list as the {list} argument (could be default on) alllinks as the {alllinks} argument filter function like the readdir() function has Then you can use: global('*', filter) like the proposed readdir() function. But you can also do: global('**', filter) To make it work recursively. We can also add an option to add a slash to directory names: dirslash

let files = readdir('Xdir', {x->stridx(x,'f')!=-1})

If you write a lambda function, please put spaces around the "->", otherwise it starts looking like C code :-).

…

-- hundred-and-one symptoms of being an internet addict: 93. New mail alarm on your palmtop annoys other churchgoers. /// Bram Moolenaar -- Bram@Moolenaar.net -- http://www.Moolenaar.net \\\ /// sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ \\\ \\\ an exciting new programming language -- http://www.Zimbu.org /// \\\ help me help AIDS victims -- http://ICCF-Holland.org ///