Mercurial > octave
annotate src/ov-fcn-handle.h @ 10313:f3b65e1ae355
untabify src header files
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Thu, 11 Feb 2010 12:16:43 -0500 |
| parents | a4fb4675accb |
| children | 97b4bd6f0925 |
| rev | line source |
|---|---|
| 4343 | 1 /* |
| 2 | |
| 8920 | 3 Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 John W. Eaton |
| 4343 | 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. | |
| 4343 | 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/>. | |
| 4343 | 20 |
| 21 */ | |
| 22 | |
| 23 #if !defined (octave_fcn_handle_h) | |
| 24 #define octave_fcn_handle_h 1 | |
| 25 | |
|
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
26 #include <iosfwd> |
| 4343 | 27 #include <string> |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
28 #include <memory> |
| 4343 | 29 |
| 30 #include "oct-alloc.h" | |
| 31 | |
| 32 #include "ov-base.h" | |
| 4654 | 33 #include "ov-base-mat.h" |
| 4343 | 34 #include "ov-fcn.h" |
| 4654 | 35 #include "ov-typeinfo.h" |
| 4343 | 36 |
| 37 // Function handles. | |
| 38 | |
| 4925 | 39 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
|
40 OCTINTERP_API |
| 4925 | 41 octave_fcn_handle : public octave_base_value |
| 4654 | 42 { |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
43 private: |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
44 |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
45 typedef std::map<std::string, octave_value> str_ov_map; |
|
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 octave_fcn_handle (const octave_value& f, const std::string& n, |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
48 str_ov_map *sdisp) |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
49 : fcn (f), nm (n), disp (sdisp) { } |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
50 |
| 4654 | 51 public: |
|
10261
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
52 |
|
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
53 static const std::string anonymous; |
|
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
54 |
| 4930 | 55 octave_fcn_handle (void) |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
56 : fcn (), nm () { } |
| 4654 | 57 |
| 5007 | 58 octave_fcn_handle (const std::string& n) |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
59 : fcn (), nm (n) { } |
| 5007 | 60 |
|
10261
a4fb4675accb
make printing of handles more Matlab-compatible
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
61 octave_fcn_handle (const octave_value& f, const std::string& n = anonymous); |
| 4654 | 62 |
| 4967 | 63 octave_fcn_handle (const octave_fcn_handle& fh) |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
64 : octave_base_value (fh), fcn (fh.fcn), nm (fh.nm) |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
65 { |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
66 if (fh.disp.get ()) |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
67 disp.reset (new str_ov_map (*fh.disp)); |
|
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 |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
95 bool is_overloaded (void) const { return disp.get () && ! disp->empty (); } |
|
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 |
| 6974 | 111 bool save_ascii (std::ostream& os); |
| 4988 | 112 |
| 113 bool load_ascii (std::istream& is); | |
| 114 | |
| 115 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 116 | |
| 117 bool load_binary (std::istream& is, bool swap, | |
| 10313 | 118 oct_mach_info::float_format fmt); |
| 4988 | 119 |
| 120 #if defined (HAVE_HDF5) | |
| 121 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 122 | |
|
9881
b3089dba88bf
Remove HDF5 cruft for older versions of HDF5
Kacper Kowalik
parents:
9463
diff
changeset
|
123 bool load_hdf5 (hid_t loc_id, const char *name); |
| 4988 | 124 #endif |
| 125 | |
| 4654 | 126 void print (std::ostream& os, bool pr_as_read_syntax = false) const; |
| 127 | |
| 128 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; | |
| 129 | |
| 130 private: | |
| 4343 | 131 |
| 6625 | 132 bool set_fcn (const std::string &octaveroot, const std::string& fpath); |
| 133 | |
| 4612 | 134 DECLARE_OCTAVE_ALLOCATOR |
| 4343 | 135 |
| 4612 | 136 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
| 4925 | 137 |
| 4933 | 138 protected: |
| 4930 | 139 |
| 4925 | 140 // The function we are handling. |
| 4930 | 141 octave_value fcn; |
| 4925 | 142 |
| 143 // The name of the handle, including the "@". | |
| 144 std::string nm; | |
|
9450
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
145 |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
146 // A pointer to statical dispatch to standard classes. If null, we don't want |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
147 // to dispatch at all. |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
148 std::auto_ptr<str_ov_map> disp; |
|
cf714e75c656
implement overloaded function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
149 |
|
9463
d34baf412786
support non-local function lookups in str2func
Jaroslav Hajek <highegg@gmail.com>
parents:
9450
diff
changeset
|
150 friend octave_value make_fcn_handle (const std::string &, bool); |
| 4343 | 151 }; |
| 152 | |
|
9463
d34baf412786
support non-local function lookups in str2func
Jaroslav Hajek <highegg@gmail.com>
parents:
9450
diff
changeset
|
153 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
|
154 bool local_funcs = true); |
| 4343 | 155 |
| 156 #endif |