Mercurial > octave
view scripts/miscellaneous/movefile.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2005-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} movefile @var{f1} ## @deftypefnx {} {} movefile @var{f1} @var{f2} ## @deftypefnx {} {} movefile @var{f1} @var{f2} f ## @deftypefnx {} {} movefile (@var{f1}) ## @deftypefnx {} {} movefile (@var{f1}, @var{f2}) ## @deftypefnx {} {} movefile (@var{f1}, @var{f2}, 'f') ## @deftypefnx {} {[@var{status}] =} movefile (@dots{}) ## @deftypefnx {} {[@var{status}, @var{msg}] =} movefile (@dots{}) ## @deftypefnx {} {[@var{status}, @var{msg}, @var{msgid}] =} movefile (@dots{}) ## Move the source file or directory @var{f1} to the destination @var{f2}. ## ## The name @var{f1} may contain globbing patterns, or may be a cell array of ## strings. If @var{f1} expands to multiple filenames, @var{f2} must be a ## directory. ## ## If no destination @var{f2} is specified then the destination is the present ## working directory. If @var{f2} is a filename then @var{f1} is renamed to ## @var{f2}. ## ## When the force flag @qcode{'f'} is given any existing files will be ## overwritten without prompting. ## ## If successful, @var{status} is logical 1, and @var{msg}, @var{msgid} are ## empty character strings (""). Otherwise, @var{status} is logical 0, ## @var{msg} contains a system-dependent error message, and @var{msgid} ## contains a unique message identifier. Note that the status code is exactly ## opposite that of the @code{system} command. ## @seealso{rename, copyfile, unlink, delete, glob} ## @end deftypefn function [status, msg, msgid] = movefile (f1, f2, force) if (nargin < 1) print_usage (); endif max_cmd_line = 1024; sts = true; msg = ""; msgid = ""; ## FIXME: maybe use the same method as in ls to allow users control ## over the command that is executed. if (ispc () && ! isunix () && isempty (file_in_path (getenv ("PATH"), "mv.exe"))) ## Windows. cmd = "cmd /C move"; cmd_force_flag = "/Y"; else cmd = "mv"; cmd_force_flag = "-f"; endif ## Input type check. if (ischar (f1)) f1 = cellstr (f1); elseif (! iscellstr (f1)) error ("copyfile: F1 must be a string or a cell array of strings"); endif if (nargin == 1) f2 = pwd (); elseif (! ischar (f2)) error ("movefile: F2 must be a string"); endif if (nargin == 3 && strcmp (force, "f")) cmd = [cmd " " cmd_force_flag]; endif ## If f1 has more than 1 element f2 must be a directory isdir = isfolder (f2); if (numel (f1) > 1 && ! isdir) if (nargout == 0) error ("movefile: when copying multiple files, F2 must be a directory"); else status = false; msg = "when copying multiple files, F2 must be a directory"; msgid = "movefile"; return; endif endif ## Protect the filename(s). if (ispc ()) f1 = __wglob__ (f1); else f1 = glob (f1); endif if (isempty (f1)) if (nargout == 0) error ("movefile: no files to move"); else status = false; msg = "no files to move"; msgid = "movefile"; return; endif endif p1 = sprintf ('"%s" ', f1{:}); p2 = tilde_expand (f2); if (isdir && length (p1) > max_cmd_line) l2 = length (p2) + length (cmd) + 6; while (! isempty (f1)) p1 = sprintf ('"%s" ', f1{1}); f1(1) = []; while (! isempty (f1) && (length (p1) + length (f1{1}) + l2 < max_cmd_line)) p1 = sprintf ('%s"%s" ', p1, f1{1}); f1(1) = []; endwhile if (ispc () && ! isunix () && ! isempty (file_in_path (getenv ("PATH"), "cp.exe"))) p1 = strrep (p1, '\', '/'); p2 = strrep (p2, '\', '/'); endif ## Close old file(s) in editor __event_manager_file_remove__ (p1, p2); ## Move the file(s). [err, msg] = system (sprintf ('%s %s "%s"', cmd, p1, p2)); if (err != 0) sts = false; msgid = "movefile"; endif ## Load new file(s) in editor __event_manager_file_renamed__ (sts); endwhile else if (ispc () && ! isunix () && ! isempty (file_in_path (getenv ("PATH"), "cp.exe"))) p1 = strrep (p1, '\', '/'); p2 = strrep (p2, '\', '/'); endif ## Close old file(s) in editor __event_manager_file_remove__ (p1, p2); ## Move the file(s). [err, msg] = system (sprintf ('%s %s "%s"', cmd, p1, p2)); if (err != 0) sts = false; msgid = "movefile"; endif ## Load new file(s) in editor __event_manager_file_renamed__ (sts); endif if (nargout == 0) if (! sts) error ("movefile: operation failed: %s", msg); endif else status = sts; endif endfunction %!test %! unwind_protect %! f1 = tempname (); %! tmp_var = pi; %! save (f1, "tmp_var"); %! fid = fopen (f1, "rb"); %! assert (fid >= 0); %! orig_data = fread (fid); %! fclose (fid); %! f2 = tempname (); %! assert (movefile (f1, f2)); %! assert (! exist (f1, "file")); %! assert (exist (f2, "file")); %! fid = fopen (f2, "rb"); %! assert (fid >= 0); %! new_data = fread (fid); %! fclose (fid); %! if (orig_data != new_data) %! error ("moved file not equal to original file!"); %! endif %! unwind_protect_cleanup %! delete (f2); %! end_unwind_protect ## Test input validation %!error <Invalid call> movefile () %!error <F1 must be a string> movefile (1, "foobar") %!error <F2 must be a string> movefile ("foobar", 1) %!error <F2 must be a directory> movefile ({"a", "b"}, "%_NOT_A_DIR_%") %!error <no files to move> movefile ("%_NOT_A_FILENAME1_%", "%_NOT_A_FILENAME2_%")