]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/ambitus-engraver.cc
Doc-es: various updates.
[lilypond.git] / lily / ambitus-engraver.cc
index dded40139a7b1408d4c68fd7ec7d5f0625b79ccc..50cebbbf99a06a4d00c48b5ba12eff5df07e5674 100644 (file)
@@ -1,11 +1,22 @@
 /*
-  ambitus-engraver.cc -- implement Ambitus_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
-
-  (c) 2002--2007 Juergen Reuter <reuter@ipd.uka.de>
+  Copyright (C) 2002--2015 Juergen Reuter <reuter@ipd.uka.de>
 
   Han-Wen Nienhuys <hanwen@xs4all.nl
+
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "engraver.hh"
@@ -28,8 +39,10 @@ class Ambitus_engraver : public Engraver
 {
 public:
   TRANSLATOR_DECLARATIONS (Ambitus_engraver);
-  void process_music ();
+protected:
   void acknowledge_note_head (Grob_info);
+
+  void process_music ();
   void stop_translation_timestep ();
   virtual void finalize ();
   virtual void derived_mark () const;
@@ -58,18 +71,16 @@ Ambitus_engraver::create_ambitus ()
 {
   ambitus_ = make_item ("AmbitusLine", SCM_EOL);
   group_ = make_item ("Ambitus", SCM_EOL);
-  Direction d = DOWN;
-  do
+  for (DOWN_and_UP (d))
     {
       heads_[d] = make_item ("AmbitusNoteHead", SCM_EOL);
       accidentals_[d] = make_item ("AmbitusAccidental", SCM_EOL);
       accidentals_[d]->set_parent (heads_[d], Y_AXIS);
       heads_[d]->set_object ("accidental-grob",
-                            accidentals_[d]->self_scm ());
+                             accidentals_[d]->self_scm ());
       Axis_group_interface::add_element (group_, heads_[d]);
       Axis_group_interface::add_element (group_, accidentals_[d]);
     }
-  while (flip (&d) != DOWN);
 
   ambitus_->set_parent (heads_[DOWN], X_AXIS);
   Axis_group_interface::add_element (group_, ambitus_);
@@ -77,11 +88,12 @@ Ambitus_engraver::create_ambitus ()
   is_typeset_ = false;
 }
 
-Ambitus_engraver::Ambitus_engraver ()
+Ambitus_engraver::Ambitus_engraver (Context *c)
+  : Engraver (c)
 {
   ambitus_ = 0;
-  heads_[LEFT] = heads_[RIGHT] = 0;
-  accidentals_[LEFT] = accidentals_[RIGHT] = 0;
+  heads_.set (0, 0);
+  accidentals_.set (0, 0);
   group_ = 0;
   is_typeset_ = false;
   start_key_sig_ = SCM_EOL;
@@ -107,9 +119,15 @@ Ambitus_engraver::stop_translation_timestep ()
        * may then oversee a clef that is defined in a staff context if
        * we are in a voice context; middleCPosition would then be
        * assumed to be 0.
+
+       * Don't use middleCPosition as this may be thwarted by a cue
+       * starting here.  middleCOffset is not affected by cue clefs.
        */
-      start_c0_ = robust_scm2int (get_property ("middleCPosition"), 0);
-      start_key_sig_ = get_property ("keySignature");
+      int clef_pos = robust_scm2int (get_property ("middleCClefPosition"), 0);
+      int offset = robust_scm2int (get_property ("middleCOffset"), 0);
+
+      start_c0_ = clef_pos + offset;
+      start_key_sig_ = get_property ("keyAlterations");
 
       is_typeset_ = true;
     }
@@ -119,14 +137,22 @@ void
 Ambitus_engraver::acknowledge_note_head (Grob_info info)
 {
   Stream_event *nr = info.event_cause ();
-  if (nr && nr->in_event_class ("note-event"))
+  if (nr && nr->in_event_class ("note-event")
+      && !to_boolean (info.grob ()->get_property ("ignore-ambitus")))
     {
-      Pitch pitch = *unsmob_pitch (nr->get_property ("pitch"));
+      SCM p = nr->get_property ("pitch");
+      /*
+        If the engraver is added to a percussion context,
+        filter out unpitched note heads.
+      */
+      if (!unsmob<Pitch> (p))
+        return;
+      Pitch pitch = *unsmob<Pitch> (p);
       Drul_array<bool> expands = pitch_interval_.add_point (pitch);
       if (expands[UP])
-       causes_[UP] = nr;
+        causes_[UP] = nr;
       if (expands[DOWN])
-       causes_[DOWN] = nr;
+        causes_[DOWN] = nr;
     }
 }
 
@@ -135,78 +161,86 @@ Ambitus_engraver::finalize ()
 {
   if (ambitus_ && !pitch_interval_.is_empty ())
     {
-      Grob *accidental_placement =
-       make_item ("AccidentalPlacement",
-                  accidentals_[DOWN]->self_scm ());
-
-      Direction d = DOWN;
-      do
-       {
-         Pitch p = pitch_interval_[d];
-         heads_[d]->set_property ("cause", causes_[d]->self_scm());
-         heads_[d]->set_property ("staff-position",
-                                  scm_from_int (start_c0_
-                                                + p.steps ()));
-
-         SCM handle = scm_assoc (scm_cons (scm_from_int (p.get_octave ()),
-                                           scm_from_int (p.get_notename ())),
-                                 start_key_sig_);
-
-         if (handle == SCM_BOOL_F)
-           handle = scm_assoc (scm_from_int (p.get_notename ()),
-                               start_key_sig_);
-
-         Rational sig_alter = (handle != SCM_BOOL_F)
-           ? robust_scm2rational (scm_cdr (handle), Rational (0)) : Rational (0);
-
-         if (sig_alter == p.get_alteration ())
-           {
-             accidentals_[d]->suicide ();
-             heads_[d]->set_object ("accidental-grob", SCM_EOL);
-           }
-         else
-           {
-             accidentals_[d]->set_property ("alteration", ly_rational2scm (p.get_alteration ()));
-           }
-         Separation_item::add_conditional_item (heads_[d], accidental_placement);
-         Accidental_placement::add_accidental (accidental_placement, accidentals_[d]);
-       }
-      while (flip (&d) != DOWN);
-
-
-      Pointer_group_interface::add_grob (ambitus_, ly_symbol2scm ("note-heads"), heads_[DOWN]);
-      Pointer_group_interface::add_grob (ambitus_, ly_symbol2scm ("note-heads"), heads_[UP]);
+      Grob *accidental_placement
+        = make_item ("AccidentalPlacement", accidentals_[DOWN]->self_scm ());
+
+      for (DOWN_and_UP (d))
+        {
+          Pitch p = pitch_interval_[d];
+          heads_[d]->set_property ("cause", causes_[d]->self_scm ());
+          heads_[d]->set_property ("staff-position",
+                                   scm_from_int (start_c0_ + p.steps ()));
+
+          SCM handle = scm_assoc (scm_cons (scm_from_int (p.get_octave ()),
+                                            scm_from_int (p.get_notename ())),
+                                  start_key_sig_);
+
+          if (scm_is_false (handle))
+            handle = scm_assoc (scm_from_int (p.get_notename ()),
+                                start_key_sig_);
+
+          Rational sig_alter = (scm_is_true (handle))
+                               ? robust_scm2rational (scm_cdr (handle), Rational (0))
+                               : Rational (0);
+
+          const Pitch other = pitch_interval_[-d];
+
+          if (sig_alter == p.get_alteration ()
+              && !((p.steps () == other.steps ())
+                   && (p.get_alteration () != other.get_alteration ())))
+            {
+              accidentals_[d]->suicide ();
+              heads_[d]->set_object ("accidental-grob", SCM_EOL);
+            }
+          else
+            accidentals_[d]->
+            set_property ("alteration",
+                          ly_rational2scm (p.get_alteration ()));
+          Separation_item::add_conditional_item (heads_[d],
+                                                 accidental_placement);
+          Accidental_placement::add_accidental (accidental_placement,
+                                                accidentals_[d], false, 0);
+          Pointer_group_interface::add_grob (ambitus_,
+                                             ly_symbol2scm ("note-heads"),
+                                             heads_[d]);
+        }
+
       Axis_group_interface::add_element (group_, accidental_placement);
     }
   else
     {
-      Direction d = DOWN;
-      do
-       {
-         accidentals_[d]->suicide ();
-         heads_[d]->suicide ();
-       }
-      while (flip (&d) != DOWN);
+      for (DOWN_and_UP (d))
+        {
+          accidentals_[d]->suicide ();
+          heads_[d]->suicide ();
+        }
 
       ambitus_->suicide ();
     }
 }
 
-ADD_ACKNOWLEDGER (Ambitus_engraver, note_head);
+void
+Ambitus_engraver::boot ()
+{
+  ADD_ACKNOWLEDGER (Ambitus_engraver, note_head);
+}
+
 ADD_TRANSLATOR (Ambitus_engraver,
-               /* doc */
-               "",
-
-               /* create */
-               "AccidentalPlacement "
-               "Ambitus "
-               "AmbitusAccidental "
-               "AmbitusLine "
-               "AmbitusNoteHead ",
-
-               /* read */
-               "",
-
-               /* write */
-               ""
-               );
+                /* doc */
+                "Create an ambitus.",
+
+                /* create */
+                "AccidentalPlacement "
+                "Ambitus "
+                "AmbitusAccidental "
+                "AmbitusLine "
+                "AmbitusNoteHead ",
+
+                /* read */
+                "keyAlterations "
+                "middleCClefPosition "
+                "middleCOffset ",
+
+                /* write */
+                ""
+               );