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