lily/engraver-group.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "context.hh"
  21 #include "dispatcher.hh"
  22 #include "engraver-group.hh"
  23 #include "global-context.hh"
  24 #include "grob.hh"
  25 #include "grob-properties.hh"
  26 #include "paper-score.hh"
  27 #include "translator-dispatch-list.hh"
  28 #include "warn.hh"
  29
  30 void
  31 Engraver_group::override (SCM sev)
  32 {
  33   Stream_event *ev = unsmob<Stream_event> (sev);
  34   SCM sym = ev->get_property ("symbol");
  35   Grob_property_info gpi (context (), sym);
  36
  37   if (to_boolean (ev->get_property ("once")))
  38     {
  39       SCM token = gpi.temporary_override (ev->get_property ("property-path"),
  40                                           ev->get_property ("value"));
  41       if (scm_is_pair (token))
  42         if (Global_context *g = context ()->get_global_context ())
  43           {
  44             g->add_finalization (scm_list_4 (ly_context_matched_pop_property_proc,
  45                                              context ()->self_scm (),
  46                                              sym,
  47                                              token));
  48           }
  49     }
  50   else
  51     gpi.push (ev->get_property ("property-path"),
  52               ev->get_property ("value"));
  53 }
  54
  55 void
  56 Engraver_group::revert (SCM sev)
  57 {
  58   Stream_event *ev = unsmob<Stream_event> (sev);
  59   SCM sym = ev->get_property ("symbol");
  60   Grob_property_info gpi (context (), sym);
  61
  62   if (to_boolean (ev->get_property ("once")))
  63     {
  64       SCM token = gpi.temporary_revert (ev->get_property ("property-path"));
  65       if (scm_is_pair (token))
  66         if (Global_context *g = context ()->get_global_context ())
  67           {
  68             g->add_finalization (scm_list_4 (ly_context_matched_pop_property_proc,
  69                                              context ()->self_scm (),
  70                                              sym,
  71                                              token));
  72           }
  73     }
  74   else
  75     gpi.pop (ev->get_property ("property-path"));
  76 }
  77
  78 void
  79 Engraver_group::connect_to_context (Context *c)
  80 {
  81   Translator_group::connect_to_context (c);
  82   c->event_source ()->add_listener (GET_LISTENER (Engraver_group, override), ly_symbol2scm ("Override"));
  83   c->event_source ()->add_listener (GET_LISTENER (Engraver_group, revert), ly_symbol2scm ("Revert"));
  84 }
  85
  86 void
  87 Engraver_group::disconnect_from_context ()
  88 {
  89   context ()->event_source ()->remove_listener (GET_LISTENER (Engraver_group, override), ly_symbol2scm ("Override"));
  90   context ()->event_source ()->remove_listener (GET_LISTENER (Engraver_group, revert), ly_symbol2scm ("Revert"));
  91   Translator_group::disconnect_from_context ();
  92 }
  93
  94 void
  95 Engraver_group::announce_grob (Grob_info info)
  96 {
  97   announce_infos_.push_back (info);
  98
  99   Context *dad_con = context_->get_parent_context ();
 100   if (info.rerouting_daddy_context_)
 101     {
 102       dad_con = info.rerouting_daddy_context_;
 103       info.rerouting_daddy_context_ = 0;
 104     }
 105
 106   Engraver_group *dad_eng
 107     = dad_con
 108       ? dynamic_cast<Engraver_group *> (dad_con->implementation ())
 109       : 0;
 110
 111   if (dad_eng)
 112     dad_eng->announce_grob (info);
 113 }
 114
 115 void
 116 Engraver_group::acknowledge_grobs ()
 117 {
 118   if (!announce_infos_.size ())
 119     return;
 120
 121   SCM name_sym = ly_symbol2scm ("name");
 122
 123   for (vsize j = 0; j < announce_infos_.size (); j++)
 124     {
 125       Grob_info info = announce_infos_[j];
 126
 127       SCM meta = info.grob ()->get_property ("meta");
 128       SCM nm = scm_assoc (name_sym, meta);
 129       if (scm_is_pair (nm))
 130         nm = scm_cdr (nm);
 131       else
 132         continue;
 133
 134       SCM ackhandle = scm_hashq_create_handle_x (acknowledge_hash_table_drul_[info.start_end ()],
 135                                                  nm, SCM_BOOL_F);
 136
 137       SCM acklist = scm_cdr (ackhandle);
 138
 139       if (scm_is_false (acklist))
 140         {
 141           SCM ifaces
 142             = scm_cdr (scm_assoc (ly_symbol2scm ("interfaces"), meta));
 143           acklist = Engraver_dispatch_list::create (get_simple_trans_list (),
 144                                                     ifaces, info.start_end ());
 145
 146           scm_set_cdr_x (ackhandle, acklist);
 147         }
 148
 149       Engraver_dispatch_list *dispatch
 150         = unsmob<Engraver_dispatch_list> (acklist);
 151
 152       if (dispatch)
 153         dispatch->apply (info);
 154     }
 155 }
 156
 157 /*
 158   Ugh. This is slightly expensive. We could/should cache the value of
 159   the group count?
 160 */
 161 bool
 162 Engraver_group::pending_grobs () const
 163 {
 164   if (!announce_infos_.empty ())
 165     return true;
 166   for (SCM s = context_->children_contexts ();
 167        scm_is_pair (s); s = scm_cdr (s))
 168     {
 169       Context *c = unsmob<Context> (scm_car (s));
 170       Engraver_group *group
 171         = dynamic_cast<Engraver_group *> (c->implementation ());
 172
 173       if (group && group->pending_grobs ())
 174         return true;
 175     }
 176   return false;
 177 }
 178
 179 void
 180 Engraver_group::do_announces ()
 181 {
 182   do
 183     {
 184       /*
 185         DOCME: why is this inside the loop?
 186        */
 187       for (SCM s = context ()->children_contexts ();
 188            scm_is_pair (s); s = scm_cdr (s))
 189         {
 190           Context *c = unsmob<Context> (scm_car (s));
 191           Engraver_group *group
 192             = dynamic_cast<Engraver_group *> (c->implementation ());
 193           if (group)
 194             group->do_announces ();
 195         }
 196
 197       while (1)
 198         {
 199           precomputed_translator_foreach (PROCESS_ACKNOWLEDGED);
 200           if (announce_infos_.size () == 0)
 201             break;
 202
 203           acknowledge_grobs ();
 204           announce_infos_.clear ();
 205         }
 206     }
 207   while (pending_grobs ());
 208 }
 209
 210 Engraver_group::Engraver_group ()
 211 {
 212   acknowledge_hash_table_drul_[LEFT]
 213     = acknowledge_hash_table_drul_[RIGHT]
 214       = SCM_EOL;
 215
 216   acknowledge_hash_table_drul_[LEFT] = scm_c_make_hash_table (61);
 217   acknowledge_hash_table_drul_[RIGHT] = scm_c_make_hash_table (61);
 218 }
 219
 220 #include "translator.icc"
 221
 222 ADD_TRANSLATOR_GROUP (Engraver_group,
 223                       /* doc */
 224                       "A group of engravers taken together.",
 225
 226                       /* create */
 227                       "",
 228
 229                       /* read */
 230                       "",
 231
 232                       /* write */
 233                       ""
 234                      );
 235
 236 void
 237 Engraver_group::derived_mark () const
 238 {
 239   scm_gc_mark (acknowledge_hash_table_drul_[LEFT]);
 240   scm_gc_mark (acknowledge_hash_table_drul_[RIGHT]);
 241 }