lily/accidental-engraver.cc

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