lily/engraver-group-engraver.cc

   1 /*
   2   engravergroup.cc -- implement Engraver_group_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "flower-proto.hh"
  10 #include "engraver-group-engraver.hh"
  11 #include "engraver.hh"
  12 #include "warn.hh"
  13 #include "paper-score.hh"
  14 #include "grob.hh"
  15
  16 void
  17 Engraver_group_engraver::announce_grob (Grob_info info)
  18 {
  19   announce_infos_.push (info);
  20   Engraver::announce_grob (info);
  21 }
  22
  23 void
  24 Engraver_group_engraver::process_acknowledged_grobs_in_simple_children ()
  25 {
  26   for (SCM p = simple_trans_list_; gh_pair_p (p); p = ly_cdr (p))
  27     {
  28       Translator * t = unsmob_translator (ly_car (p));
  29       Engraver * eng = dynamic_cast<Engraver*> (t);
  30       if (eng)
  31         eng->process_acknowledged_grobs ();
  32     }
  33 }
  34
  35 /*
  36
  37   Done: eliminating useless broadcast/acknowledge
  38
  39
  40 One cause for translation slowness: grob broadcasted/acknowledges
  41  (b/a): every grob is b/a-ed to all peer-engravers and all
  42 parent-engravers. This means that lots of (often) useless b/a is done
  43 for large scores (the top-level engravers gets to know every detail of
  44 every voice, thread, etc. Measurements indicate this is 10% of the
  45  interpretation time:
  46
  47  standchen
  48
  49 old: (pre 1.5.13)  10.28
  50 new: 8.73
  51 speedup: 15 %
  52
  53 Coriolan:
  54
  55 new: 197.59
  56 old: 219.12 seconds
  57 speedup: 10%
  58
  59
  60 The cost of this B/A is # of useless engravers * cost of one ack,
  61 which is rather low, since cost of one ack is only an interface check.
  62 The cost of precomputing engraver lists has two elts: computing the
  63 list itself, GC for the structure, looking up the list during the
  64 acks.
  65
  66 */
  67 SCM find_acknowledge_engravers (SCM gravlist, SCM meta);
  68 SCM find_accept_engravers (SCM gravlist, SCM music_descr);
  69
  70 void
  71 Engraver_group_engraver::acknowledge_grobs ()
  72 {
  73   if (!announce_infos_.size ())
  74     return ;
  75
  76   SCM tab = get_property ("acknowledgeHashTable");
  77   SCM name_sym = ly_symbol2scm ("name");
  78   SCM meta_sym = ly_symbol2scm ("meta");
  79
  80
  81   for (int j =0; j < announce_infos_.size (); j++)
  82     {
  83       Grob_info info = announce_infos_[j];
  84
  85       SCM meta = info.grob_->internal_get_grob_property (meta_sym);
  86       SCM nm = scm_assoc (name_sym, meta);
  87       if (gh_pair_p (nm))
  88         nm = ly_cdr (nm);
  89       else
  90         {
  91           /*
  92             it's tempting to put an assert for
  93             immutable_property_alist_ == '(), but in fact, some
  94             engravers (clef-engraver) add some more information to the
  95             immutable_property_alist_ (after it has been '()-ed).
  96
  97             We ignore the grob anyway. He who has no name, shall not
  98             be helped.  */
  99
 100           continue;
 101         }
 102
 103       SCM acklist = scm_hashq_ref (tab, nm, SCM_UNDEFINED);
 104       if (acklist == SCM_BOOL_F)
 105         {
 106           acklist= find_acknowledge_engravers (gh_cons (self_scm (), simple_trans_list_), meta);
 107           scm_hashq_set_x (tab, nm, acklist);
 108         }
 109
 110       for (SCM p = acklist; gh_pair_p (p); p = ly_cdr (p))
 111         {
 112           Translator * t = unsmob_translator (ly_car (p));
 113           Engraver * eng = dynamic_cast<Engraver*> (t);
 114           if (eng && eng!= info.origin_trans_)
 115             eng->acknowledge_grob (info);
 116         }
 117     }
 118 }
 119
 120 void
 121 Engraver_group_engraver::do_announces ()
 122 {
 123   for (SCM p = trans_group_list_; gh_pair_p (p); p =ly_cdr (p))
 124     {
 125       Translator * t = unsmob_translator (ly_car (p));
 126       dynamic_cast<Engraver_group_engraver*> (t)->do_announces ();
 127     }
 128
 129    process_acknowledged_grobs_in_simple_children ();
 130
 131    do
 132     {
 133       acknowledge_grobs ();
 134       announce_infos_.clear ();
 135       process_acknowledged_grobs_in_simple_children ();
 136     }
 137    while (announce_infos_.size ());
 138 }
 139
 140
 141
 142 /*
 143   order is : top to bottom (as opposed to do_announces)
 144  */
 145 void
 146 Engraver_group_engraver::process_music ()
 147 {
 148    for (SCM p = simple_trans_list_; gh_pair_p (p); p =ly_cdr (p))
 149     {
 150       Translator * t = unsmob_translator (ly_car (p));
 151       Engraver * eng = dynamic_cast<Engraver*> (t);
 152
 153       if (eng)
 154         eng->process_music ();
 155     }
 156    for (SCM p = trans_group_list_; gh_pair_p (p); p =ly_cdr (p))
 157     {
 158       Translator * t = unsmob_translator (ly_car (p));
 159       Engraver*eng = dynamic_cast<Engraver*> (t);
 160       if (eng)
 161         eng->process_music ();
 162     }
 163 }
 164
 165 void
 166 Engraver_group_engraver::initialize ()
 167 {
 168   /*
 169     docme: why bool_f.
 170
 171    */
 172   SCM tab = scm_make_vector (gh_int2scm (61), SCM_BOOL_F);
 173   set_property ("acknowledgeHashTable", tab);
 174
 175   Translator_group::initialize ();
 176 }
 177
 178 Engraver_group_engraver::Engraver_group_engraver() {}
 179
 180 ENTER_DESCRIPTION(Engraver_group_engraver,
 181 /* descr */       "A group of engravers taken together",
 182 /* creats*/       "",
 183 /* accepts */     "",
 184 /* acks  */      "",
 185 /* reads */       "",
 186 /* write */       "");
 187
 188
 189
 190 /*****************/
 191
 192
 193 bool engraver_valid (Translator*tr, SCM ifaces)
 194 {
 195   SCM ack_ifs = scm_assoc (ly_symbol2scm ("interfaces-acked"), tr->translator_description());
 196   ack_ifs = gh_cdr (ack_ifs);
 197   for (SCM s = ifaces; ly_pair_p (s); s = ly_cdr (s))
 198     if (scm_memq (ly_car (s), ack_ifs) != SCM_BOOL_F)
 199       return true;
 200   return false;
 201 }
 202
 203
 204
 205 SCM
 206 find_acknowledge_engravers (SCM gravlist, SCM meta_alist)
 207 {
 208   SCM ifaces = gh_cdr (scm_assoc (ly_symbol2scm ("interfaces"), meta_alist));
 209
 210   SCM l = SCM_EOL;
 211   for (SCM s = gravlist; ly_pair_p (s);  s = ly_cdr (s))
 212     {
 213       Translator* tr = unsmob_translator (ly_car (s));
 214       if (engraver_valid (tr, ifaces))
 215         l = scm_cons (tr->self_scm (), l);
 216     }
 217   l = scm_reverse_x (l, SCM_EOL);
 218
 219   return l;
 220 }
 221
 222