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