Mercurial > octave
annotate libinterp/corefcn/defun-int.h @ 21751:b571fc85953f
maint: Use two spaces after period to indicate sentence break.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 19 May 2016 18:48:52 -0700 |
parents | 6720e5a220ba |
children | 112b20240c87 |
rev | line source |
---|---|
525 | 1 /* |
2 | |
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19593
diff
changeset
|
3 Copyright (C) 1994-2015 John W. Eaton |
525 | 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. | |
525 | 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/>. | |
525 | 20 |
21 */ | |
22 | |
20791
f7084eae3318
maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents:
20545
diff
changeset
|
23 #if ! defined (octave_defun_int_h) |
525 | 24 #define octave_defun_int_h 1 |
25 | |
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20945
diff
changeset
|
26 #include "octave-config.h" |
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20945
diff
changeset
|
27 |
2968 | 28 #include <string> |
29 | |
3145 | 30 #include "ov-builtin.h" |
3325 | 31 #include "ov-dld-fcn.h" |
3145 | 32 #include "symtab.h" |
3015 | 33 #include "version.h" |
34 | |
2968 | 35 class octave_value; |
36 | |
6109 | 37 extern OCTINTERP_API void print_usage (void); |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
7996
diff
changeset
|
38 extern OCTINTERP_API void print_usage (const std::string&); |
3014 | 39 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
40 extern OCTINTERP_API void check_version (const std::string& version, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
41 const std::string& fcn); |
3015 | 42 |
6109 | 43 extern OCTINTERP_API void |
3523 | 44 install_builtin_function (octave_builtin::fcn f, const std::string& name, |
15004
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
45 const std::string& file, const std::string& doc, |
10313 | 46 bool can_hide_function = true); |
2968 | 47 |
6109 | 48 extern OCTINTERP_API void |
3523 | 49 install_dld_function (octave_dld_function::fcn f, const std::string& name, |
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
50 const octave::dynamic_library& shl, const std::string& doc, |
10313 | 51 bool relative = false); |
703 | 52 |
6109 | 53 extern OCTINTERP_API void |
5864 | 54 install_mex_function (void *fptr, bool fmex, const std::string& name, |
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
55 const octave::dynamic_library& shl, bool relative = false); |
5864 | 56 |
6109 | 57 extern OCTINTERP_API void |
3523 | 58 alias_builtin (const std::string& alias, const std::string& name); |
703 | 59 |
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
60 // Gets the shlib of the currently executing DLD function, if any. |
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
61 extern OCTINTERP_API octave::dynamic_library |
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
62 get_current_shlib (void); |
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
63 |
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
64 // This is a convenience class that calls the above function automatically at |
21751
b571fc85953f
maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents:
21750
diff
changeset
|
65 // construction time. When deriving new classes, you can either use it as a |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
66 // field or as a parent (with multiple inheritance). |
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
67 |
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
68 class octave_auto_shlib : public octave::dynamic_library |
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
69 { |
10641
ed6969880316
preliminary onCleanup support
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
70 public: |
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
71 octave_auto_shlib (void) |
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
72 : octave::dynamic_library (get_current_shlib ()) { } |
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
73 octave_auto_shlib (const octave::dynamic_library& shl) |
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
74 : octave::dynamic_library (shl) { } |
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
75 }; |
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
76 |
10887
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
77 extern OCTINTERP_API bool |
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
78 defun_isargout (int, int); |
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
79 |
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
80 extern OCTINTERP_API void |
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
81 defun_isargout (int, int, bool *); |
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
82 |
3743 | 83 #define DECLARE_FUNX(name, args_name, nargout_name) \ |
15421
cd6ce11b9c57
backout changeset 2e5ba861898f
John W. Eaton <jwe@octave.org>
parents:
15398
diff
changeset
|
84 OCTAVE_EXPORT octave_value_list \ |
cd6ce11b9c57
backout changeset 2e5ba861898f
John W. Eaton <jwe@octave.org>
parents:
15398
diff
changeset
|
85 name (const octave_value_list& args_name, int nargout_name) |
3743 | 86 |
87 #define DECLARE_FUN(name, args_name, nargout_name) \ | |
88 DECLARE_FUNX (F ## name, args_name, nargout_name) | |
2968 | 89 |
3325 | 90 // Define the code that will be used to insert the new function into |
91 // the symbol table. We look for this name instead of the actual | |
3523 | 92 // function so that we can easily install the doc std::string too. |
3325 | 93 |
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
94 typedef bool (*octave_dld_fcn_installer) (const octave::dynamic_library&, bool relative); |
3325 | 95 |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17787
diff
changeset
|
96 typedef octave_function * |
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
97 (*octave_dld_fcn_getter) (const octave::dynamic_library&, bool relative); |
7336 | 98 |
3325 | 99 #define DEFINE_FUN_INSTALLER_FUN(name, doc) \ |
7996
6a7db240b3a3
configure.in: eliminate CXX_ABI and OCTAVE_CXX_PREPEND_UNDERSCORE
John W. Eaton <jwe@octave.org>
parents:
7503
diff
changeset
|
100 DEFINE_FUNX_INSTALLER_FUN(#name, F ## name, G ## name, doc) |
5796 | 101 |
7996
6a7db240b3a3
configure.in: eliminate CXX_ABI and OCTAVE_CXX_PREPEND_UNDERSCORE
John W. Eaton <jwe@octave.org>
parents:
7503
diff
changeset
|
102 #define DEFINE_FUNX_INSTALLER_FUN(name, fname, gname, doc) \ |
7336 | 103 extern "C" \ |
104 OCTAVE_EXPORT \ | |
105 octave_function * \ | |
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
106 gname (const octave::dynamic_library& shl, bool relative) \ |
7336 | 107 { \ |
108 check_version (OCTAVE_API_VERSION, name); \ | |
109 \ | |
20545
c547458dc10e
eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
110 octave_dld_function *fcn = octave_dld_function::create (fname, shl, name, doc); \ |
7336 | 111 \ |
20545
c547458dc10e
eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
112 if (relative) \ |
c547458dc10e
eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
113 fcn->mark_relative (); \ |
7336 | 114 \ |
20545
c547458dc10e
eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
115 return fcn; \ |
3325 | 116 } |
117 | |
3295 | 118 // MAKE_BUILTINS is defined to extract function names and related |
119 // information and create the *.df files that are eventually used to | |
120 // create the builtins.cc file. | |
121 | |
122 #if defined (MAKE_BUILTINS) | |
123 | |
124 // Generate code to install name in the symbol table. The script | |
125 // mkdefs will create a .def file for every .cc file that uses DEFUN, | |
4208 | 126 // or DEFCMD. |
3295 | 127 |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
128 #define DEFUN_INTERNAL(name, args_name, nargout_name, doc) \ |
3295 | 129 BEGIN_INSTALL_BUILTIN \ |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
130 XDEFUN_INTERNAL (name, args_name, nargout_name, doc) \ |
3295 | 131 END_INSTALL_BUILTIN |
132 | |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
133 #define DEFCONSTFUN_INTERNAL(name, args_name, nargout_name, doc) \ |
4234 | 134 BEGIN_INSTALL_BUILTIN \ |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
135 XDEFCONSTFUN_INTERNAL (name, args_name, nargout_name, doc) \ |
4234 | 136 END_INSTALL_BUILTIN |
137 | |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
138 #define DEFUNX_INTERNAL(name, fname, args_name, nargout_name, doc) \ |
3743 | 139 BEGIN_INSTALL_BUILTIN \ |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
140 XDEFUNX_INTERNAL (name, fname, args_name, nargout_name, doc) \ |
3743 | 141 END_INSTALL_BUILTIN |
142 | |
3364 | 143 // Generate code to install name in the symbol table. The script |
144 // mkdefs will create a .def file for every .cc file that uses | |
145 // DEFUN_DLD. | |
146 | |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
147 #define DEFUN_DLD_INTERNAL(name, args_name, nargout_name, doc) \ |
3364 | 148 BEGIN_INSTALL_BUILTIN \ |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
149 XDEFUN_DLD_INTERNAL (name, args_name, nargout_name, doc) \ |
3364 | 150 END_INSTALL_BUILTIN |
151 | |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
152 #define DEFUNX_DLD_INTERNAL(name, fname, args_name, nargout_name, doc) \ |
5796 | 153 BEGIN_INSTALL_BUILTIN \ |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
154 XDEFUNX_DLD_INTERNAL (name, fname, args_name, nargout_name, doc) \ |
5796 | 155 END_INSTALL_BUILTIN |
156 | |
3295 | 157 // Generate code for making another name for an existing function. |
158 | |
159 #define DEFALIAS_INTERNAL(alias, name) \ | |
160 BEGIN_INSTALL_BUILTIN \ | |
161 XDEFALIAS_INTERNAL(alias, name) \ | |
162 END_INSTALL_BUILTIN | |
163 | |
20945
9d9270e2f98f
eliminate comments after preprocessor conditionals
John W. Eaton <jwe@octave.org>
parents:
20791
diff
changeset
|
164 #else |
3295 | 165 |
166 // Generate the first line of the function definition. This ensures | |
167 // that the internal functions all have the same signature. | |
168 | |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
169 #define DEFUN_INTERNAL(name, args_name, nargout_name, doc) \ |
3295 | 170 DECLARE_FUN (name, args_name, nargout_name) |
171 | |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
172 #define DEFCONSTFUN_INTERNAL(name, args_name, nargout_name, doc) \ |
4234 | 173 DECLARE_FUN (name, args_name, nargout_name) |
174 | |
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8575
diff
changeset
|
175 #define DEFUNX_INTERNAL(name, fname, args_name, nargout_name, doc) \ |
3743 | 176 DECLARE_FUNX (fname, args_name, nargout_name) |
177 | |
3295 | 178 // No definition is required for an alias. |
179 | |
4699 | 180 #define DEFALIAS_INTERNAL(alias, name) |
3295 | 181 |
20945
9d9270e2f98f
eliminate comments after preprocessor conditionals
John W. Eaton <jwe@octave.org>
parents:
20791
diff
changeset
|
182 #endif |
3295 | 183 |
525 | 184 #endif |