libguile/scm_validate.h

   1 /* $Id: scm_validate.h,v 1.3 1999-12-12 18:30:09 gjb Exp $ */
   2 /*      Copyright (C) 1999 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_BOOL(f) ((f)? SCM_BOOL_T : SCM_BOOL_F)
  49 #define SCM_NEGATE_BOOL(f) ((f)? SCM_BOOL_F : SCM_BOOL_T)
  50
  51 #define SCM_FUNC_NAME (scm_makfrom0str(FUNC_NAME))
  52
  53 #define SCM_SYSERROR do { scm_syserror(FUNC_NAME); } while (0)
  54
  55 #define SCM_MEMORY_ERROR do { scm_memory_error(FUNC_NAME); } while (0)
  56
  57 #define SCM_SYSERROR_MSG(str,args,val) \
  58   do { scm_syserror_msg(FUNC_NAME,(str),(args),(val)); } while (0)
  59
  60 #define SCM_SYSMISSING \
  61   do { scm_sysmissing(FUNC_NAME); } while (0)
  62
  63 #define SCM_WTA(pos,scm) \
  64   do { scm_wta(scm,(char *)pos,FUNC_NAME); } while (0)
  65
  66 #define RETURN_SCM_WTA(pos,scm) \
  67   do { return scm_wta(scm,(char *)pos,FUNC_NAME); } while (0)
  68
  69 #define SCM_MISC_ERROR(str,args) \
  70   do { scm_misc_error(FUNC_NAME,str,args); } while (0)
  71
  72 #define SCM_WRONG_TYPE_ARG(pos,obj) \
  73   do { scm_wrong_type_arg(FUNC_NAME,pos,obj); } while (0)
  74
  75 #define SCM_NUM2ULONG(pos,arg) (scm_num2ulong(arg, (char *) pos, FUNC_NAME))
  76
  77 #define SCM_NUM2LONG(pos,arg) (scm_num2long(arg, (char *) pos, FUNC_NAME))
  78
  79 #define SCM_NUM2LONG_LONG(pos,arg) (scm_num2long_long(arg, (char *) pos, FUNC_NAME))
  80
  81 #define SCM_OUT_OF_RANGE(pos,arg) do { scm_out_of_range(FUNC_NAME,arg); } while (0)
  82
  83 #define SCM_ASSERT_RANGE(pos,arg,f) do { SCM_ASSERT(f,arg,SCM_OUTOFRANGE,FUNC_NAME); } while (0)
  84
  85 #define SCM_MUST_MALLOC_TYPE(type) ((type *) scm_must_malloc(sizeof(type), FUNC_NAME))
  86
  87 #define SCM_MUST_MALLOC_TYPE_NUM(type,num) ((type *) scm_must_malloc(sizeof(type)*(num), FUNC_NAME))
  88
  89 #define SCM_MUST_MALLOC(size) (scm_must_malloc((size), FUNC_NAME))
  90
  91 #define SCM_VALIDATE_NIM (pos,scm) \
  92   do { SCM_ASSERT(SCM_NIMP(scm), scm, pos, FUNC_NAME); } while (0)
  93
  94 #define SCM_MAKE_NIM_VALIDATE(pos,var,pred) \
  95   do { SCM_ASSERT (SCM_NIMP(var) && SCM ## pred(var), var, pos, FUNC_NAME); } while (0)
  96
  97 #define SCM_MAKE_VALIDATE(pos,var,pred) \
  98   do { SCM_ASSERT (SCM ## pred(var), var, pos, FUNC_NAME); } while (0)
  99
 100 #define SCM_VALIDATE_BOOL(pos,flag) \
 101   do { SCM_ASSERT(SCM_BOOL_T == flag || SCM_BOOL_F == flag, flag, pos, FUNC_NAME); } while (0)
 102
 103 #define SCM_VALIDATE_BOOL_COPY(pos,flag,cvar) \
 104   do { SCM_ASSERT(SCM_BOOL_T == flag || SCM_BOOL_F == flag, flag, pos, FUNC_NAME); \
 105        cvar = (SCM_BOOL_T == flag)? 1: 0; } while (0)
 106
 107 #define SCM_VALIDATE_CHAR(pos,scm) \
 108   do { SCM_ASSERT(SCM_ICHRP(scm), scm, pos, FUNC_NAME); } while (0)
 109
 110 #define SCM_VALIDATE_CHAR_COPY(pos,scm,cvar) \
 111   do { SCM_ASSERT(SCM_ICHRP(scm), scm, pos, FUNC_NAME); \
 112        cvar = SCM_ICHR(scm); } while (0)
 113
 114 #define SCM_VALIDATE_ROSTRING(pos,str) \
 115   do { SCM_ASSERT(SCM_NIMP (str) && SCM_ROSTRINGP (str), str, pos, FUNC_NAME); } while (0)
 116
 117 #define SCM_VALIDATE_ROSTRING_COPY(pos,str,cvar) \
 118   do { SCM_ASSERT(SCM_NIMP (str) && SCM_ROSTRINGP (str), str, pos, FUNC_NAME); \
 119        cvar = SCM_ROCHARS(str); } while (0)
 120
 121 #define SCM_VALIDATE_NULLORROSTRING_COPY(pos,str,cvar) \
 122   do { SCM_ASSERT(SCM_FALSEP(str) || (SCM_NIMP (str) && SCM_ROSTRINGP (str)), str, pos, FUNC_NAME); \
 123        if (SCM_FALSEP(str)) cvar = NULL; else cvar = SCM_ROCHARS(str); } while (0)
 124
 125 #define SCM_VALIDATE_STRING(pos,str) \
 126   do { SCM_ASSERT(SCM_NIMP (str) && SCM_STRINGP (str), str, pos, FUNC_NAME); } while (0)
 127
 128 #define SCM_VALIDATE_STRINGORSUBSTR(pos,str) \
 129   do { SCM_ASSERT(SCM_NIMP (str) && (SCM_STRINGP (str) || SCM_SUBSTRP(str)), str, pos, FUNC_NAME); } while (0)
 130
 131 #define SCM_VALIDATE_STRING_COPY(pos,str,cvar) \
 132   do { SCM_ASSERT(SCM_NIMP (str) && SCM_STRINGP (str), str, pos, FUNC_NAME); \
 133        cvar = SCM_CHARS(str); } while (0)
 134
 135 #define SCM_VALIDATE_RWSTRING(pos,str) \
 136   do { SCM_ASSERT(SCM_NIMP (str) && SCM_STRINGP (str), str, pos, FUNC_NAME); \
 137        if (!SCM_RWSTRINGP(str)) scm_misc_error(FUNC_NAME, "argument is a read-only string", str);  } while (0)
 138
 139 #define SCM_VALIDATE_REAL(pos,z) \
 140   do { SCM_ASSERT (SCM_NIMP (z) && SCM_REALP (z), z, pos, FUNC_NAME); } while (0)
 141
 142 #define SCM_VALIDATE_INT(pos,k) \
 143   do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); } while (0)
 144
 145 #define SCM_VALIDATE_INT_COPY(pos,k,cvar) \
 146   do { cvar = scm_num2ulong(k,(char *)pos,FUNC_NAME); } while (0)
 147
 148 #define SCM_VALIDATE_BIGINT(pos,k) \
 149   do { SCM_ASSERT(SCM_NIMP(k) && SCM_BIGP(k), k, pos, FUNC_NAME); } while (0)
 150
 151 #define SCM_VALIDATE_INT_MIN(pos,k,min) \
 152   do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
 153        SCM_ASSERT(SCM_INUM(k) >= min, k, SCM_OUTOFRANGE, FUNC_NAME); } while (0)
 154
 155 #define SCM_VALIDATE_INT_MIN_COPY(pos,k,min,cvar) \
 156   do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
 157        cvar = SCM_INUM(k); \
 158        SCM_ASSERT(cvar >= min, k, SCM_OUTOFRANGE, FUNC_NAME); } while (0)
 159
 160 #define SCM_VALIDATE_INT_MIN_DEF_COPY(pos,k,min,default,cvar) \
 161   do { if (SCM_UNBNDP(k)) k = SCM_MAKINUM(default); \
 162        SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
 163        cvar = SCM_INUM(k); \
 164        SCM_ASSERT(cvar >= min, k, SCM_OUTOFRANGE, FUNC_NAME); } while (0)
 165
 166
 167 #define SCM_VALIDATE_INT_DEF(pos,k,default) \
 168   do { if (SCM_UNDEFINED==k) k = SCM_MAKINUM(default); else SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); } while (0)
 169
 170 #define SCM_VALIDATE_INT_DEF_COPY(pos,k,default,cvar) \
 171   do { if (SCM_UNDEFINED==k) { k = SCM_MAKINUM(default); cvar=default; } \
 172        else { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); cvar = SCM_INUM(k); } } while (0)
 173
 174 /* [low,high) */
 175 #define SCM_VALIDATE_INT_RANGE(pos,k,low,high) \
 176   do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
 177        SCM_ASSERT(SCM_INUM (k) >= low && ((unsigned) SCM_INUM (k)) < high, \
 178                   k, SCM_OUTOFRANGE, FUNC_NAME); } while (0)
 179
 180 #define SCM_VALIDATE_NULL(pos,scm) \
 181   do { SCM_ASSERT(SCM_NULLP(scm), scm, pos, FUNC_NAME); } while (0)
 182
 183 #define SCM_VALIDATE_CONS(pos,scm) \
 184   do { SCM_ASSERT(SCM_CONSP(scm), scm, pos, FUNC_NAME); } while (0)
 185
 186 #define SCM_VALIDATE_NIMCONS(pos,scm) \
 187   do { SCM_ASSERT(SCM_CONSP(scm), scm, pos, FUNC_NAME); } while (0)
 188
 189
 190 #define SCM_VALIDATE_LIST(pos,lst) \
 191   do { SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); } while (0)
 192
 193 #define SCM_VALIDATE_LIST_COPYLEN(pos,lst,cvar) \
 194   do { cvar = scm_ilength(lst); SCM_ASSERT(cvar >= 0,lst,pos,FUNC_NAME); } while (0)
 195
 196 #define SCM_VALIDATE_NONEMPTYLIST_COPYLEN(pos,lst,cvar) \
 197   do { cvar = scm_ilength(lst); SCM_ASSERT(cvar >= 1,lst,pos,FUNC_NAME); } while (0)
 198
 199 #define SCM_VALIDATE_ALISTCELL(pos,alist) \
 200   do { \
 201     SCM_ASSERT(SCM_CONSP(alist), alist, pos, FUNC_NAME); \
 202     { SCM tmp = SCM_CAR(alist); \
 203       SCM_ASSERT(SCM_NIMP(tmp) && SCM_CONSP(tmp), alist, pos, FUNC_NAME); } } while (0)
 204
 205 #define SCM_VALIDATE_ALISTCELL_COPYSCM(pos,alist,tmp) \
 206   do { \
 207     SCM_ASSERT(SCM_CONSP(alist), alist, pos, FUNC_NAME); \
 208     tmp = SCM_CAR(alist); \
 209     SCM_ASSERT(SCM_NIMP(tmp) && SCM_CONSP(tmp), alist, pos, FUNC_NAME); } while (0)
 210
 211 #define SCM_VALIDATE_OPORT_VALUE(pos,port) \
 212   do { SCM_ASSERT (scm_valid_oport_value_p (port), port, pos, FUNC_NAME); } while (0)
 213
 214 #define SCM_VALIDATE_PRINTSTATE(pos,a) \
 215   do { SCM_ASSERT (SCM_NIMP (a) && SCM_PRINT_STATE_P (a), a, pos, FUNC_NAME); } while (0)
 216
 217 #define SCM_VALIDATE_SMOB(pos,obj,type) \
 218   do { SCM_ASSERT ((SCM_NIMP(obj) && SCM_TYP16 (obj) == scm_tc16_ ## type), obj, pos, FUNC_NAME); } while (0)
 219
 220 #define SCM_VALIDATE_ASYNC(pos,a) \
 221   do { SCM_ASSERT (SCM_NIMP (a) && SCM_ASYNCP (a), a, pos, FUNC_NAME); } while (0)
 222
 223 #define SCM_VALIDATE_ASYNC_COPY(pos,a,cvar) \
 224   do { SCM_ASSERT (SCM_NIMP (a) && SCM_ASYNCP (a), a, pos, FUNC_NAME); \
 225        cvar = SCM_ASYNC(a); } while (0)
 226
 227 #define SCM_VALIDATE_THUNK(pos,thunk) \
 228   do { SCM_ASSERT (SCM_NFALSEP (scm_thunk_p (thunk)), thunk, pos, FUNC_NAME); } while (0)
 229
 230 #define SCM_VALIDATE_SYMBOL(pos,sym) \
 231   do { SCM_ASSERT (SCM_NIMP(sym) && SCM_SYMBOLP(sym), sym, pos, FUNC_NAME); } while (0)
 232
 233 #define SCM_VALIDATE_VARIABLE(pos,var) \
 234   do { SCM_ASSERT (SCM_NIMP(var) && SCM_VARIABLEP(var), var, pos, FUNC_NAME); } while (0)
 235
 236 #define SCM_VALIDATE_MEMOIZED(pos,obj) \
 237   do { SCM_ASSERT (SCM_NIMP(obj) && SCM_MEMOIZEDP(obj), obj, pos, FUNC_NAME); } while (0)
 238
 239 #define SCM_VALIDATE_CLOSURE(pos,obj) \
 240   do { SCM_ASSERT (SCM_NIMP(obj) && SCM_CLOSUREP(obj), obj, pos, FUNC_NAME); } while (0)
 241
 242 #define SCM_VALIDATE_PROC(pos,proc) \
 243   do { SCM_ASSERT ( SCM_BOOL_T == scm_procedure_p(proc), proc, pos, FUNC_NAME); } while (0)
 244
 245 #define SCM_VALIDATE_NULLORCONS(pos,env) \
 246   do { SCM_ASSERT (SCM_NULLP (env) || (SCM_NIMP (env) && SCM_CONSP (env)), env, pos, FUNC_NAME); } while (0)
 247
 248 #define SCM_VALIDATE_HOOK(pos,a) \
 249   do { SCM_ASSERT (SCM_NIMP (a) && SCM_HOOKP (a), a, pos, FUNC_NAME); } while (0)
 250
 251 #define SCM_VALIDATE_RGXP(pos,a) \
 252   do { SCM_ASSERT (SCM_NIMP (a) && SCM_RGXP (a), a, pos, FUNC_NAME); } while (0)
 253
 254 #define SCM_VALIDATE_OPDIR(pos,port) \
 255   do { SCM_ASSERT (SCM_NIMP (port) && SCM_OPDIRP (port), port, pos, FUNC_NAME); } while (0)
 256
 257 #define SCM_VALIDATE_DIR(pos,port) \
 258   do { SCM_ASSERT (SCM_NIMP (port) && SCM_DIRP (port), port, pos, FUNC_NAME); } while (0)
 259
 260 #define SCM_VALIDATE_PORT(pos,port) \
 261   do { SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port), port, pos, FUNC_NAME); } while (0)
 262
 263 #define SCM_VALIDATE_FPORT(pos,port) \
 264   do { SCM_ASSERT (SCM_NIMP (port) && SCM_FPORTP (port), port, pos, FUNC_NAME); } while (0)
 265
 266 #define SCM_VALIDATE_OPFPORT(pos,port) \
 267   do { SCM_ASSERT (SCM_NIMP (port) && SCM_OPFPORTP (port), port, pos, FUNC_NAME); } while (0)
 268
 269 #define SCM_VALIDATE_OPINPORT(pos,port) \
 270   do { SCM_ASSERT (SCM_NIMP (port) && SCM_OPINPORTP (port), port, pos, FUNC_NAME); } while (0)
 271
 272 #define SCM_VALIDATE_OPENPORT(pos,port) \
 273   do { SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port) && SCM_OPENP(port), port, pos, FUNC_NAME); } while (0)
 274
 275 #define SCM_VALIDATE_OPPORT(pos,port) \
 276   do { SCM_ASSERT (SCM_NIMP (port) && SCM_OPPORTP (port), port, pos, FUNC_NAME); } while (0)
 277
 278 #define SCM_VALIDATE_OPOUTPORT(pos,port) \
 279   do { SCM_ASSERT (SCM_NIMP (port) && SCM_OPOUTPORTP (port), port, pos, FUNC_NAME); } while (0)
 280
 281 #define SCM_VALIDATE_FLUID(pos,fluid) \
 282   do { SCM_ASSERT (SCM_NIMP (fluid) && SCM_FLUIDP (fluid), fluid, pos, FUNC_NAME); } while (0)
 283
 284 #define SCM_VALIDATE_KEYWORD(pos,v) \
 285   do { SCM_ASSERT (SCM_NIMP (v) && SCM_KEYWORDP (v), v, pos, FUNC_NAME); } while (0)
 286
 287 #define SCM_VALIDATE_STACK(pos,v) \
 288   do { SCM_ASSERT (SCM_NIMP (v) && SCM_STACKP (v), v, pos, FUNC_NAME); } while (0)
 289
 290 #define SCM_VALIDATE_FRAME(pos,v) \
 291   do { SCM_ASSERT (SCM_NIMP (v) && SCM_FRAMEP (v), v, pos, FUNC_NAME); } while (0)
 292
 293 #define SCM_VALIDATE_RSTATE(pos,v) \
 294   do { SCM_ASSERT (SCM_NIMP (v) && SCM_RSTATEP (v), v, pos, FUNC_NAME); } while (0)
 295
 296 #define SCM_VALIDATE_ARRAY(pos,v) \
 297   do { SCM_ASSERT (SCM_NIMP (v) && SCM_BOOL_F != scm_array_p(v,SCM_UNDEFINED), v, pos, FUNC_NAME); } while (0)
 298
 299 #define SCM_VALIDATE_VECTOR(pos,v) \
 300   do { SCM_ASSERT (SCM_NIMP (v) && SCM_VECTORP (v), v, pos, FUNC_NAME); } while (0)
 301
 302 #define SCM_VALIDATE_STRUCT(pos,v) \
 303   do { SCM_ASSERT (SCM_NIMP (v) && SCM_STRUCTP (v), v, pos, FUNC_NAME); } while (0)
 304
 305 #define SCM_VALIDATE_VTABLE(pos,v) \
 306   do { SCM_ASSERT (SCM_NIMP (v) && SCM_NFALSEP(scm_struct_vtable_p(v)), v, pos, FUNC_NAME); } while (0)
 307
 308 #define SCM_VALIDATE_VECTOR_LEN(pos,v,len) \
 309   do { SCM_ASSERT (SCM_NIMP (v) && SCM_VECTORP (v) && len == SCM_LENGTH(v), v, pos, FUNC_NAME); } while (0)
 310
 311 #endif