libguile/validate.h

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