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

/* classes: h_files */

#ifndef __SCMH
#define __SCMH
/*	Copyright (C) 1995, 1996, 1998, 1999, 2000 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.  */
\f
/* {Supported Options}
 *
 * These may be defined or undefined.
 */

/* #define GUILE_DEBUG_FREELIST */

/* If the compile FLAG `SCM_CAUTIOUS' is #defined then the number of
 * arguments is always checked for application of closures.  If the
 * compile FLAG `SCM_RECKLESS' is #defined then they are not checked.
 * Otherwise, number of argument checks for closures are made only when
 * the function position (whose value is the closure) of a combination is
 * not an ILOC or GLOC.  When the function position of a combination is a
 * symbol it will be checked only the first time it is evaluated because
 * it will then be replaced with an ILOC or GLOC.
 */
#undef SCM_RECKLESS
#define SCM_CAUTIOUS

/* After looking up a local for the first time, rewrite the
 * code graph, caching its position.
 */
#define MEMOIZE_LOCALS

/* All the number support there is.
 */
#define SCM_FLOATS
#define BIGNUMS

/* GC should relinquish empty cons-pair arenas. 
 */
#define GC_FREE_SEGMENTS

/* Provide a scheme-accessible count-down timer that
 * generates a pseudo-interrupt.
 */
#define TICKS


/* Use engineering notation when converting numbers strings?
 */
#undef ENGNOT

#undef SCM_CAREFUL_INTS
\f
/* {Unsupported Options}
 *
 * These must be defined as given here.
 */


#define CCLO

/* Guile Scheme supports the #f/() distinction; Guile Lisp won't.  We
   have horrible plans for their unification.  */
#undef SICP

\f

/* Random options (not yet supported or in final form). */

#define STACK_CHECKING
#undef NO_CEVAL_STACK_CHECKING

\f
/* What did the configure script discover about the outside world?  */
#include "libguile/scmconfig.h"

#ifdef HAVE_LONG_LONGS

/* Some auto-generated .h files contain unused prototypes
 * that need these typedefs.
 */
typedef long long long_long;
typedef unsigned long long ulong_long;

#endif /* HAVE_LONG_LONGS */

\f

/* Define
 *
 * SCM_CHAR_CODE_LIMIT		== UCHAR_MAX + 1
 * SCM_MOST_POSITIVE_FIXNUM 	(LONG_MAX>>2)
 * SCM_MOST_NEGATIVE_FIXNUM 	== SCM_SRS((long)LONG_MIN, 2)
 */

#ifdef HAVE_LIMITS_H
# include <limits.h>
# ifdef UCHAR_MAX
#  define SCM_CHAR_CODE_LIMIT (UCHAR_MAX+1L)
# else
#  define SCM_CHAR_CODE_LIMIT 256L
# endif /* def UCHAR_MAX */
# define SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
# ifdef _UNICOS			/* Stupid cray bug */
#  define SCM_MOST_NEGATIVE_FIXNUM ((long)LONG_MIN/4)
# else
#  define SCM_MOST_NEGATIVE_FIXNUM SCM_SRS((long)LONG_MIN, 2)
# endif				/* UNICOS */
#else
# define SCM_CHAR_CODE_LIMIT 256L
# define SCM_MOST_POSITIVE_FIXNUM ((long)((unsigned long)~0L>>3))
# if (0 != ~0)
#  define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
# else
#  define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM)
# endif /*  (0 != ~0) */
#endif /* def HAVE_LIMITS_H */
\f

#ifdef STDC_HEADERS
# include <stdlib.h>
# ifdef AMIGA
#  include <stddef.h>
# endif /* def AMIGA */
# define scm_sizet size_t
#else
# ifdef _SIZE_T
#  define scm_sizet size_t
# else
#  define scm_sizet unsigned int
# endif /* def _SIZE_T */
#endif /* def STDC_HEADERS */

\f

#include "libguile/tags.h"

\f
#ifdef vms
# ifndef CHEAP_CONTINUATIONS
   typedef int jmp_buf[17];
   extern int setjump(jmp_buf env);
   extern int longjump(jmp_buf env, int ret);
#  define setjmp setjump
#  define longjmp longjump
# else
#  include <setjmp.h>
# endif
#else				/* ndef vms */
# ifdef _CRAY1
    typedef int jmp_buf[112];
    extern int setjump(jmp_buf env);
    extern int longjump(jmp_buf env, int ret);
#  define setjmp setjump
#  define longjmp longjump
# else				/* ndef _CRAY1 */
#  include <setjmp.h>
# endif				/* ndef _CRAY1 */
#endif				/* ndef vms */

/* James Clark came up with this neat one instruction fix for
 * continuations on the SPARC.  It flushes the register windows so
 * that all the state of the process is contained in the stack. 
 */

#ifdef sparc
# define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3")
#else
# define SCM_FLUSH_REGISTER_WINDOWS /* empty */
#endif

/* If stack is not longword aligned then 
 */

/* #define SHORT_ALIGN */
#ifdef THINK_C
# define SHORT_ALIGN
#endif
#ifdef MSDOS
# define SHORT_ALIGN
#endif
#ifdef atarist
# define SHORT_ALIGN
#endif

#ifdef SHORT_ALIGN
typedef short SCM_STACKITEM;
#else
typedef long SCM_STACKITEM;
#endif
\f

#ifndef USE_THREADS
#define SCM_THREAD_DEFER
#define SCM_THREAD_ALLOW
#define SCM_THREAD_REDEFER
#define SCM_THREAD_SWITCHING_CODE
#endif

extern unsigned int scm_async_clock;

#define SCM_ASYNC_TICK \
do { \
  if (0 == --scm_async_clock) \
    scm_async_click (); \
} while(0)

#ifdef SCM_CAREFUL_INTS
#define SCM_CHECK_NOT_DISABLED \
  if (scm_ints_disabled) \
    fputs("ints already disabled\n", stderr); \

#define SCM_CHECK_NOT_ENABLED \
  if (!scm_ints_disabled) \
    fputs("ints already enabled\n", stderr); \

#else
#define SCM_CHECK_NOT_DISABLED
#define SCM_CHECK_NOT_ENABLED
#endif


/* Anthony Green writes:
   When the compiler sees...
	   DEFER_INTS;
	   [critical code here]
	   ALLOW_INTS;
   ...it doesn't actually promise to keep the critical code within the
   boundries of the DEFER/ALLOW_INTS instructions. It may very well
   schedule it outside of the magic defined in those macros.

   However, GCC's volatile asm feature forms a barrier over which code is
   never moved. So if you add...
	   asm ("");
   ...to each of the DEFER_INTS and ALLOW_INTS macros, the critical
   code will always remain in place.  asm's without inputs or outputs
   are implicitly volatile. */
#ifdef __GNUC__
#define SCM_FENCE asm /* volatile */ ("")
#else
#define SCM_FENCE
#endif

#define SCM_DEFER_INTS \
do { \
  SCM_FENCE; \
  SCM_CHECK_NOT_DISABLED; \
  SCM_THREAD_DEFER; \
  SCM_FENCE; \
  scm_ints_disabled = 1; \
  SCM_FENCE; \
} while (0)


#define SCM_ALLOW_INTS_ONLY \
do { \
  SCM_THREAD_ALLOW; \
  scm_ints_disabled = 0; \
} while (0)


#define SCM_ALLOW_INTS \
do { \
  SCM_FENCE; \
  SCM_CHECK_NOT_ENABLED; \
  SCM_THREAD_SWITCHING_CODE; \
  SCM_FENCE; \
  scm_ints_disabled = 0; \
  SCM_FENCE; \
  SCM_THREAD_ALLOW; \
  SCM_FENCE; \
} while (0)


#define SCM_REDEFER_INTS  \
do { \
  SCM_FENCE; \
  SCM_THREAD_REDEFER; \
  ++scm_ints_disabled; \
  SCM_FENCE; \
} while (0)


#define SCM_REALLOW_INTS \
do { \
  SCM_FENCE; \
  SCM_THREAD_SWITCHING_CODE; \
  SCM_FENCE; \
  --scm_ints_disabled; \
  SCM_FENCE; \
} while (0)


#define SCM_TICK \
do { \
  SCM_DEFER_INTS; \
  SCM_ALLOW_INTS; \
  SCM_ASYNC_TICK; \
} while (0)

\f

/* Classification of critical sections
 *
 * When Guile moves to POSIX threads, it won't be possible to prevent
 * context switching.  In fact, the whole idea of context switching is
 * bogus if threads are run by different processors.  Therefore, we
 * must ultimately eliminate all critical sections or enforce them by
 * use of mutecis.
 *
 * All instances of SCM_DEFER_INTS and SCM_ALLOW_INTS should therefore
 * be classified and replaced by one of the delimiters below.  If you
 * understand what this is all about, I'd like to encourage you to
 * help with this task.  The set of classes below must of course be
 * incrementally augmented.
 *
 * MDJ 980419 <djurfeldt@nada.kth.se>
 */

/* A sections
 *
 * Allocation of a cell with type tag in the CAR.
 *
 * With POSIX threads, each thread will have a private pool of free
 * cells.  Therefore, this type of section can be removed.  But!  It
 * is important that the CDR is initialized first (with the CAR still
 * indicating a free cell) so that we can guarantee a consistent heap
 * at all times.
 */

#ifdef SCM_POSIX_THREADS
#define SCM_ENTER_A_SECTION
#define SCM_EXIT_A_SECTION
#else
#define SCM_ENTER_A_SECTION SCM_DEFER_INTS
#define SCM_EXIT_A_SECTION SCM_ALLOW_INTS
#endif

\f

/** SCM_ASSERT
 ** 
 **/


#ifdef SCM_RECKLESS
#define SCM_ASSERT(_cond, _arg, _pos, _subr)
#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr)
#define SCM_ASRTGO(_cond, _label)
#else
#define SCM_ASSERT(_cond, _arg, _pos, _subr) \
	if (!(_cond)) \
          scm_wta(_arg, (char *)(_pos), _subr)
#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) \
	if (!(_cond)) \
          scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg)
#define SCM_ASRTGO(_cond, _label) \
        if (!(_cond)) \
          goto _label
#endif

/*
 * SCM_WTA_DISPATCH
 */

extern SCM scm_call_generic_0 (SCM gf);

#define SCM_WTA_DISPATCH_0(gf, arg, pos, subr) \
  return ((gf) \
          ? scm_call_generic_0 ((gf)) \
          : scm_wta ((arg), (char *) (pos), (subr)))
#define SCM_GASSERT0(cond, gf, arg, pos, subr) \
  if (!(cond)) SCM_WTA_DISPATCH_0((gf), (arg), (pos), (subr))

extern SCM scm_call_generic_1 (SCM gf, SCM a1);

#define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \
  return ((gf) \
          ? scm_call_generic_1 ((gf), (a1)) \
          : scm_wta ((a1), (char *) (pos), (subr)))
#define SCM_GASSERT1(cond, gf, a1, pos, subr) \
  if (!(cond)) SCM_WTA_DISPATCH_1((gf), (a1), (pos), (subr))

extern SCM scm_call_generic_2 (SCM gf, SCM a1, SCM a2);

#define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \
  return ((gf) \
          ? scm_call_generic_2 ((gf), (a1), (a2)) \
          : scm_wta ((pos) == SCM_ARG1 ? (a1) : (a2), (char *) (pos), (subr)))
#define SCM_GASSERT2(cond, gf, a1, a2, pos, subr) \
  if (!(cond)) SCM_WTA_DISPATCH_2((gf), (a1), (a2), (pos), (subr))

extern SCM scm_apply_generic (SCM gf, SCM args);

#define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \
  return ((gf) \
          ? scm_apply_generic ((gf), (args)) \
          : scm_wta (scm_list_ref ((args), SCM_MAKINUM ((pos) - 1)), \
		     (char *) (pos), \
		     (subr)))
#define SCM_GASSERTn(cond, gf, args, pos, subr) \
  if (!(cond)) SCM_WTA_DISPATCH_n((gf), (args), (pos), (subr))

#ifndef SCM_MAGIC_SNARFER
/* Let these macros pass through if
   we are snarfing;  thus we can tell the
   difference between the use of an actual
   number vs. the use of one of these macros --
   actual numbers in SCM_VALIDATE_* and SCM_ASSERT
   constructs must match the formal argument name,
   but using SCM_ARG* avoids the test */

#define SCM_ARGn 		0
#define SCM_ARG1 		1
#define SCM_ARG2 		2
#define SCM_ARG3 		3
#define SCM_ARG4 		4
#define SCM_ARG5 		5
#define SCM_ARG6 		6
#define SCM_ARG7 		7 
     /* #define SCM_ARGERR(X) 		((X) < SCM_WNA \
				 ? (char *)(X) \
				 : "wrong type argument")
				 */

/* Following must match entry indexes in scm_errmsgs[].
 * Also, SCM_WNA must follow the last SCM_ARGn in sequence.
 */
#define SCM_WNA 		8
     /* #define SCM_OVSCM_FLOW 		9 */
#define SCM_OUTOFRANGE 		10
#define SCM_NALLOC 		11
     /* #define SCM_STACK_OVFLOW	12 */
     /* #define SCM_EXIT 		13 */

#endif /* SCM_MAGIC_SNARFER */

/* (...still matching scm_errmsgs)  These
 * are signals.  Signals may become errors
 * but are distinguished because they first
 * try to invoke a handler that can resume
 * the interrupted routine.
 */
#define SCM_HUP_SIGNAL 		14
#define SCM_INT_SIGNAL 		15
#define SCM_FPE_SIGNAL 		16
#define SCM_BUS_SIGNAL 		17
#define SCM_SEGV_SIGNAL 	18
#define SCM_ALRM_SIGNAL 	19
#define SCM_GC_SIGNAL		20
#define SCM_TICK_SIGNAL		21

#define SCM_SIG_ORD(X)		((X) - SCM_HUP_SIGNAL)
#define SCM_ORD_SIG(X)		((X) + SCM_HUP_SIGNAL)
#define SCM_NUM_SIGS		(SCM_SIG_ORD (SCM_TICK_SIGNAL) + 1)

#if 0
struct errdesc
{
  char *msg;
  char *s_response;
  short parent_err;
};


extern struct errdesc scm_errmsgs[];
#endif

\f

/* SCM_EXIT_SUCCESS is the default code to return from SCM if no errors
 * were encountered.  SCM_EXIT_FAILURE is the default code to return from
 * SCM if errors were encountered.  The return code can be explicitly
 * specified in a SCM program with (scm_quit <n>).
 */

#ifndef SCM_EXIT_SUCCESS
#ifdef vms
#define SCM_EXIT_SUCCESS 1
#else
#define SCM_EXIT_SUCCESS 0
#endif /* def vms */
#endif /* ndef SCM_EXIT_SUCCESS */
#ifndef SCM_EXIT_FAILURE
#ifdef vms
#define SCM_EXIT_FAILURE 2
#else
#define SCM_EXIT_FAILURE 1
#endif /* def vms */
#endif /* ndef SCM_EXIT_FAILURE */


\f

#endif  /* __SCMH */
Commit	Line	Data
0f2d19dd JB	1	/* classes: h_files */
	2
	3	#ifndef __SCMH
	4	#define __SCMH
cd911565	5	/* Copyright (C) 1995, 1996, 1998, 1999, 2000 Free Software Foundation, Inc.
0f2d19dd JB	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2, or (at your option)
	10	* any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this software; see the file COPYING. If not, write to
82892bed JB	19	* the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
82892bed JB	20	* Boston, MA 02111-1307 USA
0f2d19dd JB	21	*
	22	* As a special exception, the Free Software Foundation gives permission
	23	* for additional uses of the text contained in its release of GUILE.
	24	*
	25	* The exception is that, if you link the GUILE library with other files
	26	* to produce an executable, this does not by itself cause the
	27	* resulting executable to be covered by the GNU General Public License.
	28	* Your use of that executable is in no way restricted on account of
	29	* linking the GUILE library code into it.
	30	*
	31	* This exception does not however invalidate any other reasons why
	32	* the executable file might be covered by the GNU General Public License.
	33	*
	34	* This exception applies only to the code released by the
	35	* Free Software Foundation under the name GUILE. If you copy
	36	* code from other Free Software Foundation releases into a copy of
	37	* GUILE, as the General Public License permits, the exception does
	38	* not apply to the code that you add in this way. To avoid misleading
	39	* anyone as to the status of such modified files, you must delete
	40	* this exception notice from them.
	41	*
	42	* If you write modifications of your own for GUILE, it is your choice
	43	* whether to permit this exception to apply to your modifications.
82892bed	44	* If you do not wish that, delete this exception notice. */
0f2d19dd JB	45	\f
	46	/* {Supported Options}
	47	*
	48	* These may be defined or undefined.
	49	*/
	50
70d63753 GB	51	/* #define GUILE_DEBUG_FREELIST */
70d63753 GB	52
cf7c17e9	53	/* If the compile FLAG `SCM_CAUTIOUS' is #defined then the number of
0f2d19dd	54	* arguments is always checked for application of closures. If the
cf7c17e9	55	* compile FLAG `SCM_RECKLESS' is #defined then they are not checked.
0f2d19dd JB	56	* Otherwise, number of argument checks for closures are made only when
	57	* the function position (whose value is the closure) of a combination is
	58	* not an ILOC or GLOC. When the function position of a combination is a
	59	* symbol it will be checked only the first time it is evaluated because
	60	* it will then be replaced with an ILOC or GLOC.
	61	*/
cf7c17e9 JB	62	#undef SCM_RECKLESS
cf7c17e9 JB	63	#define SCM_CAUTIOUS
0f2d19dd JB	64
	65	/* After looking up a local for the first time, rewrite the
	66	* code graph, caching its position.
	67	*/
	68	#define MEMOIZE_LOCALS
	69
	70	/* All the number support there is.
	71	*/
	72	#define SCM_FLOATS
	73	#define BIGNUMS
	74
	75	/* GC should relinquish empty cons-pair arenas.
	76	*/
	77	#define GC_FREE_SEGMENTS
	78
	79	/* Provide a scheme-accessible count-down timer that
	80	* generates a pseudo-interrupt.
	81	*/
	82	#define TICKS
	83
	84
	85	/* Use engineering notation when converting numbers strings?
	86	*/
	87	#undef ENGNOT
	88
0f2d19dd JB	89	#undef SCM_CAREFUL_INTS
	90	\f
	91	/* {Unsupported Options}
	92	*
3c205827	93	* These must be defined as given here.
0f2d19dd JB	94	*/
	95
	96
	97	#define CCLO
3c205827 JB	98
	99	/* Guile Scheme supports the #f/() distinction; Guile Lisp won't. We
	100	have horrible plans for their unification. */
	101	#undef SICP
0f2d19dd JB	102
	103	\f
	104
80c78696	105	/* Random options (not yet supported or in final form). */
0f2d19dd	106
80c78696 MD	107	#define STACK_CHECKING
80c78696 MD	108	#undef NO_CEVAL_STACK_CHECKING
0f2d19dd	109
43ff3170 GH	110	\f
	111	/* What did the configure script discover about the outside world? */
	112	#include "libguile/scmconfig.h"
	113
	114	#ifdef HAVE_LONG_LONGS
	115
0f2d19dd JB	116	/* Some auto-generated .h files contain unused prototypes
	117	* that need these typedefs.
	118	*/
afe5177e GH	119	typedef long long long_long;
afe5177e GH	120	typedef unsigned long long ulong_long;
0f2d19dd	121
43ff3170	122	#endif /* HAVE_LONG_LONGS */
b971d089 JB	123
b971d089 JB	124	\f
0f2d19dd JB	125
	126	/* Define
	127	*
e2806c10	128	* SCM_CHAR_CODE_LIMIT == UCHAR_MAX + 1
0f2d19dd JB	129	* SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
	130	* SCM_MOST_NEGATIVE_FIXNUM == SCM_SRS((long)LONG_MIN, 2)
	131	*/
	132
b971d089	133	#ifdef HAVE_LIMITS_H
0f2d19dd JB	134	# include <limits.h>
0f2d19dd JB	135	# ifdef UCHAR_MAX
e2806c10	136	# define SCM_CHAR_CODE_LIMIT (UCHAR_MAX+1L)
0f2d19dd	137	# else
e2806c10	138	# define SCM_CHAR_CODE_LIMIT 256L
0f2d19dd JB	139	# endif /* def UCHAR_MAX */
	140	# define SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
	141	# ifdef _UNICOS /* Stupid cray bug */
	142	# define SCM_MOST_NEGATIVE_FIXNUM ((long)LONG_MIN/4)
	143	# else
	144	# define SCM_MOST_NEGATIVE_FIXNUM SCM_SRS((long)LONG_MIN, 2)
	145	# endif /* UNICOS */
	146	#else
e2806c10	147	# define SCM_CHAR_CODE_LIMIT 256L
0f2d19dd JB	148	# define SCM_MOST_POSITIVE_FIXNUM ((long)((unsigned long)~0L>>3))
	149	# if (0 != ~0)
	150	# define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
	151	# else
	152	# define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM)
	153	# endif /* (0 != ~0) */
b971d089	154	#endif /* def HAVE_LIMITS_H */
0f2d19dd JB	155	\f
0f2d19dd JB	156
2a1d8241 JB	157	#ifdef STDC_HEADERS
	158	# include <stdlib.h>
	159	# ifdef AMIGA
	160	# include <stddef.h>
	161	# endif /* def AMIGA */
	162	# define scm_sizet size_t
	163	#else
	164	# ifdef _SIZE_T
	165	# define scm_sizet size_t
	166	# else
	167	# define scm_sizet unsigned int
	168	# endif /* def _SIZE_T */
	169	#endif /* def STDC_HEADERS */
	170
	171	\f
	172
	173	#include "libguile/tags.h"
0f2d19dd JB	174
	175	\f
	176	#ifdef vms
	177	# ifndef CHEAP_CONTINUATIONS
	178	typedef int jmp_buf[17];
	179	extern int setjump(jmp_buf env);
	180	extern int longjump(jmp_buf env, int ret);
	181	# define setjmp setjump
	182	# define longjmp longjump
	183	# else
	184	# include <setjmp.h>
	185	# endif
	186	#else /* ndef vms */
	187	# ifdef _CRAY1
	188	typedef int jmp_buf[112];
	189	extern int setjump(jmp_buf env);
	190	extern int longjump(jmp_buf env, int ret);
	191	# define setjmp setjump
	192	# define longjmp longjump
	193	# else /* ndef _CRAY1 */
	194	# include <setjmp.h>
	195	# endif /* ndef _CRAY1 */
	196	#endif /* ndef vms */
	197
0f2d19dd JB	198	/* James Clark came up with this neat one instruction fix for
	199	* continuations on the SPARC. It flushes the register windows so
	200	* that all the state of the process is contained in the stack.
	201	*/
	202
	203	#ifdef sparc
	204	# define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3")
	205	#else
	206	# define SCM_FLUSH_REGISTER_WINDOWS /* empty */
	207	#endif
	208
	209	/* If stack is not longword aligned then
	210	*/
	211
	212	/* #define SHORT_ALIGN */
	213	#ifdef THINK_C
	214	# define SHORT_ALIGN
	215	#endif
	216	#ifdef MSDOS
	217	# define SHORT_ALIGN
	218	#endif
	219	#ifdef atarist
	220	# define SHORT_ALIGN
	221	#endif
	222
	223	#ifdef SHORT_ALIGN
	224	typedef short SCM_STACKITEM;
	225	#else
	226	typedef long SCM_STACKITEM;
	227	#endif
	228	\f
	229
82339094	230	#ifndef USE_THREADS
25d3ee9d MD	231	#define SCM_THREAD_DEFER
	232	#define SCM_THREAD_ALLOW
	233	#define SCM_THREAD_REDEFER
25d3ee9d	234	#define SCM_THREAD_SWITCHING_CODE
82339094 MD	235	#endif
82339094 MD	236
0f2d19dd	237	extern unsigned int scm_async_clock;
82339094	238
25d3ee9d	239	#define SCM_ASYNC_TICK \
bfc69694	240	do { \
25d3ee9d MD	241	if (0 == --scm_async_clock) \
25d3ee9d MD	242	scm_async_click (); \
bfc69694	243	} while(0)
25d3ee9d	244
0f2d19dd JB	245	#ifdef SCM_CAREFUL_INTS
	246	#define SCM_CHECK_NOT_DISABLED \
	247	if (scm_ints_disabled) \
	248	fputs("ints already disabled\n", stderr); \
	249
	250	#define SCM_CHECK_NOT_ENABLED \
	251	if (!scm_ints_disabled) \
	252	fputs("ints already enabled\n", stderr); \
	253
	254	#else
	255	#define SCM_CHECK_NOT_DISABLED
	256	#define SCM_CHECK_NOT_ENABLED
	257	#endif
	258
	259
8417b665 JB	260	/* Anthony Green writes:
	261	When the compiler sees...
	262	DEFER_INTS;
	263	[critical code here]
	264	ALLOW_INTS;
	265	...it doesn't actually promise to keep the critical code within the
	266	boundries of the DEFER/ALLOW_INTS instructions. It may very well
	267	schedule it outside of the magic defined in those macros.
	268
	269	However, GCC's volatile asm feature forms a barrier over which code is
	270	never moved. So if you add...
35eec738 JB	271	asm ("");
	272	...to each of the DEFER_INTS and ALLOW_INTS macros, the critical
	273	code will always remain in place. asm's without inputs or outputs
	274	are implicitly volatile. */
8417b665	275	#ifdef __GNUC__
35eec738	276	#define SCM_FENCE asm /* volatile */ ("")
8417b665 JB	277	#else
	278	#define SCM_FENCE
	279	#endif
	280
0f2d19dd	281	#define SCM_DEFER_INTS \
bfc69694	282	do { \
8417b665	283	SCM_FENCE; \
0f2d19dd	284	SCM_CHECK_NOT_DISABLED; \
25d3ee9d	285	SCM_THREAD_DEFER; \
8417b665	286	SCM_FENCE; \
0f2d19dd	287	scm_ints_disabled = 1; \
8417b665	288	SCM_FENCE; \
bfc69694	289	} while (0)
0f2d19dd JB	290
	291
	292	#define SCM_ALLOW_INTS_ONLY \
bfc69694	293	do { \
25d3ee9d	294	SCM_THREAD_ALLOW; \
0f2d19dd	295	scm_ints_disabled = 0; \
bfc69694	296	} while (0)
0f2d19dd JB	297
	298
	299	#define SCM_ALLOW_INTS \
bfc69694	300	do { \
8417b665	301	SCM_FENCE; \
0f2d19dd	302	SCM_CHECK_NOT_ENABLED; \
c72cc5fb MD	303	SCM_THREAD_SWITCHING_CODE; \
c72cc5fb MD	304	SCM_FENCE; \
0f2d19dd	305	scm_ints_disabled = 0; \
8417b665 JB	306	SCM_FENCE; \
8417b665 JB	307	SCM_THREAD_ALLOW; \
8417b665	308	SCM_FENCE; \
bfc69694	309	} while (0)
0f2d19dd JB	310
	311
	312	#define SCM_REDEFER_INTS \
bfc69694	313	do { \
c72cc5fb	314	SCM_FENCE; \
25d3ee9d	315	SCM_THREAD_REDEFER; \
0f2d19dd	316	++scm_ints_disabled; \
c72cc5fb	317	SCM_FENCE; \
bfc69694	318	} while (0)
0f2d19dd JB	319
	320
	321	#define SCM_REALLOW_INTS \
bfc69694	322	do { \
c72cc5fb	323	SCM_FENCE; \
c72cc5fb MD	324	SCM_THREAD_SWITCHING_CODE; \
c72cc5fb MD	325	SCM_FENCE; \
0f2d19dd	326	--scm_ints_disabled; \
c72cc5fb	327	SCM_FENCE; \
bfc69694	328	} while (0)
0f2d19dd JB	329
0f2d19dd JB	330
c72cc5fb	331	#define SCM_TICK \
bfc69694	332	do { \
c72cc5fb MD	333	SCM_DEFER_INTS; \
c72cc5fb MD	334	SCM_ALLOW_INTS; \
cd911565	335	SCM_ASYNC_TICK; \
bfc69694	336	} while (0)
0f2d19dd JB	337
	338	\f
	339
f83e2737 MD	340	/* Classification of critical sections
	341	*
	342	* When Guile moves to POSIX threads, it won't be possible to prevent
	343	* context switching. In fact, the whole idea of context switching is
	344	* bogus if threads are run by different processors. Therefore, we
	345	* must ultimately eliminate all critical sections or enforce them by
	346	* use of mutecis.
	347	*
	348	* All instances of SCM_DEFER_INTS and SCM_ALLOW_INTS should therefore
	349	* be classified and replaced by one of the delimiters below. If you
	350	* understand what this is all about, I'd like to encourage you to
	351	* help with this task. The set of classes below must of course be
	352	* incrementally augmented.
	353	*
	354	* MDJ 980419 <djurfeldt@nada.kth.se>
	355	*/
	356
	357	/* A sections
	358	*
	359	* Allocation of a cell with type tag in the CAR.
	360	*
	361	* With POSIX threads, each thread will have a private pool of free
	362	* cells. Therefore, this type of section can be removed. But! It
	363	* is important that the CDR is initialized first (with the CAR still
	364	* indicating a free cell) so that we can guarantee a consistent heap
	365	* at all times.
	366	*/
	367
	368	#ifdef SCM_POSIX_THREADS
	369	#define SCM_ENTER_A_SECTION
	370	#define SCM_EXIT_A_SECTION
	371	#else
	372	#define SCM_ENTER_A_SECTION SCM_DEFER_INTS
	373	#define SCM_EXIT_A_SECTION SCM_ALLOW_INTS
	374	#endif
	375
	376	\f
	377
0f2d19dd JB	378	/** SCM_ASSERT
	379	**
	380	**/
	381
	382
	383	#ifdef SCM_RECKLESS
	384	#define SCM_ASSERT(_cond, _arg, _pos, _subr)
b6791b2e	385	#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr)
0f2d19dd JB	386	#define SCM_ASRTGO(_cond, _label)
	387	#else
	388	#define SCM_ASSERT(_cond, _arg, _pos, _subr) \
	389	if (!(_cond)) \
	390	scm_wta(_arg, (char *)(_pos), _subr)
b6791b2e GB	391	#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) \
	392	if (!(_cond)) \
	393	scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg)
0f2d19dd JB	394	#define SCM_ASRTGO(_cond, _label) \
	395	if (!(_cond)) \
	396	goto _label
	397	#endif
95b88819	398
9de33deb MD	399	/*
	400	* SCM_WTA_DISPATCH
	401	*/
	402
b3c8a0f5 MD	403	extern SCM scm_call_generic_0 (SCM gf);
	404
	405	#define SCM_WTA_DISPATCH_0(gf, arg, pos, subr) \
	406	return ((gf) \
	407	? scm_call_generic_0 ((gf)) \
	408	: scm_wta ((arg), (char *) (pos), (subr)))
	409	#define SCM_GASSERT0(cond, gf, arg, pos, subr) \
ff725a17	410	if (!(cond)) SCM_WTA_DISPATCH_0((gf), (arg), (pos), (subr))
b3c8a0f5	411
9de33deb MD	412	extern SCM scm_call_generic_1 (SCM gf, SCM a1);
	413
	414	#define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \
	415	return ((gf) \
	416	? scm_call_generic_1 ((gf), (a1)) \
	417	: scm_wta ((a1), (char *) (pos), (subr)))
	418	#define SCM_GASSERT1(cond, gf, a1, pos, subr) \
	419	if (!(cond)) SCM_WTA_DISPATCH_1((gf), (a1), (pos), (subr))
	420
	421	extern SCM scm_call_generic_2 (SCM gf, SCM a1, SCM a2);
	422
	423	#define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \
	424	return ((gf) \
	425	? scm_call_generic_2 ((gf), (a1), (a2)) \
	426	: scm_wta ((pos) == SCM_ARG1 ? (a1) : (a2), (char *) (pos), (subr)))
	427	#define SCM_GASSERT2(cond, gf, a1, a2, pos, subr) \
	428	if (!(cond)) SCM_WTA_DISPATCH_2((gf), (a1), (a2), (pos), (subr))
	429
89c358b1 MD	430	extern SCM scm_apply_generic (SCM gf, SCM args);
	431
	432	#define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \
	433	return ((gf) \
	434	? scm_apply_generic ((gf), (args)) \
	435	: scm_wta (scm_list_ref ((args), SCM_MAKINUM ((pos) - 1)), \
	436	(char *) (pos), \
	437	(subr)))
	438	#define SCM_GASSERTn(cond, gf, args, pos, subr) \
	439	if (!(cond)) SCM_WTA_DISPATCH_n((gf), (args), (pos), (subr))
	440
c751e5e3 GB	441	#ifndef SCM_MAGIC_SNARFER
	442	/* Let these macros pass through if
	443	we are snarfing; thus we can tell the
	444	difference between the use of an actual
	445	number vs. the use of one of these macros --
f5421cfc	446	actual numbers in SCM_VALIDATE_* and SCM_ASSERT
c751e5e3 GB	447	constructs must match the formal argument name,
	448	but using SCM_ARG* avoids the test */
	449
0f2d19dd JB	450	#define SCM_ARGn 0
	451	#define SCM_ARG1 1
	452	#define SCM_ARG2 2
	453	#define SCM_ARG3 3
	454	#define SCM_ARG4 4
	455	#define SCM_ARG5 5
1146b6cd GH	456	#define SCM_ARG6 6
1146b6cd GH	457	#define SCM_ARG7 7
f5bf2977	458	/* #define SCM_ARGERR(X) ((X) < SCM_WNA \
0f2d19dd JB	459	? (char *)(X) \
0f2d19dd JB	460	: "wrong type argument")
f5bf2977	461	*/
0f2d19dd JB	462
	463	/* Following must match entry indexes in scm_errmsgs[].
	464	* Also, SCM_WNA must follow the last SCM_ARGn in sequence.
	465	*/
	466	#define SCM_WNA 8
e1724d20	467	/* #define SCM_OVSCM_FLOW 9 */
0f2d19dd JB	468	#define SCM_OUTOFRANGE 10
0f2d19dd JB	469	#define SCM_NALLOC 11
f5bf2977 GH	470	/* #define SCM_STACK_OVFLOW 12 */
f5bf2977 GH	471	/* #define SCM_EXIT 13 */
0f2d19dd	472
c751e5e3	473	#endif /* SCM_MAGIC_SNARFER */
0f2d19dd JB	474
	475	/* (...still matching scm_errmsgs) These
	476	* are signals. Signals may become errors
	477	* but are distinguished because they first
	478	* try to invoke a handler that can resume
	479	* the interrupted routine.
	480	*/
	481	#define SCM_HUP_SIGNAL 14
	482	#define SCM_INT_SIGNAL 15
	483	#define SCM_FPE_SIGNAL 16
	484	#define SCM_BUS_SIGNAL 17
	485	#define SCM_SEGV_SIGNAL 18
	486	#define SCM_ALRM_SIGNAL 19
	487	#define SCM_GC_SIGNAL 20
	488	#define SCM_TICK_SIGNAL 21
	489
	490	#define SCM_SIG_ORD(X) ((X) - SCM_HUP_SIGNAL)
	491	#define SCM_ORD_SIG(X) ((X) + SCM_HUP_SIGNAL)
	492	#define SCM_NUM_SIGS (SCM_SIG_ORD (SCM_TICK_SIGNAL) + 1)
	493
82339094	494	#if 0
0f2d19dd JB	495	struct errdesc
	496	{
	497	char *msg;
	498	char *s_response;
	499	short parent_err;
	500	};
	501
	502
	503	extern struct errdesc scm_errmsgs[];
82339094	504	#endif
0f2d19dd JB	505
	506	\f
	507
	508	/* SCM_EXIT_SUCCESS is the default code to return from SCM if no errors
	509	* were encountered. SCM_EXIT_FAILURE is the default code to return from
	510	* SCM if errors were encountered. The return code can be explicitly
	511	* specified in a SCM program with (scm_quit <n>).
	512	*/
	513
	514	#ifndef SCM_EXIT_SUCCESS
	515	#ifdef vms
	516	#define SCM_EXIT_SUCCESS 1
	517	#else
	518	#define SCM_EXIT_SUCCESS 0
	519	#endif /* def vms */
	520	#endif /* ndef SCM_EXIT_SUCCESS */
	521	#ifndef SCM_EXIT_FAILURE
	522	#ifdef vms
	523	#define SCM_EXIT_FAILURE 2
	524	#else
	525	#define SCM_EXIT_FAILURE 1
	526	#endif /* def vms */
	527	#endif /* ndef SCM_EXIT_FAILURE */
	528
	529
	530
	531	\f
0f2d19dd JB	532
0f2d19dd JB	533	#endif /* __SCMH */