octave: scripts/miscellaneous/bunzip2.m annotate

annotate scripts/miscellaneous/bunzip2.m @ 25885:75ed70a1c108

Overhaul unpack and associated functions (bug #54567). * unpack.m: Add input validation for third input FILETYPE. Add BIST test for input validation. Require FILETYPE to be a valid extension matching documentation such as "gz" or "zip". Override ext variable with specified filetype. Guarantee output variable filelist is set even when function fails to recognize FILETYPE. Adjust BIST test for gunzip to pass new function. * bunzip2.m: Call unpack with "bz2" filetype. * gunzip.m: Call unpack with "gz" filetype. * untar.m: Call unpack with "tar" filetype. * unzip.m: Call unpack with "zip" filetype. * build.m: Use Octave coding convention for space after function call. * test/pkg/pkg.tst: Use tar.gz archives for testing, not zip files which are not an allowed format.

author	Rik <rik@octave.org>
date	Mon, 17 Sep 2018 10:52:07 -0700
parents	6652d3823428
children	b9d72a2dac8f

rev	line source
25054 6652d3823428 maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	1 ## Copyright (C) 2006-2018 Bill Denney
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	2 ##
6082 588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	4 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	5 ## Octave is free software: you can redistribute it and/or modify it
6082 588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	7 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	8 ## (at your option) any later version.
6082 588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	9 ##
588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## GNU General Public License for more details.
6082 588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	14 ##
588721ac2140 [project @ 2006-10-25 03:46:17 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: 6599 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	17 ## <https://www.gnu.org/licenses/>.
6082 588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	18
588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	20 ## @deftypefn {} {@var{filelist} =} bunzip2 (@var{bzfile})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	21 ## @deftypefnx {} {@var{filelist} =} bunzip2 (@var{bzfile}, @var{dir})
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	22 ## Unpack the bzip2 archive @var{bzfile}.
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	23 ##
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	24 ## If @var{dir} is specified the files are unpacked in this directory rather
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	25 ## than the one where @var{bzfile} is located.
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	26 ##
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	27 ## The optional output @var{filelist} is a list of the uncompressed files.
12500 8f2056646dba Improve docstrings for archive functions (gzip, bzip2, etc.) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	28 ## @seealso{bzip2, unpack, gunzip, unzip, untar}
6082 588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	29 ## @end deftypefn
588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	30
588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	31 ## Author: Bill Denney <denney@seas.upenn.edu>
588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	32
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	33 function filelist = bunzip2 (bzfile, dir = [])
6082 588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	34
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	35 if (nargin < 1 \|\| nargin > 2)
6082 588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	36 print_usage ();
588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	37 endif
588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	38
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	39 if (isempty (dir))
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	40 dir = fileparts (bzfile);
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	41 endif
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	42
6599 08ca72d6ffc9 [project @ 2007-04-28 22:47:29 by jwe] jwe parents: 6248 diff changeset	43 if (nargout > 0)
25885 75ed70a1c108 Overhaul unpack and associated functions (bug #54567). Rik <rik@octave.org> parents: 25054 diff changeset	44 filelist = unpack (bzfile, dir, "bz2");
6599 08ca72d6ffc9 [project @ 2007-04-28 22:47:29 by jwe] jwe parents: 6248 diff changeset	45 else
25885 75ed70a1c108 Overhaul unpack and associated functions (bug #54567). Rik <rik@octave.org> parents: 25054 diff changeset	46 unpack (bzfile, dir, "bz2");
6599 08ca72d6ffc9 [project @ 2007-04-28 22:47:29 by jwe] jwe parents: 6248 diff changeset	47 endif
6082 588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	48
588721ac2140 [project @ 2006-10-25 03:46:17 by jwe] jwe parents: diff changeset	49 endfunction
17338 1c89599167a6 maint: End m-files with 1 blank line. Rik <rik@octave.org> parents: 14138 diff changeset	50
19258 a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	51
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	52 ## Tests for this m-file are located in bzip2.m
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	53 ## Remove from test statistics
a4e993343e93 Overhaul the archive family (bzip2, gzip, zip, tar) of m-files. Rik <rik@octave.org> parents: 17744 diff changeset	54 %!assert (1)

Mercurial > octave

annotate scripts/miscellaneous/bunzip2.m @ 25885:75ed70a1c108