libguile/throw.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_THROW_H
   4 #define SCM_THROW_H
   5
   6 /* Copyright (C) 1995,1996,1998,2000, 2006, 2008 Free Software Foundation, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  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
  21  * 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 #include "libguile/__scm.h"
  27
  28 \f
  29
  30 typedef SCM (*scm_t_catch_body) (void *data);
  31 typedef SCM (*scm_t_catch_handler) (void *data,
  32                                     SCM tag, SCM throw_args);
  33
  34 SCM_API SCM scm_c_catch (SCM tag,
  35                          scm_t_catch_body body,
  36                          void *body_data,
  37                          scm_t_catch_handler handler,
  38                          void *handler_data,
  39                          scm_t_catch_handler pre_unwind_handler,
  40                          void *pre_unwind_handler_data);
  41
  42 SCM_API SCM scm_c_with_throw_handler (SCM tag,
  43                                       scm_t_catch_body body,
  44                                       void *body_data,
  45                                       scm_t_catch_handler handler,
  46                                       void *handler_data,
  47                                       int lazy_catch_p);
  48
  49 SCM_API SCM scm_internal_catch (SCM tag,
  50                                 scm_t_catch_body body,
  51                                 void *body_data,
  52                                 scm_t_catch_handler handler,
  53                                 void *handler_data);
  54
  55 SCM_API SCM scm_internal_lazy_catch (SCM tag,
  56                                      scm_t_catch_body body,
  57                                      void *body_data,
  58                                      scm_t_catch_handler handler,
  59                                      void *handler_data);
  60
  61 SCM_API SCM scm_internal_stack_catch (SCM tag,
  62                                       scm_t_catch_body body,
  63                                       void *body_data,
  64                                       scm_t_catch_handler handler,
  65                                       void *handler_data);
  66
  67 /* The first argument to scm_body_thunk should be a pointer to one of
  68    these.  See the implementation of catch in throw.c.  */
  69 struct scm_body_thunk_data
  70 {
  71   /* The tag being caught.  We only use it to figure out what
  72      arguments to pass to the body procedure; see scm_catch_thunk_body for
  73      details.  */
  74   SCM tag;
  75
  76   /* The Scheme procedure object constituting the catch body.
  77      scm_body_by_proc invokes this.  */
  78   SCM body_proc;
  79 };
  80
  81 SCM_API SCM scm_body_thunk (void *);
  82
  83
  84 SCM_API SCM scm_handle_by_proc (void *, SCM, SCM);
  85 SCM_API SCM scm_handle_by_proc_catching_all (void *, SCM, SCM);
  86 SCM_API SCM scm_handle_by_message (void *, SCM, SCM);
  87 SCM_API SCM scm_handle_by_message_noexit (void *, SCM, SCM);
  88 SCM_API SCM scm_handle_by_throw (void *, SCM, SCM);
  89 SCM_API int scm_exit_status (SCM args);
  90
  91 SCM_API SCM scm_catch_with_pre_unwind_handler (SCM tag, SCM thunk, SCM handler, SCM lazy_handler);
  92 SCM_API SCM scm_catch (SCM tag, SCM thunk, SCM handler);
  93 SCM_API SCM scm_with_throw_handler (SCM tag, SCM thunk, SCM handler);
  94 SCM_API SCM scm_lazy_catch (SCM tag, SCM thunk, SCM handler);
  95 SCM_API SCM scm_ithrow (SCM key, SCM args, int noreturn);
  96
  97 SCM_API SCM scm_throw (SCM key, SCM args);
  98 SCM_INTERNAL void scm_init_throw (void);
  99
 100 #endif  /* SCM_THROW_H */
 101
 102 /*
 103   Local Variables:
 104   c-file-style: "gnu"
 105   End:
 106 */