libguile/validate.h

   1 /* $Id: validate.h,v 1.2 2000-03-19 19:01:14 cmm 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_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) (SCM_UNBNDP(arg)?def:(scm_num2long(arg, (char *) pos, FUNC_NAME)))
  77
  78 #define SCM_NUM2LONG_LONG(pos,arg) (scm_num2long_long(arg, (char *) pos, FUNC_NAME))
  79
  80 #define SCM_OUT_OF_RANGE(pos,arg) do { scm_out_of_range_pos(FUNC_NAME,arg, SCM_MAKINUM(pos)); } while (0)
  81
  82 #define SCM_ASSERT_RANGE(pos,arg,f) do { SCM_ASSERT(f,arg,SCM_OUTOFRANGE,FUNC_NAME); } while (0)
  83
  84 #define SCM_MUST_MALLOC_TYPE(type) ((type *) scm_must_malloc(sizeof(type), FUNC_NAME))
  85
  86 #define SCM_MUST_MALLOC_TYPE_NUM(type,num) ((type *) scm_must_malloc(sizeof(type)*(num), FUNC_NAME))
  87
  88 #define SCM_MUST_MALLOC(size) (scm_must_malloc((size), FUNC_NAME))
  89
  90 #define SCM_MAKE_VALIDATE(pos,var,pred) \
  91   do { SCM_ASSERT_TYPE (SCM_ ## pred(var), var, pos, FUNC_NAME, #pred); } while (0)
  92
  93 \f
  94
  95 #define SCM_VALIDATE_NIM(pos,scm) SCM_MAKE_VALIDATE(pos,scm,NIMP)
  96
  97 #define SCM_VALIDATE_BOOL(pos,flag) SCM_MAKE_VALIDATE(pos,flag,BOOLP)
  98
  99 #define SCM_VALIDATE_BOOL_COPY(pos,flag,cvar) \
 100   do { SCM_ASSERT(SCM_BOOLP(flag), flag, pos, FUNC_NAME); \
 101        cvar = (SCM_BOOL_T == flag)? 1: 0; } while (0)
 102
 103 #define SCM_VALIDATE_CHAR(pos,scm) SCM_MAKE_VALIDATE(pos,scm,ICHRP)
 104
 105 #define SCM_VALIDATE_CHAR_COPY(pos,scm,cvar) \
 106   do { SCM_ASSERT(SCM_CHARP(scm), scm, pos, FUNC_NAME); \
 107        cvar = SCM_CHAR(scm); } while (0)
 108
 109 #define SCM_VALIDATE_ROSTRING(pos,str) SCM_MAKE_VALIDATE(pos,str,ROSTRINGP)
 110
 111 #define SCM_VALIDATE_ROSTRING_COPY(pos,str,cvar) \
 112   do { SCM_ASSERT(SCM_ROSTRINGP (str), str, pos, FUNC_NAME); \
 113        cvar = SCM_ROCHARS(str); } while (0)
 114
 115 #define SCM_VALIDATE_NULLORROSTRING_COPY(pos,str,cvar) \
 116   do { SCM_ASSERT(SCM_FALSEP(str) || SCM_ROSTRINGP (str), str, pos, FUNC_NAME); \
 117        if (SCM_FALSEP(str)) cvar = NULL; else cvar = SCM_ROCHARS(str); } while (0)
 118
 119 #define SCM_VALIDATE_STRING(pos,str) SCM_MAKE_VALIDATE(pos,str,STRINGP)
 120
 121 #define SCM_VALIDATE_STRINGORSUBSTR(pos,str) \
 122   do { SCM_ASSERT(SCM_STRINGP (str) || \
 123                   SCM_SUBSTRP(str), str, pos, FUNC_NAME); } while (0)
 124
 125 #define SCM_VALIDATE_STRING_COPY(pos,str,cvar) \
 126   do { SCM_ASSERT(SCM_STRINGP (str), str, pos, FUNC_NAME); \
 127        cvar = SCM_CHARS(str); } while (0)
 128
 129 #define SCM_VALIDATE_RWSTRING(pos,str) \
 130   do { SCM_ASSERT(SCM_STRINGP (str), str, pos, FUNC_NAME); \
 131        if (!SCM_RWSTRINGP(str)) scm_misc_error(FUNC_NAME, "argument is a read-only string", str);  } while (0)
 132
 133 #define SCM_VALIDATE_REAL(pos,z) SCM_MAKE_VALIDATE(pos,z,REALP)
 134
 135 #define SCM_VALIDATE_INUM(pos,k) SCM_MAKE_VALIDATE(pos,k,INUMP)
 136
 137 #define SCM_VALIDATE_INUM_COPY(pos,k,cvar) \
 138   do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
 139        cvar = SCM_INUM(k); } while (0)
 140
 141 #define SCM_VALIDATE_ULONG_COPY(pos,k,cvar) \
 142   do { cvar = SCM_NUM2ULONG(pos,k); } while (0)
 143
 144 #define SCM_VALIDATE_LONG_COPY(pos,k,cvar) \
 145   do { cvar = SCM_NUM2LONG(pos,k); } while (0)
 146
 147 #define SCM_VALIDATE_BIGINT(pos,k) SCM_MAKE_VALIDATE(pos,k,BIGP)
 148
 149 #define SCM_VALIDATE_INUM_MIN(pos,k,min) \
 150   do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
 151        SCM_ASSERT_RANGE(pos,k,(SCM_INUM(k) >= min)); } while (0)
 152
 153 #define SCM_VALIDATE_INUM_MIN_COPY(pos,k,min,cvar) \
 154   do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
 155        cvar = SCM_INUM(k); \
 156        SCM_ASSERT_RANGE(pos,k,(cvar >= min)); } while (0)
 157
 158 #define SCM_VALIDATE_INUM_MIN_DEF_COPY(pos,k,min,default,cvar) \
 159   do { if (SCM_UNBNDP(k)) k = SCM_MAKINUM(default); \
 160        SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
 161        cvar = SCM_INUM(k); \
 162        SCM_ASSERT_RANGE(pos,k,(cvar >= min)); } while (0)
 163
 164 #define SCM_VALIDATE_INUM_DEF(pos,k,default) \
 165   do { if (SCM_UNDEFINED==k) k = SCM_MAKINUM(default); \
 166        else SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); } while (0)
 167
 168 #define SCM_VALIDATE_INUM_DEF_COPY(pos,k,default,cvar) \
 169   do { if (SCM_UNDEFINED==k) { k = SCM_MAKINUM(default); cvar=default; } \
 170        else { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); cvar = SCM_INUM(k); } } while (0)
 171
 172 /* [low,high) */
 173 #define SCM_VALIDATE_INUM_RANGE(pos,k,low,high) \
 174   do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
 175        SCM_ASSERT_RANGE(pos,k,(SCM_INUM (k) >= low && ((unsigned) SCM_INUM (k)) < high)); \
 176      } while (0)
 177
 178 #define SCM_VALIDATE_NULL(pos,scm) SCM_MAKE_VALIDATE(pos,scm,NULLP)
 179
 180 #define SCM_VALIDATE_CONS(pos,scm) SCM_MAKE_VALIDATE(pos,scm,CONSP)
 181
 182 #define SCM_VALIDATE_LIST(pos,lst) \
 183   do { SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); } while (0)
 184
 185 #define SCM_VALIDATE_NONEMPTYLIST(pos,lst) \
 186   do { SCM_ASSERT (scm_ilength (lst) > 0, lst, pos, FUNC_NAME); } while (0)
 187
 188 #define SCM_VALIDATE_LIST_COPYLEN(pos,lst,cvar) \
 189   do { cvar = scm_ilength(lst); SCM_ASSERT(cvar >= 0,lst,pos,FUNC_NAME); } while (0)
 190
 191 #define SCM_VALIDATE_NONEMPTYLIST_COPYLEN(pos,lst,cvar) \
 192   do { cvar = scm_ilength(lst); SCM_ASSERT(cvar >= 1,lst,pos,FUNC_NAME); } while (0)
 193
 194 #define SCM_VALIDATE_ALISTCELL(pos,alist) \
 195   do { \
 196     SCM_ASSERT(SCM_CONSP(alist) && SCM_CONSP(SCM_CAR(alist)), alist, pos, FUNC_NAME); \
 197   } while (0)
 198
 199 #define SCM_VALIDATE_ALISTCELL_COPYSCM(pos,alist,cvar) \
 200   do { \
 201     SCM_ASSERT(SCM_CONSP(alist), alist, pos, FUNC_NAME); \
 202     cvar = SCM_CAR(alist); \
 203     SCM_ASSERT(SCM_CONSP(cvar), alist, pos, FUNC_NAME); } while (0)
 204
 205 #define SCM_VALIDATE_OPORT_VALUE(pos,port) \
 206   do { SCM_ASSERT (scm_valid_oport_value_p (port), port, pos, FUNC_NAME); } while (0)
 207
 208 #define SCM_VALIDATE_PRINTSTATE(pos,a) SCM_MAKE_VALIDATE(pos,a,PRINT_STATE_P)
 209
 210 #define SCM_VALIDATE_SMOB(pos,obj,type) \
 211   do { SCM_ASSERT ((SCM_NIMP(obj) && SCM_TYP16 (obj) == scm_tc16_ ## type), obj, pos, FUNC_NAME); } while (0)
 212
 213 #define SCM_VALIDATE_ASYNC(pos,a) SCM_MAKE_VALIDATE(pos,a,ASYNCP)
 214
 215 #define SCM_VALIDATE_ASYNC_COPY(pos,a,cvar) \
 216   do { SCM_ASSERT (SCM_ASYNCP (a), a, pos, FUNC_NAME); \
 217        cvar = SCM_ASYNC(a); } while (0)
 218
 219 #define SCM_VALIDATE_THREAD(pos,a) SCM_MAKE_VALIDATE(pos,a,THREADP)
 220
 221 #define SCM_VALIDATE_THUNK(pos,thunk) \
 222   do { SCM_ASSERT (SCM_NFALSEP (scm_thunk_p (thunk)), thunk, pos, FUNC_NAME); } while (0)
 223
 224 #define SCM_VALIDATE_SYMBOL(pos,sym) SCM_MAKE_VALIDATE(pos,sym,SYMBOLP)
 225
 226 #define SCM_VALIDATE_VARIABLE(pos,var) SCM_MAKE_VALIDATE(pos,var,VARIABLEP)
 227
 228 #define SCM_VALIDATE_MEMOIZED(pos,obj) SCM_MAKE_VALIDATE(pos,obj,MEMOIZEDP)
 229
 230 #define SCM_VALIDATE_CLOSURE(pos,obj) SCM_MAKE_VALIDATE(pos,obj,CLOSUREP)
 231
 232 #define SCM_VALIDATE_PROC(pos,proc) \
 233   do { SCM_ASSERT ( SCM_BOOL_T == scm_procedure_p(proc), proc, pos, FUNC_NAME); } while (0)
 234
 235 #define SCM_VALIDATE_NULLORCONS(pos,env) \
 236   do { SCM_ASSERT (SCM_NULLP (env) || SCM_CONSP (env), env, pos, FUNC_NAME); } while (0)
 237
 238 #define SCM_VALIDATE_HOOK(pos,a) SCM_MAKE_VALIDATE(pos,a,HOOKP)
 239
 240 #define SCM_VALIDATE_RGXP(pos,a) SCM_MAKE_VALIDATE(pos,a,RGXP)
 241
 242 #define SCM_VALIDATE_OPDIR(pos,port) SCM_MAKE_VALIDATE(pos,port,OPDIRP)
 243
 244 #define SCM_VALIDATE_DIR(pos,port) SCM_MAKE_VALIDATE(pos,port,DIRP)
 245
 246 #define SCM_VALIDATE_PORT(pos,port) SCM_MAKE_VALIDATE(pos,port,PORTP)
 247
 248 #define SCM_VALIDATE_FPORT(pos,port) SCM_MAKE_VALIDATE(pos,port,FPORTP)
 249
 250 #define SCM_VALIDATE_OPFPORT(pos,port) SCM_MAKE_VALIDATE(pos,port,OPFPORTP)
 251
 252 #define SCM_VALIDATE_OPINPORT(pos,port) SCM_MAKE_VALIDATE(pos,port,OPINPORTP)
 253
 254 #define SCM_VALIDATE_OPENPORT(pos,port) \
 255   do { SCM_ASSERT (SCM_PORTP (port) && SCM_OPENP(port), port, pos, FUNC_NAME); } while (0)
 256
 257 #define SCM_VALIDATE_OPPORT(pos,port) SCM_MAKE_VALIDATE(pos,port,OPPORTP)
 258
 259 #define SCM_VALIDATE_OPOUTPORT(pos,port) SCM_MAKE_VALIDATE(pos,port,OPOUTPORTP)
 260
 261 #define SCM_VALIDATE_FLUID(pos,fluid) SCM_MAKE_VALIDATE(pos,fluid,FLUIDP)
 262
 263 #define SCM_VALIDATE_KEYWORD(pos,v) SCM_MAKE_VALIDATE(pos,v,KEYWORDP)
 264
 265 #define SCM_VALIDATE_STACK(pos,v) SCM_MAKE_VALIDATE(pos,v,STACKP)
 266
 267 #define SCM_VALIDATE_FRAME(pos,v) SCM_MAKE_VALIDATE(pos,v,FRAMEP)
 268
 269 #define SCM_VALIDATE_RSTATE(pos,v) SCM_MAKE_VALIDATE(pos,v,RSTATEP)
 270
 271 #define SCM_VALIDATE_ARRAY(pos,v) \
 272   do { SCM_ASSERT (SCM_NIMP (v) && \
 273                    SCM_BOOL_F != scm_array_p(v,SCM_UNDEFINED), \
 274                    v, pos, FUNC_NAME); } while (0)
 275
 276 #define SCM_VALIDATE_VECTOR(pos,v) SCM_MAKE_VALIDATE(pos,v,VECTORP)
 277
 278 #define SCM_VALIDATE_VECTOR_OR_DVECTOR(pos,v) \
 279   do { SCM_ASSERT ((SCM_VECTORP (v) ||  \
 280                     (SCM_NIMP (v) && SCM_TYP7 (v) == scm_tc7_dvect)), \
 281                    v, pos, FUNC_NAME); } while (0)
 282
 283 #define SCM_VALIDATE_STRUCT(pos,v) SCM_MAKE_VALIDATE(pos,v,STRUCTP)
 284
 285 #define SCM_VALIDATE_VTABLE(pos,v) \
 286   do { SCM_ASSERT (SCM_NIMP (v) && SCM_NFALSEP(scm_struct_vtable_p(v)), v, pos, FUNC_NAME); } while (0)
 287
 288 #define SCM_VALIDATE_VECTOR_LEN(pos,v,len) \
 289   do { SCM_ASSERT (SCM_VECTORP (v) && len == SCM_LENGTH(v), v, pos, FUNC_NAME); } while (0)
 290
 291 #endif
 292
 293 /*
 294   Local Variables:
 295   c-file-style: "gnu"
 296   End:
 297 */