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 Free Software Foundation, Inc.
   7  *
   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.
  12  *
  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.
  17  *
  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
  20  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  21  * Boston, MA 02111-1307 USA
  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.
  45  * If you do not wish that, delete this exception notice.  */
  46
  47 \f
  48
  49 #include "libguile/__scm.h"
  50
  51 \f
  52
  53 typedef SCM (*scm_t_catch_body) (void *data);
  54 typedef SCM (*scm_t_catch_handler) (void *data,
  55                                     SCM tag, SCM throw_args);
  56
  57 SCM_API SCM scm_internal_catch (SCM tag,
  58                                 scm_t_catch_body body,
  59                                 void *body_data,
  60                                 scm_t_catch_handler handler,
  61                                 void *handler_data);
  62
  63 SCM_API SCM scm_internal_lazy_catch (SCM tag,
  64                                      scm_t_catch_body body,
  65                                      void *body_data,
  66                                      scm_t_catch_handler handler,
  67                                      void *handler_data);
  68
  69 SCM_API SCM scm_internal_stack_catch (SCM tag,
  70                                       scm_t_catch_body body,
  71                                       void *body_data,
  72                                       scm_t_catch_handler handler,
  73                                       void *handler_data);
  74
  75 /* The first argument to scm_body_thunk should be a pointer to one of
  76    these.  See the implementation of catch in throw.c.  */
  77 struct scm_body_thunk_data
  78 {
  79   /* The tag being caught.  We only use it to figure out what
  80      arguments to pass to the body procedure; see scm_catch_thunk_body for
  81      details.  */
  82   SCM tag;
  83
  84   /* The Scheme procedure object constituting the catch body.
  85      scm_body_by_proc invokes this.  */
  86   SCM body_proc;
  87 };
  88
  89 SCM_API SCM scm_body_thunk (void *);
  90
  91
  92 SCM_API SCM scm_handle_by_proc (void *, SCM, SCM);
  93 SCM_API SCM scm_handle_by_proc_catching_all (void *, SCM, SCM);
  94 SCM_API SCM scm_handle_by_message (void *, SCM, SCM);
  95 SCM_API SCM scm_handle_by_message_noexit (void *, SCM, SCM);
  96 SCM_API SCM scm_handle_by_throw (void *, SCM, SCM);
  97 SCM_API int scm_exit_status (SCM args);
  98
  99 SCM_API SCM scm_catch (SCM tag, SCM thunk, SCM handler);
 100 SCM_API SCM scm_lazy_catch (SCM tag, SCM thunk, SCM handler);
 101 SCM_API SCM scm_ithrow (SCM key, SCM args, int noreturn);
 102
 103 SCM_API SCM scm_throw (SCM key, SCM args);
 104 SCM_API void scm_init_throw (void);
 105
 106 #endif  /* SCM_THROW_H */
 107
 108 /*
 109   Local Variables:
 110   c-file-style: "gnu"
 111   End:
 112 */