Mercurial > octave-nkf

annotate libinterp/corefcn/file-io.cc @ 20616:fd0efcdb3718

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
use new string_value method to handle value extraction errors * dirfns.cc, file-io.cc, gammainc.cc, help.cc, load-path.cc, octave-link.cc, qz.cc, regexp.cc, strfns.cc, syscalls.cc, time.cc, variables.cc: Use new string_value method.
author John W. Eaton <jwe@octave.org>
date Thu, 08 Oct 2015 19:00:51 -0400
parents c41595061186
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
2
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19631
diff changeset
3 Copyright (C) 1993-2015 John W. Eaton
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
4
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
6
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
10 option) any later version.
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
11
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
15 for more details.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
16
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
19 <http://www.gnu.org/licenses/>.
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
20
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
21 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
22
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
23 // Originally written by John C. Campbell <jcc@bevo.che.wisc.edu>
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
24 //
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
25 // Thomas Baier <baier@ci.tuwien.ac.at> added the original versions of
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
26 // the following functions:
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
27 //
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
28 // popen
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
29 // pclose
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
30 // execute (now popen2.m)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
31 // sync_system (now merged with system)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
32 // async_system (now merged with system)
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
33
9322
66fdc831c580 fix jwe email address
John W. Eaton <jwe@octave.org>
parents: 9236
diff changeset
34 // Extensively revised by John W. Eaton <jwe@octave.org>,
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
35 // April 1996.
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
36
240
a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe]
jwe
parents: 218
diff changeset
37 #ifdef HAVE_CONFIG_H
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
38 #include <config.h>
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
39 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
40
4797
19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe]
jwe
parents: 4726
diff changeset
41 #include <cerrno>
19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe]
jwe
parents: 4726
diff changeset
42 #include <cstdio>
1343
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe]
jwe
parents: 1339
diff changeset
43
3503
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe]
jwe
parents: 3491
diff changeset
44 #include <iostream>
15215
9020dddc925a use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
45 #include <limits>
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7097
diff changeset
46 #include <stack>
4726
14dc2267c343 [project @ 2004-01-23 20:04:35 by jwe]
jwe
parents: 4715
diff changeset
47 #include <vector>
1350
5f63d83dd694 [project @ 1995-09-05 07:37:59 by jwe]
jwe
parents: 1343
diff changeset
48
13958
cb15c5185b6a mkstemp: open file in binary mode (bug #33669)
John W. Eaton <jwe@octave.org>
parents: 13929
diff changeset
49 #include <fcntl.h>
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
50 #include <sys/types.h>
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
51 #include <unistd.h>
1350
5f63d83dd694 [project @ 1995-09-05 07:37:59 by jwe]
jwe
parents: 1343
diff changeset
52
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
53 #ifdef HAVE_ZLIB_H
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
54 #include <zlib.h>
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
55 #endif
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
56
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
57 #include "error.h"
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2902
diff changeset
58 #include "file-ops.h"
6159
645605133a6f [project @ 2006-11-14 02:55:05 by jwe]
jwe
parents: 6108
diff changeset
59 #include "file-stat.h"
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
60 #include "lo-ieee.h"
6159
645605133a6f [project @ 2006-11-14 02:55:05 by jwe]
jwe
parents: 6108
diff changeset
61 #include "oct-env.h"
8377
25bc2d31e1bf improve OCTAVE_LOCAL_BUFFER
Jaroslav Hajek <highegg@gmail.com>
parents: 8021
diff changeset
62 #include "oct-locbuf.h"
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2902
diff changeset
63
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
64 #include "defun.h"
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 6053
diff changeset
65 #include "file-io.h"
6159
645605133a6f [project @ 2006-11-14 02:55:05 by jwe]
jwe
parents: 6108
diff changeset
66 #include "load-path.h"
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
67 #include "oct-fstrm.h"
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
68 #include "oct-iostrm.h"
1377
44f5d41ff757 [project @ 1995-09-12 00:07:58 by jwe]
jwe
parents: 1363
diff changeset
69 #include "oct-map.h"
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
70 #include "oct-obj.h"
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
71 #include "oct-prcstrm.h"
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
72 #include "oct-stream.h"
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
73 #include "oct-strstrm.h"
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
74 #include "pager.h"
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
75 #include "sysdep.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
76 #include "utils.h"
2370
a45c7d64b5e3 [project @ 1996-10-11 23:51:15 by jwe]
jwe
parents: 2341
diff changeset
77 #include "variables.h"
1583
5383d2d4cf9d [project @ 1995-10-27 08:51:20 by jwe]
jwe
parents: 1488
diff changeset
78
2902
c5b7a019b9ed [project @ 1997-04-30 03:46:53 by jwe]
jwe
parents: 2875
diff changeset
79 static octave_value stdin_file;
c5b7a019b9ed [project @ 1997-04-30 03:46:53 by jwe]
jwe
parents: 2875
diff changeset
80 static octave_value stdout_file;
c5b7a019b9ed [project @ 1997-04-30 03:46:53 by jwe]
jwe
parents: 2875
diff changeset
81 static octave_value stderr_file;
c5b7a019b9ed [project @ 1997-04-30 03:46:53 by jwe]
jwe
parents: 2875
diff changeset
82
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
83 static octave_stream stdin_stream;
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
84 static octave_stream stdout_stream;
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
85 static octave_stream stderr_stream;
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
86
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
87 void
164
e2c950dd96d2 [project @ 1993-10-18 19:32:00 by jwe]
jwe
parents: 66
diff changeset
88 initialize_file_io (void)
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
89 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
90 stdin_stream = octave_istream::create (&std::cin, "stdin");
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
91
3531
97cf542676e1 [project @ 2000-02-02 11:30:40 by jwe]
jwe
parents: 3523
diff changeset
92 // This uses octave_stdout (see pager.h), not std::cout so that Octave's
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
93 // standard output stream will pass through the pager.
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
94
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
95 stdout_stream = octave_ostream::create (&octave_stdout, "stdout");
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
96
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
97 stderr_stream = octave_ostream::create (&std::cerr, "stderr");
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
98
2902
c5b7a019b9ed [project @ 1997-04-30 03:46:53 by jwe]
jwe
parents: 2875
diff changeset
99 stdin_file = octave_stream_list::insert (stdin_stream);
c5b7a019b9ed [project @ 1997-04-30 03:46:53 by jwe]
jwe
parents: 2875
diff changeset
100 stdout_file = octave_stream_list::insert (stdout_stream);
c5b7a019b9ed [project @ 1997-04-30 03:46:53 by jwe]
jwe
parents: 2875
diff changeset
101 stderr_file = octave_stream_list::insert (stderr_stream);
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
102 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
103
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
104 void
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
105 close_files (void)
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
106 {
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
107 octave_stream_list::clear ();
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
108 }
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 628
diff changeset
109
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
110 // List of files to delete when we exit or crash.
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
111 //
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
112 // FIXME: this should really be static,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
113 // but that causes problems on some systems.
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
114 std::stack <std::string> tmp_files;
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
115
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
116 void
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
117 mark_for_deletion (const std::string& file)
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
118 {
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
119 tmp_files.push (file);
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
120 }
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
121
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
122 void
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
123 cleanup_tmp_files (void)
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
124 {
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
125 while (! tmp_files.empty ())
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
126 {
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
127 std::string filename = tmp_files.top ();
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
128 tmp_files.pop ();
10411
479cc8a0a846 use gnulib namespace
John W. Eaton <jwe@octave.org>
parents: 10350
diff changeset
129 gnulib::unlink (filename.c_str ());
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
130 }
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
131 }
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
132
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
133 static void
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
134 normalize_fopen_mode (std::string& mode, bool& use_zlib)
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
135 {
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
136 use_zlib = false;
896
4a2133b26fa7 [project @ 1994-11-09 16:04:06 by jwe]
jwe
parents: 870
diff changeset
137
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
138 if (! mode.empty ())
368
5c987c27f3d7 [project @ 1994-02-16 08:33:09 by jwe]
jwe
parents: 367
diff changeset
139 {
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
140 // Could probably be faster, but does it really matter?
1766
e8e76be43e79 [project @ 1996-01-23 03:33:34 by jwe]
jwe
parents: 1755
diff changeset
141
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
142 // Accept 'W', 'R', and 'A' as 'w', 'r', and 'a' but we warn about
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
143 // them because Matlab says they don't perform "automatic
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
144 // flushing" but we don't know precisely what action that implies.
7078
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
145
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
146 size_t pos = mode.find ('W');
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
147
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
148 if (pos != std::string::npos)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
149 {
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
150 warning_with_id ("Octave:fopen-mode",
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
151 "fopen: treating mode \"W\" as equivalent to \"w\"");
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
152 mode[pos] = 'w';
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
153 }
7078
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
154
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
155 pos = mode.find ('R');
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
156
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
157 if (pos != std::string::npos)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
158 {
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
159 warning_with_id ("Octave:fopen-mode",
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
160 "fopen: treating mode \"R\" as equivalent to \"r\"");
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
161 mode[pos] = 'r';
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
162 }
7078
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
163
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
164 pos = mode.find ('A');
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
165
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
166 if (pos != std::string::npos)
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
167 {
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
168 warning_with_id ("Octave:fopen-mode",
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
169 "fopen: treating mode \"A\" as equivalent to \"a\"");
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
170 mode[pos] = 'a';
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
171 }
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
172
7078
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
173 pos = mode.find ('z');
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
174
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
175 if (pos != std::string::npos)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
176 {
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
177 #if defined (HAVE_ZLIB)
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
178 use_zlib = true;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
179 mode.erase (pos, 1);
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
180 #else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
181 error ("this version of Octave does not support gzipped files");
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
182 #endif
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
183 }
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
184
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
185 // Use binary mode if 't' is not specified, but don't add
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
186 // 'b' if it is already present.
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
187
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
188 size_t bpos = mode.find ('b');
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
189 size_t tpos = mode.find ('t');
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
190
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
191 if (bpos == std::string::npos && tpos == std::string::npos)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
192 mode += 'b';
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
193 }
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
194 }
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
195
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
196 static std::ios::openmode
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
197 fopen_mode_to_ios_mode (const std::string& mode)
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
198 {
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
199 std::ios::openmode retval = std::ios::in;
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
200
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
201 if (mode == "rt")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
202 retval = std::ios::in;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
203 else if (mode == "wt")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
204 retval = std::ios::out | std::ios::trunc;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
205 else if (mode == "at")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
206 retval = std::ios::out | std::ios::app;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
207 else if (mode == "r+t" || mode == "rt+")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
208 retval = std::ios::in | std::ios::out;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
209 else if (mode == "w+t" || mode == "wt+")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
210 retval = std::ios::in | std::ios::out | std::ios::trunc;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
211 else if (mode == "a+t" || mode == "at+")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
212 retval = std::ios::in | std::ios::out | std::ios::app;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
213 else if (mode == "rb" || mode == "r")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
214 retval = std::ios::in | std::ios::binary;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
215 else if (mode == "wb" || mode == "w")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
216 retval = std::ios::out | std::ios::trunc | std::ios::binary;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
217 else if (mode == "ab" || mode == "a")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
218 retval = std::ios::out | std::ios::app | std::ios::binary;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
219 else if (mode == "r+b" || mode == "rb+" || mode == "r+")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
220 retval = std::ios::in | std::ios::out | std::ios::binary;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
221 else if (mode == "w+b" || mode == "wb+" || mode == "w+")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
222 retval = (std::ios::in | std::ios::out | std::ios::trunc
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
223 | std::ios::binary);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
224 else if (mode == "a+b" || mode == "ab+" || mode == "a+")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
225 retval = (std::ios::in | std::ios::out | std::ios::app
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
226 | std::ios::binary);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
227 else
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
228 error ("invalid mode specified");
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
229
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
230 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
231 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
232
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
233 DEFUN (fclose, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
234 "-*- texinfo -*-\n\
12575
d0b799dafede Grammarcheck files for 3.4.1 release.
Rik <octave@nomad.inbox5.com>
parents: 12552
diff changeset
235 @deftypefn {Built-in Function} {} fclose (@var{fid})\n\
12552
1cfa3d9adf0a Document the "all" parameter to fclose.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12546
diff changeset
236 @deftypefnx {Built-in Function} {} fclose (\"all\")\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
237 @deftypefnx {Built-in Function} {@var{status} =} fclose (\"all\")\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
238 Close the file specified by the file descriptor @var{fid}.\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
239 \n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
240 If successful, @code{fclose} returns 0, otherwise, it returns -1. The\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
241 second form of the @code{fclose} call closes all open files except\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
242 @code{stdout}, @code{stderr}, and @code{stdin}.\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
243 \n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
244 Programming Note: When using @qcode{\"all\"} the file descriptors associated\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
245 with gnuplot will also be closed. This will prevent further plotting with\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
246 gnuplot until Octave is closed and restarted.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
247 @seealso{fopen, fflush, freport}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
248 @end deftypefn")
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
249 {
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
250 octave_value retval = -1;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
251
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
252 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
253
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
254 if (nargin == 1)
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
255 retval = octave_stream_list::remove (args(0), "fclose");
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
256 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
257 print_usage ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
258
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
259 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
260 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
261
5144
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
262 DEFUN (fclear, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
263 "-*- texinfo -*-\n\
5144
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
264 @deftypefn {Built-in Function} {} fclear (@var{fid})\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
265 Clear the stream state for the file specified by the file descriptor\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
266 @var{fid}.\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
267 @seealso{ferror, fopen}\n\
5144
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
268 @end deftypefn")
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
269 {
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
270 octave_value retval;
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
271
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
272 int nargin = args.length ();
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
273
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
274 if (nargin == 1)
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
275 {
18111
b560bac0fca2 maint: Don't use space between 'args' and '(' when doing indexing.
Rik <rik@octave.org>
parents: 18078
diff changeset
276 int fid = octave_stream_list::get_file_number (args(0));
5144
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
277
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
278 octave_stream os = octave_stream_list::lookup (fid, "fclear");
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
279
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
280 os.clearerr ();
5144
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
281 }
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
282 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
283 print_usage ();
5144
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
284
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
285 return retval;
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
286 }
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
287
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
288 DEFUN (fflush, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
289 "-*- texinfo -*-\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
290 @deftypefn {Built-in Function} {} fflush (@var{fid})\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
291 Flush output to file descriptor @var{fid}.\n\
5095
c9a44ec47b20 [project @ 2004-12-03 14:18:51 by jwe]
jwe
parents: 5041
diff changeset
292 \n\
c9a44ec47b20 [project @ 2004-12-03 14:18:51 by jwe]
jwe
parents: 5041
diff changeset
293 @code{fflush} returns 0 on success and an OS dependent error value\n\
10791
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 10411
diff changeset
294 (@minus{}1 on Unix) on error.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
295 \n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
296 Programming Note: Flushing is useful for ensuring that all pending output\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
297 makes it to the screen before some other event occurs. For example, it is\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
298 always a good idea to flush the standard output stream before calling\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
299 @code{input}.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
300 @seealso{fopen, fclose}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
301 @end deftypefn")
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
302 {
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
303 octave_value retval = -1;
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
304
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
305 int nargin = args.length ();
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
306
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
307 if (nargin == 1)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
308 {
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
309 // FIXME: any way to avoid special case for stdout?
2609
12bc9d0a50b5 [project @ 1997-01-18 00:17:36 by jwe]
jwe
parents: 2599
diff changeset
310
18111
b560bac0fca2 maint: Don't use space between 'args' and '(' when doing indexing.
Rik <rik@octave.org>
parents: 18078
diff changeset
311 int fid = octave_stream_list::get_file_number (args(0));
2609
12bc9d0a50b5 [project @ 1997-01-18 00:17:36 by jwe]
jwe
parents: 2599
diff changeset
312
12bc9d0a50b5 [project @ 1997-01-18 00:17:36 by jwe]
jwe
parents: 2599
diff changeset
313 if (fid == 1)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
314 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
315 flush_octave_stdout ();
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
316
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
317 retval = 0;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
318 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
319 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
320 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
321 octave_stream os = octave_stream_list::lookup (fid, "fflush");
2609
12bc9d0a50b5 [project @ 1997-01-18 00:17:36 by jwe]
jwe
parents: 2599
diff changeset
322
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
323 retval = os.flush ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
324 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
325 }
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
326 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
327 print_usage ();
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
328
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
329 return retval;
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
330 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
331
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
332 DEFUN (fgetl, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
333 "-*- texinfo -*-\n\
14435
f312918f16d2 doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14429
diff changeset
334 @deftypefn {Built-in Function} {@var{str} =} fgetl (@var{fid})\n\
f312918f16d2 doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14429
diff changeset
335 @deftypefnx {Built-in Function} {@var{str} =} fgetl (@var{fid}, @var{len})\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
336 Read characters from a file, stopping after a newline, or EOF,\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
337 or @var{len} characters have been read.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
338 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
339 The characters read, excluding the possible trailing newline, are returned\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
340 as a string.\n\
1339
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
341 \n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
342 If @var{len} is omitted, @code{fgetl} reads until the next newline character.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
343 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
344 If there are no more characters to read, @code{fgetl} returns @minus{}1.\n\
14435
f312918f16d2 doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14429
diff changeset
345 \n\
f312918f16d2 doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14429
diff changeset
346 To read a line and return the terminating newline see @code{fgets}.\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
347 @seealso{fgets, fscanf, fread, fopen}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
348 @end deftypefn")
1339
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
349 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
350 static std::string who = "fgetl";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
351
2599
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2458
diff changeset
352 octave_value_list retval;
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2458
diff changeset
353
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
354 retval(1) = 0;
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
355 retval(0) = -1;
1339
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
356
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
357 int nargin = args.length ();
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
358
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
359 if (nargin == 1 || nargin == 2)
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
360 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
361 octave_stream os = octave_stream_list::lookup (args(0), who);
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
362
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
363 octave_value len_arg = (nargin == 2) ? args(1) : octave_value ();
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
364
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
365 bool err = false;
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
366
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
367 std::string tmp = os.getl (len_arg, err, who);
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
368
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
369 if (! err)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
370 {
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
371 retval(1) = tmp.length ();
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
372 retval(0) = tmp;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
373 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
374 }
1339
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
375 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
376 print_usage ();
1339
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
377
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
378 return retval;
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
379 }
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
380
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
381 DEFUN (fgets, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
382 "-*- texinfo -*-\n\
14435
f312918f16d2 doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14429
diff changeset
383 @deftypefn {Built-in Function} {@var{str} =} fgets (@var{fid})\n\
f312918f16d2 doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14429
diff changeset
384 @deftypefnx {Built-in Function} {@var{str} =} fgets (@var{fid}, @var{len})\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
385 Read characters from a file, stopping after a newline, or EOF,\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
386 or @var{len} characters have been read.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
387 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
388 The characters read, including the possible trailing newline, are returned\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
389 as a string.\n\
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
390 \n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
391 If @var{len} is omitted, @code{fgets} reads until the next newline character.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
392 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
393 If there are no more characters to read, @code{fgets} returns @minus{}1.\n\
14435
f312918f16d2 doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14429
diff changeset
394 \n\
f312918f16d2 doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14429
diff changeset
395 To read a line and discard the terminating newline see @code{fgetl}.\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
396 @seealso{fputs, fgetl, fscanf, fread, fopen}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
397 @end deftypefn")
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
398 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
399 static std::string who = "fgets";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
400
2599
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2458
diff changeset
401 octave_value_list retval;
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2458
diff changeset
402
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2458
diff changeset
403 retval(1) = 0.0;
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2458
diff changeset
404 retval(0) = -1.0;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
405
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
406 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
407
1338
3d235e3c13c0 [project @ 1995-08-25 03:10:55 by jwe]
jwe
parents: 1315
diff changeset
408 if (nargin == 1 || nargin == 2)
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
409 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
410 octave_stream os = octave_stream_list::lookup (args(0), who);
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
411
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
412 octave_value len_arg = (nargin == 2) ? args(1) : octave_value ();
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
413
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
414 bool err = false;
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
415
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
416 std::string tmp = os.gets (len_arg, err, who);
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
417
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
418 if (! err)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
419 {
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
420 retval(1) = tmp.length ();
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
421 retval(0) = tmp;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
422 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
423 }
1338
3d235e3c13c0 [project @ 1995-08-25 03:10:55 by jwe]
jwe
parents: 1315
diff changeset
424 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
425 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
426
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
427 return retval;
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
428 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
429
9701
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
430 DEFUN (fskipl, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
431 "-*- texinfo -*-\n\
14436
12097d20a23e doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents: 14435
diff changeset
432 @deftypefn {Built-in Function} {@var{nlines} =} fskipl (@var{fid})\n\
12097d20a23e doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents: 14435
diff changeset
433 @deftypefnx {Built-in Function} {@var{nlines} =} fskipl (@var{fid}, @var{count})\n\
12097d20a23e doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents: 14435
diff changeset
434 @deftypefnx {Built-in Function} {@var{nlines} =} fskipl (@var{fid}, Inf)\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
435 Read and skip @var{count} lines from the file specified by the file\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
436 descriptor @var{fid}.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
437 \n\
14436
12097d20a23e doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents: 14435
diff changeset
438 @code{fskipl} discards characters until an end-of-line is encountered exactly\n\
12097d20a23e doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents: 14435
diff changeset
439 @var{count}-times, or until the end-of-file marker is found.\n\
12097d20a23e doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents: 14435
diff changeset
440 \n\
12097d20a23e doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents: 14435
diff changeset
441 If @var{count} is omitted, it defaults to 1. @var{count} may also be\n\
12097d20a23e doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents: 14435
diff changeset
442 @code{Inf}, in which case lines are skipped until the end of the file.\n\
12097d20a23e doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents: 14435
diff changeset
443 This form is suitable for counting the number of lines in a file.\n\
12097d20a23e doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents: 14435
diff changeset
444 \n\
9701
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
445 Returns the number of lines skipped (end-of-line sequences encountered).\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
446 @seealso{fgetl, fgets, fscanf, fopen}\n\
9701
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
447 @end deftypefn")
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
448 {
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
449 static std::string who = "fskipl";
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
450
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
451 octave_value retval;
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
452
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
453 int nargin = args.length ();
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
454
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
455 if (nargin == 1 || nargin == 2)
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
456 {
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
457 octave_stream os = octave_stream_list::lookup (args(0), who);
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
458
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
459 octave_value count_arg = (nargin == 2) ? args(1) : octave_value ();
9701
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
460
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
461 bool err = false;
9701
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
462
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
463 off_t tmp = os.skipl (count_arg, err, who);
9701
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
464
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
465 if (! err)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
466 retval = tmp;
9701
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
467 }
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
468 else
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
469 print_usage ();
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
470
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
471 return retval;
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
472 }
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
473
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
474
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3321
diff changeset
475 static octave_stream
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
476 do_stream_open (const std::string& name, const std::string& mode_arg,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
477 const std::string& arch, int& fid)
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
478 {
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3321
diff changeset
479 octave_stream retval;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
480
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
481 fid = -1;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
482
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
483 std::string mode = mode_arg;
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
484 bool use_zlib = false;
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
485 normalize_fopen_mode (mode, use_zlib);
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
486
4036
1432e11733d1 [project @ 2002-08-12 18:38:40 by jwe]
jwe
parents: 4028
diff changeset
487 std::ios::openmode md = fopen_mode_to_ios_mode (mode);
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
488
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
489 oct_mach_info::float_format flt_fmt =
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
490 oct_mach_info::string_to_float_format (arch);
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
491
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
492 std::string fname = file_ops::tilde_expand (name);
6159
645605133a6f [project @ 2006-11-14 02:55:05 by jwe]
jwe
parents: 6108
diff changeset
493
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
494 file_stat fs (fname);
7730
b68e44c90afe file-io.cc (do_stream_open): return -1 for directories
John W. Eaton <jwe@octave.org>
parents: 7708
diff changeset
495
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
496 if (! (md & std::ios::out))
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
497 fname = find_data_file_in_load_path ("fopen", fname);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
498
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
499 if (! fs.is_dir ())
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
500 {
6905
aee959a21c4b [project @ 2007-09-17 16:00:30 by jwe]
jwe
parents: 6838
diff changeset
501 #if defined (HAVE_ZLIB)
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
502 if (use_zlib)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
503 {
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
504 FILE *fptr = gnulib::fopen (fname.c_str (), mode.c_str ());
11004
594adb99a25e cache file id in octave_tstdiostream class
John W. Eaton <jwe@octave.org>
parents: 10840
diff changeset
505
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
506 int fd = fileno (fptr);
11004
594adb99a25e cache file id in octave_tstdiostream class
John W. Eaton <jwe@octave.org>
parents: 10840
diff changeset
507
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
508 gzFile gzf = ::gzdopen (fd, mode.c_str ());
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
509
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
510 if (fptr)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
511 retval = octave_zstdiostream::create (fname, gzf, fd,
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
512 md, flt_fmt);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
513 else
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
514 retval.error (gnulib::strerror (errno));
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
515 }
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
516 else
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
517 #endif
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
518 {
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
519 FILE *fptr = gnulib::fopen (fname.c_str (), mode.c_str ());
5370
f07a9653b844 [project @ 2005-05-24 02:25:57 by jwe]
jwe
parents: 5353
diff changeset
520
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
521 retval = octave_stdiostream::create (fname, fptr, md,
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
522 flt_fmt);
7730
b68e44c90afe file-io.cc (do_stream_open): return -1 for directories
John W. Eaton <jwe@octave.org>
parents: 7708
diff changeset
523
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
524 if (! fptr)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
525 retval.error (gnulib::strerror (errno));
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
526 }
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
527
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
528 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
529
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
530 return retval;
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
531 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
532
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3321
diff changeset
533 static octave_stream
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
534 do_stream_open (const octave_value& tc_name, const octave_value& tc_mode,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
535 const octave_value& tc_arch, const char *fcn, int& fid)
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
536 {
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3321
diff changeset
537 octave_stream retval;
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
538
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
539 fid = -1;
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
540
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
541 std::string name = tc_name.string_value ("%s: file name must be a string", fcn);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
542 std::string mode = tc_mode.string_value ("%s: file mode must be a string", fcn);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
543 std::string arch = tc_arch.string_value ("%s: architecture type must be a string", fcn);
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
544
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
545 retval = do_stream_open (name, mode, arch, fid);
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
546
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
547 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
548 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
549
11146
69b2f237060e file-io.cc (Ffopen): argument parsing tweak
John W. Eaton <jwe@octave.org>
parents: 11081
diff changeset
550 DEFUN (fopen, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
551 "-*- texinfo -*-\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
552 @deftypefn {Built-in Function} {@var{fid} =} fopen (@var{name})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
553 @deftypefnx {Built-in Function} {@var{fid} =} fopen (@var{name}, @var{mode})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
554 @deftypefnx {Built-in Function} {@var{fid} =} fopen (@var{name}, @var{mode}, @var{arch})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
555 @deftypefnx {Built-in Function} {[@var{fid}, @var{msg}] =} fopen (@dots{})\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
556 @deftypefnx {Built-in Function} {@var{fid_list} =} fopen (\"all\")\n\
5353
df230b7df93c [project @ 2005-05-18 02:18:24 by jwe]
jwe
parents: 5333
diff changeset
557 @deftypefnx {Built-in Function} {[@var{file}, @var{mode}, @var{arch}] =} fopen (@var{fid})\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
558 Open a file for low-level I/O or query open files and file descriptors.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
559 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
560 The first form of the @code{fopen} function opens the named file with\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
561 the specified mode (read-write, read-only, etc.) and architecture\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
562 interpretation (IEEE big endian, IEEE little endian, etc.), and returns\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
563 an integer value that may be used to refer to the file later. If an\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
564 error occurs, @var{fid} is set to @minus{}1 and @var{msg} contains the\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
565 corresponding system error message. The @var{mode} is a one or two\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
566 character string that specifies whether the file is to be opened for\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
567 reading, writing, or both.\n\
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
568 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
569 The second form of the @code{fopen} function returns a vector of file ids\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
570 corresponding to all the currently open files, excluding the\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
571 @code{stdin}, @code{stdout}, and @code{stderr} streams.\n\
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
572 \n\
5353
df230b7df93c [project @ 2005-05-18 02:18:24 by jwe]
jwe
parents: 5333
diff changeset
573 The third form of the @code{fopen} function returns information about the\n\
df230b7df93c [project @ 2005-05-18 02:18:24 by jwe]
jwe
parents: 5333
diff changeset
574 open file given its file id.\n\
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
575 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
576 For example,\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
577 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
578 @example\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
579 myfile = fopen (\"splat.dat\", \"r\", \"ieee-le\");\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
580 @end example\n\
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
581 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
582 @noindent\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
583 opens the file @file{splat.dat} for reading. If necessary, binary\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
584 numeric values will be read assuming they are stored in IEEE format with\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
585 the least significant bit first, and then converted to the native\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
586 representation.\n\
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
587 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
588 Opening a file that is already open simply opens it again and returns a\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
589 separate file id. It is not an error to open a file several times,\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
590 though writing to the same file through several different file ids may\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
591 produce unexpected results.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
592 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
593 The possible values @samp{mode} may have are\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
594 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
595 @table @asis\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
596 @item @samp{r} (default)\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
597 Open a file for reading.\n\
3263
7d80b56e0dc8 [project @ 1999-08-20 19:10:09 by jwe]
jwe
parents: 3246
diff changeset
598 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
599 @item @samp{w}\n\
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6905
diff changeset
600 Open a file for writing. The previous contents are discarded.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
601 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
602 @item @samp{a}\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
603 Open or create a file for writing at the end of the file.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
604 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
605 @item @samp{r+}\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
606 Open an existing file for reading and writing.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
607 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
608 @item @samp{w+}\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
609 Open a file for reading or writing. The previous contents are\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
610 discarded.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
611 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
612 @item @samp{a+}\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
613 Open or create a file for reading or writing at the end of the\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
614 file.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
615 @end table\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
616 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
617 Append a @qcode{\"t\"} to the mode string to open the file in text mode or a\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
618 @qcode{\"b\"} to open in binary mode. On Windows and Macintosh systems, text\n\
4865
2ac0f95eaa29 [project @ 2004-04-16 16:32:24 by jwe]
jwe
parents: 4799
diff changeset
619 mode reading and writing automatically converts linefeeds to the\n\
2ac0f95eaa29 [project @ 2004-04-16 16:32:24 by jwe]
jwe
parents: 4799
diff changeset
620 appropriate line end character for the system (carriage-return linefeed\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
621 on Windows, carriage-return on Macintosh). The default when no mode is\n\
4865
2ac0f95eaa29 [project @ 2004-04-16 16:32:24 by jwe]
jwe
parents: 4799
diff changeset
622 specified is binary mode.\n\
2ac0f95eaa29 [project @ 2004-04-16 16:32:24 by jwe]
jwe
parents: 4799
diff changeset
623 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
624 Additionally, you may append a @qcode{\"z\"} to the mode string to open a\n\
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
625 gzipped file for reading or writing. For this to be successful, you\n\
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
626 must also open the file in binary mode.\n\
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
627 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
628 The parameter @var{arch} is a string specifying the default data format\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
629 for the file. Valid values for @var{arch} are:\n\
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
630 \n\
20466
f02c22f71cdb doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents: 20233
diff changeset
631 @table @asis\n\
f02c22f71cdb doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents: 20233
diff changeset
632 @item @qcode{\"native\"} or @qcode{\"n\"} (default)\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
633 The format of the current machine.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
634 \n\
20466
f02c22f71cdb doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents: 20233
diff changeset
635 @item @qcode{\"ieee-be\"} or @qcode{\"b\"}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
636 IEEE big endian format.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
637 \n\
20466
f02c22f71cdb doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents: 20233
diff changeset
638 @item @qcode{\"ieee-le\"} or @qcode{\"l\"}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
639 IEEE little endian format.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
640 @end table\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
641 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
642 @noindent\n\
20466
f02c22f71cdb doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents: 20233
diff changeset
643 However, conversions are currently only supported for @samp{native},\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
644 @samp{ieee-be}, and @samp{ieee-le} formats.\n\
20233
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
645 \n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
646 When opening a new file that does not yet exist, permissions will be set to\n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
647 @code{0666 - @var{umask}}.\n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
648 @seealso{fclose, fgets, fgetl, fscanf, fread, fputs, fdisp, fprintf, fwrite, fskipl, fseek, frewind, ftell, feof, ferror, fclear, fflush, freport, umask}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
649 @end deftypefn")
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
650 {
2599
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2458
diff changeset
651 octave_value_list retval;
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2458
diff changeset
652
9705ea40f0a2 [project @ 1996-12-19 04:49:09 by jwe]
jwe
parents: 2458
diff changeset
653 retval(0) = -1.0;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
654
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
655 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
656
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
657 if (nargin == 1)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
658 {
12896
a19b50f6697f Correctly allow single string input form of fopen() (Bug #33535).
Rik <octave@nomad.inbox5.com>
parents: 12775
diff changeset
659 if (args(0).is_string ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
660 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
661 // If there is only one argument and it is a string but it
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
662 // is not the string "all", we assume it is a file to open
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
663 // with MODE = "r". To open a file called "all", you have
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
664 // to supply more than one argument.
3263
7d80b56e0dc8 [project @ 1999-08-20 19:10:09 by jwe]
jwe
parents: 3246
diff changeset
665
12896
a19b50f6697f Correctly allow single string input form of fopen() (Bug #33535).
Rik <octave@nomad.inbox5.com>
parents: 12775
diff changeset
666 if (nargout < 2 && args(0).string_value () == "all")
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
667 return octave_stream_list::open_file_numbers ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
668 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
669 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
670 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
671 string_vector tmp = octave_stream_list::get_info (args(0));
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
672
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
673 retval(2) = tmp(2);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
674 retval(1) = tmp(1);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
675 retval(0) = tmp(0);
3263
7d80b56e0dc8 [project @ 1999-08-20 19:10:09 by jwe]
jwe
parents: 3246
diff changeset
676
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
677 return retval;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
678 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
679 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
680
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
681 if (nargin > 0 && nargin < 4)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
682 {
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
683 octave_value mode = (nargin == 2 || nargin == 3)
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
684 ? args(1) : octave_value ("r");
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
685
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
686 octave_value arch = (nargin == 3)
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
687 ? args(2) : octave_value ("native");
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
688
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
689 int fid = -1;
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
690
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3321
diff changeset
691 octave_stream os = do_stream_open (args(0), mode, arch, "fopen", fid);
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
692
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
693 if (os)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
694 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
695 retval(1) = "";
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
696 retval(0) = octave_stream_list::insert (os);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
697 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
698 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
699 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
700 int error_number = 0;
5370
f07a9653b844 [project @ 2005-05-24 02:25:57 by jwe]
jwe
parents: 5353
diff changeset
701
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
702 retval(1) = os.error (false, error_number);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
703 retval(0) = -1.0;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
704 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
705 }
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
706 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
707 print_usage ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
708
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
709 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
710 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
711
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
712 DEFUN (freport, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
713 "-*- texinfo -*-\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
714 @deftypefn {Built-in Function} {} freport ()\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
715 Print a list of which files have been opened, and whether they are open\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
716 for reading, writing, or both.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
717 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
718 For example:\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
719 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
720 @example\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
721 @group\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
722 freport ()\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
723 \n\
19157
c8f03ccdc9ee Align columns for freport() output.
Rik <rik@octave.org>
parents: 19143
diff changeset
724 @print{} number mode arch name\n\
c8f03ccdc9ee Align columns for freport() output.
Rik <rik@octave.org>
parents: 19143
diff changeset
725 @print{} ------ ---- ---- ----\n\
c8f03ccdc9ee Align columns for freport() output.
Rik <rik@octave.org>
parents: 19143
diff changeset
726 @print{} 0 r ieee-le stdin\n\
c8f03ccdc9ee Align columns for freport() output.
Rik <rik@octave.org>
parents: 19143
diff changeset
727 @print{} 1 w ieee-le stdout\n\
c8f03ccdc9ee Align columns for freport() output.
Rik <rik@octave.org>
parents: 19143
diff changeset
728 @print{} 2 w ieee-le stderr\n\
c8f03ccdc9ee Align columns for freport() output.
Rik <rik@octave.org>
parents: 19143
diff changeset
729 @print{} 3 r ieee-le myfile\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
730 @end group\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
731 @end example\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
732 @seealso{fopen, fclose, is_valid_file_id}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
733 @end deftypefn")
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
734 {
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
735 octave_value_list retval;
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
736
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
737 int nargin = args.length ();
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
738
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
739 if (nargin > 0)
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
740 warning ("freport: ignoring extra arguments");
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
741
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
742 octave_stdout << octave_stream_list::list_open_files ();
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
743
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
744 return retval;
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
745 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
746
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
747 DEFUN (frewind, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
748 "-*- texinfo -*-\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
749 @deftypefn {Built-in Function} {} frewind (@var{fid})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
750 @deftypefnx {Built-in Function} {@var{status} =} frewind (@var{fid})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
751 Move the file pointer to the beginning of the file specified by file\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
752 descriptor @var{fid}.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
753 \n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
754 @code{frewind} returns 0 for success, and -1 if an error is encountered. It\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
755 is equivalent to @code{fseek (@var{fid}, 0, SEEK_SET)}.\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
756 @seealso{fseek, ftell, fopen}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
757 @end deftypefn")
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
758 {
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
759 octave_value retval;
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
760
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
761 int result = -1;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
762
506
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe]
jwe
parents: 497
diff changeset
763 int nargin = args.length ();
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe]
jwe
parents: 497
diff changeset
764
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
765 if (nargin == 1)
1086
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1049
diff changeset
766 {
3341
14cfc9475fe4 [project @ 1999-11-05 08:11:58 by jwe]
jwe
parents: 3340
diff changeset
767 octave_stream os = octave_stream_list::lookup (args(0), "frewind");
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 628
diff changeset
768
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
769 result = os.rewind ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
770 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
771 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
772 print_usage ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
773
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
774 if (nargout > 0)
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
775 retval = result;
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
776
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
777 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
778 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
779
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
780 DEFUN (fseek, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
781 "-*- texinfo -*-\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
782 @deftypefn {Built-in Function} {} fseek (@var{fid}, @var{offset})\n\
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
783 @deftypefnx {Built-in Function} {} fseek (@var{fid}, @var{offset}, @var{origin})\n\
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
784 @deftypefnx {Built-in Function} {@var{status} =} fseek (@dots{})\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
785 Set the file pointer to the location @var{offset} within the file @var{fid}.\n\
5095
c9a44ec47b20 [project @ 2004-12-03 14:18:51 by jwe]
jwe
parents: 5041
diff changeset
786 \n\
c9a44ec47b20 [project @ 2004-12-03 14:18:51 by jwe]
jwe
parents: 5041
diff changeset
787 The pointer is positioned @var{offset} characters from the @var{origin},\n\
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
788 which may be one of the predefined variables @w{@code{SEEK_CUR}} (current\n\
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
789 position), @w{@code{SEEK_SET}} (beginning), or @w{@code{SEEK_END}} (end of\n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
790 file) or strings @qcode{\"cof\"}, @qcode{\"bof\"} or @qcode{\"eof\"}. If\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
791 @var{origin} is omitted, @w{@code{SEEK_SET}} is assumed. @var{offset} may\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
792 be positive, negative, or zero but not all combinations of @var{origin} and\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
793 @var{offset} can be realized.\n\
5095
c9a44ec47b20 [project @ 2004-12-03 14:18:51 by jwe]
jwe
parents: 5041
diff changeset
794 \n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
795 @code{fseek} returns 0 on success and -1 on error.\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
796 @seealso{fskipl, frewind, ftell, fopen}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
797 @end deftypefn")
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
798 {
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
799 octave_value retval = -1;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
800
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
801 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
802
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
803 if (nargin == 2 || nargin == 3)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
804 {
3341
14cfc9475fe4 [project @ 1999-11-05 08:11:58 by jwe]
jwe
parents: 3340
diff changeset
805 octave_stream os = octave_stream_list::lookup (args(0), "fseek");
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
806
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
807 octave_value origin_arg = (nargin == 3)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
808 ? args(2) : octave_value (-1.0);
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
809
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
810 retval = os.seek (args(1), origin_arg);
368
5c987c27f3d7 [project @ 1994-02-16 08:33:09 by jwe]
jwe
parents: 367
diff changeset
811 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
812 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
813 print_usage ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
814
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
815 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
816 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
817
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
818 DEFUN (ftell, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
819 "-*- texinfo -*-\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
820 @deftypefn {Built-in Function} {@var{pos} =} ftell (@var{fid})\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
821 Return the position of the file pointer as the number of characters from the\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
822 beginning of the file specified by file descriptor @var{fid}.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
823 @seealso{fseek, frewind, feof, fopen}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
824 @end deftypefn")
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
825 {
4797
19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe]
jwe
parents: 4726
diff changeset
826 octave_value retval = -1;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
827
506
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe]
jwe
parents: 497
diff changeset
828 int nargin = args.length ();
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe]
jwe
parents: 497
diff changeset
829
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
830 if (nargin == 1)
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
831 {
3341
14cfc9475fe4 [project @ 1999-11-05 08:11:58 by jwe]
jwe
parents: 3340
diff changeset
832 octave_stream os = octave_stream_list::lookup (args(0), "ftell");
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
833
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
834 retval = os.tell ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
835 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
836 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
837 print_usage ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
838
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
839 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
840 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
841
3737
b736f8b8f0a1 [project @ 2000-11-16 18:01:08 by jwe]
jwe
parents: 3569
diff changeset
842 DEFUN (fprintf, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
843 "-*- texinfo -*-\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
844 @deftypefn {Built-in Function} {} fprintf (@var{fid}, @var{template}, @dots{})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
845 @deftypefnx {Built-in Function} {} fprintf (@var{template}, @dots{})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
846 @deftypefnx {Built-in Function} {@var{numbytes} =} fprintf (@dots{})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
847 This function is equivalent to @code{printf}, except that the output is\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
848 written to the file descriptor @var{fid} instead of @code{stdout}.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
849 \n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
850 If @var{fid} is omitted, the output is written to @code{stdout} making the\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
851 function exactly equivalent to @code{printf}.\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
852 \n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
853 The optional output returns the number of bytes written to the file.\n\
20076
dbf2418a46dd Document expansion of escape sequences in single quotes (bug #44745).
Rik <rik@octave.org>
parents: 19895
diff changeset
854 \n\
20132
1f9ed81bd173 maint: Fix spelling and grammar mistakes in docs and comments (bug #44878)
Rafael Laboissiere <rafael@laboissiere.net>
parents: 20076
diff changeset
855 Implementation Note: For compatibility with @sc{matlab}, escape sequences in\n\
20136
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 20132
diff changeset
856 the template string (e.g., @qcode{\"@xbackslashchar{}n\"} => newline) are\n\
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 20132
diff changeset
857 expanded even when the template string is defined with single quotes.\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
858 @seealso{fputs, fdisp, fwrite, fscanf, printf, sprintf, fopen}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
859 @end deftypefn")
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
860 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
861 static std::string who = "fprintf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
862
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
863 octave_value retval;
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
864
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
865 int result = -1;
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
866
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
867 int nargin = args.length ();
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
868
2875
2e45e7a3d45e [project @ 1997-04-24 08:56:20 by jwe]
jwe
parents: 2873
diff changeset
869 if (nargin > 1 || (nargin > 0 && args(0).is_string ()))
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
870 {
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3321
diff changeset
871 octave_stream os;
2873
c3f7ed3874af [project @ 1997-04-23 04:01:02 by jwe]
jwe
parents: 2847
diff changeset
872 int fmt_n = 0;
c3f7ed3874af [project @ 1997-04-23 04:01:02 by jwe]
jwe
parents: 2847
diff changeset
873
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
874 if (args(0).is_string ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
875 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
876 os = octave_stream_list::lookup (1, who);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
877 }
2873
c3f7ed3874af [project @ 1997-04-23 04:01:02 by jwe]
jwe
parents: 2847
diff changeset
878 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
879 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
880 fmt_n = 1;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
881 os = octave_stream_list::lookup (args(0), who);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
882 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
883
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
884 if (args(fmt_n).is_string ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
885 {
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
886 octave_value_list tmp_args;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
887
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
888 if (nargin > 1 + fmt_n)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
889 {
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
890 tmp_args.resize (nargin-fmt_n-1, octave_value ());
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
891
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
892 for (int i = fmt_n + 1; i < nargin; i++)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
893 tmp_args(i-fmt_n-1) = args(i);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
894 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
895
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
896 result = os.printf (args(fmt_n), tmp_args, who);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
897 }
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
898 else
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
899 error ("%s: format TEMPLATE must be a string", who.c_str ());
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
900 }
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
901 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
902 print_usage ();
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
903
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
904 if (nargout > 0)
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
905 retval = result;
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
906
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
907 return retval;
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
908 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
909
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
910 DEFUN (printf, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
911 "-*- texinfo -*-\n\
5095
c9a44ec47b20 [project @ 2004-12-03 14:18:51 by jwe]
jwe
parents: 5041
diff changeset
912 @deftypefn {Built-in Function} {} printf (@var{template}, @dots{})\n\
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
913 Print optional arguments under the control of the template string\n\
5653
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
914 @var{template} to the stream @code{stdout} and return the number of\n\
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
915 characters printed.\n\
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
916 @ifclear OCTAVE_MANUAL\n\
5095
c9a44ec47b20 [project @ 2004-12-03 14:18:51 by jwe]
jwe
parents: 5041
diff changeset
917 \n\
5653
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
918 See the Formatted Output section of the GNU Octave manual for a\n\
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
919 complete description of the syntax of the template string.\n\
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
920 @end ifclear\n\
20076
dbf2418a46dd Document expansion of escape sequences in single quotes (bug #44745).
Rik <rik@octave.org>
parents: 19895
diff changeset
921 \n\
20132
1f9ed81bd173 maint: Fix spelling and grammar mistakes in docs and comments (bug #44878)
Rafael Laboissiere <rafael@laboissiere.net>
parents: 20076
diff changeset
922 Implementation Note: For compatibility with @sc{matlab}, escape sequences in\n\
20136
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 20132
diff changeset
923 the template string (e.g., @qcode{\"@xbackslashchar{}n\"} => newline) are\n\
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 20132
diff changeset
924 expanded even when the template string is defined with single quotes.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
925 @seealso{fprintf, sprintf, scanf}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
926 @end deftypefn")
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
927 {
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
928 static std::string who = "printf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
929
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
930 octave_value retval;
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
931
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
932 int result = -1;
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
933
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
934 int nargin = args.length ();
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
935
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
936 if (nargin > 0)
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
937 {
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
938 if (args(0).is_string ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
939 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
940 octave_value_list tmp_args;
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
941
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
942 if (nargin > 1)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
943 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
944 tmp_args.resize (nargin-1, octave_value ());
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
945
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
946 for (int i = 1; i < nargin; i++)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
947 tmp_args(i-1) = args(i);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
948 }
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
949
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
950 result = stdout_stream.printf (args(0), tmp_args, who);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
951 }
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
952 else
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
953 error ("%s: format TEMPLATE must be a string", who.c_str ());
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
954 }
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
955 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
956 print_usage ();
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
957
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
958 if (nargout > 0)
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
959 retval = result;
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
960
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
961 return retval;
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
962 }
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
963
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
964 DEFUN (fputs, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
965 "-*- texinfo -*-\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
966 @deftypefn {Built-in Function} {} fputs (@var{fid}, @var{string})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
967 @deftypefnx {Built-in Function} {@var{status} =} fputs (@var{fid}, @var{string})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
968 Write the string @var{string} to the file with file descriptor @var{fid}.\n\
5095
c9a44ec47b20 [project @ 2004-12-03 14:18:51 by jwe]
jwe
parents: 5041
diff changeset
969 \n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
970 The string is written to the file with no additional formatting. Use\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
971 @code{fdisp} instead to automatically append a newline character appropriate\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
972 for the local machine.\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
973 \n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
974 Return a non-negative number on success or EOF on error.\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
975 @seealso{fdisp, fprintf, fwrite, fopen}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
976 @end deftypefn")
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
977 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
978 static std::string who = "fputs";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
979
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
980 octave_value retval = -1;
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
981
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
982 int nargin = args.length ();
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
983
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
984 if (nargin == 2)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
985 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
986 octave_stream os = octave_stream_list::lookup (args(0), who);
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
987
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
988 retval = os.puts (args(1), who);
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
989 }
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
990 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
991 print_usage ();
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
992
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
993 return retval;
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
994 }
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
995
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
996 DEFUN (puts, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
997 "-*- texinfo -*-\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
998 @deftypefn {Built-in Function} {} puts (@var{string})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
999 @deftypefnx {Built-in Function} {@var{status} =} puts (@var{string})\n\
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1000 Write a string to the standard output with no formatting.\n\
5095
c9a44ec47b20 [project @ 2004-12-03 14:18:51 by jwe]
jwe
parents: 5041
diff changeset
1001 \n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1002 The string is written verbatim to the standard output. Use @code{disp} to\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1003 automatically append a newline character appropriate for the local machine.\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1004 \n\
5095
c9a44ec47b20 [project @ 2004-12-03 14:18:51 by jwe]
jwe
parents: 5041
diff changeset
1005 Return a non-negative number on success and EOF on error.\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
1006 @seealso{fputs, disp}\n\
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1007 @end deftypefn")
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1008 {
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1009 static std::string who = "puts";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1010
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1011 octave_value retval = -1;
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1012
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1013 if (args.length () == 1)
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1014 retval = stdout_stream.puts (args(0), who);
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1015 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1016 print_usage ();
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1017
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1018 return retval;
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1019 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1020
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1021 DEFUN (sprintf, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1022 "-*- texinfo -*-\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1023 @deftypefn {Built-in Function} {} sprintf (@var{template}, @dots{})\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1024 This is like @code{printf}, except that the output is returned as a\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1025 string.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1026 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1027 Unlike the C library function, which requires you to provide a suitably\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1028 sized string as an argument, Octave's @code{sprintf} function returns the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1029 string, automatically sized to hold all of the items converted.\n\
20076
dbf2418a46dd Document expansion of escape sequences in single quotes (bug #44745).
Rik <rik@octave.org>
parents: 19895
diff changeset
1030 \n\
20132
1f9ed81bd173 maint: Fix spelling and grammar mistakes in docs and comments (bug #44878)
Rafael Laboissiere <rafael@laboissiere.net>
parents: 20076
diff changeset
1031 Implementation Note: For compatibility with @sc{matlab}, escape sequences in\n\
20136
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 20132
diff changeset
1032 the template string (e.g., @qcode{\"@xbackslashchar{}n\"} => newline) are\n\
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 20132
diff changeset
1033 expanded even when the template string is defined with single quotes.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1034 @seealso{printf, fprintf, sscanf}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1035 @end deftypefn")
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1036 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1037 static std::string who = "sprintf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1038
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1039 octave_value_list retval;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1040
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1041 int nargin = args.length ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1042
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1043 if (nargin > 0)
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1044 {
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1045 retval(2) = -1.0;
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1046 retval(1) = "unknown error";
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1047 retval(0) = "";
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1048
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3321
diff changeset
1049 octave_ostrstream *ostr = new octave_ostrstream ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1050
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3321
diff changeset
1051 octave_stream os (ostr);
628
aecbe369233b [project @ 1994-08-19 13:27:51 by jwe]
jwe
parents: 610
diff changeset
1052
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3321
diff changeset
1053 if (os.is_valid ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1054 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1055 octave_value fmt_arg = args(0);
6007
52b520087c50 [project @ 2006-09-27 15:05:53 by jwe]
jwe
parents: 5906
diff changeset
1056
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1057 if (fmt_arg.is_string ())
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1058 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1059 octave_value_list tmp_args;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1060
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1061 if (nargin > 1)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1062 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1063 tmp_args.resize (nargin-1, octave_value ());
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1064
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1065 for (int i = 1; i < nargin; i++)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1066 tmp_args(i-1) = args(i);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1067 }
628
aecbe369233b [project @ 1994-08-19 13:27:51 by jwe]
jwe
parents: 610
diff changeset
1068
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1069 retval(2) = os.printf (fmt_arg, tmp_args, who);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1070 retval(1) = os.error ();
19761
3c3b9fce7d2b improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents: 19731
diff changeset
1071
3c3b9fce7d2b improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents: 19731
diff changeset
1072 std::string result = ostr->str ();
3c3b9fce7d2b improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents: 19731
diff changeset
1073 char type = fmt_arg.is_sq_string () ? '\'' : '"';
3c3b9fce7d2b improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents: 19731
diff changeset
1074
3c3b9fce7d2b improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents: 19731
diff changeset
1075 retval(0) = (result.empty ()
3c3b9fce7d2b improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents: 19731
diff changeset
1076 ? octave_value (charMatrix (1, 0), type)
3c3b9fce7d2b improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents: 19731
diff changeset
1077 : octave_value (result, type));
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1078 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1079 else
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
1080 error ("%s: format TEMPLATE must be a string", who.c_str ());
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1081 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1082 else
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
1083 error ("%s: unable to create output buffer", who.c_str ());
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1084 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1085 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1086 print_usage ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1087
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1088 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1089 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1090
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1091 DEFUN (fscanf, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1092 "-*- texinfo -*-\n\
13271
fba2cc36b762 return stream error message in scanf functions and document behavior
John W. Eaton <jwe@octave.org>
parents: 13194
diff changeset
1093 @deftypefn {Built-in Function} {[@var{val}, @var{count}, @var{errmsg}] =} fscanf (@var{fid}, @var{template}, @var{size})\n\
16099
4b6c44096862 Backout changeset 238e499c5fea (locale support in scanf)
Rik <rik@octave.org>
parents: 16094
diff changeset
1094 @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}, @var{errmsg}] =} fscanf (@var{fid}, @var{template}, \"C\")\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1095 In the first form, read from @var{fid} according to @var{template},\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1096 returning the result in the matrix @var{val}.\n\
2122
91d802f77456 [project @ 1996-05-12 07:08:38 by jwe]
jwe
parents: 2116
diff changeset
1097 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1098 The optional argument @var{size} specifies the amount of data to read\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1099 and may be one of\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1100 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1101 @table @code\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1102 @item Inf\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1103 Read as much as possible, returning a column vector.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1104 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1105 @item @var{nr}\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1106 Read up to @var{nr} elements, returning a column vector.\n\
2122
91d802f77456 [project @ 1996-05-12 07:08:38 by jwe]
jwe
parents: 2116
diff changeset
1107 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1108 @item [@var{nr}, Inf]\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1109 Read as much as possible, returning a matrix with @var{nr} rows. If the\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1110 number of elements read is not an exact multiple of @var{nr}, the last\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1111 column is padded with zeros.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1112 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1113 @item [@var{nr}, @var{nc}]\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1114 Read up to @code{@var{nr} * @var{nc}} elements, returning a matrix with\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1115 @var{nr} rows. If the number of elements read is not an exact multiple\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1116 of @var{nr}, the last column is padded with zeros.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1117 @end table\n\
2122
91d802f77456 [project @ 1996-05-12 07:08:38 by jwe]
jwe
parents: 2116
diff changeset
1118 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1119 @noindent\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1120 If @var{size} is omitted, a value of @code{Inf} is assumed.\n\
2122
91d802f77456 [project @ 1996-05-12 07:08:38 by jwe]
jwe
parents: 2116
diff changeset
1121 \n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1122 A string is returned if @var{template} specifies only character conversions.\n\
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1123 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1124 The number of items successfully read is returned in @var{count}.\n\
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1125 \n\
13271
fba2cc36b762 return stream error message in scanf functions and document behavior
John W. Eaton <jwe@octave.org>
parents: 13194
diff changeset
1126 If an error occurs, @var{errmsg} contains a system-dependent error message.\n\
fba2cc36b762 return stream error message in scanf functions and document behavior
John W. Eaton <jwe@octave.org>
parents: 13194
diff changeset
1127 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1128 In the second form, read from @var{fid} according to @var{template},\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1129 with each conversion specifier in @var{template} corresponding to a\n\
16766
7268845c0a1e avoid backquote in error messages, some uses in doc strings
John W. Eaton <jwe@octave.org>
parents: 16590
diff changeset
1130 single scalar return value. This form is more ``C-like'', and also\n\
3491
2c7524ffdbf5 [project @ 2000-01-28 22:44:13 by jwe]
jwe
parents: 3458
diff changeset
1131 compatible with previous versions of Octave. The number of successful\n\
16099
4b6c44096862 Backout changeset 238e499c5fea (locale support in scanf)
Rik <rik@octave.org>
parents: 16094
diff changeset
1132 conversions is returned in @var{count}\n\
5653
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
1133 @ifclear OCTAVE_MANUAL\n\
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
1134 \n\
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
1135 See the Formatted Input section of the GNU Octave manual for a\n\
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
1136 complete description of the syntax of the template string.\n\
ab9a339fcec8 [project @ 2006-03-09 17:28:13 by jwe]
jwe
parents: 5642
diff changeset
1137 @end ifclear\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
1138 @seealso{fgets, fgetl, fread, scanf, sscanf, fopen}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1139 @end deftypefn")
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1140 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1141 static std::string who = "fscanf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1142
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1143 octave_value_list retval;
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1144
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1145 int nargin = args.length ();
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1146
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1147 if (nargin == 3 && args(2).is_string ())
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1148 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1149 octave_stream os = octave_stream_list::lookup (args(0), who);
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1150
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1151 if (args(1).is_string ())
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1152 retval = os.oscanf (args(1), who);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1153 else
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1154 error ("%s: format TEMPLATE must be a string", who.c_str ());
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1155 }
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1156 else
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1157 {
13271
fba2cc36b762 return stream error message in scanf functions and document behavior
John W. Eaton <jwe@octave.org>
parents: 13194
diff changeset
1158 retval(2) = "unknown error";
fba2cc36b762 return stream error message in scanf functions and document behavior
John W. Eaton <jwe@octave.org>
parents: 13194
diff changeset
1159 retval(1) = 0.0;
fba2cc36b762 return stream error message in scanf functions and document behavior
John W. Eaton <jwe@octave.org>
parents: 13194
diff changeset
1160 retval(0) = Matrix ();
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1161
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1162 if (nargin == 2 || nargin == 3)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1163 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1164 octave_stream os = octave_stream_list::lookup (args(0), who);
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1165
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1166 if (args(1).is_string ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1167 {
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1168 octave_idx_type count = 0;
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1169
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1170 Array<double> size = (nargin == 3)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1171 ? args(2).vector_value ()
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1172 : Array<double> (dim_vector (1, 1),
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1173 lo_ieee_inf_value ());
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1174
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1175 octave_value tmp = os.scanf (args(1), size, count, who);
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1176
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1177 retval(2) = os.error ();
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1178 retval(1) = count;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1179 retval(0) = tmp;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1180 }
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1181 else
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1182 error ("%s: format must be a string", who.c_str ());
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1183 }
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1184 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1185 print_usage ();
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1186 }
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1187
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1188 return retval;
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1189 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1190
13194
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1191 static std::string
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1192 get_sscanf_data (const octave_value& val)
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1193 {
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1194 std::string retval;
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1195
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1196 if (val.is_string ())
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1197 {
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1198 octave_value tmp = val.reshape (dim_vector (1, val.numel ()));
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1199
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1200 retval = tmp.string_value ();
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1201 }
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1202 else
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
1203 error ("sscanf: argument STRING must be a string");
13194
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1204
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1205 return retval;
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1206 }
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1207
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1208 DEFUN (sscanf, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1209 "-*- texinfo -*-\n\
13271
fba2cc36b762 return stream error message in scanf functions and document behavior
John W. Eaton <jwe@octave.org>
parents: 13194
diff changeset
1210 @deftypefn {Built-in Function} {[@var{val}, @var{count}, @var{errmsg}, @var{pos}] =} sscanf (@var{string}, @var{template}, @var{size})\n\
16099
4b6c44096862 Backout changeset 238e499c5fea (locale support in scanf)
Rik <rik@octave.org>
parents: 16094
diff changeset
1211 @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}, @var{errmsg}] =} sscanf (@var{string}, @var{template}, \"C\")\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1212 This is like @code{fscanf}, except that the characters are taken from the\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1213 string @var{string} instead of from a stream.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1214 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1215 Reaching the end of the string is treated as an end-of-file condition. In\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1216 addition to the values returned by @code{fscanf}, the index of the next\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1217 character to be read is returned in @var{pos}.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1218 @seealso{fscanf, scanf, sprintf}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1219 @end deftypefn")
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1220 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1221 static std::string who = "sscanf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1222
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1223 octave_value_list retval;
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1224
506
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe]
jwe
parents: 497
diff changeset
1225 int nargin = args.length ();
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe]
jwe
parents: 497
diff changeset
1226
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1227 if (nargin == 3 && args(2).is_string ())
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1228 {
13194
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1229 std::string data = get_sscanf_data (args(0));
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1230
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1231 if (! error_state)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1232 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1233 octave_stream os = octave_istrstream::create (data);
1358
dc9c01f66a19 [project @ 1995-09-05 21:10:01 by jwe]
jwe
parents: 1352
diff changeset
1234
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1235 if (os.is_valid ())
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1236 {
16099
4b6c44096862 Backout changeset 238e499c5fea (locale support in scanf)
Rik <rik@octave.org>
parents: 16094
diff changeset
1237 if (args(1).is_string ())
4b6c44096862 Backout changeset 238e499c5fea (locale support in scanf)
Rik <rik@octave.org>
parents: 16094
diff changeset
1238 retval = os.oscanf (args(1), who);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1239 else
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
1240 error ("%s: format TEMPLATE must be a string", who.c_str ());
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1241 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1242 else
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
1243 error ("%s: unable to create temporary input buffer", who.c_str ());
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1244 }
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 628
diff changeset
1245 else
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
1246 error ("%s: argument STRING must be a string", who.c_str ());
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1247 }
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1248 else
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1249 {
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1250 if (nargin == 2 || nargin == 3)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1251 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1252 retval(3) = -1.0;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1253 retval(2) = "unknown error";
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1254 retval(1) = 0.0;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1255 retval(0) = Matrix ();
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1256
13194
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1257 std::string data = get_sscanf_data (args(0));
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1258
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1259 octave_stream os = octave_istrstream::create (data);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1260
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1261 if (os.is_valid ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1262 {
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1263 if (args(1).is_string ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1264 {
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1265 octave_idx_type count = 0;
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1266
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1267 Array<double> size = (nargin == 3)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1268 ? args(2).vector_value ()
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1269 : Array<double> (dim_vector (1, 1),
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1270 lo_ieee_inf_value ());
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1271
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1272 octave_value tmp = os.scanf (args(1), size, count, who);
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1273
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1274 // FIXME: is this the right thing to do?
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1275 // Extract error message first, because getting
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1276 // position will clear it.
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1277 std::string errmsg = os.error ();
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1278
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1279 retval(3) = (os.eof () ? data.length () : os.tell ()) + 1;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1280 retval(2) = errmsg;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1281 retval(1) = count;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1282 retval(0) = tmp;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1283 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1284 else
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1285 error ("%s: format TEMPLATE must be a string",
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1286 who.c_str ());
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1287 }
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1288 else
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1289 error ("%s: unable to create temporary input buffer",
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1290 who.c_str ());
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1291 }
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1292 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1293 print_usage ();
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1294 }
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1295
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1296 return retval;
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1297 }
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1298
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1299 DEFUN (scanf, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1300 "-*- texinfo -*-\n\
13271
fba2cc36b762 return stream error message in scanf functions and document behavior
John W. Eaton <jwe@octave.org>
parents: 13194
diff changeset
1301 @deftypefn {Built-in Function} {[@var{val}, @var{count}, @var{errmsg}] =} scanf (@var{template}, @var{size})\n\
16099
4b6c44096862 Backout changeset 238e499c5fea (locale support in scanf)
Rik <rik@octave.org>
parents: 16094
diff changeset
1302 @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}, @var{errmsg}]] =} scanf (@var{template}, \"C\")\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1303 This is equivalent to calling @code{fscanf} with @var{fid} = @code{stdin}.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1304 \n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
1305 It is currently not useful to call @code{scanf} in interactive programs.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1306 @seealso{fscanf, sscanf, printf}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1307 @end deftypefn")
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1308 {
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1309 int nargin = args.length ();
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1310
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1311 octave_value_list tmp_args (nargin+1, octave_value ());
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1312
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1313 tmp_args (0) = 0.0;
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1314 for (int i = 0; i < nargin; i++)
18111
b560bac0fca2 maint: Don't use space between 'args' and '(' when doing indexing.
Rik <rik@octave.org>
parents: 18078
diff changeset
1315 tmp_args(i+1) = args(i);
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1316
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1317 return Ffscanf (tmp_args, nargout);
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1318 }
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1319
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1320 static octave_value
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1321 do_fread (octave_stream& os, const octave_value& size_arg,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1322 const octave_value& prec_arg, const octave_value& skip_arg,
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1323 const octave_value& arch_arg, octave_idx_type& count)
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1324 {
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1325 octave_value retval;
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1326
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1327 count = -1;
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1328
3810
f19f00339363 [project @ 2001-03-29 21:03:01 by jwe]
jwe
parents: 3775
diff changeset
1329 Array<double> size = size_arg.vector_value ();
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1330
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1331 if (! error_state)
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1332 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1333 std::string prec = prec_arg.string_value ("fread: PRECISION must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1334
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1335 int block_size = 1;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1336 oct_data_conv::data_type input_type;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1337 oct_data_conv::data_type output_type;
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1338
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1339 oct_data_conv::string_to_data_type (prec, block_size,
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1340 input_type, output_type);
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1341
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1342 if (! error_state)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1343 {
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1344 int skip = skip_arg.int_value (true);
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1345
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1346 if (! error_state)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1347 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1348 std::string arch = arch_arg.string_value ("fread: ARCH architecture type must be a string");
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 3180
diff changeset
1349
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1350 oct_mach_info::float_format flt_fmt
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1351 = oct_mach_info::string_to_float_format (arch);
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1352
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1353 retval = os.read (size, block_size, input_type,
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1354 output_type, skip, flt_fmt, count);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1355 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1356 else
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1357 error ("fread: SKIP must be an integer");
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1358 }
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1359 else
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1360 error ("fread: invalid PRECISION specified");
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1361 }
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1362 else
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
1363 error ("fread: invalid SIZE specified");
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1364
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1365 return retval;
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1366 }
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1367
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1368 DEFUN (fread, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1369 "-*- texinfo -*-\n\
18207
bea06b5d4423 doc: Improve documentation for fread function.
Rik <rik@octave.org>
parents: 18111
diff changeset
1370 @deftypefn {Built-in Function} {@var{val} =} fread (@var{fid})\n\
bea06b5d4423 doc: Improve documentation for fread function.
Rik <rik@octave.org>
parents: 18111
diff changeset
1371 @deftypefnx {Built-in Function} {@var{val} =} fread (@var{fid}, @var{size})\n\
bea06b5d4423 doc: Improve documentation for fread function.
Rik <rik@octave.org>
parents: 18111
diff changeset
1372 @deftypefnx {Built-in Function} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision})\n\
bea06b5d4423 doc: Improve documentation for fread function.
Rik <rik@octave.org>
parents: 18111
diff changeset
1373 @deftypefnx {Built-in Function} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision}, @var{skip})\n\
bea06b5d4423 doc: Improve documentation for fread function.
Rik <rik@octave.org>
parents: 18111
diff changeset
1374 @deftypefnx {Built-in Function} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision}, @var{skip}, @var{arch})\n\
bea06b5d4423 doc: Improve documentation for fread function.
Rik <rik@octave.org>
parents: 18111
diff changeset
1375 @deftypefnx {Built-in Function} {[@var{val}, @var{count}] =} fread (@dots{})\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1376 Read binary data from the file specified by the file descriptor @var{fid}.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1377 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1378 The optional argument @var{size} specifies the amount of data to read\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1379 and may be one of\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1380 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1381 @table @code\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1382 @item Inf\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1383 Read as much as possible, returning a column vector.\n\
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1384 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1385 @item @var{nr}\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1386 Read up to @var{nr} elements, returning a column vector.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1387 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1388 @item [@var{nr}, Inf]\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1389 Read as much as possible, returning a matrix with @var{nr} rows. If the\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1390 number of elements read is not an exact multiple of @var{nr}, the last\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1391 column is padded with zeros.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1392 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1393 @item [@var{nr}, @var{nc}]\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1394 Read up to @code{@var{nr} * @var{nc}} elements, returning a matrix with\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1395 @var{nr} rows. If the number of elements read is not an exact multiple\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1396 of @var{nr}, the last column is padded with zeros.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1397 @end table\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1398 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1399 @noindent\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1400 If @var{size} is omitted, a value of @code{Inf} is assumed.\n\
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
1401 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1402 The optional argument @var{precision} is a string specifying the type of\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1403 data to read and may be one of\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1404 \n\
11595
5ec6aa05638d Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents: 11586
diff changeset
1405 @table @asis\n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1406 @item @qcode{\"schar\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1407 @itemx @qcode{\"signed char\"}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1408 Signed character.\n\
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1409 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1410 @item @qcode{\"uchar\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1411 @itemx @qcode{\"unsigned char\"}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1412 Unsigned character.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1413 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1414 @item @qcode{\"int8\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1415 @itemx @qcode{\"integer*1\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1416 \n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1417 8-bit signed integer.\n\
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
1418 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1419 @item @qcode{\"int16\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1420 @itemx @qcode{\"integer*2\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1421 16-bit signed integer.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1422 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1423 @item @qcode{\"int32\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1424 @itemx @qcode{\"integer*4\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1425 32-bit signed integer.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1426 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1427 @item @qcode{\"int64\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1428 @itemx @qcode{\"integer*8\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1429 64-bit signed integer.\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1430 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1431 @item @qcode{\"uint8\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1432 8-bit unsigned integer.\n\
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1433 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1434 @item @qcode{\"uint16\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1435 16-bit unsigned integer.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1436 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1437 @item @qcode{\"uint32\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1438 32-bit unsigned integer.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1439 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1440 @item @qcode{\"uint64\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1441 64-bit unsigned integer.\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1442 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1443 @item @qcode{\"single\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1444 @itemx @qcode{\"float32\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1445 @itemx @qcode{\"real*4\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1446 32-bit floating point number.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1447 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1448 @item @qcode{\"double\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1449 @itemx @qcode{\"float64\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1450 @itemx @qcode{\"real*8\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1451 64-bit floating point number.\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1452 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1453 @item @qcode{\"char\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1454 @itemx @qcode{\"char*1\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1455 Single character.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1456 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1457 @item @qcode{\"short\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1458 Short integer (size is platform dependent).\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1459 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1460 @item @qcode{\"int\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1461 Integer (size is platform dependent).\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1462 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1463 @item @qcode{\"long\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1464 Long integer (size is platform dependent).\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1465 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1466 @item @qcode{\"ushort\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1467 @itemx @qcode{\"unsigned short\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1468 Unsigned short integer (size is platform dependent).\n\
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents: 4594
diff changeset
1469 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1470 @item @qcode{\"uint\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1471 @itemx @qcode{\"unsigned int\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1472 Unsigned integer (size is platform dependent).\n\
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents: 4594
diff changeset
1473 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1474 @item @qcode{\"ulong\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1475 @itemx @qcode{\"unsigned long\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1476 Unsigned long integer (size is platform dependent).\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1477 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1478 @item @qcode{\"float\"}\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1479 Single precision floating point number (size is platform dependent).\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1480 @end table\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1481 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1482 @noindent\n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1483 The default precision is @qcode{\"uchar\"}.\n\
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
1484 \n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1485 The @var{precision} argument may also specify an optional repeat\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1486 count. For example, @samp{32*single} causes @code{fread} to read\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1487 a block of 32 single precision floating point numbers. Reading in\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1488 blocks is useful in combination with the @var{skip} argument.\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1489 \n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1490 The @var{precision} argument may also specify a type conversion.\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1491 For example, @samp{int16=>int32} causes @code{fread} to read 16-bit\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1492 integer values and return an array of 32-bit integer values. By\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1493 default, @code{fread} returns a double precision array. The special\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1494 form @samp{*TYPE} is shorthand for @samp{TYPE=>TYPE}.\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1495 \n\
7096
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7078
diff changeset
1496 The conversion and repeat counts may be combined. For example, the\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7078
diff changeset
1497 specification @samp{32*single=>single} causes @code{fread} to read\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7078
diff changeset
1498 blocks of single precision floating point values and return an array\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7078
diff changeset
1499 of single precision values instead of the default array of double\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7078
diff changeset
1500 precision values.\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1501 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1502 The optional argument @var{skip} specifies the number of bytes to skip\n\
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1503 after each element (or block of elements) is read. If it is not\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1504 specified, a value of 0 is assumed. If the final block read is not\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1505 complete, the final skip is omitted. For example,\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1506 \n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1507 @example\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1508 fread (f, 10, \"3*single=>single\", 8)\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1509 @end example\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1510 \n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1511 @noindent\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1512 will omit the final 8-byte skip because the last read will not be\n\
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1513 a complete block of 3 values.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1514 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1515 The optional argument @var{arch} is a string specifying the data format\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1516 for the file. Valid values are\n\
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1517 \n\
18078
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2.
Rik <rik@octave.org>
parents: 18040
diff changeset
1518 @table @asis\n\
20466
f02c22f71cdb doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents: 20233
diff changeset
1519 @item @qcode{\"native\"} or @qcode{\"n\"}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1520 The format of the current machine.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1521 \n\
20466
f02c22f71cdb doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents: 20233
diff changeset
1522 @item @qcode{\"ieee-be\"} or @qcode{\"b\"}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1523 IEEE big endian.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1524 \n\
20466
f02c22f71cdb doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents: 20233
diff changeset
1525 @item @qcode{\"ieee-le\"} or @qcode{\"l\"}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1526 IEEE little endian.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1527 @end table\n\
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
1528 \n\
20474
97edbce9b975 doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
Rik <rik@octave.org>
parents: 20466
diff changeset
1529 If no @var{arch} is given the value used in the call to @code{fopen} which\n\
97edbce9b975 doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
Rik <rik@octave.org>
parents: 20466
diff changeset
1530 created the file descriptor is used. Otherwise, the value specified with\n\
97edbce9b975 doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
Rik <rik@octave.org>
parents: 20466
diff changeset
1531 @code{fread} overrides that of @code{fopen} and determines the data format.\n\
97edbce9b975 doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
Rik <rik@octave.org>
parents: 20466
diff changeset
1532 \n\
18207
bea06b5d4423 doc: Improve documentation for fread function.
Rik <rik@octave.org>
parents: 18111
diff changeset
1533 The output argument @var{val} contains the data read from the file.\n\
20474
97edbce9b975 doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
Rik <rik@octave.org>
parents: 20466
diff changeset
1534 \n\
18207
bea06b5d4423 doc: Improve documentation for fread function.
Rik <rik@octave.org>
parents: 18111
diff changeset
1535 The optional return value @var{count} contains the number of elements read.\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
1536 @seealso{fwrite, fgets, fgetl, fscanf, fopen}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1537 @end deftypefn")
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1538 {
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1539 octave_value_list retval;
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1540
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1541 int nargin = args.length ();
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1542
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
1543 if (nargin > 0 && nargin < 6)
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1544 {
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1545 retval(1) = -1.0;
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1546 retval(0) = Matrix ();
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1547
3341
14cfc9475fe4 [project @ 1999-11-05 08:11:58 by jwe]
jwe
parents: 3340
diff changeset
1548 octave_stream os = octave_stream_list::lookup (args(0), "fread");
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1549
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1550 octave_value size = lo_ieee_inf_value ();
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1551 octave_value prec = "uchar";
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1552 octave_value skip = 0;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1553 octave_value arch = "unknown";
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1554
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1555 int idx = 1;
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1556
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1557 if (nargin > idx && ! args(idx).is_string ())
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1558 size = args(idx++);
4257
e556870ce8f0 [project @ 2003-01-02 03:14:41 by jwe]
jwe
parents: 4254
diff changeset
1559
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1560 if (nargin > idx)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1561 prec = args(idx++);
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1562
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1563 if (nargin > idx)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1564 skip = args(idx++);
4257
e556870ce8f0 [project @ 2003-01-02 03:14:41 by jwe]
jwe
parents: 4254
diff changeset
1565
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1566 if (nargin > idx)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1567 arch = args(idx++);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1568 else if (skip.is_string ())
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1569 {
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1570 arch = skip;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1571 skip = 0;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1572 }
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1573
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1574 octave_idx_type count = -1;
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1575
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1576 octave_value tmp = do_fread (os, size, prec, skip, arch, count);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1577
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1578 retval(1) = count;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1579 retval(0) = tmp;
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1580 }
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1581 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1582 print_usage ();
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1583
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1584 return retval;
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1585 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1586
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1587 static int
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1588 do_fwrite (octave_stream& os, const octave_value& data,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1589 const octave_value& prec_arg, const octave_value& skip_arg,
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1590 const octave_value& arch_arg)
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1591 {
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1592 int retval = -1;
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1593
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1594 std::string prec = prec_arg.string_value ("fwrite: PRECISION must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1595
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1596 int block_size = 1;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1597 oct_data_conv::data_type output_type;
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1598
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1599 oct_data_conv::string_to_data_type (prec, block_size, output_type);
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
1600
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1601 if (! error_state)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1602 {
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1603 int skip = skip_arg.int_value (true);
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1604
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1605 if (! error_state)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1606 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1607 std::string arch = arch_arg.string_value ("fwrite: ARCH architecture type must be a string");
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 3180
diff changeset
1608
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1609 oct_mach_info::float_format flt_fmt
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1610 = oct_mach_info::string_to_float_format (arch);
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1611
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1612 retval = os.write (data, block_size, output_type,
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1613 skip, flt_fmt);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1614 }
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 3180
diff changeset
1615 else
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1616 error ("fwrite: SKIP must be an integer");
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1617 }
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1618 else
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1619 error ("fwrite: invalid PRECISION specified");
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1620
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1621 return retval;
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1622 }
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1623
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1624 DEFUN (fwrite, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1625 "-*- texinfo -*-\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1626 @deftypefn {Built-in Function} {} fwrite (@var{fid}, @var{data})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1627 @deftypefnx {Built-in Function} {} fwrite (@var{fid}, @var{data}, @var{precision})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1628 @deftypefnx {Built-in Function} {} fwrite (@var{fid}, @var{data}, @var{precision}, @var{skip})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1629 @deftypefnx {Built-in Function} {} fwrite (@var{fid}, @var{data}, @var{precision}, @var{skip}, @var{arch})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1630 @deftypefnx {Built-in Function} {@var{count} =} fwrite (@dots{})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1631 Write data in binary form to the file specified by the file descriptor\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1632 @var{fid}, returning the number of values @var{count} successfully written\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1633 to the file.\n\
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1634 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1635 The argument @var{data} is a matrix of values that are to be written to\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1636 the file. The values are extracted in column-major order.\n\
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1637 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1638 The remaining arguments @var{precision}, @var{skip}, and @var{arch} are\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1639 optional, and are interpreted as described for @code{fread}.\n\
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1640 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1641 The behavior of @code{fwrite} is undefined if the values in @var{data}\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1642 are too large to fit in the specified precision.\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
1643 @seealso{fread, fputs, fprintf, fopen}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1644 @end deftypefn")
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1645 {
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
1646 octave_value retval = -1;
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1647
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1648 int nargin = args.length ();
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1649
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1650 if (nargin > 1 && nargin < 6)
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1651 {
3341
14cfc9475fe4 [project @ 1999-11-05 08:11:58 by jwe]
jwe
parents: 3340
diff changeset
1652 octave_stream os = octave_stream_list::lookup (args(0), "fwrite");
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1653
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1654 octave_value prec = "uchar";
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1655 octave_value skip = 0;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1656 octave_value arch = "unknown";
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
1657
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1658 int idx = 1;
7708
b42abee70a98 fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents: 7650
diff changeset
1659
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1660 octave_value data = args(idx++);
7708
b42abee70a98 fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents: 7650
diff changeset
1661
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1662 if (nargin > idx)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1663 prec = args(idx++);
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
1664
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1665 if (nargin > idx)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1666 skip = args(idx++);
2318
31e7eb125d89 [project @ 1996-07-14 22:44:50 by jwe]
jwe
parents: 2237
diff changeset
1667
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1668 if (nargin > idx)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1669 arch = args(idx++);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1670 else if (skip.is_string ())
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1671 {
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1672 arch = skip;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1673 skip = 0;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1674 }
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1675
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1676 double status = do_fwrite (os, data, prec, skip, arch);
2825
60ae49e1284f [project @ 1997-03-25 23:17:36 by jwe]
jwe
parents: 2802
diff changeset
1677
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1678 retval = status;
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1679 }
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1680 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1681 print_usage ();
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
1682
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1683 return retval;
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1684 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1685
5906
bdf16e1564e1 [project @ 2006-07-27 03:07:14 by jwe]
jwe
parents: 5823
diff changeset
1686 DEFUNX ("feof", Ffeof, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1687 "-*- texinfo -*-\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1688 @deftypefn {Built-in Function} {@var{status} =} feof (@var{fid})\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1689 Return 1 if an end-of-file condition has been encountered for the file\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1690 specified by file descriptor @var{fid} and 0 otherwise.\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1691 \n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1692 Note that @code{feof} will only return 1 if the end of the file has already\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1693 been encountered, not if the next read operation will result in an\n\
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1694 end-of-file condition.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
1695 @seealso{fread, frewind, fseek, fclear, fopen}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1696 @end deftypefn")
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1697 {
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
1698 octave_value retval = -1;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1699
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1700 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1701
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1702 if (nargin == 1)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1703 {
3341
14cfc9475fe4 [project @ 1999-11-05 08:11:58 by jwe]
jwe
parents: 3340
diff changeset
1704 octave_stream os = octave_stream_list::lookup (args(0), "feof");
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1705
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1706 retval = os.eof () ? 1.0 : 0.0;
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1707 }
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1708 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1709 print_usage ();
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1710
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1711 return retval;
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1712 }
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1713
5906
bdf16e1564e1 [project @ 2006-07-27 03:07:14 by jwe]
jwe
parents: 5823
diff changeset
1714 DEFUNX ("ferror", Fferror, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1715 "-*- texinfo -*-\n\
19184
adb102face2d doc: Redo docstring for ferror().
Rik <rik@octave.org>
parents: 19161
diff changeset
1716 @deftypefn {Built-in Function} {@var{msg} =} ferror (@var{fid})\n\
adb102face2d doc: Redo docstring for ferror().
Rik <rik@octave.org>
parents: 19161
diff changeset
1717 @deftypefnx {Built-in Function} {[@var{msg}, @var{err}] =} ferror (@var{fid})\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1718 @deftypefnx {Built-in Function} {[@var{dots}] =} ferror (@var{fid}, \"clear\")\n\
19184
adb102face2d doc: Redo docstring for ferror().
Rik <rik@octave.org>
parents: 19161
diff changeset
1719 Query the error status of the stream specified by file descriptor @var{fid}\n\
adb102face2d doc: Redo docstring for ferror().
Rik <rik@octave.org>
parents: 19161
diff changeset
1720 \n\
adb102face2d doc: Redo docstring for ferror().
Rik <rik@octave.org>
parents: 19161
diff changeset
1721 If an error condition exists then return a string @var{msg} describing the\n\
adb102face2d doc: Redo docstring for ferror().
Rik <rik@octave.org>
parents: 19161
diff changeset
1722 error. Otherwise, return an empty string @qcode{\"\"}.\n\
9797
f569f46a1c34 update ferror doc string, take 2
John W. Eaton <jwe@octave.org>
parents: 9796
diff changeset
1723 \n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1724 The second input @qcode{\"clear\"} is optional. If supplied, the error\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1725 state on the stream will be cleared.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1726 \n\
19184
adb102face2d doc: Redo docstring for ferror().
Rik <rik@octave.org>
parents: 19161
diff changeset
1727 The optional second output is a numeric indication of the error status.\n\
adb102face2d doc: Redo docstring for ferror().
Rik <rik@octave.org>
parents: 19161
diff changeset
1728 @var{err} is 1 if an error condition has been encountered and 0 otherwise.\n\
19161
df5e4024ec18 doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents: 19157
diff changeset
1729 \n\
19184
adb102face2d doc: Redo docstring for ferror().
Rik <rik@octave.org>
parents: 19161
diff changeset
1730 Note that @code{ferror} indicates if an error has already occurred, not\n\
adb102face2d doc: Redo docstring for ferror().
Rik <rik@octave.org>
parents: 19161
diff changeset
1731 whether the next operation will result in an error condition.\n\
14438
6a8c3cd326fd doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents: 14436
diff changeset
1732 @seealso{fclear, fopen}\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1733 @end deftypefn")
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1734 {
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1735 octave_value_list retval;
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1736
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1737 int nargin = args.length ();
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1738
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1739 if (nargin == 1 || nargin == 2)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1740 {
3341
14cfc9475fe4 [project @ 1999-11-05 08:11:58 by jwe]
jwe
parents: 3340
diff changeset
1741 octave_stream os = octave_stream_list::lookup (args(0), "ferror");
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1742
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1743 bool clear = false;
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1744
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1745 if (nargin == 2)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1746 {
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1747 std::string opt = args(1).string_value ();
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1748
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1749 clear = (opt == "clear");
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1750 }
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1751
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1752 int error_number = 0;
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1750
diff changeset
1753
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1754 std::string error_message = os.error (clear, error_number);
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1755
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1756 retval(1) = error_number;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
1757 retval(0) = error_message;
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1758 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1759 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1760 print_usage ();
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1761
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1762 return retval;
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1763 }
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1764
18477
aa7ca90ce746 avoid problems if popen is a macro
John W. Eaton <jwe@octave.org>
parents: 18040
diff changeset
1765 DEFUNX ("popen", Fpopen, args, ,
19895
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19761
diff changeset
1766 "-*- texinfo -*-\n\
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1767 @deftypefn {Built-in Function} {@var{fid} =} popen (@var{command}, @var{mode})\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1768 Start a process and create a pipe.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1769 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1770 The name of the command to run is given by @var{command}. The argument\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1771 @var{mode} may be\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1772 \n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1773 @table @code\n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1774 @item @qcode{\"r\"}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1775 The pipe will be connected to the standard output of the process, and\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1776 open for reading.\n\
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1777 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1778 @item @qcode{\"w\"}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1779 The pipe will be connected to the standard input of the process, and\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1780 open for writing.\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1781 @end table\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1782 \n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1783 The file identifier corresponding to the input or output stream of the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1784 process is returned in @var{fid}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1785 \n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
1786 For example:\n\
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1787 \n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1788 @example\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1789 @group\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1790 fid = popen (\"ls -ltr / | tail -3\", \"r\");\n\
7768
a2d9f325b65a Use isschar instead of deprecated isstr
Rafael Laboissiere <rafael@debian.org>
parents: 7730
diff changeset
1791 while (ischar (s = fgets (fid)))\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1792 fputs (stdout, s);\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1793 endwhile\n\
14360
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14210
diff changeset
1794 \n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14210
diff changeset
1795 @print{} drwxr-xr-x 33 root root 3072 Feb 15 13:28 etc\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14210
diff changeset
1796 @print{} drwxr-xr-x 3 root root 1024 Feb 15 13:28 lib\n\
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14210
diff changeset
1797 @print{} drwxrwxrwt 15 root root 2048 Feb 17 14:53 tmp\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1798 @end group\n\
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1799 @end example\n\
18984
ed3cb9f81145 file-io.cc (popen): Add seealso popen2
Andreas Weber <andy.weber.aw@gmail.com>
parents: 18487
diff changeset
1800 @seealso{popen2}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1801 @end deftypefn")
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1802 {
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
1803 octave_value retval = -1;
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1804
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1805 int nargin = args.length ();
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1806
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1807 if (nargin == 2)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1808 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1809 std::string name = args(0).string_value ("popen: COMMAND must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1810 std::string mode = args(1).string_value ("popen: MODE must be a string");
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1811
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1812 if (mode == "r")
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1813 {
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1814 octave_stream ips = octave_iprocstream::create (name);
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1815
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1816 retval = octave_stream_list::insert (ips);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1817 }
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1818 else if (mode == "w")
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1819 {
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1820 octave_stream ops = octave_oprocstream::create (name);
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1821
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1822 retval = octave_stream_list::insert (ops);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1823 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1824 else
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1825 error ("popen: invalid MODE specified");
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1826 }
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1827 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1828 print_usage ();
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1829
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1830 return retval;
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1831 }
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1832
16308
122c1a7a3004 avoid trouble if pclose is a macro
John W. Eaton <jwe@octave.org>
parents: 16099
diff changeset
1833 DEFUNX ("pclose", Fpclose, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1834 "-*- texinfo -*-\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1835 @deftypefn {Built-in Function} {} pclose (@var{fid})\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
1836 Close a file identifier that was opened by @code{popen}.\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
1837 \n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
1838 The function @code{fclose} may also be used for the same purpose.\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
1839 @seealso{fclose, popen}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
1840 @end deftypefn")
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1841 {
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
1842 octave_value retval = -1;
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1843
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1844 int nargin = args.length ();
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
1845
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1846 if (nargin == 1)
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
1847 retval = octave_stream_list::remove (args(0), "pclose");
1377
44f5d41ff757 [project @ 1995-09-12 00:07:58 by jwe]
jwe
parents: 1363
diff changeset
1848 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1849 print_usage ();
1379
e29697484908 [project @ 1995-09-12 00:41:58 by jwe]
jwe
parents: 1377
diff changeset
1850
e29697484908 [project @ 1995-09-12 00:41:58 by jwe]
jwe
parents: 1377
diff changeset
1851 return retval;
e29697484908 [project @ 1995-09-12 00:41:58 by jwe]
jwe
parents: 1377
diff changeset
1852 }
e29697484908 [project @ 1995-09-12 00:41:58 by jwe]
jwe
parents: 1377
diff changeset
1853
19312
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
1854 DEFUN (tempname, args, ,
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
1855 "-*- texinfo -*-\n\
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
1856 @deftypefn {Built-in Function} {@var{fname} =} tempname ()\n\
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
1857 @deftypefnx {Built-in Function} {@var{fname} =} tempname (@var{dir})\n\
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
1858 @deftypefnx {Built-in Function} {@var{fname} =} tempname (@var{dir}, @var{prefix})\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1859 Return a unique temporary file name as a string.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
1860 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1861 If @var{prefix} is omitted, a value of @qcode{\"oct-\"} is used.\n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
1862 \n\
4267
7cd865a8c815 [project @ 2003-01-03 15:27:05 by jwe]
jwe
parents: 4257
diff changeset
1863 If @var{dir} is also omitted, the default directory for temporary files\n\
19419
3b4d6780d6b8 doc: Add missing closing parenthesis in tempname docstring.
Rik <rik@octave.org>
parents: 19312
diff changeset
1864 (@code{P_tmpdir}) is used. If @var{dir} is provided, it must exist,\n\
19244
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
1865 otherwise the default directory for temporary files is used.\n\
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
1866 \n\
19312
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
1867 Programming Note: Because the named file is not opened by @code{tempname},\n\
19244
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
1868 it is possible, though relatively unlikely, that it will not be available\n\
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
1869 by the time your program attempts to open it. If this is a concern,\n\
19312
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
1870 see @code{tmpfile}.\n\
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
1871 @seealso{mkstemp, tempdir, P_tmpdir, tmpfile}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1872 @end deftypefn")
1802
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
1873 {
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1874 octave_value retval;
1802
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
1875
2936
87cb7614257d [project @ 1997-05-06 05:46:00 by jwe]
jwe
parents: 2926
diff changeset
1876 int len = args.length ();
87cb7614257d [project @ 1997-05-06 05:46:00 by jwe]
jwe
parents: 2926
diff changeset
1877
87cb7614257d [project @ 1997-05-06 05:46:00 by jwe]
jwe
parents: 2926
diff changeset
1878 if (len < 3)
87cb7614257d [project @ 1997-05-06 05:46:00 by jwe]
jwe
parents: 2926
diff changeset
1879 {
19437
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents: 19419
diff changeset
1880 std::string dir;
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1881
19437
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents: 19419
diff changeset
1882 if (len > 0)
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1883 dir = args(0).string_value ("tempname: DIR must be a string");
4267
7cd865a8c815 [project @ 2003-01-03 15:27:05 by jwe]
jwe
parents: 4257
diff changeset
1884
19437
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents: 19419
diff changeset
1885 std::string pfx ("oct-");
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1886
19437
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents: 19419
diff changeset
1887 if (len > 1)
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
1888 pfx = args(1).string_value ("tempname: PREFIX must be a string");
19437
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents: 19419
diff changeset
1889
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents: 19419
diff changeset
1890 retval = octave_tempnam (dir, pfx);
2936
87cb7614257d [project @ 1997-05-06 05:46:00 by jwe]
jwe
parents: 2926
diff changeset
1891 }
1802
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
1892 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1893 print_usage ();
1802
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
1894
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
1895 return retval;
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
1896 }
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
1897
19454
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1898 /*
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1899 %!test
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1900 %! if (ispc ())
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1901 %! envname = "TMP";
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1902 %! else
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1903 %! envname = "TMPDIR";
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1904 %! endif
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1905 %! envdir = getenv (envname);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1906 %! unsetenv (envname);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1907 %! unwind_protect
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1908 %! ## Test 0-argument form
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1909 %! fname = tempname ();
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19454
diff changeset
1910 %! [tmpdir, tmpfname] = fileparts (fname);
19454
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1911 %! assert (tmpdir, P_tmpdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1912 %! assert (tmpfname (1:4), "oct-");
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19454
diff changeset
1913 %! ## Test 1-argument form
19454
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1914 %! tmp_tmpdir = [P_tmpdir filesep() substr(tmpfname, -5)];
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1915 %! mkdir (tmp_tmpdir) || error ("Unable to create tmp dir");
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1916 %! setenv (envname, P_tmpdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1917 %! fname = tempname (tmp_tmpdir);
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19454
diff changeset
1918 %! [tmpdir, tmpfname] = fileparts (fname);
19454
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1919 %! assert (tmpdir, tmp_tmpdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1920 %! assert (tmpfname (1:4), "oct-");
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1921 %! ## Test 1-argument form w/null tmpdir
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1922 %! fname = tempname ("");
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19454
diff changeset
1923 %! [tmpdir, tmpfname] = fileparts (fname);
19454
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1924 %! assert (tmpdir, P_tmpdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1925 %! assert (tmpfname (1:4), "oct-");
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19454
diff changeset
1926 %! ## Test 2-argument form
19454
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1927 %! fname = tempname (tmp_tmpdir, "pfx-");
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19454
diff changeset
1928 %! [tmpdir, tmpfname] = fileparts (fname);
19454
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1929 %! assert (tmpdir, tmp_tmpdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1930 %! assert (tmpfname (1:4), "pfx-");
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1931 %! ## Test 2-argument form w/null prefix
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1932 %! fname = tempname (tmp_tmpdir, "");
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19454
diff changeset
1933 %! [tmpdir, tmpfname] = fileparts (fname);
19454
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1934 %! assert (tmpdir, tmp_tmpdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1935 %! assert (tmpfname (1:4), "file");
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1936 %! unwind_protect_cleanup
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1937 %! rmdir (tmp_tmpdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1938 %! if (isempty (envdir))
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1939 %! unsetenv (envname);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1940 %! else
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1941 %! setenv (envname, envdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1942 %! endif
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1943 %! end_unwind_protect
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1944 */
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19437
diff changeset
1945
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1946 DEFUN (tmpfile, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1947 "-*- texinfo -*-\n\
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1948 @deftypefn {Built-in Function} {[@var{fid}, @var{msg}] =} tmpfile ()\n\
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1949 Return the file ID corresponding to a new temporary file with a unique\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
1950 name.\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
1951 \n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
1952 The file is opened in binary read/write (@qcode{\"w+b\"}) mode and will be\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
1953 deleted automatically when it is closed or when Octave exits.\n\
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1954 \n\
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1955 If successful, @var{fid} is a valid file ID and @var{msg} is an empty\n\
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1956 string. Otherwise, @var{fid} is -1 and @var{msg} contains a\n\
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1957 system-dependent error message.\n\
19312
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
1958 @seealso{tempname, mkstemp, tempdir, P_tmpdir}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
1959 @end deftypefn")
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1960 {
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1961 octave_value_list retval;
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1962
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1963 retval(1) = std::string ();
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1964 retval(0) = -1;
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1965
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1966 int nargin = args.length ();
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1967
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1968 if (nargin == 0)
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1969 {
12775
d02c9a58bae1 use gnulib tmpfile module
John W. Eaton <jwe@octave.org>
parents: 12642
diff changeset
1970 FILE *fid = gnulib::tmpfile ();
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1971
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1972 if (fid)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1973 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1974 std::string nm;
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1975
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1976 std::ios::openmode md = fopen_mode_to_ios_mode ("w+b");
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1977
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1978 octave_stream s = octave_stdiostream::create (nm, fid, md);
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1979
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1980 if (s)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1981 retval(0) = octave_stream_list::insert (s);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1982 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1983 error ("tmpfile: failed to create octave_stdiostream object");
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1984
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1985 }
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1986 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1987 {
10411
479cc8a0a846 use gnulib namespace
John W. Eaton <jwe@octave.org>
parents: 10350
diff changeset
1988 retval(1) = gnulib::strerror (errno);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1989 retval(0) = -1;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
1990 }
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1991 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1992 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1993 print_usage ();
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1994
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1995 return retval;
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1996 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1997
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
1998 DEFUN (mkstemp, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1999 "-*- texinfo -*-\n\
19244
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2000 @deftypefn {Built-in Function} {[@var{fid}, @var{name}, @var{msg}] =} mkstemp (\"@var{template}\")\n\
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2001 @deftypefnx {Built-in Function} {[@var{fid}, @var{name}, @var{msg}] =} mkstemp (\"@var{template}\", @var{delete})\n\
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2002 Return the file descriptor @var{fid} corresponding to a new temporary file\n\
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2003 with a unique name created from @var{template}.\n\
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2004 \n\
19244
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2005 The last six characters of @var{template} must be @qcode{\"XXXXXX\"} and\n\
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2006 these are replaced with a string that makes the filename unique. The file\n\
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2007 is then created with mode read/write and permissions that are system\n\
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2008 dependent (on GNU/Linux systems, the permissions will be 0600 for versions of\n\
19264
cfa9996afcbf doc: fix stray escape sequence in mkstemp's docstring
Mike Miller <mtmiller@ieee.org>
parents: 19244
diff changeset
2009 glibc 2.0.7 and later). The file is opened in binary mode and with the\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2010 @w{@code{O_EXCL}} flag.\n\
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2011 \n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2012 If the optional argument @var{delete} is supplied and is true, the file will\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2013 be deleted automatically when Octave exits.\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2014 \n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2015 If successful, @var{fid} is a valid file ID, @var{name} is the name of the\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2016 file, and @var{msg} is an empty string. Otherwise, @var{fid} is -1,\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2017 @var{name} is empty, and @var{msg} contains a system-dependent error message.\n\
19312
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
2018 @seealso{tempname, tempdir, P_tmpdir, tmpfile, fopen}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5421
diff changeset
2019 @end deftypefn")
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2020 {
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2021 octave_value_list retval;
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2022
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2023 retval(2) = std::string ();
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2024 retval(1) = std::string ();
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2025 retval(0) = -1;
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2026
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2027 int nargin = args.length ();
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2028
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2029 if (nargin == 1 || nargin == 2)
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2030 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2031 std::string tmpl8 = args(0).string_value ("mkstemp: TEMPLATE argument must be a string");
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2032
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2033 OCTAVE_LOCAL_BUFFER (char, tmp, tmpl8.size () + 1);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2034 strcpy (tmp, tmpl8.c_str ());
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2035
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2036 int fd = gnulib::mkostemp (tmp, O_BINARY);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2037
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2038 if (fd < 0)
19437
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents: 19419
diff changeset
2039 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2040 retval(2) = gnulib::strerror (errno);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2041 retval(0) = fd;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2042 }
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2043 else
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2044 {
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2045 const char *fopen_mode = "w+b";
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2046
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2047 FILE *fid = fdopen (fd, fopen_mode);
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2048
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2049 if (fid)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2050 {
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2051 std::string nm = tmp;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2052
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2053 std::ios::openmode md = fopen_mode_to_ios_mode (fopen_mode);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2054
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2055 octave_stream s = octave_stdiostream::create (nm, fid, md);
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2056
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2057 if (s)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2058 {
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2059 retval(1) = nm;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2060 retval(0) = octave_stream_list::insert (s);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2061
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2062 if (nargin == 2 && args(1).is_true ())
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2063 mark_for_deletion (nm);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2064 }
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2065 else
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2066 error ("mkstemp: failed to create octave_stdiostream object");
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2067 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2068 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2069 {
20616
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2070 retval(2) = gnulib::strerror (errno);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20593
diff changeset
2071 retval(0) = -1;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2072 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2073 }
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2074 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2075 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
2076 print_usage ();
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2077
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2078 return retval;
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2079 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2080
20235
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054).
Rik <rik@octave.org>
parents: 20233
diff changeset
2081 // FIXME: This routine also exists verbatim in syscalls.cc.
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054).
Rik <rik@octave.org>
parents: 20233
diff changeset
2082 // Maybe change to be a general utility routine.
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2083 static int
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2084 convert (int x, int ibase, int obase)
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2085 {
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2086 int retval = 0;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2087
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2088 int tmp = x % obase;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2089
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2090 if (tmp > ibase - 1)
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
2091 error ("umask: invalid digit");
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2092 else
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2093 {
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2094 retval = tmp;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2095 int mult = ibase;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2096 while ((x = (x - tmp) / obase))
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2097 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2098 tmp = x % obase;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2099 if (tmp > ibase - 1)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2100 {
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
2101 error ("umask: invalid digit");
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2102 break;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2103 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2104 retval += mult * tmp;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2105 mult *= ibase;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2106 }
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2107 }
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2108
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2109 return retval;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2110 }
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2111
10197
4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents: 10182
diff changeset
2112 DEFUNX ("umask", Fumask, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
2113 "-*- texinfo -*-\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
2114 @deftypefn {Built-in Function} {} umask (@var{mask})\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2115 Set the permission mask for file creation.\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2116 \n\
20207
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
2117 The parameter @var{mask} is an integer, interpreted as an octal number.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
2118 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20136
diff changeset
2119 If successful, returns the previous value of the mask (as an integer to be\n\
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
2120 interpreted as an octal number); otherwise an error message is printed.\n\
20233
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
2121 \n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
2122 The permission mask is a UNIX concept used when creating new objects on a\n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
2123 file system such as files, directories, or named FIFOs. The object to be\n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
2124 created has base permissions in an octal number @var{mode} which are\n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
2125 modified according to the octal value of @var{mask}. The final permissions\n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
2126 for the new object are @code{@var{mode} - @var{mask}}.\n\
b597bd161a5f doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents: 20207
diff changeset
2127 @seealso{fopen, mkdir, mkfifo}\n\
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3263
diff changeset
2128 @end deftypefn")
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2129 {
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
2130 octave_value_list retval;
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2131
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2132 int status = 0;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2133
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2134 if (args.length () == 1)
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2135 {
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 3180
diff changeset
2136 int mask = args(0).int_value (true);
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2137
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 3180
diff changeset
2138 if (! error_state)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2139 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2140 if (mask < 0)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2141 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2142 status = -1;
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
2143 error ("umask: MASK must be a positive integer value");
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2144 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2145 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2146 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2147 int oct_mask = convert (mask, 8, 10);
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2148
20593
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20492
diff changeset
2149 status = convert (octave_umask (oct_mask), 10, 8);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2150 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2151 }
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 3180
diff changeset
2152 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2153 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2154 status = -1;
20463
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20235
diff changeset
2155 error ("umask: MASK must be an integer");
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2156 }
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2157 }
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2158 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
2159 print_usage ();
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2160
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2161 if (status >= 0)
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4102
diff changeset
2162 retval(0) = status;
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2163
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2164 return retval;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2165 }
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
2166
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2167 static octave_value
6483
d00da2148c53 [project @ 2007-04-04 02:58:48 by jwe]
jwe
parents: 6456
diff changeset
2168 const_value (const char *, const octave_value_list& args, int val)
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
2169 {
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2170 octave_value retval;
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2171
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2172 int nargin = args.length ();
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2173
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2174 if (nargin == 0)
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2175 retval = val;
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2176 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
2177 print_usage ();
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2178
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2179 return retval;
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2180 }
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2181
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2182 DEFUNX ("P_tmpdir", FP_tmpdir, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
2183 "-*- texinfo -*-\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2184 @deftypefn {Built-in Function} {} P_tmpdir ()\n\
19244
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2185 Return the name of the host system's @strong{default} directory for\n\
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2186 temporary files.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2187 \n\
19244
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2188 Programming Note: The value returned by @code{P_tmpdir} is always the\n\
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2189 default location. This value may not agree with that returned from\n\
20132
1f9ed81bd173 maint: Fix spelling and grammar mistakes in docs and comments (bug #44878)
Rafael Laboissiere <rafael@laboissiere.net>
parents: 20076
diff changeset
2190 @code{tempdir} if the user has overridden the default with the @env{TMPDIR}\n\
19244
841d8f606bcd doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents: 19184
diff changeset
2191 environment variable.\n\
19312
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19302
diff changeset
2192 @seealso{tempdir, tempname, mkstemp, tmpfile}\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2193 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2194 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2195 octave_value retval;
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2196
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2197 int nargin = args.length ();
4267
7cd865a8c815 [project @ 2003-01-03 15:27:05 by jwe]
jwe
parents: 4257
diff changeset
2198
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2199 if (nargin == 0)
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 12211
diff changeset
2200 retval = get_P_tmpdir ();
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2201 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
2202 print_usage ();
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2203
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2204 return retval;
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2205 }
2341
6ee55c0f25a9 [project @ 1996-07-24 10:33:09 by jwe]
jwe
parents: 2324
diff changeset
2206
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2207 // NOTE: the values of SEEK_SET, SEEK_CUR, and SEEK_END have to be
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2208 // this way for Matlab compatibility.
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2209
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2210 DEFUNX ("SEEK_SET", FSEEK_SET, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
2211 "-*- texinfo -*-\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
2212 @deftypefn {Built-in Function} {} SEEK_SET ()\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2213 @deftypefnx {Built-in Function} {} SEEK_CUR ()\n\
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2214 @deftypefnx {Built-in Function} {} SEEK_END ()\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2215 Return the numerical value to pass to @code{fseek} to perform one of the\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2216 following actions:\n\
14366
b76f0740940e doc: Periodic grammar check of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14365
diff changeset
2217 \n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
2218 @table @code\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
2219 @item SEEK_SET\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
2220 Position file relative to the beginning.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
2221 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
2222 @item SEEK_CUR\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
2223 Position file relative to the current position.\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
2224 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
2225 @item SEEK_END\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2226 Position file relative to the end.\n\
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3342
diff changeset
2227 @end table\n\
14171
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
2228 @seealso{fseek}\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2229 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2230 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2231 return const_value ("SEEK_SET", args, -1);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2232 }
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
2233
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2234 DEFUNX ("SEEK_CUR", FSEEK_CUR, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
2235 "-*- texinfo -*-\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2236 @deftypefn {Built-in Function} {} SEEK_CUR ()\n\
14171
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
2237 Return the numerical value to pass to @code{fseek} to\n\
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
2238 position the file pointer relative to the current position.\n\
18040
62f94ef938b4 don't use period after end of @seealso{...}
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
2239 @seealso{SEEK_SET, SEEK_END}\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2240 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2241 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2242 return const_value ("SEEK_CUR", args, 0);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2243 }
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
2244
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2245 DEFUNX ("SEEK_END", FSEEK_END, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
2246 "-*- texinfo -*-\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2247 @deftypefn {Built-in Function} {} SEEK_END ()\n\
14171
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
2248 Return the numerical value to pass to @code{fseek} to\n\
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
2249 position the file pointer relative to the end of the file.\n\
18040
62f94ef938b4 don't use period after end of @seealso{...}
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
2250 @seealso{SEEK_SET, SEEK_CUR}\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2251 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2252 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2253 return const_value ("SEEK_END", args, 1);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2254 }
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2255
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2256 static octave_value
6483
d00da2148c53 [project @ 2007-04-04 02:58:48 by jwe]
jwe
parents: 6456
diff changeset
2257 const_value (const char *, const octave_value_list& args,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
2258 const octave_value& val)
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2259 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2260 octave_value retval;
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2261
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2262 int nargin = args.length ();
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
2263
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2264 if (nargin == 0)
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2265 retval = val;
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2266 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
2267 print_usage ();
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2268
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2269 return retval;
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2270 }
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2271
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2272 DEFUNX ("stdin", Fstdin, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
2273 "-*- texinfo -*-\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2274 @deftypefn {Built-in Function} {} stdin ()\n\
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2275 Return the numeric value corresponding to the standard input stream.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2276 \n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2277 When Octave is used interactively, stdin is filtered through the command\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2278 line editing functions.\n\
5333
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 5325
diff changeset
2279 @seealso{stdout, stderr}\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2280 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2281 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2282 return const_value ("stdin", args, stdin_file);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2283 }
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
2284
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2285 DEFUNX ("stdout", Fstdout, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
2286 "-*- texinfo -*-\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2287 @deftypefn {Built-in Function} {} stdout ()\n\
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2288 Return the numeric value corresponding to the standard output stream.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2289 \n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2290 Data written to the standard output is normally filtered through the pager.\n\
5333
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 5325
diff changeset
2291 @seealso{stdin, stderr}\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2292 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2293 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2294 return const_value ("stdout", args, stdout_file);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2295 }
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
2296
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2297 DEFUNX ("stderr", Fstderr, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
2298 "-*- texinfo -*-\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2299 @deftypefn {Built-in Function} {} stderr ()\n\
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2300 Return the numeric value corresponding to the standard error stream.\n\
19143
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2301 \n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2302 Even if paging is turned on, the standard error is not sent to the pager.\n\
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 19064
diff changeset
2303 It is useful for error messages and prompts.\n\
5333
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 5325
diff changeset
2304 @seealso{stdin, stdout}\n\
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2305 @end deftypefn")
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2306 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
2307 return const_value ("stderr", args, stderr_file);
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
2308 }