lily/tie-engraver.cc

   1 /*
   2   tie-engraver.cc -- implement Tie_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "engraver.hh"
  10
  11 #include "context.hh"
  12 #include "grob-pitch-tuple.hh"
  13 #include "international.hh"
  14 #include "item.hh"
  15 #include "note-head.hh"
  16 #include "protected-scm.hh"
  17 #include "spanner.hh"
  18 #include "staff-symbol-referencer.hh"
  19 #include "stream-event.hh"
  20 #include "tie-column.hh"
  21 #include "tie.hh"
  22 #include "warn.hh"
  23
  24 #include "translator.icc"
  25
  26 /**
  27    Manufacture ties.  Acknowledge noteheads, and put them into a
  28    priority queue. If we have a TieEvent, connect the notes that finish
  29    just at this time, and note that start at this time.
  30
  31    TODO: Remove the dependency on musical info. We should tie on the
  32    basis of position and duration-log of the heads (not of the events).
  33 */
  34
  35 struct Head_event_tuple
  36 {
  37   Grob *head_;
  38   Moment end_moment_;
  39   SCM tie_definition_;
  40   Stream_event *event_;
  41
  42   Head_event_tuple ()
  43   {
  44     event_ = 0;
  45     head_ = 0;
  46     tie_definition_ = SCM_EOL;
  47   }
  48 };
  49
  50 class Tie_engraver : public Engraver
  51 {
  52   Stream_event *event_;
  53   vector<Grob*> now_heads_;
  54   vector<Head_event_tuple> heads_to_tie_;
  55   vector<Grob*> ties_;
  56
  57   Spanner *tie_column_;
  58
  59 protected:
  60   void stop_translation_timestep ();
  61   virtual void derived_mark () const;
  62   void start_translation_timestep ();
  63   DECLARE_ACKNOWLEDGER (note_head);
  64   DECLARE_TRANSLATOR_LISTENER (tie);
  65   void process_music ();
  66   void typeset_tie (Grob *);
  67 public:
  68   TRANSLATOR_DECLARATIONS (Tie_engraver);
  69 };
  70
  71 void
  72 Tie_engraver::derived_mark () const
  73 {
  74   Engraver::derived_mark ();
  75   for (vsize i = 0; i < heads_to_tie_.size (); i++)
  76     scm_gc_mark (heads_to_tie_[i].tie_definition_);
  77 }
  78
  79 Tie_engraver::Tie_engraver ()
  80 {
  81   event_ = 0;
  82   tie_column_ = 0;
  83 }
  84
  85 IMPLEMENT_TRANSLATOR_LISTENER (Tie_engraver, tie);
  86 void
  87 Tie_engraver::listen_tie (Stream_event *ev)
  88 {
  89   event_ = ev;
  90 }
  91
  92 void
  93 Tie_engraver::process_music ()
  94 {
  95   if (event_)
  96     context ()->set_property ("tieMelismaBusy", SCM_BOOL_T);
  97 }
  98
  99 void
 100 Tie_engraver::acknowledge_note_head (Grob_info i)
 101 {
 102   Grob *h = i.grob ();
 103   now_heads_.push_back (h);
 104   for (vsize i = heads_to_tie_.size (); i--;)
 105     {
 106       Grob *th = heads_to_tie_[i].head_;
 107       Stream_event *right_ev = unsmob_stream_event (h->get_property ("cause"));
 108       Stream_event *left_ev = unsmob_stream_event (th->get_property ("cause"));
 109
 110       /*
 111         maybe should check positions too.
 112       */
 113       if (right_ev && left_ev
 114           && ly_is_equal (right_ev->get_property ("pitch"),
 115                           left_ev->get_property ("pitch")))
 116         {
 117           Grob *p = new Spanner (heads_to_tie_[i].tie_definition_,
 118                                  context ()->get_grob_key ("Tie"));
 119           announce_grob (p, heads_to_tie_[i].event_->self_scm ());
 120           Tie::set_head (p, LEFT, th);
 121           Tie::set_head (p, RIGHT, h);
 122
 123           ties_.push_back (p);
 124           heads_to_tie_.erase (heads_to_tie_.begin () + i);
 125         }
 126     }
 127
 128   if (ties_.size () && ! tie_column_)
 129     tie_column_ = make_spanner ("TieColumn", ties_[0]->self_scm ());
 130
 131   if (tie_column_)
 132     for (vsize i = ties_.size (); i--;)
 133       Tie_column::add_tie (tie_column_, ties_[i]);
 134 }
 135
 136 void
 137 Tie_engraver::start_translation_timestep ()
 138 {
 139   context ()->set_property ("tieMelismaBusy",
 140                             ly_bool2scm (heads_to_tie_.size ()));
 141
 142
 143   if (!to_boolean (get_property ("tieWaitForNote")))
 144     {
 145       Moment now = now_mom ();
 146       for (vsize i = heads_to_tie_.size ();  i--; )
 147         {
 148           if (now > heads_to_tie_[i].end_moment_)
 149             heads_to_tie_.erase (heads_to_tie_.begin () + i);
 150         }
 151     }
 152 }
 153
 154 void
 155 Tie_engraver::stop_translation_timestep ()
 156 {
 157   if (ties_.size ())
 158     {
 159       if (!to_boolean (get_property ("tieWaitForNote")))
 160         heads_to_tie_.clear ();
 161
 162       for (vsize i = 0; i < ties_.size (); i++)
 163         typeset_tie (ties_[i]);
 164
 165       ties_.clear ();
 166       tie_column_ = 0;
 167     }
 168
 169   if (event_)
 170     {
 171       SCM start_definition
 172         = updated_grob_properties (context (), ly_symbol2scm ("Tie"));
 173
 174       if (!to_boolean (get_property ("tieWaitForNote")))
 175         heads_to_tie_.clear ();
 176
 177       for (vsize i = 0; i < now_heads_.size (); i++)
 178         {
 179           Grob *head = now_heads_[i];
 180           Stream_event *left_ev = unsmob_stream_event (head->get_property ("cause"));
 181           if (left_ev)
 182             {
 183               Head_event_tuple event_tup;
 184
 185               event_tup.head_ = head;
 186               event_tup.tie_definition_ = start_definition;
 187               event_tup.event_ = event_;
 188
 189               Moment end = now_mom ();
 190               if (end.grace_part_)
 191                 {
 192                   end.grace_part_ += get_event_length (left_ev).main_part_;
 193                 }
 194               else
 195                 {
 196                   end += get_event_length (left_ev);
 197                 }
 198               event_tup.end_moment_ = end;
 199
 200               heads_to_tie_.push_back (event_tup);
 201             }
 202         }
 203     }
 204
 205   event_ = 0;
 206   now_heads_.clear ();
 207 }
 208
 209 void
 210 Tie_engraver::typeset_tie (Grob *her)
 211 {
 212   if (! (Tie::head (her, LEFT) && Tie::head (her, RIGHT)))
 213     warning (_ ("lonely tie"));
 214
 215   Direction d = LEFT;
 216   Drul_array<Grob *> new_head_drul;
 217   new_head_drul[LEFT] = Tie::head (her, LEFT);
 218   new_head_drul[RIGHT] = Tie::head (her, RIGHT);
 219   do
 220     {
 221       if (!Tie::head (her, d))
 222         new_head_drul[d] = Tie::head (her, (Direction) - d);
 223     }
 224   while (flip (&d) != LEFT);
 225
 226   Spanner *sp = dynamic_cast<Spanner*> (her);
 227   sp->set_bound (LEFT, new_head_drul[LEFT]);
 228   sp->set_bound (RIGHT, new_head_drul[RIGHT]);
 229 }
 230
 231 ADD_ACKNOWLEDGER (Tie_engraver, note_head);
 232 ADD_TRANSLATOR (Tie_engraver,
 233                 /* doc */ "Generate ties between noteheads of equal pitch.",
 234                 /* create */
 235                 "Tie "
 236                 "TieColumn",
 237
 238                 /* accept */ "tie-event",
 239                 /* read */ "tieWaitForNote",
 240                 /* write */ "tieMelismaBusy");