GNU Octave  4.0.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.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1994-2015 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_h)
24 #define octave_defun_h 1
25 
26 #if defined (octave_defun_dld_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.
33 //
34 // name is the name of the function, unqouted.
35 //
36 // args_name is the name of the octave_value_list variable used to pass
37 // the argument list to this function.
38 //
39 // nargout_name is the name of the int variable used to pass the
40 // number of output arguments this function is expected to produce.
41 //
42 // doc is the simple help text for the function.
43 
44 #define DEFUN(name, args_name, nargout_name, doc) \
45  DEFUN_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 "Ffoo").
51 
52 #define DEFUNX(name, fname, args_name, nargout_name, doc) \
53  DEFUNX_INTERNAL (name, fname, args_name, nargout_name, doc)
54 
55 // This is a function with a name that can't be hidden by a variable.
56 #define DEFCONSTFUN(name, args_name, nargout_name, doc) \
57  DEFCONSTFUN_INTERNAL (name, args_name, nargout_name, doc)
58 
59 // Make alias another name for the existing function name. This macro
60 // must be used in the same file where name is defined, after the
61 // definition for name.
62 
63 #define DEFALIAS(alias, name) \
64  DEFALIAS_INTERNAL (alias, name)
65 
66 #endif