Mercurial > octave
annotate libinterp/corefcn/ls-hdf5.h @ 20264:bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
* oct-hdf5-types.h: Rename from oct-hdf5-id.h.
* oct-hdf5-types.cc: Rename from oct-hdf5-id.cc.
* libinterp/corefcn/module.mk: Update.
* oct-hdf5-types.h (octave_hdf5_err): New typedef.
* oct-hdf5-types.h, oct-hdf5-types.cc (check_hdf5_types): Rename from
check_hdf5_id_type. Also check size of herr_t.
* load-save.cc: Include oct-hdf5.h.
* ls-hdf5.cc: Include oct-hdf5.h instead of oct-hdf5-id.h.
Define hdf5_fstreambase functions that require HDF5 types here instead
of in ls-hdf5.h.
* ls-hdf5.h, ls-hdf5.cc: Use octave types in public interfaces.
* ls-hdf5.h, ov-base.h: Include oct-hdf5-types.h instead of oct-hdf5.h.
* oct-hdf5.h: Include oct-hdf5-types.h. Define H5T_NATIVE_IDX here.
* ls-hdf5.h: Not here.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Mon, 15 Jun 2015 17:42:44 -0400 |
| parents | 4197fc428c7d |
| children | f7084eae3318 |
| rev | line source |
|---|---|
| 4634 | 1 /* |
| 2 | |
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19217
diff
changeset
|
3 Copyright (C) 2003-2015 John W. Eaton |
| 4634 | 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 | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 4634 | 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 | |
| 7016 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 4634 | 20 |
| 21 */ | |
| 22 | |
| 23 #if !defined (octave_ls_hdf5_h) | |
| 24 #define octave_ls_hdf5_h 1 | |
| 25 | |
| 4695 | 26 #if defined (HAVE_HDF5) |
| 27 | |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
28 #include "oct-hdf5-types.h" |
| 8676 | 29 |
| 4634 | 30 // first, we need to define our own dummy stream subclass, since |
| 31 // HDF5 needs to do its own file i/o | |
| 32 | |
| 33 // hdf5_fstreambase is used for both input and output streams, modeled | |
| 34 // on the fstreambase class in <fstream.h> | |
| 35 | |
| 36 class hdf5_fstreambase : virtual public std::ios | |
| 37 { | |
| 38 public: | |
| 39 | |
| 40 // HDF5 uses an "id" to refer to an open file | |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
41 octave_hdf5_id file_id; |
| 4634 | 42 |
| 43 // keep track of current item index in the file | |
| 44 int current_item; | |
| 45 | |
|
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11523
diff
changeset
|
46 hdf5_fstreambase () : file_id (-1), current_item () { } |
| 4634 | 47 |
| 6760 | 48 ~hdf5_fstreambase () { close (); } |
| 49 | |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
50 hdf5_fstreambase (const char *name, int mode, int /* prot */ = 0); |
| 4634 | 51 |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
52 void close (void); |
| 4634 | 53 |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
54 void open (const char *name, int mode, int); |
| 4634 | 55 }; |
| 56 | |
| 57 // input and output streams, subclassing istream and ostream | |
| 58 // so that we can pass them for stream parameters in the functions below. | |
| 59 | |
| 60 class hdf5_ifstream : public hdf5_fstreambase, public std::istream | |
| 61 { | |
| 62 public: | |
| 63 | |
| 64 hdf5_ifstream () : hdf5_fstreambase (), std::istream (0) { } | |
| 65 | |
| 5255 | 66 hdf5_ifstream (const char *name, int mode = std::ios::in|std::ios::binary, |
| 10313 | 67 int prot = 0) |
| 4634 | 68 : hdf5_fstreambase (name, mode, prot), std::istream (0) { } |
| 69 | |
| 5255 | 70 void open (const char *name, int mode = std::ios::in|std::ios::binary, |
| 10313 | 71 int prot = 0) |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
72 { hdf5_fstreambase::open (name, mode, prot); } |
| 4634 | 73 }; |
| 74 | |
| 75 class hdf5_ofstream : public hdf5_fstreambase, public std::ostream | |
| 76 { | |
| 77 public: | |
| 78 | |
| 79 hdf5_ofstream () : hdf5_fstreambase (), std::ostream (0) { } | |
| 80 | |
| 5255 | 81 hdf5_ofstream (const char *name, int mode = std::ios::out|std::ios::binary, |
| 10313 | 82 int prot = 0) |
| 4634 | 83 : hdf5_fstreambase (name, mode, prot), std::ostream (0) { } |
| 84 | |
| 5255 | 85 void open (const char *name, int mode = std::ios::out|std::ios::binary, |
| 10313 | 86 int prot = 0) |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
87 { hdf5_fstreambase::open (name, mode, prot); } |
| 4634 | 88 }; |
| 89 | |
| 4687 | 90 // Callback data structure for passing data to hdf5_read_next_data, below. |
| 91 | |
| 92 struct | |
| 93 hdf5_callback_data | |
| 94 { | |
| 95 hdf5_callback_data (void) | |
| 96 : name (), global (false), tc (), doc () { } | |
| 97 | |
| 98 // the following fields are set by hdf5_read_data on successful return: | |
| 99 | |
| 100 // the name of the variable | |
| 101 std::string name; | |
| 102 | |
| 103 // whether it is global | |
| 104 bool global; | |
| 105 | |
| 106 // the value of the variable, in Octave form | |
| 107 octave_value tc; | |
| 108 | |
| 109 // a documentation string (NULL if none) | |
| 110 std::string doc; | |
| 111 }; | |
| 112 | |
| 113 #if HAVE_HDF5_INT2FLOAT_CONVERSIONS | |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
114 extern OCTINTERP_API octave_hdf5_id |
| 4687 | 115 save_type_to_hdf5 (save_type st) |
| 116 #endif | |
| 117 | |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
118 extern OCTINTERP_API octave_hdf5_id |
|
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
119 hdf5_make_complex_type (octave_hdf5_id num_type); |
| 4687 | 120 |
| 6693 | 121 extern OCTINTERP_API bool |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
122 hdf5_types_compatible (octave_hdf5_id t1, octave_hdf5_id t2); |
| 4687 | 123 |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
124 extern OCTINTERP_API octave_hdf5_err |
|
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
125 hdf5_read_next_data (octave_hdf5_id group_id, const char *name, void *dv); |
| 4687 | 126 |
| 6693 | 127 extern OCTINTERP_API bool |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
128 add_hdf5_data (octave_hdf5_id loc_id, const octave_value& tc, |
| 10313 | 129 const std::string& name, const std::string& doc, |
| 130 bool mark_as_global, bool save_as_floats); | |
| 4687 | 131 |
| 6693 | 132 extern OCTINTERP_API int |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
133 save_hdf5_empty (octave_hdf5_id loc_id, const char *name, const dim_vector d); |
| 4805 | 134 |
| 6693 | 135 extern OCTINTERP_API int |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
136 load_hdf5_empty (octave_hdf5_id loc_id, const char *name, dim_vector &d); |
| 4805 | 137 |
| 6693 | 138 extern OCTINTERP_API std::string |
| 4687 | 139 read_hdf5_data (std::istream& is, const std::string& filename, bool& global, |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
140 octave_value& tc, std::string& doc, |
|
17709
5415a9cd61d4
Implement faster partial loading of HDF5 files.
Rik <rik@octave.org>
parents:
16892
diff
changeset
|
141 const string_vector& argv, int argv_idx, int argc); |
| 4634 | 142 |
| 6693 | 143 extern OCTINTERP_API bool |
| 4634 | 144 save_hdf5_data (std::ostream& os, const octave_value& tc, |
| 10313 | 145 const std::string& name, const std::string& doc, |
| 146 bool mark_as_global, bool save_as_floats); | |
| 4634 | 147 |
|
11176
2271261f088a
Address precision issue in ranges saved to HDF5 files
David Bateman <dbateman@free.fr>
parents:
10313
diff
changeset
|
148 extern OCTINTERP_API bool |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
149 hdf5_check_attr (octave_hdf5_id loc_id, const char *attr_name); |
|
11176
2271261f088a
Address precision issue in ranges saved to HDF5 files
David Bateman <dbateman@free.fr>
parents:
10313
diff
changeset
|
150 |
|
2271261f088a
Address precision issue in ranges saved to HDF5 files
David Bateman <dbateman@free.fr>
parents:
10313
diff
changeset
|
151 extern OCTINTERP_API bool |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
152 hdf5_get_scalar_attr (octave_hdf5_id loc_id, octave_hdf5_id type_id, |
|
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
153 const char *attr_name, void *buf); |
|
11176
2271261f088a
Address precision issue in ranges saved to HDF5 files
David Bateman <dbateman@free.fr>
parents:
10313
diff
changeset
|
154 |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
155 extern OCTINTERP_API octave_hdf5_err |
|
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
156 hdf5_add_attr (octave_hdf5_id loc_id, const char *attr_name); |
|
11176
2271261f088a
Address precision issue in ranges saved to HDF5 files
David Bateman <dbateman@free.fr>
parents:
10313
diff
changeset
|
157 |
|
2271261f088a
Address precision issue in ranges saved to HDF5 files
David Bateman <dbateman@free.fr>
parents:
10313
diff
changeset
|
158 |
|
20264
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
159 extern OCTINTERP_API octave_hdf5_err |
|
bfe66db8addb
don't include hdf5.h or use HDF5 typedefs in public header files (bug #43180)
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
160 hdf5_add_scalar_attr (octave_hdf5_id loc_id, octave_hdf5_id type_id, |
|
11176
2271261f088a
Address precision issue in ranges saved to HDF5 files
David Bateman <dbateman@free.fr>
parents:
10313
diff
changeset
|
161 const char *attr_name, void *buf); |
|
2271261f088a
Address precision issue in ranges saved to HDF5 files
David Bateman <dbateman@free.fr>
parents:
10313
diff
changeset
|
162 |
| 4634 | 163 #endif |
| 164 | |
| 4695 | 165 #endif |