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