Minor documentation improvements for Scheme functions.

[lilypond.git] / lily / context-scheme.cc

diff --git a/lily/context-scheme.cc b/lily/context-scheme.cc
index 5bc3d1d2c55f861f81da8eef36c914f9c653d33a..c18dc911f77dd23b6bc679dae3d88aeb3f9106ba 100644 (file)
--- a/lily/context-scheme.cc
+++ b/lily/context-scheme.cc
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1998--2009 Jan Nieuwenhuizen <janneke@gnu.org>
+  Copyright (C) 1998--2010 Jan Nieuwenhuizen <janneke@gnu.org>
   Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   LilyPond is free software: you can redistribute it and/or modify
@@ -22,10 +22,22 @@
 #include "context-def.hh"
 #include "dispatcher.hh"
 
+LY_DEFINE (ly_context_current_moment,
+          "ly:context-current-moment",
+          1, 0, 0, (SCM context),
+          "Return the current moment of @var{context}.")
+{
+  Context *tr = unsmob_context (context);
+
+  LY_ASSERT_SMOB (Context, context, 1);
+
+  return tr->now_mom ().smobbed_copy ();
+}
+
 LY_DEFINE (ly_context_id, "ly:context-id",
           1, 0, 0, (SCM context),
           "Return the ID string of @var{context},"
-          " i.e., for @code{\\context Voice = one @dots{}}"
+          " i.e., for @code{\\context Voice = \"one\" @dots{}}"
           " return the string @code{one}.")
 {
   Context *tr = unsmob_context (context);
@@ -38,7 +50,7 @@ LY_DEFINE (ly_context_id, "ly:context-id",
 LY_DEFINE (ly_context_name, "ly:context-name",
           1, 0, 0, (SCM context),
           "Return the name of @var{context},"
-          " i.e., for @code{\\context Voice = one @dots{}}"
+          " i.e., for @code{\\context Voice = \"one\" @dots{}}"
           " return the symbol @code{Voice}.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
@@ -54,7 +66,7 @@ LY_DEFINE (ly_context_grob_definition, "ly:context-grob-definition",
           " @var{context} as an alist.")
 {
   Context *tr = unsmob_context (context);
-  
+
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
 
@@ -80,14 +92,17 @@ LY_DEFINE (ly_context_pushpop_property, "ly:context-pushpop-property",
 }
 
 LY_DEFINE (ly_context_property, "ly:context-property",
-          2, 0, 0, (SCM context, SCM sym),
-          "Return the value for property @var{sym} in @var{context}.")
+           2, 1, 0, (SCM context, SCM sym, SCM def),
+           "Return the value for property @var{sym} in @var{context}."
+           " If @var{def} is given, and property value is @code{'()},"
+           " return @var{def}.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
 
   Context *t = unsmob_context (context);
-  return t->internal_get_property (sym);
+  SCM result = t->internal_get_property (sym);
+  return def != SCM_UNDEFINED && scm_is_null (result) ? def : result;
 }
 
 LY_DEFINE (ly_context_set_property_x, "ly:context-set-property!",
@@ -112,7 +127,7 @@ LY_DEFINE (ly_context_property_where_defined, "ly:context-property-where-defined
 {
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
-  
+
   Context *tr = unsmob_context (context);
 
   SCM val;
@@ -130,7 +145,7 @@ LY_DEFINE (ly_context_unset_property, "ly:context-unset-property", 2, 0, 0,
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
   Context *tr = unsmob_context (context);
-  
+
   tr->unset_property (name);
   return SCM_UNSPECIFIED;
 }