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--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #include "command-request.hh"
  11 #include "musical-request.hh"
  12 #include "tie.hh"
  13 #include "translator-group.hh"
  14 #include "spanner.hh"
  15 #include "tie-column.hh"
  16 #include "engraver.hh"
  17 #include "item.hh"
  18 #include "grob-pitch-tuple.hh"
  19 #include "note-head.hh"
  20
  21 /**
  22    Manufacture ties.  Acknowledge noteheads, and put them into a
  23    priority queue. If we have a Tie_req, connect the notes that finish
  24    just at this time, and note that start at this time.
  25
  26    TODO: Remove the dependency on musical info. We should tie on the
  27    basis of position and duration-log of the heads (not of the reqs).
  28
  29 */
  30 class Tie_engraver : public Engraver
  31 {
  32   Moment end_mom_;
  33   Moment next_end_mom_;
  34
  35   Tie_req *req_l_;
  36   Link_array<Grob> now_heads_;
  37   Link_array<Grob> stopped_heads_;
  38   Link_array<Grob> tie_p_arr_;
  39
  40   Spanner * tie_column_p_;
  41
  42   void set_melisma (bool);
  43
  44 protected:
  45   virtual void start_translation_timestep ();
  46   virtual void stop_translation_timestep ();
  47   virtual void acknowledge_grob (Grob_info);
  48   virtual bool try_music (Music*);
  49   virtual void create_grobs ();
  50   void typeset_tie (Grob*);
  51 public:
  52   TRANSLATOR_DECLARATIONS(Tie_engraver);
  53 };
  54
  55
  56
  57 Tie_engraver::Tie_engraver ()
  58 {
  59   req_l_ = 0;
  60   tie_column_p_ = 0;
  61 }
  62
  63
  64 bool
  65 Tie_engraver::try_music (Music *m)
  66 {
  67   if (Tie_req * c = dynamic_cast<Tie_req*> (m))
  68     {
  69       /*      if (end_mom_ > now_mom ())
  70        return false;
  71       */
  72       req_l_ = c;
  73       SCM m = get_property ("automaticMelismata");
  74       bool am = gh_boolean_p (m) &&gh_scm2bool (m);
  75       if (am)
  76         {
  77           set_melisma (true);
  78         }
  79       return true;
  80     }
  81   return false;
  82 }
  83
  84 void
  85 Tie_engraver::set_melisma (bool m)
  86 {
  87   daddy_trans_l_->set_property ("tieMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
  88 }
  89
  90 void
  91 Tie_engraver::acknowledge_grob (Grob_info i)
  92 {
  93   if (Note_head::has_interface (i.grob_l_))
  94     {
  95       now_heads_.push (i.grob_l_);
  96     }
  97 }
  98
  99 int
 100 head_pitch_compare (Grob  *const&a,Grob  *const&b)
 101 {
 102   Music *m1 =unsmob_music (a->get_grob_property ("cause"));
 103   Music *m2 =unsmob_music (b->get_grob_property ("cause"));
 104
 105   return Pitch::compare (* unsmob_pitch (m1->get_mus_property ("pitch")),
 106                          * unsmob_pitch (m2->get_mus_property ("pitch")));
 107 }
 108
 109 void
 110 Tie_engraver::create_grobs ()
 111 {
 112   if (req_l_)
 113     {
 114       now_heads_.sort (&head_pitch_compare);
 115       stopped_heads_.sort (&head_pitch_compare);
 116
 117       SCM head_list = SCM_EOL;
 118
 119       int j = stopped_heads_.size ()-1;
 120       int i = now_heads_.size ()-1;
 121
 122       while (i >= 0 && j >=0)
 123         {
 124           int comp
 125             = head_pitch_compare (now_heads_[i], stopped_heads_[j]);
 126
 127           if (comp)
 128             {
 129               (comp < 0) ? j -- : i--;
 130               continue;
 131             }
 132           else
 133             {
 134               head_list  = gh_cons (gh_cons (stopped_heads_[j]->self_scm (),
 135                                              now_heads_[i]->self_scm ()),
 136                                     head_list);
 137
 138               now_heads_.del (i);
 139               stopped_heads_.del (j);
 140               i--;
 141               j--;
 142             }
 143         }
 144
 145       SCM basic = get_property ("Tie");
 146       SCM sparse = get_property ("sparseTies");
 147       if (to_boolean (sparse))
 148         {
 149           int i = scm_ilength (head_list);
 150
 151           if (!i)
 152             return;
 153
 154           SCM pair = scm_list_ref (head_list, gh_int2scm (i/2));
 155
 156           Spanner * p = new Spanner (basic);
 157
 158           Tie::set_interface (p);
 159           Tie::set_head (p,LEFT, dynamic_cast<Item*> (unsmob_grob (ly_car (pair))));
 160           Tie::set_head (p,RIGHT, dynamic_cast<Item*> (unsmob_grob (ly_cdr (pair))));
 161
 162           tie_p_arr_.push (p);
 163           announce_grob(p, req_l_->self_scm());
 164         }
 165       else for (SCM s = head_list; gh_pair_p (s); s = ly_cdr (s))
 166         {
 167           Grob * p = new Spanner (basic);
 168           Tie::set_interface (p);
 169
 170           Tie::set_head (p, LEFT, dynamic_cast<Item*> (unsmob_grob (ly_caar (s))));
 171           Tie::set_head (p, RIGHT, dynamic_cast<Item*> (unsmob_grob (ly_cdar (s))));
 172
 173           tie_p_arr_.push (p);
 174           announce_grob(p, req_l_->self_scm());
 175         }
 176
 177       if (tie_p_arr_.size () > 1 && !tie_column_p_)
 178         {
 179           tie_column_p_ = new Spanner (get_property ("TieColumn"));
 180           Tie_column::set_interface (tie_column_p_);
 181           for (int i = tie_p_arr_.size (); i--;)
 182             Tie_column::add_tie (tie_column_p_,tie_p_arr_ [i]);
 183           announce_grob(tie_column_p_, SCM_EOL);
 184         }
 185     }
 186 }
 187
 188
 189 void
 190 Tie_engraver::stop_translation_timestep ()
 191 {
 192   req_l_ = 0;
 193
 194   now_heads_.clear ();
 195
 196   /*
 197     we don't warn for no ties, since this happens naturally when you
 198     use skipTypesetting.  */
 199
 200   for (int i=0; i<  tie_p_arr_.size (); i++)
 201    {
 202       typeset_tie (tie_p_arr_[i]);
 203     }
 204   tie_p_arr_.clear ();
 205   if (tie_column_p_)
 206     {
 207       typeset_grob (tie_column_p_);
 208       tie_column_p_ =0;
 209     }
 210 }
 211
 212 void
 213 Tie_engraver::typeset_tie (Grob *her)
 214 {
 215   if (! (Tie::head (her,LEFT) && Tie::head (her,RIGHT)))
 216     warning (_ ("lonely tie"));
 217
 218   Direction d = LEFT;
 219   Drul_array<Grob *> new_head_drul;
 220   new_head_drul[LEFT] = Tie::head (her,LEFT);
 221   new_head_drul[RIGHT] = Tie::head (her,RIGHT);
 222   do {
 223     if (!Tie::head (her,d))
 224       new_head_drul[d] = Tie::head (her, (Direction)-d);
 225   } while (flip (&d) != LEFT);
 226
 227   index_set_cell (her->get_grob_property ("heads"), LEFT, new_head_drul[LEFT]->self_scm ());
 228   index_set_cell (her->get_grob_property ("heads"), RIGHT, new_head_drul[RIGHT]->self_scm ());
 229
 230   typeset_grob (her);
 231 }
 232
 233 void
 234 Tie_engraver::start_translation_timestep ()
 235 {
 236   SCM m = get_property ("automaticMelismata");
 237   if (to_boolean (m))
 238     {
 239       set_melisma (false);
 240     }
 241
 242   SCM grobs = get_property ("busyGrobs");
 243   Moment now = now_mom();
 244   stopped_heads_.clear ();
 245
 246   for (; gh_pair_p (grobs); grobs = gh_cdr (grobs))
 247     {
 248       Grob * grob  = unsmob_grob (gh_cdar (grobs));
 249       Moment end  =*unsmob_moment (gh_caar (grobs));
 250
 251       /*
 252         This is slightly ugh: we are now confunding the frontend
 253         (iterators) and the backend (note heads) */
 254       if (end > now)
 255         break;
 256       else if (end == now
 257                && Note_head::has_interface (grob))
 258         stopped_heads_.push (grob);
 259     }
 260 }
 261
 262
 263 ENTER_DESCRIPTION(Tie_engraver,
 264 /* descr */       "Generate ties between noteheads of equal pitch.",
 265 /* creats*/       "Tie TieColumn",
 266 /* acks  */       "rhythmic-head-interface",
 267 /* reads */       "sparseTies tieMelismaBusy",
 268 /* write */       "");