Mercurial > octave
annotate libinterp/octave-value/ov-fcn-handle.h @ 21574:ae4d7dfea337
maint: merge stable to default.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 01 Apr 2016 12:57:49 -0400 |
parents | 1473547f50f5 f3f8e1d3e399 |
children | c4ab2e54f100 |
rev | line source |
---|---|
4343 | 1 /* |
2 | |
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19598
diff
changeset
|
3 Copyright (C) 2003-2015 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 | |
20791
f7084eae3318
maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents:
19863
diff
changeset
|
24 #if ! defined (octave_ov_fcn_handle_h) |
17822
ebb3ef964372
maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents:
17787
diff
changeset
|
25 #define octave_ov_fcn_handle_h 1 |
4343 | 26 |
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20791
diff
changeset
|
27 #include "octave-config.h" |
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20791
diff
changeset
|
28 |
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
29 #include <iosfwd> |
4343 | 30 #include <string> |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
31 #include <memory> |
4343 | 32 |
33 | |
34 #include "ov-base.h" | |
4654 | 35 #include "ov-base-mat.h" |
4343 | 36 #include "ov-fcn.h" |
4654 | 37 #include "ov-typeinfo.h" |
4343 | 38 |
39 // Function handles. | |
40 | |
4925 | 41 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
|
42 OCTINTERP_API |
4925 | 43 octave_fcn_handle : public octave_base_value |
4654 | 44 { |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
45 private: |
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
46 |
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
47 typedef std::map<std::string, octave_value> str_ov_map; |
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
48 |
4654 | 49 public: |
10261
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
50 |
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
51 static const std::string anonymous; |
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
52 |
4930 | 53 octave_fcn_handle (void) |
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11523
diff
changeset
|
54 : fcn (), nm (), has_overloads (false), overloads () { } |
4654 | 55 |
5007 | 56 octave_fcn_handle (const std::string& n) |
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11523
diff
changeset
|
57 : fcn (), nm (n), has_overloads (false), overloads () { } |
5007 | 58 |
10261
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
59 octave_fcn_handle (const octave_value& f, const std::string& n = anonymous); |
4654 | 60 |
4967 | 61 octave_fcn_handle (const octave_fcn_handle& fh) |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
62 : octave_base_value (fh), fcn (fh.fcn), nm (fh.nm), |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
63 has_overloads (fh.has_overloads), overloads () |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
64 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
65 for (int i = 0; i < btyp_num_types; i++) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
66 builtin_overloads[i] = fh.builtin_overloads[i]; |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
67 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
68 overloads = fh.overloads; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
69 } |
4967 | 70 |
4654 | 71 ~octave_fcn_handle (void) { } |
72 | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
73 octave_base_value *clone (void) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
74 { return new octave_fcn_handle (*this); } |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
75 octave_base_value *empty_clone (void) const |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
76 { return new octave_fcn_handle (); } |
4967 | 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 subsref (const std::string& type, |
10313 | 79 const std::list<octave_value_list>& idx) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
80 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
81 octave_value_list tmp = subsref (type, idx, 1); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
82 return tmp.length () > 0 ? tmp(0) : octave_value (); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
83 } |
4924 | 84 |
85 octave_value_list subsref (const std::string& type, | |
10313 | 86 const std::list<octave_value_list>& idx, |
87 int nargout); | |
4924 | 88 |
10849
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
89 octave_value_list subsref (const std::string& type, |
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
90 const std::list<octave_value_list>& idx, |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
91 int nargout, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
92 const std::list<octave_lvalue>* lvalue_list); |
10849
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
93 |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
94 octave_value_list |
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
95 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
|
96 |
10849
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
97 octave_value_list |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
98 do_multi_index_op (int nargout, const octave_value_list& args, |
10849
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
99 const std::list<octave_lvalue>* lvalue_list); |
f1a45913662a
propagate isargout info through function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
100 |
4925 | 101 bool is_defined (void) const { return true; } |
4654 | 102 |
103 bool is_function_handle (void) const { return true; } | |
104 | |
10087
090173f2db40
improve overload dispatching of built-in classes
Jaroslav Hajek <highegg@gmail.com>
parents:
10075
diff
changeset
|
105 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
|
106 |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
107 bool is_overloaded (void) const { return has_overloads; } |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
108 |
21573
f3f8e1d3e399
avoid mulitple definitions of static function-scope vars (bug #47372)
John W. Eaton <jwe@octave.org>
parents:
19863
diff
changeset
|
109 dim_vector dims (void) const; |
5654 | 110 |
4930 | 111 octave_function *function_value (bool = false) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
112 { return fcn.function_value (); } |
4930 | 113 |
6625 | 114 octave_user_function *user_function_value (bool = false) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
115 { return fcn.user_function_value (); } |
6625 | 116 |
4654 | 117 octave_fcn_handle *fcn_handle_value (bool = false) { return this; } |
118 | |
5007 | 119 octave_value fcn_val (void) const { return fcn; } |
120 | |
4933 | 121 std::string fcn_name (void) const { return nm; } |
4930 | 122 |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
123 void set_overload (builtin_type_t btyp, const octave_value& ov_fcn) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
124 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
125 if (btyp != btyp_unknown) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
126 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
127 has_overloads = true; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
128 builtin_overloads[btyp] = ov_fcn; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
129 } |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
130 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
131 } |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
132 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
133 void set_overload (const std::string& dispatch_type, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
134 const octave_value& ov_fcn) |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
135 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
136 has_overloads = true; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
137 overloads[dispatch_type] = ov_fcn; |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
138 } |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
139 |
10322
21551cc88061
improve function handles comparison
Jaroslav Hajek <highegg@gmail.com>
parents:
10321
diff
changeset
|
140 bool is_equal_to (const octave_fcn_handle&) const; |
21551cc88061
improve function handles comparison
Jaroslav Hajek <highegg@gmail.com>
parents:
10321
diff
changeset
|
141 |
6974 | 142 bool save_ascii (std::ostream& os); |
4988 | 143 |
144 bool load_ascii (std::istream& is); | |
145 | |
146 bool save_binary (std::ostream& os, bool& save_as_floats); | |
147 | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
148 bool load_binary (std::istream& is, bool swap, |
10313 | 149 oct_mach_info::float_format fmt); |
4988 | 150 |
19863
09ed6f7538dd
avoid needing to include hdf5 in public header files (bug #44370, #43180)
John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org>
parents:
19697
diff
changeset
|
151 bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats); |
4988 | 152 |
19863
09ed6f7538dd
avoid needing to include hdf5 in public header files (bug #44370, #43180)
John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org>
parents:
19697
diff
changeset
|
153 bool load_hdf5 (octave_hdf5_id loc_id, const char *name); |
4988 | 154 |
18416
bcd71a2531d3
Support disp/display overloading in classdef
Michael Goffioul <michael.goffioul@gmail.com>
parents:
17822
diff
changeset
|
155 void print (std::ostream& os, bool pr_as_read_syntax = false); |
4654 | 156 |
157 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
158 | |
10324
7673850d6adf
make simple handles printed inline
Jaroslav Hajek <highegg@gmail.com>
parents:
10322
diff
changeset
|
159 // Simple function handles are printed without a newline. |
7673850d6adf
make simple handles printed inline
Jaroslav Hajek <highegg@gmail.com>
parents:
10322
diff
changeset
|
160 bool print_as_scalar (void) const { return nm != anonymous; } |
7673850d6adf
make simple handles printed inline
Jaroslav Hajek <highegg@gmail.com>
parents:
10322
diff
changeset
|
161 |
4654 | 162 private: |
4343 | 163 |
6625 | 164 bool set_fcn (const std::string &octaveroot, const std::string& fpath); |
165 | |
4343 | 166 |
4612 | 167 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
4925 | 168 |
4933 | 169 protected: |
4930 | 170 |
4925 | 171 // The function we are handling. |
4930 | 172 octave_value fcn; |
4925 | 173 |
174 // The name of the handle, including the "@". | |
175 std::string nm; | |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
176 |
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
177 // Whether the function is overloaded at all. |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
178 bool has_overloads; |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
179 |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
180 // 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
|
181 octave_value builtin_overloads[btyp_num_types]; |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
182 |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
183 // Overloads for other classes. |
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
184 str_ov_map overloads; |
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
185 |
9463
d34baf412786
support non-local function lookups in str2func
Jaroslav Hajek <highegg@gmail.com>
parents:
9450
diff
changeset
|
186 friend octave_value make_fcn_handle (const std::string &, bool); |
4343 | 187 }; |
188 | |
9463
d34baf412786
support non-local function lookups in str2func
Jaroslav Hajek <highegg@gmail.com>
parents:
9450
diff
changeset
|
189 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
|
190 bool local_funcs = true); |
4343 | 191 |
10960 | 192 class |
193 OCTINTERP_API | |
194 octave_fcn_binder : public octave_fcn_handle | |
195 { | |
196 private: | |
197 // Private ctor. | |
198 octave_fcn_binder (const octave_value& f, const octave_value& root, | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
199 const octave_value_list& templ, |
10960 | 200 const std::vector<int>& mask, int exp_nargin); |
201 | |
202 public: | |
203 | |
204 // Factory method. | |
205 static octave_fcn_handle *maybe_binder (const octave_value& f); | |
206 | |
207 octave_value_list | |
208 do_multi_index_op (int nargout, const octave_value_list& args); | |
209 | |
210 octave_value_list | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
211 do_multi_index_op (int nargout, const octave_value_list& args, |
10960 | 212 const std::list<octave_lvalue>* lvalue_list); |
213 | |
214 protected: | |
215 | |
216 octave_value root_handle; | |
217 octave_value_list arg_template; | |
218 std::vector<int> arg_mask; | |
219 int expected_nargin; | |
220 }; | |
4343 | 221 #endif |