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