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--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "warn.hh"
  10 #include "engraver.hh"
  11 #include "side-position-interface.hh"
  12 #include "stem.hh"
  13 #include "rhythmic-head.hh"
  14 #include "self-alignment-interface.hh"
  15 #include "script-interface.hh"
  16 #include "stem.hh"
  17
  18 #include "translator.icc"
  19
  20 struct Finger_tuple
  21 {
  22   Grob *head_;
  23   Grob *script_;
  24   Music *note_event_;
  25   Music *finger_event_;
  26   bool follow_into_staff_;
  27   int position_;
  28
  29   Finger_tuple ()
  30   {
  31     position_ = 0;
  32     head_ = script_ = 0;
  33     note_event_ = finger_event_ = 0;
  34     follow_into_staff_ = false;
  35   }
  36   static int compare (Finger_tuple const &c1, Finger_tuple const &c2)
  37   {
  38     return c1.position_- c2.position_;
  39   }
  40 };
  41
  42 class New_fingering_engraver : public Engraver
  43 {
  44   Array<Finger_tuple> fingerings_;
  45   Array<Finger_tuple> articulations_;
  46   Array<Finger_tuple> string_numbers_;
  47
  48   Link_array<Grob> heads_;
  49   Grob *stem_;
  50
  51 public:
  52   TRANSLATOR_DECLARATIONS (New_fingering_engraver);
  53 protected:
  54   void stop_translation_timestep ();
  55   DECLARE_ACKNOWLEDGER (rhythmic_head);
  56   DECLARE_ACKNOWLEDGER (stem);
  57   void add_fingering (Grob *, Music *, Music *);
  58   void add_script (Grob *, Music *, Music *);
  59   void add_string (Grob *, Music *, Music *);
  60   void position_scripts (SCM orientations, Array<Finger_tuple> *);
  61 };
  62
  63 void
  64 New_fingering_engraver::acknowledge_rhythmic_head (Grob_info inf)
  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 = scm_cdr (s))
  73     {
  74       Music *m = unsmob_music (scm_car (s));
  75
  76       if (!m)
  77         continue;
  78
  79       if (m->is_mus_type ("fingering-event"))
  80         add_fingering (inf.grob (), m, note_ev);
  81       else if (m->is_mus_type ("text-script-event"))
  82         {
  83           m->origin ()->warning (_ ("can't add text scripts to individual note heads"));
  84         }
  85       else if (m->is_mus_type ("script-event"))
  86         add_script (inf.grob (), m, note_ev);
  87       else if (m->is_mus_type ("string-number-event"))
  88         add_string (inf.grob (), m, note_ev);
  89       else if (m->is_mus_type ("harmonic-event"))
  90         {
  91           inf.grob ()->set_property ("style", ly_symbol2scm ("harmonic"));
  92           Grob *d = unsmob_grob (inf.grob ()->get_object ("dot"));
  93           if (d)
  94             d->suicide ();
  95         }
  96     }
  97
  98   heads_.push (inf.grob ());
  99 }
 100
 101 void
 102 New_fingering_engraver::acknowledge_stem (Grob_info inf)
 103 {
 104   stem_ = inf.grob ();
 105 }
 106
 107 void
 108 New_fingering_engraver::add_script (Grob *head,
 109                                     Music *event,
 110                                     Music *note)
 111 {
 112   (void) note;
 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 void
 130 New_fingering_engraver::add_fingering (Grob *head,
 131                                        Music *event,
 132                                        Music *hevent)
 133 {
 134   Finger_tuple ft;
 135
 136   ft.script_ = make_item ("Fingering", event->self_scm ());
 137
 138   Side_position_interface::add_support (ft.script_, head);
 139
 140   int d = scm_to_int (event->get_property ("digit"));
 141
 142   /*
 143     TODO:
 144
 145     Should add support for thumb.  It's a little involved, since
 146     the thumb lives in a different font. Maybe it should be moved?
 147
 148   */
 149   if (d > 5)
 150     {
 151       /*
 152         music for the softenon children?
 153       */
 154       event->origin ()->warning (_ ("music for the martians."));
 155     }
 156   SCM sstr = scm_number_to_string (scm_from_int (d), scm_from_int (10));
 157   ft.script_->set_property ("text", sstr);
 158
 159   ft.finger_event_ = event;
 160   ft.note_event_ = hevent;
 161   ft.head_ = head;
 162
 163   fingerings_.push (ft);
 164 }
 165
 166 void
 167 New_fingering_engraver::add_string (Grob *head,
 168                                     Music *event,
 169                                     Music *hevent)
 170 {
 171   Finger_tuple ft;
 172
 173   ft.script_ = make_item ("StringNumber", event->self_scm ());
 174
 175   Side_position_interface::add_support (ft.script_, head);
 176
 177   int d = scm_to_int (event->get_property ("string-number"));
 178
 179   SCM sstr = scm_number_to_string (scm_from_int (d), scm_from_int (10));
 180   ft.script_->set_property ("text", sstr);
 181
 182   ft.finger_event_ = event;
 183   ft.note_event_ = hevent;
 184   ft.head_ = head;
 185
 186   string_numbers_.push (ft);
 187 }
 188
 189 void
 190 New_fingering_engraver::position_scripts (SCM orientations,
 191                                           Array<Finger_tuple> *scripts)
 192 {
 193   for (int i = 0; i < scripts->size (); i++)
 194     if (stem_ && to_boolean (scripts->elem (i).script_->get_property ("add-stem-support")))
 195       Side_position_interface::add_support (scripts->elem (i).script_, stem_);
 196
 197   /*
 198     This is not extremely elegant, but we have to do a little
 199     formatting here, because the parent/child relations should be
 200     known before we move on to the next time step.
 201
 202     A more sophisticated approach would be to set both X and Y parents
 203     to the note head, and write a more flexible function for
 204     positioning the fingerings, setting both X and Y coordinates.
 205   */
 206   for (int i = 0; i < scripts->size (); i++)
 207     {
 208       (*scripts)[i].position_ = scm_to_int ((*scripts)[i].head_->get_property ("staff-position"));
 209     }
 210
 211   for (int i = scripts->size (); i--;)
 212     for (int j = heads_.size (); j--;)
 213       Side_position_interface::add_support ((*scripts)[i].script_, heads_[j]);
 214
 215   Array<Finger_tuple> up, down, horiz;
 216   for (int i = scripts->size (); i--;)
 217     {
 218       SCM d = (*scripts)[i].finger_event_->get_property ("direction");
 219       if (to_dir (d))
 220         {
 221           ((to_dir (d) == UP) ? up : down).push ((*scripts)[i]);
 222           scripts->del (i);
 223         }
 224     }
 225
 226   scripts->sort (&Finger_tuple::compare);
 227
 228   bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
 229   bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
 230   bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
 231   bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
 232   Direction hordir = (right_p) ? RIGHT : LEFT;
 233   if (left_p || right_p)
 234     {
 235       if (up_p && !up.size () && scripts->size ())
 236         up.push (scripts->pop ());
 237
 238       if (down_p && !down.size () && scripts->size ())
 239         {
 240           down.push ((*scripts)[0]);
 241           scripts->del (0);
 242         }
 243
 244       horiz.concat (*scripts);
 245     }
 246   else if (up_p && down_p)
 247     {
 248       int center = scripts->size () / 2;
 249       down.concat (scripts->slice (0, center));
 250       up.concat (scripts->slice (center, scripts->size ()));
 251     }
 252   else if (up_p)
 253     {
 254       up.concat (*scripts);
 255       scripts->clear ();
 256     }
 257   else
 258     {
 259       if (!down_p)
 260         {
 261           warning (_ ("no placement found for fingerings"));
 262           warning (_ ("placing below"));
 263         }
 264       down.concat (*scripts);
 265       scripts->clear ();
 266     }
 267
 268   for (int i = 0; i < horiz.size (); i++)
 269     {
 270       Finger_tuple ft = horiz[i];
 271       Grob *f = ft.script_;
 272       f->set_parent (ft.head_, X_AXIS);
 273       f->set_parent (ft.head_, Y_AXIS);
 274       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
 275       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
 276       f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
 277
 278       f->set_property ("direction", scm_from_int (hordir));
 279     }
 280
 281   int finger_prio = 200;
 282   for (int i = 0; i < up.size (); i++)
 283     {
 284       Finger_tuple ft = up[i];
 285       Grob *f = ft.script_;
 286       f->set_parent (ft.head_, X_AXIS);
 287       f->set_property ("script-priority",
 288                        scm_from_int (finger_prio + ft.position_));
 289       f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
 290       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
 291       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
 292
 293       f->set_property ("direction", scm_from_int (UP));
 294     }
 295
 296   for (int i = 0; i < down.size (); i++)
 297     {
 298       Finger_tuple ft = down[i];
 299       Grob *f = ft.script_;
 300       f->set_parent (ft.head_, X_AXIS);
 301       f->set_property ("script-priority",
 302                        scm_from_int (finger_prio + down.size () - ft.position_));
 303
 304       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
 305       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
 306       f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
 307       f->set_property ("direction", scm_from_int (DOWN));
 308     }
 309 }
 310
 311 void
 312 New_fingering_engraver::stop_translation_timestep ()
 313 {
 314   if (fingerings_.size ())
 315     {
 316       position_scripts (get_property ("fingeringOrientations"),
 317                         &fingerings_);
 318       fingerings_.clear ();
 319     }
 320
 321   if (string_numbers_.size ())
 322     {
 323       position_scripts (get_property ("stringNumberOrientations"),
 324                         &string_numbers_);
 325       string_numbers_.clear ();
 326     }
 327
 328   for (int i = articulations_.size (); i--;)
 329     {
 330       Grob *script = articulations_[i].script_;
 331
 332       for (int j = heads_.size (); j--;)
 333         Side_position_interface::add_support (script, heads_[j]);
 334
 335       if (stem_ && to_dir (script->get_property ("side-relative-direction")))
 336         script->set_object ("direction-source", stem_->self_scm ());
 337
 338       if (stem_ && to_boolean (script->get_property ("add-stem-support")))
 339         Side_position_interface::add_support (script, stem_);
 340
 341       if (articulations_[i].follow_into_staff_)
 342         {
 343           script->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
 344           script->set_property ("staff-padding", SCM_EOL);
 345         }
 346     }
 347
 348   stem_ = 0;
 349   heads_.clear ();
 350   articulations_.clear ();
 351 }
 352
 353 New_fingering_engraver::New_fingering_engraver ()
 354 {
 355   stem_ = 0;
 356 }
 357 ADD_ACKNOWLEDGER (New_fingering_engraver, rhythmic_head);
 358 ADD_ACKNOWLEDGER (New_fingering_engraver, stem);
 359
 360 ADD_TRANSLATOR (New_fingering_engraver,
 361                 /* doc */ "Create fingering-scripts for notes in a new chord.  "
 362                 "This engraver is ill-named, since it "
 363                 "also takes care of articulations and harmonic note heads",
 364                 /* create */ "Fingering",
 365                 /* accept */ "",
 366                 /* read */ "fingeringOrientations",
 367                 /* write */ "");