Minor documentation improvements for Scheme functions.

[lilypond.git] / lily / simple-closure.cc

diff --git a/lily/simple-closure.cc b/lily/simple-closure.cc
index 8a32a02871c7c42e84c9c0c617253dac7c8cbc91..48d2dab57b39d7da2d466cc45ee85c262cfd43ae 100644 (file)
--- a/lily/simple-closure.cc
+++ b/lily/simple-closure.cc
@@ -1,13 +1,25 @@
 /*
-  closure.cc -- chained closures.
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2005--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2005 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
+  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 "simple-closure.hh"
 
-#include "lily-guile.hh"
+#include "grob.hh"
 
 static scm_t_bits simple_closure_tag;
 
@@ -24,17 +36,18 @@ simple_closure_expression (SCM smob)
   return (SCM) SCM_CELL_WORD_1(smob);
 }
 
-SCM evaluate_with_simple_closure (SCM delayed_argument, SCM expr);
-
 SCM
-evaluate_args (SCM delayed_argument, SCM args)
+evaluate_args (SCM delayed_argument, SCM args, bool pure, int start, int end)
 {
   SCM new_args = SCM_EOL;
   SCM *tail = &new_args;
   for (SCM s = args; scm_is_pair (s); s = scm_cdr (s))
     {
-      *tail = scm_cons (evaluate_with_simple_closure (delayed_argument, scm_car (s)),
+      *tail = scm_cons (evaluate_with_simple_closure (delayed_argument, scm_car (s),
+                                                     pure, start, end),
                        SCM_EOL);
+      if (scm_car (*tail) == SCM_UNSPECIFIED)
+       return SCM_UNSPECIFIED;
       tail = SCM_CDRLOC (*tail);
     }
   
@@ -43,46 +56,76 @@ evaluate_args (SCM delayed_argument, SCM args)
 
 SCM
 evaluate_with_simple_closure (SCM delayed_argument,
-                             SCM expr)
+                             SCM expr,
+                             bool pure,
+                             int start,
+                             int end)
 {
   if (is_simple_closure (expr))
     {
       SCM inside = simple_closure_expression (expr);
-      return scm_apply_1 (scm_car (inside),
-                         delayed_argument,
-                         evaluate_args (delayed_argument, scm_cdr (inside)));
+      SCM args = scm_cons (delayed_argument,
+                          evaluate_args (delayed_argument, scm_cdr (inside),
+                                         pure, start, end));
+      if (scm_cdr (args) == SCM_UNSPECIFIED)
+       return SCM_UNSPECIFIED;
+      if (pure)
+       return call_pure_function (scm_car (inside), args, start, end);
+      return scm_apply_0 (scm_car (inside), args);
     }
   else if (!scm_is_pair (expr))
     return expr;
   else if (scm_car (expr) == ly_symbol2scm ("quote"))
     return scm_cadr (expr);
-  else
+  else if (ly_is_procedure (scm_car (expr)))
     {
-      return scm_apply_0 (scm_car (expr), evaluate_args (delayed_argument, scm_cdr (expr)));
+      SCM args = evaluate_args (delayed_argument, scm_cdr (expr), pure, start, end);
+      if (args == SCM_UNSPECIFIED)
+       return SCM_UNSPECIFIED;
+      if (pure)
+       return call_pure_function (scm_car (expr), args, start, end);
+      return scm_apply_0 (scm_car (expr), args);
     }
-
+  else
+    // ugh. deviation from standard. Should print error? 
+    return evaluate_args (delayed_argument, scm_cdr (expr), pure, start, end); 
+  
   assert (false);
   return SCM_EOL;
 }
 
-LY_DEFINE(ly_simple_closure_p, "ly:simple-closure?",
-         1,0,0, (SCM clos),
-         "Type predicate.")
+LY_DEFINE (ly_simple_closure_p, "ly:simple-closure?",
+         1, 0, 0, (SCM clos),
+         "Is @var{clos} a simple closure?")
 {
   return scm_from_bool (is_simple_closure (clos));
 }
 
-LY_DEFINE(ly_make_simple_closure, "ly:make-simple-closure",
-         0, 0, 1, (SCM expr),
-         "Make a simple closure. @var{expr} should be form of "
-         "@code{(@var{func} @var{a1} @var{A2} ...)}, and will be invoked "
-         "as @code{(@var{func} @var{delayed-arg} @var{a1} @var{a2} ... )}.")
+LY_DEFINE (ly_make_simple_closure, "ly:make-simple-closure",
+         1, 0, 0, (SCM expr),
+         "Make a simple closure.  @var{expr} should be form of"
+         " @code{(@var{func} @var{a1} @var{a2} @dots{})}, and will be"
+         " invoked as @code{(@var{func} @var{delayed-arg} @var{a1}"
+         " @var{a2} @dots{})}.")
 {
   SCM z;
 
-  SCM_NEWSMOB(z, simple_closure_tag, expr);
+  SCM_NEWSMOB (z, simple_closure_tag, expr);
   return z;
 }
+
+LY_DEFINE (ly_eval_simple_closure, "ly:eval-simple-closure",
+         2, 2, 0, (SCM delayed, SCM closure, SCM scm_start, SCM scm_end),
+         "Evaluate a simple @var{closure} with the given @var{delayed}"
+         " argument.  If @var{scm-start} and @var{scm-end} are defined,"
+         " evaluate it purely with those start and end points.")
+{
+  bool pure = (scm_is_number (scm_start) && scm_is_number (scm_end));
+  int start = robust_scm2int (scm_start, 0);
+  int end = robust_scm2int (scm_end, 0);
+  SCM expr = simple_closure_expression (closure);
+  return evaluate_with_simple_closure (delayed, expr, pure, start, end);
+}
  
 int
 print_simple_closure (SCM s, SCM port, scm_print_state *)
@@ -103,4 +146,4 @@ void init_simple_closure ()
 
 
 
-ADD_SCM_INIT_FUNC(simple_closure, init_simple_closure);
+ADD_SCM_INIT_FUNC (simple_closure, init_simple_closure);