]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/ly-module.cc
Doc-es: various updates.
[lilypond.git] / lily / ly-module.cc
index 7d613fcdd8ad87251ff29bacb433f05c515026c3..2076168fda75ac9ad9c73004d611bb24ebc881af 100644 (file)
 /*
-  ly-module.cc -- implement guile module stuff.
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2002--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2002--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "lily-guile.hh"
+#include "ly-module.hh"
 #include "warn.hh"
 #include "main.hh"
-#include "string.hh"
-
-#define FUNC_NAME __FUNCTION__
+#include "protected-scm.hh"
+#include "lily-imports.hh"
 
 SCM
-ly_make_anonymous_module (bool safe)
+ly_make_module (bool safe)
 {
   SCM mod = SCM_EOL;
   if (!safe)
     {
-      SCM maker = ly_lily_module_constant ("make-module");
-
-      SCM scm_module = ly_lily_module_constant ("the-scm-module");
-      
-      mod = scm_call_0 (maker);
-      scm_module_define (mod, ly_symbol2scm ("%module-public-interface"),
-                        mod);
-      
-      ly_use_module (mod, scm_module);
-      ly_use_module (mod, global_lily_module);
+      /* Look up (evaluate) Scheme make-module function and call it */
+
+      mod = Guile_user::make_module ();
+      /*
+        Look up and call Guile module-export-all! or, when using
+        Guile V1.8, the compatible shim defined in lily.scm.
+      */
+#if GUILEV2
+      Guile_user::module_export_all_x (mod);
+#else
+      Lily::module_export_all_x (mod);
+#endif
+
+      /*
+        Evaluate Guile module "the-root-module",
+        and ensure we inherit definitions from it and the "lily" module
+        N.B. this used to be "the-scm-module" and is deprecated in
+        Guile V1.9/2.0
+      */
+
+      ly_use_module (mod, Guile_user::the_root_module);
+      ly_use_module (mod, Lily::module);
     }
   else
     {
-      SCM proc = ly_lily_module_constant ("make-safe-lilypond-module");
-      mod = scm_call_0 (proc);
+      /* Evaluate and call make-safe-lilypond-module */
+      mod = Lily::make_safe_lilypond_module ();
     }
+
   return mod;
 }
 
 SCM
 ly_use_module (SCM mod, SCM used)
 {
-  SCM expr
-    = scm_list_3 (ly_symbol2scm ("module-use!"),
-                 mod,
-                 scm_list_2 (ly_symbol2scm ("module-public-interface"),
-                             used));
-
-  return scm_eval (expr, global_lily_module);
+  /*
+    Pick up the module's interface definition.
+    TODO - Replace inline evaluations (interpreted)
+    with guile API calls if these become available.
+  */
+  /*
+    Set up to interpret
+    '(module_use! <mod> (module-public-interface <used>))'
+  */
+  return Guile_user::module_use_x (mod,
+                                   Guile_user::module_public_interface (used));
 }
 
 #define FUNC_NAME __FUNCTION__
 
-static SCM
-module_define_closure_func (void *closure, SCM key, SCM val, SCM result)
-{
-  (void) result;
-  SCM module = (SCM) closure;
-  if (scm_variable_bound_p (val) == SCM_BOOL_T)
-    scm_module_define (module, key, scm_variable_ref (val));
-  return SCM_EOL;
-}
-
-/* Ugh signature of scm_internal_hash_fold () is inaccurate.  */
-typedef SCM (*Hash_cl_func) ();
-
-/*
-  If a variable in changed in SRC, we DEST doesn't see the
-  definitions.
-*/
-LY_DEFINE (ly_module_copy, "ly:module-copy",
-          2, 0, 0, (SCM dest, SCM src),
-          "Copy all bindings from module SRC into DEST.")
-{
-  SCM_VALIDATE_MODULE (1, src);
-  scm_internal_hash_fold ((Hash_cl_func) & module_define_closure_func,
-                         (void *) dest,
-                         SCM_EOL, SCM_MODULE_OBARRAY (src));
-  return SCM_UNSPECIFIED;
-}
-
-static SCM
-accumulate_symbol (void *closure, SCM key, SCM val, SCM result)
-{
-  (void) closure;
-  (void) val;
-  return scm_cons (key, result);
-}
-
 SCM
 ly_module_symbols (SCM mod)
 {
   SCM_VALIDATE_MODULE (1, mod);
 
   SCM obarr = SCM_MODULE_OBARRAY (mod);
-  return scm_internal_hash_fold ((Hash_cl_func) & accumulate_symbol,
-                                NULL, SCM_EOL, obarr);
+  return ly_hash_table_keys (obarr);
 }
 
 static SCM
-entry_to_alist (void *closure, SCM key, SCM val, SCM result)
+entry_to_alist (void * /* closure */,
+                SCM key,
+                SCM val,
+                SCM result)
 {
-  (void) closure;
-  if (scm_variable_bound_p (val) == SCM_BOOL_T)
+  if (to_boolean (scm_variable_bound_p (val)))
     return scm_cons (scm_cons (key, scm_variable_ref (val)), result);
   programming_error ("unbound variable in module");
   return result;
 }
 
-LY_DEFINE (ly_module2alist, "ly:module->alist",
-          1, 0, 0, (SCM mod),
-          "Dump the contents of  module @var{mod} as an alist.")
+LY_DEFINE (ly_module_2_alist, "ly:module->alist",
+           1, 0, 0, (SCM mod),
+           "Dump the contents of module @var{mod} as an alist.")
 {
   SCM_VALIDATE_MODULE (1, mod);
   SCM obarr = SCM_MODULE_OBARRAY (mod);
 
-  return scm_internal_hash_fold ((Hash_cl_func) & entry_to_alist, NULL, SCM_EOL, obarr);
-}
-
-/* Lookup SYM, but don't give error when it is not defined.  */
-SCM
-ly_module_lookup (SCM module, SCM sym)
-{
-#define FUNC_NAME __FUNCTION__
-  SCM_VALIDATE_MODULE (1, module);
-
-  return scm_sym2var (sym, scm_module_lookup_closure (module), SCM_BOOL_F);
-#undef FUNC_NAME
-}
-
-/* Lookup SYM in a list of modules, which do not have to be related.
-   Return the first instance. */
-LY_DEFINE (ly_modules_lookup, "ly:modules-lookup",
-          2, 1, 0,
-          (SCM modules, SCM sym, SCM def),
-          "Lookup @var{sym} in the list @var{modules}, "
-          "returning the first occurence.  "
-          "If not found, return @var{default}, or @code{#f}.")
-{
-  for (SCM s = modules; scm_is_pair (s); s = scm_cdr (s))
-    {
-      SCM mod = scm_car (s);
-      SCM v = ly_module_lookup (mod, sym);
-      if (SCM_VARIABLEP (v) && SCM_VARIABLE_REF (v) != SCM_UNDEFINED)
-       return scm_variable_ref (v);
-    }
-
-  if (def != SCM_UNDEFINED)
-    return def;
-  return SCM_BOOL_F;
+  return scm_internal_hash_fold ((scm_t_hash_fold_fn) &entry_to_alist,
+                                 NULL, SCM_EOL, obarr);
 }
 
 void
 ly_export (SCM module, SCM namelist)
 {
-  static SCM export_function;
-  if (!export_function)
-    export_function = scm_permanent_object (scm_c_lookup ("module-export!"));
-
-  scm_call_2 (SCM_VARIABLE_REF (export_function), module, namelist);
+  Guile_user::module_export_x (module, namelist);
 }
 
 void