]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/chord-tremolo-engraver.cc
Doc-es: various updates.
[lilypond.git] / lily / chord-tremolo-engraver.cc
index bb84edc4bcb3007dd9df591e83ee870efb4954b6..9e48a1a4908d5a21bf0c0e59a9242483979f4dd3 100644 (file)
@@ -1,24 +1,38 @@
 /*
-  chord-tremolo-engraver.cc -- implement Chord_tremolo_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2000--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
+                 Erik Sandberg <mandolaerik@gmail.com>
 
-  (c) 2000--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 "beam.hh"
+#include "engraver-group.hh"
+#include "international.hh"
+#include "item.hh"
+#include "math.h" // ceil
+#include "misc.hh"
 #include "repeated-music.hh"
-#include "stem.hh"
 #include "rhythmic-head.hh"
-#include "engraver-group-engraver.hh"
-#include "warn.hh"
-#include "misc.hh"
-#include "note-head.hh"
 #include "spanner.hh"
-#include "item.hh"
-#include "chord-tremolo-iterator.hh"
 #include "stem-tremolo.hh"
-#include "math.h" // ceil
+#include "stem.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+
+#include "translator.icc"
 
 /**
 
@@ -36,180 +50,131 @@ create dependencies between engravers, which is bad.
 */
 class Chord_tremolo_engraver : public Engraver
 {
-  void typeset_beam ();
   TRANSLATOR_DECLARATIONS (Chord_tremolo_engraver);
 protected:
-  Music *repeat_;
-
-  /// moment (global time) where beam started.
-  Moment start_mom_;
-  Moment stop_mom_;
-  int flags_;
-  int total_duration_flags_;
+  Stream_event *repeat_;
 
-  /// location  within measure where beam started.
-  Moment beam_start_location_;
-
-  bool body_is_sequential_;
   Spanner *beam_;
-  Spanner *finished_beam_;
-  Item *stem_tremolo_;
+  // Store the pointer to the previous stem, so we can create a beam if
+  // necessary and end the spanner
+  Grob *previous_stem_;
+
 protected:
   virtual void finalize ();
-  virtual bool try_music (Music *);
-  virtual void acknowledge_grob (Grob_info);
-  virtual void stop_translation_timestep ();
-  virtual void start_translation_timestep ();
-  virtual void process_music ();
+  void process_music ();
+  void listen_tremolo_span (Stream_event *);
+  void acknowledge_stem (Grob_info);
 };
 
-Chord_tremolo_engraver::Chord_tremolo_engraver ()
+Chord_tremolo_engraver::Chord_tremolo_engraver (Context *c)
+  : Engraver (c)
 {
-  beam_ = finished_beam_ = 0;
+  beam_ = 0;
   repeat_ = 0;
-  flags_ = 0;
-  stem_tremolo_ = 0;
-  body_is_sequential_ = false;
+  previous_stem_ = 0;
 }
 
-bool
-Chord_tremolo_engraver::try_music (Music *m)
+void
+Chord_tremolo_engraver::listen_tremolo_span (Stream_event *ev)
 {
-  if (m->is_mus_type ("repeated-music")
-      && m->get_property ("iterator-ctor") == Chord_tremolo_iterator::constructor_proc
-      && !repeat_)
+  Direction span_dir = to_dir (ev->get_property ("span-direction"));
+  if (span_dir == START)
     {
-      Moment l = m->get_length ();
-      repeat_ = m;
-      start_mom_ = now_mom ();
-      stop_mom_ = start_mom_ + l;
-
-      Music *body = Repeated_music::body (m);
-      body_is_sequential_ = body->is_mus_type ("sequential-music");
-
-      int elt_count = body_is_sequential_ ? scm_ilength (body->get_property ("elements")) : 1;
-
-      if (body_is_sequential_ && elt_count != 2)
-       {
-         m->origin ()->warning (_f ("Chord tremolo with %d elements. Must have two elements.", elt_count));
-       }
-
-      if (elt_count <= 0)
-       elt_count = 1;
-
-      Rational total_dur = l.main_part_;
-      Rational note_dur = total_dur / Rational (elt_count * Repeated_music::repeat_count (repeat_));
-
-      total_duration_flags_ = 0 >? (intlog2 (total_dur.den ()) - 2);
-
-      flags_ = intlog2 (note_dur.den ()) -2;
-
-      return true;
+      ASSIGN_EVENT_ONCE (repeat_, ev);
+    }
+  else if (span_dir == STOP)
+    {
+      if (!repeat_)
+        ev->origin ()->warning (_ ("No tremolo to end"));
+      repeat_ = 0;
+      beam_ = 0;
+      previous_stem_ = 0;
     }
-
-  return false;
 }
 
 void
 Chord_tremolo_engraver::process_music ()
 {
-  if (repeat_ && body_is_sequential_ && !beam_)
+  if (repeat_ && !beam_)
     {
       beam_ = make_spanner ("Beam", repeat_->self_scm ());
-      beam_->set_property ("chord-tremolo", SCM_BOOL_T);
-
-      beam_start_location_ = robust_scm2moment (get_property ("measurePosition"), Moment (0));
     }
 }
 
 void
 Chord_tremolo_engraver::finalize ()
 {
-  typeset_beam ();
   if (beam_)
     {
       repeat_->origin ()->warning (_ ("unterminated chord tremolo"));
+      announce_end_grob (beam_, SCM_EOL);
       beam_->suicide ();
     }
 }
 
 void
-Chord_tremolo_engraver::typeset_beam ()
-{
-  finished_beam_ = 0;
-}
-
-void
-Chord_tremolo_engraver::acknowledge_grob (Grob_info info)
+Chord_tremolo_engraver::acknowledge_stem (Grob_info info)
 {
-  if (beam_ && Stem::has_interface (info.grob_))
+  if (beam_)
     {
-      Grob *s = info.grob_;
-
-      if (start_mom_ == now_mom ())
-       Stem::set_beaming (s, flags_, RIGHT);
-      else
-       Stem::set_beaming (s, flags_, LEFT);
+      int tremolo_type = robust_scm2int (repeat_->get_property ("tremolo-type"), 1);
+      int flags = max (0, intlog2 (tremolo_type) - 2);
+      int repeat_count = robust_scm2int (repeat_->get_property ("repeat-count"), 1);
+      int gap_count = min (flags, intlog2 (repeat_count) + 1);
+
+      Grob *s = info.grob ();
+      if (previous_stem_)
+        {
+          // FIXME: We know that the beam has ended only in listen_tremolo_span
+          //        but then it is too late for Spanner_break_forbid_engraver
+          //        to allow a line break... So, as a nasty hack, announce the
+          //        spanner's end after each note except the first. The only
+          //        "drawback" is that for multi-note tremolos a break would
+          //        theoretically be allowed after the second note (but since
+          //        that note is typically not at a barline, I don't think
+          //        anyone will ever notice!)
+          announce_end_grob (beam_, previous_stem_->self_scm ());
+          // Create the whole beam between previous and current note
+          Stem::set_beaming (previous_stem_, flags, RIGHT);
+          Stem::set_beaming (s, flags, LEFT);
+        }
 
       if (Stem::duration_log (s) != 1)
-       {
-         beam_->set_property ("gap-count", scm_int2num (flags_ - total_duration_flags_));
-       }
-
-      if (info.music_cause ()->is_mus_type ("rhythmic-event"))
-       {
-         Beam::add_stem (beam_, s);
-       }
+        beam_->set_property ("gap-count", scm_from_int (gap_count));
+
+      if (info.ultimate_event_cause ()->in_event_class ("rhythmic-event"))
+        Beam::add_stem (beam_, s);
       else
-       {
-         String s = _ ("stem must have Rhythmic structure");
-         if (info.music_cause ())
-           info.music_cause ()->origin ()->warning (s);
-         else
-           ::warning (s);
-       }
-    }
-  else if (repeat_
-          && flags_ && !body_is_sequential_ && Stem::has_interface (info.grob_))
-    {
-      stem_tremolo_ = make_item ("StemTremolo", repeat_->self_scm ());
-      stem_tremolo_->set_property ("flag-count",
-                                  scm_int2num (flags_));
-      stem_tremolo_->set_property ("stem",
-                                  info.grob_->self_scm ());
-      stem_tremolo_->set_parent (info.grob_, X_AXIS);
+        {
+          string s = _ ("stem must have Rhythmic structure");
+          if (info.event_cause ())
+            info.event_cause ()->origin ()->warning (s);
+          else
+            ::warning (s);
+        }
+      // Store current grob, so we can possibly end the spanner here (and
+      // reset the beam direction to RIGHT)
+      previous_stem_ = s;
     }
 }
 
 void
-Chord_tremolo_engraver::start_translation_timestep ()
+Chord_tremolo_engraver::boot ()
 {
-  if (beam_ && stop_mom_ == now_mom ())
-    {
-      finished_beam_ = beam_;
-      repeat_ = 0;
-      beam_ = 0;
-    }
+  ADD_LISTENER (Chord_tremolo_engraver, tremolo_span);
+  ADD_ACKNOWLEDGER (Chord_tremolo_engraver, stem);
 }
 
-void
-Chord_tremolo_engraver::stop_translation_timestep ()
-{
-  if (stem_tremolo_)
-    {
-      repeat_ = 0;
-      if (beam_)
-       programming_error ("Huh, beam and stem tremolo?");
-      stem_tremolo_ = 0;
-    }
+ADD_TRANSLATOR (Chord_tremolo_engraver,
+                /* doc */
+                "Generate beams for tremolo repeats.",
 
-  typeset_beam ();
-}
+                /* create */
+                "Beam ",
 
-ADD_TRANSLATOR (Chord_tremolo_engraver,
-               /* descr */ "Generates beams for  tremolo repeats.",
-               /* creats*/ "Beam",
-               /* accepts */ "repeated-music",
-               /* acks  */ "stem-interface note-head-interface",
-               /* reads */ "",
-               /* write */ "");
+                /* read */
+                "",
+
+                /* write */
+                ""
+               );