octave-nkf: scripts/miscellaneous/copyfile.m annotate

annotate scripts/miscellaneous/copyfile.m @ 17744:d63878346099

maint: Update copyright notices for release.

author	John W. Eaton <jwe@octave.org>
date	Wed, 23 Oct 2013 22:09:27 -0400
parents	5b916efea542
children	08259ddc15a9

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 17514 diff changeset	1 ## Copyright (C) 2005-2013 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 --
12211 11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	20 ## @deftypefn {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@var{f1}, @var{f2})
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	21 ## @deftypefnx {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@var{f1}, @var{f2}, 'f')
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	22 ## Copy the file @var{f1} to the destination @var{f2}.
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	23 ##
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	24 ## 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	25 ## multiple file names, @var{f2} must be a directory.
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	26 ## 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	27 ## overwritten without prompting.
6047 176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	28 ##
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	29 ## 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	30 ## 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	31 ## system-dependent error message, and @var{msgid} contains a unique message
17514 5b916efea542 doc: spellcheck of documentation before 3.8 release. Rik <rik@octave.org> parents: 17397 diff changeset	32 ## identifier. Note that the status code is exactly opposite that of the
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	33 ## @code{system} command.
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17394 diff changeset	34 ## @seealso{movefile, rename, unlink, delete, glob}
6047 176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	35 ## @end deftypefn
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	36
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	37 function [status, msg, msgid] = copyfile (f1, f2, force)
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	38
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	39 if (nargin < 2 \|\| nargin > 3)
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	40 print_usage ();
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	41 endif
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	42
6679 a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman] dbateman parents: 6645 diff changeset	43 max_cmd_line = 1024;
6047 176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	44 status = true;
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	45 msg = "";
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	46 msgid = "";
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	47
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	48 ## 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: 6152 diff changeset	49 ## over the command that is executed.
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe] jwe parents: 6152 diff changeset	50
11300 4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH John W. Eaton <jwe@octave.org> parents: 10549 diff changeset	51 if (ispc () && ! isunix ()
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH John W. Eaton <jwe@octave.org> parents: 10549 diff changeset	52 && isempty (file_in_path (getenv ("PATH"), "cp.exe")))
6233 a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe] jwe parents: 6210 diff changeset	53 ## Windows.
6210 12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe] jwe parents: 6152 diff changeset	54 cmd = "cmd /C xcopy /E";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe] jwe parents: 6152 diff changeset	55 cmd_force_flag = "/Y";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe] jwe parents: 6152 diff changeset	56 else
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe] jwe parents: 6152 diff changeset	57 cmd = "cp -r";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe] jwe parents: 6152 diff changeset	58 cmd_force_flag = "-f";
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe] jwe parents: 6152 diff changeset	59 endif
12b676a0b183 [project @ 2006-12-07 02:37:17 by jwe] jwe parents: 6152 diff changeset	60
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	61 ## Input type check.
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	62 if (! (ischar (f1) \|\| iscellstr (f1)))
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	63 error ("copyfile: 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	64 endif
6233 a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe] jwe parents: 6210 diff changeset	65
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	66 if (! ischar (f2))
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	67 error ("copyfile: F2 must be a character string");
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 == 3 && strcmp (force, "f"))
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	71 cmd = [cmd " " cmd_force_flag];
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	72 endif
6069 67b1a61a85ce [project @ 2006-10-21 14:33:53 by jwe] jwe parents: 6047 diff changeset	73
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	74 ## 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	75 if (ischar (f1))
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	76 f1 = cellstr (f1);
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	77 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	78
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	79 ## 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	80 isdir = (exist (f2, "dir") != 0);
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	81 if (length (f1) > 1 && ! isdir)
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	82 error ("copyfile: when copying multiple files, F2 must be a directory");
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	83 endif
6679 a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman] dbateman parents: 6645 diff changeset	84
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	85 ## Protect the file name(s).
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	86 f1 = glob (f1);
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	87 if (isempty (f1))
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	88 error ("copyfile: no files to move");
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	89 endif
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	90 p1 = sprintf ('"%s" ', f1{:});
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	91 p2 = tilde_expand (f2);
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	92
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	93 if (isdir && length (p1) > max_cmd_line)
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	94 l2 = length (p2) + length (cmd) + 6;
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	95 while (! isempty (f1))
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	96 p1 = sprintf ('"%s" ', f1{1});
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	97 f1(1) = [];
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	98 while (! isempty (f1)
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	99 && (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	100 p1 = sprintf ('%s"%s" ', p1, f1{1});
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9245 diff changeset	101 f1(1) = [];
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	102 endwhile
6679 a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman] dbateman parents: 6645 diff changeset	103
11300 4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH John W. Eaton <jwe@octave.org> parents: 10549 diff changeset	104 if (ispc () && ! isunix ()
4ecc7bc5bc83 search PATH from environment for programs, not EXEC_PATH John W. Eaton <jwe@octave.org> parents: 10549 diff changeset	105 && ! 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	106 p1 = strrep (p1, '\', '/');
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	107 p2 = strrep (p2, '\', '/');
6679 a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman] dbateman parents: 6645 diff changeset	108 endif
6398 9bd49ed48ee6 [project @ 2007-03-08 19:40:01 by jwe] jwe parents: 6233 diff changeset	109
6679 a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman] dbateman parents: 6645 diff changeset	110 ## Copy the files.
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	111 [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	112 if (err != 0)
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9245 diff changeset	113 status = false;
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9245 diff changeset	114 msgid = "copyfile";
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	115 break;
6679 a40b4060efff [project @ 2007-05-31 20:07:23 by dbateman] dbateman parents: 6645 diff changeset	116 endif
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	117 endwhile
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	118 else
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	119 if (ispc () && ! isunix ()
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	120 && ! isempty (file_in_path (getenv ("PATH"), "cp.exe")))
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	121 p1 = strrep (p1, '\', '/');
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	122 p2 = strrep (p2, '\', '/');
6047 176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	123 endif
17394 b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	124
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	125 ## Copy the files.
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	126 [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	127 if (err != 0)
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	128 status = false;
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	129 msgid = "copyfile";
b6867a09d7cf Return correct status code for copyfile, movefile. Rik <rik@octave.org> parents: 17338 diff changeset	130 endif
6047 176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	131 endif
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	132
176f1c58a474 [project @ 2006-10-10 19:13:49 by jwe] jwe parents: diff changeset	133 endfunction
17338 1c89599167a6 maint: End m-files with 1 blank line. Rik <rik@octave.org> parents: 17281 diff changeset	134

Mercurial > hg > octave-nkf

annotate scripts/miscellaneous/copyfile.m @ 17744:d63878346099