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

annotate libinterp/corefcn/defun-int.h @ 22893:5ff6716cf157

allow dispatch types to be declared for built-in functions * mk-builtins.pl, gendoc.pl: Handle "classes: NAME ..." info in DEFUN macros. * defun-int.h, defun.cc (install_builtin_dispatch): New function. symtab.h (symbol_tableinstall_built_in_dispatch, symbol_table::fcn_info::install_built_in_dispatch, symbol_table::fcn_info::fcn_info_rep::install_built_in_dispatch): New functions. * svd.cc (Fsvd): Add "classes: double single" tag prior to doc: comment.

author	John W. Eaton <jwe@octave.org>
date	Wed, 14 Dec 2016 14:59:27 -0500
parents	3a2b891d0b33
children	422757f6ddbc

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
22323 bac0d6f07a3e maint: Update copyright notices for 2016. John W. Eaton <jwe@octave.org> parents: 22197 diff changeset	3 Copyright (C) 1994-2016 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
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	35 class octave_value;
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	36
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	37 extern OCTINTERP_API void print_usage (void);
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 7996 diff changeset	38 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	39
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	40 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	41 const std::string& fcn);
3015 2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe] jwe parents: 3014 diff changeset	42
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	43 extern OCTINTERP_API void
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3364 diff changeset	44 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	45 const std::string& file, const std::string& doc,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	46 bool can_hide_function = true);
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 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_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	50 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	51 bool relative = false);
703 21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe] jwe parents: 578 diff changeset	52
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	53 extern OCTINTERP_API void
5864 e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe] jwe parents: 5823 diff changeset	54 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	55 const octave::dynamic_library& shl, bool relative = false);
5864 e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe] jwe parents: 5823 diff changeset	56
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 5864 diff changeset	57 extern OCTINTERP_API void
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3364 diff changeset	58 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	59
22893 5ff6716cf157 allow dispatch types to be declared for built-in functions John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	60 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	61 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	62
9960 5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	63 // 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	64 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	65 get_current_shlib (void);
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	66
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	67 // This is a convenience class that calls the above function automatically at
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21750 diff changeset	68 // construction time. When deriving new classes, you can either use it as a
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	69 // field or as a parent (with multiple inheritance).
9960 5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	70
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	71 class octave_auto_shlib : public octave::dynamic_library
9960 5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	72 {
10641 ed6969880316 preliminary onCleanup support Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	73 public:
9960 5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	74 octave_auto_shlib (void)
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	75 : octave::dynamic_library (get_current_shlib ()) { }
6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	76 octave_auto_shlib (const octave::dynamic_library& shl)
6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	77 : octave::dynamic_library (shl) { }
9960 5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	78 };
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	79
10887 f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	80 extern OCTINTERP_API bool
f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	81 defun_isargout (int, int);
f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	82
f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	83 extern OCTINTERP_API void
f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	84 defun_isargout (int, int, bool *);
f10d0bc8f9cc make isargout available to DEFUNs Jaroslav Hajek <highegg@gmail.com> parents: 10641 diff changeset	85
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	86 #define FORWARD_DECLARE_FUNX(name) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	87 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	88 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	89
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	90 #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	91 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	92
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	93 #define DECLARE_FUNX(name, args_name, nargout_name) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	94 OCTAVE_EXPORT octave_value_list \
15421 cd6ce11b9c57 backout changeset 2e5ba861898f John W. Eaton <jwe@octave.org> parents: 15398 diff changeset	95 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	96
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	97 #define DECLARE_FUN(name, args_name, nargout_name) \
3743 35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe] jwe parents: 3741 diff changeset	98 DECLARE_FUNX (F ## name, args_name, nargout_name)
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2954 diff changeset	99
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	100 // 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	101 // 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	102 // 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	103
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	104 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	105
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	106 typedef octave_function *
21750 6720e5a220ba use namespace for octave_shlib class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	107 (*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	108
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	109 #if defined (OCTAVE_SOURCE)
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	110 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	111 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	112 #else
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	113 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	114 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	115 #endif
5796 20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe] jwe parents: 5794 diff changeset	116
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	117 #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	118 extern "C" \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	119 OCTAVE_EXPORT \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	120 octave_function * \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	121 gname (const octave::dynamic_library& shl, bool relative) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	122 { \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	123 check_version (OCTAVE_API_VERSION, name); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	124 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	125 octave_dld_function *fcn \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	126 = octave_dld_function::create (fname, shl, name, doc); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	127 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	128 if (relative) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	129 fcn->mark_relative (); \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	130 \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22004 diff changeset	131 return fcn; \
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	132 }
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3321 diff changeset	133
20945 9d9270e2f98f eliminate comments after preprocessor conditionals John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	134 #endif
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22323 diff changeset	135

Mercurial > octave

annotate libinterp/corefcn/defun-int.h @ 22893:5ff6716cf157