|
604
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
604
|
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. |
|
604
|
20 |
|
|
21 */ |
|
|
22 |
|
3911
|
23 // Author: John W. Eaton. |
|
|
24 // HDF5 support by Steven G. Johnson <stevenj@alum.mit.edu> |
|
|
25 // Matlab v5 support by James R. Van Zandt <jrv@vanzandt.mv.com> |
|
3687
|
26 |
|
604
|
27 #ifdef HAVE_CONFIG_H |
|
1192
|
28 #include <config.h> |
|
604
|
29 #endif |
|
|
30 |
|
1343
|
31 #include <cfloat> |
|
|
32 #include <cstring> |
|
|
33 #include <cctype> |
|
|
34 |
|
4249
|
35 #include <fstream> |
|
3503
|
36 #include <iomanip> |
|
|
37 #include <iostream> |
|
1728
|
38 #include <string> |
|
|
39 |
|
3687
|
40 #ifdef HAVE_HDF5 |
|
|
41 #include <hdf5.h> |
|
|
42 #endif |
|
|
43 |
|
1961
|
44 #include "byte-swap.h" |
|
|
45 #include "data-conv.h" |
|
2926
|
46 #include "file-ops.h" |
|
|
47 #include "glob-match.h" |
|
2890
|
48 #include "lo-mappers.h" |
|
4051
|
49 #include "lo-sstream.h" |
|
2318
|
50 #include "mach-info.h" |
|
3185
|
51 #include "oct-env.h" |
|
3258
|
52 #include "oct-time.h" |
|
4171
|
53 #include "quit.h" |
|
1755
|
54 #include "str-vec.h" |
|
|
55 |
|
4332
|
56 #include "Cell.h" |
|
1352
|
57 #include "defun.h" |
|
604
|
58 #include "error.h" |
|
777
|
59 #include "gripes.h" |
|
1352
|
60 #include "load-save.h" |
|
1750
|
61 #include "oct-obj.h" |
|
3687
|
62 #include "oct-map.h" |
|
4332
|
63 #include "ov-cell.h" |
|
1352
|
64 #include "pager.h" |
|
1750
|
65 #include "pt-exp.h" |
|
1352
|
66 #include "symtab.h" |
|
|
67 #include "sysdep.h" |
|
|
68 #include "unwind-prot.h" |
|
604
|
69 #include "utils.h" |
|
2371
|
70 #include "variables.h" |
|
3185
|
71 #include "version.h" |
|
3688
|
72 #include "dMatrix.h" |
|
|
73 |
|
4659
|
74 #ifdef HAVE_HDF5 |
|
4633
|
75 #include "ls-hdf5.h" |
|
4659
|
76 #endif |
|
4633
|
77 #include "ls-mat-ascii.h" |
|
|
78 #include "ls-mat4.h" |
|
|
79 #include "ls-mat5.h" |
|
|
80 #include "ls-oct-ascii.h" |
|
|
81 #include "ls-oct-binary.h" |
|
3688
|
82 |
|
3598
|
83 // Write octave-core file if Octave crashes or is killed by a signal. |
|
3189
|
84 static bool Vcrash_dumps_octave_core; |
|
|
85 |
|
4791
|
86 // The maximum amount of memory (in kilobytes) that we will attempt to |
|
|
87 // write to the Octave core file. |
|
|
88 static double Voctave_core_file_limit; |
|
|
89 |
|
|
90 // The name of the Octave core file. |
|
|
91 static std::string Voctave_core_file_name; |
|
|
92 |
|
3687
|
93 // The default output format. May be one of "binary", "text", |
|
|
94 // "mat-binary", or "hdf5". |
|
3523
|
95 static std::string Vdefault_save_format; |
|
2194
|
96 |
|
4791
|
97 // The output format for Octave core files. May be one of "binary", |
|
4788
|
98 // "text", "mat-binary", or "hdf5". |
|
4791
|
99 static std::string Voctave_core_file_format; |
|
4788
|
100 |
|
3709
|
101 // The format string for the comment line at the top of text-format |
|
|
102 // save files. Passed to strftime. Should begin with `#' and contain |
|
|
103 // no newline characters. |
|
|
104 static std::string Vsave_header_format_string; |
|
|
105 |
|
630
|
106 // XXX FIXME XXX -- shouldn't this be implemented in terms of other |
|
|
107 // functions that are already available? |
|
604
|
108 |
|
|
109 // Install a variable with name NAME and the value specified TC in the |
|
3019
|
110 // symbol table. If FORCE is TRUE, replace any existing definition |
|
|
111 // for NAME. If GLOBAL is TRUE, make the variable global. |
|
604
|
112 // |
|
|
113 // Assumes TC is defined. |
|
|
114 |
|
|
115 static void |
|
4171
|
116 install_loaded_variable (int force, const std::string& name, |
|
|
117 const octave_value& val, |
|
|
118 int global, const std::string& doc) |
|
604
|
119 { |
|
1358
|
120 // Is there already a symbol by this name? If so, what is it? |
|
604
|
121 |
|
2856
|
122 symbol_record *lsr = curr_sym_tab->lookup (name); |
|
604
|
123 |
|
3019
|
124 bool is_undefined = true; |
|
|
125 bool is_variable = false; |
|
|
126 bool is_function = false; |
|
|
127 bool is_global = false; |
|
604
|
128 |
|
|
129 if (lsr) |
|
|
130 { |
|
|
131 is_undefined = ! lsr->is_defined (); |
|
|
132 is_variable = lsr->is_variable (); |
|
|
133 is_function = lsr->is_function (); |
|
|
134 is_global = lsr->is_linked_to_global (); |
|
|
135 } |
|
|
136 |
|
|
137 symbol_record *sr = 0; |
|
|
138 |
|
|
139 if (global) |
|
|
140 { |
|
|
141 if (is_global || is_undefined) |
|
|
142 { |
|
|
143 if (force || is_undefined) |
|
|
144 { |
|
2856
|
145 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
146 link_to_global_variable (lsr); |
|
|
147 sr = lsr; |
|
|
148 } |
|
|
149 else |
|
|
150 { |
|
4171
|
151 warning ("load: global variable name `%s' exists", |
|
|
152 name.c_str ()); |
|
604
|
153 warning ("use `load -force' to overwrite"); |
|
|
154 } |
|
|
155 } |
|
|
156 else if (is_function) |
|
|
157 { |
|
|
158 if (force) |
|
|
159 { |
|
2856
|
160 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
161 link_to_global_variable (lsr); |
|
|
162 sr = lsr; |
|
|
163 } |
|
|
164 else |
|
|
165 { |
|
4171
|
166 warning ("load: `%s' is currently a function in this scope", |
|
|
167 name.c_str ()); |
|
604
|
168 warning ("`load -force' will load variable and hide function"); |
|
|
169 } |
|
|
170 } |
|
|
171 else if (is_variable) |
|
|
172 { |
|
|
173 if (force) |
|
|
174 { |
|
2856
|
175 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
176 link_to_global_variable (lsr); |
|
|
177 sr = lsr; |
|
|
178 } |
|
|
179 else |
|
|
180 { |
|
4171
|
181 warning ("load: local variable name `%s' exists", |
|
|
182 name.c_str ()); |
|
604
|
183 warning ("use `load -force' to overwrite"); |
|
|
184 } |
|
|
185 } |
|
|
186 else |
|
774
|
187 error ("load: unable to load data for unknown symbol type"); |
|
604
|
188 } |
|
|
189 else |
|
|
190 { |
|
|
191 if (is_global) |
|
|
192 { |
|
|
193 if (force || is_undefined) |
|
|
194 { |
|
2856
|
195 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
196 link_to_global_variable (lsr); |
|
|
197 sr = lsr; |
|
|
198 } |
|
|
199 else |
|
|
200 { |
|
4171
|
201 warning ("load: global variable name `%s' exists", |
|
|
202 name.c_str ()); |
|
604
|
203 warning ("use `load -force' to overwrite"); |
|
|
204 } |
|
|
205 } |
|
|
206 else if (is_function) |
|
|
207 { |
|
|
208 if (force) |
|
|
209 { |
|
2856
|
210 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
211 link_to_global_variable (lsr); |
|
|
212 sr = lsr; |
|
|
213 } |
|
|
214 else |
|
|
215 { |
|
4171
|
216 warning ("load: `%s' is currently a function in this scope", |
|
|
217 name.c_str ()); |
|
604
|
218 warning ("`load -force' will load variable and hide function"); |
|
|
219 } |
|
|
220 } |
|
|
221 else if (is_variable || is_undefined) |
|
|
222 { |
|
|
223 if (force || is_undefined) |
|
|
224 { |
|
2856
|
225 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
226 sr = lsr; |
|
|
227 } |
|
|
228 else |
|
|
229 { |
|
4171
|
230 warning ("load: local variable name `%s' exists", |
|
|
231 name.c_str ()); |
|
604
|
232 warning ("use `load -force' to overwrite"); |
|
|
233 } |
|
|
234 } |
|
|
235 else |
|
774
|
236 error ("load: unable to load data for unknown symbol type"); |
|
604
|
237 } |
|
|
238 |
|
|
239 if (sr) |
|
|
240 { |
|
2371
|
241 sr->define (val); |
|
4171
|
242 sr->document (doc); |
|
604
|
243 return; |
|
|
244 } |
|
|
245 else |
|
4171
|
246 error ("load: unable to load variable `%s'", name.c_str ()); |
|
604
|
247 |
|
|
248 return; |
|
|
249 } |
|
|
250 |
|
3019
|
251 // Return TRUE if NAME matches one of the given globbing PATTERNS. |
|
604
|
252 |
|
3013
|
253 static bool |
|
3769
|
254 matches_patterns (const string_vector& patterns, int pat_idx, |
|
3523
|
255 int num_pat, const std::string& name) |
|
604
|
256 { |
|
1755
|
257 for (int i = pat_idx; i < num_pat; i++) |
|
604
|
258 { |
|
1792
|
259 glob_match pattern (patterns[i]); |
|
3013
|
260 |
|
1792
|
261 if (pattern.match (name)) |
|
3013
|
262 return true; |
|
604
|
263 } |
|
3688
|
264 |
|
3013
|
265 return false; |
|
604
|
266 } |
|
|
267 |
|
4329
|
268 int |
|
3523
|
269 read_binary_file_header (std::istream& is, bool& swap, |
|
4329
|
270 oct_mach_info::float_format& flt_fmt, bool quiet) |
|
604
|
271 { |
|
3552
|
272 const int magic_len = 10; |
|
|
273 char magic[magic_len+1]; |
|
3557
|
274 is.read (X_CAST (char *, magic), magic_len); |
|
604
|
275 magic[magic_len] = '\0'; |
|
3688
|
276 |
|
604
|
277 if (strncmp (magic, "Octave-1-L", magic_len) == 0) |
|
2318
|
278 swap = oct_mach_info::words_big_endian (); |
|
604
|
279 else if (strncmp (magic, "Octave-1-B", magic_len) == 0) |
|
2318
|
280 swap = ! oct_mach_info::words_big_endian (); |
|
604
|
281 else |
|
|
282 { |
|
|
283 if (! quiet) |
|
|
284 error ("load: can't read binary file"); |
|
|
285 return -1; |
|
|
286 } |
|
|
287 |
|
|
288 char tmp = 0; |
|
3557
|
289 is.read (X_CAST (char *, &tmp), 1); |
|
604
|
290 |
|
2318
|
291 flt_fmt = mopt_digit_to_float_format (tmp); |
|
|
292 |
|
4574
|
293 if (flt_fmt == oct_mach_info::flt_fmt_unknown) |
|
604
|
294 { |
|
|
295 if (! quiet) |
|
|
296 error ("load: unrecognized binary format!"); |
|
3688
|
297 |
|
604
|
298 return -1; |
|
|
299 } |
|
|
300 |
|
|
301 return 0; |
|
|
302 } |
|
|
303 |
|
|
304 static load_save_format |
|
3523
|
305 get_file_format (const std::string& fname, const std::string& orig_fname) |
|
604
|
306 { |
|
|
307 load_save_format retval = LS_UNKNOWN; |
|
|
308 |
|
3687
|
309 #ifdef HAVE_HDF5 |
|
3688
|
310 // check this before we open the file |
|
3687
|
311 if (H5Fis_hdf5 (fname.c_str ()) > 0) |
|
|
312 return LS_HDF5; |
|
|
313 #endif /* HAVE_HDF5 */ |
|
|
314 |
|
3523
|
315 std::ifstream file (fname.c_str ()); |
|
604
|
316 |
|
|
317 if (! file) |
|
|
318 { |
|
1750
|
319 error ("load: couldn't open input file `%s'", orig_fname.c_str ()); |
|
604
|
320 return retval; |
|
|
321 } |
|
|
322 |
|
4574
|
323 oct_mach_info::float_format flt_fmt = oct_mach_info::flt_fmt_unknown; |
|
604
|
324 |
|
3019
|
325 bool swap = false; |
|
|
326 |
|
|
327 if (read_binary_file_header (file, swap, flt_fmt, true) == 0) |
|
604
|
328 retval = LS_BINARY; |
|
|
329 else |
|
|
330 { |
|
3538
|
331 file.seekg (0, std::ios::beg); |
|
604
|
332 |
|
|
333 FOUR_BYTE_INT mopt, nr, nc, imag, len; |
|
1180
|
334 |
|
|
335 int err = read_mat_file_header (file, swap, mopt, nr, nc, imag, len, 1); |
|
|
336 |
|
|
337 if (! err) |
|
604
|
338 retval = LS_MAT_BINARY; |
|
|
339 else |
|
|
340 { |
|
2511
|
341 file.clear (); |
|
3538
|
342 file.seekg (0, std::ios::beg); |
|
604
|
343 |
|
3697
|
344 err = read_mat5_binary_file_header (file, swap, true); |
|
3688
|
345 |
|
|
346 if (! err) |
|
|
347 { |
|
|
348 file.clear (); |
|
|
349 file.seekg (0, std::ios::beg); |
|
|
350 retval = LS_MAT5_BINARY; |
|
|
351 } |
|
|
352 else |
|
|
353 { |
|
|
354 file.clear (); |
|
|
355 file.seekg (0, std::ios::beg); |
|
|
356 |
|
4171
|
357 std::string tmp = extract_keyword (file, "name"); |
|
|
358 |
|
|
359 if (! tmp.empty ()) |
|
|
360 retval = LS_ASCII; |
|
3688
|
361 else |
|
|
362 { |
|
|
363 // Try reading the file as numbers only, determining the |
|
|
364 // number of rows and columns from the data. We don't |
|
|
365 // even bother to check to see if the first item in the |
|
|
366 // file is a number, so that get_complete_line() can |
|
|
367 // skip any comments that might appear at the top of the |
|
|
368 // file. |
|
|
369 |
|
|
370 retval = LS_MAT_ASCII; |
|
|
371 } |
|
2511
|
372 } |
|
604
|
373 } |
|
|
374 } |
|
|
375 |
|
|
376 file.close (); |
|
|
377 |
|
|
378 if (retval == LS_UNKNOWN) |
|
1750
|
379 error ("load: unable to determine file format for `%s'", |
|
|
380 orig_fname.c_str ()); |
|
604
|
381 |
|
|
382 return retval; |
|
|
383 } |
|
|
384 |
|
4329
|
385 octave_value |
|
3523
|
386 do_load (std::istream& stream, const std::string& orig_fname, bool force, |
|
2318
|
387 load_save_format format, oct_mach_info::float_format flt_fmt, |
|
4687
|
388 bool list_only, bool swap, bool verbose, |
|
3687
|
389 const string_vector& argv, int argv_idx, int argc, int nargout) |
|
604
|
390 { |
|
3727
|
391 octave_value retval; |
|
|
392 |
|
|
393 Octave_map retstruct; |
|
604
|
394 |
|
4051
|
395 OSSTREAM output_buf; |
|
|
396 |
|
604
|
397 int count = 0; |
|
4051
|
398 |
|
604
|
399 for (;;) |
|
|
400 { |
|
3019
|
401 bool global = false; |
|
2086
|
402 octave_value tc; |
|
604
|
403 |
|
4171
|
404 std::string name; |
|
|
405 std::string doc; |
|
604
|
406 |
|
|
407 switch (format) |
|
|
408 { |
|
|
409 case LS_ASCII: |
|
3136
|
410 name = read_ascii_data (stream, orig_fname, global, tc, count); |
|
604
|
411 break; |
|
|
412 |
|
|
413 case LS_BINARY: |
|
|
414 name = read_binary_data (stream, swap, flt_fmt, orig_fname, |
|
|
415 global, tc, doc); |
|
|
416 break; |
|
|
417 |
|
2511
|
418 case LS_MAT_ASCII: |
|
|
419 name = read_mat_ascii_data (stream, orig_fname, tc); |
|
|
420 break; |
|
|
421 |
|
604
|
422 case LS_MAT_BINARY: |
|
|
423 name = read_mat_binary_data (stream, orig_fname, tc); |
|
|
424 break; |
|
|
425 |
|
3687
|
426 #ifdef HAVE_HDF5 |
|
|
427 case LS_HDF5: |
|
4687
|
428 name = read_hdf5_data (stream, orig_fname, global, tc, doc); |
|
3687
|
429 break; |
|
|
430 #endif /* HAVE_HDF5 */ |
|
|
431 |
|
3688
|
432 case LS_MAT5_BINARY: |
|
|
433 name = read_mat5_binary_element (stream, orig_fname, swap, |
|
|
434 global, tc); |
|
|
435 break; |
|
|
436 |
|
604
|
437 default: |
|
775
|
438 gripe_unrecognized_data_fmt ("load"); |
|
604
|
439 break; |
|
|
440 } |
|
|
441 |
|
4171
|
442 if (error_state || stream.eof () || name.empty ()) |
|
|
443 break; |
|
|
444 else if (! error_state && ! name.empty ()) |
|
604
|
445 { |
|
|
446 if (tc.is_defined ()) |
|
|
447 { |
|
3136
|
448 if (format == LS_MAT_ASCII && argv_idx < argc) |
|
|
449 warning ("load: loaded ASCII file `%s' -- ignoring extra args", |
|
3687
|
450 orig_fname.c_str ()); |
|
3136
|
451 |
|
|
452 if (format == LS_MAT_ASCII |
|
|
453 || argv_idx == argc |
|
1755
|
454 || matches_patterns (argv, argv_idx, argc, name)) |
|
604
|
455 { |
|
|
456 count++; |
|
621
|
457 if (list_only) |
|
|
458 { |
|
|
459 if (verbose) |
|
|
460 { |
|
|
461 if (count == 1) |
|
|
462 output_buf |
|
|
463 << "type rows cols name\n" |
|
|
464 << "==== ==== ==== ====\n"; |
|
|
465 |
|
3013
|
466 output_buf |
|
3548
|
467 << std::setiosflags (std::ios::left) |
|
|
468 << std::setw (16) << tc.type_name () . c_str () |
|
|
469 << std::setiosflags (std::ios::right) |
|
|
470 << std::setw (7) << tc.rows () |
|
|
471 << std::setw (7) << tc.columns () |
|
3013
|
472 << " "; |
|
621
|
473 } |
|
|
474 output_buf << name << "\n"; |
|
|
475 } |
|
|
476 else |
|
|
477 { |
|
3727
|
478 if (nargout == 1) |
|
|
479 { |
|
|
480 if (format == LS_MAT_ASCII) |
|
|
481 retval = tc; |
|
|
482 else |
|
4675
|
483 retstruct.assign (name, tc); |
|
3727
|
484 } |
|
|
485 else |
|
|
486 install_loaded_variable (force, name, tc, global, doc); |
|
621
|
487 } |
|
604
|
488 } |
|
2511
|
489 |
|
|
490 // Only attempt to read one item from a headless text file. |
|
|
491 |
|
|
492 if (format == LS_MAT_ASCII) |
|
|
493 break; |
|
604
|
494 } |
|
|
495 else |
|
4171
|
496 error ("load: unable to load variable `%s'", name.c_str ()); |
|
604
|
497 } |
|
|
498 else |
|
|
499 { |
|
|
500 if (count == 0) |
|
|
501 error ("load: are you sure `%s' is an Octave data file?", |
|
1755
|
502 orig_fname.c_str ()); |
|
604
|
503 |
|
|
504 break; |
|
|
505 } |
|
|
506 } |
|
|
507 |
|
621
|
508 if (list_only && count) |
|
|
509 { |
|
4051
|
510 output_buf << OSSTREAM_ENDS; |
|
|
511 std::string msg = OSSTREAM_STR (output_buf); |
|
|
512 OSSTREAM_FREEZE (output_buf); |
|
2095
|
513 |
|
621
|
514 if (nargout > 0) |
|
2095
|
515 retval = msg; |
|
621
|
516 else |
|
2095
|
517 octave_stdout << msg; |
|
621
|
518 } |
|
3727
|
519 else if (! retstruct.empty ()) |
|
|
520 retval = retstruct; |
|
621
|
521 |
|
863
|
522 return retval; |
|
|
523 } |
|
|
524 |
|
3687
|
525 // HDF5 load/save documentation is included in the Octave manual |
|
|
526 // regardless, but if HDF5 is not linked in we also include a |
|
|
527 // sentence noting this, so the user understands that the features |
|
|
528 // aren't available. Define a macro for this sentence: |
|
|
529 |
|
|
530 #ifdef HAVE_HDF5 |
|
|
531 #define HAVE_HDF5_HELP_STRING "" |
|
|
532 #else /* ! HAVE_HDF5 */ |
|
|
533 #define HAVE_HDF5_HELP_STRING "\n\ |
|
|
534 HDF5 load and save are not available, as this Octave executable was\n\ |
|
|
535 not linked with the HDF5 library." |
|
|
536 #endif /* ! HAVE HDF5 */ |
|
|
537 |
|
4208
|
538 DEFCMD (load, args, nargout, |
|
3372
|
539 "-*- texinfo -*-\n\ |
|
|
540 @deffn {Command} load options file v1 v2 @dots{}\n\ |
|
|
541 Load the named variables from the file @var{file}. As with @code{save},\n\ |
|
|
542 you may specify a list of variables and @code{load} will only extract\n\ |
|
|
543 those variables with names that match. For example, to restore the\n\ |
|
|
544 variables saved in the file @file{data}, use the command\n\ |
|
|
545 \n\ |
|
|
546 @example\n\ |
|
|
547 load data\n\ |
|
|
548 @end example\n\ |
|
863
|
549 \n\ |
|
3372
|
550 If a variable that is not marked as global is loaded from a file when a\n\ |
|
|
551 global symbol with the same name already exists, it is loaded in the\n\ |
|
|
552 global symbol table. Also, if a variable is marked as global in a file\n\ |
|
|
553 and a local symbol exists, the local symbol is moved to the global\n\ |
|
|
554 symbol table and given the value from the file. Since it seems that\n\ |
|
|
555 both of these cases are likely to be the result of some sort of error,\n\ |
|
|
556 they will generate warnings.\n\ |
|
863
|
557 \n\ |
|
3727
|
558 If invoked with a single output argument, Octave returns data instead\n\ |
|
|
559 of inserting variables in the symbol table. If the data file contains\n\ |
|
|
560 only numbers (TAB- or space-delimited columns), a matrix of values is\n\ |
|
|
561 returned. Otherwise, @code{load} returns a structure with members\n\ |
|
|
562 corresponding to the names of the variables in the file.\n\ |
|
|
563 \n\ |
|
3372
|
564 The @code{load} command can read data stored in Octave's text and\n\ |
|
|
565 binary formats, and @sc{Matlab}'s binary format. It will automatically\n\ |
|
|
566 detect the type of file and do conversion from different floating point\n\ |
|
|
567 formats (currently only IEEE big and little endian, though other formats\n\ |
|
|
568 may added in the future).\n\ |
|
|
569 \n\ |
|
|
570 Valid options for @code{load} are listed in the following table.\n\ |
|
863
|
571 \n\ |
|
3372
|
572 @table @code\n\ |
|
|
573 @item -force\n\ |
|
4884
|
574 The @samp{-force} option is accepted but ignored for backward\n\ |
|
|
575 compatiability. Octave now overwrites variables currently in memeory with\n\ |
|
|
576 the same name as those found in the file.\n\ |
|
3372
|
577 \n\ |
|
|
578 @item -ascii\n\ |
|
|
579 Force Octave to assume the file is in Octave's text format.\n\ |
|
|
580 \n\ |
|
|
581 @item -binary\n\ |
|
|
582 Force Octave to assume the file is in Octave's binary format.\n\ |
|
|
583 \n\ |
|
4884
|
584 @item -mat\n\ |
|
|
585 @itemx -mat-binary\n\ |
|
3372
|
586 Force Octave to assume the file is in @sc{Matlab}'s binary format.\n\ |
|
3687
|
587 \n\ |
|
3688
|
588 @item -mat4-binary\n\ |
|
|
589 Force Octave to assume the file is in the binary format written by\n\ |
|
|
590 @sc{Matlab} version 4.\n\ |
|
|
591 \n\ |
|
3687
|
592 @item -hdf5\n\ |
|
|
593 Force Octave to assume the file is in HDF5 format.\n\ |
|
|
594 (HDF5 is a free, portable binary format developed by the National\n\ |
|
|
595 Center for Supercomputing Applications at the University of Illinois.)\n\ |
|
|
596 Note that Octave can read HDF5 files not created by itself, but may\n\ |
|
4687
|
597 skip some datasets in formats that it cannot support.\n" |
|
3687
|
598 |
|
|
599 HAVE_HDF5_HELP_STRING |
|
|
600 |
|
|
601 "\n\ |
|
|
602 @item -import\n\ |
|
4884
|
603 The @samp{-import} is accepted but ignored for backward compatiability.\n\ |
|
|
604 Octave can now support multi-dimensional HDF data and automatically\n\ |
|
|
605 modifies variable names if they are invalid Octave identifiers.\n\ |
|
3687
|
606 \n\ |
|
3372
|
607 @end table\n\ |
|
|
608 @end deffn") |
|
863
|
609 { |
|
2086
|
610 octave_value_list retval; |
|
863
|
611 |
|
1755
|
612 int argc = args.length () + 1; |
|
|
613 |
|
1968
|
614 string_vector argv = args.make_argv ("load"); |
|
1755
|
615 |
|
|
616 if (error_state) |
|
|
617 return retval; |
|
863
|
618 |
|
1358
|
619 // It isn't necessary to have the default load format stored in a |
|
|
620 // user preference variable since we can determine the type of file |
|
|
621 // as we are reading. |
|
863
|
622 |
|
|
623 load_save_format format = LS_UNKNOWN; |
|
|
624 |
|
4691
|
625 bool force = true; |
|
3019
|
626 bool list_only = false; |
|
|
627 bool verbose = false; |
|
863
|
628 |
|
1755
|
629 int i; |
|
|
630 for (i = 1; i < argc; i++) |
|
863
|
631 { |
|
1755
|
632 if (argv[i] == "-force" || argv[i] == "-f") |
|
863
|
633 { |
|
4884
|
634 // Silently ignore this |
|
|
635 // warning ("load: -force ignored"); |
|
863
|
636 } |
|
1755
|
637 else if (argv[i] == "-list" || argv[i] == "-l") |
|
863
|
638 { |
|
3019
|
639 list_only = true; |
|
863
|
640 } |
|
1755
|
641 else if (argv[i] == "-verbose" || argv[i] == "-v") |
|
863
|
642 { |
|
3019
|
643 verbose = true; |
|
863
|
644 } |
|
1755
|
645 else if (argv[i] == "-ascii" || argv[i] == "-a") |
|
863
|
646 { |
|
|
647 format = LS_ASCII; |
|
|
648 } |
|
1755
|
649 else if (argv[i] == "-binary" || argv[i] == "-b") |
|
863
|
650 { |
|
|
651 format = LS_BINARY; |
|
|
652 } |
|
4884
|
653 else if (argv[i] == "-mat-binary" || argv[i] == "-mat" || argv[i] == "-m") |
|
863
|
654 { |
|
3688
|
655 format = LS_MAT5_BINARY; |
|
|
656 } |
|
3797
|
657 else if (argv[i] == "-mat4-binary" || argv[i] == "-4" || argv[i] == "-v4") |
|
3688
|
658 { |
|
863
|
659 format = LS_MAT_BINARY; |
|
|
660 } |
|
3687
|
661 else if (argv[i] == "-hdf5" || argv[i] == "-h") |
|
|
662 { |
|
|
663 #ifdef HAVE_HDF5 |
|
|
664 format = LS_HDF5; |
|
|
665 #else /* ! HAVE_HDF5 */ |
|
|
666 error ("load: octave executable was not linked with HDF5 library"); |
|
|
667 return retval; |
|
|
668 #endif /* ! HAVE_HDF5 */ |
|
|
669 } |
|
|
670 else if (argv[i] == "-import" || argv[i] == "-i") |
|
|
671 { |
|
4687
|
672 warning ("load: -import ignored"); |
|
3687
|
673 } |
|
863
|
674 else |
|
|
675 break; |
|
|
676 } |
|
|
677 |
|
1755
|
678 if (i == argc) |
|
863
|
679 { |
|
2057
|
680 print_usage ("load"); |
|
863
|
681 return retval; |
|
|
682 } |
|
|
683 |
|
3523
|
684 std::string orig_fname = argv[i]; |
|
863
|
685 |
|
4574
|
686 oct_mach_info::float_format flt_fmt = oct_mach_info::flt_fmt_unknown; |
|
863
|
687 |
|
3019
|
688 bool swap = false; |
|
863
|
689 |
|
1755
|
690 if (argv[i] == "-") |
|
863
|
691 { |
|
1755
|
692 i++; |
|
863
|
693 |
|
3687
|
694 #ifdef HAVE_HDF5 |
|
|
695 if (format == LS_HDF5) |
|
|
696 error ("load: cannot read HDF5 format from stdin"); |
|
|
697 else |
|
|
698 #endif /* HAVE_HDF5 */ |
|
863
|
699 if (format != LS_UNKNOWN) |
|
|
700 { |
|
1358
|
701 // XXX FIXME XXX -- if we have already seen EOF on a |
|
3531
|
702 // previous call, how do we fix up the state of std::cin so |
|
|
703 // that we can get additional input? I'm afraid that we |
|
|
704 // can't fix this using std::cin only. |
|
|
705 |
|
|
706 retval = do_load (std::cin, orig_fname, force, format, flt_fmt, |
|
4687
|
707 list_only, swap, verbose, argv, i, argc, |
|
863
|
708 nargout); |
|
|
709 } |
|
|
710 else |
|
|
711 error ("load: must specify file format if reading from stdin"); |
|
|
712 } |
|
|
713 else |
|
|
714 { |
|
3523
|
715 std::string fname = file_ops::tilde_expand (argv[i]); |
|
863
|
716 |
|
5089
|
717 // Check if file exists, if it doesn't then also check with a |
|
|
718 // .mat extension |
|
|
719 std::ifstream file_exist (fname.c_str ()); |
|
|
720 if (file_exist) |
|
|
721 file_exist.close (); |
|
|
722 else |
|
|
723 { |
|
|
724 fname.append (".mat"); |
|
|
725 std::ifstream file_mat_exist (fname.c_str ()); |
|
|
726 if (file_mat_exist) |
|
|
727 file_mat_exist.close (); |
|
|
728 else |
|
|
729 { |
|
|
730 error ("load: nonexistent file: `%s'", orig_fname.c_str ()); |
|
|
731 return retval; |
|
|
732 } |
|
|
733 } |
|
|
734 |
|
863
|
735 if (format == LS_UNKNOWN) |
|
|
736 format = get_file_format (fname, orig_fname); |
|
|
737 |
|
3687
|
738 #ifdef HAVE_HDF5 |
|
|
739 if (format == LS_HDF5) |
|
|
740 { |
|
|
741 i++; |
|
|
742 |
|
5089
|
743 hdf5_ifstream hdf5_file (fname.c_str ()); |
|
3687
|
744 |
|
5089
|
745 if (hdf5_file.file_id >= 0) |
|
|
746 { |
|
|
747 retval = do_load (hdf5_file, orig_fname, force, format, |
|
|
748 flt_fmt, list_only, swap, verbose, |
|
|
749 argv, i, argc, nargout); |
|
4844
|
750 |
|
5089
|
751 hdf5_file.close (); |
|
3687
|
752 } |
|
4845
|
753 else |
|
5089
|
754 error ("load: couldn't open input file `%s'", |
|
|
755 orig_fname.c_str ()); |
|
3687
|
756 } |
|
|
757 else |
|
|
758 #endif /* HAVE_HDF5 */ |
|
|
759 // don't insert any statements here; the "else" above has to |
|
|
760 // go with the "if" below!!!!! |
|
863
|
761 if (format != LS_UNKNOWN) |
|
|
762 { |
|
1755
|
763 i++; |
|
863
|
764 |
|
3775
|
765 std::ios::openmode mode = std::ios::in; |
|
4791
|
766 |
|
|
767 if (format == LS_BINARY |
|
|
768 #ifdef HAVE_HDF5 |
|
|
769 || format == LS_HDF5 |
|
|
770 #endif |
|
|
771 || format == LS_MAT_BINARY |
|
|
772 || format == LS_MAT5_BINARY) |
|
3552
|
773 mode |= std::ios::binary; |
|
863
|
774 |
|
3523
|
775 std::ifstream file (fname.c_str (), mode); |
|
863
|
776 |
|
|
777 if (file) |
|
|
778 { |
|
|
779 if (format == LS_BINARY) |
|
|
780 { |
|
|
781 if (read_binary_file_header (file, swap, flt_fmt) < 0) |
|
|
782 { |
|
|
783 file.close (); |
|
|
784 return retval; |
|
|
785 } |
|
|
786 } |
|
3688
|
787 else if (format == LS_MAT5_BINARY) |
|
|
788 { |
|
|
789 if (read_mat5_binary_file_header (file, swap, false) < 0) |
|
|
790 { |
|
|
791 file.close (); |
|
|
792 return retval; |
|
|
793 } |
|
|
794 } |
|
863
|
795 |
|
|
796 retval = do_load (file, orig_fname, force, format, |
|
4687
|
797 flt_fmt, list_only, swap, verbose, |
|
1755
|
798 argv, i, argc, nargout); |
|
863
|
799 file.close (); |
|
|
800 } |
|
|
801 else |
|
1755
|
802 error ("load: couldn't open input file `%s'", |
|
|
803 orig_fname.c_str ()); |
|
863
|
804 } |
|
|
805 } |
|
604
|
806 |
|
|
807 return retval; |
|
|
808 } |
|
|
809 |
|
3019
|
810 // Return TRUE if PATTERN has any special globbing chars in it. |
|
|
811 |
|
|
812 static bool |
|
3523
|
813 glob_pattern_p (const std::string& pattern) |
|
604
|
814 { |
|
|
815 int open = 0; |
|
|
816 |
|
1755
|
817 int len = pattern.length (); |
|
|
818 |
|
|
819 for (int i = 0; i < len; i++) |
|
604
|
820 { |
|
1755
|
821 char c = pattern[i]; |
|
|
822 |
|
604
|
823 switch (c) |
|
|
824 { |
|
|
825 case '?': |
|
|
826 case '*': |
|
3019
|
827 return true; |
|
604
|
828 |
|
|
829 case '[': // Only accept an open brace if there is a close |
|
|
830 open++; // brace to match it. Bracket expressions must be |
|
|
831 continue; // complete, according to Posix.2 |
|
|
832 |
|
|
833 case ']': |
|
|
834 if (open) |
|
3019
|
835 return true; |
|
604
|
836 continue; |
|
4402
|
837 |
|
604
|
838 case '\\': |
|
1755
|
839 if (i == len - 1) |
|
3019
|
840 return false; |
|
604
|
841 |
|
|
842 default: |
|
|
843 continue; |
|
|
844 } |
|
|
845 } |
|
|
846 |
|
3019
|
847 return false; |
|
604
|
848 } |
|
|
849 |
|
4791
|
850 static void |
|
|
851 do_save (std::ostream& os, const octave_value& tc, |
|
|
852 const std::string& name, const std::string& help, |
|
|
853 int global, load_save_format fmt, bool save_as_floats, |
|
|
854 bool& infnan_warned) |
|
604
|
855 { |
|
|
856 switch (fmt) |
|
|
857 { |
|
|
858 case LS_ASCII: |
|
3738
|
859 save_ascii_data (os, tc, name, infnan_warned, false, global, 0); |
|
604
|
860 break; |
|
|
861 |
|
|
862 case LS_BINARY: |
|
630
|
863 save_binary_data (os, tc, name, help, global, save_as_floats); |
|
604
|
864 break; |
|
|
865 |
|
667
|
866 case LS_MAT_BINARY: |
|
|
867 save_mat_binary_data (os, tc, name); |
|
|
868 break; |
|
|
869 |
|
3687
|
870 #ifdef HAVE_HDF5 |
|
|
871 case LS_HDF5: |
|
|
872 save_hdf5_data (os, tc, name, help, global, save_as_floats); |
|
|
873 break; |
|
|
874 #endif /* HAVE_HDF5 */ |
|
|
875 |
|
3688
|
876 case LS_MAT5_BINARY: |
|
|
877 save_mat5_binary_element (os, tc, name, global, save_as_floats); |
|
|
878 break; |
|
|
879 |
|
604
|
880 default: |
|
775
|
881 gripe_unrecognized_data_fmt ("save"); |
|
604
|
882 break; |
|
|
883 } |
|
|
884 } |
|
|
885 |
|
4791
|
886 // Save the info from SR on stream OS in the format specified by FMT. |
|
|
887 |
|
|
888 void |
|
|
889 do_save (std::ostream& os, symbol_record *sr, load_save_format fmt, |
|
|
890 bool save_as_floats, bool& infnan_warned) |
|
|
891 { |
|
|
892 if (! sr->is_variable ()) |
|
|
893 { |
|
|
894 error ("save: can only save variables, not functions"); |
|
|
895 return; |
|
|
896 } |
|
|
897 |
|
|
898 octave_value tc = sr->def (); |
|
|
899 |
|
|
900 if (tc.is_defined ()) |
|
|
901 { |
|
|
902 std::string name = sr->name (); |
|
|
903 std::string help = sr->help (); |
|
|
904 |
|
|
905 int global = sr->is_linked_to_global (); |
|
|
906 |
|
|
907 do_save (os, tc, name, help, global, fmt, save_as_floats, |
|
|
908 infnan_warned); |
|
|
909 } |
|
|
910 } |
|
|
911 |
|
604
|
912 // Save variables with names matching PATTERN on stream OS in the |
|
3019
|
913 // format specified by FMT. If SAVE_BUILTINS is TRUE, also save |
|
604
|
914 // builtin variables with names that match PATTERN. |
|
|
915 |
|
|
916 static int |
|
3523
|
917 save_vars (std::ostream& os, const std::string& pattern, bool save_builtins, |
|
4791
|
918 load_save_format fmt, bool save_as_floats) |
|
604
|
919 { |
|
3355
|
920 Array<symbol_record *> vars = curr_sym_tab->glob |
|
|
921 (pattern, symbol_record::USER_VARIABLE, SYMTAB_ALL_SCOPES); |
|
|
922 |
|
|
923 int saved = vars.length (); |
|
|
924 |
|
3738
|
925 bool infnan_warned = false; |
|
|
926 |
|
3355
|
927 for (int i = 0; i < saved; i++) |
|
620
|
928 { |
|
4791
|
929 do_save (os, vars(i), fmt, save_as_floats, infnan_warned); |
|
620
|
930 |
|
|
931 if (error_state) |
|
|
932 break; |
|
|
933 } |
|
604
|
934 |
|
620
|
935 if (! error_state && save_builtins) |
|
604
|
936 { |
|
4009
|
937 vars = fbi_sym_tab->glob |
|
3355
|
938 (pattern, symbol_record::BUILTIN_VARIABLE, SYMTAB_ALL_SCOPES); |
|
|
939 |
|
|
940 int count = vars.length (); |
|
604
|
941 |
|
|
942 saved += count; |
|
|
943 |
|
3355
|
944 for (int i = 0; i < count; i++) |
|
620
|
945 { |
|
4791
|
946 do_save (os, vars(i), fmt, save_as_floats, infnan_warned); |
|
620
|
947 |
|
|
948 if (error_state) |
|
|
949 break; |
|
|
950 } |
|
604
|
951 } |
|
|
952 |
|
|
953 return saved; |
|
|
954 } |
|
|
955 |
|
|
956 static load_save_format |
|
4788
|
957 get_save_format (const std::string& fmt, |
|
|
958 load_save_format fallback_format = LS_ASCII) |
|
604
|
959 { |
|
4788
|
960 load_save_format retval = fallback_format; |
|
1755
|
961 |
|
|
962 if (fmt == "binary") |
|
604
|
963 retval = LS_BINARY; |
|
1755
|
964 else if (fmt == "mat-binary" || fmt =="mat_binary") |
|
3688
|
965 retval = LS_MAT5_BINARY; |
|
|
966 else if (fmt == "mat4-binary" || fmt =="mat4_binary") |
|
911
|
967 retval = LS_MAT_BINARY; |
|
3687
|
968 #ifdef HAVE_HDF5 |
|
|
969 else if (fmt == "hdf5") |
|
|
970 retval = LS_HDF5; |
|
|
971 #endif /* HAVE_HDF5 */ |
|
604
|
972 |
|
|
973 return retval; |
|
|
974 } |
|
|
975 |
|
4329
|
976 void |
|
3523
|
977 write_header (std::ostream& os, load_save_format format) |
|
863
|
978 { |
|
3185
|
979 switch (format) |
|
863
|
980 { |
|
3185
|
981 case LS_BINARY: |
|
|
982 { |
|
|
983 os << (oct_mach_info::words_big_endian () |
|
|
984 ? "Octave-1-B" : "Octave-1-L"); |
|
|
985 |
|
|
986 oct_mach_info::float_format flt_fmt = |
|
|
987 oct_mach_info::native_float_format (); |
|
|
988 |
|
|
989 char tmp = (char) float_format_to_mopt_digit (flt_fmt); |
|
|
990 |
|
3557
|
991 os.write (X_CAST (char *, &tmp), 1); |
|
3185
|
992 } |
|
3688
|
993 break; |
|
|
994 |
|
|
995 case LS_MAT5_BINARY: |
|
|
996 { |
|
3775
|
997 char const * versionmagic; |
|
3688
|
998 TWO_BYTE_INT number = *(TWO_BYTE_INT *)"\x00\x01"; |
|
|
999 struct tm bdt; |
|
|
1000 time_t now; |
|
|
1001 char headertext[128]; |
|
|
1002 |
|
|
1003 time (&now); |
|
|
1004 bdt = *gmtime (&now); |
|
|
1005 memset (headertext, ' ', 124); |
|
|
1006 // ISO 8601 format date |
|
|
1007 strftime (headertext, 124, "MATLAB 5.0 MAT-file, written by Octave " |
|
|
1008 OCTAVE_VERSION ", %Y-%m-%d %T UTC", &bdt); |
|
|
1009 |
|
|
1010 // The first pair of bytes give the version of the MAT file |
|
|
1011 // format. The second pair of bytes form a magic number which |
|
|
1012 // signals a MAT file. MAT file data are always written in |
|
|
1013 // native byte order. The order of the bytes in the second |
|
|
1014 // pair indicates whether the file was written by a big- or |
|
|
1015 // little-endian machine. However, the version number is |
|
|
1016 // written in the *opposite* byte order from everything else! |
|
|
1017 if (number == 1) |
|
|
1018 versionmagic = "\x01\x00\x4d\x49"; // this machine is big endian |
|
|
1019 else |
|
|
1020 versionmagic = "\x00\x01\x49\x4d"; // this machine is little endian |
|
|
1021 |
|
|
1022 memcpy (headertext+124, versionmagic, 4); |
|
|
1023 os.write (headertext, 128); |
|
|
1024 } |
|
|
1025 |
|
|
1026 break; |
|
3185
|
1027 |
|
3687
|
1028 #ifdef HAVE_HDF5 |
|
|
1029 case LS_HDF5: |
|
|
1030 #endif /* HAVE_HDF5 */ |
|
3185
|
1031 case LS_ASCII: |
|
|
1032 { |
|
3709
|
1033 octave_localtime now; |
|
|
1034 |
|
|
1035 std::string comment_string = now.strftime (Vsave_header_format_string); |
|
|
1036 |
|
|
1037 if (! comment_string.empty ()) |
|
|
1038 { |
|
3687
|
1039 #ifdef HAVE_HDF5 |
|
3709
|
1040 if (format == LS_HDF5) |
|
|
1041 { |
|
|
1042 hdf5_ofstream& hs = (hdf5_ofstream&) os; |
|
|
1043 H5Gset_comment (hs.file_id, "/", comment_string.c_str ()); |
|
|
1044 } |
|
|
1045 else |
|
3687
|
1046 #endif /* HAVE_HDF5 */ |
|
3709
|
1047 os << comment_string << "\n"; |
|
3687
|
1048 } |
|
3185
|
1049 } |
|
|
1050 break; |
|
|
1051 |
|
|
1052 default: |
|
|
1053 break; |
|
863
|
1054 } |
|
|
1055 } |
|
|
1056 |
|
|
1057 static void |
|
3769
|
1058 save_vars (const string_vector& argv, int argv_idx, int argc, |
|
3523
|
1059 std::ostream& os, bool save_builtins, load_save_format fmt, |
|
3185
|
1060 bool save_as_floats, bool write_header_info) |
|
863
|
1061 { |
|
3185
|
1062 if (write_header_info) |
|
|
1063 write_header (os, fmt); |
|
863
|
1064 |
|
1755
|
1065 if (argv_idx == argc) |
|
863
|
1066 { |
|
|
1067 save_vars (os, "*", save_builtins, fmt, save_as_floats); |
|
|
1068 } |
|
|
1069 else |
|
|
1070 { |
|
1755
|
1071 for (int i = argv_idx; i < argc; i++) |
|
863
|
1072 { |
|
1755
|
1073 if (! save_vars (os, argv[i], save_builtins, fmt, save_as_floats)) |
|
863
|
1074 { |
|
1755
|
1075 warning ("save: no such variable `%s'", argv[i].c_str ()); |
|
863
|
1076 } |
|
|
1077 } |
|
|
1078 } |
|
|
1079 } |
|
|
1080 |
|
1380
|
1081 void |
|
4791
|
1082 dump_octave_core (std::ostream& os, const char *fname, load_save_format fmt) |
|
|
1083 { |
|
|
1084 write_header (os, fmt); |
|
|
1085 |
|
|
1086 Array<symbol_record *> vars = curr_sym_tab->glob |
|
|
1087 ("*", symbol_record::USER_VARIABLE, SYMTAB_ALL_SCOPES); |
|
|
1088 |
|
|
1089 int num_to_save = vars.length (); |
|
|
1090 |
|
|
1091 bool infnan_warned = false; |
|
|
1092 |
|
|
1093 double save_mem_size = 0; |
|
|
1094 |
|
|
1095 for (int i = 0; i < num_to_save; i++) |
|
|
1096 { |
|
|
1097 symbol_record *sr = vars(i); |
|
|
1098 |
|
|
1099 if (sr->is_variable ()) |
|
|
1100 { |
|
|
1101 octave_value tc = sr->def (); |
|
|
1102 |
|
|
1103 if (tc.is_defined ()) |
|
|
1104 { |
|
|
1105 double tc_size = tc.byte_size () / 1024; |
|
|
1106 |
|
|
1107 // XXX FIXME XXX -- maybe we should try to throw out hte |
|
|
1108 // largest first... |
|
|
1109 |
|
|
1110 if (Voctave_core_file_limit < 0 |
|
|
1111 || save_mem_size + tc_size < Voctave_core_file_limit) |
|
|
1112 { |
|
|
1113 save_mem_size += tc_size; |
|
|
1114 |
|
|
1115 std::string name = sr->name (); |
|
|
1116 std::string help = sr->help (); |
|
|
1117 |
|
|
1118 int global = sr->is_linked_to_global (); |
|
|
1119 |
|
|
1120 do_save (os, tc, name, help, global, fmt, false, |
|
|
1121 infnan_warned); |
|
|
1122 |
|
|
1123 if (error_state) |
|
|
1124 break; |
|
|
1125 } |
|
|
1126 } |
|
|
1127 } |
|
|
1128 } |
|
|
1129 |
|
|
1130 message (0, "save to `%s' complete", fname); |
|
|
1131 } |
|
|
1132 |
|
|
1133 void |
|
|
1134 dump_octave_core (void) |
|
1380
|
1135 { |
|
3189
|
1136 if (Vcrash_dumps_octave_core) |
|
1380
|
1137 { |
|
3189
|
1138 // XXX FIXME XXX -- should choose better file name? |
|
|
1139 |
|
4791
|
1140 const char *fname = Voctave_core_file_name.c_str (); |
|
3189
|
1141 |
|
|
1142 message (0, "attempting to save variables to `%s'...", fname); |
|
|
1143 |
|
4788
|
1144 load_save_format format |
|
4791
|
1145 = get_save_format (Voctave_core_file_format, LS_BINARY); |
|
3189
|
1146 |
|
3775
|
1147 std::ios::openmode mode = std::ios::out|std::ios::trunc; |
|
4791
|
1148 |
|
|
1149 if (format == LS_BINARY |
|
|
1150 #ifdef HAVE_HDF5 |
|
|
1151 || format == LS_HDF5 |
|
|
1152 #endif |
|
|
1153 || format == LS_MAT_BINARY |
|
|
1154 || format == LS_MAT5_BINARY) |
|
3552
|
1155 mode |= std::ios::binary; |
|
3189
|
1156 |
|
3687
|
1157 #ifdef HAVE_HDF5 |
|
|
1158 if (format == LS_HDF5) |
|
3189
|
1159 { |
|
3687
|
1160 hdf5_ofstream file (fname); |
|
|
1161 |
|
|
1162 if (file.file_id >= 0) |
|
|
1163 { |
|
4791
|
1164 dump_octave_core (file, fname, format); |
|
3687
|
1165 |
|
|
1166 file.close (); |
|
|
1167 } |
|
|
1168 else |
|
|
1169 warning ("unable to open `%s' for writing...", fname); |
|
3189
|
1170 } |
|
|
1171 else |
|
3687
|
1172 #endif /* HAVE_HDF5 */ |
|
|
1173 // don't insert any commands here! The open brace below must |
|
|
1174 // go with the else above! |
|
|
1175 { |
|
|
1176 std::ofstream file (fname, mode); |
|
|
1177 |
|
|
1178 if (file) |
|
|
1179 { |
|
4791
|
1180 dump_octave_core (file, fname, format); |
|
|
1181 |
|
3687
|
1182 file.close (); |
|
|
1183 } |
|
|
1184 else |
|
|
1185 warning ("unable to open `%s' for writing...", fname); |
|
|
1186 } |
|
1380
|
1187 } |
|
|
1188 } |
|
|
1189 |
|
4208
|
1190 DEFCMD (save, args, , |
|
3372
|
1191 "-*- texinfo -*-\n\ |
|
|
1192 @deffn {Command} save options file v1 v2 @dots{}\n\ |
|
|
1193 Save the named variables @var{v1}, @var{v2}, @dots{} in the file\n\ |
|
|
1194 @var{file}. The special filename @samp{-} can be used to write the\n\ |
|
|
1195 output to your terminal. If no variable names are listed, Octave saves\n\ |
|
|
1196 all the variables in the current scope. Valid options for the\n\ |
|
|
1197 @code{save} command are listed in the following table. Options that\n\ |
|
|
1198 modify the output format override the format specified by the built-in\n\ |
|
|
1199 variable @code{default_save_format}.\n\ |
|
|
1200 \n\ |
|
|
1201 @table @code\n\ |
|
|
1202 @item -ascii\n\ |
|
|
1203 Save the data in Octave's text data format.\n\ |
|
|
1204 \n\ |
|
|
1205 @item -binary\n\ |
|
|
1206 Save the data in Octave's binary data format.\n\ |
|
|
1207 \n\ |
|
|
1208 @item -float-binary\n\ |
|
|
1209 Save the data in Octave's binary data format but only using single\n\ |
|
|
1210 precision. You should use this format only if you know that all the\n\ |
|
|
1211 values to be saved can be represented in single precision.\n\ |
|
|
1212 \n\ |
|
4884
|
1213 @item -mat\n\ |
|
|
1214 @itemx -mat-binary\n\ |
|
3372
|
1215 Save the data in @sc{Matlab}'s binary data format.\n\ |
|
|
1216 \n\ |
|
3688
|
1217 @item -mat4-binary\n\ |
|
|
1218 Save the data in the binary format written by @sc{Matlab} version 4.\n\ |
|
|
1219 \n\ |
|
3687
|
1220 @item -hdf5\n\ |
|
|
1221 Save the data in HDF5 format.\n\ |
|
|
1222 (HDF5 is a free, portable binary format developed by the National\n\ |
|
|
1223 Center for Supercomputing Applications at the University of Illinois.)\n" |
|
|
1224 |
|
|
1225 HAVE_HDF5_HELP_STRING |
|
|
1226 |
|
|
1227 "\n\ |
|
|
1228 @item -float-hdf5\n\ |
|
|
1229 Save the data in HDF5 format but only using single precision.\n\ |
|
|
1230 You should use this format only if you know that all the\n\ |
|
|
1231 values to be saved can be represented in single precision.\n\ |
|
|
1232 \n\ |
|
3372
|
1233 @item -save-builtins\n\ |
|
|
1234 Force Octave to save the values of built-in variables too. By default,\n\ |
|
|
1235 Octave does not save built-in variables.\n\ |
|
|
1236 @end table\n\ |
|
604
|
1237 \n\ |
|
3372
|
1238 The list of variables to save may include wildcard patterns containing\n\ |
|
|
1239 the following special characters:\n\ |
|
|
1240 @table @code\n\ |
|
|
1241 @item ?\n\ |
|
|
1242 Match any single character.\n\ |
|
|
1243 \n\ |
|
|
1244 @item *\n\ |
|
|
1245 Match zero or more characters.\n\ |
|
|
1246 \n\ |
|
|
1247 @item [ @var{list} ]\n\ |
|
|
1248 Match the list of characters specified by @var{list}. If the first\n\ |
|
|
1249 character is @code{!} or @code{^}, match all characters except those\n\ |
|
|
1250 specified by @var{list}. For example, the pattern @samp{[a-zA-Z]} will\n\ |
|
|
1251 match all lower and upper case alphabetic characters. \n\ |
|
|
1252 @end table\n\ |
|
|
1253 \n\ |
|
|
1254 Except when using the @sc{Matlab} binary data file format, saving global\n\ |
|
|
1255 variables also saves the global status of the variable, so that if it is\n\ |
|
|
1256 restored at a later time using @samp{load}, it will be restored as a\n\ |
|
|
1257 global variable.\n\ |
|
|
1258 \n\ |
|
|
1259 The command\n\ |
|
|
1260 \n\ |
|
|
1261 @example\n\ |
|
|
1262 save -binary data a b*\n\ |
|
|
1263 @end example\n\ |
|
|
1264 \n\ |
|
|
1265 @noindent\n\ |
|
|
1266 saves the variable @samp{a} and all variables beginning with @samp{b} to\n\ |
|
|
1267 the file @file{data} in Octave's binary format.\n\ |
|
|
1268 @end deffn") |
|
604
|
1269 { |
|
2086
|
1270 octave_value_list retval; |
|
604
|
1271 |
|
1755
|
1272 int argc = args.length () + 1; |
|
|
1273 |
|
1968
|
1274 string_vector argv = args.make_argv ("save"); |
|
1755
|
1275 |
|
|
1276 if (error_state) |
|
|
1277 return retval; |
|
604
|
1278 |
|
1358
|
1279 // Here is where we would get the default save format if it were |
|
|
1280 // stored in a user preference variable. |
|
604
|
1281 |
|
3019
|
1282 bool save_builtins = false; |
|
|
1283 |
|
|
1284 bool save_as_floats = false; |
|
630
|
1285 |
|
4788
|
1286 load_save_format format = get_save_format (Vdefault_save_format); |
|
604
|
1287 |
|
3185
|
1288 bool append = false; |
|
|
1289 |
|
1755
|
1290 int i; |
|
|
1291 for (i = 1; i < argc; i++) |
|
604
|
1292 { |
|
3185
|
1293 if (argv[i] == "-append") |
|
|
1294 { |
|
|
1295 append = true; |
|
|
1296 } |
|
3465
|
1297 else if (argv[i] == "-ascii" || argv[i] == "-a") |
|
604
|
1298 { |
|
|
1299 format = LS_ASCII; |
|
|
1300 } |
|
1755
|
1301 else if (argv[i] == "-binary" || argv[i] == "-b") |
|
604
|
1302 { |
|
|
1303 format = LS_BINARY; |
|
|
1304 } |
|
3687
|
1305 else if (argv[i] == "-hdf5" || argv[i] == "-h") |
|
|
1306 { |
|
|
1307 #ifdef HAVE_HDF5 |
|
|
1308 format = LS_HDF5; |
|
|
1309 #else /* ! HAVE_HDF5 */ |
|
|
1310 error ("save: octave executable was not linked with HDF5 library"); |
|
|
1311 return retval; |
|
|
1312 #endif /* ! HAVE_HDF5 */ |
|
|
1313 } |
|
4884
|
1314 else if (argv[i] == "-mat-binary" || argv[i] == "-mat" || argv[i] == "-m") |
|
667
|
1315 { |
|
3688
|
1316 format = LS_MAT5_BINARY; |
|
|
1317 } |
|
3797
|
1318 else if (argv[i] == "-mat4-binary" || argv[i] == "-4" || argv[i] == "-v4") |
|
3688
|
1319 { |
|
667
|
1320 format = LS_MAT_BINARY; |
|
|
1321 } |
|
1755
|
1322 else if (argv[i] == "-float-binary" || argv[i] == "-f") |
|
630
|
1323 { |
|
|
1324 format = LS_BINARY; |
|
3019
|
1325 save_as_floats = true; |
|
630
|
1326 } |
|
3687
|
1327 else if (argv[i] == "-float-hdf5") |
|
|
1328 { |
|
|
1329 #ifdef HAVE_HDF5 |
|
|
1330 format = LS_HDF5; |
|
|
1331 save_as_floats = true; |
|
|
1332 #else /* ! HAVE_HDF5 */ |
|
|
1333 error ("save: octave executable was not linked with HDF5 library"); |
|
|
1334 return retval; |
|
|
1335 #endif /* ! HAVE_HDF5 */ |
|
|
1336 } |
|
1755
|
1337 else if (argv[i] == "-save-builtins") |
|
604
|
1338 { |
|
3019
|
1339 save_builtins = true; |
|
604
|
1340 } |
|
|
1341 else |
|
|
1342 break; |
|
|
1343 } |
|
|
1344 |
|
2057
|
1345 if (i == argc) |
|
604
|
1346 { |
|
|
1347 print_usage ("save"); |
|
|
1348 return retval; |
|
|
1349 } |
|
|
1350 |
|
630
|
1351 if (save_as_floats && format == LS_ASCII) |
|
|
1352 { |
|
|
1353 error ("save: cannot specify both -ascii and -float-binary"); |
|
|
1354 return retval; |
|
|
1355 } |
|
|
1356 |
|
1755
|
1357 if (argv[i] == "-") |
|
604
|
1358 { |
|
1755
|
1359 i++; |
|
863
|
1360 |
|
3687
|
1361 #ifdef HAVE_HDF5 |
|
|
1362 if (format == LS_HDF5) |
|
4687
|
1363 error ("save: cannot write HDF5 format to stdout"); |
|
3687
|
1364 else |
|
|
1365 #endif /* HAVE_HDF5 */ |
|
|
1366 // don't insert any commands here! the brace below must go |
|
|
1367 // with the "else" above! |
|
|
1368 { |
|
|
1369 // XXX FIXME XXX -- should things intended for the screen end up |
|
|
1370 // in a octave_value (string)? |
|
|
1371 |
|
|
1372 save_vars (argv, i, argc, octave_stdout, save_builtins, format, |
|
|
1373 save_as_floats, true); |
|
|
1374 } |
|
604
|
1375 } |
|
1755
|
1376 |
|
|
1377 // Guard against things like `save a*', which are probably mistakes... |
|
|
1378 |
|
|
1379 else if (i == argc - 1 && glob_pattern_p (argv[i])) |
|
|
1380 { |
|
|
1381 print_usage ("save"); |
|
604
|
1382 return retval; |
|
|
1383 } |
|
|
1384 else |
|
|
1385 { |
|
3523
|
1386 std::string fname = file_ops::tilde_expand (argv[i]); |
|
1755
|
1387 |
|
|
1388 i++; |
|
604
|
1389 |
|
3775
|
1390 std::ios::openmode mode = std::ios::out; |
|
4791
|
1391 |
|
|
1392 if (format == LS_BINARY |
|
|
1393 #ifdef HAVE_HDF5 |
|
|
1394 || format == LS_HDF5 |
|
|
1395 #endif |
|
|
1396 || format == LS_MAT_BINARY |
|
|
1397 || format == LS_MAT5_BINARY) |
|
3552
|
1398 mode |= std::ios::binary; |
|
3538
|
1399 |
|
|
1400 mode |= append ? std::ios::ate : std::ios::trunc; |
|
3185
|
1401 |
|
3687
|
1402 #ifdef HAVE_HDF5 |
|
|
1403 if (format == LS_HDF5) |
|
863
|
1404 { |
|
3687
|
1405 hdf5_ofstream hdf5_file (fname.c_str ()); |
|
|
1406 |
|
4687
|
1407 if (hdf5_file.file_id >= 0) |
|
|
1408 { |
|
|
1409 save_vars (argv, i, argc, hdf5_file, save_builtins, format, |
|
|
1410 save_as_floats, true); |
|
3687
|
1411 |
|
4687
|
1412 hdf5_file.close (); |
|
3687
|
1413 } |
|
|
1414 else |
|
|
1415 { |
|
|
1416 error ("save: couldn't open output file `%s'", fname.c_str ()); |
|
|
1417 return retval; |
|
|
1418 } |
|
863
|
1419 } |
|
|
1420 else |
|
3687
|
1421 #endif /* HAVE_HDF5 */ |
|
|
1422 // don't insert any statements here! The brace below must go |
|
|
1423 // with the "else" above! |
|
604
|
1424 { |
|
3687
|
1425 std::ofstream file (fname.c_str (), mode); |
|
|
1426 |
|
|
1427 if (file) |
|
|
1428 { |
|
|
1429 bool write_header_info |
|
3775
|
1430 = ((file.rdbuf ())->pubseekoff (0, std::ios::cur) |
|
3769
|
1431 == static_cast<std::streampos> (0)); |
|
3687
|
1432 |
|
|
1433 save_vars (argv, i, argc, file, save_builtins, format, |
|
|
1434 save_as_floats, write_header_info); |
|
|
1435 } |
|
|
1436 else |
|
|
1437 { |
|
|
1438 error ("save: couldn't open output file `%s'", fname.c_str ()); |
|
|
1439 return retval; |
|
|
1440 } |
|
604
|
1441 } |
|
|
1442 } |
|
|
1443 |
|
|
1444 return retval; |
|
|
1445 } |
|
|
1446 |
|
2194
|
1447 static int |
|
3189
|
1448 crash_dumps_octave_core (void) |
|
|
1449 { |
|
|
1450 Vcrash_dumps_octave_core = check_preference ("crash_dumps_octave_core"); |
|
4449
|
1451 |
|
3189
|
1452 return 0; |
|
|
1453 } |
|
|
1454 |
|
|
1455 static int |
|
2194
|
1456 default_save_format (void) |
|
|
1457 { |
|
|
1458 int status = 0; |
|
|
1459 |
|
3523
|
1460 std::string s = builtin_string_variable ("default_save_format"); |
|
2194
|
1461 |
|
|
1462 if (s.empty ()) |
|
|
1463 { |
|
|
1464 gripe_invalid_value_specified ("default_save_format"); |
|
|
1465 status = -1; |
|
|
1466 } |
|
|
1467 else |
|
|
1468 Vdefault_save_format = s; |
|
|
1469 |
|
|
1470 return status; |
|
|
1471 } |
|
|
1472 |
|
4788
|
1473 static int |
|
4791
|
1474 octave_core_file_limit (void) |
|
|
1475 { |
|
|
1476 double val; |
|
|
1477 |
|
|
1478 if (builtin_real_scalar_variable ("octave_core_file_limit", val)) |
|
|
1479 { |
|
|
1480 Voctave_core_file_limit = val; |
|
|
1481 return 0; |
|
|
1482 } |
|
|
1483 else |
|
|
1484 gripe_invalid_value_specified ("octave_core_file_limit"); |
|
|
1485 |
|
|
1486 return -1; |
|
|
1487 } |
|
|
1488 |
|
|
1489 static int |
|
|
1490 octave_core_file_name (void) |
|
4788
|
1491 { |
|
|
1492 int status = 0; |
|
|
1493 |
|
4791
|
1494 std::string s = builtin_string_variable ("octave_core_file_name"); |
|
4788
|
1495 |
|
|
1496 if (s.empty ()) |
|
|
1497 { |
|
4791
|
1498 gripe_invalid_value_specified ("octave_core_file_name"); |
|
4788
|
1499 status = -1; |
|
|
1500 } |
|
|
1501 else |
|
4791
|
1502 Voctave_core_file_name = s; |
|
|
1503 |
|
|
1504 return status; |
|
|
1505 } |
|
|
1506 |
|
|
1507 static int |
|
|
1508 octave_core_file_format (void) |
|
|
1509 { |
|
|
1510 int status = 0; |
|
|
1511 |
|
|
1512 std::string s = builtin_string_variable ("octave_core_file_format"); |
|
|
1513 |
|
|
1514 if (s.empty ()) |
|
|
1515 { |
|
|
1516 gripe_invalid_value_specified ("octave_core_file_format"); |
|
|
1517 status = -1; |
|
|
1518 } |
|
|
1519 else |
|
|
1520 Voctave_core_file_format = s; |
|
4788
|
1521 |
|
|
1522 return status; |
|
|
1523 } |
|
|
1524 |
|
3769
|
1525 static std::string |
|
3709
|
1526 default_save_header_format (void) |
|
|
1527 { |
|
|
1528 return |
|
4633
|
1529 std::string ("# Created by Octave " OCTAVE_VERSION |
|
|
1530 ", %a %b %d %H:%M:%S %Y %Z <") |
|
3709
|
1531 + octave_env::get_user_name () |
|
|
1532 + std::string ("@") |
|
|
1533 + octave_env::get_host_name () |
|
|
1534 + std::string (">"); |
|
|
1535 } |
|
|
1536 |
|
|
1537 static int |
|
|
1538 save_header_format_string (void) |
|
|
1539 { |
|
|
1540 int status = 0; |
|
|
1541 |
|
|
1542 octave_value v = builtin_any_variable ("save_header_format_string"); |
|
|
1543 |
|
|
1544 if (v.is_string ()) |
|
|
1545 Vsave_header_format_string = v.string_value (); |
|
|
1546 else |
|
|
1547 { |
|
|
1548 gripe_invalid_value_specified ("save_header_format_string"); |
|
|
1549 status = -1; |
|
|
1550 } |
|
|
1551 |
|
|
1552 return status; |
|
|
1553 } |
|
|
1554 |
|
2194
|
1555 void |
|
|
1556 symbols_of_load_save (void) |
|
|
1557 { |
|
4233
|
1558 DEFVAR (crash_dumps_octave_core, true, crash_dumps_octave_core, |
|
3372
|
1559 "-*- texinfo -*-\n\ |
|
|
1560 @defvr {Built-in Variable} crash_dumps_octave_core\n\ |
|
|
1561 If this variable is set to a nonzero value, Octave tries to save all\n\ |
|
|
1562 current variables the the file \"octave-core\" if it crashes or receives a\n\ |
|
|
1563 hangup, terminate or similar signal. The default value is 1.\n\ |
|
4791
|
1564 @seealso{octave_core_file_limit, octave_core_file_name, and octave_core_file_format}\n\ |
|
3372
|
1565 @end defvr"); |
|
3189
|
1566 |
|
3258
|
1567 DEFVAR (default_save_format, "ascii", default_save_format, |
|
3372
|
1568 "-*- texinfo -*-\n\ |
|
|
1569 @defvr {Built-in Variable} default_save_format\n\ |
|
|
1570 This variable specifies the default format for the @code{save} command.\n\ |
|
|
1571 It should have one of the following values: @code{\"ascii\"},\n\ |
|
|
1572 @code{\"binary\"}, @code{float-binary}, or @code{\"mat-binary\"}. The\n\ |
|
|
1573 initial default save format is Octave's text format.\n\ |
|
4791
|
1574 @end defvr"); |
|
|
1575 |
|
|
1576 DEFVAR (octave_core_file_limit, -1.0, octave_core_file_limit, |
|
|
1577 "-*- texinfo -*-\n\ |
|
|
1578 @defvr {Built-in Variable} octave_core_file_limit\n\ |
|
|
1579 The maximum amount of memory (in kilobytes) of the top-level workspace\n\ |
|
|
1580 that Octave will attempt to write when saving data to the\n\ |
|
|
1581 @var{octave_core_file_name}. If @var{octave_core_file_format} is a\n\ |
|
|
1582 binary format, then @var{octave_core_file_limit} will be approximately\n\ |
|
|
1583 the maximum size of the file. If a text file format is used, then the\n\ |
|
|
1584 file could be much larger than the limit.\n\ |
|
|
1585 The default value is -1 (unlimited)\n\ |
|
|
1586 @seealso{crash_dumps_octave_core, octave_core_file_name, and octave_core_file_format}\n\ |
|
4788
|
1587 @end defvr"); |
|
|
1588 |
|
4791
|
1589 DEFVAR (octave_core_file_name, "octave-core", octave_core_file_name, |
|
4788
|
1590 "-*- texinfo -*-\n\ |
|
4791
|
1591 @defvr {Built-in Variable} octave_core_file_name\n\ |
|
|
1592 The name of the file used for saving data from the top-level workspace\n\ |
|
|
1593 when Octave aborts. The default value is @code{\"octave-core\"}\n\ |
|
|
1594 @seealso{crash_dumps_octave_core, octave_core_file_name, and octave_core_file_format}\n\ |
|
|
1595 @end defvr"); |
|
|
1596 |
|
|
1597 DEFVAR (octave_core_file_format, "binary", octave_core_file_format, |
|
|
1598 "-*- texinfo -*-\n\ |
|
|
1599 @defvr {Built-in Variable} octave_core_file_format\n\ |
|
4788
|
1600 If Octave aborts, it attempts to save the contents of the top-level\n\ |
|
|
1601 workspace in a file using this format. The value of\n\ |
|
4791
|
1602 @code{octave_core_file_format} should have one of the following values:\n\ |
|
4788
|
1603 @code{\"ascii\"}, @code{\"binary\"}, @code{float-binary}, or\n\ |
|
|
1604 @code{\"mat-binary\"}. The default value is Octave's binary format.\n\ |
|
4791
|
1605 @seealso{crash_dumps_octave_core, octave_core_file_name, and octave_core_file_limit}\n\ |
|
3372
|
1606 @end defvr"); |
|
2194
|
1607 |
|
3709
|
1608 DEFVAR (save_header_format_string, default_save_header_format (), |
|
|
1609 save_header_format_string, |
|
|
1610 "-*- texinfo -*-\n\ |
|
|
1611 @defvr {Built-in Variable} save_header_format_string\n\ |
|
|
1612 This variable specifies the the format string for the comment line\n\ |
|
|
1613 that is written at the beginning of text-format data files saved by\n\ |
|
|
1614 Octave. The format string is passed to @code{strftime} and should\n\ |
|
|
1615 begin with the character @samp{#} and contain no newline characters.\n\ |
|
|
1616 If the value of @code{save_header_format_string} is the empty string,\n\ |
|
|
1617 the header comment is omitted from text-format data files. The\n\ |
|
|
1618 default value is\n\ |
|
|
1619 \n\ |
|
|
1620 @example\n\ |
|
4060
|
1621 \"# Created by Octave VERSION, %a %b %d %H:%M:%S %Y %Z <USER@@HOST>\"\n\ |
|
3709
|
1622 @end example\n\ |
|
|
1623 @seealso{strftime}\n\ |
|
|
1624 @end defvr"); |
|
2194
|
1625 } |
|
|
1626 |
|
604
|
1627 /* |
|
|
1628 ;;; Local Variables: *** |
|
|
1629 ;;; mode: C++ *** |
|
|
1630 ;;; End: *** |
|
|
1631 */ |
