]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/chord-tremolo-engraver.cc
Release: bump Welcome versions.
[lilypond.git] / lily / chord-tremolo-engraver.cc
index 5e63ef69fe1f1ec1fce4db3b48c8ad8f7bd2b238..9e48a1a4908d5a21bf0c0e59a9242483979f4dd3 100644 (file)
 /*
-  abbreviation-beam-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)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-           Jan Nieuwenhuizen <janneke@gnu.org>
+  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 "duration-convert.hh"
-#include "time-description.hh"
-#include "chord-tremolo-engraver.hh"
-#include "stem.hh"
-#include "chord-tremolo.hh"
-#include "musical-request.hh"
+#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 "rhythmic-head.hh"
+#include "spanner.hh"
+#include "stem-tremolo.hh"
+#include "stem.hh"
+#include "stream-event.hh"
 #include "warn.hh"
-#include "score-engraver.hh"
 
-ADD_THIS_TRANSLATOR (Chord_tremolo_engraver);
+#include "translator.icc"
 
-Chord_tremolo_engraver::Chord_tremolo_engraver ()
-{
-  reqs_drul_[LEFT] = reqs_drul_[RIGHT] = 0;
-  abeam_p_ = 0;
-  finished_abeam_p_ = 0;
-  prev_start_req_ = 0;
-}
+/**
 
-bool
-Chord_tremolo_engraver::do_try_music (Music* m)
-{
-  if (Chord_tremolo_req* b = dynamic_cast <Chord_tremolo_req *> (m))
-    {
-      Direction d = b->span_dir_;
-      if (reqs_drul_[d] && !reqs_drul_[d]->equal_b (b))
-       return false;
-
-      if ((d == STOP) && !abeam_p_)
-       {
-         m->warning (_ ("no tremolo beam to end"));
-         return false;
-       }
-
-      reqs_drul_[d] = b;
-      return true;
-    }
+This acknowledges repeated music with "tremolo" style.  It typesets
+a beam.
 
-  return false;
+TODO:
+
+- perhaps use engraver this to steer other engravers? That would
+create dependencies between engravers, which is bad.
+
+- create dots if appropriate.
+
+- create TremoloBeam iso Beam?
+*/
+class Chord_tremolo_engraver : public Engraver
+{
+  TRANSLATOR_DECLARATIONS (Chord_tremolo_engraver);
+protected:
+  Stream_event *repeat_;
+
+  Spanner *beam_;
+  // 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 ();
+  void process_music ();
+  void listen_tremolo_span (Stream_event *);
+  void acknowledge_stem (Grob_info);
+};
+
+Chord_tremolo_engraver::Chord_tremolo_engraver (Context *c)
+  : Engraver (c)
+{
+  beam_ = 0;
+  repeat_ = 0;
+  previous_stem_ = 0;
 }
 
 void
-Chord_tremolo_engraver::do_process_requests ()
+Chord_tremolo_engraver::listen_tremolo_span (Stream_event *ev)
 {
-  if (reqs_drul_[STOP])
+  Direction span_dir = to_dir (ev->get_property ("span-direction"));
+  if (span_dir == START)
     {
-      if (!abeam_p_)
-       reqs_drul_[STOP]->warning (_ ("no tremolo beam to end"));
-      prev_start_req_ = 0;
-      finished_abeam_p_ = abeam_p_;
-      abeam_p_ = 0;
+      ASSIGN_EVENT_ONCE (repeat_, ev);
     }
-
-  if (abeam_p_)
+  else if (span_dir == STOP)
     {
-      Score_engraver * e = 0;
-      Translator * t  =  daddy_grav_l ();
-      for (; !e && t;  t = t->daddy_trans_l_)
-       {
-         e = dynamic_cast<Score_engraver*> (t);
-       }
-      
-      if (!e)
-       programming_error ("No score engraver!");
-      else
-       e->forbid_breaks ();
+      if (!repeat_)
+        ev->origin ()->warning (_ ("No tremolo to end"));
+      repeat_ = 0;
+      beam_ = 0;
+      previous_stem_ = 0;
     }
-
-  if (reqs_drul_[START])
-    {
-      if (abeam_p_)
-       {
-         reqs_drul_[START]->warning (_ ("Already have a tremolo beam"));
-         return;
-       }
-
-      prev_start_req_ = reqs_drul_[START];
-
-      abeam_p_ = new Chord_tremolo;
-      announce_element (Score_element_info (abeam_p_, reqs_drul_[LEFT]));
-  }
 }
 
 void
-Chord_tremolo_engraver::do_post_move_processing ()
+Chord_tremolo_engraver::process_music ()
 {
-  reqs_drul_ [START] = 0;
-}
-
-void
-Chord_tremolo_engraver::do_pre_move_processing ()
-{
-  typeset_beam ();
+  if (repeat_ && !beam_)
+    {
+      beam_ = make_spanner ("Beam", repeat_->self_scm ());
+    }
 }
 
 void
-Chord_tremolo_engraver::typeset_beam ()
+Chord_tremolo_engraver::finalize ()
 {
-  if (finished_abeam_p_)
+  if (beam_)
     {
-      typeset_element (finished_abeam_p_);
-      finished_abeam_p_ = 0;
-
-      reqs_drul_[STOP] = 0;
+      repeat_->origin ()->warning (_ ("unterminated chord tremolo"));
+      announce_end_grob (beam_, SCM_EOL);
+      beam_->suicide ();
     }
 }
 
 void
-Chord_tremolo_engraver::do_removal_processing ()
+Chord_tremolo_engraver::acknowledge_stem (Grob_info info)
 {
-  typeset_beam ();
-  if (abeam_p_)
+  if (beam_)
     {
-      prev_start_req_->warning (_ ("unfinished tremolo beam"));
-      finished_abeam_p_ = abeam_p_;
-      typeset_beam ();
+      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::acknowledge_element (Score_element_info i)
+Chord_tremolo_engraver::boot ()
 {
-  if (abeam_p_)
-    {
-      if (Stem* s = dynamic_cast<Stem *> (i.elem_l_))
-       {
-         int type_i = prev_start_req_->type_i_;
-         s->flag_i_ = intlog2 (type_i) - 2;
-
-         s->beams_i_drul_[LEFT] = s->flag_i_;
-         s->beams_i_drul_[RIGHT] = s->flag_i_;
-         
-         abeam_p_->multiple_i_ = s->flag_i_;
-         /*
-           abbrev gaps on all but half note
-         */
-#if 0
-         if (s->type_i () != 1)
-           {
-             int gap_i =s->flag_i_ - ((s->type_i () >? 2) - 2);
-             s->set_elt_property (beam_gap_scm_sym, gh_int2scm(gap_i));
-           }
-#else
-         if (s->type_i () != 1)
-           {
-             int gap_i =s->flag_i_ - ((s->type_i () >? 2) - 2);
-             abeam_p_->set_elt_property (beam_gap_scm_sym, gh_int2scm(gap_i));
-           }
-#endif
-         
-         abeam_p_->add_stem (s);
-       }
-    }
+  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 */
+                "",
+
+                /* write */
+                ""
+               );