Mercurial > hg > octave-lyh
annotate src/ov-class.h @ 9190:7a10410db2c6
[mq]: x
| author | Robert T. Short <rtshort@ieee.org> |
|---|---|
| date | Fri, 08 May 2009 15:18:22 -0400 |
| parents | 23af5910e5f5 |
| children | f27a8c07f0b2 |
| rev | line source |
|---|---|
| 7338 | 1 /* |
| 2 | |
| 8920 | 3 Copyright (C) 2007, 2008, 2009 John W. Eaton |
| 7338 | 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 | |
| 7444 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 7338 | 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 | |
| 7444 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 7338 | 20 |
| 21 */ | |
| 22 | |
| 23 #if !defined (octave_class_h) | |
| 24 #define octave_class_h 1 | |
| 25 | |
| 26 #include <cstdlib> | |
| 27 | |
|
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
28 #include <iosfwd> |
| 7338 | 29 #include <string> |
| 30 | |
| 31 #include "mx-base.h" | |
| 32 #include "str-vec.h" | |
| 33 | |
| 34 #include "error.h" | |
| 35 #include "oct-alloc.h" | |
| 36 #include "oct-map.h" | |
| 37 #include "ov-base.h" | |
| 38 #include "ov-typeinfo.h" | |
| 39 | |
| 40 class octave_value_list; | |
| 41 | |
| 42 class tree_walker; | |
| 43 | |
| 44 // Data structures. | |
| 45 | |
| 46 class | |
| 47 octave_class : public octave_base_value | |
| 48 { | |
| 49 public: | |
| 50 | |
| 51 octave_class (void) | |
| 52 : octave_base_value () { } | |
| 53 | |
| 54 octave_class (const Octave_map& m, const std::string& id) | |
| 55 : octave_base_value (), map (m), c_name (id) { } | |
| 56 | |
| 57 octave_class (const octave_class& s) | |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
58 : octave_base_value (s), map (s.map), c_name (s.c_name), |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
59 parent_list (s.parent_list) { } |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
60 |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
61 octave_class (const Octave_map& m, const std::string& id, |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
62 const octave_value_list& parents); |
| 7338 | 63 |
| 64 ~octave_class (void) { } | |
| 65 | |
| 66 octave_base_value *clone (void) const { return new octave_class (*this); } | |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
67 |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
68 octave_base_value *empty_clone (void) const |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
69 { |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
70 return new octave_class (Octave_map (map.keys ()), class_name ()); |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
71 } |
| 7338 | 72 |
| 73 Cell dotref (const octave_value_list& idx); | |
| 74 | |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
75 octave_value subsref (const std::string& type, |
|
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
76 const std::list<octave_value_list>& idx) |
| 7338 | 77 { |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
78 octave_value_list tmp = subsref (type, idx, 1); |
|
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
79 return tmp.length () > 0 ? tmp(0) : octave_value (); |
| 7338 | 80 } |
| 81 | |
| 82 octave_value_list subsref (const std::string& type, | |
| 83 const std::list<octave_value_list>& idx, | |
| 84 int nargout); | |
| 85 | |
| 86 static octave_value numeric_conv (const Cell& val, | |
| 87 const std::string& type); | |
| 88 | |
|
9147
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
89 void assign(const std::string& k, const octave_value& rhs) |
|
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
90 { map.assign (k, rhs); }; |
|
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
91 |
| 7338 | 92 octave_value subsasgn (const std::string& type, |
| 93 const std::list<octave_value_list>& idx, | |
| 94 const octave_value& rhs); | |
| 95 | |
|
8154
265a821f6555
Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
96 idx_vector index_vector (void) const; |
|
265a821f6555
Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
97 |
| 7338 | 98 dim_vector dims (void) const { return map.dims (); } |
| 99 | |
| 100 size_t byte_size (void) const; | |
| 101 | |
| 102 // This is the number of elements in each field. The total number | |
| 103 // of elements is numel () * nfields (). | |
| 104 octave_idx_type numel (void) const | |
| 105 { | |
| 106 dim_vector dv = dims (); | |
| 107 return dv.numel (); | |
| 108 } | |
| 109 | |
| 110 octave_idx_type nfields (void) const { return map.nfields (); } | |
| 111 | |
| 9151 | 112 size_t nparents (void) const { return parent_list.size (); } |
| 113 | |
| 7338 | 114 octave_value reshape (const dim_vector& new_dims) const |
| 115 { return map.reshape (new_dims); } | |
| 116 | |
| 117 octave_value resize (const dim_vector& dv, bool = false) const | |
| 118 { Octave_map tmap = map; tmap.resize (dv); return tmap; } | |
| 119 | |
| 120 bool is_defined (void) const { return true; } | |
| 121 | |
| 122 bool is_map (void) const { return false; } | |
| 123 | |
| 124 bool is_object (void) const { return true; } | |
| 125 | |
|
8212
ebf6f6a0f9a7
Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
8154
diff
changeset
|
126 Octave_map map_value (void) const { return map; } |
| 7338 | 127 |
| 128 string_vector map_keys (void) const; | |
| 129 | |
| 9151 | 130 std::list<std::string> parent_class_name_list (void) const |
| 131 { return parent_list; } | |
| 132 | |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
133 string_vector parent_class_names (void) const |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
134 { return string_vector (parent_list); } |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
135 |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
136 octave_base_value *find_parent_class (const std::string&); |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
137 |
| 7338 | 138 void print (std::ostream& os, bool pr_as_read_syntax = false) const; |
| 139 | |
| 140 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
| 141 | |
| 142 bool print_name_tag (std::ostream& os, const std::string& name) const; | |
| 143 | |
| 144 void print_with_name (std::ostream& os, const std::string& name, | |
| 145 bool print_padding = true) const; | |
| 146 | |
| 9190 | 147 bool reconstruct_exemplar (void); |
| 148 | |
|
9182
23af5910e5f5
make load work for derived classses
Robert T. Short <octave@phaselockedsystems.com>
parents:
9151
diff
changeset
|
149 bool reconstruct_parents (void); |
|
23af5910e5f5
make load work for derived classses
Robert T. Short <octave@phaselockedsystems.com>
parents:
9151
diff
changeset
|
150 |
|
8212
ebf6f6a0f9a7
Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
8154
diff
changeset
|
151 bool save_ascii (std::ostream& os); |
| 7338 | 152 |
| 153 bool load_ascii (std::istream& is); | |
| 154 | |
| 155 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 156 | |
| 157 bool load_binary (std::istream& is, bool swap, | |
| 158 oct_mach_info::float_format fmt); | |
| 159 | |
| 160 #if defined (HAVE_HDF5) | |
| 161 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 162 | |
| 163 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug); | |
| 164 #endif | |
| 165 | |
| 166 mxArray *as_mxArray (void) const; | |
| 167 | |
| 168 private: | |
| 169 | |
| 170 Octave_map map; | |
| 171 | |
| 172 DECLARE_OCTAVE_ALLOCATOR | |
| 173 | |
| 174 public: | |
| 175 int type_id (void) const { return t_id; } | |
| 176 std::string type_name (void) const { return t_name; } | |
| 177 std::string class_name (void) const { return c_name; } | |
| 178 | |
| 179 static int static_type_id (void) { return t_id; } | |
| 180 static std::string static_type_name (void) { return t_name; } | |
| 181 static std::string static_class_name (void) { return "<unknown>"; } | |
| 182 static void register_type (void); | |
| 183 | |
| 184 private: | |
| 185 static int t_id; | |
| 186 | |
| 187 static const std::string t_name; | |
| 188 std::string c_name; | |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
189 std::list<std::string> parent_list; |
| 7338 | 190 |
| 191 bool in_class_method (void) const; | |
| 9151 | 192 |
| 193 public: | |
| 194 // The list of field names and parent classes defines a class. We | |
| 195 // keep track of each class that has been created so that we know | |
| 196 class exemplar_info | |
| 197 { | |
| 198 public: | |
| 199 | |
| 200 exemplar_info (void) : field_names (), parent_class_names () { } | |
| 201 | |
| 202 exemplar_info (const octave_value& obj); | |
| 203 | |
| 204 exemplar_info (const exemplar_info& x) | |
| 205 : field_names (x.field_names), | |
| 206 parent_class_names (x.parent_class_names) { } | |
| 207 | |
| 208 exemplar_info& operator = (const exemplar_info& x) | |
| 209 { | |
| 210 if (&x != this) | |
| 211 { | |
| 212 field_names = x.field_names; | |
| 213 parent_class_names = x.parent_class_names; | |
| 214 } | |
| 215 return *this; | |
| 216 } | |
| 217 | |
| 218 octave_idx_type nfields (void) const { return field_names.length (); } | |
| 219 | |
| 220 size_t nparents (void) const { return parent_class_names.size (); } | |
| 221 | |
| 222 string_vector fields (void) const { return field_names; } | |
| 223 | |
| 224 std::list<std::string> parents (void) const { return parent_class_names; } | |
| 225 | |
| 226 bool compare (const octave_value& obj) const; | |
| 227 | |
| 228 private: | |
| 229 | |
| 230 string_vector field_names; | |
| 231 std::list<std::string> parent_class_names; | |
| 232 }; | |
| 233 | |
| 234 // A map from class names to lists of fields. | |
| 235 static std::map<std::string, exemplar_info> exemplar_map; | |
| 236 | |
| 237 typedef std::map<std::string, exemplar_info>::iterator exemplar_iterator; | |
| 238 typedef std::map<std::string, exemplar_info>::const_iterator exemplar_const_iterator; | |
| 7338 | 239 }; |
| 240 | |
| 241 #endif | |
| 242 | |
| 243 /* | |
| 244 ;;; Local Variables: *** | |
| 245 ;;; mode: C++ *** | |
| 246 ;;; End: *** | |
| 247 */ |