lily/engraver-group.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2011 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 "grob.hh"
  24 #include "paper-score.hh"
  25 #include "translator-dispatch-list.hh"
  26 #include "warn.hh"
  27
  28 IMPLEMENT_LISTENER (Engraver_group, override);
  29 void
  30 Engraver_group::override (SCM sev)
  31 {
  32   Stream_event *ev = unsmob_stream_event (sev);
  33
  34   sloppy_general_pushpop_property (context (),
  35                                    ev->get_property ("symbol"),
  36                                    ev->get_property ("property-path"),
  37                                    ev->get_property ("value"));
  38 }
  39
  40 IMPLEMENT_LISTENER (Engraver_group, revert);
  41 void
  42 Engraver_group::revert (SCM sev)
  43 {
  44   Stream_event *ev = unsmob_stream_event (sev);
  45
  46   sloppy_general_pushpop_property (context (),
  47                                    ev->get_property ("symbol"),
  48                                    ev->get_property ("property-path"),
  49                                    SCM_UNDEFINED);
  50 }
  51
  52 void
  53 Engraver_group::connect_to_context (Context *c)
  54 {
  55   Translator_group::connect_to_context (c);
  56   c->event_source ()->add_listener (GET_LISTENER (override), ly_symbol2scm ("Override"));
  57   c->event_source ()->add_listener (GET_LISTENER (revert), ly_symbol2scm ("Revert"));
  58 }
  59
  60 void
  61 Engraver_group::disconnect_from_context ()
  62 {
  63   context ()->event_source ()->remove_listener (GET_LISTENER (override), ly_symbol2scm ("Override"));
  64   context ()->event_source ()->remove_listener (GET_LISTENER (revert), ly_symbol2scm ("Revert"));
  65   Translator_group::disconnect_from_context ();
  66 }
  67
  68 void
  69 Engraver_group::announce_grob (Grob_info info)
  70 {
  71   announce_infos_.push_back (info);
  72
  73   Engraver_group *dad_eng
  74     = context_->get_parent_context ()
  75     ? dynamic_cast<Engraver_group *> (context_->get_parent_context ()->implementation ())
  76     : 0;
  77
  78   if (dad_eng)
  79     dad_eng->announce_grob (info);
  80 }
  81
  82 void
  83 Engraver_group::acknowledge_grobs ()
  84 {
  85   if (!announce_infos_.size ())
  86     return;
  87
  88   SCM name_sym = ly_symbol2scm ("name");
  89   SCM meta_sym = ly_symbol2scm ("meta");
  90
  91   for (vsize j = 0; j < announce_infos_.size (); j++)
  92     {
  93       Grob_info info = announce_infos_[j];
  94
  95       SCM meta = info.grob ()->internal_get_property (meta_sym);
  96       SCM nm = scm_assoc (name_sym, meta);
  97       if (scm_is_pair (nm))
  98         nm = scm_cdr (nm);
  99       else
 100         continue;
 101
 102       SCM acklist = scm_hashq_ref (acknowledge_hash_table_drul_[info.start_end ()],
 103                                    nm, SCM_BOOL_F);
 104
 105       Engraver_dispatch_list *dispatch
 106         = Engraver_dispatch_list::unsmob (acklist);
 107
 108       if (acklist == SCM_BOOL_F)
 109         {
 110           SCM ifaces
 111             = scm_cdr (scm_assoc (ly_symbol2scm ("interfaces"), meta));
 112           acklist = Engraver_dispatch_list::create (get_simple_trans_list (),
 113                                                     ifaces, info.start_end ());
 114
 115           dispatch
 116             = Engraver_dispatch_list::unsmob (acklist);
 117
 118           scm_hashq_set_x (acknowledge_hash_table_drul_[info.start_end ()], nm, acklist);
 119         }
 120
 121       if (dispatch)
 122         dispatch->apply (info);
 123     }
 124 }
 125
 126 /*
 127   Ugh. This is slightly expensive. We could/should cache the value of
 128   the group count?
 129 */
 130 int
 131 Engraver_group::pending_grob_count () const
 132 {
 133   int count = announce_infos_.size ();
 134   for (SCM s = context_->children_contexts ();
 135        scm_is_pair (s); s = scm_cdr (s))
 136     {
 137       Context *c = unsmob_context (scm_car (s));
 138       Engraver_group *group
 139         = dynamic_cast<Engraver_group *> (c->implementation ());
 140
 141       if (group)
 142         count += group->pending_grob_count ();
 143     }
 144   return count;
 145 }
 146
 147 void
 148 Engraver_group::do_announces ()
 149 {
 150   do
 151     {
 152       /*
 153         DOCME: why is this inside the loop?
 154        */
 155       for (SCM s = context ()->children_contexts ();
 156            scm_is_pair (s); s = scm_cdr (s))
 157         {
 158           Context *c = unsmob_context (scm_car (s));
 159           Engraver_group *group
 160             = dynamic_cast<Engraver_group *> (c->implementation ());
 161           if (group)
 162             group->do_announces ();
 163         }
 164
 165
 166       while (1)
 167         {
 168           precomputed_translator_foreach (PROCESS_ACKNOWLEDGED);
 169           if (announce_infos_.size () == 0)
 170             break;
 171
 172           acknowledge_grobs ();
 173           announce_infos_.clear ();
 174         }
 175     }
 176   while (pending_grob_count () > 0);
 177 }
 178
 179 Engraver_group::Engraver_group ()
 180 {
 181   acknowledge_hash_table_drul_[LEFT]
 182     = acknowledge_hash_table_drul_[RIGHT]
 183     = SCM_EOL;
 184
 185   acknowledge_hash_table_drul_[LEFT] = scm_c_make_hash_table (61);
 186   acknowledge_hash_table_drul_[RIGHT] = scm_c_make_hash_table (61);
 187 }
 188
 189 #include "translator.icc"
 190
 191 ADD_TRANSLATOR_GROUP (Engraver_group,
 192                       /* doc */
 193                       "A group of engravers taken together.",
 194
 195                       /* create */
 196                       "",
 197
 198                       /* read */
 199                       "",
 200
 201                       /* write */
 202                       ""
 203                       );
 204
 205 void
 206 Engraver_group::derived_mark () const
 207 {
 208   scm_gc_mark (acknowledge_hash_table_drul_[LEFT]);
 209   scm_gc_mark (acknowledge_hash_table_drul_[RIGHT]);
 210 }