Commit | Line | Data |
---|---|---|
0f2d19dd JB |
1 | /* classes: h_files */ |
2 | ||
729dbac3 DH |
3 | #ifndef SCM___SCM_H |
4 | #define SCM___SCM_H | |
8c494e99 | 5 | |
b3fcac34 | 6 | /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc. |
8c494e99 | 7 | * |
0f2d19dd JB |
8 | * This program is free software; you can redistribute it and/or modify |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation; either version 2, or (at your option) | |
11 | * any later version. | |
8c494e99 | 12 | * |
0f2d19dd JB |
13 | * This program is distributed in the hope that it will be useful, |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
8c494e99 | 17 | * |
0f2d19dd JB |
18 | * You should have received a copy of the GNU General Public License |
19 | * along with this software; see the file COPYING. If not, write to | |
82892bed JB |
20 | * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, |
21 | * Boston, MA 02111-1307 USA | |
0f2d19dd JB |
22 | * |
23 | * As a special exception, the Free Software Foundation gives permission | |
24 | * for additional uses of the text contained in its release of GUILE. | |
25 | * | |
26 | * The exception is that, if you link the GUILE library with other files | |
27 | * to produce an executable, this does not by itself cause the | |
28 | * resulting executable to be covered by the GNU General Public License. | |
29 | * Your use of that executable is in no way restricted on account of | |
30 | * linking the GUILE library code into it. | |
31 | * | |
32 | * This exception does not however invalidate any other reasons why | |
33 | * the executable file might be covered by the GNU General Public License. | |
34 | * | |
35 | * This exception applies only to the code released by the | |
36 | * Free Software Foundation under the name GUILE. If you copy | |
37 | * code from other Free Software Foundation releases into a copy of | |
38 | * GUILE, as the General Public License permits, the exception does | |
39 | * not apply to the code that you add in this way. To avoid misleading | |
40 | * anyone as to the status of such modified files, you must delete | |
41 | * this exception notice from them. | |
42 | * | |
43 | * If you write modifications of your own for GUILE, it is your choice | |
44 | * whether to permit this exception to apply to your modifications. | |
82892bed | 45 | * If you do not wish that, delete this exception notice. */ |
8c494e99 | 46 | |
0f2d19dd | 47 | \f |
176067df JB |
48 | |
49 | /* "What's the difference between _scm.h and __scm.h?" | |
50 | ||
51 | _scm.h is not installed; it's only visible to the libguile sources | |
52 | themselves. | |
53 | ||
54 | __scm.h is installed, and is #included by <libguile.h>. If both | |
55 | the client and libguile need some piece of information, and it | |
56 | doesn't fit well into the header file for any particular module, it | |
57 | should go in __scm.h. */ | |
58 | ||
59 | ||
e81d98ec DH |
60 | /* {Compiler hints} |
61 | * | |
62 | * The following macros are used to provide additional information for the | |
63 | * compiler, which may help to do better error checking and code | |
64 | * optimization. A second benefit of these macros is, that they also provide | |
65 | * additional information to the developers. | |
66 | */ | |
67 | ||
68 | /* The macro SCM_NORETURN indicates that a function will never return. | |
69 | * Examples: | |
70 | * 1) int foo (char arg) SCM_NORETURN; | |
71 | */ | |
72 | #ifdef __GNUC__ | |
73 | #define SCM_NORETURN __attribute__ ((noreturn)) | |
74 | #else | |
75 | #define SCM_NORETURN | |
76 | #endif | |
77 | ||
78 | /* The macro SCM_UNUSED indicates that a function, function argument or | |
79 | * variable may potentially be unused. | |
80 | * Examples: | |
81 | * 1) static int unused_function (char arg) SCM_UNUSED; | |
82 | * 2) int foo (char unused_argument SCM_UNUSED); | |
83 | * 3) int unused_variable SCM_UNUSED; | |
84 | */ | |
85 | #ifdef __GNUC__ | |
86 | #define SCM_UNUSED __attribute__ ((unused)) | |
87 | #else | |
88 | #define SCM_UNUSED | |
89 | #endif | |
90 | ||
91 | ||
0f2d19dd JB |
92 | /* {Supported Options} |
93 | * | |
94 | * These may be defined or undefined. | |
95 | */ | |
96 | ||
9f0e55a6 MD |
97 | /* Old async mechanism */ |
98 | /* #define GUILE_OLD_ASYNC_CLICK */ | |
99 | ||
16d35552 | 100 | /* #define GUILE_DEBUG_FREELIST */ |
70d63753 | 101 | |
cf7c17e9 | 102 | /* If the compile FLAG `SCM_CAUTIOUS' is #defined then the number of |
0f2d19dd | 103 | * arguments is always checked for application of closures. If the |
cf7c17e9 | 104 | * compile FLAG `SCM_RECKLESS' is #defined then they are not checked. |
904a077d MV |
105 | * Otherwise, number of argument checks for closures are made only |
106 | * when the function position (whose value is the closure) of a | |
107 | * combination is not an ILOC or a variable (true?). When the | |
108 | * function position of a combination is a symbol it will be checked | |
109 | * only the first time it is evaluated because it will then be | |
110 | * replaced with an ILOC or variable. | |
0f2d19dd | 111 | */ |
cf7c17e9 JB |
112 | #undef SCM_RECKLESS |
113 | #define SCM_CAUTIOUS | |
0f2d19dd JB |
114 | |
115 | /* After looking up a local for the first time, rewrite the | |
116 | * code graph, caching its position. | |
117 | */ | |
118 | #define MEMOIZE_LOCALS | |
119 | ||
120 | /* All the number support there is. | |
121 | */ | |
0f2d19dd JB |
122 | #define BIGNUMS |
123 | ||
686765af ML |
124 | /* GC should relinquish empty cons-pair arenas. */ |
125 | /* cmm:FIXME look at this after done mangling the GC */ | |
126 | /* #define GC_FREE_SEGMENTS */ | |
0f2d19dd JB |
127 | |
128 | /* Provide a scheme-accessible count-down timer that | |
129 | * generates a pseudo-interrupt. | |
130 | */ | |
131 | #define TICKS | |
132 | ||
133 | ||
134 | /* Use engineering notation when converting numbers strings? | |
135 | */ | |
136 | #undef ENGNOT | |
137 | ||
0f2d19dd JB |
138 | \f |
139 | /* {Unsupported Options} | |
140 | * | |
3c205827 | 141 | * These must be defined as given here. |
0f2d19dd JB |
142 | */ |
143 | ||
144 | ||
145 | #define CCLO | |
3c205827 JB |
146 | |
147 | /* Guile Scheme supports the #f/() distinction; Guile Lisp won't. We | |
148 | have horrible plans for their unification. */ | |
149 | #undef SICP | |
0f2d19dd JB |
150 | |
151 | \f | |
152 | ||
80c78696 | 153 | /* Random options (not yet supported or in final form). */ |
0f2d19dd | 154 | |
80c78696 MD |
155 | #define STACK_CHECKING |
156 | #undef NO_CEVAL_STACK_CHECKING | |
0f2d19dd | 157 | |
43ff3170 | 158 | \f |
3a9809df | 159 | |
1174045c MV |
160 | /* SCM_API is a macro prepended to all function and data definitions |
161 | which should be exported or imported in the resulting dynamic link | |
8f99e3f3 | 162 | library (DLL) in the Win32 port. */ |
1174045c | 163 | |
8f99e3f3 | 164 | #if defined (SCM_IMPORT) |
1174045c | 165 | # define SCM_API __declspec (dllimport) extern |
8f99e3f3 | 166 | #elif defined (SCM_EXPORT) || defined (DLL_EXPORT) |
1174045c MV |
167 | # define SCM_API __declspec (dllexport) extern |
168 | #else | |
169 | # define SCM_API extern | |
170 | #endif | |
171 | ||
172 | \f | |
173 | ||
43ff3170 GH |
174 | /* What did the configure script discover about the outside world? */ |
175 | #include "libguile/scmconfig.h" | |
176 | ||
3a9809df DH |
177 | \f |
178 | ||
179 | /* {Debugging Options} | |
180 | * | |
181 | * These compile time options determine whether to include code that is only | |
182 | * useful for debugging guile itself or C level extensions to guile. The | |
183 | * common prefix for all option macros of this kind is "SCM_DEBUG_". It is | |
184 | * guaranteed that a macro named SCM_DEBUG_XXX is defined to be either 0 or 1, | |
185 | * i. e. there is no need to test for the undefined case. This allows to use | |
8c494e99 | 186 | * these definitions comfortably within code, as in the following example: |
3a9809df DH |
187 | * #define FOO do { if (SCM_DEBUG_XXX) bar(); else baz(); } while (0) |
188 | * Any sane compiler will remove the unused branch without any performance | |
189 | * penalty for the resulting code. | |
190 | * | |
191 | * Note: Some SCM_DEBUG_XXX options are not settable at configure time. | |
192 | * To change the value of such options you will have to edit this header | |
56100716 DH |
193 | * file or give suitable options to make, like: |
194 | * make all CFLAGS="-DSCM_DEBUG_XXX=1 ..." | |
3a9809df DH |
195 | */ |
196 | ||
197 | ||
c8a54c4b DH |
198 | /* The value of SCM_DEBUG determines the default for most of the not yet |
199 | * defined debugging options. This allows, for example, to enable most of the | |
200 | * debugging options by simply defining SCM_DEBUG as 1. | |
201 | */ | |
202 | #ifndef SCM_DEBUG | |
203 | #define SCM_DEBUG 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 | ||
56100716 DH |
239 | /* Use this for _compile time_ type checking only, since the compiled result |
240 | * will be quite inefficient. The right way to make use of this option is to | |
241 | * do a 'make clean; make CFLAGS=-DSCM_DEBUG_TYPING_STRICTNESS=1', fix your | |
242 | * errors, and then do 'make clean; make'. | |
c8a54c4b | 243 | */ |
56100716 | 244 | #ifndef SCM_DEBUG_TYPING_STRICTNESS |
729dbac3 | 245 | #define SCM_DEBUG_TYPING_STRICTNESS 1 |
56100716 DH |
246 | #endif |
247 | ||
3a9809df DH |
248 | \f |
249 | ||
8c494e99 DH |
250 | /* {Feature Options} |
251 | * | |
252 | * These compile time options determine whether code for certain features | |
253 | * should be compiled into guile. The common prefix for all option macros | |
254 | * of this kind is "SCM_ENABLE_". It is guaranteed that a macro named | |
255 | * SCM_ENABLE_XXX is defined to be either 0 or 1, i. e. there is no need to | |
256 | * test for the undefined case. This allows to use these definitions | |
257 | * comfortably within code, as in the following example: | |
258 | * #define FOO do { if (SCM_ENABLE_XXX) bar(); else baz(); } while (0) | |
259 | * Any sane compiler will remove the unused branch without any performance | |
260 | * penalty for the resulting code. | |
261 | * | |
262 | * Note: Some SCM_ENABLE_XXX options are not settable at configure time. | |
263 | * To change the value of such options you will have to edit this header | |
264 | * file or give suitable options to make, like: | |
265 | * make all CFLAGS="-DSCM_ENABLE_XXX=1 ..." | |
0f2d19dd | 266 | */ |
1be6b49c | 267 | |
8c494e99 DH |
268 | /* If SCM_ENABLE_DEPRECATED is set to 1, deprecated code will be included in |
269 | * guile, as well as some functions to issue run-time warnings about uses of | |
270 | * deprecated functions. | |
271 | */ | |
272 | #ifndef SCM_ENABLE_DEPRECATED | |
273 | #define SCM_ENABLE_DEPRECATED 0 | |
1be6b49c | 274 | #endif |
0f2d19dd | 275 | |
b971d089 | 276 | \f |
0f2d19dd | 277 | |
5c75b29f | 278 | /* {Architecture and compiler properties} |
0f2d19dd | 279 | * |
5c75b29f DH |
280 | * Guile as of today can only work on systems which fulfill at least the |
281 | * following requirements: | |
282 | * - long ints have at least 32 bits. | |
283 | * Guile's type system is based on this assumption. | |
284 | * - long ints consist of at least four characters. | |
285 | * It is assumed that cells, i. e. pairs of long ints, are eight character | |
286 | * aligned, because three bits of a cell pointer are used for type data. | |
287 | * - sizeof (void*) == sizeof (long int) | |
288 | * Pointers are stored in SCM objects, and sometimes SCM objects are passed | |
289 | * as void*. Thus, there has to be a one-to-one correspondence. | |
290 | * - numbers are encoded using two's complement. | |
291 | * The implementation of the bitwise scheme level operations is based on | |
292 | * this assumption. | |
293 | * - ... add more | |
0f2d19dd JB |
294 | */ |
295 | ||
38956d84 MV |
296 | #ifndef HAVE_PTRDIFF_T |
297 | typedef long ptrdiff_t; | |
298 | #endif | |
299 | ||
b971d089 | 300 | #ifdef HAVE_LIMITS_H |
0f2d19dd | 301 | # include <limits.h> |
5c75b29f DH |
302 | #endif |
303 | ||
304 | #ifdef CHAR_BIT | |
305 | # define SCM_CHAR_BIT CHAR_BIT | |
306 | #else | |
307 | # define SCM_CHAR_BIT 8 | |
308 | #endif | |
309 | ||
310 | #ifdef LONG_BIT | |
311 | # define SCM_LONG_BIT LONG_BIT | |
312 | #else | |
313 | # define SCM_LONG_BIT (SCM_CHAR_BIT * sizeof (long) / sizeof (char)) | |
314 | #endif | |
315 | ||
316 | #ifdef UCHAR_MAX | |
317 | # define SCM_CHAR_CODE_LIMIT (UCHAR_MAX + 1L) | |
0f2d19dd | 318 | #else |
e2806c10 | 319 | # define SCM_CHAR_CODE_LIMIT 256L |
5c75b29f DH |
320 | #endif |
321 | ||
0f2d19dd JB |
322 | \f |
323 | ||
2a1d8241 JB |
324 | #ifdef STDC_HEADERS |
325 | # include <stdlib.h> | |
1be6b49c ML |
326 | # if HAVE_SYS_TYPES_H |
327 | # include <sys/types.h> | |
328 | # endif | |
329 | # if HAVE_SYS_STDTYPES_H | |
330 | # include <sys/stdtypes.h> | |
331 | # endif | |
2a1d8241 | 332 | # include <stddef.h> |
2a1d8241 JB |
333 | #endif /* def STDC_HEADERS */ |
334 | ||
335 | \f | |
336 | ||
8f99e3f3 SJ |
337 | /* Define some additional CPP macros on Win32 platforms. */ |
338 | #if USE_DLL_IMPORT | |
339 | # define __REGEX_IMPORT__ 1 | |
340 | # define __CRYPT_IMPORT__ 1 | |
341 | # define __READLINE_IMPORT__ 1 | |
342 | # define QT_IMPORT 1 | |
343 | #endif | |
344 | ||
345 | \f | |
346 | ||
2a1d8241 | 347 | #include "libguile/tags.h" |
0f2d19dd JB |
348 | |
349 | \f | |
350 | #ifdef vms | |
351 | # ifndef CHEAP_CONTINUATIONS | |
352 | typedef int jmp_buf[17]; | |
353 | extern int setjump(jmp_buf env); | |
354 | extern int longjump(jmp_buf env, int ret); | |
355 | # define setjmp setjump | |
356 | # define longjmp longjump | |
357 | # else | |
358 | # include <setjmp.h> | |
359 | # endif | |
360 | #else /* ndef vms */ | |
361 | # ifdef _CRAY1 | |
362 | typedef int jmp_buf[112]; | |
363 | extern int setjump(jmp_buf env); | |
364 | extern int longjump(jmp_buf env, int ret); | |
365 | # define setjmp setjump | |
366 | # define longjmp longjump | |
367 | # else /* ndef _CRAY1 */ | |
368 | # include <setjmp.h> | |
369 | # endif /* ndef _CRAY1 */ | |
370 | #endif /* ndef vms */ | |
371 | ||
0f2d19dd JB |
372 | /* James Clark came up with this neat one instruction fix for |
373 | * continuations on the SPARC. It flushes the register windows so | |
374 | * that all the state of the process is contained in the stack. | |
375 | */ | |
376 | ||
377 | #ifdef sparc | |
378 | # define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3") | |
379 | #else | |
380 | # define SCM_FLUSH_REGISTER_WINDOWS /* empty */ | |
381 | #endif | |
382 | ||
383 | /* If stack is not longword aligned then | |
384 | */ | |
385 | ||
386 | /* #define SHORT_ALIGN */ | |
387 | #ifdef THINK_C | |
388 | # define SHORT_ALIGN | |
389 | #endif | |
390 | #ifdef MSDOS | |
391 | # define SHORT_ALIGN | |
392 | #endif | |
393 | #ifdef atarist | |
394 | # define SHORT_ALIGN | |
395 | #endif | |
396 | ||
397 | #ifdef SHORT_ALIGN | |
398 | typedef short SCM_STACKITEM; | |
399 | #else | |
400 | typedef long SCM_STACKITEM; | |
401 | #endif | |
402 | \f | |
403 | ||
82339094 | 404 | #ifndef USE_THREADS |
216eedfc DH |
405 | #define SCM_CRITICAL_SECTION_START |
406 | #define SCM_CRITICAL_SECTION_END | |
25d3ee9d | 407 | #define SCM_THREAD_SWITCHING_CODE |
82339094 MD |
408 | #endif |
409 | ||
9f0e55a6 | 410 | #ifdef GUILE_OLD_ASYNC_CLICK |
1174045c | 411 | SCM_API unsigned int scm_async_clock; |
82339094 | 412 | |
25d3ee9d | 413 | #define SCM_ASYNC_TICK \ |
bfc69694 | 414 | do { \ |
25d3ee9d MD |
415 | if (0 == --scm_async_clock) \ |
416 | scm_async_click (); \ | |
bfc69694 | 417 | } while(0) |
9f0e55a6 | 418 | #else |
1174045c | 419 | SCM_API int scm_asyncs_pending_p; |
9f0e55a6 MD |
420 | |
421 | #define SCM_ASYNC_TICK /*fixme* should change names */ \ | |
422 | do { \ | |
423 | if (scm_asyncs_pending_p) \ | |
424 | scm_async_click (); \ | |
425 | } while (0) | |
426 | #endif | |
25d3ee9d | 427 | |
216eedfc DH |
428 | #if (SCM_DEBUG_INTERRUPTS == 1) |
429 | #include <stdio.h> | |
0f2d19dd | 430 | #define SCM_CHECK_NOT_DISABLED \ |
216eedfc DH |
431 | do { \ |
432 | if (scm_ints_disabled) \ | |
433 | fprintf(stderr, "ints already disabled (at %s:%d)\n", \ | |
434 | __FILE__, __LINE__); \ | |
435 | } while (0) | |
0f2d19dd JB |
436 | |
437 | #define SCM_CHECK_NOT_ENABLED \ | |
216eedfc DH |
438 | do { \ |
439 | if (!scm_ints_disabled) \ | |
440 | fprintf(stderr, "ints already enabled (at %s:%d)\n", \ | |
441 | __FILE__, __LINE__); \ | |
442 | } while (0) | |
0f2d19dd JB |
443 | |
444 | #else | |
445 | #define SCM_CHECK_NOT_DISABLED | |
446 | #define SCM_CHECK_NOT_ENABLED | |
447 | #endif | |
448 | ||
449 | ||
8417b665 JB |
450 | /* Anthony Green writes: |
451 | When the compiler sees... | |
452 | DEFER_INTS; | |
453 | [critical code here] | |
454 | ALLOW_INTS; | |
455 | ...it doesn't actually promise to keep the critical code within the | |
456 | boundries of the DEFER/ALLOW_INTS instructions. It may very well | |
457 | schedule it outside of the magic defined in those macros. | |
458 | ||
459 | However, GCC's volatile asm feature forms a barrier over which code is | |
460 | never moved. So if you add... | |
35eec738 JB |
461 | asm (""); |
462 | ...to each of the DEFER_INTS and ALLOW_INTS macros, the critical | |
463 | code will always remain in place. asm's without inputs or outputs | |
464 | are implicitly volatile. */ | |
8417b665 | 465 | #ifdef __GNUC__ |
35eec738 | 466 | #define SCM_FENCE asm /* volatile */ ("") |
8417b665 JB |
467 | #else |
468 | #define SCM_FENCE | |
469 | #endif | |
470 | ||
0f2d19dd | 471 | #define SCM_DEFER_INTS \ |
bfc69694 | 472 | do { \ |
8417b665 | 473 | SCM_FENCE; \ |
0f2d19dd | 474 | SCM_CHECK_NOT_DISABLED; \ |
216eedfc | 475 | SCM_CRITICAL_SECTION_START; \ |
8417b665 | 476 | SCM_FENCE; \ |
0f2d19dd | 477 | scm_ints_disabled = 1; \ |
8417b665 | 478 | SCM_FENCE; \ |
bfc69694 | 479 | } while (0) |
0f2d19dd JB |
480 | |
481 | ||
482 | #define SCM_ALLOW_INTS_ONLY \ | |
bfc69694 | 483 | do { \ |
216eedfc | 484 | SCM_CRITICAL_SECTION_END; \ |
0f2d19dd | 485 | scm_ints_disabled = 0; \ |
bfc69694 | 486 | } while (0) |
0f2d19dd JB |
487 | |
488 | ||
489 | #define SCM_ALLOW_INTS \ | |
bfc69694 | 490 | do { \ |
8417b665 | 491 | SCM_FENCE; \ |
0f2d19dd | 492 | SCM_CHECK_NOT_ENABLED; \ |
216eedfc | 493 | SCM_CRITICAL_SECTION_END; \ |
c72cc5fb | 494 | SCM_FENCE; \ |
0f2d19dd | 495 | scm_ints_disabled = 0; \ |
8417b665 | 496 | SCM_FENCE; \ |
216eedfc | 497 | SCM_THREAD_SWITCHING_CODE; \ |
8417b665 | 498 | SCM_FENCE; \ |
bfc69694 | 499 | } while (0) |
0f2d19dd JB |
500 | |
501 | ||
502 | #define SCM_REDEFER_INTS \ | |
bfc69694 | 503 | do { \ |
c72cc5fb | 504 | SCM_FENCE; \ |
216eedfc | 505 | SCM_CRITICAL_SECTION_START; \ |
0f2d19dd | 506 | ++scm_ints_disabled; \ |
c72cc5fb | 507 | SCM_FENCE; \ |
bfc69694 | 508 | } while (0) |
0f2d19dd JB |
509 | |
510 | ||
511 | #define SCM_REALLOW_INTS \ | |
bfc69694 | 512 | do { \ |
c72cc5fb | 513 | SCM_FENCE; \ |
216eedfc | 514 | SCM_CRITICAL_SECTION_END; \ |
c72cc5fb | 515 | SCM_FENCE; \ |
0f2d19dd | 516 | --scm_ints_disabled; \ |
c72cc5fb | 517 | SCM_FENCE; \ |
bfc69694 | 518 | } while (0) |
0f2d19dd JB |
519 | |
520 | ||
c72cc5fb | 521 | #define SCM_TICK \ |
bfc69694 | 522 | do { \ |
cd911565 | 523 | SCM_ASYNC_TICK; \ |
216eedfc | 524 | SCM_THREAD_SWITCHING_CODE; \ |
bfc69694 | 525 | } while (0) |
0f2d19dd JB |
526 | |
527 | \f | |
528 | ||
f83e2737 MD |
529 | /* Classification of critical sections |
530 | * | |
531 | * When Guile moves to POSIX threads, it won't be possible to prevent | |
532 | * context switching. In fact, the whole idea of context switching is | |
533 | * bogus if threads are run by different processors. Therefore, we | |
534 | * must ultimately eliminate all critical sections or enforce them by | |
535 | * use of mutecis. | |
536 | * | |
537 | * All instances of SCM_DEFER_INTS and SCM_ALLOW_INTS should therefore | |
538 | * be classified and replaced by one of the delimiters below. If you | |
539 | * understand what this is all about, I'd like to encourage you to | |
540 | * help with this task. The set of classes below must of course be | |
541 | * incrementally augmented. | |
542 | * | |
543 | * MDJ 980419 <djurfeldt@nada.kth.se> | |
544 | */ | |
545 | ||
546 | /* A sections | |
547 | * | |
548 | * Allocation of a cell with type tag in the CAR. | |
549 | * | |
550 | * With POSIX threads, each thread will have a private pool of free | |
551 | * cells. Therefore, this type of section can be removed. But! It | |
552 | * is important that the CDR is initialized first (with the CAR still | |
553 | * indicating a free cell) so that we can guarantee a consistent heap | |
554 | * at all times. | |
555 | */ | |
556 | ||
216eedfc DH |
557 | #define SCM_ENTER_A_SECTION SCM_CRITICAL_SECTION_START |
558 | #define SCM_EXIT_A_SECTION SCM_CRITICAL_SECTION_END | |
f83e2737 MD |
559 | |
560 | \f | |
561 | ||
0f2d19dd JB |
562 | /** SCM_ASSERT |
563 | ** | |
564 | **/ | |
565 | ||
566 | ||
567 | #ifdef SCM_RECKLESS | |
568 | #define SCM_ASSERT(_cond, _arg, _pos, _subr) | |
23deee81 | 569 | #define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) |
0f2d19dd JB |
570 | #define SCM_ASRTGO(_cond, _label) |
571 | #else | |
572 | #define SCM_ASSERT(_cond, _arg, _pos, _subr) \ | |
573 | if (!(_cond)) \ | |
b3fcac34 | 574 | scm_wrong_type_arg (_subr, _pos, _arg) |
b6791b2e GB |
575 | #define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) \ |
576 | if (!(_cond)) \ | |
577 | scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg) | |
0f2d19dd JB |
578 | #define SCM_ASRTGO(_cond, _label) \ |
579 | if (!(_cond)) \ | |
580 | goto _label | |
581 | #endif | |
95b88819 | 582 | |
9de33deb MD |
583 | /* |
584 | * SCM_WTA_DISPATCH | |
585 | */ | |
586 | ||
451e591c DH |
587 | /* Dirk:FIXME:: In all of the SCM_WTA_DISPATCH_* macros it is assumed that |
588 | * 'gf' is zero if uninitialized. It would be cleaner if some valid SCM value | |
589 | * like SCM_BOOL_F or SCM_UNDEFINED was chosen. | |
590 | */ | |
591 | ||
1174045c | 592 | SCM_API SCM scm_call_generic_0 (SCM gf); |
b3c8a0f5 | 593 | |
e68fc829 | 594 | #define SCM_WTA_DISPATCH_0(gf, subr) \ |
c07b3fef MD |
595 | return (SCM_UNPACK (gf) \ |
596 | ? scm_call_generic_0 ((gf)) \ | |
e68fc829 MV |
597 | : (scm_error_num_args_subr ((subr)), SCM_UNSPECIFIED)) |
598 | #define SCM_GASSERT0(cond, gf, subr) \ | |
599 | if (!(cond)) SCM_WTA_DISPATCH_0((gf), (subr)) | |
b3c8a0f5 | 600 | |
1174045c | 601 | SCM_API SCM scm_call_generic_1 (SCM gf, SCM a1); |
9de33deb | 602 | |
c07b3fef MD |
603 | #define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \ |
604 | return (SCM_UNPACK (gf) \ | |
605 | ? scm_call_generic_1 ((gf), (a1)) \ | |
606 | : (scm_wrong_type_arg ((subr), (pos), (a1)), SCM_UNSPECIFIED)) | |
9de33deb MD |
607 | #define SCM_GASSERT1(cond, gf, a1, pos, subr) \ |
608 | if (!(cond)) SCM_WTA_DISPATCH_1((gf), (a1), (pos), (subr)) | |
609 | ||
1174045c | 610 | SCM_API SCM scm_call_generic_2 (SCM gf, SCM a1, SCM a2); |
9de33deb | 611 | |
c07b3fef MD |
612 | #define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \ |
613 | return (SCM_UNPACK (gf) \ | |
614 | ? scm_call_generic_2 ((gf), (a1), (a2)) \ | |
615 | : (scm_wrong_type_arg ((subr), (pos), \ | |
616 | (pos) == SCM_ARG1 ? (a1) : (a2)), \ | |
617 | SCM_UNSPECIFIED)) | |
9de33deb MD |
618 | #define SCM_GASSERT2(cond, gf, a1, a2, pos, subr) \ |
619 | if (!(cond)) SCM_WTA_DISPATCH_2((gf), (a1), (a2), (pos), (subr)) | |
620 | ||
1174045c | 621 | SCM_API SCM scm_apply_generic (SCM gf, SCM args); |
89c358b1 | 622 | |
c07b3fef MD |
623 | #define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \ |
624 | return (SCM_UNPACK (gf) \ | |
625 | ? scm_apply_generic ((gf), (args)) \ | |
626 | : (scm_wrong_type_arg ((subr), (pos), \ | |
627 | scm_list_ref ((args), \ | |
628 | SCM_MAKINUM ((pos) - 1))), \ | |
629 | SCM_UNSPECIFIED)) | |
89c358b1 MD |
630 | #define SCM_GASSERTn(cond, gf, args, pos, subr) \ |
631 | if (!(cond)) SCM_WTA_DISPATCH_n((gf), (args), (pos), (subr)) | |
632 | ||
c751e5e3 GB |
633 | #ifndef SCM_MAGIC_SNARFER |
634 | /* Let these macros pass through if | |
635 | we are snarfing; thus we can tell the | |
636 | difference between the use of an actual | |
637 | number vs. the use of one of these macros -- | |
f5421cfc | 638 | actual numbers in SCM_VALIDATE_* and SCM_ASSERT |
c751e5e3 GB |
639 | constructs must match the formal argument name, |
640 | but using SCM_ARG* avoids the test */ | |
641 | ||
0f2d19dd JB |
642 | #define SCM_ARGn 0 |
643 | #define SCM_ARG1 1 | |
644 | #define SCM_ARG2 2 | |
645 | #define SCM_ARG3 3 | |
646 | #define SCM_ARG4 4 | |
647 | #define SCM_ARG5 5 | |
1146b6cd GH |
648 | #define SCM_ARG6 6 |
649 | #define SCM_ARG7 7 | |
0f2d19dd | 650 | |
c751e5e3 | 651 | #endif /* SCM_MAGIC_SNARFER */ |
0f2d19dd | 652 | |
0f2d19dd JB |
653 | \f |
654 | ||
655 | /* SCM_EXIT_SUCCESS is the default code to return from SCM if no errors | |
656 | * were encountered. SCM_EXIT_FAILURE is the default code to return from | |
657 | * SCM if errors were encountered. The return code can be explicitly | |
658 | * specified in a SCM program with (scm_quit <n>). | |
659 | */ | |
660 | ||
661 | #ifndef SCM_EXIT_SUCCESS | |
662 | #ifdef vms | |
663 | #define SCM_EXIT_SUCCESS 1 | |
664 | #else | |
665 | #define SCM_EXIT_SUCCESS 0 | |
666 | #endif /* def vms */ | |
667 | #endif /* ndef SCM_EXIT_SUCCESS */ | |
668 | #ifndef SCM_EXIT_FAILURE | |
669 | #ifdef vms | |
670 | #define SCM_EXIT_FAILURE 2 | |
671 | #else | |
672 | #define SCM_EXIT_FAILURE 1 | |
673 | #endif /* def vms */ | |
674 | #endif /* ndef SCM_EXIT_FAILURE */ | |
675 | ||
729dbac3 | 676 | #endif /* SCM___SCM_H */ |
89e00824 ML |
677 | |
678 | /* | |
679 | Local Variables: | |
680 | c-file-style: "gnu" | |
681 | End: | |
682 | */ |