Mercurial > octave
annotate libinterp/corefcn/defun-int.h @ 21966:112b20240c87
move docstrings in C++ files out of C strings and into comments
* __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc,
__ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc,
dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc,
dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc,
fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc,
pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc,
sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc,
ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc,
ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc,
pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy:
Docstrings are now comments instead of C strings.
* build-aux/mk-opts.pl: Emit docstrings as comments instead of C
strings.
* DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments.
* builtins.h: Include builtin-defun-decls.h unconditionally.
* defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration.
(DEFALIAS): Always expand to nothing.
* defun-dld.h: No special macro expansions for MAKE_BUILTINS.
(DEFUN_DLD): Use FORWARD_DECLARE_FUN.
(DEFUNX_DLD): Use FORWARD_DECLARE_FUNX.
* defun-int.h: No special macro expansions for MAKE_BUILTINS.
(FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros.
(DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass
"external-doc" to DEFINE_FUNX_INSTALLER_FUN.
(DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL,
DEFALIAS_INTERNAL): Delete.
* common.mk (move_if_change_rule): New macro.
(simple_move_if_change_rule): Define using move_if_change_rule.
* find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file
name extension to ".df".
* libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files.
* mkbuiltins: New argument, SRCDIR. Operate directly on source files.
* mkdefs: Delete.
* libinterp/module.mk (BUILT_SOURCES): Update list to contain only
files included in other source files.
(GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete.
(LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here.
(LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from
the list.
(libinterp_EXTRA_DIST): Remove mkdefs from the list.
(FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES.
(DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES.
(SRC_DEFUN_FILES): Rename from SRC_DEF_FILES.
(ALL_DEFUN_FILES): Rename from ALL_DEF_FILES.
(%.df: %.cc): Delete pattern rule.
(libinterp/build-env-features.cc, libinterp/builtins.cc,
libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change.
(libinterp/builtins.cc, libinterp/builtin-defun-decls.h):
Update mkbuiltins command.
($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command.
* liboctave/module.mk (BUILT_SOURCES): Don't include
liboctave-build-info.cc in the list.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 21 Jun 2016 16:07:51 -0400 |
| parents | b571fc85953f |
| children | 78000c426b73 |
| rev | line source |
|---|---|
| 525 | 1 /* |
| 2 | |
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19593
diff
changeset
|
3 Copyright (C) 1994-2015 John W. Eaton |
| 525 | 4 |
| 5 This file is part of Octave. | |
| 6 | |
| 7 Octave is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 525 | 11 |
| 12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 7016 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 525 | 20 |
| 21 */ | |
| 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 | 24 #define octave_defun_int_h 1 |
| 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 | 28 #include <string> |
| 29 | |
| 3145 | 30 #include "ov-builtin.h" |
| 3325 | 31 #include "ov-dld-fcn.h" |
| 3145 | 32 #include "symtab.h" |
| 3015 | 33 #include "version.h" |
| 34 | |
| 2968 | 35 class octave_value; |
| 36 | |
| 6109 | 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 | 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 | 42 |
| 6109 | 43 extern OCTINTERP_API void |
| 3523 | 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 | 46 bool can_hide_function = true); |
| 2968 | 47 |
| 6109 | 48 extern OCTINTERP_API void |
| 3523 | 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 | 51 bool relative = false); |
| 703 | 52 |
| 6109 | 53 extern OCTINTERP_API void |
| 5864 | 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 | 56 |
| 6109 | 57 extern OCTINTERP_API void |
| 3523 | 58 alias_builtin (const std::string& alias, const std::string& name); |
| 703 | 59 |
|
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
60 // 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
|
61 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
|
62 get_current_shlib (void); |
|
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
63 |
|
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
64 // 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
|
65 // 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
|
66 // 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
|
67 |
|
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
68 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
|
69 { |
|
10641
ed6969880316
preliminary onCleanup support
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
70 public: |
|
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
71 octave_auto_shlib (void) |
|
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
72 : octave::dynamic_library (get_current_shlib ()) { } |
|
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
73 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
|
74 : octave::dynamic_library (shl) { } |
|
9960
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
75 }; |
|
5f3c10ecb150
implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
76 |
|
10887
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
77 extern OCTINTERP_API bool |
|
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
78 defun_isargout (int, int); |
|
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
79 |
|
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
80 extern OCTINTERP_API void |
|
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
81 defun_isargout (int, int, bool *); |
|
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10641
diff
changeset
|
82 |
|
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
83 #define FORWARD_DECLARE_FUNX(name) \ |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
84 extern OCTAVE_EXPORT octave_value_list \ |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
85 name (const octave_value_list& = octave_value_list (), int = 0) |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
86 |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
87 #define FORWARD_DECLARE_FUN(name) \ |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
88 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
|
89 |
| 3743 | 90 #define DECLARE_FUNX(name, args_name, nargout_name) \ |
|
15421
cd6ce11b9c57
backout changeset 2e5ba861898f
John W. Eaton <jwe@octave.org>
parents:
15398
diff
changeset
|
91 OCTAVE_EXPORT octave_value_list \ |
|
cd6ce11b9c57
backout changeset 2e5ba861898f
John W. Eaton <jwe@octave.org>
parents:
15398
diff
changeset
|
92 name (const octave_value_list& args_name, int nargout_name) |
| 3743 | 93 |
| 94 #define DECLARE_FUN(name, args_name, nargout_name) \ | |
| 95 DECLARE_FUNX (F ## name, args_name, nargout_name) | |
| 2968 | 96 |
| 3325 | 97 // Define the code that will be used to insert the new function into |
| 98 // the symbol table. We look for this name instead of the actual | |
| 3523 | 99 // function so that we can easily install the doc std::string too. |
| 3325 | 100 |
|
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
101 typedef bool (*octave_dld_fcn_installer) (const octave::dynamic_library&, bool relative); |
| 3325 | 102 |
|
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17787
diff
changeset
|
103 typedef octave_function * |
|
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
104 (*octave_dld_fcn_getter) (const octave::dynamic_library&, bool relative); |
| 7336 | 105 |
|
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
106 #if defined (OCTAVE_SOURCE) |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
107 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \ |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
108 DEFINE_FUNX_INSTALLER_FUN(#name, F ## name, G ## name, "external-doc") |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
109 #else |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
110 # define DEFINE_FUN_INSTALLER_FUN(name, doc) \ |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
111 DEFINE_FUNX_INSTALLER_FUN(#name, F ## name, G ## name, doc) |
|
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
112 #endif |
| 5796 | 113 |
|
7996
6a7db240b3a3
configure.in: eliminate CXX_ABI and OCTAVE_CXX_PREPEND_UNDERSCORE
John W. Eaton <jwe@octave.org>
parents:
7503
diff
changeset
|
114 #define DEFINE_FUNX_INSTALLER_FUN(name, fname, gname, doc) \ |
| 7336 | 115 extern "C" \ |
| 116 OCTAVE_EXPORT \ | |
| 117 octave_function * \ | |
|
21750
6720e5a220ba
use namespace for octave_shlib class
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
118 gname (const octave::dynamic_library& shl, bool relative) \ |
| 7336 | 119 { \ |
| 120 check_version (OCTAVE_API_VERSION, name); \ | |
| 121 \ | |
|
20545
c547458dc10e
eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
122 octave_dld_function *fcn = octave_dld_function::create (fname, shl, name, doc); \ |
| 7336 | 123 \ |
|
20545
c547458dc10e
eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
124 if (relative) \ |
|
c547458dc10e
eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
125 fcn->mark_relative (); \ |
| 7336 | 126 \ |
|
20545
c547458dc10e
eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
127 return fcn; \ |
| 3325 | 128 } |
| 129 | |
|
20945
9d9270e2f98f
eliminate comments after preprocessor conditionals
John W. Eaton <jwe@octave.org>
parents:
20791
diff
changeset
|
130 #endif |