Mercurial > hg > octave-nkf
annotate src/ov-class.h @ 12522:33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Fri, 18 Mar 2011 22:47:33 -0700 |
| parents | d08901c05c1b |
| children | 3b2e005e4219 |
| rev | line source |
|---|---|
| 7338 | 1 /* |
| 2 | |
| 11523 | 3 Copyright (C) 2007-2011 John W. Eaton |
|
10521
4d1fc073fbb7
add some missing copyright stmts
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
4 Copyright (C) 2009 VZLU Prague |
| 7338 | 5 |
| 6 This file is part of Octave. | |
| 7 | |
| 8 Octave is free software; you can redistribute it and/or modify it | |
| 9 under the terms of the GNU General Public License as published by the | |
| 7444 | 10 Free Software Foundation; either version 3 of the License, or (at your |
| 11 option) any later version. | |
| 7338 | 12 |
| 13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 16 for more details. | |
| 17 | |
| 18 You should have received a copy of the GNU General Public License | |
| 7444 | 19 along with Octave; see the file COPYING. If not, see |
| 20 <http://www.gnu.org/licenses/>. | |
| 7338 | 21 |
| 22 */ | |
| 23 | |
| 24 #if !defined (octave_class_h) | |
| 25 #define octave_class_h 1 | |
| 26 | |
| 27 #include <cstdlib> | |
| 28 | |
|
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
29 #include <iosfwd> |
| 7338 | 30 #include <string> |
| 31 | |
| 32 #include "mx-base.h" | |
| 33 #include "str-vec.h" | |
| 34 | |
| 35 #include "error.h" | |
| 36 #include "oct-alloc.h" | |
| 37 #include "oct-map.h" | |
| 38 #include "ov-base.h" | |
| 39 #include "ov-typeinfo.h" | |
| 40 | |
| 41 class octave_value_list; | |
| 42 | |
| 43 class tree_walker; | |
| 44 | |
| 45 // Data structures. | |
| 46 | |
| 47 class | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
48 octave_class : public octave_base_value |
| 7338 | 49 { |
| 50 public: | |
| 51 | |
| 52 octave_class (void) | |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
53 : octave_base_value (), map (), c_name (), |
|
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
54 parent_list (), obsolete_copies (0) |
|
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11523
diff
changeset
|
55 { } |
| 7338 | 56 |
|
10768
8a868004a437
use octave_map for octave_class
Jaroslav Hajek <highegg@gmail.com>
parents:
10742
diff
changeset
|
57 octave_class (const octave_map& m, const std::string& id) |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
58 : octave_base_value (), map (m), c_name (id), |
|
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
59 parent_list (), obsolete_copies (0) |
|
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11523
diff
changeset
|
60 { } |
| 7338 | 61 |
| 62 octave_class (const octave_class& s) | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
63 : octave_base_value (s), map (s.map), c_name (s.c_name), |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
64 parent_list (s.parent_list), obsolete_copies (0) { } |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
65 |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
66 octave_class (const octave_map& m, const std::string& id, |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
67 const octave_value_list& parents); |
| 7338 | 68 |
| 69 ~octave_class (void) { } | |
| 70 | |
| 71 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
|
72 |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
73 octave_base_value *unique_clone (void); |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
74 |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
75 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
|
76 { |
|
10768
8a868004a437
use octave_map for octave_class
Jaroslav Hajek <highegg@gmail.com>
parents:
10742
diff
changeset
|
77 return new octave_class (octave_map (map.keys ()), class_name ()); |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
8212
diff
changeset
|
78 } |
| 7338 | 79 |
| 80 Cell dotref (const octave_value_list& idx); | |
| 81 | |
|
9329
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
82 Matrix size (void); |
|
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
83 |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
84 octave_idx_type numel (const octave_value_list&); |
|
9329
67fc970dad7d
improve indexed assignment using indexed numel
Jaroslav Hajek <highegg@gmail.com>
parents:
9240
diff
changeset
|
85 |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
86 octave_value subsref (const std::string& type, |
| 10313 | 87 const std::list<octave_value_list>& idx) |
| 7338 | 88 { |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7444
diff
changeset
|
89 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
|
90 return tmp.length () > 0 ? tmp(0) : octave_value (); |
| 7338 | 91 } |
| 92 | |
| 93 octave_value_list subsref (const std::string& type, | |
| 10313 | 94 const std::list<octave_value_list>& idx, |
| 95 int nargout); | |
| 7338 | 96 |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
97 static octave_value numeric_conv (const Cell& val, |
| 10313 | 98 const std::string& type); |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
99 |
|
9147
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
100 void assign(const std::string& k, const octave_value& rhs) |
|
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
101 { map.assign (k, rhs); }; |
|
5579998f8acf
Update to OOP facilities.
rtshort@bristlecone.phaselocked.com
parents:
9010
diff
changeset
|
102 |
| 7338 | 103 octave_value subsasgn (const std::string& type, |
| 10313 | 104 const std::list<octave_value_list>& idx, |
| 105 const octave_value& rhs); | |
| 7338 | 106 |
|
12171
d08901c05c1b
fix bug in class assignment to undefined object with index
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
107 octave_value undef_subsasgn (const std::string& type, |
|
d08901c05c1b
fix bug in class assignment to undefined object with index
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
108 const std::list<octave_value_list>& idx, |
|
d08901c05c1b
fix bug in class assignment to undefined object with index
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
109 const octave_value& rhs); |
|
d08901c05c1b
fix bug in class assignment to undefined object with index
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
110 |
|
8154
265a821f6555
Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
111 idx_vector index_vector (void) const; |
|
265a821f6555
Add subsindex and ismethod functions
David Bateman <dbateman@free.fr>
parents:
7651
diff
changeset
|
112 |
| 7338 | 113 dim_vector dims (void) const { return map.dims (); } |
| 114 | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
115 size_t byte_size (void) const; |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
116 |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
117 // This is the number of elements in each field. The total number |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
118 // of elements is numel () * nfields (). |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
119 octave_idx_type numel (void) const |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
120 { |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
121 dim_vector dv = dims (); |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
122 return dv.numel (); |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
123 } |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
124 |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
125 octave_idx_type nfields (void) const { return map.nfields (); } |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
126 |
| 9151 | 127 size_t nparents (void) const { return parent_list.size (); } |
| 128 | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
129 octave_value reshape (const dim_vector& new_dims) const |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
130 { return map.reshape (new_dims); } |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
131 |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
132 octave_value resize (const dim_vector& dv, bool = false) const |
|
10768
8a868004a437
use octave_map for octave_class
Jaroslav Hajek <highegg@gmail.com>
parents:
10742
diff
changeset
|
133 { octave_map tmap = map; tmap.resize (dv); return tmap; } |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
134 |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
135 bool is_defined (void) const { return true; } |
|
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
136 |
| 7338 | 137 bool is_map (void) const { return false; } |
| 138 | |
| 139 bool is_object (void) const { return true; } | |
| 140 | |
|
10742
604e13a89c7f
initial code for structs rewrite
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
141 octave_map map_value (void) const { return map; } |
|
604e13a89c7f
initial code for structs rewrite
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
142 |
| 7338 | 143 string_vector map_keys (void) const; |
| 144 | |
| 9151 | 145 std::list<std::string> parent_class_name_list (void) const |
| 146 { return parent_list; } | |
| 147 | |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
148 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
|
149 { 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
|
150 |
|
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
151 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
|
152 |
|
9767
0df32e0b2074
fix base class field assignment
Jaroslav Hajek <highegg@gmail.com>
parents:
9581
diff
changeset
|
153 octave_base_value *unique_parent_class (const std::string&); |
|
0df32e0b2074
fix base class field assignment
Jaroslav Hajek <highegg@gmail.com>
parents:
9581
diff
changeset
|
154 |
| 7338 | 155 void print (std::ostream& os, bool pr_as_read_syntax = false) const; |
| 156 | |
| 157 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
| 158 | |
| 159 bool print_name_tag (std::ostream& os, const std::string& name) const; | |
| 160 | |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
161 void print_with_name (std::ostream& os, const std::string& name, |
| 10313 | 162 bool print_padding = true); |
| 7338 | 163 |
| 9190 | 164 bool reconstruct_exemplar (void); |
| 165 | |
|
9240
f27a8c07f0b2
clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents:
9190
diff
changeset
|
166 static void clear_exemplar_map (void); |
|
f27a8c07f0b2
clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents:
9190
diff
changeset
|
167 |
|
9182
23af5910e5f5
make load work for derived classses
Robert T. Short <octave@phaselockedsystems.com>
parents:
9151
diff
changeset
|
168 bool reconstruct_parents (void); |
|
23af5910e5f5
make load work for derived classses
Robert T. Short <octave@phaselockedsystems.com>
parents:
9151
diff
changeset
|
169 |
|
8212
ebf6f6a0f9a7
Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
8154
diff
changeset
|
170 bool save_ascii (std::ostream& os); |
| 7338 | 171 |
| 172 bool load_ascii (std::istream& is); | |
| 173 | |
| 174 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 175 | |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
176 bool load_binary (std::istream& is, bool swap, |
| 10313 | 177 oct_mach_info::float_format fmt); |
| 7338 | 178 |
| 179 #if defined (HAVE_HDF5) | |
| 180 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 181 | |
|
9881
b3089dba88bf
Remove HDF5 cruft for older versions of HDF5
Kacper Kowalik
parents:
9767
diff
changeset
|
182 bool load_hdf5 (hid_t loc_id, const char *name); |
| 7338 | 183 #endif |
| 184 | |
| 185 mxArray *as_mxArray (void) const; | |
| 186 | |
|
9529
8e5009334661
partially revert e79470be3ecb
Jaroslav Hajek <highegg@gmail.com>
parents:
9522
diff
changeset
|
187 private: |
| 7338 | 188 |
|
10768
8a868004a437
use octave_map for octave_class
Jaroslav Hajek <highegg@gmail.com>
parents:
10742
diff
changeset
|
189 octave_map map; |
| 7338 | 190 |
| 191 DECLARE_OCTAVE_ALLOCATOR | |
| 192 | |
| 193 public: | |
| 194 int type_id (void) const { return t_id; } | |
| 195 std::string type_name (void) const { return t_name; } | |
| 196 std::string class_name (void) const { return c_name; } | |
| 197 | |
| 198 static int static_type_id (void) { return t_id; } | |
| 199 static std::string static_type_name (void) { return t_name; } | |
| 200 static std::string static_class_name (void) { return "<unknown>"; } | |
| 201 static void register_type (void); | |
| 202 | |
| 203 private: | |
| 204 static int t_id; | |
| 205 | |
| 206 static const std::string t_name; | |
| 207 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
|
208 std::list<std::string> parent_list; |
| 7338 | 209 |
|
9581
3d0d2bda3a0f
fix previous change, avoid duplicate loads of methods in descendant classes
Jaroslav Hajek <highegg@gmail.com>
parents:
9529
diff
changeset
|
210 bool in_class_method (void); |
|
10926
f687bd17ce21
fix field assignment from private class methods
Jaroslav Hajek <highegg@gmail.com>
parents:
10768
diff
changeset
|
211 std::string get_current_method_class (void); |
| 9151 | 212 |
|
12171
d08901c05c1b
fix bug in class assignment to undefined object with index
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
213 octave_value subsasgn_common (const octave_value& obj, |
|
d08901c05c1b
fix bug in class assignment to undefined object with index
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
214 const std::string& type, |
|
d08901c05c1b
fix bug in class assignment to undefined object with index
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
215 const std::list<octave_value_list>& idx, |
|
d08901c05c1b
fix bug in class assignment to undefined object with index
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
216 const octave_value& rhs); |
|
d08901c05c1b
fix bug in class assignment to undefined object with index
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
217 |
|
9522
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
218 int obsolete_copies; |
|
e79470be3ecb
implement subsasgn this-arg optimization
Jaroslav Hajek <highegg@gmail.com>
parents:
9521
diff
changeset
|
219 |
| 9151 | 220 public: |
| 221 // The list of field names and parent classes defines a class. We | |
| 222 // keep track of each class that has been created so that we know | |
| 223 class exemplar_info | |
| 224 { | |
| 225 public: | |
| 226 | |
| 227 exemplar_info (void) : field_names (), parent_class_names () { } | |
| 228 | |
| 229 exemplar_info (const octave_value& obj); | |
| 230 | |
| 231 exemplar_info (const exemplar_info& x) | |
| 232 : field_names (x.field_names), | |
| 10313 | 233 parent_class_names (x.parent_class_names) { } |
| 9151 | 234 |
| 235 exemplar_info& operator = (const exemplar_info& x) | |
| 236 { | |
| 237 if (&x != this) | |
| 10313 | 238 { |
| 239 field_names = x.field_names; | |
| 240 parent_class_names = x.parent_class_names; | |
| 241 } | |
| 9151 | 242 return *this; |
| 243 } | |
| 244 | |
| 245 octave_idx_type nfields (void) const { return field_names.length (); } | |
| 246 | |
| 247 size_t nparents (void) const { return parent_class_names.size (); } | |
| 248 | |
| 249 string_vector fields (void) const { return field_names; } | |
| 250 | |
| 251 std::list<std::string> parents (void) const { return parent_class_names; } | |
| 252 | |
| 253 bool compare (const octave_value& obj) const; | |
| 254 | |
| 255 private: | |
| 256 | |
| 257 string_vector field_names; | |
| 258 std::list<std::string> parent_class_names; | |
| 259 }; | |
| 260 | |
| 261 // A map from class names to lists of fields. | |
| 262 static std::map<std::string, exemplar_info> exemplar_map; | |
| 263 | |
| 264 typedef std::map<std::string, exemplar_info>::iterator exemplar_iterator; | |
| 265 typedef std::map<std::string, exemplar_info>::const_iterator exemplar_const_iterator; | |
| 7338 | 266 }; |
| 267 | |
| 268 #endif |