Mercurial > hg > octave-nkf

annotate scripts/miscellaneous/movefile.m @ 17397:0bf2fc8562c9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update documentation for file and directory functions. * libinterp/corefcn/dirfns.cc(Fpwd, Freaddir, Fmkdir, Frmdir, Freadlink, Ffnmatch): Redo docstring. * libinterp/corefcn/dirfns.cc(Fcd): Redo docstring. Return previous working directory if nargout > 0. * libinterp/corefcn/dirfns.cc(Flink, Fsymlink, Frename): Redo docstring. Re-order return values so that highest numbered value is assigned first to avoid re-sizing octave_value_list each time. * libinterp/corefcn/syscalls.cc(Flstat, Fmkfifo, FS_ISREG, FS_ISDIR, FS_ISCHR, FS_ISBLK, FS_ISFIFO, FS_ISLNK, FS_ISSOCK): Redo docstring. * scripts/general/isdir.m: Add more xrefs to @seealso. * scripts/miscellaneous/copyfile.m: Add more xrefs to @seealso. * scripts/miscellaneous/dir.m: Redo docstring. * scripts/miscellaneous/ls.m: Add more xrefs to @seealso.m. * scripts/miscellaneous/movefile.m: Add more xrefs to @seealso.
author Rik <rik@octave.org>
date Mon, 09 Sep 2013 14:30:31 -0700
parents b6867a09d7cf
children 5b916efea542
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 12497
diff changeset
1 ## Copyright (C) 2005-2012 John W. Eaton
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
2 ##
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
4 ##
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6828
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6828
diff changeset
8 ## your option) any later version.
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
9 ##
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
14 ##
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6828
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6828
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
18
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
20 ## @deftypefn {Function File} {} movefile (@var{f1})
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
21 ## @deftypefnx {Function File} {} movefile (@var{f1}, @var{f2})
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
22 ## @deftypefnx {Function File} {} movefile (@var{f1}, @var{f2}, 'f')
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
23 ## @deftypefnx {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} movefile (@dots{})
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
24 ## Move the file @var{f1} to the destination @var{f2}.
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
25 ##
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
26 ## The name @var{f1} may contain globbing patterns. If @var{f1} expands to
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
27 ## multiple file names, @var{f2} must be a directory. If no destination
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
28 ## @var{f2} is specified then the destination is the present working directory.
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
29 ## If @var{f2} is a file name then @var{f1} is renamed to @var{f2}.
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
30 ## When the force flag @qcode{'f'} is given any existing files will be
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
31 ## overwritten without prompting.
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
32 ##
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
33 ## If successful, @var{status} is 1, and @var{msg}, @var{msgid} are empty
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
34 ## character strings (""). Otherwise, @var{status} is 0, @var{msg} contains a
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
35 ## system-dependent error message, and @var{msgid} contains a unique message
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
36 ## identifier. Note that the status code is exacly opposite that of the
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
37 ## @code{system} command.
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17394
diff changeset
38 ## @seealso{rename, copyfile, unlink, delete, glob}
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
39 ## @end deftypefn
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
40
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
41 function [status, msg, msgid] = movefile (f1, f2, force)
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
42
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
43 if (nargin < 1 || nargin > 3)
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
44 print_usage ();
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
45 endif
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
46
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6398
diff changeset
47 max_cmd_line = 1024;
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
48 status = true;
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
49 msg = "";
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
50 msgid = "";
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
51
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
52 ## FIXME: maybe use the same method as in ls to allow users control
6210
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6069
diff changeset
53 ## over the command that is executed.
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6069
diff changeset
54
11300
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH
John W. Eaton <jwe@octave.org>
parents: 10549
diff changeset
55 if (ispc () && ! isunix ()
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH
John W. Eaton <jwe@octave.org>
parents: 10549
diff changeset
56 && isempty (file_in_path (getenv ("PATH"), "mv.exe")))
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
57 ## Windows.
6210
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6069
diff changeset
58 cmd = "cmd /C move";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6069
diff changeset
59 cmd_force_flag = "/Y";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6069
diff changeset
60 else
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6069
diff changeset
61 cmd = "mv";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6069
diff changeset
62 cmd_force_flag = "-f";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6069
diff changeset
63 endif
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6069
diff changeset
64
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
65 ## Input type check.
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
66 if (! (ischar (f1) || iscellstr (f1)))
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
67 error ("movefile: F1 must be a character string or a cell array of character strings");
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
68 endif
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
69
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
70 if (nargin == 1)
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
71 f2 = pwd ();
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
72 elseif (! ischar (f2))
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
73 error ("movefile: F2 must be a character string");
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
74 endif
6069
67b1a61a85ce [project @ 2006-10-21 14:33:53 by jwe]
jwe
parents: 6047
diff changeset
75
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
76 if (nargin == 3 && strcmp (force, "f"))
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
77 cmd = [cmd " " cmd_force_flag];
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
78 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
79
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
80 ## If f1 isn't a cellstr convert it to one.
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
81 if (ischar (f1))
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
82 f1 = cellstr (f1);
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
83 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
84
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
85 ## If f1 has more than 1 element f2 must be a directory
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
86 isdir = (exist (f2, "dir") != 0);
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
87 if (length (f1) > 1 && ! isdir)
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
88 error ("movefile: when moving multiple files, F2 must be a directory");
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
89 endif
6069
67b1a61a85ce [project @ 2006-10-21 14:33:53 by jwe]
jwe
parents: 6047
diff changeset
90
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
91 ## Protect the file name(s).
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
92 f1 = glob (f1);
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
93 if (isempty (f1))
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
94 error ("movefile: no files to move");
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
95 endif
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
96 p1 = sprintf ('"%s" ', f1{:});
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
97 p2 = tilde_expand (f2);
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
98
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
99 if (isdir && length (p1) > max_cmd_line)
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
100 l2 = length (p2) + length (cmd) + 6;
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
101 while (! isempty (f1))
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
102 p1 = sprintf ('"%s" ', f1{1});
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
103 f1(1) = [];
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
104 while (! isempty (f1)
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
105 && (length (p1) + length (f1{1}) + l2 < max_cmd_line))
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
106 p1 = sprintf ('%s"%s" ', p1, f1{1});
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7540
diff changeset
107 f1(1) = [];
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
108 endwhile
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6398
diff changeset
109
11300
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH
John W. Eaton <jwe@octave.org>
parents: 10549
diff changeset
110 if (ispc () && ! isunix ()
12497
1536ed546219 Fix bug #32443 preventing 'pkg install' on Windows platforms.
Rik <octave@nomad.inbox5.com>
parents: 12211
diff changeset
111 && ! isempty (file_in_path (getenv ("PATH"), "cp.exe")))
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
112 p1 = strrep (p1, '\', '/');
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
113 p2 = strrep (p2, '\', '/');
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6398
diff changeset
114 endif
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6398
diff changeset
115
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6398
diff changeset
116 ## Move the file(s).
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
117 [err, msg] = system (sprintf ('%s %s "%s"', cmd, p1, p2));
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
118 if (err != 0)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7540
diff changeset
119 status = false;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7540
diff changeset
120 msgid = "movefile";
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6398
diff changeset
121 endif
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
122 endwhile
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
123 else
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
124 if (ispc () && ! isunix ()
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
125 && ! isempty (file_in_path (getenv ("PATH"), "cp.exe")))
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
126 p1 = strrep (p1, '\', '/');
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
127 p2 = strrep (p2, '\', '/');
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
128 endif
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
129
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
130 ## Move the file(s).
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
131 [err, msg] = system (sprintf ('%s %s "%s"', cmd, p1, p2));
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
132 if (err != 0)
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
133 status = false;
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
134 msgid = "movefile";
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
135 endif
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
136 endif
17394
b6867a09d7cf Return correct status code for copyfile, movefile.
Rik <rik@octave.org>
parents: 17338
diff changeset
137
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
138 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17281
diff changeset
139