* scm_validate.h: Added the FSF copyright to the top.

[bpt/guile.git] / libguile / scm_validate.h

/* $Id: scm_validate.h,v 1.2 1999-12-12 18:08:24 gjb Exp $ */
/*	Copyright (C) 1999 Free Software Foundation, Inc.
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this software; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307 USA
 *
 * As a special exception, the Free Software Foundation gives permission
 * for additional uses of the text contained in its release of GUILE.
 *
 * The exception is that, if you link the GUILE library with other files
 * to produce an executable, this does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * Your use of that executable is in no way restricted on account of
 * linking the GUILE library code into it.
 *
 * This exception does not however invalidate any other reasons why
 * the executable file might be covered by the GNU General Public License.
 *
 * This exception applies only to the code released by the
 * Free Software Foundation under the name GUILE.  If you copy
 * code from other Free Software Foundation releases into a copy of
 * GUILE, as the General Public License permits, the exception does
 * not apply to the code that you add in this way.  To avoid misleading
 * anyone as to the status of such modified files, you must delete
 * this exception notice from them.
 *
 * If you write modifications of your own for GUILE, it is your choice
 * whether to permit this exception to apply to your modifications.
 * If you do not wish that, delete this exception notice.  */

/* Written by Greg J. Badros <gjb@cs.washington.edu>, Dec-1999 */

#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