annotate src/ov-fcn-handle.h @ 7948:af10baa63915 ss-3-1-50

3.1.50 snapshot
author John W. Eaton <jwe@octave.org>
date Fri, 18 Jul 2008 17:42:48 -0400
parents f6fffa74b9b5
children eb63fbe60fab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
1 /*
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
2
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 2003, 2004, 2005, 2006, 2007 John W. Eaton
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
4
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
6
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6974
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6974
diff changeset
10 option) any later version.
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
11
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
15 for more details.
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
16
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6974
diff changeset
18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6974
diff changeset
19 <http://www.gnu.org/licenses/>.
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
20
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
21 */
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
22
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_fcn_handle_h)
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
24 #define octave_fcn_handle_h 1
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
25
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
26 #include <iostream>
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
27 #include <string>
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
28
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
29 #include "oct-alloc.h"
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
30
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
31 #include "ov-base.h"
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
32 #include "ov-base-mat.h"
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
33 #include "ov-fcn.h"
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
34 #include "ov-typeinfo.h"
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
35
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
36 // Function handles.
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
37
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
38 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
39 OCTINTERP_API
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
40 octave_fcn_handle : public octave_base_value
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
41 {
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
42 public:
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
43 octave_fcn_handle (void)
5663
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5654
diff changeset
44 : warn_reload (true), fcn (), nm () { }
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
45
5007
f8c27dad3643 [project @ 2004-09-17 11:42:04 by jwe]
jwe
parents: 4988
diff changeset
46 octave_fcn_handle (const std::string& n)
5663
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5654
diff changeset
47 : warn_reload (true), fcn (), nm (n) { }
5007
f8c27dad3643 [project @ 2004-09-17 11:42:04 by jwe]
jwe
parents: 4988
diff changeset
48
7761
5adeea5de26c symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents: 7651
diff changeset
49 octave_fcn_handle (const octave_value& f, const std::string& n);
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
50
4967
0355f2f7d193 [project @ 2004-09-07 15:09:14 by jwe]
jwe
parents: 4933
diff changeset
51 octave_fcn_handle (const octave_fcn_handle& fh)
5663
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5654
diff changeset
52 : octave_base_value (fh), warn_reload (fh.warn_reload),
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5654
diff changeset
53 fcn (fh.fcn), nm (fh.nm) { }
4967
0355f2f7d193 [project @ 2004-09-07 15:09:14 by jwe]
jwe
parents: 4933
diff changeset
54
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
55 ~octave_fcn_handle (void) { }
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
56
5759
ce79d238f142 [project @ 2006-04-13 13:04:32 by jwe]
jwe
parents: 5663
diff changeset
57 octave_base_value *clone (void) const { return new octave_fcn_handle (*this); }
ce79d238f142 [project @ 2006-04-13 13:04:32 by jwe]
jwe
parents: 5663
diff changeset
58 octave_base_value *empty_clone (void) const { return new octave_fcn_handle (); }
4967
0355f2f7d193 [project @ 2004-09-07 15:09:14 by jwe]
jwe
parents: 4933
diff changeset
59
7651
443a8f5a50fd require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
60 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: 7336
diff changeset
61 const std::list<octave_value_list>& idx)
4924
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
62 {
7651
443a8f5a50fd require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
63 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
64 return tmp.length () > 0 ? tmp(0) : octave_value ();
4924
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
65 }
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
66
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
67 octave_value_list subsref (const std::string& type,
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
68 const std::list<octave_value_list>& idx,
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
69 int nargout);
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
70
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
71 bool is_defined (void) const { return true; }
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
72
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
73 bool is_function_handle (void) const { return true; }
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
74
5654
6aae52010e3b [project @ 2006-03-09 19:04:53 by jwe]
jwe
parents: 5307
diff changeset
75 dim_vector dims (void) const { static dim_vector dv (1, 1); return dv; }
6aae52010e3b [project @ 2006-03-09 19:04:53 by jwe]
jwe
parents: 5307
diff changeset
76
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
77 octave_function *function_value (bool = false)
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
78 { return fcn.function_value (); }
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
79
7761
5adeea5de26c symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents: 7651
diff changeset
80 const octave_function *function_value (bool = false) const
5adeea5de26c symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents: 7651
diff changeset
81 { return fcn.function_value (); }
5adeea5de26c symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents: 7651
diff changeset
82
6625
5d02dfacfc9e [project @ 2007-05-16 08:49:47 by dbateman]
dbateman
parents: 5958
diff changeset
83 octave_user_function *user_function_value (bool = false)
5d02dfacfc9e [project @ 2007-05-16 08:49:47 by dbateman]
dbateman
parents: 5958
diff changeset
84 { return fcn.user_function_value (); }
5d02dfacfc9e [project @ 2007-05-16 08:49:47 by dbateman]
dbateman
parents: 5958
diff changeset
85
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
86 octave_fcn_handle *fcn_handle_value (bool = false) { return this; }
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
87
5007
f8c27dad3643 [project @ 2004-09-17 11:42:04 by jwe]
jwe
parents: 4988
diff changeset
88 octave_value fcn_val (void) const { return fcn; }
f8c27dad3643 [project @ 2004-09-17 11:42:04 by jwe]
jwe
parents: 4988
diff changeset
89
4933
cd58733c326b [project @ 2004-08-05 16:08:28 by jwe]
jwe
parents: 4930
diff changeset
90 std::string fcn_name (void) const { return nm; }
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
91
6974
9e32bb109980 [project @ 2007-10-08 11:06:47 by jwe]
jwe
parents: 6625
diff changeset
92 bool save_ascii (std::ostream& os);
4988
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
93
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
94 bool load_ascii (std::istream& is);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
95
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
96 bool save_binary (std::ostream& os, bool& save_as_floats);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
97
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
98 bool load_binary (std::istream& is, bool swap,
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
99 oct_mach_info::float_format fmt);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
100
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
101 #if defined (HAVE_HDF5)
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
102 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
103
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
104 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
105 #endif
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
106
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
107 void print (std::ostream& os, bool pr_as_read_syntax = false) const;
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
108
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
109 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
110
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
111 private:
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
112
6625
5d02dfacfc9e [project @ 2007-05-16 08:49:47 by dbateman]
dbateman
parents: 5958
diff changeset
113 bool set_fcn (const std::string &octaveroot, const std::string& fpath);
5d02dfacfc9e [project @ 2007-05-16 08:49:47 by dbateman]
dbateman
parents: 5958
diff changeset
114
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4346
diff changeset
115 DECLARE_OCTAVE_ALLOCATOR
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
116
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4346
diff changeset
117 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
118
5663
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5654
diff changeset
119 // If TRUE, print a warning if the pointed-to fucntion is out of
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5654
diff changeset
120 // date. This variable may be removed when updating is properly
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5654
diff changeset
121 // implemented.
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5654
diff changeset
122 mutable bool warn_reload;
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5654
diff changeset
123
4933
cd58733c326b [project @ 2004-08-05 16:08:28 by jwe]
jwe
parents: 4930
diff changeset
124 protected:
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
125
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
126 // The function we are handling.
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
127 octave_value fcn;
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
128
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
129 // The name of the handle, including the "@".
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
130 std::string nm;
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
131 };
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
132
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
133 extern octave_value make_fcn_handle (const std::string& nm);
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
134
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
135 #endif
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
136
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
137 /*
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
138 ;;; Local Variables: ***
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
139 ;;; mode: C++ ***
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
140 ;;; End: ***
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
141 */