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