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, 2004 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_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 (!(f)) scm_out_of_range_pos (FUNC_NAME, arg, scm_from_int (pos)); } while (0)
 104
 105 #define SCM_MUST_MALLOC_TYPE(type) \
 106   ((type *) scm_must_malloc (sizeof (type), FUNC_NAME))
 107
 108 #define SCM_MUST_MALLOC_TYPE_NUM(type, num) \
 109   ((type *) scm_must_malloc (sizeof (type) * (num), FUNC_NAME))
 110
 111 #define SCM_MUST_MALLOC(size) (scm_must_malloc ((size), FUNC_NAME))
 112
 113 #define SCM_MAKE_VALIDATE(pos, var, pred) \
 114   do { \
 115     SCM_ASSERT_TYPE (SCM_ ## pred (var), var, pos, FUNC_NAME, #pred); \
 116   } while (0)
 117
 118 #define SCM_MAKE_VALIDATE_MSG(pos, var, pred, msg) \
 119   do { \
 120     SCM_ASSERT_TYPE (SCM_ ## pred (var), var, pos, FUNC_NAME, msg); \
 121   } while (0)
 122
 123 \f
 124
 125 #define SCM_VALIDATE_REST_ARGUMENT(x) \
 126   do { \
 127     if (SCM_DEBUG_REST_ARGUMENT) { \
 128       if (scm_ilength (x) < 0) { \
 129         SCM_MISC_ERROR ("Rest arguments do not form a proper list.", SCM_EOL); \
 130       } \
 131     } \
 132   } while (0)
 133
 134 #define SCM_VALIDATE_NIM(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, NIMP, "non-immediate")
 135
 136 #define SCM_VALIDATE_BOOL(pos, flag) \
 137   do { \
 138     SCM_ASSERT_TYPE (scm_is_bool (flag), flag, pos, FUNC_NAME, "boolean"); \
 139   } while (0)
 140
 141 #define SCM_VALIDATE_BOOL_COPY(pos, flag, cvar) \
 142   do { \
 143     SCM_ASSERT (scm_is_bool (flag), flag, pos, FUNC_NAME); \
 144     cvar = scm_to_bool (flag); \
 145   } while (0)
 146
 147 #define SCM_VALIDATE_CHAR(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, CHARP, "character")
 148
 149 #define SCM_VALIDATE_CHAR_COPY(pos, scm, cvar) \
 150   do { \
 151     SCM_ASSERT (SCM_CHARP (scm), scm, pos, FUNC_NAME); \
 152     cvar = SCM_CHAR (scm); \
 153   } while (0)
 154
 155 #define SCM_VALIDATE_STRING(pos, str) \
 156   do { \
 157     SCM_ASSERT_TYPE (scm_is_string (str), str, pos, FUNC_NAME, "string"); \
 158   } while (0)
 159
 160 #define SCM_VALIDATE_REAL(pos, z) SCM_MAKE_VALIDATE_MSG (pos, z, REALP, "real")
 161
 162 #define SCM_VALIDATE_NUMBER(pos, z) SCM_MAKE_VALIDATE_MSG (pos, z, NUMBERP, "number")
 163
 164 #define SCM_VALIDATE_USHORT_COPY(pos, k, cvar) \
 165   do { \
 166     cvar = SCM_NUM2USHORT (pos, k); \
 167   } while (0)
 168
 169 #define SCM_VALIDATE_SHORT_COPY(pos, k, cvar) \
 170   do { \
 171     cvar = SCM_NUM2SHORT (pos, k); \
 172   } while (0)
 173
 174 #define SCM_VALIDATE_UINT_COPY(pos, k, cvar) \
 175   do { \
 176     cvar = SCM_NUM2UINT (pos, k); \
 177   } while (0)
 178
 179 #define SCM_VALIDATE_INT_COPY(pos, k, cvar) \
 180   do { \
 181     cvar = SCM_NUM2INT (pos, k); \
 182   } while (0)
 183
 184 #define SCM_VALIDATE_ULONG_COPY(pos, k, cvar) \
 185   do { \
 186     cvar = SCM_NUM2ULONG (pos, k); \
 187   } while (0)
 188
 189 #define SCM_VALIDATE_LONG_COPY(pos, k, cvar) \
 190   do { \
 191     cvar = SCM_NUM2LONG (pos, k); \
 192   } while (0)
 193
 194 #define SCM_VALIDATE_FLOAT_COPY(pos, k, cvar) \
 195   do { \
 196     cvar = SCM_NUM2FLOAT (pos, k); \
 197   } while (0)
 198
 199 #define SCM_VALIDATE_DOUBLE_COPY(pos, k, cvar) \
 200   do { \
 201     cvar = SCM_NUM2DOUBLE (pos, k); \
 202   } while (0)
 203
 204 #define SCM_VALIDATE_DOUBLE_DEF_COPY(pos, k, default, cvar) \
 205   do { \
 206     if (SCM_UNBNDP (k)) \
 207       { \
 208         k = scm_make_real (default); \
 209         cvar = default; \
 210       } \
 211     else \
 212       { \
 213         cvar = SCM_NUM2DOUBLE (pos, k); \
 214       } \
 215   } while (0)
 216
 217 #define SCM_VALIDATE_NULL(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, NULLP, "null")
 218
 219 #define SCM_VALIDATE_NULL_OR_NIL(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, NULL_OR_NIL_P, "null")
 220
 221 #define SCM_VALIDATE_CONS(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, CONSP, "pair")
 222
 223 #define SCM_VALIDATE_LIST(pos, lst) \
 224   do { \
 225     SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); \
 226   } while (0)
 227
 228 #define SCM_VALIDATE_NONEMPTYLIST(pos, lst) \
 229   do { \
 230     SCM_ASSERT (scm_ilength (lst) > 0, lst, pos, FUNC_NAME); \
 231   } while (0)
 232
 233 #define SCM_VALIDATE_LIST_COPYLEN(pos, lst, cvar) \
 234   do { \
 235     cvar = scm_ilength (lst); \
 236     SCM_ASSERT (cvar >= 0, lst, pos, FUNC_NAME); \
 237   } while (0)
 238
 239 #define SCM_VALIDATE_NONEMPTYLIST_COPYLEN(pos, lst, cvar) \
 240   do { \
 241     cvar = scm_ilength (lst); \
 242     SCM_ASSERT (cvar >= 1, lst, pos, FUNC_NAME); \
 243   } while (0)
 244
 245 #define SCM_VALIDATE_ALISTCELL(pos, alist) \
 246   do { \
 247     SCM_ASSERT (SCM_CONSP (alist) && SCM_CONSP (SCM_CAR (alist)), \
 248                 alist, pos, FUNC_NAME); \
 249   } while (0)
 250
 251 #define SCM_VALIDATE_ALISTCELL_COPYSCM(pos, alist, cvar) \
 252   do { \
 253     SCM_ASSERT (SCM_CONSP (alist), alist, pos, FUNC_NAME); \
 254     cvar = SCM_CAR (alist); \
 255     SCM_ASSERT (SCM_CONSP (cvar), alist, pos, FUNC_NAME); \
 256   } while (0)
 257
 258 #define SCM_VALIDATE_OPORT_VALUE(pos, port) \
 259   do { \
 260     SCM_ASSERT (scm_valid_oport_value_p (port), port, pos, FUNC_NAME); \
 261   } while (0)
 262
 263 #define SCM_VALIDATE_PRINTSTATE(pos, a) SCM_MAKE_VALIDATE_MSG(pos, a, PRINT_STATE_P, "print-state")
 264
 265 #define SCM_VALIDATE_SMOB(pos, obj, type) \
 266   do { \
 267     SCM_ASSERT (SCM_TYP16_PREDICATE (scm_tc16_ ## type, obj), \
 268                 obj, pos, FUNC_NAME); \
 269   } while (0)
 270
 271 #define SCM_VALIDATE_THUNK(pos, thunk) \
 272   do { \
 273     SCM_ASSERT (scm_is_true (scm_thunk_p (thunk)), thunk, pos, FUNC_NAME); \
 274   } while (0)
 275
 276 #define SCM_VALIDATE_SYMBOL(pos, str) \
 277   do { \
 278     SCM_ASSERT_TYPE (scm_is_symbol (str), str, pos, FUNC_NAME, "symbol"); \
 279   } while (0)
 280
 281 #define SCM_VALIDATE_VARIABLE(pos, var) SCM_MAKE_VALIDATE_MSG (pos, var, VARIABLEP, "variable")
 282
 283 #define SCM_VALIDATE_MEMOIZED(pos, obj) SCM_MAKE_VALIDATE_MSG (pos, obj, MEMOIZEDP, "memoized code")
 284
 285 #define SCM_VALIDATE_CLOSURE(pos, obj) SCM_MAKE_VALIDATE_MSG (pos, obj, CLOSUREP, "closure")
 286
 287 #define SCM_VALIDATE_PROC(pos, proc) \
 288   do { \
 289     SCM_ASSERT (scm_is_true (scm_procedure_p (proc)), proc, pos, FUNC_NAME); \
 290   } while (0)
 291
 292 #define SCM_VALIDATE_NULLORCONS(pos, env) \
 293   do { \
 294     SCM_ASSERT (SCM_NULLP (env) || SCM_CONSP (env), env, pos, FUNC_NAME); \
 295   } while (0)
 296
 297 #define SCM_VALIDATE_HOOK(pos, a) SCM_MAKE_VALIDATE_MSG (pos, a, HOOKP, "hook")
 298
 299 #define SCM_VALIDATE_RGXP(pos, a) SCM_MAKE_VALIDATE_MSG (pos, a, RGXP, "regexp")
 300
 301 #define SCM_VALIDATE_DIR(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, DIRP, "directory port")
 302
 303 #define SCM_VALIDATE_PORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, PORTP, "port")
 304
 305 #define SCM_VALIDATE_INPUT_PORT(pos, port) \
 306   SCM_MAKE_VALIDATE_MSG (pos, port, INPUT_PORT_P, "input port")
 307
 308 #define SCM_VALIDATE_OUTPUT_PORT(pos, port) \
 309   SCM_MAKE_VALIDATE_MSG (pos, port, OUTPUT_PORT_P, "output port")
 310
 311 #define SCM_VALIDATE_FPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, FPORTP, "file port")
 312
 313 #define SCM_VALIDATE_OPFPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, OPFPORTP, "open file port")
 314
 315 #define SCM_VALIDATE_OPINPORT(pos, port) \
 316   SCM_MAKE_VALIDATE_MSG (pos, port, OPINPORTP, "open input port")
 317
 318 #define SCM_VALIDATE_OPENPORT(pos, port) \
 319   do { \
 320     SCM_ASSERT (SCM_PORTP (port) && SCM_OPENP (port), \
 321                 port, pos, FUNC_NAME); \
 322   } while (0)
 323
 324 #define SCM_VALIDATE_OPPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, OPPORTP, "open port")
 325
 326 #define SCM_VALIDATE_OPOUTPORT(pos, port) \
 327   SCM_MAKE_VALIDATE_MSG (pos, port, OPOUTPORTP, "open output port")
 328
 329 #define SCM_VALIDATE_OPOUTSTRPORT(pos, port) \
 330   SCM_MAKE_VALIDATE_MSG (pos, port, OPOUTSTRPORTP, "open output string port")
 331
 332 #define SCM_VALIDATE_FLUID(pos, fluid) SCM_MAKE_VALIDATE_MSG (pos, fluid, FLUIDP, "fluid")
 333
 334 #define SCM_VALIDATE_KEYWORD(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, KEYWORDP, "keyword")
 335
 336 #define SCM_VALIDATE_STACK(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, STACKP, "stack")
 337
 338 #define SCM_VALIDATE_FRAME(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, FRAMEP, "frame")
 339
 340 #define SCM_VALIDATE_RSTATE(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, RSTATEP, "random-generator-state")
 341
 342 #define SCM_VALIDATE_ARRAY(pos, v) \
 343   do { \
 344     SCM_ASSERT (!SCM_IMP (v) \
 345                 && scm_is_true (scm_array_p (v, SCM_UNDEFINED)), \
 346                 v, pos, FUNC_NAME); \
 347   } while (0)
 348
 349 #define SCM_VALIDATE_VECTOR(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, VECTORP, "vector")
 350
 351 #define SCM_VALIDATE_VECTOR_OR_DVECTOR(pos, v) \
 352   do { \
 353     SCM_ASSERT ((SCM_VECTORP (v) \
 354                 || (!SCM_IMP (v) && SCM_TYP7 (v) == scm_tc7_dvect)), \
 355                 v, pos, FUNC_NAME); \
 356   } while (0)
 357
 358 #define SCM_VALIDATE_STRUCT(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, STRUCTP, "struct")
 359
 360 #define SCM_VALIDATE_VTABLE(pos, v) \
 361   do { \
 362     SCM_ASSERT (!SCM_IMP (v) && scm_is_true (scm_struct_vtable_p (v)), \
 363                 v, pos, FUNC_NAME); \
 364   } while (0)
 365
 366 #define SCM_VALIDATE_VECTOR_LEN(pos, v, len) \
 367   do { \
 368     SCM_ASSERT (SCM_VECTORP (v) && len == SCM_VECTOR_LENGTH (v), v, pos, FUNC_NAME); \
 369   } while (0)
 370
 371
 372 #endif  /* SCM_VALIDATE_H */
 373
 374 /*
 375   Local Variables:
 376   c-file-style: "gnu"
 377   End:
 378 */