Mercurial > octave-nkf
annotate libinterp/corefcn/defun.h @ 20614:10ec79b47808
use new string_value method to handle value extraction errors
* __voronoi__.cc, chol.cc, colamd.cc, fftw.cc:
Use new string_value method.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Thu, 08 Oct 2015 18:15:56 -0400 |
| parents | 4197fc428c7d |
| children |
| rev | line source |
|---|---|
| 525 | 1 /* |
| 2 | |
|
19731
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
3 Copyright (C) 1994-2015 John W. Eaton |
| 525 | 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 | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 525 | 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 | |
| 7016 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 525 | 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 | |
| 550 | 32 // Define a builtin function. |
| 33 // | |
| 1957 | 34 // name is the name of the function, unqouted. |
| 550 | 35 // |
| 2086 | 36 // args_name is the name of the octave_value_list variable used to pass |
| 1957 | 37 // the argument list to this function. |
| 550 | 38 // |
| 1957 | 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. | |
| 550 | 41 // |
| 42 // doc is the simple help text for the function. | |
| 43 | |
| 1957 | 44 #define DEFUN(name, args_name, nargout_name, doc) \ |
|
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
7503
diff
changeset
|
45 DEFUN_INTERNAL (name, args_name, nargout_name, doc) |
| 525 | 46 |
|
15466
d174210ce1ec
use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
47 // This one can be used when 'name' cannot be used directly (if it is |
| 3743 | 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 | |
| 5794 | 50 // too (the convention is to use a prefix of "F", so "foo" becomes "Ffoo"). |
| 3743 | 51 |
| 52 #define DEFUNX(name, fname, args_name, nargout_name, doc) \ | |
|
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
7503
diff
changeset
|
53 DEFUNX_INTERNAL (name, fname, args_name, nargout_name, doc) |
| 4208 | 54 |
| 4234 | 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) \ | |
|
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
7503
diff
changeset
|
57 DEFCONSTFUN_INTERNAL (name, args_name, nargout_name, doc) |
| 4234 | 58 |
| 550 | 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. | |
| 525 | 62 |
| 4699 | 63 #define DEFALIAS(alias, name) \ |
| 64 DEFALIAS_INTERNAL (alias, name) | |
| 525 | 65 |
| 66 #endif |