Mercurial > hg > octave-nkf
annotate src/mexproto.h @ 10127:f21fdff5c906
Change signature of mexPrintf.
author | David Grundberg <davidg@cs.umu.se> |
---|---|
date | Mon, 18 Jan 2010 11:52:38 +0100 |
parents | 8687ce1c56da |
children | cd96d29c5efa |
rev | line source |
---|---|
5864 | 1 /* |
2 | |
8920 | 3 Copyright (C) 2006, 2007, 2008 Paul Kienzle |
5864 | 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. | |
5864 | 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/>. | |
5864 | 20 |
21 */ | |
22 | |
23 /* | |
24 | |
25 This code was originally distributed as part of Octave Forge under | |
6064 | 26 the following terms: |
5864 | 27 |
28 Author: Paul Kienzle | |
29 I grant this code to the public domain. | |
30 2001-03-22 | |
31 | |
32 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |
33 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
34 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
35 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |
36 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
37 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
38 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
39 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
40 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
41 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
42 SUCH DAMAGE. | |
43 | |
44 */ | |
45 | |
46 /* mex.h is for use in C-programs only; do NOT include it in mex.cc */ | |
47 | |
48 #if ! defined (MEXPROTO_H) | |
49 #define MEXPROTO_H | |
50 | |
51 #if defined (__cplusplus) | |
5900 | 52 #include <cstdlib> |
5864 | 53 extern "C" { |
5900 | 54 #else |
55 #include <stdlib.h> | |
5864 | 56 #endif |
57 | |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
58 /* The definition of OCTINTERP_API is normally provided by Octave's |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
59 config.h file. This is provided for the case of mex.h included by |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
60 user programs that don't use Octave's config.h. */ |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
61 #if ! defined (OCTINTERP_API) |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
62 #if defined (_MSC_VER) |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
63 #define OCTINTERP_API __declspec(dllimport) |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
64 #else |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
65 /* All other compilers, at least for now. */ |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
66 #define OCTINTERP_API |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
67 #endif |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
68 #endif |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
69 |
5900 | 70 #define MXARRAY_TYPEDEFS_ONLY |
71 #include "mxarray.h" | |
72 #undef MXARRAY_TYPEDEFS_ONLY | |
73 | |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
74 /* Interface to the interpreter. */ |
6109 | 75 extern OCTINTERP_API const char *mexFunctionName (void); |
5864 | 76 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
77 extern OCTINTERP_API int mexCallMATLAB (int nargout, mxArray *argout[], int nargin, mxArray *argin[], const char *fname); |
5864 | 78 |
6109 | 79 extern OCTINTERP_API void mexSetTrapFlag (int flag); |
80 extern OCTINTERP_API int mexEvalString (const char *s); | |
81 extern OCTINTERP_API void mexErrMsgTxt (const char *s); | |
6338 | 82 extern OCTINTERP_API void mexErrMsgIdAndTxt (const char *id, const char *s, ...); |
6109 | 83 extern OCTINTERP_API void mexWarnMsgTxt (const char *s); |
6338 | 84 extern OCTINTERP_API void mexWarnMsgIdAndTxt (const char *id, const char *s, ...); |
10127
f21fdff5c906
Change signature of mexPrintf.
David Grundberg <davidg@cs.umu.se>
parents:
10126
diff
changeset
|
85 extern OCTINTERP_API int mexPrintf (const char *fmt, ...); |
5864 | 86 |
6109 | 87 extern OCTINTERP_API mxArray *mexGetVariable (const char *space, const char *name); |
88 extern OCTINTERP_API const mxArray *mexGetVariablePtr (const char *space, const char *name); | |
5864 | 89 |
6109 | 90 extern OCTINTERP_API int mexPutVariable (const char *space, const char *name, mxArray *ptr); |
5864 | 91 |
6109 | 92 extern OCTINTERP_API void mexMakeArrayPersistent (mxArray *ptr); |
93 extern OCTINTERP_API void mexMakeMemoryPersistent (void *ptr); | |
5879 | 94 |
6109 | 95 extern OCTINTERP_API int mexAtExit (void (*f) (void)); |
96 extern OCTINTERP_API const mxArray *mexGet (double handle, const char *property); | |
97 extern OCTINTERP_API int mexIsGlobal (const mxArray *ptr); | |
98 extern OCTINTERP_API int mexIsLocked (void); | |
99 extern OCTINTERP_API void mexLock (void); | |
100 extern OCTINTERP_API int mexSet (double handle, const char *property, mxArray *val); | |
101 extern OCTINTERP_API void mexUnlock (void); | |
5900 | 102 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
103 /* Floating point predicates. */ |
6109 | 104 extern OCTINTERP_API int mxIsFinite (double v); |
105 extern OCTINTERP_API int mxIsInf (double v); | |
106 extern OCTINTERP_API int mxIsNaN (double v); | |
5900 | 107 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
108 /* Floating point values. */ |
6109 | 109 extern OCTINTERP_API double mxGetEps (void); |
110 extern OCTINTERP_API double mxGetInf (void); | |
111 extern OCTINTERP_API double mxGetNaN (void); | |
5900 | 112 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
113 /* Memory management. */ |
6109 | 114 extern OCTINTERP_API void *mxCalloc (size_t n, size_t size); |
115 extern OCTINTERP_API void *mxMalloc (size_t n); | |
116 extern OCTINTERP_API void *mxRealloc (void *ptr, size_t size); | |
117 extern OCTINTERP_API void mxFree (void *ptr); | |
5900 | 118 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
119 /* Constructors. */ |
6686 | 120 extern OCTINTERP_API mxArray *mxCreateCellArray (mwSize ndims, const mwSize *dims); |
121 extern OCTINTERP_API mxArray *mxCreateCellMatrix (mwSize m, mwSize n); | |
122 extern OCTINTERP_API mxArray *mxCreateCharArray (mwSize ndims, const mwSize *dims); | |
123 extern OCTINTERP_API mxArray *mxCreateCharMatrixFromStrings (mwSize m, const char **str); | |
124 extern OCTINTERP_API mxArray *mxCreateDoubleMatrix (mwSize nr, mwSize nc, mxComplexity flag); | |
6109 | 125 extern OCTINTERP_API mxArray *mxCreateDoubleScalar (double val); |
6686 | 126 extern OCTINTERP_API mxArray *mxCreateLogicalArray (mwSize ndims, const mwSize *dims); |
127 extern OCTINTERP_API mxArray *mxCreateLogicalMatrix (mwSize m, mwSize n); | |
7879
a017ca5a2f75
mexproto.h: fix mxCreateLogicalScalar decl
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
128 extern OCTINTERP_API mxArray *mxCreateLogicalScalar (mxLogical val); |
6686 | 129 extern OCTINTERP_API mxArray *mxCreateNumericArray (mwSize ndims, const mwSize *dims, mxClassID class_id, mxComplexity flag); |
130 extern OCTINTERP_API mxArray *mxCreateNumericMatrix (mwSize m, mwSize n, mxClassID class_id, mxComplexity flag); | |
131 extern OCTINTERP_API mxArray *mxCreateSparse (mwSize m, mwSize n, mwSize nzmax, mxComplexity flag); | |
132 extern OCTINTERP_API mxArray *mxCreateSparseLogicalMatrix (mwSize m, mwSize n, mwSize nzmax); | |
6109 | 133 extern OCTINTERP_API mxArray *mxCreateString (const char *str); |
6787 | 134 extern OCTINTERP_API mxArray *mxCreateStructArray (mwSize ndims, const mwSize *dims, int num_keys, const char **keys); |
6686 | 135 extern OCTINTERP_API mxArray *mxCreateStructMatrix (mwSize rows, mwSize cols, int num_keys, const char **keys); |
5900 | 136 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
137 /* Copy constructor. */ |
6109 | 138 extern OCTINTERP_API mxArray *mxDuplicateArray (const mxArray *v); |
5900 | 139 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
140 /* Destructor. */ |
6109 | 141 extern OCTINTERP_API void mxDestroyArray (mxArray *v); |
5900 | 142 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
143 /* Type Predicates. */ |
6109 | 144 extern OCTINTERP_API int mxIsCell (const mxArray *ptr); |
145 extern OCTINTERP_API int mxIsChar (const mxArray *ptr); | |
146 extern OCTINTERP_API int mxIsClass (const mxArray *ptr, const char *name); | |
147 extern OCTINTERP_API int mxIsComplex (const mxArray *ptr); | |
148 extern OCTINTERP_API int mxIsDouble (const mxArray *ptr); | |
149 extern OCTINTERP_API int mxIsInt16 (const mxArray *ptr); | |
150 extern OCTINTERP_API int mxIsInt32 (const mxArray *ptr); | |
151 extern OCTINTERP_API int mxIsInt64 (const mxArray *ptr); | |
152 extern OCTINTERP_API int mxIsInt8 (const mxArray *ptr); | |
153 extern OCTINTERP_API int mxIsLogical (const mxArray *ptr); | |
154 extern OCTINTERP_API int mxIsNumeric (const mxArray *ptr); | |
155 extern OCTINTERP_API int mxIsSingle (const mxArray *ptr); | |
156 extern OCTINTERP_API int mxIsSparse (const mxArray *ptr); | |
157 extern OCTINTERP_API int mxIsStruct (const mxArray *ptr); | |
158 extern OCTINTERP_API int mxIsUint16 (const mxArray *ptr); | |
159 extern OCTINTERP_API int mxIsUint32 (const mxArray *ptr); | |
160 extern OCTINTERP_API int mxIsUint64 (const mxArray *ptr); | |
161 extern OCTINTERP_API int mxIsUint8 (const mxArray *ptr); | |
5900 | 162 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
163 /* Odd type+size predicate. */ |
6109 | 164 extern OCTINTERP_API int mxIsLogicalScalar (const mxArray *ptr); |
5900 | 165 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
166 /* Odd type+size+value predicate. */ |
6109 | 167 extern OCTINTERP_API int mxIsLogicalScalarTrue (const mxArray *ptr); |
5900 | 168 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
169 /* Size predicate. */ |
6109 | 170 extern OCTINTERP_API int mxIsEmpty (const mxArray *ptr); |
5900 | 171 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
172 /* Just plain odd thing to ask of a value. */ |
6109 | 173 extern OCTINTERP_API int mxIsFromGlobalWS (const mxArray *ptr); |
5900 | 174 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
175 /* Dimension extractors. */ |
6686 | 176 extern OCTINTERP_API size_t mxGetM (const mxArray *ptr); |
177 extern OCTINTERP_API size_t mxGetN (const mxArray *ptr); | |
178 extern OCTINTERP_API mwSize *mxGetDimensions (const mxArray *ptr); | |
179 extern OCTINTERP_API mwSize mxGetNumberOfDimensions (const mxArray *ptr); | |
180 extern OCTINTERP_API size_t mxGetNumberOfElements (const mxArray *ptr); | |
5900 | 181 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
182 /* Dimension setters. */ |
6686 | 183 extern OCTINTERP_API void mxSetM (mxArray *ptr, mwSize M); |
184 extern OCTINTERP_API void mxSetN (mxArray *ptr, mwSize N); | |
10126
8687ce1c56da
Change signature of mxSetDimensions.
David Grundberg <davidg@cs.umu.se>
parents:
9651
diff
changeset
|
185 extern OCTINTERP_API void mxSetDimensions (mxArray *ptr, const mwSize *dims, mwSize ndims); |
5900 | 186 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
187 /* Data extractors. */ |
6109 | 188 extern OCTINTERP_API double *mxGetPi (const mxArray *ptr); |
189 extern OCTINTERP_API double *mxGetPr (const mxArray *ptr); | |
190 extern OCTINTERP_API double mxGetScalar (const mxArray *ptr); | |
191 extern OCTINTERP_API mxChar *mxGetChars (const mxArray *ptr); | |
192 extern OCTINTERP_API mxLogical *mxGetLogicals (const mxArray *ptr); | |
193 extern OCTINTERP_API void *mxGetData (const mxArray *ptr); | |
194 extern OCTINTERP_API void *mxGetImagData (const mxArray *ptr); | |
5900 | 195 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
196 /* Data setters. */ |
6109 | 197 extern OCTINTERP_API void mxSetPr (mxArray *ptr, double *pr); |
198 extern OCTINTERP_API void mxSetPi (mxArray *ptr, double *pi); | |
199 extern OCTINTERP_API void mxSetData (mxArray *ptr, void *data); | |
200 extern OCTINTERP_API void mxSetImagData (mxArray *ptr, void *pi); | |
5900 | 201 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
202 /* Classes. */ |
6109 | 203 extern OCTINTERP_API mxClassID mxGetClassID (const mxArray *ptr); |
204 extern OCTINTERP_API const char *mxGetClassName (const mxArray *ptr); | |
5900 | 205 |
6109 | 206 extern OCTINTERP_API void mxSetClassName (mxArray *ptr, const char *name); |
5900 | 207 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
208 /* Cell support. */ |
6686 | 209 extern OCTINTERP_API mxArray *mxGetCell (const mxArray *ptr, mwIndex idx); |
5900 | 210 |
6686 | 211 extern OCTINTERP_API void mxSetCell (mxArray *ptr, mwIndex idx, mxArray *val); |
5900 | 212 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
213 /* Sparse support. */ |
6686 | 214 extern OCTINTERP_API mwIndex *mxGetIr (const mxArray *ptr); |
215 extern OCTINTERP_API mwIndex *mxGetJc (const mxArray *ptr); | |
216 extern OCTINTERP_API mwSize mxGetNzmax (const mxArray *ptr); | |
5900 | 217 |
6686 | 218 extern OCTINTERP_API void mxSetIr (mxArray *ptr, mwIndex *ir); |
219 extern OCTINTERP_API void mxSetJc (mxArray *ptr, mwIndex *jc); | |
220 extern OCTINTERP_API void mxSetNzmax (mxArray *ptr, mwSize nzmax); | |
5900 | 221 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
222 /* Structure support. */ |
6109 | 223 extern OCTINTERP_API int mxAddField (mxArray *ptr, const char *key); |
5900 | 224 |
6109 | 225 extern OCTINTERP_API void mxRemoveField (mxArray *ptr, int key_num); |
5900 | 226 |
6686 | 227 extern OCTINTERP_API mxArray *mxGetField (const mxArray *ptr, mwIndex index, const char *key); |
228 extern OCTINTERP_API mxArray *mxGetFieldByNumber (const mxArray *ptr, mwIndex index, int key_num); | |
5900 | 229 |
6686 | 230 extern OCTINTERP_API void mxSetField (mxArray *ptr, mwIndex index, const char *key, mxArray *val); |
231 extern OCTINTERP_API void mxSetFieldByNumber (mxArray *ptr, mwIndex index, int key_num, mxArray *val); | |
5900 | 232 |
6109 | 233 extern OCTINTERP_API int mxGetNumberOfFields (const mxArray *ptr); |
5900 | 234 |
6109 | 235 extern OCTINTERP_API const char *mxGetFieldNameByNumber (const mxArray *ptr, int key_num); |
236 extern OCTINTERP_API int mxGetFieldNumber (const mxArray *ptr, const char *key); | |
5900 | 237 |
6686 | 238 extern OCTINTERP_API int mxGetString (const mxArray *ptr, char *buf, mwSize buflen); |
6109 | 239 extern OCTINTERP_API char *mxArrayToString (const mxArray *ptr); |
5900 | 240 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
241 /* Miscellaneous. */ |
5900 | 242 #ifdef NDEBUG |
243 #define mxAssert(expr, msg) \ | |
244 do \ | |
245 { \ | |
246 if (! expr) \ | |
247 { \ | |
248 mexPrintf ("Assertion failed: %s, at line %d of file \"%s\".\n%s\n", \ | |
249 #expr, __LINE__, __FILE__, msg); \ | |
250 } \ | |
251 } \ | |
252 while (0) | |
253 | |
254 #define mxAssertS(expr, msg) \ | |
255 do \ | |
256 { \ | |
257 if (! expr) \ | |
258 { \ | |
259 mexPrintf ("Assertion failed at line %d of file \"%s\".\n%s\n", \ | |
260 __LINE__, __FILE__, msg); \ | |
261 abort (); \ | |
262 } \ | |
263 } \ | |
264 while (0) | |
265 #else | |
266 #define mxAssert(expr, msg) | |
267 #define mxAssertS(expr, msg) | |
5879 | 268 #endif |
269 | |
6686 | 270 extern OCTINTERP_API mwIndex mxCalcSingleSubscript (const mxArray *ptr, mwSize nsubs, mwIndex *subs); |
5900 | 271 |
6686 | 272 extern OCTINTERP_API size_t mxGetElementSize (const mxArray *ptr); |
5900 | 273 |
5864 | 274 #if defined (__cplusplus) |
275 } | |
276 #endif | |
277 | |
278 #endif | |
279 | |
280 /* | |
281 ;;; Local Variables: *** | |
282 ;;; mode: C *** | |
283 ;;; End: *** | |
284 */ |