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_from_int (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_from_int (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) \
 139   do { \
 140     SCM_ASSERT_TYPE (scm_is_bool (flag), flag, pos, FUNC_NAME, "boolean"); \
 141   } while (0)
 142
 143 #define SCM_VALIDATE_BOOL_COPY(pos, flag, cvar) \
 144   do { \
 145     SCM_ASSERT (scm_is_bool (flag), flag, pos, FUNC_NAME); \
 146     cvar = scm_to_bool (flag); \
 147   } while (0)
 148
 149 #define SCM_VALIDATE_CHAR(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, CHARP, "character")
 150
 151 #define SCM_VALIDATE_CHAR_COPY(pos, scm, cvar) \
 152   do { \
 153     SCM_ASSERT (SCM_CHARP (scm), scm, pos, FUNC_NAME); \
 154     cvar = SCM_CHAR (scm); \
 155   } while (0)
 156
 157 #define SCM_VALIDATE_STRING(pos, str) SCM_MAKE_VALIDATE_MSG (pos, str, STRINGP, "string")
 158
 159 #define SCM_VALIDATE_STRING_COPY(pos, str, cvar) \
 160   do { \
 161     SCM_ASSERT (SCM_STRINGP (str), str, pos, FUNC_NAME); \
 162     cvar = SCM_STRING_CHARS(str); \
 163   } while (0)
 164
 165 /* validate a string and optional start/end arguments which default to
 166    0/string-len.  this is unrelated to the old shared substring
 167    support, so please do not deprecate it :) */
 168 #define SCM_VALIDATE_SUBSTRING_SPEC_COPY(pos_str, str, c_str, \
 169                                          pos_start, start, c_start,\
 170                                          pos_end, end, c_end) \
 171   do {\
 172     SCM_VALIDATE_STRING_COPY (pos_str, str, c_str);\
 173     c_start = SCM_UNBNDP(start)? 0 : scm_to_size_t (start);\
 174     c_end = SCM_UNBNDP(end)? SCM_STRING_LENGTH(str) : scm_to_size_t (end);\
 175     SCM_ASSERT_RANGE (pos_start, start,\
 176                       0 <= c_start \
 177                       && (size_t) c_start <= SCM_STRING_LENGTH (str));\
 178     SCM_ASSERT_RANGE (pos_end, end,\
 179                       c_start <= c_end \
 180                       && (size_t) c_end <= SCM_STRING_LENGTH (str));\
 181   } while (0)
 182
 183 #define SCM_VALIDATE_REAL(pos, z) SCM_MAKE_VALIDATE_MSG (pos, z, REALP, "real")
 184
 185 #define SCM_VALIDATE_NUMBER(pos, z) SCM_MAKE_VALIDATE_MSG (pos, z, NUMBERP, "number")
 186
 187 #define SCM_VALIDATE_USHORT_COPY(pos, k, cvar) \
 188   do { \
 189     cvar = SCM_NUM2USHORT (pos, k); \
 190   } while (0)
 191
 192 #define SCM_VALIDATE_SHORT_COPY(pos, k, cvar) \
 193   do { \
 194     cvar = SCM_NUM2SHORT (pos, k); \
 195   } while (0)
 196
 197 #define SCM_VALIDATE_UINT_COPY(pos, k, cvar) \
 198   do { \
 199     cvar = SCM_NUM2UINT (pos, k); \
 200   } while (0)
 201
 202 #define SCM_VALIDATE_INT_COPY(pos, k, cvar) \
 203   do { \
 204     cvar = SCM_NUM2INT (pos, k); \
 205   } while (0)
 206
 207 #define SCM_VALIDATE_ULONG_COPY(pos, k, cvar) \
 208   do { \
 209     cvar = SCM_NUM2ULONG (pos, k); \
 210   } while (0)
 211
 212 #define SCM_VALIDATE_LONG_COPY(pos, k, cvar) \
 213   do { \
 214     cvar = SCM_NUM2LONG (pos, k); \
 215   } while (0)
 216
 217 #define SCM_VALIDATE_FLOAT_COPY(pos, k, cvar) \
 218   do { \
 219     cvar = SCM_NUM2FLOAT (pos, k); \
 220   } while (0)
 221
 222 #define SCM_VALIDATE_DOUBLE_COPY(pos, k, cvar) \
 223   do { \
 224     cvar = SCM_NUM2DOUBLE (pos, k); \
 225   } while (0)
 226
 227 #define SCM_VALIDATE_DOUBLE_DEF_COPY(pos, k, default, cvar) \
 228   do { \
 229     if (SCM_UNBNDP (k)) \
 230       { \
 231         k = scm_make_real (default); \
 232         cvar = default; \
 233       } \
 234     else \
 235       { \
 236         cvar = SCM_NUM2DOUBLE (pos, k); \
 237       } \
 238   } while (0)
 239
 240 #define SCM_VALIDATE_NULL(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, NULLP, "null")
 241
 242 #define SCM_VALIDATE_NULL_OR_NIL(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, NULL_OR_NIL_P, "null")
 243
 244 #define SCM_VALIDATE_CONS(pos, scm) SCM_MAKE_VALIDATE_MSG (pos, scm, CONSP, "pair")
 245
 246 #define SCM_VALIDATE_LIST(pos, lst) \
 247   do { \
 248     SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); \
 249   } while (0)
 250
 251 #define SCM_VALIDATE_NONEMPTYLIST(pos, lst) \
 252   do { \
 253     SCM_ASSERT (scm_ilength (lst) > 0, lst, pos, FUNC_NAME); \
 254   } while (0)
 255
 256 #define SCM_VALIDATE_LIST_COPYLEN(pos, lst, cvar) \
 257   do { \
 258     cvar = scm_ilength (lst); \
 259     SCM_ASSERT (cvar >= 0, lst, pos, FUNC_NAME); \
 260   } while (0)
 261
 262 #define SCM_VALIDATE_NONEMPTYLIST_COPYLEN(pos, lst, cvar) \
 263   do { \
 264     cvar = scm_ilength (lst); \
 265     SCM_ASSERT (cvar >= 1, lst, pos, FUNC_NAME); \
 266   } while (0)
 267
 268 #define SCM_VALIDATE_ALISTCELL(pos, alist) \
 269   do { \
 270     SCM_ASSERT (SCM_CONSP (alist) && SCM_CONSP (SCM_CAR (alist)), \
 271                 alist, pos, FUNC_NAME); \
 272   } while (0)
 273
 274 #define SCM_VALIDATE_ALISTCELL_COPYSCM(pos, alist, cvar) \
 275   do { \
 276     SCM_ASSERT (SCM_CONSP (alist), alist, pos, FUNC_NAME); \
 277     cvar = SCM_CAR (alist); \
 278     SCM_ASSERT (SCM_CONSP (cvar), alist, pos, FUNC_NAME); \
 279   } while (0)
 280
 281 #define SCM_VALIDATE_OPORT_VALUE(pos, port) \
 282   do { \
 283     SCM_ASSERT (scm_valid_oport_value_p (port), port, pos, FUNC_NAME); \
 284   } while (0)
 285
 286 #define SCM_VALIDATE_PRINTSTATE(pos, a) SCM_MAKE_VALIDATE_MSG(pos, a, PRINT_STATE_P, "print-state")
 287
 288 #define SCM_VALIDATE_SMOB(pos, obj, type) \
 289   do { \
 290     SCM_ASSERT (SCM_TYP16_PREDICATE (scm_tc16_ ## type, obj), \
 291                 obj, pos, FUNC_NAME); \
 292   } while (0)
 293
 294 #define SCM_VALIDATE_THUNK(pos, thunk) \
 295   do { \
 296     SCM_ASSERT (scm_is_true (scm_thunk_p (thunk)), thunk, pos, FUNC_NAME); \
 297   } while (0)
 298
 299 #define SCM_VALIDATE_SYMBOL(pos, sym) SCM_MAKE_VALIDATE_MSG (pos, sym, SYMBOLP, "symbol")
 300
 301 #define SCM_VALIDATE_VARIABLE(pos, var) SCM_MAKE_VALIDATE_MSG (pos, var, VARIABLEP, "variable")
 302
 303 #define SCM_VALIDATE_MEMOIZED(pos, obj) SCM_MAKE_VALIDATE_MSG (pos, obj, MEMOIZEDP, "memoized code")
 304
 305 #define SCM_VALIDATE_CLOSURE(pos, obj) SCM_MAKE_VALIDATE_MSG (pos, obj, CLOSUREP, "closure")
 306
 307 #define SCM_VALIDATE_PROC(pos, proc) \
 308   do { \
 309     SCM_ASSERT (scm_is_true (scm_procedure_p (proc)), proc, pos, FUNC_NAME); \
 310   } while (0)
 311
 312 #define SCM_VALIDATE_NULLORCONS(pos, env) \
 313   do { \
 314     SCM_ASSERT (SCM_NULLP (env) || SCM_CONSP (env), env, pos, FUNC_NAME); \
 315   } while (0)
 316
 317 #define SCM_VALIDATE_HOOK(pos, a) SCM_MAKE_VALIDATE_MSG (pos, a, HOOKP, "hook")
 318
 319 #define SCM_VALIDATE_RGXP(pos, a) SCM_MAKE_VALIDATE_MSG (pos, a, RGXP, "regexp")
 320
 321 #define SCM_VALIDATE_DIR(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, DIRP, "directory port")
 322
 323 #define SCM_VALIDATE_PORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, PORTP, "port")
 324
 325 #define SCM_VALIDATE_INPUT_PORT(pos, port) \
 326   SCM_MAKE_VALIDATE_MSG (pos, port, INPUT_PORT_P, "input port")
 327
 328 #define SCM_VALIDATE_OUTPUT_PORT(pos, port) \
 329   SCM_MAKE_VALIDATE_MSG (pos, port, OUTPUT_PORT_P, "output port")
 330
 331 #define SCM_VALIDATE_FPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, FPORTP, "file port")
 332
 333 #define SCM_VALIDATE_OPFPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, OPFPORTP, "open file port")
 334
 335 #define SCM_VALIDATE_OPINPORT(pos, port) \
 336   SCM_MAKE_VALIDATE_MSG (pos, port, OPINPORTP, "open input port")
 337
 338 #define SCM_VALIDATE_OPENPORT(pos, port) \
 339   do { \
 340     SCM_ASSERT (SCM_PORTP (port) && SCM_OPENP (port), \
 341                 port, pos, FUNC_NAME); \
 342   } while (0)
 343
 344 #define SCM_VALIDATE_OPPORT(pos, port) SCM_MAKE_VALIDATE_MSG (pos, port, OPPORTP, "open port")
 345
 346 #define SCM_VALIDATE_OPOUTPORT(pos, port) \
 347   SCM_MAKE_VALIDATE_MSG (pos, port, OPOUTPORTP, "open output port")
 348
 349 #define SCM_VALIDATE_OPOUTSTRPORT(pos, port) \
 350   SCM_MAKE_VALIDATE_MSG (pos, port, OPOUTSTRPORTP, "open output string port")
 351
 352 #define SCM_VALIDATE_FLUID(pos, fluid) SCM_MAKE_VALIDATE_MSG (pos, fluid, FLUIDP, "fluid")
 353
 354 #define SCM_VALIDATE_KEYWORD(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, KEYWORDP, "keyword")
 355
 356 #define SCM_VALIDATE_STACK(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, STACKP, "stack")
 357
 358 #define SCM_VALIDATE_FRAME(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, FRAMEP, "frame")
 359
 360 #define SCM_VALIDATE_RSTATE(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, RSTATEP, "random-generator-state")
 361
 362 #define SCM_VALIDATE_ARRAY(pos, v) \
 363   do { \
 364     SCM_ASSERT (!SCM_IMP (v) \
 365                 && scm_is_true (scm_array_p (v, SCM_UNDEFINED)), \
 366                 v, pos, FUNC_NAME); \
 367   } while (0)
 368
 369 #define SCM_VALIDATE_VECTOR(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, VECTORP, "vector")
 370
 371 #define SCM_VALIDATE_VECTOR_OR_DVECTOR(pos, v) \
 372   do { \
 373     SCM_ASSERT ((SCM_VECTORP (v) \
 374                 || (!SCM_IMP (v) && SCM_TYP7 (v) == scm_tc7_dvect)), \
 375                 v, pos, FUNC_NAME); \
 376   } while (0)
 377
 378 #define SCM_VALIDATE_STRUCT(pos, v) SCM_MAKE_VALIDATE_MSG (pos, v, STRUCTP, "struct")
 379
 380 #define SCM_VALIDATE_VTABLE(pos, v) \
 381   do { \
 382     SCM_ASSERT (!SCM_IMP (v) && scm_is_true (scm_struct_vtable_p (v)), \
 383                 v, pos, FUNC_NAME); \
 384   } while (0)
 385
 386 #define SCM_VALIDATE_VECTOR_LEN(pos, v, len) \
 387   do { \
 388     SCM_ASSERT (SCM_VECTORP (v) && len == SCM_VECTOR_LENGTH (v), v, pos, FUNC_NAME); \
 389   } while (0)
 390
 391 #endif  /* SCM_VALIDATE_H */
 392
 393 /*
 394   Local Variables:
 395   c-file-style: "gnu"
 396   End:
 397 */