Run grand-replace (issue 3765)

[lilypond.git] / lily / ly-module.cc

diff --git a/lily/ly-module.cc b/lily/ly-module.cc
index 42ff2f8b063c85d514f2c27d5dc8e97135aa4f23..8023947c1e70b0d500350cae23efb8548ffa017e 100644 (file)
--- a/lily/ly-module.cc
+++ b/lily/ly-module.cc
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2002--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 2002--2014 Han-Wen Nienhuys <hanwen@xs4all.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
@@ -23,50 +23,68 @@
 #include "std-string.hh"
 #include "protected-scm.hh"
 
-
 SCM
 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");
+      /* Look up (evaluate) Scheme make-module function and call it */
 
+      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);
     }
 
-
   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__
 
-
-
 SCM
 ly_module_symbols (SCM mod)
 {
@@ -78,9 +96,9 @@ ly_module_symbols (SCM mod)
 
 static SCM
 entry_to_alist (void * /* closure */,
-               SCM key,
-               SCM val,
-               SCM result)
+                SCM key,
+                SCM val,
+                SCM result)
 {
   if (scm_variable_bound_p (val) == SCM_BOOL_T)
     return scm_cons (scm_cons (key, scm_variable_ref (val)), result);
@@ -89,14 +107,14 @@ entry_to_alist (void * /* closure */,
 }
 
 LY_DEFINE (ly_module_2_alist, "ly:module->alist",
-          1, 0, 0, (SCM mod),
-          "Dump the contents of module @var{mod} as an 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 ((scm_t_hash_fold_fn) &entry_to_alist,
-                                NULL, SCM_EOL, obarr);
+                                 NULL, SCM_EOL, obarr);
 }
 
 void