]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/context-scheme.cc
Doc: scm - Clarify ly:context-pushpop-property
[lilypond.git] / lily / context-scheme.cc
index 96193f65e7ccbe05eec5d147c876ee4036334557..feda0f607eab62fffb45c2d770277b12114e814d 100644 (file)
@@ -1,23 +1,47 @@
 /*
-  context-scheme.cc -- Context bindings
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
-
-  (c) 1998--2008 Jan Nieuwenhuizen <janneke@gnu.org>
+  Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   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 "context.hh"
 #include "context-def.hh"
 #include "dispatcher.hh"
+#include "grob-properties.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{}}"
-          " return the string @code{one}.")
+           1, 0, 0, (SCM context),
+           "Return the ID string of @var{context},"
+           " i.e., for @code{\\context Voice = \"one\" @dots{}}"
+           " return the string @code{one}.")
 {
-  Context *tr = unsmob_context (context);
+  Context *tr = unsmob<Context> (context);
 
   LY_ASSERT_SMOB (Context, context, 1);
 
@@ -25,39 +49,39 @@ 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{}}"
-          " return the symbol @code{Voice}.")
+           1, 0, 0, (SCM context),
+           "Return the name of @var{context},"
+           " i.e., for @code{\\context Voice = \"one\" @dots{}}"
+           " return the symbol @code{Voice}.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
 
-  Context *tr = unsmob_context (context);
+  Context *tr = unsmob<Context> (context);
 
   return ly_symbol2scm (tr->context_name ().c_str ());
 }
 
 LY_DEFINE (ly_context_grob_definition, "ly:context-grob-definition",
-          2, 0, 0, (SCM context, SCM name),
-          "Return the definition of @var{name} (a symbol) within"
-          " @var{context} as an alist.")
+           2, 0, 0, (SCM context, SCM name),
+           "Return the definition of @var{name} (a symbol) within"
+           " @var{context} as an alist.")
 {
-  Context *tr = unsmob_context (context);
-  
+  Context *tr = unsmob<Context> (context);
+
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
 
-  return updated_grob_properties (tr, name);
+  return Grob_property_info (tr, name).updated ();
 }
 
 LY_DEFINE (ly_context_pushpop_property, "ly:context-pushpop-property",
-          3, 1, 0, (SCM context, SCM grob, SCM eltprop, SCM val),
-          "Do a single @code{\\override} or @code{\\revert} operation"
-          " in @var{context}.  The grob definition @var{grob} is extended"
-          " with @var{eltprop} (if @var{val} is specified) or reverted"
-          " (if unspecified).")
+           3, 1, 0, (SCM context, SCM grob, SCM eltprop, SCM val),
+           "Do @code{\\temporary \\override} or @code{\\revert} operation"
+           " in @var{context}.  The grob definition @var{grob} is extended"
+           " with @var{eltprop} (if @var{val} is specified) or reverted"
+           " (if unspecified).")
 {
-  Context *tg = unsmob_context (context);
+  Context *tg = unsmob<Context> (context);
 
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, grob, 2);
@@ -68,26 +92,42 @@ LY_DEFINE (ly_context_pushpop_property, "ly:context-pushpop-property",
   return SCM_UNSPECIFIED;
 }
 
+LY_DEFINE (ly_context_matched_pop_property, "ly:context-matched-pop-property",
+           3, 0, 0, (SCM context, SCM grob, SCM cell),
+           "This undoes a particular @code{\\override},"
+           " @code{\\once \\override} or @code{\\once \\revert}"
+           " when given the specific alist pair to undo.")
+{
+  Context *tg = LY_ASSERT_SMOB (Context, context, 1);
+  LY_ASSERT_TYPE (ly_is_symbol, grob, 2);
+  Grob_property_info (tg, grob).matched_pop (cell);
+  return SCM_UNSPECIFIED;
+}
+
+
 LY_DEFINE (ly_context_property, "ly:context-property",
-          2, 0, 0, (SCM c, SCM name),
-          "Return the value of @var{name} from context @var{c}.")
+           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, c, 1);
-  LY_ASSERT_TYPE (ly_is_symbol, name, 2);
+  LY_ASSERT_SMOB (Context, context, 1);
+  LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
 
-  Context *t = unsmob_context (c);
-  return t->internal_get_property (name);
+  Context *t = unsmob<Context> (context);
+  SCM result = t->get_property (sym);
+  return !SCM_UNBNDP (def) && scm_is_null (result) ? def : result;
 }
 
 LY_DEFINE (ly_context_set_property_x, "ly:context-set-property!",
-          3, 0, 0, (SCM context, SCM name, SCM val),
-          "Set value of property @var{name} in context @var{context}"
-          " to @var{val}.")
+           3, 0, 0, (SCM context, SCM name, SCM val),
+           "Set value of property @var{name} in context @var{context}"
+           " to @var{val}.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
 
-  Context *tr = unsmob_context (context);
+  Context *tr = unsmob<Context> (context);
 
   tr->set_property (name, val);
 
@@ -95,14 +135,14 @@ LY_DEFINE (ly_context_set_property_x, "ly:context-set-property!",
 }
 
 LY_DEFINE (ly_context_property_where_defined, "ly:context-property-where-defined",
-          2, 0, 0, (SCM context, SCM name),
-          "Return the context above @var{context}"
-          " where @var{name} is defined.")
+           2, 0, 0, (SCM context, SCM name),
+           "Return the context above @var{context}"
+           " where @var{name} is defined.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
-  
-  Context *tr = unsmob_context (context);
+
+  Context *tr = unsmob<Context> (context);
 
   SCM val;
   tr = tr->where_defined (name, &val);
@@ -113,23 +153,23 @@ LY_DEFINE (ly_context_property_where_defined, "ly:context-property-where-defined
 }
 
 LY_DEFINE (ly_context_unset_property, "ly:context-unset-property", 2, 0, 0,
-          (SCM context, SCM name),
-          "Unset value of property @var{name} in context @var{context}.")
+           (SCM context, SCM name),
+           "Unset value of property @var{name} in context @var{context}.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
-  Context *tr = unsmob_context (context);
-  
+  Context *tr = unsmob<Context> (context);
+
   tr->unset_property (name);
   return SCM_UNSPECIFIED;
 }
 
 LY_DEFINE (ly_context_parent, "ly:context-parent",
-          1, 0, 0, (SCM context),
-          "Return the parent of @var{context}, @code{#f} if none.")
+           1, 0, 0, (SCM context),
+           "Return the parent of @var{context}, @code{#f} if none.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
-  Context *tr = unsmob_context (context);
+  Context *tr = unsmob<Context> (context);
 
   tr = tr->get_parent_context ();
   if (tr)
@@ -140,18 +180,18 @@ LY_DEFINE (ly_context_parent, "ly:context-parent",
 
 /* FIXME: todo: should support translator IDs, and creation? */
 LY_DEFINE (ly_context_find, "ly:context-find",
-          2, 0, 0, (SCM context, SCM name),
-          "Find a parent of @var{context} that has name or alias @var{name}."
-          "  Return @code{#f} if not found.")
+           2, 0, 0, (SCM context, SCM name),
+           "Find a parent of @var{context} that has name or alias @var{name}."
+           "  Return @code{#f} if not found.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
-  Context *tr = unsmob_context (context);
+  Context *tr = unsmob<Context> (context);
 
   while (tr)
     {
       if (tr->is_alias (name))
-       return tr->self_scm ();
+        return tr->self_scm ();
       tr = tr->get_parent_context ();
     }
 
@@ -159,11 +199,11 @@ LY_DEFINE (ly_context_find, "ly:context-find",
 }
 
 LY_DEFINE (ly_context_now, "ly:context-now",
-          1, 0, 0, (SCM context),
-          "Return @code{now-moment} of context @var{context}.")
+           1, 0, 0, (SCM context),
+           "Return @code{now-moment} of context @var{context}.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
-  Context *ctx = unsmob_context (context);
+  Context *ctx = unsmob<Context> (context);
   return ctx->now_mom ().smobbed_copy ();
 }
 
@@ -172,7 +212,7 @@ LY_DEFINE (ly_context_event_source, "ly:context-event-source",
            "Return @code{event-source} of context @var{context}.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
-  Context *ctx = unsmob_context (context);
+  Context *ctx = unsmob<Context> (context);
   return ctx->event_source ()->self_scm ();
 }
 
@@ -182,6 +222,6 @@ LY_DEFINE (ly_context_events_below, "ly:context-events-below",
            " from @var{context} and all its subcontexts.")
 {
   LY_ASSERT_SMOB (Context, context, 1);
-  Context *ctx = unsmob_context (context);
+  Context *ctx = unsmob<Context> (context);
   return ctx->events_below ()->self_scm ();
 }