lily/accidental-engraver.cc

   1 /*
   2   accidental-engraver.cc -- implement accidental_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7   Modified 2001--2002 by Rune Zedeler <rz@daimi.au.dk>
   8 */
   9
  10 #include "accidental-placement.hh"
  11 #include "arpeggio.hh"
  12 #include "spanner.hh"
  13 #include "context.hh"
  14 #include "item.hh"
  15 #include "engraver.hh"
  16 #include "international.hh"
  17 #include "pitch.hh"
  18 #include "protected-scm.hh"
  19 #include "rhythmic-head.hh"
  20 #include "side-position-interface.hh"
  21 #include "stream-event.hh"
  22 #include "tie.hh"
  23 #include "warn.hh"
  24
  25 #include "translator.icc"
  26
  27 class Accidental_entry
  28 {
  29 public:
  30   bool done_;
  31   Stream_event *melodic_;
  32   Grob *accidental_;
  33   Context *origin_;
  34   Engraver *origin_engraver_;
  35   Grob *head_;
  36   bool tied_;
  37
  38   Accidental_entry ();
  39 };
  40
  41 Accidental_entry::Accidental_entry ()
  42 {
  43   tied_ = false;
  44   done_ = false;
  45   melodic_ = 0;
  46   accidental_ = 0;
  47   origin_ = 0;
  48   head_ = 0;
  49 }
  50
  51 class Accidental_engraver : public Engraver
  52 {
  53   int get_bar_number ();
  54   void update_local_key_signature ();
  55   void create_accidental (Accidental_entry *entry, bool, bool);
  56   Grob *make_standard_accidental (Stream_event *note, Grob *note_head, Engraver *trans);
  57   Grob *make_suggested_accidental (Stream_event *note, Grob *note_head, Engraver *trans);
  58
  59 protected:
  60   TRANSLATOR_DECLARATIONS (Accidental_engraver);
  61   void process_music ();
  62
  63   void acknowledge_tie (Grob_info);
  64   void acknowledge_arpeggio (Grob_info);
  65   void acknowledge_rhythmic_head (Grob_info);
  66   void acknowledge_finger (Grob_info);
  67
  68   void stop_translation_timestep ();
  69   virtual void initialize ();
  70   void process_acknowledged ();
  71   virtual void finalize ();
  72   virtual void derived_mark () const;
  73
  74 public:
  75   SCM last_keysig_;     // ugh.
  76
  77   /*
  78     Urgh. Since the accidentals depend on lots of variables, we have
  79     to store all information before we can really create the
  80     accidentals.
  81   */
  82   vector<Grob*> left_objects_;
  83   vector<Grob*> right_objects_;
  84
  85   Grob *accidental_placement_;
  86
  87   vector<Accidental_entry> accidentals_;
  88   vector<Spanner*> ties_;
  89 };
  90
  91 /*
  92   TODO:
  93
  94   ugh, it is not clear what properties are mutable and which
  95   aren't. eg. localKeySignature is changed at runtime, which means
  96   that references in grobs should always store ly_deep_copy ()s of
  97   those.
  98 */
  99
 100
 101 Accidental_engraver::Accidental_engraver ()
 102 {
 103   accidental_placement_ = 0;
 104   last_keysig_ = SCM_EOL;
 105 }
 106
 107 void
 108 Accidental_engraver::derived_mark () const
 109 {
 110   scm_gc_mark (last_keysig_);
 111 }
 112
 113 void
 114 Accidental_engraver::update_local_key_signature ()
 115 {
 116   last_keysig_ = get_property ("keySignature");
 117   set_context_property_on_children (context (),
 118                                     ly_symbol2scm ("localKeySignature"),
 119                                     last_keysig_);
 120
 121   Context *trans = context ()->get_parent_context ();
 122
 123   /* Huh. Don't understand what this is good for. --hwn.  */
 124
 125   SCM val;
 126   while (trans && trans->where_defined (ly_symbol2scm ("localKeySignature"), &val))
 127     {
 128       trans->set_property ("localKeySignature", ly_deep_copy (last_keysig_));
 129       trans = trans->get_parent_context ();
 130     }
 131 }
 132
 133 void
 134 Accidental_engraver::initialize ()
 135 {
 136   update_local_key_signature ();
 137 }
 138
 139 /** Calculate the number of accidentals on basis of the current local key
 140     sig (passed as argument)
 141
 142     * First check step+octave (taking into account barnumbers if necessary).
 143
 144     * Then check the global signature (only step).
 145
 146     Return number of accidentals (0, 1 or 2).  */
 147
 148 static bool
 149 recent_enough (int bar_number, SCM alteration_def, SCM laziness)
 150 {
 151   if (scm_is_number (alteration_def)
 152       || laziness == SCM_BOOL_T)
 153     return true;
 154
 155   return (bar_number <= scm_to_int (scm_cdr (alteration_def)) + scm_to_int (laziness));
 156 }
 157
 158 static int
 159 extract_alteration (SCM alteration_def)
 160 {
 161   if (scm_is_number (alteration_def))
 162     return scm_to_int (alteration_def);
 163   else if (scm_is_pair (alteration_def))
 164     return scm_to_int (scm_car (alteration_def));
 165   else if (alteration_def == SCM_BOOL_F)
 166     return 0;
 167   else
 168     assert (0);
 169   return 0;
 170 }
 171
 172 bool
 173 is_tied (SCM alteration_def)
 174 {
 175   return (alteration_def == SCM_BOOL_T)
 176     || (scm_is_pair (alteration_def) && scm_car (alteration_def) == SCM_BOOL_T);
 177 }
 178
 179 static int
 180 number_accidentals_from_sig (bool *different, SCM sig, Pitch *pitch,
 181                              int bar_number, SCM laziness, bool ignore_octave)
 182 {
 183   int n = pitch->get_notename ();
 184   int o = pitch->get_octave ();
 185
 186   SCM previous_alteration = SCM_BOOL_F;
 187
 188   SCM from_same_octave = ly_assoc_get (scm_cons (scm_from_int (o),
 189                                                  scm_from_int (n)), sig, SCM_BOOL_F);
 190   SCM from_key_signature = ly_assoc_get (scm_from_int (n), sig, SCM_BOOL_F);
 191   SCM from_other_octaves = SCM_BOOL_F;
 192   for (SCM s = sig; scm_is_pair (s); s = scm_cdr (s))
 193     {
 194       SCM entry = scm_car (s);
 195       if (scm_is_pair (scm_car (entry))
 196           && scm_cdar (entry) == scm_from_int (n))
 197         from_other_octaves = scm_cdr (entry);
 198     }
 199
 200   if (from_same_octave != SCM_BOOL_F
 201       && recent_enough (bar_number, from_same_octave, laziness))
 202     previous_alteration = from_same_octave;
 203   else if (ignore_octave
 204            && from_other_octaves != SCM_BOOL_F
 205            && recent_enough (bar_number, from_other_octaves, laziness))
 206     previous_alteration = from_other_octaves;
 207   else if (from_key_signature != SCM_BOOL_F)
 208     previous_alteration = from_key_signature;
 209
 210   int num = 1;
 211   if (is_tied (previous_alteration))
 212     {
 213       num = 1;
 214       *different = true;
 215     }
 216   else
 217     {
 218       int prev = extract_alteration (previous_alteration);
 219       int alter = pitch->get_alteration ();
 220
 221       if (alter == prev)
 222         num = 0;
 223       else if ((abs (alter) < abs (prev)
 224                 || prev * alter < 0) && alter != 0)
 225         num = 2;
 226       *different = (alter != prev);
 227     }
 228   return num;
 229 }
 230
 231 static int
 232 number_accidentals (bool *different,
 233                     Pitch *pitch, Context *origin,
 234                     SCM accidentals, int bar_number)
 235 {
 236   int number = 0;
 237
 238   *different = false;
 239   if (scm_is_pair (accidentals) && !scm_is_symbol (scm_car (accidentals)))
 240     warning (_f ("accidental typesetting list must begin with context-name: %s",
 241                  ly_scm2string (scm_car (accidentals)).c_str ()));
 242
 243   for (; scm_is_pair (accidentals) && origin;
 244        accidentals = scm_cdr (accidentals))
 245     {
 246       // If pair then it is a new accidentals typesetting rule to be checked
 247       SCM rule = scm_car (accidentals);
 248       if (scm_is_pair (rule))
 249         {
 250           SCM type = scm_car (rule);
 251           SCM laziness = scm_cdr (rule);
 252           SCM localsig = origin->get_property ("localKeySignature");
 253
 254           bool same_octave_b
 255             = scm_is_eq (ly_symbol2scm ("same-octave"), type);
 256           bool any_octave_b
 257             = scm_is_eq (ly_symbol2scm ("any-octave"), type);
 258
 259           if (same_octave_b || any_octave_b)
 260             {
 261               bool d = false;
 262               int n = number_accidentals_from_sig
 263                 (&d, localsig, pitch, bar_number, laziness, any_octave_b);
 264               *different = *different || d;
 265               number = max (number, n);
 266             }
 267           else
 268             warning (_f ("ignoring unknown accidental: %s",
 269                          ly_symbol2string (type).c_str ()));
 270         }
 271
 272       /* if symbol then it is a context name.  Scan parent contexts to
 273          find it. */
 274       else if (scm_is_symbol (rule))
 275         {
 276           Context *dad = origin;
 277           while (dad && !dad->is_alias (rule))
 278             dad = dad->get_parent_context ();
 279
 280           if (dad)
 281             origin = dad;
 282         }
 283       else
 284         warning (_f ("pair or context-name expected for accidental rule, found %s",
 285                      ly_scm2string (rule).c_str ()));
 286     }
 287
 288   return number;
 289 }
 290
 291 int
 292 Accidental_engraver::get_bar_number ()
 293 {
 294   SCM barnum = get_property ("internalBarNumber");
 295   SCM smp = get_property ("measurePosition");
 296
 297   int bn = robust_scm2int (barnum, 0);
 298
 299   Moment mp = robust_scm2moment (smp, Moment (0));
 300   if (mp.main_part_ < Rational (0))
 301     bn--;
 302
 303   return bn;
 304 }
 305
 306 void
 307 Accidental_engraver::process_acknowledged ()
 308 {
 309   if (accidentals_.size () && !accidentals_.back ().done_)
 310     {
 311       SCM accidentals = get_property ("autoAccidentals");
 312       SCM cautionaries = get_property ("autoCautionaries");
 313       int barnum = get_bar_number ();
 314
 315       for (vsize i = 0; i < accidentals_.size (); i++)
 316         {
 317           if (accidentals_[i].done_)
 318             continue;
 319           accidentals_[i].done_ = true;
 320
 321           Stream_event *note = accidentals_[i].melodic_;
 322           Context *origin = accidentals_[i].origin_;
 323
 324           Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
 325           if (!pitch)
 326             continue;
 327
 328           bool different = false;
 329           bool different_caut = false;
 330
 331           int num = number_accidentals (&different,
 332                                         pitch, origin,
 333                                         accidentals, barnum);
 334           int num_caut = number_accidentals (&different_caut,
 335                                              pitch, origin,
 336                                              cautionaries, barnum);
 337
 338
 339           bool cautionary = to_boolean (note->get_property ("cautionary"));
 340           if (num_caut > num)
 341             {
 342               num = num_caut;
 343               different = different_caut;
 344               cautionary = true;
 345             }
 346
 347           bool forced = to_boolean (note->get_property ("force-accidental"));
 348           if (num == 0 && forced)
 349             num = 1;
 350
 351           /* Cannot look for ties: it's not guaranteed that they reach
 352              us before the notes. */
 353           if (num
 354               && !note->in_event_class ("trill-span-event"))
 355             create_accidental (&accidentals_[i], num > 1, cautionary);
 356
 357
 358           if (forced || cautionary)
 359             accidentals_[i].accidental_->set_property ("forced", SCM_BOOL_T);
 360         }
 361     }
 362 }
 363
 364 void
 365 Accidental_engraver::create_accidental (Accidental_entry *entry,
 366                                         bool restore_natural,
 367                                         bool cautionary)
 368 {
 369   Stream_event *note = entry->melodic_;
 370   Grob *support = entry->head_;
 371   Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
 372
 373   bool as_suggestion = to_boolean (entry->origin_->get_property ("suggestAccidentals"));
 374   Grob *a = 0;
 375   if (as_suggestion)
 376     a = make_suggested_accidental (note, support, entry->origin_engraver_);
 377   else
 378     a = make_standard_accidental (note, support, entry->origin_engraver_);
 379
 380   SCM accs = scm_cons (scm_from_int (pitch->get_alteration ()),
 381                        SCM_EOL);
 382   if (restore_natural)
 383     {
 384       if (to_boolean (get_property ("extraNatural")))
 385         accs = scm_cons (scm_from_int (0), accs);
 386     }
 387
 388   /* TODO: add cautionary option in accidental. */
 389   if (cautionary)
 390     a->set_property ("cautionary", SCM_BOOL_T);
 391
 392   a->set_property ("accidentals", accs);
 393   entry->accidental_ = a;
 394 }
 395
 396 Grob *
 397 Accidental_engraver::make_standard_accidental (Stream_event *note,
 398                                                Grob *note_head,
 399                                                Engraver *trans)
 400 {
 401
 402   (void)note;
 403   /*
 404     We construct the accidentals at the originating Voice
 405     level, so that we get the property settings for
 406     Accidental from the respective Voice.
 407   */
 408   Grob *a = trans->make_item ("Accidental", note_head->self_scm ());
 409
 410   /*
 411     We add the accidentals to the support of the arpeggio,
 412     so it is put left of the accidentals.
 413   */
 414   for (vsize i = 0; i < left_objects_.size (); i++)
 415     {
 416       if (left_objects_[i]->get_property ("side-axis") == scm_from_int (X_AXIS))
 417         Side_position_interface::add_support (left_objects_[i], a);
 418     }
 419
 420   /*
 421     Hmm. Junkme?
 422    */
 423   for (vsize i = 0; i < right_objects_.size (); i++)
 424     Side_position_interface::add_support (a, right_objects_[i]);
 425
 426   a->set_parent (note_head, Y_AXIS);
 427
 428   if (!accidental_placement_)
 429     accidental_placement_ = make_item ("AccidentalPlacement",
 430                                        a->self_scm ());
 431   Accidental_placement::add_accidental (accidental_placement_, a);
 432
 433   note_head->set_object ("accidental-grob", a->self_scm ());
 434
 435   return a;
 436 }
 437
 438 Grob *
 439 Accidental_engraver::make_suggested_accidental (Stream_event *note,
 440                                                 Grob *note_head,
 441                                                 Engraver *trans)
 442 {
 443   (void) note;
 444   Grob *a = trans->make_item ("AccidentalSuggestion", note_head->self_scm ());
 445
 446   Side_position_interface::add_support (a, note_head);
 447   if (Grob *stem = unsmob_grob (a->get_object ("stem")))
 448     Side_position_interface::add_support (a, stem);
 449
 450   a->set_parent (note_head, X_AXIS);
 451   return a;
 452 }
 453
 454 void
 455 Accidental_engraver::finalize ()
 456 {
 457   last_keysig_ = SCM_EOL;
 458 }
 459
 460 void
 461 Accidental_engraver::stop_translation_timestep ()
 462 {
 463   for (vsize j = ties_.size (); j--;)
 464     {
 465       Grob *r = Tie::head (ties_[j], RIGHT);
 466       for (vsize i = accidentals_.size (); i--;)
 467         if (accidentals_[i].head_ == r)
 468           {
 469             if (Grob *g = accidentals_[i].accidental_)
 470               {
 471                 g->set_object ("tie", ties_[j]->self_scm ());
 472                 accidentals_[i].tied_ = true;
 473               }
 474             ties_.erase (ties_.begin () + j);
 475             break;
 476           }
 477     }
 478
 479   for (vsize i = accidentals_.size (); i--;)
 480     {
 481       int barnum = get_bar_number ();
 482
 483       Stream_event *note = accidentals_[i].melodic_;
 484       Context *origin = accidentals_[i].origin_;
 485
 486       Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
 487       if (!pitch)
 488         continue;
 489
 490       int n = pitch->get_notename ();
 491       int o = pitch->get_octave ();
 492       int a = pitch->get_alteration ();
 493       SCM key = scm_cons (scm_from_int (o), scm_from_int (n));
 494
 495       SCM localsig = SCM_EOL;
 496       while (origin
 497              && origin->where_defined (ly_symbol2scm ("localKeySignature"), &localsig))
 498         {
 499           bool change = false;
 500           if (accidentals_[i].tied_)
 501             {
 502               /*
 503                 Remember an alteration that is different both from
 504                 that of the tied note and of the key signature.
 505               */
 506               localsig = ly_assoc_front_x
 507                 (localsig, key, scm_cons (SCM_BOOL_T, scm_from_int (barnum)));
 508
 509               change = true;
 510             }
 511           else
 512             {
 513               /*
 514                 not really really correct if there are more than one
 515                 noteheads with the same notename.
 516               */
 517               localsig = ly_assoc_front_x (localsig, key,
 518                                            scm_cons (scm_from_int (a),
 519                                                      scm_from_int (barnum)));
 520               change = true;
 521             }
 522
 523           if (change)
 524             origin->set_property ("localKeySignature", localsig);
 525
 526           origin = origin->get_parent_context ();
 527         }
 528     }
 529
 530   accidental_placement_ = 0;
 531   accidentals_.clear ();
 532   left_objects_.clear ();
 533   right_objects_.clear ();
 534 }
 535
 536 void
 537 Accidental_engraver::acknowledge_rhythmic_head (Grob_info info)
 538 {
 539   Stream_event *note = info.event_cause ();
 540   if (note
 541       && (note->in_event_class ("note-event")
 542           || note->in_event_class ("trill-span-event")))
 543     {
 544       /*
 545         string harmonics usually don't have accidentals.
 546       */
 547       if (to_boolean (get_property ("harmonicAccidentals"))
 548           || !ly_is_equal (info.grob ()->get_property ("style"),
 549                            ly_symbol2scm ("harmonic")))
 550         {
 551           Accidental_entry entry;
 552           entry.head_ = info.grob ();
 553           entry.origin_engraver_ = dynamic_cast<Engraver *> (info.origin_translator ());
 554           entry.origin_ = entry.origin_engraver_->context ();
 555           entry.melodic_ = note;
 556
 557           accidentals_.push_back (entry);
 558         }
 559     }
 560 }
 561
 562 void
 563 Accidental_engraver::acknowledge_tie (Grob_info info)
 564 {
 565   ties_.push_back (dynamic_cast<Spanner *> (info.grob ()));
 566 }
 567
 568 void
 569 Accidental_engraver::acknowledge_arpeggio (Grob_info info)
 570 {
 571   left_objects_.push_back (info.grob ());
 572 }
 573
 574 void
 575 Accidental_engraver::acknowledge_finger (Grob_info info)
 576 {
 577   left_objects_.push_back (info.grob ());
 578 }
 579
 580 void
 581 Accidental_engraver::process_music ()
 582 {
 583   SCM sig = get_property ("keySignature");
 584   /* Detect key sig changes.
 585      Update all parents and children.  */
 586   if (last_keysig_ != sig)
 587     update_local_key_signature ();
 588 }
 589
 590 ADD_ACKNOWLEDGER (Accidental_engraver, arpeggio);
 591 ADD_ACKNOWLEDGER (Accidental_engraver, finger);
 592 ADD_ACKNOWLEDGER (Accidental_engraver, rhythmic_head);
 593 ADD_ACKNOWLEDGER (Accidental_engraver, tie);
 594
 595 ADD_TRANSLATOR (Accidental_engraver,
 596
 597                 "Make accidentals.  "
 598                 "Catch note heads, ties and notices key-change events.  "
 599                 "This engraver usually lives at Staff level, but "
 600                 "reads the settings for Accidental at @code{Voice} level, "
 601                 "so you can @code{\\override} them at @code{Voice}. ",
 602                 "Accidental AccidentalSuggestion",
 603
 604                 "autoAccidentals "
 605                 "autoCautionaries "
 606                 "internalBarNumber "
 607                 "extraNatural "
 608                 "harmonicAccidentals "
 609                 "localKeySignature",
 610                 "localKeySignature");