]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/chord-tremolo-engraver.cc
Release: bump Welcome versions.
[lilypond.git] / lily / chord-tremolo-engraver.cc
index 43e66eb4a3d83f3861946f6e4966f398b46dbd36..9e48a1a4908d5a21bf0c0e59a9242483979f4dd3 100644 (file)
-/*   
-  new-chord-tremolo-engraver.cc --  implement Chord_tremolo_engraver
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 2000--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
-
-#include "engraver.hh"
+/*
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 2000--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
+                 Erik Sandberg <mandolaerik@gmail.com>
+
+  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 "musical-request.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 "music-list.hh"
-#include "math.h"           // ceil
+#include "stem.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+
+#include "translator.icc"
 
 /**
-  This acknowledges repeated music with "tremolo" style.  It typesets
-  a beam.
 
-  TODO:
+This acknowledges repeated music with "tremolo" style.  It typesets
+a beam.
 
-  - perhaps use engraver this to steer other engravers? That would
-  create dependencies between engravers, which is bad.
+TODO:
 
-  - create dots if appropriate.
+- perhaps use engraver this to steer other engravers? That would
+create dependencies between engravers, which is bad.
 
-  - create  TremoloBeam iso Beam?
- */
+- create dots if appropriate.
 
+- create TremoloBeam iso Beam?
+*/
 class Chord_tremolo_engraver : public Engraver
 {
-  void typeset_beam ();
-TRANSLATOR_DECLARATIONS(Chord_tremolo_engraver);
+  TRANSLATOR_DECLARATIONS (Chord_tremolo_engraver);
 protected:
-  Repeated_music * repeat_;
-
-  /// moment (global time) where beam started.
-  Moment start_mom_;
-  Moment stop_mom_;
+  Stream_event *repeat_;
 
-  /// location  within measure where beam started.
-  Moment beam_start_location_;
+  Spanner *beam_;
+  // Store the pointer to the previous stem, so we can create a beam if
+  // necessary and end the spanner
+  Grob *previous_stem_;
 
-  int note_head_i_;
-  int dots_i_;
-
-  bool sequential_body_b_;
-  Spanner * beam_p_;
-  Spanner * finished_beam_p_;
-  Item * stem_tremolo_;
 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 ()
-{
-  beam_p_  = finished_beam_p_ = 0;
-  repeat_ =0;
-  note_head_i_ = 0;
-  dots_i_ = 0;
-  stem_tremolo_ = 0;
-  sequential_body_b_ = false;
-}
-
-bool
-Chord_tremolo_engraver::try_music (Music * m)
+Chord_tremolo_engraver::Chord_tremolo_engraver (Context *c)
+  : Engraver (c)
 {
-  Repeated_music * rp = dynamic_cast<Repeated_music*> (m);
-  if (rp
-      && rp->get_mus_property ("iterator-ctor") == Chord_tremolo_iterator::constructor_cxx_function
-      && !repeat_) 
-    {
-      Moment l = rp->length_mom ();
-      repeat_ = rp;
-      start_mom_ = now_mom ();
-      stop_mom_ = start_mom_ + l;
-      sequential_body_b_ = dynamic_cast<Sequential_music*> (rp->body ());
-
-      // ugh. should generate triplet beams.
-      note_head_i_ = int (ceil (double(l.den ()) / l.num ()));
-      dots_i_ = intlog2 (1+l.num ()) -1 ; // 1->0, 3->1, 7->2
-      note_head_i_ = note_head_i_ <? 4; 
-      return true;
-    }
-
-  return false;
+  beam_ = 0;
+  repeat_ = 0;
+  previous_stem_ = 0;
 }
 
 void
-Chord_tremolo_engraver::process_music ()
+Chord_tremolo_engraver::listen_tremolo_span (Stream_event *ev)
 {
-  if (repeat_)
+  Direction span_dir = to_dir (ev->get_property ("span-direction"));
+  if (span_dir == START)
     {
-      if (sequential_body_b_ && !beam_p_)
-       {
-         beam_p_ = new Spanner (get_property ("Beam"));
-         beam_p_->set_grob_property ("chord-tremolo", SCM_BOOL_T);
-
-
-         SCM smp = get_property ("measurePosition");
-         Moment mp
-           = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
-         beam_start_location_ = mp;
-         announce_grob(beam_p_, repeat_->self_scm());
-       }
-      else if (!sequential_body_b_ && !stem_tremolo_)
-       {
-         int flags = intlog2 (note_head_i_ * repeat_->repeat_count ()) -2;
-         if (flags)
-           {
-             stem_tremolo_ = new Item (get_property ("StemTremolo"));
-             announce_grob(stem_tremolo_, repeat_->self_scm());
-             stem_tremolo_->set_grob_property ("flag-count",
-                                               gh_int2scm (flags));
-
-           }
-       }
+      ASSIGN_EVENT_ONCE (repeat_, ev);
     }
-}
-void
-Chord_tremolo_engraver::finalize ()
-{
-  typeset_beam ();
-  if (beam_p_)
+  else if (span_dir == STOP)
     {
-      repeat_->origin ()->warning (_ ("unterminated chord tremolo"));
-      beam_p_->suicide ();
+      if (!repeat_)
+        ev->origin ()->warning (_ ("No tremolo to end"));
+      repeat_ = 0;
+      beam_ = 0;
+      previous_stem_ = 0;
     }
 }
 
 void
-Chord_tremolo_engraver::typeset_beam ()
+Chord_tremolo_engraver::process_music ()
 {
-  if (finished_beam_p_)
+  if (repeat_ && !beam_)
     {
-      typeset_grob (finished_beam_p_);
-      finished_beam_p_ = 0;
+      beam_ = make_spanner ("Beam", repeat_->self_scm ());
     }
 }
 
-
 void
-Chord_tremolo_engraver::acknowledge_grob (Grob_info info)
+Chord_tremolo_engraver::finalize ()
 {
-  if (beam_p_)
-    {
-      if (Stem::has_interface (info.grob_l_))
-       {
-         Grob * s = info.grob_l_;
-         int f = Stem::duration_log (s);
-         f = (f > 2) ? f - 2 : 1;
-         Stem::set_beaming (s, f, LEFT);
-         Stem::set_beaming (s, f, RIGHT);
-         
-         SCM d = s->get_grob_property ("direction");
-         if (Stem::duration_log (s) != 1)
-           {
-             int gap_i =Stem::duration_log (s) - ((Stem::duration_log (s) >? 2) - 2);
-             beam_p_->set_grob_property ("gap", gh_int2scm (gap_i));
-           }
-         s->set_grob_property ("direction", d);
-
-         if (dynamic_cast <Rhythmic_req *> (info.music_cause ()))
-           {
-             Beam::add_stem (beam_p_, s);
-           }
-         else
-           {
-             String s = _ ("stem must have Rhythmic structure");
-             if (info.music_cause ())
-               info.music_cause ()->origin ()->warning (s);
-             else
-               ::warning (s);
-           }
-       }
-    }
-  else if (stem_tremolo_ && Stem::has_interface (info.grob_l_))
+  if (beam_)
     {
-       Stem_tremolo::set_stem (stem_tremolo_, info.grob_l_);
-
-       info.grob_l_->set_grob_property ("duration-log", gh_int2scm (intlog2 (note_head_i_)));
-    }
-
-  
-  if (repeat_ && Note_head::has_interface (info.grob_l_))
-    {
-      info.grob_l_->set_grob_property ("duration-log", gh_int2scm (intlog2 (note_head_i_)));
-      if (dots_i_ > 0) 
-       {
-          Item * d = new Item (get_property ("Dots"));
-          Rhythmic_head::set_dots (info.grob_l_, d);
-          
-         d->set_grob_property ("dot-count", gh_int2scm (dots_i_));
-
-          d->set_parent (info.grob_l_, Y_AXIS);
-          announce_grob (d, SCM_EOL);
-       }
+      repeat_->origin ()->warning (_ ("unterminated chord tremolo"));
+      announce_end_grob (beam_, SCM_EOL);
+      beam_->suicide ();
     }
 }
 
-
 void
-Chord_tremolo_engraver::start_translation_timestep ()
+Chord_tremolo_engraver::acknowledge_stem (Grob_info info)
 {
-  if (beam_p_ && stop_mom_ == now_mom ())
+  if (beam_)
     {
-      finished_beam_p_ = beam_p_;
-
-      repeat_ = 0;
-      beam_p_ = 0;
+      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_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.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::stop_translation_timestep ()
+Chord_tremolo_engraver::boot ()
 {
-  typeset_beam ();
-
-  if (stem_tremolo_)
-    {
-      typeset_grob (stem_tremolo_);
-      stem_tremolo_ = 0;
-    }
-  
+  ADD_LISTENER (Chord_tremolo_engraver, tremolo_span);
+  ADD_ACKNOWLEDGER (Chord_tremolo_engraver, stem);
 }
 
+ADD_TRANSLATOR (Chord_tremolo_engraver,
+                /* doc */
+                "Generate beams for tremolo repeats.",
+
+                /* create */
+                "Beam ",
 
+                /* read */
+                "",
 
-ENTER_DESCRIPTION(Chord_tremolo_engraver,
-/* descr */       "Generates beams for  tremolo repeats.",
-/* creats*/       "Beam",
-/* acks  */       "stem-interface note-head-interface",
-/* reads */       "",
-/* write */       "");
+                /* write */
+                ""
+               );