libguile/__scm.h

   1 /* classes: h_files */
   2
   3 #ifndef __SCMH
   4 #define __SCMH
   5 /*      Copyright (C) 1995, 1996 Free Software Foundation, Inc.
   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
  19  * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * As a special exception, the Free Software Foundation gives permission
  22  * for additional uses of the text contained in its release of GUILE.
  23  *
  24  * The exception is that, if you link the GUILE library with other files
  25  * to produce an executable, this does not by itself cause the
  26  * resulting executable to be covered by the GNU General Public License.
  27  * Your use of that executable is in no way restricted on account of
  28  * linking the GUILE library code into it.
  29  *
  30  * This exception does not however invalidate any other reasons why
  31  * the executable file might be covered by the GNU General Public License.
  32  *
  33  * This exception applies only to the code released by the
  34  * Free Software Foundation under the name GUILE.  If you copy
  35  * code from other Free Software Foundation releases into a copy of
  36  * GUILE, as the General Public License permits, the exception does
  37  * not apply to the code that you add in this way.  To avoid misleading
  38  * anyone as to the status of such modified files, you must delete
  39  * this exception notice from them.
  40  *
  41  * If you write modifications of your own for GUILE, it is your choice
  42  * whether to permit this exception to apply to your modifications.
  43  * If you do not wish that, delete this exception notice.
  44  */
  45 \f
  46 /* {Supported Options}
  47  *
  48  * These may be defined or undefined.
  49  */
  50
  51 /* If the compile FLAG `CAUTIOUS' is #defined then the number of
  52  * arguments is always checked for application of closures.  If the
  53  * compile FLAG `RECKLESS' is #defined then they are not checked.
  54  * Otherwise, number of argument checks for closures are made only when
  55  * the function position (whose value is the closure) of a combination is
  56  * not an ILOC or GLOC.  When the function position of a combination is a
  57  * symbol it will be checked only the first time it is evaluated because
  58  * it will then be replaced with an ILOC or GLOC.
  59  */
  60 #undef RECKLESS
  61 #define CAUTIOUS
  62
  63 /* After looking up a local for the first time, rewrite the
  64  * code graph, caching its position.
  65  */
  66 #define MEMOIZE_LOCALS
  67
  68 /* All the number support there is.
  69  */
  70 #define SCM_FLOATS
  71 #define BIGNUMS
  72
  73 /* GC should relinquish empty cons-pair arenas.
  74  */
  75 #define GC_FREE_SEGMENTS
  76
  77 /* Provide a scheme-accessible count-down timer that
  78  * generates a pseudo-interrupt.
  79  */
  80 #define TICKS
  81
  82
  83 /* Use engineering notation when converting numbers strings?
  84  */
  85 #undef ENGNOT
  86
  87 /* Include support for uniform arrays?
  88  *
  89  * Possibly some of the initialization code depends on this
  90  * being defined, but that is a bug and should be fixed.
  91  */
  92 #define ARRAYS
  93
  94 #undef SCM_CAREFUL_INTS
  95 \f
  96 /* {Unsupported Options}
  97  *
  98  * These must be defined as given here.
  99  */
 100
 101
 102 #define CCLO
 103
 104 /* Guile Scheme supports the #f/() distinction; Guile Lisp won't.  We
 105    have horrible plans for their unification.  */
 106 #undef SICP
 107
 108 \f
 109
 110 /* Random options (not yet supported or in final form). */
 111
 112 #define STACK_CHECKING
 113 #undef NO_CEVAL_STACK_CHECKING
 114 #undef LONGLONGS
 115
 116 /* Some auto-generated .h files contain unused prototypes
 117  * that need these typedefs.
 118  */
 119 typedef long long_long;
 120 typedef unsigned long ulong_long;
 121
 122
 123 \f
 124 /* What did the configure script discover about the outside world?  */
 125 #include "libguile/scmconfig.h"
 126
 127 \f
 128 /* Write prototype declarations like this:
 129      int foo SCM_P ((int a, int b));
 130    At definitions, use K&R style declarations, but make sure there's a
 131    declarative prototype (as above) in scope.  This will give you
 132    argument type checking, when available, and be harmless otherwise.  */
 133 #ifdef __STDC__
 134 #  define SCM_P(x) x
 135 #else
 136 #  define SCM_P(x) ()
 137 #endif
 138
 139 \f
 140
 141 /* Define
 142  *
 143  * SCM_CHAR_CODE_LIMIT          == UCHAR_MAX + 1
 144  * SCM_MOST_POSITIVE_FIXNUM     (LONG_MAX>>2)
 145  * SCM_MOST_NEGATIVE_FIXNUM     == SCM_SRS((long)LONG_MIN, 2)
 146  */
 147
 148 #ifdef HAVE_LIMITS_H
 149 # include <limits.h>
 150 # ifdef UCHAR_MAX
 151 #  define SCM_CHAR_CODE_LIMIT (UCHAR_MAX+1L)
 152 # else
 153 #  define SCM_CHAR_CODE_LIMIT 256L
 154 # endif /* def UCHAR_MAX */
 155 # define SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
 156 # ifdef _UNICOS                 /* Stupid cray bug */
 157 #  define SCM_MOST_NEGATIVE_FIXNUM ((long)LONG_MIN/4)
 158 # else
 159 #  define SCM_MOST_NEGATIVE_FIXNUM SCM_SRS((long)LONG_MIN, 2)
 160 # endif                         /* UNICOS */
 161 #else
 162 # define SCM_CHAR_CODE_LIMIT 256L
 163 # define SCM_MOST_POSITIVE_FIXNUM ((long)((unsigned long)~0L>>3))
 164 # if (0 != ~0)
 165 #  define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
 166 # else
 167 #  define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM)
 168 # endif /*  (0 != ~0) */
 169 #endif /* def HAVE_LIMITS_H */
 170 \f
 171
 172 #ifdef STDC_HEADERS
 173 # include <stdlib.h>
 174 # ifdef AMIGA
 175 #  include <stddef.h>
 176 # endif /* def AMIGA */
 177 # define scm_sizet size_t
 178 #else
 179 # ifdef _SIZE_T
 180 #  define scm_sizet size_t
 181 # else
 182 #  define scm_sizet unsigned int
 183 # endif /* def _SIZE_T */
 184 #endif /* def STDC_HEADERS */
 185
 186 \f
 187
 188 #include "libguile/tags.h"
 189
 190 \f
 191 #ifdef vms
 192 # ifndef CHEAP_CONTINUATIONS
 193    typedef int jmp_buf[17];
 194    extern int setjump(jmp_buf env);
 195    extern int longjump(jmp_buf env, int ret);
 196 #  define setjmp setjump
 197 #  define longjmp longjump
 198 # else
 199 #  include <setjmp.h>
 200 # endif
 201 #else                           /* ndef vms */
 202 # ifdef _CRAY1
 203     typedef int jmp_buf[112];
 204     extern int setjump(jmp_buf env);
 205     extern int longjump(jmp_buf env, int ret);
 206 #  define setjmp setjump
 207 #  define longjmp longjump
 208 # else                          /* ndef _CRAY1 */
 209 #  include <setjmp.h>
 210 # endif                         /* ndef _CRAY1 */
 211 #endif                          /* ndef vms */
 212
 213 /* James Clark came up with this neat one instruction fix for
 214  * continuations on the SPARC.  It flushes the register windows so
 215  * that all the state of the process is contained in the stack.
 216  */
 217
 218 #ifdef sparc
 219 # define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3")
 220 #else
 221 # define SCM_FLUSH_REGISTER_WINDOWS /* empty */
 222 #endif
 223
 224 /* If stack is not longword aligned then
 225  */
 226
 227 /* #define SHORT_ALIGN */
 228 #ifdef THINK_C
 229 # define SHORT_ALIGN
 230 #endif
 231 #ifdef MSDOS
 232 # define SHORT_ALIGN
 233 #endif
 234 #ifdef atarist
 235 # define SHORT_ALIGN
 236 #endif
 237
 238 #ifdef SHORT_ALIGN
 239 typedef short SCM_STACKITEM;
 240 #else
 241 typedef long SCM_STACKITEM;
 242 #endif
 243 \f
 244
 245 #ifndef USE_THREADS
 246 #define SCM_THREADS_SWITCHING_CODE
 247 #endif
 248
 249 extern unsigned int scm_async_clock;
 250 #define SCM_ASYNC_TICK \
 251 { \
 252   if (0 == --scm_async_clock) \
 253     scm_async_click (); \
 254   SCM_THREADS_SWITCHING_CODE; \
 255 } \
 256
 257
 258 #ifdef SCM_CAREFUL_INTS
 259 #define SCM_CHECK_NOT_DISABLED \
 260   if (scm_ints_disabled) \
 261     fputs("ints already disabled\n", stderr); \
 262
 263 #define SCM_CHECK_NOT_ENABLED \
 264   if (!scm_ints_disabled) \
 265     fputs("ints already enabled\n", stderr); \
 266
 267 #else
 268 #define SCM_CHECK_NOT_DISABLED
 269 #define SCM_CHECK_NOT_ENABLED
 270 #endif
 271
 272
 273 #define SCM_DEFER_INTS \
 274 { \
 275   SCM_CHECK_NOT_DISABLED; \
 276   scm_ints_disabled = 1; \
 277 } \
 278
 279
 280 #define SCM_ALLOW_INTS_ONLY \
 281 { \
 282   scm_ints_disabled = 0; \
 283 } \
 284
 285
 286 #define SCM_ALLOW_INTS \
 287 { \
 288   SCM_CHECK_NOT_ENABLED; \
 289   scm_ints_disabled = 0; \
 290   SCM_ASYNC_TICK; \
 291 } \
 292
 293
 294 #define SCM_REDEFER_INTS  \
 295 { \
 296   ++scm_ints_disabled; \
 297 } \
 298
 299
 300 #define SCM_REALLOW_INTS \
 301 { \
 302   --scm_ints_disabled; \
 303   if (!scm_ints_disabled) \
 304     SCM_ASYNC_TICK; \
 305 } \
 306
 307
 308
 309 \f
 310
 311 /** SCM_ASSERT
 312  **
 313  **/
 314
 315
 316 #ifdef SCM_RECKLESS
 317 #define SCM_ASSERT(_cond, _arg, _pos, _subr)
 318 #define SCM_ASRTGO(_cond, _label)
 319 #else
 320 #define SCM_ASSERT(_cond, _arg, _pos, _subr) \
 321         if (!(_cond)) \
 322           scm_wta(_arg, (char *)(_pos), _subr)
 323 #define SCM_ASRTGO(_cond, _label) \
 324         if (!(_cond)) \
 325           goto _label
 326 #endif
 327
 328 #define SCM_ARGn                0
 329 #define SCM_ARG1                1
 330 #define SCM_ARG2                2
 331 #define SCM_ARG3                3
 332 #define SCM_ARG4                4
 333 #define SCM_ARG5                5
 334      /* #define SCM_ARG6                6
 335         #define SCM_ARG7                7 */
 336      /* #define SCM_ARGERR(X)           ((X) < SCM_WNA \
 337                                  ? (char *)(X) \
 338                                  : "wrong type argument")
 339                                  */
 340
 341 /* Following must match entry indexes in scm_errmsgs[].
 342  * Also, SCM_WNA must follow the last SCM_ARGn in sequence.
 343  */
 344 #define SCM_WNA                 8
 345      /* #define SCM_OVSCM_FLOW          9 */
 346 #define SCM_OUTOFRANGE          10
 347 #define SCM_NALLOC              11
 348      /* #define SCM_STACK_OVFLOW        12 */
 349      /* #define SCM_EXIT                13 */
 350
 351
 352 /* (...still matching scm_errmsgs)  These
 353  * are signals.  Signals may become errors
 354  * but are distinguished because they first
 355  * try to invoke a handler that can resume
 356  * the interrupted routine.
 357  */
 358 #define SCM_HUP_SIGNAL          14
 359 #define SCM_INT_SIGNAL          15
 360 #define SCM_FPE_SIGNAL          16
 361 #define SCM_BUS_SIGNAL          17
 362 #define SCM_SEGV_SIGNAL         18
 363 #define SCM_ALRM_SIGNAL         19
 364 #define SCM_GC_SIGNAL           20
 365 #define SCM_TICK_SIGNAL         21
 366
 367 #define SCM_SIG_ORD(X)          ((X) - SCM_HUP_SIGNAL)
 368 #define SCM_ORD_SIG(X)          ((X) + SCM_HUP_SIGNAL)
 369 #define SCM_NUM_SIGS            (SCM_SIG_ORD (SCM_TICK_SIGNAL) + 1)
 370
 371 #if 0
 372 struct errdesc
 373 {
 374   char *msg;
 375   char *s_response;
 376   short parent_err;
 377 };
 378
 379
 380 extern struct errdesc scm_errmsgs[];
 381 #endif
 382
 383 \f
 384
 385 /* SCM_EXIT_SUCCESS is the default code to return from SCM if no errors
 386  * were encountered.  SCM_EXIT_FAILURE is the default code to return from
 387  * SCM if errors were encountered.  The return code can be explicitly
 388  * specified in a SCM program with (scm_quit <n>).
 389  */
 390
 391 #ifndef SCM_EXIT_SUCCESS
 392 #ifdef vms
 393 #define SCM_EXIT_SUCCESS 1
 394 #else
 395 #define SCM_EXIT_SUCCESS 0
 396 #endif /* def vms */
 397 #endif /* ndef SCM_EXIT_SUCCESS */
 398 #ifndef SCM_EXIT_FAILURE
 399 #ifdef vms
 400 #define SCM_EXIT_FAILURE 2
 401 #else
 402 #define SCM_EXIT_FAILURE 1
 403 #endif /* def vms */
 404 #endif /* ndef SCM_EXIT_FAILURE */
 405
 406
 407
 408 \f
 409
 410 #endif  /* __SCMH */