Mercurial > octave-nkf
annotate src/ov-fcn.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 | 5adeea5de26c |
| children | 0d607e8dbbfa |
| rev | line source |
|---|---|
| 2974 | 1 /* |
| 2 | |
| 7017 | 3 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2002, 2003, 2004, 2005, |
| 4 2006, 2007 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 | |
| 4645 | 48 octave_function (void) { } |
| 2974 | 49 |
| 50 ~octave_function (void) { } | |
| 51 | |
| 5759 | 52 octave_base_value *clone (void) const; |
| 53 octave_base_value *empty_clone (void) const; | |
| 2974 | 54 |
| 55 bool is_defined (void) const { return true; } | |
| 56 | |
| 57 bool is_function (void) const { return true; } | |
| 58 | |
| 3544 | 59 virtual bool is_system_fcn_file (void) const { return false; } |
| 2974 | 60 |
| 3523 | 61 virtual std::string fcn_file_name (void) const { return std::string (); } |
| 2974 | 62 |
| 6323 | 63 virtual std::string parent_fcn_name (void) const { return std::string (); } |
| 64 | |
| 3255 | 65 virtual void mark_fcn_file_up_to_date (const octave_time&) { } |
| 3166 | 66 |
| 7336 | 67 virtual symbol_table::scope_id scope (void) { return -1; } |
| 68 | |
| 3255 | 69 virtual octave_time time_parsed (void) const |
| 70 { return octave_time (static_cast<time_t> (0)); } | |
| 2974 | 71 |
| 3255 | 72 virtual octave_time time_checked (void) const |
| 73 { return octave_time (static_cast<time_t> (0)); } | |
| 3166 | 74 |
| 4343 | 75 virtual bool is_nested_function (void) const { return false; } |
| 76 | |
| 7336 | 77 virtual bool is_class_constructor (void) const { return false; } |
| 5744 | 78 |
| 7336 | 79 virtual bool is_class_method (void) const { return false; } |
| 80 | |
| 81 virtual std::string dispatch_class (void) const { return std::string (); } | |
| 4748 | 82 |
| 83 virtual bool takes_varargs (void) const { return false; } | |
| 84 | |
| 85 virtual bool takes_var_return (void) const { return false; } | |
| 86 | |
| 7336 | 87 std::string dir_name (void) const { return my_dir_name; } |
| 88 | |
| 89 void stash_dir_name (const std::string& dir) { my_dir_name = dir; } | |
| 90 | |
|
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
91 void lock (void) |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
92 { |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
93 this->lock_subfunctions (); |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
94 locked = true; |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
95 } |
| 7336 | 96 |
|
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
97 void unlock (void) |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
98 { |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
99 this->unlock_subfunctions (); |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
100 locked = false; |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
101 } |
| 7336 | 102 |
|
7489
8e4592e49fa7
don't clear locked functions
John W. Eaton <jwe@octave.org>
parents:
7438
diff
changeset
|
103 bool islocked (void) const { return locked; } |
| 7336 | 104 |
|
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
105 virtual void lock_subfunctions (void) { } |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
106 |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
107 virtual void unlock_subfunctions (void) { } |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
108 |
| 6323 | 109 void mark_relative (void) { relative = true; } |
| 110 | |
| 111 bool is_relative (void) const { return relative; } | |
| 112 | |
| 3523 | 113 std::string name (void) const { return my_name; } |
| 2974 | 114 |
| 5823 | 115 void document (const std::string& ds) { doc = ds; } |
| 116 | |
| 3523 | 117 std::string doc_string (void) const { return doc; } |
| 2974 | 118 |
| 3325 | 119 virtual void unload (void) { } |
| 120 | |
| 2976 | 121 virtual void accept (tree_walker&) { } |
| 122 | |
| 2974 | 123 protected: |
| 124 | |
| 5864 | 125 octave_function (const std::string& nm, |
| 126 const std::string& ds = std::string ()) | |
| 6323 | 127 : relative (false), my_name (nm), doc (ds) { } |
| 128 | |
| 129 // TRUE if this function was found from a relative path element. | |
| 130 bool relative; | |
| 2974 | 131 |
| 7336 | 132 // TRUE if this function is tagged so that it can't be cleared. |
| 133 bool locked; | |
| 134 | |
| 2974 | 135 // The name of this function. |
| 3523 | 136 std::string my_name; |
| 2974 | 137 |
| 7336 | 138 // The name of the directory in the path where we found this |
| 139 // function. May be relative. | |
| 140 std::string my_dir_name; | |
| 141 | |
| 2974 | 142 // The help text for this function. |
| 3523 | 143 std::string doc; |
| 2974 | 144 |
| 3325 | 145 private: |
| 146 | |
| 4645 | 147 // No copying! |
| 148 | |
| 149 octave_function (const octave_function& f); | |
| 150 | |
| 151 octave_function& operator = (const octave_function& f); | |
| 152 | |
| 3219 | 153 DECLARE_OCTAVE_ALLOCATOR |
| 2974 | 154 }; |
| 155 | |
| 156 #endif | |
| 157 | |
| 158 /* | |
| 6705 | 159 ;;; Local Variables: *** |
| 160 ;;; mode: C++ *** | |
| 161 ;;; End: *** | |
| 2974 | 162 */ |