lily/new-fingering-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "engraver.hh"
  21
  22 #include "international.hh"
  23 #include "item.hh"
  24 #include "rhythmic-head.hh"
  25 #include "script-interface.hh"
  26 #include "self-alignment-interface.hh"
  27 #include "side-position-interface.hh"
  28 #include "stem.hh"
  29 #include "stream-event.hh"
  30 #include "warn.hh"
  31
  32 #include "translator.icc"
  33
  34 struct Finger_tuple
  35 {
  36   Grob *head_;
  37   Grob *script_;
  38   Stream_event *note_event_;
  39   Stream_event *finger_event_;
  40   bool follow_into_staff_;
  41   int position_;
  42
  43   Finger_tuple ()
  44   {
  45     position_ = 0;
  46     head_ = script_ = 0;
  47     note_event_ = finger_event_ = 0;
  48     follow_into_staff_ = false;
  49   }
  50 };
  51
  52 bool
  53 operator < (Finger_tuple const &a, Finger_tuple const &b)
  54 {
  55   return a.position_ < b.position_;
  56 }
  57
  58 class New_fingering_engraver : public Engraver
  59 {
  60   vector<Finger_tuple> fingerings_;
  61   vector<Finger_tuple> stroke_fingerings_;
  62   vector<Finger_tuple> articulations_;
  63   vector<Finger_tuple> string_numbers_;
  64
  65   vector<Grob *> heads_;
  66   vector<Grob *> accidentals_;
  67   Grob *stem_;
  68
  69   void position_all ();
  70 public:
  71   TRANSLATOR_DECLARATIONS (New_fingering_engraver);
  72 protected:
  73   void stop_translation_timestep ();
  74   DECLARE_ACKNOWLEDGER (rhythmic_head);
  75   DECLARE_ACKNOWLEDGER (inline_accidental);
  76   DECLARE_ACKNOWLEDGER (stem);
  77   void add_fingering (Grob *, SCM,
  78                       vector<Finger_tuple> *,
  79                       Stream_event *, Stream_event *);
  80   void add_script (Grob *, Stream_event *, Stream_event *);
  81   void add_string (Grob *, Stream_event *, Stream_event *);
  82   void position_scripts (SCM orientations, vector<Finger_tuple> *);
  83 };
  84
  85 void
  86 New_fingering_engraver::acknowledge_inline_accidental (Grob_info inf)
  87 {
  88   accidentals_.push_back (inf.grob ());
  89 }
  90
  91 void
  92 New_fingering_engraver::acknowledge_rhythmic_head (Grob_info inf)
  93 {
  94   Stream_event *note_ev = inf.event_cause ();
  95   if (!note_ev)
  96     return;
  97
  98   SCM arts = note_ev->get_property ("articulations");
  99
 100   for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
 101     {
 102       Stream_event *ev = unsmob_stream_event (scm_car (s));
 103
 104       if (!ev)
 105         continue;
 106
 107       if (ev->in_event_class ("fingering-event"))
 108         add_fingering (inf.grob (),
 109                        ly_symbol2scm ("Fingering"),
 110                        &fingerings_,
 111                        ev, note_ev);
 112       else if (ev->in_event_class ("text-script-event"))
 113         ev->origin ()->warning (_ ("cannot add text scripts to individual note heads"));
 114       else if (ev->in_event_class ("script-event"))
 115         add_script (inf.grob (), ev, note_ev);
 116       else if (ev->in_event_class ("string-number-event"))
 117         {
 118           // String numbers are used in calculating harmonics even
 119           // when we don't want them displayed.  So don't make space
 120           // for them if 'stencil is #f
 121           Grob *g = make_item ("StringNumber", ev->self_scm ());
 122           if (g->get_property ("stencil") != SCM_BOOL_F)
 123             add_fingering (inf.grob (),
 124                            ly_symbol2scm ("StringNumber"), &string_numbers_,
 125                            ev, note_ev);
 126           g->suicide (); // Kill grob created to check stencil
 127         }
 128       else if (ev->in_event_class ("stroke-finger-event"))
 129         add_fingering (inf.grob (),
 130                        ly_symbol2scm ("StrokeFinger"), &stroke_fingerings_,
 131                        ev, note_ev);
 132       else if (ev->in_event_class ("harmonic-event"))
 133         {
 134           inf.grob ()->set_property ("style", ly_symbol2scm ("harmonic"));
 135           Grob *d = unsmob_grob (inf.grob ()->get_object ("dot"));
 136           if (d && !to_boolean (get_property ("harmonicDots")))
 137             d->suicide ();
 138         }
 139     }
 140
 141   heads_.push_back (inf.grob ());
 142 }
 143
 144 void
 145 New_fingering_engraver::acknowledge_stem (Grob_info inf)
 146 {
 147   stem_ = inf.grob ();
 148 }
 149
 150 void
 151 New_fingering_engraver::add_script (Grob *head,
 152                                     Stream_event *event,
 153                                     Stream_event * /* note */)
 154 {
 155   Finger_tuple ft;
 156
 157   Grob *g = make_item ("Script", event->self_scm ());
 158   make_script_from_event (g, context (),
 159                           event->get_property ("articulation-type"), 0);
 160   ft.script_ = g;
 161   ft.script_->set_parent (head, X_AXIS);
 162
 163   SCM forced_dir = event->get_property ("direction");
 164   if (to_dir (forced_dir))
 165     ft.script_->set_property ("direction", forced_dir);
 166
 167   articulations_.push_back (ft);
 168 }
 169
 170 void
 171 New_fingering_engraver::add_fingering (Grob *head,
 172                                        SCM grob_sym,
 173                                        vector<Finger_tuple> *tuple_vector,
 174                                        Stream_event *event,
 175                                        Stream_event *hevent)
 176 {
 177   Finger_tuple ft;
 178
 179   ft.script_ = internal_make_item (grob_sym, event->self_scm (),
 180                                    ly_symbol2string (grob_sym).c_str (),
 181                                    __FILE__, __LINE__, __FUNCTION__);
 182
 183   Side_position_interface::add_support (ft.script_, head);
 184
 185   ft.finger_event_ = event;
 186   ft.note_event_ = hevent;
 187   ft.head_ = head;
 188
 189   tuple_vector->push_back (ft);
 190 }
 191
 192 void
 193 New_fingering_engraver::position_scripts (SCM orientations,
 194                                           vector<Finger_tuple> *scripts)
 195 {
 196   for (vsize i = 0; i < scripts->size (); i++)
 197     if (stem_)
 198       {
 199         Side_position_interface::add_support (scripts->at (i).script_, stem_);
 200         if (Grob *flag = unsmob_grob (stem_->get_object ("flag")))
 201           Side_position_interface::add_support (scripts->at (i).script_, flag);
 202       }
 203
 204   /*
 205     This is not extremely elegant, but we have to do a little
 206     formatting here, because the parent/child relations should be
 207     known before we move on to the next time step.
 208
 209     A more sophisticated approach would be to set both X and Y parents
 210     to the note head, and write a more flexible function for
 211     positioning the fingerings, setting both X and Y coordinates.
 212   */
 213   for (vsize i = 0; i < scripts->size (); i++)
 214     (*scripts)[i].position_ = scm_to_int ((*scripts)[i].head_->get_property ("staff-position"));
 215
 216   for (vsize i = scripts->size (); i--;)
 217     for (vsize j = heads_.size (); j--;)
 218       Side_position_interface::add_support ((*scripts)[i].script_, heads_[j]);
 219
 220   vector<Finger_tuple> up, down, horiz;
 221   for (vsize i = scripts->size (); i--;)
 222     {
 223       SCM d = (*scripts)[i].finger_event_->get_property ("direction");
 224       if (to_dir (d))
 225         {
 226           ((to_dir (d) == UP) ? up : down).push_back ((*scripts)[i]);
 227           scripts->erase (scripts->begin () + i);
 228         }
 229     }
 230
 231   vector_sort (*scripts, less<Finger_tuple> ());
 232
 233   bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
 234   bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
 235   bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
 236   bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
 237   Direction hordir = (right_p) ? RIGHT : LEFT;
 238   if (left_p || right_p)
 239     {
 240       if (up_p && !up.size () && scripts->size ())
 241         {
 242           up.push_back (scripts->back ());
 243           scripts->pop_back ();
 244         }
 245
 246       if (down_p && !down.size () && scripts->size ())
 247         {
 248           down.push_back ((*scripts)[0]);
 249           scripts->erase (scripts->begin ());
 250         }
 251
 252       horiz.insert (horiz.end (), scripts->begin (), scripts->end ());
 253     }
 254   else if (up_p && down_p)
 255     {
 256       int center = scripts->size () / 2;
 257       down.insert (down.end (), scripts->begin (), scripts->begin () + center);
 258       up.insert (up.end (), scripts->begin () + center, scripts->end ());
 259     }
 260   else if (up_p)
 261     {
 262       up.insert (up.end (), scripts->begin (), scripts->end ());
 263       scripts->clear ();
 264     }
 265   else
 266     {
 267       if (!down_p)
 268         {
 269           warning (_ ("no placement found for fingerings"));
 270           warning (_ ("placing below"));
 271         }
 272       down.insert (down.end (), scripts->begin (), scripts->end ());
 273       scripts->clear ();
 274     }
 275
 276   for (vsize i = 0; i < horiz.size (); i++)
 277     {
 278       Finger_tuple ft = horiz[i];
 279       Grob *f = ft.script_;
 280       f->set_parent (ft.head_, X_AXIS);
 281       f->set_parent (ft.head_, Y_AXIS);
 282       f->set_property ("avoid-slur", ly_symbol2scm ("inside"));
 283       if (hordir == LEFT
 284           && unsmob_grob (ft.head_->get_object ("accidental-grob")))
 285         Side_position_interface::add_support (f,
 286                                               unsmob_grob (ft.head_->get_object ("accidental-grob")));
 287       else if (unsmob_grob (ft.head_->get_object ("dot")))
 288         Side_position_interface::add_support (f,
 289                                               unsmob_grob (ft.head_->get_object ("dot")));
 290
 291       Self_alignment_interface::set_align_self (f, Y_AXIS);
 292       Self_alignment_interface::set_center_parent (f, Y_AXIS);
 293       Side_position_interface::set_axis (f, X_AXIS);
 294
 295       f->set_property ("direction", scm_from_int (hordir));
 296     }
 297
 298   Drul_array< vector<Finger_tuple> > vertical (down, up);
 299   for (DOWN_and_UP (d))
 300     {
 301       for (vsize i = 0; i < vertical[d].size (); i++)
 302         {
 303           Finger_tuple ft = vertical[d][i];
 304           Grob *f = ft.script_;
 305           int finger_prio = robust_scm2int (f->get_property ("script-priority"), 200);
 306           f->set_parent (ft.head_, X_AXIS);
 307           f->set_property ("script-priority",
 308                            scm_from_int (finger_prio + d * ft.position_));
 309
 310           Self_alignment_interface::set_align_self (f, X_AXIS);
 311           Self_alignment_interface::set_center_parent (f, X_AXIS);
 312           Side_position_interface::set_axis (f, Y_AXIS);
 313
 314           f->set_property ("direction", scm_from_int (d));
 315         }
 316     }
 317 }
 318
 319 void
 320 New_fingering_engraver::stop_translation_timestep ()
 321 {
 322   position_all ();
 323   stem_ = 0;
 324   heads_.clear ();
 325 }
 326
 327 void
 328 New_fingering_engraver::position_all ()
 329 {
 330   if (fingerings_.size ())
 331     {
 332       position_scripts (get_property ("fingeringOrientations"),
 333                         &fingerings_);
 334       fingerings_.clear ();
 335     }
 336
 337   if (string_numbers_.size ())
 338     {
 339       position_scripts (get_property ("stringNumberOrientations"),
 340                         &string_numbers_);
 341       string_numbers_.clear ();
 342     }
 343
 344   if (stroke_fingerings_.size ())
 345     {
 346       position_scripts (get_property ("strokeFingerOrientations"),
 347                         &stroke_fingerings_);
 348       stroke_fingerings_.clear ();
 349     }
 350
 351   for (vsize i = articulations_.size (); i--;)
 352     {
 353       Grob *script = articulations_[i].script_;
 354
 355       for (vsize j = 0; j < accidentals_.size (); j++)
 356         Side_position_interface::add_support (script, accidentals_[j]);
 357
 358       accidentals_.resize (0);
 359       for (vsize j = heads_.size (); j--;)
 360         Side_position_interface::add_support (script, heads_[j]);
 361
 362       if (stem_ && to_dir (script->get_property ("side-relative-direction")))
 363         script->set_object ("direction-source", stem_->self_scm ());
 364
 365       if (stem_ && to_boolean (script->get_property ("add-stem-support")))
 366         Side_position_interface::add_support (script, stem_);
 367     }
 368   articulations_.clear ();
 369 }
 370
 371 New_fingering_engraver::New_fingering_engraver ()
 372 {
 373   stem_ = 0;
 374 }
 375
 376 ADD_ACKNOWLEDGER (New_fingering_engraver, rhythmic_head);
 377 ADD_ACKNOWLEDGER (New_fingering_engraver, inline_accidental);
 378 ADD_ACKNOWLEDGER (New_fingering_engraver, stem);
 379
 380 ADD_TRANSLATOR (New_fingering_engraver,
 381                 /* doc */
 382                 "Create fingering scripts for notes in a new chord.  This"
 383                 " engraver is ill-named, since it also takes care of"
 384                 " articulations and harmonic note heads.",
 385
 386                 /* create */
 387                 "Fingering "
 388                 "StringNumber "
 389                 "StrokeFinger "
 390                 "Script ",
 391
 392                 /* read */
 393                 "fingeringOrientations "
 394                 "harmonicDots "
 395                 "strokeFingerOrientations "
 396                 "stringNumberOrientations ",
 397
 398                 /* write */
 399                 ""
 400                );