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--2009 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 "item.hh"
  19 #include "warn.hh"
  20
  21 #include "translator.icc"
  22
  23
  24
  25 struct Finger_tuple
  26 {
  27   Grob *head_;
  28   Grob *script_;
  29   Stream_event *note_event_;
  30   Stream_event *finger_event_;
  31   bool follow_into_staff_;
  32   int position_;
  33
  34   Finger_tuple ()
  35   {
  36     position_ = 0;
  37     head_ = script_ = 0;
  38     note_event_ = finger_event_ = 0;
  39     follow_into_staff_ = false;
  40   }
  41 };
  42
  43 bool
  44 operator< (Finger_tuple const &a, Finger_tuple const &b)
  45 {
  46   return a.position_ < b.position_;
  47 }
  48
  49 class New_fingering_engraver : public Engraver
  50 {
  51   vector<Finger_tuple> fingerings_;
  52   vector<Finger_tuple> stroke_fingerings_;
  53   vector<Finger_tuple> articulations_;
  54   vector<Finger_tuple> string_numbers_;
  55
  56   vector<Grob*> heads_;
  57   Grob *stem_;
  58
  59   void position_all ();
  60 public:
  61   TRANSLATOR_DECLARATIONS (New_fingering_engraver);
  62 protected:
  63   void stop_translation_timestep ();
  64   DECLARE_ACKNOWLEDGER (rhythmic_head);
  65   DECLARE_ACKNOWLEDGER (stem);
  66   void add_fingering (Grob *, SCM,
  67                       vector<Finger_tuple> *,
  68                       Stream_event *, Stream_event *);
  69   void add_script (Grob *, Stream_event *, Stream_event *);
  70   void add_string (Grob *, Stream_event *, Stream_event *);
  71   void position_scripts (SCM orientations, vector<Finger_tuple> *);
  72 };
  73
  74 void
  75 New_fingering_engraver::acknowledge_rhythmic_head (Grob_info inf)
  76 {
  77   Stream_event *note_ev = inf.event_cause ();
  78   if (!note_ev)
  79     return;
  80
  81   SCM arts = note_ev->get_property ("articulations");
  82
  83   for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
  84     {
  85       Stream_event *ev = unsmob_stream_event (scm_car (s));
  86
  87       if (!ev)
  88         continue;
  89
  90       if (ev->in_event_class ("fingering-event"))
  91         add_fingering (inf.grob (),
  92                        ly_symbol2scm ("Fingering"),
  93                        &fingerings_,
  94                        ev, note_ev);
  95       else if (ev->in_event_class ("text-script-event"))
  96         ev->origin ()->warning (_ ("cannot add text scripts to individual note heads"));
  97       else if (ev->in_event_class ("script-event"))
  98         add_script (inf.grob (), ev, note_ev);
  99       else if (ev->in_event_class ("string-number-event"))
 100         add_fingering (inf.grob (),
 101                        ly_symbol2scm ("StringNumber"), &string_numbers_,
 102                        ev, note_ev);
 103       else if (ev->in_event_class ("stroke-finger-event"))
 104         add_fingering (inf.grob (),
 105                        ly_symbol2scm ("StrokeFinger"), &stroke_fingerings_,
 106                        ev, note_ev);
 107       else if (ev->in_event_class ("harmonic-event"))
 108         {
 109           inf.grob ()->set_property ("style", ly_symbol2scm ("harmonic"));
 110           Grob *d = unsmob_grob (inf.grob ()->get_object ("dot"));
 111           if (d && !to_boolean (get_property ("harmonicDots")))
 112             d->suicide ();
 113         }
 114     }
 115
 116   heads_.push_back (inf.grob ());
 117 }
 118
 119 void
 120 New_fingering_engraver::acknowledge_stem (Grob_info inf)
 121 {
 122   stem_ = inf.grob ();
 123 }
 124
 125 void
 126 New_fingering_engraver::add_script (Grob *head,
 127                                     Stream_event *event,
 128                                     Stream_event * /* note */)
 129 {
 130   Finger_tuple ft;
 131
 132   Grob *g = make_item ("Script", event->self_scm ());
 133   make_script_from_event (g, context (),
 134                           event->get_property ("articulation-type"), 0);
 135   ft.script_ = g;
 136   ft.script_->set_parent (head, X_AXIS);
 137
 138   articulations_.push_back (ft);
 139 }
 140
 141 void
 142 New_fingering_engraver::add_fingering (Grob *head,
 143                                        SCM grob_sym,
 144                                        vector<Finger_tuple> *tuple_vector,
 145                                        Stream_event *event,
 146                                        Stream_event *hevent)
 147 {
 148   Finger_tuple ft;
 149
 150   ft.script_ = internal_make_item (grob_sym, event->self_scm (),
 151                                    ly_symbol2string (grob_sym).c_str (),
 152                                    __FILE__, __LINE__, __FUNCTION__
 153                                    );
 154
 155   Side_position_interface::add_support (ft.script_, head);
 156
 157   ft.finger_event_ = event;
 158   ft.note_event_ = hevent;
 159   ft.head_ = head;
 160
 161   tuple_vector->push_back (ft);
 162 }
 163
 164 void
 165 New_fingering_engraver::position_scripts (SCM orientations,
 166                                           vector<Finger_tuple> *scripts)
 167 {
 168   for (vsize i = 0; i < scripts->size (); i++)
 169     if (stem_ && to_boolean (scripts->at (i).script_->get_property ("add-stem-support")))
 170       Side_position_interface::add_support (scripts->at (i).script_, stem_);
 171
 172   /*
 173     This is not extremely elegant, but we have to do a little
 174     formatting here, because the parent/child relations should be
 175     known before we move on to the next time step.
 176
 177     A more sophisticated approach would be to set both X and Y parents
 178     to the note head, and write a more flexible function for
 179     positioning the fingerings, setting both X and Y coordinates.
 180   */
 181   for (vsize i = 0; i < scripts->size (); i++)
 182     (*scripts)[i].position_ = scm_to_int ((*scripts)[i].head_->get_property ("staff-position"));
 183
 184   for (vsize i = scripts->size (); i--;)
 185     for (vsize j = heads_.size (); j--;)
 186       Side_position_interface::add_support ((*scripts)[i].script_, heads_[j]);
 187
 188   vector<Finger_tuple> up, down, horiz;
 189   for (vsize i = scripts->size (); i--;)
 190     {
 191       SCM d = (*scripts)[i].finger_event_->get_property ("direction");
 192       if (to_dir (d))
 193         {
 194           ((to_dir (d) == UP) ? up : down).push_back ((*scripts)[i]);
 195           scripts->erase (scripts->begin () + i);
 196         }
 197     }
 198
 199   vector_sort (*scripts, less<Finger_tuple> ());
 200
 201   bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
 202   bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
 203   bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
 204   bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
 205   Direction hordir = (right_p) ? RIGHT : LEFT;
 206   if (left_p || right_p)
 207     {
 208       if (up_p && !up.size () && scripts->size ())
 209         {
 210           up.push_back (scripts->back ());
 211           scripts->pop_back ();
 212         }
 213
 214       if (down_p && !down.size () && scripts->size ())
 215         {
 216           down.push_back ((*scripts)[0]);
 217           scripts->erase (scripts->begin ());
 218         }
 219
 220       horiz.insert (horiz.end (), scripts->begin (), scripts->end ());
 221     }
 222   else if (up_p && down_p)
 223     {
 224       int center = scripts->size () / 2;
 225       down.insert (down.end (), scripts->begin (), scripts->begin () + center);
 226       up.insert (up.end (), scripts->begin () + center, scripts->end ());
 227     }
 228   else if (up_p)
 229     {
 230       up.insert (up.end (), scripts->begin (), scripts->end ());
 231       scripts->clear ();
 232     }
 233   else
 234     {
 235       if (!down_p)
 236         {
 237           warning (_ ("no placement found for fingerings"));
 238           warning (_ ("placing below"));
 239         }
 240       down.insert (down.end (), scripts->begin (), scripts->end ());
 241       scripts->clear ();
 242     }
 243
 244   for (vsize i = 0; i < horiz.size (); i++)
 245     {
 246       Finger_tuple ft = horiz[i];
 247       Grob *f = ft.script_;
 248       f->set_parent (ft.head_, X_AXIS);
 249       f->set_parent (ft.head_, Y_AXIS);
 250       f->set_property ("avoid-slur", SCM_BOOL_F);
 251       if (hordir == LEFT
 252           && unsmob_grob (ft.head_->get_object ("accidental-grob")))
 253         Side_position_interface::add_support (f,
 254                                               unsmob_grob (ft.head_->get_object ("accidental-grob")));
 255
 256       Self_alignment_interface::set_align_self (f, Y_AXIS);
 257       Self_alignment_interface::set_center_parent (f, Y_AXIS);
 258       Side_position_interface::set_axis (f, X_AXIS);
 259
 260       f->set_property ("direction", scm_from_int (hordir));
 261     }
 262
 263   Direction d = DOWN;
 264   Drul_array< vector<Finger_tuple> > vertical (down, up);
 265   do
 266     {
 267       for (vsize i = 0; i < vertical[d].size (); i++)
 268         {
 269           Finger_tuple ft = vertical[d][i];
 270           Grob *f = ft.script_;
 271           int finger_prio = robust_scm2int (f->get_property ("script-priority"), 200);
 272           f->set_parent (ft.head_, X_AXIS);
 273           f->set_property ("script-priority",
 274                            scm_from_int (finger_prio + d * ft.position_));
 275
 276           Self_alignment_interface::set_align_self (f, X_AXIS);
 277           Self_alignment_interface::set_center_parent (f, X_AXIS);
 278           Side_position_interface::set_axis (f, Y_AXIS);
 279
 280           f->set_property ("direction", scm_from_int (d));
 281         }
 282     }
 283   while (flip (&d) != DOWN);
 284 }
 285
 286 void
 287 New_fingering_engraver::stop_translation_timestep ()
 288 {
 289   position_all ();
 290   stem_ = 0;
 291   heads_.clear ();
 292 }
 293
 294
 295 void
 296 New_fingering_engraver::position_all ()
 297 {
 298   if (fingerings_.size ())
 299     {
 300       position_scripts (get_property ("fingeringOrientations"),
 301                         &fingerings_);
 302       fingerings_.clear ();
 303     }
 304
 305   if (string_numbers_.size ())
 306     {
 307       position_scripts (get_property ("stringNumberOrientations"),
 308                         &string_numbers_);
 309       string_numbers_.clear ();
 310     }
 311
 312   if (stroke_fingerings_.size ())
 313     {
 314       position_scripts (get_property ("strokeFingerOrientations"),
 315                         &stroke_fingerings_);
 316       stroke_fingerings_.clear ();
 317     }
 318
 319   for (vsize i = articulations_.size (); i--;)
 320     {
 321       Grob *script = articulations_[i].script_;
 322
 323       for (vsize j = heads_.size (); j--;)
 324         Side_position_interface::add_support (script, heads_[j]);
 325
 326       if (stem_ && to_dir (script->get_property ("side-relative-direction")))
 327         script->set_object ("direction-source", stem_->self_scm ());
 328
 329       if (stem_ && to_boolean (script->get_property ("add-stem-support")))
 330         Side_position_interface::add_support (script, stem_);
 331     }
 332   articulations_.clear ();
 333 }
 334
 335 New_fingering_engraver::New_fingering_engraver ()
 336 {
 337   stem_ = 0;
 338 }
 339
 340
 341 ADD_ACKNOWLEDGER (New_fingering_engraver, rhythmic_head);
 342 ADD_ACKNOWLEDGER (New_fingering_engraver, stem);
 343
 344 ADD_TRANSLATOR (New_fingering_engraver,
 345                 /* doc */
 346                 "Create fingering scripts for notes in a new chord.  This"
 347                 " engraver is ill-named, since it also takes care of"
 348                 " articulations and harmonic note heads.",
 349
 350                 /* create */
 351                 "Fingering "
 352                 "StringNumber "
 353                 "StrokeFinger "
 354                 "Script ",
 355
 356                 /* read */
 357                 "fingeringOrientations "
 358                 "harmonicDots "
 359                 "strokeFingerOrientations "
 360                 "stringNumberOrientations ",
 361
 362                 /* write */
 363                 ""
 364                 );