octave: libinterp/corefcn/defun-int.h annotate

annotate libinterp/corefcn/defun-int.h @ 30390:a61e1a0f6024 stable

maint: style check C++ files in libinterp/ ahead of 7.1 release. * Cell.cc, __eigs__.cc, __ichol__.cc, __ilu__.cc, __magick_read__.cc, __qp__.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.h, ccolamd.cc, cellfun.cc, data.cc, debug.cc, defun-int.h, dlmread.cc, event-manager.cc, fftn.cc, file-io.cc, ft-text-renderer.cc, gl2ps-print.cc, graphics.cc, graphics.in.h, gzfstream.cc, gzfstream.h, jsondecode.cc, jsonencode.cc, latex-text-renderer.cc, ls-mat5.cc, lu.cc, mex.cc, oct-stream.cc, oct-strstrm.cc, ordqz.cc, pager.h, pr-output.cc, qz.cc, schur.cc, sparse-xdiv.cc, sparse-xpow.cc, sparse.cc, stack-frame.h, strfns.cc, svd.cc, symrcm.cc, symscope.h, sysdep.cc, text-engine.h, text-renderer.h, tril.cc, variables.h, xdiv.h, __glpk__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __voronoi__.cc, audiodevinfo.cc, cdef-class.cc, cdef-class.h, cdef-manager.cc, cdef-manager.h, cdef-method.cc, cdef-object.cc, ov-base-diag.cc, ov-base-diag.h, ov-base-int.cc, ov-base-int.h, ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.h, ov-base-sparse.cc, ov-base-sparse.h, ov-base.h, ov-bool-mat.cc, ov-cell.cc, ov-cell.h, ov-class.cc, ov-class.h, ov-dld-fcn.cc, ov-intx.h, ov-lazy-idx.cc, ov-lazy-idx.h, ov-mex-fcn.h, ov-perm.cc, ov-perm.h, ov-range.cc, ov-re-mat.cc, ov-re-mat.h, ov-str-mat.h, ov-struct.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov.h, parse.h, pt-cell.cc, pt-stmt.cc, pt-tm-const.cc, pt-walk.cc: Style check C++ files in libinterp/ ahead of 7.1 release.

author	Rik <rik@octave.org>
date	Sun, 28 Nov 2021 21:52:08 -0800
parents	da1678140f7e
children	796f54d4ddbf

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
29358 0a5b15007766 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	3 // Copyright (C) 1994-2021 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
525 509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20545 diff changeset	26 #if ! defined (octave_defun_int_h)
525 509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	27 #define octave_defun_int_h 1
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20945 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20945 diff changeset	30
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	31 #include <string>
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	32
3145 0d640dc625c7 [project @ 1998-02-05 08:44:59 by jwe] jwe parents: 3096 diff changeset	33 #include "ov-builtin.h"
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	34 #include "ov-dld-fcn.h"
3015 2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe] jwe parents: 3014 diff changeset	35 #include "version.h"
2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe] jwe parents: 3014 diff changeset	36
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29957 diff changeset	37 class octave_value;
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29957 diff changeset	38
29960 939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	39 OCTAVE_NAMESPACE_BEGIN
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	40
29960 939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	41 class interpreter;
29957 64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	42
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	43 extern OCTINTERP_API void print_usage (void);
29957 64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	44
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 7996 diff changeset	45 extern OCTINTERP_API void print_usage (const std::string&);
3014 38de16594cb4 [project @ 1997-06-02 20:28:09 by jwe] jwe parents: 3005 diff changeset	46
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	47 extern OCTINTERP_API void check_version (const std::string& version,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	48 const std::string& fcn);
3015 2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe] jwe parents: 3014 diff changeset	49
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	50 extern OCTINTERP_API void
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3364 diff changeset	51 install_dld_function (octave_dld_function::fcn f, const std::string& name,
29957 64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	52 const dynamic_library& shl, const std::string& doc,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	53 bool relative = false);
703 21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe] jwe parents: 578 diff changeset	54
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	55 extern OCTINTERP_API void
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	56 install_dld_function (octave_dld_function::meth m, const std::string& name,
29957 64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	57 const dynamic_library& shl, const std::string& doc,
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	58 bool relative = false);
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	59
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	60 extern OCTINTERP_API void
5864 e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe] jwe parents: 5823 diff changeset	61 install_mex_function (void *fptr, bool fmex, const std::string& name,
29957 64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	62 const dynamic_library& shl, bool relative = false);
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	63
9960 5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	64 // Gets the shlib of the currently executing DLD function, if any.
29957 64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	65 extern OCTINTERP_API dynamic_library get_current_shlib (void);
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	66
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	67 // FIXME: this class doesn't seem to be used in Octave. Is it
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	68 // really needed?
23056 422757f6ddbc * defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib. John W. Eaton <jwe@octave.org> parents: 22893 diff changeset	69
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	70 // This is a convenience class that calls the above function automatically at
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	71 // construction time. When deriving new classes, you can either use it as a
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	72 // field or as a parent (with multiple inheritance).
23056 422757f6ddbc * defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib. John W. Eaton <jwe@octave.org> parents: 22893 diff changeset	73
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	74 class auto_shlib : public dynamic_library
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	75 {
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	76 public:
23056 422757f6ddbc * defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib. John W. Eaton <jwe@octave.org> parents: 22893 diff changeset	77
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	78 auto_shlib (void) : dynamic_library (get_current_shlib ()) { }
23056 422757f6ddbc * defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib. John W. Eaton <jwe@octave.org> parents: 22893 diff changeset	79
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	80 auto_shlib (const dynamic_library& shl) : dynamic_library (shl) { }
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29967 diff changeset	81 };
29960 939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	82
939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	83 OCTAVE_NAMESPACE_END
29957 64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	84
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	85 // Some of these functions are widely used, so maybe we should avoid
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	86 // deprecating them for now?
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	87
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	88 inline void print_usage (void)
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	89 {
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	90 octave::print_usage ();
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	91 }
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	92
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	93 inline void print_usage (const std::string& name)
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	94 {
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	95 octave::print_usage (name);
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	96 }
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	97
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	98 inline void
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	99 check_version (const std::string& version, const std::string& fcn)
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	100 {
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	101 octave::check_version (version, fcn);
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	102 }
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	103
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	104 inline void
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	105 install_dld_function (octave_dld_function::fcn f, const std::string& name,
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	106 const octave::dynamic_library& shl,
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	107 const std::string& doc, bool relative = false)
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	108 {
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	109 octave::install_dld_function (f, name, shl, doc, relative);
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	110 }
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	111
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	112 inline void
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	113 install_dld_function (octave_dld_function::meth m, const std::string& name,
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	114 const octave::dynamic_library& shl,
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	115 const std::string& doc, bool relative = false)
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	116 {
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	117 octave::install_dld_function (m, name, shl, doc, relative);
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	118 }
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	119
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	120 inline void
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	121 install_mex_function (void *fptr, bool fmex, const std::string& name,
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	122 const octave::dynamic_library& shl,
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	123 bool relative = false)
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	124 {
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	125 octave::install_mex_function (fptr, fmex, name, shl, relative);
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	126 }
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	127
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	128 // Gets the shlib of the currently executing DLD function, if any.
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	129 inline octave::dynamic_library get_current_shlib (void)
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	130 {
64e3ef97384e move some defun functions inside the octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	131 return octave::get_current_shlib ();
23056 422757f6ddbc * defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib. John W. Eaton <jwe@octave.org> parents: 22893 diff changeset	132 }
422757f6ddbc * defun-int.h (auto_shlib): Move inside octave namespace and rename from octave_auto_shlib. John W. Eaton <jwe@octave.org> parents: 22893 diff changeset	133
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	134 #define FORWARD_DECLARE_FUNX(name) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	135 extern OCTAVE_EXPORT octave_value_list \
22004 78000c426b73 don't provide default parameter values in forward decls for DEFUNs John W. Eaton <jwe@octave.org> parents: 21966 diff changeset	136 name (const octave_value_list&, int)
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	137
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	138 #define FORWARD_DECLARE_METHODX(name) \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	139 extern OCTAVE_EXPORT octave_value_list \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	140 name (octave::interpreter&, const octave_value_list&, int)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	141
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	142 #define FORWARD_DECLARE_FUN(name) \
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	143 FORWARD_DECLARE_FUNX (F ## name)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	144
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	145 #define FORWARD_DECLARE_METHOD(name) \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	146 FORWARD_DECLARE_METHODX (F ## name)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	147
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	148 #define DECLARE_FUNX(name, args_name, nargout_name) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	149 OCTAVE_EXPORT octave_value_list \
15421 cd6ce11b9c57 backout changeset 2e5ba861898f John W. Eaton <jwe@octave.org> parents: 15398 diff changeset	150 name (const octave_value_list& args_name, int nargout_name)
3743 35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe] jwe parents: 3741 diff changeset	151
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	152 #define DECLARE_METHODX(name, interp_name, args_name, nargout_name) \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	153 OCTAVE_EXPORT octave_value_list \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	154 name (octave::interpreter& interp_name, \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	155 const octave_value_list& args_name, int nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	156
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	157 #define DECLARE_FUN(name, args_name, nargout_name) \
3743 35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe] jwe parents: 3741 diff changeset	158 DECLARE_FUNX (F ## name, args_name, nargout_name)
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	159
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	160 #define DECLARE_METHOD(name, interp_name, args_name, nargout_name) \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	161 DECLARE_METHODX (F ## name, interp_name, args_name, nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	162
29967 da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	163 #define FORWARD_DECLARE_STATIC_FUNX(name) \
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	164 static octave_value_list \
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	165 name (const octave_value_list&, int)
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	166
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	167 #define FORWARD_DECLARE_STATIC_METHODX(name) \
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	168 static octave_value_list \
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	169 name (octave::interpreter&, const octave_value_list&, int)
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	170
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	171 #define FORWARD_DECLARE_STATIC_FUN(name) \
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	172 FORWARD_DECLARE_STATIC_FUNX (F ## name)
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	173
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	174 #define FORWARD_DECLARE_STATIC_METHOD(name) \
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	175 FORWARD_DECLARE_STATIC_METHODX (F ## name)
da1678140f7e make interpreter functions in .oct files static John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	176
23452 0af6dbede266 also use DEFUN macros for local function declarations John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	177 #define DECLARE_STATIC_FUNX(name, args_name, nargout_name) \
0af6dbede266 also use DEFUN macros for local function declarations John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	178 static octave_value_list \
0af6dbede266 also use DEFUN macros for local function declarations John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	179 name (const octave_value_list& args_name, int nargout_name)
0af6dbede266 also use DEFUN macros for local function declarations John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	180
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	181 #define DECLARE_STATIC_METHODX(name, interp_name, args_name, nargout_name) \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	182 static octave_value_list \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	183 name (octave::interpreter& interp_name, \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	184 const octave_value_list& args_name, int nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	185
23452 0af6dbede266 also use DEFUN macros for local function declarations John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	186 #define DECLARE_STATIC_FUN(name, args_name, nargout_name) \
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	187 DECLARE_STATIC_FUNX (F ## name, args_name, nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	188
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	189 #define DECLARE_STATIC_METHOD(name, interp_name, args_name, nargout_name) \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	190 DECLARE_STATIC_METHODX (F ## name, interp_name, args_name, nargout_name)
23452 0af6dbede266 also use DEFUN macros for local function declarations John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	191
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	192 // Define the code that will be used to insert the new function into
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	193 // the symbol table. We look for this name instead of the actual
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3364 diff changeset	194 // function so that we can easily install the doc std::string too.
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	195
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	196 typedef bool (*octave_dld_fcn_installer) (const octave::dynamic_library&, bool relative);
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	197
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	198 typedef octave_function *
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	199 (*octave_dld_fcn_getter) (const octave::dynamic_library&, bool relative);
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7101 diff changeset	200
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	201 #if defined (OCTAVE_SOURCE)
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	202 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	203 DEFINE_FUNX_INSTALLER_FUN(#name, F ## name, G ## name, "external-doc")
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	204 #else
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	205 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	206 DEFINE_FUNX_INSTALLER_FUN(#name, F ## name, G ## name, doc)
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	207 #endif
5796 20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe] jwe parents: 5794 diff changeset	208
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	209 #define DEFINE_FUNX_INSTALLER_FUN(name, fname, gname, doc) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	210 extern "C" \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	211 OCTAVE_EXPORT \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	212 octave_function * \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	213 gname (const octave::dynamic_library& shl, bool relative) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	214 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	215 check_version (OCTAVE_API_VERSION, name); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	216 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	217 octave_dld_function *fcn \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	218 = octave_dld_function::create (fname, shl, name, doc); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	219 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	220 if (relative) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	221 fcn->mark_relative (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	222 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	223 return fcn; \
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	224 }
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	225
20945 9d9270e2f98f eliminate comments after preprocessor conditionals John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	226 #endif

Mercurial > octave

annotate libinterp/corefcn/defun-int.h @ 30390:a61e1a0f6024 stable