Mercurial > octave
view libinterp/corefcn/defun.h @ 29654:d13d090cb03a stable
use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
Files affected: make_int.cc, file-editor-tab.cc, octave-qscintilla.cc,
Cell.cc, Cell.h, call-stack.cc, call-stack.h, cellfun.cc, data.cc,
debug.cc, dlmread.cc, error.cc, event-queue.h, fcn-info.cc,
fcn-info.h, file-io.cc, ft-text-renderer.cc, gl2ps-print.cc,
graphics.cc, graphics.in.h, help.cc, hex2num.cc, input.cc,
latex-text-renderer.cc, load-path.cc, load-save.cc, load-save.h,
ls-hdf5.cc, ls-mat-ascii.cc, ls-mat5.cc, ls-oct-text.cc, mex.cc,
mexproto.h, mxarray.h, oct-map.cc, oct-stream.cc, oct-stream.h,
pager.cc, pager.h, pr-output.cc, regexp.cc, settings.h,
stack-frame.cc, stack-frame.h, strfns.cc, syminfo.cc, symrec.h,
symscope.cc, symscope.h, symtab.cc, sysdep.cc, toplev.cc, utils.cc,
utils.h, variables.cc, __fltk_uigetfile__.cc, __init_fltk__.cc,
audioread.cc, gzip.cc, cdef-class.cc, cdef-manager.cc, cdef-method.cc,
cdef-object.cc, cdef-object.h, ov-base-diag.cc, ov-base-diag.h,
ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.cc, ov-base-scalar.h,
ov-base-sparse.h, ov-base.cc, ov-base.h, ov-cell.cc, ov-cell.h,
ov-ch-mat.cc, ov-class.cc, ov-class.h, ov-classdef.cc,
ov-fcn-handle.cc, ov-java.cc, ov-lazy-idx.h, ov-perm.cc, ov-perm.h,
ov-range.h, ov-str-mat.cc, ov-struct.cc, ov-struct.h, ov-usr-fcn.cc,
ov-usr-fcn.h, ov.cc, ov.h, ovl.cc, octave.cc, bp-table.cc, jit-ir.cc,
jit-ir.h, jit-typeinfo.cc, jit-typeinfo.h, jit-util.h, lex.h, lex.ll,
oct-lvalue.cc, oct-parse.yy, parse.h, profiler.h, pt-eval.cc,
pt-eval.h, pt-jit.cc, pt-jit.h, pt-pr-code.cc, pt-tm-const.cc,
pt-tm-const.h, Array.h, CMatrix.cc, DiagArray2.h, PermMatrix.h,
Sparse.h, dMatrix.cc, fCMatrix.cc, fMatrix.cc, bsxfun-defs.cc,
oct-fftw.cc, oct-fftw.h, randpoisson.cc, sparse-chol.cc,
mx-inlines.cc, file-ops.cc, lo-sysdep.cc, oct-env.cc, oct-time.cc,
action-container.cc, action-container.h, base-list.h, caseless-str.h,
cmd-edit.cc, cmd-hist.cc, data-conv.cc, data-conv.h, f77-fcn.h,
file-info.cc, file-info.h, kpse.cc, kpse.h, lo-cutils.h, lo-hash.h,
lo-regexp.cc, oct-base64.cc, oct-base64.h, oct-binmap.h, oct-glob.cc,
oct-shlib.cc, oct-shlib.h, oct-sort.cc, oct-sparse.h, oct-string.cc,
quit.cc, unwind-prot.h, url-transfer.cc, main.in.cc, mkoctfile.in.cc,
and shared-fcns.h.
(grafted from aef11bb4e6d1f303ad9de5688fcb7244ef48867e)
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 28 Apr 2021 22:57:42 -0400 |
parents | 0a5b15007766 |
children | 7aa4d8c049e5 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // 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_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" //! Macro to define a 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 DEFUNX, DEFCONSTFUN #define DEFUN(name, args_name, nargout_name, doc) \ DECLARE_FUN (name, args_name, nargout_name) //! Macro to define a builtin function with certain internal name. //! //! @warning Consider to use #DEFUN, unless you have good reason. //! //! For detailed information, see \ref Macros. //! //! This macro can be used when @p name cannot be used directly (for example if //! it is already defined as a macro). In that case, @p name is already a //! quoted string (thus unaffected by macros), and the internal name of the //! function is given by @p fname. //! //! @param name The **quoted** name of the function that should be callable //! by the interpreter. //! @param fname The internal **unquoted** name of the function. This internal //! name is by convention 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 DEFUN, DEFCONSTFUN #define DEFUNX(name, fname, args_name, nargout_name, doc) \ DECLARE_FUNX (fname, args_name, nargout_name) //! Macro to define a builtin function that cannot be hidden by a variable. //! //! @warning Consider to use #DEFUN, unless you have good reason. //! //! For detailed information, see \ref Macros. //! //! The function gets installed to the 'octave::symbol_table' in a way, such //! that no variable is allowed to hide this function name. //! //! @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 DEFUN, DEFUNX #define DEFCONSTFUN(name, args_name, nargout_name, doc) \ DECLARE_FUN (name, args_name, nargout_name) //! Macro to define a 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 DEFMETHODX, DEFCONSTMETHOD #define DEFMETHOD(name, interp_name, args_name, nargout_name, doc) \ DECLARE_METHOD (name, interp_name, args_name, nargout_name) //! Macro to define a builtin method with certain internal name. //! //! @warning Consider to use #DEFMETHOD, unless you have good reason. //! //! For detailed information, see \ref Macros. //! //! This macro can be used when @p name cannot be used directly (for example if //! it is already defined as a macro). In that case, @p name is already a //! quoted string (thus unaffected by macros), and the internal name of the //! method is given by @p fname. //! //! @param name The **quoted** name of the method that should be callable //! by the interpreter. //! @param fname The internal **unquoted** name of the method. This internal //! name is by convention 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 #DEFUNX 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 DEFMETHOD, DEFCONSTMETHOD #define DEFMETHODX(name, fname, interp_name, args_name, nargout_name, doc) \ DECLARE_METHODX (fname, interp_name, args_name, nargout_name) //! Macro to define a builtin method that cannot be hidden by a variable. //! //! @warning Consider to use #DEFMETHOD, unless you have good reason. //! //! For detailed information, see \ref Macros. //! //! The method gets installed to the 'octave::symbol_table' in a way, such //! that no variable is allowed to hide this method name. //! //! @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 #DEFCONSTFUN 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 DEFMETHOD, DEFMETHODX #define DEFCONSTMETHOD(name, interp_name, args_name, nargout_name, doc) \ DECLARE_METHOD (name, interp_name, args_name, nargout_name) //! Macro to define an alias for another existing function name. //! //! For detailed information, see \ref Macros. //! //! @param alias For another existing function name. //! @param name The name of the other existing function. //! //! @see DEFUN #define DEFALIAS(alias, name) #endif