annotate libinterp/corefcn/defun-int.h @ 20791:f7084eae3318

maint: Use Octave coding conventions for #if statements. * mk-opts.pl, dialog.h, find-files-dialog.h, find-files-model.h, file-editor-tab.h, octave-qscintilla.h, octave-txt-lexer.h, main-window.h, octave-cmd.h, octave-dock-widget.h, octave-gui.h, thread-manager.h, workspace-model.h, workspace-view.h, builtins.h, Cell.h, bitfcns.cc, c-file-ptr-stream.h, cdisplay.h, comment-list.h, cutils.h, data.h, debug.h, defaults.in.h, defun-dld.h, defun-int.h, defun.h, dirfns.h, display.h, dynamic-ld.h, error.h, event-queue.h, file-io.h, filter.cc, getrusage.cc, gl-render.h, gl2ps-renderer.h, graphics.in.h, gripes.h, help.h, hook-fcn.h, input.h, jit-ir.h, jit-typeinfo.h, jit-util.h, load-path.h, load-save.h, ls-ascii-helper.h, ls-hdf5.h, ls-mat-ascii.h, ls-mat4.h, ls-mat5.h, ls-oct-binary.h, ls-oct-text.h, ls-utils.h, oct-errno.h, oct-fstrm.h, oct-handle.h, oct-hdf5-types.h, oct-hdf5.h, oct-hist.h, oct-iostrm.h, oct-lvalue.h, oct-map.h, oct-obj.h, oct-prcstrm.h, oct-procbuf.h, oct-stdstrm.h, oct-stream.h, oct-strstrm.h, oct.h, octave-link.h, pager.h, pr-output.h, procstream.h, profiler.h, pt-jit.h, sighandlers.cc, sighandlers.h, siglist.h, sparse-xdiv.h, sparse-xpow.h, symtab.h, syscalls.cc, sysdep.h, toplev.cc, toplev.h, utils.h, variables.h, workspace-element.h, xdiv.h, xnorm.h, xpow.h, dmperm.cc, oct-qhull.h, mkbuiltins, oct-conf.in.h, ov-base-diag.h, ov-base-int.h, ov-base-mat.h, ov-base-scalar.h, ov-base-sparse.h, ov-base.h, ov-bool-mat.h, ov-bool-sparse.h, ov-bool.h, ov-builtin.h, ov-cell.h, ov-ch-mat.h, ov-class.h, ov-classdef.h, ov-colon.h, ov-complex.h, ov-cs-list.h, ov-cx-diag.h, ov-cx-mat.h, ov-cx-sparse.h, ov-dld-fcn.h, ov-fcn-handle.h, ov-fcn-inline.h, ov-fcn.h, ov-float.h, ov-flt-complex.h, ov-flt-cx-diag.h, ov-flt-cx-mat.h, ov-flt-re-diag.h, ov-flt-re-mat.h, ov-int-traits.h, ov-int16.h, ov-int32.h, ov-int64.h, ov-int8.h, ov-java.h, ov-lazy-idx.h, ov-mex-fcn.h, ov-null-mat.h, ov-perm.h, ov-range.h, ov-re-diag.h, ov-re-mat.h, ov-re-sparse.h, ov-scalar.h, ov-str-mat.h, ov-struct.h, ov-type-conv.h, ov-typeinfo.h, ov-uint16.h, ov-uint32.h, ov-uint64.h, ov-uint8.h, ov-usr-fcn.h, ov.h, octave.h, ops.h, options-usage.h, lex.h, parse.h, pt-all.h, pt-arg-list.h, pt-array-list.h, pt-assign.h, pt-binop.h, pt-bp.h, pt-cbinop.h, pt-cell.h, pt-check.h, pt-classdef.h, pt-cmd.h, pt-colon.h, pt-const.h, pt-decl.h, pt-eval.h, pt-except.h, pt-exp.h, pt-fcn-handle.h, pt-funcall.h, pt-id.h, pt-idx.h, pt-jump.h, pt-loop.h, pt-mat.h, pt-misc.h, pt-pr-code.h, pt-select.h, pt-stmt.h, pt-unop.h, pt-walk.h, pt.h, token.h, version.in.h, Array-util.h, Array.h, CColVector.h, CDiagMatrix.h, CMatrix.h, CNDArray.h, CRowVector.h, CSparse.h, DiagArray2.h, MArray-decl.h, MArray-defs.h, MArray.h, MDiagArray2.h, MSparse.h, Matrix.h, MatrixType.h, PermMatrix.h, Range.h, Sparse.h, boolMatrix.h, boolNDArray.h, boolSparse.h, chMatrix.h, chNDArray.h, dColVector.h, dDiagMatrix.h, dMatrix.h, dNDArray.h, dRowVector.h, dSparse.h, dim-vector.h, fCColVector.h, fCDiagMatrix.h, fCMatrix.h, fCNDArray.h, fCRowVector.h, fColVector.h, fDiagMatrix.h, fMatrix.h, fNDArray.h, fRowVector.h, idx-vector.h, int16NDArray.h, int32NDArray.h, int64NDArray.h, int8NDArray.h, intNDArray.h, uint16NDArray.h, uint32NDArray.h, uint64NDArray.h, uint8NDArray.h, f77-fcn.h, lo-error.h, quit.h, CmplxAEPBAL.h, CmplxCHOL.h, CmplxGEPBAL.h, CmplxHESS.h, CmplxLU.h, CmplxQR.h, CmplxQRP.h, CmplxSCHUR.h, CmplxSVD.h, CollocWt.h, DAE.h, DAEFunc.h, DAERT.h, DAERTFunc.h, DASPK.h, DASRT.h, DASSL.h, DET.h, EIG.h, LSODE.h, ODE.h, ODEFunc.h, ODES.h, ODESFunc.h, Quad.h, SparseCmplxCHOL.h, SparseCmplxLU.h, SparseCmplxQR.cc, SparseCmplxQR.h, SparseQR.h, SparsedbleCHOL.h, SparsedbleLU.h, base-aepbal.h, base-dae.h, base-de.h, base-lu.h, base-min.h, base-qr.h, bsxfun-decl.h, bsxfun-defs.cc, bsxfun.h, dbleAEPBAL.h, dbleCHOL.h, dbleGEPBAL.h, dbleHESS.h, dbleLU.h, dbleQR.h, dbleQRP.h, dbleSCHUR.h, dbleSVD.h, eigs-base.cc, fCmplxAEPBAL.h, fCmplxCHOL.h, fCmplxGEPBAL.h, fCmplxHESS.h, fCmplxLU.h, fCmplxQR.h, fCmplxQRP.h, fCmplxSCHUR.h, fCmplxSVD.h, fEIG.h, floatAEPBAL.h, floatCHOL.h, floatGEPBAL.h, floatHESS.h, floatLU.h, floatQR.h, floatQRP.h, floatSCHUR.h, floatSVD.h, lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, oct-convn.h, oct-fftw.h, oct-norm.h, oct-rand.h, oct-spparms.h, randmtzig.c, sparse-base-chol.h, sparse-base-lu.h, sparse-dmsolve.cc, Sparse-diag-op-defs.h, Sparse-op-decls.h, Sparse-op-defs.h, Sparse-perm-op-defs.h, mk-ops.awk, mx-base.h, mx-defs.h, mx-ext.h, mx-inlines.cc, mx-op-decl.h, mx-op-defs.h, sparse-mk-ops.awk, dir-ops.h, file-ops.h, file-stat.h, lo-sysdep.h, mach-info.h, oct-env.h, oct-group.h, oct-openmp.h, oct-passwd.h, oct-syscalls.h, oct-time.cc, oct-time.h, oct-uname.h, pathlen.h, sysdir.h, syswait.h, action-container.h, base-list.h, byte-swap.h, caseless-str.h, cmd-edit.h, cmd-hist.h, data-conv.h, functor.h, glob-match.h, kpse.cc, lo-array-gripes.h, lo-cutils.h, lo-ieee.h, lo-macros.h, lo-math.h, lo-regexp.h, lo-traits.h, lo-utils.h, oct-alloc.h, oct-base64.h, oct-binmap.h, oct-cmplx.h, oct-glob.h, oct-inttypes.h, oct-locbuf.h, oct-mutex.h, oct-refcount.h, oct-rl-edit.h, oct-rl-hist.h, oct-shlib.h, oct-sort.h, oct-sparse.h, pathsearch.h, singleton-cleanup.h, sparse-sort.h, sparse-util.h, statdefs.h, str-vec.h, sun-utils.h, unwind-prot.h, url-transfer.h: Use Octave coding conventions for #if statements.
author Rik <rik@octave.org>
date Thu, 03 Dec 2015 10:23:38 -0800
parents c547458dc10e
children 9d9270e2f98f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
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
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
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6323
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6323
diff changeset
10 option) any later version.
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
11
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
15 for more details.
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
2968
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe]
jwe
parents: 2954
diff changeset
26 #include <string>
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe]
jwe
parents: 2954
diff changeset
27
3145
0d640dc625c7 [project @ 1998-02-05 08:44:59 by jwe]
jwe
parents: 3096
diff changeset
28 #include "ov-builtin.h"
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
29 #include "ov-dld-fcn.h"
3145
0d640dc625c7 [project @ 1998-02-05 08:44:59 by jwe]
jwe
parents: 3096
diff changeset
30 #include "symtab.h"
3015
2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe]
jwe
parents: 3014
diff changeset
31 #include "version.h"
2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe]
jwe
parents: 3014
diff changeset
32
2968
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe]
jwe
parents: 2954
diff changeset
33 class octave_value;
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe]
jwe
parents: 2954
diff changeset
34
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
35 extern OCTINTERP_API void print_usage (void);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents: 7996
diff changeset
36 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
37
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
38 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
39 const std::string& fcn);
3015
2e114e914b77 [project @ 1997-06-02 21:03:55 by jwe]
jwe
parents: 3014
diff changeset
40
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
41 extern OCTINTERP_API void
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3364
diff changeset
42 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
43 const std::string& file, const std::string& doc,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
44 bool can_hide_function = true);
2968
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe]
jwe
parents: 2954
diff changeset
45
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
46 extern OCTINTERP_API void
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3364
diff changeset
47 install_dld_function (octave_dld_function::fcn f, const std::string& name,
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
48 const octave_shlib& shl, const std::string& doc,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
49 bool relative = false);
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
50
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
51 extern OCTINTERP_API void
5864
e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe]
jwe
parents: 5823
diff changeset
52 install_mex_function (void *fptr, bool fmex, const std::string& name,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
53 const octave_shlib& shl, bool relative = false);
5864
e884ab4f29ee [project @ 2006-06-22 00:57:27 by jwe]
jwe
parents: 5823
diff changeset
54
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
55 extern OCTINTERP_API void
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3364
diff changeset
56 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
57
9960
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
58 // Gets the shlib of the currently executing DLD function, if any.
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
59 extern OCTINTERP_API octave_shlib
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
60 get_current_shlib (void);
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
61
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
62 // This is a convenience class that calls the above function automatically at
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
63 // construction time. When deriving new classes, you can either use it as a
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
64 // 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
65
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
66 class octave_auto_shlib : public octave_shlib
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
67 {
10641
ed6969880316 preliminary onCleanup support
Jaroslav Hajek <highegg@gmail.com>
parents: 10313
diff changeset
68 public:
9960
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
69 octave_auto_shlib (void)
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
70 : octave_shlib (get_current_shlib ()) { }
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
71 octave_auto_shlib (const octave_shlib& shl)
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
72 : octave_shlib (shl) { }
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
73 };
5f3c10ecb150 implement get_current_shlib and octave_auto_shlib
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
74
10887
f10d0bc8f9cc make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents: 10641
diff changeset
75 extern OCTINTERP_API bool
f10d0bc8f9cc make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents: 10641
diff changeset
76 defun_isargout (int, int);
f10d0bc8f9cc make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents: 10641
diff changeset
77
f10d0bc8f9cc make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents: 10641
diff changeset
78 extern OCTINTERP_API void
f10d0bc8f9cc make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents: 10641
diff changeset
79 defun_isargout (int, int, bool *);
f10d0bc8f9cc make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents: 10641
diff changeset
80
3743
35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe]
jwe
parents: 3741
diff changeset
81 #define DECLARE_FUNX(name, args_name, nargout_name) \
15421
cd6ce11b9c57 backout changeset 2e5ba861898f
John W. Eaton <jwe@octave.org>
parents: 15398
diff changeset
82 OCTAVE_EXPORT octave_value_list \
cd6ce11b9c57 backout changeset 2e5ba861898f
John W. Eaton <jwe@octave.org>
parents: 15398
diff changeset
83 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
84
35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe]
jwe
parents: 3741
diff changeset
85 #define DECLARE_FUN(name, args_name, nargout_name) \
35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe]
jwe
parents: 3741
diff changeset
86 DECLARE_FUNX (F ## name, args_name, nargout_name)
2968
e330cb788508 [project @ 1997-05-15 17:40:29 by jwe]
jwe
parents: 2954
diff changeset
87
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
88 // 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
89 // 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
90 // 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
91
6323
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6109
diff changeset
92 typedef bool (*octave_dld_fcn_installer) (const octave_shlib&, bool relative);
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
93
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
94 typedef octave_function *
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
95 (*octave_dld_fcn_getter) (const octave_shlib&, bool relative);
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7101
diff changeset
96
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
97 #define DEFINE_FUN_INSTALLER_FUN(name, doc) \
7996
6a7db240b3a3 configure.in: eliminate CXX_ABI and OCTAVE_CXX_PREPEND_UNDERSCORE
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
98 DEFINE_FUNX_INSTALLER_FUN(#name, F ## name, G ## name, doc)
5796
20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe]
jwe
parents: 5794
diff changeset
99
7996
6a7db240b3a3 configure.in: eliminate CXX_ABI and OCTAVE_CXX_PREPEND_UNDERSCORE
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
100 #define DEFINE_FUNX_INSTALLER_FUN(name, fname, gname, doc) \
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7101
diff changeset
101 extern "C" \
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7101
diff changeset
102 OCTAVE_EXPORT \
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7101
diff changeset
103 octave_function * \
7996
6a7db240b3a3 configure.in: eliminate CXX_ABI and OCTAVE_CXX_PREPEND_UNDERSCORE
John W. Eaton <jwe@octave.org>
parents: 7503
diff changeset
104 gname (const octave_shlib& shl, bool relative) \
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7101
diff changeset
105 { \
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7101
diff changeset
106 check_version (OCTAVE_API_VERSION, name); \
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7101
diff changeset
107 \
20545
c547458dc10e eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents: 19697
diff changeset
108 octave_dld_function *fcn = octave_dld_function::create (fname, shl, name, doc); \
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7101
diff changeset
109 \
20545
c547458dc10e eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents: 19697
diff changeset
110 if (relative) \
c547458dc10e eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents: 19697
diff changeset
111 fcn->mark_relative (); \
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7101
diff changeset
112 \
20545
c547458dc10e eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents: 19697
diff changeset
113 return fcn; \
3325
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
114 }
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe]
jwe
parents: 3321
diff changeset
115
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
116 // MAKE_BUILTINS is defined to extract function names and related
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
117 // information and create the *.df files that are eventually used to
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
118 // create the builtins.cc file.
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
119
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
120 #if defined (MAKE_BUILTINS)
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
121
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
122 // Generate code to install name in the symbol table. The script
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
123 // mkdefs will create a .def file for every .cc file that uses DEFUN,
4208
e96f52432059 [project @ 2002-12-03 19:48:57 by jwe]
jwe
parents: 4165
diff changeset
124 // or DEFCMD.
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
125
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
126 #define DEFUN_INTERNAL(name, args_name, nargout_name, doc) \
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
127 BEGIN_INSTALL_BUILTIN \
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
128 XDEFUN_INTERNAL (name, args_name, nargout_name, doc) \
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
129 END_INSTALL_BUILTIN
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
130
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
131 #define DEFCONSTFUN_INTERNAL(name, args_name, nargout_name, doc) \
4234
90e44267e8cf [project @ 2002-12-21 17:15:25 by jwe]
jwe
parents: 4208
diff changeset
132 BEGIN_INSTALL_BUILTIN \
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
133 XDEFCONSTFUN_INTERNAL (name, args_name, nargout_name, doc) \
4234
90e44267e8cf [project @ 2002-12-21 17:15:25 by jwe]
jwe
parents: 4208
diff changeset
134 END_INSTALL_BUILTIN
90e44267e8cf [project @ 2002-12-21 17:15:25 by jwe]
jwe
parents: 4208
diff changeset
135
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
136 #define DEFUNX_INTERNAL(name, fname, args_name, nargout_name, doc) \
3743
35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe]
jwe
parents: 3741
diff changeset
137 BEGIN_INSTALL_BUILTIN \
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
138 XDEFUNX_INTERNAL (name, fname, args_name, nargout_name, doc) \
3743
35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe]
jwe
parents: 3741
diff changeset
139 END_INSTALL_BUILTIN
35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe]
jwe
parents: 3741
diff changeset
140
3364
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3325
diff changeset
141 // Generate code to install name in the symbol table. The script
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3325
diff changeset
142 // mkdefs will create a .def file for every .cc file that uses
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3325
diff changeset
143 // DEFUN_DLD.
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3325
diff changeset
144
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
145 #define DEFUN_DLD_INTERNAL(name, args_name, nargout_name, doc) \
3364
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3325
diff changeset
146 BEGIN_INSTALL_BUILTIN \
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
147 XDEFUN_DLD_INTERNAL (name, args_name, nargout_name, doc) \
3364
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3325
diff changeset
148 END_INSTALL_BUILTIN
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3325
diff changeset
149
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
150 #define DEFUNX_DLD_INTERNAL(name, fname, args_name, nargout_name, doc) \
5796
20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe]
jwe
parents: 5794
diff changeset
151 BEGIN_INSTALL_BUILTIN \
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
152 XDEFUNX_DLD_INTERNAL (name, fname, args_name, nargout_name, doc) \
5796
20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe]
jwe
parents: 5794
diff changeset
153 END_INSTALL_BUILTIN
20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe]
jwe
parents: 5794
diff changeset
154
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
155 // Generate code for making another name for an existing function.
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
156
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
157 #define DEFALIAS_INTERNAL(alias, name) \
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
158 BEGIN_INSTALL_BUILTIN \
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
159 XDEFALIAS_INTERNAL(alias, name) \
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
160 END_INSTALL_BUILTIN
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
161
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
162 #else /* ! MAKE_BUILTINS */
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
163
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
164 // Generate the first line of the function definition. This ensures
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
165 // that the internal functions all have the same signature.
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
166
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
167 #define DEFUN_INTERNAL(name, args_name, nargout_name, doc) \
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
168 DECLARE_FUN (name, args_name, nargout_name)
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
169
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
170 #define DEFCONSTFUN_INTERNAL(name, args_name, nargout_name, doc) \
4234
90e44267e8cf [project @ 2002-12-21 17:15:25 by jwe]
jwe
parents: 4208
diff changeset
171 DECLARE_FUN (name, args_name, nargout_name)
90e44267e8cf [project @ 2002-12-21 17:15:25 by jwe]
jwe
parents: 4208
diff changeset
172
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8575
diff changeset
173 #define DEFUNX_INTERNAL(name, fname, args_name, nargout_name, doc) \
3743
35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe]
jwe
parents: 3741
diff changeset
174 DECLARE_FUNX (fname, args_name, nargout_name)
35daf9714b9a [project @ 2000-11-30 00:19:10 by jwe]
jwe
parents: 3741
diff changeset
175
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
176 // No definition is required for an alias.
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
177
4699
5e2c68946f30 [project @ 2004-01-20 23:04:46 by jwe]
jwe
parents: 4448
diff changeset
178 #define DEFALIAS_INTERNAL(alias, name)
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
179
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
180 #endif /* ! MAKE_BUILTINS */
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 3258
diff changeset
181
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
182 #endif