1 /* classes: h_files */ 2 3 #ifndef SCM_VALIDATE_H 4 #define SCM_VALIDATE_H 5 6 /* Copyright (C) 1999,2000,2001, 2002, 2004, 2006, 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 21 */ 22 23 /* Written by Greg J. Badros <gjb@cs.washington.edu>, Dec-1999 */ 24 25 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_to_size_t (arg)) 44 45 #define SCM_NUM2SIZE_DEF(pos, arg, def) \ 46 (SCM_UNBNDP (arg) ? def : scm_to_size_t (arg)) 47 48 #define SCM_NUM2PTRDIFF(pos, arg) (scm_to_ssize_t (arg)) 49 50 #define SCM_NUM2PTRDIFF_DEF(pos, arg, def) \ 51 (SCM_UNBNDP (arg) ? def : scm_to_ssize_t (arg)) 52 53 #define SCM_NUM2SHORT(pos, arg) (scm_to_short (arg)) 54 55 #define SCM_NUM2SHORT_DEF(pos, arg, def) \ 56 (SCM_UNBNDP (arg) ? def : scm_to_short (arg)) 57 58 #define SCM_NUM2USHORT(pos, arg) (scm_to_ushort (arg)) 59 60 #define SCM_NUM2USHORT_DEF(pos, arg, def) \ 61 (SCM_UNBNDP (arg) ? def : scm_to_ushort (arg)) 62 63 #define SCM_NUM2INT(pos, arg) (scm_to_int (arg)) 64 65 #define SCM_NUM2INT_DEF(pos, arg, def) \ 66 (SCM_UNBNDP (arg) ? def : scm_to_int (arg)) 67 68 #define SCM_NUM2UINT(pos, arg) (scm_to_uint (arg)) 69 70 #define SCM_NUM2UINT_DEF(pos, arg, def) \ 71 (SCM_UNBNDP (arg) ? def : scm_to_uint (arg)) 72 73 #define SCM_NUM2ULONG(pos, arg) (scm_to_ulong (arg)) 74 75 #define SCM_NUM2ULONG_DEF(pos, arg, def) \ 76 (SCM_UNBNDP (arg) ? def : scm_to_ulong (arg)) 77 78 #define SCM_NUM2LONG(pos, arg) (scm_to_long (arg)) 79 80 #define SCM_NUM2LONG_DEF(pos, arg, def) \ 81 (SCM_UNBNDP (arg) ? def : scm_to_long (arg)) 82 83 #define SCM_NUM2LONG_LONG(pos, arg) (scm_to_long_long (arg)) 84 85 #define SCM_NUM2LONG_LONG_DEF(pos, arg, def) \ 86 (SCM_UNBNDP (arg) ? def : scm_to_long_long (arg)) 87 88 #define SCM_NUM2ULONG_LONG(pos, arg) (scm_to_ulong_long (arg)) 89 90 #define SCM_NUM2ULONG_LONG_DEF(pos, arg, def) \ 91 (SCM_UNBNDP (arg) ? def : scm_to_ulong_long (arg)) 92 93 #define SCM_NUM2FLOAT(pos, arg) \ 94 (scm_num2float (arg, pos, FUNC_NAME)) 95 96 #define SCM_NUM2DOUBLE(pos, arg) \ 97 (scm_num2double (arg, pos, FUNC_NAME)) 98 99 #define SCM_OUT_OF_RANGE(pos, arg) \ 100 do { scm_out_of_range_pos (FUNC_NAME, arg, scm_from_int (pos)); } while (0) 101 102 #define SCM_ASSERT_RANGE(pos, arg, f) \ 103 do { if (SCM_UNLIKELY (!(f))) \ 104 scm_out_of_range_pos (FUNC_NAME, arg, scm_from_int (pos)); } \ 105 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_I_MAKE_VALIDATE_MSG2(pos, var, pred, msg) \ 121 do { \ 122 SCM_ASSERT_TYPE (pred (var), var, pos, FUNC_NAME, msg); \ 123 } while (0) 124 125 #define SCM_MAKE_VALIDATE_MSG(pos, var, pred, msg) \ 126 SCM_I_MAKE_VALIDATE_MSG2 (pos, var, SCM_ ## pred, msg) 127 128 129 130 131 #define SCM_VALIDATE_REST_ARGUMENT(x) \ 132 do { \ 133 if (SCM_DEBUG_REST_ARGUMENT) { \ 134 if (scm_ilength (x) < 0) { \ 135 SCM_MISC_ERROR ("Rest arguments do not form a proper list.", SCM_EOL); \ 136 } \ 137 } \ 138 } while (0) 139 140 #define SCM_VALIDATE_NIM(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, NIMP, "non-immediate") 141 142 #define SCM_VALIDATE_BOOL(pos, flag) \ 143 do { \ 144 SCM_ASSERT_TYPE (scm_is_bool (flag), flag, pos, FUNC_NAME, "boolean"); \ 145 } while (0) 146 147 #define SCM_VALIDATE_BOOL_COPY(pos, flag, cvar) \ 148 do { \ 149 SCM_ASSERT (scm_is_bool (flag), flag, pos, FUNC_NAME); \ 150 cvar = scm_to_bool (flag); \ 151 } while (0) 152 153 #define SCM_VALIDATE_CHAR(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, CHARP, "character") 154 155 #define SCM_VALIDATE_CHAR_COPY(pos, scm, cvar) \ 156 do { \ 157 SCM_ASSERT (SCM_CHARP (scm), scm, pos, FUNC_NAME); \ 158 cvar = SCM_CHAR (scm); \ 159 } while (0) 160 161 #define SCM_VALIDATE_STRING(pos, str) \ 162 do { \ 163 SCM_ASSERT_TYPE (scm_is_string (str), str, pos, FUNC_NAME, "string"); \ 164 } while (0) 165 166 #define SCM_VALIDATE_REAL(pos, z) SCM_MAKE_VALIDATE_MSG (pos, z, REALP, "real") 167 168 #define SCM_VALIDATE_NUMBER(pos, z) SCM_MAKE_VALIDATE_MSG (pos, z, NUMBERP, "number") 169 170 #define SCM_VALIDATE_USHORT_COPY(pos, k, cvar) \ 171 do { \ 172 cvar = SCM_NUM2USHORT (pos, k); \ 173 } while (0) 174 175 #define SCM_VALIDATE_SHORT_COPY(pos, k, cvar) \ 176 do { \ 177 cvar = SCM_NUM2SHORT (pos, k); \ 178 } while (0) 179 180 #define SCM_VALIDATE_UINT_COPY(pos, k, cvar) \ 181 do { \ 182 cvar = SCM_NUM2UINT (pos, k); \ 183 } while (0) 184 185 #define SCM_VALIDATE_INT_COPY(pos, k, cvar) \ 186 do { \ 187 cvar = SCM_NUM2INT (pos, k); \ 188 } while (0) 189 190 #define SCM_VALIDATE_ULONG_COPY(pos, k, cvar) \ 191 do { \ 192 cvar = SCM_NUM2ULONG (pos, k); \ 193 } while (0) 194 195 #define SCM_VALIDATE_LONG_COPY(pos, k, cvar) \ 196 do { \ 197 cvar = SCM_NUM2LONG (pos, k); \ 198 } while (0) 199 200 #define SCM_VALIDATE_FLOAT_COPY(pos, k, cvar) \ 201 do { \ 202 cvar = SCM_NUM2FLOAT (pos, k); \ 203 } while (0) 204 205 #define SCM_VALIDATE_DOUBLE_COPY(pos, k, cvar) \ 206 do { \ 207 cvar = SCM_NUM2DOUBLE (pos, k); \ 208 } while (0) 209 210 #define SCM_VALIDATE_DOUBLE_DEF_COPY(pos, k, default, cvar) \ 211 do { \ 212 if (SCM_UNBNDP (k)) \ 213 { \ 214 k = scm_make_real (default); \ 215 cvar = default; \ 216 } \ 217 else \ 218 { \ 219 cvar = SCM_NUM2DOUBLE (pos, k); \ 220 } \ 221 } while (0) 222 223 #define SCM_VALIDATE_NULL(pos, scm) \ 224 SCM_I_MAKE_VALIDATE_MSG2 (pos, scm, scm_is_null, "empty list") 225 226 #define SCM_VALIDATE_NULL_OR_NIL(pos, scm) \ 227 SCM_MAKE_VALIDATE_MSG (pos, scm, NULL_OR_NIL_P, "empty list") 228 229 #define SCM_VALIDATE_CONS(pos, scm) \ 230 SCM_I_MAKE_VALIDATE_MSG2 (pos, scm, scm_is_pair, "pair") 231 232 #define SCM_VALIDATE_LIST(pos, lst) \ 233 do { \ 234 SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); \ 235 } while (0) 236 237 #define SCM_VALIDATE_NONEMPTYLIST(pos, lst) \ 238 do { \ 239 SCM_ASSERT (scm_ilength (lst) > 0, lst, pos, FUNC_NAME); \ 240 } while (0) 241 242 #define SCM_VALIDATE_LIST_COPYLEN(pos, lst, cvar) \ 243 do { \ 244 cvar = scm_ilength (lst); \ 245 SCM_ASSERT (cvar >= 0, lst, pos, FUNC_NAME); \ 246 } while (0) 247 248 #define SCM_VALIDATE_NONEMPTYLIST_COPYLEN(pos, lst, cvar) \ 249 do { \ 250 cvar = scm_ilength (lst); \ 251 SCM_ASSERT (cvar >= 1, lst, pos, FUNC_NAME); \ 252 } while (0) 253 254 #define SCM_VALIDATE_ALISTCELL(pos, alist) \ 255 do { \ 256 SCM_ASSERT (scm_is_pair (alist) && scm_is_pair (SCM_CAR (alist)), \ 257 alist, pos, FUNC_NAME); \ 258 } while (0) 259 260 #define SCM_VALIDATE_ALISTCELL_COPYSCM(pos, alist, cvar) \ 261 do { \ 262 SCM_ASSERT (scm_is_pair (alist), alist, pos, FUNC_NAME); \ 263 cvar = SCM_CAR (alist); \ 264 SCM_ASSERT (scm_is_pair (cvar), alist, pos, FUNC_NAME); \ 265 } while (0) 266 267 #define SCM_VALIDATE_OPORT_VALUE(pos, port) \ 268 do { \ 269 SCM_ASSERT (scm_valid_oport_value_p (port), port, pos, FUNC_NAME); \ 270 } while (0) 271 272 #define SCM_VALIDATE_PRINTSTATE(pos, a) SCM_MAKE_VALIDATE_MSG(pos, a, PRINT_STATE_P, "print-state") 273 274 #define SCM_VALIDATE_SMOB(pos, obj, type) \ 275 do { \ 276 SCM_ASSERT (SCM_TYP16_PREDICATE (scm_tc16_ ## type, obj), \ 277 obj, pos, FUNC_NAME); \ 278 } while (0) 279 280 #define SCM_VALIDATE_THUNK(pos, thunk) \ 281 do { \ 282 SCM_ASSERT (scm_is_true (scm_thunk_p (thunk)), thunk, pos, FUNC_NAME); \ 283 } while (0) 284 285 #define SCM_VALIDATE_SYMBOL(pos, str) \ 286 do { \ 287 SCM_ASSERT_TYPE (scm_is_symbol (str), str, pos, FUNC_NAME, "symbol"); \ 288 } while (0) 289 290 #define SCM_VALIDATE_VARIABLE(pos, var) SCM_MAKE_VALIDATE_MSG (pos, var, VARIABLEP, "variable") 291 292 #define SCM_VALIDATE_MEMOIZED(pos, obj) SCM_MAKE_VALIDATE_MSG (pos, obj, MEMOIZEDP, "memoized code") 293 294 #define SCM_VALIDATE_CLOSURE(pos, obj) SCM_MAKE_VALIDATE_MSG (pos, obj, CLOSUREP, "closure") 295 296 #define SCM_VALIDATE_PROC(pos, proc) \ 297 do { \ 298 SCM_ASSERT (scm_is_true (scm_procedure_p (proc)), proc, pos, FUNC_NAME); \ 299 } while (0) 300 301 #define SCM_VALIDATE_NULLORCONS(pos, env) \ 302 do { \ 303 SCM_ASSERT (scm_is_null (env) || scm_is_pair (env), env, pos, FUNC_NAME); \ 304 } while (0) 305 306 #define SCM_VALIDATE_HOOK(pos, a) SCM_MAKE_VALIDATE_MSG (pos, a, HOOKP, "hook") 307 308 #define SCM_VALIDATE_RGXP(pos, a) SCM_MAKE_VALIDATE_MSG (pos, a, RGXP, "regexp") 309 310 #define SCM_VALIDATE_DIR(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, DIRP, "directory port") 311 312 #define SCM_VALIDATE_PORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, PORTP, "port") 313 314 #define SCM_VALIDATE_INPUT_PORT(pos, port) \ 315 SCM_MAKE_VALIDATE_MSG (pos, port, INPUT_PORT_P, "input port") 316 317 #define SCM_VALIDATE_OUTPUT_PORT(pos, port) \ 318 SCM_MAKE_VALIDATE_MSG (pos, port, OUTPUT_PORT_P, "output port") 319 320 #define SCM_VALIDATE_FPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, FPORTP, "file port") 321 322 #define SCM_VALIDATE_OPFPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, OPFPORTP, "open file port") 323 324 #define SCM_VALIDATE_OPINPORT(pos, port) \ 325 SCM_MAKE_VALIDATE_MSG (pos, port, OPINPORTP, "open input port") 326 327 #define SCM_VALIDATE_OPENPORT(pos, port) \ 328 do { \ 329 SCM_ASSERT (SCM_PORTP (port) && SCM_OPENP (port), \ 330 port, pos, FUNC_NAME); \ 331 } while (0) 332 333 #define SCM_VALIDATE_OPPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, OPPORTP, "open port") 334 335 #define SCM_VALIDATE_OPOUTPORT(pos, port) \ 336 SCM_MAKE_VALIDATE_MSG (pos, port, OPOUTPORTP, "open output port") 337 338 #define SCM_VALIDATE_OPOUTSTRPORT(pos, port) \ 339 SCM_MAKE_VALIDATE_MSG (pos, port, OPOUTSTRPORTP, "open output string port") 340 341 #define SCM_VALIDATE_FLUID(pos, fluid) \ 342 SCM_I_MAKE_VALIDATE_MSG2 (pos, fluid, scm_is_fluid, "fluid") 343 344 #define SCM_VALIDATE_KEYWORD(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, KEYWORDP, "keyword") 345 346 #define SCM_VALIDATE_STACK(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, STACKP, "stack") 347 348 #define SCM_VALIDATE_FRAME(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, FRAMEP, "frame") 349 350 #define SCM_VALIDATE_RSTATE(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, RSTATEP, "random-generator-state") 351 352 #define SCM_VALIDATE_ARRAY(pos, v) \ 353 do { \ 354 SCM_ASSERT (!SCM_IMP (v) \ 355 && scm_is_true (scm_array_p (v, SCM_UNDEFINED)), \ 356 v, pos, FUNC_NAME); \ 357 } while (0) 358 359 #define SCM_VALIDATE_VECTOR(pos, v) \ 360 do { \ 361 SCM_ASSERT (scm_is_simple_vector (v), v, pos, FUNC_NAME); \ 362 } while (0) 363 364 #define SCM_VALIDATE_VECTOR_OR_DVECTOR(pos, v) \ 365 do { \ 366 SCM_ASSERT ((scm_is_simple_vector (v) \ 367 || (scm_is_true (scm_f64vector_p (v)))), \ 368 v, pos, FUNC_NAME); \ 369 } while (0) 370 371 #define SCM_VALIDATE_STRUCT(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, STRUCTP, "struct") 372 373 #define SCM_VALIDATE_VTABLE(pos, v) \ 374 do { \ 375 SCM_ASSERT (!SCM_IMP (v) && scm_is_true (scm_struct_vtable_p (v)), \ 376 v, pos, FUNC_NAME); \ 377 } while (0) 378 379 #define SCM_VALIDATE_VECTOR_LEN(pos, v, len) \ 380 do { \ 381 SCM_ASSERT (SCM_VECTORP (v) && len == SCM_VECTOR_LENGTH (v), v, pos, FUNC_NAME); \ 382 } while (0) 383 384 385 #endif /* SCM_VALIDATE_H */ 386 387 /* 388 Local Variables: 389 c-file-style: "gnu" 390 End: 391 */ 392