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