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