libguile/validate.h

   1 /* $Id: validate.h,v 1.21 2000-12-08 17:32:56 kei 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_WTA(pos, scm) \
  58   do { scm_wta (scm, (char *) pos, FUNC_NAME); } while (0)
  59
  60 #define RETURN_SCM_WTA(pos, scm) \
  61   do { return scm_wta (scm, (char *) pos, FUNC_NAME); } while (0)
  62
  63 #define SCM_MISC_ERROR(str, args) \
  64   do { scm_misc_error (FUNC_NAME, str, args); } while (0)
  65
  66 #define SCM_WRONG_TYPE_ARG(pos, obj) \
  67   do { scm_wrong_type_arg (FUNC_NAME, pos, obj); } while (0)
  68
  69 #define SCM_NUM2ULONG(pos, arg) (scm_num2ulong (arg, (char *) pos, FUNC_NAME))
  70
  71 #define SCM_NUM2LONG(pos, arg) (scm_num2long (arg, (char *) pos, FUNC_NAME))
  72
  73 #define SCM_NUM2LONG_DEF(pos, arg, def) \
  74   (SCM_UNBNDP (arg) ? def : scm_num2long (arg, (char *) pos, FUNC_NAME))
  75
  76 #define SCM_NUM2LONG_LONG(pos, arg) \
  77   (scm_num2long_long (arg, (char *) pos, FUNC_NAME))
  78
  79 #define SCM_OUT_OF_RANGE(pos, arg) \
  80   do { scm_out_of_range_pos (FUNC_NAME, arg, SCM_MAKINUM (pos)); } while (0)
  81
  82 #define SCM_ASSERT_RANGE(pos, arg, f) \
  83   do { if (!(f)) scm_out_of_range (FUNC_NAME, arg); } while (0)
  84
  85 #define SCM_MUST_MALLOC_TYPE(type) \
  86   ((type *) scm_must_malloc (sizeof (type), FUNC_NAME))
  87
  88 #define SCM_MUST_MALLOC_TYPE_NUM(type, num) \
  89   ((type *) scm_must_malloc (sizeof (type) * (num), FUNC_NAME))
  90
  91 #define SCM_MUST_MALLOC(size) (scm_must_malloc ((size), FUNC_NAME))
  92
  93 #define SCM_MAKE_VALIDATE(pos, var, pred) \
  94   do { \
  95     SCM_ASSERT_TYPE (SCM_ ## pred (var), var, pos, FUNC_NAME, #pred); \
  96   } while (0)
  97
  98 \f
  99
 100 #define SCM_VALIDATE_REST_ARGUMENT(x) \
 101   do { \
 102     if (SCM_DEBUG_REST_ARGUMENT) { \
 103       if (scm_ilength (x) < 0) { \
 104         SCM_MISC_ERROR ("Rest arguments do not form a proper list.", SCM_EOL); \
 105       } \
 106     } \
 107   } while (0)
 108
 109 #define SCM_VALIDATE_NIM(pos, scm) SCM_MAKE_VALIDATE (pos, scm, NIMP)
 110
 111 #define SCM_VALIDATE_BOOL(pos, flag) SCM_MAKE_VALIDATE(pos, flag, BOOLP)
 112
 113 #define SCM_VALIDATE_BOOL_COPY(pos, flag, cvar) \
 114   do { \
 115     SCM_ASSERT (SCM_BOOLP (flag), flag, pos, FUNC_NAME); \
 116     cvar = SCM_EQ_P (flag, SCM_BOOL_T) ? 1 : 0; \
 117   } while (0)
 118
 119 #define SCM_VALIDATE_CHAR(pos, scm) SCM_MAKE_VALIDATE (pos, scm, CHARP)
 120
 121 #define SCM_VALIDATE_CHAR_COPY(pos, scm, cvar) \
 122   do { \
 123     SCM_ASSERT (SCM_CHARP (scm), scm, pos, FUNC_NAME); \
 124     cvar = SCM_CHAR (scm); \
 125   } while (0)
 126
 127 #define SCM_VALIDATE_STRING(pos, str) SCM_MAKE_VALIDATE (pos, str, STRINGP)
 128
 129 #define SCM_VALIDATE_STRING_COPY(pos, str, cvar) \
 130   do { \
 131     SCM_ASSERT (SCM_STRINGP (str), str, pos, FUNC_NAME); \
 132     cvar = SCM_STRING_CHARS(str); \
 133   } while (0)
 134
 135 #define SCM_VALIDATE_REAL(pos, z) SCM_MAKE_VALIDATE (pos, z, REALP)
 136
 137 #define SCM_VALIDATE_NUMBER_COPY(pos, z, cvar)  \
 138   do {                                          \
 139     if (SCM_INUMP (z))                          \
 140       cvar = (double) SCM_INUM (z);             \
 141     else if (SCM_REALP (z))                     \
 142       cvar = SCM_REAL_VALUE (z);                \
 143     else if (SCM_BIGP (z))                      \
 144       cvar = scm_big2dbl (z);                   \
 145     else                                        \
 146       {                                         \
 147         cvar = 0.0;                             \
 148         SCM_WTA (pos, z);                       \
 149       }                                         \
 150   } while (0)
 151
 152 #define SCM_VALIDATE_NUMBER_DEF_COPY(pos, number, def, cvar)    \
 153   do {                                                          \
 154     if (SCM_UNBNDP (number))                                    \
 155       cvar = def;                                               \
 156     else                                                        \
 157       SCM_VALIDATE_NUMBER_COPY(pos, number, cvar);              \
 158   } while (0)
 159
 160 #define SCM_VALIDATE_INUM(pos, k) SCM_MAKE_VALIDATE (pos, k, INUMP)
 161
 162 #define SCM_VALIDATE_INUM_COPY(pos, k, cvar) \
 163   do { \
 164     SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 165     cvar = SCM_INUM (k); \
 166   } while (0)
 167
 168 #define SCM_VALIDATE_ULONG_COPY(pos, k, cvar) \
 169   do { \
 170     cvar = SCM_NUM2ULONG (pos, k); \
 171   } while (0)
 172
 173 #define SCM_VALIDATE_LONG_COPY(pos, k, cvar) \
 174   do { \
 175     cvar = SCM_NUM2LONG(pos, k); \
 176   } while (0)
 177
 178 #define SCM_VALIDATE_BIGINT(pos, k) SCM_MAKE_VALIDATE (pos, k, BIGP)
 179
 180 #define SCM_VALIDATE_INUM_MIN(pos, k, min) \
 181   do { \
 182     SCM_ASSERT (SCM_INUMP(k), k, pos, FUNC_NAME); \
 183     SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
 184   } while (0)
 185
 186 #define SCM_VALIDATE_INUM_MIN_COPY(pos, k, min, cvar) \
 187   do { \
 188     SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 189     SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
 190     cvar = SCM_INUM (k); \
 191   } while (0)
 192
 193 #define SCM_VALIDATE_INUM_MIN_DEF_COPY(pos, k, min, default, cvar) \
 194   do { \
 195     if (SCM_UNBNDP (k)) \
 196       k = SCM_MAKINUM (default); \
 197     SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 198     SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
 199     cvar = SCM_INUM (k); \
 200   } while (0)
 201
 202 #define SCM_VALIDATE_INUM_DEF(pos, k, default) \
 203   do { \
 204     if (SCM_UNBNDP (k)) \
 205       k = SCM_MAKINUM (default); \
 206     else SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 207   } while (0)
 208
 209 #define SCM_VALIDATE_INUM_DEF_COPY(pos, k, default, cvar) \
 210   do { \
 211     if (SCM_UNBNDP (k)) \
 212       { \
 213         k = SCM_MAKINUM (default); \
 214         cvar = default; \
 215       } \
 216     else \
 217       { \
 218         SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 219         cvar = SCM_INUM (k); \
 220       } \
 221   } while (0)
 222
 223 /* [low,high) */
 224 #define SCM_VALIDATE_INUM_RANGE(pos,k,low,high) \
 225   do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
 226        SCM_ASSERT_RANGE(pos,k, \
 227                         (SCM_INUM (k) >= low && \
 228                          SCM_INUM (k) < high)); \
 229      } while (0)
 230
 231 #define SCM_VALIDATE_INUM_RANGE_COPY(pos, k, low, high, cvar) \
 232   do { \
 233     SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
 234     SCM_ASSERT_RANGE (pos, k, low <= SCM_INUM (k) && SCM_INUM (k) < high); \
 235     cvar = SCM_INUM (k); \
 236   } while (0)
 237
 238 #define SCM_VALIDATE_NULL(pos, scm) SCM_MAKE_VALIDATE (pos, scm, NULLP)
 239
 240 #define SCM_VALIDATE_CONS(pos, scm) SCM_MAKE_VALIDATE (pos, scm, CONSP)
 241
 242 #define SCM_VALIDATE_LIST(pos, lst) \
 243   do { \
 244     SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); \
 245   } while (0)
 246
 247 #define SCM_VALIDATE_NONEMPTYLIST(pos, lst) \
 248   do { \
 249     SCM_ASSERT (scm_ilength (lst) > 0, lst, pos, FUNC_NAME); \
 250   } while (0)
 251
 252 #define SCM_VALIDATE_LIST_COPYLEN(pos, lst, cvar) \
 253   do { \
 254     cvar = scm_ilength (lst); \
 255     SCM_ASSERT (cvar >= 0, lst, pos, FUNC_NAME); \
 256   } while (0)
 257
 258 #define SCM_VALIDATE_NONEMPTYLIST_COPYLEN(pos, lst, cvar) \
 259   do { \
 260     cvar = scm_ilength (lst); \
 261     SCM_ASSERT (cvar >= 1, lst, pos, FUNC_NAME); \
 262   } while (0)
 263
 264 #define SCM_VALIDATE_ALISTCELL(pos, alist) \
 265   do { \
 266     SCM_ASSERT (SCM_CONSP (alist) && SCM_CONSP (SCM_CAR (alist)), \
 267                 alist, pos, FUNC_NAME); \
 268   } while (0)
 269
 270 #define SCM_VALIDATE_ALISTCELL_COPYSCM(pos, alist, cvar) \
 271   do { \
 272     SCM_ASSERT (SCM_CONSP (alist), alist, pos, FUNC_NAME); \
 273     cvar = SCM_CAR (alist); \
 274     SCM_ASSERT (SCM_CONSP (cvar), alist, pos, FUNC_NAME); \
 275   } while (0)
 276
 277 #define SCM_VALIDATE_OPORT_VALUE(pos, port) \
 278   do { \
 279     SCM_ASSERT (scm_valid_oport_value_p (port), port, pos, FUNC_NAME); \
 280   } while (0)
 281
 282 #define SCM_VALIDATE_PRINTSTATE(pos, a) SCM_MAKE_VALIDATE(pos,a,PRINT_STATE_P)
 283
 284 #define SCM_VALIDATE_SMOB(pos, obj, type) \
 285   do { \
 286     SCM_ASSERT (SCM_TYP16_PREDICATE (scm_tc16_ ## type, obj), \
 287                 obj, pos, FUNC_NAME); \
 288   } while (0)
 289
 290 #define SCM_VALIDATE_THREAD(pos, a) SCM_MAKE_VALIDATE (pos, a, THREADP)
 291
 292 #define SCM_VALIDATE_THUNK(pos, thunk) \
 293   do { \
 294     SCM_ASSERT (SCM_NFALSEP (scm_thunk_p (thunk)), thunk, pos, FUNC_NAME); \
 295   } while (0)
 296
 297 #define SCM_VALIDATE_SYMBOL(pos, sym) SCM_MAKE_VALIDATE (pos, sym, SYMBOLP)
 298
 299 #define SCM_VALIDATE_VARIABLE(pos, var) SCM_MAKE_VALIDATE (pos, var, VARIABLEP)
 300
 301 #define SCM_VALIDATE_MEMOIZED(pos, obj) SCM_MAKE_VALIDATE (pos, obj, MEMOIZEDP)
 302
 303 #define SCM_VALIDATE_CLOSURE(pos, obj) SCM_MAKE_VALIDATE (pos, obj, CLOSUREP)
 304
 305 #define SCM_VALIDATE_PROC(pos, proc) \
 306   do { \
 307     SCM_ASSERT (SCM_EQ_P (scm_procedure_p (proc), SCM_BOOL_T), proc, pos, FUNC_NAME); \
 308   } while (0)
 309
 310 #define SCM_VALIDATE_NULLORCONS(pos, env) \
 311   do { \
 312     SCM_ASSERT (SCM_NULLP (env) || SCM_CONSP (env), env, pos, FUNC_NAME); \
 313   } while (0)
 314
 315 #define SCM_VALIDATE_HOOK(pos, a) SCM_MAKE_VALIDATE (pos, a, HOOKP)
 316
 317 #define SCM_VALIDATE_RGXP(pos, a) SCM_MAKE_VALIDATE (pos, a, RGXP)
 318
 319 #define SCM_VALIDATE_OPDIR(pos, port) SCM_MAKE_VALIDATE (pos, port, OPDIRP)
 320
 321 #define SCM_VALIDATE_DIR(pos, port) SCM_MAKE_VALIDATE (pos, port, DIRP)
 322
 323 #define SCM_VALIDATE_PORT(pos, port) SCM_MAKE_VALIDATE (pos, port, PORTP)
 324
 325 #define SCM_VALIDATE_INPUT_PORT(pos, port) \
 326   SCM_MAKE_VALIDATE (pos, port, INPUT_PORT_P)
 327
 328 #define SCM_VALIDATE_OUTPUT_PORT(pos, port) \
 329   SCM_MAKE_VALIDATE (pos, port, OUTPUT_PORT_P)
 330
 331 #define SCM_VALIDATE_FPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, FPORTP)
 332
 333 #define SCM_VALIDATE_OPFPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, OPFPORTP)
 334
 335 #define SCM_VALIDATE_OPINPORT(pos, port) \
 336   SCM_MAKE_VALIDATE (pos, port, OPINPORTP)
 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 (pos, port, OPPORTP)
 345
 346 #define SCM_VALIDATE_OPOUTPORT(pos, port) \
 347   SCM_MAKE_VALIDATE (pos, port, OPOUTPORTP)
 348
 349 #define SCM_VALIDATE_FLUID(pos, fluid) SCM_MAKE_VALIDATE (pos, fluid, FLUIDP)
 350
 351 #define SCM_VALIDATE_KEYWORD(pos, v) SCM_MAKE_VALIDATE (pos, v, KEYWORDP)
 352
 353 #define SCM_VALIDATE_STACK(pos, v) SCM_MAKE_VALIDATE (pos, v, STACKP)
 354
 355 #define SCM_VALIDATE_FRAME(pos, v) SCM_MAKE_VALIDATE (pos, v, FRAMEP)
 356
 357 #define SCM_VALIDATE_RSTATE(pos, v) SCM_MAKE_VALIDATE (pos, v, RSTATEP)
 358
 359 #define SCM_VALIDATE_ARRAY(pos,v) \
 360   do { \
 361     SCM_ASSERT (SCM_NIMP (v) \
 362                 && !SCM_FALSEP (scm_array_p (v, SCM_UNDEFINED)), \
 363                 v, pos, FUNC_NAME); \
 364   } while (0)
 365
 366 #define SCM_VALIDATE_VECTOR(pos, v) SCM_MAKE_VALIDATE (pos, v, VECTORP)
 367
 368 #define SCM_VALIDATE_VECTOR_OR_DVECTOR(pos, v) \
 369   do { \
 370     SCM_ASSERT ((SCM_VECTORP (v) \
 371                 || (SCM_NIMP (v) && SCM_TYP7 (v) == scm_tc7_dvect)), \
 372                 v, pos, FUNC_NAME); \
 373   } while (0)
 374
 375 #define SCM_VALIDATE_STRUCT(pos, v) SCM_MAKE_VALIDATE (pos, v, STRUCTP)
 376
 377 #define SCM_VALIDATE_VTABLE(pos, v) \
 378   do { \
 379     SCM_ASSERT (SCM_NIMP (v) && SCM_NFALSEP (scm_struct_vtable_p (v)), \
 380                 v, pos, FUNC_NAME); \
 381   } while (0)
 382
 383 #define SCM_VALIDATE_VECTOR_LEN(pos, v, len) \
 384   do { \
 385     SCM_ASSERT (SCM_VECTORP (v) && len == SCM_VECTOR_LENGTH (v), v, pos, FUNC_NAME); \
 386   } while (0)
 387
 388 \f
 389
 390 #if (SCM_DEBUG_DEPRECATED == 0)
 391
 392 #define SCM_VALIDATE_STRINGORSUBSTR SCM_VALIDATE_STRING
 393
 394 #define SCM_VALIDATE_ROSTRING(pos, str) SCM_MAKE_VALIDATE (pos, str, ROSTRINGP)
 395
 396 #define SCM_VALIDATE_ROSTRING_COPY(pos, str, cvar) \
 397   do { \
 398     SCM_ASSERT (SCM_ROSTRINGP (str), str, pos, FUNC_NAME); \
 399     cvar = SCM_ROCHARS (str); \
 400   } while (0)
 401
 402 #define SCM_VALIDATE_NULLORROSTRING_COPY(pos, str, cvar) \
 403   do { \
 404     SCM_ASSERT (SCM_FALSEP (str) || SCM_ROSTRINGP (str), \
 405                 str, pos, FUNC_NAME); \
 406     if (SCM_FALSEP(str)) \
 407       cvar = NULL; \
 408     else \
 409       cvar = SCM_ROCHARS(str); \
 410   } while (0)
 411
 412 #define SCM_VALIDATE_RWSTRING(pos, str) \
 413   do { \
 414     SCM_ASSERT (SCM_STRINGP (str), str, pos, FUNC_NAME); \
 415     if (!SCM_RWSTRINGP (str)) \
 416       scm_misc_error (FUNC_NAME, "argument is a read-only string", str); \
 417   } while (0)
 418
 419 #endif  /* SCM_DEBUG_DEPRECATED == 0 */
 420
 421 #endif
 422
 423 /*
 424   Local Variables:
 425   c-file-style: "gnu"
 426   End:
 427 */