1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1994-2021 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING. If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
#if ! defined (octave_defun_int_h)
#define octave_defun_int_h 1
#include "octave-config.h"
#include <string>
#include "ov-builtin.h"
#include "ov-dld-fcn.h"
#include "version.h"
namespace octave
{
class interpreter;
}
class octave_value;
extern OCTINTERP_API void print_usage (void);
extern OCTINTERP_API void print_usage (const std::string&);
extern OCTINTERP_API void check_version (const std::string& version,
const std::string& fcn);
extern OCTINTERP_API void
install_dld_function (octave_dld_function::fcn f, const std::string& name,
const octave::dynamic_library& shl, const std::string& doc,
bool relative = false);
extern OCTINTERP_API void
install_dld_function (octave_dld_function::meth m, const std::string& name,
const octave::dynamic_library& shl, const std::string& doc,
bool relative = false);
extern OCTINTERP_API void
install_mex_function (void *fptr, bool fmex, const std::string& name,
const octave::dynamic_library& shl, bool relative = false);
// Gets the shlib of the currently executing DLD function, if any.
extern OCTINTERP_API octave::dynamic_library
get_current_shlib (void);
namespace octave
{
// FIXME: this class doesn't seem to be used in Octave. Is it
// really needed?
// This is a convenience class that calls the above function automatically at
// construction time. When deriving new classes, you can either use it as a
// field or as a parent (with multiple inheritance).
class auto_shlib : public dynamic_library
{
public:
auto_shlib (void) : dynamic_library (get_current_shlib ()) { }
auto_shlib (const dynamic_library& shl) : dynamic_library (shl) { }
};
}
#define FORWARD_DECLARE_FUNX(name) \
extern OCTAVE_EXPORT octave_value_list \
name (const octave_value_list&, int)
#define FORWARD_DECLARE_METHODX(name) \
extern OCTAVE_EXPORT octave_value_list \
name (octave::interpreter&, const octave_value_list&, int)
#define FORWARD_DECLARE_FUN(name) \
FORWARD_DECLARE_FUNX (F ## name)
#define FORWARD_DECLARE_METHOD(name) \
FORWARD_DECLARE_METHODX (F ## name)
#define DECLARE_FUNX(name, args_name, nargout_name) \
OCTAVE_EXPORT octave_value_list \
name (const octave_value_list& args_name, int nargout_name)
#define DECLARE_METHODX(name, interp_name, args_name, nargout_name) \
OCTAVE_EXPORT octave_value_list \
name (octave::interpreter& interp_name, \
const octave_value_list& args_name, int nargout_name)
#define DECLARE_FUN(name, args_name, nargout_name) \
DECLARE_FUNX (F ## name, args_name, nargout_name)
#define DECLARE_METHOD(name, interp_name, args_name, nargout_name) \
DECLARE_METHODX (F ## name, interp_name, args_name, nargout_name)
#define DECLARE_STATIC_FUNX(name, args_name, nargout_name) \
static octave_value_list \
name (const octave_value_list& args_name, int nargout_name)
#define DECLARE_STATIC_METHODX(name, interp_name, args_name, nargout_name) \
static octave_value_list \
name (octave::interpreter& interp_name, \
const octave_value_list& args_name, int nargout_name)
#define DECLARE_STATIC_FUN(name, args_name, nargout_name) \
DECLARE_STATIC_FUNX (F ## name, args_name, nargout_name)
#define DECLARE_STATIC_METHOD(name, interp_name, args_name, nargout_name) \
DECLARE_STATIC_METHODX (F ## name, interp_name, args_name, nargout_name)
// Define the code that will be used to insert the new function into
// the symbol table. We look for this name instead of the actual
// function so that we can easily install the doc std::string too.
typedef bool (*octave_dld_fcn_installer) (const octave::dynamic_library&, bool relative);
typedef octave_function *
(*octave_dld_fcn_getter) (const octave::dynamic_library&, bool relative);
#if defined (OCTAVE_SOURCE)
# define DEFINE_FUN_INSTALLER_FUN(name, doc) \
DEFINE_FUNX_INSTALLER_FUN(#name, F ## name, G ## name, "external-doc")
#else
# define DEFINE_FUN_INSTALLER_FUN(name, doc) \
DEFINE_FUNX_INSTALLER_FUN(#name, F ## name, G ## name, doc)
#endif
#define DEFINE_FUNX_INSTALLER_FUN(name, fname, gname, doc) \
extern "C" \
OCTAVE_EXPORT \
octave_function * \
gname (const octave::dynamic_library& shl, bool relative) \
{ \
check_version (OCTAVE_API_VERSION, name); \
\
octave_dld_function *fcn \
= octave_dld_function::create (fname, shl, name, doc); \
\
if (relative) \
fcn->mark_relative (); \
\
return fcn; \
}
#endif
|
