]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/accidental-engraver.cc
* lily/include/grob-info.hh: origin_contexts() now does not
[lilypond.git] / lily / accidental-engraver.cc
index b7c9289eab27db460c0e2057bca1b3e87428d775..ae3fe262a8f747c363842060f378c455e4aa212b 100644 (file)
@@ -1,12 +1,13 @@
 /*
   accidental-engraver.cc -- implement accidental_engraver
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  Modified 2001-2002 by Rune Zedeler <rz@daimi.au.dk>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Modified 2001--2002 by Rune Zedeler <rz@daimi.au.dk>
 */
 
 #include "event.hh"
 
+
 #include "item.hh"
 #include "tie.hh"
 #include "rhythmic-head.hh"
 #include "engraver.hh"
 #include "arpeggio.hh"
 #include "warn.hh"
-
-#include "translator-group.hh"
+#include "context.hh"
+#include "protected-scm.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.
 
@@ -34,7 +31,7 @@ struct Accidental_entry {
   bool done_;
   Music * melodic_;
   Grob * accidental_;
-  Translator_group *origin_;
+  Context *origin_;
   Grob*  head_;
   Accidental_entry();
 };
@@ -59,41 +56,34 @@ protected:
   virtual void finalize ();
 public:
 
-  /*
-    TODO -> property.
-    
-    This is not a property, and it is not protected.  This poses a
-    very small risk of the value being GC'd from under us.
-  */
-  SCM last_keysig_;
+  Protected_scm last_keysig_;
 
   /*
     Urgh. Since the accidentals depend on lots of variables, we have to
     store all information before we can really create the accidentals.
   */
-  Link_array<Grob> arpeggios_;
+  Link_array<Grob> left_objects_;
+  Link_array<Grob> right_objects_;
 
   Grob * accidental_placement_;
-  
 
   /*
     The next 
    */
   Array<Accidental_entry> accidentals_;
-  
   Link_array<Grob> ties_;
-
-
 };
 
 
-static void set_property_on_children (Translator_group * trans, const char * sym, SCM val)
+static void
+set_property_on_children (Context * trans, const char * sym, SCM val)
 {
   trans->set_property (sym, val);
-  for (SCM p = trans -> trans_group_list_; gh_pair_p (p); p = ly_cdr(p)) {
-    Translator_group *trg =  dynamic_cast<Translator_group*> (unsmob_translator (ly_car (p)));
-    set_property_on_children(trg,sym,ly_deep_copy(val));
-  }
+  for (SCM p = trans->context_list_; gh_pair_p (p); p = ly_cdr(p))
+    {
+      Context *trg =  unsmob_context (ly_car (p));
+      set_property_on_children(trg, sym, ly_deep_copy(val));
+    }
 }
 
 Accidental_engraver::Accidental_engraver ()
@@ -107,13 +97,14 @@ Accidental_engraver::initialize ()
 {
   last_keysig_ = get_property ("keySignature");
 
-  Translator_group * trans_ = daddy_trans_;
+  Context * trans_ = daddy_context_;
   while (trans_)
     {
-      trans_ -> set_property ("localKeySignature",  ly_deep_copy (last_keysig_));
-      trans_ = trans_->daddy_trans_;
+      trans_ -> set_property ("localKeySignature",
+                             ly_deep_copy (last_keysig_));
+      trans_ = trans_->daddy_context_;
     }
-  set_property_on_children (daddy_trans_,"localKeySignature", last_keysig_);
+  set_property_on_children (daddy_context_,"localKeySignature", last_keysig_);
 }
 
 /*
@@ -125,12 +116,12 @@ calculates the number of accidentals on basis of the current local key sig
 
 */
 static int
-number_accidentals (SCM sig, Music * note, Pitch *pitch, SCM curbarnum, SCM lazyness, 
+number_accidentals_from_sig (SCM sig, Music *, Pitch *pitch, SCM curbarnum, SCM lazyness, 
                    bool ignore_octave_b)
 {
-  int n = pitch->notename_;
-  int o = pitch->octave_;
-  int a = pitch->alteration_;
+  int n = pitch->get_notename ();
+  int o = pitch->get_octave();
+  int a = pitch->get_alteration ();
   int curbarnum_i = gh_scm2int (curbarnum);
   int accbarnum_i = 0;
 
@@ -138,7 +129,7 @@ number_accidentals (SCM sig, Music * note, Pitch *pitch, SCM curbarnum, SCM lazy
   if (ignore_octave_b)
     prev = ly_assoc_cdr (scm_int2num (n), sig);
   else
-    prev = gh_assoc (gh_cons (scm_int2num (o), scm_int2num (n)), sig);
+    prev = scm_assoc (gh_cons (scm_int2num (o), scm_int2num (n)), sig);
 
   /* should really be true unless prev == SCM_BOOL_F */
   if (gh_pair_p (prev) && gh_pair_p (ly_cdr (prev)))
@@ -150,7 +141,7 @@ number_accidentals (SCM sig, Music * note, Pitch *pitch, SCM curbarnum, SCM lazy
   /* If an accidental was not found or the accidental was too old */
   if (prev == SCM_BOOL_F ||
       (gh_number_p (lazyness) && curbarnum_i > accbarnum_i + gh_scm2int (lazyness)))
-    prev = gh_assoc (scm_int2num (n), sig);
+    prev = scm_assoc (scm_int2num (n), sig);
 
 
   SCM prev_acc = (prev == SCM_BOOL_F) ? scm_int2num (0) : ly_cdr (prev);
@@ -169,7 +160,7 @@ number_accidentals (SCM sig, Music * note, Pitch *pitch, SCM curbarnum, SCM lazy
 }
 
 static int
-number_accidentals (Music * note, Pitch *pitch, Translator_group * origin, 
+number_accidentals (Music * note, Pitch *pitch, Context * origin, 
                    SCM accidentals, SCM curbarnum)
 {
   int number = 0;
@@ -179,13 +170,14 @@ number_accidentals (Music * note, Pitch *pitch, Translator_group * origin,
     warning (_f ("Accidental typesetting list must begin with context-name: %s", 
                 ly_scm2string (ly_car (accidentals)).to_str0 ()));
   
-  while (gh_pair_p (accidentals) && origin)
+  for (; gh_pair_p (accidentals) && origin; accidentals = gh_cdr (accidentals))
     {
       // If pair then it is a new accidentals typesetting rule to be checked
-      if (gh_pair_p (ly_car (accidentals)))
+      SCM rule = gh_car (accidentals);
+      if (gh_pair_p (rule))
        {
-         SCM type = gh_caar (accidentals);
-         SCM lazyness = gh_cdar (accidentals);
+         SCM type = gh_car (rule);
+         SCM lazyness = gh_cdr (rule);
          SCM localsig = origin->get_property ("localKeySignature");
          
          bool same_octave_b = 
@@ -195,7 +187,7 @@ number_accidentals (Music * note, Pitch *pitch, Translator_group * origin,
 
          if (same_octave_b || any_octave_b)
            {
-             int n = number_accidentals
+             int n = number_accidentals_from_sig
                (localsig, note, pitch, curbarnum, lazyness, any_octave_b);
              diff = diff || (n < 0);
              number = max (number, abs (n));     
@@ -209,22 +201,19 @@ number_accidentals (Music * note, Pitch *pitch, Translator_group * origin,
       /*
        if symbol then it is a context name. Scan parent contexts to find it.
       */
-      else if (gh_symbol_p (ly_car (accidentals)))
+      else if (gh_symbol_p (rule))
        {
-         String context = ly_symbol2string (ly_car (accidentals));
-         
-         while (origin && !origin->is_alias_b (context))
-           origin = origin->daddy_trans_;
+         Context * dad = origin;
+         while (dad && !dad->is_alias (rule))
+           dad = dad->daddy_context_;
       
-         if (!origin)
-           warning (_f ("Symbol is not a parent context: %s. Ignored", 
-                        context.to_str0 ()));
+         if (dad)
+           origin = dad;
        }
-      else warning (_f ("Accidental typesetting must be pair or context-name: %s", 
-                       ly_scm2string (ly_car (accidentals)).to_str0 ()));
-      
-      accidentals = ly_cdr (accidentals);
+      else warning (_f ("Accidental rule must be pair or context-name; Found %s", 
+                       ly_scm2string (rule).to_str0 ()));
     }
+
   return diff ? -number : number;
 }
 
@@ -248,9 +237,12 @@ Accidental_engraver::process_acknowledged_grobs ()
          accidentals_[i].done_  = true;
          Grob * support = accidentals_[i].head_;
          Music * note = accidentals_[i].melodic_;
-         Translator_group * origin = accidentals_[i].origin_;
+         Context * origin = accidentals_[i].origin_;
 
          Pitch * pitch = unsmob_pitch (note->get_mus_property ("pitch"));
+         if (!pitch)
+           continue;
+         
          int num = number_accidentals (note, pitch, origin, accidentals, barnum);
          int num_caut = number_accidentals (note, pitch, origin, cautionaries, barnum);
          bool cautionary = to_boolean (note->get_mus_property ("cautionary"));
@@ -291,12 +283,12 @@ Accidental_engraver::process_acknowledged_grobs ()
 
          if (num)
            {
-             Grob * a = new Item (get_property ("Accidental"));
+             Grob * a = make_item ("Accidental");
              a->set_parent (support, Y_AXIS);
 
              if (!accidental_placement_)
                {
-                 accidental_placement_ = new Item (get_property ("AccidentalPlacement"));
+                 accidental_placement_ = make_item ("AccidentalPlacement");
                  announce_grob (accidental_placement_, a->self_scm());
                }
              
@@ -304,7 +296,7 @@ Accidental_engraver::process_acknowledged_grobs ()
              announce_grob (a, SCM_EOL);
 
              
-             SCM accs = gh_cons (scm_int2num (pitch->alteration_), SCM_EOL);
+             SCM accs = gh_cons (scm_int2num (pitch->get_alteration ()), SCM_EOL);
              if (num == 2 && extra_natural_b)
                accs = gh_cons (scm_int2num (0), accs);
 
@@ -334,8 +326,10 @@ Accidental_engraver::process_acknowledged_grobs ()
        accidentals. 
        
       */
-             for (int i = 0;  i < arpeggios_.size ();  i++)
-               Side_position_interface::add_support (arpeggios_[i], a);
+             for (int i = 0;  i < left_objects_.size ();  i++)
+               Side_position_interface::add_support (left_objects_[i], a);
+             for (int i = 0;  i < right_objects_.size ();  i++)
+               Side_position_interface::add_support (a, right_objects_[i]);
            }
          
 
@@ -348,9 +342,9 @@ Accidental_engraver::process_acknowledged_grobs ()
          */
          
 
-         int n = pitch->notename_;
-         int o = pitch->octave_;
-         int a = pitch->alteration_;
+         int n = pitch->get_notename ();
+         int o = pitch->get_octave ();
+         int a = pitch->get_alteration ();
          SCM on_s = gh_cons (scm_int2num (o), scm_int2num (n));
 
          /*
@@ -393,7 +387,7 @@ Accidental_engraver::process_acknowledged_grobs ()
                    (localsig, on_s, gh_cons (scm_int2num (a), barnum)); 
                }
              origin->set_property ("localKeySignature",  localsig);
-             origin = origin->daddy_trans_;
+             origin = origin->daddy_context_;
            }
        }
     }
@@ -402,7 +396,10 @@ Accidental_engraver::process_acknowledged_grobs ()
 void
 Accidental_engraver::finalize ()
 {
-
+  /*
+    Must reset, since Accidental_engraver is GCd.
+   */
+  last_keysig_ = SCM_EOL;
 }
 
 void
@@ -422,7 +419,8 @@ Accidental_engraver::stop_translation_timestep ()
   accidental_placement_ = 00;
   
   accidentals_.clear();
-  arpeggios_.clear ();
+  left_objects_.clear ();
+  right_objects_.clear ();
   ties_.clear ();
 }
 
@@ -432,12 +430,14 @@ Accidental_engraver::acknowledge_grob (Grob_info info)
   Music * note =  info.music_cause ();
 
   if (note
-      && note->is_mus_type("note-event")
-      && Rhythmic_head::has_interface (info.grob_))
+      && note->is_mus_type ("note-event")
+      && Rhythmic_head::has_interface (info.grob_)
+      && !gh_equal_p (info.grob_->get_grob_property ("style"), ly_symbol2scm ("harmonic"))
+      )
     {
       Accidental_entry entry ;
       entry.head_ = info.grob_;
-      entry.origin_ = info.origin_trans_->daddy_trans_;
+      entry.origin_ = info.origin_trans_->daddy_context_;
       entry.melodic_ = note;
 
       accidentals_.push (entry);
@@ -448,9 +448,12 @@ Accidental_engraver::acknowledge_grob (Grob_info info)
     }
   else if (Arpeggio::has_interface (info.grob_))
     {
-      arpeggios_.push (info.grob_); 
+      left_objects_.push (info.grob_); 
+    }
+  else if (info.grob_->internal_has_interface (ly_symbol2scm("finger-interface")))
+    {
+      left_objects_.push (info.grob_); 
     }
-  
 }
 
 void
@@ -463,13 +466,13 @@ Accidental_engraver::process_music ()
   */
   if (last_keysig_ != sig)
     {
-      Translator_group * trans_ = daddy_trans_;
+      Context * trans_ = daddy_context_;
       while (trans_)
        {
          trans_ -> set_property ("localKeySignature",  ly_deep_copy (sig));
-         trans_ = trans_->daddy_trans_;
+         trans_ = trans_->daddy_context_;
        }
-      set_property_on_children(daddy_trans_,"localKeySignature", sig);
+      set_property_on_children(daddy_context_,"localKeySignature", sig);
 
       last_keysig_ = sig;
     }
@@ -485,6 +488,6 @@ ENTER_DESCRIPTION (Accidental_engraver,
 " with note heads), this needs to be in a context higher than Tie_engraver.",
               "Accidental",
 /* accepts */     "",
-              "rhythmic-head-interface tie-interface arpeggio-interface",
+              "finger-interface rhythmic-head-interface tie-interface arpeggio-interface",
               "localKeySignature extraNatural autoAccidentals autoCautionaries",
                   "localKeySignature");