Mercurial > octave-nkf
annotate libinterp/corefcn/syscalls.cc @ 20207:4f45eaf83908 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed libinterp/corefcn directory.
* libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc,
libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc,
libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc,
libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc,
libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc,
libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc,
libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc,
libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc,
libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc,
libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc,
libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc,
libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc,
libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc,
libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc,
libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc,
libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc,
libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc,
libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc,
libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc,
libinterp/corefcn/variables.cc, scripts/polynomial/spline.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sat, 09 May 2015 17:19:30 -0700 |
| parents | 4197fc428c7d |
| children | aa36fb998a4d |
| rev | line source |
|---|---|
| 2075 | 1 /* |
| 2 | |
|
19731
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19437
diff
changeset
|
3 Copyright (C) 1996-2015 John W. Eaton |
|
10521
4d1fc073fbb7
add some missing copyright stmts
Jaroslav Hajek <highegg@gmail.com>
parents:
10336
diff
changeset
|
4 Copyright (C) 2010 VZLU Prague |
| 2075 | 5 |
| 6 This file is part of Octave. | |
| 7 | |
| 8 Octave is free software; you can redistribute it and/or modify it | |
| 9 under the terms of the GNU General Public License as published by the | |
| 7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
| 11 option) any later version. | |
| 2075 | 12 |
| 13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 16 for more details. | |
| 17 | |
| 18 You should have received a copy of the GNU General Public License | |
| 7016 | 19 along with Octave; see the file COPYING. If not, see |
| 20 <http://www.gnu.org/licenses/>. | |
| 2075 | 21 |
| 22 */ | |
| 23 | |
| 24 // Thomas Baier <baier@ci.tuwien.ac.at> added the original versions of | |
| 25 // the following functions: | |
| 26 // | |
| 27 // mkfifo unlink waitpid | |
| 28 | |
| 29 #ifdef HAVE_CONFIG_H | |
| 30 #include <config.h> | |
| 31 #endif | |
| 32 | |
| 33 #include <cstdio> | |
| 2669 | 34 #include <cstring> |
| 2075 | 35 |
| 36 #include <sys/types.h> | |
| 37 #include <unistd.h> | |
| 38 | |
| 39 #include <fcntl.h> | |
| 40 | |
|
17236
6a6e3f1a824c
save history on exec (bug #39734)
John W. Eaton <jwe@octave.org>
parents:
15221
diff
changeset
|
41 #include "cmd-hist.h" |
| 2926 | 42 #include "file-ops.h" |
| 43 #include "file-stat.h" | |
|
11006
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
44 #include "oct-env.h" |
| 2937 | 45 #include "oct-syscalls.h" |
| 5547 | 46 #include "oct-uname.h" |
| 2926 | 47 |
| 2075 | 48 #include "defun.h" |
| 49 #include "error.h" | |
| 2078 | 50 #include "gripes.h" |
| 2075 | 51 #include "lo-utils.h" |
|
17236
6a6e3f1a824c
save history on exec (bug #39734)
John W. Eaton <jwe@octave.org>
parents:
15221
diff
changeset
|
52 #include "oct-hist.h" |
| 2075 | 53 #include "oct-map.h" |
| 54 #include "oct-obj.h" | |
| 55 #include "oct-stdstrm.h" | |
| 56 #include "oct-stream.h" | |
| 57 #include "sysdep.h" | |
| 58 #include "utils.h" | |
| 2366 | 59 #include "variables.h" |
| 6321 | 60 #include "input.h" |
| 2075 | 61 |
|
10762
d53eb6249892
use scalar map in some syscalls
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
62 static octave_scalar_map |
| 8549 | 63 mk_stat_map (const base_file_stat& fs) |
| 2075 | 64 { |
|
10762
d53eb6249892
use scalar map in some syscalls
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
65 octave_scalar_map m; |
| 2075 | 66 |
| 4675 | 67 m.assign ("dev", static_cast<double> (fs.dev ())); |
| 68 m.assign ("ino", fs.ino ()); | |
| 5476 | 69 m.assign ("mode", fs.mode ()); |
| 4675 | 70 m.assign ("modestr", fs.mode_as_string ()); |
| 71 m.assign ("nlink", fs.nlink ()); | |
| 72 m.assign ("uid", fs.uid ()); | |
| 73 m.assign ("gid", fs.gid ()); | |
| 3887 | 74 #if defined (HAVE_STRUCT_STAT_ST_RDEV) |
| 4675 | 75 m.assign ("rdev", static_cast<double> (fs.rdev ())); |
| 2075 | 76 #endif |
| 4675 | 77 m.assign ("size", fs.size ()); |
| 78 m.assign ("atime", fs.atime ()); | |
| 79 m.assign ("mtime", fs.mtime ()); | |
| 80 m.assign ("ctime", fs.ctime ()); | |
| 3887 | 81 #if defined (HAVE_STRUCT_STAT_ST_BLKSIZE) |
| 4675 | 82 m.assign ("blksize", fs.blksize ()); |
| 2075 | 83 #endif |
| 3887 | 84 #if defined (HAVE_STRUCT_STAT_ST_BLOCKS) |
| 4675 | 85 m.assign ("blocks", fs.blocks ()); |
| 2075 | 86 #endif |
| 87 | |
| 88 return m; | |
| 89 } | |
| 90 | |
|
10336
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
91 static octave_value_list |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
92 mk_stat_result (const base_file_stat& fs) |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
93 { |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
94 octave_value_list retval; |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
95 |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
96 if (fs) |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
97 { |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
98 retval(2) = std::string (); |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
99 retval(1) = 0; |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
100 retval(0) = octave_value (mk_stat_map (fs)); |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
101 } |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
102 else |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
103 { |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
104 retval(2) = fs.error (); |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
105 retval(1) = -1; |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
106 retval(0) = Matrix (); |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
107 } |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
108 |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
109 return retval; |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
110 } |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
111 |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
112 DEFUNX ("dup2", Fdup2, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
113 "-*- texinfo -*-\n\ |
| 3301 | 114 @deftypefn {Built-in Function} {[@var{fid}, @var{msg}] =} dup2 (@var{old}, @var{new})\n\ |
| 2669 | 115 Duplicate a file descriptor.\n\ |
| 116 \n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
117 If successful, @var{fid} is greater than zero and contains the new file ID@.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
118 Otherwise, @var{fid} is negative 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:
19731
diff
changeset
|
119 error message.\n\ |
|
19143
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
18111
diff
changeset
|
120 @seealso{fopen, fclose, fcntl}\n\ |
| 3301 | 121 @end deftypefn") |
| 2075 | 122 { |
| 2669 | 123 octave_value_list retval; |
| 124 | |
| 3523 | 125 retval(1) = std::string (); |
| 4294 | 126 retval(0) = -1; |
| 2075 | 127 |
| 128 int nargin = args.length (); | |
| 129 | |
| 130 if (nargin == 2) | |
| 131 { | |
| 3341 | 132 octave_stream old_stream |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
133 = octave_stream_list::lookup (args(0), "dup2"); |
| 2075 | 134 |
| 3341 | 135 if (! error_state) |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
136 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
137 octave_stream new_stream |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
138 = octave_stream_list::lookup (args(1), "dup2"); |
| 2075 | 139 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
140 if (! error_state) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
141 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
142 int i_old = old_stream.file_number (); |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
143 int i_new = new_stream.file_number (); |
| 2937 | 144 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
145 if (i_old >= 0 && i_new >= 0) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
146 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
147 std::string msg; |
| 2669 | 148 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
149 int status = octave_syscalls::dup2 (i_old, i_new, msg); |
| 3341 | 150 |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
151 retval(1) = msg; |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
152 retval(0) = status; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
153 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
154 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
155 } |
| 3145 | 156 else |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
157 error ("dup2: invalid stream"); |
| 2075 | 158 } |
| 159 else | |
| 5823 | 160 print_usage (); |
| 2075 | 161 |
| 162 return retval; | |
| 163 } | |
| 164 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
165 DEFUNX ("exec", Fexec, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
166 "-*- texinfo -*-\n\ |
| 3301 | 167 @deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} exec (@var{file}, @var{args})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
168 Replace current process with a new process.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
169 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
170 Calling @code{exec} without first calling @code{fork} will terminate your\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
171 current Octave process and replace it with the program named by @var{file}. \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
172 For example,\n\ |
| 2669 | 173 \n\ |
| 3301 | 174 @example\n\ |
| 175 exec (\"ls\" \"-l\")\n\ | |
| 176 @end example\n\ | |
| 2669 | 177 \n\ |
| 3301 | 178 @noindent\n\ |
| 179 will run @code{ls} and return you to your shell prompt.\n\ | |
| 180 \n\ | |
| 181 If successful, @code{exec} does not return. If @code{exec} does return,\n\ | |
| 182 @var{err} will be nonzero, and @var{msg} will contain a system-dependent\n\ | |
| 183 error message.\n\ | |
| 184 @end deftypefn") | |
| 2075 | 185 { |
| 2669 | 186 octave_value_list retval; |
| 187 | |
| 3523 | 188 retval(1) = std::string (); |
| 4294 | 189 retval(0) = -1; |
| 2075 | 190 |
| 191 int nargin = args.length (); | |
| 192 | |
| 193 if (nargin == 1 || nargin == 2) | |
| 194 { | |
|
19437
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
195 if (args(0).is_string ()) |
|
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
196 { |
|
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
197 std::string exec_file = args(0).string_value (); |
| 2075 | 198 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
199 string_vector exec_args; |
| 2075 | 200 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
201 if (nargin == 2) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
202 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
203 string_vector tmp = args(1).all_strings (); |
| 2075 | 204 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
205 if (! error_state) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
206 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
207 int len = tmp.length (); |
| 2075 | 208 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
209 exec_args.resize (len + 1); |
| 2075 | 210 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
211 exec_args[0] = exec_file; |
| 2075 | 212 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
213 for (int i = 0; i < len; i++) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
214 exec_args[i+1] = tmp[i]; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
215 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
216 else |
|
19437
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
217 error ("exec: all arguments must be strings"); |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
218 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
219 else |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
220 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
221 exec_args.resize (1); |
| 2075 | 222 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
223 exec_args[0] = exec_file; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
224 } |
| 2075 | 225 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
226 if (! error_state) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
227 { |
|
17236
6a6e3f1a824c
save history on exec (bug #39734)
John W. Eaton <jwe@octave.org>
parents:
15221
diff
changeset
|
228 octave_history_write_timestamp (); |
|
6a6e3f1a824c
save history on exec (bug #39734)
John W. Eaton <jwe@octave.org>
parents:
15221
diff
changeset
|
229 |
|
6a6e3f1a824c
save history on exec (bug #39734)
John W. Eaton <jwe@octave.org>
parents:
15221
diff
changeset
|
230 if (! command_history::ignoring_entries ()) |
|
6a6e3f1a824c
save history on exec (bug #39734)
John W. Eaton <jwe@octave.org>
parents:
15221
diff
changeset
|
231 command_history::clean_up_and_save (); |
|
6a6e3f1a824c
save history on exec (bug #39734)
John W. Eaton <jwe@octave.org>
parents:
15221
diff
changeset
|
232 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
233 std::string msg; |
| 2937 | 234 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
235 int status = octave_syscalls::execvp (exec_file, exec_args, msg); |
| 2669 | 236 |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
237 retval(1) = msg; |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
238 retval(0) = status; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
239 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
240 } |
| 2075 | 241 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
242 error ("exec: FILE must be a string"); |
| 2075 | 243 } |
| 244 else | |
| 5823 | 245 print_usage (); |
| 2075 | 246 |
| 247 return retval; | |
| 248 } | |
| 249 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
250 DEFUNX ("popen2", Fpopen2, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
251 "-*- texinfo -*-\n\ |
| 6678 | 252 @deftypefn {Built-in Function} {[@var{in}, @var{out}, @var{pid}] =} popen2 (@var{command}, @var{args})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
253 Start a subprocess with two-way communication.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
254 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
255 The name of the process is given by @var{command}, and @var{args} is an\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
256 array of strings containing options for the command.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
257 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
258 The file identifiers for the input and output streams of the subprocess are\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
259 returned in @var{in} and @var{out}. If execution of the command is\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
260 successful, @var{pid} contains the process ID of the subprocess. Otherwise,\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
261 @var{pid} is @minus{}1.\n\ |
| 6321 | 262 \n\ |
| 10840 | 263 For example:\n\ |
| 6321 | 264 \n\ |
| 265 @example\n\ | |
| 6923 | 266 [in, out, pid] = popen2 (\"sort\", \"-r\");\n\ |
| 6321 | 267 fputs (in, \"these\\nare\\nsome\\nstrings\\n\");\n\ |
| 268 fclose (in);\n\ | |
| 269 EAGAIN = errno (\"EAGAIN\");\n\ | |
| 270 done = false;\n\ | |
| 271 do\n\ | |
| 272 s = fgets (out);\n\ | |
| 273 if (ischar (s))\n\ | |
| 274 fputs (stdout, s);\n\ | |
| 275 elseif (errno () == EAGAIN)\n\ | |
| 276 sleep (0.1);\n\ | |
| 277 fclear (out);\n\ | |
| 278 else\n\ | |
| 279 done = true;\n\ | |
| 280 endif\n\ | |
| 281 until (done)\n\ | |
| 282 fclose (out);\n\ | |
|
9563
f5c28d8f5147
syscalls.cc: Recommend waitpid() in popen2() documentation.
Rob Mahurin <rob@utk.edu>
parents:
9209
diff
changeset
|
283 waitpid (pid);\n\ |
|
14360
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
284 \n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
285 @print{} these\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
286 @print{} strings\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
287 @print{} some\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
288 @print{} are\n\ |
| 6321 | 289 @end example\n\ |
|
9563
f5c28d8f5147
syscalls.cc: Recommend waitpid() in popen2() documentation.
Rob Mahurin <rob@utk.edu>
parents:
9209
diff
changeset
|
290 \n\ |
|
17968
43c199e83ed7
Reap child process in popen2 %!test block.
Rik <rik@octave.org>
parents:
17951
diff
changeset
|
291 Note that @code{popen2}, unlike @code{popen}, will not @nospell{\"reap\"} the\n\ |
|
9563
f5c28d8f5147
syscalls.cc: Recommend waitpid() in popen2() documentation.
Rob Mahurin <rob@utk.edu>
parents:
9209
diff
changeset
|
292 child process. If you don't use @code{waitpid} to check the child's\n\ |
| 9564 | 293 exit status, it will linger until Octave exits.\n\ |
|
17968
43c199e83ed7
Reap child process in popen2 %!test block.
Rik <rik@octave.org>
parents:
17951
diff
changeset
|
294 @seealso{popen, waitpid}\n\ |
| 6321 | 295 @end deftypefn") |
| 296 { | |
| 297 octave_value_list retval; | |
| 298 | |
| 299 retval(2) = -1; | |
| 300 retval(1) = Matrix (); | |
| 301 retval(0) = Matrix (); | |
| 302 | |
| 303 int nargin = args.length (); | |
| 304 | |
| 305 if (nargin >= 1 && nargin <= 3) | |
| 306 { | |
|
19437
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
307 if (args(0).is_string ()) |
|
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
308 { |
|
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
309 std::string exec_file = args(0).string_value (); |
| 6321 | 310 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
311 string_vector arg_list; |
| 6321 | 312 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
313 if (nargin >= 2) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
314 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
315 string_vector tmp = args(1).all_strings (); |
| 6321 | 316 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
317 if (! error_state) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
318 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
319 int len = tmp.length (); |
| 6321 | 320 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
321 arg_list.resize (len + 1); |
| 6321 | 322 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
323 arg_list[0] = exec_file; |
| 6321 | 324 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
325 for (int i = 0; i < len; i++) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
326 arg_list[i+1] = tmp[i]; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
327 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
328 else |
|
19437
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
329 error ("popen2: all arguments must be strings"); |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
330 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
331 else |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
332 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
333 arg_list.resize (1); |
| 6321 | 334 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
335 arg_list[0] = exec_file; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
336 } |
| 6321 | 337 |
| 338 if (! error_state) | |
| 339 { | |
|
14846
460a3c6d8bf1
maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents:
14819
diff
changeset
|
340 bool sync_mode = (nargin == 3 ? args(2).bool_value () : false); |
| 6321 | 341 |
| 342 if (! error_state) | |
| 343 { | |
| 344 int fildes[2]; | |
| 345 std::string msg; | |
| 346 pid_t pid; | |
| 347 | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
348 pid = octave_syscalls::popen2 (exec_file, arg_list, sync_mode, |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
349 fildes, msg, interactive); |
| 6321 | 350 if (pid >= 0) |
| 351 { | |
| 352 FILE *ifile = fdopen (fildes[1], "r"); | |
| 353 FILE *ofile = fdopen (fildes[0], "w"); | |
| 354 | |
| 355 std::string nm; | |
| 356 | |
| 357 octave_stream is = octave_stdiostream::create (nm, ifile, | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
358 std::ios::in); |
| 6321 | 359 |
| 360 octave_stream os = octave_stdiostream::create (nm, ofile, | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
361 std::ios::out); |
| 6321 | 362 |
| 363 Cell file_ids (1, 2); | |
| 364 | |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
365 retval(2) = pid; |
| 6321 | 366 retval(1) = octave_stream_list::insert (is); |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
367 retval(0) = octave_stream_list::insert (os); |
| 6321 | 368 } |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
369 else |
| 6321 | 370 error (msg.c_str ()); |
| 371 } | |
| 372 } | |
| 373 else | |
|
19437
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
374 error ("popen2: all arguments must be strings"); |
| 6321 | 375 } |
| 376 else | |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
377 error ("popen2: COMMAND argument must be a string"); |
| 6321 | 378 } |
| 379 else | |
| 380 print_usage (); | |
| 381 | |
| 382 return retval; | |
| 383 } | |
| 384 | |
| 385 /* | |
|
18022
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
386 |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
387 %!test # UNIX-style test |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
388 %! if (isunix () || ismac ()) |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
389 %! [in, out, pid] = popen2 ("sort", "-r"); |
|
14429
eff4a5933e28
Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14360
diff
changeset
|
390 %! EAGAIN = errno ("EAGAIN"); |
|
18022
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
391 %! fputs (in, "these\nare\nsome\nstrings\n"); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
392 %! fclose (in); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
393 %! done = false; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
394 %! str = {}; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
395 %! idx = 0; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
396 %! errs = 0; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
397 %! do |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
398 %! if (ismac ()) # FIXME: Is this necessary? |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
399 %! errno (0); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
400 %! endif |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
401 %! s = fgets (out); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
402 %! if (ischar (s)) |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
403 %! idx++; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
404 %! str{idx} = s; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
405 %! elseif (errno () == EAGAIN) |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
406 %! fclear (out); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
407 %! sleep (0.1); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
408 %! if (++errs == 100) |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
409 %! done = true; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
410 %! endif |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
411 %! else |
| 6321 | 412 %! done = true; |
| 413 %! endif | |
|
18022
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
414 %! until (done) |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
415 %! fclose (out); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
416 %! waitpid (pid); |
|
14861
f7afecdd87ef
maint: Use Octave coding conventions for cuddling parentheses in src/ directory
Rik <octave@nomad.inbox5.com>
parents:
14846
diff
changeset
|
417 %! assert (str, {"these\n","strings\n","some\n","are\n"}); |
|
18022
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
418 %! endif |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
419 |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
420 %!test # Windows-style test |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
421 %! if (ispc () && ! isunix ()) |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
422 %! [in, out, pid] = popen2 ('C:\Windows\system32\sort.exe', "/R"); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
423 %! EAGAIN = errno ("EINVAL"); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
424 %! fputs (in, "these\r\nare\r\nsome\r\nstrings\r\n"); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
425 %! fclose (in); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
426 %! done = false; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
427 %! str = {}; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
428 %! idx = 0; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
429 %! errs = 0; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
430 %! do |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
431 %! errno (0); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
432 %! s = fgets (out); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
433 %! if (ischar (s)) |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
434 %! idx++; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
435 %! str{idx} = s; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
436 %! elseif (errno () == EAGAIN) |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
437 %! fclear (out); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
438 %! sleep (0.1); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
439 %! if (++errs == 100) |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
440 %! done = true; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
441 %! endif |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
442 %! else |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
443 %! done = true; |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
444 %! endif |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
445 %! until (done) |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
446 %! fclose (out); |
|
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
447 %! waitpid (pid); |
|
14861
f7afecdd87ef
maint: Use Octave coding conventions for cuddling parentheses in src/ directory
Rik <octave@nomad.inbox5.com>
parents:
14846
diff
changeset
|
448 %! assert (str, {"these\r\n","strings\r\n","some\r\n","are\r\n"}); |
|
14429
eff4a5933e28
Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14360
diff
changeset
|
449 %! endif |
|
18022
c3cd335bd71b
Rewrite failing popen2 test for Windows (bug #40606).
Rik <rik@octave.org>
parents:
17969
diff
changeset
|
450 |
| 6321 | 451 */ |
| 452 | |
| 10259 | 453 DEFUNX ("fcntl", Ffcntl, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
454 "-*- texinfo -*-\n\ |
| 3301 | 455 @deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} fcntl (@var{fid}, @var{request}, @var{arg})\n\ |
|
19143
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
18111
diff
changeset
|
456 Change the properties of the open file @var{fid}.\n\ |
|
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
18111
diff
changeset
|
457 \n\ |
|
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
18111
diff
changeset
|
458 The following values may be passed as @var{request}:\n\ |
| 3301 | 459 \n\ |
| 460 @vtable @code\n\ | |
| 461 @item F_DUPFD\n\ | |
| 462 Return a duplicate file descriptor.\n\ | |
| 463 \n\ | |
| 464 @item F_GETFD\n\ | |
| 465 Return the file descriptor flags for @var{fid}.\n\ | |
| 466 \n\ | |
| 467 @item F_SETFD\n\ | |
| 468 Set the file descriptor flags for @var{fid}.\n\ | |
| 469 \n\ | |
| 470 @item F_GETFL\n\ | |
| 471 Return the file status flags for @var{fid}. The following codes may be\n\ | |
| 472 returned (some of the flags may be undefined on some systems).\n\ | |
| 473 \n\ | |
| 474 @vtable @code\n\ | |
| 475 @item O_RDONLY\n\ | |
| 476 Open for reading only.\n\ | |
| 477 \n\ | |
| 478 @item O_WRONLY\n\ | |
| 479 Open for writing only.\n\ | |
| 2669 | 480 \n\ |
| 3301 | 481 @item O_RDWR\n\ |
| 482 Open for reading and writing.\n\ | |
| 483 \n\ | |
| 484 @item O_APPEND\n\ | |
| 485 Append on each write.\n\ | |
| 486 \n\ | |
| 5040 | 487 @item O_CREAT\n\ |
| 488 Create the file if it does not exist.\n\ | |
| 489 \n\ | |
| 3301 | 490 @item O_NONBLOCK\n\ |
|
10791
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
10762
diff
changeset
|
491 Non-blocking mode.\n\ |
| 3301 | 492 \n\ |
| 493 @item O_SYNC\n\ | |
| 494 Wait for writes to complete.\n\ | |
| 2669 | 495 \n\ |
| 3301 | 496 @item O_ASYNC\n\ |
| 497 Asynchronous I/O.\n\ | |
| 498 @end vtable\n\ | |
| 499 \n\ | |
| 500 @item F_SETFL\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
501 Set the file status flags for @var{fid} to the value specified by @var{arg}.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
502 The only flags that can be changed are @w{@code{O_APPEND}} and\n\ |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9064
diff
changeset
|
503 @w{@code{O_NONBLOCK}}.\n\ |
| 3301 | 504 @end vtable\n\ |
| 505 \n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
506 If successful, @var{err} is 0 and @var{msg} is an empty string. Otherwise,\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
507 @var{err} is nonzero and @var{msg} contains a system-dependent error\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
508 message.\n\ |
|
19143
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
18111
diff
changeset
|
509 @seealso{fopen, dup2}\n\ |
| 3301 | 510 @end deftypefn") |
| 2075 | 511 { |
| 2669 | 512 octave_value_list retval; |
| 513 | |
| 3523 | 514 retval(1) = std::string (); |
| 4294 | 515 retval(0) = -1; |
| 2075 | 516 |
| 517 int nargin = args.length (); | |
| 518 | |
| 519 if (nargin == 3) | |
| 520 { | |
|
18111
b560bac0fca2
maint: Don't use space between 'args' and '(' when doing indexing.
Rik <rik@octave.org>
parents:
18022
diff
changeset
|
521 octave_stream strm = octave_stream_list::lookup (args(0), "fcntl"); |
| 2075 | 522 |
| 3202 | 523 if (! error_state) |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
524 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
525 int fid = strm.file_number (); |
| 3715 | 526 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
527 int req = args(1).int_value (true); |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
528 int arg = args(2).int_value (true); |
| 3715 | 529 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
530 if (! error_state) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
531 { |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
532 // FIXME: Need better checking here? |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
533 if (fid < 0) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
534 error ("fcntl: invalid file id"); |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
535 else |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
536 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
537 std::string msg; |
| 2937 | 538 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
539 int status = octave_fcntl (fid, req, arg, msg); |
| 2669 | 540 |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
541 retval(1) = msg; |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
542 retval(0) = status; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
543 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
544 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
545 } |
| 2075 | 546 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
547 error ("fcntl: FID, REQUEST, and ARG must be integers"); |
| 2075 | 548 } |
| 549 else | |
| 5823 | 550 print_usage (); |
| 2075 | 551 |
| 552 return retval; | |
| 553 } | |
| 554 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
555 DEFUNX ("fork", Ffork, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
556 "-*- texinfo -*-\n\ |
| 3301 | 557 @deftypefn {Built-in Function} {[@var{pid}, @var{msg}] =} fork ()\n\ |
| 2669 | 558 Create a copy of the current process.\n\ |
| 559 \n\ | |
| 3301 | 560 Fork can return one of the following values:\n\ |
| 561 \n\ | |
| 562 @table @asis\n\ | |
| 563 @item > 0\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
564 You are in the parent process. The value returned from @code{fork} is the\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
565 process id of the child process. You should probably arrange to wait for\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
566 any child processes to exit.\n\ |
| 3301 | 567 \n\ |
| 568 @item 0\n\ | |
| 569 You are in the child process. You can call @code{exec} to start another\n\ | |
| 570 process. If that fails, you should probably call @code{exit}.\n\ | |
| 571 \n\ | |
| 572 @item < 0\n\ | |
| 573 The call to @code{fork} failed for some reason. You must take evasive\n\ | |
| 574 action. A system dependent error message will be waiting in @var{msg}.\n\ | |
| 575 @end table\n\ | |
| 576 @end deftypefn") | |
| 2075 | 577 { |
| 2669 | 578 octave_value_list retval; |
| 579 | |
| 3523 | 580 retval(1) = std::string (); |
| 4294 | 581 retval(0) = -1; |
| 2075 | 582 |
| 583 int nargin = args.length (); | |
| 584 | |
| 585 if (nargin == 0) | |
| 2475 | 586 { |
| 3523 | 587 std::string msg; |
| 2937 | 588 |
| 589 pid_t pid = octave_syscalls::fork (msg); | |
| 2669 | 590 |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
591 retval(1) = msg; |
| 4233 | 592 retval(0) = pid; |
| 2475 | 593 } |
| 2075 | 594 else |
| 5823 | 595 print_usage (); |
| 2075 | 596 |
| 597 return retval; | |
| 598 } | |
| 599 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
600 DEFUNX ("getpgrp", Fgetpgrp, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
601 "-*- texinfo -*-\n\ |
| 3301 | 602 @deftypefn {Built-in Function} {pgid =} getpgrp ()\n\ |
| 603 Return the process group id of the current process.\n\ | |
| 604 @end deftypefn") | |
| 2075 | 605 { |
| 2937 | 606 octave_value_list retval; |
| 607 | |
| 3523 | 608 retval(1) = std::string (); |
| 4294 | 609 retval(0) = -1; |
| 2075 | 610 |
| 611 int nargin = args.length (); | |
| 612 | |
| 613 if (nargin == 0) | |
| 2475 | 614 { |
| 3523 | 615 std::string msg; |
| 2937 | 616 |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
617 retval(1) = msg; |
| 4233 | 618 retval(0) = octave_syscalls::getpgrp (msg); |
| 2475 | 619 } |
| 2075 | 620 else |
| 5823 | 621 print_usage (); |
| 2075 | 622 |
| 623 return retval; | |
| 624 } | |
| 625 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
626 DEFUNX ("getpid", Fgetpid, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
627 "-*- texinfo -*-\n\ |
| 3301 | 628 @deftypefn {Built-in Function} {pid =} getpid ()\n\ |
| 629 Return the process id of the current process.\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
630 @seealso{getppid}\n\ |
| 3301 | 631 @end deftypefn") |
| 2075 | 632 { |
| 4233 | 633 octave_value retval = -1; |
| 2075 | 634 |
| 635 int nargin = args.length (); | |
| 636 | |
| 637 if (nargin == 0) | |
| 2937 | 638 retval = octave_syscalls::getpid (); |
| 2075 | 639 else |
| 5823 | 640 print_usage (); |
| 2075 | 641 |
| 642 return retval; | |
| 643 } | |
| 644 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
645 DEFUNX ("getppid", Fgetppid, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
646 "-*- texinfo -*-\n\ |
| 3301 | 647 @deftypefn {Built-in Function} {pid =} getppid ()\n\ |
| 648 Return the process id of the parent process.\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
649 @seealso{getpid}\n\ |
| 3301 | 650 @end deftypefn") |
| 2075 | 651 { |
| 4233 | 652 octave_value retval = -1; |
| 2075 | 653 |
| 2475 | 654 int nargin = args.length (); |
| 655 | |
| 656 if (nargin == 0) | |
| 2937 | 657 retval = octave_syscalls::getppid (); |
| 2475 | 658 else |
| 5823 | 659 print_usage (); |
| 2475 | 660 |
| 661 return retval; | |
| 662 } | |
| 663 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
664 DEFUNX ("getegid", Fgetegid, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
665 "-*- texinfo -*-\n\ |
| 3301 | 666 @deftypefn {Built-in Function} {egid =} getegid ()\n\ |
| 667 Return the effective group id of the current process.\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
668 @seealso{getgid}\n\ |
| 3301 | 669 @end deftypefn") |
| 2475 | 670 { |
| 4233 | 671 octave_value retval = -1; |
| 2475 | 672 |
| 2075 | 673 int nargin = args.length (); |
| 674 | |
| 675 if (nargin == 0) | |
| 4254 | 676 retval = octave_syscalls::getegid (); |
| 2075 | 677 else |
| 5823 | 678 print_usage (); |
| 2475 | 679 |
| 680 return retval; | |
| 681 } | |
| 682 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
683 DEFUNX ("getgid", Fgetgid, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
684 "-*- texinfo -*-\n\ |
| 3301 | 685 @deftypefn {Built-in Function} {gid =} getgid ()\n\ |
| 686 Return the real group id of the current process.\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
687 @seealso{getegid}\n\ |
| 3301 | 688 @end deftypefn") |
| 2475 | 689 { |
| 4233 | 690 octave_value retval = -1; |
| 2475 | 691 |
| 692 int nargin = args.length (); | |
| 693 | |
| 694 if (nargin == 0) | |
| 4254 | 695 retval = octave_syscalls::getgid (); |
| 2475 | 696 else |
| 5823 | 697 print_usage (); |
| 2075 | 698 |
| 699 return retval; | |
| 700 } | |
| 701 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
702 DEFUNX ("geteuid", Fgeteuid, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
703 "-*- texinfo -*-\n\ |
| 3301 | 704 @deftypefn {Built-in Function} {euid =} geteuid ()\n\ |
| 705 Return the effective user id of the current process.\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
706 @seealso{getuid}\n\ |
| 3301 | 707 @end deftypefn") |
| 2472 | 708 { |
| 4233 | 709 octave_value retval = -1; |
| 2472 | 710 |
| 711 int nargin = args.length (); | |
| 712 | |
| 713 if (nargin == 0) | |
| 4254 | 714 retval = octave_syscalls::geteuid (); |
| 2472 | 715 else |
| 5823 | 716 print_usage (); |
| 2473 | 717 |
| 718 return retval; | |
| 2472 | 719 } |
| 720 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
721 DEFUNX ("getuid", Fgetuid, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
722 "-*- texinfo -*-\n\ |
| 3301 | 723 @deftypefn {Built-in Function} {uid =} getuid ()\n\ |
| 724 Return the real user id of the current process.\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
725 @seealso{geteuid}\n\ |
| 3301 | 726 @end deftypefn") |
| 2472 | 727 { |
| 4233 | 728 octave_value retval = -1; |
| 2472 | 729 |
| 730 int nargin = args.length (); | |
| 731 | |
| 732 if (nargin == 0) | |
| 4254 | 733 retval = octave_syscalls::getuid (); |
| 2472 | 734 else |
| 5823 | 735 print_usage (); |
| 2473 | 736 |
| 737 return retval; | |
| 2472 | 738 } |
| 739 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
740 DEFUNX ("kill", Fkill, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
741 "-*- texinfo -*-\n\ |
| 4294 | 742 @deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} kill (@var{pid}, @var{sig})\n\ |
| 743 Send signal @var{sig} to process @var{pid}.\n\ | |
| 744 \n\ | |
| 745 If @var{pid} is positive, then signal @var{sig} is sent to @var{pid}.\n\ | |
| 746 \n\ | |
| 747 If @var{pid} is 0, then signal @var{sig} is sent to every process\n\ | |
| 748 in the process group of the current process.\n\ | |
| 749 \n\ | |
| 750 If @var{pid} is -1, then signal @var{sig} is sent to every process\n\ | |
| 751 except process 1.\n\ | |
| 752 \n\ | |
| 753 If @var{pid} is less than -1, then signal @var{sig} is sent to every\n\ | |
| 754 process in the process group @var{-pid}.\n\ | |
| 755 \n\ | |
| 4371 | 756 If @var{sig} is 0, then no signal is sent, but error checking is still\n\ |
| 4294 | 757 performed.\n\ |
| 758 \n\ | |
| 7001 | 759 Return 0 if successful, otherwise return -1.\n\ |
| 4294 | 760 @end deftypefn") |
| 761 { | |
| 762 octave_value_list retval; | |
| 763 | |
| 764 retval(1) = std::string (); | |
| 765 retval(0) = -1; | |
| 766 | |
| 767 if (args.length () == 2) | |
| 768 { | |
| 769 pid_t pid = args(0).int_value (true); | |
| 770 | |
| 771 if (! error_state) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
772 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
773 int sig = args(1).int_value (true); |
| 4294 | 774 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
775 if (! error_state) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
776 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
777 std::string msg; |
| 4294 | 778 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
779 int status = octave_syscalls::kill (pid, sig, msg); |
| 4294 | 780 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
781 retval(1) = msg; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
782 retval(0) = status; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
783 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
784 } |
| 4294 | 785 } |
| 786 else | |
| 5823 | 787 print_usage (); |
| 4294 | 788 |
| 789 return retval; | |
| 790 } | |
| 791 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
792 DEFUNX ("lstat", Flstat, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
793 "-*- texinfo -*-\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
794 @deftypefn {Built-in Function} {@var{info} =} lstat (@var{symlink})\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
795 @deftypefnx {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} lstat (@var{symlink})\n\ |
|
12211
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
796 Return a structure @var{info} containing information about the symbolic link\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
797 @var{symlink}.\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
798 \n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
799 The function outputs are described in the documentation for @code{stat}.\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
800 @seealso{stat, symlink}\n\ |
| 3458 | 801 @end deftypefn") |
| 2075 | 802 { |
| 2263 | 803 octave_value_list retval; |
| 2075 | 804 |
| 805 if (args.length () == 1) | |
| 806 { | |
| 5872 | 807 std::string fname = args(0).string_value (); |
| 2075 | 808 |
| 809 if (! error_state) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
810 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
811 file_stat fs (fname, false); |
| 2075 | 812 |
|
10336
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
813 retval = mk_stat_result (fs); |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
814 } |
| 2075 | 815 } |
| 816 else | |
| 5823 | 817 print_usage (); |
| 2075 | 818 |
| 819 return retval; | |
| 820 } | |
| 821 | |
|
10197
4d433bd2d4dc
attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents:
10182
diff
changeset
|
822 DEFUNX ("mkfifo", Fmkfifo, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
823 "-*- texinfo -*-\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
824 @deftypefn {Built-in Function} {} mkfifo (@var{name}, @var{mode})\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
825 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} mkfifo (@var{name}, @var{mode})\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
826 Create a FIFO special file named @var{name} with file mode @var{mode}\n\ |
| 2075 | 827 \n\ |
| 3301 | 828 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:
19731
diff
changeset
|
829 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:
19731
diff
changeset
|
830 error message.\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
831 @seealso{pipe}\n\ |
| 3301 | 832 @end deftypefn") |
| 2075 | 833 { |
| 2669 | 834 octave_value_list retval; |
| 835 | |
| 3523 | 836 retval(1) = std::string (); |
| 4294 | 837 retval(0) = -1; |
| 2075 | 838 |
| 839 int nargin = args.length (); | |
| 840 | |
| 841 if (nargin == 2) | |
| 842 { | |
| 843 if (args(0).is_string ()) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
844 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
845 std::string name = args(0).string_value (); |
| 2075 | 846 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
847 if (args(1).is_scalar_type ()) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
848 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
849 long mode = args(1).long_value (); |
| 2075 | 850 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
851 if (! error_state) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
852 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
853 std::string msg; |
| 4254 | 854 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
855 int status = octave_mkfifo (name, mode, msg); |
| 2669 | 856 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
857 retval(0) = status; |
| 2669 | 858 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
859 if (status < 0) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
860 retval(1) = msg; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
861 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
862 else |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
863 error ("mkfifo: invalid MODE"); |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
864 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
865 else |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
866 error ("mkfifo: MODE must be an integer"); |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
867 } |
| 2075 | 868 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
869 error ("mkfifo: FILE must be a string"); |
| 2075 | 870 } |
| 871 else | |
| 5823 | 872 print_usage (); |
| 2075 | 873 |
| 874 return retval; | |
| 875 } | |
| 876 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
877 DEFUNX ("pipe", Fpipe, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
878 "-*- texinfo -*-\n\ |
| 6321 | 879 @deftypefn {Built-in Function} {[@var{read_fd}, @var{write_fd}, @var{err}, @var{msg}] =} pipe ()\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
880 Create a pipe and return the reading and writing ends of the pipe into\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
881 @var{read_fd} and @var{write_fd} respectively.\n\ |
| 2669 | 882 \n\ |
| 3301 | 883 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:
19731
diff
changeset
|
884 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:
19731
diff
changeset
|
885 error message.\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
886 @seealso{mkfifo}\n\ |
| 3301 | 887 @end deftypefn") |
| 2075 | 888 { |
| 2669 | 889 octave_value_list retval; |
| 890 | |
| 6321 | 891 retval(3) = std::string (); |
| 892 retval(2) = -1; | |
| 4294 | 893 retval(1) = -1; |
| 6321 | 894 retval(0) = -1; |
| 2075 | 895 |
| 896 int nargin = args.length (); | |
| 897 | |
| 898 if (nargin == 0) | |
| 899 { | |
| 900 int fid[2]; | |
| 901 | |
| 3523 | 902 std::string msg; |
| 2937 | 903 |
| 904 int status = octave_syscalls::pipe (fid, msg); | |
| 2669 | 905 |
| 906 if (status < 0) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
907 retval(3) = msg; |
| 2669 | 908 else |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
909 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
910 FILE *ifile = fdopen (fid[0], "r"); |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
911 FILE *ofile = fdopen (fid[1], "w"); |
| 2075 | 912 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
913 std::string nm; |
| 4327 | 914 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
915 octave_stream is = octave_stdiostream::create (nm, ifile, |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
916 std::ios::in); |
| 4327 | 917 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
918 octave_stream os = octave_stdiostream::create (nm, ofile, |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
919 std::ios::out); |
| 2075 | 920 |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
921 retval(2) = status; |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
922 retval(1) = octave_stream_list::insert (os); |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
923 retval(0) = octave_stream_list::insert (is); |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
924 } |
| 2075 | 925 } |
| 926 else | |
| 5823 | 927 print_usage (); |
| 2075 | 928 |
| 929 return retval; | |
| 930 } | |
| 931 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
932 DEFUNX ("stat", Fstat, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
933 "-*- texinfo -*-\n\ |
| 10840 | 934 @deftypefn {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} stat (@var{file})\n\ |
|
11417
1a7b41db5432
Add additional calling form using file descriptor (fid) to docstring for stat.
Rik <octave@nomad.inbox5.com>
parents:
11152
diff
changeset
|
935 @deftypefnx {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} stat (@var{fid})\n\ |
| 3301 | 936 @deftypefnx {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} lstat (@var{file})\n\ |
|
11417
1a7b41db5432
Add additional calling form using file descriptor (fid) to docstring for stat.
Rik <octave@nomad.inbox5.com>
parents:
11152
diff
changeset
|
937 @deftypefnx {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} lstat (@var{fid})\n\ |
|
12211
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
938 Return a structure @var{info} containing the following information about\n\ |
|
11417
1a7b41db5432
Add additional calling form using file descriptor (fid) to docstring for stat.
Rik <octave@nomad.inbox5.com>
parents:
11152
diff
changeset
|
939 @var{file} or file identifier @var{fid}.\n\ |
| 3301 | 940 \n\ |
| 941 @table @code\n\ | |
| 942 @item dev\n\ | |
| 943 ID of device containing a directory entry for this file.\n\ | |
| 944 \n\ | |
| 945 @item ino\n\ | |
| 946 File number of the file.\n\ | |
| 947 \n\ | |
| 5476 | 948 @item mode\n\ |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9064
diff
changeset
|
949 File mode, as an integer. Use the functions @w{@code{S_ISREG}},\n\ |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17236
diff
changeset
|
950 @w{@code{S_ISDIR}}, @w{@code{S_ISCHR}}, @w{@code{S_ISBLK}},\n\ |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17236
diff
changeset
|
951 @w{@code{S_ISFIFO}}, @w{@code{S_ISLNK}}, or @w{@code{S_ISSOCK}} to extract\n\ |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17236
diff
changeset
|
952 information from this value.\n\ |
| 5476 | 953 \n\ |
| 3301 | 954 @item modestr\n\ |
| 955 File mode, as a string of ten letters or dashes as would be returned by\n\ | |
| 956 @kbd{ls -l}.\n\ | |
| 957 \n\ | |
| 958 @item nlink\n\ | |
| 959 Number of links.\n\ | |
| 2075 | 960 \n\ |
| 3301 | 961 @item uid\n\ |
| 962 User ID of file's owner.\n\ | |
| 963 \n\ | |
| 964 @item gid\n\ | |
| 965 Group ID of file's group.\n\ | |
| 966 \n\ | |
| 967 @item rdev\n\ | |
| 968 ID of device for block or character special files.\n\ | |
| 969 \n\ | |
| 970 @item size\n\ | |
| 971 Size in bytes.\n\ | |
| 972 \n\ | |
| 973 @item atime\n\ | |
| 974 Time of last access in the same form as time values returned from\n\ | |
| 975 @code{time}. @xref{Timing Utilities}.\n\ | |
| 976 \n\ | |
| 977 @item mtime\n\ | |
| 978 Time of last modification in the same form as time values returned from\n\ | |
| 979 @code{time}. @xref{Timing Utilities}.\n\ | |
| 2075 | 980 \n\ |
| 3301 | 981 @item ctime\n\ |
| 982 Time of last file status change in the same form as time values\n\ | |
| 983 returned from @code{time}. @xref{Timing Utilities}.\n\ | |
| 984 \n\ | |
| 985 @item blksize\n\ | |
| 986 Size of blocks in the file.\n\ | |
| 987 \n\ | |
| 988 @item blocks\n\ | |
| 989 Number of blocks allocated for file.\n\ | |
| 990 @end table\n\ | |
| 991 \n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
992 If the call is successful @var{err} is 0 and @var{msg} is an empty string.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
993 If the file does not exist, or some other error occurs, @var{info} is an\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
994 empty matrix, @var{err} is @minus{}1, and @var{msg} contains the\n\ |
| 3301 | 995 corresponding system error message.\n\ |
| 996 \n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
997 If @var{file} is a symbolic link, @code{stat} will return information about\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
998 the actual file that is referenced by the link. Use @code{lstat} if you\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
999 want information about the symbolic link itself.\n\ |
| 3301 | 1000 \n\ |
| 10840 | 1001 For example:\n\ |
| 2075 | 1002 \n\ |
| 3301 | 1003 @example\n\ |
|
15065
f7215831fe78
doc: be consistent on var name on stat help text
Carnë Draug <carandraug+dev@gmail.com>
parents:
14861
diff
changeset
|
1004 [info, err, msg] = stat (\"/vmlinuz\")\n\ |
|
f7215831fe78
doc: be consistent on var name on stat help text
Carnë Draug <carandraug+dev@gmail.com>
parents:
14861
diff
changeset
|
1005 @result{} info =\n\ |
|
14360
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1006 @{\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1007 atime = 855399756\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1008 rdev = 0\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1009 ctime = 847219094\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1010 uid = 0\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1011 size = 389218\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1012 blksize = 4096\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1013 mtime = 847219094\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1014 gid = 6\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1015 nlink = 1\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1016 blocks = 768\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1017 mode = -rw-r--r--\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1018 modestr = -rw-r--r--\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1019 ino = 9316\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1020 dev = 2049\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1021 @}\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1022 @result{} err = 0\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1023 @result{} msg =\n\ |
| 3301 | 1024 @end example\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1025 @seealso{lstat, ls, dir}\n\ |
| 3301 | 1026 @end deftypefn") |
| 2075 | 1027 { |
| 2262 | 1028 octave_value_list retval; |
| 2075 | 1029 |
| 1030 if (args.length () == 1) | |
| 1031 { | |
|
10336
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1032 if (args(0).is_scalar_type ()) |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1033 { |
|
10336
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1034 int fid = octave_stream_list::get_file_number (args(0)); |
| 2075 | 1035 |
|
10336
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1036 if (! error_state) |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1037 { |
|
10336
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1038 file_fstat fs (fid); |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1039 |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1040 retval = mk_stat_result (fs); |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1041 } |
|
10336
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1042 } |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1043 else |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1044 { |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1045 std::string fname = args(0).string_value (); |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1046 |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1047 if (! error_state) |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1048 { |
|
10336
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1049 file_stat fs (fname); |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1050 |
|
1603dfe72933
obsolete fstat, handle the functionality by stat
Jaroslav Hajek <highegg@gmail.com>
parents:
10315
diff
changeset
|
1051 retval = mk_stat_result (fs); |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1052 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1053 } |
| 2075 | 1054 } |
| 1055 else | |
| 5823 | 1056 print_usage (); |
| 2075 | 1057 |
| 1058 return retval; | |
| 1059 } | |
| 1060 | |
| 5476 | 1061 DEFUNX ("S_ISREG", FS_ISREG, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1062 "-*- texinfo -*-\n\ |
| 5476 | 1063 @deftypefn {Built-in Function} {} S_ISREG (@var{mode})\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1064 Return true if @var{mode} corresponds to a regular file.\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1065 \n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1066 The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ |
| 5476 | 1067 @seealso{stat, lstat}\n\ |
| 1068 @end deftypefn") | |
| 1069 { | |
| 1070 octave_value retval = false; | |
| 1071 | |
| 1072 if (args.length () == 1) | |
| 1073 { | |
| 1074 double mode = args(0).double_value (); | |
| 1075 | |
| 1076 if (! error_state) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1077 retval = file_stat::is_reg (static_cast<mode_t> (mode)); |
| 5476 | 1078 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1079 error ("S_ISREG: invalid MODE value"); |
| 5476 | 1080 } |
| 1081 else | |
| 5823 | 1082 print_usage (); |
| 5476 | 1083 |
| 1084 return retval; | |
| 1085 } | |
| 1086 | |
| 1087 DEFUNX ("S_ISDIR", FS_ISDIR, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1088 "-*- texinfo -*-\n\ |
| 5476 | 1089 @deftypefn {Built-in Function} {} S_ISDIR (@var{mode})\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1090 Return true if @var{mode} corresponds to a directory.\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1091 \n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1092 The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ |
| 5476 | 1093 @seealso{stat, lstat}\n\ |
| 1094 @end deftypefn") | |
| 1095 { | |
| 1096 octave_value retval = false; | |
| 1097 | |
| 1098 if (args.length () == 1) | |
| 1099 { | |
| 1100 double mode = args(0).double_value (); | |
| 1101 | |
| 1102 if (! error_state) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1103 retval = file_stat::is_dir (static_cast<mode_t> (mode)); |
| 5476 | 1104 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1105 error ("S_ISDIR: invalid MODE value"); |
| 5476 | 1106 } |
| 1107 else | |
| 5823 | 1108 print_usage (); |
| 5476 | 1109 |
| 1110 return retval; | |
| 1111 } | |
| 1112 | |
| 1113 DEFUNX ("S_ISCHR", FS_ISCHR, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1114 "-*- texinfo -*-\n\ |
| 5476 | 1115 @deftypefn {Built-in Function} {} S_ISCHR (@var{mode})\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1116 Return true if @var{mode} corresponds to a character device.\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1117 \n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1118 The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ |
| 5476 | 1119 @seealso{stat, lstat}\n\ |
| 1120 @end deftypefn") | |
| 1121 { | |
| 1122 octave_value retval = false; | |
| 1123 | |
| 1124 if (args.length () == 1) | |
| 1125 { | |
| 1126 double mode = args(0).double_value (); | |
| 1127 | |
| 1128 if (! error_state) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1129 retval = file_stat::is_chr (static_cast<mode_t> (mode)); |
| 5476 | 1130 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1131 error ("S_ISCHR: invalid MODE value"); |
| 5476 | 1132 } |
| 1133 else | |
| 5823 | 1134 print_usage (); |
| 5476 | 1135 |
| 1136 return retval; | |
| 1137 } | |
| 1138 | |
| 1139 DEFUNX ("S_ISBLK", FS_ISBLK, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1140 "-*- texinfo -*-\n\ |
| 5476 | 1141 @deftypefn {Built-in Function} {} S_ISBLK (@var{mode})\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1142 Return true if @var{mode} corresponds to a block device.\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1143 \n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1144 The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ |
| 5476 | 1145 @seealso{stat, lstat}\n\ |
| 1146 @end deftypefn") | |
| 1147 { | |
| 1148 octave_value retval = false; | |
| 1149 | |
| 1150 if (args.length () == 1) | |
| 1151 { | |
| 1152 double mode = args(0).double_value (); | |
| 1153 | |
| 1154 if (! error_state) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1155 retval = file_stat::is_blk (static_cast<mode_t> (mode)); |
| 5476 | 1156 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1157 error ("S_ISBLK: invalid MODE value"); |
| 5476 | 1158 } |
| 1159 else | |
| 5823 | 1160 print_usage (); |
| 5476 | 1161 |
| 1162 return retval; | |
| 1163 } | |
| 1164 | |
| 1165 DEFUNX ("S_ISFIFO", FS_ISFIFO, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1166 "-*- texinfo -*-\n\ |
| 5476 | 1167 @deftypefn {Built-in Function} {} S_ISFIFO (@var{mode})\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1168 Return true if @var{mode} corresponds to a fifo.\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1169 \n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1170 The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ |
| 5476 | 1171 @seealso{stat, lstat}\n\ |
| 1172 @end deftypefn") | |
| 1173 { | |
| 1174 octave_value retval = false; | |
| 1175 | |
| 1176 if (args.length () == 1) | |
| 1177 { | |
| 1178 double mode = args(0).double_value (); | |
| 1179 | |
| 1180 if (! error_state) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1181 retval = file_stat::is_fifo (static_cast<mode_t> (mode)); |
| 5476 | 1182 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1183 error ("S_ISFIFO: invalid MODE value"); |
| 5476 | 1184 } |
| 1185 else | |
| 5823 | 1186 print_usage (); |
| 5476 | 1187 |
| 1188 return retval; | |
| 1189 } | |
| 1190 | |
| 1191 DEFUNX ("S_ISLNK", FS_ISLNK, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1192 "-*- texinfo -*-\n\ |
| 5476 | 1193 @deftypefn {Built-in Function} {} S_ISLNK (@var{mode})\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1194 Return true if @var{mode} corresponds to a symbolic link.\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1195 \n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1196 The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ |
| 5476 | 1197 @seealso{stat, lstat}\n\ |
| 1198 @end deftypefn") | |
| 1199 { | |
| 1200 octave_value retval = false; | |
| 1201 | |
| 1202 if (args.length () == 1) | |
| 1203 { | |
| 1204 double mode = args(0).double_value (); | |
| 1205 | |
| 1206 if (! error_state) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1207 retval = file_stat::is_lnk (static_cast<mode_t> (mode)); |
| 5476 | 1208 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1209 error ("S_ISLNK: invalid MODE value"); |
| 5476 | 1210 } |
| 1211 else | |
| 5823 | 1212 print_usage (); |
| 5476 | 1213 |
| 1214 return retval; | |
| 1215 } | |
| 1216 | |
| 1217 DEFUNX ("S_ISSOCK", FS_ISSOCK, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1218 "-*- texinfo -*-\n\ |
| 5476 | 1219 @deftypefn {Built-in Function} {} S_ISSOCK (@var{mode})\n\ |
|
17397
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1220 Return true if @var{mode} corresponds to a socket.\n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1221 \n\ |
|
0bf2fc8562c9
doc: Update documentation for file and directory functions.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
1222 The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ |
| 5476 | 1223 @seealso{stat, lstat}\n\ |
| 1224 @end deftypefn") | |
| 1225 { | |
| 1226 octave_value retval = false; | |
| 1227 | |
| 1228 if (args.length () == 1) | |
| 1229 { | |
| 1230 double mode = args(0).double_value (); | |
| 1231 | |
| 1232 if (! error_state) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1233 retval = file_stat::is_sock (static_cast<mode_t> (mode)); |
| 5476 | 1234 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1235 error ("S_ISSOCK: invalid MODE value"); |
| 5476 | 1236 } |
| 1237 else | |
| 5823 | 1238 print_usage (); |
| 5476 | 1239 |
| 1240 return retval; | |
| 1241 } | |
| 1242 | |
|
11006
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1243 DEFUN (gethostname, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1244 "-*- texinfo -*-\n\ |
|
12514
e5e66c389597
Add gethostname to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12483
diff
changeset
|
1245 @deftypefn {Built-in Function} {} gethostname ()\n\ |
|
e5e66c389597
Add gethostname to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12483
diff
changeset
|
1246 Return the hostname of the system where Octave is running.\n\ |
|
11006
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1247 @end deftypefn") |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1248 { |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1249 octave_value retval; |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1250 |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1251 if (args.length () == 0) |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1252 retval = octave_env::get_host_name (); |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1253 else |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1254 print_usage (); |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1255 |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1256 return retval; |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1257 } |
|
aca961a3f387
provide gethostname function
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
1258 |
| 5547 | 1259 DEFUN (uname, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1260 "-*- texinfo -*-\n\ |
| 5547 | 1261 @deftypefn {Built-in Function} {[@var{uts}, @var{err}, @var{msg}] =} uname ()\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1262 Return system information in the structure.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1263 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1264 For example:\n\ |
| 5547 | 1265 \n\ |
| 1266 @example\n\ | |
| 1267 @group\n\ | |
| 1268 uname ()\n\ | |
|
14360
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1269 @result{} @{\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1270 sysname = x86_64\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1271 nodename = segfault\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1272 release = 2.6.15-1-amd64-k8-smp\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1273 version = Linux\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1274 machine = #2 SMP Thu Feb 23 04:57:49 UTC 2006\n\ |
|
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14171
diff
changeset
|
1275 @}\n\ |
| 5547 | 1276 @end group\n\ |
| 1277 @end example\n\ | |
| 1278 \n\ | |
| 1279 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ | |
| 1280 Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ | |
| 1281 system-dependent error message.\n\ | |
| 1282 @end deftypefn") | |
| 1283 { | |
| 1284 octave_value_list retval; | |
| 1285 | |
| 1286 if (args.length () == 0) | |
| 1287 { | |
| 1288 octave_uname sysinfo; | |
| 1289 | |
|
10762
d53eb6249892
use scalar map in some syscalls
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
1290 octave_scalar_map m; |
| 5547 | 1291 |
| 1292 m.assign ("sysname", sysinfo.sysname ()); | |
| 1293 m.assign ("nodename", sysinfo.nodename ()); | |
| 1294 m.assign ("release", sysinfo.release ()); | |
| 1295 m.assign ("version", sysinfo.version ()); | |
| 1296 m.assign ("machine", sysinfo.machine ()); | |
| 1297 | |
| 1298 retval(2) = sysinfo.message (); | |
| 1299 retval(1) = sysinfo.error (); | |
| 1300 retval(0) = m; | |
| 1301 } | |
| 1302 else | |
| 5823 | 1303 print_usage (); |
| 5547 | 1304 |
| 1305 return retval; | |
| 1306 } | |
| 1307 | |
|
10197
4d433bd2d4dc
attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents:
10182
diff
changeset
|
1308 DEFUNX ("unlink", Funlink, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1309 "-*- texinfo -*-\n\ |
| 3301 | 1310 @deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} unlink (@var{file})\n\ |
| 1311 Delete the file named @var{file}.\n\ | |
| 2075 | 1312 \n\ |
| 3301 | 1313 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:
19731
diff
changeset
|
1314 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:
19731
diff
changeset
|
1315 error message.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1316 @seealso{delete, rmdir}\n\ |
| 3301 | 1317 @end deftypefn") |
| 2075 | 1318 { |
| 2669 | 1319 octave_value_list retval; |
| 1320 | |
| 3523 | 1321 retval(1) = std::string (); |
| 4294 | 1322 retval(0) = -1; |
| 2075 | 1323 |
| 1324 int nargin = args.length (); | |
| 1325 | |
| 1326 if (nargin == 1) | |
| 1327 { | |
| 1328 if (args(0).is_string ()) | |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1329 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1330 std::string name = args(0).string_value (); |
| 2075 | 1331 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1332 std::string msg; |
| 2669 | 1333 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1334 int status = octave_unlink (name, msg); |
| 2669 | 1335 |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
1336 retval(1) = msg; |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1337 retval(0) = status; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1338 } |
| 2075 | 1339 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1340 error ("unlink: FILE must be a string"); |
| 2075 | 1341 } |
| 1342 else | |
| 5823 | 1343 print_usage (); |
| 2075 | 1344 |
| 1345 return retval; | |
| 1346 } | |
| 1347 | |
|
10299
c992efc0c2fa
use DEFUNX instead of DEFUN for all functions in syscalls.cc
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
1348 DEFUNX ("waitpid", Fwaitpid, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1349 "-*- texinfo -*-\n\ |
| 5453 | 1350 @deftypefn {Built-in Function} {[@var{pid}, @var{status}, @var{msg}] =} waitpid (@var{pid}, @var{options})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1351 Wait for process @var{pid} to terminate.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1352 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1353 The @var{pid} argument can be:\n\ |
| 2075 | 1354 \n\ |
| 3301 | 1355 @table @asis\n\ |
| 1356 @item @minus{}1\n\ | |
| 1357 Wait for any child process.\n\ | |
| 2075 | 1358 \n\ |
| 3301 | 1359 @item 0\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1360 Wait for any child process whose process group ID is equal to that of the\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1361 Octave interpreter process.\n\ |
| 2075 | 1362 \n\ |
| 3301 | 1363 @item > 0\n\ |
| 1364 Wait for termination of the child process with ID @var{pid}.\n\ | |
| 1365 @end table\n\ | |
| 1366 \n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1367 The @var{options} argument can be a bitwise OR of zero or more of the\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1368 following constants:\n\ |
| 2075 | 1369 \n\ |
| 5453 | 1370 @table @code\n\ |
| 3301 | 1371 @item 0\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1372 Wait until signal is received or a child process exits (this is the default\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1373 if the @var{options} argument is missing).\n\ |
| 3301 | 1374 \n\ |
| 5453 | 1375 @item WNOHANG\n\ |
| 3301 | 1376 Do not hang if status is not immediately available.\n\ |
| 2075 | 1377 \n\ |
| 5453 | 1378 @item WUNTRACED\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1379 Report the status of any child processes that are stopped, and whose status\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1380 has not yet been reported since they stopped.\n\ |
| 3301 | 1381 \n\ |
|
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7924
diff
changeset
|
1382 @item WCONTINUE\n\ |
| 5453 | 1383 Return if a stopped child has been resumed by delivery of @code{SIGCONT}.\n\ |
| 1384 This value may not be meaningful on all systems.\n\ | |
| 3301 | 1385 @end table\n\ |
| 1386 \n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1387 If the returned value of @var{pid} is greater than 0, it is the process ID\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1388 of the child process that exited. If an error occurs, @var{pid} will be\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1389 less than zero and @var{msg} will contain a system-dependent error message. \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1390 The value of @var{status} contains additional system-dependent information\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1391 about the subprocess that exited.\n\ |
|
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7924
diff
changeset
|
1392 @seealso{WCONTINUE, WCOREDUMP, WEXITSTATUS, WIFCONTINUED, WIFSIGNALED, WIFSTOPPED, WNOHANG, WSTOPSIG, WTERMSIG, WUNTRACED}\n\ |
| 3301 | 1393 @end deftypefn") |
| 2075 | 1394 { |
| 2669 | 1395 octave_value_list retval; |
| 1396 | |
| 5453 | 1397 retval(2) = std::string (); |
| 1398 retval(1) = 0; | |
| 4294 | 1399 retval(0) = -1; |
| 2075 | 1400 |
| 1401 int nargin = args.length (); | |
| 1402 | |
| 1403 if (nargin == 1 || nargin == 2) | |
| 1404 { | |
| 3202 | 1405 pid_t pid = args(0).int_value (true); |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11572
diff
changeset
|
1406 |
| 2075 | 1407 if (! error_state) |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1408 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1409 int options = 0; |
| 2075 | 1410 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1411 if (args.length () == 2) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1412 options = args(1).int_value (true); |
| 2937 | 1413 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1414 if (! error_state) |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1415 { |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1416 std::string msg; |
| 2669 | 1417 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1418 int status = 0; |
| 5453 | 1419 |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1420 pid_t result = octave_syscalls::waitpid (pid, &status, |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1421 options, msg); |
| 3202 | 1422 |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
1423 retval(2) = msg; |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1424 retval(1) = status; |
|
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
1425 retval(0) = result; |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1426 } |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1427 else |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1428 error ("waitpid: OPTIONS must be an integer"); |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1429 } |
| 3202 | 1430 else |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1431 error ("waitpid: PID must be an integer value"); |
| 2075 | 1432 } |
| 1433 else | |
| 5823 | 1434 print_usage (); |
| 2075 | 1435 |
| 1436 return retval; | |
| 1437 } | |
| 1438 | |
| 5453 | 1439 DEFUNX ("WIFEXITED", FWIFEXITED, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1440 "-*- texinfo -*-\n\ |
| 5453 | 1441 @deftypefn {Built-in Function} {} WIFEXITED (@var{status})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1442 Given @var{status} from a call to @code{waitpid}, return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1443 true if the child terminated normally.\n\ |
| 5453 | 1444 @seealso{waitpid, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WCOREDUMP, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\ |
| 5646 | 1445 @end deftypefn") |
| 5453 | 1446 { |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1447 octave_value retval = false; |
| 5453 | 1448 |
| 1449 if (args.length () == 1) | |
| 1450 { | |
| 1451 int status = args(0).int_value (); | |
| 1452 | |
| 1453 if (! error_state) | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1454 retval = octave_wait::ifexited (status); |
| 5453 | 1455 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1456 error ("WIFEXITED: STATUS must be an integer"); |
| 5453 | 1457 } |
| 1458 | |
| 1459 return retval; | |
| 1460 } | |
| 1461 | |
| 1462 DEFUNX ("WEXITSTATUS", FWEXITSTATUS, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1463 "-*- texinfo -*-\n\ |
| 5453 | 1464 @deftypefn {Built-in Function} {} WEXITSTATUS (@var{status})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1465 Given @var{status} from a call to @code{waitpid}, return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1466 the exit status of the child.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1467 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1468 This function should only be employed if @code{WIFEXITED} returned true.\n\ |
| 5453 | 1469 @seealso{waitpid, WIFEXITED, WIFSIGNALED, WTERMSIG, WCOREDUMP, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\ |
| 1470 @end deftypefn") | |
| 1471 { | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1472 octave_value retval = 0; |
| 5453 | 1473 |
| 1474 if (args.length () == 1) | |
| 1475 { | |
| 1476 int status = args(0).int_value (); | |
| 1477 | |
| 1478 if (! error_state) | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1479 retval = octave_wait::exitstatus (status); |
| 5453 | 1480 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1481 error ("WEXITSTATUS: STATUS must be an integer"); |
| 5453 | 1482 } |
| 1483 | |
| 1484 return retval; | |
| 1485 } | |
| 1486 | |
| 1487 DEFUNX ("WIFSIGNALED", FWIFSIGNALED, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1488 "-*- texinfo -*-\n\ |
| 5453 | 1489 @deftypefn {Built-in Function} {} WIFSIGNALED (@var{status})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1490 Given @var{status} from a call to @code{waitpid}, return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1491 true if the child process was terminated by a signal.\n\ |
| 5453 | 1492 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WTERMSIG, WCOREDUMP, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\ |
| 1493 @end deftypefn") | |
| 1494 { | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1495 octave_value retval = false; |
| 5453 | 1496 |
| 1497 if (args.length () == 1) | |
| 1498 { | |
| 1499 int status = args(0).int_value (); | |
| 1500 | |
| 1501 if (! error_state) | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1502 retval = octave_wait::ifsignaled (status); |
| 5453 | 1503 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1504 error ("WIFSIGNALED: STATUS must be an integer"); |
| 5453 | 1505 } |
| 1506 | |
| 1507 return retval; | |
| 1508 } | |
| 1509 | |
| 1510 DEFUNX ("WTERMSIG", FWTERMSIG, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1511 "-*- texinfo -*-\n\ |
| 5453 | 1512 @deftypefn {Built-in Function} {} WTERMSIG (@var{status})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1513 Given @var{status} from a call to @code{waitpid}, return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1514 the number of the signal that caused the child process to terminate.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1515 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1516 This function should only be employed if @code{WIFSIGNALED} returned true.\n\ |
| 5453 | 1517 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WIFSIGNALED, WCOREDUMP, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\ |
| 1518 @end deftypefn") | |
| 1519 { | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1520 octave_value retval = 0; |
| 5453 | 1521 |
| 1522 if (args.length () == 1) | |
| 1523 { | |
| 1524 int status = args(0).int_value (); | |
| 1525 | |
| 1526 if (! error_state) | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1527 retval = octave_wait::termsig (status); |
| 5453 | 1528 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1529 error ("WTERMSIG: STATUS must be an integer"); |
| 5453 | 1530 } |
| 1531 | |
| 1532 return retval; | |
| 1533 } | |
| 1534 | |
| 1535 DEFUNX ("WCOREDUMP", FWCOREDUMP, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1536 "-*- texinfo -*-\n\ |
| 5453 | 1537 @deftypefn {Built-in Function} {} WCOREDUMP (@var{status})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1538 Given @var{status} from a call to @code{waitpid}, return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1539 true if the child produced a core dump.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1540 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1541 This function should only be employed if @code{WIFSIGNALED} returned true. \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1542 The macro used to implement this function is not specified in POSIX.1-2001\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1543 and is not available on some Unix implementations (e.g., AIX, SunOS).\n\ |
| 5453 | 1544 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\ |
| 1545 @end deftypefn") | |
| 1546 { | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1547 octave_value retval = false; |
| 5453 | 1548 |
| 1549 if (args.length () == 1) | |
| 1550 { | |
| 1551 int status = args(0).int_value (); | |
| 1552 | |
| 1553 if (! error_state) | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1554 retval = octave_wait::coredump (status); |
| 5453 | 1555 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1556 error ("WCOREDUMP: STATUS must be an integer"); |
| 5453 | 1557 } |
| 1558 | |
| 1559 return retval; | |
| 1560 } | |
| 1561 | |
| 1562 DEFUNX ("WIFSTOPPED", FWIFSTOPPED, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1563 "-*- texinfo -*-\n\ |
| 5453 | 1564 @deftypefn {Built-in Function} {} WIFSTOPPED (@var{status})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1565 Given @var{status} from a call to @code{waitpid}, return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1566 true if the child process was stopped by delivery of a signal.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1567 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1568 This is only possible if the call was done using @code{WUNTRACED} or when\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1569 the child is being traced (see ptrace(2)).\n\ |
| 5453 | 1570 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WCOREDUMP, WSTOPSIG, WIFCONTINUED}\n\ |
| 1571 @end deftypefn") | |
| 1572 { | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1573 octave_value retval = false; |
| 5453 | 1574 |
| 1575 if (args.length () == 1) | |
| 1576 { | |
| 1577 int status = args(0).int_value (); | |
| 1578 | |
| 1579 if (! error_state) | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1580 retval = octave_wait::ifstopped (status); |
| 5453 | 1581 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1582 error ("WIFSTOPPED: STATUS must be an integer"); |
| 5453 | 1583 } |
| 1584 | |
| 1585 return retval; | |
| 1586 } | |
| 1587 | |
| 1588 DEFUNX ("WSTOPSIG", FWSTOPSIG, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1589 "-*- texinfo -*-\n\ |
| 5453 | 1590 @deftypefn {Built-in Function} {} WSTOPSIG (@var{status})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1591 Given @var{status} from a call to @code{waitpid}, return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1592 the number of the signal which caused the child to stop.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1593 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1594 This function should only be employed if @code{WIFSTOPPED} returned true.\n\ |
| 5453 | 1595 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WCOREDUMP, WIFSTOPPED, WIFCONTINUED}\n\ |
| 1596 @end deftypefn") | |
| 1597 { | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1598 octave_value retval = 0; |
| 5453 | 1599 |
| 1600 if (args.length () == 1) | |
| 1601 { | |
| 1602 int status = args(0).int_value (); | |
| 1603 | |
| 1604 if (! error_state) | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1605 retval = octave_wait::stopsig (status); |
| 5453 | 1606 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1607 error ("WSTOPSIG: STATUS must be an integer"); |
| 5453 | 1608 } |
| 1609 | |
| 1610 return retval; | |
| 1611 } | |
| 1612 | |
| 1613 DEFUNX ("WIFCONTINUED", FWIFCONTINUED, args, , | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1614 "-*- texinfo -*-\n\ |
| 5453 | 1615 @deftypefn {Built-in Function} {} WIFCONTINUED (@var{status})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1616 Given @var{status} from a call to @code{waitpid}, return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1617 true if the child process was resumed by delivery of @code{SIGCONT}.\n\ |
| 5453 | 1618 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WCOREDUMP, WIFSTOPPED, WSTOPSIG}\n\ |
| 1619 @end deftypefn") | |
| 1620 { | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1621 octave_value retval = false; |
| 5453 | 1622 |
| 1623 if (args.length () == 1) | |
| 1624 { | |
| 1625 int status = args(0).int_value (); | |
| 1626 | |
| 1627 if (! error_state) | |
|
15221
a83b7b2f95ee
avoid C-style cast warnings from GCC for wait-related macros
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
1628 retval = octave_wait::ifcontinued (status); |
| 5453 | 1629 else |
|
12483
7a5aacf65f81
Rewrite error strings in src/ to use variables named in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12212
diff
changeset
|
1630 error ("WIFCONTINUED: STATUS must be an integer"); |
| 5453 | 1631 } |
| 1632 | |
| 1633 return retval; | |
| 1634 } | |
| 1635 | |
|
10249
14eba566f9f0
use DEFUNX instead of DEFUN for canonicalize_file_name
John W. Eaton <jwe@octave.org>
parents:
10197
diff
changeset
|
1636 DEFUNX ("canonicalize_file_name", Fcanonicalize_file_name, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1637 "-*- texinfo -*-\n\ |
|
14819
67b6b47a22f6
doc: Clarify docstrings for canonicalize_file_name, make_absolute_filename
Rik <octave@nomad.inbox5.com>
parents:
14429
diff
changeset
|
1638 @deftypefn {Built-in Function} {[@var{cname}, @var{status}, @var{msg}] =} canonicalize_file_name (@var{fname})\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1639 Return the canonical name of file @var{fname}.\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1640 \n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1641 If the file does not exist the empty string (\"\") is returned.\n\ |
|
14819
67b6b47a22f6
doc: Clarify docstrings for canonicalize_file_name, make_absolute_filename
Rik <octave@nomad.inbox5.com>
parents:
14429
diff
changeset
|
1642 @seealso{make_absolute_filename, is_absolute_filename, is_rooted_relative_filename}\n\ |
| 5138 | 1643 @end deftypefn") |
| 1644 { | |
| 1645 octave_value_list retval; | |
| 1646 | |
| 1647 if (args.length () == 1) | |
| 1648 { | |
|
19437
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
1649 if (args(0).is_string ()) |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1650 { |
|
19437
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
1651 std::string name = args(0).string_value (); |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1652 std::string msg; |
| 5138 | 1653 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1654 std::string result = octave_canonicalize_file_name (name, msg); |
| 5138 | 1655 |
|
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1656 retval(2) = msg; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1657 retval(1) = msg.empty () ? 0 : -1; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1658 retval(0) = result; |
|
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10299
diff
changeset
|
1659 } |
| 5138 | 1660 else |
|
19437
03067dab10ca
Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents:
19186
diff
changeset
|
1661 error ("canonicalize_file_name: NAME must be a string"); |
| 5138 | 1662 } |
| 1663 else | |
| 5823 | 1664 print_usage (); |
| 5138 | 1665 |
| 1666 return retval; | |
| 1667 } | |
| 1668 | |
| 5749 | 1669 static octave_value |
| 7924 | 1670 const_value (const octave_value_list& args, int val) |
| 5749 | 1671 { |
| 1672 octave_value retval; | |
| 1673 | |
| 1674 int nargin = args.length (); | |
| 1675 | |
| 1676 if (nargin == 0) | |
| 1677 retval = val; | |
| 1678 else | |
| 5823 | 1679 print_usage (); |
| 5749 | 1680 |
| 1681 return retval; | |
| 1682 } | |
| 1683 | |
| 2075 | 1684 #if !defined (O_NONBLOCK) && defined (O_NDELAY) |
| 1685 #define O_NONBLOCK O_NDELAY | |
| 1686 #endif | |
| 1687 | |
| 5749 | 1688 DEFUNX ("F_DUPFD", FF_DUPFD, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1689 "-*- texinfo -*-\n\ |
| 5749 | 1690 @deftypefn {Built-in Function} {} F_DUPFD ()\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1691 Return the numerical value to pass to @code{fcntl} to return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1692 a duplicate file descriptor.\n\ |
| 5749 | 1693 @seealso{fcntl, F_GETFD, F_GETFL, F_SETFD, F_SETFL}\n\ |
| 1694 @end deftypefn") | |
| 2075 | 1695 { |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1696 #if defined (F_DUPFD) |
| 7924 | 1697 return const_value (args, F_DUPFD); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1698 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1699 error ("F_DUPFD: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1700 return octave_value (); |
| 2075 | 1701 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1702 } |
| 2075 | 1703 |
| 5749 | 1704 DEFUNX ("F_GETFD", FF_GETFD, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1705 "-*- texinfo -*-\n\ |
| 5749 | 1706 @deftypefn {Built-in Function} {} F_GETFD ()\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1707 Return the numerical value to pass to @code{fcntl} to return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1708 the file descriptor flags.\n\ |
| 5333 | 1709 @seealso{fcntl, F_DUPFD, F_GETFL, F_SETFD, F_SETFL}\n\ |
| 5749 | 1710 @end deftypefn") |
| 1711 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1712 #if defined (F_GETFD) |
| 7924 | 1713 return const_value (args, F_GETFD); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1714 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1715 error ("F_GETFD: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1716 return octave_value (); |
| 2075 | 1717 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1718 } |
| 2075 | 1719 |
| 5749 | 1720 DEFUNX ("F_GETFL", FF_GETFL, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1721 "-*- texinfo -*-\n\ |
| 5749 | 1722 @deftypefn {Built-in Function} {} F_GETFL ()\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1723 Return the numerical value to pass to @code{fcntl} to return\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1724 the file status flags.\n\ |
| 5333 | 1725 @seealso{fcntl, F_DUPFD, F_GETFD, F_SETFD, F_SETFL}\n\ |
| 5749 | 1726 @end deftypefn") |
| 1727 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1728 #if defined (F_GETFL) |
| 7924 | 1729 return const_value (args, F_GETFL); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1730 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1731 error ("F_GETFL: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1732 return octave_value (); |
| 2075 | 1733 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1734 } |
| 2075 | 1735 |
| 5749 | 1736 DEFUNX ("F_SETFD", FF_SETFD, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1737 "-*- texinfo -*-\n\ |
| 5749 | 1738 @deftypefn {Built-in Function} {} F_SETFD ()\n\ |
|
14171
2ced2f59f523
doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
1739 Return the numerical value to pass to @code{fcntl} to set the file\n\ |
| 5749 | 1740 descriptor flags.\n\ |
| 5333 | 1741 @seealso{fcntl, F_DUPFD, F_GETFD, F_GETFL, F_SETFL}\n\ |
| 5749 | 1742 @end deftypefn") |
| 1743 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1744 #if defined (F_SETFD) |
| 7924 | 1745 return const_value (args, F_SETFD); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1746 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1747 error ("F_SETFD: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1748 return octave_value (); |
| 2075 | 1749 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1750 } |
| 2075 | 1751 |
| 5749 | 1752 DEFUNX ("F_SETFL", FF_SETFL, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1753 "-*- texinfo -*-\n\ |
| 5749 | 1754 @deftypefn {Built-in Function} {} F_SETFL ()\n\ |
|
14171
2ced2f59f523
doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
1755 Return the numerical value to pass to @code{fcntl} to set the file\n\ |
| 5749 | 1756 status flags.\n\ |
| 5333 | 1757 @seealso{fcntl, F_DUPFD, F_GETFD, F_GETFL, F_SETFD}\n\ |
| 5749 | 1758 @end deftypefn") |
| 1759 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1760 #if defined (F_SETFL) |
| 7924 | 1761 return const_value (args, F_SETFL); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1762 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1763 error ("F_SETFL: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1764 return octave_value (); |
| 2075 | 1765 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1766 } |
| 2075 | 1767 |
| 5749 | 1768 DEFUNX ("O_APPEND", FO_APPEND, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1769 "-*- texinfo -*-\n\ |
| 5749 | 1770 @deftypefn {Built-in Function} {} O_APPEND ()\n\ |
| 1771 Return the numerical value of the file status flag that may be\n\ | |
| 1772 returned by @code{fcntl} to indicate each write operation appends,\n\ | |
|
11152
39ae406df598
Improve docstrings for functions found in undocumented list.
Rik <octave@nomad.inbox5.com>
parents:
11006
diff
changeset
|
1773 or that may be passed to @code{fcntl} to set the write mode to append.\n\ |
| 5333 | 1774 @seealso{fcntl, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\ |
| 5749 | 1775 @end deftypefn") |
| 1776 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1777 #if defined (O_APPEND) |
| 7924 | 1778 return const_value (args, O_APPEND); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1779 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1780 error ("O_APPEND: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1781 return octave_value (); |
| 2075 | 1782 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1783 } |
| 2075 | 1784 |
| 5749 | 1785 DEFUNX ("O_ASYNC", FO_ASYNC, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1786 "-*- texinfo -*-\n\ |
| 5749 | 1787 @deftypefn {Built-in Function} {} O_ASYNC ()\n\ |
| 1788 Return the numerical value of the file status flag that may be\n\ | |
| 1789 returned by @code{fcntl} to indicate asynchronous I/O.\n\ | |
| 5333 | 1790 @seealso{fcntl, O_APPEND, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\ |
| 5749 | 1791 @end deftypefn") |
| 1792 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1793 #if defined (O_ASYNC) |
| 7924 | 1794 return const_value (args, O_ASYNC); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1795 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1796 error ("O_ASYNC: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1797 return octave_value (); |
| 2669 | 1798 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1799 } |
| 2669 | 1800 |
| 5749 | 1801 DEFUNX ("O_CREAT", FO_CREAT, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1802 "-*- texinfo -*-\n\ |
| 5749 | 1803 @deftypefn {Built-in Function} {} O_CREAT ()\n\ |
| 1804 Return the numerical value of the file status flag that may be\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1805 returned by @code{fcntl} to indicate that a file should be created if it\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1806 does not exist.\n\ |
| 5333 | 1807 @seealso{fcntl, O_APPEND, O_ASYNC, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\ |
| 5749 | 1808 @end deftypefn") |
| 1809 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1810 #if defined (O_CREAT) |
| 7924 | 1811 return const_value (args, O_CREAT); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1812 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1813 error ("O_CREAT: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1814 return octave_value (); |
| 2075 | 1815 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1816 } |
| 2075 | 1817 |
| 5749 | 1818 DEFUNX ("O_EXCL", FO_EXCL, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1819 "-*- texinfo -*-\n\ |
| 5749 | 1820 @deftypefn {Built-in Function} {} O_EXCL ()\n\ |
| 1821 Return the numerical value of the file status flag that may be\n\ | |
| 1822 returned by @code{fcntl} to indicate that file locking is used.\n\ | |
| 5333 | 1823 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\ |
| 5749 | 1824 @end deftypefn") |
| 1825 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1826 #if defined (O_EXCL) |
| 7924 | 1827 return const_value (args, O_EXCL); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1828 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1829 error ("O_EXCL: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1830 return octave_value (); |
| 2075 | 1831 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1832 } |
| 2075 | 1833 |
| 5749 | 1834 DEFUNX ("O_NONBLOCK", FO_NONBLOCK, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1835 "-*- texinfo -*-\n\ |
| 5749 | 1836 @deftypefn {Built-in Function} {} O_NONBLOCK ()\n\ |
| 1837 Return the numerical value of the file status flag that may be\n\ | |
| 1838 returned by @code{fcntl} to indicate that non-blocking I/O is in use,\n\ | |
| 1839 or that may be passsed to @code{fcntl} to set non-blocking I/O.\n\ | |
| 5333 | 1840 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\ |
| 5749 | 1841 @end deftypefn") |
| 1842 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1843 #if defined (O_NONBLOCK) |
| 7924 | 1844 return const_value (args, O_NONBLOCK); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1845 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1846 error ("O_NONBLOCK: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1847 return octave_value (); |
| 2075 | 1848 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1849 } |
| 2075 | 1850 |
| 5749 | 1851 DEFUNX ("O_RDONLY", FO_RDONLY, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1852 "-*- texinfo -*-\n\ |
| 5749 | 1853 @deftypefn {Built-in Function} {} O_RDONLY ()\n\ |
| 1854 Return the numerical value of the file status flag that may be\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1855 returned by @code{fcntl} to indicate that a file is open for reading only.\n\ |
| 5333 | 1856 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\ |
| 5749 | 1857 @end deftypefn") |
| 1858 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1859 #if defined (O_RDONLY) |
| 7924 | 1860 return const_value (args, O_RDONLY); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1861 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1862 error ("O_RDONLY: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1863 return octave_value (); |
| 2075 | 1864 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1865 } |
| 2075 | 1866 |
| 5749 | 1867 DEFUNX ("O_RDWR", FO_RDWR, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1868 "-*- texinfo -*-\n\ |
| 5749 | 1869 @deftypefn {Built-in Function} {} O_RDWR ()\n\ |
| 1870 Return the numerical value of the file status flag that may be\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1871 returned by @code{fcntl} to indicate that a file is open for both reading\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1872 and writing.\n\ |
| 5333 | 1873 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_SYNC, O_TRUNC, O_WRONLY}\n\ |
| 5749 | 1874 @end deftypefn") |
| 1875 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1876 #if defined (O_RDWR) |
| 7924 | 1877 return const_value (args, O_RDWR); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1878 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1879 error ("O_RDWR: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1880 return octave_value (); |
| 2075 | 1881 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1882 } |
| 2075 | 1883 |
| 5749 | 1884 DEFUNX ("O_SYNC", FO_SYNC, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1885 "-*- texinfo -*-\n\ |
| 5749 | 1886 @deftypefn {Built-in Function} {} O_SYNC ()\n\ |
| 1887 Return the numerical value of the file status flag that may be\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1888 returned by @code{fcntl} to indicate that a file is open for synchronous I/O.\n\ |
| 5333 | 1889 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_TRUNC, O_WRONLY}\n\ |
| 5749 | 1890 @end deftypefn") |
| 1891 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1892 #if defined (O_SYNC) |
| 7924 | 1893 return const_value (args, O_SYNC); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1894 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1895 error ("O_SYNC: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1896 return octave_value (); |
| 2669 | 1897 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1898 } |
| 2669 | 1899 |
| 5749 | 1900 DEFUNX ("O_TRUNC", FO_TRUNC, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1901 "-*- texinfo -*-\n\ |
|
19186
0f9c5a15c8fa
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19143
diff
changeset
|
1902 @deftypefn {Built-in Function} {} O_TRUNC ()\n\ |
| 5749 | 1903 Return the numerical value of the file status flag that may be\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1904 returned by @code{fcntl} to indicate that if file exists, it should be\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1905 truncated when writing.\n\ |
| 5333 | 1906 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_WRONLY}\n\ |
| 5749 | 1907 @end deftypefn") |
| 1908 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1909 #if defined (O_TRUNC) |
| 7924 | 1910 return const_value (args, O_TRUNC); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1911 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1912 error ("O_TRUNC: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1913 return octave_value (); |
| 2075 | 1914 #endif |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1915 } |
| 2075 | 1916 |
| 5749 | 1917 DEFUNX ("O_WRONLY", FO_WRONLY, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1918 "-*- texinfo -*-\n\ |
| 5749 | 1919 @deftypefn {Built-in Function} {} O_WRONLY ()\n\ |
| 1920 Return the numerical value of the file status flag that may be\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1921 returned by @code{fcntl} to indicate that a file is open for writing only.\n\ |
| 5333 | 1922 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC}\n\ |
| 5749 | 1923 @end deftypefn") |
| 1924 { | |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1925 #if defined (O_WRONLY) |
| 7924 | 1926 return const_value (args, O_WRONLY); |
|
14111
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1927 #else |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1928 error ("O_WRONLY: not available on this system"); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1929 return octave_value (); |
|
c5222658dc3c
doc: Build documentation for functions even when they are unavailable
Rik <octave@nomad.inbox5.com>
parents:
14022
diff
changeset
|
1930 #endif |
| 5749 | 1931 } |
| 3446 | 1932 |
| 5453 | 1933 #if !defined (WNOHANG) |
| 1934 #define WNOHANG 0 | |
| 1935 #endif | |
| 1936 | |
| 5749 | 1937 DEFUNX ("WNOHANG", FWNOHANG, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1938 "-*- texinfo -*-\n\ |
| 5749 | 1939 @deftypefn {Built-in Function} {} WNOHANG ()\n\ |
| 1940 Return the numerical value of the option argument that may be\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1941 passed to @code{waitpid} to indicate that it should return its status\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1942 immediately instead of waiting for a process to exit.\n\ |
| 5453 | 1943 @seealso{waitpid, WUNTRACED, WCONTINUE}\n\ |
| 5749 | 1944 @end deftypefn") |
| 1945 { | |
| 7924 | 1946 return const_value (args, WNOHANG); |
| 5749 | 1947 } |
| 5453 | 1948 |
| 1949 #if !defined (WUNTRACED) | |
| 1950 #define WUNTRACED 0 | |
| 1951 #endif | |
| 1952 | |
| 5749 | 1953 DEFUNX ("WUNTRACED", FWUNTRACED, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1954 "-*- texinfo -*-\n\ |
| 5749 | 1955 @deftypefn {Built-in Function} {} WUNTRACED ()\n\ |
| 1956 Return the numerical value of the option argument that may be\n\ | |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1957 passed to @code{waitpid} to indicate that it should also return if the child\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1958 process has stopped but is not traced via the @code{ptrace} system call\n\ |
| 5453 | 1959 @seealso{waitpid, WNOHANG, WCONTINUE}\n\ |
| 5749 | 1960 @end deftypefn") |
| 1961 { | |
| 7924 | 1962 return const_value (args, WUNTRACED); |
| 5749 | 1963 } |
| 5453 | 1964 |
| 1965 #if !defined (WCONTINUE) | |
| 1966 #define WCONTINUE 0 | |
| 1967 #endif | |
| 1968 | |
| 5749 | 1969 DEFUNX ("WCONTINUE", FWCONTINUE, args, , |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1970 "-*- texinfo -*-\n\ |
|
9724
f22bbc5d56e9
Fix various incorrect usages of TeXinfo deffn and deftypefn macros
Rik <rdrider0-list@yahoo.com>
parents:
9564
diff
changeset
|
1971 @deftypefn {Built-in Function} {} WCONTINUE ()\n\ |
| 5749 | 1972 Return the numerical value of the option argument that may be\n\ |
|
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1973 passed to @code{waitpid} to indicate that it should also return if a stopped\n\ |
|
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
1974 child has been resumed by delivery of a @code{SIGCONT} signal.\n\ |
| 5453 | 1975 @seealso{waitpid, WNOHANG, WUNTRACED}\n\ |
| 5749 | 1976 @end deftypefn") |
| 1977 { | |
| 7924 | 1978 return const_value (args, WCONTINUE); |
| 2075 | 1979 } |
|
19143
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
18111
diff
changeset
|
1980 |