octave: libinterp/corefcn/dirfns.cc annotate

annotate libinterp/corefcn/dirfns.cc @ 21966:112b20240c87

move docstrings in C++ files out of C strings and into comments * __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc, __ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc, bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc, dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc, hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc, load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc, oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc, pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc, sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc, time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc, utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc, audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc, convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc, ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc, ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc, ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc, ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc, pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy: Docstrings are now comments instead of C strings. * build-aux/mk-opts.pl: Emit docstrings as comments instead of C strings. * DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments. * builtins.h: Include builtin-defun-decls.h unconditionally. * defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration. (DEFALIAS): Always expand to nothing. * defun-dld.h: No special macro expansions for MAKE_BUILTINS. (DEFUN_DLD): Use FORWARD_DECLARE_FUN. (DEFUNX_DLD): Use FORWARD_DECLARE_FUNX. * defun-int.h: No special macro expansions for MAKE_BUILTINS. (FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros. (DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass "external-doc" to DEFINE_FUNX_INSTALLER_FUN. (DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL, DEFALIAS_INTERNAL): Delete. * common.mk (move_if_change_rule): New macro. (simple_move_if_change_rule): Define using move_if_change_rule. * find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file name extension to ".df". * libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files. * mkbuiltins: New argument, SRCDIR. Operate directly on source files. * mkdefs: Delete. * libinterp/module.mk (BUILT_SOURCES): Update list to contain only files included in other source files. (GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete. (LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here. (LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from the list. (libinterp_EXTRA_DIST): Remove mkdefs from the list. (FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES. (DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES. (SRC_DEFUN_FILES): Rename from SRC_DEF_FILES. (ALL_DEFUN_FILES): Rename from ALL_DEF_FILES. (%.df: %.cc): Delete pattern rule. (libinterp/build-env-features.cc, libinterp/builtins.cc, libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change. (libinterp/builtins.cc, libinterp/builtin-defun-decls.h): Update mkbuiltins command. ($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command. * liboctave/module.mk (BUILT_SOURCES): Don't include liboctave-build-info.cc in the list.

author	John W. Eaton <jwe@octave.org>
date	Tue, 21 Jun 2016 16:07:51 -0400
parents	aab79a1885cc
children	c2c668b3051b

rev	line source
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	1 /*
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	2
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19278 diff changeset	3 Copyright (C) 1994-2015 John W. Eaton
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	4
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	6
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	8 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	10 option) any later version.
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	11
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	15 for more details.
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	16
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	17 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: 7007 diff changeset	18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	19 <http://www.gnu.org/licenses/>.
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	20
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	21 */
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	22
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21696 diff changeset	23 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	24 # include "config.h"
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	25 #endif
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	26
1341 e4e4131b1648 [project @ 1995-09-04 00:13:33 by jwe] jwe parents: 1328 diff changeset	27 #include <cerrno>
e4e4131b1648 [project @ 1995-09-04 00:13:33 by jwe] jwe parents: 1328 diff changeset	28 #include <cstdio>
e4e4131b1648 [project @ 1995-09-04 00:13:33 by jwe] jwe parents: 1328 diff changeset	29 #include <cstddef>
e4e4131b1648 [project @ 1995-09-04 00:13:33 by jwe] jwe parents: 1328 diff changeset	30 #include <cstdlib>
e4e4131b1648 [project @ 1995-09-04 00:13:33 by jwe] jwe parents: 1328 diff changeset	31 #include <cstring>
e4e4131b1648 [project @ 1995-09-04 00:13:33 by jwe] jwe parents: 1328 diff changeset	32
5765 7ba9ad1fec11 [project @ 2006-04-17 05:05:15 by jwe] jwe parents: 5640 diff changeset	33 #include <sstream>
1728 42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1690 diff changeset	34 #include <string>
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1690 diff changeset	35
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2847 diff changeset	36 #include "file-ops.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2847 diff changeset	37 #include "file-stat.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2847 diff changeset	38 #include "glob-match.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2847 diff changeset	39 #include "oct-env.h"
5777 246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	40 #include "pathsearch.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	41 #include "str-vec.h"
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	42
5102 b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 4928 diff changeset	43 #include "Cell.h"
1355 94697d007075 [project @ 1995-09-05 20:04:15 by jwe] jwe parents: 1341 diff changeset	44 #include "defun.h"
1781 e090f89bf2f5 [project @ 1996-01-24 08:04:14 by jwe] jwe parents: 1773 diff changeset	45 #include "dir-ops.h"
1355 94697d007075 [project @ 1995-09-05 20:04:15 by jwe] jwe parents: 1341 diff changeset	46 #include "dirfns.h"
94697d007075 [project @ 1995-09-05 20:04:15 by jwe] jwe parents: 1341 diff changeset	47 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21078 diff changeset	48 #include "errwarn.h"
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5639 diff changeset	49 #include "input.h"
5832 5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe] jwe parents: 5823 diff changeset	50 #include "load-path.h"
16437 919796a440c6 use signal for changing directory John W. Eaton <jwe@octave.org> parents: 16094 diff changeset	51 #include "octave-link.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20918 diff changeset	52 #include "ovl.h"
1355 94697d007075 [project @ 1995-09-05 20:04:15 by jwe] jwe parents: 1341 diff changeset	53 #include "pager.h"
94697d007075 [project @ 1995-09-05 20:04:15 by jwe] jwe parents: 1341 diff changeset	54 #include "procstream.h"
94697d007075 [project @ 1995-09-05 20:04:15 by jwe] jwe parents: 1341 diff changeset	55 #include "sysdep.h"
1750 fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe] jwe parents: 1742 diff changeset	56 #include "toplev.h"
1449 df589c97e140 [project @ 1995-09-20 03:49:51 by jwe] jwe parents: 1402 diff changeset	57 #include "unwind-prot.h"
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	58 #include "utils.h"
1742 a02f140ed897 [project @ 1996-01-12 11:09:39 by jwe] jwe parents: 1728 diff changeset	59 #include "variables.h"
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	60
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5639 diff changeset	61 // TRUE means we ask for confirmation before recursively removing a
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5639 diff changeset	62 // directory tree.
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5639 diff changeset	63 static bool Vconfirm_recursive_rmdir = true;
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5639 diff changeset	64
6323 ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe] jwe parents: 6233 diff changeset	65 // The time we last time we changed directories.
21730 30c53770f47e use namespace for system time classes John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	66 octave::sys::time Vlast_chdir_time = 0.0;
6323 ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe] jwe parents: 6233 diff changeset	67
1328 ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe] jwe parents: 1315 diff changeset	68 static int
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3503 diff changeset	69 octave_change_to_directory (const std::string& newdir)
1328 ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe] jwe parents: 1315 diff changeset	70 {
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	71 std::string xdir = octave::sys::file_ops::tilde_expand (newdir);
16437 919796a440c6 use signal for changing directory John W. Eaton <jwe@octave.org> parents: 16094 diff changeset	72
21732 6a1eded90355 use namespace for system env class John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	73 int cd_ok = octave::sys::env::chdir (xdir);
1328 ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe] jwe parents: 1315 diff changeset	74
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	75 if (! cd_ok)
21942 aab79a1885cc limit gnulib headers to liboctave/wrappers directory John W. Eaton <jwe@octave.org> parents: 21897 diff changeset	76 error ("%s: %s", newdir.c_str (), std::strerror (errno));
6323 ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe] jwe parents: 6233 diff changeset	77
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	78 Vlast_chdir_time.stamp ();
5832 5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe] jwe parents: 5823 diff changeset	79
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	80 // FIXME: should these actions be handled as a list of functions
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	81 // to call so users can add their own chdir handlers?
16437 919796a440c6 use signal for changing directory John W. Eaton <jwe@octave.org> parents: 16094 diff changeset	82
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	83 load_path::update ();
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	84
21732 6a1eded90355 use namespace for system env class John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	85 octave_link::change_directory (octave::sys::env::get_current_directory ());
1328 ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe] jwe parents: 1315 diff changeset	86
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe] jwe parents: 1315 diff changeset	87 return cd_ok;
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe] jwe parents: 1315 diff changeset	88 }
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe] jwe parents: 1315 diff changeset	89
13912 8d19194c4b1f cd: behave like unixy shells for "cd" alone, but be Matlab compatible if doing "current_dir = cd" John W. Eaton <jwe@octave.org> parents: 12681 diff changeset	90 DEFUN (cd, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	91 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	92 @deftypefn {} {} cd @var{dir}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	93 @deftypefnx {} {} cd
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	94 @deftypefnx {} {@var{old_dir} =} cd (@var{dir})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	95 @deftypefnx {} {} chdir @dots{}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	96 Change the current working directory to @var{dir}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	97
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	98 If @var{dir} is omitted, the current directory is changed to the user's home
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	99 directory (@qcode{"~"}).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	100
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	101 For example,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	102
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	103 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	104 cd ~/octave
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	105 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	106
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	107 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	108 changes the current working directory to @file{~/octave}. If the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	109 directory does not exist, an error message is printed and the working
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	110 directory is not changed.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	111
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	112 @code{chdir} is an alias for @code{cd} and can be used in all of the same
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	113 calling formats.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	114
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	115 Compatibility Note: When called with no arguments, @sc{matlab} prints the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	116 present working directory rather than changing to the user's home directory.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	117 @seealso{pwd, mkdir, rmdir, dir, ls}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	118 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	119 {
20817 3d551b2ae928 Use variable name nargin consistently in C++ code. Rik <rik@octave.org> parents: 20804 diff changeset	120 int nargin = args.length ();
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20853 diff changeset	121
20817 3d551b2ae928 Use variable name nargin consistently in C++ code. Rik <rik@octave.org> parents: 20804 diff changeset	122 if (nargin > 1)
3d551b2ae928 Use variable name nargin consistently in C++ code. Rik <rik@octave.org> parents: 20804 diff changeset	123 print_usage ();
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	124
20817 3d551b2ae928 Use variable name nargin consistently in C++ code. Rik <rik@octave.org> parents: 20804 diff changeset	125 octave_value_list retval;
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	126
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	127 if (nargout > 0)
21732 6a1eded90355 use namespace for system env class John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	128 retval = octave_value (octave::sys::env::get_current_directory ());
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	129
20817 3d551b2ae928 Use variable name nargin consistently in C++ code. Rik <rik@octave.org> parents: 20804 diff changeset	130 if (nargin == 1)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	131 {
20817 3d551b2ae928 Use variable name nargin consistently in C++ code. Rik <rik@octave.org> parents: 20804 diff changeset	132 std::string dirname = args(0).xstring_value ("cd: DIR must be a string");
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	133
20817 3d551b2ae928 Use variable name nargin consistently in C++ code. Rik <rik@octave.org> parents: 20804 diff changeset	134 if (! dirname.empty ())
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	135 octave_change_to_directory (dirname);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	136 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	137 else
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	138 {
21732 6a1eded90355 use namespace for system env class John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	139 std::string home_dir = octave::sys::env::get_home_directory ();
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2847 diff changeset	140
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	141 if (! home_dir.empty ())
0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	142 octave_change_to_directory (home_dir);
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	143 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	144
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	145 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	146 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	147
611 60f885cd0d87 [project @ 1994-08-14 20:53:44 by jwe] jwe parents: 549 diff changeset	148 DEFALIAS (chdir, cd);
60f885cd0d87 [project @ 1994-08-14 20:53:44 by jwe] jwe parents: 549 diff changeset	149
6482 7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6323 diff changeset	150 DEFUN (pwd, , ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	151 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	152 @deftypefn {} {} pwd ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	153 @deftypefnx {} {@var{dir} =} pwd ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	154 Return the current working directory.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	155 @seealso{cd, dir, ls, mkdir, rmdir}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	156 @end deftypefn */)
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	157 {
21732 6a1eded90355 use namespace for system env class John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	158 return ovl (octave::sys::env::get_current_directory ());
523 4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	159 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe] jwe parents: diff changeset	160
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1884 diff changeset	161 DEFUN (readdir, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	162 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	163 @deftypefn {} {@var{files} =} readdir (@var{dir})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	164 @deftypefnx {} {[@var{files}, @var{err}, @var{msg}] =} readdir (@var{dir})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	165 Return the names of files in the directory @var{dir} as a cell array of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	166 strings.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	167
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	168 If an error occurs, return an empty cell array in @var{files}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	169 If successful, @var{err} is 0 and @var{msg} is an empty string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	170 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	171 error message.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	172 @seealso{ls, dir, glob, what}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	173 @end deftypefn */)
1389 affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe] jwe parents: 1380 diff changeset	174 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	175 if (args.length () != 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	176 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	177
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	178 std::string dirname = args(0).xstring_value ("readdir: DIR must be a string");
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2512 diff changeset	179
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	180 octave_value_list retval = ovl (Cell (), -1.0, "");
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	181
21897 39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	182 dirname = octave::sys::file_ops::tilde_expand (dirname);
39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	183
21735 60212efcd9cb use namespace for dir_entry class John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	184 octave::sys::dir_entry dir (dirname);
1389 affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe] jwe parents: 1380 diff changeset	185
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	186 if (dir)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	187 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	188 string_vector dirlist = dir.read ();
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	189 retval(0) = Cell (dirlist.sort ());
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	190 retval(1) = 0.0;
1389 affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe] jwe parents: 1380 diff changeset	191 }
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe] jwe parents: 1380 diff changeset	192 else
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	193 retval(2) = dir.error ();
1389 affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe] jwe parents: 1380 diff changeset	194
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	195 return retval;
633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	196 }
633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	197
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	198 // FIXME: should maybe also allow second arg to specify mode?
0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	199 // OTOH, that might cause trouble with compatibility later...
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	200
21696 b8c05cc524ef mkdir.m: new script to implement recursive mkdir (bug #30650). Lachlan Andrew <lachlanbis@gmail.com> parents: 21301 diff changeset	201 DEFUN (__mkdir__, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	202 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	203 @deftypefn {} {} __mkdir__ (@var{parent}, @var{dir})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	204 Internal function called by mkdir.m.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	205 @seealso{mkdir, rmdir, pwd, cd, umask}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	206 @end deftypefn */)
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	207 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	208 int nargin = args.length ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	209
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	210 if (nargin < 1 \|\| nargin > 2)
21696 b8c05cc524ef mkdir.m: new script to implement recursive mkdir (bug #30650). Lachlan Andrew <lachlanbis@gmail.com> parents: 21301 diff changeset	211 print_usage ("mkdir");
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	212
6187 2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe] jwe parents: 6134 diff changeset	213 std::string dirname;
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe] jwe parents: 6134 diff changeset	214
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe] jwe parents: 6134 diff changeset	215 if (nargin == 2)
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	216 {
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20667 diff changeset	217 std::string parent = args(0).xstring_value ("mkdir: PARENT must be a string");
68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20667 diff changeset	218 std::string dir = args(1).xstring_value ("mkdir: DIR must be a string");
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	219
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	220 dirname = octave::sys::file_ops::concat (parent, dir);
6187 2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe] jwe parents: 6134 diff changeset	221 }
6200 1ec9de3cd12c [project @ 2006-12-05 18:05:11 by jwe] jwe parents: 6192 diff changeset	222 else if (nargin == 1)
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20667 diff changeset	223 dirname = args(0).xstring_value ("mkdir: DIR must be a string");
6187 2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe] jwe parents: 6134 diff changeset	224
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	225 dirname = octave::sys::file_ops::tilde_expand (dirname);
6187 2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe] jwe parents: 6134 diff changeset	226
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21735 diff changeset	227 octave::sys::file_stat fs (dirname);
7970 b6d4c644b4b6 Fmkdir: improve compatibility John W. Eaton <jwe@octave.org> parents: 7272 diff changeset	228
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	229 if (fs && fs.is_dir ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	230 {
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	231 // For Matlab compatibility, return true when directory already exists.
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	232 return ovl (true, "directory exists", "mkdir");
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	233 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	234 else
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	235 {
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	236 std::string msg;
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	237
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	238 int status = octave::sys::mkdir (dirname, 0777, msg);
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	239
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	240 if (status < 0)
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	241 return ovl (false, msg, "mkdir");
6187 2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe] jwe parents: 6134 diff changeset	242 else
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	243 return ovl (true, "", "");
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	244 }
633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	245 }
633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	246
10197 4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	247 DEFUNX ("rmdir", Frmdir, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	248 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	249 @deftypefn {} {} rmdir @var{dir}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	250 @deftypefnx {} {} rmdir (@var{dir}, "s")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	251 @deftypefnx {} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	252 Remove the directory named @var{dir}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	253
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	254 If the optional second parameter is supplied with value @qcode{"s"},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	255 recursively remove all subdirectories as well.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	256
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	257 If successful, @var{status} is 1, and @var{msg}, @var{msgid} are empty
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	258 character strings (""). Otherwise, @var{status} is 0, @var{msg} contains a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	259 system-dependent error message, and @var{msgid} contains a unique message
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	260 identifier.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	261
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	262 @seealso{mkdir, confirm_recursive_rmdir, pwd}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	263 @end deftypefn */)
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	264 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	265 int nargin = args.length ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	266
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	267 if (nargin < 1 \|\| nargin > 2)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	268 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	269
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	270 std::string dirname = args(0).xstring_value ("rmdir: DIR must be a string");
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5444 diff changeset	271
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	272 std::string fulldir = octave::sys::file_ops::tilde_expand (dirname);
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	273 int status = -1;
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	274 std::string msg;
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	275
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	276 if (nargin == 2)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	277 {
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	278 if (args(1).string_value () != "s")
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	279 error ("rmdir: second argument must be \"s\" for recursive removal");
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	280
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	281 bool doit = true;
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	282
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	283 if (interactive && ! forced_interactive && Vconfirm_recursive_rmdir)
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	284 {
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	285 std::string prompt = "remove entire contents of " + fulldir + "? ";
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5639 diff changeset	286
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	287 doit = octave_yes_or_no (prompt);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	288 }
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5639 diff changeset	289
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	290 if (doit)
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	291 status = octave::sys::recursive_rmdir (fulldir, msg);
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	292 }
1389 affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe] jwe parents: 1380 diff changeset	293 else
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	294 status = octave::sys::rmdir (fulldir, msg);
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	295
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	296 if (status < 0)
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	297 return ovl (false, msg, "rmdir");
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	298 else
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	299 return ovl (true, "", "");
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	300 }
633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	301
10197 4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	302 DEFUNX ("link", Flink, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	303 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	304 @deftypefn {} {} link @var{old} @var{new}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	305 @deftypefnx {} {[@var{err}, @var{msg}] =} link (@var{old}, @var{new})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	306 Create a new link (also known as a hard link) to an existing file.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	307
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	308 If successful, @var{err} is 0 and @var{msg} is an empty string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	309 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	310 error message.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	311 @seealso{symlink, unlink, readlink, lstat}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	312 @end deftypefn */)
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	313 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	314 if (args.length () != 2)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	315 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	316
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	317 std::string from = args(0).xstring_value ("link: OLD must be a string");
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	318 std::string to = args(1).xstring_value ("link: NEW must be a string");
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	319
21897 39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	320 from = octave::sys::file_ops::tilde_expand (from);
39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	321 to = octave::sys::file_ops::tilde_expand (to);
39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	322
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	323 std::string msg;
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	324
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	325 int status = octave::sys::link (from, to, msg);
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	326
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	327 if (status < 0)
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	328 return ovl (-1.0, msg);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	329 else
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	330 return ovl (status, "");
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	331 }
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	332
10197 4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	333 DEFUNX ("symlink", Fsymlink, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	334 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	335 @deftypefn {} {} symlink @var{old} @var{new}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	336 @deftypefnx {} {[@var{err}, @var{msg}] =} symlink (@var{old}, @var{new})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	337 Create a symbolic link @var{new} which contains the string @var{old}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	338
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	339 If successful, @var{err} is 0 and @var{msg} is an empty string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	340 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	341 error message.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	342 @seealso{link, unlink, readlink, lstat}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	343 @end deftypefn */)
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	344 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	345 if (args.length () != 2)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	346 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	347
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	348 std::string from = args(0).xstring_value ("symlink: OLD must be a string");
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	349 std::string to = args(1).xstring_value ("symlink: NEW must be a string");
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	350
21897 39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	351 from = octave::sys::file_ops::tilde_expand (from);
39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	352 to = octave::sys::file_ops::tilde_expand (to);
39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	353
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	354 std::string msg;
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	355
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	356 int status = octave::sys::symlink (from, to, msg);
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	357
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	358 if (status < 0)
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	359 return ovl (-1.0, msg);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	360 else
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	361 return ovl (status, "");
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	362 }
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	363
10197 4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	364 DEFUNX ("readlink", Freadlink, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	365 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	366 @deftypefn {} {} readlink @var{symlink}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	367 @deftypefnx {} {[@var{result}, @var{err}, @var{msg}] =} readlink (@var{symlink})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	368 Read the value of the symbolic link @var{symlink}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	369
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	370 If successful, @var{result} contains the contents of the symbolic link
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	371 @var{symlink}, @var{err} is 0, and @var{msg} is an empty string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	372 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	373 error message.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	374 @seealso{lstat, symlink, link, unlink, delete}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	375 @end deftypefn */)
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	376 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	377 if (args.length () != 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	378 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	379
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	380 std::string symlink = args(0).xstring_value ("readlink: SYMLINK must be a string");
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	381
21897 39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	382 symlink = octave::sys::file_ops::tilde_expand (symlink);
39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	383
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	384 std::string result, msg;
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	385
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	386 int status = octave::sys::readlink (symlink, result, msg);
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	387
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	388 if (status < 0)
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	389 return ovl ("", -1.0, msg);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	390 else
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	391 return ovl (result, status, "");
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	392 }
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3690 diff changeset	393
10197 4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	394 DEFUNX ("rename", Frename, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	395 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	396 @deftypefn {} {} rename @var{old} @var{new}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	397 @deftypefnx {} {[@var{err}, @var{msg}] =} rename (@var{old}, @var{new})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	398 Change the name of file @var{old} to @var{new}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	399
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	400 If successful, @var{err} is 0 and @var{msg} is an empty string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	401 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	402 error message.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	403 @seealso{movefile, copyfile, ls, dir}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	404 @end deftypefn */)
1401 633199854158 [project @ 1995-09-15 04:15:27 by jwe] jwe parents: 1389 diff changeset	405 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	406 if (args.length () != 2)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	407 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	408
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	409 std::string from = args(0).xstring_value ("rename: OLD must be a string");
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	410 std::string to = args(1).xstring_value ("rename: NEW must be a string");
1728 42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1690 diff changeset	411
21897 39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	412 from = octave::sys::file_ops::tilde_expand (from);
39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	413 to = octave::sys::file_ops::tilde_expand (to);
39afd54c2981 perform tilde expansion for more file and directory functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	414
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	415 std::string msg;
1728 42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1690 diff changeset	416
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	417 int status = octave::sys::rename (from, to, msg);
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2512 diff changeset	418
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	419 if (status < 0)
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	420 return ovl (-1.0, msg);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	421 else
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	422 return ovl (status, "");
1389 affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe] jwe parents: 1380 diff changeset	423 }
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe] jwe parents: 1380 diff changeset	424
2495 29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe] jwe parents: 2442 diff changeset	425 DEFUN (glob, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	426 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	427 @deftypefn {} {} glob (@var{pattern})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	428 Given an array of pattern strings (as a char array or a cell array) in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	429 @var{pattern}, return a cell array of filenames that match any of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	430 them, or an empty cell array if no patterns match.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	431
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	432 The pattern strings are interpreted as filename globbing patterns (as they
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	433 are used by Unix shells).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	434
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	435 Within a pattern
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	436
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	437 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	438 @item *
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	439 matches any string, including the null string,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	440
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	441 @item ?
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	442 matches any single character, and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	443
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	444 @item [@dots{}]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	445 matches any of the enclosed characters.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	446 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	447
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	448 Tilde expansion is performed on each of the patterns before looking for
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	449 matching filenames. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	450
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	451 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	452 ls
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	453 @result{}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	454 file1 file2 file3 myfile1 myfile1b
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	455 glob ("*file1")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	456 @result{}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	457 @{
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	458 [1,1] = file1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	459 [2,1] = myfile1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	460 @}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	461 glob ("myfile?")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	462 @result{}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	463 @{
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	464 [1,1] = myfile1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	465 @}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	466 glob ("file[12]")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	467 @result{}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	468 @{
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	469 [1,1] = file1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	470 [2,1] = file2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	471 @}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	472 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	473 @seealso{ls, dir, readdir, what}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	474 @end deftypefn */)
2495 29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe] jwe parents: 2442 diff changeset	475 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	476 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5794 diff changeset	477 print_usage ();
2495 29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe] jwe parents: 2442 diff changeset	478
20990 fc9cca99b2de Deprecate all_strings, replace with string_vector_value. Rik <rik@octave.org> parents: 20962 diff changeset	479 string_vector pat = args(0).xstring_vector_value ("glob: PATTERN must be a string");
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	480
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	481 glob_match pattern (octave::sys::file_ops::tilde_expand (pat));
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	482
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21100 diff changeset	483 return ovl (Cell (pattern.glob ()));
2495 29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe] jwe parents: 2442 diff changeset	484 }
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe] jwe parents: 2442 diff changeset	485
10335 9dd04a06410e document glob patterns Thorsten Meyer <thorsten.meyier@gmx.de> parents: 10315 diff changeset	486 /*
9dd04a06410e document glob patterns Thorsten Meyer <thorsten.meyier@gmx.de> parents: 10315 diff changeset	487 %!test
19278 6ca096827123 Use tempname() rather than tmpnam() in core Octave. Rik <rik@octave.org> parents: 19119 diff changeset	488 %! tmpdir = tempname;
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	489 %! filename = {"file1", "file2", "file3", "myfile1", "myfile1b"};
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	490 %! if (mkdir (tmpdir))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	491 %! cwd = pwd;
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	492 %! cd (tmpdir);
16933 e39f00a32dc7 maint: Use parentheses around condition for switch(),while(),if() statements. Rik <rik@octave.org> parents: 16892 diff changeset	493 %! if (strcmp (canonicalize_file_name (pwd), canonicalize_file_name (tmpdir)))
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	494 %! a = 0;
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	495 %! for n = 1:5
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	496 %! save (filename{n}, "a");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	497 %! endfor
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	498 %! else
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	499 %! rmdir (tmpdir);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	500 %! error ("Couldn't change to temporary dir");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	501 %! endif
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	502 %! else
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	503 %! error ("Couldn't create temporary directory");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	504 %! endif
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	505 %! result1 = glob ("*file1");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	506 %! result2 = glob ("myfile?");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	507 %! result3 = glob ("file[12]");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	508 %! for n = 1:5
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	509 %! delete (filename{n});
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	510 %! endfor
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	511 %! cd (cwd);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	512 %! rmdir (tmpdir);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	513 %! assert (result1, {"file1"; "myfile1"});
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	514 %! assert (result2, {"myfile1"});
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14366 diff changeset	515 %! assert (result3, {"file1"; "file2"});
10335 9dd04a06410e document glob patterns Thorsten Meyer <thorsten.meyier@gmx.de> parents: 10315 diff changeset	516 */
9dd04a06410e document glob patterns Thorsten Meyer <thorsten.meyier@gmx.de> parents: 10315 diff changeset	517
19119 f506de9089e8 Deprecate fnmatch function. Rik <rik@octave.org> parents: 17787 diff changeset	518 DEFUN (__fnmatch__, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	519 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	520 @deftypefn {} {} fnmatch (@var{pattern}, @var{string})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	521 Return true or false for each element of @var{string} that matches any of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	522 the elements of the string array @var{pattern}, using the rules of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	523 filename pattern matching.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	524
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	525 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	526
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	527 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	528 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	529 fnmatch ("a*b", @{"ab"; "axyzb"; "xyzab"@})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	530 @result{} [ 1; 1; 0 ]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	531 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	532 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	533 @seealso{glob, regexp}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	534 @end deftypefn */)
2496 9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe] jwe parents: 2495 diff changeset	535 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	536 if (args.length () != 2)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5794 diff changeset	537 print_usage ();
2496 9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe] jwe parents: 2495 diff changeset	538
20990 fc9cca99b2de Deprecate all_strings, replace with string_vector_value. Rik <rik@octave.org> parents: 20962 diff changeset	539 string_vector pat = args(0).string_vector_value ();
fc9cca99b2de Deprecate all_strings, replace with string_vector_value. Rik <rik@octave.org> parents: 20962 diff changeset	540 string_vector str = args(1).string_vector_value ();
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	541
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	542 glob_match pattern (octave::sys::file_ops::tilde_expand (pat));
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	543
21078 49852ff04747 maint: Remove unnecessary declarations of retval. Rik <rik@octave.org> parents: 20990 diff changeset	544 return ovl (pattern.match (str));
2496 9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe] jwe parents: 2495 diff changeset	545 }
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe] jwe parents: 2495 diff changeset	546
5777 246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	547 DEFUN (filesep, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	548 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	549 @deftypefn {} {} filesep ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	550 @deftypefnx {} {} filesep ("all")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	551 Return the system-dependent character used to separate directory names.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	552
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	553 If @qcode{"all"} is given, the function returns all valid file separators
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	554 in the form of a string. The list of file separators is system-dependent.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	555 It is @samp{/} (forward slash) under UNIX or @w{Mac OS X}, @samp{/} and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	556 @samp{\} (forward and backward slashes) under Windows.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	557 @seealso{pathsep}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	558 @end deftypefn */)
5777 246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	559 {
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	560 int nargin = args.length ();
5777 246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	561
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	562 if (nargin > 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	563 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	564
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	565 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	566
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	567 if (nargin == 0)
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	568 retval = octave::sys::file_ops::dir_sep_str ();
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	569 else
8317 135c0e7d7802 Extend filesep functionality by allowing to return all valid file separators Michael Goffioul <michael.goffioul@gmail.com> parents: 8109 diff changeset	570 {
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20667 diff changeset	571 std::string s = args(0).xstring_value ("filesep: argument must be a string");
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	572 if (s != "all")
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	573 error ("filesep: argument must be \"all\"");
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	574
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	575 retval = octave::sys::file_ops::dir_sep_chars ();
8317 135c0e7d7802 Extend filesep functionality by allowing to return all valid file separators Michael Goffioul <michael.goffioul@gmail.com> parents: 8109 diff changeset	576 }
5777 246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	577
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	578 return retval;
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	579 }
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	580
9266 1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	581 DEFUN (pathsep, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	582 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	583 @deftypefn {} {@var{val} =} pathsep ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	584 @deftypefnx {} {@var{old_val} =} pathsep (@var{new_val})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	585 Query or set the character used to separate directories in a path.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	586 @seealso{filesep}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	587 @end deftypefn */)
5777 246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	588 {
9266 1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	589 int nargin = args.length ();
1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	590
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	591 if (nargin > 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	592 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20752 diff changeset	593
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	594 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	595
9266 1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	596 if (nargout > 0 \|\| nargin == 0)
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	597 retval = octave::directory_path::path_sep_str ();
9266 1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	598
1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	599 if (nargin == 1)
1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	600 {
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20667 diff changeset	601 std::string sval = args(0).xstring_value ("pathsep: argument must be a single character");
9266 1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	602
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	603 switch (sval.length ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10250 diff changeset	604 {
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	605 case 1:
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	606 octave::directory_path::path_sep_char (sval[0]);
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	607 break;
9266 1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	608
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	609 case 0:
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	610 octave::directory_path::path_sep_char ('\0');
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	611 break;
9266 1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	612
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	613 default:
fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	614 error ("pathsep: argument must be a single character");
fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20558 diff changeset	615 break;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10250 diff changeset	616 }
9266 1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 9064 diff changeset	617 }
5777 246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	618
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	619 return retval;
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	620 }
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe] jwe parents: 5775 diff changeset	621
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5777 diff changeset	622 DEFUN (confirm_recursive_rmdir, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	623 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	624 @deftypefn {} {@var{val} =} confirm_recursive_rmdir ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	625 @deftypefnx {} {@var{old_val} =} confirm_recursive_rmdir (@var{new_val})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	626 @deftypefnx {} {} confirm_recursive_rmdir (@var{new_val}, "local")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	627 Query or set the internal variable that controls whether Octave
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	628 will ask for confirmation before recursively removing a directory tree.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	629
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	630 When called from inside a function with the @qcode{"local"} option, the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	631 variable is changed locally for the function and any subroutines it calls.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	632 The original variable value is restored when exiting the function.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	633 @seealso{rmdir}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	634 @end deftypefn */)
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5639 diff changeset	635 {
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5777 diff changeset	636 return SET_INTERNAL_VARIABLE (confirm_recursive_rmdir);
4264 4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe] jwe parents: 4233 diff changeset	637 }

Mercurial > octave

annotate libinterp/corefcn/dirfns.cc @ 21966:112b20240c87