Fix continuation problems on IA64.
[bpt/guile.git] / libguile / throw.c
1 /* Copyright (C) 1995,1996,1997,1998,2000,2001, 2003, 2004, 2006, 2008 Free Software Foundation, Inc.
2 *
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
12 *
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16 */
17
18
19 \f
20
21 #include <stdio.h>
22 #include "libguile/_scm.h"
23 #include "libguile/async.h"
24 #include "libguile/smob.h"
25 #include "libguile/alist.h"
26 #include "libguile/eval.h"
27 #include "libguile/eq.h"
28 #include "libguile/dynwind.h"
29 #include "libguile/backtrace.h"
30 #include "libguile/debug.h"
31 #include "libguile/continuations.h"
32 #include "libguile/stackchk.h"
33 #include "libguile/stacks.h"
34 #include "libguile/fluids.h"
35 #include "libguile/ports.h"
36 #include "libguile/lang.h"
37 #include "libguile/validate.h"
38 #include "libguile/throw.h"
39 #include "libguile/init.h"
40 #include "libguile/strings.h"
41
42 #include "libguile/private-options.h"
43
44
45 \f
46 /* the jump buffer data structure */
47 static scm_t_bits tc16_jmpbuffer;
48
49 #define SCM_JMPBUFP(OBJ) SCM_TYP16_PREDICATE (tc16_jmpbuffer, OBJ)
50
51 #define JBACTIVE(OBJ) (SCM_CELL_WORD_0 (OBJ) & (1L << 16L))
52 #define ACTIVATEJB(x) \
53 (SCM_SET_CELL_WORD_0 ((x), (SCM_CELL_WORD_0 (x) | (1L << 16L))))
54 #define DEACTIVATEJB(x) \
55 (SCM_SET_CELL_WORD_0 ((x), (SCM_CELL_WORD_0 (x) & ~(1L << 16L))))
56
57 #define JBJMPBUF(OBJ) ((jmp_buf *) SCM_CELL_WORD_1 (OBJ))
58 #define SETJBJMPBUF(x, v) (SCM_SET_CELL_WORD_1 ((x), (scm_t_bits) (v)))
59 #define SCM_JBDFRAME(x) ((scm_t_debug_frame *) SCM_CELL_WORD_2 (x))
60 #define SCM_SETJBDFRAME(x, v) (SCM_SET_CELL_WORD_2 ((x), (scm_t_bits) (v)))
61 #define SCM_JBPREUNWIND(x) ((struct pre_unwind_data *) SCM_CELL_WORD_3 (x))
62 #define SCM_SETJBPREUNWIND(x, v) (SCM_SET_CELL_WORD_3 ((x), (scm_t_bits) (v)))
63
64 static int
65 jmpbuffer_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
66 {
67 scm_puts ("#<jmpbuffer ", port);
68 scm_puts (JBACTIVE(exp) ? "(active) " : "(inactive) ", port);
69 scm_uintprint((scm_t_bits) JBJMPBUF (exp), 16, port);
70 scm_putc ('>', port);
71 return 1 ;
72 }
73
74 static SCM
75 make_jmpbuf (void)
76 {
77 SCM answer;
78 SCM_NEWSMOB2 (answer, tc16_jmpbuffer, 0, 0);
79 SETJBJMPBUF(answer, (jmp_buf *)0);
80 DEACTIVATEJB(answer);
81 return answer;
82 }
83
84 \f
85 /* scm_c_catch (the guts of catch) */
86
87 struct jmp_buf_and_retval /* use only on the stack, in scm_catch */
88 {
89 jmp_buf buf; /* must be first */
90 SCM throw_tag;
91 SCM retval;
92 };
93
94 /* These are the structures we use to store pre-unwind handling (aka
95 "lazy") information for a regular catch, and put on the wind list
96 for a "lazy" catch. They store the pre-unwind handler function to
97 call, and the data pointer to pass through to it. It's not a
98 Scheme closure, but it is a function with data, so the term
99 "closure" is appropriate in its broader sense.
100
101 (We don't need anything like this to run the normal (post-unwind)
102 catch handler, because the same C frame runs both the body and the
103 handler.) */
104
105 struct pre_unwind_data {
106 scm_t_catch_handler handler;
107 void *handler_data;
108 int running;
109 int lazy_catch_p;
110 };
111
112
113 /* scm_c_catch is the guts of catch. It handles all the mechanics of
114 setting up a catch target, invoking the catch body, and perhaps
115 invoking the handler if the body does a throw.
116
117 The function is designed to be usable from C code, but is general
118 enough to implement all the semantics Guile Scheme expects from
119 throw.
120
121 TAG is the catch tag. Typically, this is a symbol, but this
122 function doesn't actually care about that.
123
124 BODY is a pointer to a C function which runs the body of the catch;
125 this is the code you can throw from. We call it like this:
126 BODY (BODY_DATA)
127 where:
128 BODY_DATA is just the BODY_DATA argument we received; we pass it
129 through to BODY as its first argument. The caller can make
130 BODY_DATA point to anything useful that BODY might need.
131
132 HANDLER is a pointer to a C function to deal with a throw to TAG,
133 should one occur. We call it like this:
134 HANDLER (HANDLER_DATA, THROWN_TAG, THROW_ARGS)
135 where
136 HANDLER_DATA is the HANDLER_DATA argument we recevied; it's the
137 same idea as BODY_DATA above.
138 THROWN_TAG is the tag that the user threw to; usually this is
139 TAG, but it could be something else if TAG was #t (i.e., a
140 catch-all), or the user threw to a jmpbuf.
141 THROW_ARGS is the list of arguments the user passed to the THROW
142 function, after the tag.
143
144 BODY_DATA is just a pointer we pass through to BODY. HANDLER_DATA
145 is just a pointer we pass through to HANDLER. We don't actually
146 use either of those pointers otherwise ourselves. The idea is
147 that, if our caller wants to communicate something to BODY or
148 HANDLER, it can pass a pointer to it as MUMBLE_DATA, which BODY and
149 HANDLER can then use. Think of it as a way to make BODY and
150 HANDLER closures, not just functions; MUMBLE_DATA points to the
151 enclosed variables.
152
153 Of course, it's up to the caller to make sure that any data a
154 MUMBLE_DATA needs is protected from GC. A common way to do this is
155 to make MUMBLE_DATA a pointer to data stored in an automatic
156 structure variable; since the collector must scan the stack for
157 references anyway, this assures that any references in MUMBLE_DATA
158 will be found. */
159
160 SCM
161 scm_c_catch (SCM tag,
162 scm_t_catch_body body, void *body_data,
163 scm_t_catch_handler handler, void *handler_data,
164 scm_t_catch_handler pre_unwind_handler, void *pre_unwind_handler_data)
165 {
166 struct jmp_buf_and_retval jbr;
167 SCM jmpbuf;
168 SCM answer;
169 struct pre_unwind_data pre_unwind;
170
171 jmpbuf = make_jmpbuf ();
172 answer = SCM_EOL;
173 scm_i_set_dynwinds (scm_acons (tag, jmpbuf, scm_i_dynwinds ()));
174 SETJBJMPBUF(jmpbuf, &jbr.buf);
175 SCM_SETJBDFRAME(jmpbuf, scm_i_last_debug_frame ());
176
177 pre_unwind.handler = pre_unwind_handler;
178 pre_unwind.handler_data = pre_unwind_handler_data;
179 pre_unwind.running = 0;
180 pre_unwind.lazy_catch_p = 0;
181 SCM_SETJBPREUNWIND(jmpbuf, &pre_unwind);
182
183 if (setjmp (jbr.buf))
184 {
185 SCM throw_tag;
186 SCM throw_args;
187
188 #ifdef STACK_CHECKING
189 scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
190 #endif
191 SCM_CRITICAL_SECTION_START;
192 DEACTIVATEJB (jmpbuf);
193 scm_i_set_dynwinds (SCM_CDR (scm_i_dynwinds ()));
194 SCM_CRITICAL_SECTION_END;
195 throw_args = jbr.retval;
196 throw_tag = jbr.throw_tag;
197 jbr.throw_tag = SCM_EOL;
198 jbr.retval = SCM_EOL;
199 answer = handler (handler_data, throw_tag, throw_args);
200 }
201 else
202 {
203 ACTIVATEJB (jmpbuf);
204 answer = body (body_data);
205 SCM_CRITICAL_SECTION_START;
206 DEACTIVATEJB (jmpbuf);
207 scm_i_set_dynwinds (SCM_CDR (scm_i_dynwinds ()));
208 SCM_CRITICAL_SECTION_END;
209 }
210 return answer;
211 }
212
213 SCM
214 scm_internal_catch (SCM tag,
215 scm_t_catch_body body, void *body_data,
216 scm_t_catch_handler handler, void *handler_data)
217 {
218 return scm_c_catch(tag,
219 body, body_data,
220 handler, handler_data,
221 NULL, NULL);
222 }
223
224
225 \f
226 /* The smob tag for pre_unwind_data smobs. */
227 static scm_t_bits tc16_pre_unwind_data;
228
229 /* Strictly speaking, we could just pass a zero for our print
230 function, because we don't need to print them. They should never
231 appear in normal data structures, only in the wind list. However,
232 it might be nice for debugging someday... */
233 static int
234 pre_unwind_data_print (SCM closure, SCM port, scm_print_state *pstate SCM_UNUSED)
235 {
236 struct pre_unwind_data *c = (struct pre_unwind_data *) SCM_CELL_WORD_1 (closure);
237 char buf[200];
238
239 sprintf (buf, "#<pre-unwind-data 0x%lx 0x%lx>",
240 (long) c->handler, (long) c->handler_data);
241 scm_puts (buf, port);
242
243 return 1;
244 }
245
246
247 /* Given a pointer to a pre_unwind_data structure, return a smob for it,
248 suitable for inclusion in the wind list. ("Ah yes, a Château
249 Gollombiere '72, non?"). */
250 static SCM
251 make_pre_unwind_data (struct pre_unwind_data *c)
252 {
253 SCM_RETURN_NEWSMOB (tc16_pre_unwind_data, c);
254 }
255
256 #define SCM_PRE_UNWIND_DATA_P(obj) (SCM_TYP16_PREDICATE (tc16_pre_unwind_data, obj))
257
258 SCM
259 scm_c_with_throw_handler (SCM tag,
260 scm_t_catch_body body,
261 void *body_data,
262 scm_t_catch_handler handler,
263 void *handler_data,
264 int lazy_catch_p)
265 {
266 SCM pre_unwind, answer;
267 struct pre_unwind_data c;
268
269 c.handler = handler;
270 c.handler_data = handler_data;
271 c.running = 0;
272 c.lazy_catch_p = lazy_catch_p;
273 pre_unwind = make_pre_unwind_data (&c);
274
275 SCM_CRITICAL_SECTION_START;
276 scm_i_set_dynwinds (scm_acons (tag, pre_unwind, scm_i_dynwinds ()));
277 SCM_CRITICAL_SECTION_END;
278
279 answer = (*body) (body_data);
280
281 SCM_CRITICAL_SECTION_START;
282 scm_i_set_dynwinds (SCM_CDR (scm_i_dynwinds ()));
283 SCM_CRITICAL_SECTION_END;
284
285 return answer;
286 }
287
288 /* Exactly like scm_internal_catch, except:
289 - It does not unwind the stack (this is the major difference).
290 - The handler is not allowed to return. */
291 SCM
292 scm_internal_lazy_catch (SCM tag, scm_t_catch_body body, void *body_data, scm_t_catch_handler handler, void *handler_data)
293 {
294 return scm_c_with_throw_handler (tag, body, body_data, handler, handler_data, 1);
295 }
296
297 \f
298 /* scm_internal_stack_catch
299 Use this one if you want debugging information to be stored in
300 scm_the_last_stack_fluid_var on error. */
301
302 static SCM
303 ss_handler (void *data SCM_UNUSED, SCM tag, SCM throw_args)
304 {
305 /* Save the stack */
306 scm_fluid_set_x (SCM_VARIABLE_REF (scm_the_last_stack_fluid_var),
307 scm_make_stack (SCM_BOOL_T, SCM_EOL));
308 /* Throw the error */
309 return scm_throw (tag, throw_args);
310 }
311
312 struct cwss_data
313 {
314 SCM tag;
315 scm_t_catch_body body;
316 void *data;
317 };
318
319 static SCM
320 cwss_body (void *data)
321 {
322 struct cwss_data *d = data;
323 return scm_internal_lazy_catch (d->tag, d->body, d->data, ss_handler, NULL);
324 }
325
326 SCM
327 scm_internal_stack_catch (SCM tag,
328 scm_t_catch_body body,
329 void *body_data,
330 scm_t_catch_handler handler,
331 void *handler_data)
332 {
333 struct cwss_data d;
334 d.tag = tag;
335 d.body = body;
336 d.data = body_data;
337 return scm_internal_catch (tag, cwss_body, &d, handler, handler_data);
338 }
339
340
341 \f
342 /* body and handler functions for use with any of the above catch variants */
343
344 /* This is a body function you can pass to scm_internal_catch if you
345 want the body to be like Scheme's `catch' --- a thunk.
346
347 BODY_DATA is a pointer to a scm_body_thunk_data structure, which
348 contains the Scheme procedure to invoke as the body, and the tag
349 we're catching. */
350
351 SCM
352 scm_body_thunk (void *body_data)
353 {
354 struct scm_body_thunk_data *c = (struct scm_body_thunk_data *) body_data;
355
356 return scm_call_0 (c->body_proc);
357 }
358
359
360 /* This is a handler function you can pass to scm_internal_catch if
361 you want the handler to act like Scheme's catch: (throw TAG ARGS ...)
362 applies a handler procedure to (TAG ARGS ...).
363
364 If the user does a throw to this catch, this function runs a
365 handler procedure written in Scheme. HANDLER_DATA is a pointer to
366 an SCM variable holding the Scheme procedure object to invoke. It
367 ought to be a pointer to an automatic variable (i.e., one living on
368 the stack), or the procedure object should be otherwise protected
369 from GC. */
370 SCM
371 scm_handle_by_proc (void *handler_data, SCM tag, SCM throw_args)
372 {
373 SCM *handler_proc_p = (SCM *) handler_data;
374
375 return scm_apply_1 (*handler_proc_p, tag, throw_args);
376 }
377
378 /* SCM_HANDLE_BY_PROC_CATCHING_ALL is like SCM_HANDLE_BY_PROC but
379 catches all throws that the handler might emit itself. The handler
380 used for these `secondary' throws is SCM_HANDLE_BY_MESSAGE_NO_EXIT. */
381
382 struct hbpca_data {
383 SCM proc;
384 SCM args;
385 };
386
387 static SCM
388 hbpca_body (void *body_data)
389 {
390 struct hbpca_data *data = (struct hbpca_data *)body_data;
391 return scm_apply_0 (data->proc, data->args);
392 }
393
394 SCM
395 scm_handle_by_proc_catching_all (void *handler_data, SCM tag, SCM throw_args)
396 {
397 SCM *handler_proc_p = (SCM *) handler_data;
398 struct hbpca_data data;
399 data.proc = *handler_proc_p;
400 data.args = scm_cons (tag, throw_args);
401
402 return scm_internal_catch (SCM_BOOL_T,
403 hbpca_body, &data,
404 scm_handle_by_message_noexit, NULL);
405 }
406
407 /* Derive the an exit status from the arguments to (quit ...). */
408 int
409 scm_exit_status (SCM args)
410 {
411 if (!SCM_NULL_OR_NIL_P (args))
412 {
413 SCM cqa = SCM_CAR (args);
414
415 if (scm_is_integer (cqa))
416 return (scm_to_int (cqa));
417 else if (scm_is_false (cqa))
418 return 1;
419 }
420 return 0;
421 }
422
423
424 static void
425 handler_message (void *handler_data, SCM tag, SCM args)
426 {
427 char *prog_name = (char *) handler_data;
428 SCM p = scm_current_error_port ();
429
430 if (scm_ilength (args) == 4)
431 {
432 SCM stack = scm_make_stack (SCM_BOOL_T, SCM_EOL);
433 SCM subr = SCM_CAR (args);
434 SCM message = SCM_CADR (args);
435 SCM parts = SCM_CADDR (args);
436 SCM rest = SCM_CADDDR (args);
437
438 if (SCM_BACKTRACE_P && scm_is_true (stack))
439 {
440 SCM highlights;
441
442 if (scm_is_eq (tag, scm_arg_type_key)
443 || scm_is_eq (tag, scm_out_of_range_key))
444 highlights = rest;
445 else
446 highlights = SCM_EOL;
447
448 scm_puts ("Backtrace:\n", p);
449 scm_display_backtrace_with_highlights (stack, p,
450 SCM_BOOL_F, SCM_BOOL_F,
451 highlights);
452 scm_newline (p);
453 }
454 scm_i_display_error (stack, p, subr, message, parts, rest);
455 }
456 else
457 {
458 if (! prog_name)
459 prog_name = "guile";
460
461 scm_puts (prog_name, p);
462 scm_puts (": ", p);
463
464 scm_puts ("uncaught throw to ", p);
465 scm_prin1 (tag, p, 0);
466 scm_puts (": ", p);
467 scm_prin1 (args, p, 1);
468 scm_putc ('\n', p);
469 }
470 }
471
472
473 /* This is a handler function to use if you want scheme to print a
474 message and die. Useful for dealing with throws to uncaught keys
475 at the top level.
476
477 At boot time, we establish a catch-all that uses this as its handler.
478 1) If the user wants something different, they can use (catch #t
479 ...) to do what they like.
480 2) Outside the context of a read-eval-print loop, there isn't
481 anything else good to do; libguile should not assume the existence
482 of a read-eval-print loop.
483 3) Given that we shouldn't do anything complex, it's much more
484 robust to do it in C code.
485
486 HANDLER_DATA, if non-zero, is assumed to be a char * pointing to a
487 message header to print; if zero, we use "guile" instead. That
488 text is followed by a colon, then the message described by ARGS. */
489
490 /* Dirk:FIXME:: The name of the function should make clear that the
491 * application gets terminated.
492 */
493
494 SCM
495 scm_handle_by_message (void *handler_data, SCM tag, SCM args)
496 {
497 if (scm_is_true (scm_eq_p (tag, scm_from_locale_symbol ("quit"))))
498 exit (scm_exit_status (args));
499
500 handler_message (handler_data, tag, args);
501 scm_i_pthread_exit (NULL);
502
503 /* this point not reached, but suppress gcc warning about no return value
504 in case scm_i_pthread_exit isn't marked as "noreturn" (which seemed not
505 to be the case on cygwin for instance) */
506 return SCM_BOOL_F;
507 }
508
509
510 /* This is just like scm_handle_by_message, but it doesn't exit; it
511 just returns #f. It's useful in cases where you don't really know
512 enough about the body to handle things in a better way, but don't
513 want to let throws fall off the bottom of the wind list. */
514 SCM
515 scm_handle_by_message_noexit (void *handler_data, SCM tag, SCM args)
516 {
517 if (scm_is_true (scm_eq_p (tag, scm_from_locale_symbol ("quit"))))
518 exit (scm_exit_status (args));
519
520 handler_message (handler_data, tag, args);
521
522 return SCM_BOOL_F;
523 }
524
525
526 SCM
527 scm_handle_by_throw (void *handler_data SCM_UNUSED, SCM tag, SCM args)
528 {
529 scm_ithrow (tag, args, 1);
530 return SCM_UNSPECIFIED; /* never returns */
531 }
532
533
534 \f
535 /* the Scheme-visible CATCH, WITH-THROW-HANDLER and LAZY-CATCH functions */
536
537 SCM_DEFINE (scm_catch_with_pre_unwind_handler, "catch", 3, 1, 0,
538 (SCM key, SCM thunk, SCM handler, SCM pre_unwind_handler),
539 "Invoke @var{thunk} in the dynamic context of @var{handler} for\n"
540 "exceptions matching @var{key}. If thunk throws to the symbol\n"
541 "@var{key}, then @var{handler} is invoked this way:\n"
542 "@lisp\n"
543 "(handler key args ...)\n"
544 "@end lisp\n"
545 "\n"
546 "@var{key} is a symbol or @code{#t}.\n"
547 "\n"
548 "@var{thunk} takes no arguments. If @var{thunk} returns\n"
549 "normally, that is the return value of @code{catch}.\n"
550 "\n"
551 "Handler is invoked outside the scope of its own @code{catch}.\n"
552 "If @var{handler} again throws to the same key, a new handler\n"
553 "from further up the call chain is invoked.\n"
554 "\n"
555 "If the key is @code{#t}, then a throw to @emph{any} symbol will\n"
556 "match this call to @code{catch}.\n"
557 "\n"
558 "If a @var{pre-unwind-handler} is given and @var{thunk} throws\n"
559 "an exception that matches @var{key}, Guile calls the\n"
560 "@var{pre-unwind-handler} before unwinding the dynamic state and\n"
561 "invoking the main @var{handler}. @var{pre-unwind-handler} should\n"
562 "be a procedure with the same signature as @var{handler}, that\n"
563 "is @code{(lambda (key . args))}. It is typically used to save\n"
564 "the stack at the point where the exception occurred, but can also\n"
565 "query other parts of the dynamic state at that point, such as\n"
566 "fluid values.\n"
567 "\n"
568 "A @var{pre-unwind-handler} can exit either normally or non-locally.\n"
569 "If it exits normally, Guile unwinds the stack and dynamic context\n"
570 "and then calls the normal (third argument) handler. If it exits\n"
571 "non-locally, that exit determines the continuation.")
572 #define FUNC_NAME s_scm_catch_with_pre_unwind_handler
573 {
574 struct scm_body_thunk_data c;
575
576 SCM_ASSERT (scm_is_symbol (key) || scm_is_eq (key, SCM_BOOL_T),
577 key, SCM_ARG1, FUNC_NAME);
578
579 c.tag = key;
580 c.body_proc = thunk;
581
582 /* scm_c_catch takes care of all the mechanics of setting up a catch
583 key; we tell it to call scm_body_thunk to run the body, and
584 scm_handle_by_proc to deal with any throws to this catch. The
585 former receives a pointer to c, telling it how to behave. The
586 latter receives a pointer to HANDLER, so it knows who to
587 call. */
588 return scm_c_catch (key,
589 scm_body_thunk, &c,
590 scm_handle_by_proc, &handler,
591 SCM_UNBNDP (pre_unwind_handler) ? NULL : scm_handle_by_proc,
592 &pre_unwind_handler);
593 }
594 #undef FUNC_NAME
595
596 /* The following function exists to provide backwards compatibility
597 for the C scm_catch API. Otherwise we could just change
598 "scm_catch_with_pre_unwind_handler" above to "scm_catch". */
599 SCM
600 scm_catch (SCM key, SCM thunk, SCM handler)
601 {
602 return scm_catch_with_pre_unwind_handler (key, thunk, handler, SCM_UNDEFINED);
603 }
604
605
606 SCM_DEFINE (scm_with_throw_handler, "with-throw-handler", 3, 0, 0,
607 (SCM key, SCM thunk, SCM handler),
608 "Add @var{handler} to the dynamic context as a throw handler\n"
609 "for key @var{key}, then invoke @var{thunk}.")
610 #define FUNC_NAME s_scm_with_throw_handler
611 {
612 struct scm_body_thunk_data c;
613
614 SCM_ASSERT (scm_is_symbol (key) || scm_is_eq (key, SCM_BOOL_T),
615 key, SCM_ARG1, FUNC_NAME);
616
617 c.tag = key;
618 c.body_proc = thunk;
619
620 /* scm_c_with_throw_handler takes care of the mechanics of setting
621 up a throw handler; we tell it to call scm_body_thunk to run the
622 body, and scm_handle_by_proc to deal with any throws to this
623 handler. The former receives a pointer to c, telling it how to
624 behave. The latter receives a pointer to HANDLER, so it knows
625 who to call. */
626 return scm_c_with_throw_handler (key,
627 scm_body_thunk, &c,
628 scm_handle_by_proc, &handler,
629 0);
630 }
631 #undef FUNC_NAME
632
633 SCM_DEFINE (scm_lazy_catch, "lazy-catch", 3, 0, 0,
634 (SCM key, SCM thunk, SCM handler),
635 "This behaves exactly like @code{catch}, except that it does\n"
636 "not unwind the stack before invoking @var{handler}.\n"
637 "If the @var{handler} procedure returns normally, Guile\n"
638 "rethrows the same exception again to the next innermost catch,\n"
639 "lazy-catch or throw handler. If the @var{handler} exits\n"
640 "non-locally, that exit determines the continuation.")
641 #define FUNC_NAME s_scm_lazy_catch
642 {
643 struct scm_body_thunk_data c;
644
645 SCM_ASSERT (scm_is_symbol (key) || scm_is_eq (key, SCM_BOOL_T),
646 key, SCM_ARG1, FUNC_NAME);
647
648 c.tag = key;
649 c.body_proc = thunk;
650
651 /* scm_internal_lazy_catch takes care of all the mechanics of
652 setting up a lazy catch key; we tell it to call scm_body_thunk to
653 run the body, and scm_handle_by_proc to deal with any throws to
654 this catch. The former receives a pointer to c, telling it how
655 to behave. The latter receives a pointer to HANDLER, so it knows
656 who to call. */
657 return scm_internal_lazy_catch (key,
658 scm_body_thunk, &c,
659 scm_handle_by_proc, &handler);
660 }
661 #undef FUNC_NAME
662
663
664 \f
665 /* throwing */
666
667 static void toggle_pre_unwind_running (void *data)
668 {
669 struct pre_unwind_data *pre_unwind = (struct pre_unwind_data *)data;
670 pre_unwind->running = !pre_unwind->running;
671 }
672
673 SCM_DEFINE (scm_throw, "throw", 1, 0, 1,
674 (SCM key, SCM args),
675 "Invoke the catch form matching @var{key}, passing @var{args} to the\n"
676 "@var{handler}. \n\n"
677 "@var{key} is a symbol. It will match catches of the same symbol or of\n"
678 "@code{#t}.\n\n"
679 "If there is no handler at all, Guile prints an error and then exits.")
680 #define FUNC_NAME s_scm_throw
681 {
682 SCM_VALIDATE_SYMBOL (1, key);
683 return scm_ithrow (key, args, 1);
684 }
685 #undef FUNC_NAME
686
687 SCM
688 scm_ithrow (SCM key, SCM args, int noreturn SCM_UNUSED)
689 {
690 SCM jmpbuf = SCM_UNDEFINED;
691 SCM wind_goal;
692
693 SCM dynpair = SCM_UNDEFINED;
694 SCM winds;
695
696 if (scm_i_critical_section_level)
697 {
698 SCM s = args;
699 int i = 0;
700
701 /*
702 We have much better routines for displaying Scheme, but we're
703 already inside a pernicious error, and it's unlikely that they
704 are available to us. We try to print something useful anyway,
705 so users don't need a debugger to find out what went wrong.
706 */
707 fprintf (stderr, "throw from within critical section.\n");
708 if (scm_is_symbol (key))
709 fprintf (stderr, "error key: %s\n", scm_i_symbol_chars (key));
710
711
712 for (; scm_is_pair (s); s = scm_cdr (s), i++)
713 {
714 char const *str = NULL;
715 if (scm_is_string (scm_car (s)))
716 str = scm_i_string_chars (scm_car (s));
717 else if (scm_is_symbol (scm_car (s)))
718 str = scm_i_symbol_chars (scm_car (s));
719
720 if (str != NULL)
721 fprintf (stderr, "argument %d: %s\n", i, str);
722 }
723 abort ();
724 }
725
726 rethrow:
727
728 /* Search the wind list for an appropriate catch.
729 "Waiter, please bring us the wind list." */
730 for (winds = scm_i_dynwinds (); scm_is_pair (winds); winds = SCM_CDR (winds))
731 {
732 dynpair = SCM_CAR (winds);
733 if (scm_is_pair (dynpair))
734 {
735 SCM this_key = SCM_CAR (dynpair);
736
737 if (scm_is_eq (this_key, SCM_BOOL_T) || scm_is_eq (this_key, key))
738 {
739 jmpbuf = SCM_CDR (dynpair);
740
741 if (!SCM_PRE_UNWIND_DATA_P (jmpbuf))
742 break;
743 else
744 {
745 struct pre_unwind_data *c =
746 (struct pre_unwind_data *) SCM_CELL_WORD_1 (jmpbuf);
747 if (!c->running)
748 break;
749 }
750 }
751 }
752 }
753
754 /* If we didn't find anything, print a message and abort the process
755 right here. If you don't want this, establish a catch-all around
756 any code that might throw up. */
757 if (scm_is_null (winds))
758 {
759 scm_handle_by_message (NULL, key, args);
760 abort ();
761 }
762
763 /* If the wind list is malformed, bail. */
764 if (!scm_is_pair (winds))
765 abort ();
766
767 for (wind_goal = scm_i_dynwinds ();
768 (!scm_is_pair (SCM_CAR (wind_goal))
769 || !scm_is_eq (SCM_CDAR (wind_goal), jmpbuf));
770 wind_goal = SCM_CDR (wind_goal))
771 ;
772
773 /* Is this a throw handler (or lazy catch)? In a wind list entry
774 for a throw handler or lazy catch, the key is bound to a
775 pre_unwind_data smob, not a jmpbuf. */
776 if (SCM_PRE_UNWIND_DATA_P (jmpbuf))
777 {
778 struct pre_unwind_data *c =
779 (struct pre_unwind_data *) SCM_CELL_WORD_1 (jmpbuf);
780 SCM handle, answer;
781
782 /* For old-style lazy-catch behaviour, we unwind the dynamic
783 context before invoking the handler. */
784 if (c->lazy_catch_p)
785 {
786 scm_dowinds (wind_goal, (scm_ilength (scm_i_dynwinds ())
787 - scm_ilength (wind_goal)));
788 SCM_CRITICAL_SECTION_START;
789 handle = scm_i_dynwinds ();
790 scm_i_set_dynwinds (SCM_CDR (handle));
791 SCM_CRITICAL_SECTION_END;
792 }
793
794 /* Call the handler, with framing to set the pre-unwind
795 structure's running field while the handler is running, so we
796 can avoid recursing into the same handler again. Note that
797 if the handler returns normally, the running flag stays
798 set until some kind of non-local jump occurs. */
799 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE);
800 scm_dynwind_rewind_handler (toggle_pre_unwind_running,
801 c,
802 SCM_F_WIND_EXPLICITLY);
803 scm_dynwind_unwind_handler (toggle_pre_unwind_running, c, 0);
804 answer = (c->handler) (c->handler_data, key, args);
805
806 /* There is deliberately no scm_dynwind_end call here. This
807 means that the unwind handler (toggle_pre_unwind_running)
808 stays in place until a non-local exit occurs, and will then
809 reset the pre-unwind structure's running flag. For sample
810 code where this makes a difference, see the "again but with
811 two chained throw handlers" test case in exceptions.test. */
812
813 /* If the handler returns, rethrow the same key and args. */
814 goto rethrow;
815 }
816
817 /* Otherwise, it's a normal catch. */
818 else if (SCM_JMPBUFP (jmpbuf))
819 {
820 struct pre_unwind_data * pre_unwind;
821 struct jmp_buf_and_retval * jbr;
822
823 /* Before unwinding anything, run the pre-unwind handler if
824 there is one, and if it isn't already running. */
825 pre_unwind = SCM_JBPREUNWIND (jmpbuf);
826 if (pre_unwind->handler && !pre_unwind->running)
827 {
828 /* Use framing to detect and avoid possible reentry into
829 this handler, which could otherwise cause an infinite
830 loop. */
831 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE);
832 scm_dynwind_rewind_handler (toggle_pre_unwind_running,
833 pre_unwind,
834 SCM_F_WIND_EXPLICITLY);
835 scm_dynwind_unwind_handler (toggle_pre_unwind_running,
836 pre_unwind,
837 SCM_F_WIND_EXPLICITLY);
838 (pre_unwind->handler) (pre_unwind->handler_data, key, args);
839 scm_dynwind_end ();
840 }
841
842 /* Now unwind and jump. */
843 scm_dowinds (wind_goal, (scm_ilength (scm_i_dynwinds ())
844 - scm_ilength (wind_goal)));
845 jbr = (struct jmp_buf_and_retval *)JBJMPBUF (jmpbuf);
846 jbr->throw_tag = key;
847 jbr->retval = args;
848 scm_i_set_last_debug_frame (SCM_JBDFRAME (jmpbuf));
849 longjmp (*JBJMPBUF (jmpbuf), 1);
850 }
851
852 /* Otherwise, it's some random piece of junk. */
853 else
854 abort ();
855
856 #ifdef __ia64__
857 /* On IA64, we #define longjmp as setcontext, and GCC appears not to
858 know that that doesn't return. */
859 return SCM_UNSPECIFIED;
860 #endif
861 }
862
863
864 void
865 scm_init_throw ()
866 {
867 tc16_jmpbuffer = scm_make_smob_type ("jmpbuffer", 0);
868 scm_set_smob_print (tc16_jmpbuffer, jmpbuffer_print);
869
870 tc16_pre_unwind_data = scm_make_smob_type ("pre-unwind-data", 0);
871 scm_set_smob_print (tc16_pre_unwind_data, pre_unwind_data_print);
872
873 #include "libguile/throw.x"
874 }
875
876 /*
877 Local Variables:
878 c-file-style: "gnu"
879 End:
880 */