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 "stream-event.hh"
  18 #include "warn.hh"
  19
  20 #include "translator.icc"
  21
  22 struct Finger_tuple
  23 {
  24   Grob *head_;
  25   Grob *script_;
  26   Stream_event *note_event_;
  27   Stream_event *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 };
  39
  40 bool
  41 operator< (Finger_tuple const &a, Finger_tuple const &b)
  42 {
  43   return a.position_ < b.position_;
  44 }
  45
  46 class New_fingering_engraver : public Engraver
  47 {
  48   vector<Finger_tuple> fingerings_;
  49   vector<Finger_tuple> articulations_;
  50   vector<Finger_tuple> string_numbers_;
  51
  52   vector<Grob*> heads_;
  53   Grob *stem_;
  54
  55   void position_all ();
  56 public:
  57   TRANSLATOR_DECLARATIONS (New_fingering_engraver);
  58 protected:
  59   void stop_translation_timestep ();
  60   DECLARE_ACKNOWLEDGER (rhythmic_head);
  61   DECLARE_ACKNOWLEDGER (stem);
  62   void add_fingering (Grob *, Stream_event *, Stream_event *);
  63   void add_script (Grob *, Stream_event *, Stream_event *);
  64   void add_string (Grob *, Stream_event *, Stream_event *);
  65   void position_scripts (SCM orientations, vector<Finger_tuple> *);
  66 };
  67
  68 void
  69 New_fingering_engraver::acknowledge_rhythmic_head (Grob_info inf)
  70 {
  71   Stream_event *note_ev = inf.event_cause ();
  72   if (!note_ev)
  73     return;
  74
  75   SCM arts = note_ev->get_property ("articulations");
  76
  77   for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
  78     {
  79       Stream_event *ev = unsmob_stream_event (scm_car (s));
  80
  81       if (!ev)
  82         continue;
  83
  84       if (ev->in_event_class ("fingering-event"))
  85         add_fingering (inf.grob (), ev, note_ev);
  86       else if (ev->in_event_class ("text-script-event"))
  87         ev->origin ()->warning (_ ("can't add text scripts to individual note heads"));
  88       else if (ev->in_event_class ("script-event"))
  89         add_script (inf.grob (), ev, note_ev);
  90       else if (ev->in_event_class ("string-number-event"))
  91         add_string (inf.grob (), ev, note_ev);
  92       else if (ev->in_event_class ("harmonic-event"))
  93         {
  94           inf.grob ()->set_property ("style", ly_symbol2scm ("harmonic"));
  95           Grob *d = unsmob_grob (inf.grob ()->get_object ("dot"));
  96           if (d)
  97             d->suicide ();
  98         }
  99     }
 100
 101   heads_.push_back (inf.grob ());
 102 }
 103
 104 void
 105 New_fingering_engraver::acknowledge_stem (Grob_info inf)
 106 {
 107   stem_ = inf.grob ();
 108 }
 109
 110 void
 111 New_fingering_engraver::add_script (Grob *head,
 112                                     Stream_event *event,
 113                                     Stream_event *note)
 114 {
 115   (void) note;
 116
 117   Finger_tuple ft;
 118
 119   Grob *g = make_item ("Script", event->self_scm ());
 120   make_script_from_event (g, context (), event->get_property ("articulation-type"), 0);
 121   if (g)
 122     {
 123       ft.script_ = g;
 124       ft.script_->set_parent (head, X_AXIS);
 125
 126       articulations_.push_back (ft);
 127     }
 128 }
 129
 130 void
 131 New_fingering_engraver::add_fingering (Grob *head,
 132                                        Stream_event *event,
 133                                        Stream_event *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_from_int (d), scm_from_int (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_back (ft);
 165 }
 166
 167 void
 168 New_fingering_engraver::add_string (Grob *head,
 169                                     Stream_event *event,
 170                                     Stream_event *hevent)
 171 {
 172   Finger_tuple ft;
 173
 174   ft.script_ = make_item ("StringNumber", event->self_scm ());
 175
 176   Side_position_interface::add_support (ft.script_, head);
 177
 178   int d = scm_to_int (event->get_property ("string-number"));
 179
 180   SCM sstr = scm_number_to_string (scm_from_int (d), scm_from_int (10));
 181   ft.script_->set_property ("text", sstr);
 182
 183   ft.finger_event_ = event;
 184   ft.note_event_ = hevent;
 185   ft.head_ = head;
 186
 187   string_numbers_.push_back (ft);
 188 }
 189
 190 void
 191 New_fingering_engraver::position_scripts (SCM orientations,
 192                                           vector<Finger_tuple> *scripts)
 193 {
 194   for (vsize i = 0; i < scripts->size (); i++)
 195     if (stem_ && to_boolean (scripts->at (i).script_->get_property ("add-stem-support")))
 196       Side_position_interface::add_support (scripts->at (i).script_, stem_);
 197
 198   /*
 199     This is not extremely elegant, but we have to do a little
 200     formatting here, because the parent/child relations should be
 201     known before we move on to the next time step.
 202
 203     A more sophisticated approach would be to set both X and Y parents
 204     to the note head, and write a more flexible function for
 205     positioning the fingerings, setting both X and Y coordinates.
 206   */
 207   for (vsize i = 0; i < scripts->size (); i++)
 208     (*scripts)[i].position_ = scm_to_int ((*scripts)[i].head_->get_property ("staff-position"));
 209
 210   for (vsize i = scripts->size (); i--;)
 211     for (vsize j = heads_.size (); j--;)
 212       Side_position_interface::add_support ((*scripts)[i].script_, heads_[j]);
 213
 214   vector<Finger_tuple> up, down, horiz;
 215   for (vsize i = scripts->size (); i--;)
 216     {
 217       SCM d = (*scripts)[i].finger_event_->get_property ("direction");
 218       if (to_dir (d))
 219         {
 220           ((to_dir (d) == UP) ? up : down).push_back ((*scripts)[i]);
 221           scripts->erase (scripts->begin () + i);
 222         }
 223     }
 224
 225   vector_sort (*scripts, less<Finger_tuple> ());
 226
 227   bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
 228   bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
 229   bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
 230   bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
 231   Direction hordir = (right_p) ? RIGHT : LEFT;
 232   if (left_p || right_p)
 233     {
 234       if (up_p && !up.size () && scripts->size ())
 235         {
 236           up.push_back (scripts->back ());
 237           scripts->pop_back ();
 238         }
 239
 240       if (down_p && !down.size () && scripts->size ())
 241         {
 242           down.push_back ((*scripts)[0]);
 243           scripts->erase (scripts->begin ());
 244         }
 245
 246       horiz.insert (horiz.end (), scripts->begin (), scripts->end ());
 247     }
 248   else if (up_p && down_p)
 249     {
 250       int center = scripts->size () / 2;
 251       down.insert (down.end (), scripts->begin (), scripts->begin () + center);
 252       up.insert (up.end (), scripts->begin () + center, scripts->end ());
 253     }
 254   else if (up_p)
 255     {
 256       up.insert (up.end (), scripts->begin (), scripts->end ());
 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.insert (down.end (), scripts->begin (), scripts->end ());
 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< 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   position_all();
 312   stem_ = 0;
 313   heads_.clear ();
 314 }
 315
 316
 317 void
 318 New_fingering_engraver::position_all ()
 319 {
 320   if (fingerings_.size ())
 321     {
 322       position_scripts (get_property ("fingeringOrientations"),
 323                         &fingerings_);
 324       fingerings_.clear ();
 325     }
 326
 327   if (string_numbers_.size ())
 328     {
 329       position_scripts (get_property ("stringNumberOrientations"),
 330                         &string_numbers_);
 331       string_numbers_.clear ();
 332     }
 333
 334   for (vsize i = articulations_.size (); i--;)
 335     {
 336       Grob *script = articulations_[i].script_;
 337
 338       for (vsize j = heads_.size (); j--;)
 339         Side_position_interface::add_support (script, heads_[j]);
 340
 341       if (stem_ && to_dir (script->get_property ("side-relative-direction")))
 342         script->set_object ("direction-source", stem_->self_scm ());
 343
 344       if (stem_ && to_boolean (script->get_property ("add-stem-support")))
 345         Side_position_interface::add_support (script, stem_);
 346     }
 347   articulations_.clear ();
 348 }
 349
 350 New_fingering_engraver::New_fingering_engraver ()
 351 {
 352   stem_ = 0;
 353 }
 354
 355
 356 ADD_ACKNOWLEDGER (New_fingering_engraver, rhythmic_head);
 357 ADD_ACKNOWLEDGER (New_fingering_engraver, stem);
 358
 359 ADD_TRANSLATOR (New_fingering_engraver,
 360                 /* doc */ "Create fingering-scripts for notes in a new chord.  "
 361                 "This engraver is ill-named, since it "
 362                 "also takes care of articulations and harmonic note heads",
 363                 /* create */ "Fingering",
 364                 /* accept */ "",
 365                 /* read */ "fingeringOrientations",
 366                 /* write */ "");