annotate src/ov-fcn.h @ 4748:7b145222fea3

[project @ 2004-02-07 06:27:27 by jwe]
author jwe
date Sat, 07 Feb 2004 06:27:28 +0000
parents bd2067547b40
children d2038299c683
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
1 /*
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
2
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
4
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
6
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
10 later version.
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
11
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
15 for more details.
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
16
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
20
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
21 */
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
22
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_function_h)
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
24 #define octave_function_h 1
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
25
4192
5719210fff4c [project @ 2002-11-20 16:56:47 by jwe]
jwe
parents: 4066
diff changeset
26 #if defined (__GNUG__) && defined (USE_PRAGMA_INTERFACE_IMPLEMENTATION)
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
27 #pragma interface
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
28 #endif
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
29
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
30 #include <string>
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
31
3258
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe]
jwe
parents: 3255
diff changeset
32 #include "oct-time.h"
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3258
diff changeset
33 #include "str-vec.h"
3258
4964d5391acc [project @ 1999-07-21 21:51:33 by jwe]
jwe
parents: 3255
diff changeset
34
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
35 #include "oct-alloc.h"
4748
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
36 #include "oct-obj.h"
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
37 #include "ov-base.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
38 #include "ov-typeinfo.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
39
2976
641689f67673 [project @ 1997-05-15 20:27:04 by jwe]
jwe
parents: 2974
diff changeset
40 class tree_walker;
641689f67673 [project @ 1997-05-15 20:27:04 by jwe]
jwe
parents: 2974
diff changeset
41
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
42 // Functions.
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
43
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
44 class
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
45 octave_function : public octave_base_value
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
46 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
47 public:
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
48
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4643
diff changeset
49 octave_function (void) { }
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
50
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
51 ~octave_function (void) { }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
52
4579
0854429eb037 [project @ 2003-10-31 14:30:34 by jwe]
jwe
parents: 4343
diff changeset
53 octave_value *clone (void) const;
0854429eb037 [project @ 2003-10-31 14:30:34 by jwe]
jwe
parents: 4343
diff changeset
54 octave_value *empty_clone (void) const;
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
55
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
56 bool is_defined (void) const { return true; }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
57
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
58 bool is_function (void) const { return true; }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
59
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3258
diff changeset
60 virtual bool is_dynamically_loaded_function (void) const { return false; }
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3258
diff changeset
61
3544
71bd2d124119 [project @ 2000-02-02 21:02:31 by jwe]
jwe
parents: 3523
diff changeset
62 virtual bool is_system_fcn_file (void) const { return false; }
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
63
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3325
diff changeset
64 virtual std::string fcn_file_name (void) const { return std::string (); }
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
65
3255
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3219
diff changeset
66 virtual void mark_fcn_file_up_to_date (const octave_time&) { }
3166
c3409a0cafa8 [project @ 1998-04-16 03:12:19 by jwe]
jwe
parents: 2976
diff changeset
67
3255
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3219
diff changeset
68 virtual octave_time time_parsed (void) const
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3219
diff changeset
69 { return octave_time (static_cast<time_t> (0)); }
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
70
3255
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3219
diff changeset
71 virtual octave_time time_checked (void) const
4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe]
jwe
parents: 3219
diff changeset
72 { return octave_time (static_cast<time_t> (0)); }
3166
c3409a0cafa8 [project @ 1998-04-16 03:12:19 by jwe]
jwe
parents: 2976
diff changeset
73
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents: 4192
diff changeset
74 virtual bool is_nested_function (void) const { return false; }
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents: 4192
diff changeset
75
4748
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
76 virtual bool is_user_function (void) const { return false; }
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
77
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
78 virtual bool takes_varargs (void) const { return false; }
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
79
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
80 virtual void octave_va_start (void) { }
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
81
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
82 virtual octave_value octave_va_arg (void) const { return octave_value (); }
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
83
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
84 virtual octave_value_list octave_all_va_args (void)
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
85 { return octave_value_list (); }
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
86
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
87 virtual bool takes_var_return (void) const { return false; }
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
88
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
89 virtual void octave_vr_val (const octave_value& val) { }
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
90
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
91 virtual bool has_varargout (void) const { return false; }
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4645
diff changeset
92
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3325
diff changeset
93 std::string name (void) const { return my_name; }
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
94
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3325
diff changeset
95 std::string doc_string (void) const { return doc; }
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
96
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3258
diff changeset
97 virtual void unload (void) { }
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3258
diff changeset
98
2976
641689f67673 [project @ 1997-05-15 20:27:04 by jwe]
jwe
parents: 2974
diff changeset
99 virtual void accept (tree_walker&) { }
641689f67673 [project @ 1997-05-15 20:27:04 by jwe]
jwe
parents: 2974
diff changeset
100
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
101 protected:
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
102
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3325
diff changeset
103 octave_function (const std::string& nm, const std::string& ds)
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
104 : my_name (nm), doc (ds) { }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
105
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
106 // The name of this function.
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3325
diff changeset
107 std::string my_name;
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
108
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
109 // The help text for this function.
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3325
diff changeset
110 std::string doc;
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
111
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3258
diff changeset
112 private:
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3258
diff changeset
113
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4643
diff changeset
114 // No copying!
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4643
diff changeset
115
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4643
diff changeset
116 octave_function (const octave_function& f);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4643
diff changeset
117
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4643
diff changeset
118 octave_function& operator = (const octave_function& f);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4643
diff changeset
119
3219
30770ba4457a [project @ 1998-11-13 03:44:31 by jwe]
jwe
parents: 3166
diff changeset
120 DECLARE_OCTAVE_ALLOCATOR
2974
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
121 };
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
122
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
123 #endif
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
124
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
125 /*
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
126 ;; Local Variables: ***
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
127 ;; mode: C++ ***
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
128 ;; End: ***
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe]
jwe
parents:
diff changeset
129 */