Mercurial > octave
annotate src/ov-fcn.h @ 11220:883b9308353c
allow class function to be called from methods as well as constructors
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 10 Nov 2010 00:54:34 -0500 |
parents | f3b65e1ae355 |
children | 40f311a69417 |
rev | line source |
---|---|
2974 | 1 /* |
2 | |
7017 | 3 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2002, 2003, 2004, 2005, |
8920 | 4 2006, 2007, 2008, 2009 John W. Eaton |
2974 | 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. | |
2974 | 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/>. | |
2974 | 21 |
22 */ | |
23 | |
24 #if !defined (octave_function_h) | |
25 #define octave_function_h 1 | |
26 | |
27 #include <string> | |
28 | |
3258 | 29 #include "oct-time.h" |
3325 | 30 #include "str-vec.h" |
3258 | 31 |
2974 | 32 #include "oct-alloc.h" |
4748 | 33 #include "oct-obj.h" |
2974 | 34 #include "ov-base.h" |
35 #include "ov-typeinfo.h" | |
7336 | 36 #include "symtab.h" |
2974 | 37 |
2976 | 38 class tree_walker; |
39 | |
2974 | 40 // Functions. |
41 | |
42 class | |
6109 | 43 OCTINTERP_API |
2974 | 44 octave_function : public octave_base_value |
45 { | |
46 public: | |
47 | |
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
48 octave_function (void) |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
49 : relative (false), locked (false), private_function (false), |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
50 xdispatch_class (), my_name (), my_dir_name (), doc () { } |
2974 | 51 |
52 ~octave_function (void) { } | |
53 | |
5759 | 54 octave_base_value *clone (void) const; |
55 octave_base_value *empty_clone (void) const; | |
2974 | 56 |
57 bool is_defined (void) const { return true; } | |
58 | |
59 bool is_function (void) const { return true; } | |
60 | |
3544 | 61 virtual bool is_system_fcn_file (void) const { return false; } |
2974 | 62 |
3523 | 63 virtual std::string fcn_file_name (void) const { return std::string (); } |
2974 | 64 |
6323 | 65 virtual std::string parent_fcn_name (void) const { return std::string (); } |
66 | |
7968
0d607e8dbbfa
eliminate curr_parent_function; fix subfunction lookup
John W. Eaton <jwe@octave.org>
parents:
7761
diff
changeset
|
67 virtual symbol_table::scope_id parent_fcn_scope (void) const { return -1; } |
0d607e8dbbfa
eliminate curr_parent_function; fix subfunction lookup
John W. Eaton <jwe@octave.org>
parents:
7761
diff
changeset
|
68 |
3255 | 69 virtual void mark_fcn_file_up_to_date (const octave_time&) { } |
3166 | 70 |
7336 | 71 virtual symbol_table::scope_id scope (void) { return -1; } |
72 | |
3255 | 73 virtual octave_time time_parsed (void) const |
74 { return octave_time (static_cast<time_t> (0)); } | |
2974 | 75 |
3255 | 76 virtual octave_time time_checked (void) const |
77 { return octave_time (static_cast<time_t> (0)); } | |
3166 | 78 |
4343 | 79 virtual bool is_nested_function (void) const { return false; } |
80 | |
11220
883b9308353c
allow class function to be called from methods as well as constructors
John W. Eaton <jwe@octave.org>
parents:
10313
diff
changeset
|
81 virtual bool is_class_constructor (const std::string& = std::string ()) const |
883b9308353c
allow class function to be called from methods as well as constructors
John W. Eaton <jwe@octave.org>
parents:
10313
diff
changeset
|
82 { return false; } |
5744 | 83 |
11220
883b9308353c
allow class function to be called from methods as well as constructors
John W. Eaton <jwe@octave.org>
parents:
10313
diff
changeset
|
84 virtual bool is_class_method (const std::string& = std::string ()) const |
883b9308353c
allow class function to be called from methods as well as constructors
John W. Eaton <jwe@octave.org>
parents:
10313
diff
changeset
|
85 { return false; } |
7336 | 86 |
4748 | 87 virtual bool takes_varargs (void) const { return false; } |
88 | |
89 virtual bool takes_var_return (void) const { return false; } | |
90 | |
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
91 void stash_dispatch_class (const std::string& nm) { xdispatch_class = nm; } |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
92 |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
93 std::string dispatch_class (void) const { return xdispatch_class; } |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
94 |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
95 void mark_as_private_function (const std::string& cname = std::string ()) |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
96 { |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
97 private_function = true; |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
98 xdispatch_class = cname; |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
99 } |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
100 |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
101 bool is_private_function (void) const { return private_function; } |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
102 |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
103 bool is_private_function_of_class (const std::string& nm) |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
104 { return private_function && xdispatch_class == nm; } |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
105 |
7336 | 106 std::string dir_name (void) const { return my_dir_name; } |
107 | |
108 void stash_dir_name (const std::string& dir) { my_dir_name = dir; } | |
109 | |
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
110 void lock (void) |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
111 { |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
112 this->lock_subfunctions (); |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
113 locked = true; |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
114 } |
7336 | 115 |
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
116 void unlock (void) |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
117 { |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
118 this->unlock_subfunctions (); |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
119 locked = false; |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
120 } |
7336 | 121 |
7489
8e4592e49fa7
don't clear locked functions
John W. Eaton <jwe@octave.org>
parents:
7438
diff
changeset
|
122 bool islocked (void) const { return locked; } |
7336 | 123 |
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
124 virtual void lock_subfunctions (void) { } |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
125 |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
126 virtual void unlock_subfunctions (void) { } |
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
127 |
6323 | 128 void mark_relative (void) { relative = true; } |
129 | |
130 bool is_relative (void) const { return relative; } | |
131 | |
3523 | 132 std::string name (void) const { return my_name; } |
2974 | 133 |
5823 | 134 void document (const std::string& ds) { doc = ds; } |
135 | |
3523 | 136 std::string doc_string (void) const { return doc; } |
2974 | 137 |
3325 | 138 virtual void unload (void) { } |
139 | |
2976 | 140 virtual void accept (tree_walker&) { } |
141 | |
2974 | 142 protected: |
143 | |
5864 | 144 octave_function (const std::string& nm, |
10313 | 145 const std::string& ds = std::string ()) |
10101
b51848e95e4b
cleanups to avoid valgrind warnings
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
146 : relative (false), locked (false), private_function (false), |
b51848e95e4b
cleanups to avoid valgrind warnings
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
147 xdispatch_class (), my_name (nm), my_dir_name (), doc (ds) { } |
6323 | 148 |
149 // TRUE if this function was found from a relative path element. | |
150 bool relative; | |
2974 | 151 |
7336 | 152 // TRUE if this function is tagged so that it can't be cleared. |
153 bool locked; | |
154 | |
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
155 // TRUE means this is a private function. |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
156 bool private_function; |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
157 |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
158 // If this object is a class method or constructor, or a private |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
159 // function inside a class directory, this is the name of the class |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
160 // to which the method belongs. |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
161 std::string xdispatch_class; |
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
162 |
2974 | 163 // The name of this function. |
3523 | 164 std::string my_name; |
2974 | 165 |
7336 | 166 // The name of the directory in the path where we found this |
167 // function. May be relative. | |
168 std::string my_dir_name; | |
169 | |
2974 | 170 // The help text for this function. |
3523 | 171 std::string doc; |
2974 | 172 |
3325 | 173 private: |
174 | |
4645 | 175 // No copying! |
176 | |
177 octave_function (const octave_function& f); | |
178 | |
179 octave_function& operator = (const octave_function& f); | |
180 | |
3219 | 181 DECLARE_OCTAVE_ALLOCATOR |
2974 | 182 }; |
183 | |
184 #endif |