|
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 |
|
3503
|
35 #include <iomanip> |
|
|
36 #include <iostream> |
|
|
37 #include <fstream> |
|
|
38 #include <strstream> |
|
1728
|
39 #include <string> |
|
|
40 |
|
3687
|
41 #ifdef HAVE_HDF5 |
|
|
42 #include <hdf5.h> |
|
|
43 #endif |
|
|
44 |
|
1961
|
45 #include "byte-swap.h" |
|
|
46 #include "data-conv.h" |
|
2926
|
47 #include "file-ops.h" |
|
|
48 #include "glob-match.h" |
|
2890
|
49 #include "lo-mappers.h" |
|
2318
|
50 #include "mach-info.h" |
|
3185
|
51 #include "oct-env.h" |
|
3258
|
52 #include "oct-time.h" |
|
1755
|
53 #include "str-vec.h" |
|
|
54 |
|
1352
|
55 #include "defun.h" |
|
604
|
56 #include "error.h" |
|
777
|
57 #include "gripes.h" |
|
1352
|
58 #include "load-save.h" |
|
1750
|
59 #include "oct-obj.h" |
|
3687
|
60 #include "oct-map.h" |
|
1352
|
61 #include "pager.h" |
|
1750
|
62 #include "pt-exp.h" |
|
1352
|
63 #include "symtab.h" |
|
|
64 #include "sysdep.h" |
|
|
65 #include "unwind-prot.h" |
|
604
|
66 #include "utils.h" |
|
2371
|
67 #include "variables.h" |
|
3185
|
68 #include "version.h" |
|
3688
|
69 #include "dMatrix.h" |
|
|
70 |
|
|
71 #define PAD(l) (((l)<=4)?4:(((l)+7)/8)*8) |
|
|
72 #define TAGLENGTH(l) ((l)<=4?4:8) |
|
|
73 |
|
3598
|
74 // Write octave-core file if Octave crashes or is killed by a signal. |
|
3189
|
75 static bool Vcrash_dumps_octave_core; |
|
|
76 |
|
3687
|
77 // The default output format. May be one of "binary", "text", |
|
|
78 // "mat-binary", or "hdf5". |
|
3523
|
79 static std::string Vdefault_save_format; |
|
2194
|
80 |
|
3709
|
81 // The format string for the comment line at the top of text-format |
|
|
82 // save files. Passed to strftime. Should begin with `#' and contain |
|
|
83 // no newline characters. |
|
|
84 static std::string Vsave_header_format_string; |
|
|
85 |
|
2194
|
86 // The number of decimal digits to use when writing ascii data. |
|
|
87 static int Vsave_precision; |
|
|
88 |
|
872
|
89 // Used when converting Inf to something that gnuplot can read. |
|
|
90 |
|
|
91 #ifndef OCT_RBV |
|
|
92 #define OCT_RBV DBL_MAX / 100.0 |
|
|
93 #endif |
|
|
94 |
|
604
|
95 enum load_save_format |
|
|
96 { |
|
|
97 LS_ASCII, |
|
|
98 LS_BINARY, |
|
2511
|
99 LS_MAT_ASCII, |
|
604
|
100 LS_MAT_BINARY, |
|
3688
|
101 LS_MAT5_BINARY, |
|
3687
|
102 #ifdef HAVE_HDF5 |
|
|
103 LS_HDF5, |
|
|
104 #endif /* HAVE_HDF5 */ |
|
3552
|
105 LS_UNKNOWN |
|
604
|
106 }; |
|
|
107 |
|
3688
|
108 enum arrayclasstype |
|
|
109 { |
|
|
110 mxCELL_CLASS=1, // cell array |
|
|
111 mxSTRUCT_CLASS, // structure |
|
|
112 mxOBJECT_CLASS, // object |
|
|
113 mxCHAR_CLASS, // character array |
|
|
114 mxSPARSE_CLASS, // sparse array |
|
|
115 mxDOUBLE_CLASS, // double precision array |
|
|
116 mxSINGLE_CLASS, // single precision floating point |
|
|
117 mxINT8_CLASS, // 8 bit signed integer |
|
|
118 mxUINT8_CLASS, // 8 bit unsigned integer |
|
|
119 mxINT16_CLASS, // 16 bit signed integer |
|
|
120 mxUINT16_CLASS, // 16 bit unsigned integer |
|
|
121 mxINT32_CLASS, // 32 bit signed integer |
|
|
122 mxUINT32_CLASS // 32 bit unsigned integer |
|
|
123 }; |
|
|
124 |
|
|
125 enum mat5_data_type |
|
|
126 { |
|
|
127 miINT8=1, // 8 bit signed |
|
|
128 miUINT8, // 8 bit unsigned |
|
|
129 miINT16, // 16 bit signed |
|
|
130 miUINT16, // 16 bit unsigned |
|
|
131 miINT32, // 32 bit signed |
|
|
132 miUINT32, // 32 bit unsigned |
|
|
133 miSINGLE, // IEEE 754 single precision float |
|
|
134 miRESERVE1, |
|
|
135 miDOUBLE, // IEEE 754 double precision float |
|
|
136 miRESERVE2, |
|
|
137 miRESERVE3, |
|
|
138 miINT64, // 64 bit signed |
|
|
139 miUINT64, // 64 bit unsigned |
|
|
140 miMATRIX // MATLAB array |
|
|
141 }; |
|
|
142 |
|
3019
|
143 // Return TRUE if S is a valid identifier. |
|
3005
|
144 |
|
|
145 static bool |
|
|
146 valid_identifier (const char *s) |
|
|
147 { |
|
|
148 if (! s || ! (isalnum (*s) || *s == '_')) |
|
|
149 return false; |
|
|
150 |
|
|
151 while (*++s != '\0') |
|
|
152 if (! (isalnum (*s) || *s == '_')) |
|
|
153 return false; |
|
|
154 |
|
|
155 return true; |
|
|
156 } |
|
|
157 |
|
|
158 static bool |
|
3523
|
159 valid_identifier (const std::string& s) |
|
3005
|
160 { |
|
|
161 return valid_identifier (s.c_str ()); |
|
|
162 } |
|
|
163 |
|
3687
|
164 #ifdef HAVE_HDF5 |
|
|
165 // this is only used for HDF5 import |
|
|
166 // try to convert s into a valid identifier, replacing invalid chars with "_": |
|
|
167 static void |
|
|
168 make_valid_identifier (char *s) |
|
|
169 { |
|
|
170 if (s) |
|
|
171 { |
|
|
172 for (; *s; ++s) |
|
|
173 if (! (isalnum (*s) || *s == '_')) |
|
|
174 *s = '_'; |
|
|
175 } |
|
|
176 } |
|
|
177 #endif /* HAVE_HDF5 */ |
|
|
178 |
|
630
|
179 // XXX FIXME XXX -- shouldn't this be implemented in terms of other |
|
|
180 // functions that are already available? |
|
604
|
181 |
|
|
182 // Install a variable with name NAME and the value specified TC in the |
|
3019
|
183 // symbol table. If FORCE is TRUE, replace any existing definition |
|
|
184 // for NAME. If GLOBAL is TRUE, make the variable global. |
|
604
|
185 // |
|
|
186 // Assumes TC is defined. |
|
|
187 |
|
|
188 static void |
|
2371
|
189 install_loaded_variable (int force, char *name, const octave_value& val, |
|
604
|
190 int global, char *doc) |
|
|
191 { |
|
1358
|
192 // Is there already a symbol by this name? If so, what is it? |
|
604
|
193 |
|
2856
|
194 symbol_record *lsr = curr_sym_tab->lookup (name); |
|
604
|
195 |
|
3019
|
196 bool is_undefined = true; |
|
|
197 bool is_variable = false; |
|
|
198 bool is_function = false; |
|
|
199 bool is_global = false; |
|
604
|
200 |
|
|
201 if (lsr) |
|
|
202 { |
|
|
203 is_undefined = ! lsr->is_defined (); |
|
|
204 is_variable = lsr->is_variable (); |
|
|
205 is_function = lsr->is_function (); |
|
|
206 is_global = lsr->is_linked_to_global (); |
|
|
207 } |
|
|
208 |
|
|
209 symbol_record *sr = 0; |
|
|
210 |
|
|
211 if (global) |
|
|
212 { |
|
|
213 if (is_global || is_undefined) |
|
|
214 { |
|
|
215 if (force || is_undefined) |
|
|
216 { |
|
2856
|
217 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
218 link_to_global_variable (lsr); |
|
|
219 sr = lsr; |
|
|
220 } |
|
|
221 else |
|
|
222 { |
|
|
223 warning ("load: global variable name `%s' exists.", name); |
|
|
224 warning ("use `load -force' to overwrite"); |
|
|
225 } |
|
|
226 } |
|
|
227 else if (is_function) |
|
|
228 { |
|
|
229 if (force) |
|
|
230 { |
|
2856
|
231 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
232 link_to_global_variable (lsr); |
|
|
233 sr = lsr; |
|
|
234 } |
|
|
235 else |
|
|
236 { |
|
|
237 warning ("load: `%s' is currently a function in this scope", name); |
|
|
238 warning ("`load -force' will load variable and hide function"); |
|
|
239 } |
|
|
240 } |
|
|
241 else if (is_variable) |
|
|
242 { |
|
|
243 if (force) |
|
|
244 { |
|
2856
|
245 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
246 link_to_global_variable (lsr); |
|
|
247 sr = lsr; |
|
|
248 } |
|
|
249 else |
|
|
250 { |
|
|
251 warning ("load: local variable name `%s' exists.", name); |
|
|
252 warning ("use `load -force' to overwrite"); |
|
|
253 } |
|
|
254 } |
|
|
255 else |
|
774
|
256 error ("load: unable to load data for unknown symbol type"); |
|
604
|
257 } |
|
|
258 else |
|
|
259 { |
|
|
260 if (is_global) |
|
|
261 { |
|
|
262 if (force || is_undefined) |
|
|
263 { |
|
2856
|
264 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
265 link_to_global_variable (lsr); |
|
|
266 sr = lsr; |
|
|
267 } |
|
|
268 else |
|
|
269 { |
|
|
270 warning ("load: global variable name `%s' exists.", name); |
|
|
271 warning ("use `load -force' to overwrite"); |
|
|
272 } |
|
|
273 } |
|
|
274 else if (is_function) |
|
|
275 { |
|
|
276 if (force) |
|
|
277 { |
|
2856
|
278 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
279 link_to_global_variable (lsr); |
|
|
280 sr = lsr; |
|
|
281 } |
|
|
282 else |
|
|
283 { |
|
|
284 warning ("load: `%s' is currently a function in this scope", name); |
|
|
285 warning ("`load -force' will load variable and hide function"); |
|
|
286 } |
|
|
287 } |
|
|
288 else if (is_variable || is_undefined) |
|
|
289 { |
|
|
290 if (force || is_undefined) |
|
|
291 { |
|
2856
|
292 lsr = curr_sym_tab->lookup (name, true); |
|
604
|
293 sr = lsr; |
|
|
294 } |
|
|
295 else |
|
|
296 { |
|
|
297 warning ("load: local variable name `%s' exists.", name); |
|
|
298 warning ("use `load -force' to overwrite"); |
|
|
299 } |
|
|
300 } |
|
|
301 else |
|
774
|
302 error ("load: unable to load data for unknown symbol type"); |
|
604
|
303 } |
|
|
304 |
|
|
305 if (sr) |
|
|
306 { |
|
2371
|
307 sr->define (val); |
|
604
|
308 if (doc) |
|
|
309 sr->document (doc); |
|
|
310 return; |
|
|
311 } |
|
|
312 else |
|
|
313 error ("load: unable to load variable `%s'", name); |
|
|
314 |
|
|
315 return; |
|
|
316 } |
|
|
317 |
|
|
318 // Functions for reading ascii data. |
|
|
319 |
|
|
320 // Skip white space and comments on stream IS. |
|
|
321 |
|
|
322 static void |
|
3523
|
323 skip_comments (std::istream& is) |
|
604
|
324 { |
|
|
325 char c = '\0'; |
|
|
326 while (is.get (c)) |
|
|
327 { |
|
|
328 if (c == ' ' || c == '\t' || c == '\n') |
|
|
329 ; // Skip whitespace on way to beginning of next line. |
|
|
330 else |
|
|
331 break; |
|
|
332 } |
|
|
333 |
|
|
334 for (;;) |
|
|
335 { |
|
3731
|
336 if (is && (c == '%' || c == '#')) |
|
604
|
337 while (is.get (c) && c != '\n') |
|
|
338 ; // Skip to beginning of next line, ignoring everything. |
|
|
339 else |
|
|
340 break; |
|
|
341 } |
|
|
342 } |
|
|
343 |
|
|
344 // Extract a KEYWORD and its value from stream IS, returning the |
|
|
345 // associated value in a new string. |
|
|
346 // |
|
|
347 // Input should look something like: |
|
|
348 // |
|
3731
|
349 // [%#][ \t]*keyword[ \t]*:[ \t]*string-value[ \t]*\n |
|
604
|
350 |
|
|
351 static char * |
|
3523
|
352 extract_keyword (std::istream& is, const char *keyword) |
|
604
|
353 { |
|
|
354 char *retval = 0; |
|
|
355 |
|
|
356 char c; |
|
|
357 while (is.get (c)) |
|
|
358 { |
|
3731
|
359 if (c == '%' || c == '#') |
|
604
|
360 { |
|
3523
|
361 std::ostrstream buf; |
|
2795
|
362 |
|
3731
|
363 while (is.get (c) && (c == ' ' || c == '\t' || c == '%' || c == '#')) |
|
604
|
364 ; // Skip whitespace and comment characters. |
|
|
365 |
|
|
366 if (isalpha (c)) |
|
|
367 buf << c; |
|
|
368 |
|
|
369 while (is.get (c) && isalpha (c)) |
|
|
370 buf << c; |
|
|
371 |
|
3538
|
372 buf << std::ends; |
|
604
|
373 char *tmp = buf.str (); |
|
|
374 int match = (strncmp (tmp, keyword, strlen (keyword)) == 0); |
|
|
375 delete [] tmp; |
|
|
376 |
|
|
377 if (match) |
|
|
378 { |
|
3523
|
379 std::ostrstream value; |
|
604
|
380 while (is.get (c) && (c == ' ' || c == '\t' || c == ':')) |
|
|
381 ; // Skip whitespace and the colon. |
|
|
382 |
|
|
383 if (c != '\n') |
|
|
384 { |
|
|
385 value << c; |
|
|
386 while (is.get (c) && c != '\n') |
|
|
387 value << c; |
|
|
388 } |
|
3538
|
389 value << std::ends; |
|
604
|
390 retval = value.str (); |
|
|
391 break; |
|
|
392 } |
|
|
393 } |
|
|
394 } |
|
918
|
395 |
|
|
396 if (retval) |
|
|
397 { |
|
|
398 int len = strlen (retval); |
|
|
399 if (len > 0) |
|
|
400 { |
|
|
401 char *ptr = retval + len - 1; |
|
|
402 while (*ptr == ' ' || *ptr == '\t') |
|
|
403 ptr--; |
|
3687
|
404 * (ptr+1) = '\0'; |
|
918
|
405 } |
|
|
406 } |
|
|
407 |
|
604
|
408 return retval; |
|
|
409 } |
|
|
410 |
|
|
411 // Match KEYWORD on stream IS, placing the associated value in VALUE, |
|
3019
|
412 // returning TRUE if successful and FALSE otherwise. |
|
604
|
413 // |
|
|
414 // Input should look something like: |
|
|
415 // |
|
3731
|
416 // [%#][ \t]*keyword[ \t]*int-value.*\n |
|
604
|
417 |
|
3019
|
418 static bool |
|
3523
|
419 extract_keyword (std::istream& is, const char *keyword, int& value) |
|
604
|
420 { |
|
3019
|
421 bool status = false; |
|
604
|
422 value = 0; |
|
|
423 |
|
|
424 char c; |
|
|
425 while (is.get (c)) |
|
|
426 { |
|
3731
|
427 if (c == '%' || c == '#') |
|
604
|
428 { |
|
3523
|
429 std::ostrstream buf; |
|
2795
|
430 |
|
3731
|
431 while (is.get (c) && (c == ' ' || c == '\t' || c == '%' || c == '#')) |
|
604
|
432 ; // Skip whitespace and comment characters. |
|
|
433 |
|
|
434 if (isalpha (c)) |
|
|
435 buf << c; |
|
|
436 |
|
|
437 while (is.get (c) && isalpha (c)) |
|
|
438 buf << c; |
|
|
439 |
|
3538
|
440 buf << std::ends; |
|
604
|
441 char *tmp = buf.str (); |
|
|
442 int match = (strncmp (tmp, keyword, strlen (keyword)) == 0); |
|
|
443 delete [] tmp; |
|
|
444 |
|
|
445 if (match) |
|
|
446 { |
|
|
447 while (is.get (c) && (c == ' ' || c == '\t' || c == ':')) |
|
|
448 ; // Skip whitespace and the colon. |
|
|
449 |
|
|
450 is.putback (c); |
|
|
451 if (c != '\n') |
|
|
452 is >> value; |
|
|
453 if (is) |
|
3019
|
454 status = true; |
|
604
|
455 while (is.get (c) && c != '\n') |
|
|
456 ; // Skip to beginning of next line; |
|
|
457 break; |
|
|
458 } |
|
|
459 } |
|
|
460 } |
|
|
461 return status; |
|
|
462 } |
|
|
463 |
|
|
464 // Extract one value (scalar, matrix, string, etc.) from stream IS and |
|
|
465 // place it in TC, returning the name of the variable. If the value |
|
3019
|
466 // is tagged as global in the file, return TRUE in GLOBAL. |
|
604
|
467 // |
|
|
468 // FILENAME is used for error messages. |
|
|
469 // |
|
|
470 // The data is expected to be in the following format: |
|
|
471 // |
|
|
472 // The input file must have a header followed by some data. |
|
|
473 // |
|
|
474 // All lines in the header must begin with a `#' character. |
|
|
475 // |
|
|
476 // The header must contain a list of keyword and value pairs with the |
|
|
477 // keyword and value separated by a colon. |
|
|
478 // |
|
|
479 // Keywords must appear in the following order: |
|
|
480 // |
|
|
481 // # name: <name> |
|
|
482 // # type: <type> |
|
|
483 // # <info> |
|
|
484 // |
|
|
485 // Where: |
|
|
486 // |
|
|
487 // <name> : a valid identifier |
|
|
488 // |
|
|
489 // <type> : <typename> |
|
|
490 // | global <typename> |
|
|
491 // |
|
|
492 // <typename> : scalar |
|
|
493 // | complex scalar |
|
|
494 // | matrix |
|
|
495 // | complex matrix |
|
|
496 // | string |
|
|
497 // | range |
|
1427
|
498 // | string array |
|
604
|
499 // |
|
|
500 // <info> : <matrix info> |
|
|
501 // | <string info> |
|
1427
|
502 // | <string array info> |
|
604
|
503 // |
|
|
504 // <matrix info> : # rows: <integer> |
|
1427
|
505 // : # columns: <integer> |
|
604
|
506 // |
|
1427
|
507 // <string info> : # length: <integer> |
|
|
508 // |
|
|
509 // <string array info> : # elements: <integer> |
|
|
510 // : # length: <integer> (once before each string) |
|
604
|
511 // |
|
|
512 // Formatted ASCII data follows the header. |
|
|
513 // |
|
|
514 // Example: |
|
|
515 // |
|
|
516 // # name: foo |
|
|
517 // # type: matrix |
|
|
518 // # rows: 2 |
|
|
519 // # columns: 2 |
|
|
520 // 2 4 |
|
|
521 // 1 3 |
|
|
522 // |
|
1427
|
523 // Example: |
|
|
524 // |
|
|
525 // # name: foo |
|
|
526 // # type: string array |
|
|
527 // # elements: 5 |
|
|
528 // # length: 4 |
|
|
529 // this |
|
|
530 // # length: 2 |
|
|
531 // is |
|
|
532 // # length: 1 |
|
|
533 // a |
|
|
534 // # length: 6 |
|
|
535 // string |
|
|
536 // # length: 5 |
|
|
537 // array |
|
|
538 // |
|
604
|
539 // XXX FIXME XXX -- this format is fairly rigid, and doesn't allow for |
|
|
540 // arbitrary comments, etc. Someone should fix that. |
|
|
541 |
|
|
542 static char * |
|
3523
|
543 read_ascii_data (std::istream& is, const std::string& filename, bool& global, |
|
3136
|
544 octave_value& tc, int count) |
|
604
|
545 { |
|
1358
|
546 // Read name for this entry or break on EOF. |
|
604
|
547 |
|
|
548 char *name = extract_keyword (is, "name"); |
|
|
549 |
|
|
550 if (! name) |
|
3136
|
551 { |
|
|
552 if (count == 0) |
|
|
553 error ("load: no data found in file `%s'", filename.c_str ()); |
|
|
554 |
|
|
555 return 0; |
|
|
556 } |
|
604
|
557 |
|
|
558 if (! *name) |
|
|
559 { |
|
1755
|
560 error ("load: empty name keyword found in file `%s'", |
|
|
561 filename.c_str ()); |
|
604
|
562 delete [] name; |
|
|
563 return 0; |
|
|
564 } |
|
|
565 |
|
|
566 |
|
|
567 if (! valid_identifier (name)) |
|
|
568 { |
|
1755
|
569 error ("load: bogus identifier `%s' found in file `%s'", name, |
|
|
570 filename.c_str ()); |
|
604
|
571 delete [] name; |
|
|
572 return 0; |
|
|
573 } |
|
|
574 |
|
1358
|
575 // Look for type keyword. |
|
604
|
576 |
|
|
577 char *tag = extract_keyword (is, "type"); |
|
|
578 |
|
|
579 if (tag && *tag) |
|
|
580 { |
|
|
581 char *ptr = strchr (tag, ' '); |
|
|
582 if (ptr) |
|
|
583 { |
|
|
584 *ptr = '\0'; |
|
|
585 global = (strncmp (tag, "global", 6) == 0); |
|
|
586 *ptr = ' '; |
|
|
587 if (global) |
|
|
588 ptr++; |
|
|
589 else |
|
|
590 ptr = tag; |
|
|
591 } |
|
|
592 else |
|
|
593 ptr = tag; |
|
|
594 |
|
|
595 if (strncmp (ptr, "scalar", 6) == 0) |
|
|
596 { |
|
|
597 double tmp; |
|
|
598 is >> tmp; |
|
|
599 if (is) |
|
|
600 tc = tmp; |
|
|
601 else |
|
|
602 error ("load: failed to load scalar constant"); |
|
|
603 } |
|
|
604 else if (strncmp (ptr, "matrix", 6) == 0) |
|
|
605 { |
|
3019
|
606 int nr = 0; |
|
|
607 int nc = 0; |
|
604
|
608 |
|
1275
|
609 if (extract_keyword (is, "rows", nr) && nr >= 0 |
|
|
610 && extract_keyword (is, "columns", nc) && nc >= 0) |
|
604
|
611 { |
|
1275
|
612 if (nr > 0 && nc > 0) |
|
|
613 { |
|
|
614 Matrix tmp (nr, nc); |
|
|
615 is >> tmp; |
|
|
616 if (is) |
|
|
617 tc = tmp; |
|
|
618 else |
|
|
619 error ("load: failed to load matrix constant"); |
|
|
620 } |
|
|
621 else if (nr == 0 || nc == 0) |
|
|
622 tc = Matrix (nr, nc); |
|
604
|
623 else |
|
1275
|
624 panic_impossible (); |
|
604
|
625 } |
|
|
626 else |
|
|
627 error ("load: failed to extract number of rows and columns"); |
|
|
628 } |
|
|
629 else if (strncmp (ptr, "complex scalar", 14) == 0) |
|
|
630 { |
|
|
631 Complex tmp; |
|
|
632 is >> tmp; |
|
|
633 if (is) |
|
|
634 tc = tmp; |
|
|
635 else |
|
|
636 error ("load: failed to load complex scalar constant"); |
|
|
637 } |
|
|
638 else if (strncmp (ptr, "complex matrix", 14) == 0) |
|
|
639 { |
|
3019
|
640 int nr = 0; |
|
|
641 int nc = 0; |
|
604
|
642 |
|
|
643 if (extract_keyword (is, "rows", nr) && nr > 0 |
|
|
644 && extract_keyword (is, "columns", nc) && nc > 0) |
|
|
645 { |
|
|
646 ComplexMatrix tmp (nr, nc); |
|
|
647 is >> tmp; |
|
|
648 if (is) |
|
|
649 tc = tmp; |
|
|
650 else |
|
|
651 error ("load: failed to load complex matrix constant"); |
|
|
652 } |
|
|
653 else |
|
|
654 error ("load: failed to extract number of rows and columns"); |
|
|
655 } |
|
1427
|
656 else if (strncmp (ptr, "string array", 12) == 0) |
|
|
657 { |
|
|
658 int elements; |
|
3682
|
659 if (extract_keyword (is, "elements", elements) && elements >= 0) |
|
1427
|
660 { |
|
1572
|
661 // XXX FIXME XXX -- need to be able to get max length |
|
|
662 // before doing anything. |
|
|
663 |
|
|
664 charMatrix chm (elements, 0); |
|
|
665 int max_len = 0; |
|
1427
|
666 for (int i = 0; i < elements; i++) |
|
|
667 { |
|
|
668 int len; |
|
3136
|
669 if (extract_keyword (is, "length", len) && len >= 0) |
|
1427
|
670 { |
|
2497
|
671 char *tmp = new char [len+1]; |
|
3557
|
672 if (len > 0 && ! is.read (X_CAST (char *, tmp), len)) |
|
1427
|
673 { |
|
|
674 error ("load: failed to load string constant"); |
|
|
675 break; |
|
|
676 } |
|
|
677 else |
|
1572
|
678 { |
|
2498
|
679 tmp [len] = '\0'; |
|
1572
|
680 if (len > max_len) |
|
|
681 { |
|
|
682 max_len = len; |
|
|
683 chm.resize (elements, max_len, 0); |
|
|
684 } |
|
|
685 chm.insert (tmp, i, 0); |
|
|
686 } |
|
1427
|
687 delete [] tmp; |
|
|
688 } |
|
|
689 else |
|
|
690 error ("load: failed to extract string length for element %d", i+1); |
|
|
691 } |
|
|
692 |
|
|
693 if (! error_state) |
|
2499
|
694 tc = octave_value (chm, true); |
|
1427
|
695 } |
|
|
696 else |
|
|
697 error ("load: failed to extract number of string elements"); |
|
|
698 } |
|
604
|
699 else if (strncmp (ptr, "string", 6) == 0) |
|
|
700 { |
|
|
701 int len; |
|
3682
|
702 if (extract_keyword (is, "length", len) && len >= 0) |
|
604
|
703 { |
|
|
704 char *tmp = new char [len+1]; |
|
3682
|
705 if (len > 0 && ! is.read (X_CAST (char *, tmp), len)) |
|
|
706 { |
|
|
707 error ("load: failed to load string constant"); |
|
|
708 } |
|
604
|
709 else |
|
3682
|
710 { |
|
|
711 tmp [len] = '\0'; |
|
|
712 |
|
|
713 if (is) |
|
|
714 tc = tmp; |
|
|
715 else |
|
|
716 error ("load: failed to load string constant"); |
|
|
717 } |
|
604
|
718 } |
|
|
719 else |
|
|
720 error ("load: failed to extract string length"); |
|
|
721 } |
|
|
722 else if (strncmp (ptr, "range", 5) == 0) |
|
|
723 { |
|
3687
|
724 // # base, limit, range comment added by save (). |
|
1358
|
725 |
|
604
|
726 skip_comments (is); |
|
|
727 Range tmp; |
|
|
728 is >> tmp; |
|
|
729 if (is) |
|
|
730 tc = tmp; |
|
|
731 else |
|
|
732 error ("load: failed to load range constant"); |
|
|
733 } |
|
|
734 else |
|
|
735 error ("load: unknown constant type `%s'", tag); |
|
|
736 } |
|
|
737 else |
|
|
738 error ("load: failed to extract keyword specifying value type"); |
|
|
739 |
|
|
740 delete [] tag; |
|
|
741 |
|
|
742 if (error_state) |
|
|
743 { |
|
1755
|
744 error ("load: reading file %s", filename.c_str ()); |
|
604
|
745 return 0; |
|
|
746 } |
|
|
747 |
|
|
748 return name; |
|
|
749 } |
|
|
750 |
|
|
751 // Extract one value (scalar, matrix, string, etc.) from stream IS and |
|
|
752 // place it in TC, returning the name of the variable. If the value |
|
3019
|
753 // is tagged as global in the file, return TRUE in GLOBAL. If SWAP |
|
|
754 // is TRUE, swap bytes after reading. |
|
604
|
755 // |
|
|
756 // The data is expected to be in the following format: |
|
|
757 // |
|
867
|
758 // Header (one per file): |
|
|
759 // ===================== |
|
604
|
760 // |
|
867
|
761 // object type bytes |
|
|
762 // ------ ---- ----- |
|
|
763 // magic number string 10 |
|
604
|
764 // |
|
867
|
765 // float format integer 1 |
|
|
766 // |
|
604
|
767 // |
|
867
|
768 // Data (one set for each item): |
|
|
769 // ============================ |
|
604
|
770 // |
|
867
|
771 // object type bytes |
|
|
772 // ------ ---- ----- |
|
|
773 // name_length integer 4 |
|
604
|
774 // |
|
867
|
775 // name string name_length |
|
604
|
776 // |
|
867
|
777 // doc_length integer 4 |
|
|
778 // |
|
|
779 // doc string doc_length |
|
604
|
780 // |
|
867
|
781 // global flag integer 1 |
|
604
|
782 // |
|
867
|
783 // data type integer 1 |
|
604
|
784 // |
|
867
|
785 // data (one of): |
|
|
786 // |
|
|
787 // scalar: |
|
|
788 // data real 8 |
|
604
|
789 // |
|
867
|
790 // complex scalar: |
|
|
791 // data complex 16 |
|
|
792 // |
|
|
793 // matrix: |
|
|
794 // rows integer 4 |
|
|
795 // columns integer 4 |
|
|
796 // data real r*c*8 |
|
604
|
797 // |
|
867
|
798 // complex matrix: |
|
|
799 // rows integer 4 |
|
|
800 // columns integer 4 |
|
|
801 // data complex r*c*16 |
|
604
|
802 // |
|
867
|
803 // string: |
|
|
804 // length int 4 |
|
|
805 // data string length |
|
604
|
806 // |
|
867
|
807 // range: |
|
|
808 // base real 8 |
|
|
809 // limit real 8 |
|
|
810 // increment real 8 |
|
604
|
811 // |
|
1427
|
812 // string array |
|
|
813 // elements int 4 |
|
|
814 // |
|
|
815 // for each element: |
|
|
816 // length int 4 |
|
|
817 // data string length |
|
|
818 // |
|
604
|
819 // FILENAME is used for error messages. |
|
|
820 |
|
|
821 static char * |
|
3523
|
822 read_binary_data (std::istream& is, bool swap, |
|
2318
|
823 oct_mach_info::float_format fmt, |
|
3523
|
824 const std::string& filename, bool& global, |
|
2086
|
825 octave_value& tc, char *&doc) |
|
604
|
826 { |
|
|
827 char tmp = 0; |
|
|
828 |
|
3019
|
829 FOUR_BYTE_INT name_len = 0; |
|
|
830 FOUR_BYTE_INT doc_len = 0; |
|
604
|
831 char *name = 0; |
|
|
832 |
|
|
833 doc = 0; |
|
|
834 |
|
1358
|
835 // We expect to fail here, at the beginning of a record, so not |
|
|
836 // being able to read another name should not result in an error. |
|
867
|
837 |
|
3557
|
838 is.read (X_CAST (char *, &name_len), 4); |
|
604
|
839 if (! is) |
|
867
|
840 return 0; |
|
604
|
841 if (swap) |
|
3145
|
842 swap_4_bytes (X_CAST (char *, &name_len)); |
|
604
|
843 |
|
|
844 name = new char [name_len+1]; |
|
|
845 name[name_len] = '\0'; |
|
3557
|
846 if (! is.read (X_CAST (char *, name), name_len)) |
|
604
|
847 goto data_read_error; |
|
|
848 |
|
3557
|
849 is.read (X_CAST (char *, &doc_len), 4); |
|
604
|
850 if (! is) |
|
|
851 goto data_read_error; |
|
|
852 if (swap) |
|
3145
|
853 swap_4_bytes (X_CAST (char *, &doc_len)); |
|
604
|
854 |
|
|
855 doc = new char [doc_len+1]; |
|
|
856 doc[doc_len] = '\0'; |
|
3557
|
857 if (! is.read (X_CAST (char *, doc), doc_len)) |
|
604
|
858 goto data_read_error; |
|
|
859 |
|
3557
|
860 if (! is.read (X_CAST (char *, &tmp), 1)) |
|
604
|
861 goto data_read_error; |
|
|
862 global = tmp ? 1 : 0; |
|
|
863 |
|
|
864 tmp = 0; |
|
3557
|
865 if (! is.read (X_CAST (char *, &tmp), 1)) |
|
604
|
866 goto data_read_error; |
|
|
867 |
|
|
868 switch (tmp) |
|
|
869 { |
|
|
870 case 1: |
|
|
871 { |
|
3557
|
872 if (! is.read (X_CAST (char *, &tmp), 1)) |
|
604
|
873 goto data_read_error; |
|
630
|
874 double dtmp; |
|
3145
|
875 read_doubles (is, &dtmp, X_CAST (save_type, tmp), 1, swap, fmt); |
|
774
|
876 if (error_state || ! is) |
|
630
|
877 goto data_read_error; |
|
604
|
878 tc = dtmp; |
|
|
879 } |
|
|
880 break; |
|
|
881 |
|
|
882 case 2: |
|
|
883 { |
|
|
884 FOUR_BYTE_INT nr, nc; |
|
3557
|
885 if (! is.read (X_CAST (char *, &nr), 4)) |
|
604
|
886 goto data_read_error; |
|
|
887 if (swap) |
|
3145
|
888 swap_4_bytes (X_CAST (char *, &nr)); |
|
3557
|
889 if (! is.read (X_CAST (char *, &nc), 4)) |
|
604
|
890 goto data_read_error; |
|
|
891 if (swap) |
|
3145
|
892 swap_4_bytes (X_CAST (char *, &nc)); |
|
3557
|
893 if (! is.read (X_CAST (char *, &tmp), 1)) |
|
604
|
894 goto data_read_error; |
|
|
895 Matrix m (nr, nc); |
|
|
896 double *re = m.fortran_vec (); |
|
|
897 int len = nr * nc; |
|
3145
|
898 read_doubles (is, re, X_CAST (save_type, tmp), len, swap, fmt); |
|
774
|
899 if (error_state || ! is) |
|
604
|
900 goto data_read_error; |
|
|
901 tc = m; |
|
|
902 } |
|
|
903 break; |
|
|
904 |
|
|
905 case 3: |
|
|
906 { |
|
3557
|
907 if (! is.read (X_CAST (char *, &tmp), 1)) |
|
604
|
908 goto data_read_error; |
|
630
|
909 Complex ctmp; |
|
3145
|
910 read_doubles (is, X_CAST (double *, &ctmp), |
|
|
911 X_CAST (save_type, tmp), 2, swap, fmt); |
|
774
|
912 if (error_state || ! is) |
|
630
|
913 goto data_read_error; |
|
604
|
914 tc = ctmp; |
|
|
915 } |
|
|
916 break; |
|
|
917 |
|
|
918 case 4: |
|
|
919 { |
|
|
920 FOUR_BYTE_INT nr, nc; |
|
3557
|
921 if (! is.read (X_CAST (char *, &nr), 4)) |
|
604
|
922 goto data_read_error; |
|
|
923 if (swap) |
|
3145
|
924 swap_4_bytes (X_CAST (char *, &nr)); |
|
3557
|
925 if (! is.read (X_CAST (char *, &nc), 4)) |
|
604
|
926 goto data_read_error; |
|
|
927 if (swap) |
|
3145
|
928 swap_4_bytes (X_CAST (char *, &nc)); |
|
3557
|
929 if (! is.read (X_CAST (char *, &tmp), 1)) |
|
604
|
930 goto data_read_error; |
|
|
931 ComplexMatrix m (nr, nc); |
|
|
932 Complex *im = m.fortran_vec (); |
|
|
933 int len = nr * nc; |
|
3145
|
934 read_doubles (is, X_CAST (double *, im), |
|
|
935 X_CAST (save_type, tmp), 2*len, swap, fmt); |
|
774
|
936 if (error_state || ! is) |
|
604
|
937 goto data_read_error; |
|
|
938 tc = m; |
|
|
939 } |
|
|
940 break; |
|
|
941 |
|
|
942 case 5: |
|
|
943 { |
|
1427
|
944 FOUR_BYTE_INT len; |
|
3557
|
945 if (! is.read (X_CAST (char *, &len), 4)) |
|
604
|
946 goto data_read_error; |
|
|
947 if (swap) |
|
3145
|
948 swap_4_bytes (X_CAST (char *, &len)); |
|
604
|
949 char *s = new char [len+1]; |
|
3557
|
950 if (! is.read (X_CAST (char *, s), len)) |
|
604
|
951 { |
|
|
952 delete [] s; |
|
|
953 goto data_read_error; |
|
|
954 } |
|
|
955 s[len] = '\0'; |
|
|
956 tc = s; |
|
|
957 } |
|
|
958 break; |
|
|
959 |
|
|
960 case 6: |
|
|
961 { |
|
3557
|
962 if (! is.read (X_CAST (char *, &tmp), 1)) |
|
630
|
963 goto data_read_error; |
|
604
|
964 double bas, lim, inc; |
|
3557
|
965 if (! is.read (X_CAST (char *, &bas), 8)) |
|
604
|
966 goto data_read_error; |
|
|
967 if (swap) |
|
3145
|
968 swap_8_bytes (X_CAST (char *, &bas)); |
|
3557
|
969 if (! is.read (X_CAST (char *, &lim), 8)) |
|
604
|
970 goto data_read_error; |
|
|
971 if (swap) |
|
3145
|
972 swap_8_bytes (X_CAST (char *, &lim)); |
|
3557
|
973 if (! is.read (X_CAST (char *, &inc), 8)) |
|
604
|
974 goto data_read_error; |
|
|
975 if (swap) |
|
3145
|
976 swap_8_bytes (X_CAST (char *, &inc)); |
|
604
|
977 Range r (bas, lim, inc); |
|
|
978 tc = r; |
|
|
979 } |
|
|
980 break; |
|
|
981 |
|
1427
|
982 case 7: |
|
|
983 { |
|
|
984 FOUR_BYTE_INT elements; |
|
3557
|
985 if (! is.read (X_CAST (char *, &elements), 4)) |
|
1427
|
986 goto data_read_error; |
|
|
987 if (swap) |
|
3145
|
988 swap_4_bytes (X_CAST (char *, &elements)); |
|
1572
|
989 charMatrix chm (elements, 0); |
|
|
990 int max_len = 0; |
|
1427
|
991 for (int i = 0; i < elements; i++) |
|
|
992 { |
|
|
993 FOUR_BYTE_INT len; |
|
3557
|
994 if (! is.read (X_CAST (char *, &len), 4)) |
|
1427
|
995 goto data_read_error; |
|
|
996 if (swap) |
|
3145
|
997 swap_4_bytes (X_CAST (char *, &len)); |
|
2497
|
998 char *tmp = new char [len+1]; |
|
3557
|
999 if (! is.read (X_CAST (char *, tmp), len)) |
|
1427
|
1000 { |
|
|
1001 delete [] tmp; |
|
|
1002 goto data_read_error; |
|
|
1003 } |
|
1572
|
1004 if (len > max_len) |
|
|
1005 { |
|
|
1006 max_len = len; |
|
|
1007 chm.resize (elements, max_len, 0); |
|
|
1008 } |
|
2497
|
1009 tmp [len] = '\0'; |
|
1572
|
1010 chm.insert (tmp, i, 0); |
|
1427
|
1011 delete [] tmp; |
|
|
1012 } |
|
2499
|
1013 tc = octave_value (chm, true); |
|
1427
|
1014 } |
|
|
1015 break; |
|
|
1016 |
|
604
|
1017 default: |
|
|
1018 data_read_error: |
|
1755
|
1019 error ("load: trouble reading binary file `%s'", filename.c_str ()); |
|
604
|
1020 delete [] name; |
|
|
1021 name = 0; |
|
|
1022 break; |
|
|
1023 } |
|
|
1024 |
|
|
1025 return name; |
|
|
1026 } |
|
|
1027 |
|
3687
|
1028 // HDF5 input/output |
|
|
1029 |
|
|
1030 #ifdef HAVE_HDF5 |
|
|
1031 |
|
|
1032 // Define this to 1 if/when HDF5 supports automatic conversion between |
|
|
1033 // integer and floating-point binary data: |
|
|
1034 #define HAVE_HDF5_INT2FLOAT_CONVERSIONS 0 |
|
|
1035 |
|
|
1036 // first, we need to define our own dummy stream subclass, since |
|
|
1037 // HDF5 needs to do its own file i/o |
|
|
1038 |
|
|
1039 // hdf5_fstreambase is used for both input and output streams, modeled |
|
|
1040 // on the fstreambase class in <fstream.h> |
|
|
1041 |
|
|
1042 class hdf5_fstreambase : virtual public std::ios |
|
|
1043 { |
|
|
1044 public: |
|
|
1045 |
|
|
1046 // HDF5 uses an "id" to refer to an open file |
|
|
1047 hid_t file_id; |
|
|
1048 |
|
|
1049 // keep track of current item index in the file |
|
|
1050 int current_item; |
|
|
1051 |
|
|
1052 hdf5_fstreambase () { file_id = -1; } |
|
|
1053 |
|
|
1054 hdf5_fstreambase (const char *name, int mode, int prot = 0) |
|
|
1055 { |
|
|
1056 if (mode == std::ios::in) |
|
|
1057 file_id = H5Fopen (name, H5F_ACC_RDONLY, H5P_DEFAULT); |
|
|
1058 else if (mode == std::ios::out) |
|
|
1059 file_id = H5Fcreate (name, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT); |
|
|
1060 |
|
|
1061 if (file_id < 0) |
|
3897
|
1062 std::ios::setstate (std::ios::badbit); |
|
3687
|
1063 |
|
|
1064 current_item = 0; |
|
|
1065 } |
|
|
1066 |
|
|
1067 void close () |
|
|
1068 { |
|
|
1069 if (file_id >= 0) |
|
|
1070 { |
|
|
1071 if (H5Fclose (file_id) < 0) |
|
3897
|
1072 std::ios::setstate (std::ios::badbit); |
|
3687
|
1073 file_id = -1; |
|
|
1074 } |
|
|
1075 } |
|
|
1076 |
|
|
1077 void open (const char *name, int mode, int prot = 0) |
|
|
1078 { |
|
|
1079 clear (); |
|
|
1080 |
|
|
1081 if (mode == std::ios::in) |
|
|
1082 file_id = H5Fopen (name, H5F_ACC_RDONLY, H5P_DEFAULT); |
|
|
1083 else if (mode == std::ios::out) |
|
|
1084 file_id = H5Fcreate (name, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT); |
|
|
1085 |
|
|
1086 if (file_id < 0) |
|
3897
|
1087 std::ios::setstate (std::ios::badbit); |
|
3687
|
1088 |
|
|
1089 current_item = 0; |
|
|
1090 } |
|
|
1091 }; |
|
|
1092 |
|
|
1093 // input and output streams, subclassing istream and ostream |
|
|
1094 // so that we can pass them for stream parameters in the functions below. |
|
|
1095 |
|
|
1096 class hdf5_ifstream : public hdf5_fstreambase, public std::istream |
|
|
1097 { |
|
|
1098 public: |
|
|
1099 |
|
3897
|
1100 hdf5_ifstream () : hdf5_fstreambase (), std::istream (0) { } |
|
3687
|
1101 |
|
|
1102 hdf5_ifstream (const char *name, int mode = std::ios::in, int prot = 0) |
|
3897
|
1103 : hdf5_fstreambase (name, mode, prot), std::istream (0) { } |
|
3687
|
1104 |
|
|
1105 void open (const char *name, int mode = std::ios::in, int prot = 0) |
|
|
1106 { hdf5_fstreambase::open (name, mode, prot); } |
|
|
1107 }; |
|
|
1108 |
|
|
1109 class hdf5_ofstream : public hdf5_fstreambase, public std::ostream |
|
|
1110 { |
|
|
1111 public: |
|
|
1112 |
|
3897
|
1113 hdf5_ofstream () : hdf5_fstreambase (), std::ostream (0) { } |
|
3687
|
1114 |
|
|
1115 hdf5_ofstream (const char *name, int mode = std::ios::out, int prot = 0) |
|
3897
|
1116 : hdf5_fstreambase (name, mode, prot), std::ostream (0) { } |
|
3687
|
1117 |
|
|
1118 void open (const char *name, int mode = std::ios::out, int prot = 0) |
|
|
1119 { hdf5_fstreambase::open (name, mode, prot); } |
|
|
1120 }; |
|
|
1121 |
|
|
1122 // Given two compound types t1 and t2, determine whether they |
|
|
1123 // are compatible for reading/writing. This function only |
|
|
1124 // works for non-nested types composed of simple elements (ints, floats...), |
|
|
1125 // which is all we need it for |
|
|
1126 |
|
|
1127 bool |
|
|
1128 hdf5_types_compatible (hid_t t1, hid_t t2) |
|
|
1129 { |
|
|
1130 int n; |
|
|
1131 if ((n = H5Tget_nmembers (t1)) != H5Tget_nmembers (t2)) |
|
|
1132 return false; |
|
|
1133 |
|
|
1134 for (int i = 0; i < n; ++i) |
|
|
1135 { |
|
|
1136 hid_t mt1 = H5Tget_member_type (t1, i); |
|
|
1137 hid_t mt2 = H5Tget_member_type (t2, i); |
|
|
1138 |
|
|
1139 if (H5Tget_class (mt1) != H5Tget_class (mt2)) |
|
|
1140 return false; |
|
|
1141 |
|
|
1142 H5Tclose (mt2); |
|
|
1143 H5Tclose (mt1); |
|
|
1144 } |
|
|
1145 |
|
|
1146 return true; |
|
|
1147 } |
|
|
1148 |
|
|
1149 // Import a multidimensional (rank >= 3) dataset whose id is data_id, into tc. |
|
|
1150 // This works by calling itself recursively, building up lists of lists |
|
|
1151 // of lists ... of 2d matrices. rank and dims are the rank and dimensions |
|
|
1152 // of the dataset. type_id is the datatype to read into. If it is |
|
|
1153 // H5T_NATIVE_DOUBLE, we are reading a real matrix. Otherwise, type_id |
|
|
1154 // is assumed to be a complex type for reading a complex matrix. |
|
|
1155 // |
|
|
1156 // Upon entry, we should have curdim = rank - 1, start = an array |
|
|
1157 // of length rank = all zeros, and count = an array of length rank = |
|
|
1158 // all ones except for the first two dimensions which equal the corresponding |
|
|
1159 // entries in dims[]. |
|
|
1160 // |
|
|
1161 // Note that we process the dimensions in reverse order, reflecting |
|
|
1162 // the fact that Octave is uses column-major (Fortran-order) data while |
|
|
1163 // HDF5 is row-major. This means that the HDF5 file is read |
|
|
1164 // non-contiguously, but on the other hand means that for a 3d array |
|
|
1165 // we get a list of xy-plane slices, which seems nice. We could change |
|
|
1166 // this behavior without much trouble; what is the best thing to do? |
|
|
1167 // |
|
|
1168 // Returns a positive value upon success. |
|
|
1169 |
|
|
1170 static herr_t |
|
|
1171 hdf5_import_multidim (hid_t data_id, hid_t space_id, hsize_t rank, |
|
|
1172 const hsize_t *dims, hsize_t curdim, |
|
|
1173 hssize_t *start, const hsize_t *count, |
|
|
1174 hid_t type_id, octave_value &tc) |
|
|
1175 { |
|
|
1176 herr_t retval = 1; |
|
|
1177 |
|
|
1178 if (rank < 3 || curdim < 1 || curdim >= rank) |
|
|
1179 return -1; |
|
|
1180 |
|
|
1181 if (curdim == 1) |
|
|
1182 { |
|
|
1183 // import 2d dataset for 1st 2 dims directly as a matrix |
|
|
1184 int nr, nc; // rows and columns |
|
|
1185 nc = dims[0]; // octave uses column-major & HDF5 uses row-major |
|
|
1186 nr = dims[1]; |
|
|
1187 |
|
|
1188 hid_t mem_space_id = H5Screate_simple (2, dims, NULL); |
|
|
1189 |
|
|
1190 if (mem_space_id < 0) |
|
|
1191 return -1; |
|
|
1192 |
|
|
1193 if (H5Sselect_all (mem_space_id) < 0) |
|
|
1194 return -1; |
|
|
1195 |
|
|
1196 if (H5Sselect_hyperslab (space_id, H5S_SELECT_SET, |
|
|
1197 start, NULL, count, NULL) < 0) |
|
|
1198 { |
|
|
1199 H5Sclose (mem_space_id); |
|
|
1200 return -1; |
|
|
1201 } |
|
|
1202 |
|
|
1203 if (type_id == H5T_NATIVE_DOUBLE) |
|
|
1204 { |
|
|
1205 // real matrix |
|
|
1206 Matrix m (nr, nc); |
|
|
1207 double *re = m.fortran_vec (); |
|
|
1208 if (H5Dread (data_id, type_id, mem_space_id, space_id, |
|
|
1209 H5P_DEFAULT, (void *) re) < 0) |
|
|
1210 retval = -1; // error |
|
|
1211 else |
|
|
1212 tc = m; |
|
|
1213 } |
|
|
1214 else |
|
|
1215 { |
|
|
1216 // assume that we are using complex numbers |
|
|
1217 // complex matrix |
|
|
1218 ComplexMatrix m (nr, nc); |
|
|
1219 Complex *reim = m.fortran_vec (); |
|
|
1220 if (H5Dread (data_id, type_id, mem_space_id, space_id, |
|
|
1221 H5P_DEFAULT, (void *) X_CAST (double *, reim)) < 0) |
|
|
1222 retval = -1; // error |
|
|
1223 else |
|
|
1224 tc = m; |
|
|
1225 } |
|
|
1226 |
|
|
1227 H5Sclose (mem_space_id); |
|
|
1228 |
|
|
1229 } |
|
|
1230 else |
|
|
1231 { |
|
|
1232 octave_value_list lst; |
|
|
1233 |
|
|
1234 for (hsize_t i = 0; i < dims[curdim]; ++i) |
|
|
1235 { |
|
|
1236 octave_value slice; |
|
|
1237 start[curdim] = i; |
|
|
1238 retval = hdf5_import_multidim (data_id, space_id, rank, |
|
|
1239 dims, curdim-1, start, count, |
|
|
1240 type_id, slice); |
|
|
1241 if (retval < 0) |
|
|
1242 break; |
|
|
1243 lst.append (slice); |
|
|
1244 } |
|
|
1245 |
|
|
1246 if (retval > 0) |
|
|
1247 tc = lst; |
|
|
1248 } |
|
|
1249 |
|
|
1250 return retval; |
|
|
1251 } |
|
|
1252 |
|
|
1253 // Return true if loc_id has the attribute named attr_name, and false |
|
|
1254 // otherwise. |
|
|
1255 |
|
|
1256 bool |
|
|
1257 hdf5_check_attr (hid_t loc_id, const char *attr_name) |
|
|
1258 { |
|
|
1259 bool retval = false; |
|
|
1260 |
|
|
1261 // we have to pull some shenanigans here to make sure |
|
|
1262 // HDF5 doesn't print out all sorts of error messages if we |
|
|
1263 // call H5Aopen for a non-existing attribute |
|
|
1264 |
|
|
1265 H5E_auto_t err_func; |
|
|
1266 void *err_func_data; |
|
|
1267 |
|
|
1268 // turn off error reporting temporarily, but save the error |
|
|
1269 // reporting function: |
|
|
1270 |
|
|
1271 H5Eget_auto (&err_func, &err_func_data); |
|
|
1272 H5Eset_auto (NULL, NULL); |
|
|
1273 |
|
3688
|
1274 hid_t attr_id = H5Aopen_name (loc_id, attr_name); |
|
3687
|
1275 |
|
|
1276 if (attr_id >= 0) |
|
|
1277 { |
|
|
1278 // successful |
|
|
1279 retval = 1; |
|
|
1280 H5Aclose (attr_id); |
|
|
1281 } |
|
|
1282 |
|
|
1283 // restore error reporting: |
|
|
1284 H5Eset_auto (err_func, err_func_data); |
|
|
1285 |
|
|
1286 return retval; |
|
|
1287 } |
|
|
1288 |
|
|
1289 // Callback data structure for passing data to hdf5_read_next_data, below. |
|
|
1290 |
|
|
1291 struct hdf5_callback_data |
|
|
1292 { |
|
|
1293 // the following fields are set by hdf5_read_data on successful return: |
|
|
1294 |
|
|
1295 // the name of the variable |
|
|
1296 char *name; |
|
|
1297 |
|
|
1298 // whether it is global |
|
|
1299 bool global; |
|
|
1300 |
|
|
1301 // the value of the variable, in Octave form |
|
|
1302 octave_value tc; |
|
|
1303 |
|
|
1304 // a documentation string (NULL if none) |
|
|
1305 char *doc; |
|
|
1306 |
|
|
1307 // the following fields are input to hdf5_read_data: |
|
|
1308 |
|
|
1309 // HDF5 rep's of complex and range type |
|
|
1310 hid_t complex_type, range_type; |
|
|
1311 |
|
|
1312 // whether to try extra hard to import "foreign" data |
|
|
1313 bool import; |
|
|
1314 }; |
|
|
1315 |
|
3695
|
1316 // This variable, set in read_hdf5_data(), tells whether we are using |
|
|
1317 // a version of HDF5 with a buggy H5Giterate (i.e. which neglects to |
|
|
1318 // increment the index parameter to the next unread item). |
|
|
1319 static bool have_h5giterate_bug = false; |
|
|
1320 |
|
3687
|
1321 // This function is designed to be passed to H5Giterate, which calls it |
|
|
1322 // on each data item in an HDF5 file. For the item whose name is NAME in |
|
|
1323 // the group GROUP_ID, this function sets dv->tc to an Octave representation |
|
|
1324 // of that item. (dv must be a pointer to hdf5_callback_data.) (It also |
|
|
1325 // sets the other fields of dv). |
|
|
1326 // |
|
|
1327 // It returns 1 on success (in which case H5Giterate stops and returns), |
|
|
1328 // -1 on error, and 0 to tell H5Giterate to continue on to the next item |
|
|
1329 // (e.g. if NAME was a data type we don't recognize). |
|
|
1330 |
|
|
1331 static herr_t |
|
|
1332 hdf5_read_next_data (hid_t group_id, const char *name, void *dv) |
|
|
1333 { |
|
|
1334 hdf5_callback_data *d = (hdf5_callback_data *) dv; |
|
|
1335 H5G_stat_t info; |
|
|
1336 herr_t retval = 0; |
|
|
1337 bool ident_valid = valid_identifier (name); |
|
|
1338 char *vname; |
|
|
1339 |
|
|
1340 vname = new char[strlen (name) + 1]; |
|
|
1341 |
|
|
1342 strcpy (vname, name); |
|
|
1343 |
|
3688
|
1344 if (! ident_valid && d->import) |
|
3687
|
1345 { |
|
|
1346 // fix the identifier, replacing invalid chars with underscores |
|
|
1347 make_valid_identifier (vname); |
|
|
1348 |
|
|
1349 // check again (in case vname was null, empty, or some such thing): |
|
|
1350 ident_valid = valid_identifier (vname); |
|
|
1351 } |
|
|
1352 |
|
|
1353 H5Gget_objinfo (group_id, name, 1, &info); |
|
|
1354 |
|
|
1355 if (info.type == H5G_DATASET && ident_valid) |
|
|
1356 { |
|
|
1357 retval = 1; |
|
|
1358 |
|
|
1359 hid_t data_id = H5Dopen (group_id, name); |
|
|
1360 |
|
|
1361 if (data_id < 0) |
|
|
1362 { |
|
|
1363 retval = data_id; |
|
|
1364 |
|
|
1365 goto done; |
|
|
1366 } |
|
|
1367 |
|
|
1368 hid_t type_id = H5Dget_type (data_id); |
|
|
1369 |
|
|
1370 hid_t type_class_id = H5Tget_class (type_id); |
|
|
1371 |
|
|
1372 #if HAVE_HDF5_INT2FLOAT_CONVERSIONS |
|
|
1373 if (type_class_id == H5T_INTEGER || type_class_id == H5T_FLOAT) |
|
|
1374 { |
|
|
1375 #else |
|
|
1376 // hdf5 doesn't (yet) support automatic float/integer conversions |
|
|
1377 if (type_class_id == H5T_FLOAT) |
|
|
1378 { |
|
|
1379 #endif |
|
|
1380 // read real matrix or scalar variable |
|
|
1381 |
|
|
1382 hid_t space_id = H5Dget_space (data_id); |
|
|
1383 |
|
|
1384 hsize_t rank = H5Sget_simple_extent_ndims (space_id); |
|
|
1385 |
|
|
1386 if (rank == 0) |
|
|
1387 { |
|
|
1388 // real scalar: |
|
|
1389 double dtmp; |
|
|
1390 if (H5Dread (data_id, H5T_NATIVE_DOUBLE, H5S_ALL, H5S_ALL, |
|
|
1391 H5P_DEFAULT, (void *) &dtmp) < 0) |
|
|
1392 retval = -1; // error |
|
|
1393 else |
|
|
1394 d->tc = dtmp; |
|
|
1395 } |
|
|
1396 else if (rank > 0 && rank <= 2) |
|
|
1397 { |
|
|
1398 // real matrix |
|
|
1399 hsize_t *dims = new hsize_t[rank]; |
|
|
1400 hsize_t *maxdims = new hsize_t[rank]; |
|
|
1401 |
|
|
1402 H5Sget_simple_extent_dims (space_id, dims, maxdims); |
|
|
1403 |
|
|
1404 int nr, nc; // rows and columns |
|
|
1405 // octave uses column-major & HDF5 uses row-major |
|
|
1406 nc = dims[0]; |
|
|
1407 nr = rank > 1 ? dims[1] : 1; |
|
|
1408 |
|
|
1409 delete [] dims; |
|
|
1410 delete [] maxdims; |
|
|
1411 |
|
|
1412 Matrix m (nr, nc); |
|
|
1413 double *re = m.fortran_vec (); |
|
|
1414 if (H5Dread (data_id, H5T_NATIVE_DOUBLE, H5S_ALL, H5S_ALL, |
|
|
1415 H5P_DEFAULT, (void *) re) < 0) |
|
|
1416 retval = -1; // error |
|
|
1417 else |
|
|
1418 d->tc = m; |
|
|
1419 } |
|
|
1420 else if (rank >= 3 && d->import) |
|
|
1421 { |
|
|
1422 hsize_t *dims = new hsize_t[rank]; |
|
|
1423 hsize_t *maxdims = new hsize_t[rank]; |
|
|
1424 |
|
|
1425 H5Sget_simple_extent_dims (space_id, dims, maxdims); |
|
|
1426 |
|
|
1427 hssize_t *start = new hssize_t[rank]; |
|
|
1428 hsize_t *count = new hsize_t[rank]; |
|
|
1429 |
|
|
1430 for (hsize_t i = 0; i < rank; ++i) |
|
|
1431 { |
|
|
1432 start[i] = 0; |
|
|
1433 count[i] = 1; |
|
|
1434 } |
|
|
1435 count[0] = dims[0]; |
|
|
1436 count[1] = dims[1]; |
|
|
1437 retval = hdf5_import_multidim (data_id, space_id, |
|
|
1438 rank, dims, rank-1, |
|
|
1439 start, count, |
|
|
1440 H5T_NATIVE_DOUBLE, d->tc); |
|
|
1441 |
|
|
1442 delete [] count; |
|
|
1443 delete [] start; |
|
|
1444 delete [] dims; |
|
|
1445 delete [] maxdims; |
|
|
1446 } |
|
|
1447 else |
|
|
1448 { |
|
|
1449 warning ("load: can't read %d-dim. hdf5 dataset %s", |
|
|
1450 rank, name); |
|
|
1451 retval = 0; // skip; we can't read 3+ dimensional datasets |
|
|
1452 } |
|
|
1453 |
|
|
1454 H5Sclose (space_id); |
|
|
1455 } |
|
|
1456 else if (type_class_id == H5T_STRING) |
|
|
1457 { |
|
|
1458 // read string variable |
|
|
1459 hid_t space_id = H5Dget_space (data_id); |
|
|
1460 hsize_t rank = H5Sget_simple_extent_ndims (space_id); |
|
|
1461 |
|
|
1462 if (rank == 0) |
|
|
1463 { |
|
|
1464 // a single string: |
|
|
1465 int slen = H5Tget_size (type_id); |
|
|
1466 if (slen < 0) |
|
|
1467 retval = -1; // error |
|
|
1468 else |
|
|
1469 { |
|
|
1470 char *s = new char [slen]; |
|
|
1471 // create datatype for (null-terminated) string |
|
|
1472 // to read into: |
|
|
1473 hid_t st_id = H5Tcopy (H5T_C_S1); |
|
|
1474 H5Tset_size (st_id, slen); |
|
|
1475 if (H5Dread (data_id, st_id, H5S_ALL, H5S_ALL, |
|
|
1476 H5P_DEFAULT, (void *) s) < 0) |
|
|
1477 { |
|
|
1478 delete [] s; |
|
|
1479 retval = -1; // error |
|
|
1480 } |
|
|
1481 else |
|
|
1482 d->tc = s; |
|
|
1483 |
|
|
1484 H5Tclose (st_id); |
|
|
1485 } |
|
|
1486 } |
|
|
1487 else if (rank == 1) |
|
|
1488 { |
|
|
1489 // string vector |
|
|
1490 hsize_t elements, maxdim; |
|
|
1491 H5Sget_simple_extent_dims (space_id, &elements, &maxdim); |
|
|
1492 int slen = H5Tget_size (type_id); |
|
|
1493 if (slen < 0) |
|
|
1494 retval = -1; // error |
|
|
1495 else |
|
|
1496 { |
|
|
1497 // hdf5 string arrays store strings of all the |
|
|
1498 // same physical length (I think), which is |
|
|
1499 // slightly wasteful, but oh well. |
|
|
1500 |
|
|
1501 char *s = new char [elements * slen]; |
|
|
1502 // create datatype for (null-terminated) string |
|
|
1503 // to read into: |
|
|
1504 hid_t st_id = H5Tcopy (H5T_C_S1); |
|
|
1505 H5Tset_size (st_id, slen); |
|
|
1506 |
|
|
1507 if (H5Dread (data_id, st_id, H5S_ALL, H5S_ALL, |
|
|
1508 H5P_DEFAULT, (void *) s) < 0) |
|
|
1509 retval = -1; // error |
|
|
1510 else |
|
|
1511 { |
|
|
1512 charMatrix chm (elements, slen - 1); |
|
|
1513 for (hsize_t i = 0; i < elements; ++i) |
|
|
1514 { |
|
|
1515 chm.insert (s + i*slen, i, 0); |
|
|
1516 } |
|
|
1517 d->tc = octave_value (chm, true); |
|
|
1518 } |
|
|
1519 |
|
|
1520 delete [] s; |
|
|
1521 |
|
|
1522 H5Tclose (st_id); |
|
|
1523 } |
|
|
1524 } |
|
|
1525 else |
|
|
1526 { |
|
|
1527 warning ("load: can't read %d-dim. hdf5 string vector %s", |
|
|
1528 rank, name); |
|
|
1529 // skip; we can't read higher-dimensional string vectors |
|
|
1530 retval = 0; |
|
|
1531 } |
|
|
1532 } |
|
|
1533 else if (type_class_id == H5T_COMPOUND) |
|
|
1534 { |
|
|
1535 // check for complex or range data: |
|
|
1536 |
|
|
1537 if (hdf5_types_compatible (type_id, d->complex_type)) |
|
|
1538 { |
|
|
1539 // read complex matrix or scalar variable |
|
|
1540 |
|
|
1541 hid_t space_id = H5Dget_space (data_id); |
|
|
1542 hsize_t rank = H5Sget_simple_extent_ndims (space_id); |
|
|
1543 |
|
|
1544 if (rank == 0) |
|
|
1545 { |
|
|
1546 // complex scalar: |
|
|
1547 Complex ctmp; |
|
|
1548 if (H5Dread (data_id, d->complex_type, H5S_ALL, |
|
|
1549 H5S_ALL, H5P_DEFAULT, |
|
|
1550 (void *) X_CAST (double *, &ctmp)) < 0) |
|
|
1551 retval = -1; // error |
|
|
1552 else |
|
|
1553 d->tc = ctmp; |
|
|
1554 } |
|
|
1555 else if (rank > 0 && rank <= 2) |
|
|
1556 { |
|
|
1557 // complex matrix |
|
|
1558 hsize_t *dims = new hsize_t[rank]; |
|
|
1559 hsize_t *maxdims = new hsize_t[rank]; |
|
|
1560 H5Sget_simple_extent_dims (space_id, dims, maxdims); |
|
|
1561 int nr, nc; // rows and columns |
|
|
1562 // octave uses column-major & HDF5 uses row-major |
|
|
1563 nc = dims[0]; |
|
|
1564 nr = rank > 1 ? dims[1] : 1; |
|
|
1565 delete [] dims; |
|
|
1566 delete [] maxdims; |
|
|
1567 ComplexMatrix m (nr, nc); |
|
|
1568 Complex *reim = m.fortran_vec (); |
|
|
1569 if (H5Dread (data_id, d->complex_type, H5S_ALL, |
|
|
1570 H5S_ALL, H5P_DEFAULT, |
|
|
1571 (void *) X_CAST (double *, reim)) < 0) |
|
|
1572 retval = -1; // error |
|
|
1573 else |
|
|
1574 d->tc = m; |
|
|
1575 } |
|
|
1576 else if (rank >= 3 && d->import) |
|
|
1577 { |
|
3691
|
1578 hsize_t *dims = new hsize_t[rank]; |
|
|
1579 hsize_t *maxdims = new hsize_t[rank]; |
|
3687
|
1580 H5Sget_simple_extent_dims (space_id, dims, maxdims); |
|
|
1581 hssize_t *start = new hssize_t[rank]; |
|
|
1582 hsize_t *count = new hsize_t[rank]; |
|
|
1583 for (hsize_t i = 0; i < rank; ++i) |
|
|
1584 { |
|
|
1585 start[i] = 0; |
|
|
1586 count[i] = 1; |
|
|
1587 } |
|
|
1588 count[0] = dims[0]; |
|
|
1589 count[1] = dims[1]; |
|
|
1590 retval = hdf5_import_multidim (data_id, space_id, |
|
|
1591 rank, dims, rank-1, |
|
|
1592 start, count, |
|
|
1593 d->complex_type, |
|
|
1594 d->tc); |
|
|
1595 |
|
|
1596 delete [] count; |
|
|
1597 delete [] start; |
|
|
1598 delete [] dims; |
|
|
1599 delete [] maxdims; |
|
|
1600 } |
|
|
1601 else |
|
|
1602 { |
|
|
1603 warning ("load: can't read %d-dim. hdf5 dataset %s", |
|
|
1604 rank, name); |
|
|
1605 // skip; we can't read 3+ dimensional datasets |
|
|
1606 retval = 0; |
|
|
1607 } |
|
|
1608 H5Sclose (space_id); |
|
|
1609 } |
|
|
1610 else if (hdf5_types_compatible (type_id, d->range_type)) |
|
|
1611 { |
|
|
1612 // read range variable: |
|
|
1613 hid_t space_id = H5Dget_space (data_id); |
|
|
1614 hsize_t rank = H5Sget_simple_extent_ndims (space_id); |
|
|
1615 |
|
|
1616 if (rank == 0) |
|
|
1617 { |
|
|
1618 double rangevals[3]; |
|
|
1619 if (H5Dread (data_id, d->range_type, H5S_ALL, H5S_ALL, |
|
|
1620 H5P_DEFAULT, (void *) rangevals) < 0) |
|
|
1621 retval = -1; // error |
|
|
1622 else |
|
|
1623 { |
|
|
1624 Range r (rangevals[0], rangevals[1], rangevals[2]); |
|
|
1625 d->tc = r; |
|
|
1626 } |
|
|
1627 } |
|
|
1628 else |
|
|
1629 { |
|
|
1630 warning ("load: can't read range array `%s' in hdf5 file", |
|
|
1631 name); |
|
|
1632 // skip; we can't read arrays of range variables |
|
|
1633 retval = 0; |
|
|
1634 } |
|
|
1635 |
|
|
1636 H5Sclose (space_id); |
|
|
1637 } |
|
|
1638 else |
|
|
1639 { |
|
|
1640 warning ("load: can't read `%s' (unknown compound datatype)", |
|
|
1641 name); |
|
|
1642 retval = 0; // unknown datatype; skip. |
|
|
1643 } |
|
|
1644 } |
|
|
1645 else |
|
|
1646 { |
|
|
1647 warning ("load: can't read `%s' (unknown datatype)", name); |
|
|
1648 retval = 0; // unknown datatype; skip |
|
|
1649 } |
|
|
1650 |
|
|
1651 H5Tclose (type_id); |
|
|
1652 |
|
|
1653 // check for OCTAVE_GLOBAL attribute: |
|
3688
|
1654 d->global = hdf5_check_attr (data_id, "OCTAVE_GLOBAL"); |
|
3687
|
1655 |
|
|
1656 H5Dclose (data_id); |
|
|
1657 } |
|
|
1658 else if (info.type == H5G_GROUP && ident_valid) |
|
|
1659 { |
|
|
1660 // read in group as a list or a structure |
|
|
1661 retval = 1; |
|
|
1662 |
|
|
1663 hid_t subgroup_id = H5Gopen (group_id, name); |
|
|
1664 |
|
|
1665 if (subgroup_id < 0) |
|
|
1666 { |
|
|
1667 retval = subgroup_id; |
|
|
1668 goto done; |
|
|
1669 } |
|
|
1670 |
|
|
1671 // an HDF5 group is treated as an octave structure by |
|
|
1672 // default (since that preserves name information), and an |
|
|
1673 // octave list otherwise. |
|
|
1674 |
|
3688
|
1675 bool is_list = hdf5_check_attr (subgroup_id, "OCTAVE_LIST"); |
|
3687
|
1676 |
|
|
1677 hdf5_callback_data dsub; |
|
|
1678 dsub.name = dsub.doc = (char*) NULL; |
|
|
1679 dsub.global = 0; |
|
|
1680 dsub.complex_type = d->complex_type; |
|
|
1681 dsub.range_type = d->range_type; |
|
|
1682 dsub.import = d->import; |
|
|
1683 |
|
|
1684 herr_t retval2; |
|
|
1685 octave_value_list lst; |
|
|
1686 Octave_map m; |
|
|
1687 int current_item = 0; |
|
|
1688 while ((retval2 = H5Giterate (group_id, name, ¤t_item, |
|
|
1689 hdf5_read_next_data, &dsub)) > 0) |
|
|
1690 { |
|
|
1691 if (is_list) |
|
|
1692 lst.append (dsub.tc); |
|
|
1693 else |
|
|
1694 m [dsub.name] = dsub.tc; |
|
|
1695 |
|
|
1696 if (dsub.name) |
|
|
1697 delete [] dsub.name; |
|
|
1698 |
|
|
1699 if (dsub.doc) |
|
|
1700 delete [] dsub.doc; |
|
|
1701 |
|
3695
|
1702 if (have_h5giterate_bug) |
|
|
1703 current_item++; // H5Giterate returned the last index processed |
|
3687
|
1704 } |
|
|
1705 |
|
|
1706 if (retval2 < 0) |
|
|
1707 retval = retval2; |
|
|
1708 else |
|
|
1709 { |
|
3688
|
1710 d->global = hdf5_check_attr (group_id, "OCTAVE_GLOBAL"); |
|
3687
|
1711 |
|
|
1712 if (is_list) |
|
|
1713 d->tc = lst; |
|
|
1714 else |
|
|
1715 d->tc = m; |
|
|
1716 } |
|
|
1717 |
|
|
1718 H5Gclose (subgroup_id); |
|
|
1719 } |
|
|
1720 else if (! ident_valid) |
|
|
1721 { |
|
|
1722 // should we attempt to handle invalid identifiers by converting |
|
|
1723 // bad characters to '_', say? |
|
|
1724 warning ("load: skipping invalid identifier `%s' in hdf5 file", |
|
|
1725 name); |
|
|
1726 } |
|
|
1727 |
|
|
1728 done: |
|
|
1729 |
|
|
1730 if (retval < 0) |
|
|
1731 error ("load: error while reading hdf5 item %s", name); |
|
|
1732 |
|
|
1733 if (retval > 0) |
|
|
1734 { |
|
|
1735 // get documentation string, if any: |
|
|
1736 int comment_length = H5Gget_comment (group_id, name, 0, NULL); |
|
|
1737 |
|
|
1738 if (comment_length > 1) |
|
|
1739 { |
|
|
1740 d->doc = new char[comment_length]; |
|
|
1741 H5Gget_comment (group_id, name, comment_length, d->doc); |
|
|
1742 } |
|
|
1743 else if (strcmp (name, vname) != 0) |
|
|
1744 { |
|
|
1745 // the name was changed by import; store the original name |
|
|
1746 // as the documentation string: |
|
|
1747 d->doc = new char [strlen (name) + 1]; |
|
|
1748 strcpy (d->doc, name); |
|
|
1749 } |
|
|
1750 else |
|
|
1751 d->doc = (char *) NULL; |
|
|
1752 |
|
|
1753 // copy name (actually, vname): |
|
|
1754 d->name = new char [strlen (vname) + 1]; |
|
|
1755 strcpy (d->name, vname); |
|
|
1756 } |
|
|
1757 |
|
|
1758 delete [] vname; |
|
|
1759 |
|
|
1760 return retval; |
|
|
1761 } |
|
|
1762 |
|
|
1763 // The following two subroutines create HDF5 representations of the way |
|
|
1764 // we will store Octave complex and range types (pairs and triplets of |
|
|
1765 // floating-point numbers, respectively). NUM_TYPE is the HDF5 numeric |
|
|
1766 // type to use for storage (e.g. H5T_NATIVE_DOUBLE to save as 'double'). |
|
|
1767 // Note that any necessary conversions are handled automatically by HDF5. |
|
|
1768 |
|
|
1769 static hid_t |
|
|
1770 hdf5_make_complex_type (hid_t num_type) |
|
|
1771 { |
|
|
1772 hid_t type_id = H5Tcreate (H5T_COMPOUND, sizeof (double) * 2); |
|
|
1773 |
|
|
1774 H5Tinsert (type_id, "real", 0 * sizeof (double), num_type); |
|
|
1775 H5Tinsert (type_id, "imag", 1 * sizeof (double), num_type); |
|
|
1776 |
|
|
1777 return type_id; |
|
|
1778 } |
|
|
1779 |
|
|
1780 static hid_t |
|
|
1781 hdf5_make_range_type (hid_t num_type) |
|
|
1782 { |
|
|
1783 hid_t type_id = H5Tcreate (H5T_COMPOUND, sizeof (double) * 3); |
|
|
1784 |
|
|
1785 H5Tinsert (type_id, "base", 0 * sizeof (double), num_type); |
|
|
1786 H5Tinsert (type_id, "limit", 1 * sizeof (double), num_type); |
|
|
1787 H5Tinsert (type_id, "increment", 2 * sizeof (double), num_type); |
|
|
1788 |
|
|
1789 return type_id; |
|
|
1790 } |
|
|
1791 |
|
|
1792 // Read the next Octave variable from the stream IS, which must really be |
|
|
1793 // an hdf5_ifstream. Return the variable value in tc, its doc string |
|
|
1794 // in doc, and whether it is global in global. The return value is |
|
|
1795 // the name of the variable, or NULL if none were found or there was |
|
|
1796 // and error. If import is true, we try extra hard to import "foreign" |
|
|
1797 // datasets (not created by Octave), although we usually do a reasonable |
|
|
1798 // job anyway. (c.f. load -import documentation.) |
|
|
1799 static char * |
|
|
1800 read_hdf5_data (std::istream& is, |
|
|
1801 const std::string& filename, bool& global, |
|
|
1802 octave_value& tc, char *&doc, bool import) |
|
|
1803 { |
|
|
1804 hdf5_ifstream& hs = (hdf5_ifstream&) is; |
|
|
1805 hdf5_callback_data d; |
|
|
1806 |
|
|
1807 d.name = (char *) NULL; |
|
|
1808 d.global = 0; |
|
|
1809 d.doc = (char *) NULL; |
|
|
1810 d.complex_type = hdf5_make_complex_type (H5T_NATIVE_DOUBLE); |
|
|
1811 d.range_type = hdf5_make_range_type (H5T_NATIVE_DOUBLE); |
|
|
1812 d.import = import; |
|
|
1813 |
|
3695
|
1814 // Versions of HDF5 prior to 1.2.2 had a bug in H5Giterate where it |
|
|
1815 // would return the index of the last item processed instead of the |
|
|
1816 // next item to be processed, forcing us to increment the index manually. |
|
|
1817 |
|
|
1818 unsigned int vers_major, vers_minor, vers_release; |
|
|
1819 |
|
|
1820 H5get_libversion (&vers_major, &vers_minor, &vers_release); |
|
|
1821 |
|
|
1822 // XXX FIXME XXX -- this test looks wrong. |
|
|
1823 have_h5giterate_bug |
|
|
1824 = (vers_major < 1 |
|
|
1825 || (vers_major == 1 && (vers_minor < 2 |
|
|
1826 || (vers_minor == 2 && vers_release < 2)))); |
|
|
1827 |
|
3687
|
1828 herr_t retval = H5Giterate (hs.file_id, "/", &hs.current_item, |
|
|
1829 hdf5_read_next_data, &d); |
|
|
1830 |
|
3695
|
1831 if (have_h5giterate_bug) |
|
|
1832 { |
|
|
1833 // H5Giterate sets current_item to the last item processed; we want |
|
|
1834 // the index of the next item (for the next call to read_hdf5_data) |
|
|
1835 |
|
|
1836 hs.current_item++; |
|
|
1837 } |
|
3687
|
1838 |
|
|
1839 if (retval > 0) |
|
|
1840 { |
|
|
1841 global = d.global; |
|
|
1842 tc = d.tc; |
|
|
1843 doc = d.doc; |
|
|
1844 } |
|
|
1845 else |
|
|
1846 { |
|
|
1847 // an error occurred (retval < 0) or there are no more datasets |
|
|
1848 // print an error message if retval < 0? |
|
|
1849 // hdf5_read_next_data already printed one, probably. |
|
|
1850 } |
|
|
1851 |
|
|
1852 H5Tclose (d.complex_type); |
|
|
1853 H5Tclose (d.range_type); |
|
|
1854 |
|
|
1855 return d.name; |
|
|
1856 } |
|
|
1857 |
|
|
1858 #endif /* HAVE_HDF5 */ |
|
|
1859 |
|
3536
|
1860 static std::string |
|
3523
|
1861 get_mat_data_input_line (std::istream& is) |
|
3216
|
1862 { |
|
3523
|
1863 std::string retval; |
|
3216
|
1864 |
|
|
1865 bool have_data = false; |
|
|
1866 |
|
|
1867 do |
|
|
1868 { |
|
|
1869 retval = ""; |
|
|
1870 |
|
|
1871 char c; |
|
|
1872 while (is.get (c)) |
|
|
1873 { |
|
|
1874 if (c == '\n') |
|
|
1875 break; |
|
|
1876 |
|
|
1877 if (c == '%' || c == '#') |
|
|
1878 { |
|
|
1879 // skip to end of line |
|
|
1880 while (is.get (c) && c != '\n') |
|
|
1881 ; |
|
|
1882 |
|
|
1883 break; |
|
|
1884 } |
|
|
1885 |
|
|
1886 if (! is.eof ()) |
|
|
1887 { |
|
|
1888 if (! have_data && c != ' ' && c != '\t') |
|
|
1889 have_data = true; |
|
|
1890 |
|
|
1891 retval += c; |
|
|
1892 } |
|
|
1893 } |
|
|
1894 } |
|
|
1895 while (! (have_data || is.eof ())); |
|
|
1896 |
|
|
1897 return retval; |
|
|
1898 } |
|
|
1899 |
|
2511
|
1900 static void |
|
3523
|
1901 get_lines_and_columns (std::istream& is, const std::string& filename, int& nr, int& nc) |
|
2511
|
1902 { |
|
3552
|
1903 std::streampos pos = is.tellg (); |
|
2511
|
1904 |
|
|
1905 int file_line_number = 0; |
|
|
1906 |
|
|
1907 nr = 0; |
|
|
1908 nc = 0; |
|
|
1909 |
|
2795
|
1910 while (is && ! error_state) |
|
2511
|
1911 { |
|
3523
|
1912 std::string buf = get_mat_data_input_line (is); |
|
2511
|
1913 |
|
|
1914 file_line_number++; |
|
|
1915 |
|
2795
|
1916 size_t beg = buf.find_first_not_of (" \t"); |
|
|
1917 |
|
3901
|
1918 // If we see a CR as the last character in the buffer, we had a |
|
|
1919 // CRLF pair as the line separator. Any other CR in the text |
|
|
1920 // will not be considered as whitespace. |
|
|
1921 |
|
|
1922 if (beg != NPOS && buf[beg] == '\r' && beg == buf.length () - 1) |
|
|
1923 { |
|
|
1924 // We had a blank line ending with a CRLF. Handle it the |
|
|
1925 // same as an empty line. |
|
|
1926 beg = NPOS; |
|
|
1927 } |
|
|
1928 |
|
2795
|
1929 int tmp_nc = 0; |
|
|
1930 |
|
|
1931 while (beg != NPOS) |
|
2511
|
1932 { |
|
2795
|
1933 tmp_nc++; |
|
|
1934 |
|
|
1935 size_t end = buf.find_first_of (" \t", beg); |
|
|
1936 |
|
|
1937 if (end != NPOS) |
|
3901
|
1938 { |
|
|
1939 beg = buf.find_first_not_of (" \t", end); |
|
|
1940 |
|
|
1941 if (buf[beg] == '\r' && beg == buf.length () - 1) |
|
|
1942 { |
|
|
1943 // We had a line with trailing spaces and |
|
|
1944 // ending with a CRLF, so this should look like EOL, |
|
|
1945 // not a new colum. |
|
|
1946 break; |
|
|
1947 } |
|
|
1948 } |
|
2795
|
1949 else |
|
|
1950 break; |
|
|
1951 } |
|
|
1952 |
|
|
1953 if (tmp_nc > 0) |
|
|
1954 { |
|
2511
|
1955 if (nc == 0) |
|
|
1956 { |
|
|
1957 nc = tmp_nc; |
|
|
1958 nr++; |
|
|
1959 } |
|
|
1960 else if (nc == tmp_nc) |
|
|
1961 nr++; |
|
|
1962 else |
|
|
1963 error ("load: %s: inconsistent number of columns near line %d", |
|
|
1964 filename.c_str (), file_line_number); |
|
|
1965 } |
|
|
1966 } |
|
|
1967 |
|
|
1968 if (nr == 0 || nc == 0) |
|
|
1969 error ("load: file `%s' seems to be empty!", filename.c_str ()); |
|
|
1970 |
|
|
1971 is.clear (); |
|
3538
|
1972 is.seekg (pos, std::ios::beg); |
|
2511
|
1973 } |
|
|
1974 |
|
|
1975 // Extract a matrix from a file of numbers only. |
|
|
1976 // |
|
|
1977 // Comments are not allowed. The file should only have numeric values. |
|
|
1978 // |
|
|
1979 // Reads the file twice. Once to find the number of rows and columns, |
|
|
1980 // and once to extract the matrix. |
|
|
1981 // |
|
|
1982 // FILENAME is used for error messages. |
|
|
1983 // |
|
|
1984 // This format provides no way to tag the data as global. |
|
|
1985 |
|
|
1986 static char * |
|
3523
|
1987 read_mat_ascii_data (std::istream& is, const std::string& filename, |
|
2511
|
1988 octave_value& tc) |
|
|
1989 { |
|
|
1990 char *name = 0; |
|
|
1991 |
|
3523
|
1992 std::string varname; |
|
2511
|
1993 |
|
3202
|
1994 size_t pos = filename.rfind ('/'); |
|
2511
|
1995 |
|
|
1996 if (pos != NPOS) |
|
3202
|
1997 varname = filename.substr (pos+1); |
|
2511
|
1998 else |
|
|
1999 varname = filename; |
|
|
2000 |
|
3202
|
2001 pos = varname.find ('.'); |
|
|
2002 |
|
|
2003 if (pos != NPOS) |
|
|
2004 varname = varname.substr (0, pos); |
|
|
2005 |
|
3263
|
2006 if (valid_identifier (varname)) |
|
2511
|
2007 { |
|
|
2008 int nr = 0; |
|
|
2009 int nc = 0; |
|
|
2010 |
|
|
2011 get_lines_and_columns (is, filename, nr, nc); |
|
|
2012 |
|
2795
|
2013 if (! error_state && nr > 0 && nc > 0) |
|
2511
|
2014 { |
|
|
2015 Matrix tmp (nr, nc); |
|
|
2016 |
|
3216
|
2017 if (nr < 1 || nc < 1) |
|
3538
|
2018 is.clear (std::ios::badbit); |
|
3216
|
2019 else |
|
|
2020 { |
|
|
2021 double d; |
|
|
2022 for (int i = 0; i < nr; i++) |
|
|
2023 { |
|
3523
|
2024 std::string buf = get_mat_data_input_line (is); |
|
|
2025 |
|
|
2026 std::istrstream tmp_stream (buf.c_str ()); |
|
3216
|
2027 |
|
|
2028 for (int j = 0; j < nc; j++) |
|
|
2029 { |
|
|
2030 tmp_stream >> d; |
|
3323
|
2031 |
|
|
2032 if (tmp_stream) |
|
3216
|
2033 tmp.elem (i, j) = d; |
|
|
2034 else |
|
3323
|
2035 { |
|
|
2036 error ("load: failed to read matrix from file `%s'", |
|
|
2037 filename.c_str ()); |
|
|
2038 |
|
|
2039 return name; |
|
|
2040 } |
|
|
2041 |
|
3216
|
2042 } |
|
|
2043 } |
|
|
2044 } |
|
|
2045 |
|
2511
|
2046 if (is) |
|
|
2047 { |
|
|
2048 tc = tmp; |
|
|
2049 |
|
|
2050 name = strsave (varname.c_str ()); |
|
|
2051 } |
|
|
2052 else |
|
|
2053 error ("load: failed to read matrix from file `%s'", |
|
|
2054 filename.c_str ()); |
|
|
2055 } |
|
|
2056 else |
|
|
2057 error ("load: unable to extract matrix size from file `%s'", |
|
|
2058 filename.c_str ()); |
|
|
2059 } |
|
|
2060 else |
|
|
2061 error ("load: unable to convert filename `%s' to valid identifier", |
|
|
2062 filename.c_str ()); |
|
|
2063 |
|
|
2064 return name; |
|
|
2065 } |
|
|
2066 |
|
604
|
2067 // Read LEN elements of data from IS in the format specified by |
|
3019
|
2068 // PRECISION, placing the result in DATA. If SWAP is TRUE, swap |
|
604
|
2069 // the bytes of each element before copying to DATA. FLT_FMT |
|
|
2070 // specifies the format of the data if we are reading floating point |
|
|
2071 // numbers. |
|
|
2072 |
|
|
2073 static void |
|
3523
|
2074 read_mat_binary_data (std::istream& is, double *data, int precision, |
|
3019
|
2075 int len, bool swap, |
|
2318
|
2076 oct_mach_info::float_format flt_fmt) |
|
604
|
2077 { |
|
|
2078 switch (precision) |
|
|
2079 { |
|
|
2080 case 0: |
|
630
|
2081 read_doubles (is, data, LS_DOUBLE, len, swap, flt_fmt); |
|
604
|
2082 break; |
|
|
2083 |
|
|
2084 case 1: |
|
630
|
2085 read_doubles (is, data, LS_FLOAT, len, swap, flt_fmt); |
|
604
|
2086 break; |
|
|
2087 |
|
|
2088 case 2: |
|
|
2089 read_doubles (is, data, LS_INT, len, swap, flt_fmt); |
|
|
2090 break; |
|
|
2091 |
|
|
2092 case 3: |
|
|
2093 read_doubles (is, data, LS_SHORT, len, swap, flt_fmt); |
|
|
2094 break; |
|
|
2095 |
|
|
2096 case 4: |
|
|
2097 read_doubles (is, data, LS_U_SHORT, len, swap, flt_fmt); |
|
|
2098 break; |
|
|
2099 |
|
|
2100 case 5: |
|
|
2101 read_doubles (is, data, LS_U_CHAR, len, swap, flt_fmt); |
|
|
2102 break; |
|
|
2103 |
|
|
2104 default: |
|
|
2105 break; |
|
|
2106 } |
|
|
2107 } |
|
|
2108 |
|
|
2109 static int |
|
3523
|
2110 read_mat_file_header (std::istream& is, bool& swap, FOUR_BYTE_INT& mopt, |
|
604
|
2111 FOUR_BYTE_INT& nr, FOUR_BYTE_INT& nc, |
|
|
2112 FOUR_BYTE_INT& imag, FOUR_BYTE_INT& len, |
|
|
2113 int quiet = 0) |
|
|
2114 { |
|
3019
|
2115 swap = false; |
|
671
|
2116 |
|
1358
|
2117 // We expect to fail here, at the beginning of a record, so not |
|
|
2118 // being able to read another mopt value should not result in an |
|
|
2119 // error. |
|
911
|
2120 |
|
3557
|
2121 is.read (X_CAST (char *, &mopt), 4); |
|
604
|
2122 if (! is) |
|
911
|
2123 return 1; |
|
604
|
2124 |
|
3557
|
2125 if (! is.read (X_CAST (char *, &nr), 4)) |
|
604
|
2126 goto data_read_error; |
|
|
2127 |
|
3557
|
2128 if (! is.read (X_CAST (char *, &nc), 4)) |
|
604
|
2129 goto data_read_error; |
|
|
2130 |
|
3557
|
2131 if (! is.read (X_CAST (char *, &imag), 4)) |
|
604
|
2132 goto data_read_error; |
|
|
2133 |
|
3557
|
2134 if (! is.read (X_CAST (char *, &len), 4)) |
|
604
|
2135 goto data_read_error; |
|
|
2136 |
|
|
2137 // If mopt is nonzero and the byte order is swapped, mopt will be |
|
|
2138 // bigger than we expect, so we swap bytes. |
|
|
2139 // |
|
|
2140 // If mopt is zero, it means the file was written on a little endian |
|
|
2141 // machine, and we only need to swap if we are running on a big endian |
|
|
2142 // machine. |
|
|
2143 // |
|
|
2144 // Gag me. |
|
|
2145 |
|
2318
|
2146 if (oct_mach_info::words_big_endian () && mopt == 0) |
|
3019
|
2147 swap = true; |
|
604
|
2148 |
|
1358
|
2149 // mopt is signed, therefore byte swap may result in negative value. |
|
911
|
2150 |
|
|
2151 if (mopt > 9999 || mopt < 0) |
|
3019
|
2152 swap = true; |
|
604
|
2153 |
|
|
2154 if (swap) |
|
|
2155 { |
|
3145
|
2156 swap_4_bytes (X_CAST (char *, &mopt)); |
|
|
2157 swap_4_bytes (X_CAST (char *, &nr)); |
|
|
2158 swap_4_bytes (X_CAST (char *, &nc)); |
|
|
2159 swap_4_bytes (X_CAST (char *, &imag)); |
|
|
2160 swap_4_bytes (X_CAST (char *, &len)); |
|
604
|
2161 } |
|
|
2162 |
|
911
|
2163 if (mopt > 9999 || mopt < 0 || imag > 1 || imag < 0) |
|
604
|
2164 { |
|
|
2165 if (! quiet) |
|
|
2166 error ("load: can't read binary file"); |
|
|
2167 return -1; |
|
|
2168 } |
|
|
2169 |
|
|
2170 return 0; |
|
|
2171 |
|
|
2172 data_read_error: |
|
|
2173 return -1; |
|
|
2174 } |
|
|
2175 |
|
617
|
2176 // We don't just use a cast here, because we need to be able to detect |
|
|
2177 // possible errors. |
|
|
2178 |
|
2318
|
2179 static oct_mach_info::float_format |
|
|
2180 mopt_digit_to_float_format (int mach) |
|
617
|
2181 { |
|
2318
|
2182 oct_mach_info::float_format flt_fmt = oct_mach_info::unknown; |
|
619
|
2183 |
|
617
|
2184 switch (mach) |
|
|
2185 { |
|
|
2186 case 0: |
|
2318
|
2187 flt_fmt = oct_mach_info::ieee_little_endian; |
|
617
|
2188 break; |
|
|
2189 |
|
|
2190 case 1: |
|
2318
|
2191 flt_fmt = oct_mach_info::ieee_big_endian; |
|
617
|
2192 break; |
|
|
2193 |
|
|
2194 case 2: |
|
2318
|
2195 flt_fmt = oct_mach_info::vax_d; |
|
617
|
2196 break; |
|
|
2197 |
|
|
2198 case 3: |
|
2318
|
2199 flt_fmt = oct_mach_info::vax_g; |
|
617
|
2200 break; |
|
|
2201 |
|
|
2202 case 4: |
|
2318
|
2203 flt_fmt = oct_mach_info::cray; |
|
617
|
2204 break; |
|
|
2205 |
|
|
2206 default: |
|
2318
|
2207 flt_fmt = oct_mach_info::unknown; |
|
617
|
2208 break; |
|
|
2209 } |
|
619
|
2210 |
|
|
2211 return flt_fmt; |
|
617
|
2212 } |
|
619
|
2213 |
|
2318
|
2214 static int |
|
|
2215 float_format_to_mopt_digit (oct_mach_info::float_format flt_fmt) |
|
|
2216 { |
|
|
2217 int retval = -1; |
|
|
2218 |
|
|
2219 switch (flt_fmt) |
|
|
2220 { |
|
|
2221 case oct_mach_info::ieee_little_endian: |
|
|
2222 retval = 0; |
|
|
2223 break; |
|
|
2224 |
|
|
2225 case oct_mach_info::ieee_big_endian: |
|
|
2226 retval = 1; |
|
|
2227 break; |
|
|
2228 |
|
|
2229 case oct_mach_info::vax_d: |
|
|
2230 retval = 2; |
|
|
2231 break; |
|
|
2232 |
|
|
2233 case oct_mach_info::vax_g: |
|
|
2234 retval = 3; |
|
|
2235 break; |
|
|
2236 |
|
|
2237 case oct_mach_info::cray: |
|
|
2238 retval = 4; |
|
|
2239 break; |
|
|
2240 |
|
|
2241 default: |
|
|
2242 break; |
|
|
2243 } |
|
|
2244 |
|
|
2245 return retval; |
|
|
2246 } |
|
|
2247 |
|
604
|
2248 // Extract one value (scalar, matrix, string, etc.) from stream IS and |
|
|
2249 // place it in TC, returning the name of the variable. |
|
|
2250 // |
|
3688
|
2251 // The data is expected to be in Matlab version 4 .mat format, though |
|
|
2252 // not all the features of that format are supported. |
|
604
|
2253 // |
|
|
2254 // FILENAME is used for error messages. |
|
|
2255 // |
|
|
2256 // This format provides no way to tag the data as global. |
|
|
2257 |
|
|
2258 static char * |
|
3523
|
2259 read_mat_binary_data (std::istream& is, const std::string& filename, |
|
2086
|
2260 octave_value& tc) |
|
604
|
2261 { |
|
1358
|
2262 // These are initialized here instead of closer to where they are |
|
|
2263 // first used to avoid errors from gcc about goto crossing |
|
|
2264 // initialization of variable. |
|
604
|
2265 |
|
|
2266 Matrix re; |
|
2318
|
2267 oct_mach_info::float_format flt_fmt = oct_mach_info::unknown; |
|
604
|
2268 char *name = 0; |
|
3019
|
2269 bool swap = false; |
|
|
2270 int type = 0; |
|
|
2271 int prec = 0; |
|
3136
|
2272 int order = 0; |
|
3019
|
2273 int mach = 0; |
|
|
2274 int dlen = 0; |
|
604
|
2275 |
|
|
2276 FOUR_BYTE_INT mopt, nr, nc, imag, len; |
|
|
2277 |
|
|
2278 int err = read_mat_file_header (is, swap, mopt, nr, nc, imag, len); |
|
|
2279 if (err) |
|
|
2280 { |
|
|
2281 if (err < 0) |
|
|
2282 goto data_read_error; |
|
|
2283 else |
|
|
2284 return 0; |
|
|
2285 } |
|
|
2286 |
|
3136
|
2287 type = mopt % 10; // Full, sparse, etc. |
|
|
2288 mopt /= 10; // Eliminate first digit. |
|
|
2289 prec = mopt % 10; // double, float, int, etc. |
|
|
2290 mopt /= 10; // Eliminate second digit. |
|
|
2291 order = mopt % 10; // Row or column major ordering. |
|
|
2292 mopt /= 10; // Eliminate third digit. |
|
|
2293 mach = mopt % 10; // IEEE, VAX, etc. |
|
604
|
2294 |
|
2318
|
2295 flt_fmt = mopt_digit_to_float_format (mach); |
|
|
2296 |
|
|
2297 if (flt_fmt == oct_mach_info::unknown) |
|
604
|
2298 { |
|
|
2299 error ("load: unrecognized binary format!"); |
|
|
2300 return 0; |
|
|
2301 } |
|
|
2302 |
|
|
2303 if (type != 0 && type != 1) |
|
|
2304 { |
|
|
2305 error ("load: can't read sparse matrices"); |
|
|
2306 return 0; |
|
|
2307 } |
|
|
2308 |
|
|
2309 if (imag && type == 1) |
|
|
2310 { |
|
|
2311 error ("load: encountered complex matrix with string flag set!"); |
|
|
2312 return 0; |
|
|
2313 } |
|
|
2314 |
|
2345
|
2315 // LEN includes the terminating character, and the file is also |
|
2436
|
2316 // supposed to include it, but apparently not all files do. Either |
|
|
2317 // way, I think this should work. |
|
2345
|
2318 |
|
2436
|
2319 name = new char [len+1]; |
|
3557
|
2320 if (! is.read (X_CAST (char *, name), len)) |
|
604
|
2321 goto data_read_error; |
|
2436
|
2322 name[len] = '\0'; |
|
604
|
2323 |
|
|
2324 dlen = nr * nc; |
|
|
2325 if (dlen < 0) |
|
|
2326 goto data_read_error; |
|
|
2327 |
|
3136
|
2328 if (order) |
|
|
2329 { |
|
|
2330 int tmp = nr; |
|
|
2331 nr = nc; |
|
|
2332 nc = tmp; |
|
|
2333 } |
|
|
2334 |
|
604
|
2335 re.resize (nr, nc); |
|
|
2336 |
|
|
2337 read_mat_binary_data (is, re.fortran_vec (), prec, dlen, swap, flt_fmt); |
|
|
2338 |
|
|
2339 if (! is || error_state) |
|
|
2340 { |
|
|
2341 error ("load: reading matrix data for `%s'", name); |
|
|
2342 goto data_read_error; |
|
|
2343 } |
|
|
2344 |
|
|
2345 if (imag) |
|
|
2346 { |
|
|
2347 Matrix im (nr, nc); |
|
|
2348 |
|
|
2349 read_mat_binary_data (is, im.fortran_vec (), prec, dlen, swap, flt_fmt); |
|
|
2350 |
|
|
2351 if (! is || error_state) |
|
|
2352 { |
|
|
2353 error ("load: reading imaginary matrix data for `%s'", name); |
|
|
2354 goto data_read_error; |
|
|
2355 } |
|
|
2356 |
|
|
2357 ComplexMatrix ctmp (nr, nc); |
|
|
2358 |
|
|
2359 for (int j = 0; j < nc; j++) |
|
|
2360 for (int i = 0; i < nr; i++) |
|
2305
|
2361 ctmp (i, j) = Complex (re (i, j), im (i, j)); |
|
604
|
2362 |
|
3136
|
2363 tc = order ? ctmp.transpose () : ctmp; |
|
604
|
2364 } |
|
|
2365 else |
|
3136
|
2366 tc = order ? re.transpose () : re; |
|
604
|
2367 |
|
1427
|
2368 if (type == 1) |
|
604
|
2369 tc = tc.convert_to_str (); |
|
|
2370 |
|
|
2371 return name; |
|
|
2372 |
|
|
2373 data_read_error: |
|
1755
|
2374 error ("load: trouble reading binary file `%s'", filename.c_str ()); |
|
604
|
2375 delete [] name; |
|
|
2376 return 0; |
|
|
2377 } |
|
|
2378 |
|
3688
|
2379 // Read COUNT elements of data from IS in the format specified by TYPE, |
|
|
2380 // placing the result in DATA. If SWAP is TRUE, swap the bytes of |
|
|
2381 // each element before copying to DATA. FLT_FMT specifies the format |
|
|
2382 // of the data if we are reading floating point numbers. |
|
|
2383 |
|
|
2384 static void |
|
|
2385 read_mat5_binary_data (std::istream& is, double *data, |
|
|
2386 int count, bool swap, mat5_data_type type, |
|
|
2387 oct_mach_info::float_format flt_fmt) |
|
|
2388 { |
|
|
2389 |
|
|
2390 switch (type) |
|
|
2391 { |
|
|
2392 case miINT8: |
|
|
2393 read_doubles (is, data, LS_CHAR, count, swap, flt_fmt); |
|
|
2394 break; |
|
|
2395 |
|
|
2396 case miUINT8: |
|
|
2397 read_doubles (is, data, LS_U_CHAR, count, swap, flt_fmt); |
|
|
2398 break; |
|
|
2399 |
|
|
2400 case miINT16: |
|
|
2401 read_doubles (is, data, LS_SHORT, count, swap, flt_fmt); |
|
|
2402 break; |
|
|
2403 |
|
|
2404 case miUINT16: |
|
|
2405 read_doubles (is, data, LS_U_SHORT, count, swap, flt_fmt); |
|
|
2406 break; |
|
|
2407 |
|
|
2408 case miINT32: |
|
|
2409 read_doubles (is, data, LS_INT, count, swap, flt_fmt); |
|
|
2410 break; |
|
|
2411 |
|
|
2412 case miUINT32: |
|
|
2413 read_doubles (is, data, LS_U_INT, count, swap, flt_fmt); |
|
|
2414 break; |
|
|
2415 |
|
|
2416 case miSINGLE: |
|
|
2417 read_doubles (is, data, LS_FLOAT, count, swap, flt_fmt); |
|
|
2418 break; |
|
|
2419 |
|
|
2420 case miRESERVE1: |
|
|
2421 break; |
|
|
2422 |
|
|
2423 case miDOUBLE: |
|
|
2424 read_doubles (is, data, LS_DOUBLE, count, swap, flt_fmt); |
|
|
2425 break; |
|
|
2426 |
|
|
2427 case miRESERVE2: |
|
|
2428 case miRESERVE3: |
|
|
2429 break; |
|
|
2430 |
|
|
2431 case miINT64: |
|
|
2432 #ifdef EIGHT_BYTE_INT |
|
|
2433 read_doubles (is, data, LS_LONG, count, swap, flt_fmt); |
|
|
2434 #endif |
|
|
2435 break; |
|
|
2436 |
|
|
2437 case miUINT64: |
|
|
2438 #ifdef EIGHT_BYTE_INT |
|
|
2439 read_doubles (is, data, LS_U_LONG, count, swap, flt_fmt); |
|
|
2440 #endif |
|
|
2441 break; |
|
|
2442 |
|
|
2443 case miMATRIX: |
|
|
2444 default: |
|
|
2445 break; |
|
|
2446 } |
|
|
2447 } |
|
|
2448 |
|
|
2449 // Read one element tag from stream IS, |
|
|
2450 // place the type code in TYPE and the byte count in BYTES |
|
|
2451 // return nonzero on error |
|
|
2452 static int |
|
|
2453 read_mat5_tag (std::istream& is, bool swap, int& type, int& bytes) |
|
|
2454 { |
|
|
2455 unsigned int upper; |
|
|
2456 FOUR_BYTE_INT temp; |
|
|
2457 |
|
|
2458 if (! is.read (X_CAST (char *, &temp), 4 )) |
|
|
2459 goto data_read_error; |
|
|
2460 |
|
|
2461 if (swap) |
|
|
2462 swap_4_bytes ((char *)&temp); |
|
|
2463 |
|
|
2464 upper = (temp >> 16) & 0xffff; |
|
|
2465 type = temp & 0xffff; |
|
|
2466 |
|
|
2467 if (upper) |
|
|
2468 { |
|
|
2469 // "compressed" format |
|
|
2470 bytes = upper; |
|
|
2471 } |
|
|
2472 else |
|
|
2473 { |
|
|
2474 if (! is.read (X_CAST (char *, &temp), 4 )) |
|
|
2475 goto data_read_error; |
|
|
2476 if (swap) |
|
|
2477 swap_4_bytes ((char *)&temp); |
|
|
2478 bytes = temp; |
|
|
2479 } |
|
|
2480 |
|
|
2481 return 0; |
|
|
2482 |
|
|
2483 data_read_error: |
|
|
2484 return 1; |
|
|
2485 } |
|
|
2486 |
|
|
2487 // Extract one data element (scalar, matrix, string, etc.) from stream |
|
|
2488 // IS and place it in TC, returning the name of the variable. |
|
|
2489 // |
|
|
2490 // The data is expected to be in Matlab's "Version 5" .mat format, |
|
|
2491 // though not all the features of that format are supported. |
|
|
2492 // |
|
|
2493 // FILENAME is used for error messages. |
|
|
2494 |
|
|
2495 static char * |
|
|
2496 read_mat5_binary_element (std::istream& is, const std::string& filename, |
|
|
2497 bool swap, bool& global, octave_value& tc) |
|
|
2498 { |
|
|
2499 // These are initialized here instead of closer to where they are |
|
|
2500 // first used to avoid errors from gcc about goto crossing |
|
|
2501 // initialization of variable. |
|
|
2502 |
|
|
2503 Matrix re; |
|
|
2504 oct_mach_info::float_format flt_fmt = oct_mach_info::unknown; |
|
|
2505 char *name = 0; |
|
|
2506 int type = 0; |
|
|
2507 bool imag; |
|
|
2508 bool logicalvar; |
|
|
2509 enum arrayclasstype arrayclass; |
|
|
2510 FOUR_BYTE_INT junk; |
|
|
2511 FOUR_BYTE_INT flags; |
|
|
2512 FOUR_BYTE_INT nr; |
|
|
2513 FOUR_BYTE_INT nc; |
|
|
2514 FOUR_BYTE_INT dimension_length; |
|
|
2515 int len; |
|
|
2516 int element_length; |
|
|
2517 std::streampos pos; |
|
|
2518 TWO_BYTE_INT number; |
|
|
2519 number = *(TWO_BYTE_INT *)"\x00\x01"; |
|
|
2520 |
|
|
2521 // MAT files always use IEEE floating point |
|
|
2522 if ((number == 1) ^ swap) |
|
|
2523 flt_fmt = oct_mach_info::ieee_big_endian; |
|
|
2524 else |
|
|
2525 flt_fmt = oct_mach_info::ieee_little_endian; |
|
|
2526 |
|
|
2527 // element type and length |
|
|
2528 if (read_mat5_tag (is, swap, type, element_length)) |
|
|
2529 return 0; // EOF |
|
|
2530 |
|
|
2531 if (type != miMATRIX) |
|
|
2532 { |
|
|
2533 error ("load: invalid element type"); |
|
|
2534 goto early_read_error; |
|
|
2535 } |
|
|
2536 pos = is.tellg (); |
|
|
2537 |
|
|
2538 // array flags subelement |
|
|
2539 if (read_mat5_tag (is, swap, type, len) || type != miUINT32 || len != 8) |
|
|
2540 { |
|
|
2541 error ("load: invalid array flags subelement"); |
|
|
2542 goto early_read_error; |
|
|
2543 } |
|
|
2544 |
|
|
2545 read_int (is, swap, flags); |
|
|
2546 imag = (flags & 0x0800) != 0; // has an imaginary part? |
|
|
2547 global = (flags & 0x0400) != 0; // global variable? |
|
|
2548 logicalvar = (flags & 0x0200) != 0; // we don't use this yet |
|
|
2549 arrayclass = (arrayclasstype)(flags & 0xff); |
|
|
2550 read_int (is, swap, junk); // an "undefined" entry |
|
|
2551 |
|
|
2552 // dimensions array subelement |
|
|
2553 { |
|
|
2554 std::streampos pos; |
|
|
2555 |
|
|
2556 if (read_mat5_tag (is, swap, type, dimension_length) || type != miINT32) |
|
|
2557 { |
|
|
2558 error ("load: invalid dimensions array subelement"); |
|
|
2559 goto early_read_error; |
|
|
2560 } |
|
|
2561 |
|
|
2562 pos = is.tellg (); |
|
|
2563 read_int (is, swap, nr); |
|
|
2564 read_int (is, swap, nc); |
|
|
2565 re.resize (nr, nc); |
|
|
2566 |
|
|
2567 // delay checking for a multidimensional array until we have read |
|
|
2568 // the variable name |
|
3812
|
2569 is.seekg (pos + static_cast<std::streamoff> (dimension_length)); |
|
3688
|
2570 } |
|
|
2571 |
|
|
2572 // array name subelement |
|
|
2573 { |
|
|
2574 std::streampos pos; |
|
|
2575 |
|
|
2576 if (read_mat5_tag (is, swap, type, len) || type != miINT8) |
|
|
2577 { |
|
|
2578 error ("load: invalid array name subelement"); |
|
|
2579 goto early_read_error; |
|
|
2580 } |
|
|
2581 |
|
|
2582 pos = is.tellg (); |
|
|
2583 name = new char[len+1]; |
|
|
2584 |
|
|
2585 if (len) // structure field subelements have |
|
|
2586 // zero-length array name subelements |
|
|
2587 { |
|
|
2588 if (! is.read (X_CAST (char *, name), len )) |
|
|
2589 goto data_read_error; |
|
|
2590 |
|
3812
|
2591 is.seekg (pos + static_cast<std::streamoff> (PAD (len))); |
|
3688
|
2592 } |
|
|
2593 |
|
|
2594 name[len] = '\0'; |
|
|
2595 } |
|
|
2596 |
|
|
2597 if (dimension_length != 8) |
|
|
2598 { |
|
|
2599 error ("load: multidimension arrays are not implemented"); |
|
|
2600 goto skip_ahead; |
|
|
2601 } |
|
|
2602 |
|
|
2603 switch (arrayclass) |
|
|
2604 { |
|
|
2605 case mxCELL_CLASS: |
|
|
2606 warning ("load: cell arrays are not implemented"); |
|
|
2607 goto skip_ahead; |
|
|
2608 |
|
|
2609 case mxOBJECT_CLASS: |
|
|
2610 warning ("load: objects are not implemented"); |
|
|
2611 goto skip_ahead; |
|
|
2612 |
|
|
2613 case mxSPARSE_CLASS: |
|
|
2614 warning ("load: sparse arrays are not implemented"); |
|
|
2615 goto skip_ahead; |
|
|
2616 |
|
|
2617 case mxSTRUCT_CLASS: |
|
|
2618 { |
|
|
2619 Octave_map m; |
|
|
2620 FOUR_BYTE_INT type; |
|
|
2621 FOUR_BYTE_INT len; |
|
|
2622 FOUR_BYTE_INT field_name_length; |
|
|
2623 int i; |
|
|
2624 char *elname; |
|
|
2625 |
|
|
2626 // field name length subelement -- actually the maximum length |
|
|
2627 // of a field name. The Matlab docs promise this will always |
|
|
2628 // be 32. We read and use the actual value, on the theory |
|
|
2629 // that eventually someone will recognize that's a waste of |
|
|
2630 // space. |
|
|
2631 if (read_mat5_tag (is, swap, type, len) || type != miINT32) |
|
|
2632 { |
|
|
2633 error ("load: invalid field name subelement"); |
|
|
2634 goto data_read_error; |
|
|
2635 } |
|
|
2636 |
|
|
2637 if (! is.read (X_CAST (char *, &field_name_length), len )) |
|
|
2638 goto data_read_error; |
|
|
2639 |
|
|
2640 if (swap) |
|
|
2641 swap_4_bytes ((char *)&field_name_length); |
|
|
2642 |
|
|
2643 // field name subelement. The length of this subelement tells |
|
|
2644 // us how many fields there are. |
|
|
2645 if (read_mat5_tag (is, swap, type, len) || type != miINT8) |
|
|
2646 { |
|
|
2647 error ("load: invalid field name subelement"); |
|
|
2648 goto data_read_error; |
|
|
2649 } |
|
|
2650 |
|
|
2651 elname = new char[len]; |
|
|
2652 |
|
|
2653 if (! is.read (elname, len)) |
|
|
2654 goto data_read_error; |
|
|
2655 |
|
|
2656 // fields subelements |
|
|
2657 for (i=0; i < len/field_name_length; i++) |
|
|
2658 { |
|
|
2659 char *thename; |
|
|
2660 octave_value fieldtc; |
|
|
2661 thename = read_mat5_binary_element (is, filename, swap, |
|
|
2662 global, fieldtc); |
|
|
2663 m[elname + i*field_name_length] = fieldtc; |
|
|
2664 delete [] thename; |
|
|
2665 } |
|
|
2666 |
|
|
2667 delete [] elname; |
|
|
2668 tc = m; |
|
|
2669 } |
|
|
2670 break; |
|
|
2671 |
|
|
2672 case mxCHAR_CLASS: |
|
|
2673 // handle as a numerical array to start with |
|
|
2674 |
|
|
2675 case mxDOUBLE_CLASS: |
|
|
2676 case mxSINGLE_CLASS: |
|
|
2677 case mxINT8_CLASS: |
|
|
2678 case mxUINT8_CLASS: |
|
|
2679 case mxINT16_CLASS: |
|
|
2680 case mxUINT16_CLASS: |
|
|
2681 case mxINT32_CLASS: |
|
|
2682 case mxUINT32_CLASS: |
|
|
2683 default: |
|
|
2684 // handle all these numerical formats as double arrays |
|
|
2685 |
|
|
2686 // real data subelement |
|
|
2687 { |
|
|
2688 std::streampos pos; |
|
|
2689 |
|
|
2690 if (read_mat5_tag (is, swap, type, len)) |
|
|
2691 { |
|
|
2692 error ("load: reading matrix data for `%s'", name); |
|
|
2693 goto data_read_error; |
|
|
2694 } |
|
|
2695 |
|
|
2696 pos = is.tellg (); |
|
|
2697 read_mat5_binary_data (is, re.fortran_vec (), nr*nc, swap, |
|
|
2698 (enum mat5_data_type) type, flt_fmt); |
|
|
2699 |
|
|
2700 if (! is || error_state) |
|
|
2701 { |
|
|
2702 error ("load: reading matrix data for `%s'", name); |
|
|
2703 goto data_read_error; |
|
|
2704 } |
|
|
2705 |
|
3812
|
2706 is.seekg (pos + static_cast<std::streamoff> (PAD (len))); |
|
3688
|
2707 } |
|
|
2708 |
|
|
2709 // imaginary data subelement |
|
|
2710 if (imag) |
|
|
2711 { |
|
|
2712 Matrix im (nr, nc); |
|
|
2713 |
|
|
2714 if (read_mat5_tag (is, swap, type, len)) |
|
|
2715 { |
|
|
2716 error ("load: reading matrix data for `%s'", name); |
|
|
2717 goto data_read_error; |
|
|
2718 } |
|
|
2719 |
|
|
2720 read_mat5_binary_data (is, im.fortran_vec (), nr*nc, swap, |
|
|
2721 (enum mat5_data_type) type, flt_fmt); |
|
|
2722 |
|
|
2723 if (! is || error_state) |
|
|
2724 { |
|
|
2725 error ("load: reading imaginary matrix data for `%s'", name); |
|
|
2726 goto data_read_error; |
|
|
2727 } |
|
|
2728 |
|
|
2729 ComplexMatrix ctmp (nr, nc); |
|
|
2730 |
|
|
2731 for (int j = 0; j < nc; j++) |
|
|
2732 for (int i = 0; i < nr; i++) |
|
|
2733 ctmp (i, j) = Complex (re (i, j), im (i, j)); |
|
|
2734 |
|
|
2735 tc = ctmp; |
|
|
2736 } |
|
|
2737 else |
|
|
2738 tc = re; |
|
|
2739 |
|
|
2740 if (arrayclass == mxCHAR_CLASS) |
|
|
2741 tc = tc.convert_to_str (); |
|
|
2742 } |
|
|
2743 |
|
3812
|
2744 is.seekg (pos + static_cast<std::streamoff> (element_length)); |
|
3688
|
2745 |
|
|
2746 return name; |
|
|
2747 |
|
|
2748 data_read_error: |
|
|
2749 delete [] name; |
|
|
2750 |
|
|
2751 early_read_error: |
|
|
2752 error ("load: trouble reading binary file `%s'", filename.c_str ()); |
|
|
2753 return 0; |
|
|
2754 |
|
|
2755 skip_ahead: |
|
|
2756 warning (" skipping over `%s'", name); |
|
|
2757 delete [] name; |
|
3812
|
2758 is.seekg (pos + static_cast<std::streamoff> (element_length)); |
|
3688
|
2759 return read_mat5_binary_element (is, filename, swap, global, tc); |
|
|
2760 } |
|
|
2761 |
|
|
2762 static int |
|
|
2763 read_mat5_binary_file_header (std::istream& is, bool& swap, |
|
|
2764 bool quiet = false) |
|
|
2765 { |
|
|
2766 TWO_BYTE_INT version=0, magic=0; |
|
|
2767 |
|
|
2768 is.seekg (124, std::ios::beg); |
|
|
2769 is.read (X_CAST (char *, &version), 2); |
|
|
2770 is.read (X_CAST (char *, &magic), 2); |
|
|
2771 |
|
|
2772 if (magic == 0x4d49) |
|
|
2773 swap = 0; |
|
|
2774 else if (magic == 0x494d) |
|
|
2775 swap = 1; |
|
|
2776 else |
|
|
2777 { |
|
|
2778 if (! quiet) |
|
|
2779 error ("load: can't read binary file"); |
|
|
2780 return -1; |
|
|
2781 } |
|
|
2782 |
|
|
2783 if (! swap) // version number is inverse swapped! |
|
|
2784 version = ((version >> 8) & 0xff) + ((version & 0xff) << 8); |
|
|
2785 |
|
|
2786 if (version != 1 && !quiet) |
|
|
2787 warning ("load: found version %d binary MAT file, " |
|
|
2788 "but only prepared for version 1", version); |
|
|
2789 |
|
|
2790 return 0; |
|
|
2791 } |
|
|
2792 |
|
3019
|
2793 // Return TRUE if NAME matches one of the given globbing PATTERNS. |
|
604
|
2794 |
|
3013
|
2795 static bool |
|
3769
|
2796 matches_patterns (const string_vector& patterns, int pat_idx, |
|
3523
|
2797 int num_pat, const std::string& name) |
|
604
|
2798 { |
|
1755
|
2799 for (int i = pat_idx; i < num_pat; i++) |
|
604
|
2800 { |
|
1792
|
2801 glob_match pattern (patterns[i]); |
|
3013
|
2802 |
|
1792
|
2803 if (pattern.match (name)) |
|
3013
|
2804 return true; |
|
604
|
2805 } |
|
3688
|
2806 |
|
3013
|
2807 return false; |
|
604
|
2808 } |
|
|
2809 |
|
|
2810 static int |
|
3523
|
2811 read_binary_file_header (std::istream& is, bool& swap, |
|
2318
|
2812 oct_mach_info::float_format& flt_fmt, |
|
3019
|
2813 bool quiet = false) |
|
604
|
2814 { |
|
3552
|
2815 const int magic_len = 10; |
|
|
2816 char magic[magic_len+1]; |
|
3557
|
2817 is.read (X_CAST (char *, magic), magic_len); |
|
604
|
2818 magic[magic_len] = '\0'; |
|
3688
|
2819 |
|
604
|
2820 if (strncmp (magic, "Octave-1-L", magic_len) == 0) |
|
2318
|
2821 swap = oct_mach_info::words_big_endian (); |
|
604
|
2822 else if (strncmp (magic, "Octave-1-B", magic_len) == 0) |
|
2318
|
2823 swap = ! oct_mach_info::words_big_endian (); |
|
604
|
2824 else |
|
|
2825 { |
|
|
2826 if (! quiet) |
|
|
2827 error ("load: can't read binary file"); |
|
|
2828 return -1; |
|
|
2829 } |
|
|
2830 |
|
|
2831 char tmp = 0; |
|
3557
|
2832 is.read (X_CAST (char *, &tmp), 1); |
|
604
|
2833 |
|
2318
|
2834 flt_fmt = mopt_digit_to_float_format (tmp); |
|
|
2835 |
|
|
2836 if (flt_fmt == oct_mach_info::unknown) |
|
604
|
2837 { |
|
|
2838 if (! quiet) |
|
|
2839 error ("load: unrecognized binary format!"); |
|
3688
|
2840 |
|
604
|
2841 return -1; |
|
|
2842 } |
|
|
2843 |
|
|
2844 return 0; |
|
|
2845 } |
|
|
2846 |
|
|
2847 static load_save_format |
|
3523
|
2848 get_file_format (const std::string& fname, const std::string& orig_fname) |
|
604
|
2849 { |
|
|
2850 load_save_format retval = LS_UNKNOWN; |
|
|
2851 |
|
3687
|
2852 #ifdef HAVE_HDF5 |
|
3688
|
2853 // check this before we open the file |
|
3687
|
2854 if (H5Fis_hdf5 (fname.c_str ()) > 0) |
|
|
2855 return LS_HDF5; |
|
|
2856 #endif /* HAVE_HDF5 */ |
|
|
2857 |
|
3523
|
2858 std::ifstream file (fname.c_str ()); |
|
604
|
2859 |
|
|
2860 if (! file) |
|
|
2861 { |
|
1750
|
2862 error ("load: couldn't open input file `%s'", orig_fname.c_str ()); |
|
604
|
2863 return retval; |
|
|
2864 } |
|
|
2865 |
|
2318
|
2866 oct_mach_info::float_format flt_fmt = oct_mach_info::unknown; |
|
604
|
2867 |
|
3019
|
2868 bool swap = false; |
|
|
2869 |
|
|
2870 if (read_binary_file_header (file, swap, flt_fmt, true) == 0) |
|
604
|
2871 retval = LS_BINARY; |
|
|
2872 else |
|
|
2873 { |
|
3538
|
2874 file.seekg (0, std::ios::beg); |
|
604
|
2875 |
|
|
2876 FOUR_BYTE_INT mopt, nr, nc, imag, len; |
|
1180
|
2877 |
|
|
2878 int err = read_mat_file_header (file, swap, mopt, nr, nc, imag, len, 1); |
|
|
2879 |
|
|
2880 if (! err) |
|
604
|
2881 retval = LS_MAT_BINARY; |
|
|
2882 else |
|
|
2883 { |
|
2511
|
2884 file.clear (); |
|
3538
|
2885 file.seekg (0, std::ios::beg); |
|
604
|
2886 |
|
3697
|
2887 err = read_mat5_binary_file_header (file, swap, true); |
|
3688
|
2888 |
|
|
2889 if (! err) |
|
|
2890 { |
|
|
2891 file.clear (); |
|
|
2892 file.seekg (0, std::ios::beg); |
|
|
2893 retval = LS_MAT5_BINARY; |
|
|
2894 } |
|
|
2895 else |
|
|
2896 { |
|
|
2897 file.clear (); |
|
|
2898 file.seekg (0, std::ios::beg); |
|
|
2899 |
|
|
2900 char *tmp = extract_keyword (file, "name"); |
|
|
2901 |
|
|
2902 if (tmp) |
|
|
2903 { |
|
|
2904 retval = LS_ASCII; |
|
|
2905 |
|
|
2906 delete [] tmp; |
|
|
2907 } |
|
|
2908 else |
|
|
2909 { |
|
|
2910 // Try reading the file as numbers only, determining the |
|
|
2911 // number of rows and columns from the data. We don't |
|
|
2912 // even bother to check to see if the first item in the |
|
|
2913 // file is a number, so that get_complete_line() can |
|
|
2914 // skip any comments that might appear at the top of the |
|
|
2915 // file. |
|
|
2916 |
|
|
2917 retval = LS_MAT_ASCII; |
|
|
2918 } |
|
2511
|
2919 } |
|
604
|
2920 } |
|
|
2921 } |
|
|
2922 |
|
|
2923 file.close (); |
|
|
2924 |
|
|
2925 if (retval == LS_UNKNOWN) |
|
1750
|
2926 error ("load: unable to determine file format for `%s'", |
|
|
2927 orig_fname.c_str ()); |
|
604
|
2928 |
|
|
2929 return retval; |
|
|
2930 } |
|
|
2931 |
|
3727
|
2932 static octave_value |
|
3523
|
2933 do_load (std::istream& stream, const std::string& orig_fname, bool force, |
|
2318
|
2934 load_save_format format, oct_mach_info::float_format flt_fmt, |
|
3687
|
2935 bool list_only, bool swap, bool verbose, bool import, |
|
|
2936 const string_vector& argv, int argv_idx, int argc, int nargout) |
|
604
|
2937 { |
|
3727
|
2938 octave_value retval; |
|
|
2939 |
|
|
2940 Octave_map retstruct; |
|
604
|
2941 |
|
3523
|
2942 std::ostrstream output_buf; |
|
604
|
2943 int count = 0; |
|
|
2944 for (;;) |
|
|
2945 { |
|
3019
|
2946 bool global = false; |
|
2086
|
2947 octave_value tc; |
|
604
|
2948 |
|
|
2949 char *name = 0; |
|
|
2950 char *doc = 0; |
|
|
2951 |
|
|
2952 switch (format) |
|
|
2953 { |
|
|
2954 case LS_ASCII: |
|
3136
|
2955 name = read_ascii_data (stream, orig_fname, global, tc, count); |
|
604
|
2956 break; |
|
|
2957 |
|
|
2958 case LS_BINARY: |
|
|
2959 name = read_binary_data (stream, swap, flt_fmt, orig_fname, |
|
|
2960 global, tc, doc); |
|
|
2961 break; |
|
|
2962 |
|
2511
|
2963 case LS_MAT_ASCII: |
|
|
2964 name = read_mat_ascii_data (stream, orig_fname, tc); |
|
|
2965 break; |
|
|
2966 |
|
604
|
2967 case LS_MAT_BINARY: |
|
|
2968 name = read_mat_binary_data (stream, orig_fname, tc); |
|
|
2969 break; |
|
|
2970 |
|
3687
|
2971 #ifdef HAVE_HDF5 |
|
|
2972 case LS_HDF5: |
|
|
2973 name = read_hdf5_data (stream, orig_fname, |
|
|
2974 global, tc, doc, import); |
|
|
2975 break; |
|
|
2976 #endif /* HAVE_HDF5 */ |
|
|
2977 |
|
3688
|
2978 case LS_MAT5_BINARY: |
|
|
2979 name = read_mat5_binary_element (stream, orig_fname, swap, |
|
|
2980 global, tc); |
|
|
2981 break; |
|
|
2982 |
|
604
|
2983 default: |
|
775
|
2984 gripe_unrecognized_data_fmt ("load"); |
|
604
|
2985 break; |
|
|
2986 } |
|
|
2987 |
|
867
|
2988 if (error_state || stream.eof () || ! name) |
|
604
|
2989 { |
|
867
|
2990 delete [] name; |
|
|
2991 delete [] doc; |
|
2511
|
2992 |
|
604
|
2993 break; |
|
|
2994 } |
|
|
2995 else if (! error_state && name) |
|
|
2996 { |
|
|
2997 if (tc.is_defined ()) |
|
|
2998 { |
|
3136
|
2999 if (format == LS_MAT_ASCII && argv_idx < argc) |
|
|
3000 warning ("load: loaded ASCII file `%s' -- ignoring extra args", |
|
3687
|
3001 orig_fname.c_str ()); |
|
3136
|
3002 |
|
|
3003 if (format == LS_MAT_ASCII |
|
|
3004 || argv_idx == argc |
|
1755
|
3005 || matches_patterns (argv, argv_idx, argc, name)) |
|
604
|
3006 { |
|
|
3007 count++; |
|
621
|
3008 if (list_only) |
|
|
3009 { |
|
|
3010 if (verbose) |
|
|
3011 { |
|
|
3012 if (count == 1) |
|
|
3013 output_buf |
|
|
3014 << "type rows cols name\n" |
|
|
3015 << "==== ==== ==== ====\n"; |
|
|
3016 |
|
3013
|
3017 output_buf |
|
3548
|
3018 << std::setiosflags (std::ios::left) |
|
|
3019 << std::setw (16) << tc.type_name () . c_str () |
|
|
3020 << std::setiosflags (std::ios::right) |
|
|
3021 << std::setw (7) << tc.rows () |
|
|
3022 << std::setw (7) << tc.columns () |
|
3013
|
3023 << " "; |
|
621
|
3024 } |
|
|
3025 output_buf << name << "\n"; |
|
|
3026 } |
|
|
3027 else |
|
|
3028 { |
|
3727
|
3029 if (nargout == 1) |
|
|
3030 { |
|
|
3031 if (format == LS_MAT_ASCII) |
|
|
3032 retval = tc; |
|
|
3033 else |
|
|
3034 retstruct[name] = tc; |
|
|
3035 } |
|
|
3036 else |
|
|
3037 install_loaded_variable (force, name, tc, global, doc); |
|
621
|
3038 } |
|
604
|
3039 } |
|
2511
|
3040 |
|
|
3041 delete [] name; |
|
|
3042 delete [] doc; |
|
|
3043 |
|
|
3044 // Only attempt to read one item from a headless text file. |
|
|
3045 |
|
|
3046 if (format == LS_MAT_ASCII) |
|
|
3047 break; |
|
604
|
3048 } |
|
|
3049 else |
|
|
3050 error ("load: unable to load variable `%s'", name); |
|
|
3051 } |
|
|
3052 else |
|
|
3053 { |
|
|
3054 if (count == 0) |
|
|
3055 error ("load: are you sure `%s' is an Octave data file?", |
|
1755
|
3056 orig_fname.c_str ()); |
|
604
|
3057 |
|
867
|
3058 delete [] name; |
|
|
3059 delete [] doc; |
|
2511
|
3060 |
|
604
|
3061 break; |
|
|
3062 } |
|
|
3063 } |
|
|
3064 |
|
621
|
3065 if (list_only && count) |
|
|
3066 { |
|
3538
|
3067 output_buf << std::ends; |
|
2095
|
3068 |
|
|
3069 char *msg = output_buf.str (); |
|
|
3070 |
|
621
|
3071 if (nargout > 0) |
|
2095
|
3072 retval = msg; |
|
621
|
3073 else |
|
2095
|
3074 octave_stdout << msg; |
|
|
3075 |
|
|
3076 delete [] msg; |
|
621
|
3077 } |
|
3727
|
3078 else if (! retstruct.empty ()) |
|
|
3079 retval = retstruct; |
|
621
|
3080 |
|
863
|
3081 return retval; |
|
|
3082 } |
|
|
3083 |
|
3687
|
3084 // HDF5 load/save documentation is included in the Octave manual |
|
|
3085 // regardless, but if HDF5 is not linked in we also include a |
|
|
3086 // sentence noting this, so the user understands that the features |
|
|
3087 // aren't available. Define a macro for this sentence: |
|
|
3088 |
|
|
3089 #ifdef HAVE_HDF5 |
|
|
3090 #define HAVE_HDF5_HELP_STRING "" |
|
|
3091 #else /* ! HAVE_HDF5 */ |
|
|
3092 #define HAVE_HDF5_HELP_STRING "\n\ |
|
|
3093 HDF5 load and save are not available, as this Octave executable was\n\ |
|
|
3094 not linked with the HDF5 library." |
|
|
3095 #endif /* ! HAVE HDF5 */ |
|
|
3096 |
|
1957
|
3097 DEFUN_TEXT (load, args, nargout, |
|
3372
|
3098 "-*- texinfo -*-\n\ |
|
|
3099 @deffn {Command} load options file v1 v2 @dots{}\n\ |
|
|
3100 Load the named variables from the file @var{file}. As with @code{save},\n\ |
|
|
3101 you may specify a list of variables and @code{load} will only extract\n\ |
|
|
3102 those variables with names that match. For example, to restore the\n\ |
|
|
3103 variables saved in the file @file{data}, use the command\n\ |
|
|
3104 \n\ |
|
|
3105 @example\n\ |
|
|
3106 load data\n\ |
|
|
3107 @end example\n\ |
|
863
|
3108 \n\ |
|
3372
|
3109 Octave will refuse to overwrite existing variables unless you use the\n\ |
|
|
3110 option @samp{-force}.\n\ |
|
|
3111 \n\ |
|
|
3112 If a variable that is not marked as global is loaded from a file when a\n\ |
|
|
3113 global symbol with the same name already exists, it is loaded in the\n\ |
|
|
3114 global symbol table. Also, if a variable is marked as global in a file\n\ |
|
|
3115 and a local symbol exists, the local symbol is moved to the global\n\ |
|
|
3116 symbol table and given the value from the file. Since it seems that\n\ |
|
|
3117 both of these cases are likely to be the result of some sort of error,\n\ |
|
|
3118 they will generate warnings.\n\ |
|
863
|
3119 \n\ |
|
3727
|
3120 If invoked with a single output argument, Octave returns data instead\n\ |
|
|
3121 of inserting variables in the symbol table. If the data file contains\n\ |
|
|
3122 only numbers (TAB- or space-delimited columns), a matrix of values is\n\ |
|
|
3123 returned. Otherwise, @code{load} returns a structure with members\n\ |
|
|
3124 corresponding to the names of the variables in the file.\n\ |
|
|
3125 \n\ |
|
3372
|
3126 The @code{load} command can read data stored in Octave's text and\n\ |
|
|
3127 binary formats, and @sc{Matlab}'s binary format. It will automatically\n\ |
|
|
3128 detect the type of file and do conversion from different floating point\n\ |
|
|
3129 formats (currently only IEEE big and little endian, though other formats\n\ |
|
|
3130 may added in the future).\n\ |
|
|
3131 \n\ |
|
|
3132 Valid options for @code{load} are listed in the following table.\n\ |
|
863
|
3133 \n\ |
|
3372
|
3134 @table @code\n\ |
|
|
3135 @item -force\n\ |
|
|
3136 Force variables currently in memory to be overwritten by variables with\n\ |
|
|
3137 the same name found in the file.\n\ |
|
|
3138 \n\ |
|
|
3139 @item -ascii\n\ |
|
|
3140 Force Octave to assume the file is in Octave's text format.\n\ |
|
|
3141 \n\ |
|
|
3142 @item -binary\n\ |
|
|
3143 Force Octave to assume the file is in Octave's binary format.\n\ |
|
|
3144 \n\ |
|
|
3145 @item -mat-binary\n\ |
|
|
3146 Force Octave to assume the file is in @sc{Matlab}'s binary format.\n\ |
|
3687
|
3147 \n\ |
|
3688
|
3148 @item -mat4-binary\n\ |
|
|
3149 Force Octave to assume the file is in the binary format written by\n\ |
|
|
3150 @sc{Matlab} version 4.\n\ |
|
|
3151 \n\ |
|
3687
|
3152 @item -hdf5\n\ |
|
|
3153 Force Octave to assume the file is in HDF5 format.\n\ |
|
|
3154 (HDF5 is a free, portable binary format developed by the National\n\ |
|
|
3155 Center for Supercomputing Applications at the University of Illinois.)\n\ |
|
|
3156 Note that Octave can read HDF5 files not created by itself, but may\n\ |
|
|
3157 skip some datasets in formats that it cannot support. In particular,\n\ |
|
|
3158 it will skip datasets of data types that it does not recognize, with\n\ |
|
|
3159 dimensionality > 2, or with names that aren't valid Octave identifiers\n\ |
|
|
3160 See, however, the @samp{-import} option to ameliorate this somewhat.\n" |
|
|
3161 |
|
|
3162 HAVE_HDF5_HELP_STRING |
|
|
3163 |
|
|
3164 "\n\ |
|
|
3165 @item -import\n\ |
|
|
3166 Make a stronger attempt to import foreign datasets. Currently, this means\n\ |
|
|
3167 that for HDF5 files, invalid characters in names are converted to @samp{_},\n\ |
|
|
3168 and datasets with dimensionality > 2 are imported as lists of matrices (or\n\ |
|
|
3169 lists of lists of matrices, or ...).\n\ |
|
|
3170 \n\ |
|
3372
|
3171 @end table\n\ |
|
|
3172 @end deffn") |
|
863
|
3173 { |
|
2086
|
3174 octave_value_list retval; |
|
863
|
3175 |
|
1755
|
3176 int argc = args.length () + 1; |
|
|
3177 |
|
1968
|
3178 string_vector argv = args.make_argv ("load"); |
|
1755
|
3179 |
|
|
3180 if (error_state) |
|
|
3181 return retval; |
|
863
|
3182 |
|
1358
|
3183 // It isn't necessary to have the default load format stored in a |
|
|
3184 // user preference variable since we can determine the type of file |
|
|
3185 // as we are reading. |
|
863
|
3186 |
|
|
3187 load_save_format format = LS_UNKNOWN; |
|
|
3188 |
|
3019
|
3189 bool force = false; |
|
|
3190 bool list_only = false; |
|
|
3191 bool verbose = false; |
|
3687
|
3192 bool import = false; |
|
863
|
3193 |
|
1755
|
3194 int i; |
|
|
3195 for (i = 1; i < argc; i++) |
|
863
|
3196 { |
|
1755
|
3197 if (argv[i] == "-force" || argv[i] == "-f") |
|
863
|
3198 { |
|
3019
|
3199 force = true; |
|
863
|
3200 } |
|
1755
|
3201 else if (argv[i] == "-list" || argv[i] == "-l") |
|
863
|
3202 { |
|
3019
|
3203 list_only = true; |
|
863
|
3204 } |
|
1755
|
3205 else if (argv[i] == "-verbose" || argv[i] == "-v") |
|
863
|
3206 { |
|
3019
|
3207 verbose = true; |
|
863
|
3208 } |
|
1755
|
3209 else if (argv[i] == "-ascii" || argv[i] == "-a") |
|
863
|
3210 { |
|
|
3211 format = LS_ASCII; |
|
|
3212 } |
|
1755
|
3213 else if (argv[i] == "-binary" || argv[i] == "-b") |
|
863
|
3214 { |
|
|
3215 format = LS_BINARY; |
|
|
3216 } |
|
1755
|
3217 else if (argv[i] == "-mat-binary" || argv[i] == "-m") |
|
863
|
3218 { |
|
3688
|
3219 format = LS_MAT5_BINARY; |
|
|
3220 } |
|
3797
|
3221 else if (argv[i] == "-mat4-binary" || argv[i] == "-4" || argv[i] == "-v4") |
|
3688
|
3222 { |
|
863
|
3223 format = LS_MAT_BINARY; |
|
|
3224 } |
|
3687
|
3225 else if (argv[i] == "-hdf5" || argv[i] == "-h") |
|
|
3226 { |
|
|
3227 #ifdef HAVE_HDF5 |
|
|
3228 format = LS_HDF5; |
|
|
3229 #else /* ! HAVE_HDF5 */ |
|
|
3230 error ("load: octave executable was not linked with HDF5 library"); |
|
|
3231 return retval; |
|
|
3232 #endif /* ! HAVE_HDF5 */ |
|
|
3233 } |
|
|
3234 else if (argv[i] == "-import" || argv[i] == "-i") |
|
|
3235 { |
|
|
3236 import = true; |
|
|
3237 } |
|
863
|
3238 else |
|
|
3239 break; |
|
|
3240 } |
|
|
3241 |
|
1755
|
3242 if (i == argc) |
|
863
|
3243 { |
|
2057
|
3244 print_usage ("load"); |
|
863
|
3245 return retval; |
|
|
3246 } |
|
|
3247 |
|
3523
|
3248 std::string orig_fname = argv[i]; |
|
863
|
3249 |
|
2318
|
3250 oct_mach_info::float_format flt_fmt = oct_mach_info::unknown; |
|
863
|
3251 |
|
3019
|
3252 bool swap = false; |
|
863
|
3253 |
|
1755
|
3254 if (argv[i] == "-") |
|
863
|
3255 { |
|
1755
|
3256 i++; |
|
863
|
3257 |
|
3687
|
3258 #ifdef HAVE_HDF5 |
|
|
3259 if (format == LS_HDF5) |
|
|
3260 error ("load: cannot read HDF5 format from stdin"); |
|
|
3261 else |
|
|
3262 #endif /* HAVE_HDF5 */ |
|
863
|
3263 if (format != LS_UNKNOWN) |
|
|
3264 { |
|
1358
|
3265 // XXX FIXME XXX -- if we have already seen EOF on a |
|
3531
|
3266 // previous call, how do we fix up the state of std::cin so |
|
|
3267 // that we can get additional input? I'm afraid that we |
|
|
3268 // can't fix this using std::cin only. |
|
|
3269 |
|
|
3270 retval = do_load (std::cin, orig_fname, force, format, flt_fmt, |
|
3687
|
3271 list_only, swap, verbose, import, argv, i, argc, |
|
863
|
3272 nargout); |
|
|
3273 } |
|
|
3274 else |
|
|
3275 error ("load: must specify file format if reading from stdin"); |
|
|
3276 } |
|
|
3277 else |
|
|
3278 { |
|
3523
|
3279 std::string fname = file_ops::tilde_expand (argv[i]); |
|
863
|
3280 |
|
|
3281 if (format == LS_UNKNOWN) |
|
|
3282 format = get_file_format (fname, orig_fname); |
|
|
3283 |
|
3687
|
3284 #ifdef HAVE_HDF5 |
|
|
3285 if (format == LS_HDF5) |
|
|
3286 { |
|
|
3287 i++; |
|
|
3288 |
|
|
3289 hdf5_ifstream hdf5_file (fname.c_str ()); |
|
|
3290 |
|
|
3291 if (hdf5_file.file_id >= 0) |
|
|
3292 { |
|
|
3293 retval = do_load (hdf5_file, orig_fname, force, format, |
|
|
3294 flt_fmt, list_only, swap, verbose, |
|
|
3295 import, argv, i, argc, nargout); |
|
|
3296 |
|
|
3297 hdf5_file.close (); |
|
|
3298 } |
|
|
3299 else |
|
|
3300 error ("load: couldn't open input file `%s'", |
|
|
3301 orig_fname.c_str ()); |
|
|
3302 } |
|
|
3303 else |
|
|
3304 #endif /* HAVE_HDF5 */ |
|
|
3305 // don't insert any statements here; the "else" above has to |
|
|
3306 // go with the "if" below!!!!! |
|
863
|
3307 if (format != LS_UNKNOWN) |
|
|
3308 { |
|
1755
|
3309 i++; |
|
863
|
3310 |
|
3775
|
3311 std::ios::openmode mode = std::ios::in; |
|
3688
|
3312 if (format == LS_BINARY || |
|
|
3313 format == LS_MAT_BINARY || |
|
|
3314 format == LS_MAT5_BINARY) |
|
3552
|
3315 mode |= std::ios::binary; |
|
863
|
3316 |
|
3523
|
3317 std::ifstream file (fname.c_str (), mode); |
|
863
|
3318 |
|
|
3319 if (file) |
|
|
3320 { |
|
|
3321 if (format == LS_BINARY) |
|
|
3322 { |
|
|
3323 if (read_binary_file_header (file, swap, flt_fmt) < 0) |
|
|
3324 { |
|
|
3325 file.close (); |
|
|
3326 return retval; |
|
|
3327 } |
|
|
3328 } |
|
3688
|
3329 else if (format == LS_MAT5_BINARY) |
|
|
3330 { |
|
|
3331 if (read_mat5_binary_file_header (file, swap, false) < 0) |
|
|
3332 { |
|
|
3333 file.close (); |
|
|
3334 return retval; |
|
|
3335 } |
|
|
3336 } |
|
863
|
3337 |
|
|
3338 retval = do_load (file, orig_fname, force, format, |
|
3687
|
3339 flt_fmt, list_only, swap, verbose, import, |
|
1755
|
3340 argv, i, argc, nargout); |
|
863
|
3341 file.close (); |
|
|
3342 } |
|
|
3343 else |
|
1755
|
3344 error ("load: couldn't open input file `%s'", |
|
|
3345 orig_fname.c_str ()); |
|
863
|
3346 } |
|
|
3347 } |
|
604
|
3348 |
|
|
3349 return retval; |
|
|
3350 } |
|
|
3351 |
|
3019
|
3352 // Return TRUE if PATTERN has any special globbing chars in it. |
|
|
3353 |
|
|
3354 static bool |
|
3523
|
3355 glob_pattern_p (const std::string& pattern) |
|
604
|
3356 { |
|
|
3357 int open = 0; |
|
|
3358 |
|
1755
|
3359 int len = pattern.length (); |
|
|
3360 |
|
|
3361 for (int i = 0; i < len; i++) |
|
604
|
3362 { |
|
1755
|
3363 char c = pattern[i]; |
|
|
3364 |
|
604
|
3365 switch (c) |
|
|
3366 { |
|
|
3367 case '?': |
|
|
3368 case '*': |
|
3019
|
3369 return true; |
|
604
|
3370 |
|
|
3371 case '[': // Only accept an open brace if there is a close |
|
|
3372 open++; // brace to match it. Bracket expressions must be |
|
|
3373 continue; // complete, according to Posix.2 |
|
|
3374 |
|
|
3375 case ']': |
|
|
3376 if (open) |
|
3019
|
3377 return true; |
|
604
|
3378 continue; |
|
|
3379 |
|
|
3380 case '\\': |
|
1755
|
3381 if (i == len - 1) |
|
3019
|
3382 return false; |
|
604
|
3383 |
|
|
3384 default: |
|
|
3385 continue; |
|
|
3386 } |
|
|
3387 } |
|
|
3388 |
|
3019
|
3389 return false; |
|
604
|
3390 } |
|
|
3391 |
|
618
|
3392 // MAX_VAL and MIN_VAL are assumed to have integral values even though |
|
|
3393 // they are stored in doubles. |
|
|
3394 |
|
604
|
3395 static save_type |
|
|
3396 get_save_type (double max_val, double min_val) |
|
|
3397 { |
|
|
3398 save_type st = LS_DOUBLE; |
|
|
3399 |
|
|
3400 if (max_val < 256 && min_val > -1) |
|
|
3401 st = LS_U_CHAR; |
|
|
3402 else if (max_val < 65536 && min_val > -1) |
|
|
3403 st = LS_U_SHORT; |
|
3131
|
3404 else if (max_val < 4294967295UL && min_val > -1) |
|
618
|
3405 st = LS_U_INT; |
|
|
3406 else if (max_val < 128 && min_val >= -128) |
|
|
3407 st = LS_CHAR; |
|
604
|
3408 else if (max_val < 32768 && min_val >= -32768) |
|
|
3409 st = LS_SHORT; |
|
3131
|
3410 else if (max_val <= 2147483647L && min_val >= -2147483647L) |
|
604
|
3411 st = LS_INT; |
|
|
3412 |
|
|
3413 return st; |
|
|
3414 } |
|
|
3415 |
|
|
3416 // Save the data from TC along with the corresponding NAME, help |
|
|
3417 // string DOC, and global flag MARK_AS_GLOBAL on stream OS in the |
|
1427
|
3418 // binary format described above for read_binary_data. |
|
604
|
3419 |
|
2799
|
3420 static bool |
|
3523
|
3421 save_binary_data (std::ostream& os, const octave_value& tc, |
|
|
3422 const std::string& name, const std::string& doc, |
|
3019
|
3423 bool mark_as_global, bool save_as_floats) |
|
604
|
3424 { |
|
1755
|
3425 FOUR_BYTE_INT name_len = name.length (); |
|
604
|
3426 |
|
3557
|
3427 os.write (X_CAST (char *, &name_len), 4); |
|
1755
|
3428 os << name; |
|
|
3429 |
|
|
3430 FOUR_BYTE_INT doc_len = doc.length (); |
|
604
|
3431 |
|
3557
|
3432 os.write (X_CAST (char *, &doc_len), 4); |
|
1755
|
3433 os << doc; |
|
604
|
3434 |
|
|
3435 char tmp; |
|
|
3436 |
|
|
3437 tmp = mark_as_global; |
|
3557
|
3438 os.write (X_CAST (char *, &tmp), 1); |
|
604
|
3439 |
|
3233
|
3440 if (tc.is_string ()) |
|
|
3441 { |
|
|
3442 tmp = 7; |
|
3557
|
3443 os.write (X_CAST (char *, &tmp), 1); |
|
3233
|
3444 FOUR_BYTE_INT nr = tc.rows (); |
|
3557
|
3445 os.write (X_CAST (char *, &nr), 4); |
|
3233
|
3446 charMatrix chm = tc.char_matrix_value (); |
|
|
3447 for (int i = 0; i < nr; i++) |
|
|
3448 { |
|
|
3449 FOUR_BYTE_INT len = chm.cols (); |
|
3557
|
3450 os.write (X_CAST (char *, &len), 4); |
|
3523
|
3451 std::string tstr = chm.row_as_string (i); |
|
3233
|
3452 const char *tmp = tstr.data (); |
|
3557
|
3453 os.write (X_CAST (char *, tmp), len); |
|
3233
|
3454 } |
|
|
3455 } |
|
|
3456 else if (tc.is_range ()) |
|
|
3457 { |
|
|
3458 tmp = 6; |
|
3557
|
3459 os.write (X_CAST (char *, &tmp), 1); |
|
3233
|
3460 tmp = (char) LS_DOUBLE; |
|
3557
|
3461 os.write (X_CAST (char *, &tmp), 1); |
|
3233
|
3462 Range r = tc.range_value (); |
|
|
3463 double bas = r.base (); |
|
|
3464 double lim = r.limit (); |
|
|
3465 double inc = r.inc (); |
|
3557
|
3466 os.write (X_CAST (char *, &bas), 8); |
|
|
3467 os.write (X_CAST (char *, &lim), 8); |
|
|
3468 os.write (X_CAST (char *, &inc), 8); |
|
3233
|
3469 } |
|
|
3470 else if (tc.is_real_scalar ()) |
|
604
|
3471 { |
|
|
3472 tmp = 1; |
|
3557
|
3473 os.write (X_CAST (char *, &tmp), 1); |
|
630
|
3474 tmp = (char) LS_DOUBLE; |
|
3557
|
3475 os.write (X_CAST (char *, &tmp), 1); |
|
604
|
3476 double tmp = tc.double_value (); |
|
3557
|
3477 os.write (X_CAST (char *, &tmp), 8); |
|
604
|
3478 } |
|
620
|
3479 else if (tc.is_real_matrix ()) |
|
604
|
3480 { |
|
|
3481 tmp = 2; |
|
3557
|
3482 os.write (X_CAST (char *, &tmp), 1); |
|
604
|
3483 Matrix m = tc.matrix_value (); |
|
|
3484 FOUR_BYTE_INT nr = m.rows (); |
|
|
3485 FOUR_BYTE_INT nc = m.columns (); |
|
3557
|
3486 os.write (X_CAST (char *, &nr), 4); |
|
|
3487 os.write (X_CAST (char *, &nc), 4); |
|
604
|
3488 int len = nr * nc; |
|
|
3489 save_type st = LS_DOUBLE; |
|
630
|
3490 if (save_as_floats) |
|
|
3491 { |
|
1963
|
3492 if (m.too_large_for_float ()) |
|
630
|
3493 { |
|
|
3494 warning ("save: some values too large to save as floats --"); |
|
|
3495 warning ("save: saving as doubles instead"); |
|
|
3496 } |
|
|
3497 else |
|
|
3498 st = LS_FLOAT; |
|
|
3499 } |
|
|
3500 else if (len > 8192) // XXX FIXME XXX -- make this configurable. |
|
604
|
3501 { |
|
|
3502 double max_val, min_val; |
|
1963
|
3503 if (m.all_integers (max_val, min_val)) |
|
604
|
3504 st = get_save_type (max_val, min_val); |
|
|
3505 } |
|
630
|
3506 const double *mtmp = m.data (); |
|
604
|
3507 write_doubles (os, mtmp, st, len); |
|
|
3508 } |
|
|
3509 else if (tc.is_complex_scalar ()) |
|
|
3510 { |
|
|
3511 tmp = 3; |
|
3557
|
3512 os.write (X_CAST (char *, &tmp), 1); |
|
630
|
3513 tmp = (char) LS_DOUBLE; |
|
3557
|
3514 os.write (X_CAST (char *, &tmp), 1); |
|
604
|
3515 Complex tmp = tc.complex_value (); |
|
3557
|
3516 os.write (X_CAST (char *, &tmp), 16); |
|
604
|
3517 } |
|
|
3518 else if (tc.is_complex_matrix ()) |
|
|
3519 { |
|
|
3520 tmp = 4; |
|
3557
|
3521 os.write (X_CAST (char *, &tmp), 1); |
|
604
|
3522 ComplexMatrix m = tc.complex_matrix_value (); |
|
|
3523 FOUR_BYTE_INT nr = m.rows (); |
|
|
3524 FOUR_BYTE_INT nc = m.columns (); |
|
3557
|
3525 os.write (X_CAST (char *, &nr), 4); |
|
|
3526 os.write (X_CAST (char *, &nc), 4); |
|
604
|
3527 int len = nr * nc; |
|
|
3528 save_type st = LS_DOUBLE; |
|
630
|
3529 if (save_as_floats) |
|
|
3530 { |
|
1963
|
3531 if (m.too_large_for_float ()) |
|
630
|
3532 { |
|
|
3533 warning ("save: some values too large to save as floats --"); |
|
|
3534 warning ("save: saving as doubles instead"); |
|
|
3535 } |
|
|
3536 else |
|
|
3537 st = LS_FLOAT; |
|
|
3538 } |
|
|
3539 else if (len > 4096) // XXX FIXME XXX -- make this configurable. |
|
604
|
3540 { |
|
|
3541 double max_val, min_val; |
|
1963
|
3542 if (m.all_integers (max_val, min_val)) |
|
604
|
3543 st = get_save_type (max_val, min_val); |
|
|
3544 } |
|
630
|
3545 const Complex *mtmp = m.data (); |
|
3145
|
3546 write_doubles (os, X_CAST (const double *, mtmp), st, 2*len); |
|
604
|
3547 } |
|
|
3548 else |
|
2799
|
3549 gripe_wrong_type_arg ("save", tc, false); |
|
|
3550 |
|
|
3551 return os; |
|
604
|
3552 } |
|
|
3553 |
|
3687
|
3554 #ifdef HAVE_HDF5 |
|
|
3555 |
|
|
3556 // Add an attribute named attr_name to loc_id (a simple scalar |
|
|
3557 // attribute with value 1). Return value is >= 0 on success. |
|
|
3558 static herr_t |
|
|
3559 hdf5_add_attr (hid_t loc_id, const char *attr_name) |
|
|
3560 { |
|
|
3561 herr_t retval = 0; |
|
|
3562 |
|
|
3563 hid_t as_id = H5Screate (H5S_SCALAR); |
|
|
3564 |
|
|
3565 if (as_id >= 0) |
|
|
3566 { |
|
|
3567 hid_t a_id = H5Acreate (loc_id, attr_name, |
|
|
3568 H5T_NATIVE_UCHAR, as_id, H5P_DEFAULT); |
|
|
3569 |
|
|
3570 if (a_id >= 0) |
|
|
3571 { |
|
|
3572 unsigned char attr_val = 1; |
|
|
3573 |
|
|
3574 retval = H5Awrite (a_id, H5T_NATIVE_UCHAR, (void*) &attr_val); |
|
|
3575 |
|
|
3576 H5Aclose (a_id); |
|
|
3577 } |
|
|
3578 else |
|
|
3579 retval = a_id; |
|
|
3580 |
|
|
3581 H5Sclose (as_id); |
|
|
3582 } |
|
|
3583 else |
|
|
3584 retval = as_id; |
|
|
3585 |
|
|
3586 return retval; |
|
|
3587 } |
|
|
3588 |
|
|
3589 |
|
|
3590 // save_type_to_hdf5 is not currently used, since hdf5 doesn't yet support |
|
|
3591 // automatic float<->integer conversions: |
|
|
3592 |
|
|
3593 #if HAVE_HDF5_INT2FLOAT_CONVERSIONS |
|
|
3594 |
|
|
3595 // return the HDF5 type id corresponding to the Octave save_type |
|
|
3596 |
|
|
3597 static hid_t |
|
|
3598 save_type_to_hdf5 (save_type st) |
|
|
3599 { |
|
|
3600 switch (st) |
|
|
3601 { |
|
|
3602 case LS_U_CHAR: |
|
|
3603 return H5T_NATIVE_UCHAR; |
|
|
3604 |
|
|
3605 case LS_U_SHORT: |
|
|
3606 return H5T_NATIVE_USHORT; |
|
|
3607 |
|
|
3608 case LS_U_INT: |
|
|
3609 return H5T_NATIVE_UINT; |
|
|
3610 |
|
|
3611 case LS_CHAR: |
|
|
3612 return H5T_NATIVE_CHAR; |
|
|
3613 |
|
|
3614 case LS_SHORT: |
|
|
3615 return H5T_NATIVE_SHORT; |
|
|
3616 |
|
|
3617 case LS_INT: |
|
|
3618 return H5T_NATIVE_INT; |
|
|
3619 |
|
|
3620 case LS_FLOAT: |
|
|
3621 return H5T_NATIVE_FLOAT; |
|
|
3622 |
|
|
3623 case LS_DOUBLE: |
|
|
3624 default: |
|
|
3625 return H5T_NATIVE_DOUBLE; |
|
|
3626 } |
|
|
3627 } |
|
|
3628 #endif /* HAVE_HDF5_INT2FLOAT_CONVERSIONS */ |
|
|
3629 |
|
|
3630 // Add the data from TC to the HDF5 location loc_id, which could |
|
|
3631 // be either a file or a group within a file. Return true if |
|
|
3632 // successful. This function calls itself recursively for lists |
|
|
3633 // (stored as HDF5 groups). |
|
|
3634 |
|
|
3635 static bool |
|
|
3636 add_hdf5_data (hid_t loc_id, const octave_value& tc, |
|
|
3637 const std::string& name, const std::string& doc, |
|
|
3638 bool mark_as_global, bool save_as_floats) |
|
|
3639 { |
|
|
3640 hsize_t dims[3]; |
|
|
3641 hid_t type_id = -1, space_id = -1, data_id = -1; |
|
|
3642 bool data_is_group = 0; |
|
|
3643 bool retval = 0; |
|
|
3644 |
|
|
3645 if (tc.is_string ()) |
|
|
3646 { |
|
|
3647 int nr = tc.rows (); |
|
|
3648 charMatrix chm = tc.char_matrix_value (); |
|
|
3649 int nc = chm.cols (); |
|
|
3650 |
|
|
3651 // create datatype for (null-terminated) string to write from: |
|
|
3652 type_id = H5Tcopy (H5T_C_S1); H5Tset_size (type_id, nc + 1); |
|
|
3653 if (type_id < 0) |
|
|
3654 goto error_cleanup; |
|
|
3655 |
|
|
3656 dims[0] = nr; |
|
|
3657 space_id = H5Screate_simple (nr > 0 ? 1 : 0, dims, (hsize_t*) NULL); |
|
|
3658 if (space_id < 0) |
|
|
3659 goto error_cleanup; |
|
|
3660 |
|
|
3661 data_id = H5Dcreate (loc_id, name.c_str (), |
|
|
3662 type_id, space_id, H5P_DEFAULT); |
|
|
3663 if (data_id < 0) |
|
|
3664 goto error_cleanup; |
|
|
3665 |
|
|
3666 char *s = new char [nr * (nc + 1)]; |
|
|
3667 |
|
|
3668 for (int i = 0; i < nr; ++i) |
|
|
3669 { |
|
|
3670 std::string tstr = chm.row_as_string (i); |
|
|
3671 strcpy (s + i * (nc+1), tstr.c_str ()); |
|
|
3672 } |
|
|
3673 |
|
|
3674 if (H5Dwrite (data_id, type_id, H5S_ALL, H5S_ALL, H5P_DEFAULT, |
|
|
3675 (void*) s) < 0) { |
|
|
3676 delete [] s; |
|
|
3677 goto error_cleanup; |
|
|
3678 } |
|
|
3679 |
|
|
3680 delete [] s; |
|
|
3681 } |
|
|
3682 else if (tc.is_range ()) |
|
|
3683 { |
|
|
3684 space_id = H5Screate_simple (0, dims, (hsize_t*) NULL); |
|
|
3685 if (space_id < 0) |
|
|
3686 goto error_cleanup; |
|
|
3687 |
|
|
3688 type_id = hdf5_make_range_type (H5T_NATIVE_DOUBLE); |
|
|
3689 if (type_id < 0) |
|
|
3690 goto error_cleanup; |
|
|
3691 |
|
|
3692 data_id = H5Dcreate (loc_id, name.c_str (), |
|
|
3693 type_id, space_id, H5P_DEFAULT); |
|
|
3694 if (data_id < 0) |
|
|
3695 goto error_cleanup; |
|
|
3696 |
|
|
3697 Range r = tc.range_value (); |
|
|
3698 double range_vals[3]; |
|
|
3699 range_vals[0] = r.base (); |
|
|
3700 range_vals[1] = r.limit (); |
|
|
3701 range_vals[2] = r.inc (); |
|
|
3702 |
|
|
3703 if (H5Dwrite (data_id, type_id, H5S_ALL, H5S_ALL, H5P_DEFAULT, |
|
|
3704 (void*) range_vals) < 0) |
|
|
3705 goto error_cleanup; |
|
|
3706 } |
|
|
3707 else if (tc.is_real_scalar ()) |
|
|
3708 { |
|
|
3709 space_id = H5Screate_simple (0, dims, (hsize_t*) NULL); |
|
|
3710 if (space_id < 0) goto error_cleanup; |
|
|
3711 |
|
|
3712 data_id = H5Dcreate (loc_id, name.c_str (), |
|
|
3713 H5T_NATIVE_DOUBLE, space_id, H5P_DEFAULT); |
|
|
3714 if (data_id < 0) |
|
|
3715 goto error_cleanup; |
|
|
3716 |
|
|
3717 double tmp = tc.double_value (); |
|
|
3718 if (H5Dwrite (data_id, H5T_NATIVE_DOUBLE, H5S_ALL, H5S_ALL, |
|
|
3719 H5P_DEFAULT, (void*) &tmp) < 0) |
|
|
3720 goto error_cleanup; |
|
|
3721 } |
|
|
3722 else if (tc.is_real_matrix ()) |
|
|
3723 { |
|
|
3724 Matrix m = tc.matrix_value (); |
|
|
3725 dims[1] = m.rows (); // Octave uses column-major, while |
|
|
3726 dims[0] = m.columns (); // HDF5 uses row-major ordering |
|
|
3727 |
|
|
3728 space_id = H5Screate_simple (dims[1] > 1 ?2:1, dims, (hsize_t*) NULL); |
|
|
3729 if (space_id < 0) |
|
|
3730 goto error_cleanup; |
|
|
3731 |
|
|
3732 hid_t save_type_id = H5T_NATIVE_DOUBLE; |
|
|
3733 |
|
|
3734 if (save_as_floats) |
|
|
3735 { |
|
|
3736 if (m.too_large_for_float ()) |
|
|
3737 { |
|
|
3738 warning ("save: some values too large to save as floats --"); |
|
|
3739 warning ("save: saving as doubles instead"); |
|
|
3740 } |
|
|
3741 else |
|
|
3742 save_type_id = H5T_NATIVE_FLOAT; |
|
|
3743 } |
|
|
3744 #if HAVE_HDF5_INT2FLOAT_CONVERSIONS |
|
|
3745 // hdf5 currently doesn't support float/integer conversions |
|
|
3746 else |
|
|
3747 { |
|
|
3748 double max_val, min_val; |
|
|
3749 |
|
|
3750 if (m.all_integers (max_val, min_val)) |
|
|
3751 save_type_id |
|
|
3752 = save_type_to_hdf5 (get_save_type (max_val, min_val)); |
|
|
3753 } |
|
|
3754 #endif /* HAVE_HDF5_INT2FLOAT_CONVERSIONS */ |
|
|
3755 |
|
|
3756 data_id = H5Dcreate (loc_id, name.c_str (), |
|
|
3757 save_type_id, space_id, H5P_DEFAULT); |
|
|
3758 if (data_id < 0) |
|
|
3759 goto error_cleanup; |
|
|
3760 |
|
|
3761 double *mtmp = m.fortran_vec (); |
|
|
3762 if (H5Dwrite (data_id, H5T_NATIVE_DOUBLE, H5S_ALL, H5S_ALL, |
|
|
3763 H5P_DEFAULT, (void*) mtmp) < 0) |
|
|
3764 goto error_cleanup; |
|
|
3765 } |
|
|
3766 else if (tc.is_complex_scalar ()) |
|
|
3767 { |
|
|
3768 space_id = H5Screate_simple (0, dims, (hsize_t*) NULL); |
|
|
3769 if (space_id < 0) |
|
|
3770 goto error_cleanup; |
|
|
3771 |
|
|
3772 type_id = hdf5_make_complex_type (H5T_NATIVE_DOUBLE); |
|
|
3773 if (type_id < 0) |
|
|
3774 goto error_cleanup; |
|
|
3775 |
|
|
3776 data_id = H5Dcreate (loc_id, name.c_str (), |
|
|
3777 type_id, space_id, H5P_DEFAULT); |
|
|
3778 if (data_id < 0) |
|
|
3779 goto error_cleanup; |
|
|
3780 |
|
|
3781 Complex tmp = tc.complex_value (); |
|
|
3782 if (H5Dwrite (data_id, type_id, H5S_ALL, H5S_ALL, H5P_DEFAULT, |
|
|
3783 (void*) X_CAST (double*, &tmp)) < 0) |
|
|
3784 goto error_cleanup; |
|
|
3785 } |
|
|
3786 else if (tc.is_complex_matrix ()) |
|
|
3787 { |
|
|
3788 ComplexMatrix m = tc.complex_matrix_value (); |
|
|
3789 |
|
|
3790 dims[1] = m.rows (); // Octave uses column-major, while |
|
|
3791 dims[0] = m.columns (); // HDF5 uses row-major ordering |
|
|
3792 |
|
|
3793 space_id = H5Screate_simple (dims[1] > 1 ?2:1, dims, (hsize_t*) NULL); |
|
|
3794 if (space_id < 0) |
|
|
3795 goto error_cleanup; |
|
|
3796 |
|
|
3797 hid_t save_type_id = H5T_NATIVE_DOUBLE; |
|
|
3798 |
|
|
3799 if (save_as_floats) |
|
|
3800 { |
|
|
3801 if (m.too_large_for_float ()) |
|
|
3802 { |
|
|
3803 warning ("save: some values too large to save as floats --"); |
|
|
3804 warning ("save: saving as doubles instead"); |
|
|
3805 } |
|
|
3806 else |
|
|
3807 save_type_id = H5T_NATIVE_FLOAT; |
|
|
3808 } |
|
|
3809 #if HAVE_HDF5_INT2FLOAT_CONVERSIONS |
|
|
3810 // hdf5 currently doesn't support float/integer conversions |
|
|
3811 else |
|
|
3812 { |
|
|
3813 double max_val, min_val; |
|
|
3814 |
|
|
3815 if (m.all_integers (max_val, min_val)) |
|
|
3816 save_type_id |
|
|
3817 = save_type_to_hdf5 (get_save_type (max_val, min_val)); |
|
|
3818 } |
|
|
3819 #endif /* HAVE_HDF5_INT2FLOAT_CONVERSIONS */ |
|
|
3820 |
|
|
3821 type_id = hdf5_make_complex_type (save_type_id); |
|
|
3822 if (type_id < 0) goto error_cleanup; |
|
|
3823 |
|
|
3824 data_id = H5Dcreate (loc_id, name.c_str (), |
|
|
3825 type_id, space_id, H5P_DEFAULT); |
|
|
3826 if (data_id < 0) |
|
|
3827 goto error_cleanup; |
|
|
3828 |
|
|
3829 hid_t complex_type_id = hdf5_make_complex_type (H5T_NATIVE_DOUBLE); |
|
|
3830 if (complex_type_id < 0) |
|
|
3831 goto error_cleanup; |
|
|
3832 |
|
|
3833 Complex *mtmp = m.fortran_vec (); |
|
|
3834 if (H5Dwrite (data_id, complex_type_id, H5S_ALL, H5S_ALL, H5P_DEFAULT, |
|
|
3835 (void*) X_CAST (double *, mtmp)) < 0) |
|
|
3836 { |
|
|
3837 H5Tclose (complex_type_id); |
|
|
3838 goto error_cleanup; |
|
|
3839 } |
|
|
3840 |
|
|
3841 H5Tclose (complex_type_id); |
|
|
3842 } |
|
|
3843 else if (tc.is_list ()) |
|
|
3844 { |
|
|
3845 data_id = H5Gcreate (loc_id, name.c_str (), 0); |
|
|
3846 if (data_id < 0) |
|
|
3847 goto error_cleanup; |
|
|
3848 |
|
|
3849 data_is_group = 1; |
|
|
3850 |
|
|
3851 // recursively add each element of the list to this group |
|
|
3852 octave_value_list lst = tc.list_value (); |
|
|
3853 |
|
|
3854 for (int i = 0; i < lst.length (); ++i) |
|
|
3855 { |
|
|
3856 // should we use lst.name_tags () to label the elements? |
|
|
3857 char s[20]; |
|
|
3858 sprintf (s, "%d", i); |
|
|
3859 bool retval2 = add_hdf5_data (data_id, lst (i), s, "", |
|
|
3860 false, save_as_floats); |
|
|
3861 if (! retval2) |
|
|
3862 goto error_cleanup; |
|
|
3863 } |
|
|
3864 |
|
|
3865 // mark with an attribute "OCTAVE_LIST" with value 1 |
|
|
3866 // to distinguish from structures (also stored as HDF5 groups): |
|
3688
|
3867 if (hdf5_add_attr (data_id, "OCTAVE_LIST") < 0) |
|
3687
|
3868 goto error_cleanup; |
|
|
3869 } |
|
|
3870 else if (tc.is_map ()) |
|
|
3871 { |
|
|
3872 // an Octave structure |
|
|
3873 data_id = H5Gcreate (loc_id, name.c_str (), 0); |
|
|
3874 if (data_id < 0) |
|
|
3875 goto error_cleanup; |
|
|
3876 |
|
|
3877 data_is_group = 1; |
|
|
3878 |
|
|
3879 // recursively add each element of the structure to this group |
|
|
3880 Octave_map m = tc.map_value (); |
|
|
3881 Pix i = m.first (); |
|
|
3882 while (i) |
|
|
3883 { |
|
|
3884 bool retval2 = add_hdf5_data (data_id, |
|
|
3885 m.contents (i), m.key (i), "", |
|
|
3886 false, save_as_floats); |
|
|
3887 if (! retval2) |
|
|
3888 goto error_cleanup; |
|
|
3889 |
|
|
3890 // advance i to next element, or 0 |
|
|
3891 m.next (i); |
|
|
3892 } |
|
|
3893 } |
|
|
3894 else |
|
|
3895 { |
|
|
3896 gripe_wrong_type_arg ("save", tc, false); |
|
|
3897 goto error_cleanup; |
|
|
3898 } |
|
|
3899 |
|
|
3900 // attach doc string as comment: |
|
|
3901 if (doc.length () > 0 |
|
|
3902 && H5Gset_comment (loc_id, name.c_str (), doc.c_str ()) < 0) |
|
|
3903 goto error_cleanup; |
|
|
3904 |
|
|
3905 retval = 1; |
|
|
3906 |
|
|
3907 // if it's global, add an attribute "OCTAVE_GLOBAL" with value 1 |
|
|
3908 if (mark_as_global) |
|
3688
|
3909 retval = hdf5_add_attr (data_id, "OCTAVE_GLOBAL") >= 0; |
|
3687
|
3910 |
|
|
3911 error_cleanup: |
|
|
3912 |
|
|
3913 if (! retval) |
|
|
3914 error ("save: error while writing `%s' to hdf5 file", name.c_str ()); |
|
|
3915 |
|
|
3916 if (data_id >= 0) |
|
|
3917 { |
|
|
3918 if (data_is_group) |
|
|
3919 H5Gclose (data_id); |
|
|
3920 else |
|
|
3921 H5Dclose (data_id); |
|
|
3922 } |
|
|
3923 |
|
|
3924 if (space_id >= 0) |
|
|
3925 H5Sclose (space_id); |
|
|
3926 |
|
|
3927 if (type_id >= 0) |
|
|
3928 H5Tclose (type_id); |
|
|
3929 |
|
|
3930 return retval; |
|
|
3931 } |
|
|
3932 |
|
|
3933 // Write data from TC in HDF5 (binary) format to the stream OS, |
|
|
3934 // which must be an hdf5_ofstream, returning true on success. |
|
|
3935 |
|
|
3936 static bool |
|
|
3937 save_hdf5_data (std::ostream& os, const octave_value& tc, |
|
|
3938 const std::string& name, const std::string& doc, |
|
|
3939 bool mark_as_global, bool save_as_floats) |
|
|
3940 { |
|
|
3941 hdf5_ofstream& hs = (hdf5_ofstream&) os; |
|
|
3942 |
|
|
3943 return add_hdf5_data (hs.file_id, tc, name, doc, |
|
|
3944 mark_as_global, save_as_floats); |
|
|
3945 } |
|
|
3946 |
|
|
3947 #endif /* HAVE_HDF5 */ |
|
|
3948 |
|
3688
|
3949 static int |
|
|
3950 write_mat5_tag (std::ostream& is, int type, int bytes) |
|
|
3951 { |
|
|
3952 FOUR_BYTE_INT temp; |
|
|
3953 |
|
|
3954 if (bytes <= 4) |
|
|
3955 temp = (bytes << 16) + type; |
|
|
3956 else |
|
|
3957 { |
|
|
3958 temp = type; |
|
|
3959 if (! is.write ((char *)&temp, 4)) |
|
|
3960 goto data_write_error; |
|
|
3961 temp = bytes; |
|
|
3962 } |
|
|
3963 |
|
|
3964 if (! is.write ((char *)&temp, 4)) |
|
|
3965 goto data_write_error; |
|
|
3966 |
|
|
3967 return 0; |
|
|
3968 |
|
|
3969 data_write_error: |
|
|
3970 return 1; |
|
|
3971 } |
|
|
3972 |
|
|
3973 // write out the numeric values in M to OS, |
|
|
3974 // preceded by the appropriate tag. |
|
|
3975 static void |
|
|
3976 write_mat5_array (std::ostream& os, Matrix& m, const int save_as_floats) |
|
|
3977 { |
|
|
3978 int nr = m.rows (); |
|
|
3979 int nc = m.columns (); |
|
|
3980 double max_val, min_val; |
|
|
3981 save_type st = LS_DOUBLE; |
|
|
3982 mat5_data_type mst; |
|
|
3983 int size; |
|
|
3984 unsigned len; |
|
|
3985 double *data = m.fortran_vec (); |
|
|
3986 |
|
|
3987 // Have to use copy here to avoid writing over data accessed via |
|
|
3988 // Matrix::data(). |
|
|
3989 |
|
|
3990 #define MAT5_DO_WRITE(TYPE, data, count, stream) \ |
|
|
3991 do \ |
|
|
3992 { \ |
|
|
3993 TYPE *ptr = new TYPE [count]; \ |
|
|
3994 for (int i = 0; i < count; i++) \ |
|
|
3995 ptr[i] = X_CAST (TYPE, data[i]); \ |
|
|
3996 stream.write (X_CAST (char *, ptr), count * sizeof (TYPE)); \ |
|
|
3997 delete [] ptr ; \ |
|
|
3998 } \ |
|
|
3999 while (0) |
|
|
4000 |
|
|
4001 if (save_as_floats) |
|
|
4002 { |
|
|
4003 if (m.too_large_for_float ()) |
|
|
4004 { |
|
|
4005 warning ("save: some values too large to save as floats --"); |
|
|
4006 warning ("save: saving as doubles instead"); |
|
|
4007 } |
|
|
4008 else |
|
|
4009 st = LS_FLOAT; |
|
|
4010 } |
|
|
4011 |
|
|
4012 if (m.all_integers (max_val, min_val)) |
|
|
4013 st = get_save_type (max_val, min_val); |
|
|
4014 |
|
|
4015 switch (st) |
|
|
4016 { |
|
|
4017 default: |
|
|
4018 case LS_DOUBLE: mst = miDOUBLE; size = 8; break; |
|
|
4019 case LS_FLOAT: mst = miSINGLE; size = 4; break; |
|
|
4020 case LS_U_CHAR: mst = miUINT8; size = 1; break; |
|
|
4021 case LS_U_SHORT: mst = miUINT16; size = 2; break; |
|
|
4022 case LS_U_INT: mst = miUINT32; size = 4; break; |
|
|
4023 case LS_CHAR: mst = miINT8; size = 1; break; |
|
|
4024 case LS_SHORT: mst = miINT16; size = 2; break; |
|
|
4025 case LS_INT: mst = miINT32; size = 4; break; |
|
|
4026 } |
|
|
4027 |
|
|
4028 len = nr*nc*size; |
|
|
4029 write_mat5_tag (os, mst, len); |
|
|
4030 |
|
|
4031 { |
|
|
4032 switch (st) |
|
|
4033 { |
|
|
4034 case LS_U_CHAR: |
|
|
4035 MAT5_DO_WRITE (unsigned char, data, nr*nc, os); |
|
|
4036 break; |
|
|
4037 |
|
|
4038 case LS_U_SHORT: |
|
|
4039 MAT5_DO_WRITE (unsigned TWO_BYTE_INT, data, nr*nc, os); |
|
|
4040 break; |
|
|
4041 |
|
|
4042 case LS_U_INT: |
|
|
4043 MAT5_DO_WRITE (unsigned FOUR_BYTE_INT, data, nr*nc, os); |
|
|
4044 break; |
|
|
4045 |
|
|
4046 // provide for 64 bit ints, even though get_save_type does |
|
|
4047 // not yet implement them |
|
|
4048 #ifdef EIGHT_BYTE_INT |
|
|
4049 case LS_U_LONG: |
|
|
4050 MAT5_DO_WRITE (unsigned EIGHT_BYTE_INT, data, nr*nc, os); |
|
|
4051 break; |
|
|
4052 #endif |
|
|
4053 |
|
|
4054 case LS_CHAR: |
|
|
4055 MAT5_DO_WRITE (signed char, data, nr*nc, os); |
|
|
4056 break; |
|
|
4057 |
|
|
4058 case LS_SHORT: |
|
|
4059 MAT5_DO_WRITE (TWO_BYTE_INT, data, nr*nc, os); |
|
|
4060 break; |
|
|
4061 |
|
|
4062 case LS_INT: |
|
|
4063 MAT5_DO_WRITE (FOUR_BYTE_INT, data, nr*nc, os); |
|
|
4064 break; |
|
|
4065 |
|
|
4066 #ifdef EIGHT_BYTE_INT |
|
|
4067 case LS_LONG: |
|
|
4068 MAT5_DO_WRITE (EIGHT_BYTE_INT, data, nr*nc, os); |
|
|
4069 break; |
|
|
4070 #endif |
|
|
4071 |
|
|
4072 case LS_FLOAT: |
|
|
4073 MAT5_DO_WRITE (float, data, nr*nc, os); |
|
|
4074 break; |
|
|
4075 |
|
|
4076 case LS_DOUBLE: // No conversion necessary. |
|
|
4077 os.write (X_CAST (char *, data), len); |
|
|
4078 break; |
|
|
4079 |
|
|
4080 default: |
|
|
4081 (*current_liboctave_error_handler) |
|
|
4082 ("unrecognized data format requested"); |
|
|
4083 break; |
|
|
4084 } |
|
|
4085 } |
|
|
4086 if (PAD (len) > len) |
|
|
4087 { |
|
|
4088 static char buf[9]="\x00\x00\x00\x00\x00\x00\x00\x00"; |
|
|
4089 os.write (buf, PAD (len) - len); |
|
|
4090 } |
|
|
4091 } |
|
|
4092 |
|
|
4093 // save the data from TC along with the corresponding NAME on stream |
|
|
4094 // OS in the MatLab version 5 binary format. Return true on success. |
|
|
4095 |
|
|
4096 static bool |
|
|
4097 save_mat5_binary_element (std::ostream& os, |
|
|
4098 const octave_value& tc, const std::string& name, |
|
|
4099 bool mark_as_global, bool save_as_floats) |
|
|
4100 { |
|
|
4101 FOUR_BYTE_INT flags=0; |
|
|
4102 FOUR_BYTE_INT junk=0; |
|
|
4103 FOUR_BYTE_INT nr; |
|
|
4104 FOUR_BYTE_INT nc; |
|
3769
|
4105 std::streampos fixup, contin; |
|
3688
|
4106 |
|
|
4107 // element type and length |
|
|
4108 fixup = os.tellp (); |
|
|
4109 write_mat5_tag (os, miMATRIX, 99); // we don't know the real length yet |
|
|
4110 |
|
|
4111 // array flags subelement |
|
|
4112 write_mat5_tag (os, miUINT32, 8); |
|
|
4113 |
|
|
4114 if (mark_as_global) |
|
|
4115 flags |= 0x0400; |
|
|
4116 |
|
|
4117 if (tc.is_complex_scalar () || tc.is_complex_matrix ()) |
|
|
4118 flags |= 0x0800; |
|
|
4119 |
|
|
4120 if (tc.is_string ()) |
|
|
4121 flags |= mxCHAR_CLASS; |
|
|
4122 else if (tc.is_real_scalar ()) |
|
|
4123 flags |= mxDOUBLE_CLASS; |
|
3866
|
4124 else if (tc.is_real_matrix () || tc.is_range ()) |
|
3688
|
4125 flags |= mxDOUBLE_CLASS; |
|
|
4126 else if (tc.is_complex_scalar ()) |
|
|
4127 flags |= mxDOUBLE_CLASS; |
|
|
4128 else if (tc.is_complex_matrix ()) |
|
|
4129 flags |= mxDOUBLE_CLASS; |
|
|
4130 else if (tc.is_map ()) |
|
|
4131 flags |= mxSTRUCT_CLASS; |
|
|
4132 else |
|
|
4133 { |
|
|
4134 gripe_wrong_type_arg ("save", tc, false); |
|
|
4135 goto error_cleanup; |
|
|
4136 } |
|
|
4137 |
|
|
4138 os.write ((char *)&flags, 4); |
|
|
4139 os.write ((char *)&junk, 4); |
|
|
4140 |
|
|
4141 // dimensions array subelement |
|
3866
|
4142 if (tc.is_map ()) |
|
|
4143 { |
|
|
4144 nr = nc = 1; |
|
|
4145 } |
|
|
4146 else |
|
|
4147 { |
|
|
4148 nr = tc.rows (); |
|
|
4149 nc = tc.columns (); |
|
|
4150 } |
|
|
4151 |
|
|
4152 write_mat5_tag (os, miINT32, 8); |
|
|
4153 os.write ((char *)&nr, 4); |
|
|
4154 os.write ((char *)&nc, 4); |
|
3688
|
4155 |
|
|
4156 // array name subelement |
|
|
4157 { |
|
|
4158 int namelen = name.length (); |
|
|
4159 |
|
|
4160 if (namelen > 31) |
|
|
4161 namelen = 31; // only 31 char names permitted in mat file |
|
|
4162 |
|
|
4163 int paddedlength = PAD (namelen); |
|
|
4164 |
|
|
4165 write_mat5_tag (os, miINT8, namelen); |
|
|
4166 char * paddedname = new char [paddedlength]; |
|
|
4167 memset (paddedname, 0, paddedlength); |
|
|
4168 strncpy (paddedname, name.c_str (), namelen); |
|
|
4169 os.write (paddedname, paddedlength); |
|
|
4170 delete [] paddedname; |
|
|
4171 } |
|
|
4172 |
|
|
4173 // data element |
|
|
4174 if (tc.is_string ()) |
|
|
4175 { |
|
|
4176 charMatrix chm = tc.char_matrix_value (); |
|
|
4177 int nc = chm.cols (); |
|
|
4178 int len = nr*nc*2; |
|
|
4179 int paddedlength = PAD (nr*nc*2); |
|
|
4180 |
|
3895
|
4181 TWO_BYTE_INT *buf = new TWO_BYTE_INT[nc*nr+3]; |
|
3688
|
4182 write_mat5_tag (os, miUINT16, len); |
|
|
4183 |
|
|
4184 for (int i = 0; i < nr; i++) |
|
|
4185 { |
|
|
4186 std::string tstr = chm.row_as_string (i); |
|
|
4187 const char *s = tstr.data (); |
|
|
4188 |
|
|
4189 for (int j = 0; j < nc; j++) |
|
3895
|
4190 buf[j*nr+i] = *s++; |
|
3688
|
4191 } |
|
3895
|
4192 os.write ((char *)buf, nr*nc*2); |
|
3688
|
4193 |
|
|
4194 if (paddedlength > len) |
|
|
4195 os.write ((char *)buf, paddedlength - len); |
|
|
4196 |
|
|
4197 delete [] buf; |
|
|
4198 } |
|
3866
|
4199 else if (tc.is_real_scalar () || tc.is_real_matrix () || tc.is_range ()) |
|
3688
|
4200 { |
|
|
4201 Matrix m = tc.matrix_value (); |
|
|
4202 |
|
|
4203 write_mat5_array (os, m, save_as_floats); |
|
|
4204 } |
|
|
4205 else if (tc.is_complex_scalar () || tc.is_complex_matrix ()) |
|
|
4206 { |
|
|
4207 ComplexMatrix m_cmplx = tc.complex_matrix_value (); |
|
|
4208 Matrix m = ::real (m_cmplx); |
|
|
4209 |
|
|
4210 for (int part=0; part < 2; part++) |
|
|
4211 { |
|
|
4212 // real part, then complex part |
|
|
4213 write_mat5_array (os, m, save_as_floats); |
|
|
4214 m = ::imag (m_cmplx); |
|
|
4215 } |
|
|
4216 } |
|
|
4217 else if (tc.is_map ()) |
|
|
4218 { |
|
|
4219 // an Octave structure */ |
|
|
4220 // recursively write each element of the structure |
|
|
4221 Octave_map m = tc.map_value (); |
|
|
4222 Pix i; |
|
|
4223 |
|
|
4224 { |
|
|
4225 char buf[32]; |
|
|
4226 FOUR_BYTE_INT maxfieldnamelength = 32; |
|
|
4227 int fieldcnt = 0; |
|
|
4228 |
|
|
4229 for (i = m.first (); i; m.next (i)) |
|
|
4230 fieldcnt++; |
|
|
4231 |
|
|
4232 write_mat5_tag (os, miINT32, 4); |
|
|
4233 os.write ((char *)&maxfieldnamelength, 4); |
|
|
4234 write_mat5_tag (os, miINT8, fieldcnt*32); |
|
|
4235 |
|
|
4236 for (i = m.first (); i; m.next (i)) |
|
|
4237 { |
|
|
4238 // write the name of each element |
|
3769
|
4239 std::string tstr = m.key (i); |
|
3688
|
4240 memset (buf, 0, 32); |
|
|
4241 strncpy (buf, tstr.c_str (), 31); // only 31 char names permitted |
|
|
4242 os.write (buf, 32); |
|
|
4243 } |
|
|
4244 |
|
|
4245 for (i = m.first (); i; m.next (i)) |
|
|
4246 { |
|
|
4247 // write the data of each element |
|
|
4248 bool retval2 = save_mat5_binary_element (os, m.contents (i), "", |
|
|
4249 mark_as_global, |
|
|
4250 save_as_floats); |
|
|
4251 |
|
|
4252 if (! retval2) |
|
|
4253 goto error_cleanup; |
|
|
4254 } |
|
|
4255 } |
|
|
4256 } |
|
|
4257 else |
|
|
4258 gripe_wrong_type_arg ("save", tc, false); |
|
|
4259 |
|
|
4260 contin = os.tellp (); |
|
|
4261 os.seekp (fixup); |
|
3841
|
4262 write_mat5_tag (os, miMATRIX, |
|
|
4263 static_cast<int>(contin - fixup) - 8); // the actual length |
|
3688
|
4264 os.seekp (contin); |
|
|
4265 |
|
|
4266 return true; |
|
|
4267 |
|
|
4268 error_cleanup: |
|
|
4269 error ("save: error while writing `%s' to MAT file", name.c_str ()); |
|
|
4270 |
|
|
4271 return false; |
|
|
4272 } |
|
|
4273 |
|
667
|
4274 // Save the data from TC along with the corresponding NAME on stream OS |
|
3688
|
4275 // in the MatLab version 4 binary format. |
|
667
|
4276 |
|
2799
|
4277 static bool |
|
3523
|
4278 save_mat_binary_data (std::ostream& os, const octave_value& tc, |
|
|
4279 const std::string& name) |
|
667
|
4280 { |
|
|
4281 FOUR_BYTE_INT mopt = 0; |
|
|
4282 |
|
|
4283 mopt += tc.is_string () ? 1 : 0; |
|
2318
|
4284 |
|
|
4285 oct_mach_info::float_format flt_fmt = |
|
|
4286 oct_mach_info::native_float_format ();; |
|
|
4287 |
|
|
4288 mopt += 1000 * float_format_to_mopt_digit (flt_fmt); |
|
667
|
4289 |
|
3557
|
4290 os.write (X_CAST (char *, &mopt), 4); |
|
667
|
4291 |
|
|
4292 FOUR_BYTE_INT nr = tc.rows (); |
|
3557
|
4293 os.write (X_CAST (char *, &nr), 4); |
|
667
|
4294 |
|
|
4295 FOUR_BYTE_INT nc = tc.columns (); |
|
3557
|
4296 os.write (X_CAST (char *, &nc), 4); |
|
667
|
4297 |
|
|
4298 int len = nr * nc; |
|
|
4299 |
|
|
4300 FOUR_BYTE_INT imag = tc.is_complex_type () ? 1 : 0; |
|
3557
|
4301 os.write (X_CAST (char *, &imag), 4); |
|
667
|
4302 |
|
2345
|
4303 // LEN includes the terminating character, and the file is also |
|
|
4304 // supposed to include it. |
|
|
4305 |
|
|
4306 FOUR_BYTE_INT name_len = name.length () + 1; |
|
667
|
4307 |
|
3557
|
4308 os.write (X_CAST (char *, &name_len), 4); |
|
2345
|
4309 os << name << '\0'; |
|
667
|
4310 |
|
3233
|
4311 if (tc.is_string ()) |
|
|
4312 { |
|
|
4313 unwind_protect::begin_frame ("save_mat_binary_data"); |
|
|
4314 unwind_protect_int (Vimplicit_str_to_num_ok); |
|
|
4315 Vimplicit_str_to_num_ok = true; |
|
|
4316 Matrix m = tc.matrix_value (); |
|
3557
|
4317 os.write (X_CAST (char *, m.data ()), 8 * len); |
|
3233
|
4318 unwind_protect::run_frame ("save_mat_binary_data"); |
|
|
4319 } |
|
|
4320 else if (tc.is_range ()) |
|
|
4321 { |
|
|
4322 Range r = tc.range_value (); |
|
|
4323 double base = r.base (); |
|
|
4324 double inc = r.inc (); |
|
|
4325 int nel = r.nelem (); |
|
|
4326 for (int i = 0; i < nel; i++) |
|
|
4327 { |
|
|
4328 double x = base + i * inc; |
|
3557
|
4329 os.write (X_CAST (char *, &x), 8); |
|
3233
|
4330 } |
|
|
4331 } |
|
|
4332 else if (tc.is_real_scalar ()) |
|
667
|
4333 { |
|
|
4334 double tmp = tc.double_value (); |
|
3557
|
4335 os.write (X_CAST (char *, &tmp), 8); |
|
667
|
4336 } |
|
911
|
4337 else if (tc.is_real_matrix ()) |
|
667
|
4338 { |
|
|
4339 Matrix m = tc.matrix_value (); |
|
3557
|
4340 os.write (X_CAST (char *, m.data ()), 8 * len); |
|
667
|
4341 } |
|
|
4342 else if (tc.is_complex_scalar ()) |
|
|
4343 { |
|
|
4344 Complex tmp = tc.complex_value (); |
|
3557
|
4345 os.write (X_CAST (char *, &tmp), 16); |
|
667
|
4346 } |
|
|
4347 else if (tc.is_complex_matrix ()) |
|
|
4348 { |
|
|
4349 ComplexMatrix m_cmplx = tc.complex_matrix_value (); |
|
3688
|
4350 Matrix m = ::real (m_cmplx); |
|
3557
|
4351 os.write (X_CAST (char *, m.data ()), 8 * len); |
|
3688
|
4352 m = ::imag (m_cmplx); |
|
3557
|
4353 os.write (X_CAST (char *, m.data ()), 8 * len); |
|
667
|
4354 } |
|
|
4355 else |
|
2799
|
4356 gripe_wrong_type_arg ("save", tc, false); |
|
|
4357 |
|
|
4358 return os; |
|
667
|
4359 } |
|
|
4360 |
|
620
|
4361 static void |
|
3523
|
4362 ascii_save_type (std::ostream& os, const char *type, bool mark_as_global) |
|
620
|
4363 { |
|
|
4364 if (mark_as_global) |
|
|
4365 os << "# type: global "; |
|
|
4366 else |
|
|
4367 os << "# type: "; |
|
|
4368 |
|
|
4369 os << type << "\n"; |
|
|
4370 } |
|
|
4371 |
|
872
|
4372 static Matrix |
|
|
4373 strip_infnan (const Matrix& m) |
|
|
4374 { |
|
|
4375 int nr = m.rows (); |
|
|
4376 int nc = m.columns (); |
|
|
4377 |
|
|
4378 Matrix retval (nr, nc); |
|
|
4379 |
|
|
4380 int k = 0; |
|
|
4381 for (int i = 0; i < nr; i++) |
|
|
4382 { |
|
|
4383 for (int j = 0; j < nc; j++) |
|
|
4384 { |
|
2305
|
4385 double d = m (i, j); |
|
872
|
4386 if (xisnan (d)) |
|
|
4387 goto next_row; |
|
|
4388 else |
|
2305
|
4389 retval (k, j) = xisinf (d) ? (d > 0 ? OCT_RBV : -OCT_RBV) : d; |
|
872
|
4390 } |
|
|
4391 k++; |
|
|
4392 |
|
|
4393 next_row: |
|
|
4394 continue; |
|
|
4395 } |
|
|
4396 |
|
|
4397 if (k > 0) |
|
|
4398 retval.resize (k, nc); |
|
|
4399 |
|
|
4400 return retval; |
|
|
4401 } |
|
|
4402 |
|
|
4403 static ComplexMatrix |
|
|
4404 strip_infnan (const ComplexMatrix& m) |
|
|
4405 { |
|
|
4406 int nr = m.rows (); |
|
|
4407 int nc = m.columns (); |
|
|
4408 |
|
|
4409 ComplexMatrix retval (nr, nc); |
|
|
4410 |
|
|
4411 int k = 0; |
|
|
4412 for (int i = 0; i < nr; i++) |
|
|
4413 { |
|
|
4414 for (int j = 0; j < nc; j++) |
|
|
4415 { |
|
2305
|
4416 Complex c = m (i, j); |
|
872
|
4417 if (xisnan (c)) |
|
|
4418 goto next_row; |
|
|
4419 else |
|
|
4420 { |
|
|
4421 double re = real (c); |
|
|
4422 double im = imag (c); |
|
|
4423 |
|
|
4424 re = xisinf (re) ? (re > 0 ? OCT_RBV : -OCT_RBV) : re; |
|
|
4425 im = xisinf (im) ? (im > 0 ? OCT_RBV : -OCT_RBV) : im; |
|
|
4426 |
|
2305
|
4427 retval (k, j) = Complex (re, im); |
|
872
|
4428 } |
|
|
4429 } |
|
|
4430 k++; |
|
|
4431 |
|
|
4432 next_row: |
|
|
4433 continue; |
|
|
4434 } |
|
|
4435 |
|
|
4436 if (k > 0) |
|
|
4437 retval.resize (k, nc); |
|
|
4438 |
|
|
4439 return retval; |
|
|
4440 } |
|
|
4441 |
|
620
|
4442 // Save the data from TC along with the corresponding NAME, and global |
|
604
|
4443 // flag MARK_AS_GLOBAL on stream OS in the plain text format described |
|
1755
|
4444 // above for load_ascii_data. If NAME is empty, the name: line is not |
|
604
|
4445 // generated. PRECISION specifies the number of decimal digits to print. |
|
3019
|
4446 // If STRIP_NAN_AND_INF is TRUE, rows containing NaNs are deleted, |
|
872
|
4447 // and Infinite values are converted to +/-OCT_RBV (A Real Big Value, |
|
|
4448 // but not so big that gnuplot can't handle it when trying to compute |
|
|
4449 // axis ranges, etc.). |
|
|
4450 // |
|
|
4451 // Assumes ranges and strings cannot contain Inf or NaN values. |
|
|
4452 // |
|
|
4453 // Returns 1 for success and 0 for failure. |
|
604
|
4454 |
|
|
4455 // XXX FIXME XXX -- should probably write the help string here too. |
|
|
4456 |
|
3738
|
4457 static bool |
|
3523
|
4458 save_ascii_data (std::ostream& os, const octave_value& tc, |
|
3738
|
4459 const std::string& name, bool& infnan_warned, |
|
|
4460 bool strip_nan_and_inf, bool mark_as_global, |
|
|
4461 int precision) |
|
604
|
4462 { |
|
2799
|
4463 bool success = true; |
|
620
|
4464 |
|
604
|
4465 if (! precision) |
|
2194
|
4466 precision = Vsave_precision; |
|
604
|
4467 |
|
1755
|
4468 if (! name.empty ()) |
|
604
|
4469 os << "# name: " << name << "\n"; |
|
|
4470 |
|
|
4471 long old_precision = os.precision (); |
|
|
4472 os.precision (precision); |
|
|
4473 |
|
3233
|
4474 if (tc.is_string ()) |
|
|
4475 { |
|
|
4476 ascii_save_type (os, "string array", mark_as_global); |
|
|
4477 charMatrix chm = tc.char_matrix_value (); |
|
|
4478 int elements = chm.rows (); |
|
|
4479 os << "# elements: " << elements << "\n"; |
|
|
4480 for (int i = 0; i < elements; i++) |
|
|
4481 { |
|
3841
|
4482 unsigned len = chm.cols (); |
|
3233
|
4483 os << "# length: " << len << "\n"; |
|
3836
|
4484 std::string tstr = chm.row_as_string (i, false, true); |
|
3233
|
4485 const char *tmp = tstr.data (); |
|
3836
|
4486 if (tstr.length () > len) |
|
|
4487 panic_impossible (); |
|
3557
|
4488 os.write (X_CAST (char *, tmp), len); |
|
3233
|
4489 os << "\n"; |
|
|
4490 } |
|
|
4491 } |
|
|
4492 else if (tc.is_range ()) |
|
|
4493 { |
|
|
4494 ascii_save_type (os, "range", mark_as_global); |
|
|
4495 Range tmp = tc.range_value (); |
|
|
4496 os << "# base, limit, increment\n" |
|
|
4497 << tmp.base () << " " |
|
|
4498 << tmp.limit () << " " |
|
|
4499 << tmp.inc () << "\n"; |
|
|
4500 } |
|
|
4501 else if (tc.is_real_scalar ()) |
|
620
|
4502 { |
|
|
4503 ascii_save_type (os, "scalar", mark_as_global); |
|
872
|
4504 |
|
|
4505 double d = tc.double_value (); |
|
3738
|
4506 |
|
872
|
4507 if (strip_nan_and_inf) |
|
|
4508 { |
|
|
4509 if (xisnan (d)) |
|
|
4510 { |
|
|
4511 error ("only value to plot is NaN"); |
|
2799
|
4512 success = false; |
|
872
|
4513 } |
|
|
4514 else |
|
|
4515 { |
|
|
4516 d = xisinf (d) ? (d > 0 ? OCT_RBV : -OCT_RBV) : d; |
|
|
4517 os << d << "\n"; |
|
|
4518 } |
|
|
4519 } |
|
|
4520 else |
|
3738
|
4521 { |
|
|
4522 if (! infnan_warned && (xisnan (d) || xisinf (d))) |
|
|
4523 { |
|
|
4524 warning ("save: Inf or NaN values may not be reloadable"); |
|
|
4525 infnan_warned = true; |
|
|
4526 } |
|
|
4527 |
|
|
4528 os << d << "\n"; |
|
|
4529 } |
|
620
|
4530 } |
|
|
4531 else if (tc.is_real_matrix ()) |
|
|
4532 { |
|
|
4533 ascii_save_type (os, "matrix", mark_as_global); |
|
3738
|
4534 |
|
620
|
4535 os << "# rows: " << tc.rows () << "\n" |
|
872
|
4536 << "# columns: " << tc.columns () << "\n"; |
|
|
4537 |
|
|
4538 Matrix tmp = tc.matrix_value (); |
|
3738
|
4539 |
|
872
|
4540 if (strip_nan_and_inf) |
|
|
4541 tmp = strip_infnan (tmp); |
|
3738
|
4542 else if (! infnan_warned && tmp.any_element_is_inf_or_nan ()) |
|
|
4543 { |
|
|
4544 warning ("save: Inf or NaN values may not be reloadable"); |
|
|
4545 infnan_warned = true; |
|
|
4546 } |
|
872
|
4547 |
|
|
4548 os << tmp; |
|
620
|
4549 } |
|
|
4550 else if (tc.is_complex_scalar ()) |
|
|
4551 { |
|
|
4552 ascii_save_type (os, "complex scalar", mark_as_global); |
|
872
|
4553 |
|
|
4554 Complex c = tc.complex_value (); |
|
3738
|
4555 |
|
872
|
4556 if (strip_nan_and_inf) |
|
|
4557 { |
|
|
4558 if (xisnan (c)) |
|
|
4559 { |
|
|
4560 error ("only value to plot is NaN"); |
|
2799
|
4561 success = false; |
|
872
|
4562 } |
|
|
4563 else |
|
|
4564 { |
|
|
4565 double re = real (c); |
|
|
4566 double im = imag (c); |
|
|
4567 |
|
|
4568 re = xisinf (re) ? (re > 0 ? OCT_RBV : -OCT_RBV) : re; |
|
|
4569 im = xisinf (im) ? (im > 0 ? OCT_RBV : -OCT_RBV) : im; |
|
|
4570 |
|
|
4571 c = Complex (re, im); |
|
|
4572 |
|
|
4573 os << c << "\n"; |
|
|
4574 } |
|
|
4575 } |
|
|
4576 else |
|
3738
|
4577 { |
|
|
4578 if (! infnan_warned && (xisnan (c) || xisinf (c))) |
|
|
4579 { |
|
|
4580 warning ("save: Inf or NaN values may not be reloadable"); |
|
|
4581 infnan_warned = true; |
|
|
4582 } |
|
|
4583 |
|
|
4584 os << c << "\n"; |
|
|
4585 } |
|
620
|
4586 } |
|
|
4587 else if (tc.is_complex_matrix ()) |
|
604
|
4588 { |
|
620
|
4589 ascii_save_type (os, "complex matrix", mark_as_global); |
|
3738
|
4590 |
|
620
|
4591 os << "# rows: " << tc.rows () << "\n" |
|
875
|
4592 << "# columns: " << tc.columns () << "\n"; |
|
|
4593 |
|
|
4594 ComplexMatrix tmp = tc.complex_matrix_value (); |
|
3738
|
4595 |
|
872
|
4596 if (strip_nan_and_inf) |
|
|
4597 tmp = strip_infnan (tmp); |
|
3738
|
4598 else if (! infnan_warned && tmp.any_element_is_inf_or_nan ()) |
|
|
4599 { |
|
|
4600 warning ("save: Inf or NaN values may not be reloadable"); |
|
|
4601 infnan_warned = true; |
|
|
4602 } |
|
872
|
4603 |
|
|
4604 os << tmp; |
|
620
|
4605 } |
|
|
4606 else |
|
2799
|
4607 gripe_wrong_type_arg ("save", tc, false); |
|
604
|
4608 |
|
|
4609 os.precision (old_precision); |
|
|
4610 |
|
872
|
4611 return (os && success); |
|
604
|
4612 } |
|
|
4613 |
|
3738
|
4614 bool |
|
|
4615 save_ascii_data_for_plotting (std::ostream& os, const octave_value& t, |
|
|
4616 const std::string& name) |
|
|
4617 { |
|
|
4618 bool infnan_warned = true; |
|
|
4619 |
|
3769
|
4620 return save_ascii_data (os, t, name, infnan_warned, true, false, 0); |
|
3738
|
4621 } |
|
|
4622 |
|
604
|
4623 // Save the info from sr on stream os in the format specified by fmt. |
|
|
4624 |
|
|
4625 static void |
|
3523
|
4626 do_save (std::ostream& os, symbol_record *sr, load_save_format fmt, |
|
3738
|
4627 int save_as_floats, bool& infnan_warned) |
|
604
|
4628 { |
|
|
4629 if (! sr->is_variable ()) |
|
|
4630 { |
|
|
4631 error ("save: can only save variables, not functions"); |
|
|
4632 return; |
|
|
4633 } |
|
|
4634 |
|
3523
|
4635 std::string name = sr->name (); |
|
|
4636 std::string help = sr->help (); |
|
604
|
4637 int global = sr->is_linked_to_global (); |
|
2970
|
4638 |
|
|
4639 octave_value tc = sr->def (); |
|
604
|
4640 |
|
1755
|
4641 if (tc.is_undefined ()) |
|
604
|
4642 return; |
|
|
4643 |
|
|
4644 switch (fmt) |
|
|
4645 { |
|
|
4646 case LS_ASCII: |
|
3738
|
4647 save_ascii_data (os, tc, name, infnan_warned, false, global, 0); |
|
604
|
4648 break; |
|
|
4649 |
|
|
4650 case LS_BINARY: |
|
630
|
4651 save_binary_data (os, tc, name, help, global, save_as_floats); |
|
604
|
4652 break; |
|
|
4653 |
|
667
|
4654 case LS_MAT_BINARY: |
|
|
4655 save_mat_binary_data (os, tc, name); |
|
|
4656 break; |
|
|
4657 |
|
3687
|
4658 #ifdef HAVE_HDF5 |
|
|
4659 case LS_HDF5: |
|
|
4660 save_hdf5_data (os, tc, name, help, global, save_as_floats); |
|
|
4661 break; |
|
|
4662 #endif /* HAVE_HDF5 */ |
|
|
4663 |
|
3688
|
4664 case LS_MAT5_BINARY: |
|
|
4665 save_mat5_binary_element (os, tc, name, global, save_as_floats); |
|
|
4666 break; |
|
|
4667 |
|
604
|
4668 default: |
|
775
|
4669 gripe_unrecognized_data_fmt ("save"); |
|
604
|
4670 break; |
|
|
4671 } |
|
|
4672 } |
|
|
4673 |
|
|
4674 // Save variables with names matching PATTERN on stream OS in the |
|
3019
|
4675 // format specified by FMT. If SAVE_BUILTINS is TRUE, also save |
|
604
|
4676 // builtin variables with names that match PATTERN. |
|
|
4677 |
|
|
4678 static int |
|
3523
|
4679 save_vars (std::ostream& os, const std::string& pattern, bool save_builtins, |
|
630
|
4680 load_save_format fmt, int save_as_floats) |
|
604
|
4681 { |
|
3355
|
4682 Array<symbol_record *> vars = curr_sym_tab->glob |
|
|
4683 (pattern, symbol_record::USER_VARIABLE, SYMTAB_ALL_SCOPES); |
|
|
4684 |
|
|
4685 int saved = vars.length (); |
|
|
4686 |
|
3738
|
4687 bool infnan_warned = false; |
|
|
4688 |
|
3355
|
4689 for (int i = 0; i < saved; i++) |
|
620
|
4690 { |
|
3738
|
4691 do_save (os, vars (i), fmt, save_as_floats, infnan_warned); |
|
620
|
4692 |
|
|
4693 if (error_state) |
|
|
4694 break; |
|
|
4695 } |
|
604
|
4696 |
|
620
|
4697 if (! error_state && save_builtins) |
|
604
|
4698 { |
|
3355
|
4699 vars = global_sym_tab->glob |
|
|
4700 (pattern, symbol_record::BUILTIN_VARIABLE, SYMTAB_ALL_SCOPES); |
|
|
4701 |
|
|
4702 int count = vars.length (); |
|
604
|
4703 |
|
|
4704 saved += count; |
|
|
4705 |
|
3355
|
4706 for (int i = 0; i < count; i++) |
|
620
|
4707 { |
|
3738
|
4708 do_save (os, vars (i), fmt, save_as_floats, infnan_warned); |
|
620
|
4709 |
|
|
4710 if (error_state) |
|
|
4711 break; |
|
|
4712 } |
|
604
|
4713 } |
|
|
4714 |
|
|
4715 return saved; |
|
|
4716 } |
|
|
4717 |
|
|
4718 static load_save_format |
|
|
4719 get_default_save_format (void) |
|
|
4720 { |
|
|
4721 load_save_format retval = LS_ASCII; |
|
|
4722 |
|
3523
|
4723 std::string fmt = Vdefault_save_format; |
|
1755
|
4724 |
|
|
4725 if (fmt == "binary") |
|
604
|
4726 retval = LS_BINARY; |
|
1755
|
4727 else if (fmt == "mat-binary" || fmt =="mat_binary") |
|
3688
|
4728 retval = LS_MAT5_BINARY; |
|
|
4729 else if (fmt == "mat4-binary" || fmt =="mat4_binary") |
|
911
|
4730 retval = LS_MAT_BINARY; |
|
3687
|
4731 #ifdef HAVE_HDF5 |
|
|
4732 else if (fmt == "hdf5") |
|
|
4733 retval = LS_HDF5; |
|
|
4734 #endif /* HAVE_HDF5 */ |
|
604
|
4735 |
|
|
4736 return retval; |
|
|
4737 } |
|
|
4738 |
|
863
|
4739 static void |
|
3523
|
4740 write_header (std::ostream& os, load_save_format format) |
|
863
|
4741 { |
|
3185
|
4742 switch (format) |
|
863
|
4743 { |
|
3185
|
4744 case LS_BINARY: |
|
|
4745 { |
|
|
4746 os << (oct_mach_info::words_big_endian () |
|
|
4747 ? "Octave-1-B" : "Octave-1-L"); |
|
|
4748 |
|
|
4749 oct_mach_info::float_format flt_fmt = |
|
|
4750 oct_mach_info::native_float_format (); |
|
|
4751 |
|
|
4752 char tmp = (char) float_format_to_mopt_digit (flt_fmt); |
|
|
4753 |
|
3557
|
4754 os.write (X_CAST (char *, &tmp), 1); |
|
3185
|
4755 } |
|
3688
|
4756 break; |
|
|
4757 |
|
|
4758 case LS_MAT5_BINARY: |
|
|
4759 { |
|
3775
|
4760 char const * versionmagic; |
|
3688
|
4761 TWO_BYTE_INT number = *(TWO_BYTE_INT *)"\x00\x01"; |
|
|
4762 struct tm bdt; |
|
|
4763 time_t now; |
|
|
4764 char headertext[128]; |
|
|
4765 |
|
|
4766 time (&now); |
|
|
4767 bdt = *gmtime (&now); |
|
|
4768 memset (headertext, ' ', 124); |
|
|
4769 // ISO 8601 format date |
|
|
4770 strftime (headertext, 124, "MATLAB 5.0 MAT-file, written by Octave " |
|
|
4771 OCTAVE_VERSION ", %Y-%m-%d %T UTC", &bdt); |
|
|
4772 |
|
|
4773 // The first pair of bytes give the version of the MAT file |
|
|
4774 // format. The second pair of bytes form a magic number which |
|
|
4775 // signals a MAT file. MAT file data are always written in |
|
|
4776 // native byte order. The order of the bytes in the second |
|
|
4777 // pair indicates whether the file was written by a big- or |
|
|
4778 // little-endian machine. However, the version number is |
|
|
4779 // written in the *opposite* byte order from everything else! |
|
|
4780 if (number == 1) |
|
|
4781 versionmagic = "\x01\x00\x4d\x49"; // this machine is big endian |
|
|
4782 else |
|
|
4783 versionmagic = "\x00\x01\x49\x4d"; // this machine is little endian |
|
|
4784 |
|
|
4785 memcpy (headertext+124, versionmagic, 4); |
|
|
4786 os.write (headertext, 128); |
|
|
4787 } |
|
|
4788 |
|
|
4789 break; |
|
3185
|
4790 |
|
3687
|
4791 #ifdef HAVE_HDF5 |
|
|
4792 case LS_HDF5: |
|
|
4793 #endif /* HAVE_HDF5 */ |
|
3185
|
4794 case LS_ASCII: |
|
|
4795 { |
|
3709
|
4796 octave_localtime now; |
|
|
4797 |
|
|
4798 std::string comment_string = now.strftime (Vsave_header_format_string); |
|
|
4799 |
|
|
4800 if (! comment_string.empty ()) |
|
|
4801 { |
|
3687
|
4802 #ifdef HAVE_HDF5 |
|
3709
|
4803 if (format == LS_HDF5) |
|
|
4804 { |
|
|
4805 hdf5_ofstream& hs = (hdf5_ofstream&) os; |
|
|
4806 H5Gset_comment (hs.file_id, "/", comment_string.c_str ()); |
|
|
4807 } |
|
|
4808 else |
|
3687
|
4809 #endif /* HAVE_HDF5 */ |
|
3709
|
4810 os << comment_string << "\n"; |
|
3687
|
4811 } |
|
3185
|
4812 } |
|
|
4813 break; |
|
|
4814 |
|
|
4815 default: |
|
|
4816 break; |
|
863
|
4817 } |
|
|
4818 } |
|
|
4819 |
|
|
4820 static void |
|
3769
|
4821 save_vars (const string_vector& argv, int argv_idx, int argc, |
|
3523
|
4822 std::ostream& os, bool save_builtins, load_save_format fmt, |
|
3185
|
4823 bool save_as_floats, bool write_header_info) |
|
863
|
4824 { |
|
3185
|
4825 if (write_header_info) |
|
|
4826 write_header (os, fmt); |
|
863
|
4827 |
|
1755
|
4828 if (argv_idx == argc) |
|
863
|
4829 { |
|
|
4830 save_vars (os, "*", save_builtins, fmt, save_as_floats); |
|
|
4831 } |
|
|
4832 else |
|
|
4833 { |
|
1755
|
4834 for (int i = argv_idx; i < argc; i++) |
|
863
|
4835 { |
|
1755
|
4836 if (! save_vars (os, argv[i], save_builtins, fmt, save_as_floats)) |
|
863
|
4837 { |
|
1755
|
4838 warning ("save: no such variable `%s'", argv[i].c_str ()); |
|
863
|
4839 } |
|
|
4840 } |
|
|
4841 } |
|
|
4842 } |
|
|
4843 |
|
1380
|
4844 void |
|
|
4845 save_user_variables (void) |
|
|
4846 { |
|
3189
|
4847 if (Vcrash_dumps_octave_core) |
|
1380
|
4848 { |
|
3189
|
4849 // XXX FIXME XXX -- should choose better file name? |
|
|
4850 |
|
|
4851 const char *fname = "octave-core"; |
|
|
4852 |
|
|
4853 message (0, "attempting to save variables to `%s'...", fname); |
|
|
4854 |
|
|
4855 load_save_format format = get_default_save_format (); |
|
|
4856 |
|
3775
|
4857 std::ios::openmode mode = std::ios::out|std::ios::trunc; |
|
3688
|
4858 if (format == LS_BINARY || |
|
|
4859 format == LS_MAT_BINARY || |
|
|
4860 format == LS_MAT5_BINARY) |
|
3552
|
4861 mode |= std::ios::binary; |
|
3189
|
4862 |
|
3687
|
4863 #ifdef HAVE_HDF5 |
|
|
4864 if (format == LS_HDF5) |
|
3189
|
4865 { |
|
3687
|
4866 hdf5_ofstream file (fname); |
|
|
4867 |
|
|
4868 if (file.file_id >= 0) |
|
|
4869 { |
|
|
4870 save_vars (string_vector (), 0, 0, file, |
|
|
4871 false, format, false, true); |
|
|
4872 |
|
|
4873 message (0, "save to `%s' complete", fname); |
|
|
4874 |
|
|
4875 file.close (); |
|
|
4876 } |
|
|
4877 else |
|
|
4878 warning ("unable to open `%s' for writing...", fname); |
|
3189
|
4879 } |
|
|
4880 else |
|
3687
|
4881 #endif /* HAVE_HDF5 */ |
|
|
4882 // don't insert any commands here! The open brace below must |
|
|
4883 // go with the else above! |
|
|
4884 { |
|
|
4885 std::ofstream file (fname, mode); |
|
|
4886 |
|
|
4887 if (file) |
|
|
4888 { |
|
|
4889 save_vars (string_vector (), 0, 0, file, |
|
|
4890 false, format, false, true); |
|
|
4891 message (0, "save to `%s' complete", fname); |
|
|
4892 file.close (); |
|
|
4893 } |
|
|
4894 else |
|
|
4895 warning ("unable to open `%s' for writing...", fname); |
|
|
4896 } |
|
1380
|
4897 } |
|
|
4898 } |
|
|
4899 |
|
1957
|
4900 DEFUN_TEXT (save, args, , |
|
3372
|
4901 "-*- texinfo -*-\n\ |
|
|
4902 @deffn {Command} save options file v1 v2 @dots{}\n\ |
|
|
4903 Save the named variables @var{v1}, @var{v2}, @dots{} in the file\n\ |
|
|
4904 @var{file}. The special filename @samp{-} can be used to write the\n\ |
|
|
4905 output to your terminal. If no variable names are listed, Octave saves\n\ |
|
|
4906 all the variables in the current scope. Valid options for the\n\ |
|
|
4907 @code{save} command are listed in the following table. Options that\n\ |
|
|
4908 modify the output format override the format specified by the built-in\n\ |
|
|
4909 variable @code{default_save_format}.\n\ |
|
|
4910 \n\ |
|
|
4911 @table @code\n\ |
|
|
4912 @item -ascii\n\ |
|
|
4913 Save the data in Octave's text data format.\n\ |
|
|
4914 \n\ |
|
|
4915 @item -binary\n\ |
|
|
4916 Save the data in Octave's binary data format.\n\ |
|
|
4917 \n\ |
|
|
4918 @item -float-binary\n\ |
|
|
4919 Save the data in Octave's binary data format but only using single\n\ |
|
|
4920 precision. You should use this format only if you know that all the\n\ |
|
|
4921 values to be saved can be represented in single precision.\n\ |
|
|
4922 \n\ |
|
|
4923 @item -mat-binary\n\ |
|
|
4924 Save the data in @sc{Matlab}'s binary data format.\n\ |
|
|
4925 \n\ |
|
3688
|
4926 @item -mat4-binary\n\ |
|
|
4927 Save the data in the binary format written by @sc{Matlab} version 4.\n\ |
|
|
4928 \n\ |
|
3687
|
4929 @item -hdf5\n\ |
|
|
4930 Save the data in HDF5 format.\n\ |
|
|
4931 (HDF5 is a free, portable binary format developed by the National\n\ |
|
|
4932 Center for Supercomputing Applications at the University of Illinois.)\n" |
|
|
4933 |
|
|
4934 HAVE_HDF5_HELP_STRING |
|
|
4935 |
|
|
4936 "\n\ |
|
|
4937 @item -float-hdf5\n\ |
|
|
4938 Save the data in HDF5 format but only using single precision.\n\ |
|
|
4939 You should use this format only if you know that all the\n\ |
|
|
4940 values to be saved can be represented in single precision.\n\ |
|
|
4941 \n\ |
|
3372
|
4942 @item -save-builtins\n\ |
|
|
4943 Force Octave to save the values of built-in variables too. By default,\n\ |
|
|
4944 Octave does not save built-in variables.\n\ |
|
|
4945 @end table\n\ |
|
604
|
4946 \n\ |
|
3372
|
4947 The list of variables to save may include wildcard patterns containing\n\ |
|
|
4948 the following special characters:\n\ |
|
|
4949 @table @code\n\ |
|
|
4950 @item ?\n\ |
|
|
4951 Match any single character.\n\ |
|
|
4952 \n\ |
|
|
4953 @item *\n\ |
|
|
4954 Match zero or more characters.\n\ |
|
|
4955 \n\ |
|
|
4956 @item [ @var{list} ]\n\ |
|
|
4957 Match the list of characters specified by @var{list}. If the first\n\ |
|
|
4958 character is @code{!} or @code{^}, match all characters except those\n\ |
|
|
4959 specified by @var{list}. For example, the pattern @samp{[a-zA-Z]} will\n\ |
|
|
4960 match all lower and upper case alphabetic characters. \n\ |
|
|
4961 @end table\n\ |
|
|
4962 \n\ |
|
|
4963 Except when using the @sc{Matlab} binary data file format, saving global\n\ |
|
|
4964 variables also saves the global status of the variable, so that if it is\n\ |
|
|
4965 restored at a later time using @samp{load}, it will be restored as a\n\ |
|
|
4966 global variable.\n\ |
|
|
4967 \n\ |
|
|
4968 The command\n\ |
|
|
4969 \n\ |
|
|
4970 @example\n\ |
|
|
4971 save -binary data a b*\n\ |
|
|
4972 @end example\n\ |
|
|
4973 \n\ |
|
|
4974 @noindent\n\ |
|
|
4975 saves the variable @samp{a} and all variables beginning with @samp{b} to\n\ |
|
|
4976 the file @file{data} in Octave's binary format.\n\ |
|
|
4977 @end deffn") |
|
604
|
4978 { |
|
2086
|
4979 octave_value_list retval; |
|
604
|
4980 |
|
1755
|
4981 int argc = args.length () + 1; |
|
|
4982 |
|
1968
|
4983 string_vector argv = args.make_argv ("save"); |
|
1755
|
4984 |
|
|
4985 if (error_state) |
|
|
4986 return retval; |
|
604
|
4987 |
|
1358
|
4988 // Here is where we would get the default save format if it were |
|
|
4989 // stored in a user preference variable. |
|
604
|
4990 |
|
3019
|
4991 bool save_builtins = false; |
|
|
4992 |
|
|
4993 bool save_as_floats = false; |
|
630
|
4994 |
|
604
|
4995 load_save_format format = get_default_save_format (); |
|
|
4996 |
|
3185
|
4997 bool append = false; |
|
|
4998 |
|
1755
|
4999 int i; |
|
|
5000 for (i = 1; i < argc; i++) |
|
604
|
5001 { |
|
3185
|
5002 if (argv[i] == "-append") |
|
|
5003 { |
|
|
5004 append = true; |
|
|
5005 } |
|
3465
|
5006 else if (argv[i] == "-ascii" || argv[i] == "-a") |
|
604
|
5007 { |
|
|
5008 format = LS_ASCII; |
|
|
5009 } |
|
1755
|
5010 else if (argv[i] == "-binary" || argv[i] == "-b") |
|
604
|
5011 { |
|
|
5012 format = LS_BINARY; |
|
|
5013 } |
|
3687
|
5014 else if (argv[i] == "-hdf5" || argv[i] == "-h") |
|
|
5015 { |
|
|
5016 #ifdef HAVE_HDF5 |
|
|
5017 format = LS_HDF5; |
|
|
5018 #else /* ! HAVE_HDF5 */ |
|
|
5019 error ("save: octave executable was not linked with HDF5 library"); |
|
|
5020 return retval; |
|
|
5021 #endif /* ! HAVE_HDF5 */ |
|
|
5022 } |
|
1755
|
5023 else if (argv[i] == "-mat-binary" || argv[i] == "-m") |
|
667
|
5024 { |
|
3688
|
5025 format = LS_MAT5_BINARY; |
|
|
5026 } |
|
3797
|
5027 else if (argv[i] == "-mat4-binary" || argv[i] == "-4" || argv[i] == "-v4") |
|
3688
|
5028 { |
|
667
|
5029 format = LS_MAT_BINARY; |
|
|
5030 } |
|
1755
|
5031 else if (argv[i] == "-float-binary" || argv[i] == "-f") |
|
630
|
5032 { |
|
|
5033 format = LS_BINARY; |
|
3019
|
5034 save_as_floats = true; |
|
630
|
5035 } |
|
3687
|
5036 else if (argv[i] == "-float-hdf5") |
|
|
5037 { |
|
|
5038 #ifdef HAVE_HDF5 |
|
|
5039 format = LS_HDF5; |
|
|
5040 save_as_floats = true; |
|
|
5041 #else /* ! HAVE_HDF5 */ |
|
|
5042 error ("save: octave executable was not linked with HDF5 library"); |
|
|
5043 return retval; |
|
|
5044 #endif /* ! HAVE_HDF5 */ |
|
|
5045 } |
|
1755
|
5046 else if (argv[i] == "-save-builtins") |
|
604
|
5047 { |
|
3019
|
5048 save_builtins = true; |
|
604
|
5049 } |
|
|
5050 else |
|
|
5051 break; |
|
|
5052 } |
|
|
5053 |
|
2057
|
5054 if (i == argc) |
|
604
|
5055 { |
|
|
5056 print_usage ("save"); |
|
|
5057 return retval; |
|
|
5058 } |
|
|
5059 |
|
630
|
5060 if (save_as_floats && format == LS_ASCII) |
|
|
5061 { |
|
|
5062 error ("save: cannot specify both -ascii and -float-binary"); |
|
|
5063 return retval; |
|
|
5064 } |
|
|
5065 |
|
1755
|
5066 if (argv[i] == "-") |
|
604
|
5067 { |
|
1755
|
5068 i++; |
|
863
|
5069 |
|
3687
|
5070 #ifdef HAVE_HDF5 |
|
|
5071 if (format == LS_HDF5) |
|
|
5072 error ("load: cannot write HDF5 format to stdout"); |
|
|
5073 else |
|
|
5074 #endif /* HAVE_HDF5 */ |
|
|
5075 // don't insert any commands here! the brace below must go |
|
|
5076 // with the "else" above! |
|
|
5077 { |
|
|
5078 // XXX FIXME XXX -- should things intended for the screen end up |
|
|
5079 // in a octave_value (string)? |
|
|
5080 |
|
|
5081 save_vars (argv, i, argc, octave_stdout, save_builtins, format, |
|
|
5082 save_as_floats, true); |
|
|
5083 } |
|
604
|
5084 } |
|
1755
|
5085 |
|
|
5086 // Guard against things like `save a*', which are probably mistakes... |
|
|
5087 |
|
|
5088 else if (i == argc - 1 && glob_pattern_p (argv[i])) |
|
|
5089 { |
|
|
5090 print_usage ("save"); |
|
604
|
5091 return retval; |
|
|
5092 } |
|
|
5093 else |
|
|
5094 { |
|
3523
|
5095 std::string fname = file_ops::tilde_expand (argv[i]); |
|
1755
|
5096 |
|
|
5097 i++; |
|
604
|
5098 |
|
3775
|
5099 std::ios::openmode mode = std::ios::out; |
|
3688
|
5100 if (format == LS_BINARY || |
|
|
5101 format == LS_MAT_BINARY || |
|
|
5102 format == LS_MAT5_BINARY) |
|
3552
|
5103 mode |= std::ios::binary; |
|
3538
|
5104 |
|
|
5105 mode |= append ? std::ios::ate : std::ios::trunc; |
|
3185
|
5106 |
|
3687
|
5107 #ifdef HAVE_HDF5 |
|
|
5108 if (format == LS_HDF5) |
|
863
|
5109 { |
|
3687
|
5110 hdf5_ofstream hdf5_file (fname.c_str ()); |
|
|
5111 |
|
|
5112 if (hdf5_file.file_id >= 0) { |
|
|
5113 save_vars (argv, i, argc, hdf5_file, save_builtins, format, |
|
|
5114 save_as_floats, true); |
|
|
5115 |
|
|
5116 hdf5_file.close (); |
|
|
5117 } |
|
|
5118 else |
|
|
5119 { |
|
|
5120 error ("save: couldn't open output file `%s'", fname.c_str ()); |
|
|
5121 return retval; |
|
|
5122 } |
|
863
|
5123 } |
|
|
5124 else |
|
3687
|
5125 #endif /* HAVE_HDF5 */ |
|
|
5126 // don't insert any statements here! The brace below must go |
|
|
5127 // with the "else" above! |
|
604
|
5128 { |
|
3687
|
5129 std::ofstream file (fname.c_str (), mode); |
|
|
5130 |
|
|
5131 if (file) |
|
|
5132 { |
|
|
5133 bool write_header_info |
|
3775
|
5134 = ((file.rdbuf ())->pubseekoff (0, std::ios::cur) |
|
3769
|
5135 == static_cast<std::streampos> (0)); |
|
3687
|
5136 |
|
|
5137 save_vars (argv, i, argc, file, save_builtins, format, |
|
|
5138 save_as_floats, write_header_info); |
|
|
5139 } |
|
|
5140 else |
|
|
5141 { |
|
|
5142 error ("save: couldn't open output file `%s'", fname.c_str ()); |
|
|
5143 return retval; |
|
|
5144 } |
|
604
|
5145 } |
|
|
5146 } |
|
|
5147 |
|
|
5148 return retval; |
|
|
5149 } |
|
|
5150 |
|
|
5151 // Maybe this should be a static function in tree-plot.cc? |
|
|
5152 |
|
620
|
5153 // If TC is matrix, save it on stream OS in a format useful for |
|
604
|
5154 // making a 3-dimensional plot with gnuplot. If PARAMETRIC is |
|
3019
|
5155 // TRUE, assume a parametric 3-dimensional plot will be generated. |
|
604
|
5156 |
|
2799
|
5157 bool |
|
3523
|
5158 save_three_d (std::ostream& os, const octave_value& tc, bool parametric) |
|
604
|
5159 { |
|
3019
|
5160 bool fail = false; |
|
604
|
5161 |
|
620
|
5162 int nr = tc.rows (); |
|
|
5163 int nc = tc.columns (); |
|
|
5164 |
|
|
5165 if (tc.is_real_matrix ()) |
|
604
|
5166 { |
|
|
5167 os << "# 3D data...\n" |
|
|
5168 << "# type: matrix\n" |
|
|
5169 << "# total rows: " << nr << "\n" |
|
|
5170 << "# total columns: " << nc << "\n"; |
|
|
5171 |
|
|
5172 if (parametric) |
|
|
5173 { |
|
|
5174 int extras = nc % 3; |
|
|
5175 if (extras) |
|
|
5176 warning ("ignoring last %d columns", extras); |
|
|
5177 |
|
620
|
5178 Matrix tmp = tc.matrix_value (); |
|
872
|
5179 tmp = strip_infnan (tmp); |
|
|
5180 nr = tmp.rows (); |
|
|
5181 |
|
604
|
5182 for (int i = 0; i < nc-extras; i += 3) |
|
|
5183 { |
|
|
5184 os << tmp.extract (0, i, nr-1, i+2); |
|
|
5185 if (i+3 < nc-extras) |
|
|
5186 os << "\n"; |
|
|
5187 } |
|
|
5188 } |
|
|
5189 else |
|
|
5190 { |
|
620
|
5191 Matrix tmp = tc.matrix_value (); |
|
872
|
5192 tmp = strip_infnan (tmp); |
|
|
5193 nr = tmp.rows (); |
|
|
5194 |
|
604
|
5195 for (int i = 0; i < nc; i++) |
|
|
5196 { |
|
|
5197 os << tmp.extract (0, i, nr-1, i); |
|
|
5198 if (i+1 < nc) |
|
|
5199 os << "\n"; |
|
|
5200 } |
|
|
5201 } |
|
620
|
5202 } |
|
|
5203 else |
|
|
5204 { |
|
604
|
5205 ::error ("for now, I can only save real matrices in 3D format"); |
|
3019
|
5206 fail = true; |
|
604
|
5207 } |
|
620
|
5208 |
|
|
5209 return (os && ! fail); |
|
604
|
5210 } |
|
|
5211 |
|
2194
|
5212 static int |
|
3189
|
5213 crash_dumps_octave_core (void) |
|
|
5214 { |
|
|
5215 Vcrash_dumps_octave_core = check_preference ("crash_dumps_octave_core"); |
|
|
5216 return 0; |
|
|
5217 } |
|
|
5218 |
|
|
5219 |
|
|
5220 static int |
|
2194
|
5221 default_save_format (void) |
|
|
5222 { |
|
|
5223 int status = 0; |
|
|
5224 |
|
3523
|
5225 std::string s = builtin_string_variable ("default_save_format"); |
|
2194
|
5226 |
|
|
5227 if (s.empty ()) |
|
|
5228 { |
|
|
5229 gripe_invalid_value_specified ("default_save_format"); |
|
|
5230 status = -1; |
|
|
5231 } |
|
|
5232 else |
|
|
5233 Vdefault_save_format = s; |
|
|
5234 |
|
|
5235 return status; |
|
|
5236 } |
|
|
5237 |
|
3769
|
5238 static std::string |
|
3709
|
5239 default_save_header_format (void) |
|
|
5240 { |
|
|
5241 return |
|
|
5242 std::string ("# Created by Octave " OCTAVE_VERSION ", %a %b %d %H:%M:%S %Y %Z <") |
|
|
5243 + octave_env::get_user_name () |
|
|
5244 + std::string ("@") |
|
|
5245 + octave_env::get_host_name () |
|
|
5246 + std::string (">"); |
|
|
5247 } |
|
|
5248 |
|
|
5249 static int |
|
|
5250 save_header_format_string (void) |
|
|
5251 { |
|
|
5252 int status = 0; |
|
|
5253 |
|
|
5254 octave_value v = builtin_any_variable ("save_header_format_string"); |
|
|
5255 |
|
|
5256 if (v.is_string ()) |
|
|
5257 Vsave_header_format_string = v.string_value (); |
|
|
5258 else |
|
|
5259 { |
|
|
5260 gripe_invalid_value_specified ("save_header_format_string"); |
|
|
5261 status = -1; |
|
|
5262 } |
|
|
5263 |
|
|
5264 return status; |
|
|
5265 } |
|
|
5266 |
|
2194
|
5267 static int |
|
|
5268 save_precision (void) |
|
|
5269 { |
|
|
5270 double val; |
|
|
5271 if (builtin_real_scalar_variable ("save_precision", val) |
|
|
5272 && ! xisnan (val)) |
|
|
5273 { |
|
|
5274 int ival = NINT (val); |
|
2800
|
5275 if (ival >= 0 && ival == val) |
|
2194
|
5276 { |
|
|
5277 Vsave_precision = ival; |
|
|
5278 return 0; |
|
|
5279 } |
|
|
5280 } |
|
|
5281 gripe_invalid_value_specified ("save_precision"); |
|
|
5282 return -1; |
|
|
5283 } |
|
|
5284 |
|
|
5285 void |
|
|
5286 symbols_of_load_save (void) |
|
|
5287 { |
|
3258
|
5288 DEFVAR (crash_dumps_octave_core, 1.0, crash_dumps_octave_core, |
|
3372
|
5289 "-*- texinfo -*-\n\ |
|
|
5290 @defvr {Built-in Variable} crash_dumps_octave_core\n\ |
|
|
5291 If this variable is set to a nonzero value, Octave tries to save all\n\ |
|
|
5292 current variables the the file \"octave-core\" if it crashes or receives a\n\ |
|
|
5293 hangup, terminate or similar signal. The default value is 1.\n\ |
|
|
5294 @end defvr"); |
|
3189
|
5295 |
|
3258
|
5296 DEFVAR (default_save_format, "ascii", default_save_format, |
|
3372
|
5297 "-*- texinfo -*-\n\ |
|
|
5298 @defvr {Built-in Variable} default_save_format\n\ |
|
|
5299 This variable specifies the default format for the @code{save} command.\n\ |
|
|
5300 It should have one of the following values: @code{\"ascii\"},\n\ |
|
|
5301 @code{\"binary\"}, @code{float-binary}, or @code{\"mat-binary\"}. The\n\ |
|
|
5302 initial default save format is Octave's text format.\n\ |
|
|
5303 @end defvr"); |
|
2194
|
5304 |
|
3709
|
5305 DEFVAR (save_header_format_string, default_save_header_format (), |
|
|
5306 save_header_format_string, |
|
|
5307 "-*- texinfo -*-\n\ |
|
|
5308 @defvr {Built-in Variable} save_header_format_string\n\ |
|
|
5309 This variable specifies the the format string for the comment line\n\ |
|
|
5310 that is written at the beginning of text-format data files saved by\n\ |
|
|
5311 Octave. The format string is passed to @code{strftime} and should\n\ |
|
|
5312 begin with the character @samp{#} and contain no newline characters.\n\ |
|
|
5313 If the value of @code{save_header_format_string} is the empty string,\n\ |
|
|
5314 the header comment is omitted from text-format data files. The\n\ |
|
|
5315 default value is\n\ |
|
|
5316 \n\ |
|
|
5317 @example\n\ |
|
|
5318 \"# Created by Octave VERSION, %a %b %d %H:%M:%S %Y %Z <USER@@HOST>\"\n\ |
|
|
5319 @end example\n\ |
|
|
5320 @seealso{strftime}\n\ |
|
|
5321 @end defvr"); |
|
|
5322 |
|
3258
|
5323 DEFVAR (save_precision, 15.0, save_precision, |
|
3372
|
5324 "-*- texinfo -*-\n\ |
|
|
5325 @defvr {Built-in Variable} save_precision\n\ |
|
|
5326 This variable specifies the number of digits to keep when saving data in\n\ |
|
|
5327 text format. The default value is 17.\n\ |
|
|
5328 @end defvr"); |
|
2194
|
5329 } |
|
|
5330 |
|
604
|
5331 /* |
|
|
5332 ;;; Local Variables: *** |
|
|
5333 ;;; mode: C++ *** |
|
|
5334 ;;; End: *** |
|
|
5335 */ |
