Mercurial > octave
annotate libinterp/octave-value/ov-fcn.h @ 16627:de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
* ov-fcn.h (octave_function::maybe_relocate_end,
octave_function::has_subfunctions,
octave_function::stash_subfunction_names,
octave_function::subfunction_names): New virtual functions.
* ov-usr-fcn.h, ov-usr-fcn.cc (octave_user_function::end_location_line,
octave_user_function::end_location_column,
octave_user_function::subfcn_names): New member variables.
(octave_user_function::beginning_line,
octave_user_function::beginning_column,
octave_user_function::stash_fcn_end_location,
octave_user_function::ending_line,
octave_user_function::ending_column,
octave_user_function::has_subfunctions,
octave_user_function::subfunction_names,
octave_user_function::stash_subfunction_names,
octave_user_function::maybe_relocate_end_internal,
octave_user_function::maybe_relocate_end): New functions.
* oct-parse.in.yy (FCN): Declare as token with tok_val type.
(function_beg): Declare as tok_val type. Return FCN value.
(function): Move stash_comment here from function_beg. Pass line and
column info to parser.finish_function.
(octave_base_parser::subfunction_names): New data member.
(octave_base_parser::reset): Clear subfuntction_names.
(octave_base_parser::start_function): Call stash_fcn_end_location.
(octave_base_parser::frob_function): Don't call stash_fcn_location.
(octave_base_parser_::finish_function): Call stash_fcn_location.
Append name to subfunction_names.
Call maybe_relocate_end on constructed function.
(parse_fcn_file): Attach subfunction names to primary function.
* pt-stmt.h, pt-stmt.cc (tree_statement::set_location): New function.
* pt.h (tree::set_location): New function.
* pt-cmd.h, pt-cmd.cc (tree_no_op_command::tree_no_op_command): Use
EOF member variable to track auto-generated end statements that appear
at the end of file. Change all callers.
(tree_command::is_end_of_file): New function.
* pt-stmt.h, pt-stmt.cc (tree_statement::set_location,
tree_statement::is_end_of_file): New functions.
* base-list.h (octave_base_list::reverse_iterator,
octave_base_list::const_reverse_iterator): New typedefs.
(octave_base_list::rbegin, octave_base_list::rend): New functions.
* debug.h, debug.cc (bp_table::do_add_breakpoint):
Handle subfunctions.
(bp_table::do_remove_breakpoint_1): New function.
(bp_table::do_remove_breakpoint): Use it. Handle subfunctions.
(bp_table::do_remove_all_breakpoints_in_file_1): New function.
(bp_table::do_remove_all_breakpoints_in_file): Use it. Handle
subfunctions.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 07 May 2013 15:29:00 -0400 |
| parents | 2fc554ffbc28 |
| children | 856cb7cba231 d63878346099 |
| rev | line source |
|---|---|
| 2974 | 1 /* |
| 2 | |
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13241
diff
changeset
|
3 Copyright (C) 1996-2012 John W. Eaton |
| 2974 | 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. | |
| 2974 | 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/>. | |
| 2974 | 20 |
| 21 */ | |
| 22 | |
| 23 #if !defined (octave_function_h) | |
| 24 #define octave_function_h 1 | |
| 25 | |
| 26 #include <string> | |
| 27 | |
| 3258 | 28 #include "oct-time.h" |
| 3325 | 29 #include "str-vec.h" |
| 3258 | 30 |
| 2974 | 31 #include "oct-alloc.h" |
| 4748 | 32 #include "oct-obj.h" |
| 2974 | 33 #include "ov-base.h" |
| 34 #include "ov-typeinfo.h" | |
| 7336 | 35 #include "symtab.h" |
| 2974 | 36 |
| 2976 | 37 class tree_walker; |
| 38 | |
| 2974 | 39 // Functions. |
| 40 | |
| 41 class | |
| 6109 | 42 OCTINTERP_API |
| 2974 | 43 octave_function : public octave_base_value |
| 44 { | |
| 45 public: | |
| 46 | |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
47 octave_function (void) |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
48 : 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
|
49 xdispatch_class (), my_name (), my_dir_name (), doc () { } |
| 2974 | 50 |
| 51 ~octave_function (void) { } | |
| 52 | |
| 5759 | 53 octave_base_value *clone (void) const; |
| 54 octave_base_value *empty_clone (void) const; | |
| 2974 | 55 |
| 56 bool is_defined (void) const { return true; } | |
| 57 | |
| 58 bool is_function (void) const { return true; } | |
| 59 | |
| 3544 | 60 virtual bool is_system_fcn_file (void) const { return false; } |
| 2974 | 61 |
| 3523 | 62 virtual std::string fcn_file_name (void) const { return std::string (); } |
|
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
12783
diff
changeset
|
63 |
|
15005
74c7265c057a
fix failure with function handles caused by changeset ea6997657614
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
64 virtual std::string src_file_name (void) const { return std::string (); } |
|
74c7265c057a
fix failure with function handles caused by changeset ea6997657614
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
65 |
|
12783
ad9263d965dc
First experimental profiler implementation with flat profile.
Daniel Kraft <d@domob.eu>
parents:
11586
diff
changeset
|
66 // The name to show in the profiler (also used as map-key). |
|
ad9263d965dc
First experimental profiler implementation with flat profile.
Daniel Kraft <d@domob.eu>
parents:
11586
diff
changeset
|
67 virtual std::string profiler_name (void) const { return name (); } |
| 2974 | 68 |
| 6323 | 69 virtual std::string parent_fcn_name (void) const { return std::string (); } |
| 70 | |
|
7968
0d607e8dbbfa
eliminate curr_parent_function; fix subfunction lookup
John W. Eaton <jwe@octave.org>
parents:
7761
diff
changeset
|
71 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
|
72 |
| 3255 | 73 virtual void mark_fcn_file_up_to_date (const octave_time&) { } |
| 3166 | 74 |
| 7336 | 75 virtual symbol_table::scope_id scope (void) { return -1; } |
| 76 | |
| 3255 | 77 virtual octave_time time_parsed (void) const |
| 78 { return octave_time (static_cast<time_t> (0)); } | |
| 2974 | 79 |
| 3255 | 80 virtual octave_time time_checked (void) const |
| 81 { return octave_time (static_cast<time_t> (0)); } | |
| 3166 | 82 |
|
11461
2b8531a6a3c9
Change mentions of "nested function" to the less misleading "subfunction"
David Grundberg <individ@acc.umu.se>
parents:
11445
diff
changeset
|
83 virtual bool is_subfunction (void) const { return false; } |
| 4343 | 84 |
|
11220
883b9308353c
allow class function to be called from methods as well as constructors
John W. Eaton <jwe@octave.org>
parents:
10313
diff
changeset
|
85 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
|
86 { return false; } |
| 5744 | 87 |
|
11220
883b9308353c
allow class function to be called from methods as well as constructors
John W. Eaton <jwe@octave.org>
parents:
10313
diff
changeset
|
88 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
|
89 { return false; } |
| 7336 | 90 |
| 4748 | 91 virtual bool takes_varargs (void) const { return false; } |
| 92 | |
| 93 virtual bool takes_var_return (void) const { return false; } | |
| 94 | |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
95 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
|
96 |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
97 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
|
98 |
|
11445
40f311a69417
fix OO field access in subfunctions of private functions
John W. Eaton <jwe@octave.org>
parents:
11220
diff
changeset
|
99 virtual void |
|
40f311a69417
fix OO field access in subfunctions of private functions
John W. Eaton <jwe@octave.org>
parents:
11220
diff
changeset
|
100 mark_as_private_function (const std::string& cname = std::string ()) |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
101 { |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
102 private_function = true; |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
103 xdispatch_class = cname; |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
104 } |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
105 |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
106 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
|
107 |
|
13241
2a8dcb5b3a00
improve default indexing for objects
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
108 bool is_private_function_of_class (const std::string& nm) const |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
109 { 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
|
110 |
|
13241
2a8dcb5b3a00
improve default indexing for objects
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
111 virtual bool |
|
2a8dcb5b3a00
improve default indexing for objects
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
112 is_anonymous_function_of_class (const std::string& = std::string ()) const |
|
2a8dcb5b3a00
improve default indexing for objects
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
113 { return false; } |
|
2a8dcb5b3a00
improve default indexing for objects
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
114 |
| 7336 | 115 std::string dir_name (void) const { return my_dir_name; } |
| 116 | |
| 117 void stash_dir_name (const std::string& dir) { my_dir_name = dir; } | |
| 118 | |
|
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
119 void lock (void) |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
120 { |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
121 this->lock_subfunctions (); |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
122 locked = true; |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
123 } |
| 7336 | 124 |
|
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
125 void unlock (void) |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
126 { |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
127 this->unlock_subfunctions (); |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
128 locked = false; |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
129 } |
| 7336 | 130 |
|
7489
8e4592e49fa7
don't clear locked functions
John W. Eaton <jwe@octave.org>
parents:
7438
diff
changeset
|
131 bool islocked (void) const { return locked; } |
| 7336 | 132 |
|
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
133 virtual void lock_subfunctions (void) { } |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
134 |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
135 virtual void unlock_subfunctions (void) { } |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
136 |
|
16627
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
137 virtual void maybe_relocate_end (void) { } |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
138 |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
139 // Not valid until after the function is completley parsed. |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
140 virtual bool has_subfunctions (void) const { return false; } |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
141 |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
142 virtual void stash_subfunction_names (const std::list<std::string>&) { } |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
143 |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
144 virtual std::list<std::string> subfunction_names (void) const |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
145 { |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
146 return std::list<std::string> (); |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
147 } |
|
de91b1621260
adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
148 |
| 6323 | 149 void mark_relative (void) { relative = true; } |
| 150 | |
| 151 bool is_relative (void) const { return relative; } | |
| 152 | |
| 3523 | 153 std::string name (void) const { return my_name; } |
| 2974 | 154 |
| 5823 | 155 void document (const std::string& ds) { doc = ds; } |
| 156 | |
| 3523 | 157 std::string doc_string (void) const { return doc; } |
| 2974 | 158 |
| 3325 | 159 virtual void unload (void) { } |
| 160 | |
| 2976 | 161 virtual void accept (tree_walker&) { } |
| 162 | |
| 2974 | 163 protected: |
| 164 | |
| 5864 | 165 octave_function (const std::string& nm, |
| 10313 | 166 const std::string& ds = std::string ()) |
|
10101
b51848e95e4b
cleanups to avoid valgrind warnings
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
167 : relative (false), locked (false), private_function (false), |
|
b51848e95e4b
cleanups to avoid valgrind warnings
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
168 xdispatch_class (), my_name (nm), my_dir_name (), doc (ds) { } |
| 6323 | 169 |
| 170 // TRUE if this function was found from a relative path element. | |
| 171 bool relative; | |
| 2974 | 172 |
| 7336 | 173 // TRUE if this function is tagged so that it can't be cleared. |
| 174 bool locked; | |
| 175 | |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
176 // 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
|
177 bool private_function; |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
178 |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
179 // 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
|
180 // function inside a class directory, this is the name of the class |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
181 // to which the method belongs. |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
182 std::string xdispatch_class; |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
183 |
| 2974 | 184 // The name of this function. |
| 3523 | 185 std::string my_name; |
| 2974 | 186 |
| 7336 | 187 // The name of the directory in the path where we found this |
| 188 // function. May be relative. | |
| 189 std::string my_dir_name; | |
| 190 | |
| 2974 | 191 // The help text for this function. |
| 3523 | 192 std::string doc; |
| 2974 | 193 |
| 3325 | 194 private: |
| 195 | |
| 4645 | 196 // No copying! |
| 197 | |
| 198 octave_function (const octave_function& f); | |
| 199 | |
| 200 octave_function& operator = (const octave_function& f); | |
| 201 | |
| 3219 | 202 DECLARE_OCTAVE_ALLOCATOR |
| 2974 | 203 }; |
| 204 | |
| 205 #endif |