Mercurial > hg > octave-lyh
annotate src/file-io.cc @ 7768:a2d9f325b65a
Use isschar instead of deprecated isstr
| author | Rafael Laboissiere <rafael@debian.org> |
|---|---|
| date | Sat, 03 May 2008 11:47:54 +0200 |
| parents | b68e44c90afe |
| children | 02a7fe6907d2 |
| 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\ | |
| 5642 | 362 @seealso{fread, fscanf}\n\ |
| 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\ | |
| 5642 | 620 @seealso{fclose, fread, fseek}\n\ |
| 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\ | |
| 3372 | 928 @end deftypefn") |
| 1181 | 929 { |
| 4468 | 930 static std::string who = "fputs"; |
| 931 | |
| 4233 | 932 octave_value retval = -1; |
| 1181 | 933 |
| 934 int nargin = args.length (); | |
| 935 | |
| 2095 | 936 if (nargin == 2) |
| 937 { | |
| 4468 | 938 octave_stream os = octave_stream_list::lookup (args(0), who); |
| 1181 | 939 |
| 3341 | 940 if (! error_state) |
| 4468 | 941 retval = os.puts (args(1), who); |
| 2095 | 942 } |
| 1181 | 943 else |
| 5823 | 944 print_usage (); |
| 4468 | 945 |
| 946 return retval; | |
| 947 } | |
| 948 | |
| 949 DEFUN (puts, args, , | |
| 950 "-*- texinfo -*-\n\ | |
| 951 @deftypefn {Built-in Function} {} puts (@var{string})\n\ | |
| 952 Write a string to the standard output with no formatting.\n\ | |
| 5095 | 953 \n\ |
| 954 Return a non-negative number on success and EOF on error.\n\ | |
| 4468 | 955 @end deftypefn") |
| 956 { | |
| 957 static std::string who = "puts"; | |
| 958 | |
| 959 octave_value retval = -1; | |
| 960 | |
| 961 if (args.length () == 1) | |
| 962 retval = stdout_stream.puts (args(0), who); | |
| 963 else | |
| 5823 | 964 print_usage (); |
| 1181 | 965 |
| 966 return retval; | |
| 967 } | |
| 968 | |
| 2095 | 969 DEFUN (sprintf, args, , |
| 3372 | 970 "-*- texinfo -*-\n\ |
| 971 @deftypefn {Built-in Function} {} sprintf (@var{template}, @dots{})\n\ | |
| 972 This is like @code{printf}, except that the output is returned as a\n\ | |
| 973 string. Unlike the C library function, which requires you to provide a\n\ | |
| 974 suitably sized string as an argument, Octave's @code{sprintf} function\n\ | |
| 975 returns the string, automatically sized to hold all of the items\n\ | |
| 976 converted.\n\ | |
| 5642 | 977 @seealso{printf, fprintf, sscanf}\n\ |
| 978 @end deftypefn") | |
| 1 | 979 { |
| 4468 | 980 static std::string who = "sprintf"; |
| 981 | |
| 2095 | 982 octave_value_list retval; |
| 1 | 983 |
| 2095 | 984 int nargin = args.length (); |
| 1 | 985 |
| 2095 | 986 if (nargin > 0) |
| 1 | 987 { |
| 2116 | 988 retval(2) = -1.0; |
| 989 retval(1) = "unknown error"; | |
| 990 retval(0) = ""; | |
| 991 | |
| 3340 | 992 octave_ostrstream *ostr = new octave_ostrstream (); |
| 1 | 993 |
| 3340 | 994 octave_stream os (ostr); |
| 628 | 995 |
| 3340 | 996 if (os.is_valid ()) |
| 2095 | 997 { |
| 6007 | 998 octave_value fmt_arg = args(0); |
| 999 | |
| 1000 if (fmt_arg.is_string ()) | |
| 2095 | 1001 { |
| 1002 octave_value_list tmp_args; | |
| 1 | 1003 |
| 2095 | 1004 if (nargin > 1) |
| 1005 { | |
| 1006 tmp_args.resize (nargin-1, octave_value ()); | |
| 1 | 1007 |
| 2095 | 1008 for (int i = 1; i < nargin; i++) |
| 1009 tmp_args(i-1) = args(i); | |
| 1010 } | |
| 628 | 1011 |
| 6007 | 1012 retval(2) = os.printf (fmt_arg, tmp_args, who); |
| 2095 | 1013 retval(1) = os.error (); |
| 6007 | 1014 retval(0) = octave_value (ostr->str (), |
| 1015 fmt_arg.is_sq_string () ? '\'' : '"'); | |
| 2095 | 1016 } |
| 1017 else | |
| 4468 | 1018 ::error ("%s: format must be a string", who.c_str ()); |
| 2095 | 1019 } |
| 1020 else | |
| 4468 | 1021 ::error ("%s: unable to create output buffer", who.c_str ()); |
| 1 | 1022 } |
| 1023 else | |
| 5823 | 1024 print_usage (); |
| 1 | 1025 |
| 1026 return retval; | |
| 1027 } | |
| 1028 | |
| 2095 | 1029 DEFUN (fscanf, args, , |
| 3372 | 1030 "-*- texinfo -*-\n\ |
| 1031 @deftypefn {Built-in Function} {[@var{val}, @var{count}] =} fscanf (@var{fid}, @var{template}, @var{size})\n\ | |
| 7650 | 1032 @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}] =} fscanf (@var{fid}, @var{template}, \"C\")\n\ |
| 3372 | 1033 In the first form, read from @var{fid} according to @var{template},\n\ |
| 1034 returning the result in the matrix @var{val}.\n\ | |
| 2122 | 1035 \n\ |
| 3372 | 1036 The optional argument @var{size} specifies the amount of data to read\n\ |
| 1037 and may be one of\n\ | |
| 1038 \n\ | |
| 1039 @table @code\n\ | |
| 1040 @item Inf\n\ | |
| 1041 Read as much as possible, returning a column vector.\n\ | |
| 1042 \n\ | |
| 1043 @item @var{nr}\n\ | |
| 1044 Read up to @var{nr} elements, returning a column vector.\n\ | |
| 2122 | 1045 \n\ |
| 3372 | 1046 @item [@var{nr}, Inf]\n\ |
| 1047 Read as much as possible, returning a matrix with @var{nr} rows. If the\n\ | |
| 1048 number of elements read is not an exact multiple of @var{nr}, the last\n\ | |
| 1049 column is padded with zeros.\n\ | |
| 1050 \n\ | |
| 1051 @item [@var{nr}, @var{nc}]\n\ | |
| 1052 Read up to @code{@var{nr} * @var{nc}} elements, returning a matrix with\n\ | |
| 1053 @var{nr} rows. If the number of elements read is not an exact multiple\n\ | |
| 1054 of @var{nr}, the last column is padded with zeros.\n\ | |
| 1055 @end table\n\ | |
| 2122 | 1056 \n\ |
| 3372 | 1057 @noindent\n\ |
| 1058 If @var{size} is omitted, a value of @code{Inf} is assumed.\n\ | |
| 2122 | 1059 \n\ |
| 3372 | 1060 A string is returned if @var{template} specifies only character\n\ |
| 1061 conversions.\n\ | |
| 2215 | 1062 \n\ |
| 3372 | 1063 The number of items successfully read is returned in @var{count}.\n\ |
| 2215 | 1064 \n\ |
| 3372 | 1065 In the second form, read from @var{fid} according to @var{template},\n\ |
| 1066 with each conversion specifier in @var{template} corresponding to a\n\ | |
| 1067 single scalar return value. This form is more `C-like', and also\n\ | |
| 3491 | 1068 compatible with previous versions of Octave. The number of successful\n\ |
| 1069 conversions is returned in @var{count}\n\ | |
| 5653 | 1070 @ifclear OCTAVE_MANUAL\n\ |
| 1071 \n\ | |
| 1072 See the Formatted Input section of the GNU Octave manual for a\n\ | |
| 1073 complete description of the syntax of the template string.\n\ | |
| 1074 @end ifclear\n\ | |
| 5642 | 1075 @seealso{scanf, sscanf, fread, fprintf}\n\ |
| 1076 @end deftypefn") | |
| 1181 | 1077 { |
| 4468 | 1078 static std::string who = "fscanf"; |
| 1079 | |
| 2095 | 1080 octave_value_list retval; |
| 1181 | 1081 |
| 1082 int nargin = args.length (); | |
| 1083 | |
| 2215 | 1084 if (nargin == 3 && args(2).is_string ()) |
| 2095 | 1085 { |
| 4468 | 1086 octave_stream os = octave_stream_list::lookup (args(0), who); |
| 1181 | 1087 |
| 3341 | 1088 if (! error_state) |
| 2095 | 1089 { |
| 1090 if (args(1).is_string ()) | |
| 5279 | 1091 retval = os.oscanf (args(1), who); |
| 2095 | 1092 else |
| 4468 | 1093 ::error ("%s: format must be a string", who.c_str ()); |
| 2095 | 1094 } |
| 1095 } | |
| 1181 | 1096 else |
| 2215 | 1097 { |
| 1098 retval (1) = 0.0; | |
| 1099 retval (0) = Matrix (); | |
| 1100 | |
| 1101 if (nargin == 2 || nargin == 3) | |
| 1102 { | |
| 4468 | 1103 octave_stream os = octave_stream_list::lookup (args(0), who); |
| 2215 | 1104 |
| 3342 | 1105 if (! error_state) |
| 2215 | 1106 { |
| 1107 if (args(1).is_string ()) | |
| 1108 { | |
| 5275 | 1109 octave_idx_type count = 0; |
| 2215 | 1110 |
| 3810 | 1111 Array<double> size = (nargin == 3) |
| 4102 | 1112 ? args(2).vector_value () |
| 1113 : Array<double> (1, lo_ieee_inf_value ()); | |
| 2215 | 1114 |
| 1115 if (! error_state) | |
| 1116 { | |
| 5279 | 1117 octave_value tmp = os.scanf (args(1), size, count, who); |
| 2215 | 1118 |
| 4233 | 1119 retval(1) = count; |
| 2215 | 1120 retval(0) = tmp; |
| 1121 } | |
| 1122 } | |
| 1123 else | |
| 4468 | 1124 ::error ("%s: format must be a string", who.c_str ()); |
| 2215 | 1125 } |
| 1126 } | |
| 1127 else | |
| 5823 | 1128 print_usage (); |
| 2215 | 1129 } |
| 1181 | 1130 |
| 1131 return retval; | |
| 1132 } | |
| 1133 | |
| 2095 | 1134 DEFUN (sscanf, args, , |
| 3372 | 1135 "-*- texinfo -*-\n\ |
| 1136 @deftypefn {Built-in Function} {[@var{val}, @var{count}] =} sscanf (@var{string}, @var{template}, @var{size})\n\ | |
| 7650 | 1137 @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}] =} sscanf (@var{string}, @var{template}, \"C\")\n\ |
| 3372 | 1138 This is like @code{fscanf}, except that the characters are taken from the\n\ |
| 1139 string @var{string} instead of from a stream. Reaching the end of the\n\ | |
| 1140 string is treated as an end-of-file condition.\n\ | |
| 5642 | 1141 @seealso{fscanf, scanf, sprintf}\n\ |
| 1142 @end deftypefn") | |
| 444 | 1143 { |
| 4468 | 1144 static std::string who = "sscanf"; |
| 1145 | |
| 2095 | 1146 octave_value_list retval; |
| 444 | 1147 |
| 506 | 1148 int nargin = args.length (); |
| 1149 | |
| 2215 | 1150 if (nargin == 3 && args(2).is_string ()) |
| 2095 | 1151 { |
| 1152 if (args(0).is_string ()) | |
| 1153 { | |
| 3523 | 1154 std::string data = args(0).string_value (); |
| 444 | 1155 |
| 3340 | 1156 octave_stream os = octave_istrstream::create (data); |
| 1358 | 1157 |
| 3340 | 1158 if (os.is_valid ()) |
| 2095 | 1159 { |
| 1160 if (args(1).is_string ()) | |
| 5279 | 1161 retval = os.oscanf (args(1), who); |
| 2095 | 1162 else |
| 4468 | 1163 ::error ("%s: format must be a string", who.c_str ()); |
| 2095 | 1164 } |
| 1165 else | |
| 4468 | 1166 ::error ("%s: unable to create temporary input buffer", |
| 1167 who.c_str ()); | |
| 444 | 1168 } |
| 636 | 1169 else |
| 4468 | 1170 ::error ("%s: first argument must be a string", who.c_str ()); |
| 444 | 1171 } |
| 1172 else | |
| 2215 | 1173 { |
| 1174 if (nargin == 2 || nargin == 3) | |
| 1175 { | |
| 1176 retval(3) = -1.0; | |
| 1177 retval(2) = "unknown error"; | |
| 1178 retval(1) = 0.0; | |
| 1179 retval(0) = Matrix (); | |
| 1180 | |
| 1181 if (args(0).is_string ()) | |
| 1182 { | |
| 3523 | 1183 std::string data = args(0).string_value (); |
| 2215 | 1184 |
| 3340 | 1185 octave_stream os = octave_istrstream::create (data); |
| 2215 | 1186 |
| 3340 | 1187 if (os.is_valid ()) |
| 2215 | 1188 { |
| 1189 if (args(1).is_string ()) | |
| 1190 { | |
| 5275 | 1191 octave_idx_type count = 0; |
| 2215 | 1192 |
| 3810 | 1193 Array<double> size = (nargin == 3) |
| 1194 ? args(2).vector_value () | |
| 4102 | 1195 : Array<double> (1, lo_ieee_inf_value ()); |
| 2215 | 1196 |
| 5279 | 1197 octave_value tmp = os.scanf (args(1), size, count, who); |
| 2215 | 1198 |
| 5775 | 1199 // FIXME -- is this the right thing to do? |
| 2215 | 1200 // Extract error message first, because getting |
| 1201 // position will clear it. | |
| 3523 | 1202 std::string errmsg = os.error (); |
| 2215 | 1203 |
| 4254 | 1204 retval(3) = os.tell () + 1; |
| 2215 | 1205 retval(2) = errmsg; |
| 4233 | 1206 retval(1) = count; |
| 2215 | 1207 retval(0) = tmp; |
| 1208 } | |
| 1209 else | |
| 4468 | 1210 ::error ("%s: format must be a string", who.c_str ()); |
| 2215 | 1211 } |
| 1212 else | |
| 4468 | 1213 ::error ("%s: unable to create temporary input buffer", |
| 1214 who.c_str ()); | |
| 2215 | 1215 } |
| 1216 else | |
| 4468 | 1217 ::error ("%s: first argument must be a string", who.c_str ()); |
| 2215 | 1218 } |
| 1219 else | |
| 5823 | 1220 print_usage (); |
| 2215 | 1221 } |
| 444 | 1222 |
| 1223 return retval; | |
| 1224 } | |
| 1225 | |
| 2215 | 1226 DEFUN (scanf, args, nargout, |
| 3372 | 1227 "-*- texinfo -*-\n\ |
| 1228 @deftypefn {Built-in Function} {[@var{val}, @var{count}] =} scanf (@var{template}, @var{size})\n\ | |
| 7650 | 1229 @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}]] =} scanf (@var{template}, \"C\")\n\ |
| 3372 | 1230 This is equivalent to calling @code{fscanf} with @var{fid} = @code{stdin}.\n\ |
| 1231 \n\ | |
| 1232 It is currently not useful to call @code{scanf} in interactive\n\ | |
| 1233 programs.\n\ | |
| 5642 | 1234 @seealso{fscanf, sscanf, printf}\n\ |
| 1235 @end deftypefn") | |
| 2215 | 1236 { |
| 1237 int nargin = args.length (); | |
| 1238 | |
| 1239 octave_value_list tmp_args (nargin+1, octave_value ()); | |
| 1240 | |
| 1241 tmp_args (0) = 0.0; | |
| 1242 for (int i = 0; i < nargin; i++) | |
| 1243 tmp_args (i+1) = args (i); | |
| 1244 | |
| 1245 return Ffscanf (tmp_args, nargout); | |
| 1246 } | |
| 1247 | |
| 2116 | 1248 static octave_value |
| 1249 do_fread (octave_stream& os, const octave_value& size_arg, | |
| 1250 const octave_value& prec_arg, const octave_value& skip_arg, | |
| 5275 | 1251 const octave_value& arch_arg, octave_idx_type& count) |
| 2116 | 1252 { |
| 1253 octave_value retval; | |
| 1254 | |
| 1255 count = -1; | |
| 1256 | |
| 3810 | 1257 Array<double> size = size_arg.vector_value (); |
| 2116 | 1258 |
| 1259 if (! error_state) | |
| 1260 { | |
| 3523 | 1261 std::string prec = prec_arg.string_value (); |
| 2116 | 1262 |
| 1263 if (! error_state) | |
| 1264 { | |
| 4944 | 1265 int block_size = 1; |
| 1266 oct_data_conv::data_type input_type; | |
| 1267 oct_data_conv::data_type output_type; | |
| 1268 | |
| 1269 oct_data_conv::string_to_data_type (prec, block_size, | |
| 1270 input_type, output_type); | |
| 2116 | 1271 |
| 1272 if (! error_state) | |
| 1273 { | |
| 3202 | 1274 int skip = skip_arg.int_value (true); |
| 2116 | 1275 |
| 1276 if (! error_state) | |
| 1277 { | |
| 3523 | 1278 std::string arch = arch_arg.string_value (); |
| 3202 | 1279 |
| 1280 if (! error_state) | |
| 2116 | 1281 { |
| 3202 | 1282 oct_mach_info::float_format flt_fmt |
| 1283 = oct_mach_info::string_to_float_format (arch); | |
| 2116 | 1284 |
| 1285 if (! error_state) | |
| 4944 | 1286 retval = os.read (size, block_size, input_type, |
| 1287 output_type, skip, flt_fmt, count); | |
| 2116 | 1288 } |
| 1289 else | |
| 3202 | 1290 ::error ("fread: architecture type must be a string"); |
| 2116 | 1291 } |
| 1292 else | |
| 3202 | 1293 ::error ("fread: skip must be an integer"); |
| 2116 | 1294 } |
| 1295 else | |
| 1296 ::error ("fread: invalid data type specified"); | |
| 1297 } | |
| 1298 else | |
| 1299 ::error ("fread: precision must be a string"); | |
| 1300 } | |
| 1301 else | |
| 1302 ::error ("fread: invalid size specified"); | |
| 1303 | |
| 1304 return retval; | |
| 1305 } | |
| 1306 | |
| 1307 DEFUN (fread, args, , | |
| 3372 | 1308 "-*- texinfo -*-\n\ |
| 1309 @deftypefn {Built-in Function} {[@var{val}, @var{count}] =} fread (@var{fid}, @var{size}, @var{precision}, @var{skip}, @var{arch})\n\ | |
| 1310 Read binary data of type @var{precision} from the specified file ID\n\ | |
| 1311 @var{fid}.\n\ | |
| 1312 \n\ | |
| 1313 The optional argument @var{size} specifies the amount of data to read\n\ | |
| 1314 and may be one of\n\ | |
| 1315 \n\ | |
| 1316 @table @code\n\ | |
| 1317 @item Inf\n\ | |
| 1318 Read as much as possible, returning a column vector.\n\ | |
| 529 | 1319 \n\ |
| 3372 | 1320 @item @var{nr}\n\ |
| 1321 Read up to @var{nr} elements, returning a column vector.\n\ | |
| 1322 \n\ | |
| 1323 @item [@var{nr}, Inf]\n\ | |
| 1324 Read as much as possible, returning a matrix with @var{nr} rows. If the\n\ | |
| 1325 number of elements read is not an exact multiple of @var{nr}, the last\n\ | |
| 1326 column is padded with zeros.\n\ | |
| 1327 \n\ | |
| 1328 @item [@var{nr}, @var{nc}]\n\ | |
| 1329 Read up to @code{@var{nr} * @var{nc}} elements, returning a matrix with\n\ | |
| 1330 @var{nr} rows. If the number of elements read is not an exact multiple\n\ | |
| 1331 of @var{nr}, the last column is padded with zeros.\n\ | |
| 1332 @end table\n\ | |
| 1333 \n\ | |
| 1334 @noindent\n\ | |
| 1335 If @var{size} is omitted, a value of @code{Inf} is assumed.\n\ | |
| 2318 | 1336 \n\ |
| 3372 | 1337 The optional argument @var{precision} is a string specifying the type of\n\ |
| 1338 data to read and may be one of\n\ | |
| 1339 \n\ | |
| 1340 @table @code\n\ | |
| 4944 | 1341 @item \"schar\"\n\ |
| 1342 @itemx \"signed char\"\n\ | |
| 3372 | 1343 Signed character.\n\ |
| 529 | 1344 \n\ |
| 4944 | 1345 @item \"uchar\"\n\ |
| 1346 @itemx \"unsigned char\"\n\ | |
| 3372 | 1347 Unsigned character.\n\ |
| 1348 \n\ | |
| 4944 | 1349 @item \"int8\"\n\ |
| 1350 @itemx \"integer*1\"\n\ | |
| 1351 \n\ | |
| 1352 8-bit signed integer.\n\ | |
| 2318 | 1353 \n\ |
| 4944 | 1354 @item \"int16\"\n\ |
| 1355 @itemx \"integer*2\"\n\ | |
| 1356 16-bit signed integer.\n\ | |
| 3372 | 1357 \n\ |
| 4944 | 1358 @item \"int32\"\n\ |
| 1359 @itemx \"integer*4\"\n\ | |
| 1360 32-bit signed integer.\n\ | |
| 3372 | 1361 \n\ |
| 4944 | 1362 @item \"int64\"\n\ |
| 1363 @itemx \"integer*8\"\n\ | |
| 1364 64-bit signed integer.\n\ | |
| 1365 \n\ | |
| 1366 @item \"uint8\"\n\ | |
| 1367 8-bit unsigned integer.\n\ | |
| 529 | 1368 \n\ |
| 4944 | 1369 @item \"uint16\"\n\ |
| 1370 16-bit unsigned integer.\n\ | |
| 3372 | 1371 \n\ |
| 4944 | 1372 @item \"uint32\"\n\ |
| 1373 32-bit unsigned integer.\n\ | |
| 3372 | 1374 \n\ |
| 4944 | 1375 @item \"uint64\"\n\ |
| 1376 64-bit unsigned integer.\n\ | |
| 1377 \n\ | |
| 1378 @item \"single\"\n\ | |
| 3372 | 1379 @itemx \"float32\"\n\ |
| 1380 @itemx \"real*4\"\n\ | |
| 4944 | 1381 32-bit floating point number.\n\ |
| 3372 | 1382 \n\ |
| 1383 @item \"double\"\n\ | |
| 1384 @itemx \"float64\"\n\ | |
| 1385 @itemx \"real*8\"\n\ | |
| 4944 | 1386 64-bit floating point number.\n\ |
| 1387 \n\ | |
| 1388 @item \"char\"\n\ | |
| 1389 @itemx \"char*1\"\n\ | |
| 1390 Single character.\n\ | |
| 3372 | 1391 \n\ |
| 4944 | 1392 @item \"short\"\n\ |
| 1393 Short integer (size is platform dependent).\n\ | |
| 1394 \n\ | |
| 1395 @item \"int\"\n\ | |
| 1396 Integer (size is platform dependent).\n\ | |
| 1397 \n\ | |
| 1398 @item \"long\"\n\ | |
| 1399 Long integer (size is platform dependent).\n\ | |
| 3372 | 1400 \n\ |
| 4944 | 1401 @item \"ushort\"\n\ |
| 1402 @itemx \"unsigned short\"\n\ | |
| 1403 Unsigned short integer (size is platform dependent).\n\ | |
| 4610 | 1404 \n\ |
| 4944 | 1405 @item \"uint\"\n\ |
| 1406 @itemx \"unsigned int\"\n\ | |
| 1407 Unsigned integer (size is platform dependent).\n\ | |
| 4610 | 1408 \n\ |
| 4944 | 1409 @item \"ulong\"\n\ |
| 1410 @itemx \"unsigned long\"\n\ | |
| 1411 Unsigned long integer (size is platform dependent).\n\ | |
| 1412 \n\ | |
| 1413 @item \"float\"\n\ | |
| 1414 Single precision floating point number (size is platform dependent).\n\ | |
| 3372 | 1415 @end table\n\ |
| 1416 \n\ | |
| 1417 @noindent\n\ | |
| 1418 The default precision is @code{\"uchar\"}.\n\ | |
| 2318 | 1419 \n\ |
| 4944 | 1420 The @var{precision} argument may also specify an optional repeat\n\ |
| 1421 count. For example, @samp{32*single} causes @code{fread} to read\n\ | |
| 1422 a block of 32 single precision floating point numbers. Reading in\n\ | |
| 1423 blocks is useful in combination with the @var{skip} argument.\n\ | |
| 1424 \n\ | |
| 1425 The @var{precision} argument may also specify a type conversion.\n\ | |
| 1426 For example, @samp{int16=>int32} causes @code{fread} to read 16-bit\n\ | |
| 1427 integer values and return an array of 32-bit integer values. By\n\ | |
| 1428 default, @code{fread} returns a double precision array. The special\n\ | |
| 1429 form @samp{*TYPE} is shorthand for @samp{TYPE=>TYPE}.\n\ | |
| 1430 \n\ | |
| 7096 | 1431 The conversion and repeat counts may be combined. For example, the\n\ |
| 1432 specification @samp{32*single=>single} causes @code{fread} to read\n\ | |
| 1433 blocks of single precision floating point values and return an array\n\ | |
| 1434 of single precision values instead of the default array of double\n\ | |
| 1435 precision values.\n\ | |
| 4944 | 1436 \n\ |
| 3372 | 1437 The optional argument @var{skip} specifies the number of bytes to skip\n\ |
| 4944 | 1438 after each element (or block of elements) is read. If it is not\n\ |
| 1439 specified, a value of 0 is assumed. If the final block read is not\n\ | |
| 1440 complete, the final skip is omitted. For example,\n\ | |
| 1441 \n\ | |
| 1442 @example\n\ | |
| 1443 fread (f, 10, \"3*single=>single\", 8)\n\ | |
| 1444 @end example\n\ | |
| 1445 \n\ | |
| 1446 @noindent\n\ | |
| 1447 will omit the final 8-byte skip because the last read will not be\n\ | |
| 1448 a complete block of 3 values.\n\ | |
| 3372 | 1449 \n\ |
| 1450 The optional argument @var{arch} is a string specifying the data format\n\ | |
| 1451 for the file. Valid values are\n\ | |
| 529 | 1452 \n\ |
| 3372 | 1453 @table @code\n\ |
| 1454 @item \"native\"\n\ | |
| 1455 The format of the current machine.\n\ | |
| 1456 \n\ | |
| 4546 | 1457 @item \"ieee-be\"\n\ |
| 3372 | 1458 IEEE big endian.\n\ |
| 1459 \n\ | |
| 4546 | 1460 @item \"ieee-le\"\n\ |
| 3372 | 1461 IEEE little endian.\n\ |
| 2318 | 1462 \n\ |
| 3372 | 1463 @item \"vaxd\"\n\ |
| 1464 VAX D floating format.\n\ | |
| 1465 \n\ | |
| 1466 @item \"vaxg\"\n\ | |
| 1467 VAX G floating format.\n\ | |
| 2318 | 1468 \n\ |
| 3372 | 1469 @item \"cray\"\n\ |
| 1470 Cray floating format.\n\ | |
| 1471 @end table\n\ | |
| 2318 | 1472 \n\ |
| 3372 | 1473 @noindent\n\ |
| 1474 Conversions are currently only supported for @code{\"ieee-be\"} and\n\ | |
| 1475 @code{\"ieee-le\"} formats.\n\ | |
| 2318 | 1476 \n\ |
| 3372 | 1477 The data read from the file is returned in @var{val}, and the number of\n\ |
| 1478 values read is returned in @code{count}\n\ | |
| 5642 | 1479 @seealso{fwrite, fopen, fclose}\n\ |
| 1480 @end deftypefn") | |
| 529 | 1481 { |
| 2095 | 1482 octave_value_list retval; |
| 2116 | 1483 |
| 1484 int nargin = args.length (); | |
| 1485 | |
| 2318 | 1486 if (nargin > 0 && nargin < 6) |
| 2116 | 1487 { |
| 1488 retval(1) = -1.0; | |
| 1489 retval(0) = Matrix (); | |
| 1490 | |
| 3341 | 1491 octave_stream os = octave_stream_list::lookup (args(0), "fread"); |
| 2116 | 1492 |
| 3341 | 1493 if (! error_state) |
| 2116 | 1494 { |
| 4257 | 1495 octave_value size = lo_ieee_inf_value (); |
| 1496 octave_value prec = "uchar"; | |
| 1497 octave_value skip = 0; | |
| 1498 octave_value arch = "unknown"; | |
| 2116 | 1499 |
| 4257 | 1500 int idx = 1; |
| 2116 | 1501 |
|
7708
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1502 if (nargin > idx && ! args(idx).is_string ()) |
| 4257 | 1503 size = args(idx++); |
| 1504 | |
| 1505 if (nargin > idx) | |
| 1506 prec = args(idx++); | |
| 2116 | 1507 |
| 4257 | 1508 if (nargin > idx) |
| 1509 skip = args(idx++); | |
| 1510 | |
| 1511 if (nargin > idx) | |
| 1512 arch = args(idx++); | |
|
7708
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1513 else if (skip.is_string ()) |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1514 { |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1515 arch = skip; |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1516 skip = 0; |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1517 } |
| 2116 | 1518 |
| 5275 | 1519 octave_idx_type count = -1; |
| 2116 | 1520 |
| 3340 | 1521 octave_value tmp = do_fread (os, size, prec, skip, arch, count); |
| 2116 | 1522 |
| 4233 | 1523 retval(1) = count; |
| 2116 | 1524 retval(0) = tmp; |
| 1525 } | |
| 1526 } | |
| 1527 else | |
| 5823 | 1528 print_usage (); |
| 2116 | 1529 |
| 529 | 1530 return retval; |
| 1531 } | |
| 1532 | |
| 2116 | 1533 static int |
| 1534 do_fwrite (octave_stream& os, const octave_value& data, | |
| 1535 const octave_value& prec_arg, const octave_value& skip_arg, | |
| 1536 const octave_value& arch_arg) | |
| 1537 { | |
| 1538 int retval = -1; | |
| 1539 | |
| 3523 | 1540 std::string prec = prec_arg.string_value (); |
| 2116 | 1541 |
| 1542 if (! error_state) | |
| 1543 { | |
| 4944 | 1544 int block_size = 1; |
| 1545 oct_data_conv::data_type output_type; | |
| 1546 | |
| 1547 oct_data_conv::string_to_data_type (prec, block_size, output_type); | |
| 2116 | 1548 |
| 1549 if (! error_state) | |
| 1550 { | |
| 3202 | 1551 int skip = skip_arg.int_value (true); |
| 2116 | 1552 |
| 1553 if (! error_state) | |
| 1554 { | |
| 3523 | 1555 std::string arch = arch_arg.string_value (); |
| 3202 | 1556 |
| 1557 if (! error_state) | |
| 2116 | 1558 { |
| 3202 | 1559 oct_mach_info::float_format flt_fmt |
| 1560 = oct_mach_info::string_to_float_format (arch); | |
| 2116 | 1561 |
| 1562 if (! error_state) | |
| 4944 | 1563 retval = os.write (data, block_size, output_type, |
| 1564 skip, flt_fmt); | |
| 2116 | 1565 } |
| 1566 else | |
| 3202 | 1567 ::error ("fwrite: architecture type must be a string"); |
| 2116 | 1568 } |
| 1569 else | |
| 3202 | 1570 ::error ("fwrite: skip must be an integer"); |
| 2116 | 1571 } |
| 3202 | 1572 else |
| 1573 ::error ("fwrite: invalid precision specified"); | |
| 2116 | 1574 } |
| 1575 else | |
| 1576 ::error ("fwrite: precision must be a string"); | |
| 1577 | |
| 1578 return retval; | |
| 1579 } | |
| 1580 | |
| 1581 DEFUN (fwrite, args, , | |
| 3372 | 1582 "-*- texinfo -*-\n\ |
| 1583 @deftypefn {Built-in Function} {@var{count} =} fwrite (@var{fid}, @var{data}, @var{precision}, @var{skip}, @var{arch})\n\ | |
| 1584 Write data in binary form of type @var{precision} to the specified file\n\ | |
| 1585 ID @var{fid}, returning the number of values successfully written to the\n\ | |
| 1586 file.\n\ | |
| 1181 | 1587 \n\ |
| 3372 | 1588 The argument @var{data} is a matrix of values that are to be written to\n\ |
| 1589 the file. The values are extracted in column-major order.\n\ | |
| 1181 | 1590 \n\ |
| 3372 | 1591 The remaining arguments @var{precision}, @var{skip}, and @var{arch} are\n\ |
| 1592 optional, and are interpreted as described for @code{fread}.\n\ | |
| 1181 | 1593 \n\ |
| 3372 | 1594 The behavior of @code{fwrite} is undefined if the values in @var{data}\n\ |
| 1595 are too large to fit in the specified precision.\n\ | |
| 5642 | 1596 @seealso{fread, fopen, fclose}\n\ |
| 1597 @end deftypefn") | |
| 1181 | 1598 { |
| 4233 | 1599 octave_value retval = -1; |
| 2116 | 1600 |
| 1601 int nargin = args.length (); | |
| 1602 | |
| 1603 if (nargin > 1 && nargin < 6) | |
| 1604 { | |
| 3341 | 1605 octave_stream os = octave_stream_list::lookup (args(0), "fwrite"); |
| 2116 | 1606 |
| 3341 | 1607 if (! error_state) |
| 2116 | 1608 { |
|
7708
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1609 octave_value prec = "uchar"; |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1610 octave_value skip = 0; |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1611 octave_value arch = "unknown"; |
| 2318 | 1612 |
|
7708
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1613 int idx = 1; |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1614 |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1615 octave_value data = args(idx++); |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1616 |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1617 if (nargin > idx) |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1618 prec = args(idx++); |
| 2318 | 1619 |
|
7708
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1620 if (nargin > idx) |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1621 skip = args(idx++); |
| 2318 | 1622 |
|
7708
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1623 if (nargin > idx) |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1624 arch = args(idx++); |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1625 else if (skip.is_string ()) |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1626 { |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1627 arch = skip; |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1628 skip = 0; |
|
b42abee70a98
fread, fwrite: allow SKIP arg to be omitted
John W. Eaton <jwe@octave.org>
parents:
7650
diff
changeset
|
1629 } |
| 2116 | 1630 |
| 3340 | 1631 double status = do_fwrite (os, data, prec, skip, arch); |
| 2825 | 1632 |
| 1633 retval = status; | |
| 2116 | 1634 } |
| 1635 } | |
| 1636 else | |
| 5823 | 1637 print_usage (); |
| 2116 | 1638 |
| 1181 | 1639 return retval; |
| 1640 } | |
| 1641 | |
| 5906 | 1642 DEFUNX ("feof", Ffeof, args, , |
| 3372 | 1643 "-*- texinfo -*-\n\ |
| 1644 @deftypefn {Built-in Function} {} feof (@var{fid})\n\ | |
| 1645 Return 1 if an end-of-file condition has been encountered for a given\n\ | |
| 1646 file and 0 otherwise. Note that it will only return 1 if the end of the\n\ | |
| 1647 file has already been encountered, not if the next read operation will\n\ | |
| 1648 result in an end-of-file condition.\n\ | |
| 5642 | 1649 @seealso{fread, fopen, fclose}\n\ |
| 1650 @end deftypefn") | |
| 529 | 1651 { |
| 4233 | 1652 octave_value retval = -1; |
| 529 | 1653 |
| 1654 int nargin = args.length (); | |
| 1655 | |
| 2095 | 1656 if (nargin == 1) |
| 1657 { | |
| 3341 | 1658 octave_stream os = octave_stream_list::lookup (args(0), "feof"); |
| 444 | 1659 |
| 3341 | 1660 if (! error_state) |
| 3340 | 1661 retval = os.eof () ? 1.0 : 0.0; |
| 2095 | 1662 } |
| 529 | 1663 else |
| 5823 | 1664 print_usage (); |
| 444 | 1665 |
| 1666 return retval; | |
| 1667 } | |
| 1668 | |
| 5906 | 1669 DEFUNX ("ferror", Fferror, args, , |
| 3372 | 1670 "-*- texinfo -*-\n\ |
| 1671 @deftypefn {Built-in Function} {} ferror (@var{fid})\n\ | |
| 1672 Return 1 if an error condition has been encountered for a given file\n\ | |
| 1673 and 0 otherwise. Note that it will only return 1 if an error has\n\ | |
| 1674 already been encountered, not if the next operation will result in an\n\ | |
| 1675 error condition.\n\ | |
| 1676 @end deftypefn") | |
| 1230 | 1677 { |
| 2095 | 1678 octave_value_list retval; |
| 1230 | 1679 |
| 2095 | 1680 int nargin = args.length (); |
| 1230 | 1681 |
| 2095 | 1682 if (nargin == 1 || nargin == 2) |
| 1683 { | |
| 3341 | 1684 octave_stream os = octave_stream_list::lookup (args(0), "ferror"); |
| 1230 | 1685 |
| 3341 | 1686 if (! error_state) |
| 2095 | 1687 { |
| 1688 bool clear = false; | |
| 1230 | 1689 |
| 2095 | 1690 if (nargin == 2) |
| 1691 { | |
| 3523 | 1692 std::string opt = args(1).string_value (); |
| 2095 | 1693 |
| 1694 if (! error_state) | |
| 1695 clear = (opt == "clear"); | |
| 1696 else | |
| 1697 return retval; | |
| 1698 } | |
| 1755 | 1699 |
| 2095 | 1700 int error_number = 0; |
| 1701 | |
| 3523 | 1702 std::string error_message = os.error (clear, error_number); |
| 1230 | 1703 |
| 4233 | 1704 retval(1) = error_number; |
| 2095 | 1705 retval(0) = error_message; |
| 1706 } | |
| 1230 | 1707 } |
| 2095 | 1708 else |
| 5823 | 1709 print_usage (); |
| 1230 | 1710 |
| 1711 return retval; | |
| 1712 } | |
| 1713 | |
| 1957 | 1714 DEFUN (popen, args, , |
| 3301 | 1715 "-*- texinfo -*-\n\ |
| 4326 | 1716 @deftypefn {Built-in Function} {@var{fid} =} popen (@var{command}, @var{mode})\n\ |
| 3301 | 1717 Start a process and create a pipe. The name of the command to run is\n\ |
| 1718 given by @var{command}. The file identifier corresponding to the input\n\ | |
| 1719 or output stream of the process is returned in @var{fid}. The argument\n\ | |
| 1720 @var{mode} may be\n\ | |
| 1721 \n\ | |
| 1722 @table @code\n\ | |
| 1723 @item \"r\"\n\ | |
| 1724 The pipe will be connected to the standard output of the process, and\n\ | |
| 1725 open for reading.\n\ | |
| 1230 | 1726 \n\ |
| 3301 | 1727 @item \"w\"\n\ |
| 1728 The pipe will be connected to the standard input of the process, and\n\ | |
| 1729 open for writing.\n\ | |
| 1730 @end table\n\ | |
| 1731 \n\ | |
| 1732 For example,\n\ | |
| 1230 | 1733 \n\ |
| 3301 | 1734 @example\n\ |
| 1735 @group\n\ | |
| 1736 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
|
1737 while (ischar (s = fgets (fid)))\n\ |
| 3301 | 1738 fputs (stdout, s);\n\ |
| 1739 endwhile\n\ | |
| 1740 @print{} drwxr-xr-x 33 root root 3072 Feb 15 13:28 etc\n\ | |
| 1741 @print{} drwxr-xr-x 3 root root 1024 Feb 15 13:28 lib\n\ | |
| 1742 @print{} drwxrwxrwt 15 root root 2048 Feb 17 14:53 tmp\n\ | |
| 1743 @end group\n\ | |
| 1744 @end example\n\ | |
| 1745 @end deftypefn") | |
| 1230 | 1746 { |
| 4233 | 1747 octave_value retval = -1; |
| 1230 | 1748 |
| 1749 int nargin = args.length (); | |
| 1750 | |
| 2095 | 1751 if (nargin == 2) |
| 1752 { | |
| 3523 | 1753 std::string name = args(0).string_value (); |
| 1230 | 1754 |
| 2095 | 1755 if (! error_state) |
| 1756 { | |
| 3523 | 1757 std::string mode = args(1).string_value (); |
| 1230 | 1758 |
| 2095 | 1759 if (! error_state) |
| 1760 { | |
| 1761 if (mode == "r") | |
| 1762 { | |
| 3340 | 1763 octave_stream ips = octave_iprocstream::create (name); |
| 1230 | 1764 |
| 2095 | 1765 retval = octave_stream_list::insert (ips); |
| 1766 } | |
| 1767 else if (mode == "w") | |
| 1768 { | |
| 3340 | 1769 octave_stream ops = octave_oprocstream::create (name); |
| 1230 | 1770 |
| 2095 | 1771 retval = octave_stream_list::insert (ops); |
| 1772 } | |
| 1773 else | |
| 1774 ::error ("popen: invalid mode specified"); | |
| 1775 } | |
| 1776 else | |
| 1777 ::error ("popen: mode must be a string"); | |
| 1778 } | |
| 1779 else | |
| 1780 ::error ("popen: name must be a string"); | |
| 1781 } | |
| 1230 | 1782 else |
| 5823 | 1783 print_usage (); |
| 1230 | 1784 |
| 1785 return retval; | |
| 1786 } | |
| 1787 | |
| 1957 | 1788 DEFUN (pclose, args, , |
| 3381 | 1789 "-*- texinfo -*-\n\ |
| 3301 | 1790 @deftypefn {Built-in Function} {} pclose (@var{fid})\n\ |
| 1791 Close a file identifier that was opened by @code{popen}. You may also\n\ | |
| 1792 use @code{fclose} for the same purpose.\n\ | |
| 1793 @end deftypefn") | |
| 1230 | 1794 { |
| 4233 | 1795 octave_value retval = -1; |
| 1230 | 1796 |
| 1797 int nargin = args.length (); | |
| 1798 | |
| 2095 | 1799 if (nargin == 1) |
| 4233 | 1800 retval = octave_stream_list::remove (args(0), "pclose"); |
| 1377 | 1801 else |
| 5823 | 1802 print_usage (); |
| 1379 | 1803 |
| 1804 return retval; | |
| 1805 } | |
| 1806 | |
| 2458 | 1807 DEFUN (tmpnam, args, , |
| 3372 | 1808 "-*- texinfo -*-\n\ |
| 4267 | 1809 @deftypefn {Built-in Function} {} tmpnam (@var{dir}, @var{prefix})\n\ |
| 3372 | 1810 Return a unique temporary file name as a string.\n\ |
| 1811 \n\ | |
| 4267 | 1812 If @var{prefix} is omitted, a value of @code{\"oct-\"} is used.\n\ |
| 1813 If @var{dir} is also omitted, the default directory for temporary files\n\ | |
| 1814 is used. If @var{dir} is provided, it must exist, otherwise the default\n\ | |
| 1815 directory for temporary files is used. Since the named file is not\n\ | |
| 1816 opened, by @code{tmpnam}, it is possible (though relatively unlikely)\n\ | |
| 1817 that it will not be available by the time your program attempts to open it.\n\ | |
| 5642 | 1818 @seealso{tmpfile, mkstemp, P_tmpdir}\n\ |
| 1819 @end deftypefn") | |
| 1802 | 1820 { |
| 2095 | 1821 octave_value retval; |
| 1802 | 1822 |
| 2936 | 1823 int len = args.length (); |
| 1824 | |
| 1825 if (len < 3) | |
| 1826 { | |
| 3523 | 1827 std::string dir = len > 0 ? args(0).string_value () : std::string (); |
| 2936 | 1828 |
| 1829 if (! error_state) | |
| 4267 | 1830 { |
| 1831 std::string pfx | |
| 1832 = len > 1 ? args(1).string_value () : std::string ("oct-"); | |
| 1833 | |
| 1834 if (! error_state) | |
| 1835 retval = file_ops::tempnam (dir, pfx); | |
| 1836 else | |
| 1837 ::error ("expecting second argument to be a string"); | |
| 1838 } | |
| 1839 else | |
| 1840 ::error ("expecting first argument to be a string"); | |
| 2936 | 1841 } |
| 1802 | 1842 else |
| 5823 | 1843 print_usage (); |
| 1802 | 1844 |
| 1845 return retval; | |
| 1846 } | |
| 1847 | |
| 2458 | 1848 DEFALIAS (octave_tmp_file_name, tmpnam); |
| 1849 | |
| 4326 | 1850 DEFUN (tmpfile, args, , |
| 1851 "-*- texinfo -*-\n\ | |
| 1852 @deftypefn {Built-in Function} {[@var{fid}, @var{msg}] =} tmpfile ()\n\ | |
| 1853 Return the file ID corresponding to a new temporary file with a unique\n\ | |
| 1854 name. The file is opened in binary read/write (@code{\"w+b\"}) mode.\n\ | |
| 1855 The file will be deleted automatically when it is closed or when Octave\n\ | |
| 1856 exits.\n\ | |
| 1857 \n\ | |
| 1858 If successful, @var{fid} is a valid file ID and @var{msg} is an empty\n\ | |
| 1859 string. Otherwise, @var{fid} is -1 and @var{msg} contains a\n\ | |
| 1860 system-dependent error message.\n\ | |
| 5642 | 1861 @seealso{tmpnam, mkstemp, P_tmpdir}\n\ |
| 1862 @end deftypefn") | |
| 4326 | 1863 { |
| 1864 octave_value_list retval; | |
| 1865 | |
| 1866 retval(1) = std::string (); | |
| 1867 retval(0) = -1; | |
| 1868 | |
| 1869 int nargin = args.length (); | |
| 1870 | |
| 1871 if (nargin == 0) | |
| 1872 { | |
| 1873 FILE *fid = tmpfile (); | |
| 1874 | |
| 1875 if (fid) | |
| 1876 { | |
| 1877 std::string nm; | |
| 1878 | |
| 1879 std::ios::openmode md = fopen_mode_to_ios_mode ("w+b"); | |
| 1880 | |
| 4327 | 1881 octave_stream s = octave_stdiostream::create (nm, fid, md); |
| 4326 | 1882 |
| 1883 if (s) | |
| 1884 retval(0) = octave_stream_list::insert (s); | |
| 1885 else | |
| 4327 | 1886 error ("tmpfile: failed to create octave_stdiostream object"); |
| 4326 | 1887 |
| 1888 } | |
| 1889 else | |
| 1890 { | |
| 1891 using namespace std; | |
| 1892 retval(1) = ::strerror (errno); | |
| 1893 retval(0) = -1; | |
| 1894 } | |
| 1895 } | |
| 1896 else | |
| 5823 | 1897 print_usage (); |
| 4326 | 1898 |
| 1899 return retval; | |
| 1900 } | |
| 1901 | |
| 1902 DEFUN (mkstemp, args, , | |
| 1903 "-*- texinfo -*-\n\ | |
| 5109 | 1904 @deftypefn {Built-in Function} {[@var{fid}, @var{name}, @var{msg}] =} mkstemp (@var{template}, @var{delete})\n\ |
| 4326 | 1905 Return the file ID corresponding to a new temporary file with a unique\n\ |
| 1906 name created from @var{template}. The last six characters of @var{template}\n\ | |
| 5016 | 1907 must be @code{XXXXXX} and these are replaced with a string that makes the\n\ |
| 4326 | 1908 filename unique. The file is then created with mode read/write and\n\ |
| 1909 permissions that are system dependent (on GNU/Linux systems, the permissions\n\ | |
| 1910 will be 0600 for versions of glibc 2.0.7 and later). The file is opened\n\ | |
| 1911 with the @code{O_EXCL} flag.\n\ | |
| 1912 \n\ | |
| 1913 If the optional argument @var{delete} is supplied and is true,\n\ | |
| 1914 the file will be deleted automatically when Octave exits, or when\n\ | |
| 1915 the function @code{purge_tmp_files} is called.\n\ | |
| 1916 \n\ | |
| 1917 If successful, @var{fid} is a valid file ID, @var{name} is the name of\n\ | |
| 7001 | 1918 the file, and @var{msg} is an empty string. Otherwise, @var{fid}\n\ |
| 4326 | 1919 is -1, @var{name} is empty, and @var{msg} contains a system-dependent\n\ |
| 1920 error message.\n\ | |
| 5642 | 1921 @seealso{tmpfile, tmpnam, P_tmpdir}\n\ |
| 1922 @end deftypefn") | |
| 4326 | 1923 { |
| 1924 octave_value_list retval; | |
| 1925 | |
| 1926 retval(2) = std::string (); | |
| 1927 retval(1) = std::string (); | |
| 1928 retval(0) = -1; | |
| 1929 | |
| 1930 #if defined (HAVE_MKSTEMP) | |
| 1931 | |
| 1932 int nargin = args.length (); | |
| 1933 | |
| 1934 if (nargin == 1 || nargin == 2) | |
| 1935 { | |
| 1936 std::string tmpl8 = args(0).string_value (); | |
| 1937 | |
| 1938 if (! error_state) | |
| 1939 { | |
| 4354 | 1940 OCTAVE_LOCAL_BUFFER (char, tmp, tmpl8.size () + 1); |
| 1941 strcpy (tmp, tmpl8.c_str ()); | |
| 4326 | 1942 |
| 1943 int fd = mkstemp (tmp); | |
| 1944 | |
| 1945 if (fd < 0) | |
| 1946 { | |
| 1947 using namespace std; | |
| 5109 | 1948 retval(2) = ::strerror (errno); |
| 4326 | 1949 retval(0) = fd; |
| 1950 } | |
| 1951 else | |
| 1952 { | |
| 1953 const char *fopen_mode = "w+"; | |
| 1954 | |
| 1955 FILE *fid = fdopen (fd, fopen_mode); | |
| 1956 | |
| 1957 if (fid) | |
| 1958 { | |
| 1959 std::string nm = tmp; | |
| 1960 | |
| 1961 std::ios::openmode md = fopen_mode_to_ios_mode (fopen_mode); | |
| 1962 | |
| 4327 | 1963 octave_stream s = octave_stdiostream::create (nm, fid, md); |
| 4326 | 1964 |
| 1965 if (s) | |
| 1966 { | |
| 1967 retval(1) = nm; | |
| 1968 retval(0) = octave_stream_list::insert (s); | |
| 1969 | |
| 5401 | 1970 if (nargin == 2 && args(1).is_true ()) |
| 4326 | 1971 mark_for_deletion (nm); |
| 1972 } | |
| 1973 else | |
| 4327 | 1974 error ("mkstemp: failed to create octave_stdiostream object"); |
| 4326 | 1975 } |
| 1976 else | |
| 1977 { | |
| 1978 using namespace std; | |
| 5109 | 1979 retval(2) = ::strerror (errno); |
| 4326 | 1980 retval(0) = -1; |
| 1981 } | |
| 1982 } | |
| 1983 } | |
| 1984 else | |
| 1985 error ("mkstemp: expecting string as first argument"); | |
| 1986 } | |
| 1987 else | |
| 5823 | 1988 print_usage (); |
| 4326 | 1989 |
| 1990 #else | |
| 1991 retval(2) = "mkstemp: not supported on this sytem"; | |
| 1992 #endif | |
| 1993 | |
| 1994 return retval; | |
| 1995 } | |
| 1996 | |
| 1400 | 1997 static int |
| 1998 convert (int x, int ibase, int obase) | |
| 1999 { | |
| 2000 int retval = 0; | |
| 2001 | |
| 2002 int tmp = x % obase; | |
| 2003 | |
| 2004 if (tmp > ibase - 1) | |
| 2095 | 2005 ::error ("umask: invalid digit"); |
| 1400 | 2006 else |
| 2007 { | |
| 2008 retval = tmp; | |
| 2009 int mult = ibase; | |
| 2010 while ((x = (x - tmp) / obase)) | |
| 2011 { | |
| 2012 tmp = x % obase; | |
| 2013 if (tmp > ibase - 1) | |
| 2014 { | |
| 2095 | 2015 ::error ("umask: invalid digit"); |
| 1400 | 2016 break; |
| 2017 } | |
| 2018 retval += mult * tmp; | |
| 2019 mult *= ibase; | |
| 2020 } | |
| 2021 } | |
| 2022 | |
| 2023 return retval; | |
| 2024 } | |
| 2025 | |
| 1957 | 2026 DEFUN (umask, args, , |
| 3301 | 2027 "-*- texinfo -*-\n\ |
| 2028 @deftypefn {Built-in Function} {} umask (@var{mask})\n\ | |
| 2029 Set the permission mask for file creation. The parameter @var{mask}\n\ | |
| 4715 | 2030 is an integer, interpreted as an octal number. If successful,\n\ |
| 2031 returns the previous value of the mask (as an integer to be\n\ | |
| 2032 interpreted as an octal number); otherwise an error message is printed.\n\ | |
| 3301 | 2033 @end deftypefn") |
| 1400 | 2034 { |
| 2095 | 2035 octave_value_list retval; |
| 1400 | 2036 |
| 2037 int status = 0; | |
| 2038 | |
| 2039 if (args.length () == 1) | |
| 2040 { | |
| 3202 | 2041 int mask = args(0).int_value (true); |
| 1400 | 2042 |
| 3202 | 2043 if (! error_state) |
| 1400 | 2044 { |
| 3202 | 2045 if (mask < 0) |
| 1400 | 2046 { |
| 2047 status = -1; | |
| 2095 | 2048 ::error ("umask: MASK must be a positive integer value"); |
| 1400 | 2049 } |
| 2050 else | |
| 2051 { | |
| 2052 int oct_mask = convert (mask, 8, 10); | |
| 2053 | |
| 2054 if (! error_state) | |
| 2926 | 2055 status = convert (file_ops::umask (oct_mask), 10, 8); |
| 1400 | 2056 } |
| 2057 } | |
| 3202 | 2058 else |
| 2059 { | |
| 2060 status = -1; | |
| 2061 ::error ("umask: expecting integer argument"); | |
| 2062 } | |
| 1400 | 2063 } |
| 2064 else | |
| 5823 | 2065 print_usage (); |
| 1400 | 2066 |
| 2067 if (status >= 0) | |
| 4233 | 2068 retval(0) = status; |
| 1400 | 2069 |
| 2070 return retval; | |
| 2071 } | |
| 2072 | |
| 5749 | 2073 static octave_value |
| 6483 | 2074 const_value (const char *, const octave_value_list& args, int val) |
| 2189 | 2075 { |
| 5749 | 2076 octave_value retval; |
| 2077 | |
| 2078 int nargin = args.length (); | |
| 2079 | |
| 2080 if (nargin == 0) | |
| 2081 retval = val; | |
| 2082 else | |
| 5823 | 2083 print_usage (); |
| 5749 | 2084 |
| 2085 return retval; | |
| 2086 } | |
| 2087 | |
| 4267 | 2088 #if ! defined (P_tmpdir) |
| 2089 #define P_tmpdir "/tmp" | |
| 2090 #endif | |
| 2091 | |
| 5749 | 2092 DEFUNX ("P_tmpdir", FP_tmpdir, args, , |
| 2093 "-*- texinfo -*-\n\ | |
| 2094 @deftypefn {Built-in Function} {} P_tmpdir ()\n\ | |
| 2095 Return the default name of the directory for temporary files on\n\ | |
| 2096 this system. The name of this directory is system dependent.\n\ | |
| 2097 @end deftypefn") | |
| 2098 { | |
| 2099 octave_value retval; | |
| 2100 | |
| 2101 int nargin = args.length (); | |
| 4267 | 2102 |
| 5749 | 2103 if (nargin == 0) |
| 2104 retval = P_tmpdir; | |
| 2105 else | |
| 5823 | 2106 print_usage (); |
| 5749 | 2107 |
| 2108 return retval; | |
| 2109 } | |
| 2341 | 2110 |
| 5749 | 2111 // NOTE: the values of SEEK_SET, SEEK_CUR, and SEEK_END have to be |
| 2112 // this way for Matlab compatibility. | |
| 2113 | |
| 2114 DEFUNX ("SEEK_SET", FSEEK_SET, args, , | |
| 2115 "-*- texinfo -*-\n\ | |
| 2116 @deftypefn {Built-in Function} {} SEEK_SET ()\n\ | |
| 2117 @deftypefnx {Built-in Function} {} SEEK_CUR ()\n\ | |
| 2118 @deftypefnx {Built-in Function} {} SEEK_END ()\n\ | |
| 2119 Return the value required to request that @code{fseek} perform\n\ | |
| 2120 one of the following actions:\n\ | |
| 3372 | 2121 @table @code\n\ |
| 2122 @item SEEK_SET\n\ | |
| 2123 Position file relative to the beginning.\n\ | |
| 2124 \n\ | |
| 2125 @item SEEK_CUR\n\ | |
| 2126 Position file relative to the current position.\n\ | |
| 2127 \n\ | |
| 2128 @item SEEK_END\n\ | |
| 5749 | 2129 Position file relative to the end.\n\ |
| 3372 | 2130 @end table\n\ |
| 5749 | 2131 @end deftypefn") |
| 2132 { | |
| 2133 return const_value ("SEEK_SET", args, -1); | |
| 2134 } | |
| 2189 | 2135 |
| 5749 | 2136 DEFUNX ("SEEK_CUR", FSEEK_CUR, args, , |
| 2137 "-*- texinfo -*-\n\ | |
| 2138 @deftypefn {Built-in Function} {} SEEK_CUR ()\n\ | |
| 3458 | 2139 See SEEK_SET.\n\ |
| 5749 | 2140 @end deftypefn") |
| 2141 { | |
| 2142 return const_value ("SEEK_CUR", args, 0); | |
| 2143 } | |
| 2189 | 2144 |
| 5749 | 2145 DEFUNX ("SEEK_END", FSEEK_END, args, , |
| 2146 "-*- texinfo -*-\n\ | |
| 2147 @deftypefn {Built-in Function} {} SEEK_END ()\n\ | |
| 3458 | 2148 See SEEK_SET.\n\ |
| 5749 | 2149 @end deftypefn") |
| 2150 { | |
| 2151 return const_value ("SEEK_END", args, 1); | |
| 2152 } | |
| 2153 | |
| 2154 static octave_value | |
| 6483 | 2155 const_value (const char *, const octave_value_list& args, |
| 5749 | 2156 const octave_value& val) |
| 2157 { | |
| 2158 octave_value retval; | |
| 2159 | |
| 2160 int nargin = args.length (); | |
| 2189 | 2161 |
| 5749 | 2162 if (nargin == 0) |
| 2163 retval = val; | |
| 2164 else | |
| 5823 | 2165 print_usage (); |
| 5749 | 2166 |
| 2167 return retval; | |
| 2168 } | |
| 2169 | |
| 2170 DEFUNX ("stdin", Fstdin, args, , | |
| 2171 "-*- texinfo -*-\n\ | |
| 2172 @deftypefn {Built-in Function} {} stdin ()\n\ | |
| 2173 Return the numeric value corresponding to the standard input stream.\n\ | |
| 2174 When Octave is used interactively, this is filtered through the command\n\ | |
| 2175 line editing functions.\n\ | |
| 5333 | 2176 @seealso{stdout, stderr}\n\ |
| 5749 | 2177 @end deftypefn") |
| 2178 { | |
| 2179 return const_value ("stdin", args, stdin_file); | |
| 2180 } | |
| 2189 | 2181 |
| 5749 | 2182 DEFUNX ("stdout", Fstdout, args, , |
| 2183 "-*- texinfo -*-\n\ | |
| 2184 @deftypefn {Built-in Function} {} stdout ()\n\ | |
| 2185 Return the numeric value corresponding to the standard output stream.\n\ | |
| 2186 Data written to the standard output is normally filtered through the pager.\n\ | |
| 5333 | 2187 @seealso{stdin, stderr}\n\ |
| 5749 | 2188 @end deftypefn") |
| 2189 { | |
| 2190 return const_value ("stdout", args, stdout_file); | |
| 2191 } | |
| 2189 | 2192 |
| 5749 | 2193 DEFUNX ("stderr", Fstderr, args, , |
| 2194 "-*- texinfo -*-\n\ | |
| 2195 @deftypefn {Built-in Function} {} stderr ()\n\ | |
| 2196 Return the numeric value corresponding to the standard error stream.\n\ | |
| 2197 Even if paging is turned on, the standard error is not sent to the\n\ | |
| 2198 pager. It is useful for error messages and prompts.\n\ | |
| 5333 | 2199 @seealso{stdin, stdout}\n\ |
| 5749 | 2200 @end deftypefn") |
| 2201 { | |
| 2202 return const_value ("stderr", args, stderr_file); | |
| 2189 | 2203 } |
| 2204 | |
| 444 | 2205 /* |
| 1 | 2206 ;;; Local Variables: *** |
| 2207 ;;; mode: C++ *** | |
| 2208 ;;; End: *** | |
| 2209 */ |