octave-antonio: scripts/miscellaneous/tar.m annotate

annotate scripts/miscellaneous/tar.m @ 19697:4197fc428c7d

maint: Update copyright notices for 2015.

author	John W. Eaton <jwe@octave.org>
date	Wed, 11 Feb 2015 14:19:08 -0500
parents	db92e7e28e1f
children	ee7159d9a330

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19597 diff changeset	1 ## Copyright (C) 2005-2015 Søren Hauberg
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	2 ##
6049 04c2ad6d1679 [project @ 2006-10-13 14:32:15 by jwe] jwe parents: 5808 diff changeset	3 ## This file is part of Octave.
04c2ad6d1679 [project @ 2006-10-13 14:32:15 by jwe] jwe parents: 5808 diff changeset	4 ##
04c2ad6d1679 [project @ 2006-10-13 14:32:15 by jwe] jwe parents: 5808 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
04c2ad6d1679 [project @ 2006-10-13 14:32:15 by jwe] jwe parents: 5808 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: 6049 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: 6049 diff changeset	8 ## your option) any later version.
6049 04c2ad6d1679 [project @ 2006-10-13 14:32:15 by jwe] jwe parents: 5808 diff changeset	9 ##
04c2ad6d1679 [project @ 2006-10-13 14:32:15 by jwe] jwe parents: 5808 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
04c2ad6d1679 [project @ 2006-10-13 14:32:15 by jwe] jwe parents: 5808 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
04c2ad6d1679 [project @ 2006-10-13 14:32:15 by jwe] jwe parents: 5808 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
04c2ad6d1679 [project @ 2006-10-13 14:32:15 by jwe] jwe parents: 5808 diff changeset	13 ## General Public License for more details.
04c2ad6d1679 [project @ 2006-10-13 14:32:15 by jwe] jwe parents: 5808 diff changeset	14 ##
5807 29c4fb42b210 [project @ 2006-05-11 01:48:56 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: 6049 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: 6049 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5807 29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	18
29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	20 ## @deftypefn {Function File} {@var{filelist} =} tar (@var{tarfile}, @var{files})
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	21 ## @deftypefnx {Function File} {@var{filelist} =} tar (@var{tarfile}, @var{files}, @var{rootdir})
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	22 ## Pack the list of files and directories specified in @var{files} into the
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	23 ## TAR archive @var{tarfile}.
5808 a18d85bdff31 [project @ 2006-05-11 03:11:03 by jwe] jwe parents: 5807 diff changeset	24 ##
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	25 ## @var{files} is a character array or cell array of strings. Shell
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	26 ## wildcards in the filename such as @samp{*} or @samp{?} are accepted and
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	27 ## expanded. Directories are recursively traversed and all files are added to
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	28 ## the archive.
5807 29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	29 ##
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	30 ## If @var{rootdir} is defined then any files without absolute pathnames are
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	31 ## located relative to @var{rootdir} rather than the current directory.
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	32 ##
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	33 ## The optional output @var{filelist} is a list of the files that were included
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	34 ## in the archive.
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	35 ## @seealso{untar, unpack, bzip2, gzip, zip}
5807 29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	36 ## @end deftypefn
29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	37
17243 f4c8c66faf34 maint: Update source file encodings to UTF-8 and fix character errors Mike Miller <mtmiller@ieee.org> parents: 16724 diff changeset	38 ## Author: Søren Hauberg <hauberg@gmail.com>
5807 29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	39
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	40 function filelist = tar (tarfile, files, rootdir = ".")
5808 a18d85bdff31 [project @ 2006-05-11 03:11:03 by jwe] jwe parents: 5807 diff changeset	41
12500 8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	42 if (nargin < 2 \|\| nargin > 3)
8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	43 print_usage ();
8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	44 endif
5807 29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	45
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	46 if (! ischar (tarfile))
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	47 error ("tar: TARFILE must be a string");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	48 elseif (ischar (files))
12500 8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	49 files = cellstr (files);
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	50 elseif (! iscellstr (files))
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	51 error ("tar: FILES must be a character array or cellstr");
12500 8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	52 endif
5807 29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	53
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	54 rootdir = tilde_expand (rootdir);
5808 a18d85bdff31 [project @ 2006-05-11 03:11:03 by jwe] jwe parents: 5807 diff changeset	55
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	56 tarfile = make_absolute_filename (tarfile);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19535 diff changeset	57
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	58 cmd = sprintf ("tar cvf %s -C %s %s",
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	59 tarfile, rootdir, sprintf (" %s", files{:}));
12500 8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	60
8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	61 [status, output] = system (cmd);
5807 29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	62
12500 8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	63 if (status)
8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	64 error ("tar: tar exited with status = %d", status);
8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	65 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	66
12500 8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	67 if (nargout > 0)
8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	68 if (output(end) == "\n")
8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	69 output(end) = [];
5807 29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	70 endif
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	71 filelist = ostrsplit (output, "\n");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	72 filelist = filelist';
5808 a18d85bdff31 [project @ 2006-05-11 03:11:03 by jwe] jwe parents: 5807 diff changeset	73 endif
a18d85bdff31 [project @ 2006-05-11 03:11:03 by jwe] jwe parents: 5807 diff changeset	74
5807 29c4fb42b210 [project @ 2006-05-11 01:48:56 by jwe] jwe parents: diff changeset	75 endfunction
17338 1c89599167a6 maint: End m-files with 1 blank line. Rik <rik@octave.org> parents: 17243 diff changeset	76
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	77
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	78 %!xtest
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	79 %! ## test gzip together with gunzip
19535 827cc33ae05c avoid warning message in test for tar function John W. Eaton <jwe@octave.org> parents: 19258 diff changeset	80 %! orig_dir = pwd ();
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	81 %! unwind_protect
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	82 %! dirname = tempname;
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	83 %! assert (mkdir (dirname));
19535 827cc33ae05c avoid warning message in test for tar function John W. Eaton <jwe@octave.org> parents: 19258 diff changeset	84 %! chdir (dirname);
827cc33ae05c avoid warning message in test for tar function John W. Eaton <jwe@octave.org> parents: 19258 diff changeset	85 %! dirname2 = "dir2";
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	86 %! assert (mkdir (dirname2));
19535 827cc33ae05c avoid warning message in test for tar function John W. Eaton <jwe@octave.org> parents: 19258 diff changeset	87 %! fname1 = "f1";
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	88 %! fname2 = fullfile (dirname2, "f2");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	89 %! fid = fopen (fname1, "wt");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	90 %! assert (fid >= 0);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	91 %! fdisp (fid, "Hello World");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19535 diff changeset	92 %! fclose (fid);
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	93 %! fid = fopen (fname2, "wt");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	94 %! assert (fid >= 0);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	95 %! fdisp (fid, "Goodbye World");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19535 diff changeset	96 %! fclose (fid);
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	97 %! tarname = [tempname ".tar"];
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	98 %! filelist = tar (tarname, {dirname2, fname1});
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	99 %! if (! strcmp (filelist{3}, fname1))
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	100 %! error ("tar file contents does not match expected file");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	101 %! endif
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	102 %! if (! exist (tarname, "file"))
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	103 %! error ("tar archive file cannot be found!");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	104 %! endif
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	105 %! outdir = tempname;
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	106 %! untar (tarname, outdir);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	107 %! fid = fopen (fullfile (outdir, fname1), "rt");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	108 %! assert (fid >= 0);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	109 %! str = fgetl (fid);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	110 %! fclose (fid);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	111 %! assert (str, "Hello World");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	112 %! fid = fopen (fullfile (outdir, fname2), "rt");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	113 %! assert (fid >= 0);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	114 %! str = fgetl (fid);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	115 %! fclose (fid);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	116 %! assert (str, "Goodbye World");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	117 %! unwind_protect_cleanup
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	118 %! delete (tarname);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	119 %! confirm_recursive_rmdir (false, "local");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	120 %! rmdir (dirname, "s");
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	121 %! rmdir (outdir, "s");
19535 827cc33ae05c avoid warning message in test for tar function John W. Eaton <jwe@octave.org> parents: 19258 diff changeset	122 %! chdir (orig_dir);
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	123 %! end_unwind_protect
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	124
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	125 ## Test input validation
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	126 %!error tar ()
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	127 %!error tar (1)
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	128 %!error tar (1,2,3,4)
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	129 %!error <TARFILE must be a string> tar (1, "foobar")
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	130 %!error <FILES must be a character array or cellstr> tar ("foobar", 1)
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	131

Mercurial > octave-antonio

annotate scripts/miscellaneous/tar.m @ 19697:4197fc428c7d