Use Gnulib's `count-one-bits' as a replacement for `scm_i_uint_bit_count ()'.
[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
d3cf93bc 6/* Copyright (C) 1995,1996,1998,1999,2000,2001,2002,2003, 2006, 2007, 2008 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
143#define CCLO
3c205827
JB
144
145/* Guile Scheme supports the #f/() distinction; Guile Lisp won't. We
146 have horrible plans for their unification. */
147#undef SICP
0f2d19dd
JB
148
149\f
150
80c78696 151/* Random options (not yet supported or in final form). */
0f2d19dd 152
80c78696
MD
153#define STACK_CHECKING
154#undef NO_CEVAL_STACK_CHECKING
0f2d19dd 155
43ff3170 156\f
3a9809df 157
1174045c
MV
158/* SCM_API is a macro prepended to all function and data definitions
159 which should be exported or imported in the resulting dynamic link
8f99e3f3 160 library (DLL) in the Win32 port. */
1174045c 161
8f99e3f3 162#if defined (SCM_IMPORT)
1174045c 163# define SCM_API __declspec (dllimport) extern
8f99e3f3 164#elif defined (SCM_EXPORT) || defined (DLL_EXPORT)
1174045c
MV
165# define SCM_API __declspec (dllexport) extern
166#else
167# define SCM_API extern
168#endif
169
170\f
171
3a9809df
DH
172/* {Debugging Options}
173 *
174 * These compile time options determine whether to include code that is only
175 * useful for debugging guile itself or C level extensions to guile. The
176 * common prefix for all option macros of this kind is "SCM_DEBUG_". It is
fce0b22d
DH
177 * guaranteed that a macro named SCM_DEBUG_XXX is always defined (typically to
178 * either 0 or 1), i. e. there is no need to test for the undefined case.
179 * This allows to use these definitions comfortably within code, as in the
180 * following example:
3a9809df
DH
181 * #define FOO do { if (SCM_DEBUG_XXX) bar(); else baz(); } while (0)
182 * Any sane compiler will remove the unused branch without any performance
183 * penalty for the resulting code.
184 *
185 * Note: Some SCM_DEBUG_XXX options are not settable at configure time.
186 * To change the value of such options you will have to edit this header
56100716
DH
187 * file or give suitable options to make, like:
188 * make all CFLAGS="-DSCM_DEBUG_XXX=1 ..."
3a9809df
DH
189 */
190
191
c8a54c4b
DH
192/* The value of SCM_DEBUG determines the default for most of the not yet
193 * defined debugging options. This allows, for example, to enable most of the
194 * debugging options by simply defining SCM_DEBUG as 1.
195 */
196#ifndef SCM_DEBUG
197#define SCM_DEBUG 0
198#endif
199
46d53380
DH
200/* If SCM_DEBUG_CELL_ACCESSES is set to 1, cell accesses will perform
201 * exhaustive parameter checking: It will be verified that cell parameters
202 * actually point to a valid heap cell. Note: If this option is enabled,
203 * guile will run about ten times slower than normally.
204 */
205#ifndef SCM_DEBUG_CELL_ACCESSES
206#define SCM_DEBUG_CELL_ACCESSES SCM_DEBUG
207#endif
208
216eedfc
DH
209/* If SCM_DEBUG_INTERRUPTS is set to 1, with every deferring and allowing of
210 * interrupts a consistency check will be performed.
211 */
212#ifndef SCM_DEBUG_INTERRUPTS
213#define SCM_DEBUG_INTERRUPTS SCM_DEBUG
214#endif
215
e81d98ec
DH
216/* If SCM_DEBUG_PAIR_ACCESSES is set to 1, accesses to cons cells will be
217 * exhaustively checked. Note: If this option is enabled, guile will run
218 * slower than normally.
219 */
220#ifndef SCM_DEBUG_PAIR_ACCESSES
221#define SCM_DEBUG_PAIR_ACCESSES SCM_DEBUG
222#endif
223
af45e3b0
DH
224/* If SCM_DEBUG_REST_ARGUMENT is set to 1, functions that take rest arguments
225 * will check whether the rest arguments are actually passed as a proper list.
226 * Otherwise, if SCM_DEBUG_REST_ARGUMENT is 0, functions that take rest
227 * arguments will take it for granted that these are passed as a proper list.
c8a54c4b 228 */
af45e3b0
DH
229#ifndef SCM_DEBUG_REST_ARGUMENT
230#define SCM_DEBUG_REST_ARGUMENT SCM_DEBUG
3a9809df
DH
231#endif
232
fce0b22d
DH
233/* The macro SCM_DEBUG_TYPING_STRICTNESS indicates what level of type checking
234 * shall be performed with respect to the use of the SCM datatype. The macro
235 * may be defined to one of the values 0, 1 and 2.
236 *
237 * A value of 0 means that there will be no compile time type checking, since
238 * the SCM datatype will be declared as an integral type. This setting should
239 * only be used on systems, where casting from integral types to pointers may
240 * lead to loss of bit information.
241 *
242 * A value of 1 means that there will an intermediate level of compile time
243 * type checking, since the SCM datatype will be declared as a pointer to an
244 * undefined struct. This setting is the default, since it does not cost
245 * anything in terms of performance or code size.
246 *
247 * A value of 2 provides a maximum level of compile time type checking since
248 * the SCM datatype will be declared as a struct. This setting should be used
249 * for _compile time_ type checking only, since the compiled result is likely
250 * to be quite inefficient. The right way to make use of this option is to do
251 * a 'make clean; make CFLAGS=-DSCM_DEBUG_TYPING_STRICTNESS=2', fix your
56100716 252 * errors, and then do 'make clean; make'.
c8a54c4b 253 */
56100716 254#ifndef SCM_DEBUG_TYPING_STRICTNESS
729dbac3 255#define SCM_DEBUG_TYPING_STRICTNESS 1
56100716
DH
256#endif
257
d0624e39
DH
258/* If SCM_DEBUG_DEBUGGING_SUPPORT is set to 1, guile will provide a set of
259 * special functions that support debugging with a debugger like gdb or
260 * debugging of guile internals on the scheme level. The behaviour of guile
261 * is not changed by this macro, only the set of functions that are available
262 * will differ. All functions that are introduced this way have the prefix
263 * 'scm_dbg_' on the C level and the prefix 'dbg-' on the scheme level. This
264 * allows to easily determine the set of support functions, given that your
265 * debugger or repl provide automatic name completion. Note that these
266 * functions are intended to be used during interactive debugging sessions
267 * only. They are not considered part of guile's official API. They may
268 * change or disappear without notice or deprecation phase.
94fb5a6e 269 */
d0624e39
DH
270#ifndef SCM_DEBUG_DEBUGGING_SUPPORT
271#define SCM_DEBUG_DEBUGGING_SUPPORT SCM_DEBUG
94fb5a6e
DH
272#endif
273
3a9809df
DH
274\f
275
8c494e99
DH
276/* {Feature Options}
277 *
278 * These compile time options determine whether code for certain features
279 * should be compiled into guile. The common prefix for all option macros
280 * of this kind is "SCM_ENABLE_". It is guaranteed that a macro named
281 * SCM_ENABLE_XXX is defined to be either 0 or 1, i. e. there is no need to
282 * test for the undefined case. This allows to use these definitions
283 * comfortably within code, as in the following example:
284 * #define FOO do { if (SCM_ENABLE_XXX) bar(); else baz(); } while (0)
285 * Any sane compiler will remove the unused branch without any performance
286 * penalty for the resulting code.
287 *
288 * Note: Some SCM_ENABLE_XXX options are not settable at configure time.
289 * To change the value of such options you will have to edit this header
290 * file or give suitable options to make, like:
291 * make all CFLAGS="-DSCM_ENABLE_XXX=1 ..."
0f2d19dd 292 */
1be6b49c 293
8c494e99
DH
294/* If SCM_ENABLE_DEPRECATED is set to 1, deprecated code will be included in
295 * guile, as well as some functions to issue run-time warnings about uses of
296 * deprecated functions.
297 */
298#ifndef SCM_ENABLE_DEPRECATED
299#define SCM_ENABLE_DEPRECATED 0
1be6b49c 300#endif
0f2d19dd 301
b971d089 302\f
0f2d19dd 303
5c75b29f 304/* {Architecture and compiler properties}
0f2d19dd 305 *
5c75b29f
DH
306 * Guile as of today can only work on systems which fulfill at least the
307 * following requirements:
59c4bb82
DH
308 *
309 * - scm_t_bits and SCM variables have at least 32 bits.
5c75b29f 310 * Guile's type system is based on this assumption.
59c4bb82
DH
311 *
312 * - sizeof (scm_t_bits) >= sizeof (void*) and sizeof (SCM) >= sizeof (void*)
313 * Guile's type system is based on this assumption, since it must be
314 * possible to store pointers to cells on the heap in scm_t_bits and SCM
315 * variables.
316 *
317 * - sizeof (scm_t_bits) >= 4 and sizeof (scm_t_bits) is a power of 2.
318 * Guile's type system is based on this assumption. In particular, it is
319 * assumed that cells, i. e. pairs of scm_t_bits variables, are eight
320 * character aligned. This is because three bits of a scm_t_bits variable
321 * that is holding a pointer to a cell on the heap must be available for
322 * storing type data.
323 *
324 * - sizeof (scm_t_bits) <= sizeof (void*) and sizeof (SCM) <= sizeof (void*)
325 * In some parts of guile, scm_t_bits and SCM variables are passed to
326 * functions as void* arguments. Together with the requirement above, this
327 * requires a one-to-one correspondence between the size of a void* and the
328 * sizes of scm_t_bits and SCM variables.
329 *
5c75b29f
DH
330 * - numbers are encoded using two's complement.
331 * The implementation of the bitwise scheme level operations is based on
332 * this assumption.
59c4bb82 333 *
5c75b29f 334 * - ... add more
0f2d19dd
JB
335 */
336
5c75b29f
DH
337#ifdef CHAR_BIT
338# define SCM_CHAR_BIT CHAR_BIT
339#else
340# define SCM_CHAR_BIT 8
341#endif
342
343#ifdef LONG_BIT
344# define SCM_LONG_BIT LONG_BIT
345#else
346# define SCM_LONG_BIT (SCM_CHAR_BIT * sizeof (long) / sizeof (char))
347#endif
348
349#ifdef UCHAR_MAX
350# define SCM_CHAR_CODE_LIMIT (UCHAR_MAX + 1L)
0f2d19dd 351#else
e2806c10 352# define SCM_CHAR_CODE_LIMIT 256L
5c75b29f
DH
353#endif
354
e88d45aa
MV
355#define SCM_I_UTYPE_MAX(type) ((type)-1)
356#define SCM_I_TYPE_MAX(type,umax) ((type)((umax)/2))
357#define SCM_I_TYPE_MIN(type,umax) (-((type)((umax)/2))-1)
358
359#define SCM_T_UINT8_MAX SCM_I_UTYPE_MAX(scm_t_uint8)
360#define SCM_T_INT8_MIN SCM_I_TYPE_MIN(scm_t_int8,SCM_T_UINT8_MAX)
361#define SCM_T_INT8_MAX SCM_I_TYPE_MAX(scm_t_int8,SCM_T_UINT8_MAX)
362
363#define SCM_T_UINT16_MAX SCM_I_UTYPE_MAX(scm_t_uint16)
364#define SCM_T_INT16_MIN SCM_I_TYPE_MIN(scm_t_int16,SCM_T_UINT16_MAX)
365#define SCM_T_INT16_MAX SCM_I_TYPE_MAX(scm_t_int16,SCM_T_UINT16_MAX)
366
367#define SCM_T_UINT32_MAX SCM_I_UTYPE_MAX(scm_t_uint32)
368#define SCM_T_INT32_MIN SCM_I_TYPE_MIN(scm_t_int32,SCM_T_UINT32_MAX)
369#define SCM_T_INT32_MAX SCM_I_TYPE_MAX(scm_t_int32,SCM_T_UINT32_MAX)
370
371#if SCM_HAVE_T_INT64
372#define SCM_T_UINT64_MAX SCM_I_UTYPE_MAX(scm_t_uint64)
373#define SCM_T_INT64_MIN SCM_I_TYPE_MIN(scm_t_int64,SCM_T_UINT64_MAX)
374#define SCM_T_INT64_MAX SCM_I_TYPE_MAX(scm_t_int64,SCM_T_UINT64_MAX)
375#endif
376
377#if SCM_SIZEOF_LONG_LONG
378#define SCM_I_ULLONG_MAX SCM_I_UTYPE_MAX(unsigned long long)
379#define SCM_I_LLONG_MIN SCM_I_TYPE_MIN(long long,SCM_I_ULLONG_MAX)
380#define SCM_I_LLONG_MAX SCM_I_TYPE_MAX(long long,SCM_I_ULLONG_MAX)
381#endif
382
383#define SCM_T_UINTMAX_MAX SCM_I_UTYPE_MAX(scm_t_uintmax)
384#define SCM_T_INTMAX_MIN SCM_I_TYPE_MIN(scm_t_intmax,SCM_T_UINTMAX_MAX)
385#define SCM_T_INTMAX_MAX SCM_I_TYPE_MAX(scm_t_intmax,SCM_T_UINTMAX_MAX)
386
387#define SCM_I_SIZE_MAX SCM_I_UTYPE_MAX(size_t)
388#define SCM_I_SSIZE_MIN SCM_I_TYPE_MIN(ssize_t,SCM_I_SIZE_MAX)
389#define SCM_I_SSIZE_MAX SCM_I_TYPE_MAX(ssize_t,SCM_I_SIZE_MAX)
390
0f2d19dd
JB
391\f
392
2a1d8241 393#include "libguile/tags.h"
0f2d19dd
JB
394
395\f
396#ifdef vms
397# ifndef CHEAP_CONTINUATIONS
398 typedef int jmp_buf[17];
399 extern int setjump(jmp_buf env);
400 extern int longjump(jmp_buf env, int ret);
401# define setjmp setjump
402# define longjmp longjump
403# else
404# include <setjmp.h>
405# endif
406#else /* ndef vms */
407# ifdef _CRAY1
408 typedef int jmp_buf[112];
409 extern int setjump(jmp_buf env);
410 extern int longjump(jmp_buf env, int ret);
411# define setjmp setjump
412# define longjmp longjump
413# else /* ndef _CRAY1 */
346e4402
NJ
414# if defined (__ia64__)
415/* For IA64, emulate the setjmp API using getcontext. */
416# include <signal.h>
417# include <ucontext.h>
418 typedef struct {
419 ucontext_t ctx;
420 int fresh;
421 } jmp_buf;
422# define setjmp(JB) \
423 ( (JB).fresh = 1, \
424 getcontext (&((JB).ctx)), \
425 ((JB).fresh ? ((JB).fresh = 0, 0) : 1) )
426# define longjmp(JB,VAL) scm_ia64_longjmp (&(JB), VAL)
427 void scm_ia64_longjmp (jmp_buf *, int);
428# else /* ndef __ia64__ */
429# include <setjmp.h>
430# endif /* ndef __ia64__ */
0f2d19dd
JB
431# endif /* ndef _CRAY1 */
432#endif /* ndef vms */
433
0f2d19dd
JB
434/* James Clark came up with this neat one instruction fix for
435 * continuations on the SPARC. It flushes the register windows so
3dd84ef1 436 * that all the state of the process is contained in the stack.
0f2d19dd
JB
437 */
438
7c12f0ac 439#if defined (sparc) || defined (__sparc__) || defined (__sparc)
0f2d19dd
JB
440# define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3")
441#else
442# define SCM_FLUSH_REGISTER_WINDOWS /* empty */
443#endif
444
3dd84ef1 445/* If stack is not longword aligned then
0f2d19dd
JB
446 */
447
448/* #define SHORT_ALIGN */
449#ifdef THINK_C
450# define SHORT_ALIGN
451#endif
452#ifdef MSDOS
453# define SHORT_ALIGN
454#endif
455#ifdef atarist
456# define SHORT_ALIGN
457#endif
458
459#ifdef SHORT_ALIGN
460typedef short SCM_STACKITEM;
461#else
462typedef long SCM_STACKITEM;
463#endif
79f55b7c
MD
464
465/* Cast pointer through (void *) in order to avoid compiler warnings
466 when strict aliasing is enabled */
467#define SCM_STACK_PTR(ptr) ((SCM_STACKITEM *) (void *) (ptr))
0f2d19dd
JB
468\f
469
9f0e55a6
MD
470#define SCM_ASYNC_TICK /*fixme* should change names */ \
471do { \
9de87eea 472 if (SCM_I_CURRENT_THREAD->pending_asyncs) \
9f0e55a6
MD
473 scm_async_click (); \
474} while (0)
25d3ee9d 475
0f2d19dd 476
8417b665
JB
477/* Anthony Green writes:
478 When the compiler sees...
479 DEFER_INTS;
480 [critical code here]
481 ALLOW_INTS;
482 ...it doesn't actually promise to keep the critical code within the
483 boundries of the DEFER/ALLOW_INTS instructions. It may very well
484 schedule it outside of the magic defined in those macros.
485
486 However, GCC's volatile asm feature forms a barrier over which code is
487 never moved. So if you add...
35eec738
JB
488 asm ("");
489 ...to each of the DEFER_INTS and ALLOW_INTS macros, the critical
490 code will always remain in place. asm's without inputs or outputs
491 are implicitly volatile. */
8417b665 492#ifdef __GNUC__
35eec738 493#define SCM_FENCE asm /* volatile */ ("")
189b66ba
MV
494#elif defined (__INTEL_COMPILER) && defined (__ia64)
495#define SCM_FENCE __memory_barrier()
8417b665
JB
496#else
497#define SCM_FENCE
498#endif
499
c72cc5fb 500#define SCM_TICK \
bfc69694 501do { \
cd911565 502 SCM_ASYNC_TICK; \
216eedfc 503 SCM_THREAD_SWITCHING_CODE; \
bfc69694 504} while (0)
0f2d19dd
JB
505
506\f
507
508/** SCM_ASSERT
3dd84ef1 509 **
0f2d19dd
JB
510 **/
511
512
513#ifdef SCM_RECKLESS
514#define SCM_ASSERT(_cond, _arg, _pos, _subr)
23deee81 515#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg)
0f2d19dd
JB
516#define SCM_ASRTGO(_cond, _label)
517#else
9cc37597
LC
518#define SCM_ASSERT(_cond, _arg, _pos, _subr) \
519 do { if (SCM_UNLIKELY (!(_cond))) \
aeb4c2e1 520 scm_wrong_type_arg (_subr, _pos, _arg); } while (0)
9cc37597
LC
521#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) \
522 do { if (SCM_UNLIKELY (!(_cond))) \
aeb4c2e1 523 scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg); } while (0)
9cc37597
LC
524#define SCM_ASRTGO(_cond, _label) \
525 do { if (SCM_UNLIKELY (!(_cond))) \
aeb4c2e1 526 goto _label; } while (0)
0f2d19dd 527#endif
95b88819 528
9de33deb
MD
529/*
530 * SCM_WTA_DISPATCH
531 */
532
451e591c
DH
533/* Dirk:FIXME:: In all of the SCM_WTA_DISPATCH_* macros it is assumed that
534 * 'gf' is zero if uninitialized. It would be cleaner if some valid SCM value
535 * like SCM_BOOL_F or SCM_UNDEFINED was chosen.
536 */
537
1174045c 538SCM_API SCM scm_call_generic_0 (SCM gf);
b3c8a0f5 539
e68fc829 540#define SCM_WTA_DISPATCH_0(gf, subr) \
c07b3fef
MD
541 return (SCM_UNPACK (gf) \
542 ? scm_call_generic_0 ((gf)) \
e68fc829 543 : (scm_error_num_args_subr ((subr)), SCM_UNSPECIFIED))
9cc37597
LC
544#define SCM_GASSERT0(cond, gf, subr) \
545 if (SCM_UNLIKELY(!(cond))) \
546 SCM_WTA_DISPATCH_0((gf), (subr))
b3c8a0f5 547
1174045c 548SCM_API SCM scm_call_generic_1 (SCM gf, SCM a1);
9de33deb 549
c07b3fef
MD
550#define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \
551 return (SCM_UNPACK (gf) \
552 ? scm_call_generic_1 ((gf), (a1)) \
553 : (scm_wrong_type_arg ((subr), (pos), (a1)), SCM_UNSPECIFIED))
9cc37597
LC
554#define SCM_GASSERT1(cond, gf, a1, pos, subr) \
555 if (SCM_UNLIKELY (!(cond))) \
556 SCM_WTA_DISPATCH_1((gf), (a1), (pos), (subr))
9de33deb 557
1174045c 558SCM_API SCM scm_call_generic_2 (SCM gf, SCM a1, SCM a2);
9de33deb 559
c07b3fef
MD
560#define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \
561 return (SCM_UNPACK (gf) \
562 ? scm_call_generic_2 ((gf), (a1), (a2)) \
563 : (scm_wrong_type_arg ((subr), (pos), \
564 (pos) == SCM_ARG1 ? (a1) : (a2)), \
565 SCM_UNSPECIFIED))
9cc37597
LC
566#define SCM_GASSERT2(cond, gf, a1, a2, pos, subr) \
567 if (SCM_UNLIKELY (!(cond))) \
568 SCM_WTA_DISPATCH_2((gf), (a1), (a2), (pos), (subr))
9de33deb 569
1174045c 570SCM_API SCM scm_apply_generic (SCM gf, SCM args);
89c358b1 571
c07b3fef
MD
572#define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \
573 return (SCM_UNPACK (gf) \
574 ? scm_apply_generic ((gf), (args)) \
575 : (scm_wrong_type_arg ((subr), (pos), \
576 scm_list_ref ((args), \
93ccaef0 577 scm_from_int ((pos) - 1))), \
c07b3fef 578 SCM_UNSPECIFIED))
9cc37597
LC
579#define SCM_GASSERTn(cond, gf, args, pos, subr) \
580 if (SCM_UNLIKELY (!(cond))) \
581 SCM_WTA_DISPATCH_n((gf), (args), (pos), (subr))
89c358b1 582
c751e5e3
GB
583#ifndef SCM_MAGIC_SNARFER
584/* Let these macros pass through if
585 we are snarfing; thus we can tell the
586 difference between the use of an actual
587 number vs. the use of one of these macros --
f5421cfc 588 actual numbers in SCM_VALIDATE_* and SCM_ASSERT
c751e5e3
GB
589 constructs must match the formal argument name,
590 but using SCM_ARG* avoids the test */
591
0f2d19dd
JB
592#define SCM_ARGn 0
593#define SCM_ARG1 1
594#define SCM_ARG2 2
595#define SCM_ARG3 3
596#define SCM_ARG4 4
597#define SCM_ARG5 5
1146b6cd 598#define SCM_ARG6 6
3dd84ef1 599#define SCM_ARG7 7
0f2d19dd 600
c751e5e3 601#endif /* SCM_MAGIC_SNARFER */
0f2d19dd 602
0f2d19dd
JB
603\f
604
605/* SCM_EXIT_SUCCESS is the default code to return from SCM if no errors
606 * were encountered. SCM_EXIT_FAILURE is the default code to return from
607 * SCM if errors were encountered. The return code can be explicitly
608 * specified in a SCM program with (scm_quit <n>).
609 */
610
611#ifndef SCM_EXIT_SUCCESS
612#ifdef vms
613#define SCM_EXIT_SUCCESS 1
614#else
615#define SCM_EXIT_SUCCESS 0
616#endif /* def vms */
617#endif /* ndef SCM_EXIT_SUCCESS */
618#ifndef SCM_EXIT_FAILURE
619#ifdef vms
620#define SCM_EXIT_FAILURE 2
621#else
622#define SCM_EXIT_FAILURE 1
623#endif /* def vms */
624#endif /* ndef SCM_EXIT_FAILURE */
625
570b6821
MV
626/* Define SCM_C_INLINE_KEYWORD so that it can be used as a replacement
627 for the "inline" keyword, expanding to nothing when "inline" is not
628 available.
629*/
630
631#ifdef SCM_C_INLINE
632#define SCM_C_INLINE_KEYWORD SCM_C_INLINE
633#else
634#define SCM_C_INLINE_KEYWORD
635#endif
636
729dbac3 637#endif /* SCM___SCM_H */
89e00824
ML
638
639/*
640 Local Variables:
641 c-file-style: "gnu"
642 End:
643*/