GNU Octave  3.8.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
defun-dld.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1994-2013 John W. Eaton
4 
5 This file is part of Octave.
6 
7 Octave is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
11 
12 Octave is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with Octave; see the file COPYING. If not, see
19 <http://www.gnu.org/licenses/>.
20 
21 */
22 
23 #if !defined (octave_defun_dld_h)
24 #define octave_defun_dld_h 1
25 
26 #if defined (octave_defun_h)
27 #error defun.h and defun-dld.h both included in same file!
28 #endif
29 
30 #include "defun-int.h"
31 
32 // Define a builtin function that may be loaded dynamically at run
33 // time.
34 //
35 // If Octave is not configured for dynamic linking of builtin
36 // functions, this is the same as DEFUN, except that it will generate
37 // an extra externally visible function.
38 //
39 // The first DECLARE_FUN is for the benefit of the installer function
40 // and the second is for the definition of the function.
41 
42 #if defined (MAKE_BUILTINS)
43 
44 #define DEFUN_DLD(name, args_name, nargout_name, doc) \
45  DEFUN_DLD_INTERNAL (name, args_name, nargout_name, doc)
46 
47 // This one can be used when 'name' cannot be used directly (if it is
48 // already defined as a macro). In that case, name is already a
49 // quoted string, and the internal name of the function must be passed
50 // too (the convention is to use a prefix of "F", so "foo" becomes
51 // "Ffoo") as well as the name of the generated installer function
52 // (the convention is to use a prefix of "G", so "foo" becomes "Gfoo").
53 
54 #define DEFUNX_DLD(name, fname, gname, args_name, nargout_name, doc) \
55  DEFUNX_DLD_INTERNAL (name, fname, args_name, nargout_name, doc)
56 
57 #else
58 
59 #define DEFUN_DLD(name, args_name, nargout_name, doc) \
60  DECLARE_FUN (name, args_name, nargout_name); \
61  DEFINE_FUN_INSTALLER_FUN (name, doc) \
62  DECLARE_FUN (name, args_name, nargout_name)
63 
64 #define DEFUNX_DLD(name, fname, gname, args_name, nargout_name, doc) \
65  DECLARE_FUNX (fname, args_name, nargout_name); \
66  DEFINE_FUNX_INSTALLER_FUN (name, fname, gname, doc) \
67  DECLARE_FUNX (fname, args_name, nargout_name)
68 
69 #endif
70 
71 #endif