Mercurial > octave
changeset 28098:501553fcf6e2
unlink: throw error if operation fails and nargout == 0 (bug #57830).
* syscalls.cc (Funlink): Add nargout to DEFUN macro invocation.
Add command calling form to documentation.
Rename "err" to "status" in documentation.
Document that status variable is -1 if an error is encountered.
Based on nargout variable, either throw an error if operation failed, or return
status and msg information. Change BIST test to use name "status".
* textread.m, delete.m, zip.m, io.tst: Fix BIST tests for new behavior.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 18 Feb 2020 15:58:52 -0800 |
| parents | cd7331af2e97 |
| children | ce660f584f00 |
| files | libinterp/corefcn/syscalls.cc scripts/legacy/textread.m scripts/miscellaneous/delete.m scripts/miscellaneous/zip.m test/io.tst |
| diffstat | 5 files changed, 36 insertions(+), 21 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/syscalls.cc Tue Feb 18 15:20:47 2020 -0800 +++ b/libinterp/corefcn/syscalls.cc Tue Feb 18 15:58:52 2020 -0800 @@ -1073,13 +1073,14 @@ %! endif */ -DEFMETHODX ("unlink", Funlink, interp, args, , +DEFMETHODX ("unlink", Funlink, interp, args, nargout, doc: /* -*- texinfo -*- -@deftypefn {} {[@var{err}, @var{msg}] =} unlink (@var{file}) +@deftypefn {} {} unlink (@var{file}) +@deftypefnx {} {[@var{status}, @var{msg}] =} unlink (@var{file}) Delete the file named @var{file}. -If successful, @var{err} is 0 and @var{msg} is an empty string. -Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent +If successful, @var{status} is 0 and @var{msg} is an empty string. +Otherwise, @var{status} is -1 and @var{msg} contains a system-dependent error message. @seealso{delete, rmdir} @end deftypefn */) @@ -1089,6 +1090,7 @@ std::string name = args(0).xstring_value ("unlink: FILE must be a string"); + octave_value_list retval; std::string msg; octave::event_manager& evmgr = interp.get_event_manager (); @@ -1099,7 +1101,20 @@ evmgr.file_renamed (status == 0); - return ovl (status, msg); + if (nargout == 0) + { + if (status < 0) + error ("unlink: operation failed: %s", msg.c_str ()); + } + else + { + if (status < 0) + retval = ovl (-1.0, msg); + else + retval = ovl (0.0, ""); + } + + return retval; } /* @@ -1111,13 +1126,13 @@ %! endif %! fdisp (fid, pi); %! fclose (fid); -%! [err, msg] = unlink (file); -%! assert (err, 0); +%! [status, msg] = unlink (file); +%! assert (status, 0); %! assert (msg, ""); ## Test input validation -%!error unlink () -%!error unlink ("a", "b") +%!error <Invalid call> unlink () +%!error <Invalid call> unlink ("a", "b") %!error <FILE must be a string> unlink (123) */
--- a/scripts/legacy/textread.m Tue Feb 18 15:20:47 2020 -0800 +++ b/scripts/legacy/textread.m Tue Feb 18 15:58:52 2020 -0800 @@ -346,7 +346,7 @@ ## Read multiple lines using empty format string %!test %! f = tempname (); -%! unlink (f); +%! sts = unlink (f); %! fid = fopen (f, "w"); %! d = rand (1, 4); %! fprintf (fid, " %f %f %f %f ", d); @@ -358,7 +358,7 @@ ## Empty format, corner case = one line w/o EOL %!test %! f = tempname (); -%! unlink (f); +%! sts = unlink (f); %! fid = fopen (f, "w"); %! d = rand (1, 4); %! fprintf (fid, " %f %f %f %f ", d);
--- a/scripts/miscellaneous/delete.m Tue Feb 18 15:20:47 2020 -0800 +++ b/scripts/miscellaneous/delete.m Tue Feb 18 15:58:52 2020 -0800 @@ -80,7 +80,7 @@ %! delete (file); %! assert (! exist (file, "file")); %! unwind_protect_cleanup -%! unlink (file); +%! sts = unlink (file); %! end_unwind_protect %!test
--- a/scripts/miscellaneous/zip.m Tue Feb 18 15:20:47 2020 -0800 +++ b/scripts/miscellaneous/zip.m Tue Feb 18 15:58:52 2020 -0800 @@ -126,10 +126,10 @@ %! error ("unzipped file not equal to original file!"); %! endif %! unwind_protect_cleanup -%! unlink (filename); -%! unlink ([dirname, filesep, basename, ext]); -%! unlink (zipfile); -%! unlink ([zipfile ".zip"]); +%! sts = unlink (filename); +%! sts = unlink ([dirname, filesep, basename, ext]); +%! sts = unlink (zipfile); +%! sts = unlink ([zipfile ".zip"]); %! sts = rmdir (dirname); %! end_unwind_protect
--- a/test/io.tst Tue Feb 18 15:20:47 2020 -0800 +++ b/test/io.tst Tue Feb 18 15:58:52 2020 -0800 @@ -196,7 +196,7 @@ %! [load_status, load_files] = testls (1); %! %! for f = [save_files, load_files] -%! unlink (f{1}); +%! sts = unlink (f{1}); %! endfor %! %! assert (save_status && load_status); @@ -228,7 +228,7 @@ %! assert (s64, s64t); %! assert (u64, u64t); %! unwind_protect_cleanup -%! unlink (h5file); +%! sts = unlink (h5file); %! end_unwind_protect %!test @@ -407,11 +407,11 @@ %% Note use fprintf so output not sent to stdout %!test %! nm = tempname (); -%! fid1 = fopen (nm,"w"); +%! fid1 = fopen (nm, "w"); %! x = fprintf (fid1, "%s: %d\n", "test", 1); %! fclose (fid1); -%! fid2 = fopen (nm,"r"); -%! str = fscanf (fid2,"%s"); +%! fid2 = fopen (nm, "r"); +%! str = fscanf (fid2, "%s"); %! fclose (fid2); %! unlink (nm); %! assert (x, 8);