diff options
author | zeertzjq <zeertzjq@outlook.com> | 2024-08-06 20:49:59 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-08-06 12:49:59 +0000 |
commit | 28fbba2092adb9659253434605cb94252241f5e0 (patch) | |
tree | e7665e98c3c87f3b57ab348d143da98196efdfcc /runtime | |
parent | b5f92c4e5c7428fe1c1f91620f4b545b30b49855 (diff) | |
download | rneovim-28fbba2092adb9659253434605cb94252241f5e0.tar.gz rneovim-28fbba2092adb9659253434605cb94252241f5e0.tar.bz2 rneovim-28fbba2092adb9659253434605cb94252241f5e0.zip |
vim-patch:9.1.0465: missing filecopy() function (#29989)
Problem: missing filecopy() function
Solution: implement filecopy() Vim script function
(Shougo Matsushita)
closes: vim/vim#12346
https://github.com/vim/vim/commit/60c8743ab6c90e402e6ed49d27455ef7e5698abe
Co-authored-by: Shougo Matsushita <Shougo.Matsu@gmail.com>
Diffstat (limited to 'runtime')
-rw-r--r-- | runtime/doc/builtin.txt | 9 | ||||
-rw-r--r-- | runtime/doc/usr_41.txt | 1 | ||||
-rw-r--r-- | runtime/lua/vim/_meta/vimfn.lua | 13 |
3 files changed, 23 insertions, 0 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index ad50d271b6..97baed6cc9 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -1610,6 +1610,15 @@ feedkeys({string} [, {mode}]) *feedkeys()* Return value is always 0. +filecopy({from}, {to}) *filecopy()* + Copy the file pointed to by the name {from} to {to}. The + result is a Number, which is |TRUE| if the file was copied + successfully, and |FALSE| when it failed. + If a file with name {to} already exists, it will fail. + Note that it does not handle directories (yet). + + This function is not available in the |sandbox|. + filereadable({file}) *filereadable()* The result is a Number, which is |TRUE| when a file with the name {file} exists, and can be read. If {file} doesn't exist, diff --git a/runtime/doc/usr_41.txt b/runtime/doc/usr_41.txt index ab2eecdfaf..b3911dfd09 100644 --- a/runtime/doc/usr_41.txt +++ b/runtime/doc/usr_41.txt @@ -855,6 +855,7 @@ System functions and manipulation of files: readblob() read a file into a Blob readdir() get a List of file names in a directory writefile() write a List of lines or Blob into a file + filecopy() copy a file {from} to {to} Date and Time: *date-functions* *time-functions* getftime() get last modification time of a file diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua index 4ec6925134..4f9cc881c1 100644 --- a/runtime/lua/vim/_meta/vimfn.lua +++ b/runtime/lua/vim/_meta/vimfn.lua @@ -1993,6 +1993,19 @@ function vim.fn.feedkeys(string, mode) end --- @return any function vim.fn.file_readable(file) end +--- Copy the file pointed to by the name {from} to {to}. The +--- result is a Number, which is |TRUE| if the file was copied +--- successfully, and |FALSE| when it failed. +--- If a file with name {to} already exists, it will fail. +--- Note that it does not handle directories (yet). +--- +--- This function is not available in the |sandbox|. +--- +--- @param from string +--- @param to string +--- @return 0|1 +function vim.fn.filecopy(from, to) end + --- The result is a Number, which is |TRUE| when a file with the --- name {file} exists, and can be read. If {file} doesn't exist, --- or is a directory, the result is |FALSE|. {file} is any |