Changed license terms to the plain LGPL thru-out.
[bpt/guile.git] / libguile / validate.h
1 /* classes: h_files */
2
3 #ifndef SCM_VALIDATE_H
4 #define SCM_VALIDATE_H
5
6 /* Copyright (C) 1999,2000,2001, 2002 Free Software Foundation, Inc.
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23 /* Written by Greg J. Badros <gjb@cs.washington.edu>, Dec-1999 */
24
25 \f
26
27 #define SCM_SYSERROR do { scm_syserror (FUNC_NAME); } while (0)
28
29 #define SCM_MEMORY_ERROR do { scm_memory_error (FUNC_NAME); } while (0)
30
31 #define SCM_SYSERROR_MSG(str, args, val) \
32 do { scm_syserror_msg (FUNC_NAME, (str), (args), (val)); } while (0)
33
34 #define SCM_MISC_ERROR(str, args) \
35 do { scm_misc_error (FUNC_NAME, str, args); } while (0)
36
37 #define SCM_WRONG_NUM_ARGS() \
38 do { scm_error_num_args_subr (FUNC_NAME); } while (0)
39
40 #define SCM_WRONG_TYPE_ARG(pos, obj) \
41 do { scm_wrong_type_arg (FUNC_NAME, pos, obj); } while (0)
42
43 #define SCM_NUM2SIZE(pos, arg) (scm_num2size (arg, pos, FUNC_NAME))
44
45 #define SCM_NUM2SIZE_DEF(pos, arg, def) \
46 (SCM_UNBNDP (arg) ? def : scm_num2size (arg, pos, FUNC_NAME))
47
48 #define SCM_NUM2PTRDIFF(pos, arg) (scm_num2ptrdiff (arg, pos, FUNC_NAME))
49
50 #define SCM_NUM2PTRDIFF_DEF(pos, arg, def) \
51 (SCM_UNBNDP (arg) ? def : scm_num2ptrdiff (arg, pos, FUNC_NAME))
52
53 #define SCM_NUM2SHORT(pos, arg) (scm_num2short (arg, pos, FUNC_NAME))
54
55 #define SCM_NUM2SHORT_DEF(pos, arg, def) \
56 (SCM_UNBNDP (arg) ? def : scm_num2short (arg, pos, FUNC_NAME))
57
58 #define SCM_NUM2USHORT(pos, arg) (scm_num2ushort (arg, pos, FUNC_NAME))
59
60 #define SCM_NUM2USHORT_DEF(pos, arg, def) \
61 (SCM_UNBNDP (arg) ? def : scm_num2ushort (arg, pos, FUNC_NAME))
62
63 #define SCM_NUM2INT(pos, arg) (scm_num2int (arg, pos, FUNC_NAME))
64
65 #define SCM_NUM2INT_DEF(pos, arg, def) \
66 (SCM_UNBNDP (arg) ? def : scm_num2int (arg, pos, FUNC_NAME))
67
68 #define SCM_NUM2UINT(pos, arg) (scm_num2uint (arg, pos, FUNC_NAME))
69
70 #define SCM_NUM2UINT_DEF(pos, arg, def) \
71 (SCM_UNBNDP (arg) ? def : scm_num2uint (arg, pos, FUNC_NAME))
72
73 #define SCM_NUM2ULONG(pos, arg) (scm_num2ulong (arg, pos, FUNC_NAME))
74
75 #define SCM_NUM2ULONG_DEF(pos, arg, def) \
76 (SCM_UNBNDP (arg) ? def : scm_num2ulong (arg, pos, FUNC_NAME))
77
78 #define SCM_NUM2LONG(pos, arg) (scm_num2long (arg, pos, FUNC_NAME))
79
80 #define SCM_NUM2LONG_DEF(pos, arg, def) \
81 (SCM_UNBNDP (arg) ? def : scm_num2long (arg, pos, FUNC_NAME))
82
83 #define SCM_NUM2LONG_LONG(pos, arg) \
84 (scm_num2long_long (arg, pos, FUNC_NAME))
85
86 #define SCM_NUM2LONG_LONG_DEF(pos, arg, def) \
87 (SCM_UNBNDP (arg) ? def : scm_num2long_long (arg, pos, FUNC_NAME))
88
89 #define SCM_NUM2ULONG_LONG(pos, arg) \
90 (scm_num2ulong_long (arg, pos, FUNC_NAME))
91
92 #define SCM_NUM2ULONG_LONG_DEF(pos, arg, def) \
93 (SCM_UNBNDP (arg) ? def : scm_num2ulong_long (arg, pos, FUNC_NAME))
94
95 #define SCM_NUM2FLOAT(pos, arg) \
96 (scm_num2float (arg, pos, FUNC_NAME))
97
98 #define SCM_NUM2DOUBLE(pos, arg) \
99 (scm_num2double (arg, pos, FUNC_NAME))
100
101 #define SCM_OUT_OF_RANGE(pos, arg) \
102 do { scm_out_of_range_pos (FUNC_NAME, arg, SCM_MAKINUM (pos)); } while (0)
103
104 #define SCM_ASSERT_RANGE(pos, arg, f) \
105 do { if (!(f)) scm_out_of_range_pos (FUNC_NAME, arg, SCM_MAKINUM (pos)); } while (0)
106
107 #define SCM_MUST_MALLOC_TYPE(type) \
108 ((type *) scm_must_malloc (sizeof (type), FUNC_NAME))
109
110 #define SCM_MUST_MALLOC_TYPE_NUM(type, num) \
111 ((type *) scm_must_malloc (sizeof (type) * (num), FUNC_NAME))
112
113 #define SCM_MUST_MALLOC(size) (scm_must_malloc ((size), FUNC_NAME))
114
115 #define SCM_MAKE_VALIDATE(pos, var, pred) \
116 do { \
117 SCM_ASSERT_TYPE (SCM_ ## pred (var), var, pos, FUNC_NAME, #pred); \
118 } while (0)
119
120 #define SCM_MAKE_VALIDATE_MSG(pos, var, pred, msg) \
121 do { \
122 SCM_ASSERT_TYPE (SCM_ ## pred (var), var, pos, FUNC_NAME, msg); \
123 } while (0)
124
125 \f
126
127 #define SCM_VALIDATE_REST_ARGUMENT(x) \
128 do { \
129 if (SCM_DEBUG_REST_ARGUMENT) { \
130 if (scm_ilength (x) < 0) { \
131 SCM_MISC_ERROR ("Rest arguments do not form a proper list.", SCM_EOL); \
132 } \
133 } \
134 } while (0)
135
136 #define SCM_VALIDATE_NIM(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, NIMP, "non-immediate")
137
138 #define SCM_VALIDATE_BOOL(pos, flag) SCM_MAKE_VALIDATE_MSG(pos, flag, BOOLP, "boolean")
139
140 #define SCM_VALIDATE_BOOL_COPY(pos, flag, cvar) \
141 do { \
142 SCM_ASSERT (SCM_BOOLP (flag), flag, pos, FUNC_NAME); \
143 cvar = SCM_EQ_P (flag, SCM_BOOL_T) ? 1 : 0; \
144 } while (0)
145
146 #define SCM_VALIDATE_CHAR(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, CHARP, "character")
147
148 #define SCM_VALIDATE_CHAR_COPY(pos, scm, cvar) \
149 do { \
150 SCM_ASSERT (SCM_CHARP (scm), scm, pos, FUNC_NAME); \
151 cvar = SCM_CHAR (scm); \
152 } while (0)
153
154 #define SCM_VALIDATE_STRING(pos, str) SCM_MAKE_VALIDATE_MSG (pos, str, STRINGP, "string")
155
156 #define SCM_VALIDATE_STRING_COPY(pos, str, cvar) \
157 do { \
158 SCM_ASSERT (SCM_STRINGP (str), str, pos, FUNC_NAME); \
159 cvar = SCM_STRING_CHARS(str); \
160 } while (0)
161
162 /* validate a string and optional start/end arguments which default to
163 0/string-len. this is unrelated to the old shared substring
164 support, so please do not deprecate it :) */
165 #define SCM_VALIDATE_SUBSTRING_SPEC_COPY(pos_str, str, c_str, \
166 pos_start, start, c_start,\
167 pos_end, end, c_end) \
168 do {\
169 SCM_VALIDATE_STRING_COPY (pos_str, str, c_str);\
170 SCM_VALIDATE_INUM_DEF_COPY (pos_start, start, 0, c_start);\
171 SCM_VALIDATE_INUM_DEF_COPY (pos_end, end, SCM_STRING_LENGTH (str), c_end);\
172 SCM_ASSERT_RANGE (pos_start, start,\
173 0 <= c_start \
174 && (size_t) c_start <= SCM_STRING_LENGTH (str));\
175 SCM_ASSERT_RANGE (pos_end, end,\
176 c_start <= c_end \
177 && (size_t) c_end <= SCM_STRING_LENGTH (str));\
178 } while (0)
179
180 #define SCM_VALIDATE_REAL(pos, z) SCM_MAKE_VALIDATE_MSG (pos, z, REALP, "real")
181
182 #define SCM_VALIDATE_NUMBER(pos, z) SCM_MAKE_VALIDATE_MSG (pos, z, NUMBERP, "number")
183
184 #define SCM_VALIDATE_INUM(pos, k) SCM_MAKE_VALIDATE_MSG (pos, k, INUMP, "exact integer")
185
186 #define SCM_VALIDATE_INUM_COPY(pos, k, cvar) \
187 do { \
188 SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
189 cvar = SCM_INUM (k); \
190 } while (0)
191
192 #define SCM_VALIDATE_USHORT_COPY(pos, k, cvar) \
193 do { \
194 cvar = SCM_NUM2USHORT (pos, k); \
195 } while (0)
196
197 #define SCM_VALIDATE_SHORT_COPY(pos, k, cvar) \
198 do { \
199 cvar = SCM_NUM2SHORT (pos, k); \
200 } while (0)
201
202 #define SCM_VALIDATE_UINT_COPY(pos, k, cvar) \
203 do { \
204 cvar = SCM_NUM2UINT (pos, k); \
205 } while (0)
206
207 #define SCM_VALIDATE_INT_COPY(pos, k, cvar) \
208 do { \
209 cvar = SCM_NUM2INT (pos, k); \
210 } while (0)
211
212 #define SCM_VALIDATE_ULONG_COPY(pos, k, cvar) \
213 do { \
214 cvar = SCM_NUM2ULONG (pos, k); \
215 } while (0)
216
217 #define SCM_VALIDATE_LONG_COPY(pos, k, cvar) \
218 do { \
219 cvar = SCM_NUM2LONG (pos, k); \
220 } while (0)
221
222 #define SCM_VALIDATE_FLOAT_COPY(pos, k, cvar) \
223 do { \
224 cvar = SCM_NUM2FLOAT (pos, k); \
225 } while (0)
226
227 #define SCM_VALIDATE_DOUBLE_COPY(pos, k, cvar) \
228 do { \
229 cvar = SCM_NUM2DOUBLE (pos, k); \
230 } while (0)
231
232 #define SCM_VALIDATE_BIGINT(pos, k) SCM_MAKE_VALIDATE_MSG (pos, k, BIGP, "bignum")
233
234 #define SCM_VALIDATE_INUM_MIN(pos, k, min) \
235 do { \
236 SCM_ASSERT (SCM_INUMP(k), k, pos, FUNC_NAME); \
237 SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
238 } while (0)
239
240 #define SCM_VALIDATE_INUM_MIN_COPY(pos, k, min, cvar) \
241 do { \
242 SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
243 SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
244 cvar = SCM_INUM (k); \
245 } while (0)
246
247 #define SCM_VALIDATE_INUM_MIN_DEF_COPY(pos, k, min, default, cvar) \
248 do { \
249 if (SCM_UNBNDP (k)) \
250 k = SCM_MAKINUM (default); \
251 SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
252 SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
253 cvar = SCM_INUM (k); \
254 } while (0)
255
256 #define SCM_VALIDATE_INUM_DEF(pos, k, default) \
257 do { \
258 if (SCM_UNBNDP (k)) \
259 k = SCM_MAKINUM (default); \
260 else SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
261 } while (0)
262
263 #define SCM_VALIDATE_INUM_DEF_COPY(pos, k, default, cvar) \
264 do { \
265 if (SCM_UNBNDP (k)) \
266 { \
267 k = SCM_MAKINUM (default); \
268 cvar = default; \
269 } \
270 else \
271 { \
272 SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
273 cvar = SCM_INUM (k); \
274 } \
275 } while (0)
276
277 #define SCM_VALIDATE_DOUBLE_DEF_COPY(pos, k, default, cvar) \
278 do { \
279 if (SCM_UNBNDP (k)) \
280 { \
281 k = scm_make_real (default); \
282 cvar = default; \
283 } \
284 else \
285 { \
286 cvar = SCM_NUM2DOUBLE (pos, k); \
287 } \
288 } while (0)
289
290 /* [low, high) */
291 #define SCM_VALIDATE_INUM_RANGE(pos, k, low, high) \
292 do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
293 SCM_ASSERT_RANGE(pos, k, \
294 (SCM_INUM (k) >= low && \
295 SCM_INUM (k) < high)); \
296 } while (0)
297
298 #define SCM_VALIDATE_INUM_RANGE_COPY(pos, k, low, high, cvar) \
299 do { \
300 SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
301 SCM_ASSERT_RANGE (pos, k, low <= SCM_INUM (k) && SCM_INUM (k) < high); \
302 cvar = SCM_INUM (k); \
303 } while (0)
304
305 #define SCM_VALIDATE_NULL(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, NULLP, "null")
306
307 #define SCM_VALIDATE_NULL_OR_NIL(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, NULL_OR_NIL_P, "null")
308
309 #define SCM_VALIDATE_CONS(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, CONSP, "pair")
310
311 #define SCM_VALIDATE_LIST(pos, lst) \
312 do { \
313 SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); \
314 } while (0)
315
316 #define SCM_VALIDATE_NONEMPTYLIST(pos, lst) \
317 do { \
318 SCM_ASSERT (scm_ilength (lst) > 0, lst, pos, FUNC_NAME); \
319 } while (0)
320
321 #define SCM_VALIDATE_LIST_COPYLEN(pos, lst, cvar) \
322 do { \
323 cvar = scm_ilength (lst); \
324 SCM_ASSERT (cvar >= 0, lst, pos, FUNC_NAME); \
325 } while (0)
326
327 #define SCM_VALIDATE_NONEMPTYLIST_COPYLEN(pos, lst, cvar) \
328 do { \
329 cvar = scm_ilength (lst); \
330 SCM_ASSERT (cvar >= 1, lst, pos, FUNC_NAME); \
331 } while (0)
332
333 #define SCM_VALIDATE_ALISTCELL(pos, alist) \
334 do { \
335 SCM_ASSERT (SCM_CONSP (alist) && SCM_CONSP (SCM_CAR (alist)), \
336 alist, pos, FUNC_NAME); \
337 } while (0)
338
339 #define SCM_VALIDATE_ALISTCELL_COPYSCM(pos, alist, cvar) \
340 do { \
341 SCM_ASSERT (SCM_CONSP (alist), alist, pos, FUNC_NAME); \
342 cvar = SCM_CAR (alist); \
343 SCM_ASSERT (SCM_CONSP (cvar), alist, pos, FUNC_NAME); \
344 } while (0)
345
346 #define SCM_VALIDATE_OPORT_VALUE(pos, port) \
347 do { \
348 SCM_ASSERT (scm_valid_oport_value_p (port), port, pos, FUNC_NAME); \
349 } while (0)
350
351 #define SCM_VALIDATE_PRINTSTATE(pos, a) SCM_MAKE_VALIDATE_MSG(pos, a, PRINT_STATE_P, "print-state")
352
353 #define SCM_VALIDATE_SMOB(pos, obj, type) \
354 do { \
355 SCM_ASSERT (SCM_TYP16_PREDICATE (scm_tc16_ ## type, obj), \
356 obj, pos, FUNC_NAME); \
357 } while (0)
358
359 #define SCM_VALIDATE_THUNK(pos, thunk) \
360 do { \
361 SCM_ASSERT (!SCM_FALSEP (scm_thunk_p (thunk)), thunk, pos, FUNC_NAME); \
362 } while (0)
363
364 #define SCM_VALIDATE_SYMBOL(pos, sym) SCM_MAKE_VALIDATE_MSG (pos, sym, SYMBOLP, "symbol")
365
366 #define SCM_VALIDATE_VARIABLE(pos, var) SCM_MAKE_VALIDATE_MSG (pos, var, VARIABLEP, "variable")
367
368 #define SCM_VALIDATE_MEMOIZED(pos, obj) SCM_MAKE_VALIDATE_MSG (pos, obj, MEMOIZEDP, "memoized code")
369
370 #define SCM_VALIDATE_CLOSURE(pos, obj) SCM_MAKE_VALIDATE_MSG (pos, obj, CLOSUREP, "closure")
371
372 #define SCM_VALIDATE_PROC(pos, proc) \
373 do { \
374 SCM_ASSERT (SCM_EQ_P (scm_procedure_p (proc), SCM_BOOL_T), proc, pos, FUNC_NAME); \
375 } while (0)
376
377 #define SCM_VALIDATE_NULLORCONS(pos, env) \
378 do { \
379 SCM_ASSERT (SCM_NULLP (env) || SCM_CONSP (env), env, pos, FUNC_NAME); \
380 } while (0)
381
382 #define SCM_VALIDATE_HOOK(pos, a) SCM_MAKE_VALIDATE_MSG (pos, a, HOOKP, "hook")
383
384 #define SCM_VALIDATE_RGXP(pos, a) SCM_MAKE_VALIDATE_MSG (pos, a, RGXP, "regexp")
385
386 #define SCM_VALIDATE_DIR(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, DIRP, "directory port")
387
388 #define SCM_VALIDATE_PORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, PORTP, "port")
389
390 #define SCM_VALIDATE_INPUT_PORT(pos, port) \
391 SCM_MAKE_VALIDATE_MSG (pos, port, INPUT_PORT_P, "input port")
392
393 #define SCM_VALIDATE_OUTPUT_PORT(pos, port) \
394 SCM_MAKE_VALIDATE_MSG (pos, port, OUTPUT_PORT_P, "output port")
395
396 #define SCM_VALIDATE_FPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, FPORTP, "file port")
397
398 #define SCM_VALIDATE_OPFPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, OPFPORTP, "open file port")
399
400 #define SCM_VALIDATE_OPINPORT(pos, port) \
401 SCM_MAKE_VALIDATE_MSG (pos, port, OPINPORTP, "open input port")
402
403 #define SCM_VALIDATE_OPENPORT(pos, port) \
404 do { \
405 SCM_ASSERT (SCM_PORTP (port) && SCM_OPENP (port), \
406 port, pos, FUNC_NAME); \
407 } while (0)
408
409 #define SCM_VALIDATE_OPPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, OPPORTP, "open port")
410
411 #define SCM_VALIDATE_OPOUTPORT(pos, port) \
412 SCM_MAKE_VALIDATE_MSG (pos, port, OPOUTPORTP, "open output port")
413
414 #define SCM_VALIDATE_OPOUTSTRPORT(pos, port) \
415 SCM_MAKE_VALIDATE_MSG (pos, port, OPOUTSTRPORTP, "open output string port")
416
417 #define SCM_VALIDATE_FLUID(pos, fluid) SCM_MAKE_VALIDATE_MSG (pos, fluid, FLUIDP, "fluid")
418
419 #define SCM_VALIDATE_KEYWORD(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, KEYWORDP, "keyword")
420
421 #define SCM_VALIDATE_STACK(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, STACKP, "stack")
422
423 #define SCM_VALIDATE_FRAME(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, FRAMEP, "frame")
424
425 #define SCM_VALIDATE_RSTATE(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, RSTATEP, "random-generator-state")
426
427 #define SCM_VALIDATE_ARRAY(pos, v) \
428 do { \
429 SCM_ASSERT (!SCM_IMP (v) \
430 && !SCM_FALSEP (scm_array_p (v, SCM_UNDEFINED)), \
431 v, pos, FUNC_NAME); \
432 } while (0)
433
434 #define SCM_VALIDATE_VECTOR(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, VECTORP, "vector")
435
436 #define SCM_VALIDATE_VECTOR_OR_DVECTOR(pos, v) \
437 do { \
438 SCM_ASSERT ((SCM_VECTORP (v) \
439 || (!SCM_IMP (v) && SCM_TYP7 (v) == scm_tc7_dvect)), \
440 v, pos, FUNC_NAME); \
441 } while (0)
442
443 #define SCM_VALIDATE_STRUCT(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, STRUCTP, "struct")
444
445 #define SCM_VALIDATE_VTABLE(pos, v) \
446 do { \
447 SCM_ASSERT (!SCM_IMP (v) && !SCM_FALSEP (scm_struct_vtable_p (v)), \
448 v, pos, FUNC_NAME); \
449 } while (0)
450
451 #define SCM_VALIDATE_VECTOR_LEN(pos, v, len) \
452 do { \
453 SCM_ASSERT (SCM_VECTORP (v) && len == SCM_VECTOR_LENGTH (v), v, pos, FUNC_NAME); \
454 } while (0)
455
456 #endif /* SCM_VALIDATE_H */
457
458 /*
459 Local Variables:
460 c-file-style: "gnu"
461 End:
462 */