mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-05-01 04:10:18 +02:00
1bbd0b849f
function headers and argument checking. Switched SCM_PROC, SCM_PROC1 macros to be GUILE_PROC, GUILE_PROC1 (may change names later, but was useful to keep old versions around while migrate) that has docstrings and argument lists embedded in the GUILE_PROC macro invocations that expand into a function header. Use lots of new SCM_VALIDATE_* macros to simplify error checking and reduce tons of redundancy. This is very similar to what I did for Scwm. Note that none of the extraction of the docstrings, nor software engineering checks of Scwm is yet added to Guile. I'll work on that tomorrow, I expect. * Makefile.am: Added scm_validate.h to modinclude_HEADERS. * chars.c: Added docstrings for the primitives defined in here. * snarf.h: Added GUILE_PROC, GUILE_PROC1. Added SCM_REGISTER_PROC to be like old SCM_PROC, though old SCM_PROC still remains for now. Changed naming convention for the s_foo string name of the primitive to be s_scm_foo for ease of use with the macro. * scm_validate.h: Lots of new SCM_VALIDATE macros to simplify argument checking through guile. Maybe some of these should be folded into the header file for the types they check, but for now it was easiest to just stick them all in one place.
267 lines
11 KiB
C
267 lines
11 KiB
C
/* $Id: scm_validate.h,v 1.1 1999-12-12 02:36:16 gjb Exp $
|
|
* scm_validate.h
|
|
* Copyright (C) 1999, Greg J. Badros
|
|
*
|
|
*/
|
|
|
|
#ifndef SCM_VALIDATE_H__
|
|
#define SCM_VALIDATE_H__
|
|
|
|
#define SCM_BOOL(f) ((f)? SCM_BOOL_T : SCM_BOOL_F)
|
|
#define SCM_NEGATE_BOOL(f) ((f)? SCM_BOOL_F : SCM_BOOL_T)
|
|
|
|
#define SCM_FUNC_NAME (scm_makfrom0str(FUNC_NAME))
|
|
|
|
#define SCM_SYSERROR do { scm_syserror(FUNC_NAME); } while (0)
|
|
|
|
#define SCM_MEMORY_ERROR do { scm_memory_error(FUNC_NAME); } while (0)
|
|
|
|
#define SCM_SYSERROR_MSG(str,args,val) \
|
|
do { scm_syserror_msg(FUNC_NAME,(str),(args),(val)); } while (0)
|
|
|
|
#define SCM_SYSMISSING \
|
|
do { scm_sysmissing(FUNC_NAME); } while (0)
|
|
|
|
#define SCM_WTA(pos,scm) \
|
|
do { scm_wta(scm,(char *)pos,FUNC_NAME); } while (0)
|
|
|
|
#define RETURN_SCM_WTA(pos,scm) \
|
|
do { return scm_wta(scm,(char *)pos,FUNC_NAME); } while (0)
|
|
|
|
#define SCM_MISC_ERROR(str,args) \
|
|
do { scm_misc_error(FUNC_NAME,str,args); } while (0)
|
|
|
|
#define SCM_WRONG_TYPE_ARG(pos,obj) \
|
|
do { scm_wrong_type_arg(FUNC_NAME,pos,obj); } while (0)
|
|
|
|
#define SCM_NUM2ULONG(pos,arg) (scm_num2ulong(arg, (char *) pos, FUNC_NAME))
|
|
|
|
#define SCM_NUM2LONG(pos,arg) (scm_num2long(arg, (char *) pos, FUNC_NAME))
|
|
|
|
#define SCM_NUM2LONG_LONG(pos,arg) (scm_num2long_long(arg, (char *) pos, FUNC_NAME))
|
|
|
|
#define SCM_OUT_OF_RANGE(pos,arg) do { scm_out_of_range(FUNC_NAME,arg); } while (0)
|
|
|
|
#define SCM_ASSERT_RANGE(pos,arg,f) do { SCM_ASSERT(f,arg,SCM_OUTOFRANGE,FUNC_NAME); } while (0)
|
|
|
|
#define SCM_MUST_MALLOC_TYPE(type) ((type *) scm_must_malloc(sizeof(type), FUNC_NAME))
|
|
|
|
#define SCM_MUST_MALLOC_TYPE_NUM(type,num) ((type *) scm_must_malloc(sizeof(type)*(num), FUNC_NAME))
|
|
|
|
#define SCM_MUST_MALLOC(size) (scm_must_malloc((size), FUNC_NAME))
|
|
|
|
#define SCM_VALIDATE_NIMP(pos,scm) \
|
|
do { SCM_ASSERT(SCM_NIMP(scm), scm, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_BOOL(pos,flag) \
|
|
do { SCM_ASSERT(SCM_BOOL_T == flag || SCM_BOOL_F == flag, flag, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_BOOL_COPY(pos,flag,cvar) \
|
|
do { SCM_ASSERT(SCM_BOOL_T == flag || SCM_BOOL_F == flag, flag, pos, FUNC_NAME); \
|
|
cvar = (SCM_BOOL_T == flag)? 1: 0; } while (0)
|
|
|
|
#define SCM_VALIDATE_CHAR(pos,scm) \
|
|
do { SCM_ASSERT(SCM_ICHRP(scm), scm, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_CHAR_COPY(pos,scm,cvar) \
|
|
do { SCM_ASSERT(SCM_ICHRP(scm), scm, pos, FUNC_NAME); \
|
|
cvar = SCM_ICHR(scm); } while (0)
|
|
|
|
#define SCM_VALIDATE_ROSTRING(pos,str) \
|
|
do { SCM_ASSERT(SCM_NIMP (str) && SCM_ROSTRINGP (str), str, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_ROSTRING_COPY(pos,str,cvar) \
|
|
do { SCM_ASSERT(SCM_NIMP (str) && SCM_ROSTRINGP (str), str, pos, FUNC_NAME); \
|
|
cvar = SCM_ROCHARS(str); } while (0)
|
|
|
|
#define SCM_VALIDATE_NULLORROSTRING_COPY(pos,str,cvar) \
|
|
do { SCM_ASSERT(SCM_FALSEP(str) || (SCM_NIMP (str) && SCM_ROSTRINGP (str)), str, pos, FUNC_NAME); \
|
|
if (SCM_FALSEP(str)) cvar = NULL; else cvar = SCM_ROCHARS(str); } while (0)
|
|
|
|
#define SCM_VALIDATE_STRING(pos,str) \
|
|
do { SCM_ASSERT(SCM_NIMP (str) && SCM_STRINGP (str), str, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_STRINGORSUBSTR(pos,str) \
|
|
do { SCM_ASSERT(SCM_NIMP (str) && (SCM_STRINGP (str) || SCM_SUBSTRP(str)), str, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_STRING_COPY(pos,str,cvar) \
|
|
do { SCM_ASSERT(SCM_NIMP (str) && SCM_STRINGP (str), str, pos, FUNC_NAME); \
|
|
cvar = SCM_CHARS(str); } while (0)
|
|
|
|
#define SCM_VALIDATE_RWSTRING(pos,str) \
|
|
do { SCM_ASSERT(SCM_NIMP (str) && SCM_STRINGP (str), str, pos, FUNC_NAME); \
|
|
if (!SCM_RWSTRINGP(str)) scm_misc_error(FUNC_NAME, "argument is a read-only string", str); } while (0)
|
|
|
|
#define SCM_VALIDATE_REAL(pos,z) \
|
|
do { SCM_ASSERT (SCM_NIMP (z) && SCM_REALP (z), z, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_INT(pos,k) \
|
|
do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_INT_COPY(pos,k,cvar) \
|
|
do { cvar = scm_num2ulong(k,(char *)pos,FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_BIGINT(pos,k) \
|
|
do { SCM_ASSERT(SCM_NIMP(k) && SCM_BIGP(k), k, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_INT_MIN(pos,k,min) \
|
|
do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
|
|
SCM_ASSERT(SCM_INUM(k) >= min, k, SCM_OUTOFRANGE, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_INT_MIN_COPY(pos,k,min,cvar) \
|
|
do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
|
|
cvar = SCM_INUM(k); \
|
|
SCM_ASSERT(cvar >= min, k, SCM_OUTOFRANGE, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_INT_MIN_DEF_COPY(pos,k,min,default,cvar) \
|
|
do { if (SCM_UNBNDP(k)) k = SCM_MAKINUM(default); \
|
|
SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
|
|
cvar = SCM_INUM(k); \
|
|
SCM_ASSERT(cvar >= min, k, SCM_OUTOFRANGE, FUNC_NAME); } while (0)
|
|
|
|
|
|
#define SCM_VALIDATE_INT_DEF(pos,k,default) \
|
|
do { if (SCM_UNDEFINED==k) k = SCM_MAKINUM(default); else SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_INT_DEF_COPY(pos,k,default,cvar) \
|
|
do { if (SCM_UNDEFINED==k) { k = SCM_MAKINUM(default); cvar=default; } \
|
|
else { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); cvar = SCM_INUM(k); } } while (0)
|
|
|
|
/* [low,high) */
|
|
#define SCM_VALIDATE_INT_RANGE(pos,k,low,high) \
|
|
do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
|
|
SCM_ASSERT(SCM_INUM (k) >= low && ((unsigned) SCM_INUM (k)) < high, \
|
|
k, SCM_OUTOFRANGE, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_NULL(pos,scm) \
|
|
do { SCM_ASSERT(SCM_NULLP(scm), scm, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_CONS(pos,scm) \
|
|
do { SCM_ASSERT(SCM_CONSP(scm), scm, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_NIMCONS(pos,scm) \
|
|
do { SCM_ASSERT(SCM_CONSP(scm), scm, pos, FUNC_NAME); } while (0)
|
|
|
|
|
|
#define SCM_VALIDATE_LIST(pos,lst) \
|
|
do { SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_LIST_COPYLEN(pos,lst,cvar) \
|
|
do { cvar = scm_ilength(lst); SCM_ASSERT(cvar >= 0,lst,pos,FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_NONEMPTYLIST_COPYLEN(pos,lst,cvar) \
|
|
do { cvar = scm_ilength(lst); SCM_ASSERT(cvar >= 1,lst,pos,FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_ALISTCELL(pos,alist) \
|
|
do { \
|
|
SCM_ASSERT(SCM_CONSP(alist), alist, pos, FUNC_NAME); \
|
|
{ SCM tmp = SCM_CAR(alist); \
|
|
SCM_ASSERT(SCM_NIMP(tmp) && SCM_CONSP(tmp), alist, pos, FUNC_NAME); } } while (0)
|
|
|
|
#define SCM_VALIDATE_ALISTCELL_COPYSCM(pos,alist,tmp) \
|
|
do { \
|
|
SCM_ASSERT(SCM_CONSP(alist), alist, pos, FUNC_NAME); \
|
|
tmp = SCM_CAR(alist); \
|
|
SCM_ASSERT(SCM_NIMP(tmp) && SCM_CONSP(tmp), alist, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_OPORT_VALUE(pos,port) \
|
|
do { SCM_ASSERT (scm_valid_oport_value_p (port), port, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_PRINTSTATE(pos,a) \
|
|
do { SCM_ASSERT (SCM_NIMP (a) && SCM_PRINT_STATE_P (a), a, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_SMOB(pos,obj,type) \
|
|
do { SCM_ASSERT ((SCM_NIMP(obj) && SCM_TYP16 (obj) == scm_tc16_ ## type), obj, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_ASYNC(pos,a) \
|
|
do { SCM_ASSERT (SCM_NIMP (a) && SCM_ASYNCP (a), a, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_ASYNC_COPY(pos,a,cvar) \
|
|
do { SCM_ASSERT (SCM_NIMP (a) && SCM_ASYNCP (a), a, pos, FUNC_NAME); \
|
|
cvar = SCM_ASYNC(a); } while (0)
|
|
|
|
#define SCM_VALIDATE_THUNK(pos,thunk) \
|
|
do { SCM_ASSERT (SCM_NFALSEP (scm_thunk_p (thunk)), thunk, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_SYMBOL(pos,sym) \
|
|
do { SCM_ASSERT (SCM_NIMP(sym) && SCM_SYMBOLP(sym), sym, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_VARIABLE(pos,var) \
|
|
do { SCM_ASSERT (SCM_NIMP(var) && SCM_VARIABLEP(var), var, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_MEMOIZED(pos,obj) \
|
|
do { SCM_ASSERT (SCM_NIMP(obj) && SCM_MEMOIZEDP(obj), obj, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_CLOSURE(pos,obj) \
|
|
do { SCM_ASSERT (SCM_NIMP(obj) && SCM_CLOSUREP(obj), obj, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_PROC(pos,proc) \
|
|
do { SCM_ASSERT ( SCM_BOOL_T == scm_procedure_p(proc), proc, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_NULLORCONS(pos,env) \
|
|
do { SCM_ASSERT (SCM_NULLP (env) || (SCM_NIMP (env) && SCM_CONSP (env)), env, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_HOOK(pos,a) \
|
|
do { SCM_ASSERT (SCM_NIMP (a) && SCM_HOOKP (a), a, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_RGXP(pos,a) \
|
|
do { SCM_ASSERT (SCM_NIMP (a) && SCM_RGXP (a), a, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_OPDIR(pos,port) \
|
|
do { SCM_ASSERT (SCM_NIMP (port) && SCM_OPDIRP (port), port, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_DIR(pos,port) \
|
|
do { SCM_ASSERT (SCM_NIMP (port) && SCM_DIRP (port), port, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_PORT(pos,port) \
|
|
do { SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port), port, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_FPORT(pos,port) \
|
|
do { SCM_ASSERT (SCM_NIMP (port) && SCM_FPORTP (port), port, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_OPFPORT(pos,port) \
|
|
do { SCM_ASSERT (SCM_NIMP (port) && SCM_OPFPORTP (port), port, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_OPINPORT(pos,port) \
|
|
do { SCM_ASSERT (SCM_NIMP (port) && SCM_OPINPORTP (port), port, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_OPENPORT(pos,port) \
|
|
do { SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port) && SCM_OPENP(port), port, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_OPPORT(pos,port) \
|
|
do { SCM_ASSERT (SCM_NIMP (port) && SCM_OPPORTP (port), port, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_OPOUTPORT(pos,port) \
|
|
do { SCM_ASSERT (SCM_NIMP (port) && SCM_OPOUTPORTP (port), port, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_FLUID(pos,fluid) \
|
|
do { SCM_ASSERT (SCM_NIMP (fluid) && SCM_FLUIDP (fluid), fluid, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_KEYWORD(pos,v) \
|
|
do { SCM_ASSERT (SCM_NIMP (v) && SCM_KEYWORDP (v), v, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_STACK(pos,v) \
|
|
do { SCM_ASSERT (SCM_NIMP (v) && SCM_STACKP (v), v, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_FRAME(pos,v) \
|
|
do { SCM_ASSERT (SCM_NIMP (v) && SCM_FRAMEP (v), v, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_RSTATE(pos,v) \
|
|
do { SCM_ASSERT (SCM_NIMP (v) && SCM_RSTATEP (v), v, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_ARRAY(pos,v) \
|
|
do { SCM_ASSERT (SCM_NIMP (v) && SCM_BOOL_F != scm_array_p(v,SCM_UNDEFINED), v, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_VECTOR(pos,v) \
|
|
do { SCM_ASSERT (SCM_NIMP (v) && SCM_VECTORP (v), v, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_STRUCT(pos,v) \
|
|
do { SCM_ASSERT (SCM_NIMP (v) && SCM_STRUCTP (v), v, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_VTABLE(pos,v) \
|
|
do { SCM_ASSERT (SCM_NIMP (v) && SCM_NFALSEP(scm_struct_vtable_p(v)), v, pos, FUNC_NAME); } while (0)
|
|
|
|
#define SCM_VALIDATE_VECTOR_LEN(pos,v,len) \
|
|
do { SCM_ASSERT (SCM_NIMP (v) && SCM_VECTORP (v) && len == SCM_LENGTH(v), v, pos, FUNC_NAME); } while (0)
|
|
|
|
#endif
|