octave: libinterp/corefcn/syscalls.cc annotate

annotate libinterp/corefcn/syscalls.cc @ 21937:55f7de37b618

maint: Strip trailing whitespace from source files.

author	John W. Eaton <jwe@octave.org>
date	Fri, 17 Jun 2016 05:52:21 -0400
parents	2f33052c68ff
children	baeffde5c87d

rev	line source
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1 /*
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	2
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19403 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 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	5
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	7
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	9 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	11 option) any later version.
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	12
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	16 for more details.
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	17
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	18 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	20 <http://www.gnu.org/licenses/>.
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	21
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	22 */
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	23
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	24 // Thomas Baier <baier@ci.tuwien.ac.at> added the original versions of
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	25 // the following functions:
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	26 //
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	27 // mkfifo unlink waitpid
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	28
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21672 diff changeset	29 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	30 # include "config.h"
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	31 #endif
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	32
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	33 #include <cstdio>
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	34 #include <cstring>
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	35
17236 6a6e3f1a824c save history on exec (bug #39734) John W. Eaton <jwe@octave.org> parents: 15221 diff changeset	36 #include "cmd-hist.h"
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	37 #include "fcntl-wrappers.h"
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2902 diff changeset	38 #include "file-ops.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2902 diff changeset	39 #include "file-stat.h"
11006 aca961a3f387 provide gethostname function John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	40 #include "oct-env.h"
2937 9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe] jwe parents: 2926 diff changeset	41 #include "oct-syscalls.h"
5547 8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	42 #include "oct-uname.h"
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2902 diff changeset	43
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	44 #include "defun.h"
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	45 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21055 diff changeset	46 #include "errwarn.h"
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	47 #include "lo-utils.h"
17236 6a6e3f1a824c save history on exec (bug #39734) John W. Eaton <jwe@octave.org> parents: 15221 diff changeset	48 #include "oct-hist.h"
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	49 #include "oct-map.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20939 diff changeset	50 #include "ovl.h"
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	51 #include "oct-stdstrm.h"
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	52 #include "oct-stream.h"
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	53 #include "sysdep.h"
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	54 #include "utils.h"
2366 c90105b99479 [project @ 1996-10-11 23:22:27 by jwe] jwe parents: 2305 diff changeset	55 #include "variables.h"
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	56 #include "input.h"
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	57
10762 d53eb6249892 use scalar map in some syscalls Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	58 static octave_scalar_map
21737 ab6c639f0678 finish previous changeset (0504351a45e6). John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	59 mk_stat_map (const octave::sys::base_file_stat& fs)
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	60 {
21935 2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	61 static bool have_rdev = file_stat::have_struct_stat_st_rdev ();
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	62 static bool have_blksize = file_stat::have_struct_stat_st_blksize ();
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	63 static bool have_blocks = file_stat::have_struct_stat_st_blocks ();
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	64
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	65 static double nan = octave::numeric_limits<double>::NaN ();
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	66
10762 d53eb6249892 use scalar map in some syscalls Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	67 octave_scalar_map m;
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	68
4675 f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4371 diff changeset	69 m.assign ("dev", static_cast<double> (fs.dev ()));
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4371 diff changeset	70 m.assign ("ino", fs.ino ());
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	71 m.assign ("mode", fs.mode ());
4675 f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4371 diff changeset	72 m.assign ("modestr", fs.mode_as_string ());
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4371 diff changeset	73 m.assign ("nlink", fs.nlink ());
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4371 diff changeset	74 m.assign ("uid", fs.uid ());
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4371 diff changeset	75 m.assign ("gid", fs.gid ());
21935 2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	76 m.assign ("rdev", have_rdev ? static_cast<double> (fs.rdev ()) : nan);
4675 f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4371 diff changeset	77 m.assign ("size", fs.size ());
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4371 diff changeset	78 m.assign ("atime", fs.atime ());
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4371 diff changeset	79 m.assign ("mtime", fs.mtime ());
f6d6335c08f6 [project @ 2003-12-16 05:11:26 by jwe] jwe parents: 4371 diff changeset	80 m.assign ("ctime", fs.ctime ());
21935 2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	81
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	82 if (have_blksize)
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	83 m.assign ("blksize", fs.blksize ());
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	84 else
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	85 m.assign ("blksize", nan);
21937 55f7de37b618 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 21935 diff changeset	86
21935 2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	87 if (have_blocks)
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	88 m.assign ("blocks", fs.blocks ());
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	89 else
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21921 diff changeset	90 m.assign ("blocks", nan);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	91
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	92 return m;
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	93 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	94
10336 1603dfe72933 obsolete fstat, handle the functionality by stat Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	95 static octave_value_list
21737 ab6c639f0678 finish previous changeset (0504351a45e6). John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	96 mk_stat_result (const octave::sys::base_file_stat& fs)
10336 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 if (fs)
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	99 return ovl (octave_value (mk_stat_map (fs)), 0, "");
10336 1603dfe72933 obsolete fstat, handle the functionality by stat Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	100 else
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	101 return ovl (Matrix (), -1, fs.error ());
10336 1603dfe72933 obsolete fstat, handle the functionality by stat Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	102 }
1603dfe72933 obsolete fstat, handle the functionality by stat Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	103
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	104 DEFUNX ("dup2", Fdup2, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	105 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	106 @deftypefn {} {[@var{fid}, @var{msg}] =} dup2 (@var{old}, @var{new})\n\
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	107 Duplicate a file descriptor.\n\
c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	108 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	109 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: 19697 diff changeset	110 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: 19697 diff changeset	111 error message.\n\
19109 e90bfaadb489 doc: Increase seealso links between low level C IO functions. Rik <rik@octave.org> parents: 18112 diff changeset	112 @seealso{fopen, fclose, fcntl}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	113 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	114 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20800 diff changeset	115 if (args.length () != 2)
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	116 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	117
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	118 octave_stream old_stream = octave_stream_list::lookup (args(0), "dup2");
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	119
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	120 octave_stream new_stream = octave_stream_list::lookup (args(1), "dup2");
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	121
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	122 int i_old = old_stream.file_number ();
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	123 int i_new = new_stream.file_number ();
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	124
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	125 if (i_old >= 0 && i_new >= 0)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	126 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	127 std::string msg;
3341 14cfc9475fe4 [project @ 1999-11-05 08:11:58 by jwe] jwe parents: 3340 diff changeset	128
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	129 int status = octave::sys::dup2 (i_old, i_new, msg);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	130
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	131 return ovl (status, msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	132 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	133 else
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	134 return ovl (-1, "");
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	135 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	136
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	137 DEFUNX ("exec", Fexec, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	138 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	139 @deftypefn {} {[@var{err}, @var{msg}] =} exec (@var{file}, @var{args})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	140 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: 19697 diff changeset	141 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	142 Calling @code{exec} without first calling @code{fork} will terminate your\n\
20181 aa36fb998a4d maint: Remove unnecessary whitespace at end of lines. Rik <rik@octave.org> parents: 20172 diff changeset	143 current Octave process and replace it with the program named by @var{file}.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	144 For example,\n\
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	145 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	146 @example\n\
21671 32a6d948fea7 doc: Fix typo in exec docstring. Rik <rik@octave.org> parents: 20198 diff changeset	147 exec (\"ls\", \"-l\")\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	148 @end example\n\
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	149 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	150 @noindent\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	151 will run @code{ls} and return you to your shell prompt.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	152 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	153 If successful, @code{exec} does not return. If @code{exec} does return,\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	154 @var{err} will be nonzero, and @var{msg} will contain a system-dependent\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	155 error message.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	156 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	157 {
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	158 int nargin = args.length ();
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	159
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	160 if (nargin < 1 \|\| nargin > 2)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	161 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	162
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	163 std::string exec_file = args(0).xstring_value ("exec: FILE must be a string");
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	164
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	165 string_vector exec_args;
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	166
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	167 if (nargin == 2)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	168 {
20990 fc9cca99b2de Deprecate all_strings, replace with string_vector_value. Rik <rik@octave.org> parents: 20956 diff changeset	169 string_vector tmp = args(1).xstring_vector_value ("exec: all arguments must be strings");
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	170
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	171 int len = tmp.numel ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	172
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	173 exec_args.resize (len + 1);
2937 9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe] jwe parents: 2926 diff changeset	174
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	175 exec_args[0] = exec_file;
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	176
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	177 for (int i = 0; i < len; i++)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	178 exec_args[i+1] = tmp[i];
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	179 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	180 else
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	181 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	182 exec_args.resize (1);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	183
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	184 exec_args[0] = exec_file;
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	185 }
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	186
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	187 octave_history_write_timestamp ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	188
21748 176536b15d68 use namespace for command_editor and command_history classes John W. Eaton <jwe@octave.org> parents: 21737 diff changeset	189 if (! octave::command_history::ignoring_entries ())
176536b15d68 use namespace for command_editor and command_history classes John W. Eaton <jwe@octave.org> parents: 21737 diff changeset	190 octave::command_history::clean_up_and_save ();
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	191
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	192 std::string msg;
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	193
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	194 int status = octave::sys::execvp (exec_file, exec_args, msg);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	195
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	196 return ovl (status, msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	197 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	198
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	199 DEFUNX ("popen2", Fpopen2, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	200 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	201 @deftypefn {} {[@var{in}, @var{out}, @var{pid}] =} popen2 (@var{command}, @var{args})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	202 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: 19697 diff changeset	203 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	204 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: 19697 diff changeset	205 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: 19697 diff changeset	206 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	207 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: 19697 diff changeset	208 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: 19697 diff changeset	209 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: 19697 diff changeset	210 @var{pid} is @minus{}1.\n\
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	211 \n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	212 For example:\n\
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	213 \n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	214 @example\n\
6923 1fcee6e2c4d3 [project @ 2007-09-25 16:57:12 by jwe] jwe parents: 6678 diff changeset	215 [in, out, pid] = popen2 (\"sort\", \"-r\");\n\
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	216 fputs (in, \"these\\nare\\nsome\\nstrings\\n\");\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	217 fclose (in);\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	218 EAGAIN = errno (\"EAGAIN\");\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	219 done = false;\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	220 do\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	221 s = fgets (out);\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	222 if (ischar (s))\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	223 fputs (stdout, s);\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	224 elseif (errno () == EAGAIN)\n\
20923 58263bea2fdf Unified "sleep" functions to "octave_sleep" in C++ and "pause" in Octave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20898 diff changeset	225 pause (0.1);\n\
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	226 fclear (out);\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	227 else\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	228 done = true;\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	229 endif\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	230 until (done)\n\
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	231 fclose (out);\n\
9563 f5c28d8f5147 syscalls.cc: Recommend waitpid() in popen2() documentation. Rob Mahurin <rob@utk.edu> parents: 9209 diff changeset	232 waitpid (pid);\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	233 \n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	234 @print{} these\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	235 @print{} strings\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	236 @print{} some\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	237 @print{} are\n\
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	238 @end example\n\
9563 f5c28d8f5147 syscalls.cc: Recommend waitpid() in popen2() documentation. Rob Mahurin <rob@utk.edu> parents: 9209 diff changeset	239 \n\
21547 ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	240 Note that @code{popen2}, unlike @code{popen}, will not @nospell{\"reap\"}\n\
ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	241 the child process. If you don't use @code{waitpid} to check the child's\n\
9564 9e4333169eae fix typo in last patch Jaroslav Hajek <highegg@gmail.com> parents: 9563 diff changeset	242 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	243 @seealso{popen, waitpid}\n\
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	244 @end deftypefn")
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	245 {
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	246 int nargin = args.length ();
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	247
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	248 if (nargin < 1 \|\| nargin > 3)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	249 print_usage ();
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	250
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	251 std::string exec_file = args(0).xstring_value ("popen2: COMMAND argument must be a string");
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	252
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	253 string_vector arg_list;
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	254
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	255 if (nargin >= 2)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	256 {
20990 fc9cca99b2de Deprecate all_strings, replace with string_vector_value. Rik <rik@octave.org> parents: 20956 diff changeset	257 string_vector tmp = args(1).xstring_vector_value ("popen2: all arguments must be strings");
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	258
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	259 int len = tmp.numel ();
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	260
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	261 arg_list.resize (len + 1);
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	262
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	263 arg_list[0] = exec_file;
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	264
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	265 for (int i = 0; i < len; i++)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	266 arg_list[i+1] = tmp[i];
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	267 }
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	268 else
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	269 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	270 arg_list.resize (1);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	271
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	272 arg_list[0] = exec_file;
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	273 }
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	274
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	275 bool sync_mode = (nargin == 3 ? args(2).bool_value () : false);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	276
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	277 int filedesc[2];
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	278 std::string msg;
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	279 pid_t pid;
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	280
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	281 pid = octave::sys::popen2 (exec_file, arg_list, sync_mode, filedesc,
cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	282 msg, interactive);
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	283 if (pid < 0)
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	284 error (msg.c_str ());
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	285
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	286 FILE *ifile = fdopen (filedesc[1], "r");
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	287 FILE *ofile = fdopen (filedesc[0], "w");
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	288
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	289 octave_stream is = octave_stdiostream::create (exec_file + "-in",
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	290 ifile,
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	291 std::ios::in);
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	292
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	293 octave_stream os = octave_stdiostream::create (exec_file + "-out",
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	294 ofile,
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	295 std::ios::out);
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	296
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	297 return ovl (octave_stream_list::insert (os),
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	298 octave_stream_list::insert (is),
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	299 pid);
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	300 }
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	301
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	302 /*
18022 c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	303
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	304 %!test # UNIX-style test
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	305 %! if (isunix () \|\| ismac ())
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	306 %! [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	307 %! EAGAIN = errno ("EAGAIN");
18022 c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	308 %! fputs (in, "these\nare\nsome\nstrings\n");
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	309 %! fclose (in);
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	310 %! done = false;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	311 %! str = {};
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	312 %! idx = 0;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	313 %! errs = 0;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	314 %! do
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	315 %! if (ismac ()) # FIXME: Is this necessary?
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	316 %! errno (0);
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	317 %! endif
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	318 %! s = fgets (out);
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	319 %! if (ischar (s))
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	320 %! idx++;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	321 %! str{idx} = s;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	322 %! elseif (errno () == EAGAIN)
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	323 %! fclear (out);
20923 58263bea2fdf Unified "sleep" functions to "octave_sleep" in C++ and "pause" in Octave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20898 diff changeset	324 %! pause (0.1);
18022 c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	325 %! if (++errs == 100)
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	326 %! done = true;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	327 %! endif
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	328 %! else
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	329 %! done = true;
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	330 %! endif
18022 c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	331 %! until (done)
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	332 %! fclose (out);
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	333 %! waitpid (pid);
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	334 %! 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	335 %! endif
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	336
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	337 %!test # Windows-style test
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	338 %! if (ispc () && ! isunix ())
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	339 %! [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	340 %! EAGAIN = errno ("EINVAL");
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	341 %! 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	342 %! fclose (in);
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	343 %! done = false;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	344 %! str = {};
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	345 %! idx = 0;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	346 %! errs = 0;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	347 %! do
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	348 %! errno (0);
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	349 %! s = fgets (out);
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	350 %! if (ischar (s))
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	351 %! idx++;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	352 %! str{idx} = s;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	353 %! elseif (errno () == EAGAIN)
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	354 %! fclear (out);
20923 58263bea2fdf Unified "sleep" functions to "octave_sleep" in C++ and "pause" in Octave. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20898 diff changeset	355 %! pause (0.1);
18022 c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	356 %! if (++errs == 100)
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	357 %! done = true;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	358 %! endif
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	359 %! else
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	360 %! done = true;
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	361 %! endif
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	362 %! until (done)
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	363 %! fclose (out);
c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	364 %! waitpid (pid);
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	365 %! 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	366 %! endif
18022 c3cd335bd71b Rewrite failing popen2 test for Windows (bug #40606). Rik <rik@octave.org> parents: 17969 diff changeset	367
6321 363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	368 */
363a2f8c9e97 [project @ 2007-02-16 20:26:23 by dbateman] dbateman parents: 5872 diff changeset	369
10259 65b41bc71f09 use gnulib fcntl module John W. Eaton <jwe@octave.org> parents: 10252 diff changeset	370 DEFUNX ("fcntl", Ffcntl, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	371 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	372 @deftypefn {} {[@var{err}, @var{msg}] =} fcntl (@var{fid}, @var{request}, @var{arg})\n\
19109 e90bfaadb489 doc: Increase seealso links between low level C IO functions. Rik <rik@octave.org> parents: 18112 diff changeset	373 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: 18112 diff changeset	374 \n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions. Rik <rik@octave.org> parents: 18112 diff changeset	375 The following values may be passed as @var{request}:\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	376 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	377 @vtable @code\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	378 @item F_DUPFD\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	379 Return a duplicate file descriptor.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	380 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	381 @item F_GETFD\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	382 Return the file descriptor flags for @var{fid}.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	383 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	384 @item F_SETFD\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	385 Set the file descriptor flags for @var{fid}.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	386 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	387 @item F_GETFL\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	388 Return the file status flags for @var{fid}. The following codes may be\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	389 returned (some of the flags may be undefined on some systems).\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	390 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	391 @vtable @code\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	392 @item O_RDONLY\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	393 Open for reading only.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	394 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	395 @item O_WRONLY\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	396 Open for writing only.\n\
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	397 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	398 @item O_RDWR\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	399 Open for reading and writing.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	400 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	401 @item O_APPEND\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	402 Append on each write.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	403 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4928 diff changeset	404 @item O_CREAT\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4928 diff changeset	405 Create the file if it does not exist.\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4928 diff changeset	406 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	407 @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	408 Non-blocking mode.\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	409 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	410 @item O_SYNC\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	411 Wait for writes to complete.\n\
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	412 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	413 @item O_ASYNC\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	414 Asynchronous I/O.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	415 @end vtable\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	416 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	417 @item F_SETFL\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	418 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: 19697 diff changeset	419 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	420 @w{@code{O_NONBLOCK}}.\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	421 @end vtable\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	422 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	423 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: 19697 diff changeset	424 @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: 19697 diff changeset	425 message.\n\
19109 e90bfaadb489 doc: Increase seealso links between low level C IO functions. Rik <rik@octave.org> parents: 18112 diff changeset	426 @seealso{fopen, dup2}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	427 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	428 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	429 if (args.length () != 3)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	430 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	431
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	432 octave_stream strm = octave_stream_list::lookup (args(0), "fcntl");
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	433
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	434 int fid = strm.file_number ();
3715 e5ff21d2bac6 [project @ 2000-09-01 05:52:56 by jwe] jwe parents: 3531 diff changeset	435
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	436 // FIXME: Do we want to use xint_value and throw a warning message
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	437 // if input validation fails?
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	438 int req = args(1).int_value (true);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	439 int arg = args(2).int_value (true);
3715 e5ff21d2bac6 [project @ 2000-09-01 05:52:56 by jwe] jwe parents: 3531 diff changeset	440
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	441 // FIXME: Need better checking here?
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	442 if (fid < 0)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	443 error ("fcntl: invalid file id");
2937 9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe] jwe parents: 2926 diff changeset	444
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	445 std::string msg;
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	446
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	447 int status = octave::sys::fcntl (fid, req, arg, msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	448
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	449 return ovl (status, msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	450 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	451
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	452 DEFUNX ("fork", Ffork, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	453 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	454 @deftypefn {} {[@var{pid}, @var{msg}] =} fork ()\n\
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	455 Create a copy of the current process.\n\
c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	456 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	457 Fork can return one of the following values:\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	458 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	459 @table @asis\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	460 @item > 0\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	461 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: 19697 diff changeset	462 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: 19697 diff changeset	463 any child processes to exit.\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	464 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	465 @item 0\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	466 You are in the child process. You can call @code{exec} to start another\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	467 process. If that fails, you should probably call @code{exit}.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	468 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	469 @item < 0\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	470 The call to @code{fork} failed for some reason. You must take evasive\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	471 action. A system dependent error message will be waiting in @var{msg}.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	472 @end table\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	473 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	474 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	475 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	476 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	477
21343 980abb267014 Emit error if fork called directly from command line. Rik <rik@octave.org> parents: 21301 diff changeset	478 if (symbol_table::at_top_level ())
21604 d7a268e68e69 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 21547 diff changeset	479 error ("fork: cannot be called from command line");
21343 980abb267014 Emit error if fork called directly from command line. Rik <rik@octave.org> parents: 21301 diff changeset	480
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	481 std::string msg;
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	482
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	483 pid_t pid = octave::sys::fork (msg);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	484
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	485 return ovl (pid, msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	486 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	487
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	488 DEFUNX ("getpgrp", Fgetpgrp, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	489 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	490 @deftypefn {} {pgid =} getpgrp ()\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	491 Return the process group id of the current process.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	492 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	493 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	494 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	495 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	496
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	497 std::string msg;
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	498
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	499 pid_t pid = octave::sys::getpgrp (msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	500
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	501 return ovl (pid, msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	502 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	503
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	504 DEFUNX ("getpid", Fgetpid, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	505 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	506 @deftypefn {} {pid =} getpid ()\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	507 Return the process id of the current process.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	508 @seealso{getppid}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	509 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	510 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	511 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	512 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	513
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	514 return ovl (octave::sys::getpid ());
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	515 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	516
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	517 DEFUNX ("getppid", Fgetppid, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	518 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	519 @deftypefn {} {pid =} getppid ()\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	520 Return the process id of the parent process.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	521 @seealso{getpid}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	522 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	523 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	524 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	525 print_usage ();
2475 1d7925d6bede [project @ 1996-11-07 04:36:00 by jwe] jwe parents: 2473 diff changeset	526
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	527 return ovl (octave::sys::getppid ());
2475 1d7925d6bede [project @ 1996-11-07 04:36:00 by jwe] jwe parents: 2473 diff changeset	528 }
1d7925d6bede [project @ 1996-11-07 04:36:00 by jwe] jwe parents: 2473 diff changeset	529
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	530 DEFUNX ("getegid", Fgetegid, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	531 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	532 @deftypefn {} {egid =} getegid ()\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	533 Return the effective group id of the current process.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	534 @seealso{getgid}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	535 @end deftypefn")
2475 1d7925d6bede [project @ 1996-11-07 04:36:00 by jwe] jwe parents: 2473 diff changeset	536 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	537 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	538 print_usage ();
2475 1d7925d6bede [project @ 1996-11-07 04:36:00 by jwe] jwe parents: 2473 diff changeset	539
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	540 return ovl (octave::sys::getegid ());
2475 1d7925d6bede [project @ 1996-11-07 04:36:00 by jwe] jwe parents: 2473 diff changeset	541 }
1d7925d6bede [project @ 1996-11-07 04:36:00 by jwe] jwe parents: 2473 diff changeset	542
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	543 DEFUNX ("getgid", Fgetgid, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	544 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	545 @deftypefn {} {gid =} getgid ()\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	546 Return the real group id of the current process.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	547 @seealso{getegid}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	548 @end deftypefn")
2475 1d7925d6bede [project @ 1996-11-07 04:36:00 by jwe] jwe parents: 2473 diff changeset	549 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	550 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	551 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	552
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	553 return ovl (octave::sys::getgid ());
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	554 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	555
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	556 DEFUNX ("geteuid", Fgeteuid, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	557 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	558 @deftypefn {} {euid =} geteuid ()\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	559 Return the effective user id of the current process.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	560 @seealso{getuid}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	561 @end deftypefn")
2472 0c788e9b53b8 [project @ 1996-11-06 04:10:07 by jwe] jwe parents: 2457 diff changeset	562 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	563 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	564 print_usage ();
2473 bb0c213e5885 [project @ 1996-11-06 04:34:55 by jwe] jwe parents: 2472 diff changeset	565
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	566 return ovl (octave::sys::geteuid ());
2472 0c788e9b53b8 [project @ 1996-11-06 04:10:07 by jwe] jwe parents: 2457 diff changeset	567 }
0c788e9b53b8 [project @ 1996-11-06 04:10:07 by jwe] jwe parents: 2457 diff changeset	568
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	569 DEFUNX ("getuid", Fgetuid, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	570 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	571 @deftypefn {} {uid =} getuid ()\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	572 Return the real user id of the current process.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	573 @seealso{geteuid}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	574 @end deftypefn")
2472 0c788e9b53b8 [project @ 1996-11-06 04:10:07 by jwe] jwe parents: 2457 diff changeset	575 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	576 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	577 print_usage ();
2473 bb0c213e5885 [project @ 1996-11-06 04:34:55 by jwe] jwe parents: 2472 diff changeset	578
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	579 return ovl (octave::sys::getuid ());
2472 0c788e9b53b8 [project @ 1996-11-06 04:10:07 by jwe] jwe parents: 2457 diff changeset	580 }
0c788e9b53b8 [project @ 1996-11-06 04:10:07 by jwe] jwe parents: 2457 diff changeset	581
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	582 DEFUNX ("kill", Fkill, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	583 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	584 @deftypefn {} {[@var{err}, @var{msg}] =} kill (@var{pid}, @var{sig})\n\
4294 755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	585 Send signal @var{sig} to process @var{pid}.\n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	586 \n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	587 If @var{pid} is positive, then signal @var{sig} is sent to @var{pid}.\n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	588 \n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	589 If @var{pid} is 0, then signal @var{sig} is sent to every process\n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	590 in the process group of the current process.\n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	591 \n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	592 If @var{pid} is -1, then signal @var{sig} is sent to every process\n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	593 except process 1.\n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	594 \n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	595 If @var{pid} is less than -1, then signal @var{sig} is sent to every\n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	596 process in the process group @var{-pid}.\n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	597 \n\
4371 c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe] jwe parents: 4327 diff changeset	598 If @var{sig} is 0, then no signal is sent, but error checking is still\n\
4294 755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	599 performed.\n\
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	600 \n\
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6923 diff changeset	601 Return 0 if successful, otherwise return -1.\n\
4294 755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	602 @end deftypefn")
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	603 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	604 if (args.length () != 2)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	605 print_usage ();
4294 755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	606
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	607 pid_t pid = args(0).int_value (true);
20560 56fee8f84fe7 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	608
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	609 int sig = args(1).int_value (true);
4294 755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	610
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	611 std::string msg;
4294 755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	612
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	613 int status = octave::sys::kill (pid, sig, msg);
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	614
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	615 return ovl (status, msg);
4294 755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	616 }
755f6509bb01 [project @ 2003-01-11 04:01:53 by jwe] jwe parents: 4254 diff changeset	617
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	618 DEFUNX ("lstat", Flstat, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	619 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	620 @deftypefn {} {@var{info} =} lstat (@var{symlink})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	621 @deftypefnx {} {[@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	622 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	623 @var{symlink}.\n\
0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	624 \n\
0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	625 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	626 @seealso{stat, symlink}\n\
3458 d25bc039237b [project @ 2000-01-19 09:36:14 by jwe] jwe parents: 3446 diff changeset	627 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	628 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	629 if (args.length () != 1)
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	630 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	631
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	632 std::string fname = args(0).xstring_value ("lstat: NAME must be a string");
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	633
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	634 octave::sys::file_stat fs (fname, false);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	635
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	636 return mk_stat_result (fs);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	637 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	638
20200 d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	639 // FIXME: This routine also exists verbatim in file-io.cc.
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	640 // Maybe change to be a general utility routine.
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	641 static int
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	642 convert (int x, int ibase, int obase)
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	643 {
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	644 int retval = 0;
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	645
20200 d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	646 int tmp = x % obase;
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	647
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	648 if (tmp > ibase - 1)
20428 7ac907da9fba Use error() rather than ::error() unless explicitly required. Rik <rik@octave.org> parents: 20232 diff changeset	649 error ("mkfifo: invalid digit");
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	650
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20990 diff changeset	651 retval = tmp;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20990 diff changeset	652 int mult = ibase;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20990 diff changeset	653 while ((x = (x - tmp) / obase))
20200 d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	654 {
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20990 diff changeset	655 tmp = x % obase;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20990 diff changeset	656
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20990 diff changeset	657 if (tmp > ibase - 1)
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20990 diff changeset	658 error ("mkfifo: invalid digit");
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20990 diff changeset	659
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20990 diff changeset	660 retval += mult * tmp;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20990 diff changeset	661 mult *= ibase;
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	662 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	663
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	664 return retval;
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	665 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	666
10197 4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	667 DEFUNX ("mkfifo", Fmkfifo, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	668 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	669 @deftypefn {} {@var{err} =} mkfifo (@var{name}, @var{mode})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	670 @deftypefnx {} {[@var{err}, @var{msg}] =} mkfifo (@var{name}, @var{mode})\n\
20198 b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054). Rik <rik@octave.org> parents: 20181 diff changeset	671 Create a FIFO special file named @var{name} with file mode @var{mode}.\n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054). Rik <rik@octave.org> parents: 20181 diff changeset	672 \n\
20200 d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	673 @var{mode} is interpreted as an octal number and is subject to umask\n\
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	674 processing. The final calculated mode is @code{@var{mode} - @var{umask}}.\n\
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	675 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	676 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	677 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: 19697 diff changeset	678 error message.\n\
20198 b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054). Rik <rik@octave.org> parents: 20181 diff changeset	679 @seealso{pipe, umask}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	680 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	681 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	682 if (args.length () != 2)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	683 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	684
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	685 std::string name = args(0).xstring_value ("mkfifo: FILE must be a string");
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	686
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	687 int octal_mode = args(1).xint_value ("mkfifo: MODE must be an integer");
4254 df5f2e433a11 [project @ 2002-12-31 19:43:07 by jwe] jwe parents: 4233 diff changeset	688
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	689 if (octal_mode < 0)
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	690 error ("mkfifo: MODE must be a positive integer value");
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	691
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	692 int mode = convert (octal_mode, 8, 10);
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	693
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	694 std::string msg;
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	695
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	696 int status = octave::sys::mkfifo (name, mode, msg);
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	697
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	698 return ovl (status, msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	699 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	700
20200 d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	701 /*
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	702
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	703 ## Test input validation
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	704 %!error mkfifo ()
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	705 %!error mkfifo ("abc")
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	706 %!error mkfifo ("abc", 777, 123)
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	707 %!error <FILE must be a string> mkfifo (123, 456)
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	708 ## FIXME: These tests should work, but lasterr is not being set correctly.
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	709 #%!error <MODE must be an integer> mkfifo ("abc", {456})
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	710 #%!error <MODE must be a positive integer value> mkfifo ("abc", -1)
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	711
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	712 */
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	713
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	714 DEFUNX ("pipe", Fpipe, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	715 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	716 @deftypefn {} {[@var{read_fd}, @var{write_fd}, @var{err}, @var{msg}] =} pipe ()\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	717 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: 19697 diff changeset	718 @var{read_fd} and @var{write_fd} respectively.\n\
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	719 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	720 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	721 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: 19697 diff changeset	722 error message.\n\
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	723 @seealso{mkfifo}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	724 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	725 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	726 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	727 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	728
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	729 int fid[2];
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	730 std::string msg;
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	731
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	732 int status = octave::sys::pipe (fid, msg);
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	733
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	734 if (status < 0)
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	735 return ovl (-1, -1, -1, msg);
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	736 else
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	737 {
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	738 FILE *ifile = fdopen (fid[0], "r");
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	739 FILE *ofile = fdopen (fid[1], "w");
4327 c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe] jwe parents: 4294 diff changeset	740
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	741 octave_stream is = octave_stdiostream::create ("pipe-in", ifile,
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	742 std::ios::in);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	743
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	744 octave_stream os = octave_stdiostream::create ("pipe-out", ofile,
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	745 std::ios::out);
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	746
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	747 return ovl (octave_stream_list::insert (is),
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	748 octave_stream_list::insert (os),
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	749 status,
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	750 msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	751 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	752 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	753
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	754 DEFUNX ("stat", Fstat, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	755 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	756 @deftypefn {} {[@var{info}, @var{err}, @var{msg}] =} stat (@var{file})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	757 @deftypefnx {} {[@var{info}, @var{err}, @var{msg}] =} stat (@var{fid})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	758 @deftypefnx {} {[@var{info}, @var{err}, @var{msg}] =} lstat (@var{file})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	759 @deftypefnx {} {[@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	760 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	761 @var{file} or file identifier @var{fid}.\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	762 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	763 @table @code\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	764 @item dev\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	765 ID of device containing a directory entry for this file.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	766 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	767 @item ino\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	768 File number of the file.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	769 \n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	770 @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	771 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	772 @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	773 @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	774 information from this value.\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	775 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	776 @item modestr\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	777 File mode, as a string of ten letters or dashes as would be returned by\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	778 @kbd{ls -l}.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	779 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	780 @item nlink\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	781 Number of links.\n\
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	782 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	783 @item uid\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	784 User ID of file's owner.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	785 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	786 @item gid\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	787 Group ID of file's group.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	788 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	789 @item rdev\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	790 ID of device for block or character special files.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	791 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	792 @item size\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	793 Size in bytes.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	794 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	795 @item atime\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	796 Time of last access in the same form as time values returned from\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	797 @code{time}. @xref{Timing Utilities}.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	798 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	799 @item mtime\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	800 Time of last modification in the same form as time values returned from\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	801 @code{time}. @xref{Timing Utilities}.\n\
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	802 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	803 @item ctime\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	804 Time of last file status change in the same form as time values\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	805 returned from @code{time}. @xref{Timing Utilities}.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	806 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	807 @item blksize\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	808 Size of blocks in the file.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	809 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	810 @item blocks\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	811 Number of blocks allocated for file.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	812 @end table\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	813 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	814 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: 19697 diff changeset	815 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: 19697 diff changeset	816 empty matrix, @var{err} is @minus{}1, and @var{msg} contains the\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	817 corresponding system error message.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	818 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	819 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: 19697 diff changeset	820 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: 19697 diff changeset	821 want information about the symbolic link itself.\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	822 \n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	823 For example:\n\
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	824 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	825 @example\n\
15065 f7215831fe78 doc: be consistent on var name on stat help text Carnë Draug <carandraug+dev@gmail.com> parents: 14861 diff changeset	826 [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	827 @result{} info =\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	828 @{\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	829 atime = 855399756\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	830 rdev = 0\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	831 ctime = 847219094\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	832 uid = 0\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	833 size = 389218\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	834 blksize = 4096\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	835 mtime = 847219094\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	836 gid = 6\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	837 nlink = 1\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	838 blocks = 768\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	839 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	840 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	841 ino = 9316\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	842 dev = 2049\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	843 @}\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	844 @result{} err = 0\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	845 @result{} msg =\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	846 @end example\n\
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	847 @seealso{lstat, ls, dir}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	848 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	849 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	850 if (args.length () != 1)
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	851 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	852
2262 1300df4a33d6 [project @ 1996-05-23 06:49:32 by jwe] jwe parents: 2086 diff changeset	853 octave_value_list retval;
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	854
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	855 if (args(0).is_scalar_type ())
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	856 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	857 int fid = octave_stream_list::get_file_number (args(0));
10336 1603dfe72933 obsolete fstat, handle the functionality by stat Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	858
21737 ab6c639f0678 finish previous changeset (0504351a45e6). John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	859 octave::sys::file_fstat fs (fid);
10336 1603dfe72933 obsolete fstat, handle the functionality by stat Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	860
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	861 retval = mk_stat_result (fs);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	862 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	863 else
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	864 {
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	865 std::string fname = args(0).xstring_value ("stat: NAME must be a string");
10336 1603dfe72933 obsolete fstat, handle the functionality by stat Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	866
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	867 octave::sys::file_stat fs (fname);
10336 1603dfe72933 obsolete fstat, handle the functionality by stat Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	868
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	869 retval = mk_stat_result (fs);
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	870 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	871
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	872 return retval;
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	873 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	874
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	875 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	876 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	877 @deftypefn {} {} S_ISREG (@var{mode})\n\
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	878 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	879 \n\
21547 ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	880 The value of @var{mode} is assumed to be returned from a call to\n\
ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	881 @code{stat}.\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	882 @seealso{stat, lstat}\n\
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	883 @end deftypefn")
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	884 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	885 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	886 print_usage ();
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	887
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	888 double mode = args(0).xdouble_value ("S_ISREG: invalid MODE value");
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	889
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	890 return ovl (octave::sys::file_stat::is_reg (static_cast<mode_t> (mode)));
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	891 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	892
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	893 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	894 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	895 @deftypefn {} {} S_ISDIR (@var{mode})\n\
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	896 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	897 \n\
21547 ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	898 The value of @var{mode} is assumed to be returned from a call to\n\
ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	899 @code{stat}.\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	900 @seealso{stat, lstat}\n\
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	901 @end deftypefn")
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	902 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	903 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	904 print_usage ();
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	905
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	906 double mode = args(0).xdouble_value ("S_ISDIR: invalid MODE value");
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	907
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	908 return ovl (octave::sys::file_stat::is_dir (static_cast<mode_t> (mode)));
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	909 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	910
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	911 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	912 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	913 @deftypefn {} {} S_ISCHR (@var{mode})\n\
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	914 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	915 \n\
21547 ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	916 The value of @var{mode} is assumed to be returned from a call to\n\
ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	917 @code{stat}.\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	918 @seealso{stat, lstat}\n\
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	919 @end deftypefn")
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	920 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	921 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	922 print_usage ();
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	923
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	924 double mode = args(0).xdouble_value ("S_ISCHR: invalid MODE value");
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	925
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	926 return ovl (octave::sys::file_stat::is_chr (static_cast<mode_t> (mode)));
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	927 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	928
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	929 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	930 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	931 @deftypefn {} {} S_ISBLK (@var{mode})\n\
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	932 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	933 \n\
21547 ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	934 The value of @var{mode} is assumed to be returned from a call to\n\
ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	935 @code{stat}.\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	936 @seealso{stat, lstat}\n\
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	937 @end deftypefn")
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	938 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	939 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	940 print_usage ();
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	941
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	942 double mode = args(0).xdouble_value ("S_ISBLK: invalid MODE value");
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	943
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	944 return ovl (octave::sys::file_stat::is_blk (static_cast<mode_t> (mode)));
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	945 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	946
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	947 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	948 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	949 @deftypefn {} {} S_ISFIFO (@var{mode})\n\
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	950 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	951 \n\
21547 ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	952 The value of @var{mode} is assumed to be returned from a call to\n\
ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	953 @code{stat}.\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	954 @seealso{stat, lstat}\n\
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	955 @end deftypefn")
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	956 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	957 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	958 print_usage ();
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	959
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	960 double mode = args(0).xdouble_value ("S_ISFIFO: invalid MODE value");
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	961
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	962 return ovl (octave::sys::file_stat::is_fifo (static_cast<mode_t> (mode)));
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	963 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	964
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	965 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	966 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	967 @deftypefn {} {} S_ISLNK (@var{mode})\n\
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	968 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	969 \n\
21547 ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	970 The value of @var{mode} is assumed to be returned from a call to\n\
ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	971 @code{stat}.\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	972 @seealso{stat, lstat}\n\
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	973 @end deftypefn")
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	974 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	975 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	976 print_usage ();
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	977
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	978 double mode = args(0).xdouble_value ("S_ISLNK: invalid MODE value");
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	979
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	980 return ovl (octave::sys::file_stat::is_lnk (static_cast<mode_t> (mode)));
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	981 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	982
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	983 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	984 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	985 @deftypefn {} {} S_ISSOCK (@var{mode})\n\
17397 0bf2fc8562c9 doc: Update documentation for file and directory functions. Rik <rik@octave.org> parents: 17281 diff changeset	986 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	987 \n\
21547 ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	988 The value of @var{mode} is assumed to be returned from a call to\n\
ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	989 @code{stat}.\n\
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	990 @seealso{stat, lstat}\n\
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	991 @end deftypefn")
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	992 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	993 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	994 print_usage ();
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	995
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	996 double mode = args(0).xdouble_value ("S_ISSOCK: invalid MODE value");
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	997
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	998 return ovl (octave::sys::file_stat::is_sock (static_cast<mode_t> (mode)));
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	999 }
941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5455 diff changeset	1000
11006 aca961a3f387 provide gethostname function John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	1001 DEFUN (gethostname, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1002 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1003 @deftypefn {} {} gethostname ()\n\
12514 e5e66c389597 Add gethostname to documentation. Rik <octave@nomad.inbox5.com> parents: 12483 diff changeset	1004 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	1005 @end deftypefn")
aca961a3f387 provide gethostname function John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	1006 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1007 if (args.length () != 0)
11006 aca961a3f387 provide gethostname function John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	1008 print_usage ();
aca961a3f387 provide gethostname function John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	1009
21732 6a1eded90355 use namespace for system env class John W. Eaton <jwe@octave.org> parents: 21731 diff changeset	1010 return ovl (octave::sys::env::get_host_name ());
11006 aca961a3f387 provide gethostname function John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	1011 }
aca961a3f387 provide gethostname function John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	1012
5547 8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1013 DEFUN (uname, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1014 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1015 @deftypefn {} {[@var{uts}, @var{err}, @var{msg}] =} uname ()\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1016 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: 19697 diff changeset	1017 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1018 For example:\n\
5547 8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1019 \n\
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1020 @example\n\
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1021 @group\n\
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1022 uname ()\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	1023 @result{} @{\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	1024 sysname = x86_64\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	1025 nodename = segfault\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	1026 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	1027 version = Linux\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14171 diff changeset	1028 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	1029 @}\n\
5547 8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1030 @end group\n\
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1031 @end example\n\
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1032 \n\
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1033 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1034 Otherwise, @var{err} is nonzero and @var{msg} contains a\n\
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1035 system-dependent error message.\n\
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1036 @end deftypefn")
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1037 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1038 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	1039 print_usage ();
5547 8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1040
21731 3dfec4c1eb8b use namespace for system uname class John W. Eaton <jwe@octave.org> parents: 21727 diff changeset	1041 octave::sys::uname sysinfo;
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1042
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1043 octave_scalar_map m;
5547 8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1044
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1045 m.assign ("sysname", sysinfo.sysname ());
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1046 m.assign ("nodename", sysinfo.nodename ());
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1047 m.assign ("release", sysinfo.release ());
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1048 m.assign ("version", sysinfo.version ());
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1049 m.assign ("machine", sysinfo.machine ());
5547 8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1050
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1051 return ovl (m, sysinfo.error (), sysinfo.message ());
5547 8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1052 }
8b0b36c2dc0c [project @ 2005-11-29 17:41:33 by jwe] jwe parents: 5476 diff changeset	1053
10197 4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	1054 DEFUNX ("unlink", Funlink, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1055 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1056 @deftypefn {} {[@var{err}, @var{msg}] =} unlink (@var{file})\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1057 Delete the file named @var{file}.\n\
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1058 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1059 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1060 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: 19697 diff changeset	1061 error message.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1062 @seealso{delete, rmdir}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1063 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1064 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1065 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	1066 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1067
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1068 std::string name = args(0).xstring_value ("unlink: FILE must be a string");
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	1069
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1070 std::string msg;
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1071
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	1072 int status = octave::sys::unlink (name, msg);
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	1073
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1074 return ovl (status, msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1075 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1076
10299 c992efc0c2fa use DEFUNX instead of DEFUN for all functions in syscalls.cc John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	1077 DEFUNX ("waitpid", Fwaitpid, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1078 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1079 @deftypefn {} {[@var{pid}, @var{status}, @var{msg}] =} waitpid (@var{pid}, @var{options})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1080 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: 19697 diff changeset	1081 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1082 The @var{pid} argument can be:\n\
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1083 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1084 @table @asis\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1085 @item @minus{}1\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1086 Wait for any child process.\n\
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1087 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1088 @item 0\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1089 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: 19697 diff changeset	1090 Octave interpreter process.\n\
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1091 \n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1092 @item > 0\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1093 Wait for termination of the child process with ID @var{pid}.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1094 @end table\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1095 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1096 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: 19697 diff changeset	1097 following constants:\n\
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1098 \n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1099 @table @code\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1100 @item 0\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1101 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: 19697 diff changeset	1102 if the @var{options} argument is missing).\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1103 \n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1104 @item WNOHANG\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1105 Do not hang if status is not immediately available.\n\
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1106 \n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1107 @item WUNTRACED\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1108 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: 19697 diff changeset	1109 has not yet been reported since they stopped.\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1110 \n\
8286 6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7924 diff changeset	1111 @item WCONTINUE\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1112 Return if a stopped child has been resumed by delivery of @code{SIGCONT}.\n\
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1113 This value may not be meaningful on all systems.\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1114 @end table\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1115 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1116 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: 19697 diff changeset	1117 of the child process that exited. If an error occurs, @var{pid} will be\n\
20181 aa36fb998a4d maint: Remove unnecessary whitespace at end of lines. Rik <rik@octave.org> parents: 20172 diff changeset	1118 less than zero and @var{msg} will contain a system-dependent error message.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1119 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: 19697 diff changeset	1120 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	1121 @seealso{WCONTINUE, WCOREDUMP, WEXITSTATUS, WIFCONTINUED, WIFSIGNALED, WIFSTOPPED, WNOHANG, WSTOPSIG, WTERMSIG, WUNTRACED}\n\
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3202 diff changeset	1122 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1123 {
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1124 int nargin = args.length ();
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1125
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1126 if (nargin != 1 && nargin != 2)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	1127 print_usage ();
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1128
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1129 pid_t pid = args(0).xint_value ("waitpid: OPTIONS must be an integer");
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	1130
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1131 int options = 0;
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1132
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1133 if (nargin == 2)
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1134 options = args(1).xint_value ("waitpid: PID must be an integer value");
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	1135
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1136 std::string msg;
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1137 int status;
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1138
21727 e0da98857c19 rename octave::syscalls namespace to octave::sys John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	1139 pid_t result = octave::sys::waitpid (pid, &status, options, msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1140
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1141 return ovl (result, status, msg);
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1142 }
ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1143
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1144 DEFUNX ("WIFEXITED", FWIFEXITED, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1145 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1146 @deftypefn {} {} WIFEXITED (@var{status})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1147 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: 19697 diff changeset	1148 true if the child terminated normally.\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1149 @seealso{waitpid, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WCOREDUMP, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\
5646 2b20d1707f29 [project @ 2006-03-06 22:38:32 by jwe] jwe parents: 5547 diff changeset	1150 @end deftypefn")
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1151 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1152 if (args.length () != 1)
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1153 print_usage ();
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1154
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1155 int status = args(0).xint_value ("WIFEXITED: STATUS must be an integer");
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1156
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1157 return ovl (octave::sys::wifexited (status));
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1158 }
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1159
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1160 DEFUNX ("WEXITSTATUS", FWEXITSTATUS, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1161 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1162 @deftypefn {} {} WEXITSTATUS (@var{status})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1163 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: 19697 diff changeset	1164 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: 19697 diff changeset	1165 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1166 This function should only be employed if @code{WIFEXITED} returned true.\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1167 @seealso{waitpid, WIFEXITED, WIFSIGNALED, WTERMSIG, WCOREDUMP, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1168 @end deftypefn")
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1169 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1170 if (args.length () != 1)
05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1171 print_usage ();
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1172
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1173 int status = args(0).xint_value ("WEXITSTATUS: STATUS must be an integer");
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1174
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1175 return ovl (octave::sys::wexitstatus (status));
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1176 }
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1177
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1178 DEFUNX ("WIFSIGNALED", FWIFSIGNALED, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1179 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1180 @deftypefn {} {} WIFSIGNALED (@var{status})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1181 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: 19697 diff changeset	1182 true if the child process was terminated by a signal.\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1183 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WTERMSIG, WCOREDUMP, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1184 @end deftypefn")
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1185 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1186 if (args.length () != 1)
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1187 print_usage ();
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1188
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1189 int status = args(0).xint_value ("WIFSIGNALED: STATUS must be an integer");
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1190
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1191 return ovl (octave::sys::wifsignaled (status));
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1192 }
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1193
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1194 DEFUNX ("WTERMSIG", FWTERMSIG, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1195 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1196 @deftypefn {} {} WTERMSIG (@var{status})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1197 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: 19697 diff changeset	1198 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: 19697 diff changeset	1199 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1200 This function should only be employed if @code{WIFSIGNALED} returned true.\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1201 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WIFSIGNALED, WCOREDUMP, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1202 @end deftypefn")
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1203 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1204 if (args.length () != 1)
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1205 print_usage ();
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1206
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1207 int status = args(0).xint_value ("WTERMSIG: STATUS must be an integer");
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1208
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1209 return ovl (octave::sys::wtermsig (status));
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1210 }
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1211
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1212 DEFUNX ("WCOREDUMP", FWCOREDUMP, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1213 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1214 @deftypefn {} {} WCOREDUMP (@var{status})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1215 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: 19697 diff changeset	1216 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: 19697 diff changeset	1217 \n\
20181 aa36fb998a4d maint: Remove unnecessary whitespace at end of lines. Rik <rik@octave.org> parents: 20172 diff changeset	1218 This function should only be employed if @code{WIFSIGNALED} returned true.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1219 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: 19697 diff changeset	1220 and is not available on some Unix implementations (e.g., AIX, SunOS).\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1221 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WIFSTOPPED, WSTOPSIG, WIFCONTINUED}\n\
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1222 @end deftypefn")
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1223 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1224 if (args.length () != 1)
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1225 print_usage ();
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1226
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1227 int status = args(0).xint_value ("WCOREDUMP: STATUS must be an integer");
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1228
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1229 return ovl (octave::sys::wcoredump (status));
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1230 }
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1231
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1232 DEFUNX ("WIFSTOPPED", FWIFSTOPPED, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1233 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1234 @deftypefn {} {} WIFSTOPPED (@var{status})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1235 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: 19697 diff changeset	1236 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: 19697 diff changeset	1237 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1238 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: 19697 diff changeset	1239 the child is being traced (see ptrace(2)).\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1240 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WCOREDUMP, WSTOPSIG, WIFCONTINUED}\n\
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1241 @end deftypefn")
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1242 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1243 if (args.length () != 1)
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1244 print_usage ();
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1245
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1246 int status = args(0).xint_value ("WIFSTOPPED: STATUS must be an integer");
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1247
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1248 return ovl (octave::sys::wifstopped (status));
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1249 }
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1250
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1251 DEFUNX ("WSTOPSIG", FWSTOPSIG, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1252 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1253 @deftypefn {} {} WSTOPSIG (@var{status})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1254 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: 19697 diff changeset	1255 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: 19697 diff changeset	1256 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1257 This function should only be employed if @code{WIFSTOPPED} returned true.\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1258 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WCOREDUMP, WIFSTOPPED, WIFCONTINUED}\n\
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1259 @end deftypefn")
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1260 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1261 if (args.length () != 1)
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1262 print_usage ();
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1263
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1264 int status = args(0).xint_value ("WSTOPSIG: STATUS must be an integer");
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1265
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1266 return ovl (octave::sys::wstopsig (status));
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1267 }
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1268
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1269 DEFUNX ("WIFCONTINUED", FWIFCONTINUED, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1270 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1271 @deftypefn {} {} WIFCONTINUED (@var{status})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1272 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: 19697 diff changeset	1273 true if the child process was resumed by delivery of @code{SIGCONT}.\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1274 @seealso{waitpid, WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WCOREDUMP, WIFSTOPPED, WSTOPSIG}\n\
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1275 @end deftypefn")
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1276 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1277 if (args.length () != 1)
b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1278 print_usage ();
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1279
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1280 int status = args(0).xint_value ("WIFCONTINUED: STATUS must be an integer");
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1281
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1282 return ovl (octave::sys::wifcontinued (status));
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1283 }
89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1284
10249 14eba566f9f0 use DEFUNX instead of DEFUN for canonicalize_file_name John W. Eaton <jwe@octave.org> parents: 10197 diff changeset	1285 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	1286 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1287 @deftypefn {} {[@var{cname}, @var{status}, @var{msg}] =} canonicalize_file_name (@var{fname})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1288 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: 19697 diff changeset	1289 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1290 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	1291 @seealso{make_absolute_filename, is_absolute_filename, is_rooted_relative_filename}\n\
5138 5fa9670b5956 [project @ 2005-02-09 23:13:03 by jwe] jwe parents: 5040 diff changeset	1292 @end deftypefn")
5fa9670b5956 [project @ 2005-02-09 23:13:03 by jwe] jwe parents: 5040 diff changeset	1293 {
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1294 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	1295 print_usage ();
5138 5fa9670b5956 [project @ 2005-02-09 23:13:03 by jwe] jwe parents: 5040 diff changeset	1296
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1297 std::string name = args(0).xstring_value ("canonicalize_file_name: NAME must be a string");
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1298
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1299 std::string msg;
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20560 diff changeset	1300
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21732 diff changeset	1301 std::string result = octave::sys::canonicalize_file_name (name, msg);
20856 b3a18c764161 Code sprint 2015: Refactor print_usage() in syscalls.cc to resemble m-files Yu Liu <yul.liuiyu@gmail.com> parents: 20853 diff changeset	1302
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1303 return ovl (result, msg.empty () ? 0 : -1, msg);
5138 5fa9670b5956 [project @ 2005-02-09 23:13:03 by jwe] jwe parents: 5040 diff changeset	1304 }
5fa9670b5956 [project @ 2005-02-09 23:13:03 by jwe] jwe parents: 5040 diff changeset	1305
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1306 static inline octave_value
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7096 diff changeset	1307 const_value (const octave_value_list& args, int val)
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1308 {
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1309 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	1310 print_usage ();
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1311
20887 05125a9eb9c6 2015 Code Sprint: syscalls.cc: use ovl (), move print_usage to top of fcn. Rik <rik@octave.org> parents: 20856 diff changeset	1312 return octave_value (val);
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1313 }
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1314
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1315 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	1316 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1317 @deftypefn {} {} F_DUPFD ()\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1318 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: 19697 diff changeset	1319 a duplicate file descriptor.\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1320 @seealso{fcntl, F_GETFD, F_GETFL, F_SETFD, F_SETFL}\n\
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1321 @end deftypefn")
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1322 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1323 static int val = octave_f_dupfd_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1324
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1325 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1326 err_disabled_feature ("F_DUPFD", "F_DUPFD");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1327
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1328 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1329 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1330
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1331 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	1332 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1333 @deftypefn {} {} F_GETFD ()\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1334 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: 19697 diff changeset	1335 the file descriptor flags.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1336 @seealso{fcntl, F_DUPFD, F_GETFL, F_SETFD, F_SETFL}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1337 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1338 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1339 static int val = octave_f_getfd_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1340
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1341 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1342 err_disabled_feature ("F_GETFD", "F_GETFD");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1343
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1344 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1345 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1346
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1347 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	1348 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1349 @deftypefn {} {} F_GETFL ()\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1350 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: 19697 diff changeset	1351 the file status flags.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1352 @seealso{fcntl, F_DUPFD, F_GETFD, F_SETFD, F_SETFL}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1353 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1354 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1355 static int val = octave_f_getfl_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1356
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1357 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1358 err_disabled_feature ("F_GETFL", "F_GETFL");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1359
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1360 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1361 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1362
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1363 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	1364 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1365 @deftypefn {} {} F_SETFD ()\n\
14171 2ced2f59f523 doc: miscellaneous documentation improvements Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1366 Return the numerical value to pass to @code{fcntl} to set the file\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1367 descriptor flags.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1368 @seealso{fcntl, F_DUPFD, F_GETFD, F_GETFL, F_SETFL}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1369 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1370 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1371 static int val = octave_f_setfd_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1372
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1373 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1374 err_disabled_feature ("F_SETFD", "F_SETFD");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1375
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1376 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1377 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1378
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1379 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	1380 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1381 @deftypefn {} {} F_SETFL ()\n\
14171 2ced2f59f523 doc: miscellaneous documentation improvements Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1382 Return the numerical value to pass to @code{fcntl} to set the file\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1383 status flags.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1384 @seealso{fcntl, F_DUPFD, F_GETFD, F_GETFL, F_SETFD}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1385 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1386 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1387 static int val = octave_f_setfl_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1388
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1389 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1390 err_disabled_feature ("F_SETFL", "F_SETFL");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1391
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1392 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1393 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1394
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1395 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	1396 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1397 @deftypefn {} {} O_APPEND ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1398 Return the numerical value of the file status flag that may be\n\
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1399 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	1400 or that may be passed to @code{fcntl} to set the write mode to append.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1401 @seealso{fcntl, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1402 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1403 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1404 static int val = octave_o_append_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1405
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1406 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1407 err_disabled_feature ("O_APPEND", "O_APPEND");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1408
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1409 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1410 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1411
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1412 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	1413 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1414 @deftypefn {} {} O_ASYNC ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1415 Return the numerical value of the file status flag that may be\n\
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1416 returned by @code{fcntl} to indicate asynchronous I/O.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1417 @seealso{fcntl, O_APPEND, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1418 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1419 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1420 static int val = octave_o_async_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1421
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1422 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1423 err_disabled_feature ("O_ASYNC", "O_ASYNC");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1424
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1425 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1426 }
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	1427
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1428 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	1429 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1430 @deftypefn {} {} O_CREAT ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1431 Return the numerical value of the file status flag that may be\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1432 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: 19697 diff changeset	1433 does not exist.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1434 @seealso{fcntl, O_APPEND, O_ASYNC, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1435 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1436 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1437 static int val = octave_o_creat_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1438
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1439 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1440 err_disabled_feature ("O_CREAT", "O_CREAT");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1441
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1442 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1443 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1444
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1445 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	1446 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1447 @deftypefn {} {} O_EXCL ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1448 Return the numerical value of the file status flag that may be\n\
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1449 returned by @code{fcntl} to indicate that file locking is used.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1450 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1451 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1452 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1453 static int val = octave_o_excl_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1454
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1455 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1456 err_disabled_feature ("O_EXCL", "O_EXCL");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1457
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1458 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1459 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1460
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1461 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	1462 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1463 @deftypefn {} {} O_NONBLOCK ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1464 Return the numerical value of the file status flag that may be\n\
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1465 returned by @code{fcntl} to indicate that non-blocking I/O is in use,\n\
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1466 or that may be passsed to @code{fcntl} to set non-blocking I/O.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1467 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1468 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1469 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1470 static int val = octave_o_nonblock_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1471
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1472 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1473 err_disabled_feature ("O_NONBLOCK", "O_NONBLOCK");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1474
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1475 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1476 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1477
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1478 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	1479 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1480 @deftypefn {} {} O_RDONLY ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1481 Return the numerical value of the file status flag that may be\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1482 returned by @code{fcntl} to indicate that a file is open for reading only.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1483 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1484 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1485 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1486 static int val = octave_o_rdonly_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1487
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1488 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1489 err_disabled_feature ("O_RDONLY", "O_RDONLY");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1490
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1491 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1492 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1493
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1494 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	1495 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1496 @deftypefn {} {} O_RDWR ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1497 Return the numerical value of the file status flag that may be\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1498 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: 19697 diff changeset	1499 and writing.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1500 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_SYNC, O_TRUNC, O_WRONLY}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1501 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1502 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1503 static int val = octave_o_rdwr_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1504
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1505 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1506 err_disabled_feature ("O_RDWR", "O_RDWR");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1507
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1508 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1509 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1510
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1511 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	1512 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1513 @deftypefn {} {} O_SYNC ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1514 Return the numerical value of the file status flag that may be\n\
21547 ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	1515 returned by @code{fcntl} to indicate that a file is open for synchronous\n\
ad0599a0acc6 doc: Wrap C++ docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21343 diff changeset	1516 I/O.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1517 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_TRUNC, O_WRONLY}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1518 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1519 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1520 static int val = octave_o_sync_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1521
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1522 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1523 err_disabled_feature ("O_SYNC", "O_SYNC");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1524
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1525 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1526 }
2669 c821858188b6 [project @ 1997-02-13 18:25:39 by jwe] jwe parents: 2475 diff changeset	1527
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1528 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	1529 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1530 @deftypefn {} {} O_TRUNC ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1531 Return the numerical value of the file status flag that may be\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1532 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: 19697 diff changeset	1533 truncated when writing.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1534 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_WRONLY}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1535 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1536 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1537 static int val = octave_o_trunc_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1538
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1539 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1540 err_disabled_feature ("O_TRUNC", "O_TRUNC");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1541
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1542 return const_value (args, val);
14111 c5222658dc3c doc: Build documentation for functions even when they are unavailable Rik <octave@nomad.inbox5.com> parents: 14022 diff changeset	1543 }
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1544
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1545 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	1546 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1547 @deftypefn {} {} O_WRONLY ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1548 Return the numerical value of the file status flag that may be\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1549 returned by @code{fcntl} to indicate that a file is open for writing only.\n\
5333 ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe] jwe parents: 5307 diff changeset	1550 @seealso{fcntl, O_APPEND, O_ASYNC, O_CREAT, O_EXCL, O_NONBLOCK, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1551 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1552 {
21911 c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1553 static int val = octave_o_wronly_wrapper ();
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1554
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1555 if (val < 0)
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1556 err_disabled_feature ("O_WRONLY", "O_WRONLY");
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1557
c66c156e1d1d hide fcntl.h header John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	1558 return const_value (args, val);
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1559 }
3446 5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe] jwe parents: 3360 diff changeset	1560
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1561 DEFUNX ("WNOHANG", FWNOHANG, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1562 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1563 @deftypefn {} {} WNOHANG ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1564 Return the numerical value of the option argument that may be\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1565 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: 19697 diff changeset	1566 immediately instead of waiting for a process to exit.\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1567 @seealso{waitpid, WUNTRACED, WCONTINUE}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1568 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1569 {
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1570 return const_value (args, octave::sys::wnohang ());
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1571 }
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1572
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1573 DEFUNX ("WUNTRACED", FWUNTRACED, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1574 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1575 @deftypefn {} {} WUNTRACED ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1576 Return the numerical value of the option argument that may be\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1577 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: 19697 diff changeset	1578 process has stopped but is not traced via the @code{ptrace} system call\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1579 @seealso{waitpid, WNOHANG, WCONTINUE}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1580 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1581 {
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1582 return const_value (args, octave::sys::wuntraced ());
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1583 }
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1584
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1585 DEFUNX ("WCONTINUE", FWCONTINUE, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1586 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20819 diff changeset	1587 @deftypefn {} {} WCONTINUE ()\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1588 Return the numerical value of the option argument that may be\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1589 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: 19697 diff changeset	1590 child has been resumed by delivery of a @code{SIGCONT} signal.\n\
5453 89f5979e8552 [project @ 2005-09-17 00:50:58 by jwe] jwe parents: 5333 diff changeset	1591 @seealso{waitpid, WNOHANG, WUNTRACED}\n\
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1592 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5656 diff changeset	1593 {
21921 ecfcc8527661 hide sys/wait.h header and provide wrappers for waitpid macros John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	1594 return const_value (args, octave::sys::wcontinue ());
2075 ad74682dc97e [project @ 1996-04-23 23:59:15 by jwe] jwe parents: diff changeset	1595 }

Mercurial > octave

annotate libinterp/corefcn/syscalls.cc @ 21937:55f7de37b618