libguile/validate.h

   1 /* $Id: validate.h,v 1.7 2000-04-17 02:55:00 mdj Exp $ */
   2 /*      Copyright (C) 1999, 2000 Free Software Foundation, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2, or (at your option)
   7  * any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this software; see the file COPYING.  If not, write to
  16  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  17  * Boston, MA 02111-1307 USA
  18  *
  19  * As a special exception, the Free Software Foundation gives permission
  20  * for additional uses of the text contained in its release of GUILE.
  21  *
  22  * The exception is that, if you link the GUILE library with other files
  23  * to produce an executable, this does not by itself cause the
  24  * resulting executable to be covered by the GNU General Public License.
  25  * Your use of that executable is in no way restricted on account of
  26  * linking the GUILE library code into it.
  27  *
  28  * This exception does not however invalidate any other reasons why
  29  * the executable file might be covered by the GNU General Public License.
  30  *
  31  * This exception applies only to the code released by the
  32  * Free Software Foundation under the name GUILE.  If you copy
  33  * code from other Free Software Foundation releases into a copy of
  34  * GUILE, as the General Public License permits, the exception does
  35  * not apply to the code that you add in this way.  To avoid misleading
  36  * anyone as to the status of such modified files, you must delete
  37  * this exception notice from them.
  38  *
  39  * If you write modifications of your own for GUILE, it is your choice
  40  * whether to permit this exception to apply to your modifications.
  41  * If you do not wish that, delete this exception notice.  */
  42
  43 /* Written by Greg J. Badros <gjb@cs.washington.edu>, Dec-1999 */
  44
  45 #ifndef SCM_VALIDATE_H__
  46 #define SCM_VALIDATE_H__
  47
  48 #define SCM_FUNC_NAME (scm_makfrom0str (FUNC_NAME))
  49
  50 #define SCM_SYSERROR do { scm_syserror (FUNC_NAME); } while (0)
  51
  52 #define SCM_MEMORY_ERROR do { scm_memory_error (FUNC_NAME); } while (0)
  53
  54 #define SCM_SYSERROR_MSG(str, args, val) \
  55   do { scm_syserror_msg (FUNC_NAME, (str), (args), (val)); } while (0)
  56
  57 #define SCM_COERCE_ROSTRING(pos, scm) \
  58   do { scm = scm_coerce_rostring (scm, FUNC_NAME, pos); } while (0)
  59
  60 #define SCM_WTA(pos, scm) \
  61   do { scm_wta (scm, (char *) pos, FUNC_NAME); } while (0)
  62
  63 #define RETURN_SCM_WTA(pos, scm) \
  64   do { return scm_wta (scm, (char *) pos, FUNC_NAME); } while (0)
  65
  66 #define SCM_MISC_ERROR(str, args) \
  67   do { scm_misc_error (FUNC_NAME, str, args); } while (0)
  68
  69 #define SCM_WRONG_TYPE_ARG(pos, obj) \
  70   do { scm_wrong_type_arg (FUNC_NAME, pos, obj); } while (0)
  71
  72 #define SCM_NUM2ULONG(pos, arg) (scm_num2ulong (arg, (char *) pos, FUNC_NAME))
  73
  74 #define SCM_NUM2LONG(pos, arg) (scm_num2long (arg, (char *) pos, FUNC_NAME))
  75
  76 #define SCM_NUM2LONG_DEF(pos, arg, def) \
  77   (SCM_UNBNDP (arg) ? def : scm_num2long (arg, (char *) pos, FUNC_NAME))
  78
  79 #define SCM_NUM2LONG_LONG(pos, arg) \
  80   (scm_num2long_long (arg, (char *) pos, FUNC_NAME))
  81
  82 #define SCM_OUT_OF_RANGE(pos, arg) \
  83   do { scm_out_of_range_pos (FUNC_NAME, arg, SCM_MAKINUM (pos)); } while (0)
  84
  85 #define SCM_ASSERT_RANGE(pos, arg, f) \
  86   do { SCM_ASSERT (f, arg, SCM_OUTOFRANGE, FUNC_NAME); } while (0)
  87
  88 #define SCM_MUST_MALLOC_TYPE(type) \
  89   ((type *) scm_must_malloc (sizeof (type), FUNC_NAME))
  90
  91 #define SCM_MUST_MALLOC_TYPE_NUM(type, num) \
  92   ((type *) scm_must_malloc (sizeof (type) * (num), FUNC_NAME))
  93
  94 #define SCM_MUST_MALLOC(size) (scm_must_malloc ((size), FUNC_NAME))
  95
  96 #define SCM_MAKE_VALIDATE(pos, var, pred) \
  97   do { \
  98     SCM_ASSERT_TYPE (SCM_ ## pred (var), var, pos, FUNC_NAME, #pred); \
  99   } while (0)
 100
 101 \f
 102
 103 #define SCM_VALIDATE_NIM(pos, scm) SCM_MAKE_VALIDATE (pos, scm, NIMP)
 104
 105 #define SCM_VALIDATE_BOOL(pos, flag) SCM_MAKE_VALIDATE(pos, flag, BOOLP)
 106
 107 #define SCM_VALIDATE_BOOL_COPY(pos, flag, cvar) \
 108   do { \
 109     SCM_ASSERT (SCM_BOOLP (flag), flag, pos, FUNC_NAME); \
 110     cvar = SCM_TRUE_P (flag) ? 1 : 0; \
 111   } while (0)
 112
 113 #define SCM_VALIDATE_CHAR(pos, scm) SCM_MAKE_VALIDATE (pos, scm, ICHRP)
 114
 115 #define SCM_VALIDATE_CHAR_COPY(pos, scm, cvar) \
 116   do { \
 117     SCM_ASSERT (SCM_CHARP (scm), scm, pos, FUNC_NAME); \
 118     cvar = SCM_CHAR (scm); \
 119   } while (0)
 120
 121 #define SCM_VALIDATE_ROSTRING(pos, str) SCM_MAKE_VALIDATE (pos, str, ROSTRINGP)
 122
 123 #define SCM_VALIDATE_ROSTRING_COPY(pos, str, cvar) \
 124   do { \
 125     SCM_ASSERT (SCM_ROSTRINGP (str), str, pos, FUNC_NAME); \
 126     cvar = SCM_ROCHARS (str); \
 127   } while (0)
 128
 129 #define SCM_VALIDATE_NULLORROSTRING_COPY(pos, str, cvar) \
 130   do { \
 131     SCM_ASSERT (SCM_FALSEP (str) || SCM_ROSTRINGP (str), \
 132                 str, pos, FUNC_NAME); \
 133     if (SCM_FALSEP(str)) \
 134       cvar = NULL; \
 135     else \
 136       cvar = SCM_ROCHARS(str); \
 137   } while (0)
 138
 139 #define SCM_VALIDATE_STRING(pos, str) SCM_MAKE_VALIDATE (pos, str, STRINGP)
 140
 141 #define SCM_VALIDATE_STRINGORSUBSTR(pos, str) \
 142   do { \
 143     SCM_ASSERT (SCM_STRINGP (str) || SCM_SUBSTRP (str), \
 144                 str, pos, FUNC_NAME); \
 145   } while (0)
 146
 147 #define SCM_VALIDATE_STRING_COPY(pos, str, cvar) \
 148   do { \
 149     SCM_ASSERT (SCM_STRINGP (str), str, pos, FUNC_NAME); \
 150     cvar = SCM_CHARS(str); \
 151   } while (0)
 152
 153 #define SCM_VALIDATE_RWSTRING(pos, str) \
 154   do { \
 155     SCM_ASSERT (SCM_STRINGP (str), str, pos, FUNC_NAME); \
 156     if (!SCM_RWSTRINGP (str)) \
 157       scm_misc_error (FUNC_NAME, "argument is a read-only string", str); \
 158   } while (0)
 159
 160 #define SCM_VALIDATE_REAL(pos, z) SCM_MAKE_VALIDATE (pos, z, REALP)
 161
 162 #define SCM_VALIDATE_REAL_COPY(pos, z, cvar)            \
 163   do {                                                  \
 164     SCM_ASSERT (SCM_REALP (z), z, pos, FUNC_NAME);      \
 165     cvar = SCM_REAL_VALUE (z);                          \
 166   } while (0)
 167
 168 #define SCM_VALIDATE_INUM(pos, k) SCM_MAKE_VALIDATE (pos, k, INUMP)
 169
 170 #define SCM_VALIDATE_INUM_COPY(pos, k, cvar) \
 171   do { \
 172     SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 173     cvar = SCM_INUM (k); \
 174   } while (0)
 175
 176 #define SCM_VALIDATE_ULONG_COPY(pos, k, cvar) \
 177   do { \
 178     cvar = SCM_NUM2ULONG (pos, k); \
 179   } while (0)
 180
 181 #define SCM_VALIDATE_LONG_COPY(pos, k, cvar) \
 182   do { \
 183     cvar = SCM_NUM2LONG(pos, k); \
 184   } while (0)
 185
 186 #define SCM_VALIDATE_BIGINT(pos, k) SCM_MAKE_VALIDATE (pos, k, BIGP)
 187
 188 #define SCM_VALIDATE_INUM_MIN(pos, k, min) \
 189   do { \
 190     SCM_ASSERT (SCM_INUMP(k), k, pos, FUNC_NAME); \
 191     SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
 192   } while (0)
 193
 194 #define SCM_VALIDATE_INUM_MIN_COPY(pos, k, min, cvar) \
 195   do { \
 196     SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 197     cvar = SCM_INUM (k); \
 198     SCM_ASSERT_RANGE (pos, k, (cvar >= min)); \
 199   } while (0)
 200
 201 #define SCM_VALIDATE_INUM_MIN_DEF_COPY(pos, k, min, default, cvar) \
 202   do { \
 203     if (SCM_UNBNDP (k)) \
 204       k = SCM_MAKINUM (default); \
 205     SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 206     cvar = SCM_INUM (k); \
 207     SCM_ASSERT_RANGE (pos, k, (cvar >= min)); \
 208   } while (0)
 209
 210 #define SCM_VALIDATE_INUM_DEF(pos, k, default) \
 211   do { \
 212     if (SCM_UNBNDP (k)) \
 213       k = SCM_MAKINUM (default); \
 214     else SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 215   } while (0)
 216
 217 #define SCM_VALIDATE_INUM_DEF_COPY(pos, k, default, cvar) \
 218   do { \
 219     if (SCM_UNBNDP (k)) \
 220       { \
 221         k = SCM_MAKINUM (default); \
 222         cvar = default; \
 223       } \
 224     else \
 225       { \
 226         SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 227         cvar = SCM_INUM (k); \
 228       } \
 229   } while (0)
 230
 231 /* [low,high) */
 232 #define SCM_VALIDATE_INUM_RANGE(pos, k, low, high) \
 233   do { \
 234     SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 235     SCM_ASSERT_RANGE (pos, k, \
 236                       (SCM_INUM (k) >= low \
 237                       && ((unsigned) SCM_INUM (k)) < high)); \
 238   } while (0)
 239
 240 #define SCM_VALIDATE_INUM_RANGE_COPY(pos, k, low, high, cvar) \
 241   do { \
 242     SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 243     cvar = SCM_INUM (k); \
 244     SCM_ASSERT_RANGE (pos, k, cvar >= low && cvar < high); \
 245   } while (0)
 246
 247 #define SCM_VALIDATE_NULL(pos, scm) SCM_MAKE_VALIDATE (pos, scm, NULLP)
 248
 249 #define SCM_VALIDATE_CONS(pos, scm) SCM_MAKE_VALIDATE (pos, scm, CONSP)
 250
 251 #define SCM_VALIDATE_LIST(pos, lst) \
 252   do { \
 253     SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); \
 254   } while (0)
 255
 256 #define SCM_VALIDATE_NONEMPTYLIST(pos, lst) \
 257   do { \
 258     SCM_ASSERT (scm_ilength (lst) > 0, lst, pos, FUNC_NAME); \
 259   } while (0)
 260
 261 #define SCM_VALIDATE_LIST_COPYLEN(pos, lst, cvar) \
 262   do { \
 263     cvar = scm_ilength (lst); \
 264     SCM_ASSERT (cvar >= 0, lst, pos, FUNC_NAME); \
 265   } while (0)
 266
 267 #define SCM_VALIDATE_NONEMPTYLIST_COPYLEN(pos, lst, cvar) \
 268   do { \
 269     cvar = scm_ilength (lst); \
 270     SCM_ASSERT (cvar >= 1, lst, pos, FUNC_NAME); \
 271   } while (0)
 272
 273 #define SCM_VALIDATE_ALISTCELL(pos, alist) \
 274   do { \
 275     SCM_ASSERT (SCM_CONSP (alist) && SCM_CONSP (SCM_CAR (alist)), \
 276                 alist, pos, FUNC_NAME); \
 277   } while (0)
 278
 279 #define SCM_VALIDATE_ALISTCELL_COPYSCM(pos, alist, cvar) \
 280   do { \
 281     SCM_ASSERT (SCM_CONSP (alist), alist, pos, FUNC_NAME); \
 282     cvar = SCM_CAR (alist); \
 283     SCM_ASSERT (SCM_CONSP (cvar), alist, pos, FUNC_NAME); \
 284   } while (0)
 285
 286 #define SCM_VALIDATE_OPORT_VALUE(pos, port) \
 287   do { \
 288     SCM_ASSERT (scm_valid_oport_value_p (port), port, pos, FUNC_NAME); \
 289   } while (0)
 290
 291 #define SCM_VALIDATE_PRINTSTATE(pos, a) SCM_MAKE_VALIDATE(pos,a,PRINT_STATE_P)
 292
 293 #define SCM_VALIDATE_SMOB(pos, obj, type) \
 294   do { \
 295     SCM_ASSERT ((SCM_NIMP (obj) && SCM_TYP16 (obj) == scm_tc16_ ## type), \
 296                 obj, pos, FUNC_NAME); \
 297   } while (0)
 298
 299 #define SCM_VALIDATE_THREAD(pos, a) SCM_MAKE_VALIDATE (pos, a, THREADP)
 300
 301 #define SCM_VALIDATE_THUNK(pos, thunk) \
 302   do { \
 303     SCM_ASSERT (SCM_NFALSEP (scm_thunk_p (thunk)), thunk, pos, FUNC_NAME); \
 304   } while (0)
 305
 306 #define SCM_VALIDATE_SYMBOL(pos, sym) SCM_MAKE_VALIDATE (pos, sym, SYMBOLP)
 307
 308 #define SCM_VALIDATE_VARIABLE(pos, var) SCM_MAKE_VALIDATE (pos, var, VARIABLEP)
 309
 310 #define SCM_VALIDATE_MEMOIZED(pos, obj) SCM_MAKE_VALIDATE (pos, obj, MEMOIZEDP)
 311
 312 #define SCM_VALIDATE_CLOSURE(pos, obj) SCM_MAKE_VALIDATE (pos, obj, CLOSUREP)
 313
 314 #define SCM_VALIDATE_PROC(pos, proc) \
 315   do { \
 316     SCM_ASSERT (SCM_TRUE_P (scm_procedure_p (proc)), proc, pos, FUNC_NAME); \
 317   } while (0)
 318
 319 #define SCM_VALIDATE_NULLORCONS(pos, env) \
 320   do { \
 321     SCM_ASSERT (SCM_NULLP (env) || SCM_CONSP (env), env, pos, FUNC_NAME); \
 322   } while (0)
 323
 324 #define SCM_VALIDATE_HOOK(pos, a) SCM_MAKE_VALIDATE (pos, a, HOOKP)
 325
 326 #define SCM_VALIDATE_RGXP(pos, a) SCM_MAKE_VALIDATE (pos, a, RGXP)
 327
 328 #define SCM_VALIDATE_OPDIR(pos, port) SCM_MAKE_VALIDATE (pos, port, OPDIRP)
 329
 330 #define SCM_VALIDATE_DIR(pos, port) SCM_MAKE_VALIDATE (pos, port, DIRP)
 331
 332 #define SCM_VALIDATE_PORT(pos, port) SCM_MAKE_VALIDATE (pos, port, PORTP)
 333
 334 #define SCM_VALIDATE_INPUT_PORT(pos, port) \
 335   SCM_MAKE_VALIDATE (pos, port, INPUT_PORT_P)
 336
 337 #define SCM_VALIDATE_OUTPUT_PORT(pos, port) \
 338   SCM_MAKE_VALIDATE (pos, port, OUTPUT_PORT_P)
 339
 340 #define SCM_VALIDATE_FPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, FPORTP)
 341
 342 #define SCM_VALIDATE_OPFPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, OPFPORTP)
 343
 344 #define SCM_VALIDATE_OPINPORT(pos, port) \
 345   SCM_MAKE_VALIDATE (pos, port, OPINPORTP)
 346
 347 #define SCM_VALIDATE_OPENPORT(pos,port) \
 348   do { \
 349     SCM_ASSERT (SCM_PORTP (port) && SCM_OPENP (port), \
 350                 port, pos, FUNC_NAME); \
 351   } while (0)
 352
 353 #define SCM_VALIDATE_OPPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, OPPORTP)
 354
 355 #define SCM_VALIDATE_OPOUTPORT(pos, port) \
 356   SCM_MAKE_VALIDATE (pos, port, OPOUTPORTP)
 357
 358 #define SCM_VALIDATE_FLUID(pos, fluid) SCM_MAKE_VALIDATE (pos, fluid, FLUIDP)
 359
 360 #define SCM_VALIDATE_KEYWORD(pos, v) SCM_MAKE_VALIDATE (pos, v, KEYWORDP)
 361
 362 #define SCM_VALIDATE_STACK(pos, v) SCM_MAKE_VALIDATE (pos, v, STACKP)
 363
 364 #define SCM_VALIDATE_FRAME(pos, v) SCM_MAKE_VALIDATE (pos, v, FRAMEP)
 365
 366 #define SCM_VALIDATE_RSTATE(pos, v) SCM_MAKE_VALIDATE (pos, v, RSTATEP)
 367
 368 #define SCM_VALIDATE_ARRAY(pos,v) \
 369   do { \
 370     SCM_ASSERT (SCM_NIMP (v) \
 371                 && !SCM_FALSEP (scm_array_p (v, SCM_UNDEFINED)), \
 372                 v, pos, FUNC_NAME); \
 373   } while (0)
 374
 375 #define SCM_VALIDATE_VECTOR(pos, v) SCM_MAKE_VALIDATE (pos, v, VECTORP)
 376
 377 #define SCM_VALIDATE_VECTOR_OR_DVECTOR(pos, v) \
 378   do { \
 379     SCM_ASSERT ((SCM_VECTORP (v) \
 380                 || (SCM_NIMP (v) && SCM_TYP7 (v) == scm_tc7_dvect)), \
 381                 v, pos, FUNC_NAME); \
 382   } while (0)
 383
 384 #define SCM_VALIDATE_STRUCT(pos, v) SCM_MAKE_VALIDATE (pos, v, STRUCTP)
 385
 386 #define SCM_VALIDATE_VTABLE(pos, v) \
 387   do { \
 388     SCM_ASSERT (SCM_NIMP (v) && SCM_NFALSEP (scm_struct_vtable_p (v)), \
 389                 v, pos, FUNC_NAME); \
 390   } while (0)
 391
 392 #define SCM_VALIDATE_VECTOR_LEN(pos, v, len) \
 393   do { \
 394     SCM_ASSERT (SCM_VECTORP (v) && len == SCM_LENGTH (v), v, pos, FUNC_NAME); \
 395   } while (0)
 396
 397 #endif
 398
 399 /*
 400   Local Variables:
 401   c-file-style: "gnu"
 402   End:
 403 */