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