Textadept
- Home |
- Download |
- Lua API |
- Source |
- Language Modules |
- Stats |
- Wiki |
- Mailing List
Contents
lfs
Extends the lfs
library to find files in directories.
Functions
dir_foreach
(utf8_dir, f, filter, exclude_FILTER, recursing)
Iterates over all files and sub-directories in the UTF-8-encoded directory
utf8_dir, calling function f on each file found.
Files f is called on do not match any pattern in string or table filter,
and, unless exclude_FILTER is true
, FILTER
as well. A filter table
contains Lua patterns that match filenames to exclude, with patterns matching
folders to exclude listed in a folders
sub-table. Patterns starting with
‘!’ exclude files and folders that do not match the pattern that follows. Use
a table of raw file extensions assigned to an extensions
key for fast
filtering by extension. All strings must be encoded in _G._CHARSET
, not
UTF-8.
Parameters:
utf8_dir
: A UTF-8-encoded directory path to iterate over.f
: Function to call with each full file path found. File paths are not encoded in UTF-8, but in_G._CHARSET
. If f returnsfalse
explicitly, iteration ceases.filter
: Optional filter for files and folders to exclude.exclude_FILTER
: Optional flag indicating whether or not to exclude the default filterFILTER
in the search. Iffalse
, addsFILTER
to filter. The default value isfalse
to include the default filter.recursing
: Utility flag indicating whether or not this function has been recursively called. This flag is used and set internally, and should not be set otherwise.
See also:
Tables
FILTER
Filter table containing common binary file extensions and version control
folders to exclude when iterating over files and directories using
dir_foreach
when its exclude_FILTER
argument is false
.
See also: