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