octave: libinterp/corefcn/file-io.cc annotate

annotate libinterp/corefcn/file-io.cc @ 26378:3f3677540634 stable

file-io.cc: Fix static analyzer detected V595 issue (bug #55347)

author	Andreas Weber <octave@josoansi.de>
date	Wed, 02 Jan 2019 22:46:05 +0100
parents	00f796120a6d
children	c18e59476795

rev	line source
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	1 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	2
26376 00f796120a6d maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 25649 diff changeset	3 Copyright (C) 1993-2019 John W. Eaton
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	4
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	6
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24516 diff changeset	7 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22737 diff changeset	8 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24516 diff changeset	9 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22737 diff changeset	10 (at your option) any later version.
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22737 diff changeset	11
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22737 diff changeset	12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22737 diff changeset	13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22737 diff changeset	14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22737 diff changeset	15 GNU General Public License for more details.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	16
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	17 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	18 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24516 diff changeset	19 <https://www.gnu.org/licenses/>.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	20
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	21 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	22
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	23 // Originally written by John C. Campbell <jcc@bevo.che.wisc.edu>
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	24 //
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	25 // Thomas Baier <baier@ci.tuwien.ac.at> added the original versions of
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	26 // the following functions:
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	27 //
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	28 // popen
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	29 // pclose
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	30 // execute (now popen2.m)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	31 // sync_system (now merged with system)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	32 // async_system (now merged with system)
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	33
9322 66fdc831c580 fix jwe email address John W. Eaton <jwe@octave.org> parents: 9236 diff changeset	34 // Extensively revised by John W. Eaton <jwe@octave.org>,
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	35 // April 1996.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	36
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21634 diff changeset	37 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	38 # include "config.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	39 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	40
4797 19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe] jwe parents: 4726 diff changeset	41 #include <cerrno>
19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe] jwe parents: 4726 diff changeset	42 #include <cstdio>
1343 94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1339 diff changeset	43
25438 cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	44 #include <iomanip>
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7097 diff changeset	45 #include <stack>
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	46 #include <string>
4726 14dc2267c343 [project @ 2004-01-23 20:04:35 by jwe] jwe parents: 4715 diff changeset	47 #include <vector>
1350 5f63d83dd694 [project @ 1995-09-05 07:37:59 by jwe] jwe parents: 1343 diff changeset	48
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21634 diff changeset	49 #if defined (HAVE_ZLIB_H)
21200 fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp. Rik <rik@octave.org> parents: 21127 diff changeset	50 # include <zlib.h>
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5320 diff changeset	51 #endif
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5320 diff changeset	52
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2902 diff changeset	53 #include "file-ops.h"
6159 645605133a6f [project @ 2006-11-14 02:55:05 by jwe] jwe parents: 6108 diff changeset	54 #include "file-stat.h"
5102 b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	55 #include "lo-ieee.h"
21888 00f1249f2483 create wrappers for some gnulib functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	56 #include "mkostemp-wrapper.h"
6159 645605133a6f [project @ 2006-11-14 02:55:05 by jwe] jwe parents: 6108 diff changeset	57 #include "oct-env.h"
8377 25bc2d31e1bf improve OCTAVE_LOCAL_BUFFER Jaroslav Hajek <highegg@gmail.com> parents: 8021 diff changeset	58 #include "oct-locbuf.h"
21991 80659e58609f provide wrapper for tmpfile (bug #48337) John W. Eaton <jwe@octave.org> parents: 21966 diff changeset	59 #include "tmpfile-wrapper.h"
21919 473414a91539 * file-io.cc (cleanup_tmp_files): Use octave_unlink_wrapper. John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	60 #include "unistd-wrappers.h"
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2902 diff changeset	61
23454 30b6eccd6708 use builtin-defun-decls.h to ensure declarations of interpreter functions John W. Eaton <jwe@octave.org> parents: 23450 diff changeset	62 #include "builtin-defun-decls.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	63 #include "defun.h"
23454 30b6eccd6708 use builtin-defun-decls.h to ensure declarations of interpreter functions John W. Eaton <jwe@octave.org> parents: 23450 diff changeset	64 #include "error.h"
21126 ba0a4b4f021d include errwarn.h in files that use err_disabled_feature conditionally John W. Eaton <jwe@octave.org> parents: 21109 diff changeset	65 #include "errwarn.h"
6108 143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 6053 diff changeset	66 #include "file-io.h"
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	67 #include "interpreter.h"
6159 645605133a6f [project @ 2006-11-14 02:55:05 by jwe] jwe parents: 6108 diff changeset	68 #include "load-path.h"
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	69 #include "oct-fstrm.h"
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	70 #include "oct-iostrm.h"
1377 44f5d41ff757 [project @ 1995-09-12 00:07:58 by jwe] jwe parents: 1363 diff changeset	71 #include "oct-map.h"
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	72 #include "oct-prcstrm.h"
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	73 #include "oct-stream.h"
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	74 #include "oct-strstrm.h"
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	75 #include "ov.h"
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	76 #include "ovl.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	77 #include "pager.h"
444 ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	78 #include "sysdep.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	79 #include "utils.h"
2370 a45c7d64b5e3 [project @ 1996-10-11 23:51:15 by jwe] jwe parents: 2341 diff changeset	80 #include "variables.h"
1583 5383d2d4cf9d [project @ 1995-10-27 08:51:20 by jwe] jwe parents: 1488 diff changeset	81
5102 b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	82 // List of files to delete when we exit or crash.
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	83 //
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	84 // FIXME: this should really be static,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	85 // but that causes problems on some systems.
5102 b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	86 std::stack <std::string> tmp_files;
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	87
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	88 void
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	89 mark_for_deletion (const std::string& file)
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	90 {
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	91 tmp_files.push (file);
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	92 }
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	93
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	94 void
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	95 cleanup_tmp_files (void)
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	96 {
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	97 while (! tmp_files.empty ())
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	98 {
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	99 std::string filename = tmp_files.top ();
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	100 tmp_files.pop ();
21919 473414a91539 * file-io.cc (cleanup_tmp_files): Use octave_unlink_wrapper. John W. Eaton <jwe@octave.org> parents: 21911 diff changeset	101 octave_unlink_wrapper (filename.c_str ());
5102 b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	102 }
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	103 }
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe] jwe parents: 5095 diff changeset	104
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	105 static void
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	106 normalize_fopen_mode (std::string& mode, bool& use_zlib)
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	107 {
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	108 use_zlib = false;
896 4a2133b26fa7 [project @ 1994-11-09 16:04:06 by jwe] jwe parents: 870 diff changeset	109
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	110 if (! mode.empty ())
368 5c987c27f3d7 [project @ 1994-02-16 08:33:09 by jwe] jwe parents: 367 diff changeset	111 {
24418 c23b9af6a664 Remove warnings about 'W', 'A', and 'R' modes in fopen (bug #52644). Rik <rik@octave.org> parents: 24417 diff changeset	112 // Matlab uses 'A' and 'W' to indicate that buffered writing should
c23b9af6a664 Remove warnings about 'W', 'A', and 'R' modes in fopen (bug #52644). Rik <rik@octave.org> parents: 24417 diff changeset	113 // take place. Octave already does that. Theoretically, we should
c23b9af6a664 Remove warnings about 'W', 'A', and 'R' modes in fopen (bug #52644). Rik <rik@octave.org> parents: 24417 diff changeset	114 // warn about using 'a', 'r', or 'w' because Octave does not enable
c23b9af6a664 Remove warnings about 'W', 'A', and 'R' modes in fopen (bug #52644). Rik <rik@octave.org> parents: 24417 diff changeset	115 // automatic flushing with these modes. The performance hit is ~4X
c23b9af6a664 Remove warnings about 'W', 'A', and 'R' modes in fopen (bug #52644). Rik <rik@octave.org> parents: 24417 diff changeset	116 // when using automatic flushing and seems completely unnecessary.
c23b9af6a664 Remove warnings about 'W', 'A', and 'R' modes in fopen (bug #52644). Rik <rik@octave.org> parents: 24417 diff changeset	117 // See bug #52644.
7078 405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7017 diff changeset	118
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7017 diff changeset	119 size_t pos = mode.find ('W');
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7017 diff changeset	120
8021 85184151822e fix typo in NPOS change John W. Eaton <jwe@octave.org> parents: 8019 diff changeset	121 if (pos != std::string::npos)
24418 c23b9af6a664 Remove warnings about 'W', 'A', and 'R' modes in fopen (bug #52644). Rik <rik@octave.org> parents: 24417 diff changeset	122 mode[pos] = 'w';
7078 405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7017 diff changeset	123
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7017 diff changeset	124 pos = mode.find ('R');
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7017 diff changeset	125
8021 85184151822e fix typo in NPOS change John W. Eaton <jwe@octave.org> parents: 8019 diff changeset	126 if (pos != std::string::npos)
24418 c23b9af6a664 Remove warnings about 'W', 'A', and 'R' modes in fopen (bug #52644). Rik <rik@octave.org> parents: 24417 diff changeset	127 mode[pos] = 'r';
7078 405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7017 diff changeset	128
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	129 pos = mode.find ('A');
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	130
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	131 if (pos != std::string::npos)
24418 c23b9af6a664 Remove warnings about 'W', 'A', and 'R' modes in fopen (bug #52644). Rik <rik@octave.org> parents: 24417 diff changeset	132 mode[pos] = 'a';
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	133
7078 405cf85b435c [project @ 2007-10-30 14:04:59 by jwe] jwe parents: 7017 diff changeset	134 pos = mode.find ('z');
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5320 diff changeset	135
8021 85184151822e fix typo in NPOS change John W. Eaton <jwe@octave.org> parents: 8019 diff changeset	136 if (pos != std::string::npos)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	137 {
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5320 diff changeset	138 #if defined (HAVE_ZLIB)
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	139 use_zlib = true;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	140 mode.erase (pos, 1);
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5320 diff changeset	141 #else
21109 bd1752782e56 Use err_disabled_feature, warn_disabled_feature throughout code base. Rik <rik@octave.org> parents: 21078 diff changeset	142 err_disabled_feature ("", "gzipped files (zlib)");
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5320 diff changeset	143 #endif
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	144 }
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5320 diff changeset	145
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	146 // Use binary mode if 't' is not specified, but don't add
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	147 // 'b' if it is already present.
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	148
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	149 size_t bpos = mode.find ('b');
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	150 size_t tpos = mode.find ('t');
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	151
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	152 if (bpos == std::string::npos && tpos == std::string::npos)
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	153 mode += 'b';
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	154 }
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	155 }
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	156
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	157 static std::ios::openmode
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	158 fopen_mode_to_ios_mode (const std::string& mode)
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	159 {
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	160 std::ios::openmode retval = std::ios::in;
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	161
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	162 if (mode == "rt")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	163 retval = std::ios::in;
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	164 else if (mode == "wt")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	165 retval = std::ios::out \| std::ios::trunc;
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	166 else if (mode == "at")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	167 retval = std::ios::out \| std::ios::app;
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	168 else if (mode == "r+t" \|\| mode == "rt+")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	169 retval = std::ios::in \| std::ios::out;
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	170 else if (mode == "w+t" \|\| mode == "wt+")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	171 retval = std::ios::in \| std::ios::out \| std::ios::trunc;
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	172 else if (mode == "a+t" \|\| mode == "at+")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	173 retval = std::ios::in \| std::ios::out \| std::ios::app;
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	174 else if (mode == "rb" \|\| mode == "r")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	175 retval = std::ios::in \| std::ios::binary;
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	176 else if (mode == "wb" \|\| mode == "w")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	177 retval = std::ios::out \| std::ios::trunc \| std::ios::binary;
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	178 else if (mode == "ab" \|\| mode == "a")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	179 retval = std::ios::out \| std::ios::app \| std::ios::binary;
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	180 else if (mode == "r+b" \|\| mode == "rb+" \|\| mode == "r+")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	181 retval = std::ios::in \| std::ios::out \| std::ios::binary;
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	182 else if (mode == "w+b" \|\| mode == "wb+" \|\| mode == "w+")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	183 retval = (std::ios::in \| std::ios::out \| std::ios::trunc
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	184 \| std::ios::binary);
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	185 else if (mode == "a+b" \|\| mode == "ab+" \|\| mode == "a+")
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	186 retval = (std::ios::in \| std::ios::out \| std::ios::app
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	187 \| std::ios::binary);
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	188 else
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	189 error ("invalid mode specified");
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	190
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	191 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	192 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	193
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	194 DEFMETHOD (fclose, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	195 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	196 @deftypefn {} {} fclose (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	197 @deftypefnx {} {} fclose ("all")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	198 @deftypefnx {} {@var{status} =} fclose ("all")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	199 Close the file specified by the file descriptor @var{fid}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	200
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	201 If successful, @code{fclose} returns 0, otherwise, it returns -1. The
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	202 second form of the @code{fclose} call closes all open files except
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	203 @code{stdin}, @code{stdout}, @code{stderr}, and any FIDs associated
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	204 with gnuplot.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	205 @seealso{fopen, fflush, freport}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	206 @end deftypefn */)
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	207 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	208 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	209 print_usage ();
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	210
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	211 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	212
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	213 return ovl (streams.remove (args(0), "fclose"));
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	214 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	215
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	216 DEFMETHOD (fclear, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	217 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	218 @deftypefn {} {} fclear (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	219 Clear the stream state for the file specified by the file descriptor
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	220 @var{fid}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	221 @seealso{ferror, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	222 @end deftypefn */)
5144 25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe] jwe parents: 5109 diff changeset	223 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	224 if (args.length () != 1)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	225 print_usage ();
5144 25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe] jwe parents: 5109 diff changeset	226
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	227 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	228
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	229 int fid = streams.get_file_number (args(0));
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	230
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	231 octave::stream os = streams.lookup (fid, "fclear");
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	232
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	233 os.clearerr ();
5144 25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe] jwe parents: 5109 diff changeset	234
20941 a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()". Rik <rik@octave.org> parents: 20940 diff changeset	235 return ovl ();
5144 25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe] jwe parents: 5109 diff changeset	236 }
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe] jwe parents: 5109 diff changeset	237
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	238 DEFMETHOD (fflush, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	239 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	240 @deftypefn {} {} fflush (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	241 Flush output to file descriptor @var{fid}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	242
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	243 @code{fflush} returns 0 on success and an OS dependent error value
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	244 (@minus{}1 on Unix) on error.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	245
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	246 Programming Note: Flushing is useful for ensuring that all pending output
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	247 makes it to the screen before some other event occurs. For example, it is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	248 always a good idea to flush the standard output stream before calling
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	249 @code{input}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	250 @seealso{fopen, fclose}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	251 @end deftypefn */)
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	252 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	253 if (args.length () != 1)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	254 print_usage ();
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	255
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	256 octave_value retval = -1;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	257
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	258 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	259
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	260 // FIXME: any way to avoid special case for stdout?
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	261 int fid = streams.get_file_number (args(0));
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	262
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	263 if (fid == 1)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	264 {
23060 baf03cdb28b5 move pager and diary classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23059 diff changeset	265 octave::flush_stdout ();
2609 12bc9d0a50b5 [project @ 1997-01-18 00:17:36 by jwe] jwe parents: 2599 diff changeset	266
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	267 retval = 0;
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	268 }
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	269 else
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	270 {
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	271 octave::stream os = streams.lookup (fid, "fflush");
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	272
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	273 retval = os.flush ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	274 }
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	275
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	276 return retval;
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	277 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	278
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	279 DEFMETHOD (fgetl, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	280 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	281 @deftypefn {} {@var{str} =} fgetl (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	282 @deftypefnx {} {@var{str} =} fgetl (@var{fid}, @var{len})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	283 Read characters from a file, stopping after a newline, or EOF,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	284 or @var{len} characters have been read.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	285
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	286 The characters read, excluding the possible trailing newline, are returned
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	287 as a string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	288
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	289 If @var{len} is omitted, @code{fgetl} reads until the next newline
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	290 character.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	291
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	292 If there are no more characters to read, @code{fgetl} returns @minus{}1.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	293
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	294 To read a line and return the terminating newline see @code{fgets}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	295 @seealso{fgets, fscanf, fread, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	296 @end deftypefn */)
1339 e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe] jwe parents: 1338 diff changeset	297 {
4468 efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe] jwe parents: 4388 diff changeset	298 static std::string who = "fgetl";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe] jwe parents: 4388 diff changeset	299
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	300 int nargin = args.length ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	301
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	302 if (nargin < 1 \|\| nargin > 2)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	303 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	304
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	305 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	306
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	307 octave::stream os = streams.lookup (args(0), who);
1339 e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe] jwe parents: 1338 diff changeset	308
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	309 octave_value len_arg = (nargin == 2) ? args(1) : octave_value ();
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	310
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	311 bool err = false;
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	312
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	313 std::string tmp = os.getl (len_arg, err, who);
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	314
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	315 if (! err)
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	316 return ovl (tmp, tmp.length ());
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	317 else
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	318 return ovl (-1, 0);
1339 e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe] jwe parents: 1338 diff changeset	319 }
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe] jwe parents: 1338 diff changeset	320
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	321 DEFMETHOD (fgets, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	322 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	323 @deftypefn {} {@var{str} =} fgets (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	324 @deftypefnx {} {@var{str} =} fgets (@var{fid}, @var{len})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	325 Read characters from a file, stopping after a newline, or EOF,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	326 or @var{len} characters have been read.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	327
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	328 The characters read, including the possible trailing newline, are returned
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	329 as a string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	330
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	331 If @var{len} is omitted, @code{fgets} reads until the next newline
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	332 character.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	333
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	334 If there are no more characters to read, @code{fgets} returns @minus{}1.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	335
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	336 To read a line and discard the terminating newline see @code{fgetl}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	337 @seealso{fputs, fgetl, fscanf, fread, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	338 @end deftypefn */)
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	339 {
4468 efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe] jwe parents: 4388 diff changeset	340 static std::string who = "fgets";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe] jwe parents: 4388 diff changeset	341
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	342 int nargin = args.length ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	343
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	344 if (nargin < 1 \|\| nargin > 2)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	345 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	346
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	347 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	348
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	349 octave::stream os = streams.lookup (args(0), who);
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	350
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	351 octave_value len_arg = (nargin == 2) ? args(1) : octave_value ();
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	352
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	353 bool err = false;
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	354
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	355 std::string tmp = os.gets (len_arg, err, who);
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	356
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	357 if (! err)
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	358 return ovl (tmp, tmp.length ());
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	359 else
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	360 return ovl (-1.0, 0.0);
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	361 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	362
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	363 DEFMETHOD (fskipl, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	364 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	365 @deftypefn {} {@var{nlines} =} fskipl (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	366 @deftypefnx {} {@var{nlines} =} fskipl (@var{fid}, @var{count})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	367 @deftypefnx {} {@var{nlines} =} fskipl (@var{fid}, Inf)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	368 Read and skip @var{count} lines from the file specified by the file
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	369 descriptor @var{fid}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	370
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	371 @code{fskipl} discards characters until an end-of-line is encountered
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	372 exactly @var{count}-times, or until the end-of-file marker is found.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	373
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	374 If @var{count} is omitted, it defaults to 1. @var{count} may also be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	375 @code{Inf}, in which case lines are skipped until the end of the file.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	376 This form is suitable for counting the number of lines in a file.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	377
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	378 Returns the number of lines skipped (end-of-line sequences encountered).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	379 @seealso{fgetl, fgets, fscanf, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	380 @end deftypefn */)
9701 531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	381 {
531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	382 static std::string who = "fskipl";
531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	383
531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	384 int nargin = args.length ();
531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	385
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	386 if (nargin < 1 \|\| nargin > 2)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	387 print_usage ();
9701 531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	388
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	389 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	390
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	391 octave::stream os = streams.lookup (args(0), who);
9701 531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	392
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	393 octave_value count_arg = (nargin == 2) ? args(1) : octave_value ();
9701 531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	394
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	395 bool err = false;
9701 531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	396
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	397 off_t tmp = os.skipl (count_arg, err, who);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	398
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	399 if (! err)
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	400 return ovl (tmp);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	401 else
20941 a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()". Rik <rik@octave.org> parents: 20940 diff changeset	402 return ovl ();
9701 531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	403 }
531280b07625 implement fskipl Jaroslav Hajek <highegg@gmail.com> parents: 9322 diff changeset	404
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	405 static octave::stream
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	406 do_stream_open (const std::string& name, const std::string& mode_arg,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	407 const std::string& arch, int& fid)
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	408 {
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	409 octave::stream retval;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	410
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	411 fid = -1;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	412
16590 2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	413 std::string mode = mode_arg;
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	414 bool use_zlib = false;
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	415 normalize_fopen_mode (mode, use_zlib);
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851) John W. Eaton <jwe@octave.org> parents: 16308 diff changeset	416
4036 1432e11733d1 [project @ 2002-08-12 18:38:40 by jwe] jwe parents: 4028 diff changeset	417 std::ios::openmode md = fopen_mode_to_ios_mode (mode);
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	418
21739 c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	419 octave::mach_info::float_format flt_fmt =
c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	420 octave::mach_info::string_to_float_format (arch);
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	421
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	422 std::string fname = octave::sys::file_ops::tilde_expand (name);
6159 645605133a6f [project @ 2006-11-14 02:55:05 by jwe] jwe parents: 6108 diff changeset	423
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21733 diff changeset	424 octave::sys::file_stat fs (fname);
7730 b68e44c90afe file-io.cc (do_stream_open): return -1 for directories John W. Eaton <jwe@octave.org> parents: 7708 diff changeset	425
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	426 if (! (md & std::ios::out))
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25457 diff changeset	427 fname = octave::find_data_file_in_load_path ("fopen", fname);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	428
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	429 if (! fs.is_dir ())
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	430 {
6905 aee959a21c4b [project @ 2007-09-17 16:00:30 by jwe] jwe parents: 6838 diff changeset	431 #if defined (HAVE_ZLIB)
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	432 if (use_zlib)
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	433 {
21942 aab79a1885cc limit gnulib headers to liboctave/wrappers directory John W. Eaton <jwe@octave.org> parents: 21919 diff changeset	434 FILE *fptr = std::fopen (fname.c_str (), mode.c_str ());
11004 594adb99a25e cache file id in octave_tstdiostream class John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	435
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	436 if (fptr)
26378 3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347) Andreas Weber <octave@josoansi.de> parents: 26376 diff changeset	437 {
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347) Andreas Weber <octave@josoansi.de> parents: 26376 diff changeset	438 int fd = fileno (fptr);
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347) Andreas Weber <octave@josoansi.de> parents: 26376 diff changeset	439
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347) Andreas Weber <octave@josoansi.de> parents: 26376 diff changeset	440 gzFile gzf = ::gzdopen (fd, mode.c_str ());
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347) Andreas Weber <octave@josoansi.de> parents: 26376 diff changeset	441
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347) Andreas Weber <octave@josoansi.de> parents: 26376 diff changeset	442 retval = octave_zstdiostream::create (fname, gzf, fd,
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347) Andreas Weber <octave@josoansi.de> parents: 26376 diff changeset	443 md, flt_fmt);
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347) Andreas Weber <octave@josoansi.de> parents: 26376 diff changeset	444 }
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	445 else
21942 aab79a1885cc limit gnulib headers to liboctave/wrappers directory John W. Eaton <jwe@octave.org> parents: 21919 diff changeset	446 retval.error (std::strerror (errno));
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	447 }
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	448 else
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5320 diff changeset	449 #endif
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	450 {
21942 aab79a1885cc limit gnulib headers to liboctave/wrappers directory John W. Eaton <jwe@octave.org> parents: 21919 diff changeset	451 FILE *fptr = std::fopen (fname.c_str (), mode.c_str ());
5370 f07a9653b844 [project @ 2005-05-24 02:25:57 by jwe] jwe parents: 5353 diff changeset	452
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	453 retval = octave_stdiostream::create (fname, fptr, md,
c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	454 flt_fmt);
7730 b68e44c90afe file-io.cc (do_stream_open): return -1 for directories John W. Eaton <jwe@octave.org> parents: 7708 diff changeset	455
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	456 if (! fptr)
21942 aab79a1885cc limit gnulib headers to liboctave/wrappers directory John W. Eaton <jwe@octave.org> parents: 21919 diff changeset	457 retval.error (std::strerror (errno));
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	458 }
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	459
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	460 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	461
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	462 return retval;
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	463 }
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	464
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	465 static octave::stream
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	466 do_stream_open (const octave_value& tc_name, const octave_value& tc_mode,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	467 const octave_value& tc_arch, const char *fcn, int& fid)
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	468 {
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	469 octave::stream retval;
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	470
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	471 fid = -1;
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	472
20713 2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base. Rik <rik@octave.org> parents: 20704 diff changeset	473 std::string name = tc_name.xstring_value ("%s: filename must be a string", fcn);
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20687 diff changeset	474 std::string mode = tc_mode.xstring_value ("%s: file mode must be a string", fcn);
68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20687 diff changeset	475 std::string arch = tc_arch.xstring_value ("%s: architecture type must be a string", fcn);
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	476
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20561 diff changeset	477 retval = do_stream_open (name, mode, arch, fid);
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	478
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	479 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	480 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	481
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	482 DEFMETHOD (fopen, interp, args, nargout,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	483 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	484 @deftypefn {} {@var{fid} =} fopen (@var{name})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	485 @deftypefnx {} {@var{fid} =} fopen (@var{name}, @var{mode})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	486 @deftypefnx {} {@var{fid} =} fopen (@var{name}, @var{mode}, @var{arch})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	487 @deftypefnx {} {[@var{fid}, @var{msg}] =} fopen (@dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	488 @deftypefnx {} {@var{fid_list} =} fopen ("all")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	489 @deftypefnx {} {[@var{file}, @var{mode}, @var{arch}] =} fopen (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	490 Open a file for low-level I/O or query open files and file descriptors.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	491
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	492 The first form of the @code{fopen} function opens the named file with
24516 b31fa0a0bca2 doc: Use '@:' to create non-sentence ending period for "etc.)". Rik <rik@octave.org> parents: 24469 diff changeset	493 the specified mode (read-write, read-only, etc.@:) and architecture
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	494 interpretation (IEEE big endian, IEEE little endian, etc.), and returns
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	495 an integer value that may be used to refer to the file later. If an
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	496 error occurs, @var{fid} is set to @minus{}1 and @var{msg} contains the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	497 corresponding system error message. The @var{mode} is a one or two
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	498 character string that specifies whether the file is to be opened for
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	499 reading, writing, or both.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	500
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	501 The second form of the @code{fopen} function returns a vector of file ids
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	502 corresponding to all the currently open files, excluding the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	503 @code{stdin}, @code{stdout}, and @code{stderr} streams.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	504
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	505 The third form of the @code{fopen} function returns information about the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	506 open file given its file id.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	507
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	508 For example,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	509
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	510 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	511 myfile = fopen ("splat.dat", "r", "ieee-le");
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	512 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	513
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	514 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	515 opens the file @file{splat.dat} for reading. If necessary, binary
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	516 numeric values will be read assuming they are stored in IEEE format with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	517 the least significant bit first, and then converted to the native
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	518 representation.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	519
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	520 Opening a file that is already open simply opens it again and returns a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	521 separate file id. It is not an error to open a file several times,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	522 though writing to the same file through several different file ids may
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	523 produce unexpected results.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	524
24416 d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	525 The possible values of @var{mode} are
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	526
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	527 @table @asis
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	528 @item @samp{r} (default)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	529 Open a file for reading.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	530
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	531 @item @samp{w}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	532 Open a file for writing. The previous contents are discarded.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	533
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	534 @item @samp{a}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	535 Open or create a file for writing at the end of the file.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	536
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	537 @item @samp{r+}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	538 Open an existing file for reading and writing.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	539
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	540 @item @samp{w+}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	541 Open a file for reading or writing. The previous contents are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	542 discarded.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	543
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	544 @item @samp{a+}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	545 Open or create a file for reading or writing at the end of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	546 file.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	547 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	548
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	549 Append a @qcode{"t"} to the mode string to open the file in text mode or a
24416 d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	550 @qcode{"b"} to open in binary mode. On Windows systems,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	551 text mode reading and writing automatically converts linefeeds to the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	552 appropriate line end character for the system (carriage-return linefeed on
24416 d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	553 Windows). The default when no mode is specified is binary.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	554
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	555 Additionally, you may append a @qcode{"z"} to the mode string to open a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	556 gzipped file for reading or writing. For this to be successful, you
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	557 must also open the file in binary mode.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	558
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	559 The parameter @var{arch} is a string specifying the default data format
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	560 for the file. Valid values for @var{arch} are:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	561
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	562 @table @asis
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	563 @item @qcode{"native"} or @qcode{"n"} (default)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	564 The format of the current machine.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	565
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	566 @item @qcode{"ieee-be"} or @qcode{"b"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	567 IEEE big endian format.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	568
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	569 @item @qcode{"ieee-le"} or @qcode{"l"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	570 IEEE little endian format.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	571 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	572
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	573 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	574 However, conversions are currently only supported for @samp{native},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	575 @samp{ieee-be}, and @samp{ieee-le} formats.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	576
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	577 When opening a new file that does not yet exist, permissions will be set to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	578 @code{0666 - @var{umask}}.
24416 d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	579
d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	580 Compatibility Note: Octave opens files using buffered I/O. Small writes are
d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	581 accumulated until an internal buffer is filled, and then everything is written
d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	582 in a single operation. This is very efficient and improves performance.
d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	583 @sc{matlab}, however, opens files using flushed I/O where every write operation
d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	584 is immediately performed. If the write operation must be performed immediately
d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	585 after data has been written then the write should be followed by a call to
d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644). Rik <rik@octave.org> parents: 24303 diff changeset	586 @code{fflush} to flush the internal buffer.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	587 @seealso{fclose, fgets, fgetl, fscanf, fread, fputs, fdisp, fprintf, fwrite, fskipl, fseek, frewind, ftell, feof, ferror, fclear, fflush, freport, umask}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	588 @end deftypefn */)
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	589 {
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	590 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	591
20861 6774cc464ea0 * file-io.cc (Ffopen): Fix nargin range check, fixes cset f2cd811f0f9e Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	592 if (nargin < 1 \|\| nargin > 3)
20846 f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	593 print_usage ();
f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	594
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	595 octave_value_list retval = ovl (-1.0);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	596
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	597 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	598
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	599 if (nargin == 1)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	600 {
12896 a19b50f6697f Correctly allow single string input form of fopen() (Bug #33535). Rik <octave@nomad.inbox5.com> parents: 12775 diff changeset	601 if (args(0).is_string ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	602 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	603 // If there is only one argument and it is a string but it
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	604 // is not the string "all", we assume it is a file to open
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	605 // with MODE = "r". To open a file called "all", you have
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	606 // to supply more than one argument.
12896 a19b50f6697f Correctly allow single string input form of fopen() (Bug #33535). Rik <octave@nomad.inbox5.com> parents: 12775 diff changeset	607 if (nargout < 2 && args(0).string_value () == "all")
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	608 return streams.open_file_numbers ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	609 }
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	610 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	611 {
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	612 string_vector tmp = streams.get_info (args(0));
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	613
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	614 retval = ovl (tmp(0), tmp(1), tmp(2));
3263 7d80b56e0dc8 [project @ 1999-08-20 19:10:09 by jwe] jwe parents: 3246 diff changeset	615
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	616 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	617 }
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	618 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	619
20846 f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	620 octave_value mode = (nargin == 2 \|\| nargin == 3)
f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	621 ? args(1) : octave_value ("r");
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	622
20846 f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	623 octave_value arch = (nargin == 3)
f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	624 ? args(2) : octave_value ("native");
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	625
20846 f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	626 int fid = -1;
f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	627
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	628 octave::stream os = do_stream_open (args(0), mode, arch, "fopen", fid);
5370 f07a9653b844 [project @ 2005-05-24 02:25:57 by jwe] jwe parents: 5353 diff changeset	629
20846 f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	630 if (os)
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	631 retval = ovl (streams.insert (os), "");
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	632 else
20846 f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	633 {
f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	634 int error_number = 0;
f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	635
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	636 retval = ovl (-1.0, os.error (false, error_number));
20846 f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint) Mike Miller <mtmiller@octave.org> parents: 20819 diff changeset	637 }
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	638
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	639 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	640 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	641
22837 b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	642 /*
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	643 ## FIXME: Only have tests for query mode. Need others for regular fopen call.
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	644 %!test # Uses hardcoded value of 1 for stdout
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	645 %! [name, mode, arch] = fopen (1);
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	646 %! assert (name, "stdout");
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	647 %! assert (mode, "w");
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	648
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	649 %!test # Query of non-existent stream returns all ""
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	650 %! [name, mode, arch] = fopen (-1);
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	651 %! assert (name, "");
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	652 %! assert (mode, "");
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	653 %! assert (arch, "");
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	654 */
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695). Rik <rik@octave.org> parents: 22755 diff changeset	655
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	656 DEFMETHOD (freport, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	657 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	658 @deftypefn {} {} freport ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	659 Print a list of which files have been opened, and whether they are open
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	660 for reading, writing, or both.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	661
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	662 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	663
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	664 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	665 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	666 freport ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	667
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	668 @print{} number mode arch name
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	669 @print{} ------ ---- ---- ----
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	670 @print{} 0 r ieee-le stdin
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	671 @print{} 1 w ieee-le stdout
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	672 @print{} 2 w ieee-le stderr
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	673 @print{} 3 r ieee-le myfile
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	674 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	675 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	676 @seealso{fopen, fclose, is_valid_file_id}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	677 @end deftypefn */)
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	678 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20812 diff changeset	679 if (args.length () > 0)
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	680 warning ("freport: ignoring extra arguments");
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	681
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	682 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	683
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	684 octave_stdout << streams.list_open_files ();
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	685
21078 49852ff04747 maint: Remove unnecessary declarations of retval. Rik <rik@octave.org> parents: 21055 diff changeset	686 return ovl ();
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	687 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	688
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	689 DEFMETHOD (frewind, interp, args, nargout,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	690 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	691 @deftypefn {} {} frewind (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	692 @deftypefnx {} {@var{status} =} frewind (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	693 Move the file pointer to the beginning of the file specified by file
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	694 descriptor @var{fid}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	695
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	696 @code{frewind} returns 0 for success, and -1 if an error is encountered. It
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	697 is equivalent to @code{fseek (@var{fid}, 0, SEEK_SET)}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	698 @seealso{fseek, ftell, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	699 @end deftypefn */)
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	700 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	701 if (args.length () != 1)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	702 print_usage ();
506 0f388340e607 [project @ 1994-07-09 06:10:34 by jwe] jwe parents: 497 diff changeset	703
20812 d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20805 diff changeset	704 int result = -1;
d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20805 diff changeset	705
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	706 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	707
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	708 octave::stream os = streams.lookup (args(0), "frewind");
636 fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe] jwe parents: 628 diff changeset	709
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	710 result = os.rewind ();
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	711
4715 7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe] jwe parents: 4649 diff changeset	712 if (nargout > 0)
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	713 return ovl (result);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	714 else
20941 a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()". Rik <rik@octave.org> parents: 20940 diff changeset	715 return ovl ();
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	716 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	717
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	718 DEFMETHOD (fseek, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	719 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	720 @deftypefn {} {} fseek (@var{fid}, @var{offset})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	721 @deftypefnx {} {} fseek (@var{fid}, @var{offset}, @var{origin})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	722 @deftypefnx {} {@var{status} =} fseek (@dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	723 Set the file pointer to the location @var{offset} within the file @var{fid}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	724
25005 db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	725 The pointer is positioned @var{offset} characters from the @var{origin}, which
25454 41ea5f665659 doc: Use qcode macro to document fseek offsets (bug #51402). Rik <rik@octave.org> parents: 25054 diff changeset	726 may be one of the predefined variables @w{@qcode{SEEK_SET}} (beginning),
41ea5f665659 doc: Use qcode macro to document fseek offsets (bug #51402). Rik <rik@octave.org> parents: 25054 diff changeset	727 @w{@qcode{SEEK_CUR}} (current position), or @w{@qcode{SEEK_END}} (end of file)
41ea5f665659 doc: Use qcode macro to document fseek offsets (bug #51402). Rik <rik@octave.org> parents: 25054 diff changeset	728 or strings @nospell{@qcode{"bof"}}, @nospell{@qcode{"cof"}}, or
41ea5f665659 doc: Use qcode macro to document fseek offsets (bug #51402). Rik <rik@octave.org> parents: 25054 diff changeset	729 @nospell{@qcode{"eof"}}. If @var{origin} is omitted, @w{@qcode{SEEK_SET}} is
25003 2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24933 diff changeset	730 assumed. @var{offset} may be positive, negative, or zero but not all
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24933 diff changeset	731 combinations of @var{origin} and @var{offset} can be realized.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	732
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	733 @code{fseek} returns 0 on success and -1 on error.
25005 db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	734 @seealso{fskipl, frewind, ftell, fopen, SEEK_SET, SEEK_CUR, SEEK_END}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	735 @end deftypefn */)
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	736 {
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	737 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	738
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	739 if (nargin < 2 \|\| nargin > 3)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	740 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	741
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	742 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	743
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	744 octave::stream os = streams.lookup (args(0), "fseek");
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	745
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	746 octave_value origin_arg = (nargin == 3) ? args(2) : octave_value (-1.0);
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	747
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21126 diff changeset	748 return ovl (os.seek (args(1), origin_arg));
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	749 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	750
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	751 DEFMETHOD (ftell, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	752 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	753 @deftypefn {} {@var{pos} =} ftell (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	754 Return the position of the file pointer as the number of characters from the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	755 beginning of the file specified by file descriptor @var{fid}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	756 @seealso{fseek, frewind, feof, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	757 @end deftypefn */)
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	758 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	759 if (args.length () != 1)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	760 print_usage ();
506 0f388340e607 [project @ 1994-07-09 06:10:34 by jwe] jwe parents: 497 diff changeset	761
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	762 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	763
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	764 octave::stream os = streams.lookup (args(0), "ftell");
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	765
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21126 diff changeset	766 return ovl (os.tell ());
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	767 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	768
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	769 static octave_value_list
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	770 printf_internal (octave::interpreter& interp, const std::string& who,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	771 const octave_value_list& args, int nargout)
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	772 {
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	773 int nargin = args.length ();
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	774
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	775 if (! (nargin > 1 \|\| (nargin > 0 && args(0).is_string ())))
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	776 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	777
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	778 int result;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	779
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	780 octave::stream os;
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	781 int fmt_n = 0;
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	782
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	783 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	784
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	785 if (args(0).is_string ())
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	786 os = streams.lookup (1, who);
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	787 else
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	788 {
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	789 fmt_n = 1;
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	790 os = streams.lookup (args(0), who);
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	791 }
2873 c3f7ed3874af [project @ 1997-04-23 04:01:02 by jwe] jwe parents: 2847 diff changeset	792
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	793 if (! args(fmt_n).is_string ())
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	794 error ("%s: format TEMPLATE must be a string", who.c_str ());
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	795
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	796 octave_value_list tmp_args;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	797
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	798 if (nargin > 1 + fmt_n)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	799 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	800 tmp_args.resize (nargin-fmt_n-1, octave_value ());
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	801
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	802 for (int i = fmt_n + 1; i < nargin; i++)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	803 tmp_args(i-fmt_n-1) = args(i);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	804 }
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	805
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	806 result = os.printf (args(fmt_n), tmp_args, who);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	807
4715 7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe] jwe parents: 4649 diff changeset	808 if (nargout > 0)
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21126 diff changeset	809 return ovl (result);
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	810 else
20941 a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()". Rik <rik@octave.org> parents: 20940 diff changeset	811 return ovl ();
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	812 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	813
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	814 DEFMETHOD (fprintf, interp, args, nargout,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	815 doc: /* -- texinfo --
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	816 @deftypefn {} {} fprintf (@var{fid}, @var{template}, @dots{})
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	817 @deftypefnx {} {} fprintf (@var{template}, @dots{})
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	818 @deftypefnx {} {@var{numbytes} =} fprintf (@dots{})
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	819 This function is equivalent to @code{printf}, except that the output is
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	820 written to the file descriptor @var{fid} instead of @code{stdout}.
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	821
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	822 If @var{fid} is omitted, the output is written to @code{stdout} making the
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	823 function exactly equivalent to @code{printf}.
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	824
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	825 The optional output returns the number of bytes written to the file.
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	826
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	827 Implementation Note: For compatibility with @sc{matlab}, escape sequences in
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	828 the template string (e.g., @qcode{"@xbackslashchar{}n"} => newline) are
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	829 expanded even when the template string is defined with single quotes.
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	830 @seealso{fputs, fdisp, fwrite, fscanf, printf, sprintf, fopen}
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	831 @end deftypefn */)
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	832 {
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	833 static std::string who = "fprintf";
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	834
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	835 return printf_internal (interp, who, args, nargout);
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	836 }
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	837
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	838 DEFMETHOD (printf, interp, args, nargout,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	839 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	840 @deftypefn {} {} printf (@var{template}, @dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	841 Print optional arguments under the control of the template string
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	842 @var{template} to the stream @code{stdout} and return the number of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	843 characters printed.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	844 @ifclear OCTAVE_MANUAL
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	845
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	846 See the Formatted Output section of the GNU Octave manual for a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	847 complete description of the syntax of the template string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	848 @end ifclear
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	849
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	850 Implementation Note: For compatibility with @sc{matlab}, escape sequences in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	851 the template string (e.g., @qcode{"@xbackslashchar{}n"} => newline) are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	852 expanded even when the template string is defined with single quotes.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	853 @seealso{fprintf, sprintf, scanf}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	854 @end deftypefn */)
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	855 {
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	856 static std::string who = "printf";
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	857
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	858 octave_value_list tmp_args = args;
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	859
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	860 return printf_internal (interp, who, tmp_args.prepend (octave_value (1)),
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	861 nargout);
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	862 }
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	863
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	864 static octave_value_list
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	865 puts_internal (octave::interpreter& interp, const std::string& who,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	866 const octave_value_list& args)
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	867 {
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	868 if (args.length () != 2)
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	869 print_usage ();
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	870
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	871 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	872
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	873 octave::stream os = streams.lookup (args(0), who);
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	874
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	875 return ovl (os.puts (args(1), who));
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	876 }
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	877
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	878 DEFMETHOD (fputs, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	879 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	880 @deftypefn {} {} fputs (@var{fid}, @var{string})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	881 @deftypefnx {} {@var{status} =} fputs (@var{fid}, @var{string})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	882 Write the string @var{string} to the file with file descriptor @var{fid}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	883
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	884 The string is written to the file with no additional formatting. Use
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	885 @code{fdisp} instead to automatically append a newline character appropriate
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	886 for the local machine.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	887
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	888 Return a non-negative number on success or EOF on error.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	889 @seealso{fdisp, fprintf, fwrite, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	890 @end deftypefn */)
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	891 {
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	892 static std::string who = "fputs";
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	893
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	894 return puts_internal (interp, who, args);
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	895 }
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	896
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	897 DEFMETHOD (puts, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	898 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	899 @deftypefn {} {} puts (@var{string})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	900 @deftypefnx {} {@var{status} =} puts (@var{string})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	901 Write a string to the standard output with no formatting.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	902
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	903 The string is written verbatim to the standard output. Use @code{disp} to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	904 automatically append a newline character appropriate for the local machine.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	905
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	906 Return a non-negative number on success and EOF on error.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	907 @seealso{fputs, disp}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	908 @end deftypefn */)
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	909 {
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	910 static std::string who = "puts";
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	911
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	912 octave_value_list tmp_args = args;
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	913
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	914 return puts_internal (interp, who, tmp_args.prepend (octave_value (1)));
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	915 }
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	916
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	917 DEFUN (sprintf, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	918 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	919 @deftypefn {} {} sprintf (@var{template}, @dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	920 This is like @code{printf}, except that the output is returned as a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	921 string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	922
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	923 Unlike the C library function, which requires you to provide a suitably
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	924 sized string as an argument, Octave's @code{sprintf} function returns the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	925 string, automatically sized to hold all of the items converted.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	926
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	927 Implementation Note: For compatibility with @sc{matlab}, escape sequences in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	928 the template string (e.g., @qcode{"@xbackslashchar{}n"} => newline) are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	929 expanded even when the template string is defined with single quotes.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	930 @seealso{printf, fprintf, sscanf}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	931 @end deftypefn */)
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	932 {
4468 efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe] jwe parents: 4388 diff changeset	933 static std::string who = "sprintf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe] jwe parents: 4388 diff changeset	934
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	935 int nargin = args.length ();
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	936
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	937 if (nargin == 0)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	938 print_usage ();
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	939
21506 128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	940 // We don't use octave_ostrstream::create here because need direct
128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	941 // access to the OSTR object so that we can extract a string object
128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	942 // from it to return.
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	943 octave_ostrstream *ostr = new octave_ostrstream ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	944
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	945 // The octave::stream destructor will delete OSTR for us.
b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	946 octave::stream os (ostr);
628 aecbe369233b [project @ 1994-08-19 13:27:51 by jwe] jwe parents: 610 diff changeset	947
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	948 if (! os.is_valid ())
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	949 error ("%s: unable to create output buffer", who.c_str ());
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	950
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	951 octave_value fmt_arg = args(0);
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	952
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	953 if (! fmt_arg.is_string ())
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	954 error ("%s: format TEMPLATE must be a string", who.c_str ());
628 aecbe369233b [project @ 1994-08-19 13:27:51 by jwe] jwe parents: 610 diff changeset	955
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	956 octave_value_list retval (3);
19727 3c3b9fce7d2b improve compatibility of sprintf function. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	957
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	958 octave_value_list tmp_args;
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	959 if (nargin > 1)
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	960 {
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	961 tmp_args.resize (nargin-1, octave_value ());
19727 3c3b9fce7d2b improve compatibility of sprintf function. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	962
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	963 for (int i = 1; i < nargin; i++)
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	964 tmp_args(i-1) = args(i);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	965 }
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	966
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	967 // NOTE: Call to os.error must precede next call to ostr which might reset it.
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	968 retval(2) = os.printf (fmt_arg, tmp_args, who);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	969 retval(1) = os.error ();
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	970
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	971 std::string result = ostr->str ();
23450 855122b993da maint: Wrap tertiary operator in parentheses "(COND ? x : y)". Rik <rik@octave.org> parents: 23220 diff changeset	972 char type = (fmt_arg.is_sq_string () ? '\'' : '"');
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	973
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	974 retval(0) = (result.empty () ? octave_value (charMatrix (1, 0), type)
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20884 diff changeset	975 : octave_value (result, type));
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	976
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	977 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	978 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	979
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	980 static octave_value_list
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	981 scanf_internal (octave::interpreter& interp, const std::string& who,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	982 const octave_value_list& args)
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	983 {
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	984 int nargin = args.length ();
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	985
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	986 if (nargin < 2 \|\| nargin > 3)
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	987 print_usage ();
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	988
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	989 octave_value_list retval;
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	990
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	991 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	992
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	993 octave::stream os = streams.lookup (args(0), who);
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	994
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	995 if (! args(1).is_string ())
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	996 error ("%s: format TEMPLATE must be a string", who.c_str ());
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	997
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	998 if (nargin == 3 && args(2).is_string ())
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	999 {
23924 0519eaf0cca6 fix remaining spurious octave_value_list conversions (bug #51767) Mike Miller <mtmiller@octave.org> parents: 23803 diff changeset	1000 retval = os.oscanf (args(1), who);
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1001 }
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1002 else
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1003 {
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1004 octave_idx_type count = 0;
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1005
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1006 Array<double> size
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1007 = (nargin == 3
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1008 ? args(2).vector_value ()
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1009 : Array<double> (dim_vector (1, 1), lo_ieee_inf_value ()));
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1010
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1011 octave_value tmp = os.scanf (args(1), size, count, who);
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1012
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1013 retval = ovl (tmp, count, os.error ());
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1014 }
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1015
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1016 return retval;
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1017 }
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1018
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1019 DEFMETHOD (fscanf, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1020 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1021 @deftypefn {} {[@var{val}, @var{count}, @var{errmsg}] =} fscanf (@var{fid}, @var{template}, @var{size})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1022 @deftypefnx {} {[@var{v1}, @var{v2}, @dots{}, @var{count}, @var{errmsg}] =} fscanf (@var{fid}, @var{template}, "C")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1023 In the first form, read from @var{fid} according to @var{template},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1024 returning the result in the matrix @var{val}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1025
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1026 The optional argument @var{size} specifies the amount of data to read
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1027 and may be one of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1028
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1029 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1030 @item Inf
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1031 Read as much as possible, returning a column vector.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1032
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1033 @item @var{nr}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1034 Read up to @var{nr} elements, returning a column vector.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1035
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1036 @item [@var{nr}, Inf]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1037 Read as much as possible, returning a matrix with @var{nr} rows. If the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1038 number of elements read is not an exact multiple of @var{nr}, the last
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1039 column is padded with zeros.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1040
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1041 @item [@var{nr}, @var{nc}]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1042 Read up to @code{@var{nr} * @var{nc}} elements, returning a matrix with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1043 @var{nr} rows. If the number of elements read is not an exact multiple
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1044 of @var{nr}, the last column is padded with zeros.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1045 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1046
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1047 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1048 If @var{size} is omitted, a value of @code{Inf} is assumed.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1049
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1050 A string is returned if @var{template} specifies only character conversions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1051
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1052 The number of items successfully read is returned in @var{count}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1053
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1054 If an error occurs, @var{errmsg} contains a system-dependent error message.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1055
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1056 In the second form, read from @var{fid} according to @var{template},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1057 with each conversion specifier in @var{template} corresponding to a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1058 single scalar return value. This form is more ``C-like'', and also
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1059 compatible with previous versions of Octave. The number of successful
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1060 conversions is returned in @var{count}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1061 @ifclear OCTAVE_MANUAL
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1062
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1063 See the Formatted Input section of the GNU Octave manual for a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1064 complete description of the syntax of the template string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1065 @end ifclear
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1066 @seealso{fgets, fgetl, fread, scanf, sscanf, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1067 @end deftypefn */)
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	1068 {
4468 efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe] jwe parents: 4388 diff changeset	1069 static std::string who = "fscanf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe] jwe parents: 4388 diff changeset	1070
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1071 return scanf_internal (interp, who, args);
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	1072 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	1073
13194 3e1871badab9 allow sscanf to accept character arrays with more than one row John W. Eaton <jwe@octave.org> parents: 12998 diff changeset	1074 static std::string
21507 2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1075 get_scan_string_data (const octave_value& val, const std::string& who)
13194 3e1871badab9 allow sscanf to accept character arrays with more than one row John W. Eaton <jwe@octave.org> parents: 12998 diff changeset	1076 {
3e1871badab9 allow sscanf to accept character arrays with more than one row John W. Eaton <jwe@octave.org> parents: 12998 diff changeset	1077 std::string retval;
3e1871badab9 allow sscanf to accept character arrays with more than one row John W. Eaton <jwe@octave.org> parents: 12998 diff changeset	1078
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20956 diff changeset	1079 if (! val.is_string ())
21507 2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1080 error ("%s: argument STRING must be a string", who.c_str ());
13194 3e1871badab9 allow sscanf to accept character arrays with more than one row John W. Eaton <jwe@octave.org> parents: 12998 diff changeset	1081
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20956 diff changeset	1082 octave_value tmp = val.reshape (dim_vector (1, val.numel ()));
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20956 diff changeset	1083
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20956 diff changeset	1084 retval = tmp.string_value ();
13194 3e1871badab9 allow sscanf to accept character arrays with more than one row John W. Eaton <jwe@octave.org> parents: 12998 diff changeset	1085
3e1871badab9 allow sscanf to accept character arrays with more than one row John W. Eaton <jwe@octave.org> parents: 12998 diff changeset	1086 return retval;
3e1871badab9 allow sscanf to accept character arrays with more than one row John W. Eaton <jwe@octave.org> parents: 12998 diff changeset	1087 }
3e1871badab9 allow sscanf to accept character arrays with more than one row John W. Eaton <jwe@octave.org> parents: 12998 diff changeset	1088
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	1089 DEFUN (sscanf, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1090 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1091 @deftypefn {} {[@var{val}, @var{count}, @var{errmsg}, @var{pos}] =} sscanf (@var{string}, @var{template}, @var{size})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1092 @deftypefnx {} {[@var{v1}, @var{v2}, @dots{}, @var{count}, @var{errmsg}] =} sscanf (@var{string}, @var{template}, "C")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1093 This is like @code{fscanf}, except that the characters are taken from the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1094 string @var{string} instead of from a stream.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1095
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1096 Reaching the end of the string is treated as an end-of-file condition. In
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1097 addition to the values returned by @code{fscanf}, the index of the next
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1098 character to be read is returned in @var{pos}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1099 @seealso{fscanf, scanf, sprintf}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1100 @end deftypefn */)
444 ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	1101 {
4468 efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe] jwe parents: 4388 diff changeset	1102 static std::string who = "sscanf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe] jwe parents: 4388 diff changeset	1103
506 0f388340e607 [project @ 1994-07-09 06:10:34 by jwe] jwe parents: 497 diff changeset	1104 int nargin = args.length ();
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe] jwe parents: 497 diff changeset	1105
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1106 if (nargin < 2 \|\| nargin > 3)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1107 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1108
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1109 octave_value_list retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1110
21507 2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1111 std::string data = get_scan_string_data (args(0), who);
21506 128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	1112
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	1113 octave::stream os = octave_istrstream::create (data);
21506 128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	1114
128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	1115 if (! os.is_valid ())
128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	1116 error ("%s: unable to create temporary input buffer", who.c_str ());
128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	1117
128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	1118 if (! args(1).is_string ())
128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	1119 error ("%s: format TEMPLATE must be a string", who.c_str ());
128703a29388 avoid some duplicate code in file-io functions John W. Eaton <jwe@octave.org> parents: 21504 diff changeset	1120
2215 ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe] jwe parents: 2189 diff changeset	1121 if (nargin == 3 && args(2).is_string ())
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	1122 {
23924 0519eaf0cca6 fix remaining spurious octave_value_list conversions (bug #51767) Mike Miller <mtmiller@octave.org> parents: 23803 diff changeset	1123 retval = os.oscanf (args(1), who);
444 ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	1124 }
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	1125 else
2215 ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe] jwe parents: 2189 diff changeset	1126 {
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1127 octave_idx_type count = 0;
2215 ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe] jwe parents: 2189 diff changeset	1128
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1129 Array<double> size = (nargin == 3) ? args(2).vector_value ()
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1130 : Array<double> (dim_vector (1, 1),
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1131 lo_ieee_inf_value ());
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1132
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1133 octave_value tmp = os.scanf (args(1), size, count, who);
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	1134
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1135 // FIXME: is this the right thing to do?
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1136 // Extract error message first, because getting
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1137 // position will clear it.
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1138 std::string errmsg = os.error ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1139
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1140 retval = ovl (tmp, count, errmsg,
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	1141 (os.eof () ? data.length () : os.tell ()) + 1);
2215 ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe] jwe parents: 2189 diff changeset	1142 }
444 ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	1143
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	1144 return retval;
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	1145 }
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	1146
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1147 DEFMETHOD (scanf, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1148 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1149 @deftypefn {} {[@var{val}, @var{count}, @var{errmsg}] =} scanf (@var{template}, @var{size})
24466 746081e3cbdd doc: Delete extra ']' in scanf docstring (bug #52742). Rik <rik@octave.org> parents: 24416 diff changeset	1150 @deftypefnx {} {[@var{v1}, @var{v2}, @dots{}, @var{count}, @var{errmsg}] =} scanf (@var{template}, "C")
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1151 This is equivalent to calling @code{fscanf} with @var{fid} = @code{stdin}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1152
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1153 It is currently not useful to call @code{scanf} in interactive programs.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1154 @seealso{fscanf, sscanf, printf}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1155 @end deftypefn */)
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	1156 {
23737 7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1157 static std::string who = "scanf";
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1158
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1159 octave_value_list tmp_args = args;
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions John W. Eaton <jwe@octave.org> parents: 23586 diff changeset	1160
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1161 return scanf_internal (interp, who, tmp_args.prepend (octave_value (0)));
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	1162 }
96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	1163
21504 65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1164 static octave_value_list
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1165 textscan_internal (octave::interpreter& interp, const std::string& who,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1166 const octave_value_list& args)
21504 65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1167 {
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1168 if (args.length () < 1)
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1169 print_usage (who);
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1170
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	1171 octave::stream os;
21507 2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1172
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1173 if (args(0).is_string ())
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1174 {
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1175 std::string data = get_scan_string_data (args(0), who);
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1176
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1177 os = octave_istrstream::create (data);
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1178
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1179 if (! os.is_valid ())
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1180 error ("%s: unable to create temporary input buffer", who.c_str ());
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1181 }
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	1182 else
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1183 {
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1184 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1185
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1186 os = streams.lookup (args(0), who);
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1187 }
21504 65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1188
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1189 int nskip = 1;
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1190
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1191 std::string fmt;
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1192
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1193 if (args.length () == 1)
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1194 {
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1195 // ommited format = %f. explicit "" = width from file
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1196 fmt = "%f";
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1197 }
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1198 else if (args(1).is_string ())
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1199 {
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1200 fmt = args(1).string_value ();
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1201
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1202 if (args(1).is_sq_string ())
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25457 diff changeset	1203 fmt = octave::do_string_escapes (fmt);
21504 65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1204
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1205 nskip++;
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1206 }
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1207 else
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1208 error ("%s: FORMAT must be a string", who.c_str ());
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1209
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1210 octave_idx_type ntimes = -1;
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1211
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1212 if (args.length () > 2)
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1213 {
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23573 diff changeset	1214 if (args(2).isnumeric ())
21504 65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1215 {
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1216 ntimes = args(2).idx_type_value ();
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1217
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1218 if (ntimes < args(2).double_value ())
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1219 error ("%s: REPEAT = %g is too large",
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1220 who.c_str (), args(2).double_value ());
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1221
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1222 nskip++;
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1223 }
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1224 }
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1225
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1226 octave_value_list options = args.splice (0, nskip);
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1227
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1228 octave_idx_type count = 0;
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1229
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1230 octave_value result = os.textscan (fmt, ntimes, options, who, count);
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1231
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1232 std::string errmsg = os.error ();
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1233
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1234 return ovl (result, count, errmsg);
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1235 }
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1236
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1237 DEFMETHOD (textscan, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1238 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1239 @deftypefn {} {@var{C} =} textscan (@var{fid}, @var{format})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1240 @deftypefnx {} {@var{C} =} textscan (@var{fid}, @var{format}, @var{repeat})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1241 @deftypefnx {} {@var{C} =} textscan (@var{fid}, @var{format}, @var{param}, @var{value}, @dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1242 @deftypefnx {} {@var{C} =} textscan (@var{fid}, @var{format}, @var{repeat}, @var{param}, @var{value}, @dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1243 @deftypefnx {} {@var{C} =} textscan (@var{str}, @dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1244 @deftypefnx {} {[@var{C}, @var{position}, @var{errmsg}] =} textscan (@dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1245 Read data from a text file or string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1246
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1247 The string @var{str} or file associated with @var{fid} is read from and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1248 parsed according to @var{format}. The function is an extension of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1249 @code{strread} and @code{textread}. Differences include: the ability to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1250 read from either a file or a string, additional options, and additional
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1251 format specifiers.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1252
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1253 The input is interpreted as a sequence of words, delimiters (such as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1254 whitespace), and literals. The characters that form delimiters and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1255 whitespace are determined by the options. The format consists of format
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1256 specifiers interspersed between literals. In the format, whitespace forms
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1257 a delimiter between consecutive literals, but is otherwise ignored.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1258
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1259 The output @var{C} is a cell array where the number of columns is determined
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1260 by the number of format specifiers.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1261
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1262 The first word of the input is matched to the first specifier of the format
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1263 and placed in the first column of the output; the second is matched to the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1264 second specifier and placed in the second column and so forth. If there
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1265 are more words than specifiers then the process is repeated until all words
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1266 have been processed or the limit imposed by @var{repeat} has been met (see
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1267 below).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1268
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1269 The string @var{format} describes how the words in @var{str} should be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1270 parsed. As in @var{fscanf}, any (non-whitespace) text in the format that is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1271 not one of these specifiers is considered a literal. If there is a literal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1272 between two format specifiers then that same literal must appear in the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1273 input stream between the matching words.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1274
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1275 The following specifiers are valid:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1276
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1277 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1278 @item %f
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1279 @itemx %f64
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1280 @itemx %n
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1281 The word is parsed as a number and converted to double.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1282
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1283 @item %f32
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1284 The word is parsed as a number and converted to single (float).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1285
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1286 @item %d
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1287 @itemx %d8
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1288 @itemx %d16
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1289 @itemx %d32
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1290 @itemx %d64
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1291 The word is parsed as a number and converted to int8, int16, int32, or
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1292 int64. If no size is specified then int32 is used.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1293
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1294 @item %u
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1295 @itemx %u8
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1296 @itemx %u16
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1297 @itemx %u32
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1298 @itemx %u64
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1299 The word is parsed as a number and converted to uint8, uint16, uint32, or
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1300 uint64. If no size is specified then uint32 is used.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1301
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1302 @item %s
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1303 The word is parsed as a string ending at the last character before
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1304 whitespace, an end-of-line, or a delimiter specified in the options.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1305
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1306 @item %q
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1307 The word is parsed as a "quoted string".
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1308 If the first character of the string is a double quote (") then the string
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1309 includes everything until a matching double quote---including whitespace,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1310 delimiters, and end-of-line characters. If a pair of consecutive double
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1311 quotes appears in the input, it is replaced in the output by a single
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1312 double quote. For examples, the input "He said ""Hello""" would
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1313 return the value 'He said "Hello"'.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1314
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1315 @item %c
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1316 The next character of the input is read.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1317 This includes delimiters, whitespace, and end-of-line characters.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1318
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1319 @item %[@dots{}]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1320 @itemx %[^@dots{}]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1321 In the first form, the word consists of the longest run consisting of only
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1322 characters between the brackets. Ranges of characters can be specified by
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1323 a hyphen; for example, %[0-9a-zA-Z] matches all alphanumeric characters (if
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1324 the underlying character set is ASCII). Since @sc{matlab} treats hyphens
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1325 literally, this expansion only applies to alphanumeric characters. To
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1326 include '-' in the set, it should appear first or last in the brackets; to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1327 include ']', it should be the first character. If the first character is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1328 '^' then the word consists of characters @strong{not} listed.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1329
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1330 @item %N@dots{}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1331 For %s, %c %d, %f, %n, %u, an optional width can be specified as %Ns, etc.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1332 where N is an integer > 1. For %c, this causes exactly N characters to be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1333 read instead of a single character. For the other specifiers, it is an
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1334 upper bound on the number of characters read; normal delimiters can cause
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1335 fewer characters to be read. For complex numbers, this limit applies to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1336 the real and imaginary components individually. For %f and %n, format
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1337 specifiers like %N.Mf are allowed, where M is an upper bound on number of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1338 characters after the decimal point to be considered; subsequent digits are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1339 skipped. For example, the specifier %8.2f would read 12.345e6 as 1.234e7.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1340
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1341 @item %*@dots{}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1342 The word specified by the remainder of the conversion specifier is skipped.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1343
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1344 @item literals
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1345 In addition the format may contain literal character strings; these will be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1346 skipped during reading. If the input string does not match this literal,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1347 the processing terminates.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1348 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1349
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1350 Parsed words corresponding to the first specifier are returned in the first
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1351 output argument and likewise for the rest of the specifiers.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1352
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1353 By default, if there is only one input argument, @var{format} is @t{"%f"}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1354 This means that numbers are read from the input into a single column vector.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1355 If @var{format} is explicitly empty (@qcode{""}) then textscan will
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1356 return data in a number of columns matching the number of fields on the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1357 first data line of the input. Either of these is suitable only when the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1358 input is exclusively numeric.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1359
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1360 For example, the string
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1361
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1362 @smallexample
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1363 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1364 @var{str} = "\
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1365 Bunny Bugs 5.5\n\
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1366 Duck Daffy -7.5e-5\n\
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1367 Penguin Tux 6"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1368 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1369 @end smallexample
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1370
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1371 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1372 can be read using
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1373
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1374 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1375 @var{a} = textscan (@var{str}, "%s %s %f");
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1376 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1377
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1378 The optional numeric argument @var{repeat} can be used for limiting the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1379 number of items read:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1380
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1381 @table @asis
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1382 @item -1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1383 Read all of the string or file until the end (default).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1384
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1385 @item N
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1386 Read until the first of two conditions occurs: 1) the format has been
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1387 processed N times, or 2) N lines of the input have been processed. Zero
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1388 (0) is an acceptable value for @var{repeat}. Currently, end-of-line
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1389 characters inside %q, %c, and %[@dots{}]$ conversions do not contribute to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1390 the line count. This is incompatible with @sc{matlab} and may change in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1391 future.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1392 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1393
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1394 The behavior of @code{textscan} can be changed via property/value pairs.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1395 The following properties are recognized:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1396
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1397 @table @asis
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1398 @item @qcode{"BufSize"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1399 This specifies the number of bytes to use for the internal buffer.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1400 A modest speed improvement may be obtained by setting this to a large value
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1401 when reading a large file, especially if the input contains long strings.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1402 The default is 4096, or a value dependent on @var{n} if that is specified.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1403
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1404 @item @qcode{"CollectOutput"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1405 A value of 1 or true instructs @code{textscan} to concatenate consecutive
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1406 columns of the same class in the output cell array. A value of 0 or false
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1407 (default) leaves output in distinct columns.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1408
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1409 @item @qcode{"CommentStyle"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1410 Specify parts of the input which are considered comments and will be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1411 skipped. @var{value} is the comment style and can be either (1) A string
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1412 or 1x1 cell string, to skip everything to the right of it; (2) A cell array
21992 03c692adf563 maint: strip trailing whitespace from files. John W. Eaton <jwe@octave.org> parents: 21991 diff changeset	1413 of two strings, to skip everything between the first and second strings.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1414 Comments are only parsed where whitespace is accepted and do not act as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1415 delimiters.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1416
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1417 @item @qcode{"Delimiter"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1418 If @var{value} is a string, any character in @var{value} will be used to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1419 split the input into words. If @var{value} is a cell array of strings,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1420 any string in the array will be used to split the input into words.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1421 (default value = any whitespace.)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1422
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1423 @item @qcode{"EmptyValue"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1424 Value to return for empty numeric values in non-whitespace delimited data.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1425 The default is NaN@. When the data type does not support NaN (int32 for
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1426 example), then the default is zero.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1427
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1428 @item @qcode{"EndOfLine"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1429 @var{value} can be either an emtpy or one character specifying the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1430 end-of-line character, or the pair
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1431 @qcode{"@xbackslashchar{}r@xbackslashchar{}n"} (CRLF).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1432 In the latter case, any of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1433 @qcode{"@xbackslashchar{}r"}, @qcode{"@xbackslashchar{}n"} or
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1434 @qcode{"@xbackslashchar{}r@xbackslashchar{}n"} is counted as a (single)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1435 newline. If no value is given,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1436 @qcode{"@xbackslashchar{}r@xbackslashchar{}n"} is used.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1437 @c If set to "" (empty string) EOLs are ignored as delimiters and added
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1438 @c to whitespace.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1439
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1440 @c When reading from a character string, optional input argument @var{n}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1441 @c specifies the number of times @var{format} should be used (i.e., to limit
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1442 @c the amount of data read).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1443 @c When reading from file, @var{n} specifies the number of data lines to read;
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1444 @c in this sense it differs slightly from the format repeat count in strread.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1445
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1446 @item @qcode{"HeaderLines"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1447 The first @var{value} number of lines of @var{fid} are skipped. Note that
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1448 this does not refer to the first non-comment lines, but the first lines of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1449 any type.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1450
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1451 @item @qcode{"MultipleDelimsAsOne"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1452 If @var{value} is nonzero, treat a series of consecutive delimiters,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1453 without whitespace in between, as a single delimiter. Consecutive
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1454 delimiter series need not be vertically aligned. Without this option, a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1455 single delimiter before the end of the line does not cause the line to be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1456 considered to end with an empty value, but a single delimiter at the start
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1457 of a line causes the line to be considered to start with an empty value.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1458
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1459 @item @qcode{"TreatAsEmpty"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1460 Treat single occurrences (surrounded by delimiters or whitespace) of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1461 string(s) in @var{value} as missing values.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1462
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1463 @item @qcode{"ReturnOnError"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1464 If set to numerical 1 or true, return normally as soon as an error is
22299 9fc91bb2aec3 doc: grammarcheck documentation for 4.2 release. Rik <rik@octave.org> parents: 22022 diff changeset	1465 encountered, such as trying to read a string using @code{%f}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1466 If set to 0 or false, return an error and no data.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1467
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1468 @item @qcode{"Whitespace"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1469 Any character in @var{value} will be interpreted as whitespace and trimmed;
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1470 The default value for whitespace is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1471 @c Note: the next line specifically has a newline which generates a space
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1472 @c in the output of qcode, but keeps the next line < 80 characters.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1473 @qcode{"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1474 @xbackslashchar{}b@xbackslashchar{}r@xbackslashchar{}n@xbackslashchar{}t"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1475 (note the space). Unless whitespace is set to @qcode{""} (empty) AND at
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1476 least one @qcode{"%s"} format conversion specifier is supplied, a space is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1477 always part of whitespace.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1478
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1479 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1480
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1481 When the number of words in @var{str} or @var{fid} doesn't match an exact
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1482 multiple of the number of format conversion specifiers, @code{textscan}'s
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1483 behavior depends on whether the last character of the string or file is an
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1484 end-of-line as specified by the @code{EndOfLine} option:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1485
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1486 @table @asis
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1487 @item last character = end-of-line
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1488 Data columns are padded with empty fields, NaN or 0 (for integer fields) so
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1489 that all columns have equal length
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1490
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1491 @item last character is not end-of-line
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1492 Data columns are not padded; @code{textscan} returns columns of unequal
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1493 length
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1494 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1495
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1496 The second output @var{position} provides the location, in characters
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1497 from the beginning of the file or string, where processing stopped.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1498
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1499 @seealso{dlmread, fscanf, load, strread, textread}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1500 @end deftypefn */)
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1501 {
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1502 static std::string who = "textscan";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1503
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1504 return textscan_internal (interp, who, args);
21504 65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1505 }
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1506
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1507 DEFMETHOD (__textscan__, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1508 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1509 @deftypefn {} {@var{C} =} __textscan__ (@var{who}, @dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1510 Like @code{textscan} but accept additional argument @var{who} to use
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1511 as the name of the function when reporting errors.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1512 @end deftypefn */)
21504 65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1513 {
65d1daa7d7a7 new function __textscan__ John W. Eaton <jwe@octave.org> parents: 21503 diff changeset	1514 if (args.length () == 0)
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1515 print_usage ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1516
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1517 return textscan_internal (interp, args(0).string_value (),
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	1518 args.splice (0, 1));
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1519 }
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1520
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1521 /*
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1522 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1523 %! str = "1, 2, 3, 4\n 5, , , 8\n 9, 10, 11, 12";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1524 %! fmtstr = "%f %d %f %s";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1525 %! c = textscan (str, fmtstr, 2, "delimiter", ",", "emptyvalue", -Inf);
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1526 %! assert (c{1}, [1;5]);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1527 %! assert (c{3}, [3; -Inf]);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1528 %! assert (iscellstr (c{4}));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1529
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1530 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1531 %! b = [10:10:100];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1532 %! b = [b; 8*b/5];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1533 %! str = sprintf ("%g miles/hr = %g kilometers/hr\n", b);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1534 %! fmt = "%f miles/hr = %f kilometers/hr";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1535 %! c = textscan (str, fmt);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1536 %! assert (c{1}, b(1,:)', 1e-5);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1537 %! assert (c{2}, b(2,:)', 1e-5);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1538
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1539 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1540 %! str = "13, -, NA, str1, -25\r\n// Middle line\r\n36, na, 05, str3, 6";
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1541 %! c = textscan (str, "%d %n %f %s %n", "delimiter", ",",
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1542 %! "treatAsEmpty", {"NA", "na", "-"}, "commentStyle", "//");
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1543 %! assert (c{1}, int32 ([13; 36]));
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1544 %! assert (c{2}, [NaN; NaN]);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1545 %! assert (c{3}, [NaN; 5]);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1546 %! assert (c{4}, {"str1"; "str3"});
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1547 %! assert (c{5}, [-25; 6]);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1548
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1549 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1550 %! str = "Km:10 = hhhBjjj miles16hour\r\n";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1551 %! str = [str "Km:15 = hhhJjjj miles241hour\r\n"];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1552 %! str = [str "Km:2 = hhhRjjj miles3hour\r\n"];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1553 %! str = [str "Km:25 = hhhZ\r\n"];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1554 %! fmt = "Km:%d = hhh%1sjjj miles%dhour";
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1555 %! c = textscan (str, fmt, "delimiter", " ");
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1556 %! assert (c{1}', int32 ([10, 15, 2, 25]));
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1557 %! assert (c{2}', {'B' 'J' 'R' 'Z'});
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1558 %! assert (c{3}', int32 ([16, 241, 3, 0]));
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1559
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1560 ## Test with default EndOfLine parameter
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1561 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1562 %! c = textscan ("L1\nL2", "%s");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1563 %! assert (c{:}, {"L1"; "L2"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1564
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1565 ## Test with EndofLine parameter set to "" (empty) - newline should be in word
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1566 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1567 %! c = textscan ("L1\nL2", "%s", "endofline", "");
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1568 %! assert (int8 ([c{:}{:}]), int8 ([76, 49, 10, 76, 50]));
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1569
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1570 ## Matlab fails this test. A literal after a conversion is not a delimiter
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1571 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1572 %! ## No delimiters at all besides EOL. Skip fields, even empty fields
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1573 %! str = "Text1Text2Text\nTextText4Text\nText57Text";
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1574 %! c = textscan (str, "Text%*dText%dText");
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1575 %! assert (c{1}, int32 ([2; 4; 0]));
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1576
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1577 ## CollectOutput test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1578 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1579 %! b = [10:10:100];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1580 %! b = [b; 8b/5; 8b*1000/5];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1581 %! str = sprintf ("%g miles/hr = %g (%g) kilometers (meters)/hr\n", b);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1582 %! fmt = "%f miles%s %s %f (%f) kilometers %*s";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1583 %! c = textscan (str, fmt, "collectoutput", 1);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1584 %! assert (size (c{3}), [10, 2]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1585 %! assert (size (c{2}), [10, 2]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1586
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1587 ## CollectOutput test with uneven column length files
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1588 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1589 %! b = [10:10:100];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1590 %! b = [b; 8b/5; 8b*1000/5];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1591 %! str = sprintf ("%g miles/hr = %g (%g) kilometers (meters)/hr\n", b);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1592 %! str = [str "110 miles/hr"];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1593 %! fmt = "%f miles%s %s %f (%f) kilometers %*s";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1594 %! c = textscan (str, fmt, "collectoutput", 1);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1595 %! assert (size (c{1}), [11, 1]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1596 %! assert (size (c{3}), [11, 2]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1597 %! assert (size (c{2}), [11, 2]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1598 %! assert (c{3}(end), NaN);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1599 %! assert (c{2}{11, 1}, "/hr");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1600 %! assert (isempty (c{2}{11, 2}), true);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1601
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1602 ## Double quoted string
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1603 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1604 %! str = 'First "the second called ""the middle""" third';
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1605 %! fmt = "%q";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1606 %! c = textscan (str, fmt);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1607 %! assert (c{1}, {"First"; 'the second called "the middle"'; "third"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1608
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1609 ## Arbitrary character
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1610 %!test
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1611 %! c = textscan ("a first, \n second, third", "%s %c %11c", "delimiter", " ,");
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1612 %! assert (c{1}, {"a"; "ond"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1613 %! assert (c{2}, {"f"; "t"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1614 %! assert (c{3}, {"irst, \n sec"; "hird"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1615
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1616 ## Field width and non-standard delimiters
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1617 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1618 %! str = "12;34;123456789;7";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1619 %! c = textscan (str, "%4d %4d", "delimiter", ";", "collectOutput", 1);
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1620 %! assert (c, {[12, 34; 1234, 5678; 9, 7]});
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1621
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1622 ## Field width and non-standard delimiters (2)
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1623 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1624 %! str = "12;34;123456789;7";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1625 %! c = textscan (str, "%4f %f", "delimiter", ";", "collectOutput", 1);
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1626 %! assert (c, {[12, 34; 1234, 56789; 7, NaN]});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1627
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1628 ## Ignore trailing delimiter, but use leading one
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1629 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1630 %! str = "12.234e+2,34, \n12345.789-9876j,78\n,10\|3";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1631 %! c = textscan (str, "%10.2f %f", "delimiter", ",", "collectOutput", 1,
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1632 %! "expChars", "e\|");
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1633 %! assert (c, {[1223, 34; 12345.79-9876j, 78; NaN, 10000]}, 1e-6);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1634
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1635 ## Multi-character delimiter
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1636 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1637 %! str = "99end2 space88gap 4564";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1638 %! c = textscan (str, "%d %s", "delimiter", {"end", "gap", "space"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1639 %! assert (c{1}, int32 ([99; 88]));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1640 %! assert (c{2}, {"2 "; "4564"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1641
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1642 ## FIXME: Following two tests still fail (4/13/2016).
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1643 ## Delimiters as part of literals, and following literals
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1644 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1645 %! str = "12 R&D & 7";
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1646 %! c = textscan (str, "%f R&D %f", "delimiter", "&", "collectOutput", 1,
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1647 %! "EmptyValue", -99);
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1648 %! assert (c, {[12, -99; 7, -99]});
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1649
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1650 ## Delimiters as part of literals, and before literals
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1651 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1652 %! str = "12 & R&D 7";
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1653 %! c = textscan (str, "%f R&D %f", "delimiter", "&", "collectOutput", 1);
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1654 %! assert (c, {[12 7]});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1655
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1656 ## Check number of lines read, not number of passes through format string
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1657 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1658 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1659 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1660 %! fprintf (fid, "1\n2\n3\n4\n5\n6");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1661 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1662 %! c = textscan (fid, "%f %f", 2);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1663 %! E = feof (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1664 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1665 %! unlink (f);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1666 %! assert (c, {1, 2});
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1667 %! assert (! E);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1668
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1669 ## Check number of lines read, not number of passes through format string
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1670 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1671 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1672 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1673 %! fprintf (fid, "1\r\n2\r3\n4\r\n5\n6");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1674 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1675 %! c = textscan (fid, "%f %f", 4);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1676 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1677 %! unlink (f);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21566 diff changeset	1678 %! assert (c, {[1;3], [2;4]});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1679
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1680 ## Check number of lines read, with multiple delimiters
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1681 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1682 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1683 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1684 %! fprintf (fid, "1-\r\n-2\r3-\n-4\r\n5\n6");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1685 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1686 %! c = textscan (fid, "%f %f", 4, "delimiter", "-", "multipleDelimsAsOne", 1);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1687 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1688 %! unlink (f);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21566 diff changeset	1689 %! assert (c, {[1;3], [2;4]});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1690
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1691 ## Check ReturnOnError
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1692 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1693 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1694 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1695 %! str = "1 2 3\n4 s 6";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1696 %! fprintf (fid, str);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1697 %! fseek (fid, 0, "bof");
21622 fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538) Lachlan Andrew <lachlanbis@gmail.com> parents: 21621 diff changeset	1698 %! c = textscan (fid, "%f %f %f", "ReturnOnError", 1);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1699 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1700 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1701 %! unlink (f);
21622 fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538) Lachlan Andrew <lachlanbis@gmail.com> parents: 21621 diff changeset	1702 %! u = textscan (str, "%f %f %f", "ReturnOnError", 1);
fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538) Lachlan Andrew <lachlanbis@gmail.com> parents: 21621 diff changeset	1703 %! assert (c, {[1;4], [2], [3]});
fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538) Lachlan Andrew <lachlanbis@gmail.com> parents: 21621 diff changeset	1704 %! assert (u, {[1;4], [2], [3]});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1705
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1706 %! ## Check ReturnOnError (2)
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1707 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1708 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1709 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1710 %! str = "1 2 3\n4 s 6\n";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1711 %! fprintf (fid, str);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1712 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1713 %! c = textscan (fid, "%f %f %f", "ReturnOnError", 1);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1714 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1715 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1716 %! unlink (f);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1717 %! u = textscan (str, "%f %f %f", "ReturnOnError", 1);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21566 diff changeset	1718 %! assert (c, {[1;4], 2, 3});
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21566 diff changeset	1719 %! assert (u, {[1;4], 2, 3});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1720
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1721 %!error <Read error in field 2 of row 2>
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1722 %! textscan ("1 2 3\n4 s 6", "%f %f %f", "ReturnOnError", 0);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1723
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1724 ## Check ReturnOnError (3)
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1725 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1726 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1727 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1728 %! fprintf (fid, "1 s 3\n4 5 6");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1729 %! fseek (fid, 0, "bof");
21622 fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538) Lachlan Andrew <lachlanbis@gmail.com> parents: 21621 diff changeset	1730 %! c = textscan (fid, "", "ReturnOnError", 1);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1731 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1732 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1733 %! unlink (f);
21622 fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538) Lachlan Andrew <lachlanbis@gmail.com> parents: 21621 diff changeset	1734 %! assert (c, {1});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1735
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1736 ## Check ReturnOnError with empty fields
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1737 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1738 %! c = textscan ("1,,3\n4,5,6", "", "Delimiter", ",", "ReturnOnError", 1);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21566 diff changeset	1739 %! assert (c, {[1;4], [NaN;5], [3;6]});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1740
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1741 ## Check ReturnOnError with empty fields (2)
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1742 %!test
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1743 %! c = textscan ("1,,3\n4,5,6", "%f %f %f", "Delimiter", ",",
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1744 %! "ReturnOnError", 1);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21566 diff changeset	1745 %! assert (c, {[1;4], [NaN;5], [3;6]});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1746
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1747 ## Check ReturnOnError in first column
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1748 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1749 %! c = textscan ("1 2 3\ns 5 6", "", "ReturnOnError", 1);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21566 diff changeset	1750 %! assert (c, {1, 2, 3});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1751
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1752 ## FIXME: This test fails (4/14/16)
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1753 ## Test incomplete first data line
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1754 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1755 %! R = textscan (['Empty1' char(10)], 'Empty%d %f');
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1756 %! assert (R{1}, int32 (1));
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1757 %! assert (isempty (R{2}), true);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1758
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1759 %!test <*37023>
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1760 %! data = textscan (" 1. 1 \n 2 3\n", '%f %f');
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1761 %! assert (data{1}, [1; 2], 1e-15);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1762 %! assert (data{2}, [1; 3], 1e-15);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1763
22489 93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22407 diff changeset	1764 ## Whitespace test using delimiter ";"
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1765 %!test <*37333>
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1766 %! tc{1, 1} = "C:/code;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1767 %! tc{1, end+1} = "C:/code/meas;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1768 %! tc{1, end+1} = " C:/code/sim;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1769 %! tc{1, end+1} = "C:/code/utils;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1770 %! string = [tc{:}];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1771 %! c = textscan (string, "%s", "delimiter", ";");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1772 %! for k = 1:max (numel (c{1}), numel (tc))
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1773 %! lh = c{1}{k};
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1774 %! rh = tc{k};
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1775 %! rh(rh == ";") = "";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1776 %! rh = strtrim (rh);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1777 %! assert (strcmp (lh, rh));
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1778 %! endfor
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1779
22489 93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22407 diff changeset	1780 ## Whitespace test, adding multipleDelimsAsOne true arg
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1781 %!test <*37333>
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1782 %! tc{1, 1} = "C:/code;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1783 %! tc{1, end+1} = " C:/code/meas;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1784 %! tc{1, end+1} = "C:/code/sim;;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1785 %! tc{1, end+1} = "C:/code/utils;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1786 %! string = [tc{:}];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1787 %! c = textscan (string, "%s", "delimiter", ";", "multipleDelimsAsOne", 1);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1788 %! for k = 1:max (numel (c{1}), numel (tc))
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1789 %! lh = c{1}{k};
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1790 %! rh = tc{k};
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1791 %! rh(rh == ";") = "";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1792 %! rh = strtrim (rh);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1793 %! assert (strcmp (lh, rh));
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1794 %! endfor
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1795
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1796 ## Whitespace test (bug #37333), adding multipleDelimsAsOne false arg
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1797 %!test <*37333>
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1798 %! tc{1, 1} = "C:/code;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1799 %! tc{1, end+1} = " C:/code/meas;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1800 %! tc{1, end+1} = "C:/code/sim;;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1801 %! tc{1, end+1} = "";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1802 %! tc{1, end+1} = "C:/code/utils;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1803 %! string = [tc{:}];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1804 %! c = textscan (string, "%s", "delimiter", ";", "multipleDelimsAsOne", 0);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1805 %! for k = 1:max (numel (c{1}), numel (tc))
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1806 %! lh = c{1}{k};
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1807 %! rh = tc{k};
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1808 %! rh(rh == ";") = "";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1809 %! rh = strtrim (rh);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1810 %! assert (strcmp (lh, rh));
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1811 %! endfor
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1812
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1813 ## Whitespace test (bug #37333) whitespace "" arg
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1814 %!test <*37333>
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1815 %! tc{1, 1} = "C:/code;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1816 %! tc{1, end+1} = " C:/code/meas;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1817 %! tc{1, end+1} = "C:/code/sim;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1818 %! tc{1, end+1} = "C:/code/utils;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1819 %! string = [tc{:}];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1820 %! c = textscan (string, "%s", "delimiter", ";", "whitespace", "");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1821 %! for k = 1:max (numel (c{1}), numel (tc))
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1822 %! lh = c{1}{k};
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1823 %! rh = tc{k};
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1824 %! rh(rh == ";") = "";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1825 %! assert (strcmp (lh, rh));
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1826 %! endfor
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1827
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1828 ## Whitespace test (bug #37333), whitespace " " arg
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1829 %!test <*37333>
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1830 %! tc{1, 1} = "C:/code;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1831 %! tc{1, end+1} = " C:/code/meas;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1832 %! tc{1, end+1} = "C:/code/sim;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1833 %! tc{1, end+1} = "C:/code/utils;";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1834 %! string = [tc{:}];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1835 %! c = textscan (string, "%s", "delimiter", ";", "whitespace", " ");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1836 %! for k = 1:max (numel (c{1}), numel (tc))
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1837 %! lh = c{1}{k};
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1838 %! rh = tc{k};
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1839 %! rh(rh == ";") = "";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1840 %! rh = strtrim (rh);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1841 %! assert (strcmp (lh, rh));
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1842 %! endfor
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1843
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1844 ## Tests reading with empty format, should return proper nr of columns
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1845 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1846 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1847 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1848 %! fprintf (fid, " 1 2 3 4\n5 6 7 8");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1849 %! fseek (fid, 0, "bof");
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1850 %! C = textscan (fid, "");
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1851 %! E = feof (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1852 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1853 %! unlink (f);
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1854 %! assert (C{1}, [1 ; 5], 1e-6);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1855 %! assert (C{2}, [2 ; 6], 1e-6);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1856 %! assert (C{3}, [3 ; 7], 1e-6);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1857 %! assert (C{4}, [4 ; 8], 1e-6);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1858 %! assert (E);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1859
21621 fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1860 ## Test leaving the file at the correct position on exit
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1861 %!test
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1862 %! f = tempname ();
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1863 %! fid = fopen (f, "w+");
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1864 %! fprintf (fid, "1,2\n3,4\n");
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1865 %! fseek (fid, 0, "bof");
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1866 %! C = textscan (fid, "%s %f", 2, "Delimiter", ",");
21621 fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1867 %! E = ftell (fid);
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1868 %! fclose (fid);
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1869 %! unlink (f);
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1870 %! assert (E, 8);
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671) Lachlan Andrew <lachlanbis@gmail.com> parents: 21581 diff changeset	1871
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1872 ## Tests reading with empty format; empty fields & incomplete lower row
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1873 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1874 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1875 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1876 %! fprintf (fid, " ,2,,4\n5,6");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1877 %! fseek (fid, 0, "bof");
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1878 %! C = textscan (fid, "", "delimiter", ",", "EmptyValue", 999,
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1879 %! "CollectOutput" , 1);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1880 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1881 %! unlink (f);
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1882 %! assert (C{1}, [999, 2, 999, 4; 5, 6, 999, 999], 1e-6);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1883
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1884 ## Error message tests
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1885
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1886 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1887 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1888 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1889 %! msg1 = "textscan: 1 parameters given, but only 0 values";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1890 %! try
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1891 %! C = textscan (fid, "", "headerlines");
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1892 %! end_try_catch;
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1893 %! assert (! feof (fid));
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1894 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1895 %! unlink (f);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1896 %! assert (msg1, lasterr);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1897
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1898 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1899 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1900 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1901 %! msg1 = "textscan: HeaderLines must be numeric";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1902 %! try
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1903 %! C = textscan (fid, "", "headerlines", "hh");
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1904 %! end_try_catch;
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1905 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1906 %! unlink (f);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1907 %! assert (msg1, lasterr);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1908
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1909 ## Skip headerlines
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1910 %!test
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1911 %! C = textscan ("field 1 field2\n 1 2\n3 4", "", "headerlines", 1,
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1912 %! "collectOutput", 1);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1913 %! assert (C, {[1 2; 3 4]});
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1914
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1915 ## Skip headerlines with non-default EOL
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1916 %!test
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1917 %! C = textscan ("field 1 field2\r 1 2\r3 4", "", "headerlines", 2,
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1918 %! "collectOutput", 1, "EndOfLine", '\r');
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1919 %! assert (C, {[3 4]});
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1920
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1921 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1922 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1923 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1924 %! fprintf (fid,"some_string");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1925 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1926 %! msg1 = "textscan: EndOfLine must be at most one character or '\\r\\n'";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1927 %! try
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1928 %! C = textscan (fid, "%f", "EndOfLine", "\n\r");
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1929 %! end_try_catch;
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1930 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1931 %! unlink (f);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1932 %! assert (msg1, lasterr);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1933
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1934 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1935 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1936 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1937 %! fprintf (fid,"some_string");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1938 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1939 %! msg1 = "textscan: EndOfLine must be at most one character or '\\r\\n'";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1940 %! try
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1941 %! C = textscan (fid, "%f", "EndOfLine", 33);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1942 %! end_try_catch;
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1943 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1944 %! unlink (f);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1945 %! assert (msg1, lasterr);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1946
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1947 %!assert <*41824> (textscan ("123", "", "whitespace", " "){:}, 123);
22489 93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22407 diff changeset	1948
93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22407 diff changeset	1949 ## just test supplied emptyvalue
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1950 %!assert <*42343> (textscan (",NaN", "", "delimiter", "," ,"emptyValue" ,Inf),
22489 93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22407 diff changeset	1951 %! {Inf, NaN})
93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22407 diff changeset	1952
93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22407 diff changeset	1953 ## test padding with supplied emptyvalue
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1954 %!test <*42343>
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1955 %! c = textscan (",1,,4\nInf, ,NaN\n", "", "delimiter", ",",
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1956 %! "emptyvalue", -10);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1957 %! assert (cell2mat (c), [-10, 1, -10, 4; Inf, -10, NaN, -10]);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1958
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1959 %!test <*42528>
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1960 %! assert (textscan ("1i", ""){1}, 0+1i);
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1961 %! C = textscan ("3, 2-4i, NaN\n -i, 1, 23.4+2.2i\n 1+1 1+1j", "",
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1962 %! "delimiter", ",");
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1963 %! assert (cell2mat (C), [3+0i, 2-4i, NaN+0i; 0-i, 1+0i, 23.4+2.2i; 1 1 1+1i]);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1964
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1965 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1966 %! ## TreatAsEmpty
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1967 %! C = textscan ("1,2,3,NN,5,6\n", "%d%d%d%f", "delimiter", ",",
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1968 %! "TreatAsEmpty", "NN");
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1969 %! assert (C{3}(1), int32 (3));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1970 %! assert (C{4}(1), NaN);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1971
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1972 ## MultipleDelimsAsOne
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1973 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1974 %! str = "11, 12, 13,, 15\n21,, 23, 24, 25\n,, 33, 34, 35\n";
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1975 %! C = textscan (str, "%f %f %f %f", "delimiter", ",",
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1976 %! "multipledelimsasone", 1, "endofline", "\n");
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1977 %! assert (C{1}', [11, 21, 33]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1978 %! assert (C{2}', [12, 23, 34]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1979 %! assert (C{3}', [13, 24, 35]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1980 %! assert (C{4}', [15, 25, NaN]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	1981
21551 990c6c31a684 Accept escape sequences in single quoted strings for "delimiter" (bug #47539) Lachlan Andrew <lachlanbis@gmail.com> parents: 21548 diff changeset	1982 ## Single-quoted escape sequences
990c6c31a684 Accept escape sequences in single quoted strings for "delimiter" (bug #47539) Lachlan Andrew <lachlanbis@gmail.com> parents: 21548 diff changeset	1983 %!test
990c6c31a684 Accept escape sequences in single quoted strings for "delimiter" (bug #47539) Lachlan Andrew <lachlanbis@gmail.com> parents: 21548 diff changeset	1984 %! str = "11\t12\t13\r21\t22\t23";
990c6c31a684 Accept escape sequences in single quoted strings for "delimiter" (bug #47539) Lachlan Andrew <lachlanbis@gmail.com> parents: 21548 diff changeset	1985 %! c = textscan (str, "", "delimiter", '\t', "EndOfLine", '\r');
990c6c31a684 Accept escape sequences in single quoted strings for "delimiter" (bug #47539) Lachlan Andrew <lachlanbis@gmail.com> parents: 21548 diff changeset	1986 %! assert (c{1}', [11, 21]);
990c6c31a684 Accept escape sequences in single quoted strings for "delimiter" (bug #47539) Lachlan Andrew <lachlanbis@gmail.com> parents: 21548 diff changeset	1987 %! assert (c{2}', [12, 22]);
990c6c31a684 Accept escape sequences in single quoted strings for "delimiter" (bug #47539) Lachlan Andrew <lachlanbis@gmail.com> parents: 21548 diff changeset	1988 %! assert (c{3}', [13, 23]);
990c6c31a684 Accept escape sequences in single quoted strings for "delimiter" (bug #47539) Lachlan Andrew <lachlanbis@gmail.com> parents: 21548 diff changeset	1989
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	1990 %!test <*44750>
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1991 %! c = textscan ("/home/foo/", "%s", "delimiter", "/",
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1992 %! "MultipleDelimsAsOne", 1);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1993 %! assert (c{1}, {"home"; "foo"});
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1994
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1995 ## FIXME: Test still fails (4/13/2016).
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	1996 ## Allow cuddling %sliteral, but warn it is ambiguous
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1997 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1998 %! C = textscan ("abcxyz51\nxyz83\n##xyz101", "%s xyz %d");
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	1999 %! assert (C{1}([1 3]), {"abc"; "##"});
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	2000 %! assert (isempty (C{1}{2}), true);
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	2001 %! assert (C{2}, int32 ([51; 83; 101]));
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	2002
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	2003 ## Literals are not delimiters.
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2004
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2005 ## Test for false positives in check for non-supported format specifiers
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2006 %!test
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2007 %! c = textscan ("Total: 32.5 % (of cm values)",
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2008 %! "Total: %f %% (of cm values)");
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2009 %! assert (c{1}, 32.5, 1e-5);
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2010
22489 93ea313301f9 test: Add bug ids (<#####>) to BIST tests. Rik <rik@octave.org> parents: 22407 diff changeset	2011 ## Test various forms of string format specifiers
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	2012 %!test <*45712>
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2013 %! str = "14 :1 z:2 z:3 z:5 z:11";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2014 %! C = textscan (str, "%f %s %s %3s %3s %f", "delimiter", ":");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2015 %! assert (C, {14, {"1 z"}, {"3 z"}, 11});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2016
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2017 ## Bit width, fixed width conversion specifiers
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2018 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2019 %! str2 = "123456789012345 ";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2020 %! str2 = [str2 str2 str2 str2 str2 str2 str2 str2];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2021 %! str2 = [str2 "123456789.01234 1234567890.1234 12345.678901234 12345.678901234"];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2022 %! pttrn = "%3u8%s %5u16%s %10u32%s %15u64 %3d8%s %5d16%s %10d32%s %15d64 %9f32%s %14f64%s %10.2f32%s %12.2f64%s";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2023 %! C = textscan (str2, pttrn, "delimiter", " ");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2024 %! assert (C{1}, uint8 (123));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2025 %! assert (C{2}, uint16 (12345));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2026 %! assert (C{3}, uint32 (1234567890));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2027 %! assert (C{4}, uint64 (123456789012345));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2028 %! assert (C{5}, int8 (123));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2029 %! assert (C{6}, int16 (12345));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2030 %! assert (C{7}, int32 (1234567890));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2031 %! assert (C{8}, int64 (123456789012345));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2032 %! assert (C{9}, single (123456789), 1e-12);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2033 %! assert (C{10}, double (1234567890.123), 1e-15);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2034 %! assert (C{11}, single (12345.68), 1e-5);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2035 %! assert (C{12}, double (12345.68), 1e-11);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2036
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2037 ## Bit width, fixed width conv. specifiers -- check the right amount is left
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2038 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2039 %! str2 = "123456789012345 ";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2040 %! str2 = [str2 str2 "123456789.01234"];
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2041 %! pttrn = "%3u8 %5u16 %10u32 %3d8 %5d16 %10d32 %9f32 %9f";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2042 %! C = textscan (str2, pttrn, "delimiter", " ");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2043 %! assert (C{1}, uint8 (123));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2044 %! assert (C{2}, uint16 (45678));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2045 %! assert (C{3}, uint32 (9012345));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2046 %! assert (C{4}, int8 (123));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2047 %! assert (C{5}, int16 (45678));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2048 %! assert (C{6}, int32 (9012345));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2049 %! assert (C{7}, single (123456789), 1e-12);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2050 %! assert (C{8}, double (0.01234), 1e-12);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2051
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2052 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2053 %! C = textscan ("123.123", "%2f %3f %3f");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2054 %! assert (C{1}, 12);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2055 %! assert (C{2}, 3.1, 1e-11);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2056 %! assert (C{3}, 23);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2057
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2058 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2059 %! C = textscan ("123.123", "%3f %3f %3f");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2060 %! assert (C{1}, 123);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2061 %! assert (C{2}, 0.12, 1e-11);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2062 %! assert (C{3}, 3);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2063
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2064 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2065 %! C = textscan ("123.123", "%4f %3f");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2066 %! assert (C{1}, 123);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2067 %! assert (C{2}, 123);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2068
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2069 ## field width interrupts exponent. (Matlab incorrectly gives [12, 2e12])
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2070 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2071 %! assert (textscan ("12e12", "%4f"), {[120; 2]});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2072 %! assert (textscan ("12e+12", "%5f"), {[120; 2]});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2073 %! assert (textscan ("125e-12","%6f"), {[12.5; 2]});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2074
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2075 ## %[] tests
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2076 ## Plain [..] and *[..]
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2077 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2078 %! ar = "abcdefguvwxAny\nacegxyzTrailing\nJunk";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2079 %! C = textscan (ar, "%[abcdefg] %*[uvwxyz] %s");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2080 %! assert (C{1}, {"abcdefg"; "aceg"; ""});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2081 %! assert (C{2}, {"Any"; "Trailing"; "Junk"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2082
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2083 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2084 %! assert (textscan ("A2 B2 C3", "%*[ABC]%d", 3), {int32([2; 2; 3])});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2085
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2086 ## [^..] and *[^..]
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2087 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2088 %! br = "abcdefguvwx1Any\nacegxyz2Trailing\n3Junk";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2089 %! C = textscan (br, "%[abcdefg] %*[^0123456789] %s");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2090 %! assert (C{1}, {"abcdefg"; "aceg"; ""});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2091 %! assert (C{2}, {"1Any"; "2Trailing"; "3Junk"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2092
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2093 ## [..] and [^..] containing delimiters
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2094 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2095 %! cr = "ab cd efguv wx1Any\na ce gx yz2Trailing\n 3Junk";
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2096 %! C = textscan (cr, "%[ abcdefg] %*[^0123456789] %s", "delimiter", " \n",
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2097 %! "whitespace", "");
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2098 %! assert (C{1}, {"ab cd efg"; "a ce g"; " "});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2099 %! assert (C{2}, {"1Any"; "2Trailing"; "3Junk"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2100
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	2101 %!assert <36464> (textscan ("1 2 3 4 5 6", "%n%n%*[^\n]"){1}, 2);
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2102
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2103 ## test %[]] and %[^]]
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2104 %!test
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2105 %! assert (textscan ("345]", "%*[123456]%[]]"){1}{1}, "]");
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2106 %! assert (textscan ("345]", "%*[^]]%s"){1}{1}, "]");
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2107
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2108 ## Test that "-i" checks the next two characters
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2109 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2110 %! C = textscan ("-i -in -inf -infinity", "%f %f%s %f %f %s");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2111 %! assert (C, {-i, -i, {"n"}, -Inf, -Inf, {"inity"}});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2112
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2113 ## Again for "+i", this time with custom parser
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2114 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2115 %! C = textscan ("+i +in +inf +infinity", "%f %f%s %f %f %s", "ExpChars", "eE");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2116 %! assert (C, {i, i, {"n"}, Inf, Inf, {"inity"}});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2117
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2118 ## Check single quoted format interprets control sequences
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2119 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2120 %! C = textscan ("1 2\t3 4", '%f %[^\t] %f %f');
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2121 %! assert (C, {1, {"2"}, 3, 4});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2122
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	2123 ## Check a non-empty line with no valid conversion registers empytValue
21532 936ab0fca2f7 Textscan returns emptyVal for rows with literal but no conversion (bug #47458) Lachlan Andrew <lachlanbis@gmail.com> parents: 21507 diff changeset	2124 %!test
936ab0fca2f7 Textscan returns emptyVal for rows with literal but no conversion (bug #47458) Lachlan Andrew <lachlanbis@gmail.com> parents: 21507 diff changeset	2125 %! C = textscan ("Empty\n", "Empty%f %f");
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21566 diff changeset	2126 %! assert (C, { NaN, NaN });
21532 936ab0fca2f7 Textscan returns emptyVal for rows with literal but no conversion (bug #47458) Lachlan Andrew <lachlanbis@gmail.com> parents: 21507 diff changeset	2127
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2128 ## Check overflow and underflow of integer types
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2129 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2130 %! a = "-1e90 ";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2131 %! b = "1e90 ";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2132 %! fmt = "%d8 %d16 %d32 %d64 %u8 %u16 %u32 %u64 ";
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2133 %! C = textscan ([a a a a a a a a b b b b b b b b], fmt);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2134 %! assert (C{1}, int8 ([-128; 127]));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2135 %! assert (C{2}, int16 ([-32768; 32767]));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2136 %! assert (C{3}, int32 ([-2147483648; 2147483647]));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2137 %! assert (C{4}, int64 ([-9223372036854775808; 9223372036854775807]));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2138 %! assert (C{5}, uint8 ([0; 255]));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2139 %! assert (C{6}, uint16 ([0; 65535]));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2140 %! assert (C{7}, uint32 ([0; 4294967295]));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2141 %! assert (C{8}, uint64 ([0; 18446744073709551615]));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2142
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2143 ## Tests from Matlab (does The MathWorks have any copyright over the input?)
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2144 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2145 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2146 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2147 %! fprintf (fid,"09/12/2005 Level1 12.34 45 1.23e10 inf Nan Yes 5.1+3i\n");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2148 %! fprintf (fid,"10/12/2005 Level2 23.54 60 9e19 -inf 0.001 No 2.2-.5i\n");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2149 %! fprintf (fid,"11/12/2005 Level3 34.90 12 2e5 10 100 No 3.1+.1i\n");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2150 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2151 %! C = textscan (fid,"%s %s %f32 %d8 %u %f %f %s %f");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2152 %! %assert (C{1}, {"09/12/2005";"10/12/2005";"11/12/2005"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2153 %! assert (C{2}, {"Level1";"Level2";"Level3"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2154 %! assert (C{3}, [single(12.34);single(23.54);single(34.90)]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2155 %! assert (C{4}, [int8(45);int8(60);int8(12)]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2156 %! assert (C{5}, [uint32(4294967295);uint32(4294967295);uint32(200000)]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2157 %! assert (C{6}, [inf;-inf;10]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2158 %! assert (C{7}, [NaN;0.001;100], eps);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2159 %! assert (C{8}, {"Yes";"No";"No"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2160 %! assert (C{9}, [5.1+3i;2.2-0.5i;3.1+0.1i]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2161 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2162 %! C = textscan (fid,"%s Level%d %f32 %d8 %u %f %f %s %f");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2163 %! assert (C{2}, [int32(1);int32(2);int32(3)]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2164 %! assert (C{3}, [single(12.34);single(23.54);single(34.90)]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2165 %! fseek (fid, 0, "bof");
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2166 %! C = textscan (fid, '%s %*[^\n]');
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2167 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2168 %! unlink (f);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2169 %! assert (C, {{"09/12/2005";"10/12/2005";"11/12/2005"}});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2170
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2171 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2172 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2173 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2174 %! fprintf (fid,"1, 2, 3, 4, , 6\n");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2175 %! fprintf (fid,"7, 8, 9, , 11, 12\n");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2176 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2177 %! C = textscan (fid,"%f %f %f %f %u8 %f", "Delimiter",",","EmptyValue",-Inf);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2178 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2179 %! unlink (f);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2180 %! assert (C{4}, [4; -Inf]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2181 %! assert (C{5}, uint8 ([0; 11]));
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2182
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2183 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2184 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2185 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2186 %! fprintf (fid,"abc, 2, NA, 3, 4\n");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2187 %! fprintf (fid,"// Comment Here\n");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2188 %! fprintf (fid,"def, na, 5, 6, 7\n");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2189 %! fseek (fid, 0, "bof");
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2190 %! C = textscan (fid, "%s %n %n %n %n", "Delimiter", ",",
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2191 %! "TreatAsEmpty", {"NA","na"}, "CommentStyle", "//");
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2192 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2193 %! unlink (f);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2194 %! assert (C{1}, {"abc";"def"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2195 %! assert (C{2}, [2; NaN]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2196 %! assert (C{3}, [NaN; 5]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2197 %! assert (C{4}, [3; 6]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2198 %! assert (C{5}, [4; 7]);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2199
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2200 ## FIXME: Almost passes. Second return value is {"/"}. Tested 4/14/16.
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	2201 ## Test start of comment as string
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	2202 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	2203 %! c = textscan ("1 / 2 // 3", "%n %s %u8", "CommentStyle", {"//"});
7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22725 diff changeset	2204 %! assert (c(1), {1, "/", 2});
21507 2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	2205
2cdbae31c022 improve compatibility of textscan for character arrays John W. Eaton <jwe@octave.org> parents: 21506 diff changeset	2206 %!assert (textscan (["1 2 3 4"; "5 6 7 8"], "%f"), {[15; 26; 37; 48]})
21566 02826fb0f261 textscan: Fix bug in exponent parsing Mike Miller <mtmiller@octave.org> parents: 21551 diff changeset	2207
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2208 ## Check for delimiter after exponent
21566 02826fb0f261 textscan: Fix bug in exponent parsing Mike Miller <mtmiller@octave.org> parents: 21551 diff changeset	2209 %!assert (textscan ("1e-3\|42", "%f", "delimiter", "\|"), {[1e-3; 42]})
24303 ddc91a2ee0e0 Remove all delimiters from whitespace list in textscan function (bug #52479). Daniel J Sebald <daniel.sebald@ieee.org> parents: 23219 diff changeset	2210
ddc91a2ee0e0 Remove all delimiters from whitespace list in textscan function (bug #52479). Daniel J Sebald <daniel.sebald@ieee.org> parents: 23219 diff changeset	2211 %!test <*52479>
ddc91a2ee0e0 Remove all delimiters from whitespace list in textscan function (bug #52479). Daniel J Sebald <daniel.sebald@ieee.org> parents: 23219 diff changeset	2212 %! str = "\t\ta\tb\tc\n";
ddc91a2ee0e0 Remove all delimiters from whitespace list in textscan function (bug #52479). Daniel J Sebald <daniel.sebald@ieee.org> parents: 23219 diff changeset	2213 %! ret = textscan (str, "%s", "delimiter", "\t");
24346 f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2214 %! assert (ret, { {''; ''; 'a'; 'b'; 'c'} });
24303 ddc91a2ee0e0 Remove all delimiters from whitespace list in textscan function (bug #52479). Daniel J Sebald <daniel.sebald@ieee.org> parents: 23219 diff changeset	2215
24310 4dce9d03b2ba Remove regression mark for second BIST test for textscan bug #52479. Rik <rik@octave.org> parents: 24304 diff changeset	2216 %!test <52479>
24303 ddc91a2ee0e0 Remove all delimiters from whitespace list in textscan function (bug #52479). Daniel J Sebald <daniel.sebald@ieee.org> parents: 23219 diff changeset	2217 %! str = "\t\ta\tb\tc\n";
ddc91a2ee0e0 Remove all delimiters from whitespace list in textscan function (bug #52479). Daniel J Sebald <daniel.sebald@ieee.org> parents: 23219 diff changeset	2218 %! ret = textscan (str, "%s", "delimiter", {"\t"});
24346 f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2219 %! assert (ret, { {''; ''; 'a'; 'b'; 'c'} });
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2220
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2221 %!test <52550>
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2222 %! str = ",,1,2,3\n";
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2223 %! obs = textscan (str, "%d", "delimiter", ",");
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2224 %! assert (obs, { [0; 0; 1; 2; 3] });
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2225 %! obs = textscan (str, "%d", "delimiter", {","});
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2226 %! assert (obs, { [0; 0; 1; 2; 3] });
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2227
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2228 %!test <52550>
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2229 %! str = " , ,1,2,3\n";
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2230 %! obs = textscan (str, "%d", "delimiter", ",");
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2231 %! assert (obs, { [0; 0; 1; 2; 3] });
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2232 %! textscan (str, "%d", "delimiter", {","});
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2233 %! assert (obs, { [0; 0; 1; 2; 3] });
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2234
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2235 %!test <52550>
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2236 %! str = " 0 , 5+6j , -INF+INFj ,NaN,3\n";
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2237 %! obs = textscan (str, "%f", "delimiter", ",");
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2238 %! assert (obs, { [0; 5+6i; complex(-Inf,Inf); NaN; 3] });
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2239 %! obs = textscan (str, "%f", "delimiter", {","});
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2240 %! assert (obs, { [0; 5+6i; complex(-Inf,Inf); NaN; 3] });
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2241
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2242 %!test <52550>
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2243 %! str = " 0;,;,1;,2;,3\n";
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2244 %! assert (textscan (str, "%f", "delimiter", {";,"}), { [0; NaN; 1; 2; 3] });
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2245
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2246 %!test <52550>
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2247 %! str = " 0 ;1 , $ 2 ;3\n";
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2248 %! obs = textscan (str, "%f", "delimiter", ",;$");
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2249 %! assert (obs, { [0; 1; NaN; 2; 3] });
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2250 %! obs = textscan (str, "%f", "delimiter", {",",";","$"});
f77da8da0f3f Fix textscan missing fields and number reads for cell-specified delimiters (bug #52550). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24310 diff changeset	2251 %! assert (obs, { [0; 1; NaN; 2; 3] });
24303 ddc91a2ee0e0 Remove all delimiters from whitespace list in textscan function (bug #52479). Daniel J Sebald <daniel.sebald@ieee.org> parents: 23219 diff changeset	2252
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2253 */
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2254
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2255 // These tests have end-comment sequences, so can't just be in a comment
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2256 #if 0
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2257 ## Test unfinished comment
21502 7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2258 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2259 %! c = textscan ("1 2 /* half comment", "%n %u8", "CommentStyle", {"/", "/"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2260 %! assert (c, {1, 2});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2261
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2262 ## Test reading from a real file
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2263 %!test
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2264 %! f = tempname ();
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2265 %! fid = fopen (f, "w+");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2266 %! d = rand (1, 4);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2267 %! fprintf (fid, " %f %f /* comment */ %f %f ", d);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2268 %! fseek (fid, 0, "bof");
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2269 %! A = textscan (fid, "%f %f", "CommentStyle", {"/", "/"});
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2270 %! E = feof (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2271 %! fclose (fid);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2272 %! unlink (f);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2273 %! assert (A{1}, [d(1); d(3)], 1e-6);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2274 %! assert (A{2}, [d(2); d(4)], 1e-6);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2275 %! assert (E);
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2276 #endif
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc John W. Eaton <jwe@octave.org> parents: 21457 diff changeset	2277
21625 3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2278 /*
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2279 ## Test input validation
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2280 %!error textscan ()
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2281 %!error textscan (single (40))
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2282 %!error textscan ({40})
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2283 %!error <must be a string> textscan ("Hello World", 2)
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2284 %!error <at most one character or>
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2285 %! textscan ("Hello World", "%s", "EndOfLine", 3);
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2286 %!error <'%z' is not a valid format specifier> textscan ("1.0", "%z")
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2287 %!error <no valid format conversion specifiers> textscan ("1.0", "foo")
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2288 */
3cadca91e390 Clean up BIST tests for textscan. Rik <rik@octave.org> parents: 21622 diff changeset	2289
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2290 static octave_value
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	2291 do_fread (octave::stream& os, const octave_value& size_arg,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	2292 const octave_value& prec_arg, const octave_value& skip_arg,
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	2293 const octave_value& arch_arg, octave_idx_type& count)
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2294 {
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2295 count = -1;
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2296
20703 85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	2297 Array<double> size = size_arg.xvector_value ("fread: invalid SIZE specified");
85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	2298
85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	2299 std::string prec = prec_arg.xstring_value ("fread: PRECISION must be a string");
85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	2300
85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	2301 int block_size = 1;
85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	2302 oct_data_conv::data_type input_type;
85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	2303 oct_data_conv::data_type output_type;
85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	2304
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2305 try
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2306 {
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2307 oct_data_conv::string_to_data_type (prec, block_size,
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2308 input_type, output_type);
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2309 }
22327 d0562b3159c7 move more classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	2310 catch (octave::execution_exception& e)
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2311 {
20756 200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks John W. Eaton <jwe@octave.org> parents: 20747 diff changeset	2312 error (e, "fread: invalid PRECISION specified");
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2313 }
4944 44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe] jwe parents: 4933 diff changeset	2314
20747 ee2743bd07a8 eliminate various compiler warnings John W. Eaton <jwe@octave.org> parents: 20741 diff changeset	2315 int skip = 0;
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3180 diff changeset	2316
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2317 try
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2318 {
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2319 skip = skip_arg.int_value (true);
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2320 }
22327 d0562b3159c7 move more classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	2321 catch (octave::execution_exception& e)
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2322 {
20756 200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks John W. Eaton <jwe@octave.org> parents: 20747 diff changeset	2323 error (e, "fread: SKIP must be an integer");
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2324 }
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2325
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2326 std::string arch = arch_arg.xstring_value ("fread: ARCH architecture type must be a string");
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2327
21739 c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	2328 octave::mach_info::float_format flt_fmt
c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	2329 = octave::mach_info::string_to_float_format (arch);
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2330
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2331 return os.read (size, block_size, input_type, output_type, skip,
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2332 flt_fmt, count);
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2333 }
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2334
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2335 DEFMETHOD (fread, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2336 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2337 @deftypefn {} {@var{val} =} fread (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2338 @deftypefnx {} {@var{val} =} fread (@var{fid}, @var{size})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2339 @deftypefnx {} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2340 @deftypefnx {} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision}, @var{skip})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2341 @deftypefnx {} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision}, @var{skip}, @var{arch})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2342 @deftypefnx {} {[@var{val}, @var{count}] =} fread (@dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2343 Read binary data from the file specified by the file descriptor @var{fid}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2344
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2345 The optional argument @var{size} specifies the amount of data to read
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2346 and may be one of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2347
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2348 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2349 @item Inf
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2350 Read as much as possible, returning a column vector.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2351
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2352 @item @var{nr}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2353 Read up to @var{nr} elements, returning a column vector.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2354
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2355 @item [@var{nr}, Inf]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2356 Read as much as possible, returning a matrix with @var{nr} rows. If the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2357 number of elements read is not an exact multiple of @var{nr}, the last
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2358 column is padded with zeros.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2359
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2360 @item [@var{nr}, @var{nc}]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2361 Read up to @code{@var{nr} * @var{nc}} elements, returning a matrix with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2362 @var{nr} rows. If the number of elements read is not an exact multiple
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2363 of @var{nr}, the last column is padded with zeros.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2364 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2365
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2366 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2367 If @var{size} is omitted, a value of @code{Inf} is assumed.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2368
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2369 The optional argument @var{precision} is a string specifying the type of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2370 data to read and may be one of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2371
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2372 @table @asis
23982 3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2373 @item @qcode{"uint8"} (default)
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2374 8-bit unsigned integer.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2375
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2376 @item @qcode{"int8"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2377 @itemx @qcode{"integer*1"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2378 8-bit signed integer.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2379
23982 3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2380 @item @qcode{"uint16"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2381 @itemx @qcode{"ushort"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2382 @itemx @qcode{"unsigned short"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2383 16-bit unsigned integer.
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2384
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2385 @item @qcode{"int16"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2386 @itemx @qcode{"integer*2"}
23982 3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2387 @itemx @qcode{"short"}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2388 16-bit signed integer.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2389
23982 3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2390 @item @qcode{"uint"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2391 @itemx @qcode{"uint32"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2392 @itemx @qcode{"unsigned int"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2393 @itemx @qcode{"ulong"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2394 @itemx @qcode{"unsigned long"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2395 32-bit unsigned integer.
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2396
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2397 @item @qcode{"int"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2398 @itemx @qcode{"int32"}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2399 @itemx @qcode{"integer*4"}
23982 3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2400 @itemx @qcode{"long"}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2401 32-bit signed integer.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2402
23982 3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2403 @item @qcode{"uint64"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2404 64-bit unsigned integer.
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2405
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2406 @item @qcode{"int64"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2407 @itemx @qcode{"integer*8"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2408 64-bit signed integer.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2409
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2410 @item @qcode{"single"}
23949 58435a400d4e Document that fread 'float' size is 32 bits (bug #41672). Rik <rik@octave.org> parents: 23924 diff changeset	2411 @itemx @qcode{"float"}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2412 @itemx @qcode{"float32"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2413 @itemx @qcode{"real*4"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2414 32-bit floating point number.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2415
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2416 @item @qcode{"double"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2417 @itemx @qcode{"float64"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2418 @itemx @qcode{"real*8"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2419 64-bit floating point number.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2420
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2421 @item @qcode{"char"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2422 @itemx @qcode{"char*1"}
23982 3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2423 8-bit single character.
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2424
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2425 @item @qcode{"uchar"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2426 @itemx @qcode{"unsigned char"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2427 8-bit unsigned character.
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2428
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2429 @item @qcode{"schar"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2430 @itemx @qcode{"signed char"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2431 8-bit signed character.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2432
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2433 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2434
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2435 @noindent
23982 3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2436 The default precision is @qcode{"uint8"}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2437
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2438 The @var{precision} argument may also specify an optional repeat
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2439 count. For example, @samp{32*single} causes @code{fread} to read
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2440 a block of 32 single precision floating point numbers. Reading in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2441 blocks is useful in combination with the @var{skip} argument.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2442
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2443 The @var{precision} argument may also specify a type conversion.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2444 For example, @samp{int16=>int32} causes @code{fread} to read 16-bit
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2445 integer values and return an array of 32-bit integer values. By
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2446 default, @code{fread} returns a double precision array. The special
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2447 form @samp{*TYPE} is shorthand for @samp{TYPE=>TYPE}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2448
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2449 The conversion and repeat counts may be combined. For example, the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2450 specification @samp{32*single=>single} causes @code{fread} to read
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2451 blocks of single precision floating point values and return an array
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2452 of single precision values instead of the default array of double
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2453 precision values.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2454
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2455 The optional argument @var{skip} specifies the number of bytes to skip
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2456 after each element (or block of elements) is read. If it is not
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2457 specified, a value of 0 is assumed. If the final block read is not
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2458 complete, the final skip is omitted. For example,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2459
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2460 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2461 fread (f, 10, "3*single=>single", 8)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2462 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2463
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2464 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2465 will omit the final 8-byte skip because the last read will not be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2466 a complete block of 3 values.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2467
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2468 The optional argument @var{arch} is a string specifying the data format
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2469 for the file. Valid values are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2470
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2471 @table @asis
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2472 @item @qcode{"native"} or @qcode{"n"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2473 The format of the current machine.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2474
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2475 @item @qcode{"ieee-be"} or @qcode{"b"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2476 IEEE big endian.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2477
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2478 @item @qcode{"ieee-le"} or @qcode{"l"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2479 IEEE little endian.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2480 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2481
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2482 If no @var{arch} is given the value used in the call to @code{fopen} which
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2483 created the file descriptor is used. Otherwise, the value specified with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2484 @code{fread} overrides that of @code{fopen} and determines the data format.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2485
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2486 The output argument @var{val} contains the data read from the file.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2487
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2488 The optional return value @var{count} contains the number of elements read.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2489 @seealso{fwrite, fgets, fgetl, fscanf, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2490 @end deftypefn */)
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	2491 {
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2492 int nargin = args.length ();
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2493
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2494 if (nargin < 1 \|\| nargin > 5)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2495 print_usage ();
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2496
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2497 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2498
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2499 octave::stream os = streams.lookup (args(0), "fread");
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2500
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2501 octave_value size = lo_ieee_inf_value ();
23982 3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672). Rik <rik@octave.org> parents: 23949 diff changeset	2502 octave_value prec = "uint8";
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2503 octave_value skip = 0;
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2504 octave_value arch = "unknown";
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2505
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2506 int idx = 1;
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2507
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2508 if (nargin > idx && ! args(idx).is_string ())
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2509 size = args(idx++);
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2510
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2511 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2512 prec = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2513
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2514 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2515 skip = args(idx++);
4257 e556870ce8f0 [project @ 2003-01-02 03:14:41 by jwe] jwe parents: 4254 diff changeset	2516
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2517 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2518 arch = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2519 else if (skip.is_string ())
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2520 {
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2521 arch = skip;
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2522 skip = 0;
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2523 }
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2524
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2525 octave_idx_type count = -1;
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	2526
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2527 octave_value tmp = do_fread (os, size, prec, skip, arch, count);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2528
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	2529 return ovl (tmp, count);
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	2530 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	2531
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2532 static int
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	2533 do_fwrite (octave::stream& os, const octave_value& data,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	2534 const octave_value& prec_arg, const octave_value& skip_arg,
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	2535 const octave_value& arch_arg)
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2536 {
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20687 diff changeset	2537 std::string prec = prec_arg.xstring_value ("fwrite: PRECISION must be a string");
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20561 diff changeset	2538
fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20561 diff changeset	2539 int block_size = 1;
fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20561 diff changeset	2540 oct_data_conv::data_type output_type;
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2541
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2542 try
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20561 diff changeset	2543 {
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2544 oct_data_conv::string_to_data_type (prec, block_size, output_type);
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2545 }
22327 d0562b3159c7 move more classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	2546 catch (octave::execution_exception& e)
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2547 {
20756 200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks John W. Eaton <jwe@octave.org> parents: 20747 diff changeset	2548 error (e, "fwrite: invalid PRECISION specified");
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2549 }
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2550
20747 ee2743bd07a8 eliminate various compiler warnings John W. Eaton <jwe@octave.org> parents: 20741 diff changeset	2551 int skip = 0;
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 3180 diff changeset	2552
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2553 try
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2554 {
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2555 skip = skip_arg.int_value (true);
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2556 }
22327 d0562b3159c7 move more classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	2557 catch (octave::execution_exception& e)
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2558 {
20756 200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks John W. Eaton <jwe@octave.org> parents: 20747 diff changeset	2559 error (e, "fwrite: SKIP must be an integer");
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2560 }
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2561
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2562 std::string arch = arch_arg.xstring_value ("fwrite: ARCH architecture type must be a string");
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2563
21739 c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	2564 octave::mach_info::float_format flt_fmt
c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21736 diff changeset	2565 = octave::mach_info::string_to_float_format (arch);
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2566
a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	2567 return os.write (data, block_size, output_type, skip, flt_fmt);
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2568 }
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2569
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2570 DEFMETHOD (fwrite, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2571 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2572 @deftypefn {} {} fwrite (@var{fid}, @var{data})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2573 @deftypefnx {} {} fwrite (@var{fid}, @var{data}, @var{precision})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2574 @deftypefnx {} {} fwrite (@var{fid}, @var{data}, @var{precision}, @var{skip})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2575 @deftypefnx {} {} fwrite (@var{fid}, @var{data}, @var{precision}, @var{skip}, @var{arch})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2576 @deftypefnx {} {@var{count} =} fwrite (@dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2577 Write data in binary form to the file specified by the file descriptor
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2578 @var{fid}, returning the number of values @var{count} successfully written
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2579 to the file.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2580
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2581 The argument @var{data} is a matrix of values that are to be written to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2582 the file. The values are extracted in column-major order.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2583
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2584 The remaining arguments @var{precision}, @var{skip}, and @var{arch} are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2585 optional, and are interpreted as described for @code{fread}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2586
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2587 The behavior of @code{fwrite} is undefined if the values in @var{data}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2588 are too large to fit in the specified precision.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2589 @seealso{fread, fputs, fprintf, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2590 @end deftypefn */)
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	2591 {
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2592 int nargin = args.length ();
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2593
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2594 if (nargin < 2 \|\| nargin > 5)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	2595 print_usage ();
2116 99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe] jwe parents: 2095 diff changeset	2596
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2597 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2598
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2599 octave::stream os = streams.lookup (args(0), "fwrite");
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2600
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2601 octave_value prec = "uchar";
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2602 octave_value skip = 0;
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2603 octave_value arch = "unknown";
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2604
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2605 int idx = 1;
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2606
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2607 octave_value data = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2608
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2609 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2610 prec = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2611
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2612 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2613 skip = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2614
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2615 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2616 arch = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2617 else if (skip.is_string ())
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2618 {
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2619 arch = skip;
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2620 skip = 0;
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2621 }
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2622
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21126 diff changeset	2623 return ovl (do_fwrite (os, data, prec, skip, arch));
1181 b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	2624 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe] jwe parents: 1086 diff changeset	2625
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2626 DEFMETHODX ("feof", Ffeof, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2627 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2628 @deftypefn {} {@var{status} =} feof (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2629 Return 1 if an end-of-file condition has been encountered for the file
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2630 specified by file descriptor @var{fid} and 0 otherwise.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2631
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2632 Note that @code{feof} will only return 1 if the end of the file has already
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2633 been encountered, not if the next read operation will result in an
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2634 end-of-file condition.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2635 @seealso{fread, frewind, fseek, fclear, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2636 @end deftypefn */)
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 506 diff changeset	2637 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2638 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	2639 print_usage ();
444 ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	2640
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2641 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2642
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2643 octave::stream os = streams.lookup (args(0), "feof");
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2644
21127 df7891224709 maint: Use "return ovl (...)" in DEFUN macros. Rik <rik@octave.org> parents: 21126 diff changeset	2645 return ovl (os.eof () ? 1.0 : 0.0);
444 ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	2646 }
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe] jwe parents: 372 diff changeset	2647
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2648 DEFMETHODX ("ferror", Fferror, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2649 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2650 @deftypefn {} {@var{msg} =} ferror (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2651 @deftypefnx {} {[@var{msg}, @var{err}] =} ferror (@var{fid})
22725 37e53505e2eb doc: Use Texinfo dots macro to create ellipses. Rik <rik@octave.org> parents: 22720 diff changeset	2652 @deftypefnx {} {[@dots{}] =} ferror (@var{fid}, "clear")
24933 75a748cb08a6 doc: end first sentences of doc strings with a period (bug #53388) Mike Miller <mtmiller@octave.org> parents: 24801 diff changeset	2653 Query the error status of the stream specified by file descriptor @var{fid}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2654
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2655 If an error condition exists then return a string @var{msg} describing the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2656 error. Otherwise, return an empty string @qcode{""}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2657
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2658 The second input @qcode{"clear"} is optional. If supplied, the error
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2659 state on the stream will be cleared.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2660
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2661 The optional second output is a numeric indication of the error status.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2662 @var{err} is 1 if an error condition has been encountered and 0 otherwise.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2663
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2664 Note that @code{ferror} indicates if an error has already occurred, not
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2665 whether the next operation will result in an error condition.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2666 @seealso{fclear, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2667 @end deftypefn */)
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2668 {
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	2669 int nargin = args.length ();
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2670
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2671 if (nargin < 1 \|\| nargin > 2)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2672 print_usage ();
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2673
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2674 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2675
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2676 octave::stream os = streams.lookup (args(0), "ferror");
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2677
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2678 bool clear = false;
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	2679
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2680 if (nargin == 2)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2681 {
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2682 std::string opt = args(1).string_value ();
20561 c41595061186 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20457 diff changeset	2683
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2684 clear = (opt == "clear");
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2685 }
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	2686
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2687 int error_number = 0;
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2688
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2689 std::string error_message = os.error (clear, error_number);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2690
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	2691 return ovl (error_message, error_number);
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2692 }
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2693
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2694 DEFMETHODX ("popen", Fpopen, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2695 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2696 @deftypefn {} {@var{fid} =} popen (@var{command}, @var{mode})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2697 Start a process and create a pipe.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2698
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2699 The name of the command to run is given by @var{command}. The argument
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2700 @var{mode} may be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2701
22720 766b0163b3b7 doc: Don't create @tables of type @code with @qcode entries. Rik <rik@octave.org> parents: 22511 diff changeset	2702 @table @asis
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2703 @item @qcode{"r"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2704 The pipe will be connected to the standard output of the process, and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2705 open for reading.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2706
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2707 @item @qcode{"w"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2708 The pipe will be connected to the standard input of the process, and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2709 open for writing.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2710 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2711
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2712 The file identifier corresponding to the input or output stream of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2713 process is returned in @var{fid}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2714
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2715 For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2716
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2717 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2718 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2719 fid = popen ("ls -ltr / \| tail -3", "r");
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2720 while (ischar (s = fgets (fid)))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2721 fputs (stdout, s);
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2722 endwhile
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2723
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2724 @print{} drwxr-xr-x 33 root root 3072 Feb 15 13:28 etc
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2725 @print{} drwxr-xr-x 3 root root 1024 Feb 15 13:28 lib
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2726 @print{} drwxrwxrwt 15 root root 2048 Feb 17 14:53 tmp
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2727 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2728 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2729 @seealso{popen2}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2730 @end deftypefn */)
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2731 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2732 if (args.length () != 2)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2733 print_usage ();
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2734
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2735 std::string name = args(0).xstring_value ("popen: COMMAND must be a string");
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2736 std::string mode = args(1).xstring_value ("popen: MODE must be a string");
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2737
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	2738 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	2739
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2740 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2741
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2742 if (mode == "r")
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2743 {
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	2744 octave::stream ips = octave_iprocstream::create (name);
b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	2745
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2746 retval = streams.insert (ips);
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2747 }
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2748 else if (mode == "w")
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2749 {
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	2750 octave::stream ops = octave_oprocstream::create (name);
b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	2751
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2752 retval = streams.insert (ops);
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 1996 diff changeset	2753 }
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2754 else
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2755 error ("popen: invalid MODE specified");
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2756
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2757 return retval;
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2758 }
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2759
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2760 DEFMETHODX ("pclose", Fpclose, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2761 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2762 @deftypefn {} {} pclose (@var{fid})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2763 Close a file identifier that was opened by @code{popen}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2764
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2765 The function @code{fclose} may also be used for the same purpose.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2766 @seealso{fclose, popen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2767 @end deftypefn */)
1230 92609e161b29 [project @ 1995-04-10 01:08:57 by jwe] jwe parents: 1181 diff changeset	2768 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2769 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	2770 print_usage ();
1379 e29697484908 [project @ 1995-09-12 00:41:58 by jwe] jwe parents: 1377 diff changeset	2771
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2772 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2773
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2774 return ovl (streams.remove (args(0), "pclose"));
1379 e29697484908 [project @ 1995-09-12 00:41:58 by jwe] jwe parents: 1377 diff changeset	2775 }
e29697484908 [project @ 1995-09-12 00:41:58 by jwe] jwe parents: 1377 diff changeset	2776
19278 6ca096827123 Use tempname() rather than tmpnam() in core Octave. Rik <rik@octave.org> parents: 19268 diff changeset	2777 DEFUN (tempname, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2778 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2779 @deftypefn {} {@var{fname} =} tempname ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2780 @deftypefnx {} {@var{fname} =} tempname (@var{dir})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2781 @deftypefnx {} {@var{fname} =} tempname (@var{dir}, @var{prefix})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2782 Return a unique temporary filename as a string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2783
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2784 If @var{prefix} is omitted, a value of @qcode{"oct-"} is used.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2785
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2786 If @var{dir} is also omitted, the default directory for temporary files
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2787 (@code{P_tmpdir}) is used. If @var{dir} is provided, it must exist,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2788 otherwise the default directory for temporary files is used.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2789
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2790 Programming Note: Because the named file is not opened by @code{tempname},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2791 it is possible, though relatively unlikely, that it will not be available
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2792 by the time your program attempts to open it. If this is a concern,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2793 see @code{tmpfile}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2794 @seealso{mkstemp, tempdir, P_tmpdir, tmpfile}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2795 @end deftypefn */)
1802 8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe] jwe parents: 1799 diff changeset	2796 {
20812 d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20805 diff changeset	2797 int nargin = args.length ();
2936 87cb7614257d [project @ 1997-05-06 05:46:00 by jwe] jwe parents: 2926 diff changeset	2798
20812 d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20805 diff changeset	2799 if (nargin > 2)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	2800 print_usage ();
1802 8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe] jwe parents: 1799 diff changeset	2801
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2802 std::string dir;
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2803
20812 d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20805 diff changeset	2804 if (nargin > 0)
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2805 dir = args(0).xstring_value ("tempname: DIR must be a string");
22511 1e81abd0314a tempname: respect the value of $TMPDIR if set, be consistent with tempdir Mike Miller <mtmiller@octave.org> parents: 22489 diff changeset	2806 else
1e81abd0314a tempname: respect the value of $TMPDIR if set, be consistent with tempdir Mike Miller <mtmiller@octave.org> parents: 22489 diff changeset	2807 dir = octave::sys::env::getenv ("TMPDIR");
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2808
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2809 std::string pfx ("oct-");
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2810
20812 d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20805 diff changeset	2811 if (nargin > 1)
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2812 pfx = args(1).xstring_value ("tempname: PREFIX must be a string");
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2813
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	2814 return ovl (octave::sys::tempnam (dir, pfx));
1802 8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe] jwe parents: 1799 diff changeset	2815 }
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe] jwe parents: 1799 diff changeset	2816
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2817 /*
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2818 %!test
24662 276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2819 %! envvar = {"TMPDIR", "TMP"};
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2820 %! envdir = cellfun (@(x) getenv (x), envvar, "uniformoutput", false);
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2821 %! unwind_protect
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2822 %! cellfun (@(x) unsetenv (x), envvar);
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2823 %! envname = "TMPDIR";
24662 276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2824 %! def_tmpdir = P_tmpdir;
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2825 %! ## Strip trailing file separators from P_tmpdir
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2826 %! while (length (def_tmpdir) > 2 && any (def_tmpdir(end) == filesep ("all")))
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2827 %! def_tmpdir(end) = [];
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2828 %! endwhile
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2829 %!
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2830 %! ## Test 0-argument form
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2831 %! fname = tempname ();
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19420 diff changeset	2832 %! [tmpdir, tmpfname] = fileparts (fname);
21457 05ffef4ebf62 tempname: Fix failing BIST test when P_tmpdir has trailing slash Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	2833 %! assert (tmpdir, def_tmpdir);
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2834 %! assert (tmpfname (1:4), "oct-");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19420 diff changeset	2835 %! ## Test 1-argument form
21457 05ffef4ebf62 tempname: Fix failing BIST test when P_tmpdir has trailing slash Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	2836 %! tmp_tmpdir = [def_tmpdir filesep() substr(tmpfname, -5)];
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2837 %! mkdir (tmp_tmpdir) \|\| error ("Unable to create tmp dir");
21457 05ffef4ebf62 tempname: Fix failing BIST test when P_tmpdir has trailing slash Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	2838 %! setenv (envname, def_tmpdir);
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2839 %! fname = tempname (tmp_tmpdir);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19420 diff changeset	2840 %! [tmpdir, tmpfname] = fileparts (fname);
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2841 %! assert (tmpdir, tmp_tmpdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2842 %! assert (tmpfname (1:4), "oct-");
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2843 %! ## Test 1-argument form w/null tmpdir
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2844 %! fname = tempname ("");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19420 diff changeset	2845 %! [tmpdir, tmpfname] = fileparts (fname);
21457 05ffef4ebf62 tempname: Fix failing BIST test when P_tmpdir has trailing slash Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	2846 %! assert (tmpdir, def_tmpdir);
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2847 %! assert (tmpfname (1:4), "oct-");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19420 diff changeset	2848 %! ## Test 2-argument form
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2849 %! fname = tempname (tmp_tmpdir, "pfx-");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19420 diff changeset	2850 %! [tmpdir, tmpfname] = fileparts (fname);
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2851 %! assert (tmpdir, tmp_tmpdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2852 %! assert (tmpfname (1:4), "pfx-");
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2853 %! ## Test 2-argument form w/null prefix
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2854 %! fname = tempname (tmp_tmpdir, "");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19420 diff changeset	2855 %! [tmpdir, tmpfname] = fileparts (fname);
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2856 %! assert (tmpdir, tmp_tmpdir);
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2857 %! assert (tmpfname (1:4), "file");
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2858 %! unwind_protect_cleanup
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2859 %! rmdir (tmp_tmpdir);
24662 276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2860 %! for i = 1:numel (envvar)
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2861 %! if (isempty (envdir{i}))
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2862 %! unsetenv (envvar{i});
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2863 %! else
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2864 %! setenv (envvar{i}, envdir{i});
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2865 %! endif
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627) Rik <rik@octave.org> parents: 24534 diff changeset	2866 %! endfor
19420 82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2867 %! end_unwind_protect
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2868 */
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844). Rik <rik@octave.org> parents: 19403 diff changeset	2869
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2870 DEFMETHOD (tmpfile, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2871 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2872 @deftypefn {} {[@var{fid}, @var{msg}] =} tmpfile ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2873 Return the file ID corresponding to a new temporary file with a unique
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2874 name.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2875
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2876 The file is opened in binary read/write (@qcode{"w+b"}) mode and will be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2877 deleted automatically when it is closed or when Octave exits.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2878
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2879 If successful, @var{fid} is a valid file ID and @var{msg} is an empty
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2880 string. Otherwise, @var{fid} is -1 and @var{msg} contains a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2881 system-dependent error message.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2882 @seealso{tempname, mkstemp, tempdir, P_tmpdir}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2883 @end deftypefn */)
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2884 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2885 if (args.length () != 0)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2886 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2887
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	2888 octave_value_list retval;
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2889
21991 80659e58609f provide wrapper for tmpfile (bug #48337) John W. Eaton <jwe@octave.org> parents: 21966 diff changeset	2890 FILE *fid = octave_tmpfile_wrapper ();
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2891
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2892 if (fid)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2893 {
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2894 std::string nm;
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2895
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2896 std::ios::openmode md = fopen_mode_to_ios_mode ("w+b");
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2897
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	2898 octave::stream s = octave_stdiostream::create (nm, fid, md);
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2899
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	2900 if (! s)
23741 3bb1c94b41f2 * file-io.cc (Ftmpfile): Close tmp file if stream creation fails. John W. Eaton <jwe@octave.org> parents: 23738 diff changeset	2901 {
3bb1c94b41f2 * file-io.cc (Ftmpfile): Close tmp file if stream creation fails. John W. Eaton <jwe@octave.org> parents: 23738 diff changeset	2902 fclose (fid);
3bb1c94b41f2 * file-io.cc (Ftmpfile): Close tmp file if stream creation fails. John W. Eaton <jwe@octave.org> parents: 23738 diff changeset	2903
3bb1c94b41f2 * file-io.cc (Ftmpfile): Close tmp file if stream creation fails. John W. Eaton <jwe@octave.org> parents: 23738 diff changeset	2904 error ("tmpfile: failed to create octave_stdiostream object");
3bb1c94b41f2 * file-io.cc (Ftmpfile): Close tmp file if stream creation fails. John W. Eaton <jwe@octave.org> parents: 23738 diff changeset	2905 }
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2906
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2907 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2908
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2909 retval = ovl (streams.insert (s), "");
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2910 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2911 else
23741 3bb1c94b41f2 * file-io.cc (Ftmpfile): Close tmp file if stream creation fails. John W. Eaton <jwe@octave.org> parents: 23738 diff changeset	2912 retval = ovl (-1, std::strerror (errno));
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2913
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2914 return retval;
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2915 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2916
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2917 DEFMETHOD (mkstemp, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2918 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2919 @deftypefn {} {[@var{fid}, @var{name}, @var{msg}] =} mkstemp ("@var{template}")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2920 @deftypefnx {} {[@var{fid}, @var{name}, @var{msg}] =} mkstemp ("@var{template}", @var{delete})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2921 Return the file descriptor @var{fid} corresponding to a new temporary file
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2922 with a unique name created from @var{template}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2923
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2924 The last six characters of @var{template} must be @qcode{"XXXXXX"} and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2925 these are replaced with a string that makes the filename unique. The file
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2926 is then created with mode read/write and permissions that are system
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2927 dependent (on GNU/Linux systems, the permissions will be 0600 for versions
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2928 of glibc 2.0.7 and later). The file is opened in binary mode and with the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2929 @w{@code{O_EXCL}} flag.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2930
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2931 If the optional argument @var{delete} is supplied and is true, the file will
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2932 be deleted automatically when Octave exits.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2933
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2934 If successful, @var{fid} is a valid file ID, @var{name} is the name of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2935 file, and @var{msg} is an empty string. Otherwise, @var{fid} is -1,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2936 @var{name} is empty, and @var{msg} contains a system-dependent error
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2937 message.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2938 @seealso{tempname, tempdir, P_tmpdir, tmpfile, fopen}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	2939 @end deftypefn */)
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2940 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2941 int nargin = args.length ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2942
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2943 if (nargin < 1 \|\| nargin > 2)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2944 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2945
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2946 std::string tmpl8 = args(0).xstring_value ("mkstemp: TEMPLATE argument must be a string");
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2947
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2948 octave_value_list retval = ovl (-1, "", "");
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2949
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2950 OCTAVE_LOCAL_BUFFER (char, tmp, tmpl8.size () + 1);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2951 strcpy (tmp, tmpl8.c_str ());
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2952
21888 00f1249f2483 create wrappers for some gnulib functions John W. Eaton <jwe@octave.org> parents: 21852 diff changeset	2953 int fd = octave_mkostemp_wrapper (tmp);
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2954
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2955 if (fd < 0)
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2956 {
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2957 retval(0) = fd;
21942 aab79a1885cc limit gnulib headers to liboctave/wrappers directory John W. Eaton <jwe@octave.org> parents: 21919 diff changeset	2958 retval(2) = std::strerror (errno);
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2959 }
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2960 else
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2961 {
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2962 const char *fopen_mode = "w+b";
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2963
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2964 FILE *fid = fdopen (fd, fopen_mode);
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20561 diff changeset	2965
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2966 if (! fid)
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2967 {
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2968 retval(0) = -1;
21942 aab79a1885cc limit gnulib headers to liboctave/wrappers directory John W. Eaton <jwe@octave.org> parents: 21919 diff changeset	2969 retval(2) = std::strerror (errno);
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2970 }
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2971 else
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2972 {
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2973 std::string nm = tmp;
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20561 diff changeset	2974
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2975 std::ios::openmode md = fopen_mode_to_ios_mode (fopen_mode);
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2976
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22837 diff changeset	2977 octave::stream s = octave_stdiostream::create (nm, fid, md);
20581 fd0efcdb3718 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20561 diff changeset	2978
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2979 if (! s)
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2980 error ("mkstemp: failed to create octave_stdiostream object");
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	2981
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2982 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2983
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	2984 retval(0) = streams.insert (s);
20884 f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2985 retval(1) = nm;
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2986
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2987 if (nargin == 2 && args(1).is_true ())
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files. José Luis García Pallero <jgpallero@gmail.com> parents: 20861 diff changeset	2988 mark_for_deletion (nm);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	2989 }
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2990 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2991
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2992 return retval;
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2993 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4267 diff changeset	2994
20200 d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	2995 // FIXME: This routine also exists verbatim in syscalls.cc.
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054). Rik <rik@octave.org> parents: 20198 diff changeset	2996 // Maybe change to be a general utility routine.
1400 209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	2997 static int
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	2998 convert (int x, int ibase, int obase)
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	2999 {
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3000 int retval = 0;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3001
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3002 int tmp = x % obase;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3003
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3004 if (tmp > ibase - 1)
20428 7ac907da9fba Use error() rather than ::error() unless explicitly required. Rik <rik@octave.org> parents: 20200 diff changeset	3005 error ("umask: invalid digit");
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3006
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3007 retval = tmp;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3008 int mult = ibase;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3009 while ((x = (x - tmp) / obase))
1400 209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3010 {
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3011 tmp = x % obase;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3012
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3013 if (tmp > ibase - 1)
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3014 error ("umask: invalid digit");
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3015
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3016 retval += mult * tmp;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20962 diff changeset	3017 mult *= ibase;
1400 209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3018 }
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3019
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3020 return retval;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3021 }
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3022
10197 4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	3023 DEFUNX ("umask", Fumask, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3024 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3025 @deftypefn {} {} umask (@var{mask})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3026 Set the permission mask for file creation.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3027
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3028 The parameter @var{mask} is an integer, interpreted as an octal number.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3029
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3030 If successful, returns the previous value of the mask (as an integer to be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3031 interpreted as an octal number); otherwise an error message is printed.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3032
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3033 The permission mask is a UNIX concept used when creating new objects on a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3034 file system such as files, directories, or named FIFOs. The object to be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3035 created has base permissions in an octal number @var{mode} which are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3036 modified according to the octal value of @var{mask}. The final permissions
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3037 for the new object are @code{@var{mode} - @var{mask}}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3038 @seealso{fopen, mkdir, mkfifo}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3039 @end deftypefn */)
1400 209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3040 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3041 if (args.length () != 1)
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3042 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3043
2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3044 int mask = args(0).xint_value ("umask: MASK must be an integer");
1400 209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3045
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3046 if (mask < 0)
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	3047 error ("umask: MASK must be a positive integer value");
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3048
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	3049 int oct_mask = convert (mask, 8, 10);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	3050
21733 cb0fdd941d84 use namespace for system file_ops class John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	3051 int status = convert (octave::sys::umask (oct_mask), 10, 8);
1400 209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3052
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3053 if (status >= 0)
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	3054 return ovl (status);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20898 diff changeset	3055 else
20941 a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()". Rik <rik@octave.org> parents: 20940 diff changeset	3056 return ovl ();
1400 209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3057 }
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe] jwe parents: 1381 diff changeset	3058
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3059 static octave_value
6483 d00da2148c53 [project @ 2007-04-04 02:58:48 by jwe] jwe parents: 6456 diff changeset	3060 const_value (const char *, const octave_value_list& args, int val)
2189 d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2148 diff changeset	3061 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3062 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	3063 print_usage ();
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3064
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3065 return octave_value (val);
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3066 }
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3067
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3068 DEFUNX ("P_tmpdir", FP_tmpdir, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3069 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3070 @deftypefn {} {} P_tmpdir ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3071 Return the name of the host system's @strong{default} directory for
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3072 temporary files.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3073
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3074 Programming Note: The value returned by @code{P_tmpdir} is always the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3075 default location. This value may not agree with that returned from
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3076 @code{tempdir} if the user has overridden the default with the @env{TMPDIR}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3077 environment variable.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3078 @seealso{tempdir, tempname, mkstemp, tmpfile}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3079 @end deftypefn */)
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3080 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3081 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	3082 print_usage ();
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3083
25649 85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25646 diff changeset	3084 return ovl (octave::get_P_tmpdir ());
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3085 }
2341 6ee55c0f25a9 [project @ 1996-07-24 10:33:09 by jwe] jwe parents: 2324 diff changeset	3086
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3087 // NOTE: the values of SEEK_SET, SEEK_CUR, and SEEK_END have to be
25005 db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	3088 // this way for Matlab compatibility.
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3089
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3090 DEFUNX ("SEEK_SET", FSEEK_SET, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3091 doc: /* -- texinfo --
25032 a1e391e33004 doc: grammarcheck documentation again ahead of 4.4 release. Rik <rik@octave.org> parents: 25005 diff changeset	3092 @deftypefn {} {} SEEK_SET ()
25005 db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	3093 Return the numerical value to pass to @code{fseek} to position the file pointer
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	3094 relative to the beginning of the file.
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	3095 @seealso{SEEK_CUR, SEEK_END, fseek}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3096 @end deftypefn */)
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3097 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3098 return const_value ("SEEK_SET", args, -1);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3099 }
2189 d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2148 diff changeset	3100
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3101 DEFUNX ("SEEK_CUR", FSEEK_CUR, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3102 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3103 @deftypefn {} {} SEEK_CUR ()
25005 db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	3104 Return the numerical value to pass to @code{fseek} to position the file pointer
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	3105 relative to the current position.
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	3106 @seealso{SEEK_SET, SEEK_END, fseek}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3107 @end deftypefn */)
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3108 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3109 return const_value ("SEEK_CUR", args, 0);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3110 }
2189 d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2148 diff changeset	3111
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3112 DEFUNX ("SEEK_END", FSEEK_END, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3113 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3114 @deftypefn {} {} SEEK_END ()
25005 db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	3115 Return the numerical value to pass to @code{fseek} to position the file pointer
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	3116 relative to the end of the file.
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END. Rik <rik@octave.org> parents: 25003 diff changeset	3117 @seealso{SEEK_SET, SEEK_CUR, fseek}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3118 @end deftypefn */)
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3119 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3120 return const_value ("SEEK_END", args, 1);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3121 }
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3122
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3123 static octave_value
6483 d00da2148c53 [project @ 2007-04-04 02:58:48 by jwe] jwe parents: 6456 diff changeset	3124 const_value (const char *, const octave_value_list& args,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10259 diff changeset	3125 const octave_value& val)
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3126 {
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3127 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5775 diff changeset	3128 print_usage ();
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3129
20805 2d6ddb2b157c eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	3130 return octave_value (val);
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3131 }
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3132
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3133 DEFMETHODX ("stdin", Fstdin, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3134 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3135 @deftypefn {} {} stdin ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3136 Return the numeric value corresponding to the standard input stream.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3137
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3138 When Octave is used interactively, stdin is filtered through the command
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3139 line editing functions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3140 @seealso{stdout, stderr}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3141 @end deftypefn */)
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3142 {
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3143 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3144
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3145 return const_value ("stdin", args, streams.stdin_file ());
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3146 }
2189 d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2148 diff changeset	3147
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3148 DEFMETHODX ("stdout", Fstdout, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3149 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3150 @deftypefn {} {} stdout ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3151 Return the numeric value corresponding to the standard output stream.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3152
24801 daf61c7dfcae Change default status of pager to "off" (bug #53217). Rik <rik@octave.org> parents: 24662 diff changeset	3153 Data written to the standard output may be filtered through the pager.
daf61c7dfcae Change default status of pager to "off" (bug #53217). Rik <rik@octave.org> parents: 24662 diff changeset	3154 @seealso{stdin, stderr, page_screen_output}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3155 @end deftypefn */)
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3156 {
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3157 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3158
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3159 return const_value ("stdout", args, streams.stdout_file ());
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3160 }
2189 d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2148 diff changeset	3161
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3162 DEFMETHODX ("stderr", Fstderr, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3163 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3164 @deftypefn {} {} stderr ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3165 Return the numeric value corresponding to the standard error stream.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3166
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3167 Even if paging is turned on, the standard error is not sent to the pager.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3168 It is useful for error messages and prompts.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3169 @seealso{stdin, stdout}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	3170 @end deftypefn */)
5749 26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe] jwe parents: 5653 diff changeset	3171 {
23738 8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3172 octave::stream_list& streams = interp.get_stream_list ();
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3173
8acd390d16c9 don't use singleton for stream_list object John W. Eaton <jwe@octave.org> parents: 23737 diff changeset	3174 return const_value ("stderr", args, streams.stderr_file ());
2189 d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2148 diff changeset	3175 }

Mercurial > octave

annotate libinterp/corefcn/file-io.cc @ 26378:3f3677540634 stable