Mercurial > octave

annotate libinterp/corefcn/file-io.cc @ 27137:30f53f7a7293

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Return correct error messages on octave-streams when scanf fails (bug #56396) * file-io.cc (Fsscanf): Add BIST test for bug #56396. * oct-stream.cc (base_stream::do_scanf): Perform end-of-scan processing if EOF has been detected, not just when FAILBIT has been set. If FAILBIT has been set, call error() to set an error message on the octave-stream. At end of function, assign any partial results obtained to output. Don't require that all conversions were successful. * io.tst: Update BIST tests to reflect new Matlab-compatible behavior for error message output.
author Rik <rik@octave.org>
date Mon, 03 Jun 2019 09:04:41 -0700
parents 04e5cb5e2cb3
children ec6d31ef6bb6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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"
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
55 #include "iconv-wrappers.h"
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
56 #include "lo-ieee.h"
26642
c942659a57e6 Support opening handles to files with non-ASCII characters on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26640
diff changeset
57 #include "lo-sysdep.h"
21888
00f1249f2483 create wrappers for some gnulib functions
John W. Eaton <jwe@octave.org>
parents: 21852
diff changeset
58 #include "mkostemp-wrapper.h"
6159
645605133a6f [project @ 2006-11-14 02:55:05 by jwe]
jwe
parents: 6108
diff changeset
59 #include "oct-env.h"
8377
25bc2d31e1bf improve OCTAVE_LOCAL_BUFFER
Jaroslav Hajek <highegg@gmail.com>
parents: 8021
diff changeset
60 #include "oct-locbuf.h"
21991
80659e58609f provide wrapper for tmpfile (bug #48337)
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
61 #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
62 #include "unistd-wrappers.h"
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2902
diff changeset
63
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 "builtin-defun-decls.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
65 #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
66 #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
67 #include "errwarn.h"
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 6053
diff changeset
68 #include "file-io.h"
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
69 #include "interpreter.h"
6159
645605133a6f [project @ 2006-11-14 02:55:05 by jwe]
jwe
parents: 6108
diff changeset
70 #include "load-path.h"
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
71 #include "oct-fstrm.h"
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
72 #include "oct-iostrm.h"
1377
44f5d41ff757 [project @ 1995-09-12 00:07:58 by jwe]
jwe
parents: 1363
diff changeset
73 #include "oct-map.h"
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
74 #include "oct-prcstrm.h"
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
75 #include "oct-stream.h"
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
76 #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
77 #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
78 #include "ovl.h"
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
79 #include "pager.h"
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
80 #include "sysdep.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
81 #include "utils.h"
2370
a45c7d64b5e3 [project @ 1996-10-11 23:51:15 by jwe]
jwe
parents: 2341
diff changeset
82 #include "variables.h"
1583
5383d2d4cf9d [project @ 1995-10-27 08:51:20 by jwe]
jwe
parents: 1488
diff changeset
83
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
84 // 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
85 //
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
86 // FIXME: this should really be static,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
87 // but that causes problems on some systems.
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
88 std::stack <std::string> tmp_files;
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
89
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
90 void
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
91 mark_for_deletion (const std::string& 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 tmp_files.push (file);
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
94 }
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
95
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
96 void
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
97 cleanup_tmp_files (void)
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 while (! tmp_files.empty ())
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
100 {
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
101 std::string filename = tmp_files.top ();
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
102 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
103 octave_unlink_wrapper (filename.c_str ());
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
104 }
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
105 }
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5095
diff changeset
106
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
107 static void
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
108 normalize_fopen_mode (std::string& mode, bool& use_zlib)
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
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 use_zlib = false;
896
4a2133b26fa7 [project @ 1994-11-09 16:04:06 by jwe]
jwe
parents: 870
diff changeset
111
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
112 if (! mode.empty ())
368
5c987c27f3d7 [project @ 1994-02-16 08:33:09 by jwe]
jwe
parents: 367
diff changeset
113 {
24418
c23b9af6a664 Remove warnings about 'W', 'A', and 'R' modes in fopen (bug #52644).
Rik <rik@octave.org>
parents: 24417
diff changeset
114 // 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
115 // 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
116 // 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
117 // 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
118 // 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
119 // See bug #52644.
7078
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
120
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
121 size_t pos = mode.find ('W');
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
122
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
123 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
124 mode[pos] = 'w';
7078
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
125
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
126 pos = mode.find ('R');
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
127
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
128 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
129 mode[pos] = 'r';
7078
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
130
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
131 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
132
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
133 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
134 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
135
7078
405cf85b435c [project @ 2007-10-30 14:04:59 by jwe]
jwe
parents: 7017
diff changeset
136 pos = mode.find ('z');
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
137
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
138 if (pos != std::string::npos)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
139 {
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
140 #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
141 use_zlib = true;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
142 mode.erase (pos, 1);
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
143 #else
21109
bd1752782e56 Use err_disabled_feature, warn_disabled_feature throughout code base.
Rik <rik@octave.org>
parents: 21078
diff changeset
144 err_disabled_feature ("", "gzipped files (zlib)");
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
145 #endif
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
146 }
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
147
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
148 // 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
149 // '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
150
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
151 size_t bpos = mode.find ('b');
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
152 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
153
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
154 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
155 mode += 'b';
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
156 }
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
157 }
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
158
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
159 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
160 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
161 {
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
162 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
163
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
164 if (mode == "rt")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
165 retval = std::ios::in;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
166 else if (mode == "wt")
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::trunc;
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
168 else if (mode == "at")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
169 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
170 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
171 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
172 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
173 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
174 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
175 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
176 else if (mode == "rb" || mode == "r")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
177 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
178 else if (mode == "wb" || mode == "w")
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::trunc | 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 == "ab" || mode == "a")
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
181 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
182 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
183 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
184 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
185 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
186 | std::ios::binary);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
187 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
188 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
189 | std::ios::binary);
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
190 else
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
191 error ("invalid mode specified");
1
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 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
194 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
195
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
196 DEFMETHOD (fclose, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
197 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
198 @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
199 @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
200 @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
201 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
202
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
203 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
204 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
205 @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
206 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
207 @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
208 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
209 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
210 if (args.length () != 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
211 print_usage ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
212
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
213 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
214
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
215 return ovl (streams.remove (args(0), "fclose"));
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
216 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
217
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
218 DEFMETHOD (fclear, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
219 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
220 @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
221 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
222 @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
223 @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
224 @end deftypefn */)
5144
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
225 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
226 if (args.length () != 1)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
227 print_usage ();
5144
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
228
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
229 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
230
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
231 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
232
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
233 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
234
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
235 os.clearerr ();
5144
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
236
20941
a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents: 20940
diff changeset
237 return ovl ();
5144
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
238 }
25b090e1be9f [project @ 2005-02-15 12:06:05 by jwe]
jwe
parents: 5109
diff changeset
239
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
240 DEFMETHOD (fflush, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
241 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
242 @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
243 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
244
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
245 @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
246 (@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
247
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
248 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
249 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
250 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
251 @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
252 @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
253 @end deftypefn */)
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
254 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
255 if (args.length () != 1)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
256 print_usage ();
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
257
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
258 octave_value retval = -1;
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
259
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
260 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
261
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
262 // 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
263 int fid = streams.get_file_number (args(0));
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
264
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
265 if (fid == 1)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
266 {
23060
baf03cdb28b5 move pager and diary classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 23059
diff changeset
267 octave::flush_stdout ();
2609
12bc9d0a50b5 [project @ 1997-01-18 00:17:36 by jwe]
jwe
parents: 2599
diff changeset
268
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
269 retval = 0;
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
270 }
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
271 else
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
272 {
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
273 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
274
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
275 retval = os.flush ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
276 }
1181
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 return retval;
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
279 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
280
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
281 DEFMETHOD (fgetl, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
282 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
283 @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
284 @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
285 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
286 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
287
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
288 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
289 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
290
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
291 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
292 character.
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 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
295
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
296 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
297 @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
298 @end deftypefn */)
1339
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
299 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
300 static std::string who = "fgetl";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
301
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
302 int nargin = args.length ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
303
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
304 if (nargin < 1 || nargin > 2)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
305 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
306
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
307 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
308
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
309 octave::stream os = streams.lookup (args(0), who);
1339
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
310
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
311 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
312
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
313 bool err = false;
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 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
316
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
317 if (! err)
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
318 return ovl (tmp, tmp.length ());
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
319 else
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
320 return ovl (-1, 0);
1339
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
321 }
e1dbc5585afd [project @ 1995-08-25 03:58:02 by jwe]
jwe
parents: 1338
diff changeset
322
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
323 DEFMETHOD (fgets, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
324 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
325 @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
326 @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
327 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
328 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
329
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
330 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
331 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
332
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
333 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
334 character.
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 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
337
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
338 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
339 @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
340 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
341 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
342 static std::string who = "fgets";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
343
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
344 int nargin = args.length ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
345
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
346 if (nargin < 1 || nargin > 2)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
347 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
348
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
349 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
350
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
351 octave::stream os = streams.lookup (args(0), who);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
352
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
353 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
354
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
355 bool err = false;
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 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
358
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
359 if (! err)
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
360 return ovl (tmp, tmp.length ());
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
361 else
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
362 return ovl (-1.0, 0.0);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
363 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
364
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
365 DEFMETHOD (fskipl, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
366 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
367 @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
368 @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
369 @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
370 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
371 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
372
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
373 @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
374 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
375
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
376 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
377 @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
378 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
379
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
380 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
381 @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
382 @end deftypefn */)
9701
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 static std::string who = "fskipl";
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
385
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
386 int nargin = args.length ();
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
387
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
388 if (nargin < 1 || nargin > 2)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
389 print_usage ();
9701
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
390
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
391 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
392
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
393 octave::stream os = streams.lookup (args(0), who);
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 octave_value count_arg = (nargin == 2) ? args(1) : octave_value ();
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 bool err = false;
9701
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
398
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
399 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
400
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
401 if (! err)
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
402 return ovl (tmp);
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
403 else
20941
a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents: 20940
diff changeset
404 return ovl ();
9701
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
405 }
531280b07625 implement fskipl
Jaroslav Hajek <highegg@gmail.com>
parents: 9322
diff changeset
406
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
407 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
408 do_stream_open (const std::string& name, const std::string& mode_arg,
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
409 const std::string& arch, std::string encoding, int& fid)
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
410 {
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
411 octave::stream retval;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
412
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
413 fid = -1;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
414
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
415 // Valid names for encodings consist of ASCII characters only.
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
416 std::transform (encoding.begin (), encoding.end (), encoding.begin (),
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
417 ::tolower);
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
418 if (encoding.compare ("utf-8"))
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
419 {
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
420 // check if encoding is valid
26867
7506884fc158 Avoid bogus error message when checking encoding identifier (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26706
diff changeset
421 void *codec = octave_iconv_open_wrapper (encoding.c_str (), "utf-8");
7506884fc158 Avoid bogus error message when checking encoding identifier (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26706
diff changeset
422 if (codec == reinterpret_cast<void *> (-1))
7506884fc158 Avoid bogus error message when checking encoding identifier (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26706
diff changeset
423 {
7506884fc158 Avoid bogus error message when checking encoding identifier (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26706
diff changeset
424 if (errno == EINVAL)
7506884fc158 Avoid bogus error message when checking encoding identifier (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26706
diff changeset
425 error ("fopen: conversion from codepage '%s' not supported",
7506884fc158 Avoid bogus error message when checking encoding identifier (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26706
diff changeset
426 encoding.c_str ());
7506884fc158 Avoid bogus error message when checking encoding identifier (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26706
diff changeset
427 }
7506884fc158 Avoid bogus error message when checking encoding identifier (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26706
diff changeset
428 else
7506884fc158 Avoid bogus error message when checking encoding identifier (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26706
diff changeset
429 octave_iconv_close_wrapper (codec);
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
430 }
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
431
16590
2d968b7830d6 handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents: 16308
diff changeset
432 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
433 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
434 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
435
4036
1432e11733d1 [project @ 2002-08-12 18:38:40 by jwe]
jwe
parents: 4028
diff changeset
436 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
437
21739
c4ab2e54f100 use namespace for oct_mach_info class
John W. Eaton <jwe@octave.org>
parents: 21736
diff changeset
438 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
439 octave::mach_info::string_to_float_format (arch);
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
440
21733
cb0fdd941d84 use namespace for system file_ops class
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
441 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
442
21736
0504351a45e6 use namespace for file_stat classes
John W. Eaton <jwe@octave.org>
parents: 21733
diff changeset
443 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
444
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
445 if (! (md & std::ios::out))
25646
4d565baa475e move libinterp/utils functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25457
diff changeset
446 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
447
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
448 if (! fs.is_dir ())
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
449 {
6905
aee959a21c4b [project @ 2007-09-17 16:00:30 by jwe]
jwe
parents: 6838
diff changeset
450 #if defined (HAVE_ZLIB)
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
451 if (use_zlib)
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
452 {
26642
c942659a57e6 Support opening handles to files with non-ASCII characters on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26640
diff changeset
453 FILE *fptr = octave::sys::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
454
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
455 if (fptr)
26378
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347)
Andreas Weber <octave@josoansi.de>
parents: 26376
diff changeset
456 {
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347)
Andreas Weber <octave@josoansi.de>
parents: 26376
diff changeset
457 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
458
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347)
Andreas Weber <octave@josoansi.de>
parents: 26376
diff changeset
459 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
460
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
461 retval = octave_zstdiostream::create (fname, gzf, fd, md,
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
462 flt_fmt, encoding);
26378
3f3677540634 file-io.cc: Fix static analyzer detected V595 issue (bug #55347)
Andreas Weber <octave@josoansi.de>
parents: 26376
diff changeset
463 }
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
464 else
21942
aab79a1885cc limit gnulib headers to liboctave/wrappers directory
John W. Eaton <jwe@octave.org>
parents: 21919
diff changeset
465 retval.error (std::strerror (errno));
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
466 }
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
467 else
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5320
diff changeset
468 #endif
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
469 {
26642
c942659a57e6 Support opening handles to files with non-ASCII characters on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26640
diff changeset
470 FILE *fptr = octave::sys::fopen (fname.c_str (), mode.c_str ());
5370
f07a9653b844 [project @ 2005-05-24 02:25:57 by jwe]
jwe
parents: 5353
diff changeset
471
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
472 retval = octave_stdiostream::create (fname, fptr, md, flt_fmt,
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
473 encoding);
7730
b68e44c90afe file-io.cc (do_stream_open): return -1 for directories
John W. Eaton <jwe@octave.org>
parents: 7708
diff changeset
474
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
475 if (! fptr)
21942
aab79a1885cc limit gnulib headers to liboctave/wrappers directory
John W. Eaton <jwe@octave.org>
parents: 21919
diff changeset
476 retval.error (std::strerror (errno));
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
477 }
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
478
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
479 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
480
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
481 return retval;
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
482 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
483
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
484 static octave::stream
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
485 do_stream_open (const octave_value& tc_name, const octave_value& tc_mode,
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
486 const octave_value& tc_arch, const octave_value& tc_encoding,
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
487 const char *fcn, int& fid)
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
488 {
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
489 octave::stream retval;
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
490
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
491 fid = -1;
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
492
20713
2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents: 20704
diff changeset
493 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
494 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
495 std::string arch = tc_arch.xstring_value ("%s: architecture type must be a string", fcn);
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
496 std::string encoding = tc_encoding.xstring_value ("%s: ENCODING must be a string", fcn);
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
497
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
498 retval = do_stream_open (name, mode, arch, encoding, fid);
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
499
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
500 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
501 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
502
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
503 DEFMETHOD (fopen, interp, args, nargout,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
504 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
505 @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
506 @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
507 @deftypefnx {} {@var{fid} =} fopen (@var{name}, @var{mode}, @var{arch})
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
508 @deftypefnx {} {@var{fid} =} fopen (@var{name}, @var{mode}, @var{arch}, @var{encoding})
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
509 @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
510 @deftypefnx {} {@var{fid_list} =} fopen ("all")
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
511 @deftypefnx {} {[@var{file}, @var{mode}, @var{arch}, @var{encoding}] =} fopen (@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
512 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
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 The first form of the @code{fopen} function opens the named file with
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
515 the specified mode (read-write, read-only, etc.@:), architecture
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
516 interpretation (IEEE big endian, IEEE little endian, etc.) and file encoding,
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
517 and returns an integer value that may be used to refer to the file later. If
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
518 an error occurs, @var{fid} is set to @minus{}1 and @var{msg} contains the
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
519 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
520 character string that specifies whether the file is to be opened for
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
521 reading, writing, or both. The @var{encoding} is a character string with a
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
522 valid code page identifier. This code page is used when strings are read from
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
523 or written to the file.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
524
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
525 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
526 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
527 @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
528
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
529 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
530 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
531
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
532 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
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 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
535 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
536 @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
537
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
538 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
539 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
540 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
541 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
542 representation.
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 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
545 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
546 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
547 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
548
24416
d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644).
Rik <rik@octave.org>
parents: 24303
diff changeset
549 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
550
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
551 @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
552 @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
553 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
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 @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
556 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
557
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
558 @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
559 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
560
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
561 @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
562 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
563
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
564 @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
565 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
566 discarded.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
567
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
568 @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
569 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
570 file.
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 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
574 @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
575 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
576 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
577 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
578
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
579 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
580 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
581 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
582
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
583 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
584 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
585
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
586 @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
587 @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
588 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
589
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
590 @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
591 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
592
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
593 @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
594 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
595 @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
596
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
597 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
598 @code{0666 - @var{umask}}.
24416
d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644).
Rik <rik@octave.org>
parents: 24303
diff changeset
599
d400b09043dd doc: Explain Matlab compatibility of fopen modes (bug #52644).
Rik <rik@octave.org>
parents: 24303
diff changeset
600 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
601 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
602 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
603 @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
604 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
605 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
606 @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
607 @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
608 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
609 {
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
610 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
611
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
612 if (nargin < 1 || nargin > 4)
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
613 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
614
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
615 octave_value_list retval = ovl (-1.0);
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
616
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
617 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
618
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
619 if (nargin == 1)
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
620 {
12896
a19b50f6697f Correctly allow single string input form of fopen() (Bug #33535).
Rik <octave@nomad.inbox5.com>
parents: 12775
diff changeset
621 if (args(0).is_string ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
622 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
623 // 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
624 // 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
625 // 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
626 // 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
627 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
628 return streams.open_file_numbers ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
629 }
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
630 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
631 {
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
632 string_vector tmp = streams.get_info (args(0));
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
633
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
634 retval = ovl (tmp(0), tmp(1), tmp(2), tmp(3));
3263
7d80b56e0dc8 [project @ 1999-08-20 19:10:09 by jwe]
jwe
parents: 3246
diff changeset
635
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
636 return retval;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
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
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
640 octave_value mode = (nargin > 1) ? args(1) : octave_value ("r");
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
641
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
642 octave_value arch = (nargin > 2) ? args(2) : octave_value ("native");
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
643
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
644 octave_value encoding = (nargin > 3) ? args(3) : octave_value ("utf-8");
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
645
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
646 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
647
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
648 octave::stream os = do_stream_open (args(0), mode, arch, encoding, "fopen",
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
649 fid);
5370
f07a9653b844 [project @ 2005-05-24 02:25:57 by jwe]
jwe
parents: 5353
diff changeset
650
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
651 if (os)
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
652 retval = ovl (streams.insert (os), "");
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
653 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
654 {
f2cd811f0f9e maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents: 20819
diff changeset
655 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
656
20884
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
657 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
658 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
659
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
660 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
661 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
662
22837
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695).
Rik <rik@octave.org>
parents: 22755
diff changeset
663 /*
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
664 ## Further tests are in io.tst
22837
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695).
Rik <rik@octave.org>
parents: 22755
diff changeset
665 %!test # Uses hardcoded value of 1 for stdout
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
666 %! [name, mode, arch, encoding] = fopen (1);
22837
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695).
Rik <rik@octave.org>
parents: 22755
diff changeset
667 %! assert (name, "stdout");
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695).
Rik <rik@octave.org>
parents: 22755
diff changeset
668 %! assert (mode, "w");
26705
c13143821eef Add front-end support for encodings in "fopen" (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26642
diff changeset
669 %! assert (encoding, "utf-8");
22837
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695).
Rik <rik@octave.org>
parents: 22755
diff changeset
670
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695).
Rik <rik@octave.org>
parents: 22755
diff changeset
671 %!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
672 %! [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
673 %! assert (name, "");
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695).
Rik <rik@octave.org>
parents: 22755
diff changeset
674 %! assert (mode, "");
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695).
Rik <rik@octave.org>
parents: 22755
diff changeset
675 %! assert (arch, "");
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695).
Rik <rik@octave.org>
parents: 22755
diff changeset
676 */
b125351d4243 Return null "" status when querying a bad FID with fopen (bug #49695).
Rik <rik@octave.org>
parents: 22755
diff changeset
677
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
678 DEFMETHOD (freport, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
679 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
680 @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
681 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
682 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
683
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
684 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
685
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
686 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
687 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
688 freport ()
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
689
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
690 @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
691 @print{} ------ ---- ---- ----
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
692 @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
693 @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
694 @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
695 @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
696 @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
697 @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
698 @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
699 @end deftypefn */)
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
700 {
20819
f428cbe7576f eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents: 20812
diff changeset
701 if (args.length () > 0)
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
702 warning ("freport: ignoring extra arguments");
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
703
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
704 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
705
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
706 octave_stdout << streams.list_open_files ();
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
707
21078
49852ff04747 maint: Remove unnecessary declarations of retval.
Rik <rik@octave.org>
parents: 21055
diff changeset
708 return ovl ();
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
709 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
710
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
711 DEFMETHOD (frewind, interp, args, nargout,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
712 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
713 @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
714 @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
715 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
716 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
717
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
718 @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
719 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
720 @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
721 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
722 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
723 if (args.length () != 1)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
724 print_usage ();
506
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe]
jwe
parents: 497
diff changeset
725
20812
d9ca869ca124 maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents: 20805
diff changeset
726 int result = -1;
d9ca869ca124 maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents: 20805
diff changeset
727
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
728 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
729
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
730 octave::stream os = streams.lookup (args(0), "frewind");
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 628
diff changeset
731
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
732 result = os.rewind ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
733
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
734 if (nargout > 0)
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
735 return ovl (result);
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
736 else
20941
a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents: 20940
diff changeset
737 return ovl ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
738 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
739
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
740 DEFMETHOD (fseek, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
741 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
742 @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
743 @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
744 @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
745 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
746
25005
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END.
Rik <rik@octave.org>
parents: 25003
diff changeset
747 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
748 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
749 @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
750 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
751 @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
752 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
753 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
754
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
755 @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
756 @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
757 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
758 {
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
759 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
760
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
761 if (nargin < 2 || nargin > 3)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
762 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
763
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
764 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
765
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
766 octave::stream os = streams.lookup (args(0), "fseek");
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
767
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
768 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
769
21127
df7891224709 maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents: 21126
diff changeset
770 return ovl (os.seek (args(1), origin_arg));
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
771 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
772
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
773 DEFMETHOD (ftell, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
774 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
775 @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
776 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
777 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
778 @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
779 @end deftypefn */)
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
780 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
781 if (args.length () != 1)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
782 print_usage ();
506
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe]
jwe
parents: 497
diff changeset
783
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
784 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
785
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
786 octave::stream os = streams.lookup (args(0), "ftell");
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
787
21127
df7891224709 maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents: 21126
diff changeset
788 return ovl (os.tell ());
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
789 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
790
23737
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
791 static octave_value_list
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
792 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
793 const octave_value_list& args, int nargout)
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
794 {
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
795 int nargin = args.length ();
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
796
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
797 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
798 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
799
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
800 int result;
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
801
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
802 octave::stream os;
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
803 int fmt_n = 0;
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
804
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
805 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
806
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
807 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
808 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
809 else
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
810 {
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
811 fmt_n = 1;
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
812 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
813 }
2873
c3f7ed3874af [project @ 1997-04-23 04:01:02 by jwe]
jwe
parents: 2847
diff changeset
814
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
815 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
816 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
817
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
818 octave_value_list tmp_args;
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
819
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
820 if (nargin > 1 + fmt_n)
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
821 {
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
822 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
823
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
824 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
825 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
826 }
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
827
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
828 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
829
4715
7bed0ef1a6ad [project @ 2004-01-22 22:10:28 by jwe]
jwe
parents: 4649
diff changeset
830 if (nargout > 0)
21127
df7891224709 maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents: 21126
diff changeset
831 return ovl (result);
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
832 else
20941
a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents: 20940
diff changeset
833 return ovl ();
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
834 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
835
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
836 DEFMETHOD (fprintf, interp, args, nargout,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
837 doc: /* -*- texinfo -*-
23737
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
838 @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
839 @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
840 @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
841 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
842 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
843
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
844 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
845 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
846
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
847 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
848
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
849 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
850 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
851 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
852 @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
853 @end deftypefn */)
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
854 {
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
855 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
856
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
857 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
858 }
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 DEFMETHOD (printf, interp, args, nargout,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
861 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
862 @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
863 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
864 @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
865 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
866 @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
867
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
868 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
869 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
870 @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
871
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
872 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
873 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
874 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
875 @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
876 @end deftypefn */)
21634
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
877 {
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
878 static std::string who = "printf";
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
879
23737
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
880 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
881
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
882 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
883 nargout);
23737
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
884 }
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
885
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
886 static octave_value_list
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
887 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
888 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
889 {
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
890 if (args.length () != 2)
21634
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
891 print_usage ();
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
892
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
893 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
894
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
895 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
896
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
897 return ovl (os.puts (args(1), who));
21634
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
898 }
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
899
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
900 DEFMETHOD (fputs, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
901 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
902 @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
903 @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
904 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
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 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
907 @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
908 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
909
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
910 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
911 @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
912 @end deftypefn */)
21634
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
913 {
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
914 static std::string who = "fputs";
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
915
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
916 return puts_internal (interp, who, args);
21634
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
917 }
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
918
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
919 DEFMETHOD (puts, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
920 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
921 @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
922 @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
923 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
924
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
925 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
926 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
927
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
928 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
929 @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
930 @end deftypefn */)
21634
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
931 {
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
932 static std::string who = "puts";
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
933
23737
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
934 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
935
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
936 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
937 }
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
938
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
939 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
940 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
941 @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
942 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
943 string.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
944
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
945 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
946 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
947 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
948
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
949 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
950 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
951 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
952 @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
953 @end deftypefn */)
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
954 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
955 static std::string who = "sprintf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
956
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
957 int nargin = args.length ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
958
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
959 if (nargin == 0)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
960 print_usage ();
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
961
21506
128703a29388 avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents: 21504
diff changeset
962 // 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
963 // 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
964 // from it to return.
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
965 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
966
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
967 // 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
968 octave::stream os (ostr);
628
aecbe369233b [project @ 1994-08-19 13:27:51 by jwe]
jwe
parents: 610
diff changeset
969
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
970 if (! os.is_valid ())
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
971 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
972
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
973 octave_value fmt_arg = args(0);
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
974
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
975 if (! fmt_arg.is_string ())
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
976 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
977
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
978 octave_value_list retval (3);
19727
3c3b9fce7d2b improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents: 19697
diff changeset
979
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
980 octave_value_list tmp_args;
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
981 if (nargin > 1)
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
982 {
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
983 tmp_args.resize (nargin-1, octave_value ());
19727
3c3b9fce7d2b improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents: 19697
diff changeset
984
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
985 for (int i = 1; i < nargin; i++)
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
986 tmp_args(i-1) = args(i);
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
987 }
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
988
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
989 // 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
990 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
991 retval(1) = os.error ();
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
992
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
993 std::string result = ostr->str ();
23450
855122b993da maint: Wrap tertiary operator in parentheses "(COND ? x : y)".
Rik <rik@octave.org>
parents: 23220
diff changeset
994 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
995
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20884
diff changeset
996 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
997 : octave_value (result, type));
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
998
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
999 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1000 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1001
23737
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1002 static octave_value_list
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1003 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
1004 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
1005 {
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1006 int nargin = args.length ();
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1007
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1008 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
1009 print_usage ();
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_list retval;
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1012
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1013 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
1014
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1015 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
1016
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1017 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
1018 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
1019
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1020 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
1021 {
23924
0519eaf0cca6 fix remaining spurious octave_value_list conversions (bug #51767)
Mike Miller <mtmiller@octave.org>
parents: 23803
diff changeset
1022 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
1023 }
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1024 else
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1025 {
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1026 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
1027
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1028 Array<double> size
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1029 = (nargin == 3
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1030 ? args(2).vector_value ()
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1031 : 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
1032
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1033 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
1034
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1035 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
1036 }
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1037
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1038 return retval;
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1039 }
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1040
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1041 DEFMETHOD (fscanf, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1042 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
1043 @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
1044 @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
1045 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
1046 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
1047
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1048 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
1049 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
1050
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1051 @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
1052 @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
1053 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
1054
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1055 @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
1056 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
1057
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1058 @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
1059 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
1060 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
1061 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
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 @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
1064 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
1065 @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
1066 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
1067 @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
1068
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1069 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1070 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
1071
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1072 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
1073
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1074 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
1075
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1076 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
1077
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1078 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
1079 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
1080 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
1081 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
1082 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
1083 @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
1084
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1085 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
1086 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
1087 @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
1088 @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
1089 @end deftypefn */)
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1090 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1091 static std::string who = "fscanf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1092
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1093 return scanf_internal (interp, who, args);
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1094 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
1095
13194
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1096 static std::string
21507
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1097 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
1098 {
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1099 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
1100
20962
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
1101 if (! val.is_string ())
21507
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1102 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
1103
20962
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
1104 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
1105
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents: 20956
diff changeset
1106 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
1107
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1108 return retval;
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1109 }
3e1871badab9 allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents: 12998
diff changeset
1110
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1111 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
1112 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
1113 @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
1114 @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
1115 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
1116 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
1117
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1118 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
1119 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
1120 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
1121 @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
1122 @end deftypefn */)
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1123 {
4468
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1124 static std::string who = "sscanf";
efb6301dae80 [project @ 2003-07-15 19:18:20 by jwe]
jwe
parents: 4388
diff changeset
1125
506
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe]
jwe
parents: 497
diff changeset
1126 int nargin = args.length ();
0f388340e607 [project @ 1994-07-09 06:10:34 by jwe]
jwe
parents: 497
diff changeset
1127
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1128 if (nargin < 2 || nargin > 3)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1129 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1130
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1131 octave_value_list retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1132
21507
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1133 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
1134
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
1135 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
1136
128703a29388 avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents: 21504
diff changeset
1137 if (! os.is_valid ())
128703a29388 avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents: 21504
diff changeset
1138 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
1139
128703a29388 avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents: 21504
diff changeset
1140 if (! args(1).is_string ())
128703a29388 avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents: 21504
diff changeset
1141 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
1142
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1143 if (nargin == 3 && args(2).is_string ())
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
1144 {
23924
0519eaf0cca6 fix remaining spurious octave_value_list conversions (bug #51767)
Mike Miller <mtmiller@octave.org>
parents: 23803
diff changeset
1145 retval = os.oscanf (args(1), who);
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1146 }
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1147 else
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1148 {
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1149 octave_idx_type count = 0;
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1150
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1151 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
1152 : Array<double> (dim_vector (1, 1),
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1153 lo_ieee_inf_value ());
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1154
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1155 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
1156
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1157 // 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
1158 // Extract error message first, because getting
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1159 // position will clear it.
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1160 std::string errmsg = os.error ();
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1161
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1162 retval = ovl (tmp, count, errmsg,
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
1163 (os.eof () ? data.length () : os.tell ()) + 1);
2215
ab0e1fd337f5 [project @ 1996-05-16 15:56:40 by jwe]
jwe
parents: 2189
diff changeset
1164 }
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1165
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1166 return retval;
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1167 }
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
1168
27137
30f53f7a7293 Return correct error messages on octave-streams when scanf fails (bug #56396)
Rik <rik@octave.org>
parents: 26946
diff changeset
1169 /*
30f53f7a7293 Return correct error messages on octave-streams when scanf fails (bug #56396)
Rik <rik@octave.org>
parents: 26946
diff changeset
1170 %!test <*56396>
30f53f7a7293 Return correct error messages on octave-streams when scanf fails (bug #56396)
Rik <rik@octave.org>
parents: 26946
diff changeset
1171 %! [val, count, errmsg, nextpos] = sscanf ('1234a6', '%2d', 3);
30f53f7a7293 Return correct error messages on octave-streams when scanf fails (bug #56396)
Rik <rik@octave.org>
parents: 26946
diff changeset
1172 %! assert (val, [12; 34]);
30f53f7a7293 Return correct error messages on octave-streams when scanf fails (bug #56396)
Rik <rik@octave.org>
parents: 26946
diff changeset
1173 %! assert (count, 2);
30f53f7a7293 Return correct error messages on octave-streams when scanf fails (bug #56396)
Rik <rik@octave.org>
parents: 26946
diff changeset
1174 %! assert (errmsg, "sscanf: format failed to match");
30f53f7a7293 Return correct error messages on octave-streams when scanf fails (bug #56396)
Rik <rik@octave.org>
parents: 26946
diff changeset
1175 %! assert (nextpos, 5);
30f53f7a7293 Return correct error messages on octave-streams when scanf fails (bug #56396)
Rik <rik@octave.org>
parents: 26946
diff changeset
1176 */
30f53f7a7293 Return correct error messages on octave-streams when scanf fails (bug #56396)
Rik <rik@octave.org>
parents: 26946
diff changeset
1177
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1178 DEFMETHOD (scanf, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1179 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
1180 @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
1181 @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
1182 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
1183
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1184 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
1185 @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
1186 @end deftypefn */)
21634
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
1187 {
23737
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1188 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
1189
7fb957d36357 refactor fprintf, printf, fputs, puts, fscanf, and scanf functions
John W. Eaton <jwe@octave.org>
parents: 23586
diff changeset
1190 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
1191
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1192 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
1193 }
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
1194
21504
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1195 static octave_value_list
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1196 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
1197 const octave_value_list& args)
21504
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1198 {
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1199 if (args.length () < 1)
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1200 print_usage (who);
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1201
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
1202 octave::stream os;
21507
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1203
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1204 if (args(0).is_string ())
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1205 {
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1206 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
1207
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1208 os = octave_istrstream::create (data);
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1209
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1210 if (! os.is_valid ())
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1211 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
1212 }
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
1213 else
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1214 {
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1215 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
1216
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1217 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
1218 }
21504
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1219
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1220 int nskip = 1;
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 std::string fmt;
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 if (args.length () == 1)
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 // ommited format = %f. explicit "" = width from file
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1227 fmt = "%f";
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1228 }
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1229 else if (args(1).is_string ())
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1230 {
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1231 fmt = args(1).string_value ();
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1232
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1233 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
1234 fmt = octave::do_string_escapes (fmt);
21504
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 nskip++;
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1237 }
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1238 else
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1239 error ("%s: FORMAT must be a string", who.c_str ());
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1240
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1241 octave_idx_type ntimes = -1;
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1242
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1243 if (args.length () > 2)
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1244 {
23586
f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric.
Rik <rik@octave.org>
parents: 23573
diff changeset
1245 if (args(2).isnumeric ())
21504
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1246 {
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1247 ntimes = args(2).idx_type_value ();
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1248
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1249 if (ntimes < args(2).double_value ())
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1250 error ("%s: REPEAT = %g is too large",
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1251 who.c_str (), args(2).double_value ());
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1252
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1253 nskip++;
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1254 }
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1255 }
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1256
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1257 octave_value_list options = args.splice (0, nskip);
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1258
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1259 octave_idx_type count = 0;
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1260
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1261 octave_value result = os.textscan (fmt, ntimes, options, who, count);
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1262
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1263 std::string errmsg = os.error ();
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1264
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1265 return ovl (result, count, errmsg);
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1266 }
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1267
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1268 DEFMETHOD (textscan, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1269 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
1270 @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
1271 @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
1272 @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
1273 @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
1274 @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
1275 @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
1276 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
1277
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1278 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
1279 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
1280 @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
1281 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
1282 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
1283
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 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
1285 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
1286 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
1287 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
1288 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
1289
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1290 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
1291 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
1292
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1293 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
1294 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
1295 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
1296 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
1297 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
1298 below).
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1299
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1300 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
1301 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
1302 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
1303 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
1304 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
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 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
1307
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1308 @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
1309 @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
1310 @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
1311 @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
1312 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
1313
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1314 @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
1315 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
1316
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1317 @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
1318 @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
1319 @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
1320 @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
1321 @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
1322 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
1323 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
1324
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1325 @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
1326 @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
1327 @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
1328 @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
1329 @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
1330 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
1331 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
1332
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1333 @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
1334 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
1335 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
1336
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1337 @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
1338 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
1339 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
1340 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
1341 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
1342 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
1343 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
1344 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
1345
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1346 @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
1347 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
1348 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
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 @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
1351 @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
1352 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
1353 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
1354 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
1355 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
1356 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
1357 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
1358 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
1359 '^' 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
1360
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1361 @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
1362 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
1363 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
1364 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
1365 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
1366 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
1367 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
1368 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
1369 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
1370 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
1371
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1372 @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
1373 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
1374
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1375 @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
1376 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
1377 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
1378 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
1379 @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
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 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
1382 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
1383
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1384 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
1385 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
1386 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
1387 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
1388 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
1389 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
1390
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1391 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
1392
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1393 @smallexample
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1394 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1395 @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
1396 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
1397 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
1398 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
1399 @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
1400 @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
1401
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1402 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1403 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
1404
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1405 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1406 @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
1407 @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
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 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
1410 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
1411
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1412 @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
1413 @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
1414 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
1415
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1416 @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
1417 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
1418 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
1419 (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
1420 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
1421 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
1422 future.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1423 @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
1424
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 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
1426 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
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 @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
1429 @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
1430 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
1431 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
1432 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
1433 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
1434
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1435 @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
1436 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
1437 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
1438 (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
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 @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
1441 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
1442 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
1443 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
1444 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
1445 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
1446 delimiters.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1447
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1448 @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
1449 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
1450 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
1451 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
1452 (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
1453
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1454 @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
1455 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
1456 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
1457 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
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{"EndOfLine"}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1460 @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
1461 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
1462 @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
1463 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
1464 @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
1465 @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
1466 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
1467 @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
1468 @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
1469 @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
1470
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 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
1472 @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
1473 @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
1474 @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
1475 @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
1476
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1477 @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
1478 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
1479 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
1480 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
1481
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1482 @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
1483 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
1484 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
1485 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
1486 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
1487 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
1488 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
1489
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1490 @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
1491 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
1492 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
1493
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1494 @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
1495 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
1496 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
1497 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
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 @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
1500 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
1501 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
1502 @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
1503 @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
1504 @qcode{"
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1505 @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
1506 (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
1507 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
1508 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
1509
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1510 @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
1511
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1512 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
1513 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
1514 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
1515 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
1516
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1517 @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
1518 @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
1519 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
1520 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
1521
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1522 @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
1523 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
1524 length
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1525 @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
1526
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1527 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
1528 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
1529
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
1530 @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
1531 @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
1532 {
7a19c5678f91 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 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
1534
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1535 return textscan_internal (interp, who, args);
21504
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1536 }
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1537
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1538 DEFMETHOD (__textscan__, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1539 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
1540 @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
1541 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
1542 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
1543 @end deftypefn */)
21504
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1544 {
65d1daa7d7a7 new function __textscan__
John W. Eaton <jwe@octave.org>
parents: 21503
diff changeset
1545 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
1546 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
1547
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
1548 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
1549 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
1550 }
7a19c5678f91 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
7a19c5678f91 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 /*
7a19c5678f91 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 %!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
1554 %! 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
1555 %! 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
1556 %! c = textscan (str, fmtstr, 2, "delimiter", ",", "emptyvalue", -Inf);
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1557 %! assert (c{1}, [1;5]);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1558 %! 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
1559 %! 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
1560
7a19c5678f91 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 %! 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
1563 %! 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
1564 %! 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
1565 %! 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
1566 %! 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
1567 %! 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
1568 %! 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
1569
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
1570 %!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
1571 %! 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
1572 %! c = textscan (str, "%d %n %f %s %n", "delimiter", ",",
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1573 %! "treatAsEmpty", {"NA", "na", "-"}, "commentStyle", "//");
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1574 %! assert (c{1}, int32 ([13; 36]));
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1575 %! assert (c{2}, [NaN; NaN]);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1576 %! assert (c{3}, [NaN; 5]);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1577 %! assert (c{4}, {"str1"; "str3"});
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1578 %! 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
1579
7a19c5678f91 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 %!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
1581 %! 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
1582 %! 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
1583 %! 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
1584 %! 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
1585 %! fmt = "Km:%d = hhh%1sjjj miles%dhour";
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1586 %! c = textscan (str, fmt, "delimiter", " ");
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1587 %! assert (c{1}', int32 ([10, 15, 2, 25]));
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1588 %! assert (c{2}', {'B' 'J' 'R' 'Z'});
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1589 %! assert (c{3}', int32 ([16, 241, 3, 0]));
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1590
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1591 ## 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
1592 %!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
1593 %! 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
1594 %! 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
1595
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1596 ## 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
1597 %!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
1598 %! c = textscan ("L1\nL2", "%s", "endofline", "");
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1599 %! 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
1600
22737
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1601 ## 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
1602 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1603 %! ## 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
1604 %! str = "Text1Text2Text\nTextText4Text\nText57Text";
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1605 %! 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
1606 %! 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
1607
7a19c5678f91 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 ## 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
1609 %!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
1610 %! 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
1611 %! b = [b; 8*b/5; 8*b*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
1612 %! 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
1613 %! 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
1614 %! 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
1615 %! 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
1616 %! 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
1617
7a19c5678f91 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 ## 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
1619 %!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
1620 %! 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
1621 %! b = [b; 8*b/5; 8*b*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
1622 %! 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
1623 %! 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
1624 %! 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
1625 %! 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
1626 %! 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
1627 %! 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
1628 %! 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
1629 %! 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
1630 %! 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
1631 %! 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
1632
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
1633 ## 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
1634 %!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
1635 %! 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
1636 %! 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
1637 %! 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
1638 %! 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
1639
7a19c5678f91 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 ## 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
1641 %!test
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1642 %! 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
1643 %! 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
1644 %! 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
1645 %! 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
1646
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
1647 ## 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
1648 %!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
1649 %! 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
1650 %! c = textscan (str, "%4d %4d", "delimiter", ";", "collectOutput", 1);
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1651 %! assert (c, {[12, 34; 1234, 5678; 9, 7]});
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1652
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1653 ## 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
1654 %!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
1655 %! 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
1656 %! c = textscan (str, "%4f %f", "delimiter", ";", "collectOutput", 1);
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1657 %! 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
1658
7a19c5678f91 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 ## 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
1660 %!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
1661 %! 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
1662 %! 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
1663 %! "expChars", "e|");
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1664 %! 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
1665
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1666 ## 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
1667 %!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
1668 %! 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
1669 %! 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
1670 %! 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
1671 %! 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
1672
22737
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1673 ## 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
1674 ## 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
1675 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1676 %! str = "12 R&D & 7";
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1677 %! 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
1678 %! "EmptyValue", -99);
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1679 %! 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
1680
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1681 ## 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
1682 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1683 %! str = "12 & R&D 7";
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1684 %! 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
1685 %! 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
1686
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1687 ## 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
1688 %!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
1689 %! 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
1690 %! 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
1691 %! 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
1692 %! 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
1693 %! 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
1694 %! 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
1695 %! 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
1696 %! 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
1697 %! assert (c, {1, 2});
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1698 %! assert (! E);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1699
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1700 ## 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
1701 %!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
1702 %! 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
1703 %! 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
1704 %! 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
1705 %! 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
1706 %! 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
1707 %! 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
1708 %! unlink (f);
21580
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents: 21566
diff changeset
1709 %! 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
1710
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1711 ## 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
1712 %!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
1713 %! 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
1714 %! 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
1715 %! 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
1716 %! 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
1717 %! 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
1718 %! 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
1719 %! unlink (f);
21580
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents: 21566
diff changeset
1720 %! 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
1721
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1722 ## 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
1723 %!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
1724 %! 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
1725 %! 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
1726 %! 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
1727 %! 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
1728 %! fseek (fid, 0, "bof");
21622
fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21621
diff changeset
1729 %! 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
1730 %! 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
1731 %! 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
1732 %! unlink (f);
21622
fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21621
diff changeset
1733 %! 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
1734 %! assert (c, {[1;4], [2], [3]});
fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21621
diff changeset
1735 %! 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
1736
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1737 %! ## 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
1738 %!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
1739 %! 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
1740 %! 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
1741 %! 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
1742 %! 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
1743 %! 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
1744 %! 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
1745 %! 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
1746 %! 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
1747 %! 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
1748 %! 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
1749 %! assert (c, {[1;4], 2, 3});
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents: 21566
diff changeset
1750 %! 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
1751
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1752 %!error <Read error in field 2 of row 2>
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1753 %! 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
1754
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1755 ## 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
1756 %!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
1757 %! 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
1758 %! 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
1759 %! 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
1760 %! fseek (fid, 0, "bof");
21622
fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21621
diff changeset
1761 %! 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
1762 %! 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
1763 %! 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
1764 %! unlink (f);
21622
fed1111e1899 textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21621
diff changeset
1765 %! 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
1766
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1767 ## 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
1768 %!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
1769 %! 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
1770 %! 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
1771
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1772 ## 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
1773 %!test
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1774 %! 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
1775 %! "ReturnOnError", 1);
21580
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents: 21566
diff changeset
1776 %! 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
1777
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1778 ## 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
1779 %!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
1780 %! 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
1781 %! 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
1782
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1783 ## 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
1784 ## Test incomplete first data line
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1785 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1786 %! 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
1787 %! assert (R{1}, int32 (1));
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1788 %! 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
1789
23573
1b4f4ec53b4a use new script to tag fixed bugs in tests
John W. Eaton <jwe@octave.org>
parents: 23572
diff changeset
1790 %!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
1791 %! 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
1792 %! 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
1793 %! 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
1794
22489
93ea313301f9 test: Add bug ids (<#####>) to BIST tests.
Rik <rik@octave.org>
parents: 22407
diff changeset
1795 ## 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
1796 %!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
1797 %! 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
1798 %! 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
1799 %! 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
1800 %! 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
1801 %! 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
1802 %! 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
1803 %! 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
1804 %! 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
1805 %! 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
1806 %! 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
1807 %! 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
1808 %! assert (strcmp (lh, rh));
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1809 %! 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
1810
22489
93ea313301f9 test: Add bug ids (<#####>) to BIST tests.
Rik <rik@octave.org>
parents: 22407
diff changeset
1811 ## 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
1812 %!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
1813 %! 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
1814 %! 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
1815 %! 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
1816 %! 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
1817 %! 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
1818 %! 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
1819 %! 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
1820 %! 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
1821 %! 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
1822 %! 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
1823 %! 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
1824 %! assert (strcmp (lh, rh));
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1825 %! 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
1826
7a19c5678f91 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 ## 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
1828 %!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
1829 %! 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
1830 %! 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
1831 %! 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
1832 %! 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
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", ";", "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
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 ## 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
1845 %!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
1846 %! 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
1847 %! 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
1848 %! 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
1849 %! 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
1850 %! 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
1851 %! 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
1852 %! 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
1853 %! 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
1854 %! 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
1855 %! 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
1856 %! assert (strcmp (lh, rh));
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1857 %! 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
1858
7a19c5678f91 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 ## 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
1860 %!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
1861 %! 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
1862 %! 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
1863 %! 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
1864 %! 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
1865 %! 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
1866 %! 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
1867 %! 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
1868 %! 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
1869 %! 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
1870 %! 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
1871 %! 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
1872 %! assert (strcmp (lh, rh));
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1873 %! 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
1874
7a19c5678f91 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 ## 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
1876 %!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
1877 %! 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
1878 %! 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
1879 %! 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
1880 %! fseek (fid, 0, "bof");
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1881 %! 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
1882 %! 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
1883 %! 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
1884 %! unlink (f);
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1885 %! assert (C{1}, [1 ; 5], 1e-6);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1886 %! assert (C{2}, [2 ; 6], 1e-6);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1887 %! assert (C{3}, [3 ; 7], 1e-6);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1888 %! 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
1889 %! 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
1890
21621
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21581
diff changeset
1891 ## 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
1892 %!test
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21581
diff changeset
1893 %! f = tempname ();
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21581
diff changeset
1894 %! fid = fopen (f, "w+");
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21581
diff changeset
1895 %! 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
1896 %! fseek (fid, 0, "bof");
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1897 %! 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
1898 %! E = ftell (fid);
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21581
diff changeset
1899 %! fclose (fid);
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21581
diff changeset
1900 %! unlink (f);
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21581
diff changeset
1901 %! assert (E, 8);
fe0a6de805e4 textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21581
diff changeset
1902
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
1903 ## 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
1904 %!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
1905 %! 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
1906 %! 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
1907 %! 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
1908 %! fseek (fid, 0, "bof");
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1909 %! C = textscan (fid, "", "delimiter", ",", "EmptyValue", 999,
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1910 %! "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
1911 %! 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
1912 %! unlink (f);
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1913 %! 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
1914
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
1915 ## 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
1916
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
1917 %!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
1918 %! 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
1919 %! 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
1920 %! 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
1921 %! try
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1922 %! 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
1923 %! end_try_catch;
22737
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
1924 %! 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
1925 %! 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
1926 %! 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
1927 %! 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
1928
7a19c5678f91 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 %!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
1930 %! 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
1931 %! 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
1932 %! 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
1933 %! try
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1934 %! 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
1935 %! 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
1936 %! 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
1937 %! 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
1938 %! 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
1939
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1940 ## 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
1941 %!test
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1942 %! 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
1943 %! "collectOutput", 1);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1944 %! assert (C, {[1 2; 3 4]});
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1945
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1946 ## 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
1947 %!test
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1948 %! 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
1949 %! "collectOutput", 1, "EndOfLine", '\r');
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1950 %! 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
1951
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
1952 %!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
1953 %! 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
1954 %! 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
1955 %! 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
1956 %! 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
1957 %! 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
1958 %! try
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1959 %! 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
1960 %! 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
1961 %! 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
1962 %! 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
1963 %! 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
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 %! 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
1967 %! 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
1968 %! 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
1969 %! 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
1970 %! 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
1971 %! try
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1972 %! 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
1973 %! 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
1974 %! 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
1975 %! 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
1976 %! 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
1977
23573
1b4f4ec53b4a use new script to tag fixed bugs in tests
John W. Eaton <jwe@octave.org>
parents: 23572
diff changeset
1978 %!assert <*41824> (textscan ("123", "", "whitespace", " "){:}, 123);
22489
93ea313301f9 test: Add bug ids (<#####>) to BIST tests.
Rik <rik@octave.org>
parents: 22407
diff changeset
1979
93ea313301f9 test: Add bug ids (<#####>) to BIST tests.
Rik <rik@octave.org>
parents: 22407
diff changeset
1980 ## 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
1981 %!assert <*42343> (textscan (",NaN", "", "delimiter", "," ,"emptyValue" ,Inf),
22489
93ea313301f9 test: Add bug ids (<#####>) to BIST tests.
Rik <rik@octave.org>
parents: 22407
diff changeset
1982 %! {Inf, NaN})
93ea313301f9 test: Add bug ids (<#####>) to BIST tests.
Rik <rik@octave.org>
parents: 22407
diff changeset
1983
93ea313301f9 test: Add bug ids (<#####>) to BIST tests.
Rik <rik@octave.org>
parents: 22407
diff changeset
1984 ## 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
1985 %!test <*42343>
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1986 %! c = textscan (",1,,4\nInf, ,NaN\n", "", "delimiter", ",",
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1987 %! "emptyvalue", -10);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1988 %! 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
1989
23573
1b4f4ec53b4a use new script to tag fixed bugs in tests
John W. Eaton <jwe@octave.org>
parents: 23572
diff changeset
1990 %!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
1991 %! assert (textscan ("1i", ""){1}, 0+1i);
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1992 %! 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
1993 %! "delimiter", ",");
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1994 %! 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
1995
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
1996 %!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
1997 %! ## TreatAsEmpty
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
1998 %! 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
1999 %! "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
2000 %! 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
2001 %! 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
2002
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
2003 ## 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
2004 %!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
2005 %! 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
2006 %! C = textscan (str, "%f %f %f %f", "delimiter", ",",
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2007 %! "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
2008 %! 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
2009 %! 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
2010 %! 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
2011 %! 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
2012
21551
990c6c31a684 Accept escape sequences in single quoted strings for "delimiter" (bug #47539)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21548
diff changeset
2013 ## 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
2014 %!test
990c6c31a684 Accept escape sequences in single quoted strings for "delimiter" (bug #47539)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21548
diff changeset
2015 %! 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
2016 %! 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
2017 %! 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
2018 %! 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
2019 %! 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
2020
23573
1b4f4ec53b4a use new script to tag fixed bugs in tests
John W. Eaton <jwe@octave.org>
parents: 23572
diff changeset
2021 %!test <*44750>
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2022 %! c = textscan ("/home/foo/", "%s", "delimiter", "/",
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2023 %! "MultipleDelimsAsOne", 1);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2024 %! assert (c{1}, {"home"; "foo"});
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2025
22737
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
2026 ## FIXME: Test still fails (4/13/2016).
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2027 ## 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
2028 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
2029 %! 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
2030 %! 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
2031 %! 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
2032 %! 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
2033
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
2034 ## 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
2035
7a19c5678f91 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 ## 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
2037 %!test
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2038 %! c = textscan ("Total: 32.5 % (of cm values)",
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2039 %! "Total: %f %% (of cm values)");
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2040 %! 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
2041
22489
93ea313301f9 test: Add bug ids (<#####>) to BIST tests.
Rik <rik@octave.org>
parents: 22407
diff changeset
2042 ## 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
2043 %!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
2044 %! 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
2045 %! 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
2046 %! 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
2047
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2048 ## 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
2049 %!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
2050 %! 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
2051 %! 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
2052 %! 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
2053 %! 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
2054 %! 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
2055 %! 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
2056 %! 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
2057 %! 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
2058 %! 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
2059 %! 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
2060 %! 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
2061 %! 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
2062 %! 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
2063 %! 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
2064 %! 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
2065 %! 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
2066 %! 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
2067
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2068 ## 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
2069 %!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
2070 %! 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
2071 %! 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
2072 %! 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
2073 %! 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
2074 %! 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
2075 %! 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
2076 %! 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
2077 %! 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
2078 %! 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
2079 %! 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
2080 %! 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
2081 %! 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
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 %! 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
2085 %! 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
2086 %! 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
2087 %! 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
2088
7a19c5678f91 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 %!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
2090 %! 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
2091 %! 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
2092 %! 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
2093 %! 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
2094
7a19c5678f91 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 %!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
2096 %! 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
2097 %! 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
2098 %! 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
2099
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2100 ## 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
2101 %!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
2102 %! 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
2103 %! 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
2104 %! 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
2105
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2106 ## %[] tests
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2107 ## 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
2108 %!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
2109 %! 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
2110 %! 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
2111 %! 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
2112 %! 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
2113
7a19c5678f91 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 %! 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
2116
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2117 ## [^..] 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
2118 %!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
2119 %! 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
2120 %! 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
2121 %! 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
2122 %! 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
2123
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2124 ## [..] 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
2125 %!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
2126 %! 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
2127 %! C = textscan (cr, "%[ abcdefg] %*[^0123456789] %s", "delimiter", " \n",
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2128 %! "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
2129 %! 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
2130 %! 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
2131
23573
1b4f4ec53b4a use new script to tag fixed bugs in tests
John W. Eaton <jwe@octave.org>
parents: 23572
diff changeset
2132 %!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
2133
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2134 ## 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
2135 %!test
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2136 %! assert (textscan ("345]", "%*[123456]%[]]"){1}{1}, "]");
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2137 %! assert (textscan ("345]", "%*[^]]%s"){1}{1}, "]");
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2138
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2139 ## 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
2140 %!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
2141 %! 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
2142 %! 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
2143
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2144 ## 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
2145 %!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
2146 %! 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
2147 %! 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
2148
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2149 ## 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
2150 %!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
2151 %! 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
2152 %! 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
2153
22737
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
2154 ## 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
2155 %!test
936ab0fca2f7 Textscan returns emptyVal for rows with literal but no conversion (bug #47458)
Lachlan Andrew <lachlanbis@gmail.com>
parents: 21507
diff changeset
2156 %! 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
2157 %! 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
2158
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2159 ## 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
2160 %!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
2161 %! 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
2162 %! 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
2163 %! 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
2164 %! 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
2165 %! 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
2166 %! 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
2167 %! 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
2168 %! 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
2169 %! 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
2170 %! 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
2171 %! 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
2172 %! 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
2173
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2174 ## 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
2175 %!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
2176 %! 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
2177 %! 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
2178 %! 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
2179 %! 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
2180 %! 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
2181 %! 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
2182 %! 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
2183 %! %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
2184 %! 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
2185 %! 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
2186 %! 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
2187 %! 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
2188 %! 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
2189 %! 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
2190 %! 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
2191 %! 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
2192 %! 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
2193 %! 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
2194 %! 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
2195 %! 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
2196 %! fseek (fid, 0, "bof");
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2197 %! 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
2198 %! 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
2199 %! 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
2200 %! 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
2201
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
2202 %!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
2203 %! 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
2204 %! 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
2205 %! 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
2206 %! 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
2207 %! 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
2208 %! 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
2209 %! 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
2210 %! 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
2211 %! 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
2212 %! 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
2213
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
2214 %!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
2215 %! 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
2216 %! 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
2217 %! 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
2218 %! 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
2219 %! 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
2220 %! fseek (fid, 0, "bof");
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2221 %! C = textscan (fid, "%s %n %n %n %n", "Delimiter", ",",
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2222 %! "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
2223 %! 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
2224 %! 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
2225 %! 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
2226 %! 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
2227 %! 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
2228 %! 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
2229 %! 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
2230
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2231 ## 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
2232 ## 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
2233 %!#test
7abc25e6206a maint: Clean up code base to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 22725
diff changeset
2234 %! 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
2235 %! assert (c(1), {1, "/", 2});
21507
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
2236
2cdbae31c022 improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents: 21506
diff changeset
2237 %!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
2238
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2239 ## Check for delimiter after exponent
21566
02826fb0f261 textscan: Fix bug in exponent parsing
Mike Miller <mtmiller@octave.org>
parents: 21551
diff changeset
2240 %!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
2241
ddc91a2ee0e0 Remove all delimiters from whitespace list in textscan function (bug #52479).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 23219
diff changeset
2242 %!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
2243 %! 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
2244 %! 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
2245 %! 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
2246
26946
04e5cb5e2cb3 update bug status in tests
John W. Eaton <jwe@octave.org>
parents: 26867
diff changeset
2247 %!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
2248 %! 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
2249 %! 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
2250 %! 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
2251
26946
04e5cb5e2cb3 update bug status in tests
John W. Eaton <jwe@octave.org>
parents: 26867
diff changeset
2252 %!test <*52550>
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
2253 %! 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
2254 %! 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
2255 %! 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
2256 %! 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
2257 %! 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
2258
26946
04e5cb5e2cb3 update bug status in tests
John W. Eaton <jwe@octave.org>
parents: 26867
diff changeset
2259 %!test <*52550>
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
2260 %! 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
2261 %! 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
2262 %! 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
2263 %! 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
2264 %! 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
2265
26946
04e5cb5e2cb3 update bug status in tests
John W. Eaton <jwe@octave.org>
parents: 26867
diff changeset
2266 %!test <*52550>
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
2267 %! 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
2268 %! 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
2269 %! 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
2270 %! 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
2271 %! 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
2272
26946
04e5cb5e2cb3 update bug status in tests
John W. Eaton <jwe@octave.org>
parents: 26867
diff changeset
2273 %!test <*52550>
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
2274 %! 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
2275 %! 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
2276
26946
04e5cb5e2cb3 update bug status in tests
John W. Eaton <jwe@octave.org>
parents: 26867
diff changeset
2277 %!test <*52550>
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
2278 %! 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
2279 %! 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
2280 %! 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
2281 %! 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
2282 %! 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
2283
26706
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2284 ## file stream with encoding
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2285 %!test
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2286 %! f = tempname ();
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2287 %! fid = fopen (f, "w+", "n", "iso-8859-1");
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2288 %! unwind_protect
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2289 %! fprintf (fid, "abc,äöü\n");
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2290 %! fseek (fid, 0, "bof");
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2291 %! obs = textscan (fid, "%s", "delimiter", ",");
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2292 %! fclose (fid);
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2293 %! assert (obs, { {"abc"; "äöü"} });
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2294 %! unwind_protect_cleanup
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2295 %! unlink (f);
ccea3574f36b Support encoding of file streams in textscan (bug #55452).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26705
diff changeset
2296 %! end_unwind_protect
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
2297 */
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
2298
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
2299 // 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
2300 #if 0
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2301 ## 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
2302 %!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
2303 %! 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
2304 %! 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
2305
7a19c5678f91 move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents: 21457
diff changeset
2306 ## 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
2307 %!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
2308 %! 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
2309 %! 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
2310 %! 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
2311 %! 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
2312 %! 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
2313 %! 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
2314 %! 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
2315 %! 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
2316 %! 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
2317 %! 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
2318 %! 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
2319 %! 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
2320 #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
2321
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2322 /*
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2323 ## Test input validation
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2324 %!error textscan ()
26640
c18e59476795 file id must not be single for textscan and other file I/O funcs (bug #55577)
Mike Miller <mtmiller@octave.org>
parents: 26378
diff changeset
2325 %!error <file id must be> textscan (single (4))
c18e59476795 file id must not be single for textscan and other file I/O funcs (bug #55577)
Mike Miller <mtmiller@octave.org>
parents: 26378
diff changeset
2326 %!error <file id must be> textscan ({4})
21625
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2327 %!error <must be a string> textscan ("Hello World", 2)
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2328 %!error <at most one character or>
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2329 %! textscan ("Hello World", "%s", "EndOfLine", 3);
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2330 %!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
2331 %!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
2332 */
3cadca91e390 Clean up BIST tests for textscan.
Rik <rik@octave.org>
parents: 21622
diff changeset
2333
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2334 static octave_value
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
2335 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
2336 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
2337 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
2338 {
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2339 count = -1;
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2340
20703
85e5efae848a eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
2341 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
2342
85e5efae848a eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
2343 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
2344
85e5efae848a eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
2345 int block_size = 1;
85e5efae848a eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
2346 oct_data_conv::data_type input_type;
85e5efae848a eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
2347 oct_data_conv::data_type output_type;
85e5efae848a eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
2348
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2349 try
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2350 {
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2351 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
2352 input_type, output_type);
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2353 }
22327
d0562b3159c7 move more classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 22323
diff changeset
2354 catch (octave::execution_exception& e)
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2355 {
20756
200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks
John W. Eaton <jwe@octave.org>
parents: 20747
diff changeset
2356 error (e, "fread: invalid PRECISION specified");
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2357 }
4944
44046bbaa52c [project @ 2004-08-31 05:30:46 by jwe]
jwe
parents: 4933
diff changeset
2358
20747
ee2743bd07a8 eliminate various compiler warnings
John W. Eaton <jwe@octave.org>
parents: 20741
diff changeset
2359 int skip = 0;
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 3180
diff changeset
2360
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2361 try
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2362 {
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2363 skip = skip_arg.int_value (true);
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2364 }
22327
d0562b3159c7 move more classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 22323
diff changeset
2365 catch (octave::execution_exception& e)
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2366 {
20756
200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks
John W. Eaton <jwe@octave.org>
parents: 20747
diff changeset
2367 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
2368 }
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2369
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2370 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
2371
21739
c4ab2e54f100 use namespace for oct_mach_info class
John W. Eaton <jwe@octave.org>
parents: 21736
diff changeset
2372 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
2373 = 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
2374
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2375 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
2376 flt_fmt, count);
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2377 }
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2378
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2379 DEFMETHOD (fread, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2380 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
2381 @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
2382 @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
2383 @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
2384 @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
2385 @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
2386 @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
2387 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
2388
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2389 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
2390 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
2391
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2392 @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
2393 @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
2394 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
2395
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2396 @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
2397 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
2398
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2399 @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
2400 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
2401 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
2402 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
2403
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2404 @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
2405 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
2406 @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
2407 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
2408 @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
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 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2411 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
2412
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2413 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
2414 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
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 @table @asis
23982
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2417 @item @qcode{"uint8"} (default)
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2418 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
2419
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2420 @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
2421 @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
2422 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
2423
23982
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2424 @item @qcode{"uint16"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2425 @itemx @qcode{"ushort"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2426 @itemx @qcode{"unsigned short"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2427 16-bit unsigned integer.
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2428
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2429 @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
2430 @itemx @qcode{"integer*2"}
23982
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2431 @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
2432 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
2433
23982
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2434 @item @qcode{"uint"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2435 @itemx @qcode{"uint32"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2436 @itemx @qcode{"unsigned int"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2437 @itemx @qcode{"ulong"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2438 @itemx @qcode{"unsigned long"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2439 32-bit unsigned integer.
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2440
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2441 @item @qcode{"int"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2442 @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
2443 @itemx @qcode{"integer*4"}
23982
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2444 @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
2445 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
2446
23982
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2447 @item @qcode{"uint64"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2448 64-bit unsigned integer.
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2449
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2450 @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
2451 @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
2452 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
2453
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2454 @item @qcode{"single"}
23949
58435a400d4e Document that fread 'float' size is 32 bits (bug #41672).
Rik <rik@octave.org>
parents: 23924
diff changeset
2455 @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
2456 @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
2457 @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
2458 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
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 @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
2461 @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
2462 @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
2463 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
2464
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2465 @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
2466 @itemx @qcode{"char*1"}
23982
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2467 8-bit single character.
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2468
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2469 @item @qcode{"uchar"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2470 @itemx @qcode{"unsigned char"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2471 8-bit unsigned character.
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2472
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2473 @item @qcode{"schar"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2474 @itemx @qcode{"signed char"}
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2475 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
2476
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2477 @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
2478
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2479 @noindent
23982
3706091dc91c Make fread, fwrite precisions compatible with Matlab (bug #41672).
Rik <rik@octave.org>
parents: 23949
diff changeset
2480 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
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 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
2483 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
2484 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
2485 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
2486
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2487 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
2488 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
2489 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
2490 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
2491 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
2492
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2493 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
2494 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
2495 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
2496 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
2497 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
2498
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2499 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
2500 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
2501 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
2502 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
2503
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2504 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2505 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
2506 @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
2507
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2508 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2509 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
2510 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
2511
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2512 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
2513 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
2514
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2515 @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
2516 @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
2517 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
2518
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2519 @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
2520 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
2521
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2522 @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
2523 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
2524 @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
2525
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2526 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
2527 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
2528 @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
2529
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2530 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
2531
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2532 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
2533 @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
2534 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
2535 {
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2536 int nargin = args.length ();
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2537
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2538 if (nargin < 1 || nargin > 5)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2539 print_usage ();
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2540
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2541 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
2542
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2543 octave::stream os = streams.lookup (args(0), "fread");
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2544
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2545 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
2546 octave_value prec = "uint8";
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2547 octave_value skip = 0;
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2548 octave_value arch = "unknown";
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2549
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2550 int idx = 1;
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2551
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2552 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
2553 size = args(idx++);
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2554
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2555 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2556 prec = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2557
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2558 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2559 skip = args(idx++);
4257
e556870ce8f0 [project @ 2003-01-02 03:14:41 by jwe]
jwe
parents: 4254
diff changeset
2560
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2561 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2562 arch = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2563 else if (skip.is_string ())
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2564 {
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2565 arch = skip;
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2566 skip = 0;
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2567 }
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2568
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2569 octave_idx_type count = -1;
20561
c41595061186 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20457
diff changeset
2570
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2571 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
2572
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
2573 return ovl (tmp, count);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
2574 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
2575
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2576 static int
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
2577 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
2578 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
2579 const octave_value& arch_arg)
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2580 {
20700
68e3a747ca02 rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents: 20687
diff changeset
2581 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
2582
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20561
diff changeset
2583 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
2584 oct_data_conv::data_type output_type;
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2585
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2586 try
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20561
diff changeset
2587 {
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2588 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
2589 }
22327
d0562b3159c7 move more classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 22323
diff changeset
2590 catch (octave::execution_exception& e)
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2591 {
20756
200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks
John W. Eaton <jwe@octave.org>
parents: 20747
diff changeset
2592 error (e, "fwrite: invalid PRECISION specified");
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2593 }
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2594
20747
ee2743bd07a8 eliminate various compiler warnings
John W. Eaton <jwe@octave.org>
parents: 20741
diff changeset
2595 int skip = 0;
3202
44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe]
jwe
parents: 3180
diff changeset
2596
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2597 try
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2598 {
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2599 skip = skip_arg.int_value (true);
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2600 }
22327
d0562b3159c7 move more classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 22323
diff changeset
2601 catch (octave::execution_exception& e)
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2602 {
20756
200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks
John W. Eaton <jwe@octave.org>
parents: 20747
diff changeset
2603 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
2604 }
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2605
20741
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2606 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
2607
21739
c4ab2e54f100 use namespace for oct_mach_info class
John W. Eaton <jwe@octave.org>
parents: 21736
diff changeset
2608 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
2609 = 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
2610
a5ab31b52ae8 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20713
diff changeset
2611 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
2612 }
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2613
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2614 DEFMETHOD (fwrite, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2615 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
2616 @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
2617 @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
2618 @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
2619 @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
2620 @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
2621 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
2622 @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
2623 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
2624
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2625 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
2626 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
2627
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2628 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
2629 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
2630
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2631 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
2632 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
2633 @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
2634 @end deftypefn */)
1181
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
2635 {
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
diff changeset
2636 int nargin = args.length ();
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
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 (nargin < 2 || nargin > 5)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
2639 print_usage ();
2116
99658f9b74c8 [project @ 1996-05-10 07:20:15 by jwe]
jwe
parents: 2095
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), "fwrite");
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2644
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2645 octave_value prec = "uchar";
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2646 octave_value skip = 0;
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2647 octave_value arch = "unknown";
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2648
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2649 int idx = 1;
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2650
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2651 octave_value data = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2652
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2653 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2654 prec = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2655
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2656 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2657 skip = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2658
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2659 if (nargin > idx)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2660 arch = args(idx++);
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2661 else if (skip.is_string ())
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2662 {
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2663 arch = skip;
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2664 skip = 0;
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2665 }
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2666
21127
df7891224709 maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents: 21126
diff changeset
2667 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
2668 }
b2b7c5264ac2 [project @ 1995-03-28 23:51:50 by jwe]
jwe
parents: 1086
diff changeset
2669
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2670 DEFMETHODX ("feof", Ffeof, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2671 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
2672 @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
2673 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
2674 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
2675
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2676 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
2677 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
2678 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
2679 @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
2680 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
2681 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2682 if (args.length () != 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
2683 print_usage ();
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
2684
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2685 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
2686
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2687 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
2688
21127
df7891224709 maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents: 21126
diff changeset
2689 return ovl (os.eof () ? 1.0 : 0.0);
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
2690 }
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 372
diff changeset
2691
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2692 DEFMETHODX ("ferror", Fferror, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2693 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
2694 @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
2695 @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
2696 @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
2697 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
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 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
2700 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
2701
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2702 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
2703 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
2704
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2705 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
2706 @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
2707
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2708 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
2709 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
2710 @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
2711 @end deftypefn */)
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2712 {
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
2713 int nargin = args.length ();
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2714
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2715 if (nargin < 1 || nargin > 2)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2716 print_usage ();
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2717
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2718 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
2719
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2720 octave::stream os = streams.lookup (args(0), "ferror");
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2721
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2722 bool clear = false;
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
2723
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2724 if (nargin == 2)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2725 {
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2726 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
2727
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2728 clear = (opt == "clear");
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2729 }
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1750
diff changeset
2730
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2731 int error_number = 0;
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2732
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2733 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
2734
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
2735 return ovl (error_message, error_number);
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2736 }
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2737
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2738 DEFMETHODX ("popen", Fpopen, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2739 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
2740 @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
2741 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
2742
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2743 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
2744 @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
2745
22720
766b0163b3b7 doc: Don't create @tables of type @code with @qcode entries.
Rik <rik@octave.org>
parents: 22511
diff changeset
2746 @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
2747 @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
2748 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
2749 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
2750
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2751 @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
2752 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
2753 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
2754 @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
2755
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2756 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
2757 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
2758
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2759 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
2760
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2761 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2762 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2763 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
2764 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
2765 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
2766 endwhile
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2767
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2768 @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
2769 @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
2770 @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
2771 @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
2772 @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
2773 @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
2774 @end deftypefn */)
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2775 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2776 if (args.length () != 2)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2777 print_usage ();
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2778
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2779 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
2780 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
2781
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
2782 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
2783
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2784 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
2785
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2786 if (mode == "r")
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2787 {
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
2788 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
2789
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2790 retval = streams.insert (ips);
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2791 }
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2792 else if (mode == "w")
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2793 {
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
2794 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
2795
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2796 retval = streams.insert (ops);
2095
36903d507b0e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents: 1996
diff changeset
2797 }
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2798 else
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2799 error ("popen: invalid MODE specified");
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2800
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2801 return retval;
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2802 }
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2803
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2804 DEFMETHODX ("pclose", Fpclose, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2805 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
2806 @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
2807 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
2808
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2809 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
2810 @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
2811 @end deftypefn */)
1230
92609e161b29 [project @ 1995-04-10 01:08:57 by jwe]
jwe
parents: 1181
diff changeset
2812 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2813 if (args.length () != 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
2814 print_usage ();
1379
e29697484908 [project @ 1995-09-12 00:41:58 by jwe]
jwe
parents: 1377
diff changeset
2815
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2816 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
2817
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2818 return ovl (streams.remove (args(0), "pclose"));
1379
e29697484908 [project @ 1995-09-12 00:41:58 by jwe]
jwe
parents: 1377
diff changeset
2819 }
e29697484908 [project @ 1995-09-12 00:41:58 by jwe]
jwe
parents: 1377
diff changeset
2820
19278
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19268
diff changeset
2821 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
2822 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
2823 @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
2824 @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
2825 @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
2826 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
2827
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2828 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
2829
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2830 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
2831 (@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
2832 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
2833
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2834 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
2835 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
2836 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
2837 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
2838 @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
2839 @end deftypefn */)
1802
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
2840 {
20812
d9ca869ca124 maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents: 20805
diff changeset
2841 int nargin = args.length ();
2936
87cb7614257d [project @ 1997-05-06 05:46:00 by jwe]
jwe
parents: 2926
diff changeset
2842
20812
d9ca869ca124 maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents: 20805
diff changeset
2843 if (nargin > 2)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
2844 print_usage ();
1802
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
2845
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2846 std::string dir;
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2847
20812
d9ca869ca124 maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents: 20805
diff changeset
2848 if (nargin > 0)
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2849 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
2850 else
1e81abd0314a tempname: respect the value of $TMPDIR if set, be consistent with tempdir
Mike Miller <mtmiller@octave.org>
parents: 22489
diff changeset
2851 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
2852
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2853 std::string pfx ("oct-");
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2854
20812
d9ca869ca124 maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents: 20805
diff changeset
2855 if (nargin > 1)
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2856 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
2857
21733
cb0fdd941d84 use namespace for system file_ops class
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
2858 return ovl (octave::sys::tempnam (dir, pfx));
1802
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
2859 }
8173b1fa052d [project @ 1996-01-29 06:10:18 by jwe]
jwe
parents: 1799
diff changeset
2860
19420
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19403
diff changeset
2861 /*
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19403
diff changeset
2862 %!test
24662
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2863 %! envvar = {"TMPDIR", "TMP"};
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2864 %! 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
2865 %! unwind_protect
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2866 %! 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
2867 %! envname = "TMPDIR";
24662
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2868 %! def_tmpdir = P_tmpdir;
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2869 %! ## 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
2870 %! 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
2871 %! def_tmpdir(end) = [];
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2872 %! endwhile
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2873 %!
19420
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19403
diff changeset
2874 %! ## 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
2875 %! fname = tempname ();
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19420
diff changeset
2876 %! [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
2877 %! 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
2878 %! assert (tmpfname (1:4), "oct-");
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19420
diff changeset
2879 %! ## 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
2880 %! 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
2881 %! 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
2882 %! 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
2883 %! fname = tempname (tmp_tmpdir);
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19420
diff changeset
2884 %! [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
2885 %! 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
2886 %! 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
2887 %! ## 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
2888 %! fname = tempname ("");
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19420
diff changeset
2889 %! [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
2890 %! 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
2891 %! assert (tmpfname (1:4), "oct-");
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19420
diff changeset
2892 %! ## 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
2893 %! fname = tempname (tmp_tmpdir, "pfx-");
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19420
diff changeset
2894 %! [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
2895 %! 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
2896 %! 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
2897 %! ## 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
2898 %! fname = tempname (tmp_tmpdir, "");
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19420
diff changeset
2899 %! [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
2900 %! 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
2901 %! 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
2902 %! 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
2903 %! rmdir (tmp_tmpdir);
24662
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2904 %! 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
2905 %! if (isempty (envdir{i}))
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2906 %! unsetenv (envvar{i});
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2907 %! else
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2908 %! 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
2909 %! endif
276eca875721 Clear environment variables affecting tmpdir before running BIST tests (bug #52627)
Rik <rik@octave.org>
parents: 24534
diff changeset
2910 %! endfor
19420
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19403
diff changeset
2911 %! 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
2912 */
82f2a3437e02 Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents: 19403
diff changeset
2913
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2914 DEFMETHOD (tmpfile, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2915 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
2916 @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
2917 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
2918 name.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2919
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2920 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
2921 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
2922
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2923 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
2924 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
2925 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
2926 @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
2927 @end deftypefn */)
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2928 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2929 if (args.length () != 0)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2930 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2931
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
2932 octave_value_list retval;
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2933
21991
80659e58609f provide wrapper for tmpfile (bug #48337)
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
2934 FILE *fid = octave_tmpfile_wrapper ();
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2935
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2936 if (fid)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2937 {
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2938 std::string nm;
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2939
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2940 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
2941
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
2942 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
2943
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
2944 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
2945 {
3bb1c94b41f2 * file-io.cc (Ftmpfile): Close tmp file if stream creation fails.
John W. Eaton <jwe@octave.org>
parents: 23738
diff changeset
2946 fclose (fid);
3bb1c94b41f2 * file-io.cc (Ftmpfile): Close tmp file if stream creation fails.
John W. Eaton <jwe@octave.org>
parents: 23738
diff changeset
2947
3bb1c94b41f2 * file-io.cc (Ftmpfile): Close tmp file if stream creation fails.
John W. Eaton <jwe@octave.org>
parents: 23738
diff changeset
2948 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
2949 }
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2950
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2951 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
2952
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2953 retval = ovl (streams.insert (s), "");
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2954 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2955 else
23741
3bb1c94b41f2 * file-io.cc (Ftmpfile): Close tmp file if stream creation fails.
John W. Eaton <jwe@octave.org>
parents: 23738
diff changeset
2956 retval = ovl (-1, std::strerror (errno));
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2957
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2958 return retval;
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2959 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2960
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2961 DEFMETHOD (mkstemp, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
2962 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
2963 @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
2964 @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
2965 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
2966 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
2967
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2968 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
2969 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
2970 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
2971 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
2972 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
2973 @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
2974
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2975 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
2976 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
2977
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2978 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
2979 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
2980 @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
2981 message.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
2982 @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
2983 @end deftypefn */)
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2984 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2985 int nargin = args.length ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2986
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2987 if (nargin < 1 || nargin > 2)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2988 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2989
20884
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
2990 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
2991
20884
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
2992 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
2993
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2994 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
2995 strcpy (tmp, tmpl8.c_str ());
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2996
21888
00f1249f2483 create wrappers for some gnulib functions
John W. Eaton <jwe@octave.org>
parents: 21852
diff changeset
2997 int fd = octave_mkostemp_wrapper (tmp);
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
2998
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
2999 if (fd < 0)
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
3000 {
20884
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
3001 retval(0) = fd;
21942
aab79a1885cc limit gnulib headers to liboctave/wrappers directory
John W. Eaton <jwe@octave.org>
parents: 21919
diff changeset
3002 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
3003 }
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3004 else
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3005 {
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3006 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
3007
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3008 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
3009
20884
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
3010 if (! fid)
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
3011 {
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
3012 retval(0) = -1;
21942
aab79a1885cc limit gnulib headers to liboctave/wrappers directory
John W. Eaton <jwe@octave.org>
parents: 21919
diff changeset
3013 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
3014 }
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
3015 else
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3016 {
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3017 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
3018
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3019 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
3020
23059
b98ebcd7f11c move some octave stream classes into octave namespace
John W. Eaton <jwe@octave.org>
parents: 22837
diff changeset
3021 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
3022
20884
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
3023 if (! s)
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
3024 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
3025
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3026 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
3027
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3028 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
3029 retval(1) = nm;
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
3030
f1b2a2dbc0e1 2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents: 20861
diff changeset
3031 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
3032 mark_for_deletion (nm);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10259
diff changeset
3033 }
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
3034 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
3035
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
3036 return retval;
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
3037 }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4267
diff changeset
3038
20200
d9f35ceff9e1 Change mkfifo to use an octal argument for MODE (bug #45054).
Rik <rik@octave.org>
parents: 20198
diff changeset
3039 // 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
3040 // Maybe change to be a general utility routine.
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3041 static int
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3042 convert (int x, int ibase, int obase)
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3043 {
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3044 int retval = 0;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3045
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3046 int tmp = x % obase;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3047
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3048 if (tmp > ibase - 1)
20428
7ac907da9fba Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents: 20200
diff changeset
3049 error ("umask: invalid digit");
21055
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3050
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3051 retval = tmp;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3052 int mult = ibase;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3053 while ((x = (x - tmp) / obase))
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3054 {
21055
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3055 tmp = x % obase;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3056
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3057 if (tmp > ibase - 1)
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3058 error ("umask: invalid digit");
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3059
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3060 retval += mult * tmp;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20962
diff changeset
3061 mult *= ibase;
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3062 }
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3063
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3064 return retval;
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3065 }
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3066
10197
4d433bd2d4dc attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents: 10182
diff changeset
3067 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
3068 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
3069 @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
3070 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
3071
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
3072 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
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 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
3075 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
3076
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
3077 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
3078 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
3079 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
3080 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
3081 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
3082 @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
3083 @end deftypefn */)
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3084 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3085 if (args.length () != 1)
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3086 print_usage ();
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3087
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3088 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
3089
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3090 if (mask < 0)
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
3091 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
3092
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
3093 int oct_mask = convert (mask, 8, 10);
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
3094
21733
cb0fdd941d84 use namespace for system file_ops class
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
3095 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
3096
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3097 if (status >= 0)
20918
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
3098 return ovl (status);
6f0bd96f93c0 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
3099 else
20941
a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents: 20940
diff changeset
3100 return ovl ();
1400
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3101 }
209ec8f4db00 [project @ 1995-09-15 04:08:08 by jwe]
jwe
parents: 1381
diff changeset
3102
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3103 static octave_value
6483
d00da2148c53 [project @ 2007-04-04 02:58:48 by jwe]
jwe
parents: 6456
diff changeset
3104 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
3105 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3106 if (args.length () != 0)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
3107 print_usage ();
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3108
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3109 return octave_value (val);
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3110 }
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3111
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3112 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
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 {} {} 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
3115 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
3116 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
3117
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
3118 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
3119 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
3120 @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
3121 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
3122 @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
3123 @end deftypefn */)
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3124 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3125 if (args.length () != 0)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
3126 print_usage ();
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3127
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
3128 return ovl (octave::get_P_tmpdir ());
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3129 }
2341
6ee55c0f25a9 [project @ 1996-07-24 10:33:09 by jwe]
jwe
parents: 2324
diff changeset
3130
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3131 // 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
3132 // this way for Matlab compatibility.
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3133
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3134 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
3135 doc: /* -*- texinfo -*-
25032
a1e391e33004 doc: grammarcheck documentation again ahead of 4.4 release.
Rik <rik@octave.org>
parents: 25005
diff changeset
3136 @deftypefn {} {} SEEK_SET ()
25005
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END.
Rik <rik@octave.org>
parents: 25003
diff changeset
3137 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
3138 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
3139 @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
3140 @end deftypefn */)
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3141 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3142 return const_value ("SEEK_SET", args, -1);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3143 }
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
3144
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3145 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
3146 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
3147 @deftypefn {} {} SEEK_CUR ()
25005
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END.
Rik <rik@octave.org>
parents: 25003
diff changeset
3148 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
3149 relative to the current position.
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END.
Rik <rik@octave.org>
parents: 25003
diff changeset
3150 @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
3151 @end deftypefn */)
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3152 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3153 return const_value ("SEEK_CUR", args, 0);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3154 }
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
3155
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3156 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
3157 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
3158 @deftypefn {} {} SEEK_END ()
25005
db1e3f3664f4 doc: Update documentation for SEEK_SET, SEEK_CUR, SEEK_END.
Rik <rik@octave.org>
parents: 25003
diff changeset
3159 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
3160 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
3161 @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
3162 @end deftypefn */)
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3163 {
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3164 return const_value ("SEEK_END", args, 1);
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3165 }
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3166
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3167 static octave_value
6483
d00da2148c53 [project @ 2007-04-04 02:58:48 by jwe]
jwe
parents: 6456
diff changeset
3168 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
3169 const octave_value& val)
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3170 {
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3171 if (args.length () != 0)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
3172 print_usage ();
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3173
20805
2d6ddb2b157c eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
3174 return octave_value (val);
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3175 }
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3176
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3177 DEFMETHODX ("stdin", Fstdin, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3178 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
3179 @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
3180 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
3181
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
3182 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
3183 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
3184 @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
3185 @end deftypefn */)
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3186 {
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3187 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
3188
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3189 return const_value ("stdin", args, streams.stdin_file ());
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3190 }
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
3191
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3192 DEFMETHODX ("stdout", Fstdout, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3193 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
3194 @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
3195 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
3196
24801
daf61c7dfcae Change default status of pager to "off" (bug #53217).
Rik <rik@octave.org>
parents: 24662
diff changeset
3197 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
3198 @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
3199 @end deftypefn */)
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3200 {
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3201 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
3202
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3203 return const_value ("stdout", args, streams.stdout_file ());
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3204 }
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
3205
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3206 DEFMETHODX ("stderr", Fstderr, interp, args, ,
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3207 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
3208 @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
3209 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
3210
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21942
diff changeset
3211 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
3212 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
3213 @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
3214 @end deftypefn */)
5749
26beffa9f66f [project @ 2006-04-07 20:35:07 by jwe]
jwe
parents: 5653
diff changeset
3215 {
23738
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3216 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
3217
8acd390d16c9 don't use singleton for stream_list object
John W. Eaton <jwe@octave.org>
parents: 23737
diff changeset
3218 return const_value ("stderr", args, streams.stderr_file ());
2189
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe]
jwe
parents: 2148
diff changeset
3219 }