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