]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/ly-module.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / ly-module.cc
index b2d04f4185157bdfc3d8137501d15b48dd8f6b90..8023947c1e70b0d500350cae23efb8548ffa017e 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--2014 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 "warn.hh"
 #include "main.hh"
-#include "string.hh"
+#include "std-string.hh"
 #include "protected-scm.hh"
 
-#ifdef MODULE_GC_KLUDGE
-Protected_scm anonymous_modules = SCM_EOL;
-#endif
-
-
-void
-clear_anonymous_modules ()
-{
-  for (SCM s = anonymous_modules;
-       scm_is_pair (s);
-       s = scm_cdr (s))
-    {
-      SCM module = scm_car (s);
-      SCM closure = SCM_MODULE_EVAL_CLOSURE(module);
-      SCM prop = scm_procedure_property (closure, ly_symbol2scm ("module")); 
-
-      if (ly_is_module (prop))
-       {
-         scm_set_procedure_property_x (closure, ly_symbol2scm ("module"),
-                                       SCM_BOOL_F);
-       }
-    }
-
-  anonymous_modules = SCM_EOL;
-}
-
 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");
+      /* Look up (evaluate) Scheme make-module function and call it */
 
-      SCM scm_module = ly_lily_module_constant ("the-scm-module");
-      
+      SCM maker = ly_lily_module_constant ("make-module");
       mod = scm_call_0 (maker);
-      scm_module_define (mod, ly_symbol2scm ("%module-public-interface"),
-                        mod);
-      
+      /*
+        Look up and call Guile module-export-all! or, when using
+        Guile V1.8, the compatible shim defined in lily.scm.
+      */
+      SCM module_export_all_x = ly_lily_module_constant ("module-export-all!");
+      scm_call_1 (module_export_all_x, mod);
+
+      /*
+        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
+      */
+      SCM scm_module = ly_lily_module_constant ("the-root-module");
       ly_use_module (mod, scm_module);
       ly_use_module (mod, global_lily_module);
     }
   else
     {
+      /* Evaluate and call make-safe-lilypond-module */
       SCM proc = ly_lily_module_constant ("make-safe-lilypond-module");
       mod = scm_call_0 (proc);
     }
 
-#ifdef MODULE_GC_KLUDGE
-  anonymous_modules = scm_cons (mod, anonymous_modules);
-#endif
-  
   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));
-
+  /*
+    Pick up the module's interface definition.
+    TODO - Replace inline evaluations (interpreted)
+    with guile API calls if these become available.
+  */
+  SCM scm_module_use = ly_symbol2scm ("module-use!");
+  SCM scm_module_public_interface = ly_symbol2scm ("module-public-interface");
+  SCM iface = scm_list_2 (scm_module_public_interface, used);
+  /*
+    Set up to interpret
+    '(module_use! <mod> (module-public-interface <used>))'
+  */
+  SCM expr = scm_list_3 (scm_module_use, mod, iface);
+  /*
+    Now return SCM value, this is the result of interpreting
+    '(eval (module-use! <mod> (module-public-interface <used>)) "lily")'
+  */
   return scm_eval (expr, global_lily_module);
 }
 
 #define FUNC_NAME __FUNCTION__
 
-
-
-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_closure_function) & 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)
     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_closure_function) & entry_to_alist, NULL, SCM_EOL, obarr);
+  return scm_internal_hash_fold ((scm_t_hash_fold_fn) &entry_to_alist,
+                                 NULL, SCM_EOL, obarr);
 }
 
 void
@@ -137,36 +132,3 @@ ly_reexport_module (SCM mod)
 {
   ly_export (mod, ly_module_symbols (mod));
 }
-
-
-
-#ifdef MODULE_GC_KLUDGE
-static SCM
-redefine_keyval (void *closure, SCM key, SCM val, SCM result)
-{
-  (void)closure;
-  SCM new_tab = result;
-  scm_hashq_set_x (new_tab, key, val);
-  return new_tab;
-}
-
-/*
-  UGH UGH.
-  Kludge for older GUILE 1.6 versions.
- */
-void
-make_stand_in_procs_weak ()
-{
-  SCM old_tab = scm_stand_in_procs;
-  SCM new_tab = scm_make_weak_key_hash_table (scm_from_int (257));
-  
-  new_tab = scm_internal_hash_fold ((Hash_closure_function) &redefine_keyval,
-                                   NULL,
-                                   new_tab,
-                                   old_tab);
-
-  scm_stand_in_procs = new_tab;
-}
-
-ADD_SCM_INIT_FUNC(make_stand_in_procs_weak, make_stand_in_procs_weak);
-#endif