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