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