lily/new-fingering-engraver.cc

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