|
525
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 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 |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
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 |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
1315
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
525
|
20 |
|
|
21 */ |
|
|
22 |
|
|
23 #if !defined (octave_defun_h) |
|
|
24 #define octave_defun_h 1 |
|
|
25 |
|
|
26 #if defined (octave_defun_dld_h) |
|
|
27 #error defun.h and defun-dld.h both included in same file! |
|
|
28 #endif |
|
|
29 |
|
|
30 #include "defun-int.h" |
|
|
31 |
|
550
|
32 // Define a builtin variable. |
|
|
33 // |
|
1957
|
34 // name is the name of the variable, unquoted. |
|
1340
|
35 // |
|
|
36 // defn is the initial value for the variable. |
|
550
|
37 // |
|
1340
|
38 // protect is a flag that says whether it should be possible to give |
|
|
39 // the variable a new value. |
|
|
40 // |
|
550
|
41 // eternal is a flag that says whether it should be possible to |
|
|
42 // clear the variable. Most builtin variables are eternal, and |
|
|
43 // cannot be cleared. |
|
|
44 // |
|
3005
|
45 // chg_fcn is a pointer to a function that should be called whenever |
|
550
|
46 // this variable is given a new value. It can be 0 if there is no |
|
|
47 // function to call. See also the code in user-prefs.cc. |
|
|
48 // |
|
|
49 // doc is the simple help text for this variable. |
|
|
50 |
|
3258
|
51 #define DEFVAR(name, defn, chg_fcn, doc) \ |
|
|
52 DEFVAR_INTERNAL (#name, SBV_ ## name, defn, false, chg_fcn, doc) |
|
1957
|
53 |
|
3258
|
54 // Define a builtin constant `name' (which may be redefined, but will |
|
|
55 // retain its original value when cleared) and also an alias to it |
|
|
56 // called `__name__' (which may not be redefined). |
|
1957
|
57 |
|
3141
|
58 #define DEFCONST(name, defn, doc) \ |
|
3321
|
59 DEFCONST_INTERNAL (name, defn, doc) |
|
1957
|
60 |
|
|
61 // This one can be used when `name' cannot be used directly (if it is |
|
|
62 // already defined as a macro). In that case, name is already a |
|
3743
|
63 // quoted string, and the name of the structure must to be passed too. |
|
1957
|
64 |
|
3141
|
65 #define DEFCONSTX(name, sname, defn, doc) \ |
|
3321
|
66 DEFCONSTX_INTERNAL (name, sname, defn, doc) |
|
525
|
67 |
|
550
|
68 // Define a builtin function. |
|
|
69 // |
|
1957
|
70 // name is the name of the function, unqouted. |
|
550
|
71 // |
|
2086
|
72 // args_name is the name of the octave_value_list variable used to pass |
|
1957
|
73 // the argument list to this function. |
|
550
|
74 // |
|
1957
|
75 // nargout_name is the name of the int variable used to pass the |
|
|
76 // number of output arguments this function is expected to produce. |
|
550
|
77 // |
|
|
78 // doc is the simple help text for the function. |
|
|
79 |
|
1957
|
80 #define DEFUN(name, args_name, nargout_name, doc) \ |
|
2890
|
81 DEFUN_INTERNAL (name, args_name, nargout_name, false, doc) |
|
525
|
82 |
|
3743
|
83 // This one can be used when `name' cannot be used directly (if it is |
|
|
84 // already defined as a macro). In that case, name is already a |
|
|
85 // quoted string, and the internal name of the function must be passed |
|
|
86 // too (the convetion is to use a prefix of "F", so "foo" becomes "Ffoo"). |
|
|
87 |
|
|
88 #define DEFUNX(name, fname, args_name, nargout_name, doc) \ |
|
|
89 DEFUNX_INTERNAL (name, fname, args_name, nargout_name, false, doc) |
|
|
90 |
|
4208
|
91 // Define a builtin command-style function. |
|
550
|
92 // |
|
|
93 // This is like DEFUN, except that it defines a function that can be |
|
|
94 // called from the Octave language without using parenthesis to |
|
|
95 // surround the arguments). |
|
|
96 |
|
4208
|
97 #define DEFCMD(name, args_name, nargout_name, doc) \ |
|
2890
|
98 DEFUN_INTERNAL (name, args_name, nargout_name, true, doc) |
|
525
|
99 |
|
4208
|
100 // For backward compatibility. |
|
|
101 |
|
|
102 #define DEFUN_TEXT DEFCMD |
|
|
103 |
|
4234
|
104 // This is a function with a name that can't be hidden by a variable. |
|
|
105 #define DEFCONSTFUN(name, args_name, nargout_name, doc) \ |
|
|
106 DEFCONSTFUN_INTERNAL (name, args_name, nargout_name, true, doc) |
|
|
107 |
|
550
|
108 // Define a mapper function. |
|
|
109 // |
|
1957
|
110 // name is the name of the function, unquoqted. |
|
550
|
111 // |
|
2089
|
112 // ch_map is a pointer to a function that should be called for |
|
3249
|
113 // integer arguments that are expected to create integer results. |
|
2089
|
114 // (It's a kluge to handle character mappers like isalpha.) |
|
550
|
115 // |
|
3249
|
116 // d_b_map is a pointer to a function that should be called for real |
|
|
117 // arguments that are expected to create bool results. |
|
|
118 // |
|
|
119 // c_b_map is a pointer to a function that should be called for |
|
|
120 // complex arguments that are expected to create bool results. |
|
|
121 // |
|
550
|
122 // d_d_map is a pointer to a function that should be called for real |
|
|
123 // arguments that are expected to create real results. |
|
|
124 // |
|
|
125 // d_c_map is a pointer to a function that should be called for real |
|
|
126 // arguments that are expected to create complex results. |
|
|
127 // |
|
|
128 // c_c_map is a pointer to a function that should be called for |
|
|
129 // complex arguments that are expected to create complex results. |
|
|
130 // |
|
4668
|
131 // lo is the lower bound of the range for which real arguments |
|
|
132 // return real results (e.g., lo == 0 for sqrt). |
|
2089
|
133 // |
|
4668
|
134 // hi is the upper bound of the range for which real arguments |
|
|
135 // return real results (e.g., hi == Inf for sqrt). |
|
2089
|
136 // |
|
4100
|
137 // ch_map_flag has the following meanings for the ch_map function: |
|
|
138 // |
|
|
139 // 0 => this function returns a matrix of ones and zeros |
|
|
140 // 1 => this function returns a numeric matrix (any values) |
|
|
141 // 2 => this function returns a std::string array |
|
|
142 // |
|
2089
|
143 // can_ret_cmplx_for_real is a flag that says whether this function |
|
|
144 // can create a complex number given a real-valued argument |
|
|
145 // (e.g., sqrt (-1)). |
|
|
146 // |
|
550
|
147 // doc is the simple help text for the function. |
|
|
148 |
|
4100
|
149 #define DEFUN_MAPPER(name, ch_map, d_b_map, c_b_map, d_d_map, \ |
|
|
150 d_c_map, c_c_map, lo, hi, ch_map_flag, \ |
|
|
151 can_ret_cmplx_for_real, doc) \ |
|
|
152 DEFUN_MAPPER_INTERNAL (name, ch_map, d_b_map, c_b_map, d_d_map, \ |
|
|
153 d_c_map, c_c_map, lo, hi, ch_map_flag, \ |
|
|
154 can_ret_cmplx_for_real, doc) |
|
525
|
155 |
|
550
|
156 // Make alias another name for the existing function name. This macro |
|
|
157 // must be used in the same file where name is defined, after the |
|
|
158 // definition for name. |
|
525
|
159 |
|
4699
|
160 #define DEFALIAS(alias, name) \ |
|
|
161 DEFALIAS_INTERNAL (alias, name) |
|
525
|
162 |
|
|
163 #endif |
|
|
164 |
|
|
165 /* |
|
|
166 ;;; Local Variables: *** |
|
|
167 ;;; mode: C++ *** |
|
|
168 ;;; End: *** |
|
|
169 */ |
