]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/engraver-group.cc
Web-ja: update introduction
[lilypond.git] / lily / engraver-group.cc
index 0158c532cd892dbcaf1635539e1695a3f57e6389..c431d10ae13cd35e83e6130e1e8bf09a4ac6a405 100644 (file)
 /*
-  engraver-group.cc -- implement Engraver_group
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2007 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 "dispatcher.hh"
 #include "engraver-group.hh"
+#include "global-context.hh"
 #include "grob.hh"
+#include "grob-properties.hh"
 #include "paper-score.hh"
 #include "translator-dispatch-list.hh"
 #include "warn.hh"
 
-IMPLEMENT_LISTENER (Engraver_group, override);
 void
 Engraver_group::override (SCM sev)
 {
-  Stream_event *ev = unsmob_stream_event (sev);
-  
-  execute_general_pushpop_property (context (),
-                                   ev->get_property ("symbol"),
-                                   ev->get_property ("property-path"),
-                                   ev->get_property ("value"));
+  Stream_event *ev = unsmob<Stream_event> (sev);
+  SCM sym = ev->get_property ("symbol");
+  Grob_property_info gpi (context (), sym);
+
+  if (to_boolean (ev->get_property ("once")))
+    {
+      SCM token = gpi.temporary_override (ev->get_property ("property-path"),
+                                          ev->get_property ("value"));
+      if (scm_is_pair (token))
+        if (Global_context *g = context ()->get_global_context ())
+          {
+            g->add_finalization (scm_list_4 (ly_context_matched_pop_property_proc,
+                                             context ()->self_scm (),
+                                             sym,
+                                             token));
+          }
+    }
+  else
+    gpi.push (ev->get_property ("property-path"),
+              ev->get_property ("value"));
 }
 
-IMPLEMENT_LISTENER (Engraver_group, revert);
 void
 Engraver_group::revert (SCM sev)
 {
-  Stream_event *ev = unsmob_stream_event (sev);
-  
-  execute_general_pushpop_property (context (),
-                                   ev->get_property ("symbol"),
-                                   ev->get_property ("property-path"),
-                                   SCM_UNDEFINED);
+  Stream_event *ev = unsmob<Stream_event> (sev);
+  SCM sym = ev->get_property ("symbol");
+  Grob_property_info gpi (context (), sym);
+
+  if (to_boolean (ev->get_property ("once")))
+    {
+      SCM token = gpi.temporary_revert (ev->get_property ("property-path"));
+      if (scm_is_pair (token))
+        if (Global_context *g = context ()->get_global_context ())
+          {
+            g->add_finalization (scm_list_4 (ly_context_matched_pop_property_proc,
+                                             context ()->self_scm (),
+                                             sym,
+                                             token));
+          }
+    }
+  else
+    gpi.pop (ev->get_property ("property-path"));
 }
 
 void
 Engraver_group::connect_to_context (Context *c)
 {
   Translator_group::connect_to_context (c);
-  c->event_source ()->add_listener (GET_LISTENER (override), ly_symbol2scm ("Override"));
-  c->event_source ()->add_listener (GET_LISTENER (revert), ly_symbol2scm ("Revert"));
+  c->event_source ()->add_listener (GET_LISTENER (Engraver_group, override), ly_symbol2scm ("Override"));
+  c->event_source ()->add_listener (GET_LISTENER (Engraver_group, revert), ly_symbol2scm ("Revert"));
 }
 
 void
 Engraver_group::disconnect_from_context ()
 {
-  context ()->event_source ()->remove_listener (GET_LISTENER (override), ly_symbol2scm ("Override"));
-  context ()->event_source ()->remove_listener (GET_LISTENER (revert), ly_symbol2scm ("Revert"));
+  context ()->event_source ()->remove_listener (GET_LISTENER (Engraver_group, override), ly_symbol2scm ("Override"));
+  context ()->event_source ()->remove_listener (GET_LISTENER (Engraver_group, revert), ly_symbol2scm ("Revert"));
   Translator_group::disconnect_from_context ();
 }
 
 void
-Engraver_group::announce_grob (Grob_info info)
+Engraver_group::announce_grob (Grob_info info, Direction dir,
+                               Context *reroute_context)
 {
-  announce_infos_.push_back (info);
+  announce_infos_.push_back (Announce_grob_info (info, dir));
+
+  Context *dad_con = reroute_context ? reroute_context
+    : context_->get_parent_context ();
 
   Engraver_group *dad_eng
-    = context_->get_parent_context ()
-    ? dynamic_cast<Engraver_group *> (context_->get_parent_context ()->implementation ())
-    : 0;
+    = dad_con
+      ? dynamic_cast<Engraver_group *> (dad_con->implementation ())
+      : 0;
 
   if (dad_eng)
-    dad_eng->announce_grob (info);
+    dad_eng->announce_grob (info, dir);
 }
 
 void
@@ -75,40 +116,38 @@ Engraver_group::acknowledge_grobs ()
     return;
 
   SCM name_sym = ly_symbol2scm ("name");
-  SCM meta_sym = ly_symbol2scm ("meta");
 
   for (vsize j = 0; j < announce_infos_.size (); j++)
     {
-      Grob_info info = announce_infos_[j];
-      
-      SCM meta = info.grob ()->internal_get_property (meta_sym);
+      Announce_grob_info info = announce_infos_[j];
+
+      SCM meta = info.grob ()->get_property ("meta");
       SCM nm = scm_assoc (name_sym, meta);
       if (scm_is_pair (nm))
-       nm = scm_cdr (nm);
+        nm = scm_cdr (nm);
       else
-       continue;
+        continue;
 
-      SCM acklist = scm_hashq_ref (acknowledge_hash_table_drul_[info.start_end()],
-                                  nm, SCM_BOOL_F);
-      
-      Engraver_dispatch_list *dispatch
-       = Engraver_dispatch_list::unsmob (acklist);
+      SCM ackhandle = scm_hashq_create_handle_x (acknowledge_hash_table_drul_[info.start_end ()],
+                                                 nm, SCM_BOOL_F);
+
+      SCM acklist = scm_cdr (ackhandle);
 
-      if (acklist == SCM_BOOL_F)
-       {
-         SCM ifaces
-           = scm_cdr (scm_assoc (ly_symbol2scm ("interfaces"), meta));
-         acklist = Engraver_dispatch_list::create (get_simple_trans_list (),
-                                                   ifaces, info.start_end ());
+      if (scm_is_false (acklist))
+        {
+          SCM ifaces
+            = scm_cdr (scm_assoc (ly_symbol2scm ("interfaces"), meta));
+          acklist = Engraver_dispatch_list::create (get_simple_trans_list (),
+                                                    ifaces, info.start_end ());
 
-         dispatch
-           = Engraver_dispatch_list::unsmob (acklist);
+          scm_set_cdr_x (ackhandle, acklist);
+        }
 
-         scm_hashq_set_x (acknowledge_hash_table_drul_[info.start_end ()], nm, acklist);
-       }
+      Engraver_dispatch_list *dispatch
+        = unsmob<Engraver_dispatch_list> (acklist);
 
       if (dispatch)
-       dispatch->apply (info);
+        dispatch->apply (info);
     }
 }
 
@@ -116,21 +155,22 @@ Engraver_group::acknowledge_grobs ()
   Ugh. This is slightly expensive. We could/should cache the value of
   the group count?
 */
-int
-Engraver_group::pending_grob_count () const
+bool
+Engraver_group::pending_grobs () const
 {
-  int count = announce_infos_.size ();
+  if (!announce_infos_.empty ())
+    return true;
   for (SCM s = context_->children_contexts ();
        scm_is_pair (s); s = scm_cdr (s))
     {
-      Context *c = unsmob_context (scm_car (s));
+      Context *c = unsmob<Context> (scm_car (s));
       Engraver_group *group
-       = dynamic_cast<Engraver_group *> (c->implementation ());
+        = dynamic_cast<Engraver_group *> (c->implementation ());
 
-      if (group)
-       count += group->pending_grob_count ();
+      if (group && group->pending_grobs ())
+        return true;
     }
-  return count;
+  return false;
 }
 
 void
@@ -139,38 +179,38 @@ Engraver_group::do_announces ()
   do
     {
       /*
-       DOCME: why is this inside the loop? 
+        DOCME: why is this inside the loop?
        */
       for (SCM s = context ()->children_contexts ();
-          scm_is_pair (s); s = scm_cdr (s))
-       {
-         Context *c = unsmob_context (scm_car (s));
-         Engraver_group *group
-           = dynamic_cast<Engraver_group *> (c->implementation ());
-         if (group)
-           group->do_announces ();
-       }
-
-      
+           scm_is_pair (s); s = scm_cdr (s))
+        {
+          Context *c = unsmob<Context> (scm_car (s));
+          Engraver_group *group
+            = dynamic_cast<Engraver_group *> (c->implementation ());
+          if (group)
+            group->do_announces ();
+        }
+
       while (1)
-       {
-         precomputed_translator_foreach (PROCESS_ACKNOWLEDGED);
-         if (announce_infos_.size () == 0)
-           break;
-
-         acknowledge_grobs ();
-         announce_infos_.clear ();
-       }
+        {
+          precomputed_translator_foreach (PROCESS_ACKNOWLEDGED);
+          if (announce_infos_.size () == 0)
+            break;
+
+          acknowledge_grobs ();
+          announce_infos_.clear ();
+        }
     }
-  while (pending_grob_count () > 0);
+  while (pending_grobs ());
+}
+
+Preinit_Engraver_group::Preinit_Engraver_group ()
+{
+  acknowledge_hash_table_drul_.set (SCM_EOL, SCM_EOL);
 }
 
 Engraver_group::Engraver_group ()
 {
-  acknowledge_hash_table_drul_[LEFT] 
-    = acknowledge_hash_table_drul_[RIGHT] 
-    = SCM_EOL;
-  
   acknowledge_hash_table_drul_[LEFT] = scm_c_make_hash_table (61);
   acknowledge_hash_table_drul_[RIGHT] = scm_c_make_hash_table (61);
 }
@@ -178,10 +218,18 @@ Engraver_group::Engraver_group ()
 #include "translator.icc"
 
 ADD_TRANSLATOR_GROUP (Engraver_group,
-                     /* doc */ "A group of engravers taken together",
-                     /* create */ "",
-                     /* read */ "",
-                     /* write */ "");
+                      /* doc */
+                      "A group of engravers taken together.",
+
+                      /* create */
+                      "",
+
+                      /* read */
+                      "",
+
+                      /* write */
+                      ""
+                     );
 
 void
 Engraver_group::derived_mark () const