-/* classes: h_files */
-
-#ifndef SCM___SCM_H
-#define SCM___SCM_H
-
-/* Copyright (C) 1995,1996,1998,1999,2000,2001,2002 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
-
-/* "What's the difference between _scm.h and __scm.h?"
-
- _scm.h is not installed; it's only visible to the libguile sources
- themselves.
-
- __scm.h is installed, and is #included by <libguile.h>. If both
- the client and libguile need some piece of information, and it
- doesn't fit well into the header file for any particular module, it
- should go in __scm.h. */
-
-
-/* {Compiler hints}
- *
- * The following macros are used to provide additional information for the
- * compiler, which may help to do better error checking and code
- * optimization. A second benefit of these macros is, that they also provide
- * additional information to the developers.
- */
-
-/* The macro SCM_NORETURN indicates that a function will never return.
- * Examples:
- * 1) int foo (char arg) SCM_NORETURN;
- */
-#ifdef __GNUC__
-#define SCM_NORETURN __attribute__ ((noreturn))
-#else
-#define SCM_NORETURN
-#endif
-
-/* The macro SCM_UNUSED indicates that a function, function argument or
- * variable may potentially be unused.
- * Examples:
- * 1) static int unused_function (char arg) SCM_UNUSED;
- * 2) int foo (char unused_argument SCM_UNUSED);
- * 3) int unused_variable SCM_UNUSED;
- */
-#ifdef __GNUC__
-#define SCM_UNUSED __attribute__ ((unused))
-#else
-#define SCM_UNUSED
-#endif
-
-
-/* {Supported Options}
- *
- * These may be defined or undefined.
- */
-
-/* #define GUILE_DEBUG_FREELIST */
-
-/* All the number support there is.
- */
-#define BIGNUMS
-
-/* GC should relinquish empty cons-pair arenas. */
-/* cmm:FIXME look at this after done mangling the GC */
-/* #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
-
-\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
-
-/* SCM_API is a macro prepended to all function and data definitions
- which should be exported or imported in the resulting dynamic link
- library (DLL) in the Win32 port. */
-
-#if defined (SCM_IMPORT)
-# define SCM_API __declspec (dllimport) extern
-#elif defined (SCM_EXPORT) || defined (DLL_EXPORT)
-# define SCM_API __declspec (dllexport) extern
-#else
-# define SCM_API extern
-#endif
-
-#if defined (SCM_ENABLE_DEPRECATED)
-
-/* These options are always active.
- */
-#define USE_THREADS
-#define GUILE_ISELECT
-
-#endif
-
-\f
-
-/* What did the configure script discover about the outside world? */
-#include "libguile/scmconfig.h"
-
-\f
-
-/* {Debugging Options}
- *
- * These compile time options determine whether to include code that is only
- * useful for debugging guile itself or C level extensions to guile. The
- * common prefix for all option macros of this kind is "SCM_DEBUG_". It is
- * guaranteed that a macro named SCM_DEBUG_XXX is defined to be either 0 or 1,
- * i. e. there is no need to test for the undefined case. This allows to use
- * these definitions comfortably within code, as in the following example:
- * #define FOO do { if (SCM_DEBUG_XXX) bar(); else baz(); } while (0)
- * Any sane compiler will remove the unused branch without any performance
- * penalty for the resulting code.
- *
- * Note: Some SCM_DEBUG_XXX options are not settable at configure time.
- * To change the value of such options you will have to edit this header
- * file or give suitable options to make, like:
- * make all CFLAGS="-DSCM_DEBUG_XXX=1 ..."
- */
-
-
-/* The value of SCM_DEBUG determines the default for most of the not yet
- * defined debugging options. This allows, for example, to enable most of the
- * debugging options by simply defining SCM_DEBUG as 1.
- */
-#ifndef SCM_DEBUG
-#define SCM_DEBUG 0
-#endif
-
-/* If SCM_DEBUG_CELL_ACCESSES is set to 1, cell accesses will perform
- * exhaustive parameter checking: It will be verified that cell parameters
- * actually point to a valid heap cell. Note: If this option is enabled,
- * guile will run about ten times slower than normally.
- */
-#ifndef SCM_DEBUG_CELL_ACCESSES
-#define SCM_DEBUG_CELL_ACCESSES SCM_DEBUG
-#endif
-
-/* If SCM_DEBUG_INTERRUPTS is set to 1, with every deferring and allowing of
- * interrupts a consistency check will be performed.
- */
-#ifndef SCM_DEBUG_INTERRUPTS
-#define SCM_DEBUG_INTERRUPTS SCM_DEBUG
-#endif
-
-/* If SCM_DEBUG_PAIR_ACCESSES is set to 1, accesses to cons cells will be
- * exhaustively checked. Note: If this option is enabled, guile will run
- * slower than normally.
- */
-#ifndef SCM_DEBUG_PAIR_ACCESSES
-#define SCM_DEBUG_PAIR_ACCESSES SCM_DEBUG
-#endif
-
-/* If SCM_DEBUG_REST_ARGUMENT is set to 1, functions that take rest arguments
- * will check whether the rest arguments are actually passed as a proper list.
- * Otherwise, if SCM_DEBUG_REST_ARGUMENT is 0, functions that take rest
- * arguments will take it for granted that these are passed as a proper list.
- */
-#ifndef SCM_DEBUG_REST_ARGUMENT
-#define SCM_DEBUG_REST_ARGUMENT SCM_DEBUG
-#endif
-
-/* Use this for _compile time_ type checking only, since the compiled result
- * will be quite inefficient. The right way to make use of this option is to
- * do a 'make clean; make CFLAGS=-DSCM_DEBUG_TYPING_STRICTNESS=1', fix your
- * errors, and then do 'make clean; make'.
- */
-#ifndef SCM_DEBUG_TYPING_STRICTNESS
-#define SCM_DEBUG_TYPING_STRICTNESS 1
-#endif
-
-\f
-
-/* {Feature Options}
- *
- * These compile time options determine whether code for certain features
- * should be compiled into guile. The common prefix for all option macros
- * of this kind is "SCM_ENABLE_". It is guaranteed that a macro named
- * SCM_ENABLE_XXX is defined to be either 0 or 1, i. e. there is no need to
- * test for the undefined case. This allows to use these definitions
- * comfortably within code, as in the following example:
- * #define FOO do { if (SCM_ENABLE_XXX) bar(); else baz(); } while (0)
- * Any sane compiler will remove the unused branch without any performance
- * penalty for the resulting code.
- *
- * Note: Some SCM_ENABLE_XXX options are not settable at configure time.
- * To change the value of such options you will have to edit this header
- * file or give suitable options to make, like:
- * make all CFLAGS="-DSCM_ENABLE_XXX=1 ..."
- */
-
-/* If SCM_ENABLE_DEPRECATED is set to 1, deprecated code will be included in
- * guile, as well as some functions to issue run-time warnings about uses of
- * deprecated functions.
- */
-#ifndef SCM_ENABLE_DEPRECATED
-#define SCM_ENABLE_DEPRECATED 0
-#endif
-
-\f
-
-/* {Architecture and compiler properties}
- *
- * Guile as of today can only work on systems which fulfill at least the
- * following requirements:
- * - long ints have at least 32 bits.
- * Guile's type system is based on this assumption.
- * - long ints consist of at least four characters.
- * It is assumed that cells, i. e. pairs of long ints, are eight character
- * aligned, because three bits of a cell pointer are used for type data.
- * - sizeof (void*) == sizeof (long int)
- * Pointers are stored in SCM objects, and sometimes SCM objects are passed
- * as void*. Thus, there has to be a one-to-one correspondence.
- * - numbers are encoded using two's complement.
- * The implementation of the bitwise scheme level operations is based on
- * this assumption.
- * - ... add more
- */
-
-#if SIZEOF_UINTPTR_T != 0 && defined(UINTPTR_MAX) \
- && defined(INTPTR_MAX) \
- && defined(INTPTR_MIN)
-/* Used as SCM if available, so we bundle related attributes to avoid possible
- type incon[st][oi]n[ae]nce later. Word in tags.h. */
-#define HAVE_UINTPTR_T 1
-#endif
-
-#if SIZEOF_PTRDIFF_T != 0
-#define HAVE_PTRDIFF_T 1
-#endif
-
-#if SIZEOF_LONG_LONG != 0
-#define HAVE_LONG_LONGS 1
-#define HAVE_LONG_LONG 1
-#endif
-
-#ifndef HAVE_PTRDIFF_T
-typedef long ptrdiff_t;
-#endif
-
-#ifdef HAVE_LIMITS_H
-# include <limits.h>
-#endif
-
-#ifdef CHAR_BIT
-# define SCM_CHAR_BIT CHAR_BIT
-#else
-# define SCM_CHAR_BIT 8
-#endif
-
-#ifdef LONG_BIT
-# define SCM_LONG_BIT LONG_BIT
-#else
-# define SCM_LONG_BIT (SCM_CHAR_BIT * sizeof (long) / sizeof (char))
-#endif
-
-#ifdef UCHAR_MAX
-# define SCM_CHAR_CODE_LIMIT (UCHAR_MAX + 1L)
-#else
-# define SCM_CHAR_CODE_LIMIT 256L
-#endif
-
-\f
-
-#ifdef STDC_HEADERS
-# include <stdlib.h>
-# if HAVE_SYS_TYPES_H
-# include <sys/types.h>
-# endif
-# if HAVE_SYS_STDTYPES_H
-# include <sys/stdtypes.h>
-# endif
-# include <stddef.h>
-#endif /* def STDC_HEADERS */
-
-\f
-
-/* Define some additional CPP macros on Win32 platforms. */
-#if USE_DLL_IMPORT
-# define __REGEX_IMPORT__ 1
-# define __CRYPT_IMPORT__ 1
-# define __READLINE_IMPORT__ 1
-# define QT_IMPORT 1
-#endif
-
-\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
-
-#define SCM_ASYNC_TICK /*fixme* should change names */ \
-do { \
- if (scm_root->pending_asyncs) \
- scm_async_click (); \
-} while (0)
-
-#if (SCM_DEBUG_INTERRUPTS == 1)
-#include <stdio.h>
-#define SCM_CHECK_NOT_DISABLED \
- do { \
- if (scm_ints_disabled) \
- fprintf(stderr, "ints already disabled (at %s:%d)\n", \
- __FILE__, __LINE__); \
- } while (0)
-
-#define SCM_CHECK_NOT_ENABLED \
- do { \
- if (!scm_ints_disabled) \
- fprintf(stderr, "ints already enabled (at %s:%d)\n", \
- __FILE__, __LINE__); \
- } while (0)
-
-#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_CRITICAL_SECTION_START; \
- SCM_FENCE; \
- scm_ints_disabled = 1; \
- SCM_FENCE; \
-} while (0)
-
-
-#define SCM_ALLOW_INTS_ONLY \
-do { \
- SCM_CRITICAL_SECTION_END; \
- scm_ints_disabled = 0; \
-} while (0)
-
-
-#define SCM_ALLOW_INTS \
-do { \
- SCM_FENCE; \
- SCM_CHECK_NOT_ENABLED; \
- SCM_CRITICAL_SECTION_END; \
- SCM_FENCE; \
- scm_ints_disabled = 0; \
- SCM_FENCE; \
- SCM_THREAD_SWITCHING_CODE; \
- SCM_FENCE; \
-} while (0)
-
-
-#define SCM_REDEFER_INTS \
-do { \
- SCM_FENCE; \
- SCM_CRITICAL_SECTION_START; \
- ++scm_ints_disabled; \
- SCM_FENCE; \
-} while (0)
-
-
-#define SCM_REALLOW_INTS \
-do { \
- SCM_FENCE; \
- SCM_CRITICAL_SECTION_END; \
- SCM_FENCE; \
- --scm_ints_disabled; \
- SCM_FENCE; \
-} while (0)
-
-
-#define SCM_TICK \
-do { \
- SCM_ASYNC_TICK; \
- SCM_THREAD_SWITCHING_CODE; \
-} 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.
- */
-
-#define SCM_ENTER_A_SECTION SCM_CRITICAL_SECTION_START
-#define SCM_EXIT_A_SECTION SCM_CRITICAL_SECTION_END
-
-\f
-
-/** SCM_ASSERT
- **
- **/
-
-
-#ifdef SCM_RECKLESS
-#define SCM_ASSERT(_cond, _arg, _pos, _subr)
-#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg)
-#define SCM_ASRTGO(_cond, _label)
-#else
-#define SCM_ASSERT(_cond, _arg, _pos, _subr) \
- if (!(_cond)) \
- scm_wrong_type_arg (_subr, _pos, _arg)
-#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
- */
-
-/* Dirk:FIXME:: In all of the SCM_WTA_DISPATCH_* macros it is assumed that
- * 'gf' is zero if uninitialized. It would be cleaner if some valid SCM value
- * like SCM_BOOL_F or SCM_UNDEFINED was chosen.
- */
-
-SCM_API SCM scm_call_generic_0 (SCM gf);
-
-#define SCM_WTA_DISPATCH_0(gf, subr) \
- return (SCM_UNPACK (gf) \
- ? scm_call_generic_0 ((gf)) \
- : (scm_error_num_args_subr ((subr)), SCM_UNSPECIFIED))
-#define SCM_GASSERT0(cond, gf, subr) \
- if (!(cond)) SCM_WTA_DISPATCH_0((gf), (subr))
-
-SCM_API SCM scm_call_generic_1 (SCM gf, SCM a1);
-
-#define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \
- return (SCM_UNPACK (gf) \
- ? scm_call_generic_1 ((gf), (a1)) \
- : (scm_wrong_type_arg ((subr), (pos), (a1)), SCM_UNSPECIFIED))
-#define SCM_GASSERT1(cond, gf, a1, pos, subr) \
- if (!(cond)) SCM_WTA_DISPATCH_1((gf), (a1), (pos), (subr))
-
-SCM_API SCM scm_call_generic_2 (SCM gf, SCM a1, SCM a2);
-
-#define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \
- return (SCM_UNPACK (gf) \
- ? scm_call_generic_2 ((gf), (a1), (a2)) \
- : (scm_wrong_type_arg ((subr), (pos), \
- (pos) == SCM_ARG1 ? (a1) : (a2)), \
- SCM_UNSPECIFIED))
-#define SCM_GASSERT2(cond, gf, a1, a2, pos, subr) \
- if (!(cond)) SCM_WTA_DISPATCH_2((gf), (a1), (a2), (pos), (subr))
-
-SCM_API SCM scm_apply_generic (SCM gf, SCM args);
-
-#define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \
- return (SCM_UNPACK (gf) \
- ? scm_apply_generic ((gf), (args)) \
- : (scm_wrong_type_arg ((subr), (pos), \
- scm_list_ref ((args), \
- SCM_MAKINUM ((pos) - 1))), \
- SCM_UNSPECIFIED))
-#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
-
-#endif /* SCM_MAGIC_SNARFER */
-
-\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 */
-
-#endif /* SCM___SCM_H */
-
-/*
- Local Variables:
- c-file-style: "gnu"
- End:
-*/
+/* classes: h_files */
+
+#ifndef SCM___SCM_H
+#define SCM___SCM_H
+
+/* Copyright (C) 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2003, 2006,
+ * 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
+
+\f
+
+/**********************************************************************
+ This file is Guile's central public header.
+
+ When included by other files, this file should preceed any include
+ other than __scm.h.
+
+ Under *NO* circumstances should new items be added to the global
+ namespace (via adding #define, typedef, or similar to this file) with
+ generic names. This usually means that any new names should be
+ prefixed by either SCM_ or GUILE_. i.e. do *not* #define HAVE_FOO or
+ SIZEOF_BAR. See configure.in, gen-scmconfig.h.in, and
+ gen-scmconfig.c for examples of how to properly handle this issue.
+ The main documentation is in gen-scmconfig.c.
+
+ "What's the difference between _scm.h and __scm.h?"
+
+ _scm.h is not installed; it's only visible to the libguile sources
+ themselves, and it includes config.h, the private config header.
+
+ __scm.h is installed, and is #included by <libguile.h>. If both
+ the client and libguile need some piece of information, and it
+ doesn't fit well into the header file for any particular module, it
+ should go in __scm.h. __scm.h includes scmconfig.h, the public
+ config header.
+ **********************************************************************/
+
+/* What did the configure script discover about the outside world? */
+#include "libguile/scmconfig.h"
+
+\f
+
+/* {Compiler hints}
+ *
+ * The following macros are used to provide additional information for the
+ * compiler, which may help to do better error checking and code
+ * optimization. A second benefit of these macros is, that they also provide
+ * additional information to the developers.
+ */
+
+/* Return true (non-zero) if GCC version MAJ.MIN or later is being used
+ * (macro taken from glibc.) */
+#if defined __GNUC__ && defined __GNUC_MINOR__
+# define SCM_GNUC_PREREQ(maj, min) \
+ ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
+#else
+# define SCM_GNUC_PREREQ(maj, min) 0
+#endif
+
+/* The macro SCM_NORETURN indicates that a function will never return.
+ * Examples:
+ * 1) int foo (char arg) SCM_NORETURN;
+ */
+#ifdef __GNUC__
+#define SCM_NORETURN __attribute__ ((noreturn))
+#else
+#define SCM_NORETURN
+#endif
+
+/* The macro SCM_UNUSED indicates that a function, function argument or
+ * variable may potentially be unused.
+ * Examples:
+ * 1) static int unused_function (char arg) SCM_UNUSED;
+ * 2) int foo (char unused_argument SCM_UNUSED);
+ * 3) int unused_variable SCM_UNUSED;
+ */
+#ifdef __GNUC__
+#define SCM_UNUSED __attribute__ ((unused))
+#else
+#define SCM_UNUSED
+#endif
+
+
+/* The SCM_EXPECT macros provide branch prediction hints to the compiler. To
+ * use only in places where the result of the expression under "normal"
+ * circumstances is known. */
+#if SCM_GNUC_PREREQ (3, 0)
+# define SCM_EXPECT __builtin_expect
+#else
+# define SCM_EXPECT(_expr, _value) (_expr)
+#endif
+
+#define SCM_LIKELY(_expr) SCM_EXPECT ((_expr), 1)
+#define SCM_UNLIKELY(_expr) SCM_EXPECT ((_expr), 0)
+
+/* The SCM_INTERNAL macro makes it possible to explicitly declare a function
+ * as having "internal" linkage. However our current tack on this problem is
+ * to use GCC 4's -fvisibility=hidden, making functions internal by default,
+ * and then SCM_API marks them for export. */
+#define SCM_INTERNAL extern
+
+/* The SCM_DEPRECATED macro is used in declarations of deprecated functions
+ * or variables. Defining `SCM_BUILDING_DEPRECATED_CODE' allows deprecated
+ * functions to be implemented in terms of deprecated functions, and allows
+ * deprecated functions to be referred to by `scm_c_define_gsubr ()'. */
+#if !defined (SCM_BUILDING_DEPRECATED_CODE) && SCM_GNUC_PREREQ (3, 0)
+# define SCM_DEPRECATED SCM_API __attribute__ ((__deprecated__))
+#else
+# define SCM_DEPRECATED SCM_API
+#endif
+
+/* The SCM_ALIGNED macro, when defined, can be used to instruct the compiler
+ * to honor the given alignment constraint. */
+#if defined __GNUC__
+# define SCM_ALIGNED(x) __attribute__ ((aligned (x)))
+#elif defined __INTEL_COMPILER
+# define SCM_ALIGNED(x) __declspec (align (x))
+#else
+/* Don't know how to align things. */
+# undef SCM_ALIGNED
+#endif
+
+/* The SCM_MALLOC macro can be used in function declarations to tell the
+ * compiler that a function may be treated as if any non-NULL pointer it returns
+ * cannot alias any other pointer valid when the function returns. */
+#if SCM_GNUC_PREREQ (3, 0)
+# define SCM_MALLOC __attribute__ ((__malloc__))
+#else
+# define SCM_MALLOC
+#endif
+
+\f
+
+/* SCM_API is a macro prepended to all function and data definitions
+ which should be exported from libguile. */
+
+#if defined BUILDING_LIBGUILE && defined HAVE_VISIBILITY
+# define SCM_API extern __attribute__((__visibility__("default")))
+#elif defined BUILDING_LIBGUILE && defined _MSC_VER
+# define SCM_API __declspec(dllexport) extern
+#elif defined _MSC_VER
+# define SCM_API __declspec(dllimport) extern
+#else
+# define SCM_API extern
+#endif
+
+\f
+
+/* {Debugging Options}
+ *
+ * These compile time options determine whether to include code that is only
+ * useful for debugging guile itself or C level extensions to guile. The
+ * common prefix for all option macros of this kind is "SCM_DEBUG_". It is
+ * guaranteed that a macro named SCM_DEBUG_XXX is always defined (typically to
+ * either 0 or 1), i. e. there is no need to test for the undefined case.
+ * This allows to use these definitions comfortably within code, as in the
+ * following example:
+ * #define FOO do { if (SCM_DEBUG_XXX) bar(); else baz(); } while (0)
+ * Any sane compiler will remove the unused branch without any performance
+ * penalty for the resulting code.
+ *
+ * Note: Some SCM_DEBUG_XXX options are not settable at configure time.
+ * To change the value of such options you will have to edit this header
+ * file or give suitable options to make, like:
+ * make all CFLAGS="-DSCM_DEBUG_XXX=1 ..."
+ */
+
+
+/* The value of SCM_DEBUG determines the default for most of the not yet
+ * defined debugging options. This allows, for example, to enable most of the
+ * debugging options by simply defining SCM_DEBUG as 1.
+ */
+#ifndef SCM_DEBUG
+#define SCM_DEBUG 0
+#endif
+
+/* If SCM_DEBUG_CELL_ACCESSES is set to 1, cell accesses will perform
+ * exhaustive parameter checking: It will be verified that cell parameters
+ * actually point to a valid heap cell. Note: If this option is enabled,
+ * guile will run about ten times slower than normally.
+ */
+#ifndef SCM_DEBUG_CELL_ACCESSES
+#define SCM_DEBUG_CELL_ACCESSES SCM_DEBUG
+#endif
+
+/* If SCM_DEBUG_PAIR_ACCESSES is set to 1, accesses to cons cells will be
+ * exhaustively checked. Note: If this option is enabled, guile will run
+ * slower than normally.
+ */
+#ifndef SCM_DEBUG_PAIR_ACCESSES
+#define SCM_DEBUG_PAIR_ACCESSES SCM_DEBUG
+#endif
+
+/* If SCM_DEBUG_REST_ARGUMENT is set to 1, functions that take rest arguments
+ * will check whether the rest arguments are actually passed as a proper list.
+ * Otherwise, if SCM_DEBUG_REST_ARGUMENT is 0, functions that take rest
+ * arguments will take it for granted that these are passed as a proper list.
+ */
+#ifndef SCM_DEBUG_REST_ARGUMENT
+#define SCM_DEBUG_REST_ARGUMENT SCM_DEBUG
+#endif
+
+\f
+
+/* {Feature Options}
+ *
+ * These compile time options determine whether code for certain features
+ * should be compiled into guile. The common prefix for all option macros
+ * of this kind is "SCM_ENABLE_". It is guaranteed that a macro named
+ * SCM_ENABLE_XXX is defined to be either 0 or 1, i. e. there is no need to
+ * test for the undefined case. This allows to use these definitions
+ * comfortably within code, as in the following example:
+ * #define FOO do { if (SCM_ENABLE_XXX) bar(); else baz(); } while (0)
+ * Any sane compiler will remove the unused branch without any performance
+ * penalty for the resulting code.
+ *
+ * Note: Some SCM_ENABLE_XXX options are not settable at configure time.
+ * To change the value of such options you will have to edit this header
+ * file or give suitable options to make, like:
+ * make all CFLAGS="-DSCM_ENABLE_XXX=1 ..."
+ */
+
+/* If SCM_ENABLE_DEPRECATED is set to 1, deprecated code will be included in
+ * guile, as well as some functions to issue run-time warnings about uses of
+ * deprecated functions.
+ */
+#ifndef SCM_ENABLE_DEPRECATED
+#define SCM_ENABLE_DEPRECATED 0
+#endif
+
+\f
+
+/* {Architecture and compiler properties}
+ *
+ * Guile as of today can only work on systems which fulfill at least the
+ * following requirements:
+ *
+ * - scm_t_bits and SCM variables have at least 32 bits.
+ * Guile's type system is based on this assumption.
+ *
+ * - sizeof (scm_t_bits) >= sizeof (void*) and sizeof (SCM) >= sizeof (void*)
+ * Guile's type system is based on this assumption, since it must be
+ * possible to store pointers to cells on the heap in scm_t_bits and SCM
+ * variables.
+ *
+ * - sizeof (scm_t_bits) >= 4 and sizeof (scm_t_bits) is a power of 2.
+ * Guile's type system is based on this assumption. In particular, it is
+ * assumed that cells, i. e. pairs of scm_t_bits variables, are eight
+ * character aligned. This is because three bits of a scm_t_bits variable
+ * that is holding a pointer to a cell on the heap must be available for
+ * storing type data.
+ *
+ * - sizeof (scm_t_bits) <= sizeof (void*) and sizeof (SCM) <= sizeof (void*)
+ * In some parts of guile, scm_t_bits and SCM variables are passed to
+ * functions as void* arguments. Together with the requirement above, this
+ * requires a one-to-one correspondence between the size of a void* and the
+ * sizes of scm_t_bits and SCM variables.
+ *
+ * - numbers are encoded using two's complement.
+ * The implementation of the bitwise scheme level operations is based on
+ * this assumption.
+ *
+ * - ... add more
+ */
+
+#ifdef CHAR_BIT
+# define SCM_CHAR_BIT CHAR_BIT
+#else
+# define SCM_CHAR_BIT 8
+#endif
+
+#ifdef LONG_BIT
+# define SCM_LONG_BIT LONG_BIT
+#else
+# define SCM_LONG_BIT (SCM_CHAR_BIT * sizeof (long) / sizeof (char))
+#endif
+
+#define SCM_I_UTYPE_MAX(type) ((type)-1)
+#define SCM_I_TYPE_MAX(type,umax) ((type)((umax)/2))
+#define SCM_I_TYPE_MIN(type,umax) (-((type)((umax)/2))-1)
+
+#define SCM_T_UINT8_MAX SCM_I_UTYPE_MAX(scm_t_uint8)
+#define SCM_T_INT8_MIN SCM_I_TYPE_MIN(scm_t_int8,SCM_T_UINT8_MAX)
+#define SCM_T_INT8_MAX SCM_I_TYPE_MAX(scm_t_int8,SCM_T_UINT8_MAX)
+
+#define SCM_T_UINT16_MAX SCM_I_UTYPE_MAX(scm_t_uint16)
+#define SCM_T_INT16_MIN SCM_I_TYPE_MIN(scm_t_int16,SCM_T_UINT16_MAX)
+#define SCM_T_INT16_MAX SCM_I_TYPE_MAX(scm_t_int16,SCM_T_UINT16_MAX)
+
+#define SCM_T_UINT32_MAX SCM_I_UTYPE_MAX(scm_t_uint32)
+#define SCM_T_INT32_MIN SCM_I_TYPE_MIN(scm_t_int32,SCM_T_UINT32_MAX)
+#define SCM_T_INT32_MAX SCM_I_TYPE_MAX(scm_t_int32,SCM_T_UINT32_MAX)
+
+#define SCM_T_UINT64_MAX SCM_I_UTYPE_MAX(scm_t_uint64)
+#define SCM_T_INT64_MIN SCM_I_TYPE_MIN(scm_t_int64,SCM_T_UINT64_MAX)
+#define SCM_T_INT64_MAX SCM_I_TYPE_MAX(scm_t_int64,SCM_T_UINT64_MAX)
+
+#define SCM_T_UINTMAX_MAX SCM_I_UTYPE_MAX(scm_t_uintmax)
+#define SCM_T_INTMAX_MIN SCM_I_TYPE_MIN(scm_t_intmax,SCM_T_UINTMAX_MAX)
+#define SCM_T_INTMAX_MAX SCM_I_TYPE_MAX(scm_t_intmax,SCM_T_UINTMAX_MAX)
+
+#define SCM_T_UINTPTR_MAX SCM_I_UTYPE_MAX(scm_t_uintptr)
+#define SCM_T_INTPTR_MIN SCM_I_TYPE_MIN(scm_t_intptr,SCM_T_UINTPTR_MAX)
+#define SCM_T_INTPTR_MAX SCM_I_TYPE_MAX(scm_t_intptr,SCM_T_UINTPTR_MAX)
+
+\f
+
+#include "libguile/tags.h"
+
+
+/* The type of subrs, i.e., Scheme procedures implemented in C. Empty
+ function declarators are used internally for pointers to functions of
+ any arity. However, these are equivalent to `(void)' in C++, are
+ obsolescent as of C99, and trigger `strict-prototypes' GCC warnings
+ (bug #23681). */
+
+#ifdef BUILDING_LIBGUILE
+typedef SCM (* scm_t_subr) ();
+#else
+typedef void *scm_t_subr;
+#endif
+
+\f
+
+/* scm_i_jmp_buf
+ *
+ * The corresponding SCM_I_SETJMP and SCM_I_LONGJMP are defined in the
+ * _scm.h private header.
+ */
+
+#if defined (vms)
+typedef int scm_i_jmp_buf[17];
+
+#elif defined (_CRAY1)
+typedef int scm_i_jmp_buf[112];
+
+#elif defined (__ia64__)
+# include <signal.h>
+# include <ucontext.h>
+typedef struct {
+ ucontext_t ctx;
+ int fresh;
+} scm_i_jmp_buf;
+
+#else
+# include <setjmp.h>
+typedef jmp_buf scm_i_jmp_buf;
+#endif
+
+
+\f
+
+/* 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
+
+/* Cast pointer through (void *) in order to avoid compiler warnings
+ when strict aliasing is enabled */
+#define SCM_STACK_PTR(ptr) ((SCM_STACKITEM *) (void *) (ptr))
+\f
+
+#ifdef BUILDING_LIBGUILE
+#define SCM_TICK SCM_ASYNC_TICK
+#else
+#define SCM_TICK scm_async_tick ()
+#endif
+
+\f
+
+#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
+
+#endif /* SCM_MAGIC_SNARFER */
+
+\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 */
+
+/* Define SCM_C_INLINE_KEYWORD so that it can be used as a replacement
+ for the "inline" keyword, expanding to nothing when "inline" is not
+ available.
+*/
+
+#ifdef SCM_C_INLINE
+#define SCM_C_INLINE_KEYWORD SCM_C_INLINE
+#else
+#define SCM_C_INLINE_KEYWORD
+#endif
+
+/* Handling thread-local storage (TLS). */
+
+#ifdef SCM_HAVE_THREAD_STORAGE_CLASS
+# define SCM_THREAD_LOCAL __thread
+#else
+# define SCM_THREAD_LOCAL
+#endif
+
+#endif /* SCM___SCM_H */
+
+/*
+ Local Variables:
+ c-file-style: "gnu"
+ End:
+*/
HCoop / bpt / guile.git / blobdiff