annotate scripts/miscellaneous/copyfile.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents a40b4060efff
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2005 John W. Eaton
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: 6679
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: 6679
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: 6679
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: 6679
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 -*-
6152
2eb0723b4fad [project @ 2006-11-11 19:07:17 by jwe]
jwe
parents: 6069
diff changeset
20 ## @deftypefn {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@var{f1}, @var{f2}, @var{force})
2eb0723b4fad [project @ 2006-11-11 19:07:17 by jwe]
jwe
parents: 6069
diff changeset
21 ## Copy the file @var{f1} to the new name @var{f2}. The name @var{f1}
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
22 ## may contain globbing patterns. If @var{f1} expands to multiple file
6152
2eb0723b4fad [project @ 2006-11-11 19:07:17 by jwe]
jwe
parents: 6069
diff changeset
23 ## names, @var{f2} must be a directory. If @var{force} is given and equals
2eb0723b4fad [project @ 2006-11-11 19:07:17 by jwe]
jwe
parents: 6069
diff changeset
24 ## the string "f" the copy operation will be forced.
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
25 ##
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
26 ## If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty\n\
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
27 ## character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
28 ## system-dependent error message, and @var{msgid} contains a unique\n\
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
29 ## message identifier.\n\
6152
2eb0723b4fad [project @ 2006-11-11 19:07:17 by jwe]
jwe
parents: 6069
diff changeset
30 ## @seealso{glob, movefile}
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
31 ## @end deftypefn
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
32
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
33 function [status, msg, msgid] = copyfile (f1, f2, force)
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
34
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
35 max_cmd_line = 1024;
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
36 status = true;
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
37 msg = "";
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
38 msgid = "";
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
39
6210
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
40 ## FIXME -- maybe use the same method as in ls to allow users control
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
41 ## over the command that is executed.
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
42
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6398
diff changeset
43 if (ispc () && ! isunix () && isempty (file_in_path (EXEC_PATH, "cp.exe")))
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
44 ## Windows.
6210
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
45 cmd = "cmd /C xcopy /E";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
46 cmd_force_flag = "/Y";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
47 else
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
48 cmd = "cp -r";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
49 cmd_force_flag = "-f";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
50 endif
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
51
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
52 if (nargin == 2 || nargin == 3)
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
53 ## Input type check.
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
54 if (! (ischar (f1) || iscellstr (f1)))
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
55 error ("copyfile: first argument must be a character string or a cell array of character strings");
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
56 endif
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
57
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
58 if (! ischar (f2))
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
59 error ("copyfile: second argument must be a character string");
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
60 endif
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
61
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
62 if (nargin == 3 && strcmp (force, "f"))
6210
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
63 cmd = strcat (cmd, " ", cmd_force_flag);
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
64 endif
6069
67b1a61a85ce [project @ 2006-10-21 14:33:53 by jwe]
jwe
parents: 6047
diff changeset
65
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
66 ## If f1 isn't a cellstr convert it to one.
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
67 if (ischar (f1))
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
68 f1 = cellstr (f1);
6069
67b1a61a85ce [project @ 2006-10-21 14:33:53 by jwe]
jwe
parents: 6047
diff changeset
69 endif
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
70
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
71 ## If f1 has more than 1 element f2 must be a directory
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
72 isdir = (exist (f2, "dir") != 0);
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
73 if (length(f1) > 1 && ! isdir)
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
74 error ("copyfile: when copying multiple files, second argument must be a directory");
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
75 endif
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
76
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
77 ## Protect the file name(s).
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
78 f1 = glob (f1);
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
79 p1 = sprintf ("\"%s\" ", f1{:});
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
80 p2 = tilde_expand (f2);
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
81
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
82 if (isdir && length(p1) > max_cmd_line)
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
83 l2 = length(p2) + length (cmd) + 6;
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
84 while (! isempty(f1))
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
85 p1 = sprintf ("\"%s\" ", f1{1});
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
86 f1(1) = [];
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
87 while (!isempty (f1) && (length(p1) + length(f1{1}) + l2 <
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
88 max_cmd_line))
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
89 p1 = sprintf ("%s\"%s\" ", p1, f1{1});
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
90 f1(1) = [];
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
91 endwhile
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
92
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
93 if (ispc () && ! isunix () && ! isempty (file_in_path (EXEC_PATH, "cp.exe")))
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
94 p1 = strrep (p1, "\\", "/");
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
95 p2 = strrep (p2, "\\", "/");
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
96 endif
6069
67b1a61a85ce [project @ 2006-10-21 14:33:53 by jwe]
jwe
parents: 6047
diff changeset
97
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
98 ## Copy the files.
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
99 [err, msg] = system (sprintf ("%s %s\"%s\"", cmd, p1, p2));
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
100 if (err < 0)
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
101 status = false;
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
102 msgid = "copyfile";
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
103 break;
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
104 endif
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
105 endwhile
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
106 else
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
107 if (ispc () && ! isunix () && ! isempty (file_in_path (EXEC_PATH, "cp.exe")))
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
108 p1 = strrep (p1, "\\", "/");
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
109 p2 = strrep (p2, "\\", "/");
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
110 endif
6398
9bd49ed48ee6 [project @ 2007-03-08 19:40:01 by jwe]
jwe
parents: 6233
diff changeset
111
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
112 ## Copy the files.
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
113 [err, msg] = system (sprintf ("%s %s\"%s\"", cmd, p1, p2));
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
114 if (err < 0)
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
115 status = false;
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
116 msgid = "copyfile";
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
117 endif
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
118 endif
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
119 else
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
120 print_usage ();
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
121 endif
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
122
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
123 endfunction