update packages

[CreaPhase.git] / octave_packages / m / miscellaneous / copyfile.m

diff --git a/octave_packages/m/miscellaneous/copyfile.m b/octave_packages/m/miscellaneous/copyfile.m
new file mode 100644 (file)
index 0000000..e2756ea
--- /dev/null
+++ b/octave_packages/m/miscellaneous/copyfile.m
@@ -0,0 +1,130 @@
+## Copyright (C) 2005-2012 John W. Eaton
+##
+## 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
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn  {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@var{f1}, @var{f2})
+## @deftypefnx {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@var{f1}, @var{f2}, 'f')
+## Copy the file @var{f1} to the new name @var{f2}.  The name @var{f1}
+## may contain globbing patterns.  If @var{f1} expands to multiple file
+## names, @var{f2} must be a directory.  If the force flag 'f' is given then
+## existing destination files will be overwritten without prompting.
+##
+## If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty
+## character strings.  Otherwise, @var{status} is 0, @var{msg} contains a
+## system-dependent error message, and @var{msgid} contains a unique
+## message identifier.
+## @seealso{movefile}
+## @end deftypefn
+
+function [status, msg, msgid] = copyfile (f1, f2, force)
+
+  max_cmd_line = 1024;
+  status = 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"), "cp.exe")))
+    ## Windows.
+    cmd = "cmd /C xcopy /E";
+    cmd_force_flag = "/Y";
+  else
+    cmd = "cp -r";
+    cmd_force_flag = "-f";
+  endif
+
+  if (nargin == 2 || nargin == 3)
+    ## Input type check.
+    if (! (ischar (f1) || iscellstr (f1)))
+      error ("copyfile: first argument must be a character string or a cell array of character strings");
+    endif
+
+    if (! ischar (f2))
+      error ("copyfile: second argument must be a character string");
+    endif
+
+    if (nargin == 3 && strcmp (force, "f"))
+      cmd = cstrcat (cmd, " ", cmd_force_flag);
+    endif
+
+    ## If f1 isn't a cellstr convert it to one.
+    if (ischar (f1))
+      f1 = cellstr (f1);
+    endif
+
+    ## If f1 has more than 1 element f2 must be a directory
+    isdir = (exist (f2, "dir") != 0);
+    if (length(f1) > 1 && ! isdir)
+      error ("copyfile: when copying multiple files, second argument must be a directory");
+    endif
+
+    ## Protect the file name(s).
+    f1 = glob (f1);
+    if (isempty (f1))
+      error ("copyfile: no files to move");
+    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
+
+        ## Copy the files.
+        [err, msg] = system (sprintf ("%s %s\"%s\"", cmd, p1, p2));
+        if (err < 0)
+          status = false;
+          msgid = "copyfile";
+          break;
+        endif
+      endwhile
+    else
+      if (ispc () && ! isunix ()
+          && ! isempty (file_in_path (getenv ("PATH"), "cp.exe")))
+        p1 = strrep (p1, "\\", "/");
+        p2 = strrep (p2, "\\", "/");
+      endif
+
+      ## Copy the files.
+      [err, msg] = system (sprintf ("%s %s\"%s\"", cmd, p1, p2));
+      if (err < 0)
+        status = false;
+        msgid = "copyfile";
+      endif
+    endif
+  else
+    print_usage ();
+  endif
+
+endfunction