Mercurial > octave-nkf
annotate src/ov-fcn-handle.h @ 10843:229675bb7647 ss-3-3-52
version is now 3.3.52
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Sun, 01 Aug 2010 11:49:45 -0400 |
| parents | 4d1fc073fbb7 |
| children | f1a45913662a |
| rev | line source |
|---|---|
| 4343 | 1 /* |
| 2 | |
| 8920 | 3 Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 John W. Eaton |
|
10521
4d1fc073fbb7
add some missing copyright stmts
Jaroslav Hajek <highegg@gmail.com>
parents:
10324
diff
changeset
|
4 Copyright (C) 2009 VZLU Prague |
| 4343 | 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 | |
| 7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
| 11 option) any later version. | |
| 4343 | 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 | |
| 7016 | 19 along with Octave; see the file COPYING. If not, see |
| 20 <http://www.gnu.org/licenses/>. | |
| 4343 | 21 |
| 22 */ | |
| 23 | |
| 24 #if !defined (octave_fcn_handle_h) | |
| 25 #define octave_fcn_handle_h 1 | |
| 26 | |
|
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
27 #include <iosfwd> |
| 4343 | 28 #include <string> |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
29 #include <memory> |
| 4343 | 30 |
| 31 #include "oct-alloc.h" | |
| 32 | |
| 33 #include "ov-base.h" | |
| 4654 | 34 #include "ov-base-mat.h" |
| 4343 | 35 #include "ov-fcn.h" |
| 4654 | 36 #include "ov-typeinfo.h" |
| 4343 | 37 |
| 38 // Function handles. | |
| 39 | |
| 4925 | 40 class |
|
7867
f6fffa74b9b5
Export additional symbols: octave_fcn_inline, octave_fcn_handle, read_binary_data, save_binary_data.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
7761
diff
changeset
|
41 OCTINTERP_API |
| 4925 | 42 octave_fcn_handle : public octave_base_value |
| 4654 | 43 { |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
44 private: |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
45 |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
46 typedef std::map<std::string, octave_value> str_ov_map; |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
47 |
| 4654 | 48 public: |
|
10261
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
49 |
|
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
50 static const std::string anonymous; |
|
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
51 |
| 4930 | 52 octave_fcn_handle (void) |
|
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
53 : fcn (), nm (), has_overloads (false) { } |
| 4654 | 54 |
| 5007 | 55 octave_fcn_handle (const std::string& n) |
|
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
56 : fcn (), nm (n), has_overloads (false) { } |
| 5007 | 57 |
|
10261
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
58 octave_fcn_handle (const octave_value& f, const std::string& n = anonymous); |
| 4654 | 59 |
| 4967 | 60 octave_fcn_handle (const octave_fcn_handle& fh) |
|
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
61 : octave_base_value (fh), fcn (fh.fcn), nm (fh.nm), |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
62 has_overloads (fh.has_overloads) |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
63 { |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
64 for (int i = 0; i < btyp_num_types; i++) |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
65 builtin_overloads[i] = fh.builtin_overloads[i]; |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
66 |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
67 overloads = fh.overloads; |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
68 } |
| 4967 | 69 |
| 4654 | 70 ~octave_fcn_handle (void) { } |
| 71 | |
| 5759 | 72 octave_base_value *clone (void) const { return new octave_fcn_handle (*this); } |
| 73 octave_base_value *empty_clone (void) const { return new octave_fcn_handle (); } | |
| 4967 | 74 |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7336
diff
changeset
|
75 octave_value subsref (const std::string& type, |
| 10313 | 76 const std::list<octave_value_list>& idx) |
| 4924 | 77 { |
|
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7336
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:
7336
diff
changeset
|
79 return tmp.length () > 0 ? tmp(0) : octave_value (); |
| 4924 | 80 } |
| 81 | |
| 82 octave_value_list subsref (const std::string& type, | |
| 10313 | 83 const std::list<octave_value_list>& idx, |
| 84 int nargout); | |
| 4924 | 85 |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
86 octave_value_list |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
87 do_multi_index_op (int nargout, const octave_value_list& args); |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
88 |
| 4925 | 89 bool is_defined (void) const { return true; } |
| 4654 | 90 |
| 91 bool is_function_handle (void) const { return true; } | |
| 92 | |
|
10087
090173f2db40
improve overload dispatching of built-in classes
Jaroslav Hajek <highegg@gmail.com>
parents:
10075
diff
changeset
|
93 builtin_type_t builtin_type (void) const { return btyp_func_handle; } |
|
090173f2db40
improve overload dispatching of built-in classes
Jaroslav Hajek <highegg@gmail.com>
parents:
10075
diff
changeset
|
94 |
|
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
95 bool is_overloaded (void) const { return has_overloads; } |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
96 |
| 5654 | 97 dim_vector dims (void) const { static dim_vector dv (1, 1); return dv; } |
| 98 | |
| 4930 | 99 octave_function *function_value (bool = false) |
| 100 { return fcn.function_value (); } | |
| 101 | |
| 6625 | 102 octave_user_function *user_function_value (bool = false) |
| 103 { return fcn.user_function_value (); } | |
| 104 | |
| 4654 | 105 octave_fcn_handle *fcn_handle_value (bool = false) { return this; } |
| 106 | |
| 5007 | 107 octave_value fcn_val (void) const { return fcn; } |
| 108 | |
| 4933 | 109 std::string fcn_name (void) const { return nm; } |
| 4930 | 110 |
|
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
111 void set_overload (builtin_type_t btyp, const octave_value& ov_fcn) |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
112 { |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
113 if (btyp != btyp_unknown) |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
114 { |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
115 has_overloads = true; |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
116 builtin_overloads[btyp] = ov_fcn; |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
117 } |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
118 |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
119 } |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
120 |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
121 void set_overload (const std::string& dispatch_type, const octave_value& ov_fcn) |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
122 { |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
123 has_overloads = true; |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
124 overloads[dispatch_type] = ov_fcn; |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
125 } |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
126 |
|
10322
21551cc88061
improve function handles comparison
Jaroslav Hajek <highegg@gmail.com>
parents:
10321
diff
changeset
|
127 bool is_equal_to (const octave_fcn_handle&) const; |
|
21551cc88061
improve function handles comparison
Jaroslav Hajek <highegg@gmail.com>
parents:
10321
diff
changeset
|
128 |
| 6974 | 129 bool save_ascii (std::ostream& os); |
| 4988 | 130 |
| 131 bool load_ascii (std::istream& is); | |
| 132 | |
| 133 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 134 | |
| 135 bool load_binary (std::istream& is, bool swap, | |
| 10313 | 136 oct_mach_info::float_format fmt); |
| 4988 | 137 |
| 138 #if defined (HAVE_HDF5) | |
| 139 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 140 | |
|
9881
b3089dba88bf
Remove HDF5 cruft for older versions of HDF5
Kacper Kowalik
parents:
9463
diff
changeset
|
141 bool load_hdf5 (hid_t loc_id, const char *name); |
| 4988 | 142 #endif |
| 143 | |
| 4654 | 144 void print (std::ostream& os, bool pr_as_read_syntax = false) const; |
| 145 | |
| 146 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
| 147 | |
|
10324
7673850d6adf
make simple handles printed inline
Jaroslav Hajek <highegg@gmail.com>
parents:
10322
diff
changeset
|
148 // Simple function handles are printed without a newline. |
|
7673850d6adf
make simple handles printed inline
Jaroslav Hajek <highegg@gmail.com>
parents:
10322
diff
changeset
|
149 bool print_as_scalar (void) const { return nm != anonymous; } |
|
7673850d6adf
make simple handles printed inline
Jaroslav Hajek <highegg@gmail.com>
parents:
10322
diff
changeset
|
150 |
| 4654 | 151 private: |
| 4343 | 152 |
| 6625 | 153 bool set_fcn (const std::string &octaveroot, const std::string& fpath); |
| 154 | |
| 4612 | 155 DECLARE_OCTAVE_ALLOCATOR |
| 4343 | 156 |
| 4612 | 157 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
| 4925 | 158 |
| 4933 | 159 protected: |
| 4930 | 160 |
| 4925 | 161 // The function we are handling. |
| 4930 | 162 octave_value fcn; |
| 4925 | 163 |
| 164 // The name of the handle, including the "@". | |
| 165 std::string nm; | |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
166 |
|
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
167 // Whether the function is overloaded at all. |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
168 bool has_overloads; |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
169 |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
170 // Overloads for builtin types. We use array to make lookup faster. |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
171 octave_value builtin_overloads[btyp_num_types]; |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
172 |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
173 // Overloads for other classes. |
|
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
174 str_ov_map overloads; |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
175 |
|
9463
d34baf412786
support non-local function lookups in str2func
Jaroslav Hajek <highegg@gmail.com>
parents:
9450
diff
changeset
|
176 friend octave_value make_fcn_handle (const std::string &, bool); |
| 4343 | 177 }; |
| 178 | |
|
9463
d34baf412786
support non-local function lookups in str2func
Jaroslav Hajek <highegg@gmail.com>
parents:
9450
diff
changeset
|
179 extern octave_value make_fcn_handle (const std::string& nm, |
|
d34baf412786
support non-local function lookups in str2func
Jaroslav Hajek <highegg@gmail.com>
parents:
9450
diff
changeset
|
180 bool local_funcs = true); |
| 4343 | 181 |
| 182 #endif |