lily/new-fingering-engraver.cc

   1 /*
   2   fingering-engraver.cc --  implement New_fingering_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #include "warn.hh"
  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 #include "self-alignment-interface.hh"
  18 #include "script-interface.hh"
  19 #include "stem.hh"
  20
  21 struct Finger_tuple
  22 {
  23   Grob *head_;
  24   Grob *script_;
  25   Music *note_event_;
  26   Music *finger_event_;
  27   bool follow_into_staff_;
  28   int position_;
  29
  30   Finger_tuple ()
  31   {
  32     position_ = 0;
  33     head_ = script_ = 0;
  34     note_event_ = finger_event_ = 0;
  35     follow_into_staff_ = false;
  36   }
  37   static int compare (Finger_tuple const & c1, Finger_tuple const & c2)
  38   {
  39     return c1.position_-  c2.position_;
  40   }
  41
  42 };
  43
  44 class New_fingering_engraver : public Engraver
  45 {
  46   Array<Finger_tuple> fingerings_;
  47   Array<Finger_tuple> articulations_;
  48   Link_array<Grob> heads_;
  49   Grob *stem_;
  50
  51 public:
  52   TRANSLATOR_DECLARATIONS (New_fingering_engraver);
  53 protected:
  54   virtual void stop_translation_timestep ();
  55   virtual void acknowledge_grob (Grob_info);
  56   void add_fingering (Grob*, Music*,Music*);
  57   void add_script  (Grob*, Music*,Music*);
  58   void position_scripts ();
  59 };
  60
  61 void
  62 New_fingering_engraver::acknowledge_grob (Grob_info inf)
  63 {
  64   if (Rhythmic_head::has_interface (inf.grob_))
  65     {
  66       Music * note_ev =inf.music_cause ();
  67       if (!note_ev)
  68         return;
  69
  70       SCM arts = note_ev->get_property ("articulations");
  71
  72       for (SCM s = arts; scm_is_pair (s); s = ly_cdr  (s))
  73         {
  74           Music * m = unsmob_music (ly_car (s));
  75
  76           if (!m)
  77             continue;
  78
  79
  80           if (m->is_mus_type ("fingering-event"))
  81             {
  82               add_fingering (inf.grob_ , m, note_ev);
  83             }
  84           else if (m->is_mus_type ("text-script-event"))
  85             {
  86               m->origin ()->warning ("Can not add text scripts to individual note heads");
  87             }
  88           else if (m->is_mus_type ("script-event"))
  89             {
  90               add_script (inf.grob_, m, note_ev);
  91             }
  92           else if (m->is_mus_type ("harmonic-event"))
  93             {
  94               inf.grob_->set_property ("style", ly_symbol2scm ("harmonic"));
  95               Grob * d = unsmob_grob (inf.grob_->get_property ("dot"));
  96               if (d)
  97                 d->suicide ();
  98             }
  99         }
 100
 101       heads_.push (inf.grob_);
 102     }
 103   else if (Stem::has_interface (inf.grob_))
 104     {
 105       stem_ = inf.grob_;
 106     }
 107 }
 108
 109 void
 110 New_fingering_engraver::add_script (Grob * head,
 111                                     Music * event,
 112                                     Music * )
 113 {
 114   Finger_tuple ft ;
 115
 116   Grob * g=  make_item ("Script", event->self_scm () );
 117   make_script_from_event (g, &ft.follow_into_staff_, context (),
 118                           event->get_property ("articulation-type"), 0);
 119   if (g)
 120     {
 121       ft.script_ =g ;
 122
 123       articulations_.push (ft);
 124
 125       ft.script_->set_parent (head, X_AXIS);
 126     }
 127 }
 128
 129
 130 void
 131 New_fingering_engraver::add_fingering (Grob * head,
 132                                        Music * event,
 133                                        Music *hevent)
 134 {
 135   Finger_tuple ft;
 136
 137   ft.script_ = make_item ("Fingering", event->self_scm () );
 138
 139   Side_position_interface::add_support (ft.script_, head);
 140
 141   int d = scm_to_int (event->get_property ("digit"));
 142
 143   /*
 144     TODO:
 145
 146     Should add support for thumb.  It's a little involved, since
 147     the thumb lives in a different font. Maybe it should be moved?
 148
 149    */
 150   if (d > 5)
 151     {
 152       /*
 153         music for the softenon children?
 154        */
 155       event->origin ()->warning (_("music for the martians."));
 156     }
 157   SCM sstr = scm_number_to_string (scm_int2num (d), scm_int2num (10)) ;
 158   ft.script_->set_property ("text", sstr);
 159
 160   ft.finger_event_ = event;
 161   ft.note_event_ = hevent;
 162   ft.head_ = head;
 163
 164   fingerings_.push (ft);
 165 }
 166
 167 void
 168 New_fingering_engraver::position_scripts ()
 169 {
 170
 171   /*
 172     This is not extremely elegant, but we have to do a little
 173     formatting here, because the parent/child relations should be
 174     known before we move on to the next time step.
 175
 176     A more sophisticated approach would be to set both X and Y parents
 177     to the note head, and write a more flexible function for
 178     positioning the fingerings, setting both X and Y coordinates.
 179   */
 180   for (int i = 0; i < fingerings_.size (); i++)
 181     {
 182       fingerings_[i].position_ = scm_to_int (fingerings_[i].head_ -> get_property ( "staff-position"));
 183     }
 184
 185   for (int i = fingerings_.size (); i--;)
 186     for (int j = heads_.size () ; j--;)
 187       Side_position_interface::add_support (fingerings_[i].script_, heads_[j]);
 188
 189   Array<Finger_tuple> up, down, horiz;
 190   for (int i = fingerings_.size (); i--;)
 191     {
 192       SCM d = fingerings_[i].finger_event_->get_property ("direction");
 193       if (to_dir (d))
 194         {
 195           ((to_dir (d) == UP) ? up : down ).push (fingerings_[i]);
 196           fingerings_.del (i);
 197         }
 198     }
 199
 200   fingerings_.sort (&Finger_tuple::compare);
 201   SCM orientations = get_property ("fingeringOrientations");
 202
 203   bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
 204   bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
 205   bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
 206   bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
 207   Direction hordir = (right_p) ? RIGHT : LEFT;
 208   if (left_p || right_p)
 209     {
 210       if (up_p && !up.size () && fingerings_.size ())
 211         up.push (fingerings_.pop ());
 212
 213       if (down_p && !down.size () && fingerings_.size ())
 214         {
 215           down.push (fingerings_[0]);
 216           fingerings_.del (0);
 217         }
 218
 219       horiz.concat (fingerings_);
 220     }
 221   else if (up_p && down_p)
 222     {
 223       int center = fingerings_.size () / 2;
 224       down.concat (fingerings_.slice (0,center));
 225       up.concat (fingerings_.slice (center, fingerings_.size ()));
 226     }
 227   else if (up_p)
 228     {
 229       up.concat (fingerings_);
 230       fingerings_ .clear ();
 231     }
 232   else
 233     {
 234       if (!down_p)
 235         warning (_ ("Fingerings are also not down?! Putting them down anyway."));
 236       down.concat (fingerings_);
 237       fingerings_.clear ();
 238     }
 239
 240   for (int i = 0; i < horiz.size (); i++)
 241     {
 242       Finger_tuple ft = horiz[i];
 243       Grob* f = ft.script_;
 244       f->set_parent (ft.head_, X_AXIS);
 245       f->set_parent (ft.head_, Y_AXIS);
 246       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
 247       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
 248       f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
 249
 250       f->set_property ("direction", scm_int2num (hordir));
 251     }
 252
 253   int finger_prio = 200;
 254   for (int i = 0; i < up.size (); i++)
 255     {
 256       Finger_tuple ft = up[i];
 257       Grob* f = ft.script_;
 258       f->set_parent (ft.head_, X_AXIS);
 259       f->set_property ("script-priority",
 260                             scm_int2num (finger_prio + i));
 261       f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
 262       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
 263       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
 264
 265       f->set_property ("direction", scm_int2num (UP));
 266
 267     }
 268
 269   for (int i = 0; i < down.size (); i++)
 270     {
 271       Finger_tuple ft = down[i];
 272       Grob* f = ft.script_;
 273       f->set_parent (ft.head_, X_AXIS);
 274       f->set_property ("script-priority",
 275                             scm_int2num (finger_prio + down.size () - i));
 276
 277       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
 278       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
 279       f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
 280       f->set_property ("direction", scm_int2num (DOWN));
 281     }
 282 }
 283
 284 void
 285 New_fingering_engraver::stop_translation_timestep ()
 286 {
 287   if (fingerings_.size ())
 288     {
 289       for (int i = 0;  i < fingerings_.size(); i++)
 290         if (stem_ && to_boolean (fingerings_[i].script_->get_property ("add-stem-support")))
 291           Side_position_interface::add_support (fingerings_[i].script_, stem_);
 292       position_scripts ();
 293       fingerings_.clear ();
 294     }
 295
 296   for (int i =  articulations_.size (); i--;)
 297     {
 298       Grob *script = articulations_[i].script_;
 299
 300       for (int j = heads_.size () ; j--;)
 301         Side_position_interface::add_support (script, heads_[j]);
 302
 303       if (stem_ && to_dir (script->get_property ("side-relative-direction")))
 304         script->set_property ("direction-source", stem_->self_scm ());
 305
 306
 307       if (stem_ && to_boolean (script->get_property ("add-stem-support")))
 308         Side_position_interface::add_support (script, stem_);
 309
 310       if (articulations_[i].follow_into_staff_)
 311         {
 312           script->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
 313           script->set_property ("staff-padding" , SCM_EOL);
 314         }
 315     }
 316
 317   stem_ = 0;
 318   heads_.clear ();
 319   articulations_.clear ();
 320 }
 321
 322
 323 New_fingering_engraver::New_fingering_engraver ()
 324 {
 325   stem_ = 0;
 326 }
 327
 328 ENTER_DESCRIPTION (New_fingering_engraver,
 329 /* descr */       "Create fingering-scripts for notes in a new chord.  "
 330                   "This engraver is ill-named, since it "
 331                   "also takes care of articulations and harmonic note heads",
 332 /* creats*/       "Fingering",
 333 /* accepts */     "",
 334 /* acks  */       "rhythmic-head-interface stem-interface",
 335 /* reads */       "fingeringOrientations",
 336 /* write */       "");