libguile/environments.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_ENVIRONMENTS_H
   4 #define SCM_ENVIRONMENTS_H
   5
   6 /* Copyright (C) 1999,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 /* The type for folding functions written in C.  A function meant to be passed
  31  * to scm_c_environment_fold should have the type scm_environment_folder.
  32  */
  33 typedef SCM (*scm_environment_folder) (SCM data, SCM sym, SCM val, SCM tail);
  34
  35
  36 /* The type for observer functions written in C.  A function meant to be
  37  * passed to scm_c_environment_observe should have the type
  38  * scm_environment_observer.
  39  */
  40 typedef void (*scm_environment_observer) (SCM env, SCM data);
  41
  42
  43 struct scm_environment_funcs {
  44   SCM (*ref) (SCM self, SCM symbol);
  45   SCM (*fold) (SCM self, scm_environment_folder proc, SCM data, SCM init);
  46
  47   SCM (*define) (SCM self, SCM symbol, SCM value);
  48   SCM (*undefine) (SCM self, SCM symbol);
  49   SCM (*set) (SCM self, SCM symbol, SCM value);
  50
  51   SCM (*cell) (SCM self, SCM symbol, int for_write);
  52   SCM (*observe) (SCM self, scm_environment_observer proc, SCM data, int weak_p);
  53   void (*unobserve) (SCM self, SCM token);
  54
  55   int (*print) (SCM self, SCM port, scm_print_state *pstate);
  56 };
  57
  58 \f
  59
  60 #define SCM_ENVIRONMENT_SUCCESS SCM_BOOL_T
  61 #define SCM_ENVIRONMENT_BINDING_IMMUTABLE scm_from_int (0)
  62 #define SCM_ENVIRONMENT_LOCATION_IMMUTABLE scm_from_int (1)
  63 #define SCM_ENVIRONMENT_LOCATION_NO_CELL SCM_BOOL_F
  64
  65 SCM_API scm_t_bits scm_tc16_environment;
  66
  67 #define SCM_ENVIRONMENT_P(x) \
  68   (!SCM_IMP (x) && SCM_CELL_TYPE (x) == scm_tc16_environment)
  69 #define SCM_ENVIRONMENT_FUNCS(env) \
  70   (*((struct scm_environment_funcs **) SCM_CELL_WORD_1 (env)))
  71 #define SCM_ENVIRONMENT_BOUND_P(env, symbol) \
  72   (!SCM_UNBNDP (SCM_ENVIRONMENT_REF (env, symbol)))
  73 #define SCM_ENVIRONMENT_REF(env, symbol) \
  74   ((*(SCM_ENVIRONMENT_FUNCS (env)->ref)) (env, symbol))
  75 #define SCM_ENVIRONMENT_FOLD(env, proc, data, init) \
  76   ((*(SCM_ENVIRONMENT_FUNCS (env)->fold)) (env, proc, data, init))
  77 #define SCM_ENVIRONMENT_DEFINE(env, symbol, value) \
  78   ((*(SCM_ENVIRONMENT_FUNCS (env)->define)) (env, symbol, value))
  79 #define SCM_ENVIRONMENT_UNDEFINE(env, symbol) \
  80   ((*(SCM_ENVIRONMENT_FUNCS (env)->undefine)) (env, symbol))
  81 #define SCM_ENVIRONMENT_SET(env, symbol, value) \
  82   ((*(SCM_ENVIRONMENT_FUNCS (env)->set)) (env, symbol, value))
  83 #define SCM_ENVIRONMENT_CELL(env, symbol, for_write) \
  84   ((*(SCM_ENVIRONMENT_FUNCS (env)->cell)) (env, symbol, for_write))
  85 #define SCM_ENVIRONMENT_OBSERVE(env, proc, data, weak_p) \
  86   ((*(SCM_ENVIRONMENT_FUNCS (env)->observe)) (env, proc, data, weak_p))
  87 #define SCM_ENVIRONMENT_UNOBSERVE(env, token) \
  88   ((*(SCM_ENVIRONMENT_FUNCS (env)->unobserve)) (env, token))
  89
  90 SCM_API scm_t_bits scm_tc16_observer;
  91
  92 #define SCM_OBSERVER_P(x) \
  93   (!SCM_IMP (x) && (SCM_CELL_TYPE (x) == scm_tc16_observer))
  94 #define SCM_OBSERVER_ENVIRONMENT(x) \
  95   (SCM_CELL_OBJECT_1 (x))
  96 #define SCM_OBSERVER_DATA(x) \
  97   (SCM_CELL_OBJECT_2 (x))
  98 #define SCM_OBSERVER_PROC(x) \
  99   ((scm_environment_observer) SCM_CELL_WORD_3 (x))
 100
 101 SCM_API SCM scm_system_environment;
 102
 103 SCM_API void scm_error_environment_unbound (const char *, SCM, SCM) SCM_NORETURN;
 104 SCM_API void scm_error_environment_immutable_binding (const char *, SCM, SCM) SCM_NORETURN;
 105 SCM_API void scm_error_environment_immutable_location (const char *, SCM, SCM) SCM_NORETURN;
 106
 107 SCM_API SCM scm_make_environment (void *type);
 108 SCM_API SCM scm_environment_p (SCM env);
 109 SCM_API SCM scm_environment_bound_p (SCM env, SCM sym);
 110 SCM_API SCM scm_environment_ref (SCM env, SCM sym);
 111 SCM_API SCM scm_c_environment_ref (SCM env, SCM sym);
 112 SCM_API SCM scm_environment_fold (SCM env, SCM proc, SCM init);
 113 SCM_API SCM scm_c_environment_fold (SCM env, scm_environment_folder proc, SCM data, SCM init);
 114 SCM_API SCM scm_environment_define (SCM env, SCM sym, SCM val);
 115 SCM_API SCM scm_environment_undefine (SCM env, SCM sym);
 116 SCM_API SCM scm_environment_set_x (SCM env, SCM sym, SCM val);
 117 SCM_API SCM scm_environment_cell (SCM env, SCM sym, SCM for_write);
 118 SCM_API SCM scm_c_environment_cell (SCM env, SCM sym, int for_write);
 119 SCM_API SCM scm_environment_observe (SCM env, SCM proc);
 120 SCM_API SCM scm_environment_observe_weak (SCM env, SCM proc);
 121 SCM_API SCM scm_c_environment_observe (SCM env, scm_environment_observer proc, SCM data, int weak_p);
 122 SCM_API SCM scm_environment_unobserve (SCM token);
 123
 124 SCM_INTERNAL void scm_environments_prehistory (void);
 125 SCM_INTERNAL void scm_init_environments (void);
 126
 127 \f
 128
 129 SCM_API void *scm_type_leaf_environment;
 130
 131 #define SCM_LEAF_ENVIRONMENT_P(env) \
 132   (SCM_ENVIRONMENT_P (env) \
 133    && SCM_ENVIRONMENT_FUNCS (env) == scm_type_leaf_environment)
 134
 135 SCM_API SCM scm_make_leaf_environment (void);
 136 SCM_API SCM scm_leaf_environment_p (SCM env);
 137
 138 \f
 139
 140 SCM_API void *scm_type_eval_environment;
 141
 142 #define SCM_EVAL_ENVIRONMENT_P(env) \
 143   (SCM_ENVIRONMENT_P (env) \
 144    && SCM_ENVIRONMENT_FUNCS (env) == scm_type_eval_environment)
 145
 146 SCM_API SCM scm_make_eval_environment (SCM local, SCM imported);
 147 SCM_API SCM scm_eval_environment_p (SCM env);
 148 SCM_API SCM scm_eval_environment_local (SCM env);
 149 SCM_API SCM scm_eval_environment_set_local_x (SCM env, SCM local);
 150 SCM_API SCM scm_eval_environment_imported (SCM env);
 151 SCM_API SCM scm_eval_environment_set_imported_x (SCM env, SCM imported);
 152
 153 \f
 154
 155 SCM_API void *scm_type_import_environment;
 156
 157 #define SCM_IMPORT_ENVIRONMENT_P(env) \
 158   (SCM_ENVIRONMENT_P (env) \
 159    && SCM_ENVIRONMENT_FUNCS (env) == scm_type_import_environment)
 160
 161 SCM_API SCM scm_make_import_environment (SCM imports, SCM conflict_proc);
 162 SCM_API SCM scm_import_environment_p (SCM env);
 163 SCM_API SCM scm_import_environment_imports (SCM env);
 164 SCM_API SCM scm_import_environment_set_imports_x (SCM env, SCM imports);
 165
 166 \f
 167
 168 SCM_API void *scm_type_export_environment;
 169
 170 #define SCM_EXPORT_ENVIRONMENT_P(env) \
 171   (SCM_ENVIRONMENT_P (env) \
 172    && SCM_ENVIRONMENT_FUNCS (env) == scm_type_export_environment)
 173
 174 SCM_API SCM scm_make_export_environment (SCM private, SCM signature);
 175 SCM_API SCM scm_export_environment_p (SCM env);
 176 SCM_API SCM scm_export_environment_private (SCM env);
 177 SCM_API SCM scm_export_environment_set_private_x (SCM env, SCM private);
 178 SCM_API SCM scm_export_environment_signature (SCM env);
 179 SCM_API SCM scm_export_environment_set_signature_x (SCM env, SCM signature);
 180
 181 #endif  /* SCM_ENVIRONMENTS_H */
 182
 183 /*
 184   Local Variables:
 185   c-file-style: "gnu"
 186   End:
 187 */