libguile/modules.h

   1 /* classes: h_files */
   2
   3 #ifndef MODULESH
   4 #define MODULESH
   5 /*      Copyright (C) 1998, 2000 Free Software Foundation, Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this software; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307 USA
  21  *
  22  * As a special exception, the Free Software Foundation gives permission
  23  * for additional uses of the text contained in its release of GUILE.
  24  *
  25  * The exception is that, if you link the GUILE library with other files
  26  * to produce an executable, this does not by itself cause the
  27  * resulting executable to be covered by the GNU General Public License.
  28  * Your use of that executable is in no way restricted on account of
  29  * linking the GUILE library code into it.
  30  *
  31  * This exception does not however invalidate any other reasons why
  32  * the executable file might be covered by the GNU General Public License.
  33  *
  34  * This exception applies only to the code released by the
  35  * Free Software Foundation under the name GUILE.  If you copy
  36  * code from other Free Software Foundation releases into a copy of
  37  * GUILE, as the General Public License permits, the exception does
  38  * not apply to the code that you add in this way.  To avoid misleading
  39  * anyone as to the status of such modified files, you must delete
  40  * this exception notice from them.
  41  *
  42  * If you write modifications of your own for GUILE, it is your choice
  43  * whether to permit this exception to apply to your modifications.
  44  * If you do not wish that, delete this exception notice.  */
  45 \f
  46
  47 #include "libguile/__scm.h"
  48
  49 #include "libguile/validate.h"
  50
  51 \f
  52
  53 extern int scm_module_system_booted_p;
  54 extern SCM scm_module_tag;
  55
  56 #define SCM_MODULEP(OBJ) \
  57   (SCM_NIMP (OBJ) && SCM_CELL_TYPE (OBJ) == scm_module_tag)
  58
  59 #define SCM_VALIDATE_MODULE(pos, scm) SCM_MAKE_VALIDATE (pos, scm, MODULEP)
  60
  61 /* NOTE: Indexes of module fields are dependent upon the definition of
  62  *       module-type in boot-9.scm.
  63  */
  64
  65 #define scm_module_index_obarray        0
  66 #define scm_module_index_uses           1
  67 #define scm_module_index_binder         2
  68 #define scm_module_index_eval_closure   3
  69 #define scm_module_index_transformer    4
  70
  71 #define SCM_MODULE_OBARRAY(module) \
  72   SCM_PACK (SCM_STRUCT_DATA (module) [scm_module_index_obarray])
  73 #define SCM_MODULE_USES(module) \
  74   SCM_PACK (SCM_STRUCT_DATA (module) [scm_module_index_uses])
  75 #define SCM_MODULE_BINDER(module) \
  76   SCM_PACK (SCM_STRUCT_DATA (module) [scm_module_index_binder])
  77 #define SCM_MODULE_EVAL_CLOSURE(module) \
  78   SCM_PACK (SCM_STRUCT_DATA (module)[scm_module_index_eval_closure])
  79 #define SCM_MODULE_TRANSFORMER(module) \
  80   SCM_PACK (SCM_STRUCT_DATA (module)[scm_module_index_transformer])
  81
  82 extern scm_bits_t scm_tc16_eval_closure;
  83
  84 #define SCM_EVAL_CLOSURE_P(x)   SCM_TYP16_PREDICATE (scm_tc16_eval_closure, x)
  85
  86 \f
  87
  88 extern SCM scm_current_module (void);
  89 extern SCM scm_interaction_environment (void);
  90 extern SCM scm_set_current_module (SCM module);
  91
  92 extern SCM scm_c_call_with_current_module (SCM module,
  93                                            SCM (*func)(void *), void *data);
  94
  95 extern SCM scm_c_lookup (const char *name);
  96 extern SCM scm_c_define (const char *name, SCM val);
  97 extern SCM scm_lookup (SCM symbol);
  98 extern SCM scm_define (SCM symbol, SCM val);
  99
 100 extern SCM scm_c_module_lookup (SCM module, const char *name);
 101 extern SCM scm_c_module_define (SCM module, const char *name, SCM val);
 102 extern SCM scm_module_lookup (SCM module, SCM symbol);
 103 extern SCM scm_module_define (SCM module, SCM symbol, SCM val);
 104 extern SCM scm_module_reverse_lookup (SCM module, SCM variable);
 105
 106 extern SCM scm_c_resolve_module (const char *name);
 107 extern SCM scm_resolve_module (SCM name);
 108 extern SCM scm_c_define_module (const char *name,
 109                                 void (*init)(void *), void *data);
 110 extern void scm_c_use_module (const char *name);
 111 extern void scm_c_export (const char *name, ...);
 112
 113 extern SCM scm_sym2var (SCM sym, SCM thunk, SCM definep);
 114
 115 extern SCM scm_module_lookup_closure (SCM module);
 116 extern SCM scm_module_transformer (SCM module);
 117 extern SCM scm_current_module_lookup_closure (void);
 118 extern SCM scm_current_module_transformer (void);
 119 extern SCM scm_eval_closure_lookup (SCM eclo, SCM sym, SCM definep);
 120 extern SCM scm_standard_eval_closure (SCM module);
 121 extern SCM scm_standard_interface_eval_closure (SCM module);
 122 extern SCM scm_get_pre_modules_obarray (void);
 123 extern SCM scm_lookup_closure_module (SCM proc);
 124
 125 extern SCM scm_env_top_level (SCM env);
 126 extern SCM scm_env_module (SCM env);
 127 extern SCM scm_top_level_env (SCM thunk);
 128
 129 extern void scm_modules_prehistory (void);
 130 extern void scm_init_modules (void);
 131
 132 #if SCM_DEBUG_DEPRECATED == 0
 133
 134 extern SCM scm_the_root_module (void);
 135 extern SCM scm_make_module (SCM name);
 136 extern SCM scm_ensure_user_module (SCM name);
 137 extern SCM scm_load_scheme_module (SCM name);
 138 extern SCM scm_system_module_env_p (SCM env);
 139
 140 #endif
 141
 142 #endif  /* MODULESH */
 143
 144 /*
 145   Local Variables:
 146   c-file-style: "gnu"
 147   End:
 148 */