lunarmodules / Penlight / 574

pending completion

Build # 574

Build Type

Pull #350

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/lunarmodules/Penlight/commit/<a class=hub.com/lunarmodules/Penlight/commit/f7ab769c0d684ae523a81fa6eb92a5683b1d12a9">f7ab769c0<a href="https://github.com/lunarmodules/Penlight/commit/f7ab769c0d684ae523a81fa6eb92a5683b1d12a9">">Merge </a><a class="double-link" href="https://github.com/lunarmodules/Penlight/commit/<a class="double-link" href="https://github.com/lunarmodules/Penlight/commit/5d236721dbf987399a284923dfc45abe91df480b">5d236721d</a>">5d236721d</a><a href="https://github.com/lunarmodules/Penlight/commit/f7ab769c0d684ae523a81fa6eb92a5683b1d12a9"> into 157901358">157901358</a>

Pull Request Pull Request #350: pl.dir: convert dir.walk from coroutines to iterators, take 2

Run Details

14 of 14 new or added lines in 1 file covered. (100.0%)

4897 of 5694 relevant lines covered (86.0%)

2101.03 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

51.03

/lua/pl/dir.lua

--- Listing files in directories and creating/removing directory paths.
--
-- Dependencies: `pl.utils`, `pl.path`
--
-- Soft Dependencies: `alien`, `ffi` (either are used on Windows for copying/moving files)
-- @module pl.dir

local utils = require 'pl.utils'
local path = require 'pl.path'
local is_windows = path.is_windows
local ldir = path.dir
local mkdir = path.mkdir
local rmdir = path.rmdir
local sub = string.sub
local os,pcall,ipairs,pairs,require,setmetatable = os,pcall,ipairs,pairs,require,setmetatable
local remove = os.remove
local append = table.insert
local assert_arg,assert_string,raise = utils.assert_arg,utils.assert_string,utils.raise

local exists, isdir = path.exists, path.isdir
local sep = path.sep

local dir = {}

local function makelist(l)
    return setmetatable(l, require('pl.List'))
end

local function assert_dir (n,val)
    assert_arg(n,val,'string',path.isdir,'not a directory',4)
end

local function filemask(mask)
    mask = utils.escape(path.normcase(mask))
    return '^'..mask:gsub('%%%*','.*'):gsub('%%%?','.')..'$'
end

--- Test whether a file name matches a shell pattern.
-- Both parameters are case-normalized if operating system is
-- case-insensitive.
-- @string filename A file name.
-- @string pattern A shell pattern. The only special characters are
-- `'*'` and `'?'`: `'*'` matches any sequence of characters and
-- `'?'` matches any single character.
-- @treturn bool
-- @raise dir and mask must be strings
function dir.fnmatch(filename,pattern)
    assert_string(1,filename)
    assert_string(2,pattern)
    return path.normcase(filename):find(filemask(pattern)) ~= nil
end

--- Return a list of all file names within an array which match a pattern.
-- @tab filenames An array containing file names.
-- @string pattern A shell pattern.
-- @treturn List(string) List of matching file names.
-- @raise dir and mask must be strings
function dir.filter(filenames,pattern)
    assert_arg(1,filenames,'table')
    assert_string(2,pattern)
    local res = {}
    local mask = filemask(pattern)
    for i,f in ipairs(filenames) do
        if path.normcase(f):find(mask) then append(res,f) end
    end
    return makelist(res)
end

local function _listfiles(dirname,filemode,match)
    local res = {}
    local check = utils.choose(filemode,path.isfile,path.isdir)
    if not dirname then dirname = '.' end
    for f in ldir(dirname) do
        if f ~= '.' and f ~= '..' then
            local p = path.join(dirname,f)
            if check(p) and (not match or match(f)) then
                append(res,p)
            end
        end
    end
    return makelist(res)
end

--- return a list of all files in a directory which match a shell pattern.
-- @string dirname A directory. If not given, all files in current directory are returned.
-- @string mask  A shell pattern. If not given, all files are returned.
-- @treturn {string} list of files
-- @raise dirname and mask must be strings
function dir.getfiles(dirname,mask)
    assert_dir(1,dirname)
    if mask then assert_string(2,mask) end
    local match
    if mask then
        mask = filemask(mask)
        match = function(f)
            return path.normcase(f):find(mask)
        end
    end
    return _listfiles(dirname,true,match)
end

--- return a list of all subdirectories of the directory.
-- @string dirname A directory
-- @treturn {string} a list of directories
-- @raise dir must be a a valid directory
function dir.getdirectories(dirname)
    assert_dir(1,dirname)
    return _listfiles(dirname,false)
end

local alien,ffi,ffi_checked,CopyFile,MoveFile,GetLastError,win32_errors,cmd_tmpfile

local function execute_command(cmd,parms)
   if not cmd_tmpfile then cmd_tmpfile = path.tmpname () end
   local err = path.is_windows and ' > ' or ' 2> '
    cmd = cmd..' '..parms..err..utils.quote_arg(cmd_tmpfile)
    local ret = utils.execute(cmd)
    if not ret then
        local err = (utils.readfile(cmd_tmpfile):gsub('\n(.*)',''))
        remove(cmd_tmpfile)
        return false,err
    else
        remove(cmd_tmpfile)
        return true
    end
end

local function find_ffi_copyfile ()
    if not ffi_checked then
        ffi_checked = true
        local res
        res,alien = pcall(require,'alien')
        if not res then
            alien = nil
            res, ffi = pcall(require,'ffi')
        end
        if not res then
            ffi = nil
            return
        end
    else
        return
    end
    if alien then
        -- register the Win32 CopyFile and MoveFile functions
        local kernel = alien.load('kernel32.dll')
        CopyFile = kernel.CopyFileA
        CopyFile:types{'string','string','int',ret='int',abi='stdcall'}
        MoveFile = kernel.MoveFileA
        MoveFile:types{'string','string',ret='int',abi='stdcall'}
        GetLastError = kernel.GetLastError
        GetLastError:types{ret ='int', abi='stdcall'}
    elseif ffi then
        ffi.cdef [[
            int CopyFileA(const char *src, const char *dest, int iovr);
            int MoveFileA(const char *src, const char *dest);
            int GetLastError();
        ]]
        CopyFile = ffi.C.CopyFileA
        MoveFile = ffi.C.MoveFileA
        GetLastError = ffi.C.GetLastError
    end
    win32_errors = {
        ERROR_FILE_NOT_FOUND    =         2,
        ERROR_PATH_NOT_FOUND    =         3,
        ERROR_ACCESS_DENIED    =          5,
        ERROR_WRITE_PROTECT    =          19,
        ERROR_BAD_UNIT         =          20,
        ERROR_NOT_READY        =          21,
        ERROR_WRITE_FAULT      =          29,
        ERROR_READ_FAULT       =          30,
        ERROR_SHARING_VIOLATION =         32,
        ERROR_LOCK_VIOLATION    =         33,
        ERROR_HANDLE_DISK_FULL  =         39,
        ERROR_BAD_NETPATH       =         53,
        ERROR_NETWORK_BUSY      =         54,
        ERROR_DEV_NOT_EXIST     =         55,
        ERROR_FILE_EXISTS       =         80,
        ERROR_OPEN_FAILED       =         110,
        ERROR_INVALID_NAME      =         123,
        ERROR_BAD_PATHNAME      =         161,
        ERROR_ALREADY_EXISTS    =         183,
    }
end

local function two_arguments (f1,f2)
    return utils.quote_arg(f1)..' '..utils.quote_arg(f2)
end

local function file_op (is_copy,src,dest,flag)
    if flag == 1 and path.exists(dest) then
        return false,"cannot overwrite destination"
    end
    if is_windows then
        -- if we haven't tried to load Alien/LuaJIT FFI before, then do so
        find_ffi_copyfile()
        -- fallback if there's no Alien, just use DOS commands *shudder*
        -- 'rename' involves a copy and then deleting the source.
        if not CopyFile then
            if path.is_windows then
                src = src:gsub("/","\\")
                dest = dest:gsub("/","\\")
            end
            local res, err = execute_command('copy',two_arguments(src,dest))
            if not res then return false,err end
            if not is_copy then
                return execute_command('del',utils.quote_arg(src))
            end
            return true
        else
            if path.isdir(dest) then
                dest = path.join(dest,path.basename(src))
            end
            local ret
            if is_copy then ret = CopyFile(src,dest,flag)
            else ret = MoveFile(src,dest) end
            if ret == 0 then
                local err = GetLastError()
                for name,value in pairs(win32_errors) do
                    if value == err then return false,name end
                end
                return false,"Error #"..err
            else return true
            end
        end
    else -- for Unix, just use cp for now
        return execute_command(is_copy and 'cp' or 'mv',
            two_arguments(src,dest))
    end
end

--- copy a file.
-- @string src source file
-- @string dest destination file or directory
-- @bool flag true if you want to force the copy (default)
-- @treturn bool operation succeeded
-- @raise src and dest must be strings
function dir.copyfile (src,dest,flag)
    assert_string(1,src)
    assert_string(2,dest)
    flag = flag==nil or flag
    return file_op(true,src,dest,flag and 0 or 1)
end

--- move a file.
-- @string src source file
-- @string dest destination file or directory
-- @treturn bool operation succeeded
-- @raise src and dest must be strings
function dir.movefile (src,dest)
    assert_string(1,src)
    assert_string(2,dest)
    return file_op(false,src,dest,0)
end

local function _dirfiles(dirname,attrib)
    local dirs = {}
    local files = {}
    for f in ldir(dirname) do
        if f ~= '.' and f ~= '..' then
            local p = path.join(dirname,f)
            local mode = attrib(p,'mode')
            if mode=='directory' then
                append(dirs,f)
            else
                append(files,f)
            end
        end
    end
    return makelist(dirs), makelist(files)
end


--- return an iterator which walks through a directory tree starting at root.
-- The iterator returns (root,dirs,files)
-- Note that dirs and files are lists of names (i.e. you must say path.join(root,d)
-- to get the actual full path)
-- If bottom_up is false (or not present), then the entries at the current level are returned
-- before we go deeper. This means that you can modify the returned list of directories before
-- continuing.
-- This is a clone of os.walk from the Python libraries.
-- @string root A starting directory
-- @bool bottom_up False if we start listing entries immediately.
-- @bool follow_links follow symbolic links
-- @return an iterator returning root,dirs,files
-- @raise root must be a directory
function dir.walk(root,bottom_up,follow_links)
    assert_dir(1,root)
    local attrib
    if path.is_windows or not follow_links then
        attrib = path.attrib
    else
        attrib = path.link_attrib
    end

    local to_scan = { root }
    local to_return = {}
    local iter = function()
        while #to_scan > 0 do
            local current_root = table.remove(to_scan)
            local dirs,files = _dirfiles(current_root, attrib)
            for _, d in ipairs(dirs) do
                table.insert(to_scan, current_root..path.sep..d)
            end
            if not bottom_up then
                return current_root, dirs, files
            else
                table.insert(to_return, { current_root, dirs, files })
            end
        end
        if #to_return > 0 then
            return utils.unpack(table.remove(to_return))
        end
    end

    return iter
end

--- remove a whole directory tree.
-- @string fullpath A directory path
-- @return true or nil
-- @return error if failed
-- @raise fullpath must be a string
function dir.rmtree(fullpath)
    assert_dir(1,fullpath)
    if path.islink(fullpath) then return false,'will not follow symlink' end
    for root,dirs,files in dir.walk(fullpath,true) do
        for i,f in ipairs(files) do
            local res, err = remove(path.join(root,f))
            if not res then return nil,err end
        end
        local res, err = rmdir(root)
        if not res then return nil,err end
    end
    return true
end

local dirpat
if path.is_windows then
    dirpat = '(.+)\\[^\\]+$'
else
    dirpat = '(.+)/[^/]+$'
end

local _makepath
function _makepath(p)
    -- windows root drive case
    if p:find '^%a:[\\]*$' then
        return true
    end
   if not path.isdir(p) then
    local subp = p:match(dirpat)
    local ok, err = _makepath(subp)
    if not ok then return nil, err end
    return mkdir(p)
   else
    return true
   end
end

--- create a directory path.
-- This will create subdirectories as necessary!
-- @string p A directory path
-- @return true on success, nil + errormsg on failure
-- @raise failure to create
function dir.makepath (p)
    assert_string(1,p)
    if path.is_windows then
        p = p:gsub("/", "\\")
    end
    return _makepath(path.abspath(p))
end


--- clone a directory tree. Will always try to create a new directory structure
-- if necessary.
-- @string path1 the base path of the source tree
-- @string path2 the new base path for the destination
-- @func file_fun an optional function to apply on all files
-- @bool verbose an optional boolean to control the verbosity of the output.
--  It can also be a logging function that behaves like print()
-- @return true, or nil
-- @return error message, or list of failed directory creations
-- @return list of failed file operations
-- @raise path1 and path2 must be strings
-- @usage clonetree('.','../backup',copyfile)
function dir.clonetree (path1,path2,file_fun,verbose)
    assert_string(1,path1)
    assert_string(2,path2)
    if verbose == true then verbose = print end
    local abspath,normcase,isdir,join = path.abspath,path.normcase,path.isdir,path.join
    local faildirs,failfiles = {},{}
    if not isdir(path1) then return raise 'source is not a valid directory' end
    path1 = abspath(normcase(path1))
    path2 = abspath(normcase(path2))
    if verbose then verbose('normalized:',path1,path2) end
    -- particularly NB that the new path isn't fully contained in the old path
    if path1 == path2 then return raise "paths are the same" end
    local _,i2 = path2:find(path1,1,true)
    if i2 == #path1 and path2:sub(i2+1,i2+1) == path.sep then
        return raise 'destination is a subdirectory of the source'
    end
    local cp = path.common_prefix (path1,path2)
    local idx = #cp
    if idx == 0 then -- no common path, but watch out for Windows paths!
        if path1:sub(2,2) == ':' then idx = 3 end
    end
    for root,dirs,files in dir.walk(path1) do
        local opath = path2..root:sub(idx)
        if verbose then verbose('paths:',opath,root) end
        if not isdir(opath) then
            local ret = dir.makepath(opath)
            if not ret then append(faildirs,opath) end
            if verbose then verbose('creating:',opath,ret) end
        end
        if file_fun then
            for i,f in ipairs(files) do
                local p1 = join(root,f)
                local p2 = join(opath,f)
                local ret = file_fun(p1,p2)
                if not ret then append(failfiles,p2) end
                if verbose then
                    verbose('files:',p1,p2,ret)
                end
            end
        end
    end
    return true,faildirs,failfiles
end


-- each entry of the stack is an array with three items:
-- 1. the name of the directory
-- 2. the lfs iterator function
-- 3. the lfs iterator userdata
local function treeiter(iterstack)
    local diriter = iterstack[#iterstack]
    if not diriter then
      return -- done
    end

    local dirname = diriter[1]
    local entry = diriter[2](diriter[3])
    if not entry then
      table.remove(iterstack)
      return treeiter(iterstack) -- tail-call to try next
    end

    if entry ~= "." and entry ~= ".." then
        entry = dirname .. sep .. entry
        if exists(entry) then  -- Just in case a symlink is broken.
            local is_dir = isdir(entry)
            if is_dir then
                table.insert(iterstack, { entry, ldir(entry) })
            end
            return entry, is_dir
        end
    end

    return treeiter(iterstack) -- tail-call to try next
end


--- return an iterator over all entries in a directory tree
-- @string d a directory
-- @return an iterator giving pathname and mode (true for dir, false otherwise)
-- @raise d must be a non-empty string
function dir.dirtree( d )
    assert( d and d ~= "", "directory parameter is missing or empty" )

    local last = sub ( d, -1 )
    if last == sep or last == '/' then
        d = sub( d, 1, -2 )
    end

    local iterstack = { {d, ldir(d)} }

    return treeiter, iterstack
end


--- Recursively returns all the file starting at _path_. It can optionally take a shell pattern and
-- only returns files that match _shell_pattern_. If a pattern is given it will do a case insensitive search.
-- @string start_path  A directory. If not given, all files in current directory are returned.
-- @string shell_pattern A shell pattern. If not given, all files are returned.
-- @treturn List(string) containing all the files found recursively starting at _path_ and filtered by _shell_pattern_.
-- @raise start_path must be a directory
function dir.getallfiles( start_path, shell_pattern )
    assert_dir(1,start_path)
    shell_pattern = shell_pattern or "*"

    local files = {}
    local normcase = path.normcase
    for filename, mode in dir.dirtree( start_path ) do
        if not mode then
            local mask = filemask( shell_pattern )
            if normcase(filename):find( mask ) then
                files[#files + 1] = filename
            end
        end
    end

    return makelist(files)
end

return dir

1	--- Listing files in directories and creating/removing directory paths.
2	--
3	-- Dependencies: `pl.utils`, `pl.path`
4	--
5	-- Soft Dependencies: `alien`, `ffi` (either are used on Windows for copying/moving files)
6	-- @module pl.dir
7
8	local utils = require 'pl.utils'	8✔
9	local path = require 'pl.path'	8✔
10	local is_windows = path.is_windows	8✔
11	local ldir = path.dir	8✔
12	local mkdir = path.mkdir	8✔
13	local rmdir = path.rmdir	8✔
14	local sub = string.sub	8✔
15	local os,pcall,ipairs,pairs,require,setmetatable = os,pcall,ipairs,pairs,require,setmetatable	8✔
16	local remove = os.remove	8✔
17	local append = table.insert	8✔
18	local assert_arg,assert_string,raise = utils.assert_arg,utils.assert_string,utils.raise	8✔
19
20	local exists, isdir = path.exists, path.isdir	8✔
21	local sep = path.sep	8✔
22
23	local dir = {}	8✔
24
25	local function makelist(l)
26	return setmetatable(l, require('pl.List'))	56✔
27	end
28
29	local function assert_dir (n,val)
30	assert_arg(n,val,'string',path.isdir,'not a directory',4)	48✔
31	end
32
33	local function filemask(mask)
34	mask = utils.escape(path.normcase(mask))	1,328✔
35	return '^'..mask:gsub('%%%','.'):gsub('%%%?','.')..'$'	664✔
36	end
37
38	--- Test whether a file name matches a shell pattern.
39	-- Both parameters are case-normalized if operating system is
40	-- case-insensitive.
41	-- @string filename A file name.
42	-- @string pattern A shell pattern. The only special characters are
43	-- `''` and `'?'`: `''` matches any sequence of characters and
44	-- `'?'` matches any single character.
45	-- @treturn bool
46	-- @raise dir and mask must be strings
47	function dir.fnmatch(filename,pattern)	8✔
48	assert_string(1,filename)	72✔
49	assert_string(2,pattern)	72✔
50	return path.normcase(filename):find(filemask(pattern)) ~= nil	144✔
51	end
52
53	--- Return a list of all file names within an array which match a pattern.
54	-- @tab filenames An array containing file names.
55	-- @string pattern A shell pattern.
56	-- @treturn List(string) List of matching file names.
57	-- @raise dir and mask must be strings
58	function dir.filter(filenames,pattern)	8✔
59	assert_arg(1,filenames,'table')	8✔
60	assert_string(2,pattern)	8✔
61	local res = {}	8✔
62	local mask = filemask(pattern)	8✔
63	for i,f in ipairs(filenames) do	40✔
64	if path.normcase(f):find(mask) then append(res,f) end	48✔
65	end
66	return makelist(res)	8✔
67	end
68
69	local function _listfiles(dirname,filemode,match)
70	local res = {}	32✔
71	local check = utils.choose(filemode,path.isfile,path.isdir)	32✔
72	if not dirname then dirname = '.' end	32✔
73	for f in ldir(dirname) do	560✔
74	if f ~= '.' and f ~= '..' then	528✔
75	local p = path.join(dirname,f)	464✔
76	if check(p) and (not match or match(f)) then	704✔
77	append(res,p)	216✔
78	end
79	end
80	end
81	return makelist(res)	32✔
82	end
83
84	--- return a list of all files in a directory which match a shell pattern.
85	-- @string dirname A directory. If not given, all files in current directory are returned.
86	-- @string mask A shell pattern. If not given, all files are returned.
87	-- @treturn {string} list of files
88	-- @raise dirname and mask must be strings
89	function dir.getfiles(dirname,mask)	8✔
90	assert_dir(1,dirname)	24✔
91	if mask then assert_string(2,mask) end	24✔
92	local match
93	if mask then	24✔
94	mask = filemask(mask)	12✔
95	match = function(f)
96	return path.normcase(f):find(mask)	24✔
97	end
98	end
99	return _listfiles(dirname,true,match)	24✔
100	end
101
102	--- return a list of all subdirectories of the directory.
103	-- @string dirname A directory
104	-- @treturn {string} a list of directories
105	-- @raise dir must be a a valid directory
106	function dir.getdirectories(dirname)	8✔
107	assert_dir(1,dirname)	8✔
108	return _listfiles(dirname,false)	8✔
109	end
110
111	local alien,ffi,ffi_checked,CopyFile,MoveFile,GetLastError,win32_errors,cmd_tmpfile
112
113	local function execute_command(cmd,parms)
114	if not cmd_tmpfile then cmd_tmpfile = path.tmpname () end	44✔
115	local err = path.is_windows and ' > ' or ' 2> '	40✔
116	cmd = cmd..' '..parms..err..utils.quote_arg(cmd_tmpfile)	60✔
117	local ret = utils.execute(cmd)	40✔
118	if not ret then	40✔
119	local err = (utils.readfile(cmd_tmpfile):gsub('\n(.*)',''))	36✔
120	remove(cmd_tmpfile)	24✔
121	return false,err	24✔
122	else
123	remove(cmd_tmpfile)	16✔
124	return true	16✔
125	end
126	end
127
128	local function find_ffi_copyfile ()
129	if not ffi_checked then	×
130	ffi_checked = true	×
131	local res
132	res,alien = pcall(require,'alien')	×
133	if not res then	×
134	alien = nil	×
135	res, ffi = pcall(require,'ffi')	×
136	end
137	if not res then	×
138	ffi = nil	×
139	return	×
140	end
141	else
142	return	×
143	end
144	if alien then	×
145	-- register the Win32 CopyFile and MoveFile functions
146	local kernel = alien.load('kernel32.dll')	×
147	CopyFile = kernel.CopyFileA	×
148	CopyFile:types{'string','string','int',ret='int',abi='stdcall'}	×
149	MoveFile = kernel.MoveFileA	×
150	MoveFile:types{'string','string',ret='int',abi='stdcall'}	×
151	GetLastError = kernel.GetLastError	×
152	GetLastError:types{ret ='int', abi='stdcall'}	×
153	elseif ffi then	×
154	ffi.cdef [[	×
155	int CopyFileA(const char src, const char dest, int iovr);
156	int MoveFileA(const char src, const char dest);
157	int GetLastError();
158	]]	×
159	CopyFile = ffi.C.CopyFileA	×
160	MoveFile = ffi.C.MoveFileA	×
161	GetLastError = ffi.C.GetLastError	×
162	end
163	win32_errors = {	×
164	ERROR_FILE_NOT_FOUND = 2,
165	ERROR_PATH_NOT_FOUND = 3,
166	ERROR_ACCESS_DENIED = 5,
167	ERROR_WRITE_PROTECT = 19,
168	ERROR_BAD_UNIT = 20,
169	ERROR_NOT_READY = 21,
170	ERROR_WRITE_FAULT = 29,
171	ERROR_READ_FAULT = 30,
172	ERROR_SHARING_VIOLATION = 32,
173	ERROR_LOCK_VIOLATION = 33,
174	ERROR_HANDLE_DISK_FULL = 39,
175	ERROR_BAD_NETPATH = 53,
176	ERROR_NETWORK_BUSY = 54,
177	ERROR_DEV_NOT_EXIST = 55,
178	ERROR_FILE_EXISTS = 80,
179	ERROR_OPEN_FAILED = 110,
180	ERROR_INVALID_NAME = 123,
181	ERROR_BAD_PATHNAME = 161,
182	ERROR_ALREADY_EXISTS = 183,
183	}
184	end
185
186	local function two_arguments (f1,f2)
187	return utils.quote_arg(f1)..' '..utils.quote_arg(f2)	80✔
188	end
189
190	local function file_op (is_copy,src,dest,flag)
191	if flag == 1 and path.exists(dest) then	40✔
192	return false,"cannot overwrite destination"	×
193	end
194	if is_windows then	40✔
195	-- if we haven't tried to load Alien/LuaJIT FFI before, then do so
196	find_ffi_copyfile()	×
197	-- fallback if there's no Alien, just use DOS commands shudder
198	-- 'rename' involves a copy and then deleting the source.
199	if not CopyFile then	×
200	if path.is_windows then	×
201	src = src:gsub("/","\\")	×
202	dest = dest:gsub("/","\\")	×
203	end
204	local res, err = execute_command('copy',two_arguments(src,dest))	×
205	if not res then return false,err end	×
206	if not is_copy then	×
207	return execute_command('del',utils.quote_arg(src))	×
208	end
209	return true	×
210	else
211	if path.isdir(dest) then	×
212	dest = path.join(dest,path.basename(src))	×
213	end
214	local ret
215	if is_copy then ret = CopyFile(src,dest,flag)	×
216	else ret = MoveFile(src,dest) end	×
217	if ret == 0 then	×
218	local err = GetLastError()	×
219	for name,value in pairs(win32_errors) do	×
220	if value == err then return false,name end	×
221	end
222	return false,"Error #"..err	×
223	else return true	×
224	end
225	end
226	else -- for Unix, just use cp for now
227	return execute_command(is_copy and 'cp' or 'mv',	60✔
228	two_arguments(src,dest))	60✔
229	end
230	end
231
232	--- copy a file.
233	-- @string src source file
234	-- @string dest destination file or directory
235	-- @bool flag true if you want to force the copy (default)
236	-- @treturn bool operation succeeded
237	-- @raise src and dest must be strings
238	function dir.copyfile (src,dest,flag)	8✔
239	assert_string(1,src)	24✔
240	assert_string(2,dest)	24✔
241	flag = flag==nil or flag	24✔
242	return file_op(true,src,dest,flag and 0 or 1)	24✔
243	end
244
245	--- move a file.
246	-- @string src source file
247	-- @string dest destination file or directory
248	-- @treturn bool operation succeeded
249	-- @raise src and dest must be strings
250	function dir.movefile (src,dest)	8✔
251	assert_string(1,src)	16✔
252	assert_string(2,dest)	16✔
253	return file_op(false,src,dest,0)	16✔
254	end
255
256	local function _dirfiles(dirname,attrib)
257	local dirs = {}	×
258	local files = {}	×
259	for f in ldir(dirname) do	×
260	if f ~= '.' and f ~= '..' then	×
261	local p = path.join(dirname,f)	×
262	local mode = attrib(p,'mode')	×
263	if mode=='directory' then	×
264	append(dirs,f)	×
265	else
266	append(files,f)	×
267	end
268	end
269	end
270	return makelist(dirs), makelist(files)	×
271	end
272
273
274	--- return an iterator which walks through a directory tree starting at root.
275	-- The iterator returns (root,dirs,files)
276	-- Note that dirs and files are lists of names (i.e. you must say path.join(root,d)
277	-- to get the actual full path)
278	-- If bottom_up is false (or not present), then the entries at the current level are returned
279	-- before we go deeper. This means that you can modify the returned list of directories before
280	-- continuing.
281	-- This is a clone of os.walk from the Python libraries.
282	-- @string root A starting directory
283	-- @bool bottom_up False if we start listing entries immediately.
284	-- @bool follow_links follow symbolic links
285	-- @return an iterator returning root,dirs,files
286	-- @raise root must be a directory
287	function dir.walk(root,bottom_up,follow_links)	8✔
288	assert_dir(1,root)	×
289	local attrib
290	if path.is_windows or not follow_links then	×
291	attrib = path.attrib	×
292	else
293	attrib = path.link_attrib	×
294	end
295
296	local to_scan = { root }	×
297	local to_return = {}	×
298	local iter = function()
299	while #to_scan > 0 do	×
300	local current_root = table.remove(to_scan)	×
301	local dirs,files = _dirfiles(current_root, attrib)	×
302	for _, d in ipairs(dirs) do	×
303	table.insert(to_scan, current_root..path.sep..d)	×
304	end
305	if not bottom_up then	×
306	return current_root, dirs, files	×
307	else
308	table.insert(to_return, { current_root, dirs, files })	×
309	end
310	end
311	if #to_return > 0 then	×
312	return utils.unpack(table.remove(to_return))	×
313	end
314	end
315
316	return iter	×
317	end
318
319	--- remove a whole directory tree.
320	-- @string fullpath A directory path
321	-- @return true or nil
322	-- @return error if failed
323	-- @raise fullpath must be a string
324	function dir.rmtree(fullpath)	8✔
325	assert_dir(1,fullpath)	×
326	if path.islink(fullpath) then return false,'will not follow symlink' end	×
327	for root,dirs,files in dir.walk(fullpath,true) do	×
328	for i,f in ipairs(files) do	×
329	local res, err = remove(path.join(root,f))	×
330	if not res then return nil,err end	×
331	end
332	local res, err = rmdir(root)	×
333	if not res then return nil,err end	×
334	end
335	return true	×
336	end
337
338	local dirpat
339	if path.is_windows then	8✔
340	dirpat = '(.+)\\[^\\]+$'	×
341	else
342	dirpat = '(.+)/[^/]+$'	8✔
343	end
344
345	local _makepath
346	function _makepath(p)	7✔
347	-- windows root drive case
348	if p:find '^%a:[\\]*$' then	40✔
349	return true	×
350	end
351	if not path.isdir(p) then	60✔
352	local subp = p:match(dirpat)	32✔
353	local ok, err = _makepath(subp)	32✔
354	if not ok then return nil, err end	32✔
355	return mkdir(p)	32✔
356	else
357	return true	8✔
358	end
359	end
360
361	--- create a directory path.
362	-- This will create subdirectories as necessary!
363	-- @string p A directory path
364	-- @return true on success, nil + errormsg on failure
365	-- @raise failure to create
366	function dir.makepath (p)	8✔
367	assert_string(1,p)	8✔
368	if path.is_windows then	8✔
369	p = p:gsub("/", "\\")	×
370	end
371	return _makepath(path.abspath(p))	12✔
372	end
373
374
375	--- clone a directory tree. Will always try to create a new directory structure
376	-- if necessary.
377	-- @string path1 the base path of the source tree
378	-- @string path2 the new base path for the destination
379	-- @func file_fun an optional function to apply on all files
380	-- @bool verbose an optional boolean to control the verbosity of the output.
381	-- It can also be a logging function that behaves like print()
382	-- @return true, or nil
383	-- @return error message, or list of failed directory creations
384	-- @return list of failed file operations
385	-- @raise path1 and path2 must be strings
386	-- @usage clonetree('.','../backup',copyfile)
387	function dir.clonetree (path1,path2,file_fun,verbose)	8✔
388	assert_string(1,path1)	×
389	assert_string(2,path2)	×
390	if verbose == true then verbose = print end	×
391	local abspath,normcase,isdir,join = path.abspath,path.normcase,path.isdir,path.join	×
392	local faildirs,failfiles = {},{}	×
393	if not isdir(path1) then return raise 'source is not a valid directory' end	×
394	path1 = abspath(normcase(path1))	×
395	path2 = abspath(normcase(path2))	×
396	if verbose then verbose('normalized:',path1,path2) end	×
397	-- particularly NB that the new path isn't fully contained in the old path
398	if path1 == path2 then return raise "paths are the same" end	×
399	local _,i2 = path2:find(path1,1,true)	×
400	if i2 == #path1 and path2:sub(i2+1,i2+1) == path.sep then	×
401	return raise 'destination is a subdirectory of the source'	×
402	end
403	local cp = path.common_prefix (path1,path2)	×
404	local idx = #cp	×
405	if idx == 0 then -- no common path, but watch out for Windows paths!	×
406	if path1:sub(2,2) == ':' then idx = 3 end	×
407	end
408	for root,dirs,files in dir.walk(path1) do	×
409	local opath = path2..root:sub(idx)	×
410	if verbose then verbose('paths:',opath,root) end	×
411	if not isdir(opath) then	×
412	local ret = dir.makepath(opath)	×
413	if not ret then append(faildirs,opath) end	×
414	if verbose then verbose('creating:',opath,ret) end	×
415	end
416	if file_fun then	×
417	for i,f in ipairs(files) do	×
418	local p1 = join(root,f)	×
419	local p2 = join(opath,f)	×
420	local ret = file_fun(p1,p2)	×
421	if not ret then append(failfiles,p2) end	×
422	if verbose then	×
423	verbose('files:',p1,p2,ret)	×
424	end
425	end
426	end
427	end
428	return true,faildirs,failfiles	×
429	end
430
431
432	-- each entry of the stack is an array with three items:
433	-- 1. the name of the directory
434	-- 2. the lfs iterator function
435	-- 3. the lfs iterator userdata
436	local function treeiter(iterstack)
437	local diriter = iterstack[#iterstack]	800✔
438	if not diriter then	800✔
439	return -- done	16✔
440	end
441
442	local dirname = diriter[1]	784✔
443	local entry = diriter[2](diriter[3])	784✔
444	if not entry then	784✔
445	table.remove(iterstack)	56✔
446	return treeiter(iterstack) -- tail-call to try next	56✔
447	end
448
449	if entry ~= "." and entry ~= ".." then	728✔
450	entry = dirname .. sep .. entry	616✔
451	if exists(entry) then -- Just in case a symlink is broken.	924✔
452	local is_dir = isdir(entry)	616✔
453	if is_dir then	616✔
454	table.insert(iterstack, { entry, ldir(entry) })	40✔
455	end
456	return entry, is_dir	616✔
457	end
458	end
459
460	return treeiter(iterstack) -- tail-call to try next	112✔
461	end
462
463
464	--- return an iterator over all entries in a directory tree
465	-- @string d a directory
466	-- @return an iterator giving pathname and mode (true for dir, false otherwise)
467	-- @raise d must be a non-empty string
468	function dir.dirtree( d )	8✔
469	assert( d and d ~= "", "directory parameter is missing or empty" )	16✔
470
471	local last = sub ( d, -1 )	16✔
472	if last == sep or last == '/' then	16✔
473	d = sub( d, 1, -2 )	×
474	end
475
476	local iterstack = { {d, ldir(d)} }	16✔
477
478	return treeiter, iterstack	16✔
479	end
480
481
482	--- Recursively returns all the file starting at _path_. It can optionally take a shell pattern and
483	-- only returns files that match _shell_pattern_. If a pattern is given it will do a case insensitive search.
484	-- @string start_path A directory. If not given, all files in current directory are returned.
485	-- @string shell_pattern A shell pattern. If not given, all files are returned.
486	-- @treturn List(string) containing all the files found recursively starting at _path_ and filtered by _shell_pattern_.
487	-- @raise start_path must be a directory
488	function dir.getallfiles( start_path, shell_pattern )	8✔
489	assert_dir(1,start_path)	16✔
490	shell_pattern = shell_pattern or "*"	16✔
491
492	local files = {}	16✔
493	local normcase = path.normcase	16✔
494	for filename, mode in dir.dirtree( start_path ) do	956✔
495	if not mode then	616✔
496	local mask = filemask( shell_pattern )	576✔
497	if normcase(filename):find( mask ) then	864✔
498	files[#files + 1] = filename	48✔
499	end
500	end
501	end
502
503	return makelist(files)	16✔
504	end
505
506	return dir	8✔

lunarmodules / Penlight / 574

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous