Merge #6111 from ZyX-I/split-eval'/os-fileio

Refactor writefile() and create more tests for it

src/nvim/eval.c

@@ -30,6 +30,7 @@
 #include "nvim/ex_eval.h"
 #include "nvim/ex_getln.h"
 #include "nvim/fileio.h"
+#include "nvim/os/fileio.h"
 #include "nvim/func_attr.h"
 #include "nvim/fold.h"
 #include "nvim/getchar.h"
@@ -18467,29 +18468,60 @@ static void f_winsaveview(typval_T *argvars, typval_T *rettv, FunPtr fptr)
 }
 
 /// Writes list of strings to file
-static bool write_list(FILE *fd, list_T *list, bool binary)
+///
+/// @param  fp  File to write to.
+/// @param[in]  list  List to write.
+/// @param[in]  binary  Whether to write in binary mode.
+///
+/// @return true in case of success, false otherwise.
+static bool write_list(FileDescriptor *const fp, const list_T *const list,
+                       const bool binary)
 {
-  int ret = true;
+  int error = 0;
-
+  for (const listitem_T *li = list->lv_first; li != NULL; li = li->li_next) {
-  for (listitem_T *li = list->lv_first; li != NULL; li = li->li_next) {
+    const char *const s = (const char *)get_tv_string_chk(
-    for (char_u *s = get_tv_string(&li->li_tv); *s != NUL; ++s) {
+        (typval_T *)&li->li_tv);
-      if (putc(*s == '\n' ? NUL : *s, fd) == EOF) {
+    if (s == NULL) {
-        ret = false;
+      return false;
-        break;
+    }
+    const char *hunk_start = s;
+    for (const char *p = hunk_start;; p++) {
+      if (*p == NUL || *p == NL) {
+        if (p != hunk_start) {
+          const ptrdiff_t written = file_write(fp, hunk_start,
+                                               (size_t)(p - hunk_start));
+          if (written < 0) {
+            error = (int)written;
+            goto write_list_error;
+          }
+        }
+        if (*p == NUL) {
+          break;
+        } else {
+          hunk_start = p + 1;
+          const ptrdiff_t written = file_write(fp, (char[]){ NUL }, 1);
+          if (written < 0) {
+            error = (int)written;
+            break;
+          }
+        }
       }
     }
     if (!binary || li->li_next != NULL) {
-      if (putc('\n', fd) == EOF) {
+      const ptrdiff_t written = file_write(fp, "\n", 1);
-        ret = false;
+      if (written < 0) {
-        break;
+        error = (int)written;
+        goto write_list_error;
       }
     }
-    if (ret == false) {
-      EMSG(_(e_write));
-      break;
-    }
   }
-  return ret;
+  if ((error = file_fsync(fp)) != 0) {
+    goto write_list_error;
+  }
+  return true;
+write_list_error:
+  emsgf(_("E80: Error while writing: %s"), os_strerror(error));
+  return false;
 }
 
 /// Initializes a static list with 10 items.
@@ -18617,27 +18649,42 @@ static void f_writefile(typval_T *argvars, typval_T *rettv, FunPtr fptr)
   bool binary = false;
   bool append = false;
   if (argvars[2].v_type != VAR_UNKNOWN) {
-    if (vim_strchr(get_tv_string(&argvars[2]), 'b')) {
+    const char *const flags = (const char *)get_tv_string_chk(&argvars[2]);
+    if (flags == NULL) {
+      return;
+    }
+    if (strchr(flags, 'b')) {
       binary = true;
     }
-    if (vim_strchr(get_tv_string(&argvars[2]), 'a')) {
+    if (strchr(flags, 'a')) {
       append = true;
     }
   }
 
-  // Always open the file in binary mode, library functions have a mind of
+  const char buf[NUMBUFLEN];
-  // their own about CR-LF conversion.
+  const char *const fname = (const char *)get_tv_string_buf_chk(&argvars[1],
-  char_u *fname = get_tv_string(&argvars[1]);
+                                                                (char_u *)buf);
-  FILE *fd;
+  if (fname == NULL) {
-  if (*fname == NUL || (fd = mch_fopen((char *)fname,
+    return;
-       append ? APPENDBIN : WRITEBIN)) == NULL) {
+  }
-    EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
+  FileDescriptor *fp;
-    rettv->vval.v_number = -1;
+  int error;
+  rettv->vval.v_number = -1;
+  if (*fname == NUL) {
+    EMSG(_("E482: Can't open file with an empty name"));
+  } else if ((fp = file_open_new(&error, fname,
+                                 ((append ? kFileAppend : kFileTruncate)
+                                  | kFileCreate), 0666)) == NULL) {
+    emsgf(_("E482: Can't open file %s for writing: %s"),
+          fname, os_strerror(error));
   } else {
-    if (write_list(fd, argvars[0].vval.v_list, binary) == false) {
+    if (write_list(fp, argvars[0].vval.v_list, binary)) {
-      rettv->vval.v_number = -1;
+      rettv->vval.v_number = 0;
+    }
+    if ((error = file_free(fp)) != 0) {
+      emsgf(_("E80: Error when closing file %s: %s"),
+            fname, os_strerror(error));
     }
-    fclose(fd);
   }
 }
 /*

src/nvim/ex_cmds.c

@@ -1131,11 +1131,12 @@ static void do_filter(
    */
   ++no_wait_return;             /* don't call wait_return() while busy */
   if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
-          FALSE, FALSE, FALSE, TRUE) == FAIL) {
+                                false, false, false, true) == FAIL) {
-    msg_putchar('\n');                  /* keep message from buf_write() */
+    msg_putchar('\n');  // Keep message from buf_write().
-    --no_wait_return;
+    no_wait_return--;
-    if (!aborting())
+    if (!aborting()) {
-      (void)EMSG2(_(e_notcreate), itmp);        /* will call wait_return */
+      EMSG2(_("E482: Can't create file %s"), itmp);  // Will call wait_return.
+    }
     goto filterend;
   }
   if (curbuf != old_curbuf)

src/nvim/globals.h

@@ -1150,7 +1150,6 @@ EXTERN char_u e_noprev[] INIT(= N_("E34: No previous command"));
 EXTERN char_u e_noprevre[] INIT(= N_("E35: No previous regular expression"));
 EXTERN char_u e_norange[] INIT(= N_("E481: No range allowed"));
 EXTERN char_u e_noroom[] INIT(= N_("E36: Not enough room"));
-EXTERN char_u e_notcreate[] INIT(= N_("E482: Can't create file %s"));
 EXTERN char_u e_notmp[] INIT(= N_("E483: Can't get temp file name"));
 EXTERN char_u e_notopen[] INIT(= N_("E484: Can't open file %s"));
 EXTERN char_u e_notread[] INIT(= N_("E485: Can't read file %s"));

src/nvim/os/fileio.c

@@ -62,6 +62,8 @@ int file_open(FileDescriptor *const ret_fp, const char *const fname,
   FLAG(flags, kFileCreate, O_CREAT|O_WRONLY, kTrue, !(flags & kFileCreateOnly));
   FLAG(flags, kFileTruncate, O_TRUNC|O_WRONLY, kTrue,
        !(flags & kFileCreateOnly));
+  FLAG(flags, kFileAppend, O_APPEND|O_WRONLY, kTrue,
+       !(flags & kFileCreateOnly));
   FLAG(flags, kFileReadOnly, O_RDONLY, kFalse, wr != kTrue);
 #ifdef O_NOFOLLOW
   FLAG(flags, kFileNoSymlink, O_NOFOLLOW, kNone, true);
@@ -153,7 +155,11 @@ int file_fsync(FileDescriptor *const fp)
     fp->_error = 0;
     return error;
   }
-  return os_fsync(fp->fd);
+  const int error = os_fsync(fp->fd);
+  if (error != UV_EINVAL && error != UV_EROFS) {
+    return error;
+  }
+  return 0;
 }
 
 /// Buffer used for writing

src/nvim/os/fileio.h

@@ -30,6 +30,8 @@ typedef enum {
   kFileTruncate = 32,  ///< Truncate the file if it exists.
                        ///< Implies kFileWriteOnly. Cannot be used with
                        ///< kFileCreateOnly.
+  kFileAppend = 64,  ///< Append to the file. Implies kFileWriteOnly. Cannot
+                     ///< be used with kFileCreateOnly.
 } FileOpenFlags;
 
 static inline bool file_eof(const FileDescriptor *const fp)

test/functional/eval/writefile_spec.lua

@@ -0,0 +1,140 @@
+local helpers = require('test.functional.helpers')(after_each)
+local lfs = require('lfs')
+
+local clear = helpers.clear
+local eq = helpers.eq
+local funcs = helpers.funcs
+local meths = helpers.meths
+local exc_exec = helpers.exc_exec
+local read_file = helpers.read_file
+local write_file = helpers.write_file
+local redir_exec = helpers.redir_exec
+
+local fname = 'Xtest-functional-eval-writefile'
+local dname = fname .. '.d'
+local dfname_tail = '1'
+local dfname = dname .. '/' .. dfname_tail
+local ddname_tail = '2'
+local ddname = dname .. '/' .. ddname_tail
+
+before_each(function()
+  lfs.mkdir(dname)
+  lfs.mkdir(ddname)
+  clear()
+end)
+
+after_each(function()
+  os.remove(fname)
+  os.remove(dfname)
+  lfs.rmdir(ddname)
+  lfs.rmdir(dname)
+end)
+
+describe('writefile()', function()
+  it('writes empty list to a file', function()
+    eq(nil, read_file(fname))
+    eq(0, funcs.writefile({}, fname))
+    eq('', read_file(fname))
+    os.remove(fname)
+    eq(nil, read_file(fname))
+    eq(0, funcs.writefile({}, fname, 'b'))
+    eq('', read_file(fname))
+    os.remove(fname)
+    eq(nil, read_file(fname))
+    eq(0, funcs.writefile({}, fname, 'ab'))
+    eq('', read_file(fname))
+    os.remove(fname)
+    eq(nil, read_file(fname))
+    eq(0, funcs.writefile({}, fname, 'a'))
+    eq('', read_file(fname))
+  end)
+
+  it('writes list with an empty string to a file', function()
+    eq(0, exc_exec(
+       ('call writefile([$XXX_NONEXISTENT_VAR_XXX], "%s", "b")'):format(
+          fname)))
+    eq('', read_file(fname))
+    eq(0, exc_exec(('call writefile([$XXX_NONEXISTENT_VAR_XXX], "%s")'):format(
+        fname)))
+    eq('\n', read_file(fname))
+  end)
+
+  it('appends to a file', function()
+    eq(nil, read_file(fname))
+    eq(0, funcs.writefile({'abc', 'def', 'ghi'}, fname))
+    eq('abc\ndef\nghi\n', read_file(fname))
+    eq(0, funcs.writefile({'jkl'}, fname, 'a'))
+    eq('abc\ndef\nghi\njkl\n', read_file(fname))
+    os.remove(fname)
+    eq(nil, read_file(fname))
+    eq(0, funcs.writefile({'abc', 'def', 'ghi'}, fname, 'b'))
+    eq('abc\ndef\nghi', read_file(fname))
+    eq(0, funcs.writefile({'jkl'}, fname, 'ab'))
+    eq('abc\ndef\nghijkl', read_file(fname))
+  end)
+
+  it('correctly treats NLs', function()
+    eq(0, funcs.writefile({'\na\nb\n'}, fname, 'b'))
+    eq('\0a\0b\0', read_file(fname))
+    eq(0, funcs.writefile({'a\n\n\nb'}, fname, 'b'))
+    eq('a\0\0\0b', read_file(fname))
+  end)
+
+  it('correctly overwrites file', function()
+    eq(0, funcs.writefile({'\na\nb\n'}, fname, 'b'))
+    eq('\0a\0b\0', read_file(fname))
+    eq(0, funcs.writefile({'a\n'}, fname, 'b'))
+    eq('a\0', read_file(fname))
+  end)
+
+  it('shows correct file name when supplied numbers', function()
+    meths.set_current_dir(dname)
+    eq('\nE482: Can\'t open file 2 for writing: illegal operation on a directory',
+       redir_exec(('call writefile([42], %s)'):format(ddname_tail)))
+  end)
+
+  it('errors out with invalid arguments', function()
+    write_file(fname, 'TEST')
+    eq('\nE119: Not enough arguments for function: writefile',
+       redir_exec('call writefile()'))
+    eq('\nE119: Not enough arguments for function: writefile',
+       redir_exec('call writefile([])'))
+    eq('\nE118: Too many arguments for function: writefile',
+       redir_exec(('call writefile([], "%s", "b", 1)'):format(fname)))
+    for _, arg in ipairs({'0', '0.0', 'function("tr")', '{}', '"test"'}) do
+      eq('\nE686: Argument of writefile() must be a List',
+         redir_exec(('call writefile(%s, "%s", "b")'):format(arg, fname)))
+    end
+    for _, args in ipairs({'[], %s, "b"', '[], "' .. fname .. '", %s'}) do
+      eq('\nE806: using Float as a String',
+         redir_exec(('call writefile(%s)'):format(args:format('0.0'))))
+      eq('\nE730: using List as a String',
+         redir_exec(('call writefile(%s)'):format(args:format('[]'))))
+      eq('\nE731: using Dictionary as a String',
+         redir_exec(('call writefile(%s)'):format(args:format('{}'))))
+      eq('\nE729: using Funcref as a String',
+         redir_exec(('call writefile(%s)'):format(args:format('function("tr")'))))
+    end
+    eq('TEST', read_file(fname))
+  end)
+
+  it('stops writing to file after error in list', function()
+    local args = '["tset"] + repeat([%s], 3), "' .. fname .. '"'
+    eq('\nE806: using Float as a String',
+        redir_exec(('call writefile(%s)'):format(args:format('0.0'))))
+    eq('tset\n', read_file(fname))
+    write_file(fname, 'TEST')
+    eq('\nE730: using List as a String',
+        redir_exec(('call writefile(%s)'):format(args:format('[]'))))
+    eq('tset\n', read_file(fname))
+    write_file(fname, 'TEST')
+    eq('\nE731: using Dictionary as a String',
+        redir_exec(('call writefile(%s)'):format(args:format('{}'))))
+    eq('tset\n', read_file(fname))
+    write_file(fname, 'TEST')
+    eq('\nE729: using Funcref as a String',
+        redir_exec(('call writefile(%s)'):format(args:format('function("tr")'))))
+    eq('tset\n', read_file(fname))
+    write_file(fname, 'TEST')
+  end)
+end)

test/functional/helpers.lua

@@ -344,6 +344,16 @@ local function write_file(name, text, dont_dedent)
   file:close()
 end
 
+local function read_file(name)
+  local file = io.open(name, 'r')
+  if not file then
+    return nil
+  end
+  local ret = file:read('*a')
+  file:close()
+  return ret
+end
+
 local function source(code)
   local fname = tmpname()
   write_file(fname, code)
@@ -585,6 +595,7 @@ local M = {
   sleep = sleep,
   set_session = set_session,
   write_file = write_file,
+  read_file = read_file,
   os_name = os_name,
   rmdir = rmdir,
   mkdir = lfs.mkdir,