lily/accidental-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5   Modified 2001--2002 by Rune Zedeler <rz@daimi.au.dk>
   6
   7   LilyPond is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   LilyPond is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "accidental-placement.hh"
  22 #include "arpeggio.hh"
  23 #include "context.hh"
  24 #include "duration.hh"
  25 #include "engraver.hh"
  26 #include "international.hh"
  27 #include "item.hh"
  28 #include "pitch.hh"
  29 #include "protected-scm.hh"
  30 #include "rhythmic-head.hh"
  31 #include "separation-item.hh"
  32 #include "side-position-interface.hh"
  33 #include "spanner.hh"
  34 #include "stream-event.hh"
  35 #include "tie.hh"
  36 #include "warn.hh"
  37
  38 #include "translator.icc"
  39
  40 class Accidental_entry
  41 {
  42 public:
  43   bool done_;
  44   Stream_event *melodic_;
  45   Grob *accidental_;
  46   Context *origin_;
  47   Engraver *origin_engraver_;
  48   Grob *head_;
  49   bool tied_;
  50
  51   Accidental_entry ();
  52 };
  53
  54 Accidental_entry::Accidental_entry ()
  55 {
  56   tied_ = false;
  57   done_ = false;
  58   melodic_ = 0;
  59   accidental_ = 0;
  60   origin_ = 0;
  61   origin_engraver_ = 0;
  62   head_ = 0;
  63 }
  64
  65 class Accidental_engraver : public Engraver
  66 {
  67   void update_local_key_signature (SCM new_signature);
  68   void create_accidental (Accidental_entry *entry, bool, bool);
  69   Grob *make_standard_accidental (Stream_event *note, Grob *note_head, Engraver *trans, bool);
  70   Grob *make_suggested_accidental (Stream_event *note, Grob *note_head, Engraver *trans);
  71
  72 protected:
  73   TRANSLATOR_DECLARATIONS (Accidental_engraver);
  74   void process_music ();
  75
  76   void acknowledge_end_tie (Grob_info);
  77   void acknowledge_arpeggio (Grob_info);
  78   void acknowledge_rhythmic_head (Grob_info);
  79   void acknowledge_finger (Grob_info);
  80   void acknowledge_note_column (Grob_info);
  81
  82   void stop_translation_timestep ();
  83   void process_acknowledged ();
  84
  85   virtual void finalize ();
  86   virtual void derived_mark () const;
  87
  88 public:
  89   SCM last_keysig_;
  90
  91   vector<Grob *> left_objects_;
  92   vector<Grob *> right_objects_;
  93
  94   Grob *accidental_placement_;
  95
  96   vector<Accidental_entry> accidentals_;
  97   vector<Spanner *> ties_;
  98   vector<Grob *> note_columns_;
  99 };
 100
 101 /*
 102   localAlterations is changed at runtime, which means that references
 103   in grobs should always store ly_deep_copy ()s of those.
 104 */
 105
 106 Accidental_engraver::Accidental_engraver ()
 107 {
 108   accidental_placement_ = 0;
 109   last_keysig_ = SCM_EOL;
 110 }
 111
 112 void
 113 Accidental_engraver::derived_mark () const
 114 {
 115   scm_gc_mark (last_keysig_);
 116 }
 117
 118 void
 119 Accidental_engraver::update_local_key_signature (SCM new_sig)
 120 {
 121   last_keysig_ = new_sig;
 122   set_context_property_on_children (context (),
 123                                     ly_symbol2scm ("localAlterations"),
 124                                     new_sig);
 125
 126   Context *trans = context ()->get_parent_context ();
 127
 128   /*
 129     Reset parent contexts so that e.g. piano-accidentals won't remember old
 130     cross-staff accidentals after key-sig-changes.
 131   */
 132
 133   SCM val;
 134   while (trans && trans->here_defined (ly_symbol2scm ("localAlterations"), &val))
 135     {
 136       trans->set_property ("localAlterations", ly_deep_copy (last_keysig_));
 137       trans = trans->get_parent_context ();
 138     }
 139 }
 140
 141 struct Accidental_result
 142 {
 143   bool need_acc;
 144   bool need_restore;
 145
 146   Accidental_result ()
 147   {
 148     need_restore = need_acc = false;
 149   }
 150
 151   Accidental_result (bool restore, bool acc)
 152   {
 153     need_restore = restore;
 154     need_acc = acc;
 155   }
 156
 157   Accidental_result (SCM scm)
 158   {
 159     need_restore = to_boolean (scm_car (scm));
 160     need_acc = to_boolean (scm_cdr (scm));
 161   }
 162
 163   int score () const
 164   {
 165     return need_acc ? 1 : 0
 166            + need_restore ? 1 : 0;
 167   }
 168 };
 169
 170 static
 171 Accidental_result
 172 check_pitch_against_rules (Pitch const &pitch, Context *origin,
 173                            SCM rules, int bar_number, SCM measurepos)
 174 {
 175   Accidental_result result;
 176   SCM pitch_scm = pitch.smobbed_copy ();
 177   SCM barnum_scm = scm_from_int (bar_number);
 178
 179   if (scm_is_pair (rules) && !scm_is_symbol (scm_car (rules)))
 180     warning (_f ("accidental typesetting list must begin with context-name: %s",
 181                  ly_scm2string (scm_car (rules)).c_str ()));
 182
 183   for (; scm_is_pair (rules) && origin; rules = scm_cdr (rules))
 184     {
 185       SCM rule = scm_car (rules);
 186       if (ly_is_procedure (rule))
 187         {
 188           SCM rule_result_scm = scm_call_4 (rule, origin->self_scm (),
 189                                             pitch_scm, barnum_scm, measurepos);
 190           Accidental_result rule_result (rule_result_scm);
 191
 192           result.need_acc |= rule_result.need_acc;
 193           result.need_restore |= rule_result.need_restore;
 194         }
 195
 196       /*
 197         If symbol then it is a context name.  Scan parent contexts to
 198         find it.
 199       */
 200       else if (scm_is_symbol (rule))
 201         {
 202           Context *dad = find_context_above (origin, rule);
 203           if (dad)
 204             origin = dad;
 205         }
 206       else
 207         warning (_f ("procedure or context-name expected for accidental rule, found %s",
 208                      print_scm_val (rule).c_str ()));
 209     }
 210
 211   return result;
 212 }
 213
 214 void
 215 Accidental_engraver::process_acknowledged ()
 216 {
 217   if (accidentals_.size () && !accidentals_.back ().done_)
 218     {
 219       SCM accidental_rules = get_property ("autoAccidentals");
 220       SCM cautionary_rules = get_property ("autoCautionaries");
 221       SCM measure_position = get_property ("measurePosition");
 222       int barnum = measure_number (context ());
 223
 224       for (vsize i = 0; i < accidentals_.size (); i++)
 225         {
 226           if (accidentals_[i].done_)
 227             continue;
 228           accidentals_[i].done_ = true;
 229
 230           Stream_event *note = accidentals_[i].melodic_;
 231           Context *origin = accidentals_[i].origin_;
 232
 233           Pitch *pitch = unsmob<Pitch> (note->get_property ("pitch"));
 234           if (!pitch)
 235             continue;
 236
 237           Accidental_result acc = check_pitch_against_rules (*pitch, origin, accidental_rules,
 238                                                              barnum, measure_position);
 239           Accidental_result caut = check_pitch_against_rules (*pitch, origin, cautionary_rules,
 240                                                               barnum, measure_position);
 241
 242           bool cautionary = to_boolean (note->get_property ("cautionary"));
 243           if (caut.score () > acc.score ())
 244             {
 245               acc.need_acc |= caut.need_acc;
 246               acc.need_restore |= caut.need_restore;
 247
 248               cautionary = true;
 249             }
 250
 251           bool forced = to_boolean (note->get_property ("force-accidental"));
 252           if (!acc.need_acc && forced)
 253             acc.need_acc = true;
 254
 255           /*
 256             Cannot look for ties: it's not guaranteed that they reach
 257             us before the notes.
 258           */
 259           if (!note->in_event_class ("trill-span-event"))
 260             {
 261               if (acc.need_acc)
 262                 create_accidental (&accidentals_[i], acc.need_restore, cautionary);
 263
 264               if (forced || cautionary)
 265                 accidentals_[i].accidental_->set_property ("forced", SCM_BOOL_T);
 266             }
 267         }
 268     }
 269 }
 270
 271 void
 272 Accidental_engraver::create_accidental (Accidental_entry *entry,
 273                                         bool restore_natural,
 274                                         bool cautionary)
 275 {
 276   Stream_event *note = entry->melodic_;
 277   Grob *support = entry->head_;
 278   bool as_suggestion = to_boolean (entry->origin_->get_property ("suggestAccidentals"));
 279   Grob *a = 0;
 280   if (as_suggestion)
 281     a = make_suggested_accidental (note, support, entry->origin_engraver_);
 282   else
 283     a = make_standard_accidental (note, support, entry->origin_engraver_, cautionary);
 284
 285   if (restore_natural)
 286     {
 287       if (to_boolean (get_property ("extraNatural")))
 288         a->set_property ("restore-first", SCM_BOOL_T);
 289     }
 290
 291   entry->accidental_ = a;
 292 }
 293
 294 Grob *
 295 Accidental_engraver::make_standard_accidental (Stream_event * /* note */,
 296                                                Grob *note_head,
 297                                                Engraver *trans,
 298                                                bool cautionary)
 299 {
 300   /*
 301     We construct the accidentals at the originating Voice
 302     level, so that we get the property settings for
 303     Accidental from the respective Voice.
 304   */
 305   Grob *a = 0;
 306   if (cautionary)
 307     a = trans->make_item ("AccidentalCautionary", note_head->self_scm ());
 308   else
 309     a = trans->make_item ("Accidental", note_head->self_scm ());
 310
 311   /*
 312     We add the accidentals to the support of the arpeggio,
 313     so it is put left of the accidentals.
 314   */
 315   for (vsize i = 0; i < left_objects_.size (); i++)
 316     {
 317       if (scm_is_eq (left_objects_[i]->get_property ("side-axis"), scm_from_int (X_AXIS)))
 318         Side_position_interface::add_support (left_objects_[i], a);
 319     }
 320
 321   for (vsize i = 0; i < right_objects_.size (); i++)
 322     Side_position_interface::add_support (a, right_objects_[i]);
 323
 324   a->set_parent (note_head, Y_AXIS);
 325
 326   if (!accidental_placement_)
 327     accidental_placement_ = make_item ("AccidentalPlacement",
 328                                        a->self_scm ());
 329
 330   Accidental_placement::add_accidental
 331     (accidental_placement_, a,
 332      scm_is_eq (get_property ("accidentalGrouping"), ly_symbol2scm ("voice")),
 333      (long) trans);
 334
 335   note_head->set_object ("accidental-grob", a->self_scm ());
 336
 337   return a;
 338 }
 339
 340 Grob *
 341 Accidental_engraver::make_suggested_accidental (Stream_event * /* note */,
 342                                                 Grob *note_head,
 343                                                 Engraver *trans)
 344 {
 345   Grob *a = trans->make_item ("AccidentalSuggestion", note_head->self_scm ());
 346
 347   Side_position_interface::add_support (a, note_head);
 348   if (Grob *stem = unsmob<Grob> (a->get_object ("stem")))
 349     Side_position_interface::add_support (a, stem);
 350
 351   a->set_parent (note_head, X_AXIS);
 352   return a;
 353 }
 354
 355 void
 356 Accidental_engraver::finalize ()
 357 {
 358   last_keysig_ = SCM_EOL;
 359 }
 360
 361 void
 362 Accidental_engraver::stop_translation_timestep ()
 363 {
 364   for (vsize j = ties_.size (); j--;)
 365     {
 366       Grob *r = Tie::head (ties_[j], RIGHT);
 367       Grob *l = Tie::head (ties_[j], LEFT);
 368       if (l && r)
 369         {
 370           // Don't mark accidentals as "tied" when the pitch is not
 371           // actually the same.  This is relevant for enharmonic ties.
 372           Stream_event *le = unsmob<Stream_event> (l->get_property ("cause"));
 373           Stream_event *re = unsmob<Stream_event> (r->get_property ("cause"));
 374           if (le && re
 375               && !ly_is_equal (le->get_property ("pitch"), re->get_property ("pitch")))
 376             continue;
 377         }
 378
 379       for (vsize i = accidentals_.size (); i--;)
 380         if (accidentals_[i].head_ == r)
 381           {
 382             if (Grob *g = accidentals_[i].accidental_)
 383               {
 384                 g->set_object ("tie", ties_[j]->self_scm ());
 385                 accidentals_[i].tied_ = true;
 386               }
 387             ties_.erase (ties_.begin () + j);
 388             break;
 389           }
 390     }
 391
 392   for (vsize i = accidentals_.size (); i--;)
 393     {
 394       Stream_event *note = accidentals_[i].melodic_;
 395       Context *origin = accidentals_[i].origin_;
 396
 397       int barnum = measure_number (origin);
 398
 399       Pitch *pitch = unsmob<Pitch> (note->get_property ("pitch"));
 400       if (!pitch)
 401         continue;
 402
 403       int n = pitch->get_notename ();
 404       int o = pitch->get_octave ();
 405       Rational a = pitch->get_alteration ();
 406       SCM key = scm_cons (scm_from_int (o), scm_from_int (n));
 407
 408       Moment end_mp = measure_position (context (),
 409                                         unsmob<Duration> (note->get_property ("duration")));
 410       SCM position = scm_cons (scm_from_int (barnum), end_mp.smobbed_copy ());
 411
 412       SCM localsig = SCM_EOL;
 413       while (origin
 414              && origin->where_defined (ly_symbol2scm ("localAlterations"), &localsig))
 415         {
 416           bool change = false;
 417           if (accidentals_[i].tied_
 418               && !(to_boolean (accidentals_[i].accidental_->get_property ("forced"))))
 419             {
 420               /*
 421                 Remember an alteration that is different both from
 422                 that of the tied note and of the key signature.
 423               */
 424               localsig = ly_assoc_prepend_x (localsig, key, scm_cons (ly_symbol2scm ("tied"),
 425                                                                       position));
 426               change = true;
 427             }
 428           else
 429             {
 430               /*
 431                 not really correct if there is more than one
 432                 note head with the same notename.
 433               */
 434               localsig = ly_assoc_prepend_x (localsig, key,
 435                                              scm_cons (ly_rational2scm (a),
 436                                                        position));
 437               change = true;
 438             }
 439
 440           if (change)
 441             origin->set_property ("localAlterations", localsig);
 442
 443           origin = origin->get_parent_context ();
 444         }
 445     }
 446
 447   if (accidental_placement_)
 448     for (vsize i = 0; i < note_columns_.size (); i++)
 449       Separation_item::add_conditional_item (note_columns_[i], accidental_placement_);
 450
 451   accidental_placement_ = 0;
 452   accidentals_.clear ();
 453   note_columns_.clear ();
 454   left_objects_.clear ();
 455   right_objects_.clear ();
 456 }
 457
 458 void
 459 Accidental_engraver::acknowledge_rhythmic_head (Grob_info info)
 460 {
 461   Stream_event *note = info.event_cause ();
 462   if (note
 463       && (note->in_event_class ("note-event")
 464           || note->in_event_class ("trill-span-event"))
 465       // option to skip accidentals on string harmonics
 466       && (to_boolean (get_property ("harmonicAccidentals"))
 467           || !scm_is_eq (info.grob ()->get_property ("style"),
 468                          ly_symbol2scm ("harmonic")))
 469       // ignore accidentals in non-printing voices like NullVoice
 470       && !to_boolean (info.context ()->get_property ("nullAccidentals")))
 471     {
 472       Accidental_entry entry;
 473       entry.head_ = info.grob ();
 474       entry.origin_engraver_ = dynamic_cast<Engraver *> (info.origin_translator ());
 475       entry.origin_ = entry.origin_engraver_->context ();
 476       entry.melodic_ = note;
 477
 478       accidentals_.push_back (entry);
 479     }
 480 }
 481
 482 void
 483 Accidental_engraver::acknowledge_end_tie (Grob_info info)
 484 {
 485   ties_.push_back (dynamic_cast<Spanner *> (info.grob ()));
 486 }
 487
 488 void
 489 Accidental_engraver::acknowledge_note_column (Grob_info info)
 490 {
 491   note_columns_.push_back (info.grob ());
 492 }
 493
 494 void
 495 Accidental_engraver::acknowledge_arpeggio (Grob_info info)
 496 {
 497   left_objects_.push_back (info.grob ());
 498 }
 499
 500 void
 501 Accidental_engraver::acknowledge_finger (Grob_info info)
 502 {
 503   left_objects_.push_back (info.grob ());
 504 }
 505
 506 void
 507 Accidental_engraver::process_music ()
 508 {
 509   SCM sig = get_property ("keyAlterations");
 510   if (last_keysig_ != sig)
 511     update_local_key_signature (sig);
 512 }
 513
 514 ADD_ACKNOWLEDGER (Accidental_engraver, arpeggio);
 515 ADD_ACKNOWLEDGER (Accidental_engraver, finger);
 516 ADD_ACKNOWLEDGER (Accidental_engraver, rhythmic_head);
 517 ADD_END_ACKNOWLEDGER (Accidental_engraver, tie);
 518 ADD_ACKNOWLEDGER (Accidental_engraver, note_column);
 519
 520 ADD_TRANSLATOR (Accidental_engraver,
 521                 /* doc */
 522                 "Make accidentals."
 523                 "  Catch note heads, ties and notices key-change events."
 524                 "  This engraver usually lives at Staff level, but"
 525                 " reads the settings for Accidental at @code{Voice} level,"
 526                 " so you can @code{\\override} them at @code{Voice}.",
 527
 528                 /* create */
 529                 "Accidental "
 530                 "AccidentalCautionary "
 531                 "AccidentalPlacement "
 532                 "AccidentalSuggestion ",
 533
 534                 /* read */
 535                 "autoAccidentals "
 536                 "autoCautionaries "
 537                 "internalBarNumber "
 538                 "extraNatural "
 539                 "harmonicAccidentals "
 540                 "accidentalGrouping "
 541                 "keyAlterations "
 542                 "localAlterations ",
 543
 544                 /* write */
 545                 "localAlterations "
 546                );