libguile/root.h

   1 /* classes: h_files */
   2
   3 #ifndef ROOTH
   4 #define ROOTH
   5
   6 /*      Copyright (C) 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 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  48    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  49 \f
  50
  51 \f
  52
  53 #include "libguile/__scm.h"
  54 #include "libguile/debug.h"
  55 #include "libguile/throw.h"
  56
  57 \f
  58
  59 #define scm_flo0 scm_sys_protects[0]
  60 #define scm_listofnull scm_sys_protects[1]
  61 #define scm_undefineds scm_sys_protects[2]
  62 #define scm_nullvect scm_sys_protects[3]
  63 #define scm_nullstr scm_sys_protects[4]
  64 #define scm_symhash scm_sys_protects[5]
  65 #define scm_weak_symhash scm_sys_protects[6]
  66 #define scm_symhash_vars scm_sys_protects[7]
  67 #define scm_keyword_obarray scm_sys_protects[8]
  68 #define scm_stand_in_procs scm_sys_protects[9]
  69 #define scm_object_whash scm_sys_protects[10]
  70 #define scm_permobjs scm_sys_protects[11]
  71 #define scm_asyncs scm_sys_protects[12]
  72 #define scm_protects scm_sys_protects[13]
  73 #define scm_properties_whash scm_sys_protects[14]
  74 #ifdef DEBUG_EXTENSIONS
  75 #define scm_source_whash scm_sys_protects[15]
  76 #define SCM_NUM_PROTECTS 16
  77 #else
  78 #define SCM_NUM_PROTECTS 15
  79 #endif
  80
  81 extern SCM scm_sys_protects[];
  82
  83 \f
  84
  85 extern long scm_tc16_root;
  86
  87 #define SCM_ROOTP(obj) (SCM_NIMP(obj) && (scm_tc16_root == SCM_TYP16 (obj)))
  88 #define SCM_ROOT_STATE(root) ((scm_root_state *) SCM_CELL_WORD_1 (root))
  89
  90 typedef struct scm_root_state
  91 {
  92   SCM_STACKITEM * stack_base;
  93   jmp_buf save_regs_gc_mark;
  94   int errjmp_bad;
  95
  96   SCM rootcont;
  97   SCM dynwinds;
  98   SCM continuation_stack;
  99   SCM continuation_stack_ptr;
 100 #ifdef DEBUG_EXTENSIONS
 101   /* It is very inefficient to have this variable in the root state. */
 102   scm_debug_frame *last_debug_frame;
 103 #endif
 104
 105   SCM progargs;                 /* vestigial */
 106   SCM exitval;                  /* vestigial */
 107
 108   SCM cur_inp;
 109   SCM cur_outp;
 110   SCM cur_errp;
 111   SCM def_inp;
 112   SCM def_outp;
 113   SCM def_errp;
 114   SCM cur_loadp;
 115
 116   SCM fluids;
 117
 118   SCM system_transformer;           /* No longer used (but kept for binary compatibility) */
 119   SCM top_level_lookup_closure_var; /* No longer used (but kept for binary compatibility) */
 120
 121   SCM handle;                   /* The root object for this root state */
 122   SCM parent;                   /* The parent root object */
 123 } scm_root_state;
 124
 125 #define scm_stack_base                  (scm_root->stack_base)
 126 #define scm_save_regs_gc_mark           (scm_root->save_regs_gc_mark)
 127 #define scm_errjmp_bad                  (scm_root->errjmp_bad)
 128
 129 #define scm_rootcont                    (scm_root->rootcont)
 130 #define scm_dynwinds                    (scm_root->dynwinds)
 131 #define scm_continuation_stack          (scm_root->continuation_stack)
 132 #define scm_continuation_stack_ptr      (scm_root->continuation_stack_ptr)
 133 #define scm_progargs                    (scm_root->progargs)
 134 #ifdef USE_THREADS
 135 #define scm_last_debug_frame            (scm_root->last_debug_frame)
 136 #endif
 137 #define scm_exitval                     (scm_root->exitval)
 138 #define scm_cur_inp                     (scm_root->cur_inp)
 139 #define scm_cur_outp                    (scm_root->cur_outp)
 140 #define scm_cur_errp                    (scm_root->cur_errp)
 141 #define scm_def_inp                     (scm_root->def_inp)
 142 #define scm_def_outp                    (scm_root->def_outp)
 143 #define scm_def_errp                    (scm_root->def_errp)
 144 #define scm_cur_loadp                   (scm_root->cur_loadp)
 145
 146 #ifdef USE_THREADS
 147 #define scm_root ((scm_root_state *) SCM_THREAD_LOCAL_DATA)
 148 #define scm_set_root(new_root) SCM_SET_THREAD_LOCAL_DATA (new_root)
 149 #else /* USE_THREADS */
 150 extern struct scm_root_state *scm_root;
 151 #define scm_set_root(new_root) (scm_root = (new_root))
 152 #endif /* USE_THREADS */
 153
 154 \f
 155
 156 extern SCM scm_make_root (SCM parent);
 157 extern SCM scm_internal_cwdr (scm_catch_body_t body,
 158                               void *body_data,
 159                               scm_catch_handler_t handler,
 160                               void *handler_data,
 161                               SCM_STACKITEM *stack_start);
 162 extern SCM scm_call_with_dynamic_root (SCM thunk, SCM handler);
 163 extern SCM scm_dynamic_root (void);
 164 extern SCM scm_apply_with_dynamic_root (SCM proc, SCM a1, SCM args, SCM handler);
 165 extern void scm_init_root (void);
 166
 167 \f
 168
 169 #if (SCM_DEBUG_DEPRECATED == 0)
 170
 171 /* Use the catch functions from throw.[ch] instead of: */
 172 extern SCM scm_call_catching_errors (SCM (*thunk)(), SCM (*err_filter)(), void * closure);
 173
 174 #endif  /* SCM_DEBUG_DEPRECATED == 0 */
 175
 176 #endif  /* ROOTH */
 177
 178 /*
 179   Local Variables:
 180   c-file-style: "gnu"
 181   End:
 182 */