Mercurial > hg > octave-lyh
annotate src/ov-fcn.h @ 13141:e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
* bicg.m, gmres.m, pkg.m: Untabify and remove trailing whitespace.
* libcruft/Makefile.am, libcruft/blas-xtra/cdotc3.f,
libcruft/blas-xtra/cmatm3.f, libcruft/blas-xtra/ddot3.f,
libcruft/blas-xtra/dmatm3.f, libcruft/blas-xtra/sdot3.f,
libcruft/blas-xtra/smatm3.f, libcruft/blas-xtra/zdotc3.f,
libcruft/blas-xtra/zmatm3.f, libcruft/lapack-xtra/crsf2csf.f,
libcruft/lapack-xtra/zrsf2csf.f, liboctave/Array.cc,
liboctave/DASPK-opts.in, liboctave/DASRT-opts.in,
liboctave/DASSL-opts.in, liboctave/LSODE-opts.in,
liboctave/Makefile.a,mliboctave/Quad-opts.in,
liboctave/Sparse-perm-op-defs.h,
scripts/Makefile.a,mscripts/deprecated/glpkmex.m,
scripts/general/blkdiag.m, scripts/general/interp1.m,
scripts/general/profshow.m, scripts/general/quadl.m,
scripts/general/triplequad.m, scripts/help/__makeinfo__.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/linear-algebra/rank.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/private/__xzip__.m,
scripts/miscellaneous/tempdir.m, scripts/miscellaneous/unpack.m,
scripts/pkg/pkg.m, scripts/plot/allchild.m, scripts/plot/ancestor.m,
scripts/plot/cla.m, scripts/plot/clf.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gca.m, scripts/plot/gcf.m,
scripts/plot/hggroup.m, scripts/plot/isfigure.m,
scripts/plot/ishghandle.m, scripts/plot/legend.m,
scripts/plot/line.m, scripts/plot/loglog.m, scripts/plot/patch.m,
scripts/plot/print.m, scripts/plot/private/__quiver__.m,
scripts/plot/private/__scatter__.m, scripts/plot/rectangle.m,
scripts/plot/semilogx.m, scripts/plot/semilogy.m,
scripts/plot/surface.m, scripts/plot/text.m, scripts/plot/title.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/whitebg.m,
scripts/plot/xlabel.m, scripts/plot/xlim.m, scripts/plot/ylabel.m,
scripts/plot/ylim.m, scripts/plot/zlabel.m, scripts/plot/zlim.m,
scripts/polynomial/mkpp.m, scripts/polynomial/polygcd.m,
scripts/polynomial/ppint.m, scripts/polynomial/ppjumps.m,
scripts/polynomial/ppval.m, scripts/set/setxor.m,
scripts/sparse/bicgstab.m, scripts/sparse/cgs.m,
scripts/sparse/spconvert.m, scripts/specfun/nthroot.m,
scripts/strings/strmatch.m, scripts/strings/untabify.m,
scripts/testfun/demo.m, scripts/testfun/example.m,
src/DLD-FUNCTIONS/filter.cc, src/DLD-FUNCTIONS/mgorth.cc,
src/DLD-FUNCTIONS/quadcc.cc, src/DLD-FUNCTIONS/str2double.cc,
src/Makefile.a,msrc/gl-render.cc, src/gl2ps-renderer.cc,
src/graphics.cc, src/octave-config.cc.in, src/octave-config.in,
src/ov-class.h, src/ov-fcn.h, src/profiler.cc, src/profiler.h,
src/pt-binop.cc, src/pt-unop.cc, src/symtab.cc, src/txt-eng-ft.cc:
Remove trailing whitespace.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Thu, 15 Sep 2011 12:51:10 -0400 |
| parents | ad9263d965dc |
| children | 2a8dcb5b3a00 |
| rev | line source |
|---|---|
| 2974 | 1 /* |
| 2 | |
| 11523 | 3 Copyright (C) 1996-2011 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 |
|
12783
ad9263d965dc
First experimental profiler implementation with flat profile.
Daniel Kraft <d@domob.eu>
parents:
11586
diff
changeset
|
64 // 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
|
65 virtual std::string profiler_name (void) const { return name (); } |
| 2974 | 66 |
| 6323 | 67 virtual std::string parent_fcn_name (void) const { return std::string (); } |
| 68 | |
|
7968
0d607e8dbbfa
eliminate curr_parent_function; fix subfunction lookup
John W. Eaton <jwe@octave.org>
parents:
7761
diff
changeset
|
69 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
|
70 |
| 3255 | 71 virtual void mark_fcn_file_up_to_date (const octave_time&) { } |
| 3166 | 72 |
| 7336 | 73 virtual symbol_table::scope_id scope (void) { return -1; } |
| 74 | |
| 3255 | 75 virtual octave_time time_parsed (void) const |
| 76 { return octave_time (static_cast<time_t> (0)); } | |
| 2974 | 77 |
| 3255 | 78 virtual octave_time time_checked (void) const |
| 79 { return octave_time (static_cast<time_t> (0)); } | |
| 3166 | 80 |
|
11461
2b8531a6a3c9
Change mentions of "nested function" to the less misleading "subfunction"
David Grundberg <individ@acc.umu.se>
parents:
11445
diff
changeset
|
81 virtual bool is_subfunction (void) const { return false; } |
| 4343 | 82 |
|
11220
883b9308353c
allow class function to be called from methods as well as constructors
John W. Eaton <jwe@octave.org>
parents:
10313
diff
changeset
|
83 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
|
84 { return false; } |
| 5744 | 85 |
|
11220
883b9308353c
allow class function to be called from methods as well as constructors
John W. Eaton <jwe@octave.org>
parents:
10313
diff
changeset
|
86 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
|
87 { return false; } |
| 7336 | 88 |
| 4748 | 89 virtual bool takes_varargs (void) const { return false; } |
| 90 | |
| 91 virtual bool takes_var_return (void) const { return false; } | |
| 92 | |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
93 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
|
94 |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
95 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
|
96 |
|
11445
40f311a69417
fix OO field access in subfunctions of private functions
John W. Eaton <jwe@octave.org>
parents:
11220
diff
changeset
|
97 virtual void |
|
40f311a69417
fix OO field access in subfunctions of private functions
John W. Eaton <jwe@octave.org>
parents:
11220
diff
changeset
|
98 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
|
99 { |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
100 private_function = true; |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
101 xdispatch_class = cname; |
|
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 |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
104 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
|
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_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
|
107 { 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
|
108 |
| 7336 | 109 std::string dir_name (void) const { return my_dir_name; } |
| 110 | |
| 111 void stash_dir_name (const std::string& dir) { my_dir_name = dir; } | |
| 112 | |
|
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
113 void lock (void) |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
114 { |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
115 this->lock_subfunctions (); |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
116 locked = true; |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
117 } |
| 7336 | 118 |
|
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
119 void unlock (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->unlock_subfunctions (); |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
122 locked = false; |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
123 } |
| 7336 | 124 |
|
7489
8e4592e49fa7
don't clear locked functions
John W. Eaton <jwe@octave.org>
parents:
7438
diff
changeset
|
125 bool islocked (void) const { return locked; } |
| 7336 | 126 |
|
7761
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
127 virtual void lock_subfunctions (void) { } |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
128 |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
129 virtual void unlock_subfunctions (void) { } |
|
5adeea5de26c
symbol table reporting functions
John W. Eaton <jwe@octave.org>
parents:
7489
diff
changeset
|
130 |
| 6323 | 131 void mark_relative (void) { relative = true; } |
| 132 | |
| 133 bool is_relative (void) const { return relative; } | |
| 134 | |
| 3523 | 135 std::string name (void) const { return my_name; } |
| 2974 | 136 |
| 5823 | 137 void document (const std::string& ds) { doc = ds; } |
| 138 | |
| 3523 | 139 std::string doc_string (void) const { return doc; } |
| 2974 | 140 |
| 3325 | 141 virtual void unload (void) { } |
| 142 | |
| 2976 | 143 virtual void accept (tree_walker&) { } |
| 144 | |
| 2974 | 145 protected: |
| 146 | |
| 5864 | 147 octave_function (const std::string& nm, |
| 10313 | 148 const std::string& ds = std::string ()) |
|
10101
b51848e95e4b
cleanups to avoid valgrind warnings
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
149 : relative (false), locked (false), private_function (false), |
|
b51848e95e4b
cleanups to avoid valgrind warnings
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
150 xdispatch_class (), my_name (nm), my_dir_name (), doc (ds) { } |
| 6323 | 151 |
| 152 // TRUE if this function was found from a relative path element. | |
| 153 bool relative; | |
| 2974 | 154 |
| 7336 | 155 // TRUE if this function is tagged so that it can't be cleared. |
| 156 bool locked; | |
| 157 | |
|
8785
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
158 // 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
|
159 bool private_function; |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
160 |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
161 // 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
|
162 // 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
|
163 // 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
|
164 std::string xdispatch_class; |
|
70f5a0375afd
oct-map.h: fix think-o in previous change
John W. Eaton <jwe@octave.org>
parents:
7968
diff
changeset
|
165 |
| 2974 | 166 // The name of this function. |
| 3523 | 167 std::string my_name; |
| 2974 | 168 |
| 7336 | 169 // The name of the directory in the path where we found this |
| 170 // function. May be relative. | |
| 171 std::string my_dir_name; | |
| 172 | |
| 2974 | 173 // The help text for this function. |
| 3523 | 174 std::string doc; |
| 2974 | 175 |
| 3325 | 176 private: |
| 177 | |
| 4645 | 178 // No copying! |
| 179 | |
| 180 octave_function (const octave_function& f); | |
| 181 | |
| 182 octave_function& operator = (const octave_function& f); | |
| 183 | |
| 3219 | 184 DECLARE_OCTAVE_ALLOCATOR |
| 2974 | 185 }; |
| 186 | |
| 187 #endif |