]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/local-key-engraver.cc
release: 1.5.13
[lilypond.git] / lily / local-key-engraver.cc
index fe1ee8b0d704ae04f7b7a38f6791631180c573b6..8ef57ed105436310af8e92d38fe2d21bf922fdb6 100644 (file)
@@ -12,7 +12,7 @@
 #include "rhythmic-head.hh"
 #include "timing-translator.hh"
 #include "engraver-group-engraver.hh"
-#include "grace-align-item.hh"
+
 #include "staff-symbol-referencer.hh"
 #include "side-position-interface.hh"
 #include "engraver.hh"
    FIXME: should not compute vertical positioning of accidentals, but
    get them from the noteheads
 
+   The algorithm for accidentals should be documented, and made
+   tweakable.
+
 */
 
 
 struct Local_key_engraver : Engraver {
   Item *key_item_p_;
 protected:
-  VIRTUAL_COPY_CONS(Translator);
-  virtual void process_music();
+  TRANSLATOR_DECLARATIONS(Local_key_engraver);
+  virtual void process_music ();
   virtual void acknowledge_grob (Grob_info);
-  virtual void stop_translation_timestep();
+  virtual void stop_translation_timestep ();
   virtual void initialize ();
   virtual void create_grobs ();
   virtual void finalize ();
@@ -52,15 +55,12 @@ public:
   Link_array<Grob> support_l_arr_;
   Link_array<Item> forced_l_arr_;
   Link_array<Grob> tie_l_arr_;
-  Local_key_engraver();
 
-  Item * grace_align_l_;
 };
 
-Local_key_engraver::Local_key_engraver()
+Local_key_engraver::Local_key_engraver ()
 {
   key_item_p_ =0;
-  grace_align_l_ =0;
   last_keysig_ = SCM_EOL;
 }
 
@@ -74,11 +74,11 @@ Local_key_engraver::initialize ()
 void
 Local_key_engraver::create_grobs ()
 {
-  if (!key_item_p_ && mel_l_arr_.size()) 
+  if (!key_item_p_ && mel_l_arr_.size ()) 
     {
       SCM localsig = get_property ("localKeySignature");
   
-      for (int i=0; i  < mel_l_arr_.size(); i++) 
+      for (int i=0; i  < mel_l_arr_.size (); i++) 
        {
          Grob * support_l = support_l_arr_[i];
          Note_req * note_l = mel_l_arr_[i];
@@ -94,20 +94,24 @@ Local_key_engraver::create_grobs ()
          SCM prev = scm_assoc (gh_cons (gh_int2scm (o), gh_int2scm (n)), localsig);
          if (prev == SCM_BOOL_F)
            prev = scm_assoc (gh_int2scm (n), localsig);
-         SCM prev_acc = (prev == SCM_BOOL_F) ? gh_int2scm(0) : gh_cdr (prev);
-         bool different = !gh_equal_p(prev_acc , gh_int2scm(a));
-         int p = gh_number_p(prev_acc) ? gh_scm2int(prev_acc) : 0;
+         SCM prev_acc = (prev == SCM_BOOL_F) ? gh_int2scm (0) : ly_cdr (prev);
+         bool different = !gh_equal_p (prev_acc , gh_int2scm (a));
+         int p = gh_number_p (prev_acc) ? gh_scm2int (prev_acc) : 0;
 
-         Grob *tie_break_cautionary = 0;
+         Grob *tie_break_reminder = 0;
          bool tie_changes = false;
          for (int i=0; i < tie_l_arr_.size (); i++)
            if (support_l == Tie::head (tie_l_arr_[i], RIGHT))
              {
                tie_changes = different;
-#if 1
-               /* Enable accidentals for broken tie */
-               tie_break_cautionary = tie_l_arr_[i];
-#endif
+               /* Enable accidentals for broken tie
+
+                  We only want an accidental on a broken tie,
+                  if the tie changes the accidental.
+                  
+                  Maybe check property noTieBreakForceAccidental? */
+               if (different)
+                 tie_break_reminder = tie_l_arr_[i];
                break;
              }
 
@@ -118,18 +122,21 @@ Local_key_engraver::create_grobs ()
             2. when different and not tie-changes
             3. maybe when at end of a tie: we must later see if
             we're after a line break */
-         if (((to_boolean (note_l->get_mus_property ("force-accidental"))
+         if (( (to_boolean (note_l->get_mus_property ("force-accidental"))
                || different)
               && !tie_changes)
-             || tie_break_cautionary)
+             || tie_break_reminder)
            {
              if (!key_item_p_) 
                {
-                 key_item_p_ = new Item(get_property ("Accidentals"));
+                 key_item_p_ = new Item (get_property ("Accidentals"));
                  Local_key_item::set_interface (key_item_p_);
 
-
+                 
                  Staff_symbol_referencer::set_interface (key_item_p_);
+                 SCM c0 = get_property ("centralCPosition");
+                 if (gh_number_p (c0))
+                   Staff_symbol_referencer::set_position (key_item_p_, gh_scm2int (c0));
                         
                  announce_grob (key_item_p_, 0);
                }
@@ -137,13 +144,13 @@ Local_key_engraver::create_grobs ()
              
              bool extra_natural =
                sign (p) * (p - a) == 1
-               && abs(p) == 2;
+               && abs (p) == 2;
 
              Local_key_item::add_pitch (key_item_p_, *unsmob_pitch (note_l->get_mus_property ("pitch")),
                                         to_boolean (note_l->get_mus_property ("cautionary")),
                                         extra_natural,
-                                        tie_break_cautionary);
-             Side_position::add_support (key_item_p_,support_l);
+                                        tie_break_reminder);
+             Side_position_interface::add_support (key_item_p_,support_l);
            }
          
          /*
@@ -186,11 +193,6 @@ Local_key_engraver::create_grobs ()
       daddy_trans_l_->set_property ("localKeySignature",  localsig);
     }
   
-  if (key_item_p_ && grace_align_l_)
-    {
-      Side_position::add_support (grace_align_l_,key_item_p_);
-      grace_align_l_ =0;
-    }
 
   if (key_item_p_)
     {
@@ -199,10 +201,10 @@ Local_key_engraver::create_grobs ()
 
        On which left, code or paper?
 
      (Arpeggios are engraved left of accidentals, of course.)
+ (Arpeggios are engraved left of accidentals, of course.)
        */
       for (int i=0;  i < arpeggios_.size ();  i++)
-       Side_position::add_support (arpeggios_[i], key_item_p_);
+       Side_position_interface::add_support (arpeggios_[i], key_item_p_);
 
       arpeggios_.clear ();
     }
@@ -211,59 +213,46 @@ Local_key_engraver::create_grobs ()
 void
 Local_key_engraver::finalize ()
 {
-  // TODO: if grace ? signal accidentals to Local_key_engraver the 
+
 }
 
 void
-Local_key_engraver::stop_translation_timestep()
+Local_key_engraver::stop_translation_timestep ()
 {
   if (key_item_p_)
     {
-      for (int i=0; i < support_l_arr_.size(); i++)
-       Side_position::add_support (key_item_p_,support_l_arr_[i]);
+      for (int i=0; i < support_l_arr_.size (); i++)
+       Side_position_interface::add_support (key_item_p_,support_l_arr_[i]);
 
       typeset_grob (key_item_p_);
       key_item_p_ =0;
     }
 
-  grace_align_l_ = 0;
-  mel_l_arr_.clear();
+
+  mel_l_arr_.clear ();
   arpeggios_.clear ();
   tie_l_arr_.clear ();
-  support_l_arr_.clear();
-  forced_l_arr_.clear();       
+  support_l_arr_.clear ();
+  forced_l_arr_.clear ();      
 }
 
 void
 Local_key_engraver::acknowledge_grob (Grob_info info)
 {
-  SCM wg= get_property ("weAreGraceContext");
-  
-  bool selfgr = gh_boolean_p (wg) &&gh_scm2bool (wg);
-  bool he_gr = to_boolean (info.elem_l_->get_grob_property ("grace"));
-
-  Item * item = dynamic_cast<Item*> (info.elem_l_);  
-  if (he_gr && !selfgr && item && Grace_align_item::has_interface (item))
-    {
-      grace_align_l_ = item;
-    }
-  if (he_gr != selfgr)
-    return;
-  
   Note_req * note_l =  dynamic_cast <Note_req *> (info.req_l_);
 
-  if (note_l && Rhythmic_head::has_interface (info.elem_l_))
+  if (note_l && Rhythmic_head::has_interface (info.grob_l_))
     {
       mel_l_arr_.push (note_l);
-      support_l_arr_.push (info.elem_l_);
+      support_l_arr_.push (info.grob_l_);
     }
-  else if (Tie::has_interface (info.elem_l_))
+  else if (Tie::has_interface (info.grob_l_))
     {
-      tie_l_arr_.push (info.elem_l_);
+      tie_l_arr_.push (info.grob_l_);
     }
-  else if (Arpeggio::has_interface (info.elem_l_))
+  else if (Arpeggio::has_interface (info.grob_l_))
     {
-      arpeggios_.push (info.elem_l_); 
+      arpeggios_.push (info.grob_l_); 
     }
   
 }
@@ -272,10 +261,10 @@ Local_key_engraver::acknowledge_grob (Grob_info info)
   ugh. repeated deep_copy generates lots of garbage.
  */
 void
-Local_key_engraver::process_music()
+Local_key_engraver::process_music ()
 {
   SCM smp = get_property ("measurePosition");
-  Moment mp =  (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
+  Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
 
   SCM sig = get_property ("keySignature");
 
@@ -287,7 +276,7 @@ Local_key_engraver::process_music()
       daddy_trans_l_->set_property ("localKeySignature",  ly_deep_copy (sig));
       last_keysig_ = sig;
     }
-  else if (!mp)
+  else if (!mp.to_bool () )
     {
       if (!to_boolean (get_property ("noResetKey")))
        daddy_trans_l_->set_property ("localKeySignature",  ly_deep_copy (sig));
@@ -296,5 +285,13 @@ Local_key_engraver::process_music()
 
 
 
-ADD_THIS_TRANSLATOR(Local_key_engraver);
 
+
+ENTER_DESCRIPTION(Local_key_engraver,
+/* descr */       "Make accidentals.  Catches note heads, ties and notices key-change
+events.  Due to interaction with ties (which don't come together
+with note heads), this needs to be in a context higher than Tie_engraver. FIXME",
+/* creats*/       "Accidentals",
+/* acks  */       "rhythmic-head-interface tie-interface arpeggio-interface",
+/* reads */       "localKeySignature forgetAccidentals noResetKey",
+/* write */       "");