]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem-engraver.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / stem-engraver.cc
index 579aeed7a3f58fb80559536b7194d0b6f0cff21f..40bee1c504c761bf062cb8579495bd44cd4b775c 100644 (file)
@@ -1,14 +1,28 @@
 /*
-  stem-engraver.cc -- implement Stem_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.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"
+
 #include "context.hh"
 #include "directional-element-interface.hh"
-#include "engraver.hh"
+#include "duration.hh"
+#include "international.hh"
 #include "item.hh"
 #include "misc.hh"
 #include "rhythmic-head.hh"
 #include "staff-symbol-referencer.hh"
 #include "stem-tremolo.hh"
 #include "stem.hh"
-#include "duration.hh"
+#include "stream-event.hh"
+
+#include "translator.icc"
 
-/**
-   Make stems upon receiving noteheads.
-*/
 class Stem_engraver : public Engraver
 {
   Grob *stem_;
   Grob *tremolo_;
-  Music *rhythmic_ev_;
-  Music *tremolo_ev_;
+  vector <Grob *> maybe_flags_;
+  Stream_event *rhythmic_ev_;
+  Stream_event *tremolo_ev_;
+  bool tuplet_start_;
 
   TRANSLATOR_DECLARATIONS (Stem_engraver);
 
 protected:
-  void make_stem (Grob_info);
+  void make_stem (Grob_info, bool);
 
+  DECLARE_TRANSLATOR_LISTENER (tremolo);
+  DECLARE_TRANSLATOR_LISTENER (tuplet_span);
   DECLARE_ACKNOWLEDGER (rhythmic_head);
   void stop_translation_timestep ();
-  virtual bool try_music (Music *);
+  void finalize ();
+  void kill_unused_flags ();
 };
 
 Stem_engraver::Stem_engraver ()
@@ -44,65 +62,66 @@ Stem_engraver::Stem_engraver ()
   stem_ = 0;
   tremolo_ = 0;
   rhythmic_ev_ = 0;
+  tuplet_start_ = false;
 }
 
 void
-Stem_engraver::make_stem (Grob_info gi)
+Stem_engraver::make_stem (Grob_info gi, bool tuplet_start)
 {
   /* Announce the cause of the head as cause of the stem.  The
      stem needs a rhythmic structure to fit it into a beam.  */
-  stem_ = make_item ("Stem", gi.music_cause ()->self_scm ());
-
-  /*
-    we take the duration log from the Event, since the duration-log
-    for a note head is always <= 2.
-  */
-  Music *music = gi.music_cause ();
-  Duration *dur = unsmob_duration (music->get_property ("duration"));
-  
-  stem_->set_property ("duration-log", dur ? scm_from_int (dur->duration_log ()) : 0);
-
+  stem_ = make_item ("Stem", gi.grob ()->self_scm ());
+  if (tuplet_start)
+    stem_->set_property ("tuplet-start", SCM_BOOL_T);
+  (void) make_item ("StemStub", gi.grob ()->self_scm ());
   if (tremolo_ev_)
     {
       /* Stem tremolo is never applied to a note by default,
-        is must me requested.  But there is a default for the
-        tremolo value:
+         it must be requested.  But there is a default for the
+         tremolo value:
 
-        c4:8 c c:
+         c4:8 c c:
 
-        the first and last (quarter) note bothe get one tremolo flag.  */
+         the first and last (quarter) note both get one tremolo flag.  */
       int requested_type
-       = scm_to_int (tremolo_ev_->get_property ("tremolo-type"));
+        = robust_scm2int (tremolo_ev_->get_property ("tremolo-type"), 0);
       SCM f = get_property ("tremoloFlags");
       if (!requested_type)
-       {
-         if (scm_is_number (f))
-           requested_type = scm_to_int (f);
-         else
-           requested_type = 8;
-       }
+        {
+          if (scm_is_number (f))
+            requested_type = scm_to_int (f);
+          else
+            requested_type = 8;
+        }
       else
-       context ()->set_property ("tremoloFlags", scm_from_int (requested_type));
+        context ()->set_property ("tremoloFlags", scm_from_int (requested_type));
+
+      /*
+        we take the duration log from the Event, since the duration-log
+        for a note head is always <= 2.
+      */
+      Stream_event *ev = gi.event_cause ();
+      Duration *dur = unsmob_duration (ev->get_property ("duration"));
 
       int tremolo_flags = intlog2 (requested_type) - 2
-       - (dur->duration_log () > 2 ? dur->duration_log () - 2 : 0);
+                          - (dur->duration_log () > 2 ? dur->duration_log () - 2 : 0);
       if (tremolo_flags <= 0)
-       {
-         tremolo_ev_->origin ()->warning (_ ("tremolo duration is too long"));
-         tremolo_flags = 0;
-       }
+        {
+          tremolo_ev_->origin ()->warning (_ ("tremolo duration is too long"));
+          tremolo_flags = 0;
+        }
 
       if (tremolo_flags)
-       {
-         tremolo_ = make_item ("StemTremolo", tremolo_ev_->self_scm ());
-
-         /* The number of tremolo flags is the number of flags of the
-            tremolo-type minus the number of flags of the note itself.  */
-         tremolo_->set_property ("flag-count", scm_from_int (tremolo_flags));
-         tremolo_->set_parent (stem_, X_AXIS);
-         stem_->set_object ("tremolo-flag", tremolo_->self_scm ());
-         tremolo_->set_object ("stem", stem_->self_scm ());
-       }
+        {
+          tremolo_ = make_item ("StemTremolo", tremolo_ev_->self_scm ());
+
+          /* The number of tremolo flags is the number of flags of the
+             tremolo-type minus the number of flags of the note itself.  */
+          tremolo_->set_property ("flag-count", scm_from_int (tremolo_flags));
+          tremolo_->set_parent (stem_, X_AXIS);
+          stem_->set_object ("tremolo-flag", tremolo_->self_scm ());
+          tremolo_->set_object ("stem", stem_->self_scm ());
+        }
     }
 }
 
@@ -112,68 +131,134 @@ Stem_engraver::acknowledge_rhythmic_head (Grob_info gi)
   if (Rhythmic_head::get_stem (gi.grob ()))
     return;
 
-  Music *cause = gi.music_cause ();
+  Stream_event *cause = gi.event_cause ();
   if (!cause)
     return;
   Duration *d = unsmob_duration (cause->get_property ("duration"));
   if (!d)
-    return ;
-      
+    return;
+
   if (!stem_)
-    make_stem (gi);
-      
-  if (Stem::duration_log (stem_) != d->duration_log ())
+    make_stem (gi, tuplet_start_);
+
+  int ds = Stem::duration_log (stem_);
+  int dc = d->duration_log ();
+
+  // half notes and quarter notes all have compatible stems.
+  // Longas are done differently (oops?), so we can't unify
+  // them with the other stemmed notes.
+  if (ds == 1)
+    ds = 2;
+  if (dc == 1)
+    dc = 2;
+  // whole notes and brevis both have no stems
+  if (ds == -1)
+    ds = 0;
+  if (dc == -1)
+    dc = 0;
+
+  if (ds != dc)
     {
-      // FIXME: 
-      gi.music_cause ()->origin ()->warning (_f ("adding note head to incompatible stem (type = %d)",
-                                                1 << Stem::duration_log (stem_)));
-      gi.music_cause ()->origin ()->warning (_f ("maybe input should specify polyphonic voices"));
+      gi.event_cause ()->origin ()->warning (_f ("adding note head to incompatible stem (type = %d/%d)",
+                                                 ds < 0 ? 1 << -ds : 1,
+                                                 ds > 0 ? 1 << ds : 1));
+      gi.event_cause ()->origin ()->warning (_ ("maybe input should specify polyphonic voices"));
     }
 
   Stem::add_head (stem_, gi.grob ());
+
+  if (Stem::is_normal_stem (stem_)
+      && Stem::duration_log (stem_) > 2)
+    {
+      Item *flag = make_item ("Flag", stem_->self_scm ());
+      flag->set_parent (stem_, X_AXIS);
+      stem_->set_object ("flag", flag->self_scm ());
+      maybe_flags_.push_back (flag);
+    }
+  if (tuplet_start_)
+    stem_->set_property ("tuplet-start", SCM_BOOL_T);
+}
+
+void
+Stem_engraver::kill_unused_flags ()
+{
+  for (vsize i = 0; i < maybe_flags_.size (); i++)
+    if (unsmob_grob (maybe_flags_[i]->get_parent (X_AXIS)->get_object ("beam")))
+      maybe_flags_[i]->suicide ();
+}
+
+void
+Stem_engraver::finalize ()
+{
+  kill_unused_flags ();
 }
 
 void
 Stem_engraver::stop_translation_timestep ()
 {
+  if (scm_is_string (get_property ("whichBar")))
+    kill_unused_flags ();
+
   tremolo_ = 0;
   if (stem_)
     {
       /* FIXME: junk these properties.  */
       SCM prop = get_property ("stemLeftBeamCount");
       if (scm_is_number (prop))
-       {
-         Stem::set_beaming (stem_, scm_to_int (prop), LEFT);
-         context ()->unset_property (ly_symbol2scm ("stemLeftBeamCount"));
-       }
+        {
+          Stem::set_beaming (stem_, scm_to_int (prop), LEFT);
+          context ()->unset_property (ly_symbol2scm ("stemLeftBeamCount"));
+        }
       prop = get_property ("stemRightBeamCount");
       if (scm_is_number (prop))
-       {
-         Stem::set_beaming (stem_, scm_to_int (prop), RIGHT);
-         context ()->unset_property (ly_symbol2scm ("stemRightBeamCount"));
-       }
+        {
+          Stem::set_beaming (stem_, scm_to_int (prop), RIGHT);
+          context ()->unset_property (ly_symbol2scm ("stemRightBeamCount"));
+        }
       stem_ = 0;
     }
+  tuplet_start_ = false;
   tremolo_ev_ = 0;
 }
 
-bool
-Stem_engraver::try_music (Music *m)
+IMPLEMENT_TRANSLATOR_LISTENER (Stem_engraver, tuplet_span);
+void
+Stem_engraver::listen_tuplet_span (Stream_event *ev)
 {
-  if (m->is_mus_type ("tremolo-event"))
+  Direction dir = to_dir (ev->get_property ("span-direction"));
+  if (dir == START)
     {
-      tremolo_ev_ = m;
-      return true;
+      // set stem property if stem already exists
+      if (stem_)
+        stem_->set_property ("tuplet-start", SCM_BOOL_T);
+      tuplet_start_ = true;  // stash the value for use in later creation
     }
-  return false;
 }
 
-#include "translator.icc"
-ADD_ACKNOWLEDGER (Stem_engraver,rhythmic_head);
+IMPLEMENT_TRANSLATOR_LISTENER (Stem_engraver, tremolo);
+void
+Stem_engraver::listen_tremolo (Stream_event *ev)
+{
+  ASSIGN_EVENT_ONCE (tremolo_ev_, ev);
+}
+
+ADD_ACKNOWLEDGER (Stem_engraver, rhythmic_head);
+
 ADD_TRANSLATOR (Stem_engraver,
-               /* descr */ "Create stems and single-stem tremolos.  It also works together with "
-               "the beam engraver for overriding beaming.",
-               /* creats*/ "Stem StemTremolo",
-               /* accepts */ "tremolo-event",
-               /* reads */ "tremoloFlags stemLeftBeamCount stemRightBeamCount",
-               /* write */ "");
+                /* doc */
+                "Create stems and single-stem tremolos.  It also works"
+                " together with the beam engraver for overriding beaming.",
+
+                /* create */
+                "Stem "
+                "StemTremolo ",
+
+                /* read */
+                "tremoloFlags "
+                "stemLeftBeamCount "
+                "stemRightBeamCount "
+                "whichBar ",
+
+                /* write */
+                ""
+               );