lily/fingering-engraver.cc

   1 /*
   2   fingering-engraver.cc --  implement Fingering_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
  11 #include "engraver.hh"
  12 #include "side-position-interface.hh"
  13 #include "item.hh"
  14 #include "event.hh"
  15 #include "stem.hh"
  16 #include "rhythmic-head.hh"
  17
  18 class Fingering_engraver : public Engraver
  19 {
  20   Link_array<Music> reqs_;
  21   Link_array<Item> fingerings_;
  22
  23   Link_array<Music> up_reqs_;
  24   Link_array<Music> hor_reqs_;
  25   Link_array<Music> down_reqs_;
  26
  27 public:
  28   TRANSLATOR_DECLARATIONS(Fingering_engraver);
  29 protected:
  30   virtual bool try_music (Music* m);
  31   virtual void stop_translation_timestep ();
  32   virtual void start_translation_timestep ();
  33   virtual void process_music ();
  34   virtual void acknowledge_grob (Grob_info);
  35
  36   void make_script (Direction, Music*,Axis, int);
  37 };
  38
  39 bool
  40 Fingering_engraver::try_music (Music *m)
  41 {
  42   if (m->is_mus_type ("text-script-event"))
  43     {
  44       if (m->get_mus_property ("text-type") != ly_symbol2scm ("finger"))
  45         return false;
  46
  47       reqs_.push (m);
  48       return true;
  49     }
  50   return false;
  51 }
  52
  53 void
  54 Fingering_engraver::acknowledge_grob (Grob_info inf)
  55 {
  56   if (Stem::has_interface (inf.grob_))
  57     {
  58       for (int i=0; i < fingerings_.size (); i++)
  59         {
  60           Side_position_interface::add_support (fingerings_[i],inf.grob_);
  61         }
  62     }
  63   else if (Rhythmic_head::has_interface (inf.grob_))
  64     {
  65       Music * mc =inf.music_cause ();
  66       Pitch * mp = mc? unsmob_pitch (mc->get_mus_property ("pitch")) :0;
  67       for (int i=0; i < fingerings_.size (); i++)
  68         {
  69           Grob*t = fingerings_[i];
  70           Side_position_interface::add_support (t,inf.grob_);
  71           Pitch *fp = unsmob_pitch (t->get_grob_property ("pitch"));
  72           if (fp)
  73             {
  74               if (!mp)
  75                 continue;
  76
  77               if (*fp == *mp)
  78                 {
  79                   Axis other = other_axis (Side_position_interface::get_axis (t));
  80                   t->set_parent (inf.grob_, other);
  81                 }
  82             }
  83           else
  84             {
  85               if (!t->get_parent (X_AXIS))
  86                 t->set_parent (inf.grob_, X_AXIS);
  87             }
  88         }
  89     }
  90 }
  91
  92 static int
  93 req_compare (Music * const &a,Music * const &b)
  94 {
  95   Pitch *pa  = unsmob_pitch (a->get_mus_property ("pitch"));
  96   Pitch *pb  = unsmob_pitch (b->get_mus_property ("pitch"));
  97
  98   if (!pa && !pb)
  99     return 0;
 100   if (pa && !pb)
 101     return 1;
 102   if (!pa && pb)
 103     return -1;
 104
 105   return Pitch::compare (*pa, *pb);
 106 }
 107
 108 void
 109 Fingering_engraver::process_music ()
 110 {
 111   if (!reqs_.size())
 112     return ;
 113
 114   Link_array<Music> pitch_sorted_reqs = reqs_;
 115   for (int i= pitch_sorted_reqs.size(); i--;)
 116     {
 117       SCM dir = pitch_sorted_reqs[i]->get_mus_property ("direction");
 118       if (ly_dir_p (dir) && to_dir (dir)) {
 119         if (to_dir (dir) == UP)
 120           up_reqs_.push (pitch_sorted_reqs[i]);
 121         else if (to_dir (dir) == DOWN)
 122           down_reqs_ .push (pitch_sorted_reqs[i]);
 123         pitch_sorted_reqs.del(i);
 124
 125         continue ;
 126       }
 127       else if (!unsmob_pitch (pitch_sorted_reqs[i]->get_mus_property ("pitch")))
 128         {
 129           /*
 130             chuck out reqs that have no pitch.  We put them over the note by default.
 131           */
 132           up_reqs_.push (pitch_sorted_reqs [i]);
 133           pitch_sorted_reqs.del (i);
 134         }
 135     }
 136   up_reqs_.reverse ();
 137   down_reqs_.reverse ();
 138
 139   pitch_sorted_reqs.sort (&req_compare);
 140
 141   if (to_boolean (get_property ("scriptHorizontal")))
 142     {
 143 #if 1 // -> 0 for testing horizontal fingerings.
 144
 145       down_reqs_.push  ( pitch_sorted_reqs[0]);
 146       pitch_sorted_reqs.del (0);
 147
 148       if (pitch_sorted_reqs.size())
 149         {
 150           up_reqs_.push (pitch_sorted_reqs.top ());
 151           pitch_sorted_reqs.pop();
 152         }
 153 #endif
 154       hor_reqs_ = pitch_sorted_reqs;
 155     }
 156   else
 157     {
 158       int sz = pitch_sorted_reqs.size ();
 159       down_reqs_.concat (pitch_sorted_reqs.slice(0, (sz + sz%2)/2 ));
 160       up_reqs_.concat (pitch_sorted_reqs.slice((sz + sz%2)/2, sz));
 161       hor_reqs_ .clear ();
 162     }
 163
 164   for (int i = 0; i < down_reqs_.size();i++)
 165     make_script (DOWN,  down_reqs_[i], Y_AXIS, i);
 166   for (int i = 0; i < up_reqs_.size();i++)
 167     make_script (UP,   up_reqs_[i], Y_AXIS, i);
 168   for (int i = 0; i < hor_reqs_.size();i++)
 169     make_script (CENTER,  hor_reqs_[i],X_AXIS, i);
 170 }
 171
 172 void
 173 Fingering_engraver::make_script (Direction d, Music *r,Axis a,  int i)
 174 {
 175   Item *fingering = new Item (get_property ("Fingering"));
 176
 177   Axis other = other_axis (a);
 178
 179   SCM pitch = r->get_mus_property ("pitch");
 180   if (unsmob_pitch (pitch))
 181     fingering->set_grob_property ("pitch", pitch);
 182
 183   Side_position_interface::set_axis (fingering, a);
 184
 185   fingering->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, other);
 186   fingering->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, other);
 187
 188   // Hmm
 189   int priority = 200;
 190   SCM s = fingering->get_grob_property ("script-priority");
 191   if (gh_number_p (s))
 192     priority = gh_scm2int (s);
 193
 194   /* See script-engraver.cc */
 195   priority += i;
 196
 197   fingering->set_grob_property ("script-priority", gh_int2scm (priority));
 198
 199
 200   if (!ly_dir_p (fingering->get_grob_property ("direction")))
 201     {
 202       if (d)
 203         fingering->set_grob_property ("direction", gh_int2scm (d));
 204       else
 205         fingering->set_grob_property ("direction",  gh_int2scm (RIGHT));
 206     }
 207
 208   fingering->set_grob_property ("text", r->get_mus_property ("text"));
 209
 210   announce_grob (fingering, r->self_scm());
 211   fingerings_.push (fingering);
 212 }
 213
 214 void
 215 Fingering_engraver::stop_translation_timestep ()
 216 {
 217   if (!fingerings_.size ())
 218     return;
 219
 220   for (int i=0; i < fingerings_.size (); i++)
 221     {
 222       Item *ti = fingerings_[i];
 223       Side_position_interface::add_staff_support (ti);
 224       typeset_grob (ti);
 225     }
 226   fingerings_.clear ();
 227 }
 228
 229 void
 230 Fingering_engraver::start_translation_timestep ()
 231 {
 232   reqs_.clear ();
 233   up_reqs_.clear ();
 234   down_reqs_.clear ();
 235   hor_reqs_.clear ();
 236 }
 237
 238 Fingering_engraver::Fingering_engraver()
 239 {
 240
 241 }
 242
 243 ENTER_DESCRIPTION(Fingering_engraver,
 244 /* descr */       "Create fingering-scripts",
 245 /* creats*/       "Fingering",
 246 /* accepts */     "text-script-event",
 247 /* acks  */      "rhythmic-head-interface stem-interface",
 248 /* reads */       "scriptHorizontal",
 249 /* write */       "");