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
|
////////////////////////////////////////////////////////////////////////
//
// 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_dld_h)
#define octave_defun_dld_h 1
#include "octave-config.h"
#if defined (octave_defun_h)
# error defun.h and defun-dld.h both included in same file!
#endif
#include "defun-int.h"
//! Macro to define an at run time dynamically loadable 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 DEFMETHOD_DLD
// The order of this macro for name = foo is:
// 1. Forward declaration of Ffoo.
// 2. Definition of installation function Gfoo.
// 3. Definition of Ffoo.
#define DEFUN_DLD(name, args_name, nargout_name, doc) \
FORWARD_DECLARE_FUN (name); \
DEFINE_FUN_INSTALLER_FUN (name, doc) \
DECLARE_FUN (name, args_name, nargout_name)
#define DEFUNX_DLD(name, fname, gname, args_name, nargout_name, doc) \
FORWARD_DECLARE_FUNX (fname); \
DEFINE_FUNX_INSTALLER_FUN (name, fname, gname, doc) \
DECLARE_FUNX (fname, args_name, nargout_name)
//! Macro to define an at run time dynamically loadable 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 DEFUN_DLD
// The order of this macro for name = foo is again:
// 1. Forward declaration of Ffoo.
// 2. Definition of installation function Gfoo.
// 3. Definition of Ffoo.
#define DEFMETHOD_DLD(name, interp_name, args_name, nargout_name, doc) \
FORWARD_DECLARE_METHOD (name); \
DEFINE_FUN_INSTALLER_FUN (name, doc) \
DECLARE_METHOD (name, interp_name, args_name, nargout_name)
#define DEFMETHODX_DLD(name, fname, gname, interp_name, args_name, \
nargout_name, doc) \
FORWARD_DECLARE_METHODX (fname); \
DEFINE_FUNX_INSTALLER_FUN (name, fname, gname, doc) \
DECLARE_METHODX (fname, interp_name, args_name, nargout_name)
#endif
|
