Mercurial > octave
view libinterp/corefcn/defun.h @ 23432:e35a5c1233d0
maint: Use convention 'int *x' for naming pointers.
* annotation-dialog.h, files-dock-widget.cc, find-files-dialog.cc,
find-files-dialog.h, file-editor.cc, file-editor.h, main-window.cc,
main-window.h, octave-dock-widget.cc, parser.h, settings-dialog.h,
load-save.cc, mex.cc, pr-output.cc, symtab.cc, __ode15__.cc, ov-bool-sparse.cc,
ov-cx-sparse.cc, ov-fcn-inline.cc, ov-re-sparse.cc, Sparse.cc, idx-vector.cc,
idx-vector.h: Use convention 'int *x' for naming pointers.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 24 Apr 2017 14:38:34 -0700 |
parents | 092078913d54 |
children | 8744d4ed8fb4 |
line wrap: on
line source
/* Copyright (C) 1994-2017 John W. Eaton 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 <http://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" // Define a builtin function. // // name is the name of the function, unqouted. // // args_name is the name of the octave_value_list variable used to pass // the argument list to this function. // // nargout_name is the name of the int variable used to pass the // number of output arguments this function is expected to produce. // // doc is the simple help text for the function. #define DEFUN(name, args_name, nargout_name, doc) \ DECLARE_FUN (name, args_name, nargout_name) // This one can be used when 'name' cannot be used directly (if it is // already defined as a macro). In that case, name is already a // quoted string, and the internal name of the function must be passed // too (the convention is to use a prefix of "F", so "foo" becomes "Ffoo"). #define DEFUNX(name, fname, args_name, nargout_name, doc) \ DECLARE_FUNX (fname, args_name, nargout_name) // This is a function with a name that can't be hidden by a variable. #define DEFCONSTFUN(name, args_name, nargout_name, doc) \ DECLARE_FUN (name, args_name, nargout_name) // Make alias another name for the existing function name. This macro // is processed by the mkbuiltins to generate code in builtins.cc to // create the alias in the symbol table. #define DEFALIAS(alias, name) #endif