libguile/modules.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_MODULES_H
   4 #define SCM_MODULES_H
   5
   6 /* Copyright (C) 1998, 2000, 2001 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 #include "libguile/validate.h"
  52
  53 \f
  54
  55 SCM_API int scm_module_system_booted_p;
  56 SCM_API scm_t_bits scm_module_tag;
  57
  58 #define SCM_MODULEP(OBJ) \
  59   (!SCM_IMP (OBJ) && SCM_CELL_TYPE (OBJ) == scm_module_tag)
  60
  61 #define SCM_VALIDATE_MODULE(pos, scm) SCM_MAKE_VALIDATE (pos, scm, MODULEP)
  62
  63 /* NOTE: Indexes of module fields are dependent upon the definition of
  64  *       module-type in boot-9.scm.
  65  */
  66
  67 #define scm_module_index_obarray        0
  68 #define scm_module_index_uses           1
  69 #define scm_module_index_binder         2
  70 #define scm_module_index_eval_closure   3
  71 #define scm_module_index_transformer    4
  72
  73 #define SCM_MODULE_OBARRAY(module) \
  74   SCM_PACK (SCM_STRUCT_DATA (module) [scm_module_index_obarray])
  75 #define SCM_MODULE_USES(module) \
  76   SCM_PACK (SCM_STRUCT_DATA (module) [scm_module_index_uses])
  77 #define SCM_MODULE_BINDER(module) \
  78   SCM_PACK (SCM_STRUCT_DATA (module) [scm_module_index_binder])
  79 #define SCM_MODULE_EVAL_CLOSURE(module) \
  80   SCM_PACK (SCM_STRUCT_DATA (module)[scm_module_index_eval_closure])
  81 #define SCM_MODULE_TRANSFORMER(module) \
  82   SCM_PACK (SCM_STRUCT_DATA (module)[scm_module_index_transformer])
  83
  84 SCM_API scm_t_bits scm_tc16_eval_closure;
  85
  86 #define SCM_EVAL_CLOSURE_P(x)   SCM_TYP16_PREDICATE (scm_tc16_eval_closure, x)
  87
  88 \f
  89
  90 SCM_API SCM scm_current_module (void);
  91 SCM_API SCM scm_interaction_environment (void);
  92 SCM_API SCM scm_set_current_module (SCM module);
  93
  94 SCM_API SCM scm_c_call_with_current_module (SCM module,
  95                                             SCM (*func)(void *), void *data);
  96
  97 SCM_API SCM scm_c_lookup (const char *name);
  98 SCM_API SCM scm_c_define (const char *name, SCM val);
  99 SCM_API SCM scm_lookup (SCM symbol);
 100 SCM_API SCM scm_define (SCM symbol, SCM val);
 101
 102 SCM_API SCM scm_c_module_lookup (SCM module, const char *name);
 103 SCM_API SCM scm_c_module_define (SCM module, const char *name, SCM val);
 104 SCM_API SCM scm_module_lookup (SCM module, SCM symbol);
 105 SCM_API SCM scm_module_define (SCM module, SCM symbol, SCM val);
 106 SCM_API SCM scm_module_reverse_lookup (SCM module, SCM variable);
 107
 108 SCM_API SCM scm_c_resolve_module (const char *name);
 109 SCM_API SCM scm_resolve_module (SCM name);
 110 SCM_API SCM scm_c_define_module (const char *name,
 111                                  void (*init)(void *), void *data);
 112 SCM_API void scm_c_use_module (const char *name);
 113 SCM_API void scm_c_export (const char *name, ...);
 114
 115 SCM_API SCM scm_sym2var (SCM sym, SCM thunk, SCM definep);
 116
 117 SCM_API SCM scm_module_lookup_closure (SCM module);
 118 SCM_API SCM scm_module_transformer (SCM module);
 119 SCM_API SCM scm_current_module_lookup_closure (void);
 120 SCM_API SCM scm_current_module_transformer (void);
 121 SCM_API SCM scm_eval_closure_lookup (SCM eclo, SCM sym, SCM definep);
 122 SCM_API SCM scm_standard_eval_closure (SCM module);
 123 SCM_API SCM scm_standard_interface_eval_closure (SCM module);
 124 SCM_API SCM scm_get_pre_modules_obarray (void);
 125 SCM_API SCM scm_lookup_closure_module (SCM proc);
 126
 127 SCM_API SCM scm_env_top_level (SCM env);
 128 SCM_API SCM scm_env_module (SCM env);
 129 SCM_API SCM scm_top_level_env (SCM thunk);
 130 SCM_API SCM scm_system_module_env_p (SCM env);
 131
 132 SCM_API void scm_modules_prehistory (void);
 133 SCM_API void scm_init_modules (void);
 134
 135 #endif  /* SCM_MODULES_H */
 136
 137 /*
 138   Local Variables:
 139   c-file-style: "gnu"
 140   End:
 141 */