annotate libinterp/corefcn/dirfns.cc @ 20654:b65888ec820e draft default tip gccjit

dmalcom gcc jit import
author Stefan Mahr <dac922@gmx.de>
date Fri, 27 Feb 2015 16:59:36 +0100
parents fd0efcdb3718
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19312
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
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
23 #ifdef HAVE_CONFIG_H
1192
b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe]
jwe
parents: 1158
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
1832
0c0d14cc90cd [project @ 1996-02-03 05:03:40 by jwe]
jwe
parents: 1804
diff changeset
36 #include <sys/types.h>
0c0d14cc90cd [project @ 1996-02-03 05:03:40 by jwe]
jwe
parents: 1804
diff changeset
37 #include <unistd.h>
0c0d14cc90cd [project @ 1996-02-03 05:03:40 by jwe]
jwe
parents: 1804
diff changeset
38
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2847
diff changeset
39 #include "file-ops.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2847
diff changeset
40 #include "file-stat.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2847
diff changeset
41 #include "glob-match.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2847
diff changeset
42 #include "oct-env.h"
5777
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
43 #include "pathsearch.h"
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1750
diff changeset
44 #include "str-vec.h"
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1750
diff changeset
45
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 4928
diff changeset
46 #include "Cell.h"
1355
94697d007075 [project @ 1995-09-05 20:04:15 by jwe]
jwe
parents: 1341
diff changeset
47 #include "defun.h"
1781
e090f89bf2f5 [project @ 1996-01-24 08:04:14 by jwe]
jwe
parents: 1773
diff changeset
48 #include "dir-ops.h"
1355
94697d007075 [project @ 1995-09-05 20:04:15 by jwe]
jwe
parents: 1341
diff changeset
49 #include "dirfns.h"
94697d007075 [project @ 1995-09-05 20:04:15 by jwe]
jwe
parents: 1341
diff changeset
50 #include "error.h"
1402
6550c74777b9 [project @ 1995-09-15 04:27:57 by jwe]
jwe
parents: 1401
diff changeset
51 #include "gripes.h"
5640
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe]
jwe
parents: 5639
diff changeset
52 #include "input.h"
5832
5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe]
jwe
parents: 5823
diff changeset
53 #include "load-path.h"
16437
919796a440c6 use signal for changing directory
John W. Eaton <jwe@octave.org>
parents: 16094
diff changeset
54 #include "octave-link.h"
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
55 #include "oct-obj.h"
1355
94697d007075 [project @ 1995-09-05 20:04:15 by jwe]
jwe
parents: 1341
diff changeset
56 #include "pager.h"
94697d007075 [project @ 1995-09-05 20:04:15 by jwe]
jwe
parents: 1341
diff changeset
57 #include "procstream.h"
94697d007075 [project @ 1995-09-05 20:04:15 by jwe]
jwe
parents: 1341
diff changeset
58 #include "sysdep.h"
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
59 #include "toplev.h"
1449
df589c97e140 [project @ 1995-09-20 03:49:51 by jwe]
jwe
parents: 1402
diff changeset
60 #include "unwind-prot.h"
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
61 #include "utils.h"
1742
a02f140ed897 [project @ 1996-01-12 11:09:39 by jwe]
jwe
parents: 1728
diff changeset
62 #include "variables.h"
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
63
5640
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe]
jwe
parents: 5639
diff changeset
64 // 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
65 // directory tree.
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe]
jwe
parents: 5639
diff changeset
66 static bool Vconfirm_recursive_rmdir = true;
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe]
jwe
parents: 5639
diff changeset
67
6323
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6233
diff changeset
68 // The time we last time we changed directories.
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6233
diff changeset
69 octave_time Vlast_chdir_time = 0.0;
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6233
diff changeset
70
1328
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe]
jwe
parents: 1315
diff changeset
71 static int
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
72 octave_change_to_directory (const std::string& newdir)
1328
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe]
jwe
parents: 1315
diff changeset
73 {
16437
919796a440c6 use signal for changing directory
John W. Eaton <jwe@octave.org>
parents: 16094
diff changeset
74 std::string xdir = file_ops::tilde_expand (newdir);
919796a440c6 use signal for changing directory
John W. Eaton <jwe@octave.org>
parents: 16094
diff changeset
75
919796a440c6 use signal for changing directory
John W. Eaton <jwe@octave.org>
parents: 16094
diff changeset
76 int cd_ok = octave_env::chdir (xdir);
1328
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe]
jwe
parents: 1315
diff changeset
77
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe]
jwe
parents: 1315
diff changeset
78 if (cd_ok)
5832
5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe]
jwe
parents: 5823
diff changeset
79 {
6323
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6233
diff changeset
80 Vlast_chdir_time.stamp ();
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6233
diff changeset
81
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
82 // FIXME: should these actions be handled as a list of functions
5832
5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe]
jwe
parents: 5823
diff changeset
83 // to call so users can add their own chdir handlers?
5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe]
jwe
parents: 5823
diff changeset
84
5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe]
jwe
parents: 5823
diff changeset
85 load_path::update ();
16437
919796a440c6 use signal for changing directory
John W. Eaton <jwe@octave.org>
parents: 16094
diff changeset
86
16526
01541f7321f7 correctly track directory for cd ..
John W. Eaton <jwe@octave.org>
parents: 16437
diff changeset
87 octave_link::change_directory (octave_env::get_current_directory ());
5832
5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe]
jwe
parents: 5823
diff changeset
88 }
1328
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe]
jwe
parents: 1315
diff changeset
89 else
10411
479cc8a0a846 use gnulib namespace
John W. Eaton <jwe@octave.org>
parents: 10348
diff changeset
90 error ("%s: %s", newdir.c_str (), gnulib::strerror (errno));
1328
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe]
jwe
parents: 1315
diff changeset
91
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe]
jwe
parents: 1315
diff changeset
92 return cd_ok;
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe]
jwe
parents: 1315
diff changeset
93 }
ec2ab864e8eb [project @ 1995-08-22 22:32:34 by jwe]
jwe
parents: 1315
diff changeset
94
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
95 DEFUN (cd, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
96 "-*- texinfo -*-\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
97 @deftypefn {Command} {} cd @var{dir}\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
98 @deftypefnx {Command} {} cd\n\
20213
2ae4a7ef4378 doc: Clean up several deftypefn entries of Command type.
Rik <rik@octave.org>
parents: 20207
diff changeset
99 @deftypefnx {Built-in Function} {@var{old_dir} =} cd (@var{dir})\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
100 @deftypefnx {Command} {} chdir @dots{}\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
101 Change the current working directory to @var{dir}.\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
102 \n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
103 If @var{dir} is omitted, the current directory is changed to the user's home\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
104 directory (@qcode{\"~\"}).\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
105 \n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
106 For example,\n\
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
107 \n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
108 @example\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
109 cd ~/octave\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
110 @end example\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
111 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
112 @noindent\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
113 changes the current working directory to @file{~/octave}. If the\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
114 directory does not exist, an error message is printed and the working\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
115 directory is not changed.\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
116 \n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
117 @code{chdir} is an alias for @code{cd} and can be used in all of the same\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
118 calling formats.\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
119 \n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
120 Compatibility Note: When called with no arguments, @sc{matlab} prints the\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
121 present working directory rather than changing to the user's home directory.\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
122 @seealso{pwd, mkdir, rmdir, dir, ls}\n\
11547
e1851653d59c Eliminate @deffn macros.
Rik <octave@nomad.inbox5.com>
parents: 11531
diff changeset
123 @end deftypefn")
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
124 {
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
125 octave_value_list retval;
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
126
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1750
diff changeset
127 int argc = args.length () + 1;
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1750
diff changeset
128
1965
01e3ed56c415 [project @ 1996-02-17 02:02:50 by jwe]
jwe
parents: 1957
diff changeset
129 string_vector argv = args.make_argv ("cd");
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1750
diff changeset
130
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
131 if (nargout > 0)
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
132 retval = octave_value (octave_env::get_current_directory ());
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
133
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
134 if (argc > 1)
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
135 {
5872
44f24cf66b95 [project @ 2006-06-30 18:19:20 by jwe]
jwe
parents: 5832
diff changeset
136 std::string dirname = argv[1];
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
137
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
138 if (dirname.length () > 0)
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
139 octave_change_to_directory (dirname);
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
140 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
141 else
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
142 {
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
143 std::string home_dir = octave_env::get_home_directory ();
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2847
diff changeset
144
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
145 if (! home_dir.empty ())
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
146 octave_change_to_directory (home_dir);
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
147 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
148
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
149 return retval;
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
150 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
151
611
60f885cd0d87 [project @ 1994-08-14 20:53:44 by jwe]
jwe
parents: 549
diff changeset
152 DEFALIAS (chdir, cd);
60f885cd0d87 [project @ 1994-08-14 20:53:44 by jwe]
jwe
parents: 549
diff changeset
153
6482
7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe]
jwe
parents: 6323
diff changeset
154 DEFUN (pwd, , ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
155 "-*- texinfo -*-\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
156 @deftypefn {Built-in Function} {} pwd ()\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
157 @deftypefnx {Built-in Function} {@var{dir} =} pwd ()\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
158 Return the current working directory.\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
159 @seealso{cd, dir, ls, mkdir, rmdir}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
160 @end deftypefn")
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
161 {
10250
2d47356a7a1a use gnulib getcwd module
John W. Eaton <jwe@octave.org>
parents: 10197
diff changeset
162 return octave_value (octave_env::get_current_directory ());
523
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
163 }
4a07f0083ab0 [project @ 1994-07-20 18:33:47 by jwe]
jwe
parents:
diff changeset
164
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
165 DEFUN (readdir, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
166 "-*- texinfo -*-\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
167 @deftypefn {Built-in Function} {@var{files} =} readdir (@var{dir})\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
168 @deftypefnx {Built-in Function} {[@var{files}, @var{err}, @var{msg}] =} readdir (@var{dir})\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
169 Return the names of files in the directory @var{dir} as a cell array of\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
170 strings.\n\
1389
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
171 \n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
172 If an error occurs, return an empty cell array in @var{files}.\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
173 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
174 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
175 error message.\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
176 @seealso{ls, dir, glob, what}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
177 @end deftypefn")
1389
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
178 {
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
179 octave_value_list retval;
1389
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
180
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
181 retval(2) = std::string ();
2669
c821858188b6 [project @ 1997-02-13 18:25:39 by jwe]
jwe
parents: 2512
diff changeset
182 retval(1) = -1.0;
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents: 4494
diff changeset
183 retval(0) = Cell ();
2669
c821858188b6 [project @ 1997-02-13 18:25:39 by jwe]
jwe
parents: 2512
diff changeset
184
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
185 if (args.length () == 1)
1389
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
186 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
187 std::string dirname = args(0).string_value ("readdir: DIR must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
188
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
189 dir_entry dir (dirname);
1389
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
190
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
191 if (dir)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
192 {
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
193 string_vector dirlist = dir.read ();
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
194 retval(1) = 0.0;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
195 retval(0) = Cell (dirlist.sort ());
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
196 }
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
197 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
198 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
199 retval(2) = dir.error ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
200 }
1389
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
201 }
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
202 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
203 print_usage ();
1389
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
204
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
205 return retval;
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
206 }
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
207
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
208 // 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
209 // OTOH, that might cause trouble with compatibility later...
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
210
10197
4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents: 10182
diff changeset
211 DEFUNX ("mkdir", Fmkdir, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
212 "-*- texinfo -*-\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
213 @deftypefn {Built-in Function} {} mkdir @var{dir}\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
214 @deftypefnx {Built-in Function} {} mkdir (@var{parent}, @var{dir})\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
215 @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@dots{})\n\
8109
f3be63199134 Document mkdir()'s parent argument
weber@atlan
parents: 8008
diff changeset
216 Create a directory named @var{dir} in the directory @var{parent}.\n\
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
217 \n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
218 If no @var{parent} directory is specified the present working directory is\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
219 used.\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
220 \n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
221 If successful, @var{status} is 1, and @var{msg}, @var{msgid} are empty\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
222 character strings (""). Otherwise, @var{status} is 0, @var{msg} contains a\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
223 system-dependent error message, and @var{msgid} contains a unique message\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
224 identifier.\n\
20233
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20213
diff changeset
225 \n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20213
diff changeset
226 When creating a directory permissions will be set to\n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20213
diff changeset
227 @code{0777 - @var{umask}}.\n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20213
diff changeset
228 @seealso{rmdir, pwd, cd, umask}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
229 @end deftypefn")
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
230 {
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
231 octave_value_list retval;
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
232
5476
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe]
jwe
parents: 5444
diff changeset
233 retval(2) = std::string ();
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
234 retval(1) = std::string ();
5476
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe]
jwe
parents: 5444
diff changeset
235 retval(0) = false;
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
236
6187
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
237 int nargin = args.length ();
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
238
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
239 std::string dirname;
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
240
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
241 if (nargin == 2)
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
242 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
243 std::string parent = args(0).string_value ("mkdir: PARENT must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
244 std::string dir = args(1).string_value ("mkdir: DIR must be a string");
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
245
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
246 dirname = file_ops::concat (parent, dir);
6187
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
247 }
6200
1ec9de3cd12c [project @ 2006-12-05 18:05:11 by jwe]
jwe
parents: 6192
diff changeset
248 else if (nargin == 1)
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
249 dirname = args(0).string_value ("mkdir: DIR must be a string");
6187
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
250
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
251 if (nargin == 1 || nargin == 2)
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
252 {
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
253 std::string msg;
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
254
7970
b6d4c644b4b6 Fmkdir: improve compatibility
John W. Eaton <jwe@octave.org>
parents: 7272
diff changeset
255 dirname = file_ops::tilde_expand (dirname);
b6d4c644b4b6 Fmkdir: improve compatibility
John W. Eaton <jwe@octave.org>
parents: 7272
diff changeset
256
b6d4c644b4b6 Fmkdir: improve compatibility
John W. Eaton <jwe@octave.org>
parents: 7272
diff changeset
257 file_stat fs (dirname);
1489
3e705c864019 [project @ 1995-09-28 05:38:26 by jwe]
jwe
parents: 1488
diff changeset
258
7970
b6d4c644b4b6 Fmkdir: improve compatibility
John W. Eaton <jwe@octave.org>
parents: 7272
diff changeset
259 if (fs && fs.is_dir ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
260 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
261 // For compatibility with Matlab, we return true when the
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
262 // directory already exists.
7970
b6d4c644b4b6 Fmkdir: improve compatibility
John W. Eaton <jwe@octave.org>
parents: 7272
diff changeset
263
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
264 retval(2) = "mkdir";
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
265 retval(1) = "directory exists";
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
266 retval(0) = true;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
267 }
6187
2a8922007c12 [project @ 2006-11-29 01:59:59 by jwe]
jwe
parents: 6134
diff changeset
268 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
269 {
14741
0ab3dd0fad18 Backout changeset a543ed02e673: mkdir-p
John W. Eaton <jwe@octave.org>
parents: 14679
diff changeset
270 int status = octave_mkdir (dirname, 0777, msg);
7970
b6d4c644b4b6 Fmkdir: improve compatibility
John W. Eaton <jwe@octave.org>
parents: 7272
diff changeset
271
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
272 if (status < 0)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
273 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
274 retval(2) = "mkdir";
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
275 retval(1) = msg;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
276 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
277 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
278 retval(0) = true;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
279 }
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
280 }
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
281 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
282 print_usage ();
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
283
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
284 return retval;
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
285 }
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
286
10197
4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents: 10182
diff changeset
287 DEFUNX ("rmdir", Frmdir, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
288 "-*- texinfo -*-\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
289 @deftypefn {Built-in Function} {} rmdir @var{dir}\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
290 @deftypefnx {Built-in Function} {} rmdir (@var{dir}, \"s\")\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
291 @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@dots{})\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
292 Remove the directory named @var{dir}.\n\
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
293 \n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
294 If the optional second parameter is supplied with value @qcode{\"s\"},\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
295 recursively remove all subdirectories as well.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
296 \n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
297 If successful, @var{status} is 1, and @var{msg}, @var{msgid} are empty\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
298 character strings (""). Otherwise, @var{status} is 0, @var{msg} contains a\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
299 system-dependent error message, and @var{msgid} contains a unique message\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
300 identifier.\n\
5476
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe]
jwe
parents: 5444
diff changeset
301 \n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
302 @seealso{mkdir, confirm_recursive_rmdir, pwd}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
303 @end deftypefn")
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
304 {
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
305 octave_value_list retval;
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
306
5476
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe]
jwe
parents: 5444
diff changeset
307 retval(2) = std::string ();
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
308 retval(1) = std::string ();
5476
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe]
jwe
parents: 5444
diff changeset
309 retval(0) = false;
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
310
5476
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe]
jwe
parents: 5444
diff changeset
311 int nargin = args.length ();
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe]
jwe
parents: 5444
diff changeset
312
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe]
jwe
parents: 5444
diff changeset
313 if (nargin == 1 || nargin == 2)
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
314 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
315 std::string dirname = args(0).string_value ("rmdir: DIR must be a string");
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
316
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
317 std::string fulldir = file_ops::tilde_expand (dirname);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
318 int status = -1;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
319 std::string msg;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
320
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
321 if (nargin == 2)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
322 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
323 if (args(1).string_value () == "s")
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
324 {
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
325 bool doit = true;
2669
c821858188b6 [project @ 1997-02-13 18:25:39 by jwe]
jwe
parents: 2512
diff changeset
326
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
327 if (interactive && ! forced_interactive
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
328 && Vconfirm_recursive_rmdir)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
329 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
330 std::string prompt
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
331 = "remove entire contents of " + fulldir + "? ";
5640
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe]
jwe
parents: 5639
diff changeset
332
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
333 doit = octave_yes_or_no (prompt);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
334 }
5640
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe]
jwe
parents: 5639
diff changeset
335
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
336 if (doit)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
337 status = octave_recursive_rmdir (fulldir, msg);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
338 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
339 else
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
340 error ("rmdir: expecting second argument to be \"s\"");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
341 }
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
342 else
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
343 status = octave_rmdir (fulldir, msg);
2669
c821858188b6 [project @ 1997-02-13 18:25:39 by jwe]
jwe
parents: 2512
diff changeset
344
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
345 if (status < 0)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
346 {
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
347 retval(2) = "rmdir";
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
348 retval(1) = msg;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
349 }
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
350 else
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
351 retval(0) = true;
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
352 }
1389
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
353 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
354 print_usage ();
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
355
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
356 return retval;
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
357 }
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
358
10197
4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents: 10182
diff changeset
359 DEFUNX ("link", Flink, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
360 "-*- texinfo -*-\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
361 @deftypefn {Built-in Function} {} link @var{old} @var{new}\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
362 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} link (@var{old}, @var{new})\n\
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
363 Create a new link (also known as a hard link) to an existing file.\n\
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
364 \n\
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
365 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
366 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
367 error message.\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
368 @seealso{symlink, unlink, readlink, lstat}\n\
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
369 @end deftypefn")
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
370 {
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
371 octave_value_list retval;
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
372
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
373 retval(1) = std::string ();
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
374 retval(0) = -1.0;
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
375
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
376 if (args.length () == 2)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
377 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
378 std::string from = args(0).string_value ("link: OLD must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
379 std::string to = args(1).string_value ("link: NEW must be a string");
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
380
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
381 std::string msg;
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
382
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
383 int status = octave_link (from, to, msg);
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
384
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
385 if (status < 0)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
386 retval(1) = msg;
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
387
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
388 retval(0) = status;
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
389 }
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
390 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
391 print_usage ();
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 return retval;
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
394 }
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
395
10197
4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents: 10182
diff changeset
396 DEFUNX ("symlink", Fsymlink, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
397 "-*- texinfo -*-\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
398 @deftypefn {Built-in Function} {} symlink @var{old} @var{new}\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
399 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} symlink (@var{old}, @var{new})\n\
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
400 Create a symbolic link @var{new} which contains the string @var{old}.\n\
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
401 \n\
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
402 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
403 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
404 error message.\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
405 @seealso{link, unlink, readlink, lstat}\n\
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
406 @end deftypefn")
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
407 {
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
408 octave_value_list retval;
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
409
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
410 retval(1) = std::string ();
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
411 retval(0) = -1.0;
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
412
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
413 if (args.length () == 2)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
414 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
415 std::string from = args(0).string_value ("symlink: OLD must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
416 std::string to = args(1).string_value ("symlink: NEW must be a string");
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
417
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
418 std::string msg;
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
419
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
420 int status = octave_symlink (from, to, msg);
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
421
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
422 if (status < 0)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
423 retval(1) = msg;
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
424
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
425 retval(0) = status;
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
426 }
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
427 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
428 print_usage ();
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
429
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
430 return retval;
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
431 }
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
432
10197
4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents: 10182
diff changeset
433 DEFUNX ("readlink", Freadlink, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
434 "-*- texinfo -*-\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
435 @deftypefn {Built-in Function} {} readlink @var{symlink}\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
436 @deftypefnx {Built-in Function} {[@var{result}, @var{err}, @var{msg}] =} readlink (@var{symlink})\n\
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
437 Read the value of the symbolic link @var{symlink}.\n\
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
438 \n\
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
439 If successful, @var{result} contains the contents of the symbolic link\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
440 @var{symlink}, @var{err} is 0, and @var{msg} is an empty string.\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
441 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
442 error message.\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
443 @seealso{lstat, symlink, link, unlink, delete}\n\
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
444 @end deftypefn")
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
445 {
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
446 octave_value_list retval;
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
447
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
448 retval(2) = std::string ();
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
449 retval(1) = -1.0;
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
450 retval(0) = std::string ();
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
451
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
452 if (args.length () == 1)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
453 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
454 std::string symlink = args(0).string_value ("readlink: SYMLINK must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
455
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
456 std::string result;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
457 std::string msg;
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
458
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
459 int status = octave_readlink (symlink, result, msg);
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
460
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
461 if (status < 0)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
462 retval(2) = msg;
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
463
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
464 retval(1) = status;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
465 retval(0) = result;
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
466 }
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
467 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
468 print_usage ();
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
469
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
470 return retval;
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
471 }
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3690
diff changeset
472
10197
4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents: 10182
diff changeset
473 DEFUNX ("rename", Frename, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
474 "-*- texinfo -*-\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
475 @deftypefn {Built-in Function} {} rename @var{old} @var{new}\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
476 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} rename (@var{old}, @var{new})\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
477 Change the name of file @var{old} to @var{new}.\n\
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
478 \n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
479 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
480 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
481 error message.\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
482 @seealso{movefile, copyfile, ls, dir}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
483 @end deftypefn")
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
484 {
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
485 octave_value_list retval;
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
486
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
487 retval(1) = std::string ();
2669
c821858188b6 [project @ 1997-02-13 18:25:39 by jwe]
jwe
parents: 2512
diff changeset
488 retval(0) = -1.0;
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
489
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
490 if (args.length () == 2)
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
491 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
492 std::string from = args(0).string_value ("rename: OLD must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
493 std::string to = args(1).string_value ("rename: NEW must be a string");
1728
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe]
jwe
parents: 1690
diff changeset
494
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
495 std::string msg;
1728
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe]
jwe
parents: 1690
diff changeset
496
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
497 int status = octave_rename (from, to, msg);
2669
c821858188b6 [project @ 1997-02-13 18:25:39 by jwe]
jwe
parents: 2512
diff changeset
498
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
499 if (status < 0)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
500 retval(1) = msg;
2669
c821858188b6 [project @ 1997-02-13 18:25:39 by jwe]
jwe
parents: 2512
diff changeset
501
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
502 retval(0) = status;
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
503 }
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
504 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
505 print_usage ();
1401
633199854158 [project @ 1995-09-15 04:15:27 by jwe]
jwe
parents: 1389
diff changeset
506
1389
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
507 return retval;
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
508 }
affbd42dd0c1 [project @ 1995-09-14 07:41:09 by jwe]
jwe
parents: 1380
diff changeset
509
2495
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
510 DEFUN (glob, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
511 "-*- texinfo -*-\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
512 @deftypefn {Built-in Function} {} glob (@var{pattern})\n\
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
513 Given an array of pattern strings (as a char array or a cell array) in\n\
5444
781c9e7dbb73 [project @ 2005-09-08 02:55:21 by jwe]
jwe
parents: 5307
diff changeset
514 @var{pattern}, return a cell array of file names that match any of\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
515 them, or an empty cell array if no patterns match.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
516 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
517 The pattern strings are interpreted as filename globbing patterns (as they\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
518 are used by Unix shells).\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
519 \n\
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
520 Within a pattern\n\
14366
b76f0740940e doc: Periodic grammar check of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14361
diff changeset
521 \n\
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
522 @table @code\n\
16094
8899c785cc99 doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents: 15195
diff changeset
523 @item *\n\
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
524 matches any string, including the null string,\n\
16816
12005245b645 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 16526
diff changeset
525 \n\
16094
8899c785cc99 doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents: 15195
diff changeset
526 @item ?\n\
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
527 matches any single character, and\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
528 \n\
10711
fbd7843974fa Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents: 10411
diff changeset
529 @item [@dots{}]\n\
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
530 matches any of the enclosed characters.\n\
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
531 @end table\n\
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
532 \n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
533 Tilde expansion is performed on each of the patterns before looking for\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
534 matching file names. For example:\n\
2495
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
535 \n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
536 @example\n\
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
537 ls\n\
14360
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
538 @result{}\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
539 file1 file2 file3 myfile1 myfile1b\n\
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
540 glob (\"*file1\")\n\
14360
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
541 @result{}\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
542 @{\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
543 [1,1] = file1\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
544 [2,1] = myfile1\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
545 @}\n\
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
546 glob (\"myfile?\")\n\
14360
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
547 @result{}\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
548 @{\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
549 [1,1] = myfile1\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
550 @}\n\
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
551 glob (\"file[12]\")\n\
14360
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
552 @result{}\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
553 @{\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
554 [1,1] = file1\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
555 [2,1] = file2\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
556 @}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
557 @end example\n\
19153
f506de9089e8 Deprecate fnmatch function.
Rik <rik@octave.org>
parents: 17787
diff changeset
558 @seealso{ls, dir, readdir, what}\n\
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents: 5476
diff changeset
559 @end deftypefn")
2495
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
560 {
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
561 octave_value retval;
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
562
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
563 if (args.length () == 1)
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
564 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
565 string_vector pat = args(0).all_strings ("glob: PATTERN must be a string");
2495
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
566
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
567 glob_match pattern (file_ops::tilde_expand (pat));
2495
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
568
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
569 retval = Cell (pattern.glob ());
2495
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
570 }
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
571 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
572 print_usage ();
2495
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
573
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
574 return retval;
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
575 }
29cd3862a9dc [project @ 1996-11-11 02:39:49 by jwe]
jwe
parents: 2442
diff changeset
576
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
577 /*
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
578 %!test
19312
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19153
diff changeset
579 %! tmpdir = tempname;
14429
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
580 %! 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
581 %! if (mkdir (tmpdir))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
582 %! cwd = pwd;
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
583 %! cd (tmpdir);
16933
e39f00a32dc7 maint: Use parentheses around condition for switch(),while(),if() statements.
Rik <rik@octave.org>
parents: 16892
diff changeset
584 %! 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
585 %! a = 0;
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
586 %! for n = 1:5
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
587 %! save (filename{n}, "a");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
588 %! endfor
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
589 %! else
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
590 %! rmdir (tmpdir);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
591 %! 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
592 %! endif
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
593 %! else
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
594 %! 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
595 %! endif
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
596 %! result1 = glob ("*file1");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
597 %! result2 = glob ("myfile?");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
598 %! result3 = glob ("file[12]");
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
599 %! for n = 1:5
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
600 %! delete (filename{n});
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
601 %! endfor
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
602 %! cd (cwd);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
603 %! rmdir (tmpdir);
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
604 %! assert (result1, {"file1"; "myfile1"});
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
605 %! assert (result2, {"myfile1"});
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
606 %! assert (result3, {"file1"; "file2"});
10335
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
607 */
9dd04a06410e document glob patterns
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 10315
diff changeset
608
19153
f506de9089e8 Deprecate fnmatch function.
Rik <rik@octave.org>
parents: 17787
diff changeset
609 DEFUN (__fnmatch__, args, ,
19895
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19883
diff changeset
610 "-*- texinfo -*-\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
611 @deftypefn {Built-in Function} {} fnmatch (@var{pattern}, @var{string})\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
612 Return true or false for each element of @var{string} that matches any of\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
613 the elements of the string array @var{pattern}, using the rules of\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
614 \n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
615 filename pattern matching. For example:\n\
2496
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
616 \n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
617 @example\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
618 @group\n\
6233
a299c8a6d96e [project @ 2007-01-09 04:31:18 by jwe]
jwe
parents: 6200
diff changeset
619 fnmatch (\"a*b\", @{\"ab\"; \"axyzb\"; \"xyzab\"@})\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
620 @result{} [ 1; 1; 0 ]\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
621 @end group\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
622 @end example\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
623 @seealso{glob, regexp}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3147
diff changeset
624 @end deftypefn")
2496
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
625 {
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
626 octave_value retval;
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
627
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
628 if (args.length () == 2)
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
629 {
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
630 string_vector pat = args(0).all_strings ();
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
631 string_vector str = args(1).all_strings ();
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
632
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
633 if (error_state)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
634 gripe_wrong_type_arg ("fnmatch", args(0));
2496
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
635 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
636 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
637 glob_match pattern (file_ops::tilde_expand (pat));
2496
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
638
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
639 retval = pattern.match (str);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
640 }
2496
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
641 }
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
642 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
643 print_usage ();
2496
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
644
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
645 return retval;
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
646 }
9823f8bfd1a5 [project @ 1996-11-11 03:17:10 by jwe]
jwe
parents: 2495
diff changeset
647
5777
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
648 DEFUN (filesep, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
649 "-*- texinfo -*-\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
650 @deftypefn {Built-in Function} {} filesep ()\n\
14361
8de863b7126b doc: Use Octave preference for double quote in docstrings in all .cc files
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
651 @deftypefnx {Built-in Function} {} filesep (\"all\")\n\
5777
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
652 Return the system-dependent character used to separate directory names.\n\
8317
135c0e7d7802 Extend filesep functionality by allowing to return all valid file separators
Michael Goffioul <michael.goffioul@gmail.com>
parents: 8109
diff changeset
653 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16933
diff changeset
654 If @qcode{\"all\"} is given, the function returns all valid file separators\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16933
diff changeset
655 in the form of a string. The list of file separators is system-dependent.\n\
12668
e3dc23f7dd54 doc: Improve a few docstrings related to test functions and directories.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
656 It is @samp{/} (forward slash) under UNIX or @w{Mac OS X}, @samp{/} and\n\
e3dc23f7dd54 doc: Improve a few docstrings related to test functions and directories.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
657 @samp{\\} (forward and backward slashes) under Windows.\n\
12211
11faa69c4eaa Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11572
diff changeset
658 @seealso{pathsep}\n\
5777
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
659 @end deftypefn")
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
660 {
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
661 octave_value retval;
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
662
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
663 if (args.length () == 0)
8007
a2ab20ba78f7 make file_ops a proper singleton class
John W. Eaton <jwe@octave.org>
parents: 7970
diff changeset
664 retval = file_ops::dir_sep_str ();
8317
135c0e7d7802 Extend filesep functionality by allowing to return all valid file separators
Michael Goffioul <michael.goffioul@gmail.com>
parents: 8109
diff changeset
665 else if (args.length () == 1)
135c0e7d7802 Extend filesep functionality by allowing to return all valid file separators
Michael Goffioul <michael.goffioul@gmail.com>
parents: 8109
diff changeset
666 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
667 std::string s = args(0).string_value ("filesep: argument must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
668 if (s == "all")
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
669 retval = 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
670 else
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
671 error ("filesep: argument must be \"all\"");
8317
135c0e7d7802 Extend filesep functionality by allowing to return all valid file separators
Michael Goffioul <michael.goffioul@gmail.com>
parents: 8109
diff changeset
672 }
5777
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
673 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
674 print_usage ();
5777
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
675
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
676 return retval;
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
677 }
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
678
9266
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
679 DEFUN (pathsep, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
680 "-*- texinfo -*-\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
681 @deftypefn {Built-in Function} {@var{val} =} pathsep ()\n\
9270
f9ac007bb926 fix typo in 9266:1d3b91166b9c
Jaroslav Hajek <highegg@gmail.com>
parents: 9266
diff changeset
682 @deftypefnx {Built-in Function} {@var{old_val} =} pathsep (@var{new_val})\n\
12211
11faa69c4eaa Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11572
diff changeset
683 Query or set the character used to separate directories in a path.\n\
11faa69c4eaa Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11572
diff changeset
684 @seealso{filesep}\n\
5777
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
685 @end deftypefn")
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
686 {
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
687 octave_value retval;
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
688
9266
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
689 int nargin = args.length ();
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
690
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
691 if (nargout > 0 || nargin == 0)
8008
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 8007
diff changeset
692 retval = dir_path::path_sep_str ();
9266
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
693
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
694 if (nargin == 1)
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
695 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
696 std::string sval = args(0).string_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
697
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
698 switch (sval.length ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
699 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
700 case 1:
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
701 dir_path::path_sep_char (sval[0]);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
702 break;
9266
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
703
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
704 case 0:
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
705 dir_path::path_sep_char ('\0');
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
706 break;
9266
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
707
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
708 default:
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20590
diff changeset
709 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: 20590
diff changeset
710 break;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10250
diff changeset
711 }
9266
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
712 }
1d3b91166b9c allow pathsep to be set
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
713 else if (nargin > 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5794
diff changeset
714 print_usage ();
5777
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
715
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
716 return retval;
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
717 }
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5775
diff changeset
718
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5777
diff changeset
719 DEFUN (confirm_recursive_rmdir, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
720 "-*- texinfo -*-\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
721 @deftypefn {Built-in Function} {@var{val} =} confirm_recursive_rmdir ()\n\
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5777
diff changeset
722 @deftypefnx {Built-in Function} {@var{old_val} =} confirm_recursive_rmdir (@var{new_val})\n\
13951
79aa00a94e9e doc: Document "local" option for configuration variables.
Rik <octave@nomad.inbox5.com>
parents: 13912
diff changeset
723 @deftypefnx {Built-in Function} {} confirm_recursive_rmdir (@var{new_val}, \"local\")\n\
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5777
diff changeset
724 Query or set the internal variable that controls whether Octave\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5777
diff changeset
725 will ask for confirmation before recursively removing a directory tree.\n\
13951
79aa00a94e9e doc: Document "local" option for configuration variables.
Rik <octave@nomad.inbox5.com>
parents: 13912
diff changeset
726 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16933
diff changeset
727 When called from inside a function with the @qcode{\"local\"} option, the\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19895
diff changeset
728 variable is changed locally for the function and any subroutines it calls.\n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16933
diff changeset
729 The original variable value is restored when exiting the function.\n\
17397
0bf2fc8562c9 doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
730 @seealso{rmdir}\n\
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5777
diff changeset
731 @end deftypefn")
5640
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe]
jwe
parents: 5639
diff changeset
732 {
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5777
diff changeset
733 return SET_INTERNAL_VARIABLE (confirm_recursive_rmdir);
4264
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents: 4233
diff changeset
734 }