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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
////////////////////////////////////////////////////////////////////////
//
// 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_h)
#define octave_defun_h 1
#include "octave-config.h"
#if defined (octave_defun_dld_h)
# error defun.h and defun-dld.h both included in same file!
#endif
#include "defun-int.h"
//! Macro to define a builtin function.
//!
//! For detailed information, see \ref Macros.
//!
//! @param name The **unquoted** name of the function that should be installed
//! on the 'octave::symbol_table' and can be called by the
//! interpreter. Internally, the function name is prepended by an
//! 'F'.
//! @param args_name The name of the octave_value_list variable used to pass
//! the argument list to this function. If this value is
//! omitted, the function cannot access the argument list.
//! @param nargout_name The name of the 'int' variable used to pass the number
//! of output arguments this function is expected to
//! produce from the caller. If this value is
//! omitted, the function cannot access this number.
//! @param doc Texinfo help text (docstring) for the function.
//!
//! @see DEFUNX, DEFCONSTFUN
#define DEFUN(name, args_name, nargout_name, doc) \
DECLARE_FUN (name, args_name, nargout_name)
//! Macro to define a builtin function with certain internal name.
//!
//! @warning Consider to use #DEFUN, unless you have good reason.
//!
//! For detailed information, see \ref Macros.
//!
//! This macro can be used when @p name cannot be used directly (for example if
//! it is already defined as a macro). In that case, @p name is already a
//! quoted string (thus unaffected by macros), and the internal name of the
//! function is given by @p fname.
//!
//! @param name The **quoted** name of the function that should be callable
//! by the interpreter.
//! @param fname The internal **unquoted** name of the function. This internal
//! name is by convention prepended by an 'F'.
//! @param args_name The name of the octave_value_list variable used to pass
//! the argument list to this function. If this value is
//! omitted, the function cannot access the argument list.
//! @param nargout_name The name of the 'int' variable used to pass the number
//! of output arguments this function is expected to
//! produce from the caller. If this value is
//! omitted, the function cannot access this number.
//! @param doc Texinfo help text (docstring) for the function.
//!
//! @see DEFUN, DEFCONSTFUN
#define DEFUNX(name, fname, args_name, nargout_name, doc) \
DECLARE_FUNX (fname, args_name, nargout_name)
//! Macro to define a builtin function that cannot be hidden by a variable.
//!
//! @warning Consider to use #DEFUN, unless you have good reason.
//!
//! For detailed information, see \ref Macros.
//!
//! The function gets installed to the 'octave::symbol_table' in a way, such
//! that no variable is allowed to hide this function name.
//!
//! @param name The **unquoted** name of the function that should be installed
//! on the 'octave::symbol_table' and can be called by the
//! interpreter. Internally, the function name is prepended by an
//! 'F'.
//! @param args_name The name of the octave_value_list variable used to pass
//! the argument list to this function. If this value is
//! omitted, the function cannot access the argument list.
//! @param nargout_name The name of the 'int' variable used to pass the number
//! of output arguments this function is expected to
//! produce from the caller. If this value is
//! omitted, the function cannot access this number.
//! @param doc Texinfo help text (docstring) for the function.
//!
//! @see DEFUN, DEFUNX
#define DEFCONSTFUN(name, args_name, nargout_name, doc) \
DECLARE_FUN (name, args_name, nargout_name)
//! Macro to define a builtin method.
//!
//! For detailed information, see \ref Macros.
//!
//! @param name The **unquoted** name of the method that should be installed
//! on the 'octave::symbol_table' and can be called by the
//! interpreter. Internally, the method name is prepended by an
//! 'F'.
//! @param interp_name The name of the 'octave::interpreter' reference that can
//! be used by this method. If this value is omitted,
//! there is no access to the interpreter and one should
//! use #DEFUN to define a function instead.
//! @param args_name The name of the octave_value_list variable used to pass
//! the argument list to this method. If this value is
//! omitted, the method cannot access the argument list.
//! @param nargout_name The name of the 'int' variable used to pass the number
//! of output arguments this method is expected to
//! produce from the caller. If this value is
//! omitted, the method cannot access this number.
//! @param doc Texinfo help text (docstring) for the method.
//!
//! @see DEFMETHODX, DEFCONSTMETHOD
#define DEFMETHOD(name, interp_name, args_name, nargout_name, doc) \
DECLARE_METHOD (name, interp_name, args_name, nargout_name)
//! Macro to define a builtin method with certain internal name.
//!
//! @warning Consider to use #DEFMETHOD, unless you have good reason.
//!
//! For detailed information, see \ref Macros.
//!
//! This macro can be used when @p name cannot be used directly (for example if
//! it is already defined as a macro). In that case, @p name is already a
//! quoted string (thus unaffected by macros), and the internal name of the
//! method is given by @p fname.
//!
//! @param name The **quoted** name of the method that should be callable
//! by the interpreter.
//! @param fname The internal **unquoted** name of the method. This internal
//! name is by convention prepended by an 'F'.
//! @param interp_name The name of the 'octave::interpreter' reference that can
//! be used by this method. If this value is omitted,
//! there is no access to the interpreter and one should
//! use #DEFUNX to define a function instead.
//! @param args_name The name of the octave_value_list variable used to pass
//! the argument list to this method. If this value is
//! omitted, the method cannot access the argument list.
//! @param nargout_name The name of the 'int' variable used to pass the number
//! of output arguments this method is expected to
//! produce from the caller. If this value is
//! omitted, the method cannot access this number.
//! @param doc Texinfo help text (docstring) for the method.
//!
//! @see DEFMETHOD, DEFCONSTMETHOD
#define DEFMETHODX(name, fname, interp_name, args_name, nargout_name, doc) \
DECLARE_METHODX (fname, interp_name, args_name, nargout_name)
//! Macro to define a builtin method that cannot be hidden by a variable.
//!
//! @warning Consider to use #DEFMETHOD, unless you have good reason.
//!
//! For detailed information, see \ref Macros.
//!
//! The method gets installed to the 'octave::symbol_table' in a way, such
//! that no variable is allowed to hide this method name.
//!
//! @param name The **unquoted** name of the method that should be installed
//! on the 'octave::symbol_table' and can be called by the
//! interpreter. Internally, the method name is prepended by an
//! 'F'.
//! @param interp_name The name of the 'octave::interpreter' reference that can
//! be used by this method. If this value is omitted,
//! there is no access to the interpreter and one should
//! use #DEFCONSTFUN to define a function instead.
//! @param args_name The name of the octave_value_list variable used to pass
//! the argument list to this method. If this value is
//! omitted, the method cannot access the argument list.
//! @param nargout_name The name of the 'int' variable used to pass the number
//! of output arguments this method is expected to
//! produce from the caller. If this value is
//! omitted, the method cannot access this number.
//! @param doc Texinfo help text (docstring) for the method.
//!
//! @see DEFMETHOD, DEFMETHODX
#define DEFCONSTMETHOD(name, interp_name, args_name, nargout_name, doc) \
DECLARE_METHOD (name, interp_name, args_name, nargout_name)
//! Macro to define an alias for another existing function name.
//!
//! For detailed information, see \ref Macros.
//!
//! @param alias For another existing function name.
//! @param name The name of the other existing function.
//!
//! @see DEFUN
#define DEFALIAS(alias, name)
#endif
|
