annotate scripts/miscellaneous/copyfile.m @ 11587:c792872f8942

all script files: untabify and strip trailing whitespace
author John W. Eaton <jwe@octave.org>
date Thu, 20 Jan 2011 17:35:29 -0500
parents fd0a3ac60b0e
children 11faa69c4eaa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11300
diff changeset
1 ## Copyright (C) 2005-2011 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: 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
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7540
diff changeset
23 ## names, @var{f2} must be a directory. If @var{force} is given and equals
6152
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
11300
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH
John W. Eaton <jwe@octave.org>
parents: 10549
diff changeset
43 if (ispc () && ! isunix ()
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH
John W. Eaton <jwe@octave.org>
parents: 10549
diff changeset
44 && isempty (file_in_path (getenv ("PATH"), "cp.exe")))
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
45 ## Windows.
6210
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
46 cmd = "cmd /C xcopy /E";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
47 cmd_force_flag = "/Y";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
48 else
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
49 cmd = "cp -r";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
50 cmd_force_flag = "-f";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
51 endif
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe]
jwe
parents: 6152
diff changeset
52
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
53 if (nargin == 2 || nargin == 3)
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
54 ## Input type check.
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
55 if (! (ischar (f1) || iscellstr (f1)))
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
56 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
57 endif
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
58
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
59 if (! ischar (f2))
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
60 error ("copyfile: second argument must be a character string");
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
61 endif
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
62
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
63 if (nargin == 3 && strcmp (force, "f"))
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7352
diff changeset
64 cmd = cstrcat (cmd, " ", cmd_force_flag);
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
65 endif
6069
67b1a61a85ce [project @ 2006-10-21 14:33:53 by jwe]
jwe
parents: 6047
diff changeset
66
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
67 ## 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
68 if (ischar (f1))
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
69 f1 = cellstr (f1);
6069
67b1a61a85ce [project @ 2006-10-21 14:33:53 by jwe]
jwe
parents: 6047
diff changeset
70 endif
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
71
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
72 ## 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
73 isdir = (exist (f2, "dir") != 0);
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
74 if (length(f1) > 1 && ! isdir)
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
75 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
76 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
77
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
78 ## Protect the file name(s).
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6210
diff changeset
79 f1 = glob (f1);
7352
fab9bc33b949 [project @ 2008-01-07 18:54:45 by jwe]
jwe
parents: 7017
diff changeset
80 if (isempty (f1))
fab9bc33b949 [project @ 2008-01-07 18:54:45 by jwe]
jwe
parents: 7017
diff changeset
81 error ("copyfile: no files to move");
fab9bc33b949 [project @ 2008-01-07 18:54:45 by jwe]
jwe
parents: 7017
diff changeset
82 endif
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
83 p1 = sprintf ("\"%s\" ", f1{:});
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
84 p2 = tilde_expand (f2);
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
85
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
86 if (isdir && length(p1) > max_cmd_line)
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
87 l2 = length(p2) + length (cmd) + 6;
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
88 while (! isempty(f1))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
89 p1 = sprintf ("\"%s\" ", f1{1});
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
90 f1(1) = [];
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
91 while (!isempty (f1) && (length(p1) + length(f1{1}) + l2 <
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
92 max_cmd_line))
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
93 p1 = sprintf ("%s\"%s\" ", p1, f1{1});
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
94 f1(1) = [];
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
95 endwhile
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
96
11300
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH
John W. Eaton <jwe@octave.org>
parents: 10549
diff changeset
97 if (ispc () && ! isunix ()
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH
John W. Eaton <jwe@octave.org>
parents: 10549
diff changeset
98 && ! isempty (file_in_path (getenv ("PATH"), "cp.exe")))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
99 p1 = strrep (p1, "\\", "/");
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
100 p2 = strrep (p2, "\\", "/");
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
101 endif
6069
67b1a61a85ce [project @ 2006-10-21 14:33:53 by jwe]
jwe
parents: 6047
diff changeset
102
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
103 ## Copy the files.
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
104 [err, msg] = system (sprintf ("%s %s\"%s\"", cmd, p1, p2));
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
105 if (err < 0)
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
106 status = false;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
107 msgid = "copyfile";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
108 break;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
109 endif
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
110 endwhile
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
111 else
11300
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH
John W. Eaton <jwe@octave.org>
parents: 10549
diff changeset
112 if (ispc () && ! isunix ()
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH
John W. Eaton <jwe@octave.org>
parents: 10549
diff changeset
113 && ! isempty (file_in_path (getenv ("PATH"), "cp.exe")))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
114 p1 = strrep (p1, "\\", "/");
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
115 p2 = strrep (p2, "\\", "/");
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
116 endif
6398
9bd49ed48ee6 [project @ 2007-03-08 19:40:01 by jwe]
jwe
parents: 6233
diff changeset
117
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
118 ## Copy the files.
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
119 [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
120 if (err < 0)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
121 status = false;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
122 msgid = "copyfile";
6679
a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman]
dbateman
parents: 6645
diff changeset
123 endif
6047
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
124 endif
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
125 else
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
126 print_usage ();
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
127 endif
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
128
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe]
jwe
parents:
diff changeset
129 endfunction