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