Module luarocks.fs.win32.tools
fs operations implemented with third-party tools for Windows platform abstractions.
Download http://unxutils.sourceforge.net/ for Windows GNU utilities used by this module.
Functions
| exists (file) | Test for existance of a file. |
| current_dir () | Obtain current directory. |
| is_file (file) | Test is pathname is a regular file. |
| get_md5 (file, md5sum) | Get the MD5 checksum for a file. |
| change_dir (d) | Change the current directory. |
| change_dir_to_root () | Change directory to root. |
| pop_dir () | Change working directory to the previous in the dir stack. |
| execute_string (cmd) | Run the given command. |
| is_dir (file) | Test is pathname is a regular file. |
| make_dir (d) | Create a directory if it does not already exist. |
| remove_dir_if_empty (d) | Remove a directory if it is empty. |
| remove_dir_tree_if_empty (dir, d) | Remove a directory if it is empty. |
| copy (src, dest) | Copy a file. |
| copy_contents (src, dest) | Recursively copy the contents of a directory. |
| delete (arg) | Delete a file or a directory and all its contents. |
| list_dir (at) | List the contents of a directory. |
| find (at) | Recursively scan the contents of a directory. |
| download (url, filename) | Download a remote file. |
| zip (zipfile, ...) | Compress files in a .zip archive. |
| unzip (zipfile) | Uncompress files from a .zip archive. |
| unpack_archive (archive) | Unpack an archive. |
Functions
- exists (file)
-
Test for existance of a file.
Parameters:
file: string: filename to test
Returns:
-
boolean: true if file exists, false otherwise.
- current_dir ()
-
Obtain current directory.
Uses the module's internal dir stack.
Returns:
-
string: the absolute pathname of the current directory.
- is_file (file)
-
Test is pathname is a regular file.
Parameters:
file: string: pathname to test
Returns:
-
boolean: true if it is a regular file, false otherwise.
- get_md5 (file, md5sum)
-
Get the MD5 checksum for a file.
Parameters:
file: string: The file to be computed.md5sum:
Returns:
-
string: The MD5 checksum
- change_dir (d)
-
Change the current directory.
Uses the module's internal dir stack. This does not have exact
semantics of chdir, as it does not handle errors the same way,
but works well for our purposes for now.
Parameters:
d: string: The directory to switch to.
- change_dir_to_root ()
- Change directory to root. Allows leaving a directory (e.g. for deleting it) in a crossplatform way.
- pop_dir ()
- Change working directory to the previous in the dir stack.
- execute_string (cmd)
-
Run the given command.
The command is executed in the current directory in the dir stack.
Parameters:
cmd: string: No quoting/escaping is applied to the command.
Returns:
-
boolean: true if command succeeds (status code 0), false
otherwise.
- is_dir (file)
-
Test is pathname is a regular file.
Parameters:
file: string: pathname to test
Returns:
-
boolean: true if it is a regular file, false otherwise.
- make_dir (d)
-
Create a directory if it does not already exist.
If any of the higher levels in the path name does not exist
too, they are created as well.
Parameters:
d: string: pathname of directory to create.
Returns:
-
boolean: true on success, false on failure.
- remove_dir_if_empty (d)
-
Remove a directory if it is empty.
Does not return errors (for example, if directory is not empty or
if already does not exist)
Parameters:
d: string: pathname of directory to remove.
- remove_dir_tree_if_empty (dir, d)
-
Remove a directory if it is empty.
Does not return errors (for example, if directory is not empty or
if already does not exist)
Parameters:
dir: string: pathname of directory to remove.d:
- copy (src, dest)
-
Copy a file.
Parameters:
src: string: Pathname of sourcedest: string: Pathname of destination
Returns:
-
boolean or (boolean, string): true on success, false on failure,
plus an error message.
- copy_contents (src, dest)
-
Recursively copy the contents of a directory.
Parameters:
src: string: Pathname of sourcedest: string: Pathname of destination
Returns:
-
boolean or (boolean, string): true on success, false on failure,
plus an error message.
- delete (arg)
-
Delete a file or a directory and all its contents.
For safety, this only accepts absolute paths.
Parameters:
arg: string: Pathname of source
Returns:
-
boolean: true on success, false on failure.
- list_dir (at)
-
List the contents of a directory.
Parameters:
at: string or nil: directory to list (will be the current directory if none is given).
Returns:
-
table: an array of strings with the filenames representing
the contents of a directory.
- find (at)
-
Recursively scan the contents of a directory.
Parameters:
at: string or nil: directory to scan (will be the current directory if none is given).
Returns:
-
table: an array of strings with the filenames representing
the contents of a directory. Paths are returned with forward slashes.
- download (url, filename)
-
Download a remote file.
Parameters:
url: string: URL to be fetched.filename: string or nil: this function attempts to detect the resulting local filename of the remote file as the basename of the URL; if that is not correct (due to a redirection, for example), the local filename can be given explicitly as this second argument.
Returns:
-
boolean: true on success, false on failure.
- zip (zipfile, ...)
-
Compress files in a .zip archive.
Parameters:
zipfile: string: pathname of .zip archive to be created....: Filenames to be stored in the archive are given as additional arguments.
Returns:
-
boolean: true on success, false on failure.
- unzip (zipfile)
-
Uncompress files from a .zip archive.
Parameters:
zipfile: string: pathname of .zip archive to be extracted.
Returns:
-
boolean: true on success, false on failure.
- unpack_archive (archive)
-
Unpack an archive.
Extract the contents of an archive, detecting its format by
filename extension.
Parameters:
archive: string: Filename of archive.
Returns:
-
boolean or (boolean, string): true on success, false and an error message on failure.