Mercurial > octave
annotate libinterp/octave-value/ov-builtin.h @ 23446:cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
* make_int.cc, dialog.h, file-editor-interface.h, file-editor-tab.h,
file-editor.h, octave-txt-lexer.h, main-window.h, octave-dock-widget.h,
parser.h, webinfo.h, resource-manager.h, thread-manager.h, c-file-ptr-stream.h,
call-stack.h, comment-list.h, ft-text-renderer.h, gl-render.cc, input.h,
mex.cc, mexproto.h, mxarray.in.h, oct-fstrm.h, oct-iostrm.h, oct-procbuf.h,
oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.h, octave-link.h,
sighandlers.cc, symtab.h, sysdep.h, utils.h, audiodevinfo.cc, ov-base-diag.h,
ov-base-int.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.cc, ov-complex.h, ov-cs-list.h,
ov-cx-diag.h, ov-cx-mat.h, ov-cx-sparse.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-intx.h, ov-java.cc, ov-java.h,
ov-lazy-idx.h, ov-mex-fcn.h, ov-oncleanup.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-usr-fcn.h, ov.h, octave.h, bp-table.h, jit-ir.h,
jit-typeinfo.h, jit-util.h, lex.h, parse.h, pt-arg-list.h, pt-array-list.h,
pt-assign.h, pt-binop.h, pt-cell.h, pt-classdef.h, pt-cmd.h, pt-colon.h,
pt-const.h, pt-decl.h, pt-except.h, pt-exp.h, pt-fcn-handle.h, pt-funcall.h,
pt-id.h, pt-idx.h, pt-jit.h, pt-jump.h, pt-loop.h, pt-mat.h, pt-misc.h,
pt-select.h, pt-stmt.h, pt-unop.h, token.h, Array.cc, Array.h, DiagArray2.h,
Sparse.h, dim-vector.h, idx-vector.h, sparse-chol.cc, cmd-edit.cc, cmd-edit.h,
lo-array-errwarn.cc, lo-array-errwarn.h, lo-array-gripes.cc, lo-utils.h,
oct-inttypes.h, oct-locbuf.h, oct-refcount.h, oct-rl-edit.h, oct-rl-hist.h,
oct-shlib.cc, oct-shlib.h, str-vec.h, canonicalize-file-name-wrapper.h,
dirent-wrappers.h, getopt-wrapper.h, glob-wrappers.h, localcharset-wrapper.h,
set-program-name-wrapper.h, signal-wrappers.h, strdup-wrapper.h,
tmpfile-wrapper.h, unistd-wrappers.h, display-available.h:
Use convention 'void * fcn ()' for functions which return pointers.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 27 Apr 2017 09:48:57 -0700 |
parents | 092078913d54 |
children | 73558a835b64 |
rev | line source |
---|---|
2974 | 1 /* |
2 | |
23219
3ac9f9ecfae5
maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents:
23083
diff
changeset
|
3 Copyright (C) 1996-2017 John W. Eaton |
2974 | 4 |
5 This file is part of Octave. | |
6 | |
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. |
2974 | 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. |
2974 | 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/>. | |
2974 | 20 |
21 */ | |
22 | |
20791
f7084eae3318
maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
23 #if ! defined (octave_ov_builtin_h) |
17822
ebb3ef964372
maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents:
17787
diff
changeset
|
24 #define octave_ov_builtin_h 1 |
2974 | 25 |
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
21017
diff
changeset
|
26 #include "octave-config.h" |
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
21017
diff
changeset
|
27 |
22897
4090c32fccf8
store set of dispatch classes in built-in function objects
John W. Eaton <jwe@octave.org>
parents:
22869
diff
changeset
|
28 #include <list> |
4090c32fccf8
store set of dispatch classes in built-in function objects
John W. Eaton <jwe@octave.org>
parents:
22869
diff
changeset
|
29 #include <set> |
2974 | 30 #include <string> |
31 | |
32 #include "ov-fcn.h" | |
33 #include "ov-typeinfo.h" | |
34 | |
35 class octave_value; | |
36 class octave_value_list; | |
14973 | 37 class jit_type; |
2974 | 38 |
39 // Builtin functions. | |
40 | |
41 class | |
7349 | 42 OCTINTERP_API |
2974 | 43 octave_builtin : public octave_function |
44 { | |
45 public: | |
46 | |
15004
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14974
diff
changeset
|
47 octave_builtin (void) : octave_function (), f (0), file (), jtype (0) { } |
4642 | 48 |
2974 | 49 typedef octave_value_list (*fcn) (const octave_value_list&, int); |
50 | |
21017
93748bcaec17
maint: Replace emtpy 'std::string ()' calls with "".
Rik <rik@octave.org>
parents:
20791
diff
changeset
|
51 octave_builtin (fcn ff, const std::string& nm = "", |
93748bcaec17
maint: Replace emtpy 'std::string ()' calls with "".
Rik <rik@octave.org>
parents:
20791
diff
changeset
|
52 const std::string& ds = "") |
15004
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14974
diff
changeset
|
53 : octave_function (nm, ds), f (ff), file (), jtype (0) { } |
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14974
diff
changeset
|
54 |
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14974
diff
changeset
|
55 octave_builtin (fcn ff, const std::string& nm, const std::string& fnm, |
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14974
diff
changeset
|
56 const std::string& ds) |
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14974
diff
changeset
|
57 : octave_function (nm, ds), f (ff), file (fnm), jtype (0) { } |
2974 | 58 |
22869
f75d289645ec
make deleted functions public
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
59 // No copying! |
f75d289645ec
make deleted functions public
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
60 |
f75d289645ec
make deleted functions public
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
61 octave_builtin (const octave_builtin& ob) = delete; |
f75d289645ec
make deleted functions public
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
62 |
f75d289645ec
make deleted functions public
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
63 octave_builtin& operator = (const octave_builtin& ob) = delete; |
f75d289645ec
make deleted functions public
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
64 |
22868
87e3163f6c87
use c++11 "= default" syntax for declaration of trivial destructors
John W. Eaton <jwe@octave.org>
parents:
22865
diff
changeset
|
65 ~octave_builtin (void) = default; |
2974 | 66 |
15005
74c7265c057a
fix failure with function handles caused by changeset ea6997657614
John W. Eaton <jwe@octave.org>
parents:
15004
diff
changeset
|
67 std::string src_file_name (void) const { return file; } |
15004
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14974
diff
changeset
|
68 |
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7349
diff
changeset
|
69 octave_value subsref (const std::string& type, |
10313 | 70 const std::list<octave_value_list>& idx) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
71 { |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
72 octave_value_list tmp = subsref (type, idx, 1); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
73 return tmp.length () > 0 ? tmp(0) : octave_value (); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
74 } |
4271 | 75 |
4247 | 76 octave_value_list subsref (const std::string& type, |
10313 | 77 const std::list<octave_value_list>& idx, |
78 int nargout); | |
3933 | 79 |
10887
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
80 octave_value_list subsref (const std::string& type, |
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
81 const std::list<octave_value_list>& idx, |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
82 int nargout, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
83 const std::list<octave_lvalue>* lvalue_list); |
10887
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
84 |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
85 octave_function * function_value (bool = false) { return this; } |
2974 | 86 |
3325 | 87 bool is_builtin_function (void) const { return true; } |
88 | |
3544 | 89 octave_value_list |
90 do_multi_index_op (int nargout, const octave_value_list& args); | |
2974 | 91 |
10887
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
92 octave_value_list |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
93 do_multi_index_op (int nargout, const octave_value_list& args, |
10887
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
94 const std::list<octave_lvalue>* lvalue_list); |
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
95 |
23446
cd4e1ee28716
maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
96 jit_type * to_jit (void) const; |
14973 | 97 |
98 void stash_jit (jit_type& type); | |
99 | |
14974
e3cd4c9d7ccc
Generalize builtin specification in JIT and add support for cos and exp
Max Brister <max@2bass.com>
parents:
14973
diff
changeset
|
100 fcn function (void) const; |
e3cd4c9d7ccc
Generalize builtin specification in JIT and add support for cos and exp
Max Brister <max@2bass.com>
parents:
14973
diff
changeset
|
101 |
22897
4090c32fccf8
store set of dispatch classes in built-in function objects
John W. Eaton <jwe@octave.org>
parents:
22869
diff
changeset
|
102 void push_dispatch_class (const std::string& dispatch_type); |
4090c32fccf8
store set of dispatch classes in built-in function objects
John W. Eaton <jwe@octave.org>
parents:
22869
diff
changeset
|
103 |
4090c32fccf8
store set of dispatch classes in built-in function objects
John W. Eaton <jwe@octave.org>
parents:
22869
diff
changeset
|
104 bool handles_dispatch_class (const std::string& dispatch_type) const; |
4090c32fccf8
store set of dispatch classes in built-in function objects
John W. Eaton <jwe@octave.org>
parents:
22869
diff
changeset
|
105 |
10887
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
106 static const std::list<octave_lvalue> *curr_lvalue_list; |
f10d0bc8f9cc
make isargout available to DEFUNs
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
107 |
3325 | 108 protected: |
109 | |
110 // A pointer to the actual function. | |
111 fcn f; | |
112 | |
15004
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14974
diff
changeset
|
113 // The name of the file where this function was defined. |
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14974
diff
changeset
|
114 std::string file; |
ea6997657614
which: provide source file name for built-in functions
John W. Eaton <jwe@octave.org>
parents:
14974
diff
changeset
|
115 |
22897
4090c32fccf8
store set of dispatch classes in built-in function objects
John W. Eaton <jwe@octave.org>
parents:
22869
diff
changeset
|
116 // The types this function has been declared to handle (if any). |
4090c32fccf8
store set of dispatch classes in built-in function objects
John W. Eaton <jwe@octave.org>
parents:
22869
diff
changeset
|
117 std::set<std::string> dispatch_classes; |
4090c32fccf8
store set of dispatch classes in built-in function objects
John W. Eaton <jwe@octave.org>
parents:
22869
diff
changeset
|
118 |
14973 | 119 // A pointer to the jit type that represents the function. |
120 jit_type *jtype; | |
121 | |
2974 | 122 private: |
123 | |
4612 | 124 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
2974 | 125 }; |
126 | |
127 #endif |