Remove "compiled closures" ("cclos") in favor of a simpler mechanism.
[bpt/guile.git] / libguile / __scm.h
CommitLineData
0f2d19dd
JB
1/* classes: h_files */
2
729dbac3
DH
3#ifndef SCM___SCM_H
4#define SCM___SCM_H
8c494e99 5
e20d7001 6/* Copyright (C) 1995,1996,1998,1999,2000,2001,2002,2003, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
8c494e99 7 *
d3cf93bc
NJ
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
8c494e99 12 *
d3cf93bc 13 * This library is distributed in the hope that it will be useful,
0f2d19dd 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
d3cf93bc
NJ
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
8c494e99 17 *
d3cf93bc
NJ
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
8c494e99 22
0f2d19dd 23\f
176067df 24
92e6989f
RB
25/**********************************************************************
26 This file is Guile's central public header.
27
28 When included by other files, this file should preceed any include
29 other than __scm.h.
30
31 Under *NO* circumstances should new items be added to the global
32 namespace (via adding #define, typedef, or similar to this file) with
33 generic names. This usually means that any new names should be
34 prefixed by either SCM_ or GUILE_. i.e. do *not* #define HAVE_FOO or
35 SIZEOF_BAR. See configure.in, gen-scmconfig.h.in, and
36 gen-scmconfig.c for examples of how to properly handle this issue.
37 The main documentation is in gen-scmconfig.c.
38
39 "What's the difference between _scm.h and __scm.h?"
176067df
JB
40
41 _scm.h is not installed; it's only visible to the libguile sources
92e6989f 42 themselves, and it includes config.h, the private config header.
176067df
JB
43
44 __scm.h is installed, and is #included by <libguile.h>. If both
45 the client and libguile need some piece of information, and it
46 doesn't fit well into the header file for any particular module, it
92e6989f
RB
47 should go in __scm.h. __scm.h includes scmconfig.h, the public
48 config header.
49 **********************************************************************/
50
51/* What did the configure script discover about the outside world? */
52#include "libguile/scmconfig.h"
176067df 53
92e6989f 54\f
176067df 55
e81d98ec
DH
56/* {Compiler hints}
57 *
58 * The following macros are used to provide additional information for the
59 * compiler, which may help to do better error checking and code
60 * optimization. A second benefit of these macros is, that they also provide
61 * additional information to the developers.
62 */
63
64/* The macro SCM_NORETURN indicates that a function will never return.
65 * Examples:
66 * 1) int foo (char arg) SCM_NORETURN;
67 */
68#ifdef __GNUC__
69#define SCM_NORETURN __attribute__ ((noreturn))
70#else
71#define SCM_NORETURN
72#endif
73
74/* The macro SCM_UNUSED indicates that a function, function argument or
75 * variable may potentially be unused.
76 * Examples:
77 * 1) static int unused_function (char arg) SCM_UNUSED;
78 * 2) int foo (char unused_argument SCM_UNUSED);
79 * 3) int unused_variable SCM_UNUSED;
80 */
81#ifdef __GNUC__
82#define SCM_UNUSED __attribute__ ((unused))
83#else
84#define SCM_UNUSED
85#endif
86
87
9cc37597
LC
88/* The SCM_EXPECT macros provide branch prediction hints to the compiler. To
89 * use only in places where the result of the expression under "normal"
90 * circumstances is known. */
91#if defined(__GNUC__) && (__GNUC__ >= 3)
92# define SCM_EXPECT __builtin_expect
93#else
94# define SCM_EXPECT(_expr, _value) (_expr)
95#endif
96
97#define SCM_LIKELY(_expr) SCM_EXPECT ((_expr), 1)
98#define SCM_UNLIKELY(_expr) SCM_EXPECT ((_expr), 0)
99
102dbb6f
LC
100/* The SCM_INTERNAL macro makes it possible to explicitly declare a function
101 * as having "internal" linkage. */
102#if (defined __GNUC__) && \
103 ((__GNUC__ >= 4) || (__GNUC__ == 3 && __GNUC_MINOR__ == 3))
3e28462f 104# define SCM_INTERNAL extern __attribute__ ((__visibility__ ("internal")))
102dbb6f 105#else
3e28462f 106# define SCM_INTERNAL extern
102dbb6f
LC
107#endif
108
9cc37597
LC
109
110\f
0f2d19dd
JB
111/* {Supported Options}
112 *
113 * These may be defined or undefined.
114 */
115
16d35552 116/* #define GUILE_DEBUG_FREELIST */
70d63753 117
0f2d19dd
JB
118/* All the number support there is.
119 */
0f2d19dd
JB
120#define BIGNUMS
121
686765af
ML
122/* GC should relinquish empty cons-pair arenas. */
123/* cmm:FIXME look at this after done mangling the GC */
124/* #define GC_FREE_SEGMENTS */
0f2d19dd
JB
125
126/* Provide a scheme-accessible count-down timer that
127 * generates a pseudo-interrupt.
128 */
129#define TICKS
130
131
132/* Use engineering notation when converting numbers strings?
133 */
134#undef ENGNOT
135
0f2d19dd
JB
136\f
137/* {Unsupported Options}
138 *
3c205827 139 * These must be defined as given here.
0f2d19dd
JB
140 */
141
142
3c205827
JB
143/* Guile Scheme supports the #f/() distinction; Guile Lisp won't. We
144 have horrible plans for their unification. */
145#undef SICP
0f2d19dd
JB
146
147\f
148
80c78696 149/* Random options (not yet supported or in final form). */
0f2d19dd 150
80c78696
MD
151#define STACK_CHECKING
152#undef NO_CEVAL_STACK_CHECKING
0f2d19dd 153
43ff3170 154\f
3a9809df 155
1174045c
MV
156/* SCM_API is a macro prepended to all function and data definitions
157 which should be exported or imported in the resulting dynamic link
8f99e3f3 158 library (DLL) in the Win32 port. */
1174045c 159
8f99e3f3 160#if defined (SCM_IMPORT)
1174045c 161# define SCM_API __declspec (dllimport) extern
8f99e3f3 162#elif defined (SCM_EXPORT) || defined (DLL_EXPORT)
1174045c
MV
163# define SCM_API __declspec (dllexport) extern
164#else
165# define SCM_API extern
166#endif
167
168\f
169
3a9809df
DH
170/* {Debugging Options}
171 *
172 * These compile time options determine whether to include code that is only
173 * useful for debugging guile itself or C level extensions to guile. The
174 * common prefix for all option macros of this kind is "SCM_DEBUG_". It is
fce0b22d
DH
175 * guaranteed that a macro named SCM_DEBUG_XXX is always defined (typically to
176 * either 0 or 1), i. e. there is no need to test for the undefined case.
177 * This allows to use these definitions comfortably within code, as in the
178 * following example:
3a9809df
DH
179 * #define FOO do { if (SCM_DEBUG_XXX) bar(); else baz(); } while (0)
180 * Any sane compiler will remove the unused branch without any performance
181 * penalty for the resulting code.
182 *
183 * Note: Some SCM_DEBUG_XXX options are not settable at configure time.
184 * To change the value of such options you will have to edit this header
56100716
DH
185 * file or give suitable options to make, like:
186 * make all CFLAGS="-DSCM_DEBUG_XXX=1 ..."
3a9809df
DH
187 */
188
189
c8a54c4b
DH
190/* The value of SCM_DEBUG determines the default for most of the not yet
191 * defined debugging options. This allows, for example, to enable most of the
192 * debugging options by simply defining SCM_DEBUG as 1.
193 */
194#ifndef SCM_DEBUG
195#define SCM_DEBUG 0
196#endif
197
7ddb9baf
HWN
198/* For debugging purposes: define this is to ensure nobody is using
199 * the mark bits outside of the marking phase. This is meant for
200 * debugging purposes only.
201 */
202#ifndef SCM_DEBUG_MARKING_API
203#define SCM_DEBUG_MARKING_API 0
204#endif
205
46d53380
DH
206/* If SCM_DEBUG_CELL_ACCESSES is set to 1, cell accesses will perform
207 * exhaustive parameter checking: It will be verified that cell parameters
208 * actually point to a valid heap cell. Note: If this option is enabled,
209 * guile will run about ten times slower than normally.
210 */
211#ifndef SCM_DEBUG_CELL_ACCESSES
212#define SCM_DEBUG_CELL_ACCESSES SCM_DEBUG
213#endif
214
216eedfc
DH
215/* If SCM_DEBUG_INTERRUPTS is set to 1, with every deferring and allowing of
216 * interrupts a consistency check will be performed.
217 */
218#ifndef SCM_DEBUG_INTERRUPTS
219#define SCM_DEBUG_INTERRUPTS SCM_DEBUG
220#endif
221
e81d98ec
DH
222/* If SCM_DEBUG_PAIR_ACCESSES is set to 1, accesses to cons cells will be
223 * exhaustively checked. Note: If this option is enabled, guile will run
224 * slower than normally.
225 */
226#ifndef SCM_DEBUG_PAIR_ACCESSES
227#define SCM_DEBUG_PAIR_ACCESSES SCM_DEBUG
228#endif
229
af45e3b0
DH
230/* If SCM_DEBUG_REST_ARGUMENT is set to 1, functions that take rest arguments
231 * will check whether the rest arguments are actually passed as a proper list.
232 * Otherwise, if SCM_DEBUG_REST_ARGUMENT is 0, functions that take rest
233 * arguments will take it for granted that these are passed as a proper list.
c8a54c4b 234 */
af45e3b0
DH
235#ifndef SCM_DEBUG_REST_ARGUMENT
236#define SCM_DEBUG_REST_ARGUMENT SCM_DEBUG
3a9809df
DH
237#endif
238
fce0b22d
DH
239/* The macro SCM_DEBUG_TYPING_STRICTNESS indicates what level of type checking
240 * shall be performed with respect to the use of the SCM datatype. The macro
241 * may be defined to one of the values 0, 1 and 2.
242 *
243 * A value of 0 means that there will be no compile time type checking, since
244 * the SCM datatype will be declared as an integral type. This setting should
245 * only be used on systems, where casting from integral types to pointers may
246 * lead to loss of bit information.
247 *
248 * A value of 1 means that there will an intermediate level of compile time
249 * type checking, since the SCM datatype will be declared as a pointer to an
250 * undefined struct. This setting is the default, since it does not cost
251 * anything in terms of performance or code size.
252 *
253 * A value of 2 provides a maximum level of compile time type checking since
254 * the SCM datatype will be declared as a struct. This setting should be used
255 * for _compile time_ type checking only, since the compiled result is likely
256 * to be quite inefficient. The right way to make use of this option is to do
257 * a 'make clean; make CFLAGS=-DSCM_DEBUG_TYPING_STRICTNESS=2', fix your
56100716 258 * errors, and then do 'make clean; make'.
c8a54c4b 259 */
56100716 260#ifndef SCM_DEBUG_TYPING_STRICTNESS
729dbac3 261#define SCM_DEBUG_TYPING_STRICTNESS 1
56100716
DH
262#endif
263
d0624e39
DH
264/* If SCM_DEBUG_DEBUGGING_SUPPORT is set to 1, guile will provide a set of
265 * special functions that support debugging with a debugger like gdb or
266 * debugging of guile internals on the scheme level. The behaviour of guile
267 * is not changed by this macro, only the set of functions that are available
268 * will differ. All functions that are introduced this way have the prefix
269 * 'scm_dbg_' on the C level and the prefix 'dbg-' on the scheme level. This
270 * allows to easily determine the set of support functions, given that your
271 * debugger or repl provide automatic name completion. Note that these
272 * functions are intended to be used during interactive debugging sessions
273 * only. They are not considered part of guile's official API. They may
274 * change or disappear without notice or deprecation phase.
94fb5a6e 275 */
d0624e39
DH
276#ifndef SCM_DEBUG_DEBUGGING_SUPPORT
277#define SCM_DEBUG_DEBUGGING_SUPPORT SCM_DEBUG
94fb5a6e
DH
278#endif
279
3a9809df
DH
280\f
281
8c494e99
DH
282/* {Feature Options}
283 *
284 * These compile time options determine whether code for certain features
285 * should be compiled into guile. The common prefix for all option macros
286 * of this kind is "SCM_ENABLE_". It is guaranteed that a macro named
287 * SCM_ENABLE_XXX is defined to be either 0 or 1, i. e. there is no need to
288 * test for the undefined case. This allows to use these definitions
289 * comfortably within code, as in the following example:
290 * #define FOO do { if (SCM_ENABLE_XXX) bar(); else baz(); } while (0)
291 * Any sane compiler will remove the unused branch without any performance
292 * penalty for the resulting code.
293 *
294 * Note: Some SCM_ENABLE_XXX options are not settable at configure time.
295 * To change the value of such options you will have to edit this header
296 * file or give suitable options to make, like:
297 * make all CFLAGS="-DSCM_ENABLE_XXX=1 ..."
0f2d19dd 298 */
1be6b49c 299
8c494e99
DH
300/* If SCM_ENABLE_DEPRECATED is set to 1, deprecated code will be included in
301 * guile, as well as some functions to issue run-time warnings about uses of
302 * deprecated functions.
303 */
304#ifndef SCM_ENABLE_DEPRECATED
305#define SCM_ENABLE_DEPRECATED 0
1be6b49c 306#endif
0f2d19dd 307
b971d089 308\f
0f2d19dd 309
5c75b29f 310/* {Architecture and compiler properties}
0f2d19dd 311 *
5c75b29f
DH
312 * Guile as of today can only work on systems which fulfill at least the
313 * following requirements:
59c4bb82
DH
314 *
315 * - scm_t_bits and SCM variables have at least 32 bits.
5c75b29f 316 * Guile's type system is based on this assumption.
59c4bb82
DH
317 *
318 * - sizeof (scm_t_bits) >= sizeof (void*) and sizeof (SCM) >= sizeof (void*)
319 * Guile's type system is based on this assumption, since it must be
320 * possible to store pointers to cells on the heap in scm_t_bits and SCM
321 * variables.
322 *
323 * - sizeof (scm_t_bits) >= 4 and sizeof (scm_t_bits) is a power of 2.
324 * Guile's type system is based on this assumption. In particular, it is
325 * assumed that cells, i. e. pairs of scm_t_bits variables, are eight
326 * character aligned. This is because three bits of a scm_t_bits variable
327 * that is holding a pointer to a cell on the heap must be available for
328 * storing type data.
329 *
330 * - sizeof (scm_t_bits) <= sizeof (void*) and sizeof (SCM) <= sizeof (void*)
331 * In some parts of guile, scm_t_bits and SCM variables are passed to
332 * functions as void* arguments. Together with the requirement above, this
333 * requires a one-to-one correspondence between the size of a void* and the
334 * sizes of scm_t_bits and SCM variables.
335 *
5c75b29f
DH
336 * - numbers are encoded using two's complement.
337 * The implementation of the bitwise scheme level operations is based on
338 * this assumption.
59c4bb82 339 *
5c75b29f 340 * - ... add more
0f2d19dd
JB
341 */
342
5c75b29f
DH
343#ifdef CHAR_BIT
344# define SCM_CHAR_BIT CHAR_BIT
345#else
346# define SCM_CHAR_BIT 8
347#endif
348
349#ifdef LONG_BIT
350# define SCM_LONG_BIT LONG_BIT
351#else
352# define SCM_LONG_BIT (SCM_CHAR_BIT * sizeof (long) / sizeof (char))
353#endif
354
355#ifdef UCHAR_MAX
356# define SCM_CHAR_CODE_LIMIT (UCHAR_MAX + 1L)
0f2d19dd 357#else
e2806c10 358# define SCM_CHAR_CODE_LIMIT 256L
5c75b29f
DH
359#endif
360
e88d45aa
MV
361#define SCM_I_UTYPE_MAX(type) ((type)-1)
362#define SCM_I_TYPE_MAX(type,umax) ((type)((umax)/2))
363#define SCM_I_TYPE_MIN(type,umax) (-((type)((umax)/2))-1)
364
365#define SCM_T_UINT8_MAX SCM_I_UTYPE_MAX(scm_t_uint8)
366#define SCM_T_INT8_MIN SCM_I_TYPE_MIN(scm_t_int8,SCM_T_UINT8_MAX)
367#define SCM_T_INT8_MAX SCM_I_TYPE_MAX(scm_t_int8,SCM_T_UINT8_MAX)
368
369#define SCM_T_UINT16_MAX SCM_I_UTYPE_MAX(scm_t_uint16)
370#define SCM_T_INT16_MIN SCM_I_TYPE_MIN(scm_t_int16,SCM_T_UINT16_MAX)
371#define SCM_T_INT16_MAX SCM_I_TYPE_MAX(scm_t_int16,SCM_T_UINT16_MAX)
372
373#define SCM_T_UINT32_MAX SCM_I_UTYPE_MAX(scm_t_uint32)
374#define SCM_T_INT32_MIN SCM_I_TYPE_MIN(scm_t_int32,SCM_T_UINT32_MAX)
375#define SCM_T_INT32_MAX SCM_I_TYPE_MAX(scm_t_int32,SCM_T_UINT32_MAX)
376
377#if SCM_HAVE_T_INT64
378#define SCM_T_UINT64_MAX SCM_I_UTYPE_MAX(scm_t_uint64)
379#define SCM_T_INT64_MIN SCM_I_TYPE_MIN(scm_t_int64,SCM_T_UINT64_MAX)
380#define SCM_T_INT64_MAX SCM_I_TYPE_MAX(scm_t_int64,SCM_T_UINT64_MAX)
381#endif
382
383#if SCM_SIZEOF_LONG_LONG
384#define SCM_I_ULLONG_MAX SCM_I_UTYPE_MAX(unsigned long long)
385#define SCM_I_LLONG_MIN SCM_I_TYPE_MIN(long long,SCM_I_ULLONG_MAX)
386#define SCM_I_LLONG_MAX SCM_I_TYPE_MAX(long long,SCM_I_ULLONG_MAX)
387#endif
388
389#define SCM_T_UINTMAX_MAX SCM_I_UTYPE_MAX(scm_t_uintmax)
390#define SCM_T_INTMAX_MIN SCM_I_TYPE_MIN(scm_t_intmax,SCM_T_UINTMAX_MAX)
391#define SCM_T_INTMAX_MAX SCM_I_TYPE_MAX(scm_t_intmax,SCM_T_UINTMAX_MAX)
392
393#define SCM_I_SIZE_MAX SCM_I_UTYPE_MAX(size_t)
394#define SCM_I_SSIZE_MIN SCM_I_TYPE_MIN(ssize_t,SCM_I_SIZE_MAX)
395#define SCM_I_SSIZE_MAX SCM_I_TYPE_MAX(ssize_t,SCM_I_SIZE_MAX)
396
0f2d19dd
JB
397\f
398
2a1d8241 399#include "libguile/tags.h"
0f2d19dd
JB
400
401\f
402#ifdef vms
403# ifndef CHEAP_CONTINUATIONS
404 typedef int jmp_buf[17];
405 extern int setjump(jmp_buf env);
406 extern int longjump(jmp_buf env, int ret);
407# define setjmp setjump
408# define longjmp longjump
409# else
410# include <setjmp.h>
411# endif
412#else /* ndef vms */
413# ifdef _CRAY1
414 typedef int jmp_buf[112];
415 extern int setjump(jmp_buf env);
416 extern int longjump(jmp_buf env, int ret);
417# define setjmp setjump
418# define longjmp longjump
419# else /* ndef _CRAY1 */
346e4402
NJ
420# if defined (__ia64__)
421/* For IA64, emulate the setjmp API using getcontext. */
422# include <signal.h>
423# include <ucontext.h>
424 typedef struct {
425 ucontext_t ctx;
426 int fresh;
427 } jmp_buf;
428# define setjmp(JB) \
429 ( (JB).fresh = 1, \
430 getcontext (&((JB).ctx)), \
431 ((JB).fresh ? ((JB).fresh = 0, 0) : 1) )
432# define longjmp(JB,VAL) scm_ia64_longjmp (&(JB), VAL)
433 void scm_ia64_longjmp (jmp_buf *, int);
434# else /* ndef __ia64__ */
435# include <setjmp.h>
436# endif /* ndef __ia64__ */
0f2d19dd
JB
437# endif /* ndef _CRAY1 */
438#endif /* ndef vms */
439
0f2d19dd
JB
440/* James Clark came up with this neat one instruction fix for
441 * continuations on the SPARC. It flushes the register windows so
3dd84ef1 442 * that all the state of the process is contained in the stack.
0f2d19dd
JB
443 */
444
7c12f0ac 445#if defined (sparc) || defined (__sparc__) || defined (__sparc)
0f2d19dd
JB
446# define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3")
447#else
448# define SCM_FLUSH_REGISTER_WINDOWS /* empty */
449#endif
450
3dd84ef1 451/* If stack is not longword aligned then
0f2d19dd
JB
452 */
453
454/* #define SHORT_ALIGN */
455#ifdef THINK_C
456# define SHORT_ALIGN
457#endif
458#ifdef MSDOS
459# define SHORT_ALIGN
460#endif
461#ifdef atarist
462# define SHORT_ALIGN
463#endif
464
465#ifdef SHORT_ALIGN
466typedef short SCM_STACKITEM;
467#else
468typedef long SCM_STACKITEM;
469#endif
79f55b7c
MD
470
471/* Cast pointer through (void *) in order to avoid compiler warnings
472 when strict aliasing is enabled */
473#define SCM_STACK_PTR(ptr) ((SCM_STACKITEM *) (void *) (ptr))
0f2d19dd
JB
474\f
475
9f0e55a6
MD
476#define SCM_ASYNC_TICK /*fixme* should change names */ \
477do { \
9de87eea 478 if (SCM_I_CURRENT_THREAD->pending_asyncs) \
9f0e55a6
MD
479 scm_async_click (); \
480} while (0)
25d3ee9d 481
0f2d19dd 482
8417b665
JB
483/* Anthony Green writes:
484 When the compiler sees...
485 DEFER_INTS;
486 [critical code here]
487 ALLOW_INTS;
488 ...it doesn't actually promise to keep the critical code within the
489 boundries of the DEFER/ALLOW_INTS instructions. It may very well
490 schedule it outside of the magic defined in those macros.
491
492 However, GCC's volatile asm feature forms a barrier over which code is
493 never moved. So if you add...
35eec738
JB
494 asm ("");
495 ...to each of the DEFER_INTS and ALLOW_INTS macros, the critical
496 code will always remain in place. asm's without inputs or outputs
497 are implicitly volatile. */
8417b665 498#ifdef __GNUC__
35eec738 499#define SCM_FENCE asm /* volatile */ ("")
189b66ba
MV
500#elif defined (__INTEL_COMPILER) && defined (__ia64)
501#define SCM_FENCE __memory_barrier()
8417b665
JB
502#else
503#define SCM_FENCE
504#endif
505
c72cc5fb 506#define SCM_TICK \
bfc69694 507do { \
cd911565 508 SCM_ASYNC_TICK; \
216eedfc 509 SCM_THREAD_SWITCHING_CODE; \
bfc69694 510} while (0)
0f2d19dd
JB
511
512\f
513
514/** SCM_ASSERT
3dd84ef1 515 **
0f2d19dd
JB
516 **/
517
518
519#ifdef SCM_RECKLESS
520#define SCM_ASSERT(_cond, _arg, _pos, _subr)
23deee81 521#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg)
0f2d19dd
JB
522#define SCM_ASRTGO(_cond, _label)
523#else
9cc37597
LC
524#define SCM_ASSERT(_cond, _arg, _pos, _subr) \
525 do { if (SCM_UNLIKELY (!(_cond))) \
aeb4c2e1 526 scm_wrong_type_arg (_subr, _pos, _arg); } while (0)
9cc37597
LC
527#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) \
528 do { if (SCM_UNLIKELY (!(_cond))) \
aeb4c2e1 529 scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg); } while (0)
9cc37597
LC
530#define SCM_ASRTGO(_cond, _label) \
531 do { if (SCM_UNLIKELY (!(_cond))) \
aeb4c2e1 532 goto _label; } while (0)
0f2d19dd 533#endif
95b88819 534
9de33deb
MD
535/*
536 * SCM_WTA_DISPATCH
537 */
538
451e591c
DH
539/* Dirk:FIXME:: In all of the SCM_WTA_DISPATCH_* macros it is assumed that
540 * 'gf' is zero if uninitialized. It would be cleaner if some valid SCM value
541 * like SCM_BOOL_F or SCM_UNDEFINED was chosen.
542 */
543
1174045c 544SCM_API SCM scm_call_generic_0 (SCM gf);
b3c8a0f5 545
e68fc829 546#define SCM_WTA_DISPATCH_0(gf, subr) \
c07b3fef
MD
547 return (SCM_UNPACK (gf) \
548 ? scm_call_generic_0 ((gf)) \
e68fc829 549 : (scm_error_num_args_subr ((subr)), SCM_UNSPECIFIED))
9cc37597
LC
550#define SCM_GASSERT0(cond, gf, subr) \
551 if (SCM_UNLIKELY(!(cond))) \
552 SCM_WTA_DISPATCH_0((gf), (subr))
b3c8a0f5 553
1174045c 554SCM_API SCM scm_call_generic_1 (SCM gf, SCM a1);
9de33deb 555
c07b3fef
MD
556#define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \
557 return (SCM_UNPACK (gf) \
558 ? scm_call_generic_1 ((gf), (a1)) \
559 : (scm_wrong_type_arg ((subr), (pos), (a1)), SCM_UNSPECIFIED))
9cc37597
LC
560#define SCM_GASSERT1(cond, gf, a1, pos, subr) \
561 if (SCM_UNLIKELY (!(cond))) \
562 SCM_WTA_DISPATCH_1((gf), (a1), (pos), (subr))
9de33deb 563
1174045c 564SCM_API SCM scm_call_generic_2 (SCM gf, SCM a1, SCM a2);
9de33deb 565
c07b3fef
MD
566#define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \
567 return (SCM_UNPACK (gf) \
568 ? scm_call_generic_2 ((gf), (a1), (a2)) \
569 : (scm_wrong_type_arg ((subr), (pos), \
570 (pos) == SCM_ARG1 ? (a1) : (a2)), \
571 SCM_UNSPECIFIED))
9cc37597
LC
572#define SCM_GASSERT2(cond, gf, a1, a2, pos, subr) \
573 if (SCM_UNLIKELY (!(cond))) \
574 SCM_WTA_DISPATCH_2((gf), (a1), (a2), (pos), (subr))
9de33deb 575
1174045c 576SCM_API SCM scm_apply_generic (SCM gf, SCM args);
89c358b1 577
c07b3fef
MD
578#define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \
579 return (SCM_UNPACK (gf) \
580 ? scm_apply_generic ((gf), (args)) \
581 : (scm_wrong_type_arg ((subr), (pos), \
582 scm_list_ref ((args), \
93ccaef0 583 scm_from_int ((pos) - 1))), \
c07b3fef 584 SCM_UNSPECIFIED))
9cc37597
LC
585#define SCM_GASSERTn(cond, gf, args, pos, subr) \
586 if (SCM_UNLIKELY (!(cond))) \
587 SCM_WTA_DISPATCH_n((gf), (args), (pos), (subr))
89c358b1 588
c751e5e3
GB
589#ifndef SCM_MAGIC_SNARFER
590/* Let these macros pass through if
591 we are snarfing; thus we can tell the
592 difference between the use of an actual
593 number vs. the use of one of these macros --
f5421cfc 594 actual numbers in SCM_VALIDATE_* and SCM_ASSERT
c751e5e3
GB
595 constructs must match the formal argument name,
596 but using SCM_ARG* avoids the test */
597
0f2d19dd
JB
598#define SCM_ARGn 0
599#define SCM_ARG1 1
600#define SCM_ARG2 2
601#define SCM_ARG3 3
602#define SCM_ARG4 4
603#define SCM_ARG5 5
1146b6cd 604#define SCM_ARG6 6
3dd84ef1 605#define SCM_ARG7 7
0f2d19dd 606
c751e5e3 607#endif /* SCM_MAGIC_SNARFER */
0f2d19dd 608
0f2d19dd
JB
609\f
610
611/* SCM_EXIT_SUCCESS is the default code to return from SCM if no errors
612 * were encountered. SCM_EXIT_FAILURE is the default code to return from
613 * SCM if errors were encountered. The return code can be explicitly
614 * specified in a SCM program with (scm_quit <n>).
615 */
616
617#ifndef SCM_EXIT_SUCCESS
618#ifdef vms
619#define SCM_EXIT_SUCCESS 1
620#else
621#define SCM_EXIT_SUCCESS 0
622#endif /* def vms */
623#endif /* ndef SCM_EXIT_SUCCESS */
624#ifndef SCM_EXIT_FAILURE
625#ifdef vms
626#define SCM_EXIT_FAILURE 2
627#else
628#define SCM_EXIT_FAILURE 1
629#endif /* def vms */
630#endif /* ndef SCM_EXIT_FAILURE */
631
570b6821
MV
632/* Define SCM_C_INLINE_KEYWORD so that it can be used as a replacement
633 for the "inline" keyword, expanding to nothing when "inline" is not
634 available.
635*/
636
637#ifdef SCM_C_INLINE
638#define SCM_C_INLINE_KEYWORD SCM_C_INLINE
639#else
640#define SCM_C_INLINE_KEYWORD
641#endif
642
729dbac3 643#endif /* SCM___SCM_H */
89e00824
ML
644
645/*
646 Local Variables:
647 c-file-style: "gnu"
648 End:
649*/