annotate libinterp/corefcn/defun-int.h @ 30748:e00154c0a71b stable

move auto_shlib class to separate source file * auto-shlib.h, auto-shlib.cc: New files with class definition extracted from defun-int.h. * libinterp/corefcn/module.mk: Update.
author John W. Eaton <jwe@octave.org>
date Thu, 17 Feb 2022 22:19:11 -0500
parents 796f54d4ddbf
children e88a07dec498
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 //
30564
796f54d4ddbf update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 30390
diff changeset
3 // Copyright (C) 1994-2022 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
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
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
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
27 #define octave_defun_int_h 1
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
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
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe]
jwe
parents: 2954
diff changeset
31 #include <string>
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe]
jwe
parents: 2954
diff changeset
32
3145
0d640dc625c7 [project @ 1998-02-05 08:44:59 by jwe]
jwe
parents: 3096
diff changeset
33 #include "ov-builtin.h"
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
34 #include "ov-dld-fcn.h"
3015
2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe]
jwe
parents: 3014
diff changeset
35 #include "version.h"
2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe]
jwe
parents: 3014
diff changeset
36
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29957
diff changeset
37 class octave_value;
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29957
diff changeset
38
29960
939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
39 OCTAVE_NAMESPACE_BEGIN
23518
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
40
29960
939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
41 class interpreter;
29957
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
42
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
43 extern OCTINTERP_API void print_usage (void);
29957
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
44
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
38de16594cb4 [project @ 1997-06-02 20:28:09 by jwe]
jwe
parents: 3005
diff changeset
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
2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe]
jwe
parents: 3014
diff changeset
49
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
50 extern OCTINTERP_API void
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3364
diff changeset
51 install_dld_function (octave_dld_function::fcn f, const std::string& name,
29957
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
52 const dynamic_library& shl, const std::string& doc,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
53 bool relative = false);
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
54
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
55 extern OCTINTERP_API void
23518
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
56 install_dld_function (octave_dld_function::meth m, const std::string& name,
29957
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
57 const dynamic_library& shl, const std::string& doc,
23518
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
58 bool relative = false);
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
59
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
60 extern OCTINTERP_API void
5864
e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe]
jwe
parents: 5823
diff changeset
61 install_mex_function (void *fptr, bool fmex, const std::string& name,
29957
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
62 const dynamic_library& shl, bool relative = false);
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
63
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.
29957
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
65 extern OCTINTERP_API dynamic_library get_current_shlib (void);
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
66
29960
939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
67 OCTAVE_NAMESPACE_END
29957
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
68
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
69 // Some of these functions are widely used, so maybe we should avoid
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
70 // deprecating them for now?
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
71
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
72 inline void print_usage (void)
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
73 {
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
74 octave::print_usage ();
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
75 }
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
76
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
77 inline void print_usage (const std::string& name)
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
78 {
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
79 octave::print_usage (name);
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
80 }
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
81
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
82 inline void
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
83 check_version (const std::string& version, const std::string& fcn)
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
84 {
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
85 octave::check_version (version, fcn);
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
86 }
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
87
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
88 inline void
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
89 install_dld_function (octave_dld_function::fcn f, const std::string& name,
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
90 const octave::dynamic_library& shl,
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
91 const std::string& doc, bool relative = false)
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
92 {
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
93 octave::install_dld_function (f, name, shl, doc, relative);
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
94 }
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
95
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
96 inline void
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
97 install_dld_function (octave_dld_function::meth m, const std::string& name,
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
98 const octave::dynamic_library& shl,
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
99 const std::string& doc, bool relative = false)
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
100 {
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
101 octave::install_dld_function (m, name, shl, doc, relative);
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
102 }
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
103
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
104 inline void
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
105 install_mex_function (void *fptr, bool fmex, const std::string& name,
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
106 const octave::dynamic_library& shl,
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
107 bool relative = false)
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
108 {
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
109 octave::install_mex_function (fptr, fmex, name, shl, relative);
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
110 }
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
111
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
112 // Gets the shlib of the currently executing DLD function, if any.
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
113 inline octave::dynamic_library get_current_shlib (void)
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
114 {
64e3ef97384e move some defun functions inside the octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
115 return octave::get_current_shlib ();
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
116 }
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
117
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
118 #define FORWARD_DECLARE_FUNX(name) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
119 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
120 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
121
23518
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
122 #define FORWARD_DECLARE_METHODX(name) \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
123 extern OCTAVE_EXPORT octave_value_list \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
124 name (octave::interpreter&, const octave_value_list&, int)
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
125
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
126 #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
127 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
128
23518
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
129 #define FORWARD_DECLARE_METHOD(name) \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
130 FORWARD_DECLARE_METHODX (F ## name)
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
131
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
132 #define DECLARE_FUNX(name, args_name, nargout_name) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
133 OCTAVE_EXPORT octave_value_list \
15421
cd6ce11b9c57 backout changeset 2e5ba861898f
John W. Eaton <jwe@octave.org>
parents: 15398
diff changeset
134 name (const octave_value_list& args_name, int nargout_name)
3743
35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe]
jwe
parents: 3741
diff changeset
135
23518
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
136 #define DECLARE_METHODX(name, interp_name, args_name, nargout_name) \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
137 OCTAVE_EXPORT octave_value_list \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
138 name (octave::interpreter& interp_name, \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
139 const octave_value_list& args_name, int nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
140
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
141 #define DECLARE_FUN(name, args_name, nargout_name) \
3743
35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe]
jwe
parents: 3741
diff changeset
142 DECLARE_FUNX (F ## name, args_name, nargout_name)
2968
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe]
jwe
parents: 2954
diff changeset
143
23518
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
144 #define DECLARE_METHOD(name, interp_name, args_name, nargout_name) \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
145 DECLARE_METHODX (F ## name, interp_name, args_name, nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
146
29967
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
147 #define FORWARD_DECLARE_STATIC_FUNX(name) \
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
148 static octave_value_list \
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
149 name (const octave_value_list&, int)
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
150
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
151 #define FORWARD_DECLARE_STATIC_METHODX(name) \
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
152 static octave_value_list \
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
153 name (octave::interpreter&, const octave_value_list&, int)
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
154
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
155 #define FORWARD_DECLARE_STATIC_FUN(name) \
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
156 FORWARD_DECLARE_STATIC_FUNX (F ## name)
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
157
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
158 #define FORWARD_DECLARE_STATIC_METHOD(name) \
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
159 FORWARD_DECLARE_STATIC_METHODX (F ## name)
da1678140f7e make interpreter functions in .oct files static
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
160
23452
0af6dbede266 also use DEFUN macros for local function declarations
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
161 #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
162 static octave_value_list \
0af6dbede266 also use DEFUN macros for local function declarations
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
163 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
164
23518
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
165 #define DECLARE_STATIC_METHODX(name, interp_name, args_name, nargout_name) \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
166 static octave_value_list \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
167 name (octave::interpreter& interp_name, \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
168 const octave_value_list& args_name, int nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
169
23452
0af6dbede266 also use DEFUN macros for local function declarations
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
170 #define DECLARE_STATIC_FUN(name, args_name, nargout_name) \
23518
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
171 DECLARE_STATIC_FUNX (F ## name, args_name, nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
172
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
173 #define DECLARE_STATIC_METHOD(name, interp_name, args_name, nargout_name) \
8744d4ed8fb4 provide DEFMETHOD macros
John W. Eaton <jwe@octave.org>
parents: 23452
diff changeset
174 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
175
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
176 // Define the code that will be used to insert the new function into
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
177 // the symbol table. We look for this name instead of the actual
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3364
diff changeset
178 // function so that we can easily install the doc std::string too.
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
179
21750
6720e5a220ba use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
180 typedef bool (*octave_dld_fcn_installer) (const octave::dynamic_library&, bool relative);
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
181
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
182 typedef octave_function *
21750
6720e5a220ba use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
183 (*octave_dld_fcn_getter) (const octave::dynamic_library&, bool relative);
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7101
diff changeset
184
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
185 #if defined (OCTAVE_SOURCE)
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
186 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
187 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
188 #else
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
189 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
190 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
191 #endif
5796
20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe]
jwe
parents: 5794
diff changeset
192
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
193 #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
194 extern "C" \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
195 OCTAVE_EXPORT \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
196 octave_function * \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
197 gname (const octave::dynamic_library& shl, bool relative) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
198 { \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
199 check_version (OCTAVE_API_VERSION, name); \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
200 \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
201 octave_dld_function *fcn \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
202 = octave_dld_function::create (fname, shl, name, doc); \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
203 \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
204 if (relative) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
205 fcn->mark_relative (); \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
206 \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22004
diff changeset
207 return fcn; \
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
208 }
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
209
20945
9d9270e2f98f eliminate comments after preprocessor conditionals
John W. Eaton <jwe@octave.org>
parents: 20791
diff changeset
210 #endif