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

/* $Id: validate.h,v 1.31 2001-04-10 07:57:05 dirk Exp $ */
/* Copyright (C) 1999,2000,2001 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_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_MISC_ERROR(str, args) \
  do { scm_misc_error (FUNC_NAME, str, args); } while (0)

#define SCM_WRONG_NUM_ARGS() \
  do { scm_error_num_args_subr (FUNC_NAME); } 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, pos, FUNC_NAME))

#define SCM_NUM2LONG(pos, arg) (scm_num2long (arg, pos, FUNC_NAME))

#define SCM_NUM2LONG_DEF(pos, arg, def) \
  (SCM_UNBNDP (arg) ? def : scm_num2long (arg, pos, FUNC_NAME))

#define SCM_NUM2LONG_LONG(pos, arg) \
  (scm_num2long_long (arg, pos, FUNC_NAME))

#define SCM_OUT_OF_RANGE(pos, arg) \
  do { scm_out_of_range_pos (FUNC_NAME, arg, SCM_MAKINUM (pos)); } while (0)

#define SCM_ASSERT_RANGE(pos, arg, f) \
  do { if (!(f)) scm_out_of_range_pos (FUNC_NAME, arg, SCM_MAKINUM (pos)); } 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_MAKE_VALIDATE(pos, var, pred) \
  do { \
    SCM_ASSERT_TYPE (SCM_ ## pred (var), var, pos, FUNC_NAME, #pred); \
  } while (0)

\f

#define SCM_VALIDATE_REST_ARGUMENT(x) \
  do { \
    if (SCM_DEBUG_REST_ARGUMENT) { \
      if (scm_ilength (x) < 0) { \
        SCM_MISC_ERROR ("Rest arguments do not form a proper list.", SCM_EOL); \
      } \
    } \
  } while (0)

#define SCM_VALIDATE_NIM(pos, scm) SCM_MAKE_VALIDATE (pos, scm, NIMP)

#define SCM_VALIDATE_BOOL(pos, flag) SCM_MAKE_VALIDATE(pos, flag, BOOLP)

#define SCM_VALIDATE_BOOL_COPY(pos, flag, cvar) \
  do { \
    SCM_ASSERT (SCM_BOOLP (flag), flag, pos, FUNC_NAME); \
    cvar = SCM_EQ_P (flag, SCM_BOOL_T) ? 1 : 0; \
  } while (0)

#define SCM_VALIDATE_CHAR(pos, scm) SCM_MAKE_VALIDATE (pos, scm, CHARP)

#define SCM_VALIDATE_CHAR_COPY(pos, scm, cvar) \
  do { \
    SCM_ASSERT (SCM_CHARP (scm), scm, pos, FUNC_NAME); \
    cvar = SCM_CHAR (scm); \
  } while (0)

#define SCM_VALIDATE_STRING(pos, str) SCM_MAKE_VALIDATE (pos, str, STRINGP)

#define SCM_VALIDATE_STRING_COPY(pos, str, cvar) \
  do { \
    SCM_ASSERT (SCM_STRINGP (str), str, pos, FUNC_NAME); \
    cvar = SCM_STRING_CHARS(str); \
  } while (0)

/* validate a string and optional start/end arguments which default to
   0/string-len.  this is unrelated to the old shared substring
   support, so please do not deprecate it :) */
#define SCM_VALIDATE_SUBSTRING_SPEC_COPY(pos_str, str, c_str, \
                                         pos_start, start, c_start,\
                                         pos_end, end, c_end) \
  do {\
    SCM_VALIDATE_STRING_COPY (pos_str, str, c_str);\
    SCM_VALIDATE_INUM_DEF_COPY (pos_start, start, 0, c_start);\
    SCM_VALIDATE_INUM_DEF_COPY (pos_end, end, SCM_STRING_LENGTH (str), c_end);\
    SCM_ASSERT_RANGE (pos_start, start,\
                      0 <= c_start && c_start <= SCM_STRING_LENGTH (str));\
    SCM_ASSERT_RANGE (pos_end, end,\
		      c_start <= c_end && c_end <= SCM_STRING_LENGTH (str));\
  } while (0)

#define SCM_VALIDATE_REAL(pos, z) SCM_MAKE_VALIDATE (pos, z, REALP)

#define SCM_VALIDATE_NUMBER(pos, z) SCM_MAKE_VALIDATE (pos, z, NUMBERP)

#define SCM_VALIDATE_INUM(pos, k) SCM_MAKE_VALIDATE (pos, k, INUMP)

#define SCM_VALIDATE_INUM_COPY(pos, k, cvar) \
  do { \
    SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
    cvar = SCM_INUM (k); \
  } while (0)

#define SCM_VALIDATE_ULONG_COPY(pos, k, cvar) \
  do { \
    cvar = SCM_NUM2ULONG (pos, k); \
  } while (0)

#define SCM_VALIDATE_LONG_COPY(pos, k, cvar) \
  do { \
    cvar = SCM_NUM2LONG (pos, k); \
  } while (0)

#define SCM_VALIDATE_BIGINT(pos, k) SCM_MAKE_VALIDATE (pos, k, BIGP)

#define SCM_VALIDATE_INUM_MIN(pos, k, min) \
  do { \
    SCM_ASSERT (SCM_INUMP(k), k, pos, FUNC_NAME); \
    SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
  } while (0)

#define SCM_VALIDATE_INUM_MIN_COPY(pos, k, min, cvar) \
  do { \
    SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
    SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
    cvar = SCM_INUM (k); \
  } while (0)

#define SCM_VALIDATE_INUM_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); \
    SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
    cvar = SCM_INUM (k); \
  } while (0)

#define SCM_VALIDATE_INUM_DEF(pos, k, default) \
  do { \
    if (SCM_UNBNDP (k)) \
      k = SCM_MAKINUM (default); \
    else SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
  } while (0)

#define SCM_VALIDATE_INUM_DEF_COPY(pos, k, default, cvar) \
  do { \
    if (SCM_UNBNDP (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_INUM_RANGE(pos,k,low,high) \
  do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
       SCM_ASSERT_RANGE(pos,k, \
                        (SCM_INUM (k) >= low && \
                         SCM_INUM (k) < high)); \
     } while (0)

#define SCM_VALIDATE_INUM_RANGE_COPY(pos, k, low, high, cvar) \
  do { \
    SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
    SCM_ASSERT_RANGE (pos, k, low <= SCM_INUM (k) && SCM_INUM (k) < high); \
    cvar = SCM_INUM (k); \
  } while (0)

#define SCM_VALIDATE_NULL(pos, scm) SCM_MAKE_VALIDATE (pos, scm, NULLP)

#define SCM_VALIDATE_CONS(pos, scm) SCM_MAKE_VALIDATE (pos, scm, CONSP)

#define SCM_VALIDATE_LIST(pos, lst) \
  do { \
    SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); \
  } while (0)

#define SCM_VALIDATE_NONEMPTYLIST(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) && SCM_CONSP (SCM_CAR (alist)), \
                alist, pos, FUNC_NAME); \
  } while (0)

#define SCM_VALIDATE_ALISTCELL_COPYSCM(pos, alist, cvar) \
  do { \
    SCM_ASSERT (SCM_CONSP (alist), alist, pos, FUNC_NAME); \
    cvar = SCM_CAR (alist); \
    SCM_ASSERT (SCM_CONSP (cvar), 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) SCM_MAKE_VALIDATE(pos,a,PRINT_STATE_P)

#define SCM_VALIDATE_SMOB(pos, obj, type) \
  do { \
    SCM_ASSERT (SCM_TYP16_PREDICATE (scm_tc16_ ## type, obj), \
                obj, pos, FUNC_NAME); \
  } while (0)

#define SCM_VALIDATE_THREAD(pos, a) SCM_MAKE_VALIDATE (pos, a, THREADP)

#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) SCM_MAKE_VALIDATE (pos, sym, SYMBOLP)

#define SCM_VALIDATE_VARIABLE(pos, var) SCM_MAKE_VALIDATE (pos, var, VARIABLEP)

#define SCM_VALIDATE_MEMOIZED(pos, obj) SCM_MAKE_VALIDATE (pos, obj, MEMOIZEDP)

#define SCM_VALIDATE_CLOSURE(pos, obj) SCM_MAKE_VALIDATE (pos, obj, CLOSUREP)

#define SCM_VALIDATE_PROC(pos, proc) \
  do { \
    SCM_ASSERT (SCM_EQ_P (scm_procedure_p (proc), SCM_BOOL_T), proc, pos, FUNC_NAME); \
  } while (0)

#define SCM_VALIDATE_NULLORCONS(pos, env) \
  do { \
    SCM_ASSERT (SCM_NULLP (env) || SCM_CONSP (env), env, pos, FUNC_NAME); \
  } while (0)

#define SCM_VALIDATE_HOOK(pos, a) SCM_MAKE_VALIDATE (pos, a, HOOKP)

#define SCM_VALIDATE_RGXP(pos, a) SCM_MAKE_VALIDATE (pos, a, RGXP)

#define SCM_VALIDATE_DIR(pos, port) SCM_MAKE_VALIDATE (pos, port, DIRP)

#define SCM_VALIDATE_PORT(pos, port) SCM_MAKE_VALIDATE (pos, port, PORTP)

#define SCM_VALIDATE_INPUT_PORT(pos, port) \
  SCM_MAKE_VALIDATE (pos, port, INPUT_PORT_P)

#define SCM_VALIDATE_OUTPUT_PORT(pos, port) \
  SCM_MAKE_VALIDATE (pos, port, OUTPUT_PORT_P)

#define SCM_VALIDATE_FPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, FPORTP)

#define SCM_VALIDATE_OPFPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, OPFPORTP)

#define SCM_VALIDATE_OPINPORT(pos, port) \
  SCM_MAKE_VALIDATE (pos, port, OPINPORTP)

#define SCM_VALIDATE_OPENPORT(pos,port) \
  do { \
    SCM_ASSERT (SCM_PORTP (port) && SCM_OPENP (port), \
                port, pos, FUNC_NAME); \
  } while (0)

#define SCM_VALIDATE_OPPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, OPPORTP)

#define SCM_VALIDATE_OPOUTPORT(pos, port) \
  SCM_MAKE_VALIDATE (pos, port, OPOUTPORTP)

#define SCM_VALIDATE_OPOUTSTRPORT(pos, port) \
  SCM_MAKE_VALIDATE (pos, port, OPOUTSTRPORTP)

#define SCM_VALIDATE_FLUID(pos, fluid) SCM_MAKE_VALIDATE (pos, fluid, FLUIDP)

#define SCM_VALIDATE_KEYWORD(pos, v) SCM_MAKE_VALIDATE (pos, v, KEYWORDP)

#define SCM_VALIDATE_STACK(pos, v) SCM_MAKE_VALIDATE (pos, v, STACKP)

#define SCM_VALIDATE_FRAME(pos, v) SCM_MAKE_VALIDATE (pos, v, FRAMEP)

#define SCM_VALIDATE_RSTATE(pos, v) SCM_MAKE_VALIDATE (pos, v, RSTATEP)

#define SCM_VALIDATE_ARRAY(pos,v) \
  do { \
    SCM_ASSERT (SCM_NIMP (v) \
                && !SCM_FALSEP (scm_array_p (v, SCM_UNDEFINED)), \
                v, pos, FUNC_NAME); \
  } while (0)

#define SCM_VALIDATE_VECTOR(pos, v) SCM_MAKE_VALIDATE (pos, v, VECTORP)

#define SCM_VALIDATE_VECTOR_OR_DVECTOR(pos, v) \
  do { \
    SCM_ASSERT ((SCM_VECTORP (v) \
                || (SCM_NIMP (v) && SCM_TYP7 (v) == scm_tc7_dvect)), \
                v, pos, FUNC_NAME); \
  } while (0)

#define SCM_VALIDATE_STRUCT(pos, v) SCM_MAKE_VALIDATE (pos, v, STRUCTP)

#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_VECTORP (v) && len == SCM_VECTOR_LENGTH (v), v, pos, FUNC_NAME); \
  } while (0)

\f

#if (SCM_DEBUG_DEPRECATED == 0)

#define SCM_FUNC_NAME (scm_makfrom0str (FUNC_NAME))

#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_VALIDATE_NUMBER_COPY(pos, z, cvar)	\
  do {						\
    if (SCM_INUMP (z))				\
      cvar = (double) SCM_INUM (z);		\
    else if (SCM_REALP (z))			\
      cvar = SCM_REAL_VALUE (z);		\
    else if (SCM_BIGP (z))			\
      cvar = scm_big2dbl (z);			\
    else					\
      {						\
	cvar = 0.0;				\
        SCM_WRONG_TYPE_ARG (pos, z);		\
      }						\
  } while (0)

#define SCM_VALIDATE_NUMBER_DEF_COPY(pos, number, def, cvar)	\
  do {								\
    if (SCM_UNBNDP (number))					\
      cvar = def;						\
    else							\
      SCM_VALIDATE_NUMBER_COPY(pos, number, cvar);		\
  } while (0)

#define SCM_VALIDATE_STRINGORSUBSTR SCM_VALIDATE_STRING

#define SCM_VALIDATE_ROSTRING(pos, str) SCM_MAKE_VALIDATE (pos, str, ROSTRINGP)

#define SCM_VALIDATE_ROSTRING_COPY(pos, str, cvar) \
  do { \
    SCM_ASSERT (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_ROSTRINGP (str), \
                str, pos, FUNC_NAME); \
    if (SCM_FALSEP(str)) \
      cvar = NULL; \
    else \
      cvar = SCM_ROCHARS(str); \
  } while (0)

#define SCM_VALIDATE_RWSTRING(pos, str) \
  do { \
    SCM_ASSERT (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_OPDIR(pos, port) SCM_MAKE_VALIDATE (pos, port, OPDIRP)

#endif  /* SCM_DEBUG_DEPRECATED == 0 */

#endif

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/
Commit	Line	Data
e4b265d8 DH	1	/* $Id: validate.h,v 1.31 2001-04-10 07:57:05 dirk Exp $ */
e4b265d8 DH	2	/* Copyright (C) 1999,2000,2001 Free Software Foundation, Inc.
e94e3f21	3	*
5bff3127 GB	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.
e94e3f21	8	*
5bff3127 GB	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.
e94e3f21	13	*
5bff3127 GB	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
39bcc76e	48	#define SCM_SYSERROR do { scm_syserror (FUNC_NAME); } while (0)
1bbd0b84	49
39bcc76e	50	#define SCM_MEMORY_ERROR do { scm_memory_error (FUNC_NAME); } while (0)
1bbd0b84	51
39bcc76e MD	52	#define SCM_SYSERROR_MSG(str, args, val) \
39bcc76e MD	53	do { scm_syserror_msg (FUNC_NAME, (str), (args), (val)); } while (0)
1bbd0b84	54
39bcc76e MD	55	#define SCM_MISC_ERROR(str, args) \
39bcc76e MD	56	do { scm_misc_error (FUNC_NAME, str, args); } while (0)
1bbd0b84	57
398d8ee1	58	#define SCM_WRONG_NUM_ARGS() \
68baa7e7	59	do { scm_error_num_args_subr (FUNC_NAME); } while (0)
398d8ee1	60
39bcc76e MD	61	#define SCM_WRONG_TYPE_ARG(pos, obj) \
39bcc76e MD	62	do { scm_wrong_type_arg (FUNC_NAME, pos, obj); } while (0)
1bbd0b84	63
e4b265d8	64	#define SCM_NUM2ULONG(pos, arg) (scm_num2ulong (arg, pos, FUNC_NAME))
1bbd0b84	65
e4b265d8	66	#define SCM_NUM2LONG(pos, arg) (scm_num2long (arg, pos, FUNC_NAME))
1bbd0b84	67
39bcc76e	68	#define SCM_NUM2LONG_DEF(pos, arg, def) \
e4b265d8	69	(SCM_UNBNDP (arg) ? def : scm_num2long (arg, pos, FUNC_NAME))
c1bfcf60	70
39bcc76e	71	#define SCM_NUM2LONG_LONG(pos, arg) \
e4b265d8	72	(scm_num2long_long (arg, pos, FUNC_NAME))
1bbd0b84	73
39bcc76e MD	74	#define SCM_OUT_OF_RANGE(pos, arg) \
39bcc76e MD	75	do { scm_out_of_range_pos (FUNC_NAME, arg, SCM_MAKINUM (pos)); } while (0)
1bbd0b84	76
39bcc76e	77	#define SCM_ASSERT_RANGE(pos, arg, f) \
23deee81	78	do { if (!(f)) scm_out_of_range_pos (FUNC_NAME, arg, SCM_MAKINUM (pos)); } while (0)
1bbd0b84	79
39bcc76e MD	80	#define SCM_MUST_MALLOC_TYPE(type) \
39bcc76e MD	81	((type *) scm_must_malloc (sizeof (type), FUNC_NAME))
1bbd0b84	82
39bcc76e MD	83	#define SCM_MUST_MALLOC_TYPE_NUM(type, num) \
39bcc76e MD	84	((type ) scm_must_malloc (sizeof (type) (num), FUNC_NAME))
1bbd0b84	85
39bcc76e	86	#define SCM_MUST_MALLOC(size) (scm_must_malloc ((size), FUNC_NAME))
1bbd0b84	87
39bcc76e MD	88	#define SCM_MAKE_VALIDATE(pos, var, pred) \
	89	do { \
	90	SCM_ASSERT_TYPE (SCM_ ## pred (var), var, pos, FUNC_NAME, #pred); \
	91	} while (0)
6b5a304f	92
6e8d25a6 GB	93	\f
6e8d25a6 GB	94
af45e3b0 DH	95	#define SCM_VALIDATE_REST_ARGUMENT(x) \
	96	do { \
	97	if (SCM_DEBUG_REST_ARGUMENT) { \
	98	if (scm_ilength (x) < 0) { \
	99	SCM_MISC_ERROR ("Rest arguments do not form a proper list.", SCM_EOL); \
	100	} \
	101	} \
	102	} while (0)
	103
39bcc76e	104	#define SCM_VALIDATE_NIM(pos, scm) SCM_MAKE_VALIDATE (pos, scm, NIMP)
6e8d25a6	105
39bcc76e	106	#define SCM_VALIDATE_BOOL(pos, flag) SCM_MAKE_VALIDATE(pos, flag, BOOLP)
1bbd0b84	107
39bcc76e MD	108	#define SCM_VALIDATE_BOOL_COPY(pos, flag, cvar) \
	109	do { \
	110	SCM_ASSERT (SCM_BOOLP (flag), flag, pos, FUNC_NAME); \
9a09deb1	111	cvar = SCM_EQ_P (flag, SCM_BOOL_T) ? 1 : 0; \
39bcc76e	112	} while (0)
1bbd0b84	113
f5f2dcff	114	#define SCM_VALIDATE_CHAR(pos, scm) SCM_MAKE_VALIDATE (pos, scm, CHARP)
1bbd0b84	115
39bcc76e MD	116	#define SCM_VALIDATE_CHAR_COPY(pos, scm, cvar) \
	117	do { \
	118	SCM_ASSERT (SCM_CHARP (scm), scm, pos, FUNC_NAME); \
	119	cvar = SCM_CHAR (scm); \
	120	} while (0)
1bbd0b84	121
39bcc76e	122	#define SCM_VALIDATE_STRING(pos, str) SCM_MAKE_VALIDATE (pos, str, STRINGP)
1bbd0b84	123
39bcc76e MD	124	#define SCM_VALIDATE_STRING_COPY(pos, str, cvar) \
	125	do { \
	126	SCM_ASSERT (SCM_STRINGP (str), str, pos, FUNC_NAME); \
86c991c2	127	cvar = SCM_STRING_CHARS(str); \
39bcc76e	128	} while (0)
1bbd0b84	129
60d02d09 GH	130	/* validate a string and optional start/end arguments which default to
	131	0/string-len. this is unrelated to the old shared substring
	132	support, so please do not deprecate it :) */
	133	#define SCM_VALIDATE_SUBSTRING_SPEC_COPY(pos_str, str, c_str, \
	134	pos_start, start, c_start,\
	135	pos_end, end, c_end) \
	136	do {\
	137	SCM_VALIDATE_STRING_COPY (pos_str, str, c_str);\
	138	SCM_VALIDATE_INUM_DEF_COPY (pos_start, start, 0, c_start);\
	139	SCM_VALIDATE_INUM_DEF_COPY (pos_end, end, SCM_STRING_LENGTH (str), c_end);\
	140	SCM_ASSERT_RANGE (pos_start, start,\
	141	0 <= c_start && c_start <= SCM_STRING_LENGTH (str));\
	142	SCM_ASSERT_RANGE (pos_end, end,\
	143	c_start <= c_end && c_end <= SCM_STRING_LENGTH (str));\
	144	} while (0)
	145
39bcc76e	146	#define SCM_VALIDATE_REAL(pos, z) SCM_MAKE_VALIDATE (pos, z, REALP)
1bbd0b84	147
e8a46ba8 MV	148	#define SCM_VALIDATE_NUMBER(pos, z) SCM_MAKE_VALIDATE (pos, z, NUMBERP)
e8a46ba8 MV	149
39bcc76e	150	#define SCM_VALIDATE_INUM(pos, k) SCM_MAKE_VALIDATE (pos, k, INUMP)
1bbd0b84	151
39bcc76e MD	152	#define SCM_VALIDATE_INUM_COPY(pos, k, cvar) \
	153	do { \
	154	SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
	155	cvar = SCM_INUM (k); \
	156	} while (0)
1bbd0b84	157
39bcc76e MD	158	#define SCM_VALIDATE_ULONG_COPY(pos, k, cvar) \
	159	do { \
	160	cvar = SCM_NUM2ULONG (pos, k); \
	161	} while (0)
2cd04b42	162
39bcc76e MD	163	#define SCM_VALIDATE_LONG_COPY(pos, k, cvar) \
39bcc76e MD	164	do { \
e4b265d8	165	cvar = SCM_NUM2LONG (pos, k); \
39bcc76e	166	} while (0)
2cd04b42	167
39bcc76e	168	#define SCM_VALIDATE_BIGINT(pos, k) SCM_MAKE_VALIDATE (pos, k, BIGP)
1bbd0b84	169
39bcc76e MD	170	#define SCM_VALIDATE_INUM_MIN(pos, k, min) \
	171	do { \
	172	SCM_ASSERT (SCM_INUMP(k), k, pos, FUNC_NAME); \
	173	SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
	174	} while (0)
1bbd0b84	175
39bcc76e MD	176	#define SCM_VALIDATE_INUM_MIN_COPY(pos, k, min, cvar) \
	177	do { \
	178	SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
fdf25853	179	SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
39bcc76e	180	cvar = SCM_INUM (k); \
39bcc76e	181	} while (0)
1bbd0b84	182
39bcc76e MD	183	#define SCM_VALIDATE_INUM_MIN_DEF_COPY(pos, k, min, default, cvar) \
	184	do { \
	185	if (SCM_UNBNDP (k)) \
	186	k = SCM_MAKINUM (default); \
	187	SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
fdf25853	188	SCM_ASSERT_RANGE (pos, k, (SCM_INUM (k) >= min)); \
39bcc76e	189	cvar = SCM_INUM (k); \
39bcc76e	190	} while (0)
1bbd0b84	191
39bcc76e MD	192	#define SCM_VALIDATE_INUM_DEF(pos, k, default) \
	193	do { \
	194	if (SCM_UNBNDP (k)) \
	195	k = SCM_MAKINUM (default); \
	196	else SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
	197	} while (0)
1bbd0b84	198
39bcc76e MD	199	#define SCM_VALIDATE_INUM_DEF_COPY(pos, k, default, cvar) \
	200	do { \
	201	if (SCM_UNBNDP (k)) \
	202	{ \
	203	k = SCM_MAKINUM (default); \
	204	cvar = default; \
	205	} \
	206	else \
	207	{ \
	208	SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
	209	cvar = SCM_INUM (k); \
	210	} \
	211	} while (0)
1bbd0b84 GB	212
1bbd0b84 GB	213	/* [low,high) */
120d4924 GB	214	#define SCM_VALIDATE_INUM_RANGE(pos,k,low,high) \
	215	do { SCM_ASSERT(SCM_INUMP(k), k, pos, FUNC_NAME); \
	216	SCM_ASSERT_RANGE(pos,k, \
	217	(SCM_INUM (k) >= low && \
	218	SCM_INUM (k) < high)); \
	219	} while (0)
39bcc76e	220
7642eb4b MD	221	#define SCM_VALIDATE_INUM_RANGE_COPY(pos, k, low, high, cvar) \
	222	do { \
	223	SCM_ASSERT (SCM_INUMP (k), k, pos, FUNC_NAME); \
fdf25853	224	SCM_ASSERT_RANGE (pos, k, low <= SCM_INUM (k) && SCM_INUM (k) < high); \
7642eb4b	225	cvar = SCM_INUM (k); \
7642eb4b MD	226	} while (0)
7642eb4b MD	227
39bcc76e	228	#define SCM_VALIDATE_NULL(pos, scm) SCM_MAKE_VALIDATE (pos, scm, NULLP)
1bbd0b84	229
39bcc76e	230	#define SCM_VALIDATE_CONS(pos, scm) SCM_MAKE_VALIDATE (pos, scm, CONSP)
1bbd0b84	231
39bcc76e MD	232	#define SCM_VALIDATE_LIST(pos, lst) \
	233	do { \
	234	SCM_ASSERT (scm_ilength (lst) >= 0, lst, pos, FUNC_NAME); \
	235	} while (0)
1bbd0b84	236
39bcc76e MD	237	#define SCM_VALIDATE_NONEMPTYLIST(pos, lst) \
	238	do { \
	239	SCM_ASSERT (scm_ilength (lst) > 0, lst, pos, FUNC_NAME); \
	240	} while (0)
1bbd0b84	241
39bcc76e MD	242	#define SCM_VALIDATE_LIST_COPYLEN(pos, lst, cvar) \
	243	do { \
	244	cvar = scm_ilength (lst); \
	245	SCM_ASSERT (cvar >= 0, lst, pos, FUNC_NAME); \
	246	} while (0)
c1bfcf60	247
39bcc76e MD	248	#define SCM_VALIDATE_NONEMPTYLIST_COPYLEN(pos, lst, cvar) \
	249	do { \
	250	cvar = scm_ilength (lst); \
	251	SCM_ASSERT (cvar >= 1, lst, pos, FUNC_NAME); \
	252	} while (0)
1bbd0b84	253
39bcc76e MD	254	#define SCM_VALIDATE_ALISTCELL(pos, alist) \
	255	do { \
	256	SCM_ASSERT (SCM_CONSP (alist) && SCM_CONSP (SCM_CAR (alist)), \
	257	alist, pos, FUNC_NAME); \
	258	} while (0)
1bbd0b84	259
39bcc76e	260	#define SCM_VALIDATE_ALISTCELL_COPYSCM(pos, alist, cvar) \
1bbd0b84	261	do { \
39bcc76e MD	262	SCM_ASSERT (SCM_CONSP (alist), alist, pos, FUNC_NAME); \
	263	cvar = SCM_CAR (alist); \
	264	SCM_ASSERT (SCM_CONSP (cvar), alist, pos, FUNC_NAME); \
30939477	265	} while (0)
1bbd0b84	266
39bcc76e	267	#define SCM_VALIDATE_OPORT_VALUE(pos, port) \
1bbd0b84	268	do { \
39bcc76e MD	269	SCM_ASSERT (scm_valid_oport_value_p (port), port, pos, FUNC_NAME); \
	270	} while (0)
	271
	272	#define SCM_VALIDATE_PRINTSTATE(pos, a) SCM_MAKE_VALIDATE(pos,a,PRINT_STATE_P)
1bbd0b84	273
39bcc76e MD	274	#define SCM_VALIDATE_SMOB(pos, obj, type) \
39bcc76e MD	275	do { \
e841c3e0	276	SCM_ASSERT (SCM_TYP16_PREDICATE (scm_tc16_ ## type, obj), \
39bcc76e MD	277	obj, pos, FUNC_NAME); \
39bcc76e MD	278	} while (0)
1bbd0b84	279
39bcc76e	280	#define SCM_VALIDATE_THREAD(pos, a) SCM_MAKE_VALIDATE (pos, a, THREADP)
1bbd0b84	281
39bcc76e MD	282	#define SCM_VALIDATE_THUNK(pos, thunk) \
	283	do { \
	284	SCM_ASSERT (SCM_NFALSEP (scm_thunk_p (thunk)), thunk, pos, FUNC_NAME); \
	285	} while (0)
1bbd0b84	286
39bcc76e	287	#define SCM_VALIDATE_SYMBOL(pos, sym) SCM_MAKE_VALIDATE (pos, sym, SYMBOLP)
0c95b57d	288
39bcc76e	289	#define SCM_VALIDATE_VARIABLE(pos, var) SCM_MAKE_VALIDATE (pos, var, VARIABLEP)
1bbd0b84	290
39bcc76e	291	#define SCM_VALIDATE_MEMOIZED(pos, obj) SCM_MAKE_VALIDATE (pos, obj, MEMOIZEDP)
1bbd0b84	292
39bcc76e	293	#define SCM_VALIDATE_CLOSURE(pos, obj) SCM_MAKE_VALIDATE (pos, obj, CLOSUREP)
1bbd0b84	294
39bcc76e MD	295	#define SCM_VALIDATE_PROC(pos, proc) \
39bcc76e MD	296	do { \
9a09deb1	297	SCM_ASSERT (SCM_EQ_P (scm_procedure_p (proc), SCM_BOOL_T), proc, pos, FUNC_NAME); \
39bcc76e	298	} while (0)
1bbd0b84	299
39bcc76e MD	300	#define SCM_VALIDATE_NULLORCONS(pos, env) \
	301	do { \
	302	SCM_ASSERT (SCM_NULLP (env) \|\| SCM_CONSP (env), env, pos, FUNC_NAME); \
	303	} while (0)
1bbd0b84	304
39bcc76e	305	#define SCM_VALIDATE_HOOK(pos, a) SCM_MAKE_VALIDATE (pos, a, HOOKP)
1bbd0b84	306
39bcc76e	307	#define SCM_VALIDATE_RGXP(pos, a) SCM_MAKE_VALIDATE (pos, a, RGXP)
1bbd0b84	308
39bcc76e	309	#define SCM_VALIDATE_DIR(pos, port) SCM_MAKE_VALIDATE (pos, port, DIRP)
1bbd0b84	310
39bcc76e	311	#define SCM_VALIDATE_PORT(pos, port) SCM_MAKE_VALIDATE (pos, port, PORTP)
1bbd0b84	312
39bcc76e MD	313	#define SCM_VALIDATE_INPUT_PORT(pos, port) \
39bcc76e MD	314	SCM_MAKE_VALIDATE (pos, port, INPUT_PORT_P)
1bbd0b84	315
39bcc76e MD	316	#define SCM_VALIDATE_OUTPUT_PORT(pos, port) \
39bcc76e MD	317	SCM_MAKE_VALIDATE (pos, port, OUTPUT_PORT_P)
1bbd0b84	318
39bcc76e	319	#define SCM_VALIDATE_FPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, FPORTP)
1bbd0b84	320
39bcc76e	321	#define SCM_VALIDATE_OPFPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, OPFPORTP)
1bbd0b84	322
39bcc76e MD	323	#define SCM_VALIDATE_OPINPORT(pos, port) \
39bcc76e MD	324	SCM_MAKE_VALIDATE (pos, port, OPINPORTP)
1bbd0b84 GB	325
1bbd0b84 GB	326	#define SCM_VALIDATE_OPENPORT(pos,port) \
39bcc76e MD	327	do { \
	328	SCM_ASSERT (SCM_PORTP (port) && SCM_OPENP (port), \
	329	port, pos, FUNC_NAME); \
	330	} while (0)
1bbd0b84	331
39bcc76e	332	#define SCM_VALIDATE_OPPORT(pos, port) SCM_MAKE_VALIDATE (pos, port, OPPORTP)
1bbd0b84	333
39bcc76e MD	334	#define SCM_VALIDATE_OPOUTPORT(pos, port) \
39bcc76e MD	335	SCM_MAKE_VALIDATE (pos, port, OPOUTPORTP)
1bbd0b84	336
e87a03fc MG	337	#define SCM_VALIDATE_OPOUTSTRPORT(pos, port) \
	338	SCM_MAKE_VALIDATE (pos, port, OPOUTSTRPORTP)
	339
39bcc76e	340	#define SCM_VALIDATE_FLUID(pos, fluid) SCM_MAKE_VALIDATE (pos, fluid, FLUIDP)
1bbd0b84	341
39bcc76e	342	#define SCM_VALIDATE_KEYWORD(pos, v) SCM_MAKE_VALIDATE (pos, v, KEYWORDP)
1bbd0b84	343
39bcc76e	344	#define SCM_VALIDATE_STACK(pos, v) SCM_MAKE_VALIDATE (pos, v, STACKP)
1bbd0b84	345
39bcc76e	346	#define SCM_VALIDATE_FRAME(pos, v) SCM_MAKE_VALIDATE (pos, v, FRAMEP)
1bbd0b84	347
39bcc76e	348	#define SCM_VALIDATE_RSTATE(pos, v) SCM_MAKE_VALIDATE (pos, v, RSTATEP)
1bbd0b84 GB	349
1bbd0b84 GB	350	#define SCM_VALIDATE_ARRAY(pos,v) \
39bcc76e MD	351	do { \
	352	SCM_ASSERT (SCM_NIMP (v) \
	353	&& !SCM_FALSEP (scm_array_p (v, SCM_UNDEFINED)), \
	354	v, pos, FUNC_NAME); \
	355	} while (0)
1bbd0b84	356
39bcc76e	357	#define SCM_VALIDATE_VECTOR(pos, v) SCM_MAKE_VALIDATE (pos, v, VECTORP)
1bbd0b84	358
39bcc76e MD	359	#define SCM_VALIDATE_VECTOR_OR_DVECTOR(pos, v) \
	360	do { \
	361	SCM_ASSERT ((SCM_VECTORP (v) \
	362	\|\| (SCM_NIMP (v) && SCM_TYP7 (v) == scm_tc7_dvect)), \
	363	v, pos, FUNC_NAME); \
	364	} while (0)
368cf54d	365
39bcc76e	366	#define SCM_VALIDATE_STRUCT(pos, v) SCM_MAKE_VALIDATE (pos, v, STRUCTP)
1bbd0b84	367
39bcc76e MD	368	#define SCM_VALIDATE_VTABLE(pos, v) \
	369	do { \
	370	SCM_ASSERT (SCM_NIMP (v) && SCM_NFALSEP (scm_struct_vtable_p (v)), \
	371	v, pos, FUNC_NAME); \
	372	} while (0)
1bbd0b84	373
39bcc76e MD	374	#define SCM_VALIDATE_VECTOR_LEN(pos, v, len) \
39bcc76e MD	375	do { \
9fd38a3d	376	SCM_ASSERT (SCM_VECTORP (v) && len == SCM_VECTOR_LENGTH (v), v, pos, FUNC_NAME); \
39bcc76e	377	} while (0)
1bbd0b84	378
d1ca2c64 DH	379	\f
	380
	381	#if (SCM_DEBUG_DEPRECATED == 0)
	382
b3fcac34 DH	383	#define SCM_FUNC_NAME (scm_makfrom0str (FUNC_NAME))
b3fcac34 DH	384
276dd677 DH	385	#define SCM_WTA(pos, scm) \
	386	do { scm_wta (scm, (char *) pos, FUNC_NAME); } while (0)
	387
	388	#define RETURN_SCM_WTA(pos, scm) \
	389	do { return scm_wta (scm, (char *) pos, FUNC_NAME); } while (0)
	390
b3fcac34 DH	391	#define SCM_VALIDATE_NUMBER_COPY(pos, z, cvar) \
	392	do { \
	393	if (SCM_INUMP (z)) \
	394	cvar = (double) SCM_INUM (z); \
	395	else if (SCM_REALP (z)) \
	396	cvar = SCM_REAL_VALUE (z); \
	397	else if (SCM_BIGP (z)) \
	398	cvar = scm_big2dbl (z); \
	399	else \
	400	{ \
	401	cvar = 0.0; \
	402	SCM_WRONG_TYPE_ARG (pos, z); \
	403	} \
	404	} while (0)
	405
	406	#define SCM_VALIDATE_NUMBER_DEF_COPY(pos, number, def, cvar) \
	407	do { \
	408	if (SCM_UNBNDP (number)) \
	409	cvar = def; \
	410	else \
	411	SCM_VALIDATE_NUMBER_COPY(pos, number, cvar); \
	412	} while (0)
	413
d1ca2c64 DH	414	#define SCM_VALIDATE_STRINGORSUBSTR SCM_VALIDATE_STRING
d1ca2c64 DH	415
a6d9e5ab DH	416	#define SCM_VALIDATE_ROSTRING(pos, str) SCM_MAKE_VALIDATE (pos, str, ROSTRINGP)
	417
	418	#define SCM_VALIDATE_ROSTRING_COPY(pos, str, cvar) \
	419	do { \
	420	SCM_ASSERT (SCM_ROSTRINGP (str), str, pos, FUNC_NAME); \
	421	cvar = SCM_ROCHARS (str); \
	422	} while (0)
	423
	424	#define SCM_VALIDATE_NULLORROSTRING_COPY(pos, str, cvar) \
	425	do { \
	426	SCM_ASSERT (SCM_FALSEP (str) \|\| SCM_ROSTRINGP (str), \
	427	str, pos, FUNC_NAME); \
	428	if (SCM_FALSEP(str)) \
	429	cvar = NULL; \
	430	else \
	431	cvar = SCM_ROCHARS(str); \
	432	} while (0)
	433
395d8627 DH	434	#define SCM_VALIDATE_RWSTRING(pos, str) \
	435	do { \
	436	SCM_ASSERT (SCM_STRINGP (str), str, pos, FUNC_NAME); \
	437	if (!SCM_RWSTRINGP (str)) \
	438	scm_misc_error (FUNC_NAME, "argument is a read-only string", str); \
	439	} while (0)
	440
30ea841d DH	441	#define SCM_VALIDATE_OPDIR(pos, port) SCM_MAKE_VALIDATE (pos, port, OPDIRP)
30ea841d DH	442
d1ca2c64 DH	443	#endif /* SCM_DEBUG_DEPRECATED == 0 */
d1ca2c64 DH	444
1bbd0b84	445	#endif
89e00824 ML	446
	447	/*
	448	Local Variables:
	449	c-file-style: "gnu"
	450	End:
	451	*/