]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/accidental-engraver.cc
Merge branch 'master' of git://git.sv.gnu.org/lilypond
[lilypond.git] / lily / accidental-engraver.cc
index eb4efce0e920032df870ed61b1f8c8975f799380..c7eb79955a827f3061dce6d32d5c38a823cd8846 100644 (file)
@@ -3,21 +3,24 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Modified 2001--2002 by Rune Zedeler <rz@daimi.au.dk>
 */
 
 #include "accidental-placement.hh"
 #include "arpeggio.hh"
+#include "spanner.hh"
 #include "context.hh"
+#include "item.hh"
 #include "engraver.hh"
+#include "international.hh"
+#include "pitch.hh"
 #include "protected-scm.hh"
 #include "rhythmic-head.hh"
 #include "side-position-interface.hh"
+#include "stream-event.hh"
 #include "tie.hh"
 #include "warn.hh"
-#include "music.hh"
-#include "pitch.hh"
 
 #include "translator.icc"
 
@@ -25,7 +28,7 @@ class Accidental_entry
 {
 public:
   bool done_;
-  Music *melodic_;
+  Stream_event *melodic_;
   Grob *accidental_;
   Context *origin_;
   Engraver *origin_engraver_;
@@ -50,8 +53,8 @@ class Accidental_engraver : public Engraver
   int get_bar_number ();
   void update_local_key_signature ();
   void create_accidental (Accidental_entry *entry, bool, bool);
-  Grob *make_standard_accidental (Music *note, Grob *note_head, Engraver *trans);
-  Grob *make_suggested_accidental (Music *note, Grob *note_head, Engraver *trans);
+  Grob *make_standard_accidental (Stream_event *note, Grob *note_head, Engraver *trans);
+  Grob *make_suggested_accidental (Stream_event *note, Grob *note_head, Engraver *trans);
 
 protected:
   TRANSLATOR_DECLARATIONS (Accidental_engraver);
@@ -63,8 +66,8 @@ protected:
   void acknowledge_finger (Grob_info);
 
   void stop_translation_timestep ();
-  virtual void initialize ();
   void process_acknowledged ();
+  
   virtual void finalize ();
   virtual void derived_mark () const;
 
@@ -76,14 +79,13 @@ public:
     to store all information before we can really create the
     accidentals.
   */
-  Link_array<Grob> left_objects_;
-  Link_array<Grob> right_objects_;
+  vector<Grob*> left_objects_;
+  vector<Grob*> right_objects_;
 
   Grob *accidental_placement_;
 
-  Array<Accidental_entry> accidentals_;
-  Link_array<Spanner> ties_;
-
+  vector<Accidental_entry> accidentals_;
+  vector<Spanner*> ties_;
 };
 
 /*
@@ -95,16 +97,6 @@ public:
   those.
 */
 
-static void
-set_property_on_children (Context *trans, char const *sym, SCM val)
-{
-  trans->set_property (sym, ly_deep_copy (val));
-  for (SCM p = trans->children_contexts (); scm_is_pair (p); p = scm_cdr (p))
-    {
-      Context *trg = unsmob_context (scm_car (p));
-      set_property_on_children (trg, sym, ly_deep_copy (val));
-    }
-}
 
 Accidental_engraver::Accidental_engraver ()
 {
@@ -122,25 +114,23 @@ void
 Accidental_engraver::update_local_key_signature ()
 {
   last_keysig_ = get_property ("keySignature");
-  set_property_on_children (context (), "localKeySignature", last_keysig_);
+  set_context_property_on_children (context (),
+                                   ly_symbol2scm ("localKeySignature"),
+                                   last_keysig_);
 
   Context *trans = context ()->get_parent_context ();
 
-  /* Huh. Don't understand what this is good for. --hwn.  */
+  /* Reset parent contexts so that e.g. piano-accidentals won't remember old
+     cross-staff accidentals after key-sig-changes */
 
   SCM val;
-  while (trans && trans->where_defined (ly_symbol2scm ("localKeySignature"), &val))
+  while (trans && trans->where_defined (ly_symbol2scm ("localKeySignature"), &val)==trans)
     {
       trans->set_property ("localKeySignature", ly_deep_copy (last_keysig_));
       trans = trans->get_parent_context ();
     }
 }
 
-void
-Accidental_engraver::initialize ()
-{
-  update_local_key_signature ();
-}
 
 /** Calculate the number of accidentals on basis of the current local key
     sig (passed as argument)
@@ -161,18 +151,18 @@ recent_enough (int bar_number, SCM alteration_def, SCM laziness)
   return (bar_number <= scm_to_int (scm_cdr (alteration_def)) + scm_to_int (laziness));
 }
 
-static int
+static Rational
 extract_alteration (SCM alteration_def)
 {
   if (scm_is_number (alteration_def))
-    return scm_to_int (alteration_def);
+    return ly_scm2rational (alteration_def);
   else if (scm_is_pair (alteration_def))
-    return scm_to_int (scm_car (alteration_def));
+    return ly_scm2rational (scm_car (alteration_def));
   else if (alteration_def == SCM_BOOL_F)
-    return 0;
+    return Rational (0);
   else
     assert (0);
-  return 0;
+  return Rational (0);
 }
 
 bool
@@ -200,24 +190,22 @@ number_accidentals_from_sig (bool *different, SCM sig, Pitch *pitch,
       SCM entry = scm_car (s);
       if (scm_is_pair (scm_car (entry))
          && scm_cdar (entry) == scm_from_int (n))
-       from_other_octaves = scm_cdr (entry);
+       {
+         from_other_octaves = scm_cdr (entry);
+         break;
+       }
     }
 
-  if (from_same_octave != SCM_BOOL_F
+  if (!ignore_octave
+      && from_same_octave != SCM_BOOL_F
       && recent_enough (bar_number, from_same_octave, laziness))
-    {
-      previous_alteration = from_same_octave;
-    }
+    previous_alteration = from_same_octave;
   else if (ignore_octave
           && from_other_octaves != SCM_BOOL_F
           && recent_enough (bar_number, from_other_octaves, laziness))
-    {
-      previous_alteration = from_other_octaves;
-    }
+    previous_alteration = from_other_octaves;
   else if (from_key_signature != SCM_BOOL_F)
-    {
-      previous_alteration = from_key_signature;
-    }
+    previous_alteration = from_key_signature;
 
   int num = 1;
   if (is_tied (previous_alteration))
@@ -227,12 +215,13 @@ number_accidentals_from_sig (bool *different, SCM sig, Pitch *pitch,
     }
   else
     {
-      int prev = extract_alteration (previous_alteration);
-      int alter = pitch->get_alteration ();
+      Rational prev = extract_alteration (previous_alteration);
+      Rational alter = pitch->get_alteration ();
 
       if (alter == prev)
        num = 0;
-      else if ((abs (alter) < abs (prev) || prev * alter < 0) && alter != 0)
+      else if ((alter.abs () < prev.abs ()
+               || (prev * alter).sign () < 0) && alter.sign ())
        num = 2;
       *different = (alter != prev);
     }
@@ -249,7 +238,7 @@ number_accidentals (bool *different,
   *different = false;
   if (scm_is_pair (accidentals) && !scm_is_symbol (scm_car (accidentals)))
     warning (_f ("accidental typesetting list must begin with context-name: %s",
-                ly_scm2string (scm_car (accidentals)).to_str0 ()));
+                ly_scm2string (scm_car (accidentals)).c_str ()));
 
   for (; scm_is_pair (accidentals) && origin;
        accidentals = scm_cdr (accidentals))
@@ -277,7 +266,7 @@ number_accidentals (bool *different,
            }
          else
            warning (_f ("ignoring unknown accidental: %s",
-                        ly_symbol2string (type).to_str0 ()));
+                        ly_symbol2string (type).c_str ()));
        }
 
       /* if symbol then it is a context name.  Scan parent contexts to
@@ -293,7 +282,7 @@ number_accidentals (bool *different,
        }
       else
        warning (_f ("pair or context-name expected for accidental rule, found %s",
-                    ly_scm2string (rule).to_str0 ()));
+                    ly_scm2string (rule).c_str ()));
     }
 
   return number;
@@ -302,7 +291,7 @@ number_accidentals (bool *different,
 int
 Accidental_engraver::get_bar_number ()
 {
-  SCM barnum = get_property ("currentBarNumber");
+  SCM barnum = get_property ("internalBarNumber");
   SCM smp = get_property ("measurePosition");
 
   int bn = robust_scm2int (barnum, 0);
@@ -317,19 +306,19 @@ Accidental_engraver::get_bar_number ()
 void
 Accidental_engraver::process_acknowledged ()
 {
-  if (accidentals_.size () && !accidentals_.top ().done_)
+  if (accidentals_.size () && !accidentals_.back ().done_)
     {
       SCM accidentals = get_property ("autoAccidentals");
       SCM cautionaries = get_property ("autoCautionaries");
       int barnum = get_bar_number ();
 
-      for (int i = 0; i < accidentals_.size (); i++)
+      for (vsize i = 0; i < accidentals_.size (); i++)
        {
          if (accidentals_[i].done_)
            continue;
          accidentals_[i].done_ = true;
 
-         Music *note = accidentals_[i].melodic_;
+         Stream_event *note = accidentals_[i].melodic_;
          Context *origin = accidentals_[i].origin_;
 
          Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
@@ -346,8 +335,8 @@ Accidental_engraver::process_acknowledged ()
                                             pitch, origin,
                                             cautionaries, barnum);
 
-         bool cautionary = to_boolean (note->get_property ("cautionary"));
 
+         bool cautionary = to_boolean (note->get_property ("cautionary"));
          if (num_caut > num)
            {
              num = num_caut;
@@ -355,13 +344,18 @@ Accidental_engraver::process_acknowledged ()
              cautionary = true;
            }
 
-         if (num == 0 && to_boolean (note->get_property ("force-accidental")))
+         bool forced = to_boolean (note->get_property ("force-accidental"));
+         if (num == 0 && forced)
            num = 1;
 
          /* Cannot look for ties: it's not guaranteed that they reach
             us before the notes. */
-         if (num)
+         if (num
+             && !note->in_event_class ("trill-span-event"))
            create_accidental (&accidentals_[i], num > 1, cautionary);
+
+         if (forced || cautionary)
+           accidentals_[i].accidental_->set_property ("forced", SCM_BOOL_T);
        }
     }
 }
@@ -371,7 +365,7 @@ Accidental_engraver::create_accidental (Accidental_entry *entry,
                                        bool restore_natural,
                                        bool cautionary)
 {
-  Music *note = entry->melodic_;
+  Stream_event *note = entry->melodic_;
   Grob *support = entry->head_;
   Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
 
@@ -382,7 +376,7 @@ Accidental_engraver::create_accidental (Accidental_entry *entry,
   else
     a = make_standard_accidental (note, support, entry->origin_engraver_);
 
-  SCM accs = scm_cons (scm_from_int (pitch->get_alteration ()),
+  SCM accs = scm_cons (scm_from_int (pitch->get_alteration () * Rational (4)),
                       SCM_EOL);
   if (restore_natural)
     {
@@ -399,59 +393,59 @@ Accidental_engraver::create_accidental (Accidental_entry *entry,
 }
 
 Grob *
-Accidental_engraver::make_standard_accidental (Music *note,
-                                              Grob *support,
+Accidental_engraver::make_standard_accidental (Stream_event *note,
+                                              Grob *note_head,
                                               Engraver *trans)
 {
+  (void)note;
 
   /*
     We construct the accidentals at the originating Voice
     level, so that we get the property settings for
     Accidental from the respective Voice.
   */
-  Grob *a
-    = make_grob_from_properties (trans,
-                                ly_symbol2scm ("Accidental"),
-                                note->self_scm (),
-                                "Accidental");
+  Grob *a = trans->make_item ("Accidental", note_head->self_scm ());
 
   /*
     We add the accidentals to the support of the arpeggio,
     so it is put left of the accidentals.
   */
-  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++)
+  for (vsize i = 0; i < left_objects_.size (); i++)
+    {
+      if (left_objects_[i]->get_property ("side-axis") == scm_from_int (X_AXIS))
+       Side_position_interface::add_support (left_objects_[i], a);
+    }
+
+  /*
+    Hmm. Junkme? 
+   */
+  for (vsize i = 0; i < right_objects_.size (); i++)
     Side_position_interface::add_support (a, right_objects_[i]);
 
-  a->set_parent (support, Y_AXIS);
+  a->set_parent (note_head, Y_AXIS);
 
   if (!accidental_placement_)
     accidental_placement_ = make_item ("AccidentalPlacement",
                                       a->self_scm ());
   Accidental_placement::add_accidental (accidental_placement_, a);
 
-  support->set_object ("accidental-grob", a->self_scm ());
+  note_head->set_object ("accidental-grob", a->self_scm ());
 
   return a;
 }
 
 Grob *
-Accidental_engraver::make_suggested_accidental (Music *note,
-                                               Grob *note_head, Engraver *trans)
+Accidental_engraver::make_suggested_accidental (Stream_event *note,
+                                               Grob *note_head,
+                                               Engraver *trans)
 {
+  (void) note;
 
-  Grob *a
-    = make_grob_from_properties (trans,
-                                ly_symbol2scm ("AccidentalSuggestion"),
-                                note->self_scm (),
-                                "AccidentalSuggestion");
+  Grob *a = trans->make_item ("AccidentalSuggestion", note_head->self_scm ());
 
   Side_position_interface::add_support (a, note_head);
   if (Grob *stem = unsmob_grob (a->get_object ("stem")))
-    {
-      Side_position_interface::add_support (a, stem);
-    }
+    Side_position_interface::add_support (a, stem);
 
   a->set_parent (note_head, X_AXIS);
   return a;
@@ -466,10 +460,10 @@ Accidental_engraver::finalize ()
 void
 Accidental_engraver::stop_translation_timestep ()
 {
-  for (int j = ties_.size (); j--;)
+  for (vsize j = ties_.size (); j--;)
     {
       Grob *r = Tie::head (ties_[j], RIGHT);
-      for (int i = accidentals_.size (); i--;)
+      for (vsize i = accidentals_.size (); i--;)
        if (accidentals_[i].head_ == r)
          {
            if (Grob *g = accidentals_[i].accidental_)
@@ -477,16 +471,16 @@ Accidental_engraver::stop_translation_timestep ()
                g->set_object ("tie", ties_[j]->self_scm ());
                accidentals_[i].tied_ = true;
              }
-           ties_.del (j);
+           ties_.erase (ties_.begin () + j);
            break;
          }
     }
 
-  for (int i = accidentals_.size (); i--;)
+  for (vsize i = accidentals_.size (); i--;)
     {
       int barnum = get_bar_number ();
 
-      Music *note = accidentals_[i].melodic_;
+      Stream_event *note = accidentals_[i].melodic_;
       Context *origin = accidentals_[i].origin_;
 
       Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
@@ -495,7 +489,7 @@ Accidental_engraver::stop_translation_timestep ()
 
       int n = pitch->get_notename ();
       int o = pitch->get_octave ();
-      int a = pitch->get_alteration ();
+      Rational a = pitch->get_alteration ();
       SCM key = scm_cons (scm_from_int (o), scm_from_int (n));
 
       SCM localsig = SCM_EOL;
@@ -521,7 +515,7 @@ Accidental_engraver::stop_translation_timestep ()
                noteheads with the same notename.
              */
              localsig = ly_assoc_front_x (localsig, key,
-                                          scm_cons (scm_from_int (a),
+                                          scm_cons (ly_rational2scm (a),
                                                     scm_from_int (barnum)));
              change = true;
            }
@@ -542,12 +536,13 @@ Accidental_engraver::stop_translation_timestep ()
 void
 Accidental_engraver::acknowledge_rhythmic_head (Grob_info info)
 {
-  Music *note = info.music_cause ();
+  Stream_event *note = info.event_cause ();
   if (note
-      && note->is_mus_type ("note-event"))
+      && (note->in_event_class ("note-event")
+         || note->in_event_class ("trill-span-event")))
     {
       /*
-       String harmonics usually don't have accidentals.
+       string harmonics usually don't have accidentals.
       */
       if (to_boolean (get_property ("harmonicAccidentals"))
          || !ly_is_equal (info.grob ()->get_property ("style"),
@@ -559,7 +554,7 @@ Accidental_engraver::acknowledge_rhythmic_head (Grob_info info)
          entry.origin_ = entry.origin_engraver_->context ();
          entry.melodic_ = note;
 
-         accidentals_.push (entry);
+         accidentals_.push_back (entry);
        }
     }
 }
@@ -567,19 +562,19 @@ Accidental_engraver::acknowledge_rhythmic_head (Grob_info info)
 void
 Accidental_engraver::acknowledge_tie (Grob_info info)
 {
-  ties_.push (dynamic_cast<Spanner *> (info.grob ()));
+  ties_.push_back (dynamic_cast<Spanner *> (info.grob ()));
 }
 
 void
 Accidental_engraver::acknowledge_arpeggio (Grob_info info)
 {
-  left_objects_.push (info.grob ());
+  left_objects_.push_back (info.grob ());
 }
 
 void
 Accidental_engraver::acknowledge_finger (Grob_info info)
 {
-  left_objects_.push (info.grob ());
+  left_objects_.push_back (info.grob ());
 }
 
 void
@@ -598,6 +593,7 @@ ADD_ACKNOWLEDGER (Accidental_engraver, rhythmic_head);
 ADD_ACKNOWLEDGER (Accidental_engraver, tie);
 
 ADD_TRANSLATOR (Accidental_engraver,
+               
                "Make accidentals.  "
                "Catch note heads, ties and notices key-change events.  "
                "This engraver usually lives at Staff level, but "
@@ -605,11 +601,11 @@ ADD_TRANSLATOR (Accidental_engraver,
                "so you can @code{\\override} them at @code{Voice}. ",
                "Accidental AccidentalSuggestion",
 
-               "",
-
                "autoAccidentals "
                "autoCautionaries "
+               "internalBarNumber "
                "extraNatural "
                "harmonicAccidentals "
-               "localKeySignature",
-               "localKeySignature");
+               "localKeySignature ",
+               "localKeySignature "
+               );