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

annotate libinterp/corefcn/defun-int.h @ 23518:8744d4ed8fb4

provide DEFMETHOD macros Allow a reference to the interpreter object to be passed to built-in interpreter functions. * find-defun-files.sh: Adjust regexp pattern for finding built-in functions. * mk-builtins.pl: Handle DEFMETHOD variants of built-in function macros. * defun-int.h, defun.cc (install_builtin_function): New overloads for methods. * defun-int.h (FORWARD_DECLARE_METHODX, FORWARD_DECLARE_METHOD, DECLARE_METHODX, DECLARE_METHOD, DECLARE_STATIC_METHODX, DECLARE_STATIC_METHOD): New macros. * defun.h (DEFMETHOD, DEFMETHODX, DEFCONSTMETHOD): New macros. * libinterp/gendoc.pl: Likewise. * ov-builtin.h, ov-builtin.cc (octave_builtin::meth): New typedef. (octave_builtin::m): New data member. (octave_builtin::method): New function. (octave_builtin::octave_builtin, octave_builtin::call): Handle methods. * ov-dld-fcn.h, ov-dld-fcn.cc (octave_dld_function::create, octave_dld_function::octave_dld_function): Handle methods.

author	John W. Eaton <jwe@octave.org>
date	Fri, 19 May 2017 16:01:18 -0400
parents	0af6dbede266
children	be7b884ac589

rev	line source
525 509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	1 /*
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	2
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 23083 diff changeset	3 Copyright (C) 1994-2017 John W. Eaton
525 509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	4
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	6
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	8 under the terms of the GNU General Public License as published by
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	9 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	10 (at your option) any later version.
525 509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	11
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	15 GNU General Public License for more details.
525 509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	16
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	17 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6323 diff changeset	18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6323 diff changeset	19 <http://www.gnu.org/licenses/>.
525 509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	20
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	21 */
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	22
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20545 diff changeset	23 #if ! defined (octave_defun_int_h)
525 509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	24 #define octave_defun_int_h 1
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe] jwe parents: diff changeset	25
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20945 diff changeset	26 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20945 diff changeset	27
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	28 #include <string>
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	29
3145 0d640dc625c7 [project @ 1998-02-05 08:44:59 by jwe] jwe parents: 3096 diff changeset	30 #include "ov-builtin.h"
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	31 #include "ov-dld-fcn.h"
3145 0d640dc625c7 [project @ 1998-02-05 08:44:59 by jwe] jwe parents: 3096 diff changeset	32 #include "symtab.h"
3015 2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe] jwe parents: 3014 diff changeset	33 #include "version.h"
2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe] jwe parents: 3014 diff changeset	34
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	35 namespace octave
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	36 {
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	37 class interpreter;
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	38 }
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	39
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	40 class octave_value;
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	41
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	42 extern OCTINTERP_API void print_usage (void);
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 7996 diff changeset	43 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	44
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	45 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	46 const std::string& fcn);
3015 2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe] jwe parents: 3014 diff changeset	47
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	48 extern OCTINTERP_API void
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3364 diff changeset	49 install_builtin_function (octave_builtin::fcn f, const std::string& name,
15004 ea6997657614 which: provide source file name for built-in functions John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	50 const std::string& file, const std::string& doc,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	51 bool can_hide_function = true);
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	52
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	53 extern OCTINTERP_API void
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	54 install_builtin_function (octave_builtin::meth m, const std::string& name,
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	55 const std::string& file, const std::string& doc,
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	56 bool can_hide_function = true);
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	57
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	58 extern OCTINTERP_API void
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3364 diff changeset	59 install_dld_function (octave_dld_function::fcn f, const std::string& name,
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	60 const octave::dynamic_library& shl, const std::string& doc,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	61 bool relative = false);
703 21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe] jwe parents: 578 diff changeset	62
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	63 extern OCTINTERP_API void
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	64 install_dld_function (octave_dld_function::meth m, const std::string& name,
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	65 const octave::dynamic_library& shl, const std::string& doc,
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	66 bool relative = false);
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	67
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	68 extern OCTINTERP_API void
5864 e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe] jwe parents: 5823 diff changeset	69 install_mex_function (void *fptr, bool fmex, const std::string& name,
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	70 const octave::dynamic_library& shl, bool relative = false);
5864 e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe] jwe parents: 5823 diff changeset	71
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	72 extern OCTINTERP_API void
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3364 diff changeset	73 alias_builtin (const std::string& alias, const std::string& name);
703 21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe] jwe parents: 578 diff changeset	74
22893 5ff6716cf157 allow dispatch types to be declared for built-in functions John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	75 extern OCTINTERP_API void
5ff6716cf157 allow dispatch types to be declared for built-in functions John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	76 install_builtin_dispatch (const std::string& name, const std::string& klass);
5ff6716cf157 allow dispatch types to be declared for built-in functions John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	77
9960 5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	78 // Gets the shlib of the currently executing DLD function, if any.
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	79 extern OCTINTERP_API octave::dynamic_library
9960 5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	80 get_current_shlib (void);
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	81
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	82 namespace octave
9960 5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	83 {
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	84 // FIXME: this class doesn't seem to be used in Octave. Is it
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	85 // really needed?
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	86
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	87 // This is a convenience class that calls the above function automatically at
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	88 // construction time. When deriving new classes, you can either use it as a
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	89 // field or as a parent (with multiple inheritance).
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	90
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	91 class auto_shlib : public dynamic_library
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	92 {
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	93 public:
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	94
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	95 auto_shlib (void) : dynamic_library (get_current_shlib ()) { }
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	96
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	97 auto_shlib (const dynamic_library& shl) : dynamic_library (shl) { }
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	98 };
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	99 }
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	100
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	101 #if defined (OCTAVE_USE_DEPRECATED_FUNCTIONS)
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	102
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	103 OCTAVE_DEPRECATED ("use 'octave::auto_shlib' instead")
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	104 typedef octave::auto_shlib octave_auto_shlib;
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	105
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	106 #endif
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	107
9960 5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	108
10887 f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	109 extern OCTINTERP_API bool
f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	110 defun_isargout (int, int);
f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	111
f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	112 extern OCTINTERP_API void
f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	113 defun_isargout (int, int, bool *);
f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	114
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	115 #define FORWARD_DECLARE_FUNX(name) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	116 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	117 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	118
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	119 #define FORWARD_DECLARE_METHODX(name) \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	120 extern OCTAVE_EXPORT octave_value_list \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	121 name (octave::interpreter&, const octave_value_list&, int)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	122
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	123 #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	124 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	125
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	126 #define FORWARD_DECLARE_METHOD(name) \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	127 FORWARD_DECLARE_METHODX (F ## name)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	128
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	129 #define DECLARE_FUNX(name, args_name, nargout_name) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	130 OCTAVE_EXPORT octave_value_list \
15421 cd6ce11b9c57 backout changeset 2e5ba861898f John W. Eaton <jwe@octave.org> parents: 15398 diff changeset	131 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	132
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	133 #define DECLARE_METHODX(name, interp_name, args_name, nargout_name) \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	134 OCTAVE_EXPORT octave_value_list \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	135 name (octave::interpreter& interp_name, \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	136 const octave_value_list& args_name, int nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	137
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	138 #define DECLARE_FUN(name, args_name, nargout_name) \
3743 35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe] jwe parents: 3741 diff changeset	139 DECLARE_FUNX (F ## name, args_name, nargout_name)
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	140
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	141 #define DECLARE_METHOD(name, interp_name, args_name, nargout_name) \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	142 DECLARE_METHODX (F ## name, interp_name, args_name, nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	143
23452 0af6dbede266 also use DEFUN macros for local function declarations John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	144 #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	145 static octave_value_list \
0af6dbede266 also use DEFUN macros for local function declarations John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	146 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	147
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	148 #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	149 static octave_value_list \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	150 name (octave::interpreter& interp_name, \
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	151 const octave_value_list& args_name, int nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	152
23452 0af6dbede266 also use DEFUN macros for local function declarations John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	153 #define DECLARE_STATIC_FUN(name, args_name, nargout_name) \
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	154 DECLARE_STATIC_FUNX (F ## name, args_name, nargout_name)
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	155
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23452 diff changeset	156 #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	157 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	158
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	159 // 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	160 // 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	161 // 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	162
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	163 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	164
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	165 typedef octave_function *
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	166 (*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	167
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	168 #if defined (OCTAVE_SOURCE)
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	169 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	170 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	171 #else
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	172 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	173 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	174 #endif
5796 20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe] jwe parents: 5794 diff changeset	175
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	176 #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	177 extern "C" \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	178 OCTAVE_EXPORT \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	179 octave_function * \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	180 gname (const octave::dynamic_library& shl, bool relative) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	181 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	182 check_version (OCTAVE_API_VERSION, name); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	183 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	184 octave_dld_function *fcn \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	185 = octave_dld_function::create (fname, shl, name, doc); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	186 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	187 if (relative) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	188 fcn->mark_relative (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	189 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	190 return fcn; \
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	191 }
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	192
20945 9d9270e2f98f eliminate comments after preprocessor conditionals John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	193 #endif

Mercurial > octave

annotate libinterp/corefcn/defun-int.h @ 23518:8744d4ed8fb4