Mercurial > octave
annotate libinterp/corefcn/defun-int.h @ 29358:0a5b15007766 stable
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2021.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 10 Feb 2021 09:52:15 -0500 |
parents | bd51beb6205e |
children | 64e3ef97384e |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 //////////////////////////////////////////////////////////////////////// |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 // |
29358
0a5b15007766
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
3 // Copyright (C) 1994-2021 The Octave Project Developers |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
4 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 // See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 // distribution or <https://octave.org/copyright/>. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
7 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
8 // This file is part of Octave. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
9 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
10 // Octave is free software: you can redistribute it and/or modify it |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
11 // under the terms of the GNU General Public License as published by |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
12 // the Free Software Foundation, either version 3 of the License, or |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
13 // (at your option) any later version. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
14 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
15 // Octave is distributed in the hope that it will be useful, but |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
16 // WITHOUT ANY WARRANTY; without even the implied warranty of |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
18 // GNU General Public License for more details. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
19 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
20 // You should have received a copy of the GNU General Public License |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
21 // along with Octave; see the file COPYING. If not, see |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
22 // <https://www.gnu.org/licenses/>. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 //////////////////////////////////////////////////////////////////////// |
525 | 25 |
20791
f7084eae3318
maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents:
20545
diff
changeset
|
26 #if ! defined (octave_defun_int_h) |
525 | 27 #define octave_defun_int_h 1 |
28 | |
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20945
diff
changeset
|
29 #include "octave-config.h" |
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20945
diff
changeset
|
30 |
2968 | 31 #include <string> |
32 | |
3145 | 33 #include "ov-builtin.h" |
3325 | 34 #include "ov-dld-fcn.h" |
3015 | 35 #include "version.h" |
36 | |
23518 | 37 namespace octave |
38 { | |
39 class interpreter; | |
40 } | |
41 | |
2968 | 42 class octave_value; |
43 | |
6109 | 44 extern OCTINTERP_API void print_usage (void); |
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
7996
diff
changeset
|
45 extern OCTINTERP_API void print_usage (const std::string&); |
3014 | 46 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
47 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
|
48 const std::string& fcn); |
3015 | 49 |
6109 | 50 extern OCTINTERP_API void |
3523 | 51 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
|
52 const octave::dynamic_library& shl, const std::string& doc, |
10313 | 53 bool relative = false); |
703 | 54 |
6109 | 55 extern OCTINTERP_API void |
23518 | 56 install_dld_function (octave_dld_function::meth m, const std::string& name, |
57 const octave::dynamic_library& shl, const std::string& doc, | |
58 bool relative = false); | |
59 | |
60 extern OCTINTERP_API void | |
5864 | 61 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
|
62 const octave::dynamic_library& shl, bool relative = false); |
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
63 // 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
|
64 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
|
65 get_current_shlib (void); |
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
66 |
23056
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
67 namespace octave |
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
68 { |
23056
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
69 // FIXME: this class doesn't seem to be used in Octave. Is it |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
70 // really needed? |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
71 |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
72 // This is a convenience class that calls the above function automatically at |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
73 // construction time. When deriving new classes, you can either use it as a |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
74 // field or as a parent (with multiple inheritance). |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
75 |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
76 class auto_shlib : public dynamic_library |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
77 { |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
78 public: |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
79 |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
80 auto_shlib (void) : dynamic_library (get_current_shlib ()) { } |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
81 |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
82 auto_shlib (const dynamic_library& shl) : dynamic_library (shl) { } |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
83 }; |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
84 } |
422757f6ddbc
* defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib.
John W. Eaton <jwe@octave.org>
parents:
22893
diff
changeset
|
85 |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
86 #define FORWARD_DECLARE_FUNX(name) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
87 extern OCTAVE_EXPORT octave_value_list \ |
22004
78000c426b73
don't provide default parameter values in forward decls for DEFUNs
John W. Eaton <jwe@octave.org>
parents:
21966
diff
changeset
|
88 name (const octave_value_list&, int) |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
89 |
23518 | 90 #define FORWARD_DECLARE_METHODX(name) \ |
91 extern OCTAVE_EXPORT octave_value_list \ | |
92 name (octave::interpreter&, const octave_value_list&, int) | |
93 | |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
94 #define FORWARD_DECLARE_FUN(name) \ |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
95 FORWARD_DECLARE_FUNX (F ## name) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
96 |
23518 | 97 #define FORWARD_DECLARE_METHOD(name) \ |
98 FORWARD_DECLARE_METHODX (F ## name) | |
99 | |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
100 #define DECLARE_FUNX(name, args_name, nargout_name) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
101 OCTAVE_EXPORT octave_value_list \ |
15421
cd6ce11b9c57
backout changeset 2e5ba861898f
John W. Eaton <jwe@octave.org>
parents:
15398
diff
changeset
|
102 name (const octave_value_list& args_name, int nargout_name) |
3743 | 103 |
23518 | 104 #define DECLARE_METHODX(name, interp_name, args_name, nargout_name) \ |
105 OCTAVE_EXPORT octave_value_list \ | |
106 name (octave::interpreter& interp_name, \ | |
107 const octave_value_list& args_name, int nargout_name) | |
108 | |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
109 #define DECLARE_FUN(name, args_name, nargout_name) \ |
3743 | 110 DECLARE_FUNX (F ## name, args_name, nargout_name) |
2968 | 111 |
23518 | 112 #define DECLARE_METHOD(name, interp_name, args_name, nargout_name) \ |
113 DECLARE_METHODX (F ## name, interp_name, args_name, nargout_name) | |
114 | |
23452
0af6dbede266
also use DEFUN macros for local function declarations
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
115 #define DECLARE_STATIC_FUNX(name, args_name, nargout_name) \ |
0af6dbede266
also use DEFUN macros for local function declarations
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
116 static octave_value_list \ |
0af6dbede266
also use DEFUN macros for local function declarations
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
117 name (const octave_value_list& args_name, int nargout_name) |
0af6dbede266
also use DEFUN macros for local function declarations
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
118 |
23518 | 119 #define DECLARE_STATIC_METHODX(name, interp_name, args_name, nargout_name) \ |
120 static octave_value_list \ | |
121 name (octave::interpreter& interp_name, \ | |
122 const octave_value_list& args_name, int nargout_name) | |
123 | |
23452
0af6dbede266
also use DEFUN macros for local function declarations
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
124 #define DECLARE_STATIC_FUN(name, args_name, nargout_name) \ |
23518 | 125 DECLARE_STATIC_FUNX (F ## name, args_name, nargout_name) |
126 | |
127 #define DECLARE_STATIC_METHOD(name, interp_name, args_name, nargout_name) \ | |
128 DECLARE_STATIC_METHODX (F ## name, interp_name, args_name, nargout_name) | |
23452
0af6dbede266
also use DEFUN macros for local function declarations
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
129 |
3325 | 130 // Define the code that will be used to insert the new function into |
131 // the symbol table. We look for this name instead of the actual | |
3523 | 132 // function so that we can easily install the doc std::string too. |
3325 | 133 |
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
134 typedef bool (*octave_dld_fcn_installer) (const octave::dynamic_library&, bool relative); |
3325 | 135 |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17787
diff
changeset
|
136 typedef octave_function * |
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
137 (*octave_dld_fcn_getter) (const octave::dynamic_library&, bool relative); |
7336 | 138 |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
139 #if defined (OCTAVE_SOURCE) |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
140 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
141 DEFINE_FUNX_INSTALLER_FUN(#name, F ## name, G ## name, "external-doc") |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
142 #else |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
143 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
144 DEFINE_FUNX_INSTALLER_FUN(#name, F ## name, G ## name, doc) |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
145 #endif |
5796 | 146 |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
147 #define DEFINE_FUNX_INSTALLER_FUN(name, fname, gname, doc) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
148 extern "C" \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
149 OCTAVE_EXPORT \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
150 octave_function * \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
151 gname (const octave::dynamic_library& shl, bool relative) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
152 { \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
153 check_version (OCTAVE_API_VERSION, name); \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
154 \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
155 octave_dld_function *fcn \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
156 = octave_dld_function::create (fname, shl, name, doc); \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
157 \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
158 if (relative) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
159 fcn->mark_relative (); \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
160 \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22004
diff
changeset
|
161 return fcn; \ |
3325 | 162 } |
163 | |
20945
9d9270e2f98f
eliminate comments after preprocessor conditionals
John W. Eaton <jwe@octave.org>
parents:
20791
diff
changeset
|
164 #endif |