Doc: scm - Clarify ly:context-pushpop-property

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

diff --git a/lily/context-scheme.cc b/lily/context-scheme.cc
index 1559d67e0157255698640830bcd2e15ccb46a504..feda0f607eab62fffb45c2d770277b12114e814d 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--2014 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
@@ -21,13 +21,14 @@
 #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);
+  Context *tr = unsmob<Context> (context);
 
   LY_ASSERT_SMOB (Context, context, 1);
 
@@ -40,7 +41,7 @@ LY_DEFINE (ly_context_id, "ly:context-id",
            " 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);
 
@@ -55,7 +56,7 @@ LY_DEFINE (ly_context_name, "ly:context-name",
 {
   LY_ASSERT_SMOB (Context, context, 1);
 
-  Context *tr = unsmob_context (context);
+  Context *tr = unsmob<Context> (context);
 
   return ly_symbol2scm (tr->context_name ().c_str ());
 }
@@ -65,22 +66,22 @@ LY_DEFINE (ly_context_grob_definition, "ly:context-grob-definition",
            "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"
+           "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);
@@ -91,6 +92,19 @@ 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, 1, 0, (SCM context, SCM sym, SCM def),
            "Return the value for property @var{sym} in @var{context}."
@@ -100,9 +114,9 @@ LY_DEFINE (ly_context_property, "ly:context-property",
   LY_ASSERT_SMOB (Context, context, 1);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
 
-  Context *t = unsmob_context (context);
-  SCM result = t->internal_get_property (sym);
-  return def != SCM_UNDEFINED && scm_is_null (result) ? def : result;
+  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!",
@@ -113,7 +127,7 @@ LY_DEFINE (ly_context_set_property_x, "ly:context-set-property!",
   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);
 
@@ -128,7 +142,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);
+  Context *tr = unsmob<Context> (context);
 
   SCM val;
   tr = tr->where_defined (name, &val);
@@ -144,7 +158,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);
+  Context *tr = unsmob<Context> (context);
 
   tr->unset_property (name);
   return SCM_UNSPECIFIED;
@@ -155,7 +169,7 @@ LY_DEFINE (ly_context_parent, "ly:context-parent",
            "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)
@@ -172,7 +186,7 @@ LY_DEFINE (ly_context_find, "ly:context-find",
 {
   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)
     {
@@ -189,7 +203,7 @@ LY_DEFINE (ly_context_now, "ly:context-now",
            "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 ();
 }
 
@@ -198,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 ();
 }
 
@@ -208,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 ();
 }